com.entrust.toolkit.credentials

Class TokenPrivateKey

java.lang.Object

com.entrust.toolkit.credentials.TokenKey

com.entrust.toolkit.credentials.TokenPrivateKey

All Implemented Interfaces:

com.entrust.toolkit.security.provider.EntrustPrivateKey, KeyWithLength, java.io.Serializable, java.security.Key, java.security.PrivateKey

Direct Known Subclasses:

TokenDSAPrivateKey, TokenECPrivateKey, TokenRSAPrivateKey

public abstract class TokenPrivateKey
extends TokenKey
implements com.entrust.toolkit.security.provider.EntrustPrivateKey

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

A cryptographic operation performed with this key occurs on the PKCS#11 device. Private keying material is sensitive, critical, non-extractable data; no one has access to it.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	delete()
java.lang.String	getType() Returns the key type, which is "TokenPrivateKey".

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 com.entrust.toolkit.security.provider.PrivateKey

destroyCriticalData

Methods inherited from interface java.security.Key

getAlgorithm, getEncoded, getFormat

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

getKeyLength

Constructor Detail

TokenPrivateKey

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

The constructor; creates a new TokenPrivateKey instance.

Parameters:

pkcs11LC - the connection to the PKCS#11 library

session - the "read only" session

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

slotID - the slot ID under which the session was opened

Method Detail

getType

public final java.lang.String getType()

Returns the key type, which is "TokenPrivateKey".

Returns:

the key type

delete

public final void delete()
                  throws java.security.KeyException

Specified by:

delete in interface com.entrust.toolkit.security.provider.EntrustPrivateKey

Throws:

java.security.KeyException