be.bosa.commons.eid.jca

Class BeIDKeyStore

java.lang.Object

java.security.KeyStoreSpi

be.bosa.commons.eid.jca.BeIDKeyStore

public class BeIDKeyStore
extends KeyStoreSpi

eID based JCA KeyStore. Used to load eID key material via standard JCA API calls. Once the JCA security provider has been registered you have a new key store available named "BeID". Two key aliases are available:

• "Authentication" which gives you access to the eID authentication private key and corresponding certificate chain.
• "Signature" which gives you access to the eID non-repudiation private key and corresponding certificate chain.

Further the Citizen CA certificate can be accessed via the "CA" alias, the Root CA certificate can be accessed via the "Root" alias, and the national registration certificate can be accessed via the "RRN" alias.
Supports the eID specific BeIDKeyStoreParameter key store parameter. You can also let any JFrame implement the KeyStore.LoadStoreParameter interface. If you pass this to KeyStore.load(LoadStoreParameter) the keystore will use that Swing frame as parent for positioning the dialogs.
Usage:

 import java.security.KeyStore;
 import java.security.cert.X509Certificate;
 import java.security.PrivateKey;
 
 ...
 KeyStore keyStore = KeyStore.getInstance("BeID");
 keyStore.load(null);
 X509Certificate authnCertificate = (X509Certificate) keyStore
                        .getCertificate("Authentication");
 PrivateKey authnPrivateKey = (PrivateKey) keyStore.getKey(
                        "Authentication", null);
 Certificate[] signCertificateChain = keyStore.getCertificateChain("Signature");
 

Author:

Frank Cornelis

See Also:

BeIDKeyStoreParameter, BeIDProvider

Constructor Summary

Constructors

Constructor and Description
BeIDKeyStore()

Method Summary

Modifier and Type	Method and 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 protParam)
Key	engineGetKey(String alias, char[] password)
boolean	engineIsCertificateEntry(String alias)
boolean	engineIsKeyEntry(String alias)
void	engineLoad(InputStream stream, char[] password)
void	engineLoad(KeyStore.LoadStoreParameter param)
void	engineSetCertificateEntry(String alias, Certificate cert)
void	engineSetEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam)
void	engineSetKeyEntry(String alias, byte[] key, Certificate[] chain)
void	engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain)
int	engineSize()
void	engineStore(KeyStore.LoadStoreParameter param)
void	engineStore(OutputStream stream, char[] password)
BeIDCard	getBeIDCard(boolean recover)

Methods inherited from class java.lang.Object

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

Constructor Detail

BeIDKeyStore

public BeIDKeyStore()

Method Detail

engineGetKey

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

Specified by:

engineGetKey in class KeyStoreSpi

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

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

engineStore

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

Overrides:

engineStore in class KeyStoreSpi

Throws:

IOException

NoSuchAlgorithmException

CertificateException

engineGetEntry

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

Overrides:

engineGetEntry in class KeyStoreSpi

Throws:

KeyStoreException

NoSuchAlgorithmException

UnrecoverableEntryException

engineSetEntry

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

Overrides:

engineSetEntry in class KeyStoreSpi

Throws:

KeyStoreException

engineEntryInstanceOf

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

Overrides:

engineEntryInstanceOf in class KeyStoreSpi

engineGetCertificateAlias

public String engineGetCertificateAlias(Certificate cert)

Specified by:

engineGetCertificateAlias in class KeyStoreSpi

engineStore

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

Specified by:

engineStore in class KeyStoreSpi

engineLoad

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

Specified by:

engineLoad in class KeyStoreSpi

engineLoad

public void engineLoad(KeyStore.LoadStoreParameter param)
                throws NoSuchAlgorithmException

Overrides:

engineLoad in class KeyStoreSpi

Throws:

NoSuchAlgorithmException

getBeIDCard

public BeIDCard getBeIDCard(boolean recover)