Gio.TlsClientConnection

g GObject.GInterface GObject.GInterface Gio.TlsClientConnection Gio.TlsClientConnection GObject.GInterface->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 Distinguished names of the CAs the server accepts certificates from
server-identity Gio.SocketConnectable r/w/c Gio.SocketConnectable identifying the server
use-ssl3 bool d/r/w/c Use fallback version of SSL/TLS rather than most recent version deprecated
validation-flags Gio.TlsCertificateFlags r/w/c What certificate validation to perform

Signals

None

Fields

None

Class Details

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

Gio.TlsClientConnection is the client-side subclass of Gio.TlsConnection, representing a client-side TLS connection.

New in version 2.28.

classmethod new(base_io_stream, server_identity)[source]
Parameters:
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

Copies session state from one connection to another. 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 self should not have completed a handshake.

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

Gets self’s expected server identity

New in version 2.28.

get_use_ssl3()[source]
Returns:whether self will use the lowest-supported TLS protocol version
Return type:bool

Gets whether self will force the lowest-supported TLS protocol version rather than attempt to negotiate the highest mutually- supported version of TLS; see Gio.TlsClientConnection.set_use_ssl3().

New in version 2.28.

Deprecated since version 2.56: SSL 3.0 is insecure, and this function does not actually indicate whether it is enabled.

get_validation_flags()[source]
Returns:the validation flags
Return type:Gio.TlsCertificateFlags

Gets self’s validation flags

New in version 2.28.

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) – whether to use the lowest-supported protocol version

Since 2.42.1, if use_ssl3 is True, this forces self to use the lowest-supported TLS protocol version rather than trying to properly negotiate the highest mutually-supported protocol version with the peer. Be aware that SSL 3.0 is generally disabled by the Gio.TlsBackend, so the lowest-supported protocol version is probably not SSL 3.0.

Since 2.58, this may additionally cause an RFC 7507 fallback SCSV to be sent to the server, causing modern TLS servers to immediately terminate the connection. You should generally only use this function if you need to connect to broken servers that exhibit TLS protocol version intolerance, and when an initial attempt to connect to a server normally has already failed.

New in version 2.28.

Deprecated since version 2.56: SSL 3.0 is insecure, and this function does not generally enable or disable it, despite its name.

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.

New in version 2.28.

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

Copies session state from one connection to another. 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 conn should not have completed a handshake.

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

If True, forces the connection to use a fallback version of TLS or SSL, rather than trying to negotiate the best version of TLS to use. See Gio.TlsClientConnection.set_use_ssl3().

New in version 2.28.

Deprecated since version 2.56: SSL 3.0 is insecure, and this property does not generally enable or disable it, despite its name.

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:READABLE, WRITABLE, CONSTRUCT

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

New in version 2.28.