se.litsec.opensaml.utils.spring

Class PrivateKeyEntryFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<KeyStore.PrivateKeyEntry>

se.litsec.opensaml.utils.spring.PrivateKeyEntryFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<KeyStore.PrivateKeyEntry>, org.springframework.beans.factory.InitializingBean

public class PrivateKeyEntryFactoryBean
extends org.springframework.beans.factory.config.AbstractFactoryBean<KeyStore.PrivateKeyEntry>

An implementation of a Spring FactoryBean that reads a JKS-file and extracts a private key with its certificate.

Author:

Martin Lindström (martin@litsec.se)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	alias The alias holding the private key entry.
protected char[]	keyPassword The password for unlocking the key.
protected org.springframework.core.io.Resource	storeLocation The resource holding the keystore.
protected char[]	storePassword The keystore password.
protected String	storeType The type of keystore.

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Constructor Summary

Constructors

Constructor and Description
PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation, char[] storePassword) Constructor setting up a factory bean that will load the JKS-file given by storeLocation, unlock it and then load the private key entry using the storePassword.
PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation, char[] storePassword, String storeType) Constructor setting up a factory bean that will load the keystore of the given type from storeLocation, unlock it and then load the private key entry using the storePassword.
PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation, char[] storePassword, String alias, char[] keyPassword) Constructor setting up a factory bean the will load a JKS-store, unlock it and locate and unlock the given private key entry identified by alias.
PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation, char[] storePassword, String storeType, String alias, char[] keyPassword) Constructor setting up a factory bean the will load a keystore of the given type, unlock it and locate and unlock the given private key entry identified by alias.

Method Summary

Modifier and Type	Method and Description
protected KeyStore.PrivateKeyEntry	createInstance()
void	destroy()
protected void	destroyInstance(KeyStore.PrivateKeyEntry instance)
Class<? extends KeyStore.PrivateKeyEntry>	getObjectType()

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Field Detail

storeLocation

protected org.springframework.core.io.Resource storeLocation

The resource holding the keystore.

storePassword

protected char[] storePassword

The keystore password.

storeType

protected String storeType

The type of keystore.

alias

protected String alias

The alias holding the private key entry. If null the first private key entry is selected.

keyPassword

protected char[] keyPassword

The password for unlocking the key. If null the store password will be used.

Constructor Detail

PrivateKeyEntryFactoryBean

public PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation,
                                  char[] storePassword)

Constructor setting up a factory bean that will load the JKS-file given by storeLocation, unlock it and then load the private key entry using the storePassword.

This constructor should be used if the caller knows that the keystore only contains one private key entry that has the same password as the store itself. However, if the keystore contains several private key entries, the first one that can be unlocked using the keystore password will be returned.

Parameters:

storeLocation - the path to the JKS-file

storePassword - the password for unlocking the JKS-file

See Also:

PrivateKeyEntryFactoryBean(Resource, char[], String, char[])

PrivateKeyEntryFactoryBean

public PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation,
                                  char[] storePassword,
                                  String storeType)

Constructor setting up a factory bean that will load the keystore of the given type from storeLocation, unlock it and then load the private key entry using the storePassword.

This constructor should be used if the caller knows that the keystore only contains one private key entry that has the same password as the store itself. However, if the keystore contains several private key entries, the first one that can be unlocked using the keystore password will be returned.

Parameters:

storeLocation - the path to the keystore

storePassword - the password for unlocking the keystore

storeType - the type of keystore ("jks", "pkcs12", ...)

See Also:

PrivateKeyEntryFactoryBean(Resource, char[], String, String, char[])

PrivateKeyEntryFactoryBean

public PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation,
                                  char[] storePassword,
                                  String alias,
                                  char[] keyPassword)

Constructor setting up a factory bean the will load a JKS-store, unlock it and locate and unlock the given private key entry identified by alias.

Parameters:

storeLocation - the path to the JKS-file

storePassword - the password for unlocking the keystore

alias - keystore alias for the private key entry

keyPassword - the password for unlocking the private key entry

PrivateKeyEntryFactoryBean

public PrivateKeyEntryFactoryBean(org.springframework.core.io.Resource storeLocation,
                                  char[] storePassword,
                                  String storeType,
                                  String alias,
                                  char[] keyPassword)

Constructor setting up a factory bean the will load a keystore of the given type, unlock it and locate and unlock the given private key entry identified by alias.

Parameters:

storeLocation - the path to the JKS-file

storePassword - the password for unlocking the keystore

storeType - the type of keystore ("jks", "pkcs12", ...)

alias - keystore alias for the private key entry

keyPassword - the password for unlocking the private key entry

Method Detail

createInstance

protected KeyStore.PrivateKeyEntry createInstance()
                                           throws Exception

Specified by:

createInstance in class org.springframework.beans.factory.config.AbstractFactoryBean<KeyStore.PrivateKeyEntry>

Throws:

Exception

getObjectType

public Class<? extends KeyStore.PrivateKeyEntry> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<KeyStore.PrivateKeyEntry>

Specified by:

getObjectType in class org.springframework.beans.factory.config.AbstractFactoryBean<KeyStore.PrivateKeyEntry>

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Overrides:

destroy in class org.springframework.beans.factory.config.AbstractFactoryBean<KeyStore.PrivateKeyEntry>

Throws:

Exception

destroyInstance

protected void destroyInstance(KeyStore.PrivateKeyEntry instance)
                        throws Exception

Overrides:

destroyInstance in class org.springframework.beans.factory.config.AbstractFactoryBean<KeyStore.PrivateKeyEntry>

Throws:

Exception