gio.dtls_connection_mixin

Get baseSocket property.

Get certificate property.

Set certificate property.

Get ciphersuiteName property.

Get database property.

Set database property.

Get interaction property.

Set interaction property.

Get negotiatedProtocol property.

Get peerCertificate property.

Get peerCertificateErrors property.

Get protocolVersion property.

Get rehandshakeMode property.

Set rehandshakeMode property.

Get requireCloseNotify property.

Set requireCloseNotify property.

Close the DTLS connection. This is equivalent to calling gio.dtls_connection.DtlsConnection.shutdown to shut down both sides of the connection.

Closing a #GDtlsConnection waits for all buffered but untransmitted data to be sent before it completes. It then sends a close_notify DTLS alert to the peer and may wait for a close_notify to be received from the peer. It does not close the underlying #GDtlsConnection:base-socket; that must be closed separately.

Once conn is closed, all other operations will return gio.types.IOErrorEnum.Closed. Closing a #GDtlsConnection multiple times will not return an error.

#GDtlsConnections will 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 #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call gio.dtls_connection.DtlsConnection.close again to complete closing the #GDtlsConnection.

Asynchronously close the DTLS connection. See gio.dtls_connection.DtlsConnection.close for more information.

Finish an asynchronous TLS close operation. See gio.dtls_connection.DtlsConnection.close for more information.

Used by #GDtlsConnection implementations to emit the #GDtlsConnection::accept-certificate signal.

Gets conn's certificate, as set by gio.dtls_connection.DtlsConnection.setCertificate.

Query the TLS backend for TLS channel binding data of type for conn.

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 #GByteArray buffer management and will be freed when the data is destroyed by glib.byte_array.ByteArray.unref. If data is null, 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.

Returns the name of the current DTLS ciphersuite, or null if the connection has not handshaked or has been closed. Beware that the TLS backend may use any of multiple different naming conventions, because OpenSSL and GnuTLS have their own ciphersuite naming conventions that are different from each other and different from the standard, IANA- registered ciphersuite names. The ciphersuite name is intended to be displayed to the user for informative purposes only, and parsing it is not recommended.

Gets the certificate database that conn uses to verify peer certificates. See gio.dtls_connection.DtlsConnection.setDatabase.

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 null is returned, then no user interaction will occur for this connection.

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 null. See gio.dtls_connection.DtlsConnection.setAdvertisedProtocols.

Gets conn's peer's certificate after the handshake has completed or failed. (It is not set during the emission of #GDtlsConnection::accept-certificate.)

Gets the errors associated with validating conn's peer's certificate, after the handshake has completed or failed. (It is not set during the emission of #GDtlsConnection::accept-certificate.)

Returns the current DTLS protocol version, which may be gio.types.TlsProtocolVersion.Unknown if the connection has not handshaked, or has been closed, or if the TLS backend has implemented a protocol version that is not a recognized #GTlsProtocolVersion.

Gets conn rehandshaking mode. See gio.dtls_connection.DtlsConnection.setRehandshakeMode for details.

Tests whether or not conn expects a proper TLS close notification when the connection is closed. See gio.dtls_connection.DtlsConnection.setRequireCloseNotify for details.

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, #GDtlsConnection will handle this for you automatically when you try to send or receive data on the connection. You can call gio.dtls_connection.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.dtls_connection.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.

Asynchronously performs a TLS handshake on conn. See gio.dtls_connection.DtlsConnection.handshake for more information.

Finish an asynchronous TLS handshake operation. See gio.dtls_connection.DtlsConnection.handshake for more information.

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.dtls_connection.DtlsConnection.getNegotiatedProtocol to find the negotiated protocol after the handshake. Specifying null for the the value of protocols will disable ALPN negotiation.

See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs.

This sets the certificate that conn will present to its peer during the TLS handshake. For a #GDtlsServerConnection, it is mandatory to set this, and that will normally be done at construct time.

For a #GDtlsClientConnection, this is optional. If a handshake fails with gio.types.TlsError.CertificateRequired, that means that the server requires a certificate, and if you try connecting again, you should call this method first. You can call gio.dtls_client_connection.DtlsClientConnection.getAcceptedCas 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.dtls_client_connection.DtlsClientConnection.getAcceptedCas will return non-null.)

Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See gio.tls_backend.TlsBackend.getDefaultDatabase. If set to null, then peer certificate validation will always set the gio.types.TlsCertificateFlags.UnknownCa error (meaning #GDtlsConnection::accept-certificate will always be emitted on client-side connections, unless that bit is not set in #GDtlsClientConnection:validation-flags).

There are nonintuitive security implications when using a non-default database. See #GDtlsConnection:database for details.

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 #GTlsInteraction. null can also be provided if no user interaction should occur for this connection.

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.

Sets whether or not conn expects a proper TLS close notification before the connection is closed. If this is true (the default), then conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a gio.types.TlsError.Eof error 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.dtls_connection.DtlsConnection.setRequireCloseNotify to tell conn to allow an "unannounced" connection close, in which case the close will show up as a 0-length read, as in a non-TLS #GDatagramBased, 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.dtls_connection.DtlsConnection.closeAsync on conn 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 conn's #GDtlsConnection:base-socket rather than closing conn itself.

Shut down part or all of a DTLS connection.

If shutdown_read is true then the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to gio.datagram_based.DatagramBased.receiveMessages will return gio.types.IOErrorEnum.Closed.

If shutdown_write is true then the sending side of the connection is shut down, and further writing is disallowed. Subsequent calls to gio.datagram_based.DatagramBased.sendMessages will return gio.types.IOErrorEnum.Closed.

It is allowed for both shutdown_read and shutdown_write to be TRUE — this is equivalent to calling gio.dtls_connection.DtlsConnection.close.

If cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call gio.dtls_connection.DtlsConnection.shutdown again to complete closing the #GDtlsConnection.

Asynchronously shut down part or all of the DTLS connection. See gio.dtls_connection.DtlsConnection.shutdown for more information.

Finish an asynchronous TLS shutdown operation. See gio.dtls_connection.DtlsConnection.shutdown for more information.

Connect to AcceptCertificate signal.

Emitted during the TLS handshake after the peer certificate has been received. You can examine peer_cert's certification path by calling gio.tls_certificate.TlsCertificate.getIssuer 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 true from the signal handler. Otherwise, if no handler accepts the certificate, the handshake will fail with gio.types.TlsError.BadCertificate.

GLib guarantees that if certificate verification fails, this signal will be emitted with at least one error will be set in errors, but it does not guarantee that all possible errors will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to ignore gio.types.TlsCertificateFlags.Expired if you want to allow expired certificates, because this could potentially be the only error flag set even if other problems exist with the 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 false from the signal handler on the first attempt, and then after the connection attempt returns a gio.types.TlsError.BadCertificate, you can interact with the user, and if the user decides to accept the certificate, remember that fact, create a new connection, and return true from 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.

Set baseSocket property.

Set certificate property.

Set database property.

Set interaction property.

Set rehandshakeMode property.

Set requireCloseNotify property.