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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23
  24 package org.onap.clamp.clds.util;
  25
  26 import java.security.GeneralSecurityException;
  27
  28 import javax.annotation.PostConstruct;
  29 import javax.crypto.Cipher;
  30 import javax.crypto.spec.SecretKeySpec;
  31
  32 import org.springframework.beans.factory.annotation.Autowired;
  33 import org.springframework.core.env.Environment;
  34 import org.springframework.stereotype.Component;
  35
  36 /**
  37  * CryptoUtils for encrypting/decrypting string based on a Key defined in
  38  * application.properties (Spring config file).
  39  *
  40  */
  41 @Component("CryptoUtils")
  42 public final class CryptoUtils {
  43     public static final String AES       = "AES";
  44     public static final String KEY_PARAM = "org.onap.clamp.encryption.aes.key";
  45     @Autowired
  46     private Environment        springEnv;
  47     private SecretKeySpec      secretKeySpec;
  48
  49     /**
  50      * Initialize Method
  51      *
  52      */
  53     @PostConstruct
  54     public void init() {
  55         secretKeySpec = getSecretKeySpec(springEnv.getProperty(KEY_PARAM));
  56     }
  57
  58     /**
  59      * Encrypt a value based on the Clamp Encryption Key.
  60      *
  61      * @param value
  62      * @return The encrypted string
  63      * @throws GeneralSecurityException
  64      *             In case of issue with the encryption
  65      */
  66     public String encrypt(String value) throws GeneralSecurityException {
  67         Cipher cipher = Cipher.getInstance(CryptoUtils.AES);
  68         cipher.init(Cipher.ENCRYPT_MODE, secretKeySpec, cipher.getParameters());
  69         byte[] encrypted = cipher.doFinal(value.getBytes());
  70         return byteArrayToHexString(encrypted);
  71     }
  72
  73     /**
  74      * Decrypt a value.
  75      *
  76      * @param message
  77      *            The encrypted string that must be decrypted using the Clamp
  78      *            Encryption Key
  79      * @return The String decrypted
  80      * @throws GeneralSecurityException
  81      *             In case of issue with the encryption
  82      */
  83     public String decrypt(String message) throws GeneralSecurityException {
  84         Cipher cipher = Cipher.getInstance(CryptoUtils.AES);
  85         cipher.init(Cipher.DECRYPT_MODE, secretKeySpec);
  86         byte[] decrypted = cipher.doFinal(hexStringToByteArray(message));
  87         return new String(decrypted);
  88     }
  89
  90     private SecretKeySpec getSecretKeySpec(String keyString) {
  91         byte[] key = hexStringToByteArray(keyString);
  92         return new SecretKeySpec(key, CryptoUtils.AES);
  93     }
  94
  95     private String byteArrayToHexString(byte[] b) {
  96         StringBuilder sb = new StringBuilder(b.length * 2);
  97         for (int i = 0; i < b.length; i++) {
  98             int v = b[i] & 0xff;
  99             if (v < 16) {
 100                 sb.append('0');
 101             }
 102             sb.append(Integer.toHexString(v));
 103         }
 104         return sb.toString().toUpperCase();
 105     }
 106
 107     private byte[] hexStringToByteArray(String s) {
 108         byte[] b = new byte[s.length() / 2];
 109         for (int i = 0; i < b.length; i++) {
 110             int index = i * 2;
 111             int v = Integer.parseInt(s.substring(index, index + 2), 16);
 112             b[i] = (byte) v;
 113         }
 114         return b;
 115     }
 116 }