GI.Gio.Interfaces.DtlsClientConnection

DtlsClientConnection is the client-side subclass of DtlsConnection, representing a client-side DTLS connection.

Exported types

newtype DtlsClientConnection

Constructors

DtlsClientConnection (ManagedPtr DtlsClientConnection)

Instances

GObject DtlsClientConnection

Methods

gobjectType :: DtlsClientConnection -> IO GType

IsObject DtlsClientConnection

IsDtlsConnection DtlsClientConnection

IsDatagramBased DtlsClientConnection

IsDtlsClientConnection DtlsClientConnection

noDtlsClientConnection :: Maybe DtlsClientConnection

class GObject o => IsDtlsClientConnection o

Instances

(GObject a, UnknownAncestorError Constraint DtlsClientConnection a) => IsDtlsClientConnection a

IsDtlsClientConnection DtlsClientConnection

toDtlsClientConnection :: (MonadIO m, IsDtlsClientConnection o) => o -> m DtlsClientConnection

Methods

getAcceptedCas

dtlsClientConnectionGetAcceptedCas

Arguments

:: (HasCallStack, MonadIO m, IsDtlsClientConnection a)

=> a

conn: the DtlsClientConnection

-> m [ByteString]

Returns: the list of CA DNs. You should unref each element with byteArrayUnref and then the free the list with g_list_free().

Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be Nothing.

Each item in the list is a ByteArray which contains the complete subject DN of the certificate authority.

Since: 2.48

getServerIdentity

dtlsClientConnectionGetServerIdentity

Arguments

:: (HasCallStack, MonadIO m, IsDtlsClientConnection a)

=> a

conn: the DtlsClientConnection

-> m SocketConnectable

Returns: a SocketConnectable describing the expected server identity, or Nothing if the expected identity is not known.

Gets conn's expected server identity

Since: 2.48

getValidationFlags

dtlsClientConnectionGetValidationFlags

Arguments

:: (HasCallStack, MonadIO m, IsDtlsClientConnection a)

=> a

conn: the DtlsClientConnection

-> m [TlsCertificateFlags]

Returns: the validation flags

Gets conn's validation flags

Since: 2.48

new

dtlsClientConnectionNew

Arguments

:: (HasCallStack, MonadIO m, IsDatagramBased a, IsSocketConnectable b)

=> a

baseSocket: the DatagramBased to wrap

-> Maybe b

serverIdentity: the expected identity of the server

-> m DtlsClientConnection

Returns: the new DtlsClientConnection, or Nothing on error (Can throw GError)

Creates a new DtlsClientConnection wrapping baseSocket which is assumed to communicate with the server identified by serverIdentity.

Since: 2.48

setServerIdentity

dtlsClientConnectionSetServerIdentity

Arguments

:: (HasCallStack, MonadIO m, IsDtlsClientConnection a, IsSocketConnectable b)

=> a

conn: the DtlsClientConnection

-> b

identity: a SocketConnectable describing the expected server identity

-> m ()

Sets conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let conn know what name to look for in the certificate when performing TlsCertificateFlagsBadIdentity validation, if enabled.

Since: 2.48

setValidationFlags

dtlsClientConnectionSetValidationFlags

Arguments

:: (HasCallStack, MonadIO m, IsDtlsClientConnection a)

=> a

conn: the DtlsClientConnection

-> [TlsCertificateFlags]

flags: the TlsCertificateFlags to use

-> m ()

Sets conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, TlsCertificateFlagsValidateAll is used.

Since: 2.48

Properties

acceptedCas

getDtlsClientConnectionAcceptedCas :: (MonadIO m, IsDtlsClientConnection o) => o -> m [Ptr ()]

serverIdentity

constructDtlsClientConnectionServerIdentity :: (IsDtlsClientConnection o, IsSocketConnectable a) => a -> IO (GValueConstruct o)

getDtlsClientConnectionServerIdentity :: (MonadIO m, IsDtlsClientConnection o) => o -> m SocketConnectable

setDtlsClientConnectionServerIdentity :: (MonadIO m, IsDtlsClientConnection o, IsSocketConnectable a) => o -> a -> m ()

validationFlags

constructDtlsClientConnectionValidationFlags :: IsDtlsClientConnection o => [TlsCertificateFlags] -> IO (GValueConstruct o)

getDtlsClientConnectionValidationFlags :: (MonadIO m, IsDtlsClientConnection o) => o -> m [TlsCertificateFlags]

setDtlsClientConnectionValidationFlags :: (MonadIO m, IsDtlsClientConnection o) => o -> [TlsCertificateFlags] -> m ()