.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH nethsm-openpgp-import 1  "nethsm-openpgp-import " 
.SH NAME
nethsm\-openpgp\-import \- Import OpenPGP TSK\-formatted private key
.SH SYNOPSIS
\fBnethsm openpgp import\fR [\fB\-k\fR|\fB\-\-key\-id\fR] [\fB\-t\fR|\fB\-\-tags\fR] [\fB\-a\fR|\fB\-\-auth\-passphrase\-file\fR] [\fB\-c\fR|\fB\-\-config\fR] [\fB\-l\fR|\fB\-\-label\fR] [\fB\-u\fR|\fB\-\-user\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fITSK_FILE\fR> 
.SH DESCRIPTION
Import OpenPGP Transferable Secret Key (TSK) formatted private key
.PP
Only TSKs with a single component key are supported.
.PP
System\-wide users in the "Administrator" role can only import TSKs as system\-wide keys.
Namespaced users in the "Administrator" role can only import TSKs as keys in their own namespace.
.PP
Note: Although assigning tags to the new key is optional, it is highly recommended as not doing so means that all users in the same scope have access to it!
.PP
Requires authentication of a user in the "Administrator" role.
.SH OPTIONS
.TP
\fB\-k\fR, \fB\-\-key\-id\fR \fI<KEY_ID>\fR
An optional unique ID that is assigned to the imported key

If none is provided a generic one is generated for the key.
.RS
May also be specified with the \fBNETHSM_OPENPGP_KEY_ID\fR environment variable. 
.RE
.TP
\fB\-t\fR, \fB\-\-tags\fR \fI<TAGS>\fR
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.
.RS
May also be specified with the \fBNETHSM_OPENPGP_KEY_TAGS\fR environment variable. 
.RE
.TP
\fB\-a\fR, \fB\-\-auth\-passphrase\-file\fR \fI<AUTH_PASSPHRASE_FILE>\fR
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.
.RS
May also be specified with the \fBNETHSM_AUTH_PASSPHRASE_FILE\fR environment variable. 
.RE
.TP
\fB\-c\fR, \fB\-\-config\fR \fI<CONFIG>\fR
The path to a custom configuration file

If specified, the custom configuration file is used instead of the default configuration file location.
.RS
May also be specified with the \fBNETHSM_CONFIG\fR environment variable. 
.RE
.TP
\fB\-l\fR, \fB\-\-label\fR \fI<LABEL>\fR
A label uniquely identifying a device in the configuration file

Must be provided if more than one device is setup in the configuration file.
.RS
May also be specified with the \fBNETHSM_LABEL\fR environment variable. 
.RE
.TP
\fB\-u\fR, \fB\-\-user\fR \fI<USER>\fR
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.

.RS
May also be specified with the \fBNETHSM_USER\fR environment variable. 
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.TP
<\fITSK_FILE\fR>
The path to the Transferable Secret Key file to import
.RS
May also be specified with the \fBNETHSM_OPENPGP_TSK_FILE\fR environment variable. 
.RE