All Downloads are FREE. Search and download functionalities are using the official Maven repository.

hu.icellmobilsoft.coffee.tool.utils.crypto.AesGcmUtil Maven / Gradle / Ivy

There is a newer version: 2.9.0
Show newest version
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package hu.icellmobilsoft.coffee.tool.utils.crypto;

import java.security.SecureRandom;
import java.text.MessageFormat;

import javax.crypto.Cipher;
import javax.crypto.SecretKey;
import javax.crypto.spec.GCMParameterSpec;
import javax.crypto.spec.SecretKeySpec;

import hu.icellmobilsoft.coffee.dto.exception.InvalidParameterException;
import hu.icellmobilsoft.coffee.dto.exception.TechnicalException;
import hu.icellmobilsoft.coffee.dto.exception.enums.CoffeeFaultType;
import hu.icellmobilsoft.coffee.se.api.exception.BaseException;

/**
 * Util class for AES/GCM/NoPadding encode/decode
 *
 * @author mark.petrenyi
 * @since 1.1.0
 */
public class AesGcmUtil {

    /**
     * Default Initialization Vector (IV) buffer
     */
    public static final byte[] DEFAULT_IV = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };

    // For GCM a 12 byte (not 16!) byte-array is recommend by NIST because it’s faster and more secure
    private static final int IV_BYTE_LENGTH = 12;

    private static final int KEY_LENGTH = 256;
    private static final int KEY_BYTE_LENGTH = KEY_LENGTH / 8;
    private static final int AES_BLOCK_SIZE = 128;

    private static final String AES = "AES";
    private static final String CIPHER_AES_GCM_NOPADDING = "AES/GCM/NoPadding";

    /**
     * Default constructor, constructs a new object.
     */
    public AesGcmUtil() {
        super();
    }

    /**
     * Generates a secure random 256 bit length key
     *
     * @return random secure key as byte array
     */
    public static byte[] generateKey() {
        byte[] key = new byte[KEY_BYTE_LENGTH];
        SecureRandom secureRandom = new SecureRandom();
        secureRandom.nextBytes(key);
        return key;
    }

    /**
     * Generates a secure random 12 byte length iv
     *
     * @return random secure key as byte array
     */
    public static byte[] generateIv() {
        byte[] key = new byte[IV_BYTE_LENGTH];
        SecureRandom secureRandom = new SecureRandom();
        secureRandom.nextBytes(key);
        return key;
    }

    /**
     * AES-256 encrypting (GCM, NoPadding) with one time key (Since the default IV is used, the key must NOT be reused!)
     *
     * @param oneTimeKey
     *            - one time key used for encryption
     * @param plainText
     *            - byte array to encrypt
     * @return the encrypted data as byte array
     * @throws BaseException
     *             exception
     */
    public static byte[] encryptWithAes256GcmNoPadding(byte[] oneTimeKey, byte[] plainText) throws BaseException {
        return encryptWithAes256GcmNoPadding(oneTimeKey, plainText, DEFAULT_IV);
    }

    /**
     * AES-256 encrypting (GCM, NoPadding)
     *
     * @param key
     *            - key used for encryption
     * @param plainText
     *            - byte array to encrypt
     * @param iv
     *            - initialization vector (NEVER use the same key-iv pair more than once)
     * @return the encrypted data as byte array
     * @throws BaseException
     *             exception
     */
    public static byte[] encryptWithAes256GcmNoPadding(byte[] key, byte[] plainText, byte[] iv) throws BaseException {
        checkKeyAndIVSize(key, iv);
        SecretKey secretKey = new SecretKeySpec(key, AES);

        try {
            final Cipher cipher = Cipher.getInstance(CIPHER_AES_GCM_NOPADDING);
            GCMParameterSpec parameterSpec = new GCMParameterSpec(AES_BLOCK_SIZE, iv);
            cipher.init(Cipher.ENCRYPT_MODE, secretKey, parameterSpec);
            return cipher.doFinal(plainText);
        } catch (Exception e) {
            throw new TechnicalException(CoffeeFaultType.OPERATION_FAILED, e.getLocalizedMessage(), e);
        }
    }

    /**
     * AES-256 decrypting (GCM, NoPadding) with one time key (Since the default IV is used, the key must NOT be reused!)
     *
     * @param oneTimeKey
     *            - one time key used for decrypting
     * @param encryptedBytes
     *            - byte array to decrypt
     * @return decrypted data as byte array
     * @throws BaseException
     *             exception
     */
    public static byte[] decryptWithAes256GcmNoPadding(byte[] oneTimeKey, byte[] encryptedBytes) throws BaseException {
        return decryptWithAes256GcmNoPadding(oneTimeKey, encryptedBytes, DEFAULT_IV);
    }

    /**
     * AES-256 decrypting (GCM, NoPadding)
     *
     * @param key
     *            - key used for decrypting
     * @param encryptedBytes
     *            - byte array to decrypt
     * @param iv
     *            - initialization vector
     * @return decrypted data as byte array
     * @throws BaseException
     *             exception
     */
    public static byte[] decryptWithAes256GcmNoPadding(byte[] key, byte[] encryptedBytes, byte[] iv) throws BaseException {
        checkKeyAndIVSize(key, iv);

        try {
            final Cipher cipher = Cipher.getInstance(CIPHER_AES_GCM_NOPADDING);
            SecretKey secretKey = new SecretKeySpec(key, AES);
            GCMParameterSpec parameterSpec = new GCMParameterSpec(AES_BLOCK_SIZE, iv);
            cipher.init(Cipher.DECRYPT_MODE, secretKey, parameterSpec);
            return cipher.doFinal(encryptedBytes);
        } catch (Exception e) {
            throw new TechnicalException(CoffeeFaultType.OPERATION_FAILED, e.getLocalizedMessage(), e);
        }
    }

    private static void checkKeyAndIVSize(byte[] key, byte[] iv) throws BaseException {
        if (key == null || key.length != KEY_BYTE_LENGTH) {
            throw new InvalidParameterException(
                    MessageFormat.format("Invalid key length or key is null! Expected key length in bytes: [{0}]", KEY_BYTE_LENGTH));
        }
        if (iv == null || iv.length != IV_BYTE_LENGTH) {
            throw new InvalidParameterException(
                    MessageFormat.format("Invalid IV length or IV is null! Expected IV length in bytes: [{0}]", IV_BYTE_LENGTH));
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy