Module: Gio::TlsClientConnection

Defined in:
(unknown)

Overview

GTls::ClientConnection is the client-side subclass of GTls::Connection, representing a client-side TLS connection.

Instance Method Summary collapse

Instance Method Details

#accepted_cas ⇒ GLib::List

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

Each item in the list is a GByte::Array which contains the complete subject DN of the certificate authority. CA DNs. You should unref each element with g_byte_array_unref() and then the free the list with g_list_free().

Returns:

  • (GLib::List) —

    the list of

#copy_session_state(source) ⇒ nil

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 GTls::ClientConnection 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.

Parameters:

Returns:

  • (nil)

#server_identity ⇒ Gio::SocketConnectable

Gets conn’s expected server identity expected server identity, or nil if the expected identity is not known.

Returns:

#server_identity=(identity) ⇒ nil

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 %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled.

Parameters:

Returns:

  • (nil)

#use_ssl3 ⇒ TrueClass

SSL 3.0 is no longer supported. See g_tls_client_connection_set_use_ssl3() for details.

Returns:

  • (TrueClass) —

    false

#use_ssl3=(use_ssl3) ⇒ nil

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.

Parameters:

  • use_ssl3 (TrueClass) —

    a #gboolean, ignored

Returns:

  • (nil)

#validation_flags ⇒ Gio::TlsCertificateFlags

Gets conn’s validation flags

Returns:

#validation_flags=(flags) ⇒ nil

Sets conn’s validation flags, to override the default set of checks performed when validating a server certificate. By default, %G_TLS_CERTIFICATE_VALIDATE_ALL is used.

Parameters:

Returns:

  • (nil)