summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_gen_dhchap_key.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
commit3945f3269b3e2763faa1ab22d225ca4dd1856b82 (patch)
tree7e96ec768baa3807ce3a1076a74037a287f4caa8 /doc/man/nvme_gen_dhchap_key.2
parentInitial commit. (diff)
downloadlibnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.tar.xz
libnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.zip
Adding upstream version 1.0.upstream/1.0
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..b9a0866
--- /dev/null
+++ b/doc/man/nvme_gen_dhchap_key.2
@@ -0,0 +1,24 @@
+.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "April 2022" "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.