Gio.TlsConnection
Description: Reference for Gio.TlsConnection

### Class

# GioTlsConnection

since: 2.28

#### Description [src]

    abstract class Gio.TlsConnection : Gio.IOStream
    {
      priv: GTlsConnectionPrivate*
    }

`GTlsConnection` is the base TLS connection class type, which wraps a `GIOStream` and provides TLS encryption on top of it. Its subclasses, `GTlsClientConnection` and `GTlsServerConnection`, implement client-side and server-side TLS, respectively.

For DTLS (Datagram TLS) support, see `GDtlsConnection`.

Available since: 2.28

#### Hierarchy

#### Ancestors

- GIOStream
- GObject

#### Instance methods

###### g_tls_connection_emit_accept_certificate

Used by `GTlsConnection` implementations to emit the `GTlsConnection::accept-certificate` signal.

since: 2.28

###### g_tls_connection_get_certificate

Gets `conn`‘s certificate, as set by g_tls_connection_set_certificate().

since: 2.28

###### g_tls_connection_get_channel_binding_data

Query the TLS backend for TLS channel binding data of `type` for `conn`.

since: 2.66

###### g_tls_connection_get_ciphersuite_name

Returns the name of the current TLS ciphersuite, or `NULL` 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.

since: 2.70

###### g_tls_connection_get_database

Gets the certificate database that `conn` uses to verify peer certificates. See g_tls_connection_set_database().

since: 2.30

###### g_tls_connection_get_interaction

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 `NULL` is returned, then no user interaction will occur for this connection.

since: 2.30

###### g_tls_connection_get_negotiated_protocol

Gets the name of the application-layer protocol negotiated during the handshake.

since: 2.60

###### g_tls_connection_get_peer_certificate

Gets `conn`‘s peer’s certificate after the handshake has completed or failed. (It is not set during the emission of `GTlsConnection::accept-certificate`.).

since: 2.28

###### g_tls_connection_get_peer_certificate_errors

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 `GTlsConnection::accept-certificate`.).

since: 2.28

###### g_tls_connection_get_protocol_version

Returns the current TLS protocol version, which may be `G_TLS_PROTOCOL_VERSION_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 `GTlsProtocolVersion`.

since: 2.70

###### g_tls_connection_get_rehandshake_mode

Gets `conn` rehandshaking mode. See `g_tls_connection_set_rehandshake_mode()` for details.

deprecated: 2.60. since: 2.28

###### g_tls_connection_get_require_close_notify

Tests whether or not `conn` expects a proper TLS close notification when the connection is closed. See `g_tls_connection_set_require_close_notify()` for details.

since: 2.28

###### g_tls_connection_get_use_system_certdb

Gets whether `conn` uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb().

deprecated: 2.30

###### g_tls_connection_handshake

Attempts a TLS handshake on `conn`.

since: 2.28

###### g_tls_connection_handshake_async

Asynchronously performs a TLS handshake on `conn`. See `g_tls_connection_handshake()` for more information.

since: 2.28

###### g_tls_connection_handshake_finish

Finish an asynchronous TLS handshake operation. See `g_tls_connection_handshake()` for more information.

since: 2.28

###### g_tls_connection_set_advertised_protocols

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 `g_tls_connection_get_negotiated_protocol()` to find the negotiated protocol after the handshake. Specifying `NULL` for the the value of `protocols` will disable ALPN negotiation.

since: 2.60

###### g_tls_connection_set_certificate

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.

since: 2.28

###### g_tls_connection_set_database

Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to `NULL`, then peer certificate validation will always set the `G_TLS_CERTIFICATE_UNKNOWN_CA` error (meaning `GTlsConnection::accept-certificate` will always be emitted on client-side connections, unless that bit is not set in `GTlsClientConnection:validation-flags`).

since: 2.30

###### g_tls_connection_set_interaction

Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords.

since: 2.30

###### g_tls_connection_set_rehandshake_mode

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.

deprecated: 2.60. since: 2.28

###### g_tls_connection_set_require_close_notify

Sets whether or not `conn` expects a proper TLS close notification before the connection is closed. If this is `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 `G_TLS_ERROR_EOF` error if the connection is closed without proper notification (since this may indicate a network error, or man-in-the-middle attack).

since: 2.28

###### g_tls_connection_set_use_system_certdb

Sets whether `conn` uses the system certificate database to verify peer certificates. This is `TRUE` by default. If set to `FALSE`, then peer certificate validation will always set the `G_TLS_CERTIFICATE_UNKNOWN_CA` error (meaning `GTlsConnection::accept-certificate` will always be emitted on client-side connections, unless that bit is not set in `GTlsClientConnection:validation-flags`).

deprecated: 2.30

##### Methods inherited from GIOStream (10)

###### g_io_stream_clear_pending

Clears the pending flag on `stream`.

since: 2.22

###### g_io_stream_close

Closes the stream, releasing resources related to it. This will also close the individual input and output streams, if they are not already closed.

since: 2.22

###### g_io_stream_close_async

Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished `callback` will be called. You can then call `g_io_stream_close_finish()` to get the result of the operation.

since: 2.22

###### g_io_stream_close_finish

Closes a stream.

since: 2.22

###### g_io_stream_get_input_stream

Gets the input stream for this object. This is used for reading.

since: 2.22

###### g_io_stream_get_output_stream

Gets the output stream for this object. This is used for writing.

since: 2.22

###### g_io_stream_has_pending

Checks if a stream has pending actions.

since: 2.22

###### g_io_stream_is_closed

Checks if a stream is closed.

since: 2.22

###### g_io_stream_set_pending

Sets `stream` to have actions pending. If the pending flag is already set or `stream` is closed, it will return `FALSE` and set `error`.

since: 2.22

###### g_io_stream_splice_async

Asynchronously splice the output stream of `stream1` to the input stream of `stream2`, and splice the output stream of `stream2` to the input stream of `stream1`.

since: 2.28

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### Gio.TlsConnection:advertised-protocols

The list of application-layer protocols that the connection advertises that it is willing to speak. See g_tls_connection_set_advertised_protocols().

since: 2.60

###### Gio.TlsConnection:base-io-stream

The `GIOStream` 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 `GIOStream` has been constructed, application code may only run its own operations on this stream when no `GIOStream` operations are running.

since: 2.28

###### Gio.TlsConnection:certificate

The connection’s certificate; see g_tls_connection_set_certificate().

since: 2.28

###### Gio.TlsConnection:ciphersuite-name

The name of the TLS ciphersuite in use. See g_tls_connection_get_ciphersuite_name().

since: 2.70

###### Gio.TlsConnection:database

The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database().

since: 2.30

###### Gio.TlsConnection:interaction

A `GTlsInteraction` 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.

since: 2.30

###### Gio.TlsConnection:negotiated-protocol

The application-layer protocol negotiated during the TLS handshake. See g_tls_connection_get_negotiated_protocol().

since: 2.60

###### Gio.TlsConnection:peer-certificate

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 `GTlsConnection::accept-certificate`.

since: 2.28

###### Gio.TlsConnection:peer-certificate-errors

The errors noticed while verifying `GTlsConnection:peer-certificate`. Normally this should be 0, but it may not be if `GTlsClientConnection:validation-flags` is not `G_TLS_CERTIFICATE_VALIDATE_ALL`, or if `GTlsConnection::accept-certificate` overrode the default behavior.

since: 2.28

###### Gio.TlsConnection:protocol-version

The TLS protocol version in use. See g_tls_connection_get_protocol_version().

since: 2.70

###### Gio.TlsConnection:rehandshake-mode

The rehandshaking mode. See g_tls_connection_set_rehandshake_mode().

deprecated: 2.60 since: 2.28

###### Gio.TlsConnection:require-close-notify

Whether or not proper TLS close notification is required. See g_tls_connection_set_require_close_notify().

since: 2.28

###### Gio.TlsConnection:use-system-certdb

Whether or not the system certificate database will be used to verify peer certificates. See g_tls_connection_set_use_system_certdb().

deprecated: 2.30

##### Properties inherited from GIOStream (3)

###### Gio.IOStream:closed

Whether the stream is closed.

since: 2.22

###### Gio.IOStream:input-stream

The `GInputStream` to read from.

since: 2.22

###### Gio.IOStream:output-stream

The `GOutputStream` to write to.

since: 2.22

#### Signals

###### Gio.TlsConnection::accept-certificate

Emitted during the TLS handshake after the peer certificate has been received. You can examine `peer_cert`‘s certification path by calling `g_tls_certificate_get_issuer()` on it.

since: 2.28

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct GioTlsConnectionClass {
      GIOStreamClass parent_class;
      gboolean (* accept_certificate) (
        GTlsConnection* connection,
        GTlsCertificate* peer_cert,
        GTlsCertificateFlags errors
      );
      gboolean (* handshake) (
        GTlsConnection* conn,
        GCancellable* cancellable,
        GError** error
      );
      void (* handshake_async) (
        GTlsConnection* conn,
        int io_priority,
        GCancellable* cancellable,
        GAsyncReadyCallback callback,
        gpointer user_data
      );
      gboolean (* handshake_finish) (
        GTlsConnection* conn,
        GAsyncResult* result,
        GError** error
      );
      gboolean (* get_binding_data) (
        GTlsConnection* conn,
        GTlsChannelBindingType type,
        GByteArray* data,
        GError** error
      );
      const gchar* (* get_negotiated_protocol) (
        GTlsConnection* conn
      );

    }

The class structure for the `GTlsConnection` type.

###### Class members

`parent_class: GIOStreamClass`

  The parent class.

`accept_certificate: gboolean (* accept_certificate) ( GTlsConnection* connection, GTlsCertificate* peer_cert, GTlsCertificateFlags errors )`

  Check whether to accept a certificate.

`handshake: gboolean (* handshake) ( GTlsConnection* conn, GCancellable* cancellable, GError** error )`

  Perform a handshake operation.

`handshake_async: void (* handshake_async) ( GTlsConnection* conn, int io_priority, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data )`

  Start an asynchronous handshake operation.

`handshake_finish: gboolean (* handshake_finish) ( GTlsConnection* conn, GAsyncResult* result, GError** error )`

  Finish an asynchronous handshake operation.

`get_binding_data: gboolean (* get_binding_data) ( GTlsConnection* conn, GTlsChannelBindingType type, GByteArray* data, GError** error )`

  Retrieve TLS channel binding data (Since: 2.66).

`get_negotiated_protocol: const gchar* (* get_negotiated_protocol) ( GTlsConnection* conn )`

  Get ALPN-negotiated protocol (Since: 2.70).

#### Virtual methods

###### Gio.TlsConnectionClass.accept_certificate

Check whether to accept a certificate.

###### Gio.TlsConnectionClass.get_binding_data

Retrieve TLS channel binding data (Since: 2.66).

###### Gio.TlsConnectionClass.get_negotiated_protocol

Gets the name of the application-layer protocol negotiated during the handshake.

since: 2.60

###### Gio.TlsConnectionClass.handshake

Attempts a TLS handshake on `conn`.

since: 2.28

###### Gio.TlsConnectionClass.handshake_async

Asynchronously performs a TLS handshake on `conn`. See `g_tls_connection_handshake()` for more information.

since: 2.28

###### Gio.TlsConnectionClass.handshake_finish

Finish an asynchronous TLS handshake operation. See `g_tls_connection_handshake()` for more information.

since: 2.28