com.ignaciosandoval.utils.security

Class EncryptUtil

java.lang.Object

com.ignaciosandoval.utils.security.EncryptUtil

public class EncryptUtil
extends java.lang.Object

Utility class to encrypt and decrypt a text or file using the Advanced Encryption Standard algorithm with the Galois/Counter Mode and No Padding (AES/GCM/NoPadding).

The Key is being generated using the Password-based-Key-Derivative-Function with Keyed-Hash Message Authentication Code and Secure Hash Algorithm 1 (PBKDF2WithHmacSHA1).

Version:

2.0

Author:

iasandoval

Constructor Summary

Constructors

Constructor and Description
EncryptUtil(java.lang.String key) Default constructor.

Method Summary

Modifier and Type	Method and Description
EncryptUtil	decrypt(byte[] dataToDecrypt) Chained method used to Decrypt the provided Data (byte[]).
EncryptUtil	decrypt(java.io.File fileToDecrypt) Chained method used to Decrypt the provided File object.
EncryptUtil	decrypt(java.nio.file.Path pathToDecrypt) Chained method used to Decrypt the provided Path object.
EncryptUtil	decrypt(java.lang.String textToDecrypt) Chained method used to Decrypt the provided text.
EncryptUtil	encrypt(byte[] dataToEncrypt) Chained method used to Encrypt the provided Data (byte[]).
EncryptUtil	encrypt(java.io.File fileToEncrypt) Chained method used to Encrypt the provided File object.
EncryptUtil	encrypt(java.nio.file.Path pathToEncrypt) Chained method used to Encrypt the provided Path object.
EncryptUtil	encrypt(java.lang.String textToEncrypt) Chained method used to Encrypt the provided text.
byte[]	getBytes() This method will return the encrypted/decrypted data.
java.lang.String	toString() This method will use the encrypted/decrypted data (bytes[]) to convert it to a String representation.
void	writeFile() This method will write the encrypted/decrypted data (byte[]) into the provided File.
static void	writeFile(byte[] fileBytes, java.io.File file) Helper method to write the data in the provided File.
static void	writeFile(byte[] fileBytes, java.nio.file.Path path) Helper method to write the data in the provided Path.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptUtil

public EncryptUtil(java.lang.String key)

Default constructor. It will use the provided KEY.

Parameters:

key - The Key to Encrypt/Decrypt the data.

Method Detail

writeFile

public static void writeFile(byte[] fileBytes,
                             java.io.File file)
                      throws java.io.IOException

Helper method to write the data in the provided File.

Parameters:

fileBytes - The data to write.

file - The file to write the data.

Throws:

java.io.IOException - In case of IOException.

writeFile

public static void writeFile(byte[] fileBytes,
                             java.nio.file.Path path)
                      throws java.io.IOException

Helper method to write the data in the provided Path.

Parameters:

fileBytes - The data to write.

path - The Path to write the data.

Throws:

java.io.IOException - In case of IOException.

encrypt

public EncryptUtil encrypt(java.lang.String textToEncrypt)
                    throws EncryptUtilException

Chained method used to Encrypt the provided text.

Parameters:

textToEncrypt - Text to encrypt.

Returns:

An EncryptUtil object with the bytes[] set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

decrypt

public EncryptUtil decrypt(java.lang.String textToDecrypt)
                    throws EncryptUtilException

Chained method used to Decrypt the provided text.

Parameters:

textToDecrypt - Text to decrypt.

Returns:

An EncryptUtil object with the bytes[] set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

encrypt

public EncryptUtil encrypt(java.nio.file.Path pathToEncrypt)
                    throws EncryptUtilException

Chained method used to Encrypt the provided Path object.

Parameters:

pathToEncrypt - The Path with the file location to encrypt.

Returns:

An EncryptUtil object with the data (byte[]) and Path object set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

decrypt

public EncryptUtil decrypt(java.nio.file.Path pathToDecrypt)
                    throws EncryptUtilException

Chained method used to Decrypt the provided Path object.

Parameters:

pathToDecrypt - The Path with the file location to decrypt.

Returns:

An EncryptUtil object with the data (byte[]) and Path object set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

encrypt

public EncryptUtil encrypt(java.io.File fileToEncrypt)
                    throws EncryptUtilException

Chained method used to Encrypt the provided File object.

Parameters:

fileToEncrypt - The File object with the location to encrypt.

Returns:

An EncryptUtil object with the data (byte[]) and Path object set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

decrypt

public EncryptUtil decrypt(java.io.File fileToDecrypt)
                    throws EncryptUtilException

Chained method used to Decrypt the provided File object.

Parameters:

fileToDecrypt - The File object with the location to decrypt.

Returns:

An EncryptUtil object with the data (byte[]) and Path object set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

encrypt

public EncryptUtil encrypt(byte[] dataToEncrypt)
                    throws EncryptUtilException

Chained method used to Encrypt the provided Data (byte[]).

Parameters:

dataToEncrypt - The Data (byte[]) to encrypt.

Returns:

An EncryptUtil object with the data (byte[]) set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

decrypt

public EncryptUtil decrypt(byte[] dataToDecrypt)
                    throws EncryptUtilException

Chained method used to Decrypt the provided Data (byte[]).

Parameters:

dataToDecrypt - The Data (byte[]) to encrypt.

Returns:

An EncryptUtil object with the data (byte[]) set.

Throws:

EncryptUtilException - In case of EncryptUtilException.

toString

public java.lang.String toString()

This method will use the encrypted/decrypted data (bytes[]) to convert it to a String representation. For Encrypted data, will encode the data to Base64. For Decrypted data, will encode the data in UTF-8.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of the encrypted data (bytes[]).

getBytes

public byte[] getBytes()

This method will return the encrypted/decrypted data.

Returns:

The encrypted/decrypted data.

writeFile

public void writeFile()
               throws java.io.IOException

This method will write the encrypted/decrypted data (byte[]) into the provided File.

Throws:

java.io.IOException - In case of IOException.