Module ibm.crypto.hdwrcca

Package com.ibm.crypto.hdwrCCA.provider

Class DESKeyGenerator

java.lang.Object

javax.crypto.KeyGeneratorSpi

com.ibm.crypto.hdwrCCA.provider.DESKeyGenerator

public final class DESKeyGenerator
extends KeyGeneratorSpi

This class generates a DES key.

This documentation describes a Service Provider Interface. It is provided for implementation insight only. This class is not intended to be called directly by application developers. Please consult the 'Java Cryptography Architecture Standard' for details on how to use this interface through a public standard class.

NOTE:

Certain operations may require specific hardware or software, or specific key types. See the rest of this document and the z/OS Unique Considerations Hardware Crypto Reference Guide for more details. Unsupported operations and/or combinations may result in a RuntimeException Hardware Error.

For public interface details, consult the JCE API documentation for javax.crypto.KeyGenerator.

Constructor Summary

Constructors

Constructor	Description
DESKeyGenerator()	Verify the JCE framework in the constructor.

Method Summary

Modifier and Type	Method	Description
protected SecretKey	engineGenerateKey()	Generates the DES key.
protected void	engineInit(int keysize, SecureRandom random)	Initializes this key generator for a certain keysize, using the given source of randomness.
protected void	engineInit(SecureRandom random)	Initializes this key generator with a source of randomness.
protected void	engineInit(AlgorithmParameterSpec params, SecureRandom random)	Initializes this key generator with the specified parameter set and a user-provided source of randomness.

Methods inherited from class java.lang.Object

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

Constructor Details

DESKeyGenerator

public DESKeyGenerator()

Verify the JCE framework in the constructor.

Throws:

SecurityException - if fails to verify the JCE framework.

Method Details

engineInit

protected void engineInit(SecureRandom random)

Initializes this key generator with a source of randomness. It is not valid to specify a source of randomness for a key that will be generated as a secret hardware key.

Specified by:

engineInit in class KeyGeneratorSpi

Parameters:

random - the source of randomness for this generator

engineInit

protected void engineInit(AlgorithmParameterSpec params,
 SecureRandom random)
                   throws InvalidAlgorithmParameterException

Initializes this key generator with the specified parameter set and a user-provided source of randomness. If a CCAAlgorithmParameterSpec is specified, and the requested key type is either CCAAlgorithmParameterSpec.SECURE_INTERNAL_TOKEN or CCAAlgorithmParameterSpec.CKDS, then the DES key will be generated as a secret hardware key. Generation of key encrypting keys is not supported.

Specified by:

engineInit in class KeyGeneratorSpi

Parameters:

params - the key generation parameters

random - the source of randomness for this key generator

Throws:

InvalidAlgorithmParameterException - if params is inappropriate for this key generator.

InvalidParameterException - if the key size in the key generation parameters is not valid.

engineInit

protected void engineInit(int keysize,
 SecureRandom random)

Initializes this key generator for a certain keysize, using the given source of randomness.

Specified by:

engineInit in class KeyGeneratorSpi

Parameters:

keysize - the keysize. This is an algorithm-specific metric specified in number of bits

random - the source of randomness for this key generator

Throws:

InvalidParameterException - if the specified key size is not valid.

engineGenerateKey

protected SecretKey engineGenerateKey()

Generates the DES key.

Specified by:

engineGenerateKey in class KeyGeneratorSpi

Returns:

the new DES key.