com.entrust.toolkit.security.crypto.cipher

Class Cast3KeyGenerator

java.lang.Object

javax.crypto.KeyGeneratorSpi

com.entrust.toolkit.security.crypto.cipher.Cast3KeyGenerator

public final class Cast3KeyGenerator
extends javax.crypto.KeyGeneratorSpi

A software based implementation of the CAST3 key generation algorithm.

It is designed to generate symmetric keys that can be used with the CAST3 symmetric cipher algorithm algorithm. The keys that are generated are in 'RAW' format. These keys can be of any 40, 48, 56, or 64-bits in length. This algorithm does not use algorithm parameters; if provided during initialization they will be rejected.

An instance of this algorithm can be obtained using Java Cryptography Architecture (JCA), by requesting a 'CAST3' key generator from the Entrust cryptographic service provider. This can be done using the following call:

KeyGenerator.getInstance("CAST3", "Entrust");

This class SHOULD NOT be used directly; it should only be used through the JCA/JCE.

Warning:

CAST3 provides a maximum of 64-bits of security; NIST recommends a minimum of 112-bits of security be used beyond 2010. This algorithm should be used for interoperability purposes only.

FIPS 140-2:

This class is part of the Toolkit's FIPS 140-2 cryptographic module and contains APIs that are considered part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; refer to the API documentation for further details

Since:

7.0

See Also:

Cast3Cipher

Constructor Summary

Constructors

Constructor and Description
Cast3KeyGenerator() The constructor; creates a new instance of the CAST3 key generation algorithm.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Cast3KeyGenerator

public Cast3KeyGenerator()

The constructor; creates a new instance of the CAST3 key generation algorithm.

Applications should not use this constructor, instead the key generation algorithm should be requested from the appropriate JCA/JCE cryptographic service provider as follows: KeyGenerator.getInstance("CAST3", "Entrust").

FIPS 140-2:

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• status output interface (exceptions)

Method Detail

engineInit

protected void engineInit(java.security.SecureRandom random)

Initializes the key generator.

FIPS 140-2:

FIPS Service: Initialization

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call, parameters)
• status output interface (exceptions)

Specified by:

engineInit in class javax.crypto.KeyGeneratorSpi

Parameters:

random - [FIPS 140-2 control input] the source of randomness for this generator

Throws:

Fips140ErrorStateException - [FIPS 140-2 status output] thrown if the Toolkit is not allowed to perform cryptographic operations

engineInit

protected void engineInit(int keysize,
              java.security.SecureRandom random)
                   throws java.security.InvalidParameterException

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

FIPS 140-2:

FIPS Service: Initialization

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call, parameters)
• data input interface (parameters)
• status output interface (exceptions)

Specified by:

engineInit in class javax.crypto.KeyGeneratorSpi

Parameters:

keysize - [FIPS 140-2 data input] the keysize. This is an algorithm-specific metric, specified in number of bits.

random - [FIPS 140-2 control input] the source of randomness for this key generator

Throws:

java.security.InvalidParameterException - [FIPS 140-2 status output] if the keysize is wrong or not supported.

Fips140ErrorStateException - [FIPS 140-2 status output] thrown if the Toolkit is not allowed to perform cryptographic operations

engineInit

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

Initializes the key generator with the specified parameter set and a user-provided source of randomness.

FIPS 140-2:

FIPS Service: Initialization

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call, parameters)
• data input interface (parameters)
• status output interface (exceptions)

Specified by:

engineInit in class javax.crypto.KeyGeneratorSpi

Parameters:

params - [FIPS 140-2 data input] the key generation parameters

random - [FIPS 140-2 control input] the source of randomness for this key generator

Throws:

java.security.InvalidAlgorithmParameterException - [FIPS 140-2 status output] if params is inappropriate for this key generator

Fips140ErrorStateException - [FIPS 140-2 status output] thrown if the Toolkit is not allowed to perform cryptographic operations

engineGenerateKey

protected javax.crypto.SecretKey engineGenerateKey()

Generates a secret key.

FIPS 140-2:

FIPS Service: Key Generation

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 crypto officer role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• data output interface (return value)
• status output interface (exceptions)

Specified by:

engineGenerateKey in class javax.crypto.KeyGeneratorSpi

Returns:

[FIPS 140-2 data output] [FIPS 140-2 CSP] the new key

Throws:

Fips140ErrorStateException - [FIPS 140-2 status output] thrown if the Toolkit is not allowed to perform cryptographic operations