]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
docs: update TLS options
authorDaniel Wagner <dwagner@suse.de>
Wed, 23 Oct 2024 09:39:32 +0000 (11:39 +0200)
committerDaniel Wagner <wagi@monom.org>
Mon, 28 Oct 2024 18:38:51 +0000 (19:38 +0100)
With the added support to also accept the key via the command line
update the documentation accordingly.

Signed-off-by: Daniel Wagner <dwagner@suse.de>
Documentation/nvme-connect.txt

index 0112e110be5d833deadfae00eb99544c034d9c9e..a18ff0b861a7b8565e6e0ad254dafcee041fb2c2 100644 (file)
@@ -26,7 +26,8 @@ SYNOPSIS
                        [--keep-alive-tmo=<#> | -k <#>]
                        [--reconnect-delay=<#> | -c <#>]
                        [--ctrl-loss-tmo=<#> | -l <#>] [--tos=<#> | -T <#>]
-                       [--keyring=<#>] [--tls_key=<#>]
+                       [--keyring=<keyring>] [--tls-key=<tls-key>]
+                       [--tls-key-identity=<identity>]
                        [--duplicate-connect | -D] [--disable-sqflow ]
                        [--hdr-digest | -g] [--data-digest | -G] [--tls]
                        [--concat] [--dump-config | -O] [--application=<id>]
@@ -151,11 +152,22 @@ OPTIONS
 --tos=<#>::
        Type of service for the connection (TCP)
 
---keyring=<#>::
-       Keyring for TLS key lookup.
-
---tls_key=<#>::
-       TLS key for the connection (TCP).
+--keyring=<keyring>::
+       Keyring for TLS key lookup, either the key id or the keyring name.
+
+--tls-key=<tls-key>::
+       TLS key for the connection (TCP), either the TLS key in
+       interchange format or the key id. It's strongly recommended not
+       to provide the TLS key via the comamnd line due to security
+       concerns. Instead in production situation, the key should be
+       loaded into the keystore with 'nvme tls --import' and only the
+       '--tls' options used. The kernel will select the matching key.
+
+--tls-key-identity=<identity>::
+       The identity used for the tls-key. If none is provided the
+       tls-key provided via the comamnd line is considered a
+       configuration key and a derive key will be loaded into the
+       keyring.
 
 -D::
 --duplicate-connect::