com.entrust.toolkit.credentials

Class CapiPrivateKey

java.lang.Object

com.entrust.toolkit.credentials.CapiPrivateKey

All Implemented Interfaces:

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

Direct Known Subclasses:

CapiDsaPrivateKey, CapiRsaPrivateKey

public abstract class CapiPrivateKey
extends java.lang.Object
implements com.entrust.toolkit.security.provider.EntrustPrivateKey

The CapiPrivateKey class represents a private key that is stored in Microsoft's CAPI.

Private key operations, such as signing and decryption, are performed in CAPI. Private keys cannot be extracted from CAPI, there is no way to get the private key information in to Java.

Despite implementing the java.security.Key interface, instances of this class cannot be serialized. Attempting to do so will result in a SecurityException being thrown.

Since:

7.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	delete()
void	destroyCriticalData() Destroys the critical data of this key.
CryptKey	getCryptKey() Returns the CryptKey object associated with this key.
CryptProvider	getCryptProvider() Returns the CryptProvider object associated with this key.
byte[]	getEncoded() Part of the Key interface, always returns null as keys cannot be extracted from CAPI.
java.lang.String	getFormat() Part of the Key interface, always returns null as keys cannot be extracted from CAPI.
static CapiPrivateKey	getInstance(CryptKey cryptKey) Creates and returns a CapiPrivateKey using with an already initialized CAPI provider and key.
java.lang.String	getType() Returns the key type.

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

getAlgorithm

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Method Detail

getInstance

public static CapiPrivateKey getInstance(CryptKey cryptKey)
                                  throws CapiException

Creates and returns a CapiPrivateKey using with an already initialized CAPI provider and key.

Parameters:

cryptKey - the handle to the key within that provider

Returns:

a CapiPrivateKey of the correct type.

Throws:

CapiException - if there is no private key type associated with cryptKey.

getFormat

public java.lang.String getFormat()

Part of the Key interface, always returns null as keys cannot be extracted from CAPI.

Specified by:

getFormat in interface java.security.Key

Returns:

null

getEncoded

public byte[] getEncoded()

Part of the Key interface, always returns null as keys cannot be extracted from CAPI.

Specified by:

getEncoded in interface java.security.Key

Returns:

null

destroyCriticalData

public final void destroyCriticalData()

Destroys the critical data of this key. Releases any open handles to the CAPI Provider and key. Any calls to or use of this object after calling this method will have undetermined results.

delete

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

Specified by:

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

Throws:

java.security.KeyException

getType

public final java.lang.String getType()

Returns the key type.

Returns:

"CapiPrivateKey"

getCryptKey

public CryptKey getCryptKey()

Returns the CryptKey object associated with this key. This object is required to use CAPI functions that require a key.

Returns:

the CryptKey object associated with this key.

getCryptProvider

public CryptProvider getCryptProvider()

Returns the CryptProvider object associated with this key. This object is required for CAPI functions that require a provider.

Returns:

the CryptProvider object associated with this key.