com.entrust.toolkit.credentials

Class KeychainPrivateKey

java.lang.Object

com.entrust.toolkit.credentials.KeychainPrivateKey

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:

KeychainEcPrivateKey, KeychainRsaPrivateKey

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeychainPrivateKey(KeychainKey key) The constructor for a KeychainPrivateKey.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the private key.
void	destroyCriticalData() Destroy the Critical Data for this Keychain Private Key
abstract java.lang.String	getAlgorithm() The abstract method getAlgorithm which all Keychain key types will return
byte[]	getEncoded() Returns the key in its primary encoding format, or null if this key does not support encoding.
java.lang.String	getFormat() Returns the name of the primary encoding format of this key, or null if this key does not support encoding.
static KeychainPrivateKey	getInstance(KeychainKey keychainKey) Creates and returns a KeyChainPrivateKey using with an already initialized Keychainkey.
static KeychainPrivateKey	getInstance(X509Certificate cert) Get an instance of a KeychainPrivateKey that is associated with the specified certificate.
KeychainKey	getKeychainKey()
java.lang.String	getType() Returns the type of this private key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Constructor Detail

KeychainPrivateKey

public KeychainPrivateKey(KeychainKey key)
                   throws KeychainException

The constructor for a KeychainPrivateKey. It takes a KeychainKey

Parameters:

key - the keychainKey

Throws:

KeychainException

Method Detail

getInstance

public static KeychainPrivateKey getInstance(KeychainKey keychainKey)
                                      throws KeychainException

Creates and returns a KeyChainPrivateKey using with an already initialized Keychainkey.

Parameters:

keychainKey - the handle to the key within the Keychain

Returns:

a KeychainPrivateKey of the correct type.

Throws:

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

getInstance

public static KeychainPrivateKey getInstance(X509Certificate cert)
                                      throws KeychainException

Get an instance of a KeychainPrivateKey that is associated with the specified certificate. If no KeychainPrivateKey is found in the keychain for the given certificate a KeychainException will be thrown.

Parameters:

cert - The certificate to use to search for the private key

Returns:

the KeychainPrivateKey or null if no corresponding key found in the keychain

Throws:

KeychainException

getKeychainKey

public KeychainKey getKeychainKey()

Returns:

the KeychainKey associated with this KeychainPrivateKey

destroyCriticalData

public void destroyCriticalData()

Destroy the Critical Data for this Keychain Private Key

getType

public java.lang.String getType()

Description copied from interface: PrivateKey

Returns the type of this private key.

Currently, the following private key types are supported in the Toolkit:

• ConfinedPrivateKey - ConfinedPrivateKey
• TokenPrivateKey - TokenPrivateKey
• CapiPrivateKey - CapiPrivateKey
• CapiDummyPrivateKey - CapiDummyPrivateKey

Returns:

the type of key that is represented by this object. In this case it is a KeyChainPrivateKey

getAlgorithm

public abstract java.lang.String getAlgorithm()

The abstract method getAlgorithm which all Keychain key types will return

Specified by:

getAlgorithm in interface java.security.Key

getFormat

public java.lang.String getFormat()

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. Since this key does not support encoding, it always returns null

Specified by:

getFormat in interface java.security.Key

Returns:

the primary encoding format of null since this key does not support encoding

getEncoded

public byte[] getEncoded()

Returns the key in its primary encoding format, or null if this key does not support encoding.

Specified by:

getEncoded in interface java.security.Key

Returns:

null since we do not allow returned the encoded key

delete

public void delete()
            throws java.security.KeyException

Deletes the private key.

The effect of this operation depends on the underlying key type. For keys stored in the Keychain it deletes the key from the Keychain

Specified by:

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

Throws:

java.security.KeyException - if an error occurs while attempting to delete the key