[648:7] extends: object
Generated low-level callback wrapper for GIR callback accept-certificate.
DtlsConnectionAcceptcertificateCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, peer_cert, errors, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[720:14] static extends: object
Generated metadata helpers for DtlsConnection interface surfaces.
properties ()
Returns property metadata for
DtlsConnection.
A list.signals ()
Returns signal metadata for
DtlsConnection.
A list.[27:7] extends: object
GDtlsConnection is the base DTLS connection class type, which wraps a
[iface@Gio.DatagramBased] and provides DTLS encryption on top of it. Its
subclasses, [iface@Gio.DtlsClientConnection] and
[iface@Gio.DtlsServerConnection], implement client-side and server-side DTLS,
respectively. For TLS support, see [class@Gio.TlsConnection]. As DTLS is
datagram based, GDtlsConnection implements [iface@Gio.DatagramBased],
presenting a datagram-socket-like API for the encrypted connection. This
operates over a base datagram connection, which is also a GDatagramBased
([property@Gio.DtlsConnection:base-socket]). To close a DTLS connection, use
[method@Gio.DtlsConnection.close]. Neither [iface@Gio.DtlsServerConnection]
or [iface@Gio.DtlsClientConnection] set the peer address on their base
[iface@Gio.DatagramBased] if it is a [class@Gio.Socket] — it is up to the
caller to do that if they wish. If they do not, and [method@Gio.Socket.close]
is called on the base socket, the GDtlsConnection will not raise a
G_IO_ERROR_NOT_CONNECTED error on further I/O.
DtlsConnection (Handle = null)
Creates a new
DtlsConnectionby wrapping a native handle or another wrapper.
Handle is the native handle or another wrapper whose handle to adopt.toNativeHandle (Source)
Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from
fn.call(...), another generated wrapper exposinghandle(), or null. Returns null when the argument carries no pointer.
Source is the raw handle, raw buffer, wrapper, or null.A raw pointer carrier or null when no pointer is present.getLib ()
Returns the opened native library for this generated wrapper.
The opened native library.handle ()
Returns the wrapped NativeHandle.
The wrapped NativeHandle.isNull ()
Returns true when the wrapped handle is null.
A bool.describe ()
Returns a small string for debugging generated wrappers.
A string.connectSignal (string Name, CallbackObj)
Connects one generated callback wrapper to a named signal.
Name is the signal name.CallbackObj is the generated callback wrapper to connect.The connected handler id.disconnectSignalHandler (int HandlerId)
Disconnects one retained signal handler id.
HandlerId is the signal handler id to disconnect.None.setOnAcceptcertificate (callback Fn, UserData = null)
Emitted during the TLS handshake after the peer certificate has been received. You can examine @peer_cert's certification path by calling g_tls_certificate_get_issuer() on it. For a client-side connection,
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 %G_TLS_ERROR_BAD_CERTIFICATE. 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 %G_TLS_CERTIFICATE_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 %G_TLS_ERROR_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 %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.Fn is the Aussom callback.Fn is called with (DtlsConnection Self, TlsCertificate Peer_cert, string Errors).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.getProperty (string Name)
Reads one generated property by name.
setProperty (string Name, Value)
Writes one generated property by name.
setCertificate (object Value)
The connection's certificate; see g_dtls_connection_set_certificate().
Value is the new property value.None.setDatabase (object Value)
The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database(). When using a non-default database, #GDtlsConnection must fall back to using the #GTlsDatabase to perform certificate verification using g_tls_database_verify_chain(), which means certificate verification will not be able to make use of TLS session context. This may be less secure. For example, if you create your own #GTlsDatabase that just wraps the default #GTlsDatabase, you might expect that you have not changed anything, but this is not true because you may have altered the behavior of #GDtlsConnection by causing it to use g_tls_database_verify_chain(). See the documentation of g_tls_database_verify_chain() for more details on specific security checks that may not be performed. Accordingly, setting a non-default database is discouraged except for specialty applications with unusual security requirements.
Value is the new property value.None.setInteraction (object Value)
A #GTlsInteraction object 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.
Value is the new property value.None.setRehandshakemode (string Value)
The rehandshaking mode. See g_dtls_connection_set_rehandshake_mode().
Value is the new property value.None.setRequireclosenotify (bool Value)
Whether or not proper TLS close notification is required. See g_dtls_connection_set_require_close_notify().
Value is the new property value.None.close (object cancellable)
Close the DTLS connection. This is equivalent to calling g_dtls_connection_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_notifyDTLS alert to the peer and may wait for aclose_notifyto 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 %G_IO_ERROR_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
is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_close() again to complete closing the #GDtlsConnection.cancellable is a #GCancellable, or %NULL.close_finish (object result)
Finish an asynchronous TLS close operation. See g_dtls_connection_close() for more information.
result is a #GAsyncResult.emit_accept_certificate (object peer_cert, string errors)
Used by #GDtlsConnection implementations to emit the #GDtlsConnection::accept-certificate signal.
peer_cert is the peer's #GTlsCertificate.errors is the problems with @peer_cert.get_certificate ()
Gets @conn's certificate, as set by g_dtls_connection_set_certificate().
get_ciphersuite_name ()
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.
get_database ()
Gets the certificate database that @conn uses to verify peer certificates. See g_dtls_connection_set_database().
get_interaction ()
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.
get_negotiated_protocol ()
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 g_dtls_connection_set_advertised_protocols().
get_peer_certificate ()
Gets @conn's peer's certificate after the handshake has completed or failed. (It is not set during the emission of #GDtlsConnection::accept-certificate.)
get_peer_certificate_errors ()
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.)
get_protocol_version ()
Returns the current DTLS protocol version, which may be %G_TLS_PROTOCOL_VERSION_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.
get_rehandshake_mode ()
Gets @conn rehandshaking mode. See g_dtls_connection_set_rehandshake_mode() for details.
get_require_close_notify ()
Tests whether or not @conn expects a proper TLS close notification when the connection is closed. See g_dtls_connection_set_require_close_notify() for details.
handshake (object cancellable)
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 g_dtls_connection_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 g_dtls_connection_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.
cancellable is a #GCancellable, or %NULL.handshake_finish (object result)
Finish an asynchronous TLS handshake operation. See g_dtls_connection_handshake() for more information.
result is a #GAsyncResult..set_advertised_protocols (list protocols)
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 g_dtls_connection_get_negotiated_protocol() 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.
protocols is a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL.None.set_certificate (object certificate)
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 %G_TLS_ERROR_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 g_dtls_client_connection_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 g_dtls_client_connection_get_accepted_cas() will return non-%NULL.)
certificate is the certificate to use for @conn.None.set_database (object database)
Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to %NULL, then peer certificate validation will always set the %G_TLS_CERTIFICATE_UNKNOWN_CA 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.
database is a #GTlsDatabase.None.set_interaction (object interaction)
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.
interaction is an interaction object, or %NULL.None.set_rehandshake_mode (string 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.
mode is the rehandshaking mode.None.set_require_close_notify (bool require_close_notify)
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 %G_TLS_ERROR_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 g_dtls_connection_set_require_close_notify() 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 g_dtls_connection_close_async() 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
#GDtlsConnection:base-socket rather than closing @conn itself.require_close_notify is whether or not to require close notification.None.shutdown (bool shutdown_read, bool shutdown_write, object cancellable)
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 g_datagram_based_receive_messages() will return %G_IO_ERROR_CLOSED. If
is %TRUE then the sending side of the connection is shut down, and further writing is disallowed. Subsequent calls to g_datagram_based_send_messages() will return %G_IO_ERROR_CLOSED. It is allowed for both @shutdown_read and @shutdown_write to be TRUE — this is equivalent to calling g_dtls_connection_close(). If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection.shutdown_read is %TRUE to stop reception of incoming datagrams.shutdown_write is %TRUE to stop sending outgoing datagrams.cancellable is a #GCancellable, or %NULL.shutdown_finish (object result)
Finish an asynchronous TLS shutdown operation. See g_dtls_connection_shutdown() for more information.
result is a #GAsyncResult.
