iaik.pkcs.pkcs11.provider.keygenerators

Class PKCS11KeyDerivation

java.lang.Object

javax.crypto.KeyGeneratorSpi

iaik.pkcs.pkcs11.provider.keygenerators.PKCS11KeyGenerator

iaik.pkcs.pkcs11.provider.keygenerators.PKCS11KeyDerivation

All Implemented Interfaces:

PKCS11EngineClass

Direct Known Subclasses:

AesCbcEncryptDataKeyDerivation, AesEcbEncryptDataKeyDerivation, Des3CbcEncryptDataKeyDerivation, Des3EcbEncryptDataKeyDerivation, DesCbcEncryptDataKeyDerivation, DesEcbEncryptDataKeyDerivation, Md2KeyDerivation, Md5KeyDerivation, Sha1KeyDerivation, Sha256KeyDerivation, Sha384KeyDerivation, Sha512KeyDerivation, SSL3KeyAndMacDerivation, SSL3MasterKeyDerivation

public abstract class PKCS11KeyDerivation
extends PKCS11KeyGenerator

This is a generic key generator that generates keys on a token by deriving them from existing keys on the token. Through a PKCS11KeyDerivationSpec parameters object, the application can control the derivation of new keys; e.g. specify the base key and an attribute template for the new key.

Author:

Karl Scheibelhofer

Field Summary

Fields

Modifier and Type	Field and Description
protected iaik.pkcs.pkcs11.Mechanism	keyDerivationMechanism_ The key derivation mechanism.

Fields inherited from class iaik.pkcs.pkcs11.provider.keygenerators.PKCS11KeyGenerator

initialized_, keyGenerationSpec_, pkcs11OperationInitialized_, session_, tokenManager_, usedMechanismInfos_, usedMechanisms_

Constructor Summary

Constructors

Constructor and Description
PKCS11KeyDerivation() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected javax.crypto.SecretKey	engineGenerateKey() Actually generates a secret key from this KeyGenerator object.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random) Initializes this key derivator with given algorithm parameters and random seed.
protected void	engineInit(int strength, java.security.SecureRandom random) Initializes this key generator for the given strength with the given random seed
protected void	engineInit(java.security.SecureRandom random) Initializes the key generator with the given random seed.
protected iaik.pkcs.pkcs11.parameters.Parameters	getParameters() Gets the parameters that this key generator needs.
protected iaik.pkcs.pkcs11.MechanismInfo[][]	getUsedMechanismFeatures() Returns an two-dimensional array of MechanismInfos that this engine class uses.

Methods inherited from class iaik.pkcs.pkcs11.provider.keygenerators.PKCS11KeyGenerator

finalize, finalizePkcs11Operation, getAlgorithmName, getMechanism, getUsedMechanisms, initializePkcs11Operation, initializeSession, isSupportedBy

Methods inherited from class java.lang.Object

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

Field Detail

keyDerivationMechanism_

protected iaik.pkcs.pkcs11.Mechanism keyDerivationMechanism_

The key derivation mechanism. Will be set during init.

Constructor Detail

PKCS11KeyDerivation

public PKCS11KeyDerivation()

Default constructor.

Method Detail

getUsedMechanismFeatures

protected iaik.pkcs.pkcs11.MechanismInfo[][] getUsedMechanismFeatures()

Returns an two-dimensional array of MechanismInfos that this engine class uses. For each mechanism used by this engine, the engine must provide at least one MechanismInfo. The first dimension (index) of the returned array corresponds to the used mechanism as returned by getUsedMechanisms(). The array at this index is the list of used feature combinations used by this engine. The current token must at least support one mechanism and one of the feature combinations (expressed as a MechanismInfo) of the same machanism.

Overrides:

getUsedMechanismFeatures in class PKCS11KeyGenerator

Returns:

An two-dimensional array that includes MechanismInfo objects. The first dimension is equal to the array dimension of getUsedMechanisms(). The token must at least supprot one of these features.

Postconditions:

(result <> null) and (result.length > 0) and (result.length == getUsedMechanisms().length)

engineGenerateKey

protected javax.crypto.SecretKey engineGenerateKey()

Actually generates a secret key from this KeyGenerator object.

Overrides:

engineGenerateKey in class PKCS11KeyGenerator

Returns:

the generated secret key

See Also:

KeyGeneratorSpi.engineGenerateKey()

Postconditions:

(result <> null)

engineInit

protected void engineInit(java.security.SecureRandom random)

Initializes the key generator with the given random seed.

Overrides:

engineInit in class PKCS11KeyGenerator

Parameters:

random - the random seed

See Also:

KeyGeneratorSpi.engineInit(SecureRandom)

engineInit

protected void engineInit(int strength,
                          java.security.SecureRandom random)

Initializes this key generator for the given strength with the given random seed

Overrides:

engineInit in class PKCS11KeyGenerator

Parameters:

strength - the strength of the key to be created

random - the random seed

engineInit

protected void engineInit(java.security.spec.AlgorithmParameterSpec params,
                          java.security.SecureRandom random)
                   throws java.security.InvalidAlgorithmParameterException

Initializes this key derivator with given algorithm parameters and random seed.

Overrides:

engineInit in class PKCS11KeyGenerator

Parameters:

params - The algorithm parameters, which must be an instance of PKCS11KeyDerivationSpec and must not be null.

random - This implementation ignores this parameter.

Throws:

java.security.InvalidAlgorithmParameterException - if the given algorithm parameters do not match to this KeyGenerator

See Also:

KeyGeneratorSpi.engineInit(AlgorithmParameterSpec, SecureRandom)

Preconditions:

(params instanceof PKCS11KeyDerivationSpec)

getParameters

protected iaik.pkcs.pkcs11.parameters.Parameters getParameters()

Gets the parameters that this key generator needs. This returns null by default. Override if necessary.

Returns:

the parameters. defaults to null.