Package eu.europa.esig.dss.token

Class Pkcs11SignatureToken

java.lang.Object

eu.europa.esig.dss.token.AbstractSignatureTokenConnection

eu.europa.esig.dss.token.AbstractKeyStoreTokenConnection

eu.europa.esig.dss.token.Pkcs11SignatureToken

All Implemented Interfaces:

SignatureTokenConnection, AutoCloseable

public class Pkcs11SignatureToken
extends AbstractKeyStoreTokenConnection

PKCS11 token with callback

Constructor Summary

Constructors

Constructor	Description
Pkcs11SignatureToken(String pkcs11Path)	Create the SignatureTokenConnection, using the provided path for the library.
Pkcs11SignatureToken(String pkcs11Path, PasswordInputCallback callback)	Create the SignatureTokenConnection, using the provided path for the library and a way of retrieving the password from the user.
Pkcs11SignatureToken(String pkcs11Path, PasswordInputCallback callback, int slotId)	Sometimes, multiple SmartCard reader is connected.
Pkcs11SignatureToken(String pkcs11Path, PasswordInputCallback callback, int slotId, int slotListIndex, String extraPkcs11Config)	Sometimes, multiple SmartCard reader is connected.
Pkcs11SignatureToken(String pkcs11Path, PasswordInputCallback callback, int slotId, String extraPkcs11Config)	Sometimes, multiple SmartCard reader is connected.
Pkcs11SignatureToken(String pkcs11Path, PasswordInputCallback callback, String extraPkcs11Config)	Create the SignatureTokenConnection, using the provided path for the library and a way of retrieving the password from the user.
Pkcs11SignatureToken(String pkcs11Path, String extraPkcs11Config)	Create the SignatureTokenConnection, using the provided path for the library.
Pkcs11SignatureToken(String pkcs11Path, KeyStore.PasswordProtection password)	Sometimes, the password is known in advance.
Pkcs11SignatureToken(String pkcs11Path, KeyStore.PasswordProtection password, int slotId)	Sometimes, multiple SmartCard reader is connected.
Pkcs11SignatureToken(String pkcs11Path, KeyStore.PasswordProtection password, int slotId, String extraPkcs11Config)	Sometimes, multiple SmartCard reader is connected.
Pkcs11SignatureToken(String pkcs11Path, KeyStore.PasswordProtection password, String extraPkcs11Config)	Sometimes, the password is known in advance.

Method Summary

Modifier and Type	Method	Description
protected String	buildConfig()	Builds the PKCS11 config
void	close()
protected String	escapePath(String pathToEscape)	Replaces the path like ('\' to '\\')
protected KeyStore.PasswordProtection	getKeyProtectionParameter()	Gets the password protection
protected KeyStore	getKeyStore()	Gets the key store
protected String	getPkcs11Path()	Gets the path to PKCS library
protected Provider	getProvider()	Gets the Provider to use
protected Signature	getSignatureInstance(String javaSignatureAlgorithm)	Returns the java.security.Signature instance for the given javaSignatureAlgorithm

Methods inherited from class eu.europa.esig.dss.token.AbstractKeyStoreTokenConnection

getKey, getKey, getKeys, setKeyEntryPredicate

Methods inherited from class eu.europa.esig.dss.token.AbstractSignatureTokenConnection

createPSSParam, sign, sign, sign, signDigest, signDigest, signDigest

Methods inherited from class java.lang.Object

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

Constructor Details

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path)

Create the SignatureTokenConnection, using the provided path for the library.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 String extraPkcs11Config)

Create the SignatureTokenConnection, using the provided path for the library.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

extraPkcs11Config - extra configuration for pkcs11 library

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 KeyStore.PasswordProtection password)

Sometimes, the password is known in advance. This create a SignatureTokenConnection and the keys will be accessed using the provided password. The default constructor for CallbackPkcs11SignatureToken.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

password - the pin code / password to use

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 KeyStore.PasswordProtection password,
 String extraPkcs11Config)

Sometimes, the password is known in advance. This create a SignatureTokenConnection and the keys will be accessed using the provided password. The default constructor for CallbackPkcs11SignatureToken.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

password - the pin code / password to use

extraPkcs11Config - extra configuration for pkcs11 library

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 PasswordInputCallback callback)

Create the SignatureTokenConnection, using the provided path for the library and a way of retrieving the password from the user. The default constructor for CallbackPkcs11SignatureToken.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

callback - the callback to enter the pin code / password

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 PasswordInputCallback callback,
 String extraPkcs11Config)

Create the SignatureTokenConnection, using the provided path for the library and a way of retrieving the password from the user. The default constructor for CallbackPkcs11SignatureToken.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

callback - the callback to enter the pin code / password

extraPkcs11Config - extra configuration for pkcs11 library

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 KeyStore.PasswordProtection password,
 int slotId)

Sometimes, multiple SmartCard reader is connected. To create a connection on a specific one, slotIndex is used. This Create the SignatureTokenConnection, using the provided path for the library and a way of retrieving the password from the user.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

password - the pin code / password to use

slotId - the slotId to use

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 KeyStore.PasswordProtection password,
 int slotId,
 String extraPkcs11Config)

Sometimes, multiple SmartCard reader is connected. To create a connection on a specific one, slotIndex is used. This Create the SignatureTokenConnection, using the provided path for the library and a way of retrieving the password from the user.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

password - the pin code / password to use

slotId - the slotId to use

extraPkcs11Config - extra configuration for pkcs11 library

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 PasswordInputCallback callback,
 int slotId)

Sometimes, multiple SmartCard reader is connected. To create a connection on a specific one, slotIndex is used. This create a SignatureTokenConnection and the keys will be accessed using the provided password.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

callback - the callback to enter the pin code / password

slotId - the slotId to use

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 PasswordInputCallback callback,
 int slotId,
 String extraPkcs11Config)

Sometimes, multiple SmartCard reader is connected. To create a connection on a specific one, slotIndex is used. This create a SignatureTokenConnection and the keys will be accessed using the provided password.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

callback - the callback to enter the pin code / password

slotId - the slotId to use

extraPkcs11Config - extra configuration for pkcs11 library

Pkcs11SignatureToken

public Pkcs11SignatureToken(String pkcs11Path,
 PasswordInputCallback callback,
 int slotId,
 int slotListIndex,
 String extraPkcs11Config)

Sometimes, multiple SmartCard reader is connected. To create a connection on a specific one, slotListIndex is used. This create a SignatureTokenConnection and the keys will be accessed using the provided password.

Parameters:

pkcs11Path - the path for the library (.dll, .so)

callback - the callback to enter the pin code / password

slotId - the slotId to use (if negative, the parameter is not used)

slotListIndex - the slotListIndex to use (if negative, the parameter is not used)

extraPkcs11Config - extra configuration for pkcs11 library

Method Details

getProvider

protected Provider getProvider()

Gets the Provider to use

Returns:

Provider

buildConfig

protected String buildConfig()

Builds the PKCS11 config

Returns:

String

escapePath

protected String escapePath(String pathToEscape)

Replaces the path like ('\' to '\\')

Parameters:

pathToEscape - String to modify

Returns:

String

getKeyStore

protected KeyStore getKeyStore()
                        throws DSSException

Description copied from class: AbstractKeyStoreTokenConnection

Gets the key store

Specified by:

getKeyStore in class AbstractKeyStoreTokenConnection

Returns:

KeyStore

Throws:

DSSException

getPkcs11Path

protected String getPkcs11Path()

Gets the path to PKCS library

Returns:

String

getKeyProtectionParameter

protected KeyStore.PasswordProtection getKeyProtectionParameter()

Description copied from class: AbstractKeyStoreTokenConnection

Gets the password protection

Specified by:

getKeyProtectionParameter in class AbstractKeyStoreTokenConnection

Returns:

KeyStore.PasswordProtection

getSignatureInstance

protected Signature getSignatureInstance(String javaSignatureAlgorithm)
                                  throws NoSuchAlgorithmException

Description copied from class: AbstractSignatureTokenConnection

Returns the java.security.Signature instance for the given javaSignatureAlgorithm

Overrides:

getSignatureInstance in class AbstractSignatureTokenConnection

Parameters:

javaSignatureAlgorithm - String representing the Java name of a signature algorithm

Returns:

Signature

Throws:

NoSuchAlgorithmException - if the algorithm is not found

close

public void close()