com.entrust.toolkit.security.provider

Class RSAKeyPairGenerator

java.lang.Object

java.security.KeyPairGeneratorSpi

java.security.KeyPairGenerator

com.entrust.toolkit.security.provider.RSAKeyPairGenerator

public class RSAKeyPairGenerator
extends java.security.KeyPairGenerator

A software based implementation of the RSA key pair generation algorithm.

An RSA key generator is used to generate an RSA key pair, which consists of an RSA public key and an RSA private key. This key pair can then be used with RSA-based cryptographic algorithms (ex: RSA digital signatures - RsaSignature).

The key size of an RSA key pair refers to the length of the modulus. When not specified, a default key size of 1024-bits is used; when specified, a minimum key size of 512-bits is enforced. Algorithm parameters are not supported by this implementation; if provided during initialization they will be rejected. When a public exponent is specified by a call to initialize(int, BigInteger, SecureRandom), the public exponent must be odd; when not specified, a default public exponent of 65537 is used.

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

KeyPairGenerator.getInstance("RSA", "Entrust");

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

Constructor Summary

Constructors

Constructor and Description
RSAKeyPairGenerator() The constructor; creates a new instance of the RSA key pair generation algorithm.

Method Summary

Modifier and Type	Method and Description
java.security.KeyPair	generateKeyPair() Generates a key pair.
void	initialize(java.security.spec.AlgorithmParameterSpec params) Initializes the key pair generator using the specified parameter set and Entrust's default SecureRandom implementation (see Entrust.getDefaultSecureRandomInstance()).
void	initialize(java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random) Initializes the key pair generator using the specified parameter set and user-provided source of randomness.
void	initialize(int keysize) Initializes the key pair generator for a certain keysize using a default parameter set and Entrust's default SecureRandom implementation (see Entrust.getDefaultSecureRandomInstance()).
void	initialize(int keysize, java.math.BigInteger publicExponent, java.security.SecureRandom random) Initializes the key pair generator for a certain keysize, public exponent, and user-provided source of randomness.
void	initialize(int keysize, java.security.SecureRandom secureRandom) Initializes the key pair generator for a certain keysize and user-provided source of randomness.

Methods inherited from class java.security.KeyPairGenerator

genKeyPair, getAlgorithm, getInstance, getInstance, getInstance, getProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

RSAKeyPairGenerator

public RSAKeyPairGenerator()

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

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

FIPS 140-2:

FIPS Service: Modify Object

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

initialize

public void initialize(java.security.spec.AlgorithmParameterSpec params,
                       java.security.SecureRandom random)
                throws java.security.InvalidAlgorithmParameterException

Initializes the key pair generator using the specified parameter set and 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)

Overrides:

initialize in class java.security.KeyPairGenerator

Parameters:

params - [FIPS 140-2 data input] the parameter set used to generate the keys.

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

Throws:

java.security.InvalidAlgorithmParameterException - [FIPS 140-2 status output] if the given parameters are inappropriate for this key pair generator.

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

initialize

public void initialize(java.security.spec.AlgorithmParameterSpec params)
                throws java.security.InvalidAlgorithmParameterException

Initializes the key pair generator using the specified parameter set and Entrust's default SecureRandom implementation (see Entrust.getDefaultSecureRandomInstance()).

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)
• data input interface (parameters)
• status output interface (exceptions)

Overrides:

initialize in class java.security.KeyPairGenerator

Parameters:

params - [FIPS 140-2 data input] the parameter set used to generate the keys.

Throws:

java.security.InvalidAlgorithmParameterException - [FIPS 140-2 status output] if the given parameters are inappropriate for this key pair generator.

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

Since:

8.0

initialize

public void initialize(int keysize)

Initializes the key pair generator for a certain keysize using a default parameter set and Entrust's default SecureRandom implementation (see Entrust.getDefaultSecureRandomInstance()).

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)
• data input interface (parameters)
• status output interface (exceptions)

Overrides:

initialize in class java.security.KeyPairGenerator

Parameters:

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

Throws:

java.security.InvalidParameterException - [FIPS 140-2 status output] if the keysize is not supported by this KeyPairGenerator object.

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

initialize

public void initialize(int keysize,
                       java.security.SecureRandom secureRandom)

Initializes the key pair generator for a certain keysize and 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)

Overrides:

initialize in class java.security.KeyPairGenerator

Parameters:

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

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

Throws:

java.security.InvalidAlgorithmParameterException - [FIPS 140-2 status output] if the given parameters are inappropriate for this key pair generator.

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

initialize

public void initialize(int keysize,
                       java.math.BigInteger publicExponent,
                       java.security.SecureRandom random)
                throws java.security.InvalidParameterException

Initializes the key pair generator for a certain keysize, public exponent, and user-provided source of randomness.

Typical values for the public exponent are the Fermat primes F4 and F0 (0x10001 and 0x11) and, less commonly, 17.

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)

Parameters:

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

publicExponent - [FIPS 140-2 data input] the public exponent (must be odd)

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

java.security.InvalidParameterException

generateKeyPair

public java.security.KeyPair generateKeyPair()

Generates a key pair.

Unless an initialization method is called using a KeyPairGenerator interface, algorithm-specific defaults will be used. This will generate a new key pair every time it is called.

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)

Overrides:

generateKeyPair in class java.security.KeyPairGenerator

Returns:

[FIPS 140-2 data output] [FIPS 140-2 CSP] the newly generated KeyPair

Throws:

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