com.entrust.toolkit.credentials

Class TokenRSAPrivateKey

java.lang.Object

com.entrust.toolkit.credentials.TokenKey

com.entrust.toolkit.credentials.TokenPrivateKey

com.entrust.toolkit.credentials.TokenRSAPrivateKey

All Implemented Interfaces:

com.entrust.toolkit.security.provider.EntrustPrivateKey, KeyWithLength, java.io.Serializable, java.security.interfaces.RSAKey, java.security.interfaces.RSAPrivateKey, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable

public final class TokenRSAPrivateKey
extends TokenPrivateKey
implements java.security.interfaces.RSAPrivateKey

This class represents an RSA private key key that is stored on a PKCS#11 device.

A cryptographic operation performed with this key occurs on the PKCS#11 device.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenRSAPrivateKey(PKCS11LibraryConnection pkcs11LC, long session, long objectHandle, long slotID) The constructor; creates a new TokenRSAPrivateKey instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm() Returns the standard algorithm name for this key, which is "RSA".
int	getKeyLength() Return the length of the key in bits.
java.math.BigInteger	getModulus() Returns the modulus.
java.math.BigInteger	getPrivateExponent() Not supported.

Methods inherited from class com.entrust.toolkit.credentials.TokenPrivateKey

delete, getType

Methods inherited from class com.entrust.toolkit.credentials.TokenKey

assertMechanismSupported, destroyCriticalData, getEncoded, getFormat, getObjectHandle, getPKCS11LibraryConnection, getSession, getSlotID, setOwner

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Key

getEncoded, getFormat

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Methods inherited from interface java.security.interfaces.RSAKey

getParams

Methods inherited from interface com.entrust.toolkit.security.provider.PrivateKey

destroyCriticalData

Constructor Detail

TokenRSAPrivateKey

public TokenRSAPrivateKey(PKCS11LibraryConnection pkcs11LC,
                          long session,
                          long objectHandle,
                          long slotID)

The constructor; creates a new TokenRSAPrivateKey instance.

Parameters:

pkcs11LC - the connection to the PKCS#11 library

session - the "read only" session

objectHandle - the handle to the private key on the PKCS#11 device

slotID - the slot ID under which the session was opened

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()

Returns the standard algorithm name for this key, which is "RSA".

Specified by:

getAlgorithm in interface java.security.Key

Returns:

the standard name of the algorithm for this key

getModulus

public java.math.BigInteger getModulus()

Returns the modulus.

Note: Because this key is stored on a PKCS#11 device, this call extracts the modulus value from the device.

Specified by:

getModulus in interface java.security.interfaces.RSAKey

Returns:

the modulus

getKeyLength

public int getKeyLength()

Return the length of the key in bits.

For example, an RSA-1024 key, this API would return 1024.

Note: Because this key is stored on a PKCS#11 device, this call extracts the key length from the device.

Specified by:

getKeyLength in interface KeyWithLength

Returns:

the key length (in bits)

Since:

7.2 SP2

getPrivateExponent

public java.math.BigInteger getPrivateExponent()

Not supported.

Specified by:

getPrivateExponent in interface java.security.interfaces.RSAPrivateKey

Throws:

java.lang.RuntimeException - always thrown indicating that this API is not supported