nethsm-openpgp-import(1)

πŸ“¦ version 0.10.0, in arch rolling

πŸ’– nethsm-openpgp-import(1) β€” the glow-up πŸ’–

okay so bestie, you're about to import a key into your Nitrokey NetHSM, and the manual page for nethsm-openpgp-import is gonna walk you through it. this is the page for the nethsm openpgp import command, straight out of the General Commands Manual, and we're gonna go through every single flag together. grab a snack πŸ“


✨ NAME ✨

nethsm-openpgp-import β€” literally just the nethsm openpgp import command, that's the whole vibe πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

nethsm openpgp import [-a|--auth-passphrase-file] [-k|--key-id]
[-c|--config] [-t|--tags] [-l|--label] [-u|--user] [-h|--help]
<TSK_FILE>

like, that's the shape of it, ok? one file argument, a lil pile of options. slay.


🌸 DESCRIPTION 🌸

The nethsm openpgp import command. that's it, that's the description β€” she's brief but she's iconic πŸ‘‘


πŸŽ€ OPTIONS πŸŽ€

  • -a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE> β€” the path to a file holding a passphrase for authentication πŸ”‘ the passphrase inside that file must be the one for the user you picked for this command, no substitutions bestie. this option can be given multiple times, which you need for commands that require multiple roles at once. when you pass multiple passphrase files, ordering matters β€” the files get assigned to the respective user provided by the --user option, in order. no shuffling πŸ™ˆ may also be specified with the NETHSM_AUTH_PASSPHRASE_FILE environment variable.
  • -k, --key-id <KEY_ID> β€” an optional unique ID assigned to the imported key πŸ†” if you don't pass one, a generic one gets generated for the key. so like, it's optional, but it's yours if you want it. may also be specified with the NETHSM_OPENPGP_KEY_ID environment variable.
  • -c, --config <CONFIG> β€” the path to a custom configuration file πŸ“„ if you specify it, that custom config file gets used instead of the default configuration file location. no cap. may also be specified with the NETHSM_CONFIG environment variable.
  • -t, --tags <TAGS> β€” an optional list of tags assigned to the imported key 🏷️ and here's why tags ate: tags on keys are used to grant access to those keys for users that carry the same tags. iykyk. may also be specified with the NETHSM_OPENPGP_KEY_TAGS environment variable.
  • -l, --label <LABEL> β€” an optional label assigned to the imported key 🎟️ labels are how you filter keys in the list of all keys. very handy, very main character. may also be specified with the NETHSM_OPENPGP_KEY_LABEL environment variable.
  • -u, --user <USER> β€” a user name used for a command πŸ‘€ you can provide it if there's no user name set up in the configuration file for a device. you must provide it if several user names of the same target role are set up 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) 🫢
  • <TSK_FILE> β€” the path to the Transferable Secret Key file to import πŸ” may also be specified with the NETHSM_OPENPGP_TSK_FILE environment variable.
⚠️ heads up: <TSK_FILE> is a Transferable Secret Key file. that's a secret key, bestie. handle it like the precious thing it is, don't go waving it around πŸ’€

🌈 SEE ALSO 🌈

no SEE ALSO section on this one β€” she stands alone, and honestly? respect ✨


okay that's the whole page, every flag, every env var, nothing skipped, periodt πŸ’œ and for the sign-off: this was nethsm-openpgp-import from the nethsm-openpgp-import source, General Commands Manual β€” the page doesn't stamp a version or a date on it, so we're not gonna invent one πŸ™ˆ stay hydrated, back up your keys, and go import something iconic πŸŒŸπŸŽ€

πŸ“¦ where this page comes from