nethsm-key-encrypt(1)

NAME
nethsm-key-encrypt - Encrypt a message using a key

SYNOPSIS
nethsm key encrypt [-a|--auth-passphrase-file] [-f|--force] [-c|--config] [-i|--initialization-vector] [-l|--label] [-o|--output] [-u|--user] [-h|--help] <KEY_ID> <MESSAGE> [ENCRYPT_MODE]

DESCRIPTION
Encrypt a message using a key

Only symmetric encryption is supported.

System-wide users in the "Operator" role can only encrypt messages using system-wide keys. Namespaced users in the "Operator" role can only encrypt messages using keys in their own namespace.

Requires authentication of a user in the "Operator" role that has access (see "nethsm key tag" and "nethsm user tag") to the targeted key.

OPTIONS

-a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE>
    The path to a file containing a passphrase for authentication The passphrase provided in the file must be the one for the user chosen for the command. This option can be provided multiple times, which is needed for commands that require multiple roles at once. With multiple passphrase files ordering matters, as the files are assigned to the respective user provided by the "--user" option.
    May also be specified with the NETHSM_AUTH_PASSPHRASE_FILE environment variable.

-f, --force
    Write to output file even if it exists already
    May also be specified with the NETHSM_FORCE environment variable.

-c, --config <CONFIG>
    The path to a custom configuration file If specified, the custom configuration file is used instead of the default configuration file location.
    May also be specified with the NETHSM_CONFIG environment variable.

-i, --initialization-vector <INITIALIZATION_VECTOR>
    The path to a file containing the initialization vector (IV) for symmetric encryption The IV can only be used when choosing symmetric encryption (i.e. with "AesCbc")
    May also be specified with the NETHSM_KEY_ENCRYPT_IV environment variable.

-l, --label <LABEL>
    A label uniquely identifying a device in the configuration file Must be provided if more than one device is setup in the configuration file.
    May also be specified with the NETHSM_LABEL environment variable.

-o, --output <OUTPUT>
    The path to a specific file to write the encrypted message to
    May also be specified with the NETHSM_KEY_ENCRYPT_OUTPUT environment variable.

-u, --user <USER>
    A user name which is used for a command Can be provided, if no user name is setup in the configuration file for a device. Must be provided, if several user names of the same target role are setup in the configuration file for a device. This option can be provided multiple times, which is needed for commands that require multiple roles at once.
    May also be specified with the NETHSM_USER environment variable.

-h, --help
    Print help (see a summary with '-h')

<KEY_ID>
    The ID of the key to use for encryption
    May also be specified with the NETHSM_KEY_ID environment variable.

<MESSAGE>
    The path to a message to encrypt
    May also be specified with the NETHSM_KEY_ENCRYPT_MESSAGE environment variable.

[ENCRYPT_MODE]
    The encryption mode to use One of ["AesCbc"] (defaults to "AesCbc").
    May also be specified with the NETHSM_KEY_ENCRYPT_MODE environment variable.