Module: Gio::DtlsConnection

Defined in:
(unknown)

Overview

GDtlsConnection is the base DTLS connection class type, which wraps
a [ifaceGio.DatagramBased] and provides DTLS encryption on top of it. Its
subclasses, [ifaceGio.DtlsClientConnection] and
[ifaceGio.DtlsServerConnection], implement client-side and server-side DTLS,
respectively.

For TLS support, see [classGio.TlsConnection].

As DTLS is datagram based, GDtlsConnection implements
[ifaceGio.DatagramBased], presenting a datagram-socket-like API for the
encrypted connection. This operates over a base datagram connection, which is
also a GDatagramBased ([propertyGio.DtlsConnection:base-socket]).

To close a DTLS connection, use [methodGio.DtlsConnection.close].

Neither [ifaceGio.DtlsServerConnection] or [ifaceGio.DtlsClientConnection]
set the peer address on their base [ifaceGio.DatagramBased] if it is a
[classGio.Socket] — it is up to the caller to do that if they wish. If they
do not, and [methodGio.Socket.close] is called on the base socket, the
GDtlsConnection will not raise a G_IO_ERROR_NOT_CONNECTED error on
further I/O.

Instance Method Summary collapse

Instance Method Details

#accept_certificate(peer_cert, errors) ⇒ Boolean

Check whether to accept a certificate.

Parameters:

Returns:

  • (Boolean)

#advertised_protocols=(protocols) ⇒ nil

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 nil for the the value
of protocols will disable ALPN negotiation.

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

Parameters:

  • protocols (Array<String>) —

    a nil-terminated
    array of ALPN protocol names (eg, "http/1.1", "h2"), or nil

Returns:

  • (nil)

#certificate ⇒ Gio::TlsCertificate

Gets conn's certificate, as set by
g_dtls_connection_set_certificate().

Returns:

#certificate=(certificate) ⇒ nil

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

For a GDtls::ClientConnection, 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-nil.)

Parameters:

Returns:

  • (nil)

#ciphersuite_name ⇒ String

Returns the name of the current DTLS ciphersuite, or nil 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.

Returns:

  • (String) —

    The name of the current DTLS ciphersuite, or nil

#close(cancellable) ⇒ Boolean

Close the DTLS connection. This is equivalent to calling
g_dtls_connection_shutdown() to shut down both sides of the connection.

Closing a GDtls::Connection 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 GDtls::Connection:base-socket; that must be closed
separately.

Once conn is closed, all other operations will return %G_IO_ERROR_CLOSED.
Closing a GDtls::Connection multiple times will not return an error.

GDtls::Connections 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 GDtls::Connection may be left
partially-closed and any pending untransmitted data may be lost. Call
g_dtls_connection_close() again to complete closing the GDtls::Connection.

Parameters:

Returns:

  • (Boolean) —

    true on success, false otherwise

#close_async(io_priority, cancellable, callback, user_data) ⇒ nil

Asynchronously close the DTLS connection. See g_dtls_connection_close() for
more information.

Parameters:

  • io_priority (Integer) —

    the [I/O priority][io-priority] of the request

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback) —

    callback to call when the close operation is complete

  • user_data (GObject) —

    the data to pass to the callback function

Returns:

  • (nil)

#close_finish(result) ⇒ Boolean

Finish an asynchronous TLS close operation. See g_dtls_connection_close()
for more information.
case error will be set

Parameters:

Returns:

  • (Boolean) —

    true on success, false on failure, in which

#database ⇒ Gio::TlsDatabase

Gets the certificate database that conn uses to verify
peer certificates. See g_dtls_connection_set_database().

Returns:

#database=(database) ⇒ nil

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 nil, then
peer certificate validation will always set the
%G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning
GDtls::Connection::accept-certificate will always be emitted on
client-side connections, unless that bit is not set in
GDtls::ClientConnection:validation-flags).

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

Parameters:

Returns:

  • (nil)

#emit_accept_certificate(peer_cert, errors) ⇒ Boolean

Used by GDtls::Connection implementations to emit the
GDtls::Connection::accept-certificate signal.

Parameters:

Returns:

  • (Boolean) —

    true if one of the signal handlers has returned
    true to accept peer_cert

#get_binding_data(type, data) ⇒ Boolean

Retrieve TLS channel binding data (Since: 2.66)

Parameters:

Returns:

  • (Boolean)

#get_channel_binding_data(type, data) ⇒ Boolean

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 GByte::Array buffer management and will be freed when the data
is destroyed by g_byte_array_unref(). If data is nil, 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.

Parameters:

  • type (Gio::TlsChannelBindingType) —

    GTls::ChannelBindingType type of data to fetch

  • data (Array<Integer>) —

    GByte::Array is
    filled with the binding data, or nil

Returns:

  • (Boolean) —

    true on success, false otherwise

#handshake(cancellable) ⇒ Boolean

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, GDtls::Connection 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.

GDtls::Connection::accept_certificate may be emitted during the
handshake.

Parameters:

Returns:

  • (Boolean) —

    success or failure

#handshake_async(io_priority, cancellable, callback, user_data) ⇒ nil

Asynchronously performs a TLS handshake on conn. See
g_dtls_connection_handshake() for more information.

Parameters:

  • io_priority (Integer) —

    the [I/O priority][io-priority] of the request

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback) —

    callback to call when the handshake is complete

  • user_data (GObject) —

    the data to pass to the callback function

Returns:

  • (nil)

#handshake_finish(result) ⇒ Boolean

Finish an asynchronous TLS handshake operation. See
g_dtls_connection_handshake() for more information.
case error will be set.

Parameters:

Returns:

  • (Boolean) —

    true on success, false on failure, in which

#interaction ⇒ Gio::TlsInteraction

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

Returns:

#interaction=(interaction) ⇒ nil

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
GTls::Interaction. nil can also be provided if no user interaction
should occur for this connection.

Parameters:

Returns:

  • (nil)

#negotiated_protocol ⇒ String

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 nil. See
g_dtls_connection_set_advertised_protocols().

Returns:

  • (String) —

    the negotiated protocol, or nil

#peer_certificate ⇒ Gio::TlsCertificate

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

Returns:

#peer_certificate_errors ⇒ Gio::TlsCertificateFlags

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 GDtls::Connection::accept-certificate.)

Returns:

#protocol_version ⇒ Gio::TlsProtocolVersion

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 GTls::ProtocolVersion.

Returns:

#rehandshake_mode ⇒ Gio::TlsRehandshakeMode

Gets conn rehandshaking mode. See
g_dtls_connection_set_rehandshake_mode() for details.

Returns:

#rehandshake_mode=(mode) ⇒ nil

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.

Parameters:

Returns:

  • (nil)

#require_close_notify ⇒ Boolean

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.

Returns:

  • (Boolean) —

    true if conn requires a proper TLS close notification.

#require_close_notify=(require_close_notify) ⇒ nil

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
GDatagram::Based, 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 conn's GDtls::Connection:base-socket rather
than closing conn itself.

Parameters:

  • require_close_notify (Boolean) —

    whether or not to require close notification

Returns:

  • (nil)

#shutdown(shutdown_read, shutdown_write, cancellable) ⇒ Boolean

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 shutdown_write 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 GDtls::Connection may be left
partially-closed and any pending untransmitted data may be lost. Call
g_dtls_connection_shutdown() again to complete closing the GDtls::Connection.

Parameters:

  • shutdown_read (Boolean) —

    true to stop reception of incoming datagrams

  • shutdown_write (Boolean) —

    true to stop sending outgoing datagrams

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

Returns:

  • (Boolean) —

    true on success, false otherwise

#shutdown_async(shutdown_read, shutdown_write, io_priority, cancellable, callback, user_data) ⇒ nil

Asynchronously shut down part or all of the DTLS connection. See
g_dtls_connection_shutdown() for more information.

Parameters:

  • shutdown_read (Boolean) —

    true to stop reception of incoming datagrams

  • shutdown_write (Boolean) —

    true to stop sending outgoing datagrams

  • io_priority (Integer) —

    the [I/O priority][io-priority] of the request

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback) —

    callback to call when the shutdown operation is complete

  • user_data (GObject) —

    the data to pass to the callback function

Returns:

  • (nil)

#shutdown_finish(result) ⇒ Boolean

Finish an asynchronous TLS shutdown operation. See
g_dtls_connection_shutdown() for more information.
case error will be set

Parameters:

Returns:

  • (Boolean) —

    true on success, false on failure, in which