org.imixs.signature.service

Class KeystoreService

java.lang.Object

org.imixs.signature.service.KeystoreService

public class KeystoreService
extends Object

The KeystoreService provides methods to open a java keystore and find certificates by alias

The service is implemented as a singleton to avoid concurrent access from different clients.

Version:

1.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_SIGNATURE_KEYSTORE_PASSWORD
static String	ENV_SIGNATURE_KEYSTORE_PATH
static String	ENV_SIGNATURE_KEYSTORE_TYPE

Constructor Summary

Constructors

Constructor and Description
KeystoreService()
KeystoreService(String keyStorePath, String keyStorePassword, String keyStoreType)

Method Summary

Modifier and Type	Method and Description
Certificate[]	loadCertificate(String alias) Loads a certificate chain by a given alias.
PrivateKey	loadPrivateKey(String alias) Loads a private key by a given alias name with an empty password.
PrivateKey	loadPrivateKey(String alias, String password) Loads a private key by a given alias name and password.
KeyStore	openKeyStore() Open a java keyStore based on the environment variables SIGNATURE_KEYSTORE_PATH , SIGNATURE_KEYSTORE_TYPE and SIGNATURE_KEYSTORE_PASSWORD
void	storeCertificate(Certificate[] certificateChain, PrivateKey privKey, String password, String alias) This method stores the certificate into the keystore.

Methods inherited from class java.lang.Object

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

Field Detail

ENV_SIGNATURE_KEYSTORE_PATH

public static final String ENV_SIGNATURE_KEYSTORE_PATH

See Also:

Constant Field Values

ENV_SIGNATURE_KEYSTORE_PASSWORD

public static final String ENV_SIGNATURE_KEYSTORE_PASSWORD

See Also:

Constant Field Values

ENV_SIGNATURE_KEYSTORE_TYPE

public static final String ENV_SIGNATURE_KEYSTORE_TYPE

See Also:

Constant Field Values

Constructor Detail

KeystoreService

public KeystoreService(String keyStorePath,
                       String keyStorePassword,
                       String keyStoreType)

KeystoreService

public KeystoreService()

Method Detail

openKeyStore

public KeyStore openKeyStore()
                      throws KeyStoreException,
                             NoSuchAlgorithmException,
                             CertificateException,
                             FileNotFoundException,
                             IOException

Open a java keyStore based on the environment variables SIGNATURE_KEYSTORE_PATH , SIGNATURE_KEYSTORE_TYPE and SIGNATURE_KEYSTORE_PASSWORD

Throws:

KeyStoreException

IOException

FileNotFoundException

CertificateException

NoSuchAlgorithmException

loadCertificate

public Certificate[] loadCertificate(String alias)

Loads a certificate chain by a given alias.

If a certificate for the given alias name does not exist in the keystore than the default alias (SIGNATURE_KEYSTORE_DEFAULT_ALIAS) will be loaded.

The method returns null if no certificate was found!

Throws:

CertificateException

NoSuchAlgorithmException

KeyStoreException

loadPrivateKey

public PrivateKey loadPrivateKey(String alias,
                                 String password)

Loads a private key by a given alias name and password. The password can be null if the key was stored into the keystore with an empty password.

Parameters:

alias -

Returns:

PrivateKey or null if not found

loadPrivateKey

public PrivateKey loadPrivateKey(String alias)

Loads a private key by a given alias name with an empty password.

Parameters:

alias -

Returns:

PrivateKey or null if not found

storeCertificate

public void storeCertificate(Certificate[] certificateChain,
                             PrivateKey privKey,
                             String password,
                             String alias)
                      throws KeyStoreException,
                             NoSuchAlgorithmException,
                             CertificateException,
                             IOException

This method stores the certificate into the keystore.

Parameters:

certificateChain - - the certificate chain to be stored

privKey - - the associated private key

password - - optional password to protect the entry, can be null

alias - - alias name to store the entry

Throws:

KeyStoreException

IOException

CertificateException

NoSuchAlgorithmException

Exception