summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_cipher_suite_get_name
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/gnutls_cipher_suite_get_name')
-rw-r--r--doc/functions/gnutls_cipher_suite_get_name21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/functions/gnutls_cipher_suite_get_name b/doc/functions/gnutls_cipher_suite_get_name
new file mode 100644
index 0000000..1174416
--- /dev/null
+++ b/doc/functions/gnutls_cipher_suite_get_name
@@ -0,0 +1,21 @@
+
+
+
+
+@deftypefun {const char *} {gnutls_cipher_suite_get_name} (gnutls_kx_algorithm_t @var{kx_algorithm}, gnutls_cipher_algorithm_t @var{cipher_algorithm}, gnutls_mac_algorithm_t @var{mac_algorithm})
+@var{kx_algorithm}: is a Key exchange algorithm
+
+@var{cipher_algorithm}: is a cipher algorithm
+
+@var{mac_algorithm}: is a MAC algorithm
+
+This function returns the ciphersuite name under TLS1.2 or earlier
+versions when provided with individual algorithms. The full cipher suite
+name must be prepended by TLS or SSL depending of the protocol in use.
+
+To get a description of the current ciphersuite across versions, it
+is recommended to use @code{gnutls_session_get_desc()} .
+
+@strong{Returns:} a string that contains the name of a TLS cipher suite,
+specified by the given algorithms, or @code{NULL} .
+@end deftypefun