.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH nethsm-key-sign 1  "nethsm-key-sign " 
.SH NAME
nethsm\-key\-sign \- Sign a message using a key
.SH SYNOPSIS
\fBnethsm key sign\fR [\fB\-f\fR|\fB\-\-force\fR] [\fB\-o\fR|\fB\-\-output\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] <\fIKEY_ID\fR> <\fISIGNATURE_TYPE\fR> <\fIMESSAGE\fR> 
.SH DESCRIPTION
Sign a message using a key
.PP
The targeted key must be equipped with relevant key mechanisms for signing.
The chosen signature type must match the target key type and key mechanisms.
.PP
If no specific output file is chosen, the signature is written to stdout.
.PP
System\-wide users in the "Operator" role can only create signatures for messages using system\-wide keys.
Namespaced users in the "Operator" role can only create signatures for messages using keys in their own namespace.
.PP
Requires authentication of a user in the "Operator" role with access (see "nethsm key tag" and "nethsm user tag") to the target key.
.SH OPTIONS
.TP
\fB\-f\fR, \fB\-\-force\fR
Write to output file even if it exists already
.RS
May also be specified with the \fBNETHSM_FORCE\fR environment variable. 
.RE
.TP
\fB\-o\fR, \fB\-\-output\fR=\fIOUTPUT\fR
The optional path to a specific file that the signature is written to
.RS
May also be specified with the \fBNETHSM_KEY_SIGNATURE_OUTPUT_FILE\fR environment variable. 
.RE
.TP
\fB\-a\fR, \fB\-\-auth\-passphrase\-file\fR=\fIAUTH_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=\fICONFIG\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=\fILABEL\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=\fIUSER\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
<\fIKEY_ID\fR>
The ID of the key to use for signing the message
.RS
May also be specified with the \fBNETHSM_KEY_ID\fR environment variable. 
.RE
.TP
<\fISIGNATURE_TYPE\fR>
The signature type to use for the signature

One of ["EcdsaP224", "EcdsaP256", "EcdsaP384", "EcdsaP521", "EdDsa", "Pkcs1", "PssMd5", "PssSha1", "PssSha224", "PssSha256", "PssSha384", "PssSha512"]
.RS
May also be specified with the \fBNETHSM_KEY_SIGNATURE_TYPE\fR environment variable. 
.RE
.TP
<\fIMESSAGE\fR>
The path to a message for which to create a signature
.RS
May also be specified with the \fBNETHSM_KEY_SIGNATURE_MESSAGE\fR environment variable. 
.RE