PKCS#11 Key Manager Provider

The PKCS#11 Key Manager Provider enables the server to access the private key information through the PKCS11 interface.

This standard interface is used by cryptographic accelerators and hardware security modules.

Parent

The PKCS#11 Key Manager Provider object inherits from Key Manager Provider.

PKCS#11 Key Manager Provider Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties Advanced Properties

enabled
key-store-pin
key-store-type

java-class

Basic Properties

Use the --advanced option to access advanced properties.

enabled

Synopsis

Indicates whether the Key Manager Provider is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

key-store-pin

Synopsis

Specifies the clear-text PIN needed to access the PKCS#11 Key Manager Provider .

Default Value

None

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Changes to this property will take effect the next time that the PKCS#11 Key Manager Provider is accessed.

Advanced

No

Read-Only

No

key-store-type

Synopsis

Specifies the type of PKCS#11 key manager, when the specific name must be explicit.

Description

  1. If no type is specified, the default value of "PKCS11" will be used.

Default Value

PKCS11

Allowed Values

Any PKCS#11 key store format supported by this Java runtime environment.

Multi-valued

No

Required

No

Admin Action Required

Restart the server for changes to take effect.

Advanced

No

Read-Only

No

Advanced Properties

Use the --advanced option to access advanced properties.

java-class

Synopsis

The fully-qualified name of the Java class that provides the PKCS#11 Key Manager Provider implementation.

Default Value

org.opends.server.extensions.PKCS11KeyManagerProvider

Allowed Values

A Java class that extends or implements:

  • org.opends.server.api.KeyManagerProvider

Multi-valued

No

Required

Yes

Admin Action Required

The object must be disabled and re-enabled for changes to take effect.

Advanced

Yes

Read-Only

No