Ping Identity Directory Server - Export Reversible Passwords Extended Operation Handler

Export Reversible Passwords Extended Operation Handler

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 Export Reversible Passwords Extended Operation Handler provides support for an extended operation handler that can be used to export any user passwords encoded with a reversible scheme to a specified file in the clear. Entries will be exported in LDIF, and the output file will be encrypted with a user-provided specified cipher and key.

Because of the sensitive nature of the content that can be exposed by this extended operation handler, it can only be invoked under the following circumstances:

It can only be requested by a connection established over the loopback interface.
It can only be requested over a secure connection (for example, a connection encrypted with TLS).
It can only be requested by a user that has the "permit-export-reversible-passwords" privilege.
The client must have access control permission to issue the extended request.
The output path must be below the server root, and that path must not reference a file or directory that already exists.

Parent Component Properties dsconfig Usage

Parent Component

The Export Reversible Passwords Extended Operation Handler component inherits from the Extended Operation Handler

Properties

The properties supported by this managed object are as follows:

Basic Properties:	Advanced Properties:
description	None
enabled

Basic Properties

description

Description	A description for this Extended Operation Handler
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 Extended Operation Handler is enabled (that is, whether the types of extended operations are allowed in the server).
Default Value	None
Allowed Values	true false
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

dsconfig Usage

To list the configured Extended Operation Handlers:

dsconfig list-extended-operation-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Extended Operation Handler:

dsconfig get-extended-operation-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Extended Operation Handler:

dsconfig set-extended-operation-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Export Reversible Passwords Extended Operation Handler:

dsconfig create-extended-operation-handler
     --handler-name {name}
     --type export-reversible-passwords
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Extended Operation Handler:

dsconfig delete-extended-operation-handler
     --handler-name {name}