com.entrust.toolkit.credentials

Class TokenSymmetricKey

java.lang.Object

com.entrust.toolkit.credentials.TokenKey

com.entrust.toolkit.credentials.TokenSymmetricKey

All Implemented Interfaces:

KeyWithLength, java.io.Serializable, java.security.Key, javax.crypto.SecretKey, javax.security.auth.Destroyable

public class TokenSymmetricKey
extends TokenKey
implements javax.crypto.SecretKey

This class represents a symmetric (aka: secret) key that is stored on a PKCS#11 device.

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

Since:

7.2 SP2 Patch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenSymmetricKey(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.
int	getKeyLength() Returns the length of this key (in bits).
SymmetricKeyType	getKeyType() Returns the type of this key.

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

Constructor Detail

TokenSymmetricKey

public TokenSymmetricKey(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 symmetric 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.

For example, "AES" would indicate that this key is an AES key. Refer to SymmetricKeyType for a list of supported symmetric key types

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

Specified by:

getAlgorithm in interface java.security.Key

Returns:

the name of the algorithm associated with this key.

getKeyType

public SymmetricKeyType getKeyType()

Returns the type of this key.

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

Returns:

key type

getKeyLength

public int getKeyLength()

Returns the length of this key (in bits).

For example, an AES-256 key, this API would return 256.

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