summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-gen-dhchap-key.1
blob: ad54b1ff1d207d89e769654384cc93bec7631164 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
'\" t
.\"     Title: nvme-gen-dhchap-key
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 11/25/2021
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-GEN\-DHCHAP\-K" "1" "11/25/2021" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-gen-dhchap-key \- Generate a host DH\-HMAC\-CHAP key
.SH "SYNOPSIS"
.sp
.nf
\fInvme gen\-dhchap\-key\fR [\-\-hmac=<hmac\-id> | \-h <hmac\-id>]
                      [\-\-secret=<secret> | \-s <secret> ]
                      [\-\-key\-length=<len> | \-l <len> ]
                      [\-\-nqn=<host\-nqn> | \-n <host\-nqn> ]
.fi
.SH "DESCRIPTION"
.sp
Generate a base64\-encoded DH\-HMAC\-CHAP host key in the form: DHHC\-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: and prints it to stdout\&.
.SH "OPTIONS"
.PP
\-h <hmac\-id>, \-\-hmac=<hmac\-id>
.RS 4
Select a HMAC algorithm to use\&. Possible values are: 0 \- No HMAC algorithm 1 \- SHA\-256 2 \- SHA\-384 3 \- SHA\-512
.RE
.PP
\-s <secret>, \-\-secret=<secret>
.RS 4
Secret value (in hexadecimal) to be used for the key\&. If none are provided a random value is used\&.
.RE
.PP
\-l <len>, \-\-key\-length=<len>
.RS 4
Length of the resulting key\&. Possible values are 32, 48, or 64\&.
.RE
.PP
\-n <hostnqn>, \-\-nqn=<hostnqn>
.RS 4
Host\-NQN to be used for the transformation\&. This parameter is only valid if a non\-zero HMAC function has been specified\&.
.RE
.SH "EXAMPLES"
.sp
No Examples
.SH "NVME"
.sp
Part of the nvme\-user suite