:right-sidebar: True DtlsClientConnection =================================================================== .. currentmodule:: gi.repository.Gio .. versionadded:: 2.48 .. class:: DtlsClientConnection(*args, **kwargs) :no-contents-entry: ``GDtlsClientConnection`` is the client-side subclass of :obj:`~gi.repository.Gio.DtlsConnection`, representing a client-side DTLS connection. Methods ------- .. rst-class:: interim-class .. class:: DtlsClientConnection :no-index: .. method:: get_accepted_cas() -> list[~typing.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 :const:`None`. Each item in the list is a ``GByteArray`` which contains the complete subject DN of the certificate authority. .. versionadded:: 2.48 .. method:: get_server_identity() -> ~gi.repository.Gio.SocketConnectable Gets ``conn``'s expected server identity .. versionadded:: 2.48 .. method:: get_validation_flags() -> ~gi.repository.Gio.TlsCertificateFlags Gets ``conn``'s validation flags This function does not work as originally designed and is impossible to use correctly. See :obj:`~gi.repository.Gio.DtlsClientConnection`:validation-flags for more information. .. versionadded:: 2.48 .. deprecated:: 2.74 Do not attempt to ignore validation errors. .. method:: new(base_socket: ~gi.repository.Gio.DatagramBased, server_identity: ~gi.repository.Gio.SocketConnectable | None = None) -> ~gi.repository.Gio.DtlsClientConnection Creates a new :obj:`~gi.repository.Gio.DtlsClientConnection` wrapping ``base_socket`` which is assumed to communicate with the server identified by ``server_identity``. .. versionadded:: 2.48 :param base_socket: the :obj:`~gi.repository.Gio.DatagramBased` to wrap :param server_identity: the expected identity of the server .. method:: set_server_identity(identity: ~gi.repository.Gio.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 :const:`~gi.repository.Gio.TlsCertificateFlags.BAD_IDENTITY` validation, if enabled. .. versionadded:: 2.48 :param identity: a :obj:`~gi.repository.Gio.SocketConnectable` describing the expected server identity .. method:: set_validation_flags(flags: ~gi.repository.Gio.TlsCertificateFlags) -> None Sets ``conn``'s validation flags, to override the default set of checks performed when validating a server certificate. By default, :const:`~gi.repository.Gio.TlsCertificateFlags.VALIDATE_ALL` is used. This function does not work as originally designed and is impossible to use correctly. See :obj:`~gi.repository.Gio.DtlsClientConnection`:validation-flags for more information. .. versionadded:: 2.48 .. deprecated:: 2.74 Do not attempt to ignore validation errors. :param flags: the :obj:`~gi.repository.Gio.TlsCertificateFlags` to use Properties ---------- .. rst-class:: interim-class .. class:: DtlsClientConnection :no-index: .. attribute:: props.accepted_cas :type: 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. .. versionadded:: 2.48 .. attribute:: props.server_identity :type: ~gi.repository.Gio.SocketConnectable A :obj:`~gi.repository.Gio.SocketConnectable` describing the identity of the server that is expected on the other end of the connection. If the :const:`~gi.repository.Gio.TlsCertificateFlags.BAD_IDENTITY` flag is set in :obj:`~gi.repository.Gio.DtlsClientConnection`:validation-flags, this object will be used to determine the expected identify of the remote end of the connection; if :obj:`~gi.repository.Gio.DtlsClientConnection`:server-identity is not set, or does not match the identity presented by the server, then the :const:`~gi.repository.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. .. versionadded:: 2.48 .. attribute:: props.validation_flags :type: ~gi.repository.Gio.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 :obj:`~gi.repository.Gio.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 :const:`~gi.repository.Gio.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. 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 :obj:`~gi.repository.Gio.DtlsConnection`::accept-certificate. .. versionadded:: 2.48 .. deprecated:: 2.74 Do not attempt to ignore validation errors.