Note: this is an abstract component, that cannot be instantiated.
A Key Pin defines the PIN (password) to be used to access a private key in a key store. If there is no Key Pin defined for a given private key, the code will use the PIN defined to access the key store.
The following Key Pins are available in the server :
These Key Pins inherit from the properties described below.
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ key-pin | None |
| ↓ key-pin-environment-variable | |
| ↓ key-pin-file | |
| ↓ key-pin-property |
| Description | Specifies the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the key PIN properties is specified, the server will try to access the private key using the key manager provider PIN. The server will check if the properties are defined in the following order: Java property, environment variable, file, value. The first defined value will be used . |
|---|---|
| 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 |
| 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 . |
|---|---|
| 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 |
| 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 . |
|---|---|
| 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 |
| 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 . |
|---|---|
| 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 |