src/main/java/org/onap/clamp/clds/util/CryptoUtils.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
   6  *                             reserved.
   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
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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  * ===================================================================
  21  *
  22  */
  23
  24 package org.onap.clamp.clds.util;
  25
  26 import com.att.eelf.configuration.EELFLogger;
  27 import com.att.eelf.configuration.EELFManager;
  28 import com.google.common.base.Charsets;
  29
  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;
  35
  36 import javax.crypto.Cipher;
  37 import javax.crypto.spec.IvParameterSpec;
  38 import javax.crypto.spec.SecretKeySpec;
  39
  40 import org.apache.commons.codec.DecoderException;
  41 import org.apache.commons.codec.binary.Hex;
  42 import org.apache.commons.lang3.ArrayUtils;
  43
  44 /**
  45  * CryptoUtils for encrypting/decrypting string based on a Key defined in
  46  * application.properties (Spring config file).
  47  */
  48 public final class CryptoUtils {
  49
  50     /**
  51      * Used to log CryptoUtils class.
  52      */
  53     private static final EELFLogger logger = EELFManager.getInstance().getLogger(CryptoUtils.class);
  54     // Openssl commands:
  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
  58     // command
  59     // ************************************************************
  60     // Decrypt: echo -n 'Encrypted string' | xxd -r -ps | openssl aes-128-cbc -d
  61     // -K
  62     // <Private Hex Key> -iv <16 Bytes IV extracted from Encrypted String, be
  63     // careful it's 32 Hex Chars>
  64     /**
  65      * Definition of encryption algorithm.
  66      */
  67     private static final String ALGORITHM = "AES";
  68     /**
  69      * Detailed definition of encryption algorithm.
  70      */
  71     private static final String ALGORITHM_DETAILS = ALGORITHM + "/CBC/PKCS5PADDING";
  72     private static final int IV_BLOCK_SIZE_IN_BITS = 128;
  73     /**
  74      * An Initial Vector of 16 Bytes, so 32 Hexadecimal Chars.
  75      */
  76     private static final int IV_BLOCK_SIZE_IN_BYTES = IV_BLOCK_SIZE_IN_BITS / 8;
  77     /**
  78      * Key to read in the key.properties file.
  79      */
  80     private static final String KEY_PARAM = "org.onap.clamp.encryption.aes.key";
  81     private static final String PROPERTIES_FILE_NAME = "clds/key.properties";
  82     /**
  83      * The SecretKeySpec created from the Base 64 String key.
  84      */
  85     private static final SecretKeySpec SECRET_KEY_SPEC = readSecretKeySpec(PROPERTIES_FILE_NAME);
  86
  87     /**
  88      * Private constructor to avoid creating instances of util class.
  89      */
  90     private CryptoUtils() {
  91     }
  92
  93     /**
  94      * Encrypt a value based on the Clamp Encryption Key.
  95      *
  96      * @param value
  97      *            The value to encrypt
  98      * @return The encrypted string
  99      * @throws GeneralSecurityException
 100      *             In case of issue with the encryption
 101      * @throws UnsupportedEncodingException
 102      *             In case of issue with the charset conversion
 103      */
 104     public static String encrypt(String value) throws GeneralSecurityException {
 105         Cipher cipher = Cipher.getInstance(ALGORITHM_DETAILS, "SunJCE");
 106         byte[] iv = new byte[IV_BLOCK_SIZE_IN_BYTES];
 107         SecureRandom.getInstance("SHA1PRNG").nextBytes(iv);
 108         IvParameterSpec ivspec = new IvParameterSpec(iv);
 109         cipher.init(Cipher.ENCRYPT_MODE, SECRET_KEY_SPEC, ivspec);
 110         return Hex.encodeHexString(ArrayUtils.addAll(iv, cipher.doFinal(value.getBytes(Charsets.UTF_8))));
 111     }
 112
 113     /**
 114      * Decrypt a value based on the Clamp Encryption Key.
 115      *
 116      * @param message
 117      *            The encrypted string that must be decrypted using the Clamp
 118      *            Encryption Key
 119      * @return The String decrypted
 120      * @throws GeneralSecurityException
 121      *             In case of issue with the encryption
 122      * @throws DecoderException
 123      *             In case of issue to decode the HexString
 124      */
 125     public static String decrypt(String message) throws GeneralSecurityException, DecoderException {
 126         byte[] encryptedMessage = Hex.decodeHex(message.toCharArray());
 127         Cipher cipher = Cipher.getInstance(ALGORITHM_DETAILS, "SunJCE");
 128         IvParameterSpec ivspec = new IvParameterSpec(ArrayUtils.subarray(encryptedMessage, 0, IV_BLOCK_SIZE_IN_BYTES));
 129         byte[] realData = ArrayUtils.subarray(encryptedMessage, IV_BLOCK_SIZE_IN_BYTES, encryptedMessage.length);
 130         cipher.init(Cipher.DECRYPT_MODE, SECRET_KEY_SPEC, ivspec);
 131         byte[] decrypted = cipher.doFinal(realData);
 132         return new String(decrypted);
 133     }
 134
 135     /**
 136      * Method used to generate the SecretKeySpec from a Base64 String.
 137      *
 138      * @param keyString
 139      *            The key as a string in Base 64
 140      * @return The SecretKeySpec created
 141      * @throws DecoderException
 142      *             In case of issues with the decoding of Base64
 143      */
 144     private static SecretKeySpec getSecretKeySpec(String keyString) throws DecoderException {
 145         byte[] key = Hex.decodeHex(keyString.toCharArray());
 146         return new SecretKeySpec(key, ALGORITHM);
 147     }
 148
 149     /**
 150      * Reads SecretKeySpec from file specified by propertiesFileName
 151      *
 152      * @param propertiesFileName
 153      *            File name with properties
 154      * @return SecretKeySpec secret key spec read from propertiesFileName
 155      */
 156     private static SecretKeySpec readSecretKeySpec(String propertiesFileName) {
 157         Properties props = new Properties();
 158         try {
 159             props.load(ResourceFileUtil.getResourceAsStream(propertiesFileName));
 160             return getSecretKeySpec(props.getProperty(KEY_PARAM));
 161         } catch (IOException | DecoderException e) {
 162             logger.error("Exception occurred during the key reading", e);
 163             return null;
 164         }
 165     }
 166 }