@gtkx/ffi 0.1.45 → 0.1.47

package/dist/generated/gio/dtls-client-connection.js

@@ -1,6 +1,10 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { SocketConnectable } from "./socket-connectable.js";
+/**
+ * `GDtlsClientConnection` is the client-side subclass of
+ * [iface@Gio.DtlsConnection], representing a client-side DTLS connection.
+ */
 export class DtlsClientConnection {
     ptr;
     constructor(ptr) {
@@ -9,6 +13,15 @@ export class DtlsClientConnection {
     static fromPtr(ptr) {
         return new DtlsClientConnection(ptr);
     }
+    /**
+     * 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.
+     */
     getAcceptedCas() {
         return call("libgio-2.0.so.0", "g_dtls_client_connection_get_accepted_cas", [
             {
@@ -26,6 +39,9 @@ export class DtlsClientConnection {
             borrowed: true,
         });
     }
+    /**
+     * Gets @conn's expected server identity
+     */
     getServerIdentity() {
         const ptr = call("libgio-2.0.so.0", "g_dtls_client_connection_get_server_identity", [
             {
@@ -35,6 +51,13 @@ export class DtlsClientConnection {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, SocketConnectable);
     }
+    /**
+     * Gets @conn's validation flags
+     *
+     * This function does not work as originally designed and is impossible
+     * to use correctly. See #GDtlsClientConnection:validation-flags for more
+     * information.
+     */
     getValidationFlags() {
         return call("libgio-2.0.so.0", "g_dtls_client_connection_get_validation_flags", [
             {
@@ -43,6 +66,13 @@ export class DtlsClientConnection {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * 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.
+     * @param identity - a #GSocketConnectable describing the expected server identity
+     */
     setServerIdentity(identity) {
         call("libgio-2.0.so.0", "g_dtls_client_connection_set_server_identity", [
             {
@@ -55,6 +85,16 @@ export class DtlsClientConnection {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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 #GDtlsClientConnection:validation-flags for more
+     * information.
+     * @param flags - the #GTlsCertificateFlags to use
+     */
     setValidationFlags(flags) {
         call("libgio-2.0.so.0", "g_dtls_client_connection_set_validation_flags", [
             {

package/dist/generated/gio/dtls-connection.d.ts

@@ -6,35 +6,340 @@ import { TlsCertificate } from "./tls-certificate.js";
 import { TlsDatabase } from "./tls-database.js";
 import { TlsInteraction } from "./tls-interaction.js";
 import * as GLib from "../glib/index.js";
+/**
+ * `GDtlsConnection` is the base DTLS connection class type, which wraps
+ * a [iface@Gio.DatagramBased] and provides DTLS encryption on top of it. Its
+ * subclasses, [iface@Gio.DtlsClientConnection] and
+ * [iface@Gio.DtlsServerConnection], implement client-side and server-side DTLS,
+ * respectively.
+ *
+ * For TLS support, see [class@Gio.TlsConnection].
+ *
+ * As DTLS is datagram based, `GDtlsConnection` implements
+ * [iface@Gio.DatagramBased], presenting a datagram-socket-like API for the
+ * encrypted connection. This operates over a base datagram connection, which is
+ * also a `GDatagramBased` ([property@Gio.DtlsConnection:base-socket]).
+ *
+ * To close a DTLS connection, use [method@Gio.DtlsConnection.close].
+ *
+ * Neither [iface@Gio.DtlsServerConnection] or [iface@Gio.DtlsClientConnection]
+ * set the peer address on their base [iface@Gio.DatagramBased] if it is a
+ * [class@Gio.Socket] — it is up to the caller to do that if they wish. If they
+ * do not, and [method@Gio.Socket.close] is called on the base socket, the
+ * `GDtlsConnection` will not raise a `G_IO_ERROR_NOT_CONNECTED` error on
+ * further I/O.
+ */
 export declare class DtlsConnection {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): DtlsConnection;
+    /**
+     * Close the DTLS connection. This is equivalent to calling
+     * g_dtls_connection_shutdown() to shut down both sides of the connection.
+     *
+     * Closing a #GDtlsConnection waits for all buffered but untransmitted data to
+     * be sent before it completes. It then sends a `close_notify` DTLS alert to the
+     * peer and may wait for a `close_notify` to be received from the peer. It does
+     * not close the underlying #GDtlsConnection:base-socket; that must be closed
+     * separately.
+     *
+     * Once `conn` is closed, all other operations will return %G_IO_ERROR_CLOSED.
+     * Closing a #GDtlsConnection multiple times will not return an error.
+     *
+     * #GDtlsConnections will be automatically closed when the last reference is
+     * dropped, but you might want to call this function to make sure resources are
+     * released as early as possible.
+     *
+     * If `cancellable` is cancelled, the #GDtlsConnection may be left
+     * partially-closed and any pending untransmitted data may be lost. Call
+     * g_dtls_connection_close() again to complete closing the #GDtlsConnection.
+     * @param cancellable - a #GCancellable, or %NULL
+     */
     close(cancellable?: Cancellable | null): boolean;
+    /**
+     * Asynchronously close the DTLS connection. See g_dtls_connection_close() for
+     * more information.
+     * @param ioPriority - the I/O priority of the request
+     * @param cancellable - a #GCancellable, or %NULL
+     * @param callback - callback to call when the close operation is complete
+     * @param userData - the data to pass to the callback function
+     */
     closeAsync(ioPriority: number, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finish an asynchronous TLS close operation. See g_dtls_connection_close()
+     * for more information.
+     * @param result - a #GAsyncResult
+     */
     closeFinish(result: AsyncResult): boolean;
+    /**
+     * Used by #GDtlsConnection implementations to emit the
+     * #GDtlsConnection::accept-certificate signal.
+     * @param peerCert - the peer's #GTlsCertificate
+     * @param errors - the problems with @peer_cert
+     */
     emitAcceptCertificate(peerCert: TlsCertificate, errors: TlsCertificateFlags): boolean;
+    /**
+     * Gets @conn's certificate, as set by
+     * g_dtls_connection_set_certificate().
+     */
     getCertificate(): TlsCertificate | null;
+    /**
+     * Query the TLS backend for TLS channel binding data of `type` for @conn.
+     *
+     * This call retrieves TLS channel binding data as specified in RFC
+     * [5056](https://tools.ietf.org/html/rfc5056), RFC
+     * [5929](https://tools.ietf.org/html/rfc5929), and related RFCs.  The
+     * binding data is returned in @data.  The `data` is resized by the callee
+     * using #GByteArray buffer management and will be freed when the `data` is destroyed by g_byte_array_unref(). If `data` is %NULL, it will only
+     * check whether TLS backend is able to fetch the data (e.g. whether `type` is supported by the TLS backend). It does not guarantee that the data
+     * will be available though.  That could happen if TLS connection does not
+     * support `type` or the binding data is not available yet due to additional
+     * negotiation or input required.
+     * @param type - #GTlsChannelBindingType type of data to fetch
+     * @param data - #GByteArray is
+     */
     getChannelBindingData(type: TlsChannelBindingType, data?: Ref<GLib.ByteArray> | null): boolean;
+    /**
+     * Returns the name of the current DTLS 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.
+     */
     getCiphersuiteName(): string | null;
+    /**
+     * Gets the certificate database that `conn` uses to verify
+     * peer certificates. See g_dtls_connection_set_database().
+     */
     getDatabase(): TlsDatabase | null;
+    /**
+     * 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.
+     */
     getInteraction(): TlsInteraction | null;
+    /**
+     * 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_dtls_connection_set_advertised_protocols().
+     */
     getNegotiatedProtocol(): string | null;
+    /**
+     * Gets @conn's peer's certificate after the handshake has completed
+     * or failed. (It is not set during the emission of
+     * #GDtlsConnection::accept-certificate.)
+     */
     getPeerCertificate(): TlsCertificate | null;
+    /**
+     * 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 #GDtlsConnection::accept-certificate.)
+     */
     getPeerCertificateErrors(): TlsCertificateFlags;
+    /**
+     * Returns the current DTLS 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.
+     */
     getProtocolVersion(): TlsProtocolVersion;
+    /**
+     * Gets `conn` rehandshaking mode. See
+     * g_dtls_connection_set_rehandshake_mode() for details.
+     */
     getRehandshakeMode(): TlsRehandshakeMode;
+    /**
+     * Tests whether or not `conn` expects a proper TLS close notification
+     * when the connection is closed. See
+     * g_dtls_connection_set_require_close_notify() for details.
+     */
     getRequireCloseNotify(): boolean;
+    /**
+     * 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, #GDtlsConnection will handle this for you automatically
+     * when you try to send or receive data on the connection. You can call
+     * g_dtls_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_dtls_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.
+     *
+     * #GDtlsConnection::accept_certificate may be emitted during the
+     * handshake.
+     * @param cancellable - a #GCancellable, or %NULL
+     */
     handshake(cancellable?: Cancellable | null): boolean;
+    /**
+     * Asynchronously performs a TLS handshake on @conn. See
+     * g_dtls_connection_handshake() for more information.
+     * @param ioPriority - the I/O priority of the request
+     * @param cancellable - a #GCancellable, or %NULL
+     * @param callback - callback to call when the handshake is complete
+     * @param userData - the data to pass to the callback function
+     */
     handshakeAsync(ioPriority: number, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finish an asynchronous TLS handshake operation. See
+     * g_dtls_connection_handshake() for more information.
+     * @param result - a #GAsyncResult.
+     */
     handshakeFinish(result: AsyncResult): boolean;
+    /**
+     * 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_dtls_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.
+     * @param protocols - a %NULL-terminated
+     */
     setAdvertisedProtocols(protocols?: string[] | null): void;
+    /**
+     * This sets the certificate that `conn` will present to its peer
+     * during the TLS handshake. For a #GDtlsServerConnection, it is
+     * mandatory to set this, and that will normally be done at construct
+     * time.
+     *
+     * For a #GDtlsClientConnection, 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_dtls_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_dtls_client_connection_get_accepted_cas() will return
+     * non-%NULL.)
+     * @param certificate - the certificate to use for @conn
+     */
     setCertificate(certificate: TlsCertificate): void;
+    /**
+     * 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
+     * #GDtlsConnection::accept-certificate will always be emitted on
+     * client-side connections, unless that bit is not set in
+     * #GDtlsClientConnection:validation-flags).
+     *
+     * There are nonintuitive security implications when using a non-default
+     * database. See #GDtlsConnection:database for details.
+     * @param database - a #GTlsDatabase
+     */
     setDatabase(database?: TlsDatabase | null): void;
+    /**
+     * 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.
+     * @param interaction - an interaction object, or %NULL
+     */
     setInteraction(interaction?: TlsInteraction | null): void;
+    /**
+     * 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.
+     * @param mode - the rehandshaking mode
+     */
     setRehandshakeMode(mode: TlsRehandshakeMode): void;
+    /**
+     * 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 may be omitted. You
+     * can use g_dtls_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
+     * #GDatagramBased, 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_dtls_connection_close_async() on
+     * `conn` itself, 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 #GDtlsConnection:base-socket rather
+     * than closing `conn` itself.
+     * @param requireCloseNotify - whether or not to require close notification
+     */
     setRequireCloseNotify(requireCloseNotify: boolean): void;
+    /**
+     * Shut down part or all of a DTLS connection.
+     *
+     * If `shutdown_read` is %TRUE then the receiving side of the connection is shut
+     * down, and further reading is disallowed. Subsequent calls to
+     * g_datagram_based_receive_messages() will return %G_IO_ERROR_CLOSED.
+     *
+     * If `shutdown_write` is %TRUE then the sending side of the connection is shut
+     * down, and further writing is disallowed. Subsequent calls to
+     * g_datagram_based_send_messages() will return %G_IO_ERROR_CLOSED.
+     *
+     * It is allowed for both `shutdown_read` and `shutdown_write` to be TRUE — this
+     * is equivalent to calling g_dtls_connection_close().
+     *
+     * If `cancellable` is cancelled, the #GDtlsConnection may be left
+     * partially-closed and any pending untransmitted data may be lost. Call
+     * g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection.
+     * @param shutdownRead - %TRUE to stop reception of incoming datagrams
+     * @param shutdownWrite - %TRUE to stop sending outgoing datagrams
+     * @param cancellable - a #GCancellable, or %NULL
+     */
     shutdown(shutdownRead: boolean, shutdownWrite: boolean, cancellable?: Cancellable | null): boolean;
+    /**
+     * Asynchronously shut down part or all of the DTLS connection. See
+     * g_dtls_connection_shutdown() for more information.
+     * @param shutdownRead - %TRUE to stop reception of incoming datagrams
+     * @param shutdownWrite - %TRUE to stop sending outgoing datagrams
+     * @param ioPriority - the I/O priority of the request
+     * @param cancellable - a #GCancellable, or %NULL
+     * @param callback - callback to call when the shutdown operation is complete
+     * @param userData - the data to pass to the callback function
+     */
     shutdownAsync(shutdownRead: boolean, shutdownWrite: boolean, ioPriority: number, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finish an asynchronous TLS shutdown operation. See
+     * g_dtls_connection_shutdown() for more information.
+     * @param result - a #GAsyncResult
+     */
     shutdownFinish(result: AsyncResult): boolean;
 }