nvme-cli/Documentation/nvme-check-tls-key.txt

nvme-check-tls-key(1)
========================

NAME
----
nvme-check-tls-key - Check a generated NVMe TLS PSK

SYNOPSIS
--------
[verse]
'nvme check-tls-key' [--keyring=<name>  | -k <name> ]
		     [--keytype=<type>  | -t <type> ]
		     [--hostnqn=<nqn>   | -n <nqn>  ]
		     [--subsysnqn=<nqn> | -c <nqn>  ]
		     [--keydata=<key>   | -d <key>  ]

DESCRIPTION
-----------
Checks if the key is a valid NVMe TLS PSK in the PSK interchange format
'NVMeTLSkey-1:01:<base64-encoded data>:', and stores the derived 'retained'
TLS key in the keyring if the subsystem NQN is specified.

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

-d <key>::
--keydata=<key>::
	Key to be checked.

EXAMPLES
--------
No Examples

NVME
----
Part of the nvme-user suite