summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-gen-tls-key.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 08:17:38 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 08:17:38 +0000
commitd57675fc67455faf7c68d4003a1ce884779e2c7c (patch)
tree3becd19ea8eda8827e45bf9e627d580fe614be64 /Documentation/nvme-gen-tls-key.txt
parentReleasing debian version 2.4-1. (diff)
downloadnvme-cli-d57675fc67455faf7c68d4003a1ce884779e2c7c.tar.xz
nvme-cli-d57675fc67455faf7c68d4003a1ce884779e2c7c.zip
Merging upstream version 2.4+really2.3.
This reverts commit f42531334c05b7f49ae43c0a27e347a487fb2667.
Diffstat (limited to 'Documentation/nvme-gen-tls-key.txt')
-rw-r--r--Documentation/nvme-gen-tls-key.txt49
1 files changed, 5 insertions, 44 deletions
diff --git a/Documentation/nvme-gen-tls-key.txt b/Documentation/nvme-gen-tls-key.txt
index 9a03e3a..cfa8614 100644
--- a/Documentation/nvme-gen-tls-key.txt
+++ b/Documentation/nvme-gen-tls-key.txt
@@ -8,52 +8,18 @@ nvme-gen-tls-key - Generate a NVMe TLS PSK
SYNOPSIS
--------
[verse]
-'nvme gen-tls-key' [--keyring=<name> | -k <name>]
- [--keytype=<type> | -t <type> ]
- [--hostnqn=<nqn> | -n <nqn>]
- [--subsysnqn=<nqn> | -c <nqn>]
- [--hmac=<hmac-id> | -h <hmac-id>]
+'nvme gen-tls-key' [--hmac=<hmac-id> | -h <hmac-id>]
[--secret=<secret> | -s <secret> ]
- [--insert | -i ]
DESCRIPTION
-----------
-Generate a base64-encoded NVMe TLS pre-shared key (PSK).
-The resulting key is either printed in the PSK interchange format
-'NVMeTLSkey-1:01:<base64 encoded data>:',
-inserted as a 'retained' key into the specified keyring, or both.
-When the PSK should be inserted into the keyring a 'retained' key
-is derived from the secret key material, and the resulting 'retained'
-key is stored with the identity
-'NVMe0R0<hmac> <host NQN> <subsystem NQN>'
-in the keyring.
-The 'retained' key is derived from the secret key material,
-the specified subsystem NQN, and the host NQN.
-Once the 'retained' key is stored in the keyring the original
-secret key material cannot be retrieved.
+Generate a base64-encoded NVMe TLS pre-shared key (PSK) in
+the PSK interchange format
+NVMeTLSkey-1:01:VRLbtnN9AQb2WXW3c9+wEf/DRLz0QuLdbYvEhwtdWwNf9LrZ:
+and prints it to stdout.
OPTIONS
-------
--k <name>::
---keyring=<name>::
- Name of the keyring into which the 'retained' TLS key should be
- stored. Default is '.nvme'.
-
--t <type>::
---keytype=<type>::
- Type of the key for resulting TLS key.
- Default is 'psk'.
-
--n <nqn>::
---hostnqn=<nqn>::
- Host NVMe Qualified Name (NQN) to be used to derive the
- 'retained' TLS key
-
--c <nqn>::
---subsysnqn=<nqn>::
- Subsystem NVMe Qualified Name (NQN) to be used to derive the
- 'retained' TLS key
-
-h <hmac-id>::
--hmac=<hmac-id>::
Select a HMAC algorithm to use. Possible values are:
@@ -65,11 +31,6 @@ OPTIONS
Secret value (in hexadecimal) to be used for the key. If none are
provided a random value is used.
--i::
---insert::
- Insert the resulting TLS key into the keyring without printing out
- the key in PSK interchange format.
-
EXAMPLES
--------
No Examples