summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_import_tls_key.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_import_tls_key.2')
-rw-r--r--doc/man/nvme_import_tls_key.221
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/man/nvme_import_tls_key.2 b/doc/man/nvme_import_tls_key.2
new file mode 100644
index 0000000..4b3a4cc
--- /dev/null
+++ b/doc/man/nvme_import_tls_key.2
@@ -0,0 +1,21 @@
+.TH "nvme_import_tls_key" 9 "nvme_import_tls_key" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_import_tls_key \- Import a TLS key
+.SH SYNOPSIS
+.B "unsigned char *" nvme_import_tls_key
+.BI "(const char *encoded_key " ","
+.BI "int *key_len " ","
+.BI "unsigned int *hmac " ");"
+.SH ARGUMENTS
+.IP "encoded_key" 12
+TLS key in PSK interchange format
+.IP "key_len" 12
+Length of the resulting key data
+.IP "hmac" 12
+HMAC algorithm
+.SH "DESCRIPTION"
+Imports \fIkey_data\fP in the PSK Interchange format as defined in section
+3.6.1.5 of the NVMe TCP Transport specification.
+.SH "RETURN"
+The raw data of the PSK or NULL with errno set on error. It is
+the responsibility of the caller to free the returned string.