org.antfarmer.ejce.parameter

Class PbeParameters

java.lang.Object

org.antfarmer.ejce.parameter.AbstractAlgorithmParameters<T>

org.antfarmer.ejce.parameter.AbstractSymmetricAlgorithmParameters<T>

org.antfarmer.ejce.parameter.AbstractBlockCipherParameters<PbeParameters>

org.antfarmer.ejce.parameter.PbeParameters

All Implemented Interfaces:

AlgorithmParameters<PbeParameters>, SymmetricAlgorithmParameters<PbeParameters>

public class PbeParameters
extends AbstractBlockCipherParameters<PbeParameters>

AlgorithmParameters object used for PBE (Password-Based Encryption).

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM_PBE_MD5_DES Algorithm for PBEWithMD5AndDES encryption.
static String	ALGORITHM_PBE_SHA1_DES_EDE Algorithm for PBEWithHmacSHA1AndDESede encryption.
static int	DEFAULT_ITERATION_COUNT Default number of PBE iterations.
static int	DEFAULT_PASSWORD_SIZE Default size of randomly generated passwords in bytes.
static int	DEFAULT_SALT_SIZE Default size of salt array in bytes.

Fields inherited from class org.antfarmer.ejce.parameter.AbstractBlockCipherParameters

BLOCK_MODE_CBC, BLOCK_MODE_CCM, BLOCK_MODE_CFB, BLOCK_MODE_CTR, BLOCK_MODE_CTS, BLOCK_MODE_ECB, BLOCK_MODE_GCM, BLOCK_MODE_OFB, BLOCK_MODE_PCBC, DEFAULT_BLOCK_SIZE, DEFAULT_PARAM_SPEC_SIZE_GCM, GCM_AUTH_TAG_LEN_104, GCM_AUTH_TAG_LEN_112, GCM_AUTH_TAG_LEN_120, GCM_AUTH_TAG_LEN_128, GCM_AUTH_TAG_LEN_96, PADDING_NONE, PADDING_PKCS5, PADDING_PKCS7

Fields inherited from class org.antfarmer.ejce.parameter.AbstractAlgorithmParameters

KEY_SIZE_128, KEY_SIZE_192, KEY_SIZE_256, MAC_ALGORITHM_HMAC_MD5, MAC_ALGORITHM_HMAC_SHA1, MAC_ALGORITHM_HMAC_SHA224, MAC_ALGORITHM_HMAC_SHA256, MAC_ALGORITHM_HMAC_SHA3_224, MAC_ALGORITHM_HMAC_SHA3_256, MAC_ALGORITHM_HMAC_SHA3_384, MAC_ALGORITHM_HMAC_SHA3_512, MAC_ALGORITHM_HMAC_SHA384, MAC_ALGORITHM_HMAC_SHA512, MAC_ALGORITHM_HMAC_SHA512_224, MAC_ALGORITHM_HMAC_SHA512_256, MAC_KEY_SIZE_128, MAC_KEY_SIZE_160

Constructor Summary

Constructors

Constructor and Description
PbeParameters() Initializes the PbeParameters.
PbeParameters(TextEncoder textEncoder) Initializes the PbeParameters with a TextEncoder which is used to decode the key when set as a string.

Method Summary

Modifier and Type	Method and Description
AlgorithmParameterSpec	createParameterSpec(byte[] parameterData) Generates an algorithm-specific AlgorithmParameterSpec object used to hold algorithm parameters such as an initialization vector or salt.
protected byte[]	generateKeyData(String algorithm) Returns a randomly generated byte array used to create a key.
protected String	getDefaultAlgorithm() Returns the defaultAlgorithm.
int	getIterationCount() Returns the iterationCount value.
AlgorithmParameterSpec	getParameterSpec(byte[] messageData) Returns an algorithm-specific AlgorithmParameterSpec object used to hold algorithm parameters such as an initialization vector or salt from the enciphered message.
int	getParameterSpecSize() Returns the algorithm parameter data size.
int	getSaltSize() Returns the saltSize value.
String	getTransformation() Returns the transformation value.
PbeParameters	setAlgorithm(String algorithm) Sets the algorithm value.
PbeParameters	setIterationCount(int iterationCount) Sets the iterationCount value.
PbeParameters	setSaltSize(int saltSize) Sets the saltSize value.

Methods inherited from class org.antfarmer.ejce.parameter.AbstractBlockCipherParameters

getBlockMode, getBlockSize, getDefaultBlockSize, getGcmTagLen, getPadding, setBlockMode, setBlockSize, setGcmTagLen, setPadding

Methods inherited from class org.antfarmer.ejce.parameter.AbstractSymmetricAlgorithmParameters

getDecryptionKey, getKey, loadKey, setKey, setKey, setKey, setKeyLoader

Methods inherited from class org.antfarmer.ejce.parameter.AbstractAlgorithmParameters

generateParameterSpecData, getAlgorithm, getDefaultKeySize, getEncryptionKey, getKeySize, getMacAlgorithm, getMacKey, getMacKeySize, getProvider, getProviderName, hasDecryptionKey, hasEncryptionKey, parseAndVerifySalt, setDecryptionKey, setDecryptionKey, setDecryptionKey, setDecryptionKeyLoader, setEncryptionKey, setEncryptionKey, setEncryptionKey, setEncryptionKeyLoader, setKeySize, setMacAlgorithm, setMacKey, setMacKey, setMacKey, setMacKeyLoader, setMacKeySize, setProvider, setProviderName, setSaltGenerator, setSaltMatcher

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.antfarmer.ejce.parameter.AlgorithmParameters

generateParameterSpecData, getAlgorithm, getEncryptionKey, getKeySize, getMacAlgorithm, getMacKey, getMacKeySize, getProvider, getProviderName, setKeySize, setMacAlgorithm, setMacKey, setMacKey, setMacKey, setMacKeyLoader, setMacKeySize, setProvider, setProviderName, setSaltGenerator, setSaltMatcher

Field Detail

ALGORITHM_PBE_MD5_DES

public static final String ALGORITHM_PBE_MD5_DES

Algorithm for PBEWithMD5AndDES encryption.

See Also:

Constant Field Values

ALGORITHM_PBE_SHA1_DES_EDE

public static final String ALGORITHM_PBE_SHA1_DES_EDE

Algorithm for PBEWithHmacSHA1AndDESede encryption.

See Also:

Constant Field Values

DEFAULT_SALT_SIZE

public static final int DEFAULT_SALT_SIZE

Default size of salt array in bytes. The default value is 8.

See Also:

Constant Field Values

DEFAULT_ITERATION_COUNT

public static final int DEFAULT_ITERATION_COUNT

Default number of PBE iterations. The default value is 500.

See Also:

Constant Field Values

DEFAULT_PASSWORD_SIZE

public static final int DEFAULT_PASSWORD_SIZE

Default size of randomly generated passwords in bytes. The default value is 20.

See Also:

Constant Field Values

Constructor Detail

PbeParameters

public PbeParameters()

Initializes the PbeParameters. The default transformation is 'PBEWithMD5AndDES'.

PbeParameters

public PbeParameters(TextEncoder textEncoder)

Initializes the PbeParameters with a TextEncoder which is used to decode the key when set as a string. The default transformation is 'PBEWithMD5AndDES'.

Parameters:

textEncoder - the TextEncoder

Method Detail

setAlgorithm

public PbeParameters setAlgorithm(String algorithm)

Sets the algorithm value.

Overrides:

setAlgorithm in class AbstractAlgorithmParameters<PbeParameters>

Parameters:

algorithm - The algorithm to set.

Returns:

this concrete class

getDefaultAlgorithm

protected String getDefaultAlgorithm()

Returns the defaultAlgorithm.

Specified by:

getDefaultAlgorithm in class AbstractAlgorithmParameters<PbeParameters>

Returns:

the defaultAlgorithm

getTransformation

public String getTransformation()

Returns the transformation value.

Specified by:

getTransformation in interface AlgorithmParameters<PbeParameters>

Overrides:

getTransformation in class AbstractBlockCipherParameters<PbeParameters>

Returns:

the transformation.

getParameterSpecSize

public int getParameterSpecSize()

Returns the algorithm parameter data size.

Specified by:

getParameterSpecSize in interface AlgorithmParameters<PbeParameters>

Overrides:

getParameterSpecSize in class AbstractBlockCipherParameters<PbeParameters>

Returns:

the algorithm parameter data size.

getParameterSpec

public AlgorithmParameterSpec getParameterSpec(byte[] messageData)
                                        throws GeneralSecurityException

Returns an algorithm-specific AlgorithmParameterSpec object used to hold algorithm parameters such as an initialization vector or salt from the enciphered message.

Specified by:

getParameterSpec in interface AlgorithmParameters<PbeParameters>

Overrides:

getParameterSpec in class AbstractBlockCipherParameters<PbeParameters>

Parameters:

messageData - the message data byte array which holds the parameter data

Returns:

an algorithm-specific AlgorithmParameterSpec object

Throws:

GeneralSecurityException - GeneralSecurityException

createParameterSpec

public AlgorithmParameterSpec createParameterSpec(byte[] parameterData)

Generates an algorithm-specific AlgorithmParameterSpec object used to hold algorithm parameters such as an initialization vector or salt.

Specified by:

createParameterSpec in interface AlgorithmParameters<PbeParameters>

Overrides:

createParameterSpec in class AbstractBlockCipherParameters<PbeParameters>

Parameters:

parameterData - the data for the AlgorithmParameterSpec

Returns:

an algorithm-specific AlgorithmParameterSpec object

generateKeyData

protected byte[] generateKeyData(String algorithm)
                          throws GeneralSecurityException

Returns a randomly generated byte array used to create a key.

Overrides:

generateKeyData in class AbstractSymmetricAlgorithmParameters<PbeParameters>

Parameters:

algorithm - the algorithm for the key

Returns:

a randomly generated byte array used to create a key

Throws:

GeneralSecurityException - GeneralSecurityException

getSaltSize

public int getSaltSize()

Returns the saltSize value.

Returns:

the saltSize.

setSaltSize

public PbeParameters setSaltSize(int saltSize)

Sets the saltSize value.

Parameters:

saltSize - The saltSize to set.

Returns:

this class

getIterationCount

public int getIterationCount()

Returns the iterationCount value.

Returns:

the iterationCount.

setIterationCount

public PbeParameters setIterationCount(int iterationCount)

Sets the iterationCount value.

Parameters:

iterationCount - The iterationCount to set.

Returns:

this class