diff options
Diffstat (limited to 'libmariadb/man/mysql_get_ssl_cipher.3')
| -rw-r--r-- | libmariadb/man/mysql_get_ssl_cipher.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_get_ssl_cipher.3 b/libmariadb/man/mysql_get_ssl_cipher.3 new file mode 100644 index 00000000..5305d562 --- /dev/null +++ b/libmariadb/man/mysql_get_ssl_cipher.3 @@ -0,0 +1,47 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "mysql_get_ssl_cipher" "3" "" "Version 3.3.1" "MariaDB Connector/C" +.hy +.SS Name +.PP +mysql_get_ssl_cipher \- returns the cipher suite in use +.SS Synopsis +.IP +.nf +\f[C] +#include <mysql.h> + +const char *mysql_get_ssl_cipher(MYSQL *mysql) +\f[R] +.fi +.SS Description +.PP +Returns the name of the currently used cipher suite of the secure +connection, or NULL for non TLS connections. +.SS Parameter +.IP \[bu] 2 +\f[C]mysql\f[R] \- a connection identifier, which was previously +allocated by \f[B]mysql_init(3)\f[R] and connected by +\f[B]mysql_real_connect(3)\f[R]. +.SS Notes +.IP \[bu] 2 +For using \f[C]mysql_get_ssl_cipher()\f[R] MariaDB Connector/C must be +built with TLS/SSL support, otherwise the function will return NULL. +.IP \[bu] 2 +\[ga]mysql_get_ssl_cipher()\[cq] can be used to determine if the client +server connection is secure. +.IP \[bu] 2 +Depending on the TLS library in use (OpenSSL, GnuTLS or Windows +Schannel) the name of the cipher suites may differ. +For example the cipher suite 0x002F +(\f[C]TLS_RSA_WITH_AES_128_CBC_SHA\f[R]) has different names: +\f[C]AES128\-SHA\f[R] for OpenSSL and Schannel and +\f[C]TLS_RSA_AES_128_CBC_SHA1\f[R] for GnuTLS. +.SS Return value +.PP +Returns a zero terminated string containing the cipher suite used for a +secure connection, or \f[C]NULL\f[R] if connection doesn\[cq]t use +TLS/SSL. +.SS See also +.IP \[bu] 2 +\f[B]mysql_ssl_set(3)\f[R] |