Added in API level 1

Summary: Ctors | Methods | Inherited Methods

KeyStoreSpi

public abstract class KeyStoreSpi
extends Object

java.lang.Object
↳	java.security.KeyStoreSpi

---

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.

See also:

• KeyStore

Summary

Public constructors
KeyStoreSpi()

Public methods
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.
boolean	engineEntryInstanceOf(String alias, Class<? extends KeyStore.Entry> entryClass) Determines if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass.
abstract Certificate	engineGetCertificate(String alias) Returns the certificate associated with the given alias.
abstract String	engineGetCertificateAlias(Certificate cert) Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.
abstract Certificate[]	engineGetCertificateChain(String alias) Returns the certificate chain associated with the given alias.
abstract Date	engineGetCreationDate(String alias) Returns the creation date of the entry identified by the given alias.
KeyStore.Entry	engineGetEntry(String alias, KeyStore.ProtectionParameter protParam) Gets a KeyStore.Entry for the specified alias with the specified protection parameter.
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.
void	engineLoad(KeyStore.LoadStoreParameter param) Loads the keystore using the given KeyStore.LoadStoreParameter.
abstract void	engineLoad(InputStream stream, char[] password) Loads the keystore from the given input stream.
boolean	engineProbe(InputStream stream) Probes the specified input stream to determine whether it contains a keystore that is supported by this implementation, or not.
abstract void	engineSetCertificateEntry(String alias, Certificate cert) Assigns the given certificate to the given alias.
void	engineSetEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam) Saves a KeyStore.Entry under the specified alias.
abstract void	engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain) Assigns the given key to the given alias, protecting it with the given password.
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.
void	engineStore(KeyStore.LoadStoreParameter param) Stores this keystore using the given KeyStore.LoadStoreParmeter.
abstract void	engineStore(OutputStream stream, char[] password) Stores this keystore to the given output stream, and protects its integrity with the given password.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

KeyStoreSpi

Added in API level 1

public KeyStoreSpi ()

Public methods

engineAliases

Added in API level 1

public abstract Enumeration<String> engineAliases ()

Lists all the alias names of this keystore.

Returns
Enumeration<String>	enumeration of the alias names

engineContainsAlias

Added in API level 1

public abstract boolean engineContainsAlias (String alias)

Checks if the given alias exists in this keystore.

Parameters
alias	String: the alias name

Returns
boolean	true if the alias exists, false otherwise

engineDeleteEntry

Added in API level 1

public abstract void engineDeleteEntry (String alias)

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

Parameters
alias	String: the alias name

Throws
KeyStoreException	if the entry cannot be removed.

engineEntryInstanceOf

Added in API level 1

public boolean engineEntryInstanceOf (String alias, 
                Class<? extends KeyStore.Entry> entryClass)

Determines if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass.

Parameters
alias	String: the alias name
entryClass	Class: the entry class

Returns
boolean	true if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass, false otherwise

engineGetCertificate

Added in API level 1

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	String: the alias name

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

engineGetCertificateAlias

Added in API level 1

public abstract String engineGetCertificateAlias (Certificate cert)

Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.

This method attempts to match the given certificate with each keystore entry. If the entry being considered was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, then the given certificate is compared to that entry's certificate.

If the entry being considered was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry, then the given certificate is compared to the first element of that entry's certificate chain.

Parameters
cert	Certificate: the certificate to match with.

Returns
String	the alias name of the first entry with matching certificate, or null if no such entry exists in this keystore.

engineGetCertificateChain

Added in API level 1

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	String: the alias name

Returns
Certificate[]	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

engineGetCreationDate

Added in API level 1

public abstract Date engineGetCreationDate (String alias)

Returns the creation date of the entry identified by the given alias.

Parameters
alias	String: the alias name

Returns
Date	the creation date of this entry, or null if the given alias does not exist

engineGetEntry

Added in API level 1

public KeyStore.Entry engineGetEntry (String alias, 
                KeyStore.ProtectionParameter protParam)

Gets a KeyStore.Entry for the specified alias with the specified protection parameter.

Parameters
alias	String: get the KeyStore.Entry for this alias
protParam	KeyStore.ProtectionParameter: the ProtectionParameter used to protect the Entry, which may be null

Returns
KeyStore.Entry	the KeyStore.Entry for the specified alias, or null if there is no such entry

Throws
KeyStoreException	if the operation failed
NoSuchAlgorithmException	if the algorithm for recovering the entry cannot be found
UnrecoverableEntryException	if the specified protParam were insufficient or invalid
UnrecoverableKeyException	if the entry is a PrivateKeyEntry or SecretKeyEntry and the specified protParam does not contain the information needed to recover the key (e.g. wrong password)

engineGetKey

Added in API level 1

public abstract Key engineGetKey (String alias, 
                char[] password)

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	String: the alias name
password	char: the password for recovering the key

Returns
Key	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).

engineIsCertificateEntry

Added in API level 1

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	String: the alias for the keystore entry to be checked

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

engineIsKeyEntry

Added in API level 1

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	String: the alias for the keystore entry to be checked

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

engineLoad

Added in API level 1

public void engineLoad (KeyStore.LoadStoreParameter param)

Loads the keystore using the given KeyStore.LoadStoreParameter.

Note that if this KeyStore has already been loaded, it is reinitialized and loaded again from the given parameter.

Parameters
param	KeyStore.LoadStoreParameter: the KeyStore.LoadStoreParameter that specifies how to load the keystore, which may be null

Throws
IllegalArgumentException	if the given KeyStore.LoadStoreParameter input is not recognized
IOException	if there is an I/O or format problem with the keystore data. If the error is due to an incorrect ProtectionParameter (e.g. 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

engineLoad

Added in API level 1

public abstract void engineLoad (InputStream stream, 
                char[] password)

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	InputStream: the input stream from which the keystore is loaded, or null
password	char: 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

engineProbe

Added in API level 33

public boolean engineProbe (InputStream stream)

Probes the specified input stream to determine whether it contains a keystore that is supported by this implementation, or not.

Implementation Requirements:

• This method returns false by default. Keystore implementations should override this method to peek at the data stream directly or to use other content detection mechanisms.

Parameters
stream	InputStream: the keystore data to be probed

Returns
boolean	true if the keystore data is supported, otherwise false

Throws
IOException	if there is an I/O problem with the keystore data.
NullPointerException	if stream is null.

engineSetCertificateEntry

Added in API level 1

public abstract void engineSetCertificateEntry (String alias, 
                Certificate cert)

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	String: the alias name
cert	Certificate: 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.

engineSetEntry

Added in API level 1

public void engineSetEntry (String alias, 
                KeyStore.Entry entry, 
                KeyStore.ProtectionParameter protParam)

Saves a KeyStore.Entry under the specified alias. The specified protection parameter is used to protect the Entry.

If an entry already exists for the specified alias, it is overridden.

Parameters
alias	String: save the KeyStore.Entry under this alias
entry	KeyStore.Entry: the Entry to save
protParam	KeyStore.ProtectionParameter: the ProtectionParameter used to protect the Entry, which may be null

Throws
KeyStoreException	if this operation fails

engineSetKeyEntry

Added in API level 1

public abstract void engineSetKeyEntry (String alias, 
                Key key, 
                char[] password, 
                Certificate[] chain)

Assigns the given key to the given alias, protecting it with the given password.

If the given 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	String: the alias name
key	Key: the key to be associated with the alias
password	char: the password to protect the key
chain	Certificate: the certificate chain for the corresponding public key (only required if the given key is of type java.security.PrivateKey).

Throws
KeyStoreException	if the given key cannot be protected, or this operation fails for some other reason

engineSetKeyEntry

Added in API level 1

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

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	String: the alias name
key	byte: the key (in protected format) to be associated with the alias
chain	Certificate: 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.

engineSize

Added in API level 1

public abstract int engineSize ()

Retrieves the number of entries in this keystore.

Returns
int	the number of entries in this keystore

engineStore

Added in API level 1

public void engineStore (KeyStore.LoadStoreParameter param)

Stores this keystore using the given KeyStore.LoadStoreParmeter.

Parameters
param	KeyStore.LoadStoreParameter: the KeyStore.LoadStoreParmeter that specifies how to store the keystore, which may be null

Throws
IllegalArgumentException	if the given KeyStore.LoadStoreParmeter input is not recognized
IOException	if there was an I/O problem with data
NoSuchAlgorithmException	if the appropriate data integrity algorithm could not be found
CertificateException	if any of the certificates included in the keystore data could not be stored

engineStore

Added in API level 1

public abstract void engineStore (OutputStream stream, 
                char[] password)

Stores this keystore to the given output stream, and protects its integrity with the given password.

Parameters
stream	OutputStream: the output stream to which this keystore is written.
password	char: the password to generate the keystore integrity check

Throws
IOException	if there was an I/O problem with data
NoSuchAlgorithmException	if the appropriate data integrity algorithm could not be found
CertificateException	if any of the certificates included in the keystore data could not be stored