sviolet.thistle.util.crypto.AESCipher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thistle-common Show documentation
Comprehensive Java common library (Java7+)
There is a newer version: 22.1.0
/*
 * Copyright (C) 2015-2017 S.Violet
 *
 * 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.
 *
 * Project GitHub: https://github.com/shepherdviolet/thistle
 * Email: [email protected]
 */

package sviolet.thistle.util.crypto;

import sviolet.thistle.util.crypto.base.BaseCipher;

import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.security.InvalidAlgorithmParameterException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;

/**
 * 
 * AES加解密工具
 *
 * Cipher/Signature/MessageDigest线程不安全!!!
 * 
 * @author S.Violet
 */
public class AESCipher{

	/**
	 * 密钥类型:AES
	 */
	public static final String KEY_ALGORITHM = "AES";

	/**
	 * 加密算法:AES + ECB/PKCS5Padding填充
	 */
	public static final String CRYPTO_ALGORITHM_AES_ECB_PKCS5PADDING = "AES/ECB/PKCS5Padding";

	/**
	 * 加密算法:AES + CBC/PKCS5Padding填充
	 */
	public static final String CRYPTO_ALGORITHM_AES_CBC_PKCS5PADDING = "AES/CBC/PKCS5Padding";

	/**
	 * 加密算法:AES + CBC无填充
	 */
    public static final String CRYPTO_ALGORITHM_AES_CBC_NOPADDING = "AES/CBC/NoPadding";

	/**
	 * 加密算法:AES + GCM无填充, 需要Security.addProvider(new BouncyCastleProvider());
	 */
	public static final String CRYPTO_ALGORITHM_AES_GCM_NOPADDING = "AES/GCM/NoPadding";

	/**
	 * 加密(byte[]数据)
	 *
	 * @param data 数据
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static byte[] encrypt(byte[] data, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException{
		return BaseCipher.encrypt(data, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

	/**
	 * 加密(byte[]数据, 使用CBC填充算法时需要用该方法并指定iv初始化向量)
	 *
	 * @param data 数据
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param ivSeed iv初始化向量, 16 bytes, 例如:"1234567812345678".getBytes("UTF-8")
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static byte[] encryptCBC(byte[] data, byte[] key, byte[] ivSeed, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException, InvalidAlgorithmParameterException{
		return BaseCipher.encryptCBC(data, key, KEY_ALGORITHM, ivSeed, cryptoAlgorithm);
	}

	/**
	 * 加密(byte[]数据, 使用GCM模式), 需要Security.addProvider(new BouncyCastleProvider());
	 *
	 * @param data 数据
	 * @param aad 附加验证数据(Additional Authenticated Data)
	 * @param iv 初始化向量, AES 16 bytes, DES 8bytes
	 * @param tagLength 附加验证数据标签长度(bit), 32, 64, 96, 104, 112, 120, 128
	 * @param key 秘钥(AES:128/256bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法, AES/GCM/NoPadding
	 */
	public static byte[] encryptGCM(byte[] data, byte[] aad, byte[] iv, int tagLength, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException, InvalidAlgorithmParameterException {
		return BaseCipher.encryptGCM(data, aad, iv, tagLength, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

	/**
	 * 加密(大文件, 注意, 输入输出流会被关闭)
	 *
	 * @param in 待加密数据流
	 * @param out 加密后数据流
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static void encrypt(InputStream in, OutputStream out, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IOException {
		BaseCipher.encrypt(in, out, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

	/**
	 * 加密(大文件, 注意, 输入输出流会被关闭, 使用CBC填充算法时需要用该方法并指定iv初始化向量)
	 *
	 * @param in 待加密数据流
	 * @param out 加密后数据流
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param ivSeed iv初始化向量, 16 bytes, 例如:"1234567812345678".getBytes("UTF-8")
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static void encryptCBC(InputStream in, OutputStream out, byte[] key, byte[] ivSeed, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException, IOException {
		BaseCipher.encryptCBC(in, out, key, KEY_ALGORITHM, ivSeed, cryptoAlgorithm);
	}

	/**
	 * 加密(大文件, 注意, 输入输出流会被关闭, 使用GCM模式), 需要Security.addProvider(new BouncyCastleProvider());
	 *
	 * @param in 待加密数据流
	 * @param out 加密后数据流
	 * @param aad 附加验证数据(Additional Authenticated Data)
	 * @param iv 初始化向量, AES 16 bytes, DES 8bytes
	 * @param tagLength 附加验证数据标签长度(bit), 32, 64, 96, 104, 112, 120, 128
	 * @param key 秘钥(AES:128/256bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法, AES/GCM/NoPadding
	 */
	public static void encryptGCM(InputStream in, OutputStream out, byte[] aad, byte[] iv, int tagLength, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException, IOException {
		BaseCipher.encryptGCM(in, out, aad, iv, tagLength, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

	/**
	 * 解密(byte[]数据)
	 *
	 * @param data 数据
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static byte[] decrypt(byte[] data, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException{
		return BaseCipher.decrypt(data, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

	/**
	 * 解密(byte[]数据, CBC填充需要用该方法并指定iv初始化向量)
	 *
	 * @param data 数据
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param ivSeed iv初始化向量, 16 bytes, "1234567812345678".getBytes("UTF-8")
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static byte[] decryptCBC(byte[] data, byte[] key, byte[] ivSeed, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException, InvalidAlgorithmParameterException{
		return BaseCipher.decryptCBC(data, key, KEY_ALGORITHM, ivSeed, cryptoAlgorithm);
	}

	/**
	 * 解密(byte[]数据, 使用GCM模式), 需要Security.addProvider(new BouncyCastleProvider());
	 *
	 * @param data 数据
	 * @param aad 附加验证数据(Additional Authenticated Data)
	 * @param iv 初始化向量, AES 16 bytes, DES 8bytes
	 * @param tagLength 附加验证数据标签长度(bit), 32, 64, 96, 104, 112, 120, 128
	 * @param key 秘钥(AES:128/256bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法, AES/GCM/NoPadding
	 */
	public static byte[] decryptGCM(byte[] data, byte[] aad, byte[] iv, int tagLength, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException, InvalidAlgorithmParameterException {
		return BaseCipher.decryptGCM(data, aad, iv, tagLength, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

	/**
	 * 解密(大文件, 注意, 输入输出流会被关闭)
	 *
	 * @param in 待解密数据流
	 * @param out 解密后数据流
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static void decrypt(InputStream in, OutputStream out, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IOException {
		BaseCipher.decrypt(in, out, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

	/**
	 * 解密(大文件, 注意, 输入输出流会被关闭, CBC填充需要用该方法并指定iv初始化向量)
	 *
	 * @param in 待解密数据流
	 * @param out 解密后数据流
	 * @param key 秘钥(AES:128bit, DES:64/192bit)
	 * @param ivSeed iv初始化向量, 16 bytes, "1234567812345678".getBytes("UTF-8")
	 * @param cryptoAlgorithm 加密算法/填充算法
	 */
	public static void decryptCBC(InputStream in, OutputStream out, byte[] key, byte[] ivSeed, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException, IOException {
		BaseCipher.decryptCBC(in, out, key, KEY_ALGORITHM, ivSeed, cryptoAlgorithm);
	}

	/**
	 * 解密(大文件, 注意, 输入输出流会被关闭, 使用GCM模式), 需要Security.addProvider(new BouncyCastleProvider());
	 *
	 * @param in 待解密数据流
	 * @param out 解密后数据流
	 * @param aad 附加验证数据(Additional Authenticated Data)
	 * @param iv 初始化向量, AES 16 bytes, DES 8bytes
	 * @param tagLength 附加验证数据标签长度(bit), 32, 64, 96, 104, 112, 120, 128
	 * @param key 秘钥(AES:128/256bit, DES:64/192bit)
	 * @param cryptoAlgorithm 加密算法/填充算法, AES/GCM/NoPadding
	 */
	public static void decryptGCM(InputStream in, OutputStream out, byte[] aad, byte[] iv, int tagLength, byte[] key, String cryptoAlgorithm) throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException, IOException {
		BaseCipher.decryptGCM(in, out, aad, iv, tagLength, key, KEY_ALGORITHM, cryptoAlgorithm);
	}

}