2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.openecomp.appc.ccadaptor;
23 import java.security.Provider;
24 import java.security.Provider.Service;
25 import java.security.Security;
27 import javax.crypto.Cipher;
29 import org.jasypt.contrib.org.apache.commons.codec_1_3.binary.Base64;
30 import org.jasypt.util.text.BasicTextEncryptor;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
35 * This class is used to encapsulate the encryption and decryption support in one place and to provide a utility to
36 * encrypt and decrypt data.
38 public class EncryptionTool {
41 * This lock object is used ONLY if the singleton has not been set up.
43 private static final Object lock = new Object();
46 * The salt is used to initialize the PBE (password Based Encrpytion) algorithm.
48 private static final byte[] DEFAULT_SALT = {
49 (byte) 0xc7, (byte) 0x73, (byte) 0x21, (byte) 0x8c, (byte) 0x7e, (byte) 0xc8, (byte) 0xee, (byte) 0x99
53 * The prefix we insert onto any data we encrypt so that we can tell if it is encrpyted later and therefore decrypt
56 @SuppressWarnings("nls")
57 public static final String ENCRYPTED_VALUE_PREFIX = "enc:";
60 * The instance of the encryption utility object
62 private static EncryptionTool instance = null;
65 * The iteration count used to initialize the PBE algorithm and to generate the key spec
67 private static final int ITERATION_COUNT = 20;
70 * The logger for this class.
72 private static final Logger LOG = LoggerFactory.getLogger(EncryptionTool.class);
75 * The secret passphrase (PBE) that we use to perform encryption and decryption. The algorithm we are using is a
78 private static char[] secret = {
79 'C', '_', 'z', 'l', '!', 'K', '!', '4', '?', 'O', 'z', 'E', 'K', 'E', '>', 'U', 'R', '/', '%', 'Y', '\\', 'f',
80 'b', '"', 'e', 'n', '{', '"', 'l', 'U', 'F', '+', 'E', '\'', 'R', 'T', 'p', '1', 'V', '4', 'l', 'a', '9', 'w',
81 'v', '5', 'Z', '#', 'i', 'V', '"', 'd', 'l', '!', 'L', 'M', 'g', 'L', 'Q', '{', 'v', 'v', 'K', 'V'
85 * The algorithm to encrypt and decrpyt data is "Password (or passphrase) Based Encryption with Message Digest #5
86 * and the Data Encryption Standard", i.e., PBEWithMD5AndDES.
88 @SuppressWarnings("nls")
89 private static final String SECURITY_ALGORITHM = "PBEWITHMD5AND256BITAES";// "PBEWithMD5AndDES";
92 * The decryption cipher object
94 private Cipher decryptCipher = null;
97 * The encryption cipher object
99 private Cipher encryptCipher = null;
101 private BasicTextEncryptor encryptor;
104 * Get an instance of the EncryptionTool
106 * @return The encryption tool to be used
108 public static final EncryptionTool getInstance() {
109 if (instance == null) {
110 synchronized (lock) {
111 if (instance == null) {
112 instance = new EncryptionTool();
120 * Create the EncryptionTool instance
122 @SuppressWarnings("nls")
123 private EncryptionTool() {
124 // encryptor = new BasicTextEncryptor();
125 // encryptor.setPassword(secret.toString());
126 String out = "Found the following security algorithms:";
127 for (Provider p : Security.getProviders()) {
128 for (Service s : p.getServices()) {
129 String algo = s.getAlgorithm();
131 String.format("\n -Algorithm [ %s ] in provider [ %s ] and service [ %s ]", algo, p.getName(),
139 * Decrypt the provided encrypted text
142 * THe cipher text to be decrypted. If the ciphertext is not encrypted, then it is returned as is.
143 * @return the clear test of the (possibly) encrypted value. The original value if the string is not encrypted.
145 @SuppressWarnings("nls")
146 public synchronized String decrypt(String cipherText) {
147 if (isEncrypted(cipherText)) {
148 String encValue = cipherText.substring(ENCRYPTED_VALUE_PREFIX.length());
149 // return encryptor.decrypt(encValue);
150 byte[] plainByte = Base64.decodeBase64(encValue.getBytes());
151 byte[] decryptByte = xorWithSecret(plainByte);
152 return new String(decryptByte);
160 * Encrypt the provided clear text
163 * The clear text to be encrypted
164 * @return the encrypted text. If the clear text is empty (null or zero length), then an empty string is returned.
165 * If the clear text is already encrypted, it is not encrypted again and is returned as is. Otherwise, the
166 * clear text is encrypted and returned.
168 @SuppressWarnings("nls")
169 public synchronized String encrypt(String clearText) {
170 if (clearText != null) {
171 byte[] encByte = xorWithSecret(clearText.getBytes());
172 String encryptedValue = new String(Base64.encodeBase64(encByte));
173 return ENCRYPTED_VALUE_PREFIX + encryptedValue;
180 * Is a value encrypted? A value is considered to be encrypted if it begins with the
181 * {@linkplain #ENCRYPTED_VALUE_PREFIX encrypted value prefix}.
184 * the value to check.
185 * @return true/false;
187 private static boolean isEncrypted(final String value) {
188 return value != null && value.startsWith(ENCRYPTED_VALUE_PREFIX);
192 * XORs the input byte array with the secret key, padding 0x0 to the end of the secret key if the input is longer
193 * and returns a byte array the same size as input
196 * The byte array to be XORed with secret
197 * @return A byte array the same size as inp or null if input is null.
199 private byte[] xorWithSecret(byte[] inp) {
204 byte[] secretBytes = new String(secret).getBytes();
205 int size = inp.length;
207 byte[] out = new byte[size];
208 for (int i = 0; i < size; i++) {
209 out[i] = (byte) ((inp[i]) ^ (secretBytes[i % secretBytes.length]));