Gio.DtlsClientConnection

g GObject.GInterface GObject.GInterface Gio.DtlsClientConnection Gio.DtlsClientConnection GObject.GInterface->Gio.DtlsClientConnection

Implementations:
 None

Methods

class new (base_socket, server_identity)
  get_accepted_cas ()
  get_server_identity ()
  get_validation_flags ()
  set_server_identity (identity)
  set_validation_flags (flags)

Virtual Methods

None

Properties

Name Type Flags Short Description
accepted-cas int r Distinguished names of the CAs the server accepts certificates from
server-identity Gio.SocketConnectable r/w/c Gio.SocketConnectable identifying the server
validation-flags Gio.TlsCertificateFlags r/w/c What certificate validation to perform

Signals

None

Fields

None

Class Details

class Gio.DtlsClientConnection
Bases:GObject.GInterface
Structure:Gio.DtlsClientConnectionInterface

Gio.DtlsClientConnection is the client-side subclass of Gio.DtlsConnection, representing a client-side DTLS connection.

New in version 2.48.

classmethod new(base_socket, server_identity)[source]
Parameters:
Raises:

GLib.Error

Returns:

the new Gio.DtlsClientConnection, or None on error

Return type:

Gio.DtlsClientConnection

Creates a new Gio.DtlsClientConnection wrapping base_socket which is assumed to communicate with the server identified by server_identity.

New in version 2.48.

get_accepted_cas()[source]
Returns:the list of CA DNs. You should unref each element with GLib.ByteArray.unref() and then the free the list with g_list_free().
Return type:[bytes]

Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be None.

Each item in the list is a GLib.ByteArray which contains the complete subject DN of the certificate authority.

New in version 2.48.

get_server_identity()[source]
Returns:a Gio.SocketConnectable describing the expected server identity, or None if the expected identity is not known.
Return type:Gio.SocketConnectable

Gets self’s expected server identity

New in version 2.48.

get_validation_flags()[source]
Returns:the validation flags
Return type:Gio.TlsCertificateFlags

Gets self’s validation flags

New in version 2.48.

set_server_identity(identity)[source]
Parameters:identity (Gio.SocketConnectable) – a Gio.SocketConnectable describing the expected server identity

Sets self’s expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let self know what name to look for in the certificate when performing Gio.TlsCertificateFlags.BAD_IDENTITY validation, if enabled.

New in version 2.48.

set_validation_flags(flags)[source]
Parameters:flags (Gio.TlsCertificateFlags) – the Gio.TlsCertificateFlags to use

Sets self’s validation flags, to override the default set of checks performed when validating a server certificate. By default, Gio.TlsCertificateFlags.VALIDATE_ALL is used.

New in version 2.48.

Property Details

Gio.DtlsClientConnection.props.accepted_cas
Name:accepted-cas
Type:int
Default Value:None
Flags:READABLE

A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes.

Each item in the list is a GLib.ByteArray which contains the complete subject DN of the certificate authority.

New in version 2.48.

Gio.DtlsClientConnection.props.server_identity
Name:server-identity
Type:Gio.SocketConnectable
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT

A Gio.SocketConnectable describing the identity of the server that is expected on the other end of the connection.

If the Gio.TlsCertificateFlags.BAD_IDENTITY flag is set in Gio.DtlsClientConnection :validation-flags, this object will be used to determine the expected identify of the remote end of the connection; if Gio.DtlsClientConnection :server-identity is not set, or does not match the identity presented by the server, then the Gio.TlsCertificateFlags.BAD_IDENTITY validation will fail.

In addition to its use in verifying the server certificate, this is also used to give a hint to the server about what certificate we expect, which is useful for servers that serve virtual hosts.

New in version 2.48.

Gio.DtlsClientConnection.props.validation_flags
Name:validation-flags
Type:Gio.TlsCertificateFlags
Default Value:Gio.TlsCertificateFlags.UNKNOWN_CA | Gio.TlsCertificateFlags.BAD_IDENTITY | Gio.TlsCertificateFlags.NOT_ACTIVATED | Gio.TlsCertificateFlags.EXPIRED | Gio.TlsCertificateFlags.REVOKED | Gio.TlsCertificateFlags.INSECURE | Gio.TlsCertificateFlags.GENERIC_ERROR | Gio.TlsCertificateFlags.VALIDATE_ALL
Flags:READABLE, WRITABLE, CONSTRUCT

What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in all of the ways indicated here will be rejected unless the application overrides the default via Gio.DtlsConnection ::accept-certificate.

New in version 2.48.