Administrate Security¶

Encrypt passwords used for seal-dpf-workingunit-hdm-checkin or seal-dpf-workingunit-odata-notify.

Requirements¶

For the requirements for using DPF CLI, refer to DPF CLI.

Commands¶

Usage: dpf security [options] [command]

Options:
  -V, --version               output the version number
  --verbose                   Verbose mode. It prints detailed messages.
  -h, --help                  display help for command

Commands:
  createPwdSecret [options]   Creates a new secret for encoding passwords.

  encryptPwd [options] <pwd>  Encrypts the given password using the secret from the specified file or the secret
                              provided as an option.
  help [command]              display help for command

createPwdSecret¶

createPwdSecret creates a new secret for encoding passwords. The secret is either printed to the console or saved to a file.

Usage: dpf security createPwdSecret [--secretFile <fileName> ]

Options:

--secretFile

Name of file to save secret to, optional

Examples:

dpf security createPwdSecret

Prints a new secret ot console, like "6ad58d51dcee6518f044ffbdd5d03d37".
dpf security createPwdSecret --secretFile secret.json

Saves the secret as JSON to the file secret.json.

Hint - environment keys SECRET and SECRET_FILE

For storing the secret, the two environment keys SECRET and SECRET_FILE are available. The DPF services will need one of those to decrypt the used passwords.

encryptPwd¶

encryptPwd encrypts the given password using the secret from the specified file or the secret provided as an option

Usage: dpf security encryptPwd [options] <pwd>

Arguments:

pwd: the pasword to encrypt.

Options:

--secretFile <fileName>

JSON file containing the secret
--secret <secret>

Secret used for encryption

Either --secretFile or --secret must be provided.

Examples:

dpf security encryptPwd myPassword --secret 6ad58d51dcee6518f044ffbdd5d03d37

Prints the encrypted password on console, like "381e3f31a28e9a477bb3f80dcdb4bdba8bdef26f0c71fc15"
dpf security encryptPwd myPassword --secretFile secret.json

Reads secret from file and prints the encrypted password on console, like "381e3f31a28e9a477bb3f80dcdb4bdba8bdef26f0c71fc15"

Hint - environment keys SECRET and SECRET_FILE

Before encrypting a password, check whether a SECRET and SECRET_FILE has already been specified. The decryption only works with the correct secret.

help¶

help displays the help for the command.

Usage: dpf security help [command]