Package com.eurodyn.qlack.fuse.crypto.service

Class CryptoSymmetricService

java.lang.Object

com.eurodyn.qlack.fuse.crypto.service.CryptoSymmetricService

@Service
@Validated
public class CryptoSymmetricService
extends Object

Symmetric encryption/decryption utility methods.

Constructor Summary

Constructors

Constructor	Description
CryptoSymmetricService()

Method Summary

Modifier and Type	Method	Description
byte[]	decrypt(byte[] ciphertext, SecretKey key, byte[] iv, String cipherInstance, String keyAlgorithm)	Decrypts an encrypted message.
byte[]	decrypt(byte[] ciphertext, SecretKey key, String cipherInstance, String keyAlgorithm)	Decrypts an encrypted message prefixed with a 16 bytes IV.
void	decrypt(File encryptedFile, File plainFile, SecretKey key, byte[] iv, String cipherInstance, String keyAlgorithm)	Decrypts a file, optionally decoding an appended IV.
void	decrypt(File encryptedFile, File plainFile, SecretKey key, String cipherInstance, String keyAlgorithm)	Decrypts a file also decoding an appended IV.
void	decrypt(InputStream sourceStream, OutputStream targetStream, SecretKey key, byte[] iv, String cipherInstance, String keyAlgorithm)	Decrypts a file, optionally decoding an appended IV.
void	decrypt(InputStream sourceStream, OutputStream targetStream, SecretKey key, String cipherInstance, String keyAlgorithm)	Decrypts a file which is encrypted with a 16 byte IV prefixed.
byte[]	encrypt(byte[] plaintext, SecretKey key, byte[] iv, String cipherInstance, String keyAlgorithm, boolean prefixIv)	Encrypts a plaintext with a given IV.
byte[]	encrypt(byte[] plaintext, SecretKey key, String cipherInstance, String keyAlgorithm)	Encrypts a plaintext with an internally generated IV.
void	encrypt(File sourceFile, File targetFile, SecretKey key, byte[] iv, String cipherInstance, String keyAlgorithm, boolean prefixIv)	Encrypts a file producing an encrypted file with optionally appending the IV.
void	encrypt(File sourceFile, File targetFile, SecretKey key, String cipherInstance, String keyAlgorithm)	Encrypts a file producing an encrypted file prefixed with the internally generated IV.
void	encrypt(InputStream sourceStream, OutputStream targetStream, SecretKey key, byte[] iv, String cipherInstance, String keyAlgorithm, boolean prefixIv)	Encrypts a stream producing an encrypted stream with optionally appending the IV.
byte[]	generateIV()	Generates a random IV of 16 bytes.
byte[]	generateIV(int length)	Generates a random IV of specific length.
SecretKey	generateKey(int keyLength, String algorithm)	Generates a symmetric key.
SecretKey	generateKey(int keyLength, String algorithm, String provider)	Generates a symmetric key.
byte[]	ivFromString(String iv)	Generates the original IV from a Base64 encoded IV.
SecretKey	keyFromString(String key, String algorithm)	Generates a SecretKey from a Base64 encoded symmetric key.

Methods inherited from class java.lang.Object

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

Constructor Details

CryptoSymmetricService

public CryptoSymmetricService()

Method Details

generateKey

public SecretKey generateKey(int keyLength,
 String algorithm)
                      throws NoSuchAlgorithmException

Generates a symmetric key.

Parameters:

keyLength - the length of the key

algorithm - the algorithm to use, e.g. AES

Returns:

the generated key

Throws:

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

generateKey

public SecretKey generateKey(int keyLength,
 String algorithm,
 String provider)
                      throws NoSuchAlgorithmException,
NoSuchProviderException

Generates a symmetric key.

Parameters:

keyLength - the length of the key

algorithm - the algorithm to use, e.g. AES

provider - the provider for the algorithm, e.g. SUN

Returns:

the generated key

Throws:

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

NoSuchProviderException

keyFromString

public SecretKey keyFromString(String key,
 String algorithm)

Generates a SecretKey from a Base64 encoded symmetric key.

Parameters:

key - the Base64 encoded version of the key

algorithm - the algorithm to use, e.g. AES

Returns:

the generated secret key

generateIV

public byte[] generateIV()

Generates a random IV of 16 bytes.

Returns:

the bytes of the generated IV

generateIV

public byte[] generateIV(int length)

Generates a random IV of specific length.

Parameters:

length - the length of the IV

Returns:

the bytes of the generated IV

ivFromString

public byte[] ivFromString(String iv)

Generates the original IV from a Base64 encoded IV.

Parameters:

iv - the IV to decode

Returns:

the bytes of the decoded IV

encrypt

public byte[] encrypt(byte[] plaintext,
 SecretKey key,
 byte[] iv,
 String cipherInstance,
 String keyAlgorithm,
 boolean prefixIv)
               throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Encrypts a plaintext with a given IV.

Parameters:

plaintext - The plaintext to encrypt

key - the key to use for encryption

iv - the encryption IV

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

prefixIv - whether to prefix the IV on the return value or not

Returns:

the ciphertext optionally prefixed with the IV

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

encrypt

public byte[] encrypt(byte[] plaintext,
 SecretKey key,
 String cipherInstance,
 String keyAlgorithm)
               throws NoSuchPaddingException,
InvalidKeyException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
IOException

Encrypts a plaintext with an internally generated IV.

Parameters:

plaintext - the plaintext to encrypt

key - the key to use for encryption

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

Returns:

the ciphertext prefixed with the IV

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

encrypt

public void encrypt(File sourceFile,
 File targetFile,
 SecretKey key,
 String cipherInstance,
 String keyAlgorithm)
             throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Encrypts a file producing an encrypted file prefixed with the internally generated IV.

Parameters:

sourceFile - the source file to encrypt

targetFile - the target, encrypted file to produce

key - the key to use for encryption

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

encrypt

public void encrypt(File sourceFile,
 File targetFile,
 SecretKey key,
 byte[] iv,
 String cipherInstance,
 String keyAlgorithm,
 boolean prefixIv)
             throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Encrypts a file producing an encrypted file with optionally appending the IV.

Parameters:

sourceFile - the source file to encrypt

targetFile - the target, encrypted file to produce

key - the key to use for encryption

iv - the IV to use

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

prefixIv - whether to prefix the IV on the return value or not

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

encrypt

public void encrypt(InputStream sourceStream,
 OutputStream targetStream,
 SecretKey key,
 byte[] iv,
 String cipherInstance,
 String keyAlgorithm,
 boolean prefixIv)
             throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Encrypts a stream producing an encrypted stream with optionally appending the IV.

Parameters:

sourceStream - the source stream to encrypt

targetStream - the target, encrypted stream to populate

key - the key to use for encryption

iv - the IV to use

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

prefixIv - whether to prefix the IV on the return value or not

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

decrypt

public void decrypt(File encryptedFile,
 File plainFile,
 SecretKey key,
 String cipherInstance,
 String keyAlgorithm)
             throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Decrypts a file also decoding an appended IV.

Parameters:

encryptedFile - the encrypted file to decrypt

plainFile - the decrypted file to produce

key - the key to use for decryption

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

decrypt

public void decrypt(File encryptedFile,
 File plainFile,
 SecretKey key,
 byte[] iv,
 String cipherInstance,
 String keyAlgorithm)
             throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Decrypts a file, optionally decoding an appended IV.

Parameters:

encryptedFile - the encrypted file to decrypt

plainFile - the decrypted file to produce

key - the key to use for decryption

iv - the IV with which this file was encrypted. If left null, the IV will be decoded from the 16 first bytes of `encryptedFile`

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

decrypt

public void decrypt(InputStream sourceStream,
 OutputStream targetStream,
 SecretKey key,
 String cipherInstance,
 String keyAlgorithm)
             throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Decrypts a file which is encrypted with a 16 byte IV prefixed.

Parameters:

sourceStream - the encrypted stream to decrypt

targetStream - the decrypted stream to populate

key - the key to use for decryption. the 16 first bytes of `encryptedFile`

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

decrypt

public void decrypt(InputStream sourceStream,
 OutputStream targetStream,
 SecretKey key,
 byte[] iv,
 String cipherInstance,
 String keyAlgorithm)
             throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Decrypts a file, optionally decoding an appended IV.

Parameters:

sourceStream - the encrypted stream to decrypt

targetStream - the decrypted stream to populate

key - the key to use for decryption

iv - the IV with which this file was encrypted. If left null, the IV will be decoded from the 16 first bytes of `encryptedFile`

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

decrypt

public byte[] decrypt(byte[] ciphertext,
 SecretKey key,
 String cipherInstance,
 String keyAlgorithm)
               throws NoSuchPaddingException,
InvalidKeyException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
IOException

Decrypts an encrypted message prefixed with a 16 bytes IV.

Parameters:

ciphertext - the encrypted message to decrypt

key - the key to decrypt with

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

Returns:

the bytes of the decrypted message

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens

decrypt

public byte[] decrypt(byte[] ciphertext,
 SecretKey key,
 byte[] iv,
 String cipherInstance,
 String keyAlgorithm)
               throws NoSuchPaddingException,
NoSuchAlgorithmException,
InvalidAlgorithmParameterException,
InvalidKeyException,
IOException

Decrypts an encrypted message.

Parameters:

ciphertext - the encrypted message to decrypt

key - the key to decrypt with

cipherInstance - the cipher instance to use, e.g. "AES/CBC/PKCS5Padding"

keyAlgorithm - the algorithm for the secret key, e.g. "AES"

iv - the IV to use

Returns:

the bytes of the decrypted message

Throws:

NoSuchPaddingException - thrown when the provided cipherInstance is not valid

NoSuchAlgorithmException - thrown when no algorithm is found for encryption

InvalidAlgorithmParameterException - thrown when the found algorithm cannot be executed

InvalidKeyException - thrown when the provided key is invalid

IOException - thrown when something unexpected happens