: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` :Constructors: :: TlsConnection(**properties) Methods ------- .. rst-class:: interim-class .. class:: TlsConnection :no-index: .. 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, bytes] 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(io_priority: int, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> 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][io-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: ~typing.Sequence[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: ~typing.Sequence[str] The list of application-layer protocols that the connection advertises that it is willing to speak. See :func:`~gi.repository.Gio.TlsConnection.set_advertised_protocols`. .. versionadded:: 2.60 .. attribute:: props.base_io_stream :type: ~gi.repository.Gio.IOStream The :obj:`~gi.repository.Gio.IOStream` that the connection wraps. The connection holds a reference to this stream, and may run operations on the stream from other threads throughout its lifetime. Consequently, after the :obj:`~gi.repository.Gio.IOStream` has been constructed, application code may only run its own operations on this stream when no :obj:`~gi.repository.Gio.IOStream` operations are running. .. versionadded:: 2.28 .. attribute:: props.certificate :type: ~gi.repository.Gio.TlsCertificate The connection's certificate; see :func:`~gi.repository.Gio.TlsConnection.set_certificate`. .. versionadded:: 2.28 .. attribute:: props.ciphersuite_name :type: str The name of the TLS ciphersuite in use. See :func:`~gi.repository.Gio.TlsConnection.get_ciphersuite_name`. .. versionadded:: 2.70 .. attribute:: props.database :type: ~gi.repository.Gio.TlsDatabase The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See :func:`~gi.repository.Gio.TlsBackend.get_default_database`. When using a non-default database, :obj:`~gi.repository.Gio.TlsConnection` must fall back to using the :obj:`~gi.repository.Gio.TlsDatabase` to perform certificate verification using :func:`~gi.repository.Gio.TlsDatabase.verify_chain`, which means certificate verification will not be able to make use of TLS session context. This may be less secure. For example, if you create your own :obj:`~gi.repository.Gio.TlsDatabase` that just wraps the default :obj:`~gi.repository.Gio.TlsDatabase`, you might expect that you have not changed anything, but this is not true because you may have altered the behavior of :obj:`~gi.repository.Gio.TlsConnection` by causing it to use :func:`~gi.repository.Gio.TlsDatabase.verify_chain`. See the documentation of :func:`~gi.repository.Gio.TlsDatabase.verify_chain` for more details on specific security checks that may not be performed. Accordingly, setting a non-default database is discouraged except for specialty applications with unusual security requirements. .. versionadded:: 2.30 .. attribute:: props.interaction :type: ~gi.repository.Gio.TlsInteraction A :obj:`~gi.repository.Gio.TlsInteraction` object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. .. versionadded:: 2.30 .. attribute:: props.negotiated_protocol :type: str The application-layer protocol negotiated during the TLS handshake. See :func:`~gi.repository.Gio.TlsConnection.get_negotiated_protocol`. .. versionadded:: 2.60 .. attribute:: props.peer_certificate :type: ~gi.repository.Gio.TlsCertificate The connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of :obj:`~gi.repository.Gio.TlsConnection`::accept-certificate. (You can watch for a :obj:`~gi.repository.GObject.Object`::notify signal on this property to detect when a handshake has occurred.) .. versionadded:: 2.28 .. attribute:: props.peer_certificate_errors :type: ~gi.repository.Gio.TlsCertificateFlags The errors noticed while verifying :obj:`~gi.repository.Gio.TlsConnection`:peer-certificate. Normally this should be 0, but it may not be if :obj:`~gi.repository.Gio.TlsClientConnection`:validation-flags is not :const:`~gi.repository.Gio.TlsCertificateFlags.VALIDATE_ALL`, or if :obj:`~gi.repository.Gio.TlsConnection`::accept-certificate overrode the default behavior. GLib guarantees that if certificate verification fails, at least one error will be set, but it does not guarantee that all possible errors 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. .. versionadded:: 2.28 .. attribute:: props.protocol_version :type: ~gi.repository.Gio.TlsProtocolVersion The TLS protocol version in use. See :func:`~gi.repository.Gio.TlsConnection.get_protocol_version`. .. versionadded:: 2.70 .. attribute:: props.rehandshake_mode :type: ~gi.repository.Gio.TlsRehandshakeMode The rehandshaking mode. See :func:`~gi.repository.Gio.TlsConnection.set_rehandshake_mode`. .. versionadded:: 2.28 .. deprecated:: 2.60 The rehandshake mode is ignored. .. attribute:: props.require_close_notify :type: bool Whether or not proper TLS close notification is required. See :func:`~gi.repository.Gio.TlsConnection.set_require_close_notify`. .. versionadded:: 2.28 .. attribute:: props.use_system_certdb :type: bool Whether or not the system certificate database will be used to verify peer certificates. See :func:`~gi.repository.Gio.TlsConnection.set_use_system_certdb`. .. 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 Emitted during the TLS handshake after the peer certificate has been received. You can examine ``peer_cert``'s certification path by calling :func:`~gi.repository.Gio.TlsCertificate.get_issuer` on it. For a client-side connection, ``peer_cert`` is the server's certificate, and the signal will only be emitted if the certificate was not acceptable according to ``conn``'s :obj:`~gi.repository.Gio.TlsClientConnection`:validation_flags. If you would like the certificate to be accepted despite ``errors``, return :const:`True` from the signal handler. Otherwise, if no handler accepts the certificate, the handshake will fail with :const:`~gi.repository.Gio.TlsError.BAD_CERTIFICATE`. GLib guarantees that if certificate verification fails, this signal will be emitted with at least one error will be set in ``errors``, but it does not guarantee that all possible errors will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to ignore :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. For a server-side connection, ``peer_cert`` is the certificate presented by the client, if this was requested via the server's ``GTlsServerConnection``:authentication_mode. On the server side, the signal is always emitted when the client presents a certificate, and the certificate will only be accepted if a handler returns :const:`True`. Note that if this signal is emitted as part of asynchronous I/O in the main thread, then you should not attempt to interact with the user before returning from the signal handler. If you want to let the user decide whether or not to accept the certificate, you would have to return :const:`False` from the signal handler on the first attempt, and then after the connection attempt returns a :const:`~gi.repository.Gio.TlsError.BAD_CERTIFICATE`, you can interact with the user, and if the user decides to accept the certificate, remember that fact, create a new connection, and return :const:`True` from the signal handler the next time. If you are doing I/O in another thread, you do not need to worry about this, and can simply block in the signal handler until the UI thread returns an answer. .. 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 Check whether to accept a certificate. :param peer_cert: :param errors: .. method:: do_get_binding_data(type: ~gi.repository.Gio.TlsChannelBindingType, data: ~typing.Sequence[int]) -> bool Retrieve TLS channel binding data (Since: 2.66) :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[[...], None] | None = None, *user_data: ~typing.Any) -> 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][io-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