.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH nethsm-openpgp-sign 1  "nethsm-openpgp-sign " 
.SH NAME
nethsm\-openpgp\-sign \- Create an OpenPGP signature for a message
.SH SYNOPSIS
\fBnethsm openpgp 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> <\fIMESSAGE\fR> 
.SH DESCRIPTION
Create an OpenPGP signature for a message
.PP
The signature is written to stdout, unless a specific path to a file is provided.
.PP
System\-wide users in the "Operator" role can only create OpenPGP signatures for a message using system\-wide keys.
Namespaced users in the "Operator" role can only create OpenPGP signatures for a message using keys in their own namespace.
.PP
Requires authentication of a user in the "Operator" role that has access to the targeted key (see "nethsm key tag" and "nethsm user tag").
.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 \fI<OUTPUT>\fR
The optional path to a specific output file
.RS
May also be specified with the \fBNETHSM_OPENPGP_SIGNATURE_OUTPUT_FILE\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
<\fIKEY_ID\fR>
The ID of the key to use
.RS
May also be specified with the \fBNETHSM_KEY_ID\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_OPENPGP_SIGNATURE_MESSAGE\fR environment variable. 
.RE