Skip to content

Commit b9c74e0

Browse files
committed
docs: update TLS options
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>
1 parent 2fc6010 commit b9c74e0

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

Documentation/nvme-connect.txt

+18-6
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ SYNOPSIS
2626
[--keep-alive-tmo=<#> | -k <#>]
2727
[--reconnect-delay=<#> | -c <#>]
2828
[--ctrl-loss-tmo=<#> | -l <#>] [--tos=<#> | -T <#>]
29-
[--keyring=<#>] [--tls_key=<#>]
29+
[--keyring=<keyring>] [--tls-key=<tls-key>]
30+
[--tls-key-identity=<identity>]
3031
[--duplicate-connect | -D] [--disable-sqflow ]
3132
[--hdr-digest | -g] [--data-digest | -G] [--tls]
3233
[--concat] [--dump-config | -O] [--application=<id>]
@@ -151,11 +152,22 @@ OPTIONS
151152
--tos=<#>::
152153
Type of service for the connection (TCP)
153154

154-
--keyring=<#>::
155-
Keyring for TLS key lookup.
156-
157-
--tls_key=<#>::
158-
TLS key for the connection (TCP).
155+
--keyring=<keyring>::
156+
Keyring for TLS key lookup, either the key id or the keyring name.
157+
158+
--tls-key=<tls-key>::
159+
TLS key for the connection (TCP), either the TLS key in
160+
interchange format or the key id. It's strongly recommended not
161+
to provide the TLS key via the comamnd line due to security
162+
concerns. Instead in production situation, the key should be
163+
loaded into the keystore with 'nvme tls --import' and only the
164+
'--tls' options used. The kernel will select the matching key.
165+
166+
--tls-key-identity=<identity>::
167+
The identity used for the tls-key. If none is provided the
168+
tls-key provided via the comamnd line is considered a
169+
configuration key and a derive key will be loaded into the
170+
keyring.
159171

160172
-D::
161173
--duplicate-connect::

0 commit comments

Comments
 (0)