java.security

Class KeyStoreSpi

java.lang.Object

java.security.KeyStoreSpi

public abstract class KeyStoreSpi
extends Object

This class defines the Service Provider Interface (SPI) for the KeyStore class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a keystore for a particular keystore type.

Since:

1.2

Author:

Jan Luehe

See Also:

KeyStore

Constructor Summary

Constructors

Constructor and Description
KeyStoreSpi()

Method Summary

Modifier and Type	Method and Description
abstract Enumeration<String>	engineAliases() Lists all the alias names of this keystore.
abstract boolean	engineContainsAlias(String alias) Checks if the given alias exists in this keystore.
abstract void	engineDeleteEntry(String alias) Deletes the entry identified by the given alias from this keystore.
abstract Certificate	engineGetCertificate(String alias) Returns the certificate associated with the given alias.
abstract Certificate[]	engineGetCertificateChain(String alias) Returns the certificate chain associated with the given alias.
abstract Key	engineGetKey(String alias, char[] password) Returns the key associated with the given alias, using the given password to recover it.
abstract boolean	engineIsCertificateEntry(String alias) Returns true if the entry identified by the given alias was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry.
abstract boolean	engineIsKeyEntry(String alias) Returns true if the entry identified by the given alias was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry or a SecretKeyEntry.
abstract void	engineLoad(InputStream stream, char[] password) Loads the keystore from the given input stream.
abstract void	engineSetCertificateEntry(String alias, Certificate cert) Assigns the given certificate to the given alias.
abstract void	engineSetKeyEntry(String alias, byte[] key, Certificate[] chain) Assigns the given key (that has already been protected) to the given alias.
abstract int	engineSize() Retrieves the number of entries in this keystore.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreSpi

public KeyStoreSpi()

Method Detail

engineGetKey

@Nullable
public abstract Key engineGetKey(String alias,
                                            char[] password)
                                     throws NoSuchAlgorithmException,
                                            UnrecoverableKeyException

Returns the key associated with the given alias, using the given password to recover it. The key must have been associated with the alias by a call to setKeyEntry, or by a call to setEntry with a PrivateKeyEntry or SecretKeyEntry.

Parameters:

alias - the alias name

password - the password for recovering the key

Returns:

the requested key, or null if the given alias does not exist or does not identify a key-related entry.

Throws:

NoSuchAlgorithmException - if the algorithm for recovering the key cannot be found

UnrecoverableKeyException - if the key cannot be recovered (e.g., the given password is wrong).

engineGetCertificateChain

@Nullable
public abstract Certificate[] engineGetCertificateChain(String alias)

Returns the certificate chain associated with the given alias. The certificate chain must have been associated with the alias by a call to setKeyEntry, or by a call to setEntry with a PrivateKeyEntry.

Parameters:

alias - the alias name

Returns:

the certificate chain (ordered with the user's certificate first and the root certificate authority last), or null if the given alias does not exist or does not contain a certificate chain

engineGetCertificate

@Nullable
public abstract Certificate engineGetCertificate(String alias)

Returns the certificate associated with the given alias.

If the given alias name identifies an entry created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, then the trusted certificate contained in that entry is returned.

If the given alias name identifies an entry created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry, then the first element of the certificate chain in that entry (if a chain exists) is returned.

Parameters:

alias - the alias name

Returns:

the certificate, or null if the given alias does not exist or does not contain a certificate.

engineSetKeyEntry

public abstract void engineSetKeyEntry(String alias,
                                       byte[] key,
                                       Certificate[] chain)
                                throws KeyStoreException

Assigns the given key (that has already been protected) to the given alias.

If the protected key is of type java.security.PrivateKey, it must be accompanied by a certificate chain certifying the corresponding public key.

If the given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).

Parameters:

alias - the alias name

key - the key (in protected format) to be associated with the alias

chain - the certificate chain for the corresponding public key (only useful if the protected key is of type java.security.PrivateKey).

Throws:

KeyStoreException - if this operation fails.

engineSetCertificateEntry

public abstract void engineSetCertificateEntry(String alias,
                                               Certificate cert)
                                        throws KeyStoreException

Assigns the given certificate to the given alias.

If the given alias identifies an existing entry created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, the trusted certificate in the existing entry is overridden by the given certificate.

Parameters:

alias - the alias name

cert - the certificate

Throws:

KeyStoreException - if the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason.

engineDeleteEntry

public abstract void engineDeleteEntry(String alias)
                                throws KeyStoreException

Deletes the entry identified by the given alias from this keystore.

Parameters:

alias - the alias name

Throws:

KeyStoreException - if the entry cannot be removed.

engineAliases

public abstract Enumeration<String> engineAliases()

Lists all the alias names of this keystore.

Returns:

enumeration of the alias names

engineContainsAlias

public abstract boolean engineContainsAlias(String alias)

Checks if the given alias exists in this keystore.

Parameters:

alias - the alias name

Returns:

true if the alias exists, false otherwise

engineSize

public abstract int engineSize()

Retrieves the number of entries in this keystore.

Returns:

the number of entries in this keystore

engineIsKeyEntry

public abstract boolean engineIsKeyEntry(String alias)

Returns true if the entry identified by the given alias was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry or a SecretKeyEntry.

Parameters:

alias - the alias for the keystore entry to be checked

Returns:

true if the entry identified by the given alias is a key-related, false otherwise.

engineIsCertificateEntry

public abstract boolean engineIsCertificateEntry(String alias)

Returns true if the entry identified by the given alias was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry.

Parameters:

alias - the alias for the keystore entry to be checked

Returns:

true if the entry identified by the given alias contains a trusted certificate, false otherwise.

engineLoad

public abstract void engineLoad(@Nullable
                                InputStream stream,
                                @Nullable
                                char[] password)
                         throws IOException,
                                NoSuchAlgorithmException,
                                CertificateException

Loads the keystore from the given input stream.

A password may be given to unlock the keystore (e.g. the keystore resides on a hardware token device), or to check the integrity of the keystore data. If a password is not given for integrity checking, then integrity checking is not performed.

Parameters:

stream - the input stream from which the keystore is loaded, or null

password - the password used to check the integrity of the keystore, the password used to unlock the keystore, or null

Throws:

IOException - if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect. If the error is due to a wrong password, the cause of the IOException should be an UnrecoverableKeyException

NoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be found

CertificateException - if any of the certificates in the keystore could not be loaded