iaik.utils

Class UniversalKeyStore

java.lang.Object

java.security.KeyStoreSpi

iaik.utils.UniversalKeyStore

Direct Known Subclasses:

ExtendedUniversalKeyStore, UniversalKeyStore.PKCS12JKSKeyStore

public class UniversalKeyStore
extends java.security.KeyStoreSpi

Universal KeyStore utility for reading Java key stores without using a specific format.

The universal KeyStore may be used to read a Java KeyStore in the accustomed way by the JDK KeyStore API but without having the necessity of explicitly specifying the actual KeyStore type. This might be useful when supporting KeyStores of arbitrary (pre-defined) type and providers.
By the default the Universal KeyStore supports the KeyStore types "PKCS12" and "IAIKKeyStore" meaning that the Universal KeyStore first tries the PKCS12 format when reading a KeyStore and then -- if PKSC12 fails -- tries the IAIKKeyStore format:

 // stream from which to read the (PKCS12 or IAIK)KeyStore
 InputStream is = ...;
 // the keystore password
 char[] pwd = ...;
 // create the KeyStore
 KeyStore keyStore = KeyStore.getInstance("Universal", "IAIK");
 // load the KeyStore:
 keyStore.load(is, pwd);
 // perform any KeyStore operations (like querying for aliases or fetch keys/certificates)
 Enumeration aliases = ks.aliases();
 ...
 

When creating an entire new key store the key store will have the format of the first supported type (PKCS12 by default).

If you want to support other or additional key store format than the default types you must specify them by calling method setSupportedKeyStoreTypes before using the KeyStore. To, for instance, reverse the order of the default KeyStore types (PKCS12, IAIKKeyStore) you may call:

 UniversalKeyStore.setSupportedKeyStoreTypes(new KeyStoreType[] {
   UniversalKeyStore.KS_TYPE_IAIK,
   UniversalKeyStore.KS_TYPE_PKCS12,
   new KeyStoreType("JKS", "SUN")
 });
 

You also may specify/add and use key store types of other than the IAIK provider:

 String otherKeyStoreType = ...,
 String otherProvider = ...;
 UniversalKeyStore.setSupportedKeyStoreTypes(new KeyStoreType[] {
   UniversalKeyStore.KS_TYPE_PKCS12,
   UniversalKeyStore.KS_TYPE_IAIK,
   new KeyStoreType(otherKeyStoreType, otherProvider)
 });
 

Note that using the UniversalKeyStore may cause some certain overhead when parsing a KeyStore because it might be necessary to try several formats and because the KeyStore API has to wrapped by the KeyStore SPI. Furthermore -- when failing to parse a KeyStore -- the final error message may not entirely represent the actual reason of the parsing failure. Therefore you should use the UniversalKeyStore only if you are sure about the supported KeyStore formats and if you not have to take care of the actual KeyStore format.

Version:

File Revision 45

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UniversalKeyStore.KeyStoreType Identifies a KeyStore by its type (e.g.
static class	UniversalKeyStore.PKCS12JKSKeyStore UniversalKeyStore with "PKCS12" as primary KeyStore type and "JKS" as secondary (fallback) type to may be used to solve JSSE default KeyStore parsing problems.

Field Summary

Fields

Modifier and Type	Field and Description
static UniversalKeyStore.KeyStoreType	KS_TYPE_IAIK KeyStore type for the IAIKKeyStore.
static UniversalKeyStore.KeyStoreType	KS_TYPE_PKCS12 KeyStore type for the IAIK PKCS12KeyStore.

Constructor Summary

Constructors

Constructor and Description
UniversalKeyStore() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Enumeration	engineAliases() Lists all aliases contained in the keystore.
boolean	engineContainsAlias(java.lang.String alias) Checks if the given alias exists in this keystore.
void	engineDeleteEntry(java.lang.String alias) Deletes the entry identified by the given alias from the keystore.
java.security.cert.Certificate	engineGetCertificate(java.lang.String alias) Returns the certificate associated with the given alias.
java.lang.String	engineGetCertificateAlias(java.security.cert.Certificate cert) Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.
java.security.cert.Certificate[]	engineGetCertificateChain(java.lang.String alias) Returns the certificate chain associated with the given alias.
java.util.Date	engineGetCreationDate(java.lang.String alias) Returns the creation date of the entry identified by the given alias.
java.security.Key	engineGetKey(java.lang.String alias, char[] password) Returns the key associated with the given alias, using the given password to recover it.
boolean	engineIsCertificateEntry(java.lang.String alias) Returns true if the entry identified by the given alias is a trusted certificate entry, and false otherwise.
boolean	engineIsKeyEntry(java.lang.String alias) Returns true if the entry identified by the given alias is a key entry, and false otherwise.
void	engineLoad(java.io.InputStream stream, char[] password) Loads the keystore from the given input stream.
void	engineSetCertificateEntry(java.lang.String alias, java.security.cert.Certificate cert) Assigns the given certificate to the given alias.
void	engineSetKeyEntry(java.lang.String alias, byte[] key, java.security.cert.Certificate[] chain) Assigns the given key (that has already been protected) to the given alias.
void	engineSetKeyEntry(java.lang.String alias, java.security.Key key, char[] password, java.security.cert.Certificate[] chain) Assigns the given key to the given alias, protecting it with the given password.
int	engineSize() Retrieves the number of entries in this keystore.
void	engineStore(java.io.OutputStream stream, char[] password) Writes this keystore to the given output stream, and protects its integrity with the specified password.
static void	setSupportedKeyStoreTypes(UniversalKeyStore.KeyStoreType[] keyStoreTypes) Sets the list of supported KeyStore types.

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

KS_TYPE_PKCS12

public static final UniversalKeyStore.KeyStoreType KS_TYPE_PKCS12

KeyStore type for the IAIK PKCS12KeyStore.

KS_TYPE_IAIK

public static final UniversalKeyStore.KeyStoreType KS_TYPE_IAIK

KeyStore type for the IAIKKeyStore.

Constructor Detail

UniversalKeyStore

public UniversalKeyStore()

Default constructor.

Method Detail

setSupportedKeyStoreTypes

public static final void setSupportedKeyStoreTypes(UniversalKeyStore.KeyStoreType[] keyStoreTypes)

Sets the list of supported KeyStore types.

Parameters:

keyStoreTypes - the List of supported KeyStore types.

engineGetKey

public java.security.Key engineGetKey(java.lang.String alias,
                             char[] password)
                               throws java.security.NoSuchAlgorithmException,
                                      java.security.UnrecoverableKeyException

Returns the key associated with the given alias, using the given password to recover it.

Specified by:

engineGetKey in class java.security.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 entry.

Throws:

java.security.NoSuchAlgorithmException - if the algorithm for recovering the key cannot be found

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

engineGetCertificateChain

public java.security.cert.Certificate[] engineGetCertificateChain(java.lang.String alias)

Returns the certificate chain associated with the given alias.

Specified by:

engineGetCertificateChain in class java.security.KeyStoreSpi

Parameters:

alias - the alias name

Returns:

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

engineGetCertificate

public java.security.cert.Certificate engineGetCertificate(java.lang.String alias)

Returns the certificate associated with the given alias.

If the given alias name identifies a trusted certificate entry, the certificate associated with that entry is returned. If the given alias name identifies a key entry, the first element of the certificate chain is returned, or null if that entry does not have a certificate chain.

Specified by:

engineGetCertificate in class java.security.KeyStoreSpi

Parameters:

alias - the alias name

Returns:

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

engineGetCreationDate

public java.util.Date engineGetCreationDate(java.lang.String alias)

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

Specified by:

engineGetCreationDate in class java.security.KeyStoreSpi

Parameters:

alias - the alias name

Returns:

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

engineSetKeyEntry

public void engineSetKeyEntry(java.lang.String alias,
                     java.security.Key key,
                     char[] password,
                     java.security.cert.Certificate[] chain)
                       throws java.security.KeyStoreException

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

Specified by:

engineSetKeyEntry in class java.security.KeyStoreSpi

Parameters:

alias - the alias name

key - the key to be associated with the alias

password - the password to protect the key

chain - the certificate chain for the corresponding public key

Throws:

java.security.KeyStoreException - if the given key cannot be protected, or this operation fails for some other reason

engineSetKeyEntry

public void engineSetKeyEntry(java.lang.String alias,
                     byte[] key,
                     java.security.cert.Certificate[] chain)
                       throws java.security.KeyStoreException

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

Specified by:

engineSetKeyEntry in class java.security.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:

java.security.KeyStoreException - if this operation fails for some reason

engineSetCertificateEntry

public void engineSetCertificateEntry(java.lang.String alias,
                             java.security.cert.Certificate cert)
                               throws java.security.KeyStoreException

Assigns the given certificate to the given alias.

Specified by:

engineSetCertificateEntry in class java.security.KeyStoreSpi

Parameters:

alias - the alias name

cert - the certificate

Throws:

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

engineDeleteEntry

public void engineDeleteEntry(java.lang.String alias)
                       throws java.security.KeyStoreException

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

Specified by:

engineDeleteEntry in class java.security.KeyStoreSpi

Parameters:

alias - the alias name

Throws:

java.security.KeyStoreException - if the entry cannot be removed.

engineAliases

public java.util.Enumeration engineAliases()

Lists all aliases contained in the keystore.

Specified by:

engineAliases in class java.security.KeyStoreSpi

Returns:

enumeration of the alias names

engineContainsAlias

public boolean engineContainsAlias(java.lang.String alias)

Checks if the given alias exists in this keystore.

Specified by:

engineContainsAlias in class java.security.KeyStoreSpi

Parameters:

alias - the alias name

Returns:

true if the alias exists, false otherwise

engineSize

public int engineSize()

Retrieves the number of entries in this keystore.

Specified by:

engineSize in class java.security.KeyStoreSpi

Returns:

the number of entries in this keystore

engineIsKeyEntry

public boolean engineIsKeyEntry(java.lang.String alias)

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

Specified by:

engineIsKeyEntry in class java.security.KeyStoreSpi

Returns:

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

engineIsCertificateEntry

public boolean engineIsCertificateEntry(java.lang.String alias)

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

Specified by:

engineIsCertificateEntry in class java.security.KeyStoreSpi

Returns:

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

engineGetCertificateAlias

public java.lang.String engineGetCertificateAlias(java.security.cert.Certificate cert)

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

Specified by:

engineGetCertificateAlias in class java.security.KeyStoreSpi

Parameters:

cert - the certificate to match with.

Returns:

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

engineStore

public void engineStore(java.io.OutputStream stream,
               char[] password)
                 throws java.io.IOException,
                        java.security.NoSuchAlgorithmException,
                        java.security.cert.CertificateException

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

Specified by:

engineStore in class java.security.KeyStoreSpi

Parameters:

stream - the output stream to which this keystore is written.

password - the password to generate the keystore integrity check

Throws:

java.io.IOException - if there was an I/O problem with data

java.security.NoSuchAlgorithmException - if the appropriate data integrity algorithm could not be found

java.security.cert.CertificateException - if any of the certificates included in the keystore data could not be stored

engineLoad

public void engineLoad(java.io.InputStream stream,
              char[] password)
                throws java.io.IOException,
                       java.security.NoSuchAlgorithmException,
                       java.security.cert.CertificateException

Loads the keystore from the given input stream.

If a password is given, it is used to check the integrity of the keystore data. Otherwise, the integrity of the keystore is not checked.

Specified by:

engineLoad in class java.security.KeyStoreSpi

Parameters:

stream - the input stream from which the keystore is loaded

password - the (optional) password used to check the integrity of the keystore.

Throws:

java.io.IOException - if there is an I/O or format problem with the keystore data

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

java.security.cert.CertificateException - if any of the certificates in the keystore could not be loaded