Package ch.bailu.gtk.gio

Class DtlsConnection

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.type.Interface
ch.bailu.gtk.gio.DtlsConnection
All Implemented Interfaces:
PointerInterface
public class DtlsConnection extends Interface
#GDtlsConnection is the base DTLS connection class type, which wraps
a #GDatagramBased and provides DTLS encryption on top of it. Its
subclasses, #GDtlsClientConnection and #GDtlsServerConnection,
implement client-side and server-side DTLS, respectively.

For TLS support, see #GTlsConnection.

As DTLS is datagram based, #GDtlsConnection implements #GDatagramBased,
presenting a datagram-socket-like API for the encrypted connection. This
operates over a base datagram connection, which is also a #GDatagramBased
(#GDtlsConnection:base-socket).

To close a DTLS connection, use g_dtls_connection_close().

Neither #GDtlsServerConnection or #GDtlsClientConnection set the peer address
on their base #GDatagramBased if it is a #GSocket — it is up to the caller to
do that if they wish. If they do not, and g_socket_close() is called on the
base socket, the #GDtlsConnection will not raise a %G_IO_ERROR_NOT_CONNECTED
error on further I/O.

https://docs.gtk.org/gio/iface.DtlsConnection.html

  • Field Details

  • Constructor Details

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • close

      public boolean close(@Nullable Cancellable cancellable) throws AllocationError
      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.
      Parameters:
      cancellable - a #GCancellable, or %NULL
      Returns:
      %TRUE on success, %FALSE otherwise
      Throws:
      AllocationError

    • closeAsync

      public void closeAsync(int io_priority, @Nullable Cancellable cancellable, DtlsConnection.OnAsyncReadyCallback callback, @Nullable Pointer user_data)
      Asynchronously close the DTLS connection. See g_dtls_connection_close() for
      more information.
      Parameters:
      io_priority - the [I/O priority][io-priority] of the request
      cancellable - a #GCancellable, or %NULL
      callback - callback to call when the close operation is complete
      user_data - the data to pass to the callback function

    • closeFinish

      public boolean closeFinish(@Nonnull AsyncResult result) throws AllocationError
      Finish an asynchronous TLS close operation. See g_dtls_connection_close()
      for more information.
      Parameters:
      result - a #GAsyncResult
      Returns:
      %TRUE on success, %FALSE on failure, in which case @error will be set
      Throws:
      AllocationError

    • emitAcceptCertificate

      public boolean emitAcceptCertificate(@Nonnull TlsCertificate peer_cert, int errors)
      Used by #GDtlsConnection implementations to emit the
      #GDtlsConnection::accept-certificate signal.
      Parameters:
      peer_cert - the peer's #GTlsCertificate
      errors - the problems with @peer_cert
      Returns:
      %TRUE if one of the signal handlers has returned %TRUE to accept @peer_cert

    • getCertificate

      public TlsCertificate getCertificate()
      Gets @conn's certificate, as set by
      g_dtls_connection_set_certificate().
      Returns:
      @conn's certificate, or %NULL

    • getChannelBindingData

      public boolean getChannelBindingData(int type, @Nullable ByteArray data) throws AllocationError
      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.
      Parameters:
      type - #GTlsChannelBindingType type of data to fetch
      data - #GByteArray is filled with the binding data, or %NULL
      Returns:
      %TRUE on success, %FALSE otherwise
      Throws:
      AllocationError

    • getCiphersuiteName

      public Str getCiphersuiteName()
      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.
      Returns:
      The name of the current DTLS ciphersuite, or %NULL

    • getDatabase

      public TlsDatabase getDatabase()
      Gets the certificate database that @conn uses to verify
      peer certificates. See g_dtls_connection_set_database().
      Returns:
      the certificate database that @conn uses or %NULL

    • getInteraction

      public TlsInteraction getInteraction()
      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.
      Returns:
      The interaction object.

    • getNegotiatedProtocol

      public Str getNegotiatedProtocol()
      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().
      Returns:
      the negotiated protocol, or %NULL

    • getPeerCertificate

      public TlsCertificate getPeerCertificate()
      Gets @conn's peer's certificate after the handshake has completed
      or failed. (It is not set during the emission of
      #GDtlsConnection::accept-certificate.)
      Returns:
      @conn's peer's certificate, or %NULL

    • getPeerCertificateErrors

      public int getPeerCertificateErrors()
      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.)
      Returns:
      @conn's peer's certificate errors

    • getProtocolVersion

      public int getProtocolVersion()
      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.
      Returns:
      The current DTLS protocol version

    • getRequireCloseNotify

      public boolean getRequireCloseNotify()
      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.
      Returns:
      %TRUE if @conn requires a proper TLS close notification.

    • handshake

      public boolean handshake(@Nullable Cancellable cancellable) throws AllocationError
      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.
      Parameters:
      cancellable - a #GCancellable, or %NULL
      Returns:
      success or failure
      Throws:
      AllocationError

    • handshakeAsync

      public void handshakeAsync(int io_priority, @Nullable Cancellable cancellable, DtlsConnection.OnAsyncReadyCallback callback, @Nullable Pointer user_data)
      Asynchronously performs a TLS handshake on @conn. See
      g_dtls_connection_handshake() for more information.
      Parameters:
      io_priority - the [I/O priority][io-priority] of the request
      cancellable - a #GCancellable, or %NULL
      callback - callback to call when the handshake is complete
      user_data - the data to pass to the callback function

    • handshakeFinish

      public boolean handshakeFinish(@Nonnull AsyncResult result) throws AllocationError
      Finish an asynchronous TLS handshake operation. See
      g_dtls_connection_handshake() for more information.
      Parameters:
      result - a #GAsyncResult.
      Returns:
      %TRUE on success, %FALSE on failure, in which case @error will be set.
      Throws:
      AllocationError

    • setCertificate

      public void setCertificate(@Nonnull TlsCertificate certificate)
      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.)
      Parameters:
      certificate - the certificate to use for @conn

    • setDatabase

      public void setDatabase(@Nullable TlsDatabase 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
      #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.
      Parameters:
      database - a #GTlsDatabase

    • setInteraction

      public void setInteraction(@Nullable TlsInteraction 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.

      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.
      Parameters:
      interaction - an interaction object, or %NULL

    • setRequireCloseNotify

      public void setRequireCloseNotify(boolean 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).

      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.
      Parameters:
      require_close_notify - whether or not to require close notification

    • shutdown

      public boolean shutdown(boolean shutdown_read, boolean shutdown_write, @Nullable Cancellable cancellable) throws AllocationError
      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.
      Parameters:
      shutdown_read - %TRUE to stop reception of incoming datagrams
      shutdown_write - %TRUE to stop sending outgoing datagrams
      cancellable - a #GCancellable, or %NULL
      Returns:
      %TRUE on success, %FALSE otherwise
      Throws:
      AllocationError

    • shutdownAsync

      public void shutdownAsync(boolean shutdown_read, boolean shutdown_write, int io_priority, @Nullable Cancellable cancellable, DtlsConnection.OnAsyncReadyCallback callback, @Nullable Pointer user_data)
      Asynchronously shut down part or all of the DTLS connection. See
      g_dtls_connection_shutdown() for more information.
      Parameters:
      shutdown_read - %TRUE to stop reception of incoming datagrams
      shutdown_write - %TRUE to stop sending outgoing datagrams
      io_priority - the [I/O priority][io-priority] of the request
      cancellable - a #GCancellable, or %NULL
      callback - callback to call when the shutdown operation is complete
      user_data - the data to pass to the callback function

    • shutdownFinish

      public boolean shutdownFinish(@Nonnull AsyncResult result) throws AllocationError
      Finish an asynchronous TLS shutdown operation. See
      g_dtls_connection_shutdown() for more information.
      Parameters:
      result - a #GAsyncResult
      Returns:
      %TRUE on success, %FALSE on failure, in which case @error will be set
      Throws:
      AllocationError

    • onAcceptCertificate

      public SignalHandler onAcceptCertificate(DtlsConnection.OnAcceptCertificate signal)
      Connect to signal "accept-certificate".
      See DtlsConnection.OnAcceptCertificate.onAcceptCertificate(ch.bailu.gtk.gio.TlsCertificate, int) for signal description.
      Field SIGNAL_ON_ACCEPT_CERTIFICATE contains original signal name and can be used as resource reference.
      Parameters:
      signal - callback function (lambda).
      Returns:
      SignalHandler. Can be used to disconnect signal and to release callback function.

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()