com.entrust.toolkit.credentials

Class TokenDSAPrivateKey

java.lang.Object

com.entrust.toolkit.credentials.TokenKey

com.entrust.toolkit.credentials.TokenPrivateKey

com.entrust.toolkit.credentials.TokenDSAPrivateKey

All Implemented Interfaces:

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

public final class TokenDSAPrivateKey
extends TokenPrivateKey
implements java.security.interfaces.DSAPrivateKey

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm() Returns the standard algorithm name for this key, which is "DSA".
int	getKeyLength() Return the length of the key in bits.
java.security.interfaces.DSAParams	getParams() Returns the DSA-specific key parameters.
java.math.BigInteger	getX() 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

TokenDSAPrivateKey

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

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

Specified by:

getAlgorithm in interface java.security.Key

Returns:

the standard name of the algorithm for this key

getParams

public java.security.interfaces.DSAParams getParams()

Returns the DSA-specific key parameters. These parameters are never secret.

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

Specified by:

getParams in interface java.security.interfaces.DSAKey

Returns:

the DSA-specific key parameters

getKeyLength

public int getKeyLength()

Return the length of the key in bits.

For example, for a DSA-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 Patch

getX

public java.math.BigInteger getX()
                          throws java.lang.RuntimeException

Not supported.

Specified by:

getX in interface java.security.interfaces.DSAPrivateKey

Throws:

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