2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END============================================
20 * ===================================================================
24 package org.onap.clamp.clds.util;
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
28 import com.google.common.base.Charsets;
30 import java.io.IOException;
31 import java.io.UnsupportedEncodingException;
32 import java.security.GeneralSecurityException;
33 import java.security.SecureRandom;
34 import java.util.Properties;
36 import javax.crypto.Cipher;
37 import javax.crypto.spec.IvParameterSpec;
38 import javax.crypto.spec.SecretKeySpec;
40 import org.apache.commons.codec.DecoderException;
41 import org.apache.commons.codec.binary.Hex;
42 import org.apache.commons.lang3.ArrayUtils;
45 * CryptoUtils for encrypting/decrypting string based on a Key defined in
46 * application.properties (Spring config file).
48 public final class CryptoUtils {
51 * Used to log CryptoUtils class.
53 private static final EELFLogger logger = EELFManager.getInstance().getLogger(CryptoUtils.class);
55 // Encrypt: echo -n "123456" | openssl aes-128-cbc -e -K <Private Hex key>
56 // -iv <16 Bytes iv (HEX), be careful it's 32 Hex Chars> | xxd -u -g100
57 // Final result is to put in properties file is: IV + Outcome of openssl
59 // ************************************************************
60 // Decrypt: echo -n 'Encrypted string' | xxd -r -ps | openssl aes-128-cbc -d
62 // <Private Hex Key> -iv <16 Bytes IV extracted from Encrypted String, be
63 // careful it's 32 Hex Chars>
65 * Definition of encryption algorithm.
67 private static final String ALGORITHM = "AES";
70 * AES Encryption Key environment variable for external configuration.
72 private static final String AES_ENCRYPTION_KEY = "AES_ENCRYPTION_KEY";
75 * Detailed definition of encryption algorithm.
77 private static final String ALGORITHM_DETAILS = ALGORITHM + "/CBC/PKCS5PADDING";
78 private static final int IV_BLOCK_SIZE_IN_BITS = 128;
80 * An Initial Vector of 16 Bytes, so 32 Hexadecimal Chars.
82 private static final int IV_BLOCK_SIZE_IN_BYTES = IV_BLOCK_SIZE_IN_BITS / 8;
84 * Key to read in the key.properties file.
86 private static final String KEY_PARAM = "org.onap.clamp.encryption.aes.key";
87 private static final String PROPERTIES_FILE_NAME = "clds/key.properties";
89 * The SecretKeySpec created from the Base 64 String key.
91 private static final SecretKeySpec SECRET_KEY_SPEC = readSecretKeySpec(PROPERTIES_FILE_NAME);
94 * Private constructor to avoid creating instances of util class.
96 private CryptoUtils() {
100 * Encrypt a value based on the Clamp Encryption Key.
102 * @param value The value to encrypt
103 * @return The encrypted string
104 * @throws GeneralSecurityException In case of issue with the encryption
105 * @throws UnsupportedEncodingException In case of issue with the charset
108 public static String encrypt(String value) throws GeneralSecurityException {
109 Cipher cipher = Cipher.getInstance(ALGORITHM_DETAILS, "SunJCE");
110 byte[] iv = new byte[IV_BLOCK_SIZE_IN_BYTES];
111 SecureRandom.getInstance("SHA1PRNG").nextBytes(iv);
112 IvParameterSpec ivspec = new IvParameterSpec(iv);
113 cipher.init(Cipher.ENCRYPT_MODE, SECRET_KEY_SPEC, ivspec);
114 return Hex.encodeHexString(ArrayUtils.addAll(iv, cipher.doFinal(value.getBytes(Charsets.UTF_8))));
118 * Decrypt a value based on the Clamp Encryption Key.
120 * @param message The encrypted string that must be decrypted using the Clamp
122 * @return The String decrypted
123 * @throws GeneralSecurityException In case of issue with the encryption
124 * @throws DecoderException In case of issue to decode the HexString
126 public static String decrypt(String message) throws GeneralSecurityException, DecoderException {
127 byte[] encryptedMessage = Hex.decodeHex(message.toCharArray());
128 Cipher cipher = Cipher.getInstance(ALGORITHM_DETAILS, "SunJCE");
129 IvParameterSpec ivspec = new IvParameterSpec(ArrayUtils.subarray(encryptedMessage, 0, IV_BLOCK_SIZE_IN_BYTES));
130 byte[] realData = ArrayUtils.subarray(encryptedMessage, IV_BLOCK_SIZE_IN_BYTES, encryptedMessage.length);
131 cipher.init(Cipher.DECRYPT_MODE, SECRET_KEY_SPEC, ivspec);
132 byte[] decrypted = cipher.doFinal(realData);
133 return new String(decrypted);
137 * Method used to generate the SecretKeySpec from a Base64 String.
139 * @param keyString The key as a string in Base 64
140 * @return The SecretKeySpec created
141 * @throws DecoderException In case of issues with the decoding of Base64
143 private static SecretKeySpec getSecretKeySpec(String keyString) throws DecoderException {
144 byte[] key = Hex.decodeHex(keyString.toCharArray());
145 return new SecretKeySpec(key, ALGORITHM);
149 * Reads SecretKeySpec from file specified by propertiesFileName.
151 * @param propertiesFileName File name with properties
152 * @return SecretKeySpec secret key spec read from propertiesFileName
154 private static SecretKeySpec readSecretKeySpec(String propertiesFileName) {
155 Properties props = new Properties();
157 // Workaround fix to make encryption key configurable
158 // System environment variable takes precedence for over clds/key.properties
159 String encryptionKey = System.getenv(AES_ENCRYPTION_KEY);
160 if (encryptionKey != null && encryptionKey.trim().length() > 0) {
161 return getSecretKeySpec(encryptionKey);
163 props.load(ResourceFileUtil.getResourceAsStream(propertiesFileName));
164 return getSecretKeySpec(props.getProperty(KEY_PARAM));
166 } catch (IOException | DecoderException e) {
167 logger.error("Exception occurred during the key reading", e);