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 | --authPasswordSyntaxUse the authentication password syntax rather than the user password syntax.
Default: false
-c | --clearPassword {clearPW}Clear-text password to encode or to compare against an encoded password.
-e | --encodedPassword {encodedPW}Encoded password to compare against the clear-text password.
-E | --encodedPasswordFile {file}Encoded password file.
-f | --clearPasswordFile {file}Clear-text password file.
-i | --interactivePasswordThe password to encode or to compare against an encoded password is interactively asked to the user.
Default: false
-l | --listSchemesList available password storage schemes.
Default: false
-r | --useCompareResultCodeUse 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 | --versionDisplay Directory Server version information.
Default: false
-H | --helpDisplay this usage information.
Default: false
Exit Codes
- 0
The command completed successfully.
- 5
The
-roption was used, and the compare did not match.- 6
The
-roption was used, and the compare did match.- other
An error occurred.
Examples
The following example encodes a password and compares a password with the encoded value:
$encode-password --listSchemes3DES AES BASE64 BCRYPT BLOWFISH CLEAR CRYPT MD5 PBKDF2 PKCS5S2 RC4 SHA SMD5 SSHA SSHA256 SSHA384 SSHA512$encode-password --clearPassword secret12 --storageScheme CRYPT{CRYPT}ZulJ6Dy3TFnrE$encode-password \ --clearPassword secret12 \ --storageScheme CRYPT \ --encodedPassword "{CRYPT}ZulJ6Dy3TFnrE" \ --useCompareResultCodeThe provided clear-text and encoded passwords match$echo $?6