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

gtlsconnection: Improve documentation of peer-certificate[-errors]

Browse Source 
In glib-networking#127, it was reported that we don't properly implement
the documented behavior of these properties. However, we cannot fix it
because libsoup relies on the implemented behavior, and it's hard to
change that without cascading breakage. The practical solution is to
adjust our documentation to match reality. There should be no downsides
to this, and compat risk of changing the documentation is much smaller
than risk of changing the implementation, so I think this is the best we
can make of an unfortunate situation. See glib-networking#127 for full
discussion and glib-networking#129 for the regression when we attempted
to match the documented behavior.
This commit is contained in:
Michael Catanzaro 2020-06-10 09:56:47 -05:00
parent d918b6bcd1
commit 4db1336ff6
2 changed files with 14 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
gio/gdtlsconnection.c
View File

@ -195,9 +195,8 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
* GDtlsConnection:peer-certificate: (nullable)
*
* The connection's peer's certificate, after the TLS handshake has
* completed and the certificate has been accepted. Note in
* particular that this is not yet set during the emission of
* #GDtlsConnection::accept-certificate.
* completed or failed. Note in particular that this is not yet set
* during the emission of #GDtlsConnection::accept-certificate.
*
* (You can watch for a #GObject::notify signal on this property to
* detect when a handshake has occurred.)
@ -214,7 +213,7 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
/**
* GDtlsConnection:peer-certificate-errors:
*
* The errors noticed-and-ignored while verifying
* The errors noticed while verifying
* #GDtlsConnection:peer-certificate. Normally this should be 0, but
* it may not be if #GDtlsClientConnection:validation-flags is not
* %G_TLS_CERTIFICATE_VALIDATE_ALL, or if
@ -494,8 +493,8 @@ g_dtls_connection_get_interaction (GDtlsConnection *conn)
* g_dtls_connection_get_peer_certificate:
* @conn: a #GDtlsConnection
*
* Gets @conn's peer's certificate after the handshake has completed.
* (It is not set during the emission of
* Gets @conn's peer's certificate after the handshake has completed
* or failed. (It is not set during the emission of
* #GDtlsConnection::accept-certificate.)
*
* Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL
@ -521,8 +520,8 @@ g_dtls_connection_get_peer_certificate (GDtlsConnection *conn)
* @conn: a #GDtlsConnection
*
* Gets the errors associated with validating @conn's peer's
* certificate, after the handshake has completed. (It is not set
* during the emission of #GDtlsConnection::accept-certificate.)
* certificate, after the handshake has completed or failed. (It is
* not set during the emission of #GDtlsConnection::accept-certificate.)
*
* Returns: @conn's peer's certificate errors
*

15
gio/gtlsconnection.c
View File

@ -228,9 +228,8 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
* GTlsConnection:peer-certificate: (nullable)
*
* The connection's peer's certificate, after the TLS handshake has
* completed and the certificate has been accepted. Note in
* particular that this is not yet set during the emission of
* #GTlsConnection::accept-certificate.
* completed or failed. Note in particular that this is not yet set
* during the emission of #GTlsConnection::accept-certificate.
*
* (You can watch for a #GObject::notify signal on this property to
* detect when a handshake has occurred.)
@ -247,7 +246,7 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
/**
* GTlsConnection:peer-certificate-errors:
*
* The errors noticed-and-ignored while verifying
* The errors noticed while verifying
* #GTlsConnection:peer-certificate. Normally this should be 0, but
* it may not be if #GTlsClientConnection:validation-flags is not
* %G_TLS_CERTIFICATE_VALIDATE_ALL, or if
@ -611,8 +610,8 @@ g_tls_connection_get_interaction (GTlsConnection *conn)
* g_tls_connection_get_peer_certificate:
* @conn: a #GTlsConnection
*
* Gets @conn's peer's certificate after the handshake has completed.
* (It is not set during the emission of
* Gets @conn's peer's certificate after the handshake has completed
* or failed. (It is not set during the emission of
* #GTlsConnection::accept-certificate.)
*
* Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL
@ -638,8 +637,8 @@ g_tls_connection_get_peer_certificate (GTlsConnection *conn)
* @conn: a #GTlsConnection
*
* Gets the errors associated with validating @conn's peer's
* certificate, after the handshake has completed. (It is not set
* during the emission of #GTlsConnection::accept-certificate.)
* certificate, after the handshake has completed or failed. (It is
* not set during the emission of #GTlsConnection::accept-certificate.)
*
* Returns: @conn's peer's certificate errors
*