org.antfarmer.ejce.parameter

Interface AlgorithmParameters<T extends AlgorithmParameters<T>>

Type Parameters:

T - the concrete type of this object

All Known Subinterfaces:

AsymmetricAlgorithmParameters<T>, SymmetricAlgorithmParameters<T>

All Known Implementing Classes:

Abstract128BitBlockCipherParameters, AbstractAlgorithmParameters, AbstractAsymmetricAlgorithmParameters, AbstractBlockCipherParameters, AbstractStreamCipherParameters, AbstractSymmetricAlgorithmParameters, AesParameters, BlowfishParameters, CamelliaParameters, DesEdeParameters, DesParameters, ElGamalParameters, PbeParameters, Rc2Parameters, Rc4Parameters, Rc5Parameters, Rc6Parameters, RsaParameters, SerpentParameters, TeaParameters, TwofishParameters, XteaParameters

public interface AlgorithmParameters<T extends AlgorithmParameters<T>>

Interface for initializing encryption algorithms.

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.
byte[]	generateParameterSpecData() Generates a byte array which holds algorithm parameters such as an initialization vector or salt.
String	getAlgorithm() Returns the algorithm value.
Key	getDecryptionKey() Returns the key used for decryption.
Key	getEncryptionKey() Returns the key used for encryption.
int	getKeySize() Returns the size of the key to be generated in bits.
String	getMacAlgorithm() Returns the macAlgorithm value.
Key	getMacKey() Returns the macKey.
int	getMacKeySize() Returns the size of the MAC key to be generated in bits.
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.
Provider	getProvider() Returns the Java Security Provider.
String	getProviderName() Returns the Java Security Provider name.
String	getTransformation() Returns the transformation value.
T	setKeySize(int keySize) Sets the size of the key in bits to be generated during initialization.
T	setMacAlgorithm(String macAlgorithm) Sets the macAlgorithm value.
T	setMacKey(byte[] macKey) Sets the raw byte array of the MAC key.
T	setMacKey(Key macKey) Sets the macKey.
T	setMacKey(String macKey) Sets the macKey.
T	setMacKeyLoader(Object macKeyLoader) Sets the KeyLoader, which is used to load the cipher key for the MAC.
T	setMacKeySize(int macKeySize) Sets the size of the MAC key in bits to be generated during initialization.
T	setProvider(Provider provider) Sets the Java Security Provider.
T	setProviderName(String providerName) Sets the Java Security Provider name.
T	setSaltGenerator(SaltGenerator saltGenerator) Sets the SaltGenerator, which allows for custom salt data generation.
T	setSaltMatcher(SaltMatcher saltMatcher) Sets the SaltMatcher, which may be used to verify the salt within the cipher text matches some expected value.

Method Detail

getAlgorithm

String getAlgorithm()

Returns the algorithm value.

Returns:

the algorithm.

getTransformation

String getTransformation()

Returns the transformation value.

Returns:

the transformation.

getEncryptionKey

Key getEncryptionKey()
              throws GeneralSecurityException

Returns the key used for encryption.

Returns:

the key used for encryption.

Throws:

GeneralSecurityException - GeneralSecurityException

getDecryptionKey

Key getDecryptionKey()
              throws GeneralSecurityException

Returns the key used for decryption.

Returns:

the key used for decryption.

Throws:

GeneralSecurityException - GeneralSecurityException

generateParameterSpecData

byte[] generateParameterSpecData()

Generates a byte array which holds algorithm parameters such as an initialization vector or salt.

Returns:

an array of bytes which holds algorithm parameters

createParameterSpec

AlgorithmParameterSpec createParameterSpec(byte[] parameterData)

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

Parameters:

parameterData - the data for the AlgorithmParameterSpec

Returns:

an algorithm-specific AlgorithmParameterSpec object

getParameterSpec

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.

Parameters:

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

Returns:

an algorithm-specific AlgorithmParameterSpec object

Throws:

GeneralSecurityException - GeneralSecurityException

getParameterSpecSize

int getParameterSpecSize()

Returns the algorithm parameter data size.

Returns:

the algorithm parameter data size.

getKeySize

int getKeySize()

Returns the size of the key to be generated in bits.

Returns:

the keySize.

setKeySize

T setKeySize(int keySize)

Sets the size of the key in bits to be generated during initialization. This value is only used if the key has not been set.

Parameters:

keySize - The keySize to set.

Returns:

this concrete class

getMacKeySize

int getMacKeySize()

Returns the size of the MAC key to be generated in bits.

Returns:

the macKeySize.

setMacKeySize

T setMacKeySize(int macKeySize)

Sets the size of the MAC key in bits to be generated during initialization. This value is only used if the MAC key has not been set.

Parameters:

macKeySize - The macKeySize to set.

Returns:

this concrete class

getMacKey

Key getMacKey()
       throws GeneralSecurityException

Returns the macKey.

Returns:

the macKey.

Throws:

GeneralSecurityException - GeneralSecurityException

setMacKey

T setMacKey(byte[] macKey)

Sets the raw byte array of the MAC key.

Parameters:

macKey - The macKey to set.

Returns:

this concrete class

setMacKey

T setMacKey(String macKey)

Sets the macKey. If a text encoder has been set, the text will first be decoded, otherwise the raw bytes of the string will be used as the MAC key.

Parameters:

macKey - The macKey to set.

Returns:

this concrete class

setMacKey

T setMacKey(Key macKey)

Sets the macKey.

Parameters:

macKey - The macKey to set.

Returns:

this concrete class

getMacAlgorithm

String getMacAlgorithm()

Returns the macAlgorithm value.

Returns:

the macAlgorithm.

setMacAlgorithm

T setMacAlgorithm(String macAlgorithm)

Sets the macAlgorithm value.

Parameters:

macAlgorithm - The macAlgorithm to set.

Returns:

this concrete class

getProviderName

String getProviderName()

Returns the Java Security Provider name.

Returns:

the providerName.

setProviderName

T setProviderName(String providerName)

Sets the Java Security Provider name.

Parameters:

providerName - The providerName to set.

Returns:

this concrete class

getProvider

Provider getProvider()

Returns the Java Security Provider.

Returns:

the provider.

setProvider

T setProvider(Provider provider)

Sets the Java Security Provider.

Parameters:

provider - The provider to set.

Returns:

this concrete class

setMacKeyLoader

T setMacKeyLoader(Object macKeyLoader)

Sets the KeyLoader, which is used to load the cipher key for the MAC. The value may either be the full class name of a KeyLoader implementation or an actual KeyLoader instance.

Parameters:

macKeyLoader - The macKeyLoader to set.

Returns:

this concrete class

setSaltGenerator

T setSaltGenerator(SaltGenerator saltGenerator)

Sets the SaltGenerator, which allows for custom salt data generation.

Parameters:

saltGenerator - the saltGenerator to set

Returns:

this concrete class

setSaltMatcher

T setSaltMatcher(SaltMatcher saltMatcher)

Sets the SaltMatcher, which may be used to verify the salt within the cipher text matches some expected value.

Parameters:

saltMatcher - the saltMatcher to set

Returns:

this concrete class