.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH nethsm-key 1  "nethsm-key " 
.SH NAME
nethsm\-key \- Operate on the keys of a device
.SH SYNOPSIS
\fBnethsm key\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] <\fIsubcommands\fR>
.SH DESCRIPTION
Operate on the keys of a device
.PP
Supports all relevant cryptographic operations (decrypt, encrypt, sign), certificate handling, importing, generation and ACL management.
.PP
Keys may exist in specific scopes: system\-wide or in namespaces (see "nethsm namespace").
While system\-wide users only have access to system\-wide keys, namespaced users only have access to keys in their own namespace.
.SH OPTIONS
.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)
.SH SUBCOMMANDS
.TP
nethsm\-key\-cert(1)
Operate on certificates for a key
.TP
nethsm\-key\-csr(1)
Get a Certificate Signing Request for a key
.TP
nethsm\-key\-decrypt(1)
Decrypt a message using a key
.TP
nethsm\-key\-encrypt(1)
Encrypt a message using a key
.TP
nethsm\-key\-generate(1)
Generate a new key
.TP
nethsm\-key\-get(1)
Get information on a key
.TP
nethsm\-key\-import(1)
Import a key
.TP
nethsm\-key\-list(1)
List all key IDs
.TP
nethsm\-key\-public\-key(1)
Get the public key for a key
.TP
nethsm\-key\-remove(1)
Remove a key
.TP
nethsm\-key\-sign(1)
Sign a message using a key
.TP
nethsm\-key\-tag(1)
Tag a key
.TP
nethsm\-key\-untag(1)
Untag a key
.TP
nethsm\-key\-help(1)
Print this message or the help of the given subcommand(s)