Interface DtlsConnection

All Superinterfaces:
DatagramBased, Proxy
All Known Subinterfaces:
DtlsClientConnection, DtlsServerConnection
All Known Implementing Classes:
DtlsClientConnection.DtlsClientConnection$Impl, DtlsConnection.DtlsConnection$Impl, DtlsServerConnection.DtlsServerConnection$Impl
@Generated("org.javagi.JavaGI") public interface DtlsConnection extends Proxy, DatagramBased

GDtlsConnection is the base DTLS connection class type, which wraps a DatagramBased and provides DTLS encryption on top of it. Its subclasses, DtlsClientConnection and DtlsServerConnection, implement client-side and server-side DTLS, respectively.

For TLS support, see TlsConnection.

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

To close a DTLS connection, use close(Cancellable).

Neither DtlsServerConnection or DtlsClientConnection set the peer address on their base DatagramBased if it is a Socket — it is up to the caller to do that if they wish. If they do not, and Socket.close() is called on the base socket, the GDtlsConnection will not raise a G_IO_ERROR_NOT_CONNECTED error on further I/O.

Since:
2.48

  • Method Details

    • getType

      static @Nullable Type getType()
      Get the GType of the DtlsConnection class.
      Returns:
      the GType

    • close

      default boolean close(@Nullable Cancellable cancellable) throws GErrorException

      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 this DtlsConnection is closed, all other operations will return IOErrorEnum.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:
      GErrorException - see GError
      Since:
      2.48

    • closeAsync

      default void closeAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Asynchronously close the DTLS connection. See g_dtls_connection_close() for more information.
      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - a GCancellable, or null
      callback - callback to call when the close operation is complete
      Since:
      2.48

    • closeFinish

      default boolean closeFinish(AsyncResult result) throws GErrorException
      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:
      GErrorException - see GError
      Since:
      2.48

    • emitAcceptCertificate

      default boolean emitAcceptCertificate(TlsCertificate peerCert, Set<TlsCertificateFlags> errors)
      Used by GDtlsConnection implementations to emit the GDtlsConnection::accept-certificate signal.
      Parameters:
      peerCert - the peer's GTlsCertificate
      errors - the problems with peerCert
      Returns:
      true if one of the signal handlers has returned true to accept peerCert
      Since:
      2.48

    • emitAcceptCertificate

      default boolean emitAcceptCertificate(TlsCertificate peerCert, TlsCertificateFlags... errors)
      Used by GDtlsConnection implementations to emit the GDtlsConnection::accept-certificate signal.
      Parameters:
      peerCert - the peer's GTlsCertificate
      errors - the problems with peerCert
      Returns:
      true if one of the signal handlers has returned true to accept peerCert
      Since:
      2.48

    • getCertificate

      default @Nullable TlsCertificate getCertificate()
      Gets conn's certificate, as set by g_dtls_connection_set_certificate().
      Returns:
      conn's certificate, or null
      Since:
      2.48

    • getChannelBindingData

      default boolean getChannelBindingData(TlsChannelBindingType type, @Nullable Out<byte[]> data) throws GErrorException

      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, RFC 5929, 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:
      GErrorException - see GError
      Since:
      2.66

    • getCiphersuiteName

      default @Nullable String 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
      Since:
      2.70

    • getDatabase

      default @Nullable TlsDatabase getDatabase()
      Gets the certificate database that this DtlsConnection uses to verify peer certificates. See g_dtls_connection_set_database().
      Returns:
      the certificate database that this DtlsConnection uses or null
      Since:
      2.48

    • getInteraction

      default @Nullable 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.
      Since:
      2.48

    • getNegotiatedProtocol

      default @Nullable String 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
      Since:
      2.60

    • getPeerCertificate

      default @Nullable 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
      Since:
      2.48

    • getPeerCertificateErrors

      default Set<TlsCertificateFlags> 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
      Since:
      2.48

    • getProtocolVersion

      default TlsProtocolVersion getProtocolVersion()
      Returns the current DTLS protocol version, which may be TlsProtocolVersion.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
      Since:
      2.70

    • getRehandshakeMode

      @Deprecated default TlsRehandshakeMode getRehandshakeMode()
      Deprecated.
      Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3.
      Gets this DtlsConnection rehandshaking mode. See g_dtls_connection_set_rehandshake_mode() for details.
      Returns:
      TlsRehandshakeMode.SAFELY
      Since:
      2.48

    • getRequireCloseNotify

      default boolean getRequireCloseNotify()
      Tests whether or not this DtlsConnection expects a proper TLS close notification when the connection is closed. See g_dtls_connection_set_require_close_notify() for details.
      Returns:
      true if this DtlsConnection requires a proper TLS close notification.
      Since:
      2.48

    • handshake

      default boolean handshake(@Nullable Cancellable cancellable) throws GErrorException

      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 this DtlsConnection 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:
      GErrorException - see GError
      Since:
      2.48

    • handshakeAsync

      default void handshakeAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Asynchronously performs a TLS handshake on conn. See g_dtls_connection_handshake() for more information.
      Parameters:
      ioPriority - the I/O priority of the request
      cancellable - a GCancellable, or null
      callback - callback to call when the handshake is complete
      Since:
      2.48

    • handshakeFinish

      default boolean handshakeFinish(AsyncResult result) throws GErrorException
      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:
      GErrorException - see GError
      Since:
      2.48

    • setAdvertisedProtocols

      default void setAdvertisedProtocols(@Nullable String @Nullable [] 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_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 for a list of registered protocol IDs.

      Parameters:
      protocols - a null-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or null
      Since:
      2.60

    • setCertificate

      default void setCertificate(TlsCertificate certificate)

      This sets the certificate that this DtlsConnection 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 TlsError.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 this DtlsConnection
      Since:
      2.48

    • setDatabase

      default 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 TlsCertificateFlags.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
      Since:
      2.48

    • setInteraction

      default 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
      Since:
      2.48

    • setRehandshakeMode

      @Deprecated default void setRehandshakeMode(TlsRehandshakeMode mode)
      Deprecated.
      Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3.
      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.
      Parameters:
      mode - the rehandshaking mode
      Since:
      2.48

    • setRequireCloseNotify

      default void setRequireCloseNotify(boolean requireCloseNotify)

      Sets whether or not this DtlsConnection expects a proper TLS close notification before the connection is closed. If this is true (the default), then this DtlsConnection will expect to receive a TLS close notification from its peer before the connection is closed, and will return a TlsError.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 this DtlsConnection 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 this DtlsConnection 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 this DtlsConnection itself.

      Parameters:
      requireCloseNotify - whether or not to require close notification
      Since:
      2.48

    • shutdown

      default boolean shutdown(boolean shutdownRead, boolean shutdownWrite, @Nullable Cancellable cancellable) throws GErrorException

      Shut down part or all of a DTLS connection.

      If shutdownRead 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 IOErrorEnum.CLOSED.

      If shutdownWrite 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 IOErrorEnum.CLOSED.

      It is allowed for both shutdownRead and shutdownWrite 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:
      shutdownRead - true to stop reception of incoming datagrams
      shutdownWrite - true to stop sending outgoing datagrams
      cancellable - a GCancellable, or null
      Returns:
      true on success, false otherwise
      Throws:
      GErrorException - see GError
      Since:
      2.48

    • shutdownAsync

      default void shutdownAsync(boolean shutdownRead, boolean shutdownWrite, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
      Asynchronously shut down part or all of the DTLS connection. See g_dtls_connection_shutdown() for more information.
      Parameters:
      shutdownRead - true to stop reception of incoming datagrams
      shutdownWrite - true to stop sending outgoing datagrams
      ioPriority - the I/O priority of the request
      cancellable - a GCancellable, or null
      callback - callback to call when the shutdown operation is complete
      Since:
      2.48

    • shutdownFinish

      default boolean shutdownFinish(AsyncResult result) throws GErrorException
      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:
      GErrorException - see GError
      Since:
      2.48

    • onAcceptCertificate

      default SignalConnection<DtlsConnection.AcceptCertificateCallback> onAcceptCertificate(DtlsConnection.AcceptCertificateCallback handler)

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

      For a client-side connection, peerCert is the server's certificate, and the signal will only be emitted if the certificate was not acceptable according to conn's GDtlsClientConnection:validation_flags. If you would like the certificate to be accepted despite errors, return true from the signal handler. Otherwise, if no handler accepts the certificate, the handshake will fail with TlsError.BAD_CERTIFICATE.

      GLib guarantees that if certificate verification fails, this signal will be emitted with at least one error will be set in errors, but it does not guarantee that all possible errors will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to ignore TlsCertificateFlags.EXPIRED if you want to allow expired certificates, because this could potentially be the only error flag set even if other problems exist with the certificate.

      For a server-side connection, peerCert is the certificate presented by the client, if this was requested via the server's GDtlsServerConnection:authentication_mode. On the server side, the signal is always emitted when the client presents a certificate, and the certificate will only be accepted if a handler returns true.

      Note that if this signal is emitted as part of asynchronous I/O in the main thread, then you should not attempt to interact with the user before returning from the signal handler. If you want to let the user decide whether or not to accept the certificate, you would have to return false from the signal handler on the first attempt, and then after the connection attempt returns a TlsError.BAD_CERTIFICATE, you can interact with the user, and if the user decides to accept the certificate, remember that fact, create a new connection, and return true from the signal handler the next time.

      If you are doing I/O in another thread, you do not need to worry about this, and can simply block in the signal handler until the UI thread returns an answer.

      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      Since:
      2.48
      See Also: