summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_cipher_suite_info
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/functions/gnutls_cipher_suite_info
parentInitial commit. (diff)
downloadgnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz
gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/functions/gnutls_cipher_suite_info')
-rw-r--r--doc/functions/gnutls_cipher_suite_info26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/functions/gnutls_cipher_suite_info b/doc/functions/gnutls_cipher_suite_info
new file mode 100644
index 0000000..04b30ee
--- /dev/null
+++ b/doc/functions/gnutls_cipher_suite_info
@@ -0,0 +1,26 @@
+
+
+
+
+@deftypefun {const char *} {gnutls_cipher_suite_info} (size_t @var{idx}, unsigned char * @var{cs_id}, gnutls_kx_algorithm_t * @var{kx}, gnutls_cipher_algorithm_t * @var{cipher}, gnutls_mac_algorithm_t * @var{mac}, gnutls_protocol_t * @var{min_version})
+@var{idx}: index of cipher suite to get information about, starts on 0.
+
+@var{cs_id}: output buffer with room for 2 bytes, indicating cipher suite value
+
+@var{kx}: output variable indicating key exchange algorithm, or @code{NULL} .
+
+@var{cipher}: output variable indicating cipher, or @code{NULL} .
+
+@var{mac}: output variable indicating MAC algorithm, or @code{NULL} .
+
+@var{min_version}: output variable indicating TLS protocol version, or @code{NULL} .
+
+Get information about supported cipher suites. Use the function
+iteratively to get information about all supported cipher suites.
+Call with idx=0 to get information about first cipher suite, then
+idx=1 and so on until the function returns NULL.
+
+@strong{Returns:} the name of @code{idx} cipher suite, and set the information
+about the cipher suite in the output variables. If @code{idx} is out of
+bounds, @code{NULL} is returned.
+@end deftypefun