Identity Broker Documentation Index
Command-Line Tool Reference Home

encrypt-file

Description
Examples
Arguments

Description

Encrypt the contents of a file (or data read from standard input) with a user-supplied passphrase.

Examples

Encrypt the data contained in 'sensitive-info.txt' and write the result to file 'sensitive-info.encrypted'. The tool will interactively prompt the user for the passphrase to use to generate the encryption key:
encrypt-file --fileToEncrypt sensitive-info.txt \
     --outputFile sensitive-info.encrypted


Encrypt data read from standard input and write the result to standard output. The passphrase used to generate the encryption key will be automatically generated and written to 'passphrase.txt':
encrypt-file --passphraseFile passphrase.txt --generatePassphrase

Arguments

-V
--version

Description Display Identity Broker version information

-H
--help

Description Display general usage information

--help-debug

Description Display help for using debug options
Advanced Yes

-i {path}
--fileToEncrypt {path}

Description The path to the file to be encrypted. If this is not provided, then the data to be encrypted will be read from standard input, and a passphrase file must have been specified
Required No
Multi-Valued No

-o {path}
--outputFile {path}

Description The path to the file to which the encrypted data should be written. If this is not provided, then the encrypted data will be written to standard output
Required No
Multi-Valued No

-p {path}
--passphraseFile {path}

Description The path to a file containing the passphrase that should be used to generate the encryption key. If this is not provided, then the user will be interactively prompted for the passphrase to use. If the --fileToEncrypt argument is not provided, then this argument must be used to specify the passphrase file
Required No
Multi-Valued No

-g
--generatePassphrase

Description Indicates that the passphrase used to generate the encryption key should be automatically generated by the tool rather than provided by the user. The generated password will be written to the passphrase file specified by the --passphraseFile argument. If the passphrase file already exists, it will be overwritten with the new passphrase