Package org.bouncycastle.jcajce.provider.keystore.bc

Class BcKeyStoreSpi

java.lang.Object

java.security.KeyStoreSpi

org.bouncycastle.jcajce.provider.keystore.bc.BcKeyStoreSpi

All Implemented Interfaces:

BCKeyStore

Direct Known Subclasses:

BcKeyStoreSpi.BouncyCastleStore, BcKeyStoreSpi.Std, BcKeyStoreSpi.Version1

public class BcKeyStoreSpi
extends KeyStoreSpi
implements BCKeyStore

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BcKeyStoreSpi.BouncyCastleStore	the BouncyCastle store.
static class	BcKeyStoreSpi.Std
static class	BcKeyStoreSpi.Version1

Field Summary

Fields

Modifier and Type	Field	Description
protected SecureRandom	random
protected Hashtable	table
protected int	version

Constructor Summary

Constructors

Constructor	Description
BcKeyStoreSpi(int version)

Method Summary

Modifier and Type	Method	Description
Enumeration	engineAliases()	Returns an Enumeration over all alias names stored in this KeyStoreSpi.
boolean	engineContainsAlias(String alias)	Indicates whether the given alias is present in this KeyStoreSpi.
void	engineDeleteEntry(String alias)	Deletes the entry identified with the given alias from this KeyStoreSpi.
Certificate	engineGetCertificate(String alias)	Returns the trusted certificate for the entry with the given alias.
String	engineGetCertificateAlias(Certificate cert)	Returns the alias associated with the first entry whose certificate matches the specified certificate.
Certificate[]	engineGetCertificateChain(String alias)	Returns the certificate chain for the entry with the given alias.
Date	engineGetCreationDate(String alias)	Returns the creation date of the entry with the given alias.
Key	engineGetKey(String alias, char[] password)	Returns the key with the given alias, using the password to recover the key from the store.
boolean	engineIsCertificateEntry(String alias)	Indicates whether the specified alias is associated with a KeyStore.TrustedCertificateEntry.
boolean	engineIsKeyEntry(String alias)	Indicates whether the specified alias is associated with either a KeyStore.PrivateKeyEntry or a KeyStore.SecretKeyEntry.
void	engineLoad(InputStream stream, char[] password)	Loads this KeyStoreSpi from the given InputStream.
void	engineSetCertificateEntry(String alias, Certificate cert)	Associates the given alias with a certificate.
void	engineSetKeyEntry(String alias, byte[] key, Certificate[] chain)	Associates the given alias with a key and a certificate chain.
void	engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain)	Associates the given alias with the key, password and certificate chain.
int	engineSize()	Returns the number of entries stored in this KeyStoreSpi.
void	engineStore(OutputStream stream, char[] password)	Writes this KeyStoreSpi to the specified OutputStream.
protected void	loadStore(InputStream in)
protected Cipher	makePBECipher(String algorithm, int mode, char[] password, byte[] salt, int iterationCount)
protected void	saveStore(OutputStream out)
void	setRandom(SecureRandom rand)	set the random source for the key store

Methods inherited from class java.security.KeyStoreSpi

engineEntryInstanceOf, engineGetEntry, engineLoad, engineSetEntry, engineStore

Methods inherited from class java.lang.Object

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

Field Detail

table

protected Hashtable table

random

protected SecureRandom random

version

protected int version

Constructor Detail

BcKeyStoreSpi

public BcKeyStoreSpi(int version)

Method Detail

makePBECipher

protected Cipher makePBECipher(String algorithm,
                               int mode,
                               char[] password,
                               byte[] salt,
                               int iterationCount)
                        throws IOException

Throws:

IOException

setRandom

public void setRandom(SecureRandom rand)

Description copied from interface: BCKeyStore

set the random source for the key store

Specified by:

setRandom in interface BCKeyStore

engineAliases

public Enumeration engineAliases()

Description copied from class: KeyStoreSpi

Returns an Enumeration over all alias names stored in this KeyStoreSpi.

Specified by:

engineAliases in class KeyStoreSpi

Returns:

an Enumeration over all alias names stored in this KeyStoreSpi.

engineContainsAlias

public boolean engineContainsAlias(String alias)

Description copied from class: KeyStoreSpi

Indicates whether the given alias is present in this KeyStoreSpi.

Specified by:

engineContainsAlias in class KeyStoreSpi

Parameters:

alias - the alias of an entry.

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 with the given alias from this KeyStoreSpi.

Specified by:

engineDeleteEntry in class KeyStoreSpi

Parameters:

alias - the alias for the entry.

Throws:

KeyStoreException - if the entry can not be deleted.

engineGetCertificate

public Certificate engineGetCertificate(String alias)

Description copied from class: KeyStoreSpi

Returns the trusted certificate for the entry with the given alias.

Specified by:

engineGetCertificate in class KeyStoreSpi

Parameters:

alias - the alias for the entry.

Returns:

the trusted certificate for the entry with the given alias, or null if the specified alias is not bound to an entry.

engineGetCertificateAlias

public String engineGetCertificateAlias(Certificate cert)

Description copied from class: KeyStoreSpi

Returns the alias associated with the first entry whose certificate matches the specified certificate.

Specified by:

engineGetCertificateAlias in class KeyStoreSpi

Parameters:

cert - the certificate to find the associated entry's alias for.

Returns:

the alias or null if no entry with the specified certificate can be found.

engineGetCertificateChain

public Certificate[] engineGetCertificateChain(String alias)

Description copied from class: KeyStoreSpi

Returns the certificate chain for the entry with the given alias.

Specified by:

engineGetCertificateChain in class KeyStoreSpi

Parameters:

alias - the alias for the entry

Returns:

the certificate chain for the entry with the given alias, or null if the specified alias is not bound to an entry.

engineGetCreationDate

public Date engineGetCreationDate(String alias)

Description copied from class: KeyStoreSpi

Returns the creation date of the entry with the given alias.

Specified by:

engineGetCreationDate in class KeyStoreSpi

Parameters:

alias - the alias for the entry.

Returns:

the creation date, or null if the specified alias is not bound to an entry.

engineGetKey

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

Description copied from class: KeyStoreSpi

Returns the key with the given alias, using the password to recover the key from the store.

Specified by:

engineGetKey in class KeyStoreSpi

Parameters:

alias - the alias for the entry.

password - the password used to recover the key.

Returns:

the key with the specified alias, or null if the specified alias is not bound to an entry.

Throws:

NoSuchAlgorithmException - if the algorithm for recovering the key is not available.

UnrecoverableKeyException - if the key can not be recovered.

engineIsCertificateEntry

public boolean engineIsCertificateEntry(String alias)

Description copied from class: KeyStoreSpi

Indicates whether the specified alias is associated with a KeyStore.TrustedCertificateEntry.

Specified by:

engineIsCertificateEntry in class KeyStoreSpi

Parameters:

alias - the alias of an entry.

Returns:

true if the given alias is associated with a certificate entry.

engineIsKeyEntry

public boolean engineIsKeyEntry(String alias)

Description copied from class: KeyStoreSpi

Indicates whether the specified alias is associated with either a KeyStore.PrivateKeyEntry or a KeyStore.SecretKeyEntry.

Specified by:

engineIsKeyEntry in class KeyStoreSpi

Parameters:

alias - the alias of an entry.

Returns:

true if the given alias is associated with a key entry.

engineSetCertificateEntry

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

Description copied from class: KeyStoreSpi

Associates the given alias with a certificate.

If the specified alias already exists, it will be reassigned.

Specified by:

engineSetCertificateEntry in class KeyStoreSpi

Parameters:

alias - the alias for the certificate.

cert - the certificate.

Throws:

KeyStoreException - if an existing alias is not associated to an entry containing a trusted certificate, or this method fails for any other reason.

engineSetKeyEntry

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

Description copied from class: KeyStoreSpi

Associates the given alias with a key and a certificate chain.

If the specified alias already exists, it will be reassigned.

Specified by:

engineSetKeyEntry in class KeyStoreSpi

Parameters:

alias - the alias for the key.

key - the key in an encoded format.

chain - the certificate chain.

Throws:

KeyStoreException - if this operation fails.

engineSetKeyEntry

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

Description copied from class: KeyStoreSpi

Associates the given alias with the key, password and certificate chain.

If the specified alias already exists, it will be reassigned.

Specified by:

engineSetKeyEntry in class KeyStoreSpi

Parameters:

alias - the alias for the key.

key - the key.

password - the password.

chain - the certificate chain.

Throws:

KeyStoreException - if the specified key can not be protected, or if this operation fails for another reason.

engineSize

public int engineSize()

Description copied from class: KeyStoreSpi

Returns the number of entries stored in this KeyStoreSpi.

Specified by:

engineSize in class KeyStoreSpi

Returns:

the number of entries stored in this KeyStoreSpi.

loadStore

protected void loadStore(InputStream in)
                  throws IOException

Throws:

IOException

saveStore

protected void saveStore(OutputStream out)
                  throws IOException

Throws:

IOException

engineLoad

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

Description copied from class: KeyStoreSpi

Loads this KeyStoreSpi from the given InputStream. Utilizes the given password to verify the stored data.

Specified by:

engineLoad in class KeyStoreSpi

Parameters:

stream - the InputStream to load this KeyStoreSpi's data from.

password - the password to verify the stored data, maybe null.

Throws:

IOException - if a problem occurred while reading from the stream.

engineStore

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

Description copied from class: KeyStoreSpi

Writes this KeyStoreSpi to the specified OutputStream. The data written to the OutputStream is protected by the specified password.

Specified by:

engineStore in class KeyStoreSpi

Parameters:

stream - the OutputStream to write the store's data to.

password - the password to protect the data.

Throws:

IOException - if a problem occurred while writing to the stream.