:right-sidebar: True TlsConnection =================================================================== .. currentmodule:: gi.repository.Gio .. versionadded:: 2.28 .. class:: TlsConnection(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.Gio.IOStream`, :class:`~gi.repository.GObject.Object` ``GTlsConnection`` is the base TLS connection class type, which wraps a :obj:`~gi.repository.Gio.IOStream` and provides TLS encryption on top of it. Its subclasses, :obj:`~gi.repository.Gio.TlsClientConnection` and :obj:`~gi.repository.Gio.TlsServerConnection`\, implement client-side and server-side TLS, respectively. For DTLS (Datagram TLS) support, see :obj:`~gi.repository.Gio.DtlsConnection`\. Methods ------- .. rst-class:: interim-class .. class:: TlsConnection :no-index: .. method:: do_accept_certificate(self, peer_cert: ~gi.repository.Gio.TlsCertificate, errors: ~gi.repository.Gio.TlsCertificateFlags) -> bool :param peer_cert: :param errors: .. method:: do_get_binding_data(self, type: ~gi.repository.Gio.TlsChannelBindingType, data: list[int]) -> bool :param type: :param data: .. method:: do_get_negotiated_protocol(self) -> str | None .. method:: do_handshake(self, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool :param cancellable: .. method:: do_handshake_async(self, io_priority: int, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[~gi.repository.GObject.Object | None, ~gi.repository.Gio.AsyncResult, ~typing.Any], None] | None = None, user_data: ~typing.Any = None) -> None :param io_priority: :param cancellable: :param callback: :param user_data: .. method:: do_handshake_finish(self, result: ~gi.repository.Gio.AsyncResult) -> bool :param result: .. method:: emit_accept_certificate(peer_cert: ~gi.repository.Gio.TlsCertificate, errors: ~gi.repository.Gio.TlsCertificateFlags) -> bool Used by :obj:`~gi.repository.Gio.TlsConnection` implementations to emit the :obj:`~gi.repository.Gio.TlsConnection`\::accept-certificate signal. .. versionadded:: 2.28 :param peer_cert: the peer's :obj:`~gi.repository.Gio.TlsCertificate` :param errors: the problems with ``peer_cert`` .. method:: get_certificate() -> ~gi.repository.Gio.TlsCertificate | None Gets ``conn``\'s certificate, as set by :func:`~gi.repository.Gio.TlsConnection.set_certificate`. .. versionadded:: 2.28 .. method:: get_channel_binding_data(type: ~gi.repository.Gio.TlsChannelBindingType) -> tuple[bool, list[int]] 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 ``GByteArray`` buffer management and will be freed when the ``data`` is destroyed by :func:`~gi.repository.GLib.ByteArray.unref`. If ``data`` is :const:`None`, 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. .. versionadded:: 2.66 :param type: :obj:`~gi.repository.Gio.TlsChannelBindingType` type of data to fetch .. method:: get_ciphersuite_name() -> str | None Returns the name of the current TLS ciphersuite, or :const:`None` 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. .. versionadded:: 2.70 .. method:: get_database() -> ~gi.repository.Gio.TlsDatabase | None Gets the certificate database that ``conn`` uses to verify peer certificates. See :func:`~gi.repository.Gio.TlsConnection.set_database`. .. versionadded:: 2.30 .. method:: get_interaction() -> ~gi.repository.Gio.TlsInteraction | None 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 :const:`None` is returned, then no user interaction will occur for this connection. .. versionadded:: 2.30 .. method:: get_negotiated_protocol() -> str | None 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 :const:`None`. See :func:`~gi.repository.Gio.TlsConnection.set_advertised_protocols`. .. versionadded:: 2.60 .. method:: get_peer_certificate() -> ~gi.repository.Gio.TlsCertificate | None Gets ``conn``\'s peer's certificate after the handshake has completed or failed. (It is not set during the emission of :obj:`~gi.repository.Gio.TlsConnection`\::accept-certificate.) .. versionadded:: 2.28 .. method:: get_peer_certificate_errors() -> ~gi.repository.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 :obj:`~gi.repository.Gio.TlsConnection`\::accept-certificate.) See :obj:`~gi.repository.Gio.TlsConnection`\:peer-certificate-errors for more information. .. versionadded:: 2.28 .. method:: get_protocol_version() -> ~gi.repository.Gio.TlsProtocolVersion Returns the current TLS protocol version, which may be :const:`~gi.repository.Gio.TlsProtocolVersion.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 :obj:`~gi.repository.Gio.TlsProtocolVersion`\. .. versionadded:: 2.70 .. method:: get_rehandshake_mode() -> ~gi.repository.Gio.TlsRehandshakeMode Gets ``conn`` rehandshaking mode. See :func:`~gi.repository.Gio.TlsConnection.set_rehandshake_mode` for details. .. versionadded:: 2.28 .. deprecated:: 2.60. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. .. method:: get_require_close_notify() -> bool Tests whether or not ``conn`` expects a proper TLS close notification when the connection is closed. See :func:`~gi.repository.Gio.TlsConnection.set_require_close_notify` for details. .. versionadded:: 2.28 .. method:: get_use_system_certdb() -> bool Gets whether ``conn`` uses the system certificate database to verify peer certificates. See :func:`~gi.repository.Gio.TlsConnection.set_use_system_certdb`. .. deprecated:: 2.30 Use :func:`~gi.repository.Gio.TlsConnection.get_database` instead .. method:: handshake(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool 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 (or after sending a "STARTTLS"-type command), :obj:`~gi.repository.Gio.TlsConnection` will handle this for you automatically when you try to send or receive data on the connection. You can call :func:`~gi.repository.Gio.TlsConnection.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 :func:`~gi.repository.Gio.TlsConnection.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. When using a :obj:`~gi.repository.Gio.TlsConnection` created by :obj:`~gi.repository.Gio.SocketClient`\, the :obj:`~gi.repository.Gio.SocketClient` performs the initial handshake, so calling this function manually is not recommended. :obj:`~gi.repository.Gio.TlsConnection`\::accept_certificate may be emitted during the handshake. .. versionadded:: 2.28 :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`\, or :const:`None` .. method:: handshake_async(self, io_priority: int) -> bool :async: This is the `awaitable `_ version of :meth:`handshake_async`. .. versionadded:: 2.28 :param io_priority: the `I/O priority `__ of the request .. method:: handshake_async(io_priority: int, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[~gi.repository.GObject.Object | None, ~gi.repository.Gio.AsyncResult, ~typing.Any], None] | None = None, user_data: ~typing.Any = None) -> None Asynchronously performs a TLS handshake on ``conn``\. See :func:`~gi.repository.Gio.TlsConnection.handshake` for more information. .. versionadded:: 2.28 :param io_priority: the `I/O priority `__ of the request :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`\, or :const:`None` :param callback: callback to call when the handshake is complete :param user_data: the data to pass to the callback function .. method:: handshake_finish(result: ~gi.repository.Gio.AsyncResult) -> bool Finish an asynchronous TLS handshake operation. See :func:`~gi.repository.Gio.TlsConnection.handshake` for more information. .. versionadded:: 2.28 :param result: a :obj:`~gi.repository.Gio.AsyncResult`\. .. method:: set_advertised_protocols(protocols: list[str] | None = None) -> None 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 :func:`~gi.repository.Gio.TlsConnection.get_negotiated_protocol` to find the negotiated protocol after the handshake. Specifying :const:`None` for the the value of ``protocols`` will disable ALPN negotiation. See `IANA TLS ALPN Protocol IDs `__ for a list of registered protocol IDs. .. versionadded:: 2.60 :param protocols: a :const:`None`-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or :const:`None` .. method:: set_certificate(certificate: ~gi.repository.Gio.TlsCertificate) -> None This sets the certificate that ``conn`` will present to its peer during the TLS handshake. For a ``GTlsServerConnection``, it is mandatory to set this, and that will normally be done at construct time. For a :obj:`~gi.repository.Gio.TlsClientConnection`\, this is optional. If a handshake fails with :const:`~gi.repository.Gio.TlsError.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 :func:`~gi.repository.Gio.TlsClientConnection.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 :func:`~gi.repository.Gio.TlsClientConnection.get_accepted_cas` will return non-:const:`None`.) .. versionadded:: 2.28 :param certificate: the certificate to use for ``conn`` .. method:: set_database(database: ~gi.repository.Gio.TlsDatabase | None = None) -> None Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See :func:`~gi.repository.Gio.TlsBackend.get_default_database`. If set to :const:`None`, then peer certificate validation will always set the :const:`~gi.repository.Gio.TlsCertificateFlags.UNKNOWN_CA` error (meaning :obj:`~gi.repository.Gio.TlsConnection`\::accept-certificate will always be emitted on client-side connections, unless that bit is not set in :obj:`~gi.repository.Gio.TlsClientConnection`\:validation-flags). There are nonintuitive security implications when using a non-default database. See :obj:`~gi.repository.Gio.TlsConnection`\:database for details. .. versionadded:: 2.30 :param database: a :obj:`~gi.repository.Gio.TlsDatabase` .. method:: set_interaction(interaction: ~gi.repository.Gio.TlsInteraction | None = None) -> None 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 :obj:`~gi.repository.Gio.TlsInteraction`\. :const:`None` can also be provided if no user interaction should occur for this connection. .. versionadded:: 2.30 :param interaction: an interaction object, or :const:`None` .. method:: set_rehandshake_mode(mode: ~gi.repository.Gio.TlsRehandshakeMode) -> None 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. .. versionadded:: 2.28 .. deprecated:: 2.60. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. :param mode: the rehandshaking mode .. method:: set_require_close_notify(require_close_notify: bool) -> None Sets whether or not ``conn`` expects a proper TLS close notification before the connection is closed. If this is :const:`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 :const:`~gi.repository.Gio.TlsError.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 sometimes omitted. (TLS 1.1 explicitly allows this; in TLS 1.0 it is technically an error, but often done anyway.) You can use :func:`~gi.repository.Gio.TlsConnection.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 :obj:`~gi.repository.Gio.SocketConnection`\, 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 :func:`~gi.repository.Gio.IOStream.close` itself on ``conn``\, 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 :obj:`~gi.repository.Gio.TlsConnection`\:base-io-stream rather than closing ``conn`` itself, but note that this may only be done when no other operations are pending on ``conn`` or the base I/O stream. .. versionadded:: 2.28 :param require_close_notify: whether or not to require close notification .. method:: set_use_system_certdb(use_system_certdb: bool) -> None Sets whether ``conn`` uses the system certificate database to verify peer certificates. This is :const:`True` by default. If set to :const:`False`, then peer certificate validation will always set the :const:`~gi.repository.Gio.TlsCertificateFlags.UNKNOWN_CA` error (meaning :obj:`~gi.repository.Gio.TlsConnection`\::accept-certificate will always be emitted on client-side connections, unless that bit is not set in :obj:`~gi.repository.Gio.TlsClientConnection`\:validation-flags). .. deprecated:: 2.30 Use :func:`~gi.repository.Gio.TlsConnection.set_database` instead :param use_system_certdb: whether to use the system certificate database Properties ---------- .. rst-class:: interim-class .. class:: TlsConnection :no-index: .. attribute:: props.advertised_protocols :type: list[str] The type of the None singleton. .. versionadded:: 2.60 .. attribute:: props.base_io_stream :type: ~gi.repository.Gio.IOStream The type of the None singleton. .. versionadded:: 2.28 .. attribute:: props.certificate :type: ~gi.repository.Gio.TlsCertificate The type of the None singleton. .. versionadded:: 2.28 .. attribute:: props.ciphersuite_name :type: str The type of the None singleton. .. versionadded:: 2.70 .. attribute:: props.database :type: ~gi.repository.Gio.TlsDatabase The type of the None singleton. .. versionadded:: 2.30 .. attribute:: props.interaction :type: ~gi.repository.Gio.TlsInteraction The type of the None singleton. .. versionadded:: 2.30 .. attribute:: props.negotiated_protocol :type: str The type of the None singleton. .. versionadded:: 2.60 .. attribute:: props.peer_certificate :type: ~gi.repository.Gio.TlsCertificate The type of the None singleton. .. versionadded:: 2.28 .. attribute:: props.peer_certificate_errors :type: ~gi.repository.Gio.TlsCertificateFlags The type of the None singleton. .. versionadded:: 2.28 .. attribute:: props.protocol_version :type: ~gi.repository.Gio.TlsProtocolVersion The type of the None singleton. .. versionadded:: 2.70 .. attribute:: props.rehandshake_mode :type: ~gi.repository.Gio.TlsRehandshakeMode The type of the None singleton. .. versionadded:: 2.28 .. deprecated:: 2.60 The rehandshake mode is ignored. .. attribute:: props.require_close_notify :type: bool The type of the None singleton. .. versionadded:: 2.28 .. attribute:: props.use_system_certdb :type: bool The type of the None singleton. .. deprecated:: 2.30 Use GTlsConnection:database instead Signals ------- .. rst-class:: interim-class .. class:: TlsConnection.signals :no-index: .. method:: accept_certificate(peer_cert: ~gi.repository.Gio.TlsCertificate, errors: ~gi.repository.Gio.TlsCertificateFlags) -> bool The type of the None singleton. .. versionadded:: 2.28 :param peer_cert: the peer's :obj:`~gi.repository.Gio.TlsCertificate` :param errors: the problems with ``peer_cert``\. Virtual Methods --------------- .. rst-class:: interim-class .. class:: TlsConnection :no-index: .. method:: do_accept_certificate(peer_cert: ~gi.repository.Gio.TlsCertificate, errors: ~gi.repository.Gio.TlsCertificateFlags) -> bool The type of the None singleton. :param peer_cert: :param errors: .. method:: do_get_binding_data(type: ~gi.repository.Gio.TlsChannelBindingType, data: list[int]) -> bool The type of the None singleton. :param type: :param data: .. method:: do_get_negotiated_protocol() -> str | None 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 :const:`None`. See :func:`~gi.repository.Gio.TlsConnection.set_advertised_protocols`. .. versionadded:: 2.60 .. method:: do_handshake(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool 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 (or after sending a "STARTTLS"-type command), :obj:`~gi.repository.Gio.TlsConnection` will handle this for you automatically when you try to send or receive data on the connection. You can call :func:`~gi.repository.Gio.TlsConnection.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 :func:`~gi.repository.Gio.TlsConnection.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. When using a :obj:`~gi.repository.Gio.TlsConnection` created by :obj:`~gi.repository.Gio.SocketClient`\, the :obj:`~gi.repository.Gio.SocketClient` performs the initial handshake, so calling this function manually is not recommended. :obj:`~gi.repository.Gio.TlsConnection`\::accept_certificate may be emitted during the handshake. .. versionadded:: 2.28 :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`\, or :const:`None` .. method:: do_handshake_async(io_priority: int, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[~gi.repository.GObject.Object | None, ~gi.repository.Gio.AsyncResult, ~typing.Any], None] | None = None, user_data: ~typing.Any = None) -> None Asynchronously performs a TLS handshake on ``conn``\. See :func:`~gi.repository.Gio.TlsConnection.handshake` for more information. .. versionadded:: 2.28 :param io_priority: the `I/O priority `__ of the request :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`\, or :const:`None` :param callback: callback to call when the handshake is complete :param user_data: the data to pass to the callback function .. method:: do_handshake_finish(result: ~gi.repository.Gio.AsyncResult) -> bool Finish an asynchronous TLS handshake operation. See :func:`~gi.repository.Gio.TlsConnection.handshake` for more information. .. versionadded:: 2.28 :param result: a :obj:`~gi.repository.Gio.AsyncResult`\. Fields ------ .. rst-class:: interim-class .. class:: TlsConnection :no-index: .. attribute:: parent_instance .. attribute:: priv