summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-tls-key.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-tls-key.txt69
1 files changed, 69 insertions, 0 deletions
diff --git a/Documentation/nvme-tls-key.txt b/Documentation/nvme-tls-key.txt
new file mode 100644
index 0000000..15942a4
--- /dev/null
+++ b/Documentation/nvme-tls-key.txt
@@ -0,0 +1,69 @@
+nvme-tls-key(1)
+======================
+
+NAME
+----
+nvme-tls-key - Manage NVMe TLS PSKs
+
+SYNOPSIS
+--------
+[verse]
+'nvme tls-key' [--keyring=<name> | -k <name>]
+ [--keytype=<type> | -t <type>]
+ [--keyfile=<file> | -f <file>]
+ [--import | -i] [--export | -e]
+ [--verbose | -v]
+
+DESCRIPTION
+-----------
+Import or export NVMe TLS pre-shared keys (PSKs) from the
+system keystore. When the '--export' option is given, all
+NVMe TLS PSKs are exported in the form
+
+<descriptions> <psk>
+
+where '<description>' is the key description from the
+exported key and '<psk>' is the key data in PSK interchange
+format 'NVMeTLSkey-1:01:<base64 encoded data>:'.
+Each key is exported in a single line.
+When the '--import' option is given key data is read in the
+same format and imported into the kernel keystore.
+
+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'.
+
+-k <file>::
+--keyfile=<file>::
+ File to read the keys from or write the keys to instead of
+ stdin / stdout.
+
+-i::
+--import::
+ Read the key data from the file specified by '--keyfile'
+ or stdin if not present.
+
+-e::
+--export::
+ Write the key data to the file specified by '--keyfile'
+ or stdou if not present.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
+EXAMPLES
+--------
+No Examples
+
+NVME
+----
+Part of the nvme-user suite