The Trust Store Backend provides an LDAP view of a file-based trust store. It is used by the administrative cryptographic framework.
The Trust Store Backend object inherits from Local Backend.
Use the --advanced
option to access advanced properties.
Basic Properties
Advanced Properties
Synopsis | Specifies a name to identify the associated backend. |
Description | The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server. |
Default Value | None |
Allowed Values | A string. |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced | No |
Read-Only | Yes |
Synopsis | Indicates whether the backend is enabled in the server. |
Description | If a backend is not enabled, then its contents are not accessible when processing operations. |
Default Value | None |
Allowed Values | true false |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced | No |
Read-Only | No |
Synopsis | Specifies the path to the file that stores the trust information. |
Description | It may be an absolute path, or a path that is relative to the OpenDJ instance root. |
Default Value | config/ads-truststore |
Allowed Values | A string. |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced | No |
Read-Only | No |
Synopsis | Specifies the clear-text PIN needed to access the Trust Store Backend . |
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 Trust Store Backend is accessed. |
Advanced | No |
Read-Only | No |
trust-store-pin-environment-variable
Synopsis | Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Backend . |
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 Trust Store Backend 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 Trust Store Backend . |
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 Trust Store Backend 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 Trust Store Backend . |
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 Trust Store Backend is accessed. |
Advanced | No |
Read-Only | No |
Synopsis | Specifies the format for the data in the key store file. |
Description | Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well. |
Default Value | The JVM default value is used. |
Allowed Values | A string. |
Multi-valued | No |
Required | No |
Admin Action Required | None Changes to this property take effect the next time that the key manager is accessed. |
Advanced | No |
Read-Only | No |
Synopsis | Specifies the behavior that the backend should use when processing write operations. |
Default Value | enabled |
Allowed Values | disabled: Causes all write attempts to fail. enabled: Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled). internal-only: Causes external write attempts to fail but allows writes by replication and internal operations. |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced | No |
Read-Only | No |
Synopsis | Specifies the fully-qualified name of the Java class that provides the backend implementation. |
Default Value | org.opends.server.backends.TrustStoreBackend |
Allowed Values | A Java class that extends or implements: org.opends.server.api.Backend |
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 |