com.entrust.toolkit.credentials

Class TokenECPrivateKey

java.lang.Object

com.entrust.toolkit.credentials.TokenKey

com.entrust.toolkit.credentials.TokenPrivateKey

com.entrust.toolkit.credentials.TokenECPrivateKey

All Implemented Interfaces:

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

public class TokenECPrivateKey
extends TokenPrivateKey
implements java.security.interfaces.ECPrivateKey

This class represents an EC 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
TokenECPrivateKey(PKCS11LibraryConnection pkcs11LC, long session, long objectHandle, long slotID) The constructor; creates a new TokenECPrivateKey instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm() Returns the standard algorithm name for this key, which is "EC".
int	getKeyLength() Return the length of the key in bits.
java.security.spec.ECParameterSpec	getParams() Returns the domain parameters associated with this key.
java.math.BigInteger	getS() 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 com.entrust.toolkit.security.provider.PrivateKey

destroyCriticalData

Constructor Detail

TokenECPrivateKey

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

The constructor; creates a new TokenECPrivateKey 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 "EC".

Specified by:

getAlgorithm in interface java.security.Key

Returns:

the standard name of the algorithm for this key

getParams

public java.security.spec.ECParameterSpec getParams()

Returns the domain parameters associated with this key. The domain parameters are either explicitly specified or implicitly created during key generation.

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

Specified by:

getParams in interface java.security.interfaces.ECKey

Returns:

the associated domain parameters.

getKeyLength

public int getKeyLength()

Return the length of the key in bits.

For example, an EC-P-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

Returns:

the key length (in bits)

Since:

7.2 SP2

getS

public java.math.BigInteger getS()

Not supported.

Specified by:

getS in interface java.security.interfaces.ECPrivateKey

Throws:

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