Package de.christofreichardt.jca.shamir

Class ShamirsKeystore

java.lang.Object

java.security.KeyStoreSpi

de.christofreichardt.jca.shamir.ShamirsKeystore

All Implemented Interfaces:

de.christofreichardt.diagnosis.Traceable

public class ShamirsKeystore
extends KeyStoreSpi
implements de.christofreichardt.diagnosis.Traceable

The actual implementation of the JCA engine class KeyStoreSpi. This interpretation uses some specific KeyStore.LoadStoreParameter and KeyStore.ProtectionParameter classes, see ShamirsLoadParameter and ShamirsProtection. The idea is that the password required to load the KeyStore has been splitted by Shamirs Secret Sharing algorithm into several secret shares. Some subset of these shares is needed to recover the original password. Those methods which aren't expecting one of the protection parameter simply delegate to the underlying PKCS#12 KeyStore implementation of the JDK.

Author:

Christof Reichardt

Constructor Summary

Constructors

Constructor	Description
ShamirsKeystore()	Creates a PKCS#12 KeyStore instance provided by the Java platform.

Method Summary

Modifier and Type	Method	Description
Enumeration<String>	engineAliases()
boolean	engineContainsAlias(String alias)
void	engineDeleteEntry(String alias)
boolean	engineEntryInstanceOf(String alias, Class<? extends KeyStore.Entry> entryClass)
Certificate	engineGetCertificate(String alias)
String	engineGetCertificateAlias(Certificate cert)
Certificate[]	engineGetCertificateChain(String alias)
Date	engineGetCreationDate(String alias)
KeyStore.Entry	engineGetEntry(String alias, KeyStore.ProtectionParameter protectionParameter)	This method expects a ShamirsProtection instance as KeyStore.ProtectionParameter.
Key	engineGetKey(String alias, char[] password)
boolean	engineIsCertificateEntry(String alias)
boolean	engineIsKeyEntry(String alias)
void	engineLoad(InputStream stream, char[] password)
void	engineLoad(KeyStore.LoadStoreParameter loadStoreParameter)	This method expects a ShamirsLoadParameter instance as KeyStore.LoadStoreParameter.
void	engineSetCertificateEntry(String alias, Certificate cert)
void	engineSetEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protectionParameter)	This method expects a ShamirsProtection instance as KeyStore.ProtectionParameter.
void	engineSetKeyEntry(String alias, byte[] key, Certificate[] chain)
void	engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain)
int	engineSize()
void	engineStore(OutputStream stream, char[] password)
void	engineStore(KeyStore.LoadStoreParameter loadStoreParameter)	This method expects a ShamirsLoadParameter instance as KeyStore.LoadStoreParameter.
de.christofreichardt.diagnosis.AbstractTracer	getCurrentTracer()	Switched off.

Methods inherited from class java.security.KeyStoreSpi

engineProbe

Methods inherited from class java.lang.Object

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

Constructor Detail

ShamirsKeystore

public ShamirsKeystore()

Creates a PKCS#12 KeyStore instance provided by the Java platform.

Method Detail

engineGetKey

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

Specified by:

engineGetKey in class KeyStoreSpi

Throws:

NoSuchAlgorithmException

UnrecoverableKeyException

engineGetCertificateChain

public Certificate[] engineGetCertificateChain(String alias)

Specified by:

engineGetCertificateChain in class KeyStoreSpi

engineGetCertificate

public Certificate engineGetCertificate(String alias)

Specified by:

engineGetCertificate in class KeyStoreSpi

engineGetCreationDate

public Date engineGetCreationDate(String alias)

Specified by:

engineGetCreationDate in class KeyStoreSpi

engineSetKeyEntry

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

Specified by:

engineSetKeyEntry in class KeyStoreSpi

Throws:

KeyStoreException

engineSetKeyEntry

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

Specified by:

engineSetKeyEntry in class KeyStoreSpi

Throws:

KeyStoreException

engineGetEntry

public KeyStore.Entry engineGetEntry(String alias,
                                     KeyStore.ProtectionParameter protectionParameter)
                              throws KeyStoreException,
                                     NoSuchAlgorithmException,
                                     UnrecoverableEntryException

This method expects a ShamirsProtection instance as KeyStore.ProtectionParameter. Otherwise an IllegalArgumentException will be thrown. After the recovering of the password the underlying PKCS#12 Keystore of the JDK will be called.

Overrides:

engineGetEntry in class KeyStoreSpi

Parameters:

alias - get the KeyStore.Entry for this alias

protectionParameter - the ShamirsProtection used to protect this entry

Returns:

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, that would be an algorithm for password based encryption

UnrecoverableEntryException - if the key entry cannot be recovered, e.g. the specified protectionParameter were insufficient or invalid

engineSetEntry

public void engineSetEntry(String alias,
                           KeyStore.Entry entry,
                           KeyStore.ProtectionParameter protectionParameter)
                    throws KeyStoreException

This method expects a ShamirsProtection instance as KeyStore.ProtectionParameter. Otherwise an IllegalArgumentException will be thrown. After the recovering of the password the underlying PKCS#12 Keystore of the JDK will be called.

Overrides:

engineSetEntry in class KeyStoreSpi

Parameters:

alias - save the KeyStore.Entry under this alias

entry - the KeyStore.Entry to save

protectionParameter - the ShamirsProtection used to protect the Entry

Throws:

KeyStoreException - if this operation fails

engineSetCertificateEntry

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

Specified by:

engineSetCertificateEntry in class KeyStoreSpi

Throws:

KeyStoreException

engineDeleteEntry

public void engineDeleteEntry(String alias)
                       throws KeyStoreException

Specified by:

engineDeleteEntry in class KeyStoreSpi

Throws:

KeyStoreException

engineAliases

public Enumeration<String> engineAliases()

Specified by:

engineAliases in class KeyStoreSpi

engineContainsAlias

public boolean engineContainsAlias(String alias)

Specified by:

engineContainsAlias in class KeyStoreSpi

engineSize

public int engineSize()

Specified by:

engineSize in class KeyStoreSpi

engineIsKeyEntry

public boolean engineIsKeyEntry(String alias)

Specified by:

engineIsKeyEntry in class KeyStoreSpi

engineIsCertificateEntry

public boolean engineIsCertificateEntry(String alias)

Specified by:

engineIsCertificateEntry in class KeyStoreSpi

engineGetCertificateAlias

public String engineGetCertificateAlias(Certificate cert)

Specified by:

engineGetCertificateAlias in class KeyStoreSpi

engineStore

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

Specified by:

engineStore in class KeyStoreSpi

Throws:

IOException

NoSuchAlgorithmException

CertificateException

engineStore

public void engineStore(KeyStore.LoadStoreParameter loadStoreParameter)
                 throws IOException,
                        NoSuchAlgorithmException,
                        CertificateException

This method expects a ShamirsLoadParameter instance as KeyStore.LoadStoreParameter. Otherwise an IllegalArgumentException will be thrown. After the recovering of the password the underlying PKCS#12 Keystore of the JDK will be called.

Overrides:

engineStore in class KeyStoreSpi

Parameters:

loadStoreParameter - the ShamirsLoadParameter that specifies how to store the keystore

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

engineLoad

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

Specified by:

engineLoad in class KeyStoreSpi

Throws:

IOException

NoSuchAlgorithmException

CertificateException

engineLoad

public void engineLoad(KeyStore.LoadStoreParameter loadStoreParameter)
                throws IOException,
                       NoSuchAlgorithmException,
                       CertificateException

This method expects a ShamirsLoadParameter instance as KeyStore.LoadStoreParameter. Otherwise an IllegalArgumentException will be thrown. After the recovering of the password the underlying PKCS#12 Keystore of the JDK will be called.

Overrides:

engineLoad in class KeyStoreSpi

Parameters:

loadStoreParameter - the ShamirsLoadParameter that specifies how to load the keystore

Throws:

IOException - if there is an I/O or format problem with the keystore data or if the recovered password was incorrect

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

engineEntryInstanceOf

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

Overrides:

engineEntryInstanceOf in class KeyStoreSpi

getCurrentTracer

public de.christofreichardt.diagnosis.AbstractTracer getCurrentTracer()

Switched off.

Specified by:

getCurrentTracer in interface de.christofreichardt.diagnosis.Traceable

Returns:

the NullTracer