luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 11:26:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'mcatanzaro/tls-docs' into 'master'

Browse Source 
Update TLS documentation

See merge request GNOME/glib!199
This commit is contained in:
Philip Withnall 2018-08-07 09:46:30 +00:00
commit a5f824451f
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
gio/gtlsclientconnection.c
View File

@ -105,14 +105,7 @@ g_tls_client_connection_default_init (GTlsClientConnectionInterface *iface)
* *
* If %TRUE, forces the connection to use a fallback version of TLS * If %TRUE, forces the connection to use a fallback version of TLS
* or SSL, rather than trying to negotiate the best version of TLS * or SSL, rather than trying to negotiate the best version of TLS
* to use. This can be used when talking to servers that don't * to use. See g_tls_client_connection_set_use_ssl3().
* implement version negotiation correctly and therefore refuse to
* handshake at all with a modern TLS handshake.
*
* Despite the property name, the fallback version is usually not
* SSL 3.0, because SSL 3.0 is generally disabled by the #GTlsBackend.
* #GTlsClientConnection will use the next-highest available version
* as the fallback version.
* *
* Since: 2.28 * Since: 2.28
* *
@ -304,14 +297,19 @@ g_tls_client_connection_get_use_ssl3 (GTlsClientConnection *conn)
* @conn: the #GTlsClientConnection * @conn: the #GTlsClientConnection
* @use_ssl3: whether to use the lowest-supported protocol version * @use_ssl3: whether to use the lowest-supported protocol version
* *
* If @use_ssl3 is %TRUE, this forces @conn to use the lowest-supported * Since 2.42.1, if @use_ssl3 is %TRUE, this forces @conn to use the
* TLS protocol version rather than trying to properly negotiate the * lowest-supported TLS protocol version rather than trying to properly
* highest mutually-supported protocol version with the peer. This can * negotiate the highest mutually-supported protocol version with the
* be used when talking to broken TLS servers that exhibit protocol * peer. Be aware that SSL 3.0 is generally disabled by the
* version intolerance. * #GTlsBackend, so the lowest-supported protocol version is probably
* not SSL 3.0.
* *
* Be aware that SSL 3.0 is generally disabled by the #GTlsBackend, so * Since 2.58, this may additionally cause an RFC 7507 fallback SCSV to
* the lowest-supported protocol version is probably not SSL 3.0. * be sent to the server, causing modern TLS servers to immediately
* terminate the connection. You should generally only use this function
* if you need to connect to broken servers that exhibit TLS protocol
* version intolerance, and when an initial attempt to connect to a
* server normally has already failed.
* *
* Since: 2.28 * Since: 2.28
* *

6
gio/gtlsconnection.c
View File

@ -674,7 +674,8 @@ g_tls_connection_get_require_close_notify (GTlsConnection *conn)
* @conn: a #GTlsConnection * @conn: a #GTlsConnection
* @mode: the rehandshaking mode * @mode: the rehandshaking mode
* *
* Sets how @conn behaves with respect to rehandshaking requests. * Sets how @conn behaves with respect to rehandshaking requests, when
* TLS 1.2 or older is in use.
* *
* %G_TLS_REHANDSHAKE_NEVER means that it will never agree to * %G_TLS_REHANDSHAKE_NEVER means that it will never agree to
* rehandshake after the initial handshake is complete. (For a client, * rehandshake after the initial handshake is complete. (For a client,
@ -756,7 +757,8 @@ g_tls_connection_get_rehandshake_mode (GTlsConnection *conn)
* the beginning of the communication, you do not need to call this * the beginning of the communication, you do not need to call this
* function explicitly unless you want clearer error reporting. * function explicitly unless you want clearer error reporting.
* However, you may call g_tls_connection_handshake() later on to * However, you may call g_tls_connection_handshake() later on to
* renegotiate parameters (encryption methods, etc) with the client. * rehandshake, if TLS 1.2 or older is in use. With TLS 1.3, this will
* instead perform a rekey.
* *
* #GTlsConnection::accept_certificate may be emitted during the * #GTlsConnection::accept_certificate may be emitted during the
* handshake. * handshake.