TlsConnection

open class TlsConnection(pointer: <Error class: unknown class><<Error class: unknown class>>) : IoStream

GTlsConnection is the base TLS connection class type, which wraps a class@Gio.IOStream and provides TLS encryption on top of it. Its subclasses, iface@Gio.TlsClientConnection and iface@Gio.TlsServerConnection, implement client-side and server-side TLS, respectively.

For DTLS (Datagram TLS) support, see iface@Gio.DtlsConnection.

Skipped during bindings generation

  • parameter data: data: Out parameter is not supported

  • method advertised-protocols: Property has no getter

  • method base-io-stream: Property has no getter nor setter

  • method certificate: Property TypeInfo of getter and setter do not match

Since

2.28

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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().

Link copied to clipboard
val gioIOStreamPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gioTlsConnectionPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard

The class@Gio.InputStream to read from.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The class@Gio.OutputStream to write to.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The rehandshaking mode. See g_tls_connection_set_rehandshake_mode().

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
open fun clearPending()

Clears the pending flag on @stream.

Link copied to clipboard
open fun close(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

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

Link copied to clipboard
open fun closeAsync(ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

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.

Link copied to clipboard
open fun closeFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Closes a stream.

Link copied to clipboard
fun connectAcceptCertificate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (peerCert: TlsCertificate, errors: TlsCertificateFlags) -> Boolean): <Error class: unknown class>

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.

Link copied to clipboard

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

Link copied to clipboard

Gets @conn's certificate, as set by g_tls_connection_set_certificate().

Link copied to clipboard
open fun handshake(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Attempts a TLS handshake on @conn.

Link copied to clipboard
open fun handshakeAsync(ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

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

Link copied to clipboard
open fun handshakeFinish(result: AsyncResult): <Error class: unknown class><Boolean>

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

Link copied to clipboard
open fun hasPending(): Boolean

Checks if a stream has pending actions.

Link copied to clipboard
open fun isClosed(): Boolean

Checks if a stream is closed.

Link copied to clipboard
open fun setAdvertisedProtocols(protocols: List<String>? = null)

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.

Link copied to clipboard
open fun setCertificate(certificate: TlsCertificate)

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.

Link copied to clipboard
open fun setPending(): <Error class: unknown class><Boolean>

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

Link copied to clipboard
open fun spliceAsync(stream2: IoStream, flags: IoStreamSpliceFlags, ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Asynchronously splice the output stream of @stream1 to the input stream of