DS 7.2.4

encode-password

encode-password — encode a password with a storage scheme

Synopsis

encode-password {options}

Description

This utility can be used to encode user passwords with a specified storage scheme, or to determine whether a given clear-text value matches a provided encoded password.

Options

The encode-password command takes the following options:

Command options:

-a | --authPasswordSyntax

Use the authentication password syntax rather than the user password syntax. Default: false

-c | --clearPassword[:env|:file] {clearPW}

Clear-text password to encode or to compare against an encoded password.

-e | --encodedPassword[:env|:file] {encodedPW}

Encoded password to compare against the clear-text password.

-i | --interactivePassword

The password to encode or to compare against an encoded password is interactively asked to the user. Default: false

-l | --listSchemes

List available password storage schemes. Default: false

-r | --useCompareResultCode

Use the LDAP compare result as an exit code for the password comparison. Default: false

-s | --storageScheme {scheme}

Scheme to use for the encoded password.

General options:

-V | --version

Display Directory Server version information. Default: false

-H | --help

Display this usage information. Default: false

Exit codes

0

The command completed successfully.

5

The -r option was used, and the compare did not match.

6

The -r option was used, and the compare did match.

other

An error occurred.

Copyright © 2010-2023 ForgeRock, all rights reserved.