nethsm-key-generate(1)

💖 NAME 💖

nethsm-key-generate(1) — literally the nethsm key generate command, bestie. It’s from the General Commands Manual, and the (1) is right there in the name. ✨

✨ SYNOPSIS ✨

nethsm key generate [-a|--auth-passphrase-file] [-L|--length]
[-c|--config] [-k|--key-id] [-t|--tags] [-l|--label] [-u|--user]
[-h|--help] [KEY_TYPE] [KEY_MECHANISMS]

🌸 DESCRIPTION 🌸

This page does the most for the nethsm key generate command. Short, iconic, to the point — that’s the whole description, bestie. 💅

💅 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.

• -L, --length <LENGTH> — The optional bit length of the generated key. If none is provided, a default is chosen. May also be specified with the NETHSM_KEY_BIT_LENGTH 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.
• -k, --key-id <KEY_ID> — An optional unique ID that is assigned to the generated key. If none is provided a generic one is generated for the key. May also be specified with the NETHSM_KEY_ID environment variable.
• -t, --tags <TAGS> — An optional list of tags that are assigned to the generated key. Tags on keys are used to grant access to those keys for users that carry the same tags — it’s giving access-control energy. May also be specified with the NETHSM_KEY_TAGS environment variable.
• -l, --label <LABEL> — An optional label that is assigned to the generated key. Labels can be used to filter keys in the list of all keys. May also be specified with the NETHSM_KEY_LABEL 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'). Yes bestie, it’s giving long-help energy.
• [KEY_TYPE] — The optional type of key to generate. The key type must match the chosen key mechanisms! One of ["Curve25519", "EcBp256", "EcBp384", "EcBp512", "EcK256", "EcP224", "EcP256", "EcP384", "EcP521", "Generic", "Rsa"] (defaults to "Curve25519"). May also be specified with the NETHSM_KEY_TYPE environment variable.
• [KEY_MECHANISMS] — The mechanisms provided by the generated key. The key mechanisms must match the chosen key type! At least one of ["AesDecryptionCbc", "AesEncryptionCbc", "EcdsaSignature", "EdDsaSignature", "RsaDecryptionOaepMd5", "RsaDecryptionOaepSha1", "RsaDecryptionOaepSha224", "RsaDecryptionOaepSha256", "RsaDecryptionOaepSha384", "RsaDecryptionOaepSha512", "RsaDecryptionPkcs1", "RsaDecryptionRaw", "RsaSignaturePkcs1", "RsaSignaturePssSha1", "RsaSignaturePssSha224", "RsaSignaturePssSha256", "RsaSignaturePssSha384", "RsaSignaturePssSha512"] (defaults to "EdDsaSignature"). May also be specified with the NETHSM_KEY_MECHANISMS environment variable.

Cute footer sign-off: the source/version bits are nethsm-key-generate and nethsm-key-generate(1). The page didn’t print a date, so I’m not inventing one — no cap, bestie. 🫶✨