org.antfarmer.ejce.parameter

Class AbstractAsymmetricAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

java.lang.Object

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

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

Type Parameters:

T - the concrete type of this object

All Implemented Interfaces:

AlgorithmParameters<T>, AsymmetricAlgorithmParameters<T>

Direct Known Subclasses:

ElGamalParameters, RsaParameters

public abstract class AbstractAsymmetricAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>
extends AbstractAlgorithmParameters<T>
implements AsymmetricAlgorithmParameters<T>

Abstract AsymmetricAlgorithmParameters class.

Field Summary

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

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

Method Summary

Modifier and Type	Method and Description
String	getBlockType() Returns the blockType value.
String	getPadding() Returns the padding 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.
String	getTransformation() Returns the transformation value.
protected Key	loadKey(byte[] rawKey, KeyLoader keyLoader, String algorithm) Loads a key from the given possible key sources.
T	setBlockType(String blockType) Sets the blockType value.
T	setDecryptionKey(Key decryptionKey) Sets the decryption key.
T	setDecryptionKeyLoader(Object decryptionKeyLoader) Sets the KeyLoader, which is used to load the decryption key.
T	setEncryptionKey(Key encryptionKey) Sets the encryption key.
T	setEncryptionKeyLoader(Object encryptionKeyLoader) Sets the KeyLoader, which is used to load the encryption key.
T	setPadding(String padding) Sets the padding value.

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

createParameterSpec, generateParameterSpecData, getAlgorithm, getDecryptionKey, getDefaultAlgorithm, getDefaultKeySize, getEncryptionKey, getKeySize, getMacAlgorithm, getMacKey, getMacKeySize, getProvider, getProviderName, hasDecryptionKey, hasEncryptionKey, parseAndVerifySalt, setAlgorithm, setDecryptionKey, setDecryptionKey, setEncryptionKey, setEncryptionKey, 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

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

Constructor Detail

AbstractAsymmetricAlgorithmParameters

protected AbstractAsymmetricAlgorithmParameters()

Initializes the AbstractAsymmetricAlgorithmParameters.

AbstractAsymmetricAlgorithmParameters

protected AbstractAsymmetricAlgorithmParameters(TextEncoder textEncoder)

Initializes the AbstractAsymmetricAlgorithmParameters with a TextEncoder which is used to decode the key when set as a string.

Parameters:

textEncoder - the TextEncoder

Method Detail

loadKey

protected Key loadKey(byte[] rawKey,
                      KeyLoader keyLoader,
                      String algorithm)
               throws GeneralSecurityException

Loads a key from the given possible key sources.

Specified by:

loadKey in class AbstractAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Parameters:

rawKey - the raw key bytes (may be null)

keyLoader - the keyLoader (may be null)

algorithm - the algorithm for the key

Returns:

a key from the given possible key sources

Throws:

GeneralSecurityException - GeneralSecurityException

setEncryptionKey

public T setEncryptionKey(Key encryptionKey)

Sets the encryption key.

Specified by:

setEncryptionKey in interface AsymmetricAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Overrides:

setEncryptionKey in class AbstractAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Parameters:

encryptionKey - The encryptionKey to set.

Returns:

this concrete class

setEncryptionKeyLoader

public T setEncryptionKeyLoader(Object encryptionKeyLoader)

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

Specified by:

setEncryptionKeyLoader in interface AsymmetricAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Overrides:

setEncryptionKeyLoader in class AbstractAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Parameters:

encryptionKeyLoader - The encryptionKeyLoader to set.

Returns:

this concrete class

setDecryptionKey

public T setDecryptionKey(Key decryptionKey)

Sets the decryption key.

Specified by:

setDecryptionKey in interface AsymmetricAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Overrides:

setDecryptionKey in class AbstractAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Parameters:

decryptionKey - The decryptionKey to set.

Returns:

this concrete class

setDecryptionKeyLoader

public T setDecryptionKeyLoader(Object decryptionKeyLoader)

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

Specified by:

setDecryptionKeyLoader in interface AsymmetricAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Overrides:

setDecryptionKeyLoader in class AbstractAlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Parameters:

decryptionKeyLoader - The decryptionKeyLoader to set.

Returns:

this concrete class

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<T extends AbstractAsymmetricAlgorithmParameters<T>>

Parameters:

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

Returns:

an algorithm-specific AlgorithmParameterSpec object

Throws:

GeneralSecurityException - GeneralSecurityException

getParameterSpecSize

public int getParameterSpecSize()

Returns the algorithm parameter data size.

Specified by:

getParameterSpecSize in interface AlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Returns:

the algorithm parameter data size.

getTransformation

public String getTransformation()

Returns the transformation value.

Specified by:

getTransformation in interface AlgorithmParameters<T extends AbstractAsymmetricAlgorithmParameters<T>>

Returns:

the transformation.

getBlockType

public String getBlockType()

Returns the blockType value.

Returns:

the blockType.

setBlockType

public T setBlockType(String blockType)

Sets the blockType value. Generally, possible values include: "ECB" or "None". Setting this value will have no effect unless a padding scheme is also set.

Parameters:

blockType - The blockType to set.

Returns:

this concrete instance

getPadding

public String getPadding()

Returns the padding value.

Returns:

the padding.

setPadding

public T setPadding(String padding)

Sets the padding value. Setting a padding scheme will select a block type of "ECB". If this is inappropriate, the block type value should also be set.

Parameters:

padding - The padding to set.

Returns:

this concrete instance