iaik.security.kdf

Class KDF1ParameterSpec

java.lang.Object

iaik.pkcs.pkcs1.PKCS1AlgorithmParameterSpec

iaik.pkcs.pkcs1.MGF1ParameterSpec

iaik.security.kdf.KDF1ParameterSpec

All Implemented Interfaces:

KeyDerivationParameterSpec, java.security.spec.AlgorithmParameterSpec

Direct Known Subclasses:

KDF2ParameterSpec

public class KDF1ParameterSpec
extends MGF1ParameterSpec
implements KeyDerivationParameterSpec

Algorithm parameter specification for the KDF1 Key Derivation Function (KDF).

This class holds all information needed for using the KDF1. This includes the used hash algorithm, the desired key length, the secret value, and the additional information. We use this approach, as the KDF1 is implemented using the KeyGenerator class, and and KeyGenerator.generateKey() is not parameterized.

Constructor Summary

Constructors

Constructor and Description
KDF1ParameterSpec(AlgorithmID hashAlgorithm, int keyLength) Creates a new KDF1ParameterSpec for the hash algorithm to be used with KDF1 and the desired key length.
KDF1ParameterSpec(AlgorithmID hashAlgorithm, int keyLength, byte[] secretValue) Creates a new KDF1ParameterSpec for the hash algorithm to be used with KDF1, the desired key length, and the secret value.
KDF1ParameterSpec(AlgorithmID hashAlgorithm, int keyLength, byte[] secretValue, byte[] otherInfo) Creates a new KDF1ParameterSpec for the hash algorithm to be used with KDF1, the desired key length, the secret value, and the additional information.

Method Summary

Modifier and Type	Method and Description
AlgorithmID	getAlgorithmId() Returns the AlgorithmID of the KDF associated with this class.
java.lang.String	getKdf() Returns the name of the KDF associated with this class.
int	getKeyLength() Returns the desired key length.
byte[]	getOtherInfo() Returns the additional information used for key derivation.
byte[]	getSecretValue() Returns the secret value used for key derivation.
void	setKeyLength(int keyLength) Sets the key length.
void	setOtherInfo(byte[] otherInfo) Sets the additional information used for key derivation.
void	setSecretValue(byte[] secretValue) Sets the secret value used for key derivation.

Methods inherited from class iaik.pkcs.pkcs1.MGF1ParameterSpec

getHashAlgorithm, getHashEngine, setHashEngine, toString

Methods inherited from class iaik.pkcs.pkcs1.PKCS1AlgorithmParameterSpec

getSecureRandom, setSecureRandom

Methods inherited from class java.lang.Object

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

Constructor Detail

KDF1ParameterSpec

public KDF1ParameterSpec(AlgorithmID hashAlgorithm,
                         int keyLength)

Creates a new KDF1ParameterSpec for the hash algorithm to be used with KDF1 and the desired key length. It is possible to set the secret value and the additional information with setSecretValue(byte[]) and setOtherInfo(byte[]) respectively. At least the secret value is mandatory.

Parameters:

hashAlgorithm - the hash algorithm ID

keyLength - the desired key length

KDF1ParameterSpec

public KDF1ParameterSpec(AlgorithmID hashAlgorithm,
                         int keyLength,
                         byte[] secretValue)

Creates a new KDF1ParameterSpec for the hash algorithm to be used with KDF1, the desired key length, and the secret value. It is possible to set the additional information with setOtherInfo(byte[]).

Parameters:

hashAlgorithm - the hash algorithm ID

keyLength - the desired key length

secretValue - the secret value used for key derivation

KDF1ParameterSpec

public KDF1ParameterSpec(AlgorithmID hashAlgorithm,
                         int keyLength,
                         byte[] secretValue,
                         byte[] otherInfo)

Creates a new KDF1ParameterSpec for the hash algorithm to be used with KDF1, the desired key length, the secret value, and the additional information.

Parameters:

hashAlgorithm - the hash algorithm ID

keyLength - the desired key length

secretValue - the secret value used for key derivation

otherInfo - the additional information for key derivation

Method Detail

getKeyLength

public int getKeyLength()

Returns the desired key length.

Specified by:

getKeyLength in interface KeyDerivationParameterSpec

Returns:

the key length

setKeyLength

public void setKeyLength(int keyLength)

Sets the key length.

Specified by:

setKeyLength in interface KeyDerivationParameterSpec

Parameters:

keyLength - the desired key length

getAlgorithmId

public AlgorithmID getAlgorithmId()

Returns the AlgorithmID of the KDF associated with this class.

Specified by:

getAlgorithmId in interface KeyDerivationParameterSpec

Returns:

The algorithmID of KDF1

getSecretValue

public byte[] getSecretValue()

Returns the secret value used for key derivation.

Specified by:

getSecretValue in interface KeyDerivationParameterSpec

Returns:

the secret value

setSecretValue

public void setSecretValue(byte[] secretValue)

Sets the secret value used for key derivation.

Specified by:

setSecretValue in interface KeyDerivationParameterSpec

Parameters:

secretValue - the secret value

getOtherInfo

public byte[] getOtherInfo()

Returns the additional information used for key derivation.

Specified by:

getOtherInfo in interface KeyDerivationParameterSpec

Returns:

the additional information

setOtherInfo

public void setOtherInfo(byte[] otherInfo)

Sets the additional information used for key derivation.

Specified by:

setOtherInfo in interface KeyDerivationParameterSpec

Parameters:

otherInfo - the additional information

getKdf

public java.lang.String getKdf()

Returns the name of the KDF associated with this class.

Specified by:

getKdf in interface KeyDerivationParameterSpec

Returns:

"KDF1"