summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_gen_dhchap_key.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_gen_dhchap_key.2
parentInitial commit. (diff)
downloadlibnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz
libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.zip
Adding upstream version 1.3.upstream/1.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_gen_dhchap_key.2')
-rw-r--r--doc/man/nvme_gen_dhchap_key.224
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/man/nvme_gen_dhchap_key.2 b/doc/man/nvme_gen_dhchap_key.2
new file mode 100644
index 0000000..7035019
--- /dev/null
+++ b/doc/man/nvme_gen_dhchap_key.2
@@ -0,0 +1,24 @@
+.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_gen_dhchap_key \- DH-HMAC-CHAP key generation
+.SH SYNOPSIS
+.B "int" nvme_gen_dhchap_key
+.BI "(char *hostnqn " ","
+.BI "enum nvme_hmac_alg hmac " ","
+.BI "unsigned int key_len " ","
+.BI "unsigned char *secret " ","
+.BI "unsigned char *key " ");"
+.SH ARGUMENTS
+.IP "hostnqn" 12
+Host NVMe Qualified Name
+.IP "hmac" 12
+HMAC algorithm
+.IP "key_len" 12
+Output key length
+.IP "secret" 12
+Secret to used for digest
+.IP "key" 12
+Generated DH-HMAC-CHAP key
+.SH "RETURN"
+If key generation was successful the function returns 0 or
+-1 with errno set otherwise.