class: TlsClientConnection

[14:7] extends: object

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

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• TlsClientConnection (Handle = null)

  Creates a new TlsClientConnection by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setServeridentity (object Value)

  A #GSocketConnectable describing the identity of the server that is expected on the other end of the connection. If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in #GTlsClientConnection:validation-flags, this object will be used to determine the expected identify of the remote end of the connection; if #GTlsClientConnection:server-identity is not set, or does not match the identity presented by the server, then the %G_TLS_CERTIFICATE_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.

  • @p Value is the new property value.
  • @r None.

• setUsessl3 (bool Value)

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

  • @p Value is the new property value.
  • @r None.

• setValidationflags (string Value)

  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 #GTlsConnection::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 %G_TLS_CERTIFICATE_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 #GTlsConnection::accept-certificate.

  • @p Value is the new property value.
  • @r None.

• copy_session_state (object source)

  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 #GTlsClientConnection 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.
  • @p source is a #GTlsClientConnection.
  • @r None.

• get_accepted_cas ()

  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 %NULL. Each item in the list is a #GByteArray which contains the complete subject DN of the certificate authority.

• get_server_identity ()

  Gets @conn's expected server identity

• get_use_ssl3 ()

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

• get_validation_flags ()

  Gets @conn's validation flags This function does not work as originally designed and is impossible to use correctly. See #GTlsClientConnection:validation-flags for more information.

• set_server_identity (object identity)

  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.

  • @p identity is a #GSocketConnectable describing the expected server identity.
  • @r None.

• set_use_ssl3 (bool use_ssl3)

  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.

  • @p use_ssl3 is a #gboolean, ignored.
  • @r None.

• set_validation_flags (string flags)

  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. This function does not work as originally designed and is impossible to use correctly. See #GTlsClientConnection:validation-flags for more information.

  • @p flags is the #GTlsCertificateFlags to use.
  • @r None.

• accepted_cas ()

  Returns get_accepted_cas as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_accepted_cas() when lazy or change-notify access is required.

  • @r An Aussom list of elements.

class: TlsClientConnectionMeta

[323:14] static extends: object

Generated metadata helpers for TlsClientConnection interface surfaces.

Methods

• properties ()

  Returns property metadata for TlsClientConnection.

  • @r A list.