Package org.summerboot.jexpress.security

Class EncryptorUtil

java.lang.Object

org.summerboot.jexpress.security.EncryptorUtil

public class EncryptorUtil
extends Object

Author:

Changski Tie Zheng Zhang 张铁铮, 魏泽北, 杜旺财, 杜富贵

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EncryptorUtil.EncryptionMeta
static enum	EncryptorUtil.KeyFileType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AES_KEY_ALGO
static final int	AES_KEY_BIT
static final String	ENCRYPT_ALGO
static final int	IV_LENGTH_BYTE
static final String	MESSAGEDIGEST_ALGORITHM
static final org.bouncycastle.jce.provider.BouncyCastleProvider	PROVIDER
static final String	RSA_CIPHER_ALGORITHM
static final String	RSA_KEY_ALGO
static final int	TAG_LENGTH_BIT

Constructor Summary

Constructors

Constructor	Description
EncryptorUtil()

Method Summary

Modifier and Type	Method	Description
protected static byte[]	asymmetric(int cipherMode, Key asymmetricKey, byte[] in)
static Cipher	buildCypher_GCM(boolean encrypt, SecretKey symmetricKey, byte[] iv)
static byte[]	buildSecretKey(String password)
static byte[]	decrypt(Key asymmetricKey, byte[] in)
static byte[]	decrypt(Key asymmetricKey, SecretKey symmetricKey, byte[] encryptedData, Key digitalSignatureKey, EncryptorUtil.EncryptionMeta meta)	decrypt data in RAM
static byte[]	decrypt(Key asymmetricKey, SecretKey symmetricKey, byte[] encryptedData, Key digitalSignatureKey, EncryptorUtil.EncryptionMeta meta, String md5Algorithm)
static void	decrypt(Key asymmetricKey, SecretKey symmetricKey, String encryptedFileName, String plainDataFileName, Key digitalSignatureKey, EncryptorUtil.EncryptionMeta meta)	decrypt large file
static void	decrypt(Key asymmetricKey, SecretKey symmetricKey, String encryptedFileName, String plainDataFileName, Key digitalSignatureKey, EncryptorUtil.EncryptionMeta meta, String md5Algorithm)
static byte[]	decrypt(SecretKey symmetricKey, byte[] encryptedLibraryBytes)
static byte[]	decrypt(SecretKey symmetricKey, byte[] iv, byte[] encryptedData)
static byte[]	encrypt(Key asymmetricKey, byte[] in)
static byte[]	encrypt(Key asymmetricKey, SecretKey symmetricKey, byte[] plainData, Key digitalSignatureKey)	encrypt data in RAM
static byte[]	encrypt(Key asymmetricKey, SecretKey symmetricKey, byte[] plainData, Key digitalSignatureKey, String md5Algorithm)
static void	encrypt(Key asymmetricKey, SecretKey symmetricKey, String plainDataFileName, String encryptedFileName, Key digitalSignatureKey)	encrypt large file
static void	encrypt(Key asymmetricKey, SecretKey symmetricKey, String plainDataFileName, String encryptedFileName, Key digitalSignatureKey, String md5Algorithm)
static byte[]	encrypt(SecretKey symmetricKey, byte[] iv, byte[] plainData)
static void	encrypt(SecretKey symmetricKey, String plainDataFileName, String encryptedFileName)
static SecretKey	generateAESKey()
static byte[]	generateInitializationVector(int ivBytes)
static KeyPair	generateKeyPair(String keyfactoryAlgorithm, int size)	1. generate keypair: openssl genrsa -des3 -out keypair.pem 4096 2. export public key: openssl rsa -in keypair.pem -outform PEM -pubout -out public.pem 3. export private key: openssl rsa -in keypair.pem -out private_unencrypted.pem -outform PEM 4. encrypt and convert private key from PKCS#1 to PKCS#8: openssl pkcs8 -topk8 -inform PEM -outform PEM -in private_unencrypted.pem -out private.pem
static KeyPair	generateKeyPair_RSA4096()
static void	init(String applicationPwd)
static Key	keyFromString(String encodedKey, String algorithm)	HmacSHA256, HmacSHA384, HmacSHA512, AES, etc.
static String	keyToString(Key signingKey)
static KeyPair	loadKeyPair(EncryptorUtil.KeyFileType fileType, File keystoreFile, char[] keyStorePwd, String alias, char[] privateKeyPwd)
static byte[]	loadPermKey(File pemFile)
static byte[]	loadPermKey(String pemFileContent)
static PrivateKey	loadPrivateKey(byte[] pkcs8Data, String algorithm)
static PrivateKey	loadPrivateKey(File pemFile)
static PrivateKey	loadPrivateKey(File pemFile, char... password)
static PrivateKey	loadPrivateKey(File pemFile, String algorithm)
static PublicKey	loadPublicKey(EncryptorUtil.KeyFileType fileType, File publicKeyFile)
static PublicKey	loadPublicKey(EncryptorUtil.KeyFileType fileType, File publicKeyFile, String algorithm)
static SecretKey	loadSymmetricKey(byte[] symmetricKeyBytes, String symmetricKeyAlgorithm)
static SecretKey	loadSymmetricKey(String symmetricKeyFile, String symmetricKeyAlgorithm)
static PublicKey	loadX509EncodedPublicKey(byte[] permData, String algorithm)
static byte[]	md5(byte[] data)
static byte[]	md5(byte[] data, String algorithm)
static byte[]	md5(File filename)
static byte[]	md5(File filename, String algorithm)
static byte[]	md5(String text)
static String	md5ToString(byte[] md5)
static void	saveKeyToFile(Key key, File file)
static void	secureMem(char[] pwd)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AES_KEY_ALGO

public static final String AES_KEY_ALGO

See Also:

• Constant Field Values

MESSAGEDIGEST_ALGORITHM

public static final String MESSAGEDIGEST_ALGORITHM

See Also:

• Constant Field Values

RSA_KEY_ALGO

public static final String RSA_KEY_ALGO

See Also:

• Constant Field Values

ENCRYPT_ALGO

public static final String ENCRYPT_ALGO

See Also:

• Constant Field Values

RSA_CIPHER_ALGORITHM

public static final String RSA_CIPHER_ALGORITHM

See Also:

• Constant Field Values

TAG_LENGTH_BIT

public static final int TAG_LENGTH_BIT

See Also:

• Constant Field Values

IV_LENGTH_BYTE

public static final int IV_LENGTH_BYTE

See Also:

• Constant Field Values

AES_KEY_BIT

public static final int AES_KEY_BIT

See Also:

• Constant Field Values

PROVIDER

public static final org.bouncycastle.jce.provider.BouncyCastleProvider PROVIDER

Constructor Details

EncryptorUtil

public EncryptorUtil()

Method Details

keyToString

public static String keyToString(Key signingKey)

keyFromString

public static Key keyFromString(String encodedKey,
 String algorithm)

HmacSHA256, HmacSHA384, HmacSHA512, AES, etc.

Parameters:

encodedKey -

algorithm -

Returns:

buildSecretKey

public static byte[] buildSecretKey(String password)

init

public static void init(String applicationPwd)

md5

public static byte[] md5(File filename)
                  throws NoSuchAlgorithmException,
IOException

Parameters:

filename -

Returns:

Throws:

NoSuchAlgorithmException

IOException

md5

public static byte[] md5(File filename,
 String algorithm)
                  throws NoSuchAlgorithmException,
IOException

Parameters:

filename -

algorithm - MD5, SHA-1, SHA-256 or SHA3-256 see https://en.wikipedia.org/wiki/SHA-3 (section Comparison of SHA functions)

Returns:

Throws:

NoSuchAlgorithmException

IOException

md5

public static byte[] md5(String text)
                  throws UnsupportedEncodingException,
NoSuchAlgorithmException

Parameters:

text -

Returns:

Throws:

UnsupportedEncodingException

NoSuchAlgorithmException

md5

public static byte[] md5(byte[] data)
                  throws NoSuchAlgorithmException

Parameters:

data -

Returns:

Throws:

NoSuchAlgorithmException

md5

public static byte[] md5(byte[] data,
 String algorithm)
                  throws NoSuchAlgorithmException

Parameters:

data -

algorithm - MD5, SHA-1, SHA-256 or SHA3-256 see https://en.wikipedia.org/wiki/SHA-3 (section Comparison of SHA functions) (128-bit)

Returns:

Throws:

NoSuchAlgorithmException

md5ToString

public static String md5ToString(byte[] md5)

generateAESKey

public static SecretKey generateAESKey()
                                throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

loadSymmetricKey

public static SecretKey loadSymmetricKey(String symmetricKeyFile,
 String symmetricKeyAlgorithm)
                                  throws IOException

Throws:

IOException

loadSymmetricKey

public static SecretKey loadSymmetricKey(byte[] symmetricKeyBytes,
 String symmetricKeyAlgorithm)
                                  throws IOException

Throws:

IOException

generateInitializationVector

public static byte[] generateInitializationVector(int ivBytes)

buildCypher_GCM

public static Cipher buildCypher_GCM(boolean encrypt,
 SecretKey symmetricKey,
 byte[] iv)
                              throws NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

encrypt

public static byte[] encrypt(SecretKey symmetricKey,
 byte[] iv,
 byte[] plainData)
                      throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

decrypt

public static byte[] decrypt(SecretKey symmetricKey,
 byte[] iv,
 byte[] encryptedData)
                      throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

encrypt

public static void encrypt(SecretKey symmetricKey,
 String plainDataFileName,
 String encryptedFileName)
                    throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

decrypt

public static byte[] decrypt(SecretKey symmetricKey,
 byte[] encryptedLibraryBytes)
                      throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

generateKeyPair_RSA4096

public static KeyPair generateKeyPair_RSA4096()
                                       throws NoSuchAlgorithmException,
InvalidKeySpecException

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

generateKeyPair

public static KeyPair generateKeyPair(String keyfactoryAlgorithm,
 int size)
                               throws NoSuchAlgorithmException,
InvalidKeySpecException

1. generate keypair: openssl genrsa -des3 -out keypair.pem 4096 2. export public key: openssl rsa -in keypair.pem -outform PEM -pubout -out public.pem 3. export private key: openssl rsa -in keypair.pem -out private_unencrypted.pem -outform PEM 4. encrypt and convert private key from PKCS#1 to PKCS#8: openssl pkcs8 -topk8 -inform PEM -outform PEM -in private_unencrypted.pem -out private.pem

Parameters:

keyfactoryAlgorithm - - RSA(2048), EC(571)

size -

Returns:

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

saveKeyToFile

public static void saveKeyToFile(Key key,
 File file)
                          throws IOException

Throws:

IOException

secureMem

public static void secureMem(char[] pwd)

loadKeyPair

public static KeyPair loadKeyPair(EncryptorUtil.KeyFileType fileType,
 File keystoreFile,
 char[] keyStorePwd,
 String alias,
 char[] privateKeyPwd)
                           throws NoSuchAlgorithmException,
KeyStoreException,
IOException,
CertificateException,
UnrecoverableKeyException

Parameters:

fileType -

keystoreFile -

keyStorePwd -

alias -

privateKeyPwd -

Returns:

Throws:

NoSuchAlgorithmException

KeyStoreException

IOException

CertificateException

UnrecoverableKeyException

loadPublicKey

public static PublicKey loadPublicKey(EncryptorUtil.KeyFileType fileType,
 File publicKeyFile)
                               throws IOException,
NoSuchAlgorithmException,
InvalidKeySpecException,
CertificateException

Throws:

IOException

NoSuchAlgorithmException

InvalidKeySpecException

CertificateException

loadPublicKey

public static PublicKey loadPublicKey(EncryptorUtil.KeyFileType fileType,
 File publicKeyFile,
 String algorithm)
                               throws IOException,
NoSuchAlgorithmException,
InvalidKeySpecException,
CertificateException

Parameters:

fileType -

publicKeyFile -

algorithm -

Returns:

Throws:

IOException

NoSuchAlgorithmException

InvalidKeySpecException

CertificateException

loadX509EncodedPublicKey

public static PublicKey loadX509EncodedPublicKey(byte[] permData,
 String algorithm)
                                          throws NoSuchAlgorithmException,
InvalidKeySpecException

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

loadPrivateKey

public static PrivateKey loadPrivateKey(File pemFile)
                                 throws IOException,
InvalidKeySpecException,
NoSuchAlgorithmException

Throws:

IOException

InvalidKeySpecException

NoSuchAlgorithmException

loadPrivateKey

public static PrivateKey loadPrivateKey(File pemFile,
 String algorithm)
                                 throws IOException,
InvalidKeySpecException,
NoSuchAlgorithmException

Throws:

IOException

InvalidKeySpecException

NoSuchAlgorithmException

loadPrivateKey

public static PrivateKey loadPrivateKey(byte[] pkcs8Data,
 String algorithm)
                                 throws InvalidKeySpecException,
NoSuchAlgorithmException

Throws:

InvalidKeySpecException

NoSuchAlgorithmException

loadPrivateKey

public static PrivateKey loadPrivateKey(File pemFile,
 char... password)
                                 throws IOException,
org.bouncycastle.operator.OperatorCreationException,
GeneralSecurityException

Throws:

IOException

org.bouncycastle.operator.OperatorCreationException

GeneralSecurityException

loadPermKey

public static byte[] loadPermKey(File pemFile)
                          throws InvalidKeySpecException,
IOException

Throws:

InvalidKeySpecException

IOException

loadPermKey

public static byte[] loadPermKey(String pemFileContent)
                          throws InvalidKeySpecException

Throws:

InvalidKeySpecException

asymmetric

protected static byte[] asymmetric(int cipherMode,
 Key asymmetricKey,
 byte[] in)
                            throws NoSuchAlgorithmException,
InvalidKeyException,
NoSuchPaddingException,
IllegalBlockSizeException,
BadPaddingException

Parameters:

cipherMode - Cipher.ENCRYPT_MODE(1) or Cipher.DECRYPT_MODE(2)

asymmetricKey -

in -

Returns:

Throws:

NoSuchAlgorithmException

InvalidKeyException

NoSuchPaddingException

IllegalBlockSizeException

BadPaddingException

encrypt

public static byte[] encrypt(Key asymmetricKey,
 byte[] in)
                      throws NoSuchAlgorithmException,
InvalidKeyException,
NoSuchPaddingException,
IllegalBlockSizeException,
BadPaddingException

Throws:

NoSuchAlgorithmException

InvalidKeyException

NoSuchPaddingException

IllegalBlockSizeException

BadPaddingException

decrypt

public static byte[] decrypt(Key asymmetricKey,
 byte[] in)
                      throws NoSuchAlgorithmException,
InvalidKeyException,
NoSuchPaddingException,
IllegalBlockSizeException,
BadPaddingException

Throws:

NoSuchAlgorithmException

InvalidKeyException

NoSuchPaddingException

IllegalBlockSizeException

BadPaddingException

encrypt

public static void encrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 String plainDataFileName,
 String encryptedFileName,
 Key digitalSignatureKey)
                    throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

encrypt large file

Parameters:

asymmetricKey - symmetric encryption will be used if null

symmetricKey - encrypt with random session key if null

plainDataFileName -

encryptedFileName -

digitalSignatureKey - - to sign the digital signature if not null

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

encrypt

public static void encrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 String plainDataFileName,
 String encryptedFileName,
 Key digitalSignatureKey,
 String md5Algorithm)
                    throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Parameters:

asymmetricKey -

symmetricKey -

plainDataFileName -

encryptedFileName -

digitalSignatureKey -

md5Algorithm - MD5, SHA-1, SHA-256 or SHA3-256 see https://en.wikipedia.org/wiki/SHA-3 (section Comparison of SHA functions)

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

encrypt

public static byte[] encrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 byte[] plainData,
 Key digitalSignatureKey)
                      throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

encrypt data in RAM

Parameters:

asymmetricKey - symmetric encryption will be used if null

symmetricKey - encrypt with random session key if null

plainData -

digitalSignatureKey - - to sign the digital signature if not null

Returns:

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

encrypt

public static byte[] encrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 byte[] plainData,
 Key digitalSignatureKey,
 String md5Algorithm)
                      throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Parameters:

asymmetricKey -

symmetricKey -

plainData -

digitalSignatureKey -

md5Algorithm - MD5, SHA-1, SHA-256 or SHA3-256 see https://en.wikipedia.org/wiki/SHA-3 (section Comparison of SHA functions)

Returns:

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

decrypt

public static void decrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 String encryptedFileName,
 String plainDataFileName,
 Key digitalSignatureKey,
 @Nullable
 EncryptorUtil.EncryptionMeta meta)
                    throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

decrypt large file

Parameters:

asymmetricKey - symmetric decryption if null

symmetricKey - decrypt with asymmetric encrypted random session key if null

encryptedFileName -

plainDataFileName -

digitalSignatureKey - - to verify the digital signature if not null

meta -

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

decrypt

public static void decrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 String encryptedFileName,
 String plainDataFileName,
 Key digitalSignatureKey,
 @Nullable
 EncryptorUtil.EncryptionMeta meta,
 String md5Algorithm)
                    throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Parameters:

asymmetricKey -

symmetricKey -

encryptedFileName -

plainDataFileName -

digitalSignatureKey -

meta -

md5Algorithm - MD5, SHA-1, SHA-256 or SHA3-256 see https://en.wikipedia.org/wiki/SHA-3 (section Comparison of SHA functions)

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

decrypt

public static byte[] decrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 byte[] encryptedData,
 Key digitalSignatureKey,
 @Nullable
 EncryptorUtil.EncryptionMeta meta)
                      throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

decrypt data in RAM

Parameters:

asymmetricKey - symmetric decryption if null

symmetricKey - decrypt with asymmetric encrypted random session key if null

encryptedData -

digitalSignatureKey - - to verify the digital signature if not null

meta -

Returns:

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException

decrypt

public static byte[] decrypt(Key asymmetricKey,
 SecretKey symmetricKey,
 byte[] encryptedData,
 Key digitalSignatureKey,
 @Nullable
 EncryptorUtil.EncryptionMeta meta,
 String md5Algorithm)
                      throws IOException,
NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
InvalidAlgorithmParameterException,
IllegalBlockSizeException,
BadPaddingException

Parameters:

asymmetricKey -

symmetricKey -

encryptedData -

digitalSignatureKey -

meta -

md5Algorithm - MD5, SHA-1, SHA-256 or SHA3-256 see https://en.wikipedia.org/wiki/SHA-3 (section Comparison of SHA functions)

Returns:

Throws:

IOException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

IllegalBlockSizeException

BadPaddingException