com.captainalm.lib.stdcrypt.encryption

Class AESPasswordRfc2898CipherFactory

java.lang.Object

com.captainalm.lib.stdcrypt.encryption.AESPasswordRfc2898CipherFactory

All Implemented Interfaces:

ICipherFactory

public class AESPasswordRfc2898CipherFactory
extends java.lang.Object
implements ICipherFactory

This class provides an AES cipher that uses Rfc2898 for key generation and a string password.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
AESPasswordRfc2898CipherFactory(java.lang.String password) Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password.
AESPasswordRfc2898CipherFactory(java.lang.String password, byte[] salt, byte[] initializationVector) Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password, salt and initialization vector.

Method Summary

Modifier and Type	Method and Description
boolean	cipherAttributesModified() Gets if the cipher settings attributes have been modified.
javax.crypto.Cipher	getCipher(int opmode) Gets a new cipher instance.
byte[]	getInitializationVector() Gets the initialization vector.
java.lang.String	getName() Gets the name of the cipher factory.
java.lang.String	getPassword() Gets the password.
byte[]	getSalt() Gets the salt in use.
byte[]	getSettings() Gets the cipher settings as a byte array.
int	getSettingsLength() Gets the length of the settings byte array.
byte[]	getSettingsNoSecrets() Gets the cipher settings as a byte array without secrets.
int	getSettingsNoSecretsLength() Gets the length of the settings byte array without secrets.
boolean	isOutputtingInitializationVector() Gets whether the InitializationVector is output.
boolean	isOutputtingSalt() Gets whether the salt is output.
void	setInitializationVector(byte[] initializationVector) Sets the initialization vector in use, set to null to generate a random initialization vector.
void	setOutputInitializationVector(boolean outputInitializationVector) Sets if the InitializationVector is output.
void	setOutputSalt(boolean outputSalt) Sets if the salt is output.
void	setPassword(java.lang.String password) Sets the password.
void	setSalt(byte[] salt) Sets the salt in use, set to null to generate a random salt.
void	setSettings(byte[] settingsIn) Sets the cipher settings using a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

AESPasswordRfc2898CipherFactory

public AESPasswordRfc2898CipherFactory(java.lang.String password)

Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password.

Parameters:

password - The password to use.

Throws:

java.lang.NullPointerException - password is null.

AESPasswordRfc2898CipherFactory

public AESPasswordRfc2898CipherFactory(java.lang.String password,
                                       byte[] salt,
                                       byte[] initializationVector)

Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password, salt and initialization vector.

Parameters:

password - The password to use.

salt - The salt to use or null.

initializationVector - The initialization vector to use or null.

Throws:

java.lang.NullPointerException - password is null.

java.lang.IllegalArgumentException - salt or initializationVector is larger than 255.

Method Detail

getCipher

public javax.crypto.Cipher getCipher(int opmode)
                              throws CipherException

Gets a new cipher instance.

Specified by:

getCipher in interface ICipherFactory

Parameters:

opmode - The Cipher Operation Mode (Cipher.ENCRYPT_MODE, Cipher.DECRYPT_MODE, Cipher.WRAP_MODE and Cipher.UNWRAP_MODE).

Returns:

The new cipher instance or null.

Throws:

CipherException - An Exception has occurred.

getName

public java.lang.String getName()

Gets the name of the cipher factory.

Specified by:

getName in interface ICipherFactory

Returns:

The name of the cipher factory.

cipherAttributesModified

public boolean cipherAttributesModified()

Gets if the cipher settings attributes have been modified. Resets the flag once checked.

Specified by:

cipherAttributesModified in interface ICipherFactory

Returns:

If the attributes have been modified.

getSettings

public byte[] getSettings()

Gets the cipher settings as a byte array.

Specified by:

getSettings in interface ICipherFactory

Returns:

The byte array of the settings.

getSettingsLength

public int getSettingsLength()

Gets the length of the settings byte array.

Specified by:

getSettingsLength in interface ICipherFactory

Returns:

The length of the settings byte array.

getSettingsNoSecrets

public byte[] getSettingsNoSecrets()

Gets the cipher settings as a byte array without secrets.

Specified by:

getSettingsNoSecrets in interface ICipherFactory

Returns:

The byte array of the settings without secrets.

getSettingsNoSecretsLength

public int getSettingsNoSecretsLength()

Gets the length of the settings byte array without secrets.

Specified by:

getSettingsNoSecretsLength in interface ICipherFactory

Returns:

The length of the settings byte array without secrets.

setSettings

public void setSettings(byte[] settingsIn)
                 throws CipherException

Sets the cipher settings using a byte array.

Specified by:

setSettings in interface ICipherFactory

Parameters:

settingsIn - The byte array to load the settings from.

Throws:

java.lang.NullPointerException - settingsIn is null.

CipherException - An Exception has occurred.

getPassword

public java.lang.String getPassword()

Gets the password.

Returns:

The password.

setPassword

public void setPassword(java.lang.String password)

Sets the password.

Parameters:

password - The new password.

Throws:

java.lang.NullPointerException - password is null.

getSalt

public byte[] getSalt()

Gets the salt in use.

Returns:

The salt.

setSalt

public void setSalt(byte[] salt)

Sets the salt in use, set to null to generate a random salt.

Parameters:

salt - The new salt or null.

Throws:

java.lang.IllegalArgumentException - salt is larger than 255.

getInitializationVector

public byte[] getInitializationVector()

Gets the initialization vector.

Returns:

The initialization vector.

setInitializationVector

public void setInitializationVector(byte[] initializationVector)

Sets the initialization vector in use, set to null to generate a random initialization vector.

Parameters:

initializationVector - The new initialization vector or null.

Throws:

java.lang.IllegalArgumentException - initializationVector is larger than 255.

isOutputtingSalt

public boolean isOutputtingSalt()

Gets whether the salt is output.

Returns:

Is the salt output.

setOutputSalt

public void setOutputSalt(boolean outputSalt)

Sets if the salt is output.

Parameters:

outputSalt - Should the salt be output.

isOutputtingInitializationVector

public boolean isOutputtingInitializationVector()

Gets whether the InitializationVector is output.

Returns:

Is the InitializationVector output.

setOutputInitializationVector

public void setOutputInitializationVector(boolean outputInitializationVector)

Sets if the InitializationVector is output.

Parameters:

outputInitializationVector - Should the InitializationVector be output.