com.microej.crypto.internal

Class DefaultKeyStore

java.lang.Object

java.security.KeyStoreSpi

com.microej.crypto.internal.DefaultKeyStore

public class DefaultKeyStore
extends KeyStoreSpi

This default keystore implementation supports both certificate and key entry.

The content of this keystore can not be load from an inputstream when the method engineLoad(InputStream, char[]) is called.

The methods engineSetCertificateEntry(String, Certificate) and engineDeleteEntry(String) are used to add/remove certificates to/from this keystore. The method engineSetKeyEntry(String, byte[], Certificate[]) is used to set a private key with it associated certificate chain. the private key must be an encrypted DER (ASN1) private key in PKCS#8 format.

Constructor Summary

Constructors

Constructor and Description
DefaultKeyStore()

Method Summary

Modifier and Type	Method and Description
Enumeration<String>	engineAliases() Lists all the alias names of this keystore.
boolean	engineContainsAlias(String alias) Checks if the given alias exists in this keystore.
void	engineDeleteEntry(String alias) Deletes the entry identified by the given alias from this keystore.
Certificate	engineGetCertificate(String alias) Returns the certificate associated with the given alias.
Certificate[]	engineGetCertificateChain(String alias) Returns the certificate chain associated with the given alias.
Key	engineGetKey(String alias, char[] password) Returns the key associated with the given alias, using the given password to recover it.
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.
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(InputStream stream, char[] password) Loads the keystore from the given input stream.
void	engineSetCertificateEntry(String alias, Certificate cert) Assigns the given certificate to the given alias.
void	engineSetKeyEntry(String alias, byte[] key, Certificate[] chain) Assigns the given key (that has already been protected) to the given alias.
void	engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain)
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

DefaultKeyStore

public DefaultKeyStore()

Method Detail

engineAliases

public Enumeration<String> engineAliases()

Description copied from class: KeyStoreSpi

Lists all the alias names of this keystore.

Specified by:

engineAliases in class KeyStoreSpi

Returns:

enumeration of the alias names

engineContainsAlias

public boolean engineContainsAlias(String alias)

Description copied from class: KeyStoreSpi

Checks if the given alias exists in this keystore.

Specified by:

engineContainsAlias in class KeyStoreSpi

Parameters:

alias - the alias name

Returns:

true if the alias exists, false otherwise

engineDeleteEntry

public void engineDeleteEntry(String alias)
                       throws KeyStoreException

Description copied from class: KeyStoreSpi

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

Specified by:

engineDeleteEntry in class KeyStoreSpi

Parameters:

alias - the alias name

Throws:

KeyStoreException - if the entry cannot be removed.

engineGetCertificate

public Certificate engineGetCertificate(String alias)

Description copied from class: KeyStoreSpi

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.

Specified by:

engineGetCertificate in class KeyStoreSpi

Parameters:

alias - the alias name

Returns:

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

engineGetCertificateChain

public Certificate[] engineGetCertificateChain(String alias)

Description copied from class: KeyStoreSpi

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.

Specified by:

engineGetCertificateChain in class KeyStoreSpi

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

engineGetKey

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

Description copied from class: KeyStoreSpi

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.

Specified by:

engineGetKey in class KeyStoreSpi

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

engineIsCertificateEntry

public boolean engineIsCertificateEntry(String alias)

Description copied from class: KeyStoreSpi

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.

Specified by:

engineIsCertificateEntry in class KeyStoreSpi

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.

engineIsKeyEntry

public boolean engineIsKeyEntry(String alias)

Description copied from class: KeyStoreSpi

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.

Specified by:

engineIsKeyEntry in class KeyStoreSpi

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.

engineLoad

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

Description copied from class: KeyStoreSpi

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.

Specified by:

engineLoad in class KeyStoreSpi

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

engineSetCertificateEntry

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

Description copied from class: KeyStoreSpi

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.

Specified by:

engineSetCertificateEntry in class KeyStoreSpi

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.

engineSetKeyEntry

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

Description copied from class: KeyStoreSpi

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

Specified by:

engineSetKeyEntry in class KeyStoreSpi

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.

engineSetKeyEntry

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

Throws:

KeyStoreException

engineSize

public int engineSize()

Description copied from class: KeyStoreSpi

Retrieves the number of entries in this keystore.

Specified by:

engineSize in class KeyStoreSpi

Returns:

the number of entries in this keystore