summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-tls-key.txt
blob: 15942a409f96961d803bcf79d1966d716a98540f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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