package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.gio/Ocgtk_gio/Gio/Wrappers/Tls_connection/index.html

Module Wrappers.Tls_connection

type t = [ `tls_connection | `io_stream | `object_ ] Gobject.obj
val set_use_system_certdb : t -> bool -> unit

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

val set_require_close_notify : t -> bool -> unit

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

In some protocols, the application will know whether or not the connection was closed cleanly based on application-level data (because the application-level data includes a length field, or is somehow self-delimiting); in this case, the close notify is redundant and sometimes omitted. (TLS 1.1 explicitly allows this; in TLS 1.0 it is technically an error, but often done anyway.) You can use g_tls_connection_set_require_close_notify() to tell @conn to allow an "unannounced" connection close, in which case the close will show up as a 0-length read, as in a non-TLS #GSocketConnection, and it is up to the application to check that the data has been fully received.

Note that this only affects the behavior when the peer closes the connection; when the application calls g_io_stream_close() itself on @conn, this will send a close notification regardless of the setting of this property. If you explicitly want to do an unclean close, you can close @conn's #GTlsConnection:base-io-stream rather than closing @conn itself, but note that this may only be done when no other operations are pending on @conn or the base I/O stream.

val set_rehandshake_mode : t -> Gio_enums.tlsrehandshakemode -> unit

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.

val set_interaction : t -> [ `tls_interaction | `object_ ] Gobject.obj option -> unit

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

The @interaction argument will normally be a derived subclass of #GTlsInteraction. %NULL can also be provided if no user interaction should occur for this connection.

val set_database : t -> [ `tls_database | `object_ ] Gobject.obj option -> unit

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

There are nonintuitive security implications when using a non-default database. See #GTlsConnection:database for details.

val set_certificate : t -> [ `tls_certificate | `object_ ] Gobject.obj -> unit

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.

For a #GTlsClientConnection, this is optional. If a handshake fails with %G_TLS_ERROR_CERTIFICATE_REQUIRED, that means that the server requires a certificate, and if you try connecting again, you should call this method first. You can call g_tls_client_connection_get_accepted_cas() on the failed connection to get a list of Certificate Authorities that the server will accept certificates from.

(It is also possible that a server will allow the connection with or without a certificate; in that case, if you don't provide a certificate, you can tell that the server requested one by the fact that g_tls_client_connection_get_accepted_cas() will return non-%NULL.)

val set_advertised_protocols : t -> string array option -> unit

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.

See IANA TLS ALPN Protocol IDs(https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs.

val handshake_finish : t -> [ `async_result ] Gobject.obj -> (bool, GError.t) result

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

val handshake : t -> [ `cancellable | `object_ ] Gobject.obj option -> (bool, GError.t) result

Attempts a TLS handshake on @conn.

On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after connecting (or after sending a "STARTTLS"-type command), #GTlsConnection will handle this for you automatically when you try to send or receive data on the connection. You can call g_tls_connection_handshake() manually if you want to know whether the initial handshake succeeded or failed (as opposed to just immediately trying to use @conn to read or write, in which case, if it fails, it may not be possible to tell if it failed before or after completing the handshake), but beware that servers may reject client authentication after the handshake has completed, so a successful handshake does not indicate the connection will be usable.

Likewise, on the server side, although a handshake is necessary at the beginning of the communication, you do not need to call this function explicitly unless you want clearer error reporting.

Previously, calling g_tls_connection_handshake() after the initial handshake would trigger a rehandshake; however, this usage was deprecated in GLib 2.60 because rehandshaking was removed from the TLS protocol in TLS 1.3. Since GLib 2.64, calling this function after the initial handshake will no longer do anything.

When using a #GTlsConnection created by #GSocketClient, the #GSocketClient performs the initial handshake, so calling this function manually is not recommended.

#GTlsConnection::accept_certificate may be emitted during the handshake.

val get_use_system_certdb : t -> bool

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

val get_require_close_notify : t -> bool

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.

val get_rehandshake_mode : t -> Gio_enums.tlsrehandshakemode

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

val get_protocol_version : t -> Gio_enums.tlsprotocolversion

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.

val get_peer_certificate_errors : t -> Gio_enums.tlscertificateflags

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

See #GTlsConnection:peer-certificate-errors for more information.

val get_peer_certificate : t -> [ `tls_certificate | `object_ ] Gobject.obj option

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

val get_negotiated_protocol : t -> string option

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

If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_tls_connection_set_advertised_protocols().

val get_interaction : t -> [ `tls_interaction | `object_ ] Gobject.obj option

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.

val get_database : t -> [ `tls_database | `object_ ] Gobject.obj option

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

val get_ciphersuite_name : t -> string option

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.

val get_certificate : t -> [ `tls_certificate | `object_ ] Gobject.obj option

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

val emit_accept_certificate : t -> [ `tls_certificate | `object_ ] Gobject.obj -> Gio_enums.tlscertificateflags -> bool

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

val get_base_io_stream : t -> [ `io_stream | `object_ ] Gobject.obj

Get property: base-io-stream

val on_accept_certificate : ?after:bool -> t -> callback: (peer_cert:[ `tls_certificate | `object_ ] Gobject.obj -> errors:Gio_enums.tlscertificateflags -> bool) -> Gobject.Signal.handler_id