com.austinv11.collectiveframework.utils.security

Class Encryption

java.lang.Object

com.austinv11.collectiveframework.utils.security.Encryption

public final class Encryption
extends java.lang.Object

This class simplifies and attempts to merge all java cipher/encryption apis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Encryption.EncryptionType Eases the management of algorithms, modes, and padding See http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#Cipher for a description of each.

Constructor Summary

Constructors

Constructor and Description
Encryption()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	base64Decode(java.lang.String string) Performs a base 64 decoding on a string
static java.lang.String	base64Decode(java.lang.String string, java.lang.String encoding) Performs a base 64 decoding on a string
static java.lang.String	base64Encode(java.lang.String string) Performs a base 64 encoding on a string
static java.lang.String	base64Encode(java.lang.String string, java.lang.String encoding) Performs a base 64 encoding on a string
static SecretValue<java.lang.String,byte[],java.lang.Integer>	decrypt(java.lang.String string, int encryptionLength, java.lang.String algorithm, byte[] key, byte[] initializationVector) Decrypts a value
static SecretValue<java.lang.String,byte[],java.lang.Integer>	encrypt(java.lang.String string, java.lang.String algorithm, byte[] key, byte[] initializationVector) Encrypts a value
static <V,K,M> K	getKey(SecretValue<V,K,M> value) Gets the key of the SecretValue
static <V,K,M> M	getMeta(SecretValue<V,K,M> value) Gets the metadata of the SecretValue
static <V,K,M> V	getValue(SecretValue<V,K,M> value) Gets the value of the SecretValue
static <V,K,M> SecretValue<V,K,M>	newSecretValue(V value, K key, M meta) Creates a new secret value
static <V,K,M> SecretValue<V,K,M>	newSecretValue(V value, K key, M meta, boolean isCallerSensitive) Creates a new secret value with the approved caller as the caller of this method
static <V,K,M> SecretValue<V,K,M>	newSecretValue(V value, K key, M meta, boolean isCallerSensitive, java.lang.String approvedCaller) Creates a new secret value

Methods inherited from class java.lang.Object

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

Constructor Detail

Encryption

public Encryption()

Method Detail

encrypt

public static SecretValue<java.lang.String,byte[],java.lang.Integer> encrypt(java.lang.String string,
                                                             java.lang.String algorithm,
                                                             byte[] key,
                                                             byte[] initializationVector)
                                                                      throws javax.crypto.NoSuchPaddingException,
                                                                             java.security.NoSuchAlgorithmException,
                                                                             java.security.InvalidAlgorithmParameterException,
                                                                             java.security.InvalidKeyException,
                                                                             javax.crypto.ShortBufferException,
                                                                             javax.crypto.IllegalBlockSizeException,
                                                                             javax.crypto.BadPaddingException

Encrypts a value

Parameters:

string - The string to encrypt

algorithm - The algorithm, mode and padding to use

key - The key

initializationVector - The initialization vector

Returns:

The value, use getValue(SecretValue) to get the encrypted value and getMeta(SecretValue) to get the length of the encryption

Throws:

javax.crypto.NoSuchPaddingException

java.security.NoSuchAlgorithmException

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

javax.crypto.ShortBufferException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

decrypt

public static SecretValue<java.lang.String,byte[],java.lang.Integer> decrypt(java.lang.String string,
                                                             int encryptionLength,
                                                             java.lang.String algorithm,
                                                             byte[] key,
                                                             byte[] initializationVector)
                                                                      throws javax.crypto.NoSuchPaddingException,
                                                                             java.security.NoSuchAlgorithmException,
                                                                             java.security.InvalidAlgorithmParameterException,
                                                                             java.security.InvalidKeyException,
                                                                             javax.crypto.ShortBufferException,
                                                                             javax.crypto.IllegalBlockSizeException,
                                                                             javax.crypto.BadPaddingException

Decrypts a value

Parameters:

string - The encrypted string

encryptionLength - The length of the encryption

algorithm - The algorithm, mode and padding to use

key - The key

initializationVector - The initialization vector

Returns:

The value, use getValue(SecretValue) to get the decrypted value and getMeta(SecretValue) to get the length of the decryption

Throws:

javax.crypto.NoSuchPaddingException

java.security.NoSuchAlgorithmException

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

javax.crypto.ShortBufferException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

newSecretValue

public static <V,K,M> SecretValue<V,K,M> newSecretValue(V value,
                                        K key,
                                        M meta,
                                        boolean isCallerSensitive,
                                        java.lang.String approvedCaller)

Creates a new secret value

Parameters:

value - The value

key - The key

meta - Any metadata

isCallerSensitive - Set this to true to limit callers (if supported on the JDK)

approvedCaller - The only class allowed to retrieve info from it

Returns:

The secret value

newSecretValue

public static <V,K,M> SecretValue<V,K,M> newSecretValue(V value,
                                        K key,
                                        M meta,
                                        boolean isCallerSensitive)

Creates a new secret value with the approved caller as the caller of this method

Parameters:

value - The value

key - The key

meta - Any metadata

isCallerSensitive - Set this to true to limit callers (if supported on the JDK)

Returns:

The secret value

newSecretValue

public static <V,K,M> SecretValue<V,K,M> newSecretValue(V value,
                                        K key,
                                        M meta)

Creates a new secret value

Parameters:

value - The value

key - The key

meta - Any metadata

Returns:

The secret value

getValue

public static <V,K,M> V getValue(SecretValue<V,K,M> value)

Gets the value of the SecretValue

Parameters:

value - The SecretValue

Returns:

The value

getKey

public static <V,K,M> K getKey(SecretValue<V,K,M> value)

Gets the key of the SecretValue

Parameters:

value - The SecretValue

Returns:

The key

getMeta

public static <V,K,M> M getMeta(SecretValue<V,K,M> value)

Gets the metadata of the SecretValue

Parameters:

value - The SecretValue

Returns:

The metadata

base64Encode

public static java.lang.String base64Encode(java.lang.String string,
                            java.lang.String encoding)
                                     throws java.lang.UnsupportedOperationException,
                                            java.io.UnsupportedEncodingException

Performs a base 64 encoding on a string

Parameters:

string - The string to encode

encoding - The encoding of the string

Returns:

Encoded string

Throws:

java.lang.UnsupportedOperationException - Thrown if the sun package isn't found (i.e. when running with OpenJDK)

java.io.UnsupportedEncodingException

base64Encode

public static java.lang.String base64Encode(java.lang.String string)
                                     throws java.lang.UnsupportedOperationException,
                                            java.io.UnsupportedEncodingException

Performs a base 64 encoding on a string

Parameters:

string - The string to encode

Returns:

Encoded string

Throws:

java.lang.UnsupportedOperationException - Thrown if the sun package isn't found (i.e. when running with OpenJDK)

java.io.UnsupportedEncodingException

base64Decode

public static java.lang.String base64Decode(java.lang.String string,
                            java.lang.String encoding)
                                     throws java.lang.UnsupportedOperationException,
                                            java.io.IOException

Performs a base 64 decoding on a string

Parameters:

string - The string to encode

encoding - The encoding of the string

Returns:

Decoded string

Throws:

java.lang.UnsupportedOperationException - Thrown if the sun package isn't found (i.e. when running with OpenJDK)

java.io.IOException

base64Decode

public static java.lang.String base64Decode(java.lang.String string)
                                     throws java.lang.UnsupportedOperationException,
                                            java.io.IOException

Performs a base 64 decoding on a string

Parameters:

string - The string to encode

Returns:

Decoded string

Throws:

java.lang.UnsupportedOperationException - Thrown if the sun package isn't found (i.e. when running with OpenJDK)

java.io.IOException