nethsm-openpgp-add(1)

NAME
nethsm-openpgp-add - Add an OpenPGP certificate for a key

SYNOPSIS
nethsm openpgp add [-a|--auth-passphrase-file] [-t|--time] [-c|--config] [-v|--version] [--can-sign] [-l|--label] [--cannot-sign] [-u|--user] [-h|--help] <KEY_ID> <USER_ID>

DESCRIPTION
Add an OpenPGP certificate for a key

Creates an OpenPGP certificate for an existing key. The created certificate is then added as the key's certificate (see "nethsm key cert import").

System-wide users in the "Administrator" and "Operator" role can only add OpenPGP certificates for system-wide keys. Namespaced users in the "Administrator" and "Operator" role can only add OpenPGP certificates for keys in their own namespace.

Requires authentication of a user in the "Operator" role, that has access to the targeted key (see "nethsm key tag" and "nethsm user tag"). Additionally, authentication of a user in the "Administrator" role is needed to import the certificate.

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.

-t, --time <TIME>
    The optional creation time of the certificate (defaults to now)
    May also be specified with the NETHSM_OPENPGP_CREATED_AT 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.

-v, --version <VERSION>
    The OpenPGP version the certificate is created with (defaults to "4") One of ["4", "6"].
    May also be specified with the NETHSM_OPENPGP_VERSION environment variable.

--can-sign
    Sets the signing key flag (default to set) If this option is used, the key is created with a component key that has the signing key flag set.
    May also be specified with the NETHSM_OPENPGP_CERT_GENERATE_CAN_SIGN 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.

--cannot-sign
    Clears the signing key flag If this option is used, the key is created without a component key that has the signing key flag set.
    May also be specified with the NETHSM_OPENPGP_CERT_GENERATE_CANNOT_SIGN 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
    May also be specified with the NETHSM_KEY_ID environment variable.

<USER_ID>
    The User ID to use for the key
    May also be specified with the NETHSM_OPENPGP_USERID environment variable.