org.antfarmer.ejce.parameter

Class AbstractSymmetricAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

java.lang.Object

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

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

Type Parameters:

T - the concrete type of this object

All Implemented Interfaces:

AlgorithmParameters<T>, SymmetricAlgorithmParameters<T>

Direct Known Subclasses:

AbstractBlockCipherParameters, AbstractStreamCipherParameters

public abstract class AbstractSymmetricAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>
extends AbstractAlgorithmParameters<T>
implements SymmetricAlgorithmParameters<T>

Abstract SymmetricAlgorithmParameters 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	AbstractSymmetricAlgorithmParameters() Initializes the AbstractSymmetricAlgorithmParameters.
protected	AbstractSymmetricAlgorithmParameters(TextEncoder textEncoder) Initializes the AbstractSymmetricAlgorithmParameters with a TextEncoder which is used to decode the key when set as a string.

Method Summary

Modifier and Type	Method and Description
protected byte[]	generateKeyData(String algorithm) Returns a randomly generated byte array used to create a key.
Key	getDecryptionKey() Returns the key used for decryption.
Key	getKey() Returns the key.
protected Key	loadKey(byte[] rawKey, KeyLoader keyLoader, String algorithm) Loads a key from the given possible key sources.
T	setKey(byte[] key) Sets the raw byte array of the key.
T	setKey(Key key) Sets the key.
T	setKey(String key) Sets the key.
T	setKeyLoader(Object keyLoader) Sets the KeyLoader, which is used to load the key.

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

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

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

Constructor Detail

AbstractSymmetricAlgorithmParameters

protected AbstractSymmetricAlgorithmParameters()

Initializes the AbstractSymmetricAlgorithmParameters.

AbstractSymmetricAlgorithmParameters

protected AbstractSymmetricAlgorithmParameters(TextEncoder textEncoder)

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

Parameters:

textEncoder - the TextEncoder

Method Detail

getKey

public Key getKey()
           throws GeneralSecurityException

Returns the key.

Specified by:

getKey in interface SymmetricAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

Returns:

the key.

Throws:

GeneralSecurityException - GeneralSecurityException

setKey

public T setKey(byte[] key)

Sets the raw byte array of the key.

Specified by:

setKey in interface SymmetricAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

Parameters:

key - The encryptionKey to set.

Returns:

this concrete class

setKey

public T setKey(String key)

Sets the key. 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 key.

Specified by:

setKey in interface SymmetricAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

Parameters:

key - The key to set.

Returns:

this concrete class

setKey

public T setKey(Key key)

Sets the key.

Specified by:

setKey in interface SymmetricAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

Parameters:

key - The key to set.

Returns:

this concrete class

setKeyLoader

public T setKeyLoader(Object keyLoader)

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

Specified by:

setKeyLoader in interface SymmetricAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

Parameters:

keyLoader - The keyLoader to set.

Returns:

this concrete class

getDecryptionKey

public Key getDecryptionKey()
                     throws GeneralSecurityException

Returns the key used for decryption.

Specified by:

getDecryptionKey in interface AlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

Overrides:

getDecryptionKey in class AbstractAlgorithmParameters<T extends AbstractSymmetricAlgorithmParameters<T>>

Returns:

the key used for decryption.

Throws:

GeneralSecurityException - GeneralSecurityException

generateKeyData

protected byte[] generateKeyData(String algorithm)
                          throws GeneralSecurityException

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

Parameters:

algorithm - the algorithm for the key

Returns:

a randomly generated byte array used to create a key

Throws:

GeneralSecurityException - GeneralSecurityException

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 AbstractSymmetricAlgorithmParameters<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