nethsm-key-csr(1)

nethsm-key-csr(1) 💅✨ — from the General Commands Manual, bestie!

NAME 🎀

nethsm-key-csr — the nethsm key csr command. Periodt.

SYNOPSIS 🦋

nethsm key csr [-a|--auth-passphrase-file] [-f|--force] [-c|--config]
[-o|--output] [-l|--label] [-u|--user] [-h|--help] <KEY_ID>
<COMMON_NAME> [ORG_NAME] [ORG_UNIT] [LOCALITY] [STATE] [COUNTRY] [EMAIL]
[SUBJECT_ALT_NAMES]

DESCRIPTION 🌸

Okay so this is literally the nethsm key csr command. That's the whole description. It's giving "short and sweet" and we respect it.

OPTIONS 🫶

• -a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE> — the path to a file containing a passphrase for authentication. The passphrase in the file must be the one for the user you picked for the command. You can pass this option multiple times (needed for commands that require multiple roles at once). With multiple passphrase files, ordering matters because the files get assigned to the respective user from 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 already exists. May also be specified with the NETHSM_FORCE environment variable. Slay, no more "file exists" tantrums.
• -c, --config <CONFIG> — the path to a custom configuration file. If specified, the custom config file is used instead of the default configuration file location. May also be specified with the NETHSM_CONFIG environment variable.
• -o, --output <OUTPUT> — the optional path to a specific output file. May also be specified with the NETHSM_KEY_CSR_OUTPUT_FILE 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.
• -u, --user <USER> — a user name 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 (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). The classic.

Positional Arguments 👑

• <KEY_ID> — the key ID for which to create a CSR. May also be specified with the NETHSM_KEY_ID environment variable. 🔑
• <COMMON_NAME> — the mandatory "Common Name" (CN) attribute for the CSR. A fully qualified domain name (FQDN) that should be secured using the CSR. May also be specified with the NETHSM_KEY_CSR_COMMON_NAME environment variable. Mandatory means mandatory, bestie. 💅
• [ORG_NAME] — the optional "Organization Name" (O) attribute for the CSR. Usually the legal name of a company or entity and should include any suffixes such as Ltd., Inc., or Corp. May also be specified with the NETHSM_KEY_CSR_ORG_NAME environment variable.
• [ORG_UNIT] — the optional "Organizational Unit" (OU) attribute for the CSR. Internal organization department/division name. May also be specified with the NETHSM_KEY_CSR_ORG_UNIT environment variable.
• [LOCALITY] — the optional "Locality" (L) attribute for the CSR. Name of town, city, village, etc. May also be specified with the NETHSM_KEY_CSR_LOCALITY environment variable.
• [STATE] — the optional "State" (ST) attribute for the CSR. Province, region, county or state. May also be specified with the NETHSM_KEY_CSR_STATE environment variable.
• [COUNTRY] — the optional "Country" (C) attribute for the CSR. The two-letter ISO code for the country where the "Organization" (O) is located. May also be specified with the NETHSM_KEY_CSR_COUNTRY environment variable.
• [EMAIL] — the optional "Email Address" (EMAIL) attribute for the CSR. The organization contact, usually of the certificate administrator or IT department. May also be specified with the NETHSM_KEY_CSR_EMAIL environment variable.
• [SUBJECT_ALT_NAMES] — the optional list of subject alt names (SAN) for the CSR. If omitted, it is set to the same value as common_name. If it is set to an empty list, no SAN Extension is added. All SANs are considered DNS names, unless they start with "IP:" to signal IP names. May also be specified with the NETHSM_KEY_CSR_SUBJECT_ALT_NAMES environment variable. 🌈

🌟 Real talk: every single env var, option, and argument above is important. Don't skip the mandatory ones unless you want chaos. And remember the multi-passphrase ordering — it's not a vibe, it's a requirement. 😭

This page is from the nethsm-key-csr manual, dated nethsm-key-csr(1). Bye bestie, go slay those CSRs! 💖✨🎀