PingAuthorize Server Documentation Index
Configuration Reference Home

AES 256 Password Storage Scheme

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact support for assistance if you believe that you have a need to create or modify this type of object.

The AES 256 Password Storage Scheme provides a mechanism for reversibly encrypting passwords using the 256-bit AES cipher.

Encryption keys will be derived from definitions in the server's encryption settings database. The UnboundID LDAP SDK for Java provides support for this password storage scheme through the com.unboundid.ldap.sdk.unboundidds.AES256EncodedPassword class. Clients with access to encoded passwords and the passphrase used to create the associated encryption settings definition may use this class (or a compatible implementation) to decrypt the encoded password and obtain the original cleartext value used to create it.

Parent Component
Properties
dsconfig Usage

Parent Component

The AES 256 Password Storage Scheme component inherits from the Password Storage Scheme

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ encryption-settings-definition-id

Basic Properties

description

Description
A description for this Password Storage Scheme
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Password Storage Scheme is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

encryption-settings-definition-id

Description
The identifier for the encryption settings definition that should be used to derive the encryption key to use when encrypting new passwords. If this is not provided, the server's preferred encryption settings definition will be used.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Password Storage Schemes:

dsconfig list-password-storage-schemes
     [--property {propertyName}] ...

To view the configuration for an existing Password Storage Scheme:

dsconfig get-password-storage-scheme-prop
     --scheme-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Password Storage Scheme:

dsconfig set-password-storage-scheme-prop
     --scheme-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new AES 256 Password Storage Scheme:

dsconfig create-password-storage-scheme
     --scheme-name {name}
     --type aes-256
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Password Storage Scheme:

dsconfig delete-password-storage-scheme
     --scheme-name {name}