Configuration Reference Home
Oracle Unified Directory - Key Manager Provider Key Pin

Key Manager Provider Key Pin

A Key Manager Provider Key Pin defines the PIN (password) to be used to access a private key in a key store. If there is no Key Manager Provider Key Pin defined for a given certificate, the code will use the PIN defined to access the key store.

Parent Component

The Key Manager Provider Key Pin component inherits from the Key Pin

Relations To this Component

The following components have a direct COMPOSITION relation TO Key Manager Provider Key Pins :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ key-pin  None
↓ key-pin-environment-variable
↓ key-pin-file
↓ key-pin-property
↓ ssl-cert-nickname

Basic Properties

key-pin

Description
Specifies the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If the key PIN property is not specified, the server will try to access the private key using the key manager provider PIN.
Default Value
None
Allowed Values
Unknown
Multi-valued
No
Required
No
Admin Action Required
None. Changes to this property will take effect the next time that the Key Pin is accessed.
Advanced Property
No
Read-only
No

key-pin-environment-variable

Description
Specifies the name of the environment variable that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN. This property is no longer honored starting release 12.2.1.4.210406.
Default Value
None
Allowed Values
The name of a defined environment variable that contains the clear-text PIN required to access the private key in the key store.
Multi-valued
No
Required
No
Admin Action Required
None. Changes to this property will take effect the next time that the Key Pin is accessed.
Advanced Property
No
Read-only
No

key-pin-file

Description
Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN. This property is no longer honored starting release 12.2.1.4.210406.
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 Key Pin is accessed.
Advanced Property
No
Read-only
No

key-pin-property

Description
Specifies the name of the Java property that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN. This property is no longer honored starting release 12.2.1.4.210406.
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 Key Pin is accessed.
Advanced Property
No
Read-only
No

ssl-cert-nickname

Description
Specifies the nickname of the certificate this Key Manager Provider Key Pin applies to.
Default Value
None
Allowed Values
The nickname of the certificate.
Multi-valued
No
Required
Yes
Admin Action Required
None. Changes to this property will take effect the next time that the Key Manager Provider Key Pin is accessed.
Advanced Property
No
Read-only
Yes


Copyright © 2019, 2022, Oracle and/or its affiliates.