Gio.TlsClientConnection¶

Implementations:: None

Methods¶

class	`new` (base_io_stream, server_identity)
	`copy_session_state` (source)
	`get_accepted_cas` ()
	`get_server_identity` ()
	`get_use_ssl3` ()
	`get_validation_flags` ()
	`set_server_identity` (identity)
	`set_use_ssl3` (use_ssl3)
	`set_validation_flags` (flags)

Virtual Methods¶

do_copy_session_state (source)

Properties¶

Name	Type	Flags	Short Description
`accepted-cas`	`int`	r
`server-identity`	`Gio.SocketConnectable`	r/w/c
`use-ssl3`	`bool`	d/r/w/c	`deprecated`
`validation-flags`	`Gio.TlsCertificateFlags`	d/r/w/c	`deprecated`

Signals¶

None

Fields¶

None

Class Details¶

class Gio.TlsClientConnection¶

Bases:: GObject.GInterface
Structure:: Gio.TlsClientConnectionInterface

GTlsClientConnection is the client-side subclass of [class`Gio`.TlsConnection], representing a client-side TLS connection.

New in version 2.28.

classmethod new(base_io_stream, server_identity)[source]¶

Parameters:

base_io_stream (Gio.IOStream) – the Gio.IOStream to wrap
server_identity (Gio.SocketConnectable or None) – the expected identity of the server

Raises:

GLib.Error

Returns:

the new Gio.TlsClientConnection, or None on error

Return type:

Gio.TlsClientConnection

Creates a new Gio.TlsClientConnection wrapping base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by server_identity.

See the documentation for Gio.TlsConnection :base-io-stream for restrictions on when application code can run operations on the base_io_stream after this function has returned.

New in version 2.28.

copy_session_state(source)[source]¶

Parameters:: source (Gio.TlsClientConnection) – a Gio.TlsClientConnection

Possibly copies session state from one connection to another, for use in TLS session resumption. This is not normally needed, but may be used when the same session needs to be used between different endpoints, as is required by some protocols, such as FTP over TLS. source should have already completed a handshake and, since TLS 1.3, it should have been used to read data at least once. self should not have completed a handshake.

It is not possible to know whether a call to this function will actually do anything. Because session resumption is normally used only for performance benefit, the TLS backend might not implement this function. Even if implemented, it may not actually succeed in allowing self to resume source's TLS session, because the server may not have sent a session resumption token to source, or it may refuse to accept the token from self. There is no way to know whether a call to this function is actually successful.

Using this function is not required to benefit from session resumption. If the TLS backend supports session resumption, the session will be resumed automatically if it is possible to do so without weakening the privacy guarantees normally provided by TLS, without need to call this function. For example, with TLS 1.3, a session ticket will be automatically copied from any Gio.TlsClientConnection that has previously received session tickets from the server, provided a ticket is available that has not previously been used for session resumption, since session ticket reuse would be a privacy weakness. Using this function causes the ticket to be copied without regard for privacy considerations.

New in version 2.46.

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.28.

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 or None

Gets self's expected server identity

New in version 2.28.

get_use_ssl3()[source]¶

Returns:: False
Return type:: bool

SSL 3.0 is no longer supported. See Gio.TlsClientConnection.set_use_ssl3() for details.

New in version 2.28.

Deprecated since version 2.56: SSL 3.0 is insecure.

get_validation_flags()[source]¶

Returns:: the validation flags
Return type:: Gio.TlsCertificateFlags

Gets self's validation flags

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

New in version 2.28.

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

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.28.

set_use_ssl3(use_ssl3)[source]¶

Parameters:: use_ssl3 (bool) – a bool, ignored

Since GLib 2.42.1, SSL 3.0 is no longer supported.

From GLib 2.42.1 through GLib 2.62, this function could be used to force use of TLS 1.0, the lowest-supported TLS protocol version at the time. In the past, this was needed to connect to broken TLS servers that exhibited protocol version intolerance. Such servers are no longer common, and using TLS 1.0 is no longer considered acceptable.

Since GLib 2.64, this function does nothing.

New in version 2.28.

Deprecated since version 2.56: SSL 3.0 is insecure.

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.

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

New in version 2.28.

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

do_copy_session_state(source) virtual¶

Parameters:: source (Gio.TlsClientConnection) – a Gio.TlsClientConnection

Possibly copies session state from one connection to another, for use in TLS session resumption. This is not normally needed, but may be used when the same session needs to be used between different endpoints, as is required by some protocols, such as FTP over TLS. source should have already completed a handshake and, since TLS 1.3, it should have been used to read data at least once. conn should not have completed a handshake.

It is not possible to know whether a call to this function will actually do anything. Because session resumption is normally used only for performance benefit, the TLS backend might not implement this function. Even if implemented, it may not actually succeed in allowing conn to resume source's TLS session, because the server may not have sent a session resumption token to source, or it may refuse to accept the token from conn. There is no way to know whether a call to this function is actually successful.

Using this function is not required to benefit from session resumption. If the TLS backend supports session resumption, the session will be resumed automatically if it is possible to do so without weakening the privacy guarantees normally provided by TLS, without need to call this function. For example, with TLS 1.3, a session ticket will be automatically copied from any Gio.TlsClientConnection that has previously received session tickets from the server, provided a ticket is available that has not previously been used for session resumption, since session ticket reuse would be a privacy weakness. Using this function causes the ticket to be copied without regard for privacy considerations.

New in version 2.46.

Property Details¶

Gio.TlsClientConnection.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.28.

Gio.TlsClientConnection.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.TlsClientConnection :validation-flags, this object will be used to determine the expected identify of the remote end of the connection; if Gio.TlsClientConnection :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.28.

Gio.TlsClientConnection.props.use_ssl3¶

Name:: use-ssl3
Type:: bool
Default Value:: False
Flags:: DEPRECATED, READABLE, WRITABLE, CONSTRUCT

SSL 3.0 is no longer supported. See Gio.TlsClientConnection.set_use_ssl3() for details.

New in version 2.28.

Deprecated since version 2.56: SSL 3.0 is insecure.

Gio.TlsClientConnection.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:: DEPRECATED, READABLE, WRITABLE, CONSTRUCT

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 Gio.TlsConnection ::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 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 Gio.TlsConnection ::accept-certificate.

New in version 2.28.

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