appc-common/src/main/java/org/onap/appc/encryption/EncryptionTool.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   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
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  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.
  20  *
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.appc.encryption;
  25
  26 import java.security.Provider;
  27 import java.security.Provider.Service;
  28 import java.security.Security;
  29
  30 import javax.crypto.Cipher;
  31
  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;
  36
  37 /**
  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.
  40  */
  41 public class EncryptionTool {
  42
  43     /**
  44      * This lock object is used ONLY if the singleton has not been set up.
  45      */
  46     private static final Object lock = new Object();
  47
  48     /**
  49      * The salt is used to initialize the PBE (password Based Encrpytion) algorithm.
  50      */
  51     private static final byte[] DEFAULT_SALT = {
  52         (byte) 0xc7, (byte) 0x73, (byte) 0x21, (byte) 0x8c, (byte) 0x7e, (byte) 0xc8, (byte) 0xee, (byte) 0x99
  53     };
  54
  55     /**
  56      * The prefix we insert onto any data we encrypt so that we can tell if it is encrpyted later and therefore decrypt
  57      * it
  58      */
  59     @SuppressWarnings("nls")
  60     public static final String ENCRYPTED_VALUE_PREFIX = "enc:";
  61
  62     /**
  63      * The instance of the encryption utility object
  64      */
  65     private static EncryptionTool instance = null;
  66
  67     /**
  68      * The iteration count used to initialize the PBE algorithm and to generate the key spec
  69      */
  70     private static final int ITERATION_COUNT = 20;
  71
  72     /**
  73      * The logger for this class.
  74      */
  75     private static final Logger LOG = LoggerFactory.getLogger(EncryptionTool.class);
  76
  77     /**
  78      * The secret passphrase (PBE) that we use to perform encryption and decryption. The algorithm we are using is a
  79      * symmetrical cipher.
  80      */
  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'
  85     };
  86
  87     /**
  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.
  90      */
  91     @SuppressWarnings("nls")
  92     private static final String SECURITY_ALGORITHM = "PBEWITHMD5AND256BITAES";// "PBEWithMD5AndDES";
  93
  94     /**
  95      * The decryption cipher object
  96      */
  97     private Cipher decryptCipher = null;
  98
  99     /**
 100      * The encryption cipher object
 101      */
 102     private Cipher encryptCipher = null;
 103
 104     private BasicTextEncryptor encryptor;
 105
 106     /**
 107      * Get an instance of the EncryptionTool
 108      *
 109      * @return The encryption tool to be used
 110      */
 111     public static final EncryptionTool getInstance() {
 112         if (instance == null) {
 113             synchronized (lock) {
 114                 if (instance == null) {
 115                     instance = new EncryptionTool();
 116                 }
 117             }
 118         }
 119         return instance;
 120     }
 121
 122     /**
 123      * Create the EncryptionTool instance
 124      */
 125     @SuppressWarnings("nls")
 126     private EncryptionTool() {
 127         String out = "Found the following security algorithms:";
 128         for (Provider p : Security.getProviders()) {
 129             for (Service s : p.getServices()) {
 130                 String algo = s.getAlgorithm();
 131                 out +=
 132                     String.format("%n  -Algorithm [ %s ] in provider [ %s ] and service [ %s ]", algo, p.getName(),
 133                         s.getClassName());
 134             }
 135         }
 136         LOG.debug(out);
 137     }
 138
 139     /**
 140      * Decrypt the provided encrypted text
 141      *
 142      * @param cipherText
 143      *            THe cipher text to be decrypted. If the ciphertext is not encrypted, then it is returned as is.
 144      * @return the clear test of the (possibly) encrypted value. The original value if the string is not encrypted.
 145      */
 146     @SuppressWarnings("nls")
 147     public synchronized String decrypt(String cipherText) {
 148         if (isEncrypted(cipherText)) {
 149             String encValue = cipherText.substring(ENCRYPTED_VALUE_PREFIX.length());
 150             byte[] plainByte = Base64.decodeBase64(encValue.getBytes());
 151             byte[] decryptByte = xorWithSecret(plainByte);
 152             return new String(decryptByte);
 153         } else {
 154             return cipherText;
 155         }
 156
 157     }
 158
 159     /**
 160      * Encrypt the provided clear text
 161      *
 162      * @param clearText
 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.
 167      */
 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;
 174         } else {
 175             return null;
 176         }
 177     }
 178
 179     /**
 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}.
 182      *
 183      * @param value
 184      *            the value to check.
 185      * @return true/false;
 186      */
 187     private static boolean isEncrypted(final String value) {
 188         return value != null && value.startsWith(ENCRYPTED_VALUE_PREFIX);
 189     }
 190
 191     /**
 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
 194      *
 195      * @param inp
 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.
 198      */
 199     private byte[] xorWithSecret(byte[] inp) {
 200         if (inp == null) {
 201             return null;
 202         }
 203
 204         byte[] secretBytes = new String(secret).getBytes();
 205         int size = inp.length;
 206
 207         byte[] out = new byte[size];
 208         for (int i = 0; i < size; i++) {
 209             out[i] = (byte) ((inp[i]) ^ (secretBytes[i % secretBytes.length]));
 210         }
 211         return out;
 212     }
 213
 214 }