Pem Key Manager Provider

The Pem Key Manager Provider obtains TLS and master keys from PEM files in a file system directory.

The Pem Key Manager Provider tries to read all the PEM files in the configured PEM directory. The Pem Key Manager Provider loads PEM files that include the following, in this order: a private key, a certificate and, optionally, each certificate of a certificate chain. Key aliases are derived directly from the full name of the PEM file. For example, the keys in the file 'ssl-key-pair.pem' will have the alias 'ssl-key-pair.pem'. Files are not required to have specific suffixes. Other components reference the alias in their 'ssl-cert-nickname' or 'master-key-alias' properties. When a PEM file is added, deleted or modified, the change is automatically taken into account the next time the key manager is accessed after a delay of, at most, one minute. When sharing the same PEM directory for a Pem Key Manager Provider and a Pem trust manager provider, it is recommended that all the TLS certificates include the 'keyEncipherment' usage extension and all the trusted certificates include the 'keyCertSign' usage extension. Files such as backup and temporary files may be excluded from the Pem Key Manager Provider by listing file name patterns in 'excluded-filename-pattern' property.

Parent

The Pem Key Manager Provider object inherits from Key Manager Provider.

Pem 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
excluded-filename-pattern
pem-directory

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

excluded-filename-pattern

Synopsis

The set of file name patterns identifying files to be excluded from the Pem Key Manager Provider.

Description

Hidden files will always be excluded. File name patterns use the "glob" syntax defined by the Java "java.nio.file.FileSystem.getPathMatcher" method.

Default Value

.*

*.bak

*.tmp

*.md

Allowed Values

File name pattern

Multi-valued

Yes

Required

No

Admin Action Required

None

Changes to this configuration attribute take effect the next time the component is accessed.

Advanced

No

Read-Only

No

pem-directory

Synopsis

Specifies the path to a directory containing PEM files. It can be an absolute path or a path that is relative to the OpenDJ instance root. The same directory may also be used for a PEM trust manager provider.

Default Value

None

Allowed Values

A string.

Multi-valued

No

Required

Yes

Admin Action Required

None

Changes to this configuration attribute take effect the next time the key manager is accessed.

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 Pem Key Manager Provider implementation.

Default Value

org.opends.server.extensions.PemKeyManagerProvider

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