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.
The PKCS#11 Key Manager Provider object inherits from Key Manager Provider.
Use the --advanced
option to access advanced properties.
Basic Properties
Advanced Properties
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 |
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-pin-environment-variable
Synopsis | Specifies the name of the environment variable that contains the clear-text PIN needed to access the PKCS#11 Key Manager Provider . |
Default Value | None |
Allowed Values | The name of a defined environment variable that contains the clear-text PIN required to access the contents of the key store. |
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 |
Synopsis | Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the PKCS#11 Key Manager Provider . |
Default Value | None |
Allowed Values | A path to an existing file that is readable by the server. |
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 |
Synopsis | Specifies the name of the Java property that contains the clear-text PIN needed to access the PKCS#11 Key Manager Provider . |
Default Value | None |
Allowed Values | The name of a defined Java property. |
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 |
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 |