summaryrefslogtreecommitdiffstats
path: root/doc/rst/linux.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-11-09 08:04:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-11-09 08:04:14 +0000
commit90e4bb6ac55713bbad28f98f515b9d5dcafb7c82 (patch)
tree8d020c088a40dc6f1db2a16e6697db7a22238da0 /doc/rst/linux.rst
parentReleasing debian version 1.10-1. (diff)
downloadlibnvme-90e4bb6ac55713bbad28f98f515b9d5dcafb7c82.tar.xz
libnvme-90e4bb6ac55713bbad28f98f515b9d5dcafb7c82.zip
Merging upstream version 1.11.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--doc/rst/linux.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/doc/rst/linux.rst b/doc/rst/linux.rst
index 05d1418..2693373 100644
--- a/doc/rst/linux.rst
+++ b/doc/rst/linux.rst
@@ -760,6 +760,37 @@ on error. It is the responsibility of the caller to free the returned
string.
+.. c:function:: char * nvme_export_tls_key_versioned (unsigned char version, unsigned char hmac, const unsigned char *key_data, size_t key_len)
+
+ Export a TLS pre-shared key
+
+**Parameters**
+
+``unsigned char version``
+ Indicated the representation of the TLS PSK
+
+``unsigned char hmac``
+ HMAC algorithm used to transfor the configured PSK
+ in a retained PSK
+
+``const unsigned char *key_data``
+ Raw data of the key
+
+``size_t key_len``
+ Length of **key_data**
+
+**Description**
+
+Returns **key_data** in the PSK Interchange format as defined in section
+3.6.1.5 of the NVMe TCP Transport specification.
+
+**Return**
+
+The string containing the TLS identity or NULL with errno set
+on error. It is the responsibility of the caller to free the returned
+string.
+
+
.. c:function:: unsigned char * nvme_import_tls_key (const char *encoded_key, int *key_len, unsigned int *hmac)
Import a TLS key
@@ -786,6 +817,36 @@ 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.
+.. c:function:: unsigned char * nvme_import_tls_key_versioned (const char *encoded_key, unsigned char *version, unsigned char *hmac, size_t *key_len)
+
+ Import a TLS key
+
+**Parameters**
+
+``const char *encoded_key``
+ TLS key in PSK interchange format
+
+``unsigned char *version``
+ Indicated the representation of the TLS PSK
+
+``unsigned char *hmac``
+ HMAC algorithm used to transfor the configured
+ PSK in a retained PSK
+
+``size_t *key_len``
+ Length of the resulting key data
+
+**Description**
+
+Imports **key_data** in the PSK Interchange format as defined in section
+3.6.1.5 of the NVMe TCP Transport specification.
+
+**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.
+
+
.. c:function:: int nvme_submit_passthru (int fd, unsigned long ioctl_cmd, struct nvme_passthru_cmd *cmd, __u32 *result)
Low level ioctl wrapper for passthru commands