gi-gio-2.0.19: Gio bindings

Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell | None
Language | Haskell2010

GI.Gio.Interfaces.DtlsConnection

Contents

- Exported types
- Methods
  - close
  - closeAsync
  - closeFinish
  - emitAcceptCertificate
  - getCertificate
  - getDatabase
  - getInteraction
  - getNegotiatedProtocol
  - getPeerCertificate
  - getPeerCertificateErrors
  - getRehandshakeMode
  - getRequireCloseNotify
  - handshake
  - handshakeAsync
  - handshakeFinish
  - setAdvertisedProtocols
  - setCertificate
  - setDatabase
  - setInteraction
  - setRehandshakeMode
  - setRequireCloseNotify
  - shutdown
  - shutdownAsync
  - shutdownFinish
- Properties
  - advertisedProtocols
  - baseSocket
  - certificate
  - database
  - interaction
  - negotiatedProtocol
  - peerCertificate
  - peerCertificateErrors
  - rehandshakeMode
  - requireCloseNotify
- Signals
  - acceptCertificate

Description

`DtlsConnection` 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, `DtlsConnection` implements `DatagramBased`, presenting a datagram-socket-like API for the encrypted connection. This operates over a base datagram connection, which is also a `DatagramBased` (`DtlsConnection`:`base-socket`).

To close a DTLS connection, use `dtlsConnectionClose`.

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 `socketClose` is called on the base socket, the `DtlsConnection` will not raise a `IOErrorEnumNotConnected` error on further I/O.

Since: 2.48

Synopsis

- newtype DtlsConnection = DtlsConnection (ManagedPtr DtlsConnection)
- noDtlsConnection :: Maybe DtlsConnection
- class GObject o => IsDtlsConnection o
- toDtlsConnection :: (MonadIO m, IsDtlsConnection o) => o -> m DtlsConnection
- dtlsConnectionClose :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Maybe b -> m ()
- dtlsConnectionCloseAsync :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- dtlsConnectionCloseFinish :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) => a -> b -> m ()
- dtlsConnectionEmitAcceptCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) => a -> b -> [TlsCertificateFlags] -> m Bool
- dtlsConnectionGetCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m TlsCertificate
- dtlsConnectionGetDatabase :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m TlsDatabase
- dtlsConnectionGetInteraction :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m TlsInteraction
- dtlsConnectionGetNegotiatedProtocol :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m (Maybe Text)
- dtlsConnectionGetPeerCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m TlsCertificate
- dtlsConnectionGetPeerCertificateErrors :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m [TlsCertificateFlags]
- dtlsConnectionGetRehandshakeMode :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m TlsRehandshakeMode
- dtlsConnectionGetRequireCloseNotify :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m Bool
- dtlsConnectionHandshake :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Maybe b -> m ()
- dtlsConnectionHandshakeAsync :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- dtlsConnectionHandshakeFinish :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) => a -> b -> m ()
- dtlsConnectionSetAdvertisedProtocols :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> Maybe [Text] -> m ()
- dtlsConnectionSetCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) => a -> b -> m ()
- dtlsConnectionSetDatabase :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsDatabase b) => a -> b -> m ()
- dtlsConnectionSetInteraction :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsInteraction b) => a -> Maybe b -> m ()
- dtlsConnectionSetRehandshakeMode :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> TlsRehandshakeMode -> m ()
- dtlsConnectionSetRequireCloseNotify :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> Bool -> m ()
- dtlsConnectionShutdown :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Bool -> Bool -> Maybe b -> m ()
- dtlsConnectionShutdownAsync :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Bool -> Bool -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- dtlsConnectionShutdownFinish :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) => a -> b -> m ()
- clearDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m ()
- constructDtlsConnectionAdvertisedProtocols :: IsDtlsConnection o => [Text] -> IO (GValueConstruct o)
- getDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe [Text])
- setDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> [Text] -> m ()
- constructDtlsConnectionBaseSocket :: (IsDtlsConnection o, IsDatagramBased a) => a -> IO (GValueConstruct o)
- getDtlsConnectionBaseSocket :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe DatagramBased)
- constructDtlsConnectionCertificate :: (IsDtlsConnection o, IsTlsCertificate a) => a -> IO (GValueConstruct o)
- getDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m TlsCertificate
- setDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o, IsTlsCertificate a) => o -> a -> m ()
- constructDtlsConnectionDatabase :: (IsDtlsConnection o, IsTlsDatabase a) => a -> IO (GValueConstruct o)
- getDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o) => o -> m TlsDatabase
- setDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o, IsTlsDatabase a) => o -> a -> m ()
- clearDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m ()
- constructDtlsConnectionInteraction :: (IsDtlsConnection o, IsTlsInteraction a) => a -> IO (GValueConstruct o)
- getDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m TlsInteraction
- setDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o, IsTlsInteraction a) => o -> a -> m ()
- getDtlsConnectionNegotiatedProtocol :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe Text)
- getDtlsConnectionPeerCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m TlsCertificate
- getDtlsConnectionPeerCertificateErrors :: (MonadIO m, IsDtlsConnection o) => o -> m [TlsCertificateFlags]
- constructDtlsConnectionRehandshakeMode :: IsDtlsConnection o => TlsRehandshakeMode -> IO (GValueConstruct o)
- getDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> m TlsRehandshakeMode
- setDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> TlsRehandshakeMode -> m ()
- constructDtlsConnectionRequireCloseNotify :: IsDtlsConnection o => Bool -> IO (GValueConstruct o)
- getDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> m Bool
- setDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> Bool -> m ()
- type C_DtlsConnectionAcceptCertificateCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt
- type DtlsConnectionAcceptCertificateCallback = TlsCertificate -> [TlsCertificateFlags] -> IO Bool
- afterDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> DtlsConnectionAcceptCertificateCallback -> m SignalHandlerId
- genClosure_DtlsConnectionAcceptCertificate :: DtlsConnectionAcceptCertificateCallback -> IO Closure
- mk_DtlsConnectionAcceptCertificateCallback :: C_DtlsConnectionAcceptCertificateCallback -> IO (FunPtr C_DtlsConnectionAcceptCertificateCallback)
- noDtlsConnectionAcceptCertificateCallback :: Maybe DtlsConnectionAcceptCertificateCallback
- onDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> DtlsConnectionAcceptCertificateCallback -> m SignalHandlerId
- wrap_DtlsConnectionAcceptCertificateCallback :: DtlsConnectionAcceptCertificateCallback -> C_DtlsConnectionAcceptCertificateCallback

# Exported types

newtype DtlsConnection Source #

Memory-managed wrapper type.

Constructors

DtlsConnection (ManagedPtr DtlsConnection) |

Instances

GObject DtlsConnection Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsConnection Methods gobjectType :: DtlsConnection -> IO GType Source #
IsObject DtlsConnection Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsConnection
IsDatagramBased DtlsConnection Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsConnection
IsDtlsConnection DtlsConnection Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsConnection

noDtlsConnection :: Maybe DtlsConnection Source #

A convenience alias for `Nothing` :: `Maybe` `DtlsConnection`.

class GObject o => IsDtlsConnection o Source #

Type class for types which can be safely cast to `DtlsConnection`, for instance with `toDtlsConnection`.

Instances

(GObject a, (UnknownAncestorError DtlsConnection a :: Constraint)) => IsDtlsConnection a Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsConnection
IsDtlsConnection DtlsConnection Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsConnection
IsDtlsConnection DtlsClientConnection Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsClientConnection
IsDtlsConnection DtlsServerConnection Source # |
Instance details Defined in GI.Gio.Interfaces.DtlsServerConnection

toDtlsConnection :: (MonadIO m, IsDtlsConnection o) => o -> m DtlsConnection Source #

Cast to `DtlsConnection`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

## close

dtlsConnectionClose Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) |
=> a | `conn`: a `DtlsConnection`
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> m () | (Can throw `GError`)

Close the DTLS connection. This is equivalent to calling `dtlsConnectionShutdown` to shut down both sides of the connection.

Closing a `DtlsConnection` 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 `DtlsConnection`:`base-socket`; that must be closed separately.

Once `conn` is closed, all other operations will return `IOErrorEnumClosed`. Closing a `DtlsConnection` 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 `DtlsConnection` may be left partially-closed and any pending untransmitted data may be lost. Call `dtlsConnectionClose` again to complete closing the `DtlsConnection`.

Since: 2.48

## closeAsync

dtlsConnectionCloseAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) |
=> a | `conn`: a `DtlsConnection`
-> Int32 | `ioPriority`: the [I/O priority][io-priority] of the request
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> Maybe AsyncReadyCallback | `callback`: callback to call when the close operation is complete
-> m () |

Asynchronously close the DTLS connection. See `dtlsConnectionClose` for more information.

Since: 2.48

## closeFinish

dtlsConnectionCloseFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) |
=> a | `conn`: a `DtlsConnection`
-> b | `result`: a `AsyncResult`
-> m () | (Can throw `GError`)

Finish an asynchronous TLS close operation. See `dtlsConnectionClose` for more information.

Since: 2.48

## emitAcceptCertificate

dtlsConnectionEmitAcceptCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) |
=> a | `conn`: a `DtlsConnection`
-> b | `peerCert`: the peer's `TlsCertificate`
-> [TlsCertificateFlags] | `errors`: the problems with `peerCert`
-> m Bool | Returns: `True` if one of the signal handlers has returned `True` to accept `peerCert`

Used by `DtlsConnection` implementations to emit the `DtlsConnection`::`accept-certificate` signal.

Since: 2.48

## getCertificate

dtlsConnectionGetCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> m TlsCertificate | Returns: `conn`'s certificate, or `Nothing`

Gets `conn`'s certificate, as set by `dtlsConnectionSetCertificate`.

Since: 2.48

## getDatabase

dtlsConnectionGetDatabase Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> m TlsDatabase | Returns: the certificate database that `conn` uses or `Nothing`

Gets the certificate database that `conn` uses to verify peer certificates. See `dtlsConnectionSetDatabase`.

Since: 2.48

## getInteraction

dtlsConnectionGetInteraction Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a connection
-> m TlsInteraction | Returns: The interaction object.

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 `Nothing` is returned, then no user interaction will occur for this connection.

Since: 2.48

## getNegotiatedProtocol

dtlsConnectionGetNegotiatedProtocol Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> m (Maybe Text) | Returns: the negotiated protocol, or `Nothing`

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 `Nothing`. See `dtlsConnectionSetAdvertisedProtocols`.

Since: 2.60

## getPeerCertificate

dtlsConnectionGetPeerCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> m TlsCertificate | Returns: `conn`'s peer's certificate, or `Nothing`

Gets `conn`'s peer's certificate after the handshake has completed. (It is not set during the emission of `DtlsConnection`::`accept-certificate`.)

Since: 2.48

## getPeerCertificateErrors

dtlsConnectionGetPeerCertificateErrors Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> m [TlsCertificateFlags] | Returns: `conn`'s peer's certificate errors

Gets the errors associated with validating `conn`'s peer's certificate, after the handshake has completed. (It is not set during the emission of `DtlsConnection`::`accept-certificate`.)

Since: 2.48

## getRehandshakeMode

dtlsConnectionGetRehandshakeMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> m TlsRehandshakeMode | Returns: `conn`'s rehandshaking mode

Gets `conn` rehandshaking mode. See `dtlsConnectionSetRehandshakeMode` for details.

Since: 2.48

## getRequireCloseNotify

dtlsConnectionGetRequireCloseNotify Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> m Bool | Returns: `True` if `conn` requires a proper TLS close notification.

Tests whether or not `conn` expects a proper TLS close notification when the connection is closed. See `dtlsConnectionSetRequireCloseNotify` for details.

Since: 2.48

## handshake

dtlsConnectionHandshake Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) |
=> a | `conn`: a `DtlsConnection`
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> m () | (Can throw `GError`)

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) and may need to rehandshake later if the server requests it, `DtlsConnection` will handle this for you automatically when you try to send or receive data on the connection. However, you can call `dtlsConnectionHandshake` manually if you want to know for sure whether the initial handshake succeeded or failed (as opposed to just immediately trying to write to `conn`, in which case if it fails, it may not be possible to tell if it failed before or after completing the handshake).

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.

If TLS 1.2 or older is in use, you may call `dtlsConnectionHandshake` after the initial handshake to rehandshake; however, this usage is deprecated because rehandshaking is no longer part of the TLS protocol in TLS 1.3. Accordingly, the behavior of calling this function after the initial handshake is now undefined, except it is guaranteed to be reasonable and nondestructive so as to preserve compatibility with code written for older versions of GLib.

`DtlsConnection`::`accept_certificate` may be emitted during the handshake.

Since: 2.48

## handshakeAsync

dtlsConnectionHandshakeAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) |
=> a | `conn`: a `DtlsConnection`
-> Int32 | `ioPriority`: the [I/O priority][io-priority] of the request
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> Maybe AsyncReadyCallback | `callback`: callback to call when the handshake is complete
-> m () |

Asynchronously performs a TLS handshake on `conn`. See `dtlsConnectionHandshake` for more information.

Since: 2.48

## handshakeFinish

dtlsConnectionHandshakeFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) |
=> a | `conn`: a `DtlsConnection`
-> b | `result`: a `AsyncResult`.
-> m () | (Can throw `GError`)

Finish an asynchronous TLS handshake operation. See `dtlsConnectionHandshake` for more information.

Since: 2.48

## setAdvertisedProtocols

dtlsConnectionSetAdvertisedProtocols Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> Maybe [Text] | `protocols`: a `Nothing`-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or `Nothing`
-> m () |

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 `dtlsConnectionGetNegotiatedProtocol` to find the negotiated protocol after the handshake. Specifying `Nothing` for the the value of `protocols` will disable ALPN negotiation.

See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs.

Since: 2.60

## setCertificate

dtlsConnectionSetCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) |
=> a | `conn`: a `DtlsConnection`
-> b | `certificate`: the certificate to use for `conn`
-> m () |

This sets the certificate that `conn` will present to its peer during the TLS handshake. For a `DtlsServerConnection`, it is mandatory to set this, and that will normally be done at construct time.

For a `DtlsClientConnection`, this is optional. If a handshake fails with `TlsErrorCertificateRequired`, that means that the server requires a certificate, and if you try connecting again, you should call this method first. You can call `dtlsClientConnectionGetAcceptedCas` 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 `dtlsClientConnectionGetAcceptedCas` will return non-`Nothing`.)

Since: 2.48

## setDatabase

dtlsConnectionSetDatabase Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsDatabase b) |
=> a | `conn`: a `DtlsConnection`
-> b | `database`: a `TlsDatabase`
-> m () |

Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See `tlsBackendGetDefaultDatabase`. If set to `Nothing`, then peer certificate validation will always set the `TlsCertificateFlagsUnknownCa` error (meaning `DtlsConnection`::`accept-certificate` will always be emitted on client-side connections, unless that bit is not set in `DtlsClientConnection`:`validation-flags`).

Since: 2.48

## setInteraction

dtlsConnectionSetInteraction Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsInteraction b) |
=> a | `conn`: a connection
-> Maybe b | `interaction`: an interaction object, or `Nothing`
-> m () |

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 `TlsInteraction`. `Nothing` can also be provided if no user interaction should occur for this connection.

Since: 2.48

## setRehandshakeMode

dtlsConnectionSetRehandshakeMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> TlsRehandshakeMode | `mode`: the rehandshaking mode
-> m () |

Deprecated: (Since version 2.60.)Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3.

Sets how `conn` behaves with respect to rehandshaking requests.

`TlsRehandshakeModeNever` means that it will never agree to rehandshake after the initial handshake is complete. (For a client, this means it will refuse rehandshake requests from the server, and for a server, this means it will close the connection with an error if the client attempts to rehandshake.)

`TlsRehandshakeModeSafely` means that the connection will allow a rehandshake only if the other end of the connection supports the TLS `renegotiation_info` extension. This is the default behavior, but means that rehandshaking will not work against older implementations that do not support that extension.

`TlsRehandshakeModeUnsafely` means that the connection will allow rehandshaking even without the `renegotiation_info` extension. On the server side in particular, this is not recommended, since it leaves the server open to certain attacks. However, this mode is necessary if you need to allow renegotiation with older client software.

Since: 2.48

## setRequireCloseNotify

dtlsConnectionSetRequireCloseNotify Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a) |
=> a | `conn`: a `DtlsConnection`
-> Bool | `requireCloseNotify`: whether or not to require close notification
-> m () |

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 `TlsErrorEof` 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 `dtlsConnectionSetRequireCloseNotify` 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 `DatagramBased`, 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 `dtlsConnectionCloseAsync` 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 `DtlsConnection`:`base-socket` rather than closing `conn` itself.

Since: 2.48

## shutdown

dtlsConnectionShutdown Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) |
=> a | `conn`: a `DtlsConnection`
-> Bool | `shutdownRead`: `True` to stop reception of incoming datagrams
-> Bool | `shutdownWrite`: `True` to stop sending outgoing datagrams
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> m () | (Can throw `GError`)

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 `datagramBasedReceiveMessages` will return `IOErrorEnumClosed`.

If `shutdownWrite` is `True` then the sending side of the connection is shut down, and further writing is disallowed. Subsequent calls to `datagramBasedSendMessages` will return `IOErrorEnumClosed`.

It is allowed for both `shutdownRead` and `shutdownWrite` to be TRUE — this is equivalent to calling `dtlsConnectionClose`.

If `cancellable` is cancelled, the `DtlsConnection` may be left partially-closed and any pending untransmitted data may be lost. Call `dtlsConnectionShutdown` again to complete closing the `DtlsConnection`.

Since: 2.48

## shutdownAsync

dtlsConnectionShutdownAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) |
=> a | `conn`: a `DtlsConnection`
-> Bool | `shutdownRead`: `True` to stop reception of incoming datagrams
-> Bool | `shutdownWrite`: `True` to stop sending outgoing datagrams
-> Int32 | `ioPriority`: the [I/O priority][io-priority] of the request
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> Maybe AsyncReadyCallback | `callback`: callback to call when the shutdown operation is complete
-> m () |

Asynchronously shut down part or all of the DTLS connection. See `dtlsConnectionShutdown` for more information.

Since: 2.48

## shutdownFinish

dtlsConnectionShutdownFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) |
=> a | `conn`: a `DtlsConnection`
-> b | `result`: a `AsyncResult`
-> m () | (Can throw `GError`)

Finish an asynchronous TLS shutdown operation. See `dtlsConnectionShutdown` for more information.

Since: 2.48

# Properties

## advertisedProtocols

The list of application-layer protocols that the connection advertises that it is willing to speak. See `dtlsConnectionSetAdvertisedProtocols`.

Since: 2.60

clearDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m () Source #

Set the value of the “`advertised-protocols`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #advertisedProtocols

constructDtlsConnectionAdvertisedProtocols :: IsDtlsConnection o => [Text] -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`advertised-protocols`” property. This is rarely needed directly, but it is used by `new`.

getDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe [Text]) Source #

Get the value of the “`advertised-protocols`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #advertisedProtocols

setDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> [Text] -> m () Source #

Set the value of the “`advertised-protocols`” property. When overloading is enabled, this is equivalent to

    set dtlsConnection [ #advertisedProtocols := value ]

## baseSocket

The `DatagramBased` that the connection wraps. Note that this may be any implementation of `DatagramBased`, not just a `Socket`.

Since: 2.48

constructDtlsConnectionBaseSocket :: (IsDtlsConnection o, IsDatagramBased a) => a -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`base-socket`” property. This is rarely needed directly, but it is used by `new`.

getDtlsConnectionBaseSocket :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe DatagramBased) Source #

Get the value of the “`base-socket`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #baseSocket

## certificate

The connection's certificate; see `dtlsConnectionSetCertificate`.

Since: 2.48

constructDtlsConnectionCertificate :: (IsDtlsConnection o, IsTlsCertificate a) => a -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`certificate`” property. This is rarely needed directly, but it is used by `new`.

getDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m TlsCertificate Source #

Get the value of the “`certificate`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #certificate

setDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o, IsTlsCertificate a) => o -> a -> m () Source #

Set the value of the “`certificate`” property. When overloading is enabled, this is equivalent to

    set dtlsConnection [ #certificate := value ]

## database

The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See `tlsBackendGetDefaultDatabase`.

Since: 2.48

constructDtlsConnectionDatabase :: (IsDtlsConnection o, IsTlsDatabase a) => a -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`database`” property. This is rarely needed directly, but it is used by `new`.

getDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o) => o -> m TlsDatabase Source #

Get the value of the “`database`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #database

setDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o, IsTlsDatabase a) => o -> a -> m () Source #

Set the value of the “`database`” property. When overloading is enabled, this is equivalent to

    set dtlsConnection [ #database := value ]

## interaction

A `TlsInteraction` 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.

Since: 2.48

clearDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m () Source #

Set the value of the “`interaction`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #interaction

constructDtlsConnectionInteraction :: (IsDtlsConnection o, IsTlsInteraction a) => a -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`interaction`” property. This is rarely needed directly, but it is used by `new`.

getDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m TlsInteraction Source #

Get the value of the “`interaction`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #interaction

setDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o, IsTlsInteraction a) => o -> a -> m () Source #

Set the value of the “`interaction`” property. When overloading is enabled, this is equivalent to

    set dtlsConnection [ #interaction := value ]

## negotiatedProtocol

The application-layer protocol negotiated during the TLS handshake. See `dtlsConnectionGetNegotiatedProtocol`.

Since: 2.60

getDtlsConnectionNegotiatedProtocol :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe Text) Source #

Get the value of the “`negotiated-protocol`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #negotiatedProtocol

## peerCertificate

The connection's peer's certificate, after the TLS handshake has completed and the certificate has been accepted. Note in particular that this is not yet set during the emission of `DtlsConnection`::`accept-certificate`.

(You can watch for a `Object`::`notify` signal on this property to detect when a handshake has occurred.)

Since: 2.48

getDtlsConnectionPeerCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m TlsCertificate Source #

Get the value of the “`peer-certificate`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #peerCertificate

## peerCertificateErrors

The errors noticed-and-ignored while verifying `DtlsConnection`:`peer-certificate`. Normally this should be 0, but it may not be if `DtlsClientConnection`:`validation-flags` is not `TlsCertificateFlagsValidateAll`, or if `DtlsConnection`::`accept-certificate` overrode the default behavior.

Since: 2.48

getDtlsConnectionPeerCertificateErrors :: (MonadIO m, IsDtlsConnection o) => o -> m [TlsCertificateFlags] Source #

Get the value of the “`peer-certificate-errors`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #peerCertificateErrors

## rehandshakeMode

The rehandshaking mode. See `dtlsConnectionSetRehandshakeMode`.

Since: 2.48

constructDtlsConnectionRehandshakeMode :: IsDtlsConnection o => TlsRehandshakeMode -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`rehandshake-mode`” property. This is rarely needed directly, but it is used by `new`.

getDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> m TlsRehandshakeMode Source #

Get the value of the “`rehandshake-mode`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #rehandshakeMode

setDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> TlsRehandshakeMode -> m () Source #

Set the value of the “`rehandshake-mode`” property. When overloading is enabled, this is equivalent to

    set dtlsConnection [ #rehandshakeMode := value ]

## requireCloseNotify

Whether or not proper TLS close notification is required. See `dtlsConnectionSetRequireCloseNotify`.

Since: 2.48

constructDtlsConnectionRequireCloseNotify :: IsDtlsConnection o => Bool -> IO (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`require-close-notify`” property. This is rarely needed directly, but it is used by `new`.

getDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> m Bool Source #

Get the value of the “`require-close-notify`” property. When overloading is enabled, this is equivalent to

    get dtlsConnection #requireCloseNotify

setDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> Bool -> m () Source #

Set the value of the “`require-close-notify`” property. When overloading is enabled, this is equivalent to

    set dtlsConnection [ #requireCloseNotify := value ]

# Signals

## acceptCertificate

type C_DtlsConnectionAcceptCertificateCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt Source #

Type for the callback on the (unwrapped) C side.

type DtlsConnectionAcceptCertificateCallback Source #

Arguments

= TlsCertificate | `peerCert`: the peer's `TlsCertificate`
-> [TlsCertificateFlags] | `errors`: the problems with `peerCert`.
-> IO Bool | Returns: `True` to accept `peerCert` (which will also immediately end the signal emission). `False` to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it.

Emitted during the TLS handshake after the peer certificate has been received. You can examine `peerCert`'s certification path by calling `tlsCertificateGetIssuer` 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 `DtlsClientConnection`:`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 `TlsErrorBadCertificate`.

For a server-side connection, `peerCert` is the certificate presented by the client, if this was requested via the server's `DtlsServerConnection`:`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 `TlsErrorBadCertificate`, 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.

Since: 2.48

afterDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> DtlsConnectionAcceptCertificateCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`accept-certificate`” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after dtlsConnection #acceptCertificate callback

genClosure_DtlsConnectionAcceptCertificate :: DtlsConnectionAcceptCertificateCallback -> IO Closure Source #

Wrap the callback into a `Closure`.

mk_DtlsConnectionAcceptCertificateCallback :: C_DtlsConnectionAcceptCertificateCallback -> IO (FunPtr C_DtlsConnectionAcceptCertificateCallback) Source #

Generate a function pointer callable from C code, from a `C_DtlsConnectionAcceptCertificateCallback`.

noDtlsConnectionAcceptCertificateCallback :: Maybe DtlsConnectionAcceptCertificateCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `DtlsConnectionAcceptCertificateCallback``.

onDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> DtlsConnectionAcceptCertificateCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`accept-certificate`” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on dtlsConnection #acceptCertificate callback

wrap_DtlsConnectionAcceptCertificateCallback :: DtlsConnectionAcceptCertificateCallback -> C_DtlsConnectionAcceptCertificateCallback Source #

Wrap a `DtlsConnectionAcceptCertificateCallback` into a `C_DtlsConnectionAcceptCertificateCallback`.