GI.Gio.Interfaces.DtlsConnection

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.

Exported types

newtype DtlsConnection

Constructors

DtlsConnection (ManagedPtr DtlsConnection)

Instances

GObject DtlsConnection

Methods

gobjectType :: DtlsConnection -> IO GType

IsObject DtlsConnection

IsDtlsConnection DtlsConnection

IsDatagramBased DtlsConnection

noDtlsConnection :: Maybe DtlsConnection

class GObject o => IsDtlsConnection o

Instances

(GObject a, UnknownAncestorError Constraint DtlsConnection a) => IsDtlsConnection a

IsDtlsConnection DtlsConnection

IsDtlsConnection DtlsClientConnection

IsDtlsConnection DtlsServerConnection

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

Methods

close

dtlsConnectionClose

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

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

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

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

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

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

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

getPeerCertificate

dtlsConnectionGetPeerCertificate

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

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

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

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

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. However, you may call dtlsConnectionHandshake later on to renegotiate parameters (encryption methods, etc) with the client.

DtlsConnection::accept_certificate may be emitted during the handshake.

Since: 2.48

handshakeAsync

dtlsConnectionHandshakeAsync

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

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

setCertificate

dtlsConnectionSetCertificate

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

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

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

Arguments

:: (HasCallStack, MonadIO m, IsDtlsConnection a)

=> a

conn: a DtlsConnection

-> TlsRehandshakeMode

mode: the rehandshaking mode

-> m ()

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

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

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

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

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

baseSocket

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

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

certificate

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

database

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

interaction

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

peerCertificate

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

peerCertificateErrors

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

rehandshakeMode

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

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

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

requireCloseNotify

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

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

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

Signals

acceptCertificate

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 -> Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt