Module net.shibboleth.ext.spring

Package net.shibboleth.ext.spring.factory

Class PKCS11PrivateKeyFactoryBean

java.lang.Object

net.shibboleth.ext.spring.factory.PKCS11PrivateKeyFactoryBean

All Implemented Interfaces:

FactoryBean<PrivateKey>

public class PKCS11PrivateKeyFactoryBean
extends Object
implements FactoryBean<PrivateKey>

Spring bean factory for extracting a PrivateKey from a PKCS#11 keystore. This relies on the SunPKCS11 provider.

Field Summary

Fields

Modifier and Type	Field	Description
private PrivateKey	key	The singleton instance of the private key produced by this factory.
private String	keyAlias	Alias for the private key.
private String	keyPassword	Password for the private key.
private org.slf4j.Logger	log	Class logger.
private String	pkcs11Config	PKCS#11 provider parameter string.
private static Provider	provider	Singleton Provider for all instances of this factory.
private static String	PROVIDER_CLASS_NAME	The class name for the PKCS#11 provider class.

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
PKCS11PrivateKeyFactoryBean()

Method Summary

Modifier and Type	Method	Description
String	getKeyAlias()	Gets the key alias in use.
String	getKeyPassword()	Gets the key password in use.
private KeyStore	getKeyStore()	Gets a PKCS#11 KeyStore from the Provider.
PrivateKey	getObject()
Class<?>	getObjectType()
String	getPkcs11Config()	Returns the PKCS#11 configuration.
private Provider	getProvider()	Gets the singleton PKCS#11 Provider.
boolean	isSingleton()
void	setKeyAlias(String alias)	Sets the key alias to use.
void	setKeyPassword(String password)	Set the key password to use.
void	setPkcs11Config(String config)	Sets the PKCS#11 configuration to use.

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER_CLASS_NAME

private static final String PROVIDER_CLASS_NAME

The class name for the PKCS#11 provider class.

See Also:

Constant Field Values

provider

private static Provider provider

Singleton Provider for all instances of this factory.

log

private final org.slf4j.Logger log

Class logger.

pkcs11Config

private String pkcs11Config

PKCS#11 provider parameter string.

keyAlias

private String keyAlias

Alias for the private key.

keyPassword

private String keyPassword

Password for the private key.

key

private PrivateKey key

The singleton instance of the private key produced by this factory.

Constructor Detail

PKCS11PrivateKeyFactoryBean

public PKCS11PrivateKeyFactoryBean()

Method Detail

getPkcs11Config

public String getPkcs11Config()

Returns the PKCS#11 configuration.

Returns:

returns the PKCS#11 configuration.

setPkcs11Config

public void setPkcs11Config(@Nonnull
                            String config)

Sets the PKCS#11 configuration to use.

Parameters:

config - the PKCS#11 configuration to use

getKeyAlias

public String getKeyAlias()

Gets the key alias in use.

Returns:

returns the key alias in use

setKeyAlias

public void setKeyAlias(String alias)

Sets the key alias to use.

Parameters:

alias - the key alias to use

getKeyPassword

public String getKeyPassword()

Gets the key password in use.

Returns:

returns the key password in use

setKeyPassword

public void setKeyPassword(@Nonnull
                           String password)

Set the key password to use.

Parameters:

password - the key password to use

getProvider

private Provider getProvider()
                      throws Exception

Gets the singleton PKCS#11 Provider. The constructed Provider is also added to the system's list of providers.

Returns:

the singleton Provider

Throws:

Exception - if something goes wrong building the Provider

getKeyStore

private KeyStore getKeyStore()
                      throws Exception

Gets a PKCS#11 KeyStore from the Provider.

Returns:

the KeyStore

Throws:

Exception - if something goes wrong building the keystore

getObject

public PrivateKey getObject()
                     throws Exception

Specified by:

getObject in interface FactoryBean<PrivateKey>

Throws:

Exception

getObjectType

@Nonnull
public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<PrivateKey>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface FactoryBean<PrivateKey>