iaik.security.keystore

Class IAIKKeyStore

java.lang.Object

java.security.KeyStoreSpi

iaik.security.keystore.IAIKKeyStore

public final class IAIKKeyStore
extends java.security.KeyStoreSpi

This class implements the Service Provider Interface (SPI) for the KeyStore class. The KeyStore provides privacy and integrity when saving private keys, secret keys, and certificates.

If you want to instantiate an IAIKKeyStore object, specify keystore type and package provider.

 KeyStore ks = KeyStore.getInstance("IAIKKeyStore", "IAIK");
 

Before a IAIKKeyStore can be used, it must be loaded. You must even load the IAIKKeyStore in the case you instantiate a new empty IAIKKeyStore object.

 ks.load(inputStream, password);
 

If you instantiate a new empty IAIKKeyStore object, the parameters shall be null.

 ks.load(null, null);
 

Details on the IAIK KeyStore implementation:

The IAIK implementation of the KeyStore uses the password based key derivation function 2 from the PKCS#5 v2.1: Password-Based Cryptography Standard (RFC 8018).

The private and secret keys are encrypted with the AES in cipher block chaining mode using a 256 bit key. The integrity of the KeyStore, when written to disk, is provided by applying HmacSHA3-512.

Abstract Syntax Notation 1and Distinguished Encoding Rules are used, when the KeyStore is written to disk.

 KeyStore ::= SEQUENCE {
   keyStoreRecords KeyStoreRecords,
   keyDerivationAlgorithm AlgorithmIdentifier,
   macValue OCTET STRING }
 
 AlgorithmIdentifier ::= SEQUENCE {
   algorithm OBJECT IDENTIFIER ::= {iso(1) member-body(2) US(840)
                                    rsadsi(113549) pkcs(1) pkcs-5(5) 9},
   parameters Salt }
 
 Salt ::= OCTET STRING
 
 KeyStoreRecords ::= SEQUENCE OF KeyStoreRecord
 
 KeyStoreRecord ::= SEQUENCE {
   alias OCTET STRING,
   keyStoreEntry KeyStoreEntry }
 
 KeyStoreEntry ::= SEQUENCE {
   creationDate MilliSecondsSince1970,
   secretKey [0] EXPLICIT EncryptedKeyInfo OPTIONAL,
   encryptedKey [1] EXPLICIT EncryptedKeyInfo OPTIONAL,
   encryptedPrivateKey [2] EXPLICIT EncryptedPrivateKeyInfo OPTIONAL,
   cert [3] EXPLICIT CertificateChain OPTIONAL }
 
 MilliSecondsSince1970 ::= INTEGER
 
 EncryptedKeyInfo ::= SEQUENCE {
   encryptionAlgorithm AlgorithmIdentifier,
   encryptedData EncryptedData }
 
 CertificateChain ::= SEQUENCE OF Certificate
 
 

Since:

JDK1.2

Version:

File Revision 45

Constructor Summary

Constructors

Constructor and Description
IAIKKeyStore() This is the default constructor

Method Summary

Methods

Modifier and Type	Method and Description
static java.security.KeyStore	convertKeyStore(java.security.KeyStore oldKeyStore, char[] password) Converts a KeyStore of old format (%lt; v5.5) to new format.
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	setKeyStoreVersion(int version) Sets the IAIKKeyStore version to be used.

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

Constructor Detail

IAIKKeyStore

public IAIKKeyStore()

This is the default constructor

Method Detail

setKeyStoreVersion

public static final void setKeyStoreVersion(int version)

Sets the IAIKKeyStore version to be used.

Before IAIK-JCE version 5.5 the IAIKKeyStore has used HMAC/SHA-1 and TripleDES for mac calculation and encryption (instead of HmacSHA3-512, AES 256 bit and increased salt and iteration count values since version 5.5). Although reading of the old format is still supported an application may still use the old (V0) version to store key stores for backwards compatibility with former IAIK-JCE versions (although this may not be recommended). With this method the default key store version can be reset to version 0 or 1.

Parameters:

version - the IAIKKeyStore version (0 or 1 or 2)

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. If the key is an instance of EncryptedPrivateKeyInfo the password can be null.

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. The password can be null if the key is already protected in a EncryptedPrivateKeyInfo. You do not have to specify a certificate chain to a private 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 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. The key must be a DER encoded EncryptedPrivateKeyInfo. Note: You can also store a EncryptedPrivateKeyInfo with method engineSetKeyEntry(alias, key, password, chain)

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

If the given alias already exists in this keystore and identifies a trusted certificate entry, the certificate associated with it is overridden by the given certificate.

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.

This method attempts to match the given certificate with each keystore entry. If the entry being considered is a trusted certificate entry, the given certificate is compared to that entry's certificate. If the entry being considered is a key entry, the given certificate is compared to the first element of its certificate chain (if a chain exists).

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

convertKeyStore

public static final java.security.KeyStore convertKeyStore(java.security.KeyStore oldKeyStore,
                                     char[] password)
                                                    throws java.security.KeyStoreException

Converts a KeyStore of old format (%lt; v5.5) to new format. The new format uses stronger algorithms (HMAC/SHA3-512, AES 256 bit instead of HMAC/SHA-1, 3DES) and higher salt (32 bytes instead of 16 bytes) and iteration count values (2000 instead of 1000).

Parameters:

oldKeyStore - the old key store

password - the KeyStore password

Returns:

the new KeyStore

Throws:

java.security.KeyStoreException