com.entrust.toolkit.roaming.speke

Class SPEKEKeyPairGenerator

java.lang.Object

java.security.KeyPairGeneratorSpi

java.security.KeyPairGenerator

com.entrust.toolkit.roaming.speke.SPEKEKeyPairGenerator

public class SPEKEKeyPairGenerator
extends java.security.KeyPairGenerator

A software based implementation of the Simple Password Exponential Key Exchange (SPEKE) key pair generation algorithm.

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

See Also:

SPEKEParameterSpec, SPEKEKeyAgreement, SPEKEPrivateKey, SPEKEPublicKey

Constructor Summary

Constructors

Constructor and Description
SPEKEKeyPairGenerator() The constructor; creates a new instance of the SPEKE 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.

Methods inherited from class java.security.KeyPairGenerator

genKeyPair, getAlgorithm, getInstance, getInstance, getInstance, getProvider, initialize, initialize, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

SPEKEKeyPairGenerator

public SPEKEKeyPairGenerator()

The constructor; creates a new instance of the SPEKE 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("SPEKE", "Entrust").

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

Method Detail

initialize

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

Initializes the key pair generator using the specified parameter set.

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.

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

java.security.InvalidParameterException

generateKeyPair

public java.security.KeyPair generateKeyPair()
                                      throws java.security.InvalidParameterException

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

java.security.InvalidParameterException