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