Gio.DtlsConnection¶
| Implementations: | |
|---|---|
| None | |
Methods¶
| close(cancellable) | |
| close_async(io_priority, cancellable, callback, *user_data) | |
| close_finish(result) | |
| emit_accept_certificate(peer_cert, errors) | |
| get_certificate() | |
| get_channel_binding_data(type) | |
| get_database() | |
| get_interaction() | |
| get_negotiated_protocol() | |
| get_peer_certificate() | |
| get_peer_certificate_errors() | |
| get_rehandshake_mode() | |
| get_require_close_notify() | |
| handshake(cancellable) | |
| handshake_async(io_priority, cancellable, callback, *user_data) | |
| handshake_finish(result) | |
| set_advertised_protocols(protocols) | |
| set_certificate(certificate) | |
| set_database(database) | |
| set_interaction(interaction) | |
| set_rehandshake_mode(mode) | |
| set_require_close_notify(require_close_notify) | |
| shutdown(shutdown_read, shutdown_write, cancellable) | |
| shutdown_async(shutdown_read, shutdown_write, io_priority, cancellable, callback, *user_data) | |
| shutdown_finish(result) | 
Virtual Methods¶
| do_accept_certificate(peer_cert, errors) | |
| do_get_binding_data(type, data) | |
| do_get_negotiated_protocol() | |
| do_handshake(cancellable) | |
| do_handshake_async(io_priority, cancellable, callback, *user_data) | |
| do_handshake_finish(result) | |
| do_set_advertised_protocols(protocols) | |
| do_shutdown(shutdown_read, shutdown_write, cancellable) | |
| do_shutdown_async(shutdown_read, shutdown_write, io_priority, cancellable, callback, *user_data) | |
| do_shutdown_finish(result) | 
Properties¶
| Name | Type | Flags | Short Description | 
|---|---|---|---|
| advertised-protocols | [ str] | r/w | Application-layer protocols available on this connection | 
| base-socket | Gio.DatagramBased | r/w/co | The Gio.DatagramBasedthat the connection wraps | 
| certificate | Gio.TlsCertificate | r/w | The connection’s certificate | 
| database | Gio.TlsDatabase | r/w | Certificate database to use for looking up or verifying certificates | 
| interaction | Gio.TlsInteraction | r/w | Optional object for user interaction | 
| negotiated-protocol | str | r | Application-layer protocol negotiated for this connection | 
| peer-certificate | Gio.TlsCertificate | r | The connection’s peer’s certificate | 
| peer-certificate-errors | Gio.TlsCertificateFlags | r | Errors found with the peer’s certificate | 
| rehandshake-mode | Gio.TlsRehandshakeMode | d/r/w/c | When to allow rehandshaking deprecated | 
| require-close-notify | bool | r/w/c | Whether to require proper TLS close notification | 
Signals¶
| Name | Short Description | 
|---|---|
| accept-certificate | Emitted during the TLS handshake after the peer certificate has been received. | 
Fields¶
None
Class Details¶
- 
class Gio.DtlsConnection¶
- Bases: - GObject.GInterface- Structure: - Gio.DtlsConnectionInterface- Gio.DtlsConnectionis the base DTLS connection class type, which wraps a- Gio.DatagramBasedand provides DTLS encryption on top of it. Its subclasses,- Gio.DtlsClientConnectionand- Gio.DtlsServerConnection, implement client-side and server-side DTLS, respectively.- For TLS support, see - Gio.TlsConnection.- As DTLS is datagram based, - Gio.DtlsConnectionimplements- Gio.DatagramBased, presenting a datagram-socket-like API for the encrypted connection. This operates over a base datagram connection, which is also a- Gio.DatagramBased(- Gio.DtlsConnection- :base-socket).- To close a DTLS connection, use - Gio.DtlsConnection.close().- Neither - Gio.DtlsServerConnectionor- Gio.DtlsClientConnectionset the peer address on their base- Gio.DatagramBasedif it is a- Gio.Socket— it is up to the caller to do that if they wish. If they do not, and- Gio.Socket.close() is called on the base socket, the- Gio.DtlsConnectionwill not raise a- Gio.IOErrorEnum.NOT_CONNECTEDerror on further I/O.- New in version 2.48. - 
close(cancellable)[source]¶
- Parameters: - cancellable ( - Gio.Cancellableor- None) – a- Gio.Cancellable, or- None- Raises: - GLib.Error- Returns: - Trueon success,- Falseotherwise- Return type: - bool- Close the DTLS connection. This is equivalent to calling - Gio.DtlsConnection.shutdown() to shut down both sides of the connection.- Closing a - Gio.DtlsConnectionwaits for all buffered but untransmitted data to be sent before it completes. It then sends a- close_notifyDTLS alert to the peer and may wait for a- close_notifyto be received from the peer. It does not close the underlying- Gio.DtlsConnection- :base-socket; that must be closed separately.- Once self is closed, all other operations will return - Gio.IOErrorEnum.CLOSED. Closing a- Gio.DtlsConnectionmultiple times will not return an error.- Gio.DtlsConnectionswill be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible.- If cancellable is cancelled, the - Gio.DtlsConnectionmay be left partially-closed and any pending untransmitted data may be lost. Call- Gio.DtlsConnection.close() again to complete closing the- Gio.DtlsConnection.- New in version 2.48. 
 - 
close_async(io_priority, cancellable, callback, *user_data)[source]¶
- Parameters: - io_priority (int) – the I/O priority of the request
- cancellable (Gio.CancellableorNone) – aGio.Cancellable, orNone
- callback (Gio.AsyncReadyCallbackorNone) – callback to call when the close operation is complete
- user_data (objectorNone) – the data to pass to the callback function
 - Asynchronously close the DTLS connection. See - Gio.DtlsConnection.close() for more information.- New in version 2.48. 
- io_priority (
 - 
close_finish(result)[source]¶
- Parameters: - result ( - Gio.AsyncResult) – a- Gio.AsyncResult- Raises: - GLib.Error- Returns: - Trueon success,- Falseon failure, in which case error will be set- Return type: - bool- Finish an asynchronous TLS close operation. See - Gio.DtlsConnection.close() for more information.- New in version 2.48. 
 - 
emit_accept_certificate(peer_cert, errors)[source]¶
- Parameters: - peer_cert (Gio.TlsCertificate) – the peer’sGio.TlsCertificate
- errors (Gio.TlsCertificateFlags) – the problems with peer_cert
 - Returns: - Trueif one of the signal handlers has returned- Trueto accept peer_cert- Return type: - Used by - Gio.DtlsConnectionimplementations to emit the- Gio.DtlsConnection- ::accept-certificatesignal.- New in version 2.48. 
- peer_cert (
 - 
get_certificate()[source]¶
- Returns: - self’s certificate, or - None- Return type: - Gio.TlsCertificateor- None- Gets self’s certificate, as set by - Gio.DtlsConnection.set_certificate().- New in version 2.48. 
 - 
get_channel_binding_data(type)[source]¶
- Parameters: - type ( - Gio.TlsChannelBindingType) –- Gio.TlsChannelBindingTypetype of data to fetch- Raises: - GLib.Error- Returns: - Trueon success,- Falseotherwise- data: - GLib.ByteArrayis filled with the binding data, or- None- Return type: - ( - bool, data:- bytes)- Query the TLS backend for TLS channel binding data of type for self. - This call retrieves TLS channel binding data as specified in RFC 5056, RFC 5929, and related RFCs. The binding data is returned in data. The data is resized by the callee using - GLib.ByteArraybuffer management and will be freed when the data is destroyed by- GLib.ByteArray.unref(). If data is- None, it will only check whether TLS backend is able to fetch the data (e.g. whether type is supported by the TLS backend). It does not guarantee that the data will be available though. That could happen if TLS connection does not support type or the binding data is not available yet due to additional negotiation or input required.- New in version 2.66. 
 - 
get_database()[source]¶
- Returns: - the certificate database that self uses or - None- Return type: - Gio.TlsDatabaseor- None- Gets the certificate database that self uses to verify peer certificates. See - Gio.DtlsConnection.set_database().- New in version 2.48. 
 - 
get_interaction()[source]¶
- Returns: - The interaction object. - Return type: - Gio.TlsInteractionor- None- Get the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. If - Noneis returned, then no user interaction will occur for this connection.- New in version 2.48. 
 - 
get_negotiated_protocol()[source]¶
- Returns: - the negotiated protocol, or - None- Return type: - stror- None- Gets the name of the application-layer protocol negotiated during the handshake. - If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of self’s protocols, or the TLS backend does not support ALPN, then this will be - None. See- Gio.DtlsConnection.set_advertised_protocols().- New in version 2.60. 
 - 
get_peer_certificate()[source]¶
- Returns: - self’s peer’s certificate, or - None- Return type: - Gio.TlsCertificateor- None- Gets self’s peer’s certificate after the handshake has completed or failed. (It is not set during the emission of - Gio.DtlsConnection- ::accept-certificate.)- New in version 2.48. 
 - 
get_peer_certificate_errors()[source]¶
- Returns: - self’s peer’s certificate errors - Return type: - Gio.TlsCertificateFlags- Gets the errors associated with validating self’s peer’s certificate, after the handshake has completed or failed. (It is not set during the emission of - Gio.DtlsConnection- ::accept-certificate.)- New in version 2.48. 
 - 
get_rehandshake_mode()[source]¶
- Returns: - Gio.TlsRehandshakeMode.SAFELY- Return type: - Gio.TlsRehandshakeMode- Gets self rehandshaking mode. See - Gio.DtlsConnection.set_rehandshake_mode() for details.- New in version 2.48. - Deprecated since version 2.64.: Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. 
 - 
get_require_close_notify()[source]¶
- Returns: - Trueif self requires a proper TLS close notification.- Return type: - bool- Tests whether or not self expects a proper TLS close notification when the connection is closed. See - Gio.DtlsConnection.set_require_close_notify() for details.- New in version 2.48. 
 - 
handshake(cancellable)[source]¶
- Parameters: - cancellable ( - Gio.Cancellableor- None) – a- Gio.Cancellable, or- None- Raises: - GLib.Error- Returns: - success or failure - Return type: - bool- Attempts a TLS handshake on self. - On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after connecting, - Gio.DtlsConnectionwill handle this for you automatically when you try to send or receive data on the connection. You can call- Gio.DtlsConnection.handshake() manually if you want to know whether the initial handshake succeeded or failed (as opposed to just immediately trying to use self to read or write, in which case, if it fails, it may not be possible to tell if it failed before or after completing the handshake), but beware that servers may reject client authentication after the handshake has completed, so a successful handshake does not indicate the connection will be usable.- Likewise, on the server side, although a handshake is necessary at the beginning of the communication, you do not need to call this function explicitly unless you want clearer error reporting. - Previously, calling - Gio.DtlsConnection.handshake() after the initial handshake would trigger a rehandshake; however, this usage was deprecated in GLib 2.60 because rehandshaking was removed from the TLS protocol in TLS 1.3. Since GLib 2.64, calling this function after the initial handshake will no longer do anything.- #GDtlsConnection::accept_certificate may be emitted during the handshake. - New in version 2.48. 
 - 
handshake_async(io_priority, cancellable, callback, *user_data)[source]¶
- Parameters: - io_priority (int) – the I/O priority of the request
- cancellable (Gio.CancellableorNone) – aGio.Cancellable, orNone
- callback (Gio.AsyncReadyCallbackorNone) – callback to call when the handshake is complete
- user_data (objectorNone) – the data to pass to the callback function
 - Asynchronously performs a TLS handshake on self. See - Gio.DtlsConnection.handshake() for more information.- New in version 2.48. 
- io_priority (
 - 
handshake_finish(result)[source]¶
- Parameters: - result ( - Gio.AsyncResult) – a- Gio.AsyncResult.- Raises: - GLib.Error- Returns: - Trueon success,- Falseon failure, in which case error will be set.- Return type: - bool- Finish an asynchronous TLS handshake operation. See - Gio.DtlsConnection.handshake() for more information.- New in version 2.48. 
 - 
set_advertised_protocols(protocols)[source]¶
- Parameters: - protocols ([ - str] or- None) – a- None-terminated array of ALPN protocol names (eg, “http/1.1”, “h2”), or- None- Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use - Gio.DtlsConnection.get_negotiated_protocol() to find the negotiated protocol after the handshake. Specifying- Nonefor the the value of protocols will disable ALPN negotiation.- See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs. - New in version 2.60. 
 - 
set_certificate(certificate)[source]¶
- Parameters: - certificate ( - Gio.TlsCertificate) – the certificate to use for self- This sets the certificate that self will present to its peer during the TLS handshake. For a - Gio.DtlsServerConnection, it is mandatory to set this, and that will normally be done at construct time.- For a - Gio.DtlsClientConnection, this is optional. If a handshake fails with- Gio.TlsError.CERTIFICATE_REQUIRED, that means that the server requires a certificate, and if you try connecting again, you should call this method first. You can call- Gio.DtlsClientConnection.get_accepted_cas() on the failed connection to get a list of Certificate Authorities that the server will accept certificates from.- (It is also possible that a server will allow the connection with or without a certificate; in that case, if you don’t provide a certificate, you can tell that the server requested one by the fact that - Gio.DtlsClientConnection.get_accepted_cas() will return non-- None.)- New in version 2.48. 
 - 
set_database(database)[source]¶
- Parameters: - database ( - Gio.TlsDatabaseor- None) – a- Gio.TlsDatabase- Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See - Gio.TlsBackend.get_default_database(). If set to- None, then peer certificate validation will always set the- Gio.TlsCertificateFlags.UNKNOWN_CAerror (meaning- Gio.DtlsConnection- ::accept-certificatewill always be emitted on client-side connections, unless that bit is not set in- Gio.DtlsClientConnection- :validation-flags).- New in version 2.48. 
 - 
set_interaction(interaction)[source]¶
- Parameters: - interaction ( - Gio.TlsInteractionor- None) – an interaction object, or- None- Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. - The interaction argument will normally be a derived subclass of - Gio.TlsInteraction.- Nonecan also be provided if no user interaction should occur for this connection.- New in version 2.48. 
 - 
set_rehandshake_mode(mode)[source]¶
- Parameters: - mode ( - Gio.TlsRehandshakeMode) – the rehandshaking mode- Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations. - New in version 2.48. - Deprecated since version 2.60.: Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. 
 - 
set_require_close_notify(require_close_notify)[source]¶
- Parameters: - require_close_notify ( - bool) – whether or not to require close notification- Sets whether or not self expects a proper TLS close notification before the connection is closed. If this is - True(the default), then self will expect to receive a TLS close notification from its peer before the connection is closed, and will return a- Gio.TlsError.EOFerror if the connection is closed without proper notification (since this may indicate a network error, or man-in-the-middle attack).- In some protocols, the application will know whether or not the connection was closed cleanly based on application-level data (because the application-level data includes a length field, or is somehow self-delimiting); in this case, the close notify is redundant and may be omitted. You can use - Gio.DtlsConnection.set_require_close_notify() to tell self to allow an “unannounced” connection close, in which case the close will show up as a 0-length read, as in a non-TLS- Gio.DatagramBased, and it is up to the application to check that the data has been fully received.- Note that this only affects the behavior when the peer closes the connection; when the application calls - Gio.DtlsConnection.close_async() on self itself, this will send a close notification regardless of the setting of this property. If you explicitly want to do an unclean close, you can close self’s- Gio.DtlsConnection- :base-socketrather than closing self itself.- New in version 2.48. 
 - 
shutdown(shutdown_read, shutdown_write, cancellable)[source]¶
- Parameters: - shutdown_read (bool) –Trueto stop reception of incoming datagrams
- shutdown_write (bool) –Trueto stop sending outgoing datagrams
- cancellable (Gio.CancellableorNone) – aGio.Cancellable, orNone
 - Raises: - Returns: - Return type: - Shut down part or all of a DTLS connection. - If shutdown_read is - Truethen the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to- Gio.DatagramBased.receive_messages() will return- Gio.IOErrorEnum.CLOSED.- If shutdown_write is - Truethen the sending side of the connection is shut down, and further writing is disallowed. Subsequent calls to- Gio.DatagramBased.send_messages() will return- Gio.IOErrorEnum.CLOSED.- It is allowed for both shutdown_read and shutdown_write to be - True— this is equivalent to calling- Gio.DtlsConnection.close().- If cancellable is cancelled, the - Gio.DtlsConnectionmay be left partially-closed and any pending untransmitted data may be lost. Call- Gio.DtlsConnection.shutdown() again to complete closing the- Gio.DtlsConnection.- New in version 2.48. 
- shutdown_read (
 - 
shutdown_async(shutdown_read, shutdown_write, io_priority, cancellable, callback, *user_data)[source]¶
- Parameters: - shutdown_read (bool) –Trueto stop reception of incoming datagrams
- shutdown_write (bool) –Trueto stop sending outgoing datagrams
- io_priority (int) – the I/O priority of the request
- cancellable (Gio.CancellableorNone) – aGio.Cancellable, orNone
- callback (Gio.AsyncReadyCallbackorNone) – callback to call when the shutdown operation is complete
- user_data (objectorNone) – the data to pass to the callback function
 - Asynchronously shut down part or all of the DTLS connection. See - Gio.DtlsConnection.shutdown() for more information.- New in version 2.48. 
- shutdown_read (
 - 
shutdown_finish(result)[source]¶
- Parameters: - result ( - Gio.AsyncResult) – a- Gio.AsyncResult- Raises: - GLib.Error- Returns: - Trueon success,- Falseon failure, in which case error will be set- Return type: - bool- Finish an asynchronous TLS shutdown operation. See - Gio.DtlsConnection.shutdown() for more information.- New in version 2.48. 
 - 
do_accept_certificate(peer_cert, errors) virtual¶
- Parameters: - peer_cert (Gio.TlsCertificate) –
- errors (Gio.TlsCertificateFlags) –
 - Return type: 
- peer_cert (
 - 
do_get_binding_data(type, data) virtual¶
- Parameters: - type (Gio.TlsChannelBindingType) –
- data (bytes) –
 - Return type: 
- type (
 - 
do_get_negotiated_protocol() virtual¶
- Returns: - the negotiated protocol, or - None- Return type: - stror- None- Gets the name of the application-layer protocol negotiated during the handshake. - If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of conn’s protocols, or the TLS backend does not support ALPN, then this will be - None. See- Gio.DtlsConnection.set_advertised_protocols().- New in version 2.60. 
 - 
do_handshake(cancellable) virtual¶
- Parameters: - cancellable ( - Gio.Cancellableor- None) – a- Gio.Cancellable, or- None- Returns: - success or failure - Return type: - bool- Attempts a TLS handshake on conn. - On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after connecting, - Gio.DtlsConnectionwill handle this for you automatically when you try to send or receive data on the connection. You can call- Gio.DtlsConnection.handshake() manually if you want to know whether the initial handshake succeeded or failed (as opposed to just immediately trying to use conn to read or write, in which case, if it fails, it may not be possible to tell if it failed before or after completing the handshake), but beware that servers may reject client authentication after the handshake has completed, so a successful handshake does not indicate the connection will be usable.- Likewise, on the server side, although a handshake is necessary at the beginning of the communication, you do not need to call this function explicitly unless you want clearer error reporting. - Previously, calling - Gio.DtlsConnection.handshake() after the initial handshake would trigger a rehandshake; however, this usage was deprecated in GLib 2.60 because rehandshaking was removed from the TLS protocol in TLS 1.3. Since GLib 2.64, calling this function after the initial handshake will no longer do anything.- #GDtlsConnection::accept_certificate may be emitted during the handshake. - New in version 2.48. 
 - 
do_handshake_async(io_priority, cancellable, callback, *user_data) virtual¶
- Parameters: - io_priority (int) – the I/O priority of the request
- cancellable (Gio.CancellableorNone) – aGio.Cancellable, orNone
- callback (Gio.AsyncReadyCallbackorNone) – callback to call when the handshake is complete
- user_data (objectorNone) – the data to pass to the callback function
 - Asynchronously performs a TLS handshake on conn. See - Gio.DtlsConnection.handshake() for more information.- New in version 2.48. 
- io_priority (
 - 
do_handshake_finish(result) virtual¶
- Parameters: - result ( - Gio.AsyncResult) – a- Gio.AsyncResult.- Returns: - Trueon success,- Falseon failure, in which case error will be set.- Return type: - bool- Finish an asynchronous TLS handshake operation. See - Gio.DtlsConnection.handshake() for more information.- New in version 2.48. 
 - 
do_set_advertised_protocols(protocols) virtual¶
- Parameters: - protocols ([ - str] or- None) – a- None-terminated array of ALPN protocol names (eg, “http/1.1”, “h2”), or- None- Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use - Gio.DtlsConnection.get_negotiated_protocol() to find the negotiated protocol after the handshake. Specifying- Nonefor the the value of protocols will disable ALPN negotiation.- See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs. - New in version 2.60. 
 - 
do_shutdown(shutdown_read, shutdown_write, cancellable) virtual¶
- Parameters: - shutdown_read (bool) –Trueto stop reception of incoming datagrams
- shutdown_write (bool) –Trueto stop sending outgoing datagrams
- cancellable (Gio.CancellableorNone) – aGio.Cancellable, orNone
 - Returns: - Return type: - Shut down part or all of a DTLS connection. - If shutdown_read is - Truethen the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to- Gio.DatagramBased.receive_messages() will return- Gio.IOErrorEnum.CLOSED.- If shutdown_write is - Truethen the sending side of the connection is shut down, and further writing is disallowed. Subsequent calls to- Gio.DatagramBased.send_messages() will return- Gio.IOErrorEnum.CLOSED.- It is allowed for both shutdown_read and shutdown_write to be - True— this is equivalent to calling- Gio.DtlsConnection.close().- If cancellable is cancelled, the - Gio.DtlsConnectionmay be left partially-closed and any pending untransmitted data may be lost. Call- Gio.DtlsConnection.shutdown() again to complete closing the- Gio.DtlsConnection.- New in version 2.48. 
- shutdown_read (
 - 
do_shutdown_async(shutdown_read, shutdown_write, io_priority, cancellable, callback, *user_data) virtual¶
- Parameters: - shutdown_read (bool) –Trueto stop reception of incoming datagrams
- shutdown_write (bool) –Trueto stop sending outgoing datagrams
- io_priority (int) – the I/O priority of the request
- cancellable (Gio.CancellableorNone) – aGio.Cancellable, orNone
- callback (Gio.AsyncReadyCallbackorNone) – callback to call when the shutdown operation is complete
- user_data (objectorNone) – the data to pass to the callback function
 - Asynchronously shut down part or all of the DTLS connection. See - Gio.DtlsConnection.shutdown() for more information.- New in version 2.48. 
- shutdown_read (
 - 
do_shutdown_finish(result) virtual¶
- Parameters: - result ( - Gio.AsyncResult) – a- Gio.AsyncResult- Returns: - Trueon success,- Falseon failure, in which case error will be set- Return type: - bool- Finish an asynchronous TLS shutdown operation. See - Gio.DtlsConnection.shutdown() for more information.- New in version 2.48. 
 
- 
Signal Details¶
- 
Gio.DtlsConnection.signals.accept_certificate(dtls_connection, peer_cert, errors)¶
- Signal Name: - accept-certificate- Flags: - Parameters: - dtls_connection (Gio.DtlsConnection) – The object which received the signal
- peer_cert (Gio.TlsCertificate) – the peer’sGio.TlsCertificate
- errors (Gio.TlsCertificateFlags) – the problems with peer_cert.
 - Returns: - Trueto accept peer_cert (which will also immediately end the signal emission).- Falseto allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it.- Return type: - Emitted during the TLS handshake after the peer certificate has been received. You can examine peer_cert’s certification path by calling - Gio.TlsCertificate.get_issuer() on it.- For a client-side connection, peer_cert is the server’s certificate, and the signal will only be emitted if the certificate was not acceptable according to conn’s #GDtlsClientConnection:validation_flags. If you would like the certificate to be accepted despite errors, return - Truefrom the signal handler. Otherwise, if no handler accepts the certificate, the handshake will fail with- Gio.TlsError.BAD_CERTIFICATE.- For a server-side connection, peer_cert is the certificate presented by the client, if this was requested via the server’s #GDtlsServerConnection:authentication_mode. On the server side, the signal is always emitted when the client presents a certificate, and the certificate will only be accepted if a handler returns - True.- Note that if this signal is emitted as part of asynchronous I/O in the main thread, then you should not attempt to interact with the user before returning from the signal handler. If you want to let the user decide whether or not to accept the certificate, you would have to return - Falsefrom the signal handler on the first attempt, and then after the connection attempt returns a- Gio.TlsError.BAD_CERTIFICATE, you can interact with the user, and if the user decides to accept the certificate, remember that fact, create a new connection, and return- Truefrom the signal handler the next time.- If you are doing I/O in another thread, you do not need to worry about this, and can simply block in the signal handler until the UI thread returns an answer. - New in version 2.48. 
- dtls_connection (
Property Details¶
- 
Gio.DtlsConnection.props.advertised_protocols¶
- Name: - advertised-protocols- Type: - [ - str]- Default Value: - []- Flags: - READABLE,- WRITABLE- The list of application-layer protocols that the connection advertises that it is willing to speak. See - Gio.DtlsConnection.set_advertised_protocols().- New in version 2.60. 
- 
Gio.DtlsConnection.props.base_socket¶
- Name: - base-socket- Type: - Gio.DatagramBased- Default Value: - None- Flags: - READABLE,- WRITABLE,- CONSTRUCT_ONLY- The - Gio.DatagramBasedthat the connection wraps. Note that this may be any implementation of- Gio.DatagramBased, not just a- Gio.Socket.- New in version 2.48. 
- 
Gio.DtlsConnection.props.certificate¶
- Name: - certificate- Type: - Gio.TlsCertificate- Default Value: - None- Flags: - READABLE,- WRITABLE- The connection’s certificate; see - Gio.DtlsConnection.set_certificate().- New in version 2.48. 
- 
Gio.DtlsConnection.props.database¶
- Name: - database- Type: - Gio.TlsDatabase- Default Value: - None- Flags: - READABLE,- WRITABLE- The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See - Gio.TlsBackend.get_default_database().- New in version 2.48. 
- 
Gio.DtlsConnection.props.interaction¶
- Name: - interaction- Type: - Gio.TlsInteraction- Default Value: - None- Flags: - READABLE,- WRITABLE- A - Gio.TlsInteractionobject to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary.- New in version 2.48. 
- 
Gio.DtlsConnection.props.negotiated_protocol¶
- Name: - negotiated-protocol- Type: - str- Default Value: - None- Flags: - READABLE- The application-layer protocol negotiated during the TLS handshake. See - Gio.DtlsConnection.get_negotiated_protocol().- New in version 2.60. 
- 
Gio.DtlsConnection.props.peer_certificate¶
- Name: - peer-certificate- Type: - Gio.TlsCertificate- Default Value: - None- Flags: - READABLE- The connection’s peer’s certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of - Gio.DtlsConnection- ::accept-certificate.- (You can watch for a - GObject.Object- ::notifysignal on this property to detect when a handshake has occurred.)- New in version 2.48. 
- 
Gio.DtlsConnection.props.peer_certificate_errors¶
- Name: - peer-certificate-errors- Type: - Gio.TlsCertificateFlags- Default Value: - 0- Flags: - READABLE- The errors noticed while verifying - Gio.DtlsConnection- :peer-certificate. Normally this should be 0, but it may not be if- Gio.DtlsClientConnection- :validation-flagsis not- Gio.TlsCertificateFlags.VALIDATE_ALL, or if- Gio.DtlsConnection- ::accept-certificateoverrode the default behavior.- New in version 2.48. 
- 
Gio.DtlsConnection.props.rehandshake_mode¶
- Name: - rehandshake-mode- Type: - Gio.TlsRehandshakeMode- Default Value: - Gio.TlsRehandshakeMode.NEVER- Flags: - DEPRECATED,- READABLE,- WRITABLE,- CONSTRUCT- The rehandshaking mode. See - Gio.DtlsConnection.set_rehandshake_mode().- New in version 2.48. - Deprecated since version 2.60: The rehandshake mode is ignored.