AbstractAlgorithmParameters (easyjce 1.1.0 API)

java.lang.Object
- org.antfarmer.ejce.parameter.AbstractAlgorithmParameters<T>

Type Parameters:

T - the concrete type of this object.

All Implemented Interfaces:

AlgorithmParameters<T>

Direct Known Subclasses:

AbstractAsymmetricAlgorithmParameters, AbstractSymmetricAlgorithmParameters
```
public abstract class AbstractAlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
extends Object
implements AlgorithmParameters<T>
```
Abstract AlgorithmParameters class.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KEY_SIZE_128` 128-bit key size.
`static int`	`KEY_SIZE_192` 192-bit key size (not available in all jurisdictions).
`static int`	`KEY_SIZE_256` 256-bit key size (not available in all jurisdictions).
`static String`	`MAC_ALGORITHM_HMAC_MD5` The HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA1` The HMAC-SHA1 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA224` The HMAC-SHA224 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA256` The HMAC-SHA256 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA3_224` The HMAC-SHA3-224 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA3_256` The HMAC-SHA3-256 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA3_384` The HMAC-SHA3-384 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA3_512` The HMAC-SHA3-512 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA384` The HMAC-SHA384 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA512` The HMAC-SHA512 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA512_224` The HMAC-SHA512/224 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static String`	`MAC_ALGORITHM_HMAC_SHA512_256` The HMAC-SHA512/256 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
`static int`	`MAC_KEY_SIZE_128` 128-bit MAC key size (Suggested minimum key size for HmacMD5).
`static int`	`MAC_KEY_SIZE_160` 160-bit MAC key size (Suggested minimum key size for HmacSHA1).

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAlgorithmParameters()` Initializes the AbstractAlgorithmParameters.
`protected`	`AbstractAlgorithmParameters(TextEncoder textEncoder)` Initializes the AbstractAlgorithmParameters with a `TextEncoder`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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.
`protected abstract String`	`getDefaultAlgorithm()` Returns the defaultAlgorithm.
`protected int`	`getDefaultKeySize()` Returns the defaultKeySize.
`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.
`Provider`	`getProvider()` Returns the Java Security Provider.
`String`	`getProviderName()` Returns the Java Security Provider name.
`protected boolean`	`hasDecryptionKey()` Returns true if this instance has a loaded decryptionKey.
`protected boolean`	`hasEncryptionKey()` Returns true if this instance has a loaded encryptionKey.
`protected abstract Key`	`loadKey(byte[] rawKey, KeyLoader keyLoader, String algorithm)` Loads a key from the given possible key sources.
`protected byte[]`	`parseAndVerifySalt(byte[] messageData)` Separates and returns the algorithm spec data or salt from the enciphered message.
`protected T`	`setAlgorithm(String algorithm)` Sets the algorithm value.
`protected T`	`setDecryptionKey(byte[] decryptionKey)` Sets the raw byte array of the decryption key.
`protected T`	`setDecryptionKey(Key decryptionKey)` Sets the decryption key.
`protected T`	`setDecryptionKey(String decryptionKey)` Sets the decryption key.
`protected T`	`setDecryptionKeyLoader(Object decryptionKeyLoader)` Sets the `KeyLoader`, which is used to load the decryption key.
`protected T`	`setEncryptionKey(byte[] encryptionKey)` Sets the raw byte array of the encryption key.
`protected T`	`setEncryptionKey(Key encryptionKey)` Sets the encryption key.
`protected T`	`setEncryptionKey(String encryptionKey)` Sets the encryption key.
`protected T`	`setEncryptionKeyLoader(Object encryptionKeyLoader)` Sets the `KeyLoader`, which is used to load the encryption key.
`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.

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
getParameterSpec, getParameterSpecSize, getTransformation

- Field Detail
  - KEY_SIZE_128
```
public static final int KEY_SIZE_128
```
    128-bit key size.
    
    See Also:
    
    Constant Field Values
  - KEY_SIZE_192
```
public static final int KEY_SIZE_192
```
    192-bit key size (not available in all jurisdictions).
    
    See Also:
    
    Constant Field Values
  - KEY_SIZE_256
```
public static final int KEY_SIZE_256
```
    256-bit key size (not available in all jurisdictions).
    
    See Also:
    
    Constant Field Values
  - MAC_KEY_SIZE_128
```
public static final int MAC_KEY_SIZE_128
```
    128-bit MAC key size (Suggested minimum key size for HmacMD5).
    
    See Also:
    
    Constant Field Values
  - MAC_KEY_SIZE_160
```
public static final int MAC_KEY_SIZE_160
```
    160-bit MAC key size (Suggested minimum key size for HmacSHA1).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_MD5
```
public static final String MAC_ALGORITHM_HMAC_MD5
```
    The HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA1
```
public static final String MAC_ALGORITHM_HMAC_SHA1
```
    The HMAC-SHA1 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA224
```
public static final String MAC_ALGORITHM_HMAC_SHA224
```
    The HMAC-SHA224 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA256
```
public static final String MAC_ALGORITHM_HMAC_SHA256
```
    The HMAC-SHA256 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA384
```
public static final String MAC_ALGORITHM_HMAC_SHA384
```
    The HMAC-SHA384 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA512
```
public static final String MAC_ALGORITHM_HMAC_SHA512
```
    The HMAC-SHA512 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA512_224
```
public static final String MAC_ALGORITHM_HMAC_SHA512_224
```
    The HMAC-SHA512/224 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA512_256
```
public static final String MAC_ALGORITHM_HMAC_SHA512_256
```
    The HMAC-SHA512/256 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA3_224
```
public static final String MAC_ALGORITHM_HMAC_SHA3_224
```
    The HMAC-SHA3-224 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA3_256
```
public static final String MAC_ALGORITHM_HMAC_SHA3_256
```
    The HMAC-SHA3-256 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA3_384
```
public static final String MAC_ALGORITHM_HMAC_SHA3_384
```
    The HMAC-SHA3-384 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM_HMAC_SHA3_512
```
public static final String MAC_ALGORITHM_HMAC_SHA3_512
```
    The HMAC-SHA3-512 keyed-hashing algorithm as defined in RFC 2104: "HMAC: Keyed-Hashing for Message Authentication" (February 1997).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractAlgorithmParameters
```
protected AbstractAlgorithmParameters()
```
    Initializes the AbstractAlgorithmParameters.
  - AbstractAlgorithmParameters
```
protected AbstractAlgorithmParameters(TextEncoder textEncoder)
```
    Initializes the AbstractAlgorithmParameters with a TextEncoder.
    
    Parameters:
    
    textEncoder - the TextEncoder
- Method Detail
  - getDefaultAlgorithm
```
protected abstract String getDefaultAlgorithm()
```
    Returns the defaultAlgorithm.
    
    Returns:
    
    the defaultAlgorithm
  - getDefaultKeySize
```
protected int getDefaultKeySize()
```
    Returns the defaultKeySize.
    
    Returns:
    
    the defaultKeySize
  - getKeySize
```
public int getKeySize()
```
    Returns the size of the key to be generated in bits.
    
    Specified by:
    
    getKeySize in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the keySize.
  - setKeySize
```
public 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.
    
    Specified by:
    
    setKeySize in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    keySize - The keySize to set.
    
    Returns:
    
    this concrete class
  - loadKey
```
protected abstract Key loadKey(byte[] rawKey,
                               KeyLoader keyLoader,
                               String algorithm)
                        throws GeneralSecurityException
```
    Loads a key from the given possible key sources.
    
    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
  - getEncryptionKey
```
public Key getEncryptionKey()
                     throws GeneralSecurityException
```
    Returns the key used for encryption.
    
    Specified by:
    
    getEncryptionKey in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the key used for encryption.
    
    Throws:
    
    GeneralSecurityException - GeneralSecurityException
  - hasDecryptionKey
```
protected boolean hasDecryptionKey()
```
    Returns true if this instance has a loaded decryptionKey.
    
    Returns:
    
    true if this instance has a loaded decryptionKey; false otherwise
  - setEncryptionKey
```
protected T setEncryptionKey(byte[] encryptionKey)
```
    Sets the raw byte array of the encryption key.
    
    Parameters:
    
    encryptionKey - The encryptionKey to set.
    
    Returns:
    
    this concrete class
  - setEncryptionKey
```
protected T setEncryptionKey(String encryptionKey)
```
    Sets the encryption 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 encryption key.
    
    Parameters:
    
    encryptionKey - The encryptionKey to set.
    
    Returns:
    
    this concrete class
  - setEncryptionKey
```
protected T setEncryptionKey(Key encryptionKey)
```
    Sets the encryption key.
    
    Parameters:
    
    encryptionKey - The encryptionKey to set.
    
    Returns:
    
    this concrete class
  - setEncryptionKeyLoader
```
protected 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.
    
    Parameters:
    
    encryptionKeyLoader - The encryptionKeyLoader 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 AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the key used for decryption.
    
    Throws:
    
    GeneralSecurityException - GeneralSecurityException
  - hasEncryptionKey
```
protected boolean hasEncryptionKey()
```
    Returns true if this instance has a loaded encryptionKey.
    
    Returns:
    
    true if this instance has a loaded encryptionKey; false otherwise
  - setDecryptionKey
```
protected T setDecryptionKey(byte[] decryptionKey)
```
    Sets the raw byte array of the decryption key.
    
    Parameters:
    
    decryptionKey - The decryptionKey to set.
    
    Returns:
    
    this concrete class
  - setDecryptionKey
```
protected T setDecryptionKey(String decryptionKey)
```
    Sets the decryption 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 decryption key.
    
    Parameters:
    
    decryptionKey - The decryptionKey to set.
    
    Returns:
    
    this concrete class
  - setDecryptionKey
```
protected T setDecryptionKey(Key decryptionKey)
```
    Sets the decryption key.
    
    Parameters:
    
    decryptionKey - The decryptionKey to set.
    
    Returns:
    
    this concrete class
  - setDecryptionKeyLoader
```
protected 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.
    
    Parameters:
    
    decryptionKeyLoader - The decryptionKeyLoader to set.
    
    Returns:
    
    this concrete class
  - getAlgorithm
```
public String getAlgorithm()
```
    Returns the algorithm value.
    
    Specified by:
    
    getAlgorithm in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the algorithm.
  - setAlgorithm
```
protected T setAlgorithm(String algorithm)
```
    Sets the algorithm value.
    
    Parameters:
    
    algorithm - The algorithm to set.
    
    Returns:
    
    this concrete class
  - generateParameterSpecData
```
public byte[] generateParameterSpecData()
```
    Generates a byte array which holds algorithm parameters such as an initialization vector or salt.
    
    Specified by:
    
    generateParameterSpecData in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    an array of bytes which holds algorithm parameters
  - 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<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    parameterData - the data for the AlgorithmParameterSpec
    
    Returns:
    
    an algorithm-specific AlgorithmParameterSpec object
  - getMacKeySize
```
public int getMacKeySize()
```
    Returns the size of the MAC key to be generated in bits.
    
    Specified by:
    
    getMacKeySize in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the macKeySize.
  - setMacKeySize
```
public 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.
    
    Specified by:
    
    setMacKeySize in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    macKeySize - The macKeySize to set.
    
    Returns:
    
    this concrete class
  - getMacKey
```
public Key getMacKey()
              throws GeneralSecurityException
```
    Returns the macKey.
    
    Specified by:
    
    getMacKey in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the macKey.
    
    Throws:
    
    GeneralSecurityException - GeneralSecurityException
  - setMacKey
```
public T setMacKey(byte[] macKey)
```
    Sets the raw byte array of the MAC key.
    
    Specified by:
    
    setMacKey in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    macKey - The macKey to set.
    
    Returns:
    
    this concrete class
  - setMacKey
```
public 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.
    
    Specified by:
    
    setMacKey in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    macKey - The macKey to set.
    
    Returns:
    
    this concrete class
  - setMacKey
```
public T setMacKey(Key macKey)
```
    Sets the macKey.
    
    Specified by:
    
    setMacKey in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    macKey - The macKey to set.
    
    Returns:
    
    this concrete class
  - getMacAlgorithm
```
public String getMacAlgorithm()
```
    Returns the macAlgorithm value.
    
    Specified by:
    
    getMacAlgorithm in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the macAlgorithm.
  - setMacAlgorithm
```
public T setMacAlgorithm(String macAlgorithm)
```
    Sets the macAlgorithm value.
    
    Specified by:
    
    setMacAlgorithm in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    macAlgorithm - The macAlgorithm to set.
    
    Returns:
    
    this concrete class
  - getProviderName
```
public String getProviderName()
```
    Returns the Java Security Provider name.
    
    Specified by:
    
    getProviderName in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the providerName.
  - setProviderName
```
public T setProviderName(String providerName)
```
    Sets the Java Security Provider name.
    
    Specified by:
    
    setProviderName in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    providerName - The providerName to set.
    
    Returns:
    
    this concrete class
  - getProvider
```
public Provider getProvider()
```
    Returns the Java Security Provider.
    
    Specified by:
    
    getProvider in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Returns:
    
    the provider.
  - setProvider
```
public T setProvider(Provider provider)
```
    Sets the Java Security Provider.
    
    Specified by:
    
    setProvider in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    provider - The provider to set.
    
    Returns:
    
    this concrete class
  - setMacKeyLoader
```
public 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.
    
    Specified by:
    
    setMacKeyLoader in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    macKeyLoader - The macKeyLoader to set.
    
    Returns:
    
    this concrete class
  - setSaltGenerator
```
public T setSaltGenerator(SaltGenerator saltGenerator)
```
    Sets the SaltGenerator, which allows for custom salt data generation.
    
    Specified by:
    
    setSaltGenerator in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    saltGenerator - the saltGenerator to set
    
    Returns:
    
    this concrete class
  - setSaltMatcher
```
public T setSaltMatcher(SaltMatcher saltMatcher)
```
    Sets the SaltMatcher, which may be used to verify the salt within the cipher text matches some expected value.
    
    Specified by:
    
    setSaltMatcher in interface AlgorithmParameters<T extends AbstractAlgorithmParameters<T>>
    
    Parameters:
    
    saltMatcher - the saltMatcher to set
    
    Returns:
    
    this concrete class
  - parseAndVerifySalt
```
protected byte[] parseAndVerifySalt(byte[] messageData)
                             throws GeneralSecurityException
```
    Separates and returns the algorithm spec data or salt from the enciphered message. Also executes the SaltMatcher if one exists.
    
    Parameters:
    
    messageData - the enciphered message
    
    Returns:
    
    the algorithm spec data or salt from the enciphered message
    
    Throws:
    
    GeneralSecurityException - if an error occurs when verifying a salt match (if one exists)

Class AbstractAlgorithmParameters<T extends AbstractAlgorithmParameters<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SIZE_128

KEY_SIZE_192

KEY_SIZE_256

MAC_KEY_SIZE_128

MAC_KEY_SIZE_160

MAC_ALGORITHM_HMAC_MD5

MAC_ALGORITHM_HMAC_SHA1

MAC_ALGORITHM_HMAC_SHA224

MAC_ALGORITHM_HMAC_SHA256

MAC_ALGORITHM_HMAC_SHA384

MAC_ALGORITHM_HMAC_SHA512

MAC_ALGORITHM_HMAC_SHA512_224

MAC_ALGORITHM_HMAC_SHA512_256

MAC_ALGORITHM_HMAC_SHA3_224

MAC_ALGORITHM_HMAC_SHA3_256

MAC_ALGORITHM_HMAC_SHA3_384

MAC_ALGORITHM_HMAC_SHA3_512

Constructor Detail

AbstractAlgorithmParameters

AbstractAlgorithmParameters

Method Detail

getDefaultAlgorithm

getDefaultKeySize

getKeySize

setKeySize

loadKey

getEncryptionKey

hasDecryptionKey

setEncryptionKey

setEncryptionKey

setEncryptionKey

setEncryptionKeyLoader

getDecryptionKey

hasEncryptionKey

setDecryptionKey

setDecryptionKey

setDecryptionKey

setDecryptionKeyLoader

getAlgorithm

setAlgorithm

generateParameterSpecData

createParameterSpec

getMacKeySize

setMacKeySize

getMacKey

setMacKey

setMacKey

setMacKey

getMacAlgorithm

setMacAlgorithm

getProviderName

setProviderName

getProvider

setProvider

setMacKeyLoader

setSaltGenerator

setSaltMatcher

parseAndVerifySalt