mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-04-18 21:24:07 +03:00
42 lines
1.4 KiB
Groff
42 lines
1.4 KiB
Groff
.\" Automatically generated by Pandoc 3.5
|
|
.\"
|
|
.TH "mysql_get_ssl_cipher" "3" "" "Version 3.3" "MariaDB Connector/C"
|
|
.SS Name
|
|
mysql_get_ssl_cipher \- returns the cipher suite in use
|
|
.SS Synopsis
|
|
.IP
|
|
.EX
|
|
#include \f[B]<mysql.h>\f[R]
|
|
|
|
const char *mysql_get_ssl_cipher(MYSQL *mysql)
|
|
.EE
|
|
.SS Description
|
|
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[CR]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[CR]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[CR]TLS_RSA_WITH_AES_128_CBC_SHA\f[R]) has different names:
|
|
\f[CR]AES128\-SHA\f[R] for OpenSSL and Schannel and
|
|
\f[CR]TLS_RSA_AES_128_CBC_SHA1\f[R] for GnuTLS.
|
|
.SS Return value
|
|
Returns a zero terminated string containing the cipher suite used for a
|
|
secure connection, or \f[CR]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]
|