oracle.security.crypto.cryptoki.crypto

Class CkiKeyPairGenerator

java.lang.Object

oracle.security.crypto.core.KeyPairGenerator

oracle.security.crypto.cryptoki.crypto.CkiKeyPairGenerator

public class CkiKeyPairGenerator
extends oracle.security.crypto.core.KeyPairGenerator

A class for randomly generating public/private key pairs on a PKCS #11 token.

Field Summary

Fields inherited from class oracle.security.crypto.core.KeyPairGenerator

d

Constructor Summary

Constructors

Constructor and Description
CkiKeyPairGenerator() Empty constructor
CkiKeyPairGenerator(CkiSession session) Creates a new CkiKeyPairGenerator
CkiKeyPairGenerator(CkiSlot slot) Creates a new CkiKeyPairGenerator

Method Summary

Modifier and Type	Method and Description
oracle.security.crypto.core.KeyPair	generateKeyPair() Generates the key pair.
oracle.security.crypto.core.KeyPair	generateKeyPair(boolean tokenPersistent) Generates the key pair.
java.lang.String	getAlgorithm() Gets the algorithm used for the generation of the key pair.
int	getRSAExponent() Gets the RSA public exponent value.
CkiSlot	getSlot() Returns the slot used by this CkiKeyPairGenerator.
boolean	getTokenPersistent() Returns whether or not the keys will be persistent on the token.
void	initialize(int strength, oracle.security.crypto.core.RandomBitsSource rbs) Initializes the CkiKeyPairGenerator.
void	setAlgID(oracle.security.crypto.core.AlgorithmIdentifier algID) Sets the AlgorithmIdentifier for this KeyPairGenerator object.
void	setRSAExponent(int rsaPubExponent) Sets the RSA public exponent.
void	setSlot(CkiSlot slot) Set the slot for this CkiKeyPairGenerator.
void	setTokenPersistent(boolean value) Sets whether or not the generated key pairs are persistent on the token or exist only for the life of the session.

Methods inherited from class oracle.security.crypto.core.KeyPairGenerator

getInstance, setRandomBitsSource

Methods inherited from class java.lang.Object

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

Constructor Detail

CkiKeyPairGenerator

public CkiKeyPairGenerator()

Empty constructor

CkiKeyPairGenerator

public CkiKeyPairGenerator(CkiSlot slot)
                    throws CryptokiException

Creates a new CkiKeyPairGenerator

Parameters:

slot - A CkiSlot object representing the slot where to generate the keys.

Throws:

CryptokiException

CkiKeyPairGenerator

public CkiKeyPairGenerator(CkiSession session)

Creates a new CkiKeyPairGenerator

Parameters:

session - A CkiSession object representing the session to use to generate the keys.

Method Detail

setSlot

public void setSlot(CkiSlot slot)
             throws CryptokiException

Set the slot for this CkiKeyPairGenerator.

Parameters:

slot - The slot to be used.

Throws:

CryptokiException

getSlot

public CkiSlot getSlot()

Returns the slot used by this CkiKeyPairGenerator.

Returns:

The CkiSlot object representing the slot.

initialize

public void initialize(int strength,
                       oracle.security.crypto.core.RandomBitsSource rbs)

Initializes the CkiKeyPairGenerator.

Specified by:

initialize in class oracle.security.crypto.core.KeyPairGenerator

Parameters:

strength - The strength of the key pair.

rbs - The RandomBitsSource to be used.

setAlgID

public void setAlgID(oracle.security.crypto.core.AlgorithmIdentifier algID)
              throws oracle.security.crypto.core.AlgorithmIdentifierException

Sets the AlgorithmIdentifier for this KeyPairGenerator object.

Specified by:

setAlgID in class oracle.security.crypto.core.KeyPairGenerator

Throws:

oracle.security.crypto.core.AlgorithmIdentifierException

setTokenPersistent

public void setTokenPersistent(boolean value)

Sets whether or not the generated key pairs are persistent on the token or exist only for the life of the session. Default is true.

getTokenPersistent

public boolean getTokenPersistent()

Returns whether or not the keys will be persistent on the token.

generateKeyPair

public oracle.security.crypto.core.KeyPair generateKeyPair()

Generates the key pair. By default, the tokenPersistent flag is true: in that case the key pair will be persistent on the token.

Specified by:

generateKeyPair in class oracle.security.crypto.core.KeyPairGenerator

Returns:

KeyPair generated on the token. It represents a CkiPublicKey and a CkiPrivateKey.

generateKeyPair

public oracle.security.crypto.core.KeyPair generateKeyPair(boolean tokenPersistent)

Generates the key pair.

Parameters:

tokenPersistent - Specifies whether or not the generated key pair are persistent on the token

Returns:

KeyPair generated on the token. It represents a CkiPublicKey and a CkiPrivateKey.

getAlgorithm

public java.lang.String getAlgorithm()

Gets the algorithm used for the generation of the key pair.

Specified by:

getAlgorithm in class oracle.security.crypto.core.KeyPairGenerator

Returns:

A String representing the algorithm used in this CkiKeyPairGenerator.

setRSAExponent

public void setRSAExponent(int rsaPubExponent)

Sets the RSA public exponent.

Parameters:

rsaPubExponent - The value to be used for the generation of RSA Key Pairs.

getRSAExponent

public int getRSAExponent()

Gets the RSA public exponent value.

Returns:

An int representing the value of the public exponent.