com.entrust.toolkit.credentials

Class TokenKey

java.lang.Object

com.entrust.toolkit.credentials.TokenKey

All Implemented Interfaces:

KeyWithLength

Direct Known Subclasses:

TokenPrivateKey, TokenSymmetricKey

public abstract class TokenKey
extends java.lang.Object
implements KeyWithLength

The base class for all cryptographic keys that reside on a PKCS#11 device.

Contains the common elements required by both symmetric and asymmetric implementations.

Since:

7.2 SP2 Patch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	assertMechanismSupported(long mechanism) Asserts that the given PKCS#11 mechanism is supported on the PKCS#11 device on which this key resides on.
void	destroyCriticalData() Destroys any critical data contained in this object.
byte[]	getEncoded() Returns null since this key implementation does not support encoding.
java.lang.String	getFormat() Returns null since this key implementation does not support encoding.
long	getObjectHandle() The handle to the key on the PKCS#11 device
PKCS11LibraryConnection	getPKCS11LibraryConnection() Returns the connection to the PKCS#11 library.
long	getSession() The opened "read-only" session with the PKCS#11 device.
long	getSlotID() Returns the slot ID under which the session was opened.
void	setOwner(java.lang.Object owner) Sets the owner of this TokenKey.

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.KeyWithLength

getKeyLength

Constructor Detail

TokenKey

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

The constructor; creates a new TokenKey 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

getPKCS11LibraryConnection

public final PKCS11LibraryConnection getPKCS11LibraryConnection()

Returns the connection to the PKCS#11 library.

Returns:

the PKCS#11 library connection

getSession

public final long getSession()

The opened "read-only" session with the PKCS#11 device.

Returns:

The "read-only" session

getObjectHandle

public final long getObjectHandle()

The handle to the key on the PKCS#11 device

Returns:

the key handle

getSlotID

public final long getSlotID()

Returns the slot ID under which the session was opened.

Returns:

the slot ID

destroyCriticalData

public final void destroyCriticalData()

Destroys any critical data contained in this object.

This wipes any internal variables that can be used to access the key on the PKCS#11 device.

assertMechanismSupported

public final void assertMechanismSupported(long mechanism)
                                    throws java.security.InvalidKeyException

Asserts that the given PKCS#11 mechanism is supported on the PKCS#11 device on which this key resides on.

Parameters:

mechanism - a PKCS#11 mechanism

Throws:

java.security.InvalidKeyException - if the given PKCS#11 mechanism is supported

getEncoded

public final byte[] getEncoded()

Returns null since this key implementation does not support encoding.

Returns:

null (encoding is not supported)

getFormat

public final java.lang.String getFormat()

Returns null since this key implementation does not support encoding.

Returns:

null (encoding is not supported)

setOwner

public final void setOwner(java.lang.Object owner)

Sets the owner of this TokenKey. This should only be called by an Object (such as EntrustKeyStoreSpi) whose finalize will trigger destroyCriticalData in this TokenKey. Recording that object here prevents early destruction.

Parameters:

owner - An object whose finalize will render this TokenKey useless.