nethsm-key-encrypt(1)

NAME ✨

okay bestie, welcome to the nethsm-key-encrypt(1) page from the General Commands Manual — manual name folded in right here so we don’t have to copy that crusty header line 💅

nethsm-key-encrypt — literally the nethsm key encrypt command, and yes she’s iconic for it 🎀

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 🦋

The nethsm key encrypt command. That’s the whole vibe check — this is the command page for it, and we’re about to go through every flag like it’s a group chat receipt 🔥

OPTIONS ✨

• -a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE> — the path to a file containing a passphrase for authentication. The passphrase in that file must be the one for the user chosen for the command, no cap. This option can be provided multiple times, which is needed for commands that require multiple roles at once. With multiple passphrase files, ordering matters because 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 the 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. ⭐

bestie, remember: the IV only works with AesCbc, and that’s not a suggestion — it’s literally what the page says 💀

Cute sign-off 🎀: footer source/version check — it’s just nethsm-key-encrypt mirrored on both sides, with no version or date shown, so that’s the whole ending vibe. periodt 💅