Reference

nethsm-openpgp-import(1)

The "nethsm openpgp import" command

NAME

nethsm-openpgp-import - The "nethsm openpgp import" command

SYNOPSIS

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

DESCRIPTION

The "nethsm openpgp import" command

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.

-k, --key-id <KEY_ID>

An optional unique ID that is assigned to the imported key

If none is provided a generic one is generated for the key.

May also be specified with the NETHSM_OPENPGP_KEY_ID 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.

-t, --tags <TAGS>

An optional list of tags that are assigned to the imported key

Tags on keys are used to grant access to those keys for users that carry the same tags.

May also be specified with the NETHSM_OPENPGP_KEY_TAGS environment variable.

-l, --label <LABEL>

An optional label that is assigned to the imported key

Labels can be used to filter keys in the list of all keys.

May also be specified with the NETHSM_OPENPGP_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')

<TSK_FILE>

The path to the Transferable Secret Key file to import

May also be specified with the NETHSM_OPENPGP_TSK_FILE environment variable.