DtlsClientConnection

Added in version 2.48.

class DtlsClientConnection(*args, **kwargs)

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

Methods

class DtlsClientConnection

get_accepted_cas() → list[Sequence[int]]

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 GByteArray which contains the complete subject DN of the certificate authority.

Added in version 2.48.

get_server_identity() → SocketConnectable

Gets conn’s expected server identity

Added in version 2.48.

get_validation_flags() → TlsCertificateFlags

Gets conn’s validation flags

This function does not work as originally designed and is impossible to use correctly. See DtlsClientConnection:validation-flags for more information.

Added in version 2.48.

Deprecated since version 2.74: Do not attempt to ignore validation errors.

new(base_socket: DatagramBased, server_identity: SocketConnectable | None = None) → DtlsClientConnection

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

Added in version 2.48.

Parameters:

• base_socket – the DatagramBased to wrap

• server_identity – the expected identity of the server

set_server_identity(identity: SocketConnectable) → None

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

Added in version 2.48.

Parameters:

identity – a SocketConnectable describing the expected server identity

set_validation_flags(flags: TlsCertificateFlags) → None

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

This function does not work as originally designed and is impossible to use correctly. See DtlsClientConnection:validation-flags for more information.

Added in version 2.48.

Deprecated since version 2.74: Do not attempt to ignore validation errors.

Parameters:

flags – the TlsCertificateFlags to use

Properties

class DtlsClientConnection

props.accepted_cas: list[None]

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 GByteArray which contains the complete subject DN of the certificate authority.

Added in version 2.48.

props.server_identity: SocketConnectable

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

If the BAD_IDENTITY flag is set in DtlsClientConnection:validation-flags, this object will be used to determine the expected identify of the remote end of the connection; if DtlsClientConnection:server-identity is not set, or does not match the identity presented by the server, then the 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.

Added in version 2.48.

props.validation_flags: TlsCertificateFlags

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

GLib guarantees that if certificate verification fails, at least one flag will be set, but it does not guarantee that all possible flags will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to mask 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. Therefore, there is no safe way to use this property. This is not a horrible problem, though, because you should not be attempting to ignore validation errors anyway. If you really must ignore TLS certificate errors, connect to DtlsConnection::accept-certificate.

Added in version 2.48.

Deprecated since version 2.74: Do not attempt to ignore validation errors.