GI.Gio.Interfaces.TlsBackend

TLS (Transport Layer Security, aka SSL) and DTLS backend.

Since: 2.28

Exported types

newtype TlsBackend

Memory-managed wrapper type.

Constructors

TlsBackend (ManagedPtr TlsBackend)

Instances

GObject TlsBackend

Defined in GI.Gio.Interfaces.TlsBackend

Methods

gobjectType :: IO GType

HasParentTypes TlsBackend

Defined in GI.Gio.Interfaces.TlsBackend

type ParentTypes TlsBackend

Defined in GI.Gio.Interfaces.TlsBackend

type ParentTypes TlsBackend = Object ': ([] :: [Type])

noTlsBackend :: Maybe TlsBackend

A convenience alias for Nothing :: Maybe TlsBackend.

class (GObject o, IsDescendantOf TlsBackend o) => IsTlsBackend o

Type class for types which can be safely cast to TlsBackend, for instance with toTlsBackend.

Instances

(GObject o, IsDescendantOf TlsBackend o) => IsTlsBackend o

Defined in GI.Gio.Interfaces.TlsBackend

toTlsBackend :: (MonadIO m, IsTlsBackend o) => o -> m TlsBackend

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

Methods

getCertificateType

tlsBackendGetCertificateType

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m GType

Returns: the GType of backend's TlsCertificate implementation.

Gets the GType of backend's TlsCertificate implementation.

Since: 2.28

getClientConnectionType

tlsBackendGetClientConnectionType

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m GType

Returns: the GType of backend's TlsClientConnection implementation.

Gets the GType of backend's TlsClientConnection implementation.

Since: 2.28

getDefault

tlsBackendGetDefault

Arguments

:: (HasCallStack, MonadIO m)

=> m TlsBackend

Returns: a TlsBackend

Gets the default TlsBackend for the system.

Since: 2.28

getDefaultDatabase

tlsBackendGetDefaultDatabase

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m TlsDatabase

Returns: the default database, which should be unreffed when done.

Gets the default TlsDatabase used to verify TLS connections.

Since: 2.30

getDtlsClientConnectionType

tlsBackendGetDtlsClientConnectionType

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m GType

Returns: the GType of backend’s DtlsClientConnection implementation, or G_TYPE_INVALID if this backend doesn’t support DTLS.

Gets the GType of backend’s DtlsClientConnection implementation.

Since: 2.48

getDtlsServerConnectionType

tlsBackendGetDtlsServerConnectionType

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m GType

Returns: the GType of backend’s DtlsServerConnection implementation, or G_TYPE_INVALID if this backend doesn’t support DTLS.

Gets the GType of backend’s DtlsServerConnection implementation.

Since: 2.48

getFileDatabaseType

tlsBackendGetFileDatabaseType

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m GType

Returns: the GType of backend's TlsFileDatabase implementation.

Gets the GType of backend's TlsFileDatabase implementation.

Since: 2.30

getServerConnectionType

tlsBackendGetServerConnectionType

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m GType

Returns: the GType of backend's TlsServerConnection implementation.

Gets the GType of backend's TlsServerConnection implementation.

Since: 2.28

setDefaultDatabase

tlsBackendSetDefaultDatabase

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a, IsTlsDatabase b)

=> a

backend: the TlsBackend

-> Maybe b

database: the TlsDatabase

-> m ()

Set the default TlsDatabase used to verify TLS connections

Any subsequent call to tlsBackendGetDefaultDatabase will return the database set in this call. Existing databases and connections are not modified.

Setting a Nothing default database will reset to using the system default database as if tlsBackendSetDefaultDatabase had never been called.

Since: 2.60

supportsDtls

tlsBackendSupportsDtls

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m Bool

Returns: whether DTLS is supported

Checks if DTLS is supported. DTLS support may not be available even if TLS support is available, and vice-versa.

Since: 2.48

supportsTls

tlsBackendSupportsTls

Arguments

:: (HasCallStack, MonadIO m, IsTlsBackend a)

=> a

backend: the TlsBackend

-> m Bool

Returns: whether or not TLS is supported

Checks if TLS is supported; if this returns False for the default TlsBackend, it means no "real" TLS backend is available.

Since: 2.28