diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:11:06 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:11:06 +0000 |
commit | a8123060e6717f82ee27efca50c7d2daf4392809 (patch) | |
tree | 3b0b740dd83d6a1244e81e4270497ad8db31a9b7 /Documentation/nvme-tls-key.txt | |
parent | Adding debian version 2.8-2. (diff) | |
download | nvme-cli-a8123060e6717f82ee27efca50c7d2daf4392809.tar.xz nvme-cli-a8123060e6717f82ee27efca50c7d2daf4392809.zip |
Merging upstream version 2.9.1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | Documentation/nvme-tls-key.txt | 69 |
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 |