se.swedenconnect.opensaml.pkcs11.configuration

Class PKCS11ProviderConfiguration

java.lang.Object

se.swedenconnect.opensaml.pkcs11.configuration.PKCS11ProviderConfiguration

Direct Known Subclasses:

PKCS11ProvidedCfgConfiguration, PKCS11SoftHsmProviderConfiguration

public class PKCS11ProviderConfiguration
extends Object

Configuration class for setting up a PKCS#11 provider.

It is recommended to supply either slot (number) or slotListIndex, but not both, since if the index and slot supplied does not match the device's view an error will occur.

Author:

Stefan Santesson (stefan@idsec.se), Martin Lindström (martin@idsec.se)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	library The pkcs11 library on the host to use.
protected String	name The name of the HSM slot.
protected String	slot The slot number to use.
protected Integer	slotListIndex The slot index to use.
protected Integer	slotListIndexMaxRange The maximum number och slots to use starting from the slotListIndex

Constructor Summary

Constructors

Constructor and Description
PKCS11ProviderConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getLibrary() Returns the path to the pkcs11 library on the host to use for the provider.
String	getName() Returns the name of the HSM slot.
String	getSlot() Returns the slot number to use.
Integer	getSlotListIndex() Returns the slot list index to use.
Integer	getSlotListIndexMaxRange() Returns the maximum range of slot list indexes to traverse, starting from the active slotListIndex.
void	setLibrary(String library) Assigns the path to the pkcs11 library on the host to use for the provider.
void	setName(String name) Assigns the name of the HSM slot.
void	setSlot(String slot) Assigns the slot number to use.
void	setSlotListIndex(Integer slotListIndex) Assigns the slot list index to use.
void	setSlotListIndexMaxRange(Integer slotListIndexMaxRange) Assigns the slot list index max range
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

library

protected String library

The pkcs11 library on the host to use.

name

protected String name

The name of the HSM slot.

slot

protected String slot

The slot number to use.

slotListIndex

protected Integer slotListIndex

The slot index to use.

slotListIndexMaxRange

protected Integer slotListIndexMaxRange

The maximum number och slots to use starting from the slotListIndex

Constructor Detail

PKCS11ProviderConfiguration

public PKCS11ProviderConfiguration()

Method Detail

getLibrary

public String getLibrary()

Returns the path to the pkcs11 library on the host to use for the provider.

Returns:

path to pkcs11 library

setLibrary

public void setLibrary(String library)

Assigns the path to the pkcs11 library on the host to use for the provider.

Parameters:

library - path to pkcs11 library

getName

public String getName()

Returns the name of the HSM slot.

Returns:

the name of the HSM slot

setName

public void setName(String name)

Assigns the name of the HSM slot.

Parameters:

name - the name of the HSM slot

getSlot

public String getSlot()

Returns the slot number to use.

If null is returned, the device will use the slot entry identified by the active slotListIndex.

Returns:

slot number, or null

setSlot

public void setSlot(String slot)

Assigns the slot number to use.

Parameters:

slot - slot number

getSlotListIndex

public Integer getSlotListIndex()

Returns the slot list index to use.

If no slot list index is assigned (null is returned), the following logic applies:

• If slot (getSlot()) is null, the default slot list index 0 will be used.
• If slot (getSlot()) is non-null, the slot identified by this slot number will be used.

Returns:

the slot list index

setSlotListIndex

public void setSlotListIndex(Integer slotListIndex)

Assigns the slot list index to use.

Parameters:

slotListIndex - slot list index

getSlotListIndexMaxRange

public Integer getSlotListIndexMaxRange()

Returns the maximum range of slot list indexes to traverse, starting from the active slotListIndex.

Returns:

the maximum slot list index range

setSlotListIndexMaxRange

public void setSlotListIndexMaxRange(Integer slotListIndexMaxRange)

Assigns the slot list index max range

Parameters:

slotListIndexMaxRange - slot list index max range

toString

public String toString()

Overrides:

toString in class Object