| 1 |
.TH "nvme_insert_tls_key" 9 "nvme_insert_tls_key" "November 2025" "libnvme API manual" LINUX |
| 2 |
.SH NAME |
| 3 |
nvme_insert_tls_key \- Derive and insert TLS key |
| 4 |
.SH SYNOPSIS |
| 5 |
.B "long" nvme_insert_tls_key |
| 6 |
.BI "(const char *keyring " "," |
| 7 |
.BI "const char *key_type " "," |
| 8 |
.BI "const char *hostnqn " "," |
| 9 |
.BI "const char *subsysnqn " "," |
| 10 |
.BI "int hmac " "," |
| 11 |
.BI "unsigned char *configured_key " "," |
| 12 |
.BI "int key_len " ");" |
| 13 |
.SH ARGUMENTS |
| 14 |
.IP "keyring" 12 |
| 15 |
Keyring to use |
| 16 |
.IP "key_type" 12 |
| 17 |
Type of the resulting key |
| 18 |
.IP "hostnqn" 12 |
| 19 |
Host NVMe Qualified Name |
| 20 |
.IP "subsysnqn" 12 |
| 21 |
Subsystem NVMe Qualified Name |
| 22 |
.IP "hmac" 12 |
| 23 |
HMAC algorithm |
| 24 |
.IP "configured_key" 12 |
| 25 |
Configured key data to derive the key from |
| 26 |
.IP "key_len" 12 |
| 27 |
Length of \fIconfigured_key\fP |
| 28 |
.SH "DESCRIPTION" |
| 29 |
Derives a 'retained' TLS key as specified in NVMe TCP 1.0a and |
| 30 |
stores it as type \fIkey_type\fP in the keyring specified by \fIkeyring\fP. |
| 31 |
.SH "RETURN" |
| 32 |
The key serial number if the key could be inserted into |
| 33 |
the keyring or 0 with errno otherwise. |