diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-12-24 07:57:49 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-12-24 07:57:49 +0000 |
| commit | fc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch) | |
| tree | 4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation/nvme-check-tls-key.txt | |
| parent | Adding upstream version 2.5. (diff) | |
| download | nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip | |
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
| -rw-r--r-- | Documentation/nvme-check-tls-key.txt | 38 |
1 files changed, 31 insertions, 7 deletions
diff --git a/Documentation/nvme-check-tls-key.txt b/Documentation/nvme-check-tls-key.txt index a676f04..2df4fca 100644 --- a/Documentation/nvme-check-tls-key.txt +++ b/Documentation/nvme-check-tls-key.txt @@ -8,17 +8,22 @@ 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> ] +'nvme check-tls-key' [--keyring=<name> | -k <name>] + [--keytype=<type> | -t <type>] + [--hostnqn=<nqn> | -n <nqn>] + [--subsysnqn=<nqn> | -c <nqn>] + [--keydata=<key> | -d <key>] + [--output-format=<fmt> | -o <fmt>] + [--identity=<id-vers> | -I <id-vers>] + [--insert | -i ] + [--verbose | -v] 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. +'NVMeTLSkey-1:01:<base64-encoded data>:'. If '--insert' is specified the +the derived 'retained' TLS key is stored in the keyring, otherwise the +TLS identity of the key is printed out. OPTIONS ------- @@ -46,6 +51,25 @@ OPTIONS --keydata=<key>:: Key to be checked. +-I <id-vers>:: +--identity=<id-vers>:: + NVMe TLS key identity version to be used; '0' for the default + identity, and '1' for the TLS identity suffixed by the PSK hash + as specified in TP8018. + +-i: +--insert: + Insert the derived 'retained' key in the keyring. + +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No Examples |