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 |
- Exported types
- Methods
- createCertificateHandle
- lookupCertificateForHandle
- lookupCertificateForHandleAsync
- lookupCertificateForHandleFinish
- lookupCertificateIssuer
- lookupCertificateIssuerAsync
- lookupCertificateIssuerFinish
- lookupCertificatesIssuedBy
- lookupCertificatesIssuedByAsync
- lookupCertificatesIssuedByFinish
- verifyChain
- verifyChainAsync
- verifyChainFinish
TlsDatabase
is used to lookup certificates and other information
from a certificate or key store. It is an abstract base class which
TLS library specific subtypes override.
Most common client applications will not directly interact with
TlsDatabase
. It is used internally by TlsConnection
.
- newtype TlsDatabase = TlsDatabase (ManagedPtr TlsDatabase)
- class GObject o => IsTlsDatabase o
- toTlsDatabase :: IsTlsDatabase o => o -> IO TlsDatabase
- noTlsDatabase :: Maybe TlsDatabase
- data TlsDatabaseCreateCertificateHandleMethodInfo
- tlsDatabaseCreateCertificateHandle :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b) => a -> b -> m (Maybe Text)
- data TlsDatabaseLookupCertificateForHandleMethodInfo
- tlsDatabaseLookupCertificateForHandle :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => a -> Text -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> m (Maybe TlsCertificate)
- data TlsDatabaseLookupCertificateForHandleAsyncMethodInfo
- tlsDatabaseLookupCertificateForHandleAsync :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => a -> Text -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> Maybe AsyncReadyCallback -> m ()
- data TlsDatabaseLookupCertificateForHandleFinishMethodInfo
- tlsDatabaseLookupCertificateForHandleFinish :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) => a -> b -> m TlsCertificate
- data TlsDatabaseLookupCertificateIssuerMethodInfo
- tlsDatabaseLookupCertificateIssuer :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsTlsInteraction c, IsCancellable d) => a -> b -> Maybe c -> TlsDatabaseLookupFlags -> Maybe d -> m TlsCertificate
- data TlsDatabaseLookupCertificateIssuerAsyncMethodInfo
- tlsDatabaseLookupCertificateIssuerAsync :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsTlsInteraction c, IsCancellable d) => a -> b -> Maybe c -> TlsDatabaseLookupFlags -> Maybe d -> Maybe AsyncReadyCallback -> m ()
- data TlsDatabaseLookupCertificateIssuerFinishMethodInfo
- tlsDatabaseLookupCertificateIssuerFinish :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) => a -> b -> m TlsCertificate
- data TlsDatabaseLookupCertificatesIssuedByMethodInfo
- tlsDatabaseLookupCertificatesIssuedBy :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => a -> ByteString -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> m [TlsCertificate]
- data TlsDatabaseLookupCertificatesIssuedByAsyncMethodInfo
- tlsDatabaseLookupCertificatesIssuedByAsync :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => a -> ByteString -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> Maybe AsyncReadyCallback -> m ()
- data TlsDatabaseLookupCertificatesIssuedByFinishMethodInfo
- tlsDatabaseLookupCertificatesIssuedByFinish :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) => a -> b -> m [TlsCertificate]
- data TlsDatabaseVerifyChainMethodInfo
- tlsDatabaseVerifyChain :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsSocketConnectable c, IsTlsInteraction d, IsCancellable e) => a -> b -> Text -> Maybe c -> Maybe d -> [TlsDatabaseVerifyFlags] -> Maybe e -> m [TlsCertificateFlags]
- data TlsDatabaseVerifyChainAsyncMethodInfo
- tlsDatabaseVerifyChainAsync :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsSocketConnectable c, IsTlsInteraction d, IsCancellable e) => a -> b -> Text -> Maybe c -> Maybe d -> [TlsDatabaseVerifyFlags] -> Maybe e -> Maybe AsyncReadyCallback -> m ()
- data TlsDatabaseVerifyChainFinishMethodInfo
- tlsDatabaseVerifyChainFinish :: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) => a -> b -> m [TlsCertificateFlags]
Exported types
newtype TlsDatabase Source #
GObject TlsDatabase Source # | |
IsObject TlsDatabase Source # | |
IsTlsDatabase TlsDatabase Source # | |
((~) * info (ResolveTlsDatabaseMethod t TlsDatabase), MethodInfo * info TlsDatabase p) => IsLabel t (TlsDatabase -> p) Source # | |
((~) * info (ResolveTlsDatabaseMethod t TlsDatabase), MethodInfo * info TlsDatabase p) => IsLabelProxy t (TlsDatabase -> p) Source # | |
HasAttributeList * TlsDatabase Source # | |
type AttributeList TlsDatabase Source # | |
type SignalList TlsDatabase Source # | |
class GObject o => IsTlsDatabase o Source #
toTlsDatabase :: IsTlsDatabase o => o -> IO TlsDatabase Source #
Methods
createCertificateHandle
data TlsDatabaseCreateCertificateHandleMethodInfo Source #
((~) * signature (b -> m (Maybe Text)), MonadIO m, IsTlsDatabase a, IsTlsCertificate b) => MethodInfo * TlsDatabaseCreateCertificateHandleMethodInfo a signature Source # | |
tlsDatabaseCreateCertificateHandle Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b) | |
=> a |
|
-> b |
|
-> m (Maybe Text) | Returns: a newly allocated string containing the handle. |
Create a handle string for the certificate. The database will only be able
to create a handle for certificates that originate from the database. In
cases where the database cannot create a handle for a certificate, Nothing
will be returned.
This handle should be stable across various instances of the application, and between applications. If a certificate is modified in the database, then it is not guaranteed that this handle will continue to point to it.
Since: 2.30
lookupCertificateForHandle
data TlsDatabaseLookupCertificateForHandleMethodInfo Source #
((~) * signature (Text -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> m (Maybe TlsCertificate)), MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => MethodInfo * TlsDatabaseLookupCertificateForHandleMethodInfo a signature Source # | |
tlsDatabaseLookupCertificateForHandle Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) | |
=> a |
|
-> Text |
|
-> Maybe b |
|
-> TlsDatabaseLookupFlags |
|
-> Maybe c |
|
-> m (Maybe TlsCertificate) | Returns: a newly allocated
|
Lookup a certificate by its handle.
The handle should have been created by calling
tlsDatabaseCreateCertificateHandle
on a TlsDatabase
object of
the same TLS backend. The handle is designed to remain valid across
instantiations of the database.
If the handle is no longer valid, or does not point to a certificate in
this database, then Nothing
will be returned.
This function can block, use tlsDatabaseLookupCertificateForHandleAsync
to perform
the lookup operation asynchronously.
Since: 2.30
lookupCertificateForHandleAsync
data TlsDatabaseLookupCertificateForHandleAsyncMethodInfo Source #
((~) * signature (Text -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => MethodInfo * TlsDatabaseLookupCertificateForHandleAsyncMethodInfo a signature Source # | |
tlsDatabaseLookupCertificateForHandleAsync Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) | |
=> a |
|
-> Text |
|
-> Maybe b |
|
-> TlsDatabaseLookupFlags |
|
-> Maybe c |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously lookup a certificate by its handle in the database. See
tlsDatabaseLookupCertificateForHandle
for more information.
Since: 2.30
lookupCertificateForHandleFinish
data TlsDatabaseLookupCertificateForHandleFinishMethodInfo Source #
((~) * signature (b -> m TlsCertificate), MonadIO m, IsTlsDatabase a, IsAsyncResult b) => MethodInfo * TlsDatabaseLookupCertificateForHandleFinishMethodInfo a signature Source # | |
tlsDatabaseLookupCertificateForHandleFinish Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m TlsCertificate | Returns: a newly allocated |
Finish an asynchronous lookup of a certificate by its handle. See
g_tls_database_lookup_certificate_handle()
for more information.
If the handle is no longer valid, or does not point to a certificate in
this database, then Nothing
will be returned.
Since: 2.30
lookupCertificateIssuer
data TlsDatabaseLookupCertificateIssuerMethodInfo Source #
((~) * signature (b -> Maybe c -> TlsDatabaseLookupFlags -> Maybe d -> m TlsCertificate), MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsTlsInteraction c, IsCancellable d) => MethodInfo * TlsDatabaseLookupCertificateIssuerMethodInfo a signature Source # | |
tlsDatabaseLookupCertificateIssuer Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsTlsInteraction c, IsCancellable d) | |
=> a |
|
-> b |
|
-> Maybe c |
|
-> TlsDatabaseLookupFlags |
|
-> Maybe d |
|
-> m TlsCertificate | Returns: a newly allocated issuer |
Lookup the issuer of certificate
in the database.
The issuer
property
of certificate
is not modified, and the two certificates are not hooked
into a chain.
This function can block, use tlsDatabaseLookupCertificateIssuerAsync
to perform
the lookup operation asynchronously.
Since: 2.30
lookupCertificateIssuerAsync
data TlsDatabaseLookupCertificateIssuerAsyncMethodInfo Source #
((~) * signature (b -> Maybe c -> TlsDatabaseLookupFlags -> Maybe d -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsTlsInteraction c, IsCancellable d) => MethodInfo * TlsDatabaseLookupCertificateIssuerAsyncMethodInfo a signature Source # | |
tlsDatabaseLookupCertificateIssuerAsync Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsTlsInteraction c, IsCancellable d) | |
=> a |
|
-> b |
|
-> Maybe c |
|
-> TlsDatabaseLookupFlags |
|
-> Maybe d |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously lookup the issuer of certificate
in the database. See
tlsDatabaseLookupCertificateIssuer
for more information.
Since: 2.30
lookupCertificateIssuerFinish
data TlsDatabaseLookupCertificateIssuerFinishMethodInfo Source #
((~) * signature (b -> m TlsCertificate), MonadIO m, IsTlsDatabase a, IsAsyncResult b) => MethodInfo * TlsDatabaseLookupCertificateIssuerFinishMethodInfo a signature Source # | |
tlsDatabaseLookupCertificateIssuerFinish Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m TlsCertificate | Returns: a newly allocated issuer |
Finish an asynchronous lookup issuer operation. See
tlsDatabaseLookupCertificateIssuer
for more information.
Since: 2.30
lookupCertificatesIssuedBy
data TlsDatabaseLookupCertificatesIssuedByMethodInfo Source #
((~) * signature (ByteString -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> m [TlsCertificate]), MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => MethodInfo * TlsDatabaseLookupCertificatesIssuedByMethodInfo a signature Source # | |
tlsDatabaseLookupCertificatesIssuedBy Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) | |
=> a |
|
-> ByteString |
|
-> Maybe b |
|
-> TlsDatabaseLookupFlags |
|
-> Maybe c |
|
-> m [TlsCertificate] | Returns: a newly allocated list of |
Lookup certificates issued by this issuer in the database.
This function can block, use tlsDatabaseLookupCertificatesIssuedByAsync
to perform
the lookup operation asynchronously.
Since: 2.30
lookupCertificatesIssuedByAsync
data TlsDatabaseLookupCertificatesIssuedByAsyncMethodInfo Source #
((~) * signature (ByteString -> Maybe b -> TlsDatabaseLookupFlags -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) => MethodInfo * TlsDatabaseLookupCertificatesIssuedByAsyncMethodInfo a signature Source # | |
tlsDatabaseLookupCertificatesIssuedByAsync Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsInteraction b, IsCancellable c) | |
=> a |
|
-> ByteString |
|
-> Maybe b |
|
-> TlsDatabaseLookupFlags |
|
-> Maybe c |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously lookup certificates issued by this issuer in the database. See
tlsDatabaseLookupCertificatesIssuedBy
for more information.
The database may choose to hold a reference to the issuer byte array for the duration of of this asynchronous operation. The byte array should not be modified during this time.
Since: 2.30
lookupCertificatesIssuedByFinish
data TlsDatabaseLookupCertificatesIssuedByFinishMethodInfo Source #
((~) * signature (b -> m [TlsCertificate]), MonadIO m, IsTlsDatabase a, IsAsyncResult b) => MethodInfo * TlsDatabaseLookupCertificatesIssuedByFinishMethodInfo a signature Source # | |
tlsDatabaseLookupCertificatesIssuedByFinish Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m [TlsCertificate] | Returns: a newly allocated list of |
Finish an asynchronous lookup of certificates. See
tlsDatabaseLookupCertificatesIssuedBy
for more information.
Since: 2.30
verifyChain
data TlsDatabaseVerifyChainMethodInfo Source #
((~) * signature (b -> Text -> Maybe c -> Maybe d -> [TlsDatabaseVerifyFlags] -> Maybe e -> m [TlsCertificateFlags]), MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsSocketConnectable c, IsTlsInteraction d, IsCancellable e) => MethodInfo * TlsDatabaseVerifyChainMethodInfo a signature Source # | |
tlsDatabaseVerifyChain Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsSocketConnectable c, IsTlsInteraction d, IsCancellable e) | |
=> a |
|
-> b |
|
-> Text |
|
-> Maybe c |
|
-> Maybe d |
|
-> [TlsDatabaseVerifyFlags] |
|
-> Maybe e |
|
-> m [TlsCertificateFlags] | Returns: the appropriate |
Verify's a certificate chain after looking up and adding any missing certificates to the chain.
chain
is a chain of TlsCertificate
objects each pointing to the next
certificate in the chain by its issuer
property. The chain may initially
consist of one or more certificates. After the verification process is
complete, chain
may be modified by adding missing certificates, or removing
extra certificates. If a certificate anchor was found, then it is added to
the chain
.
purpose
describes the purpose (or usage) for which the certificate
is being used. Typically purpose
will be set to TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER
which means that the certificate is being used to authenticate a server
(and we are acting as the client).
The identity
is used to check for pinned certificates (trust exceptions)
in the database. These will override the normal verification process on a
host by host basis.
Currently there are no flags
, and TlsDatabaseVerifyFlagsNone
should be
used.
This function can block, use tlsDatabaseVerifyChainAsync
to perform
the verification operation asynchronously.
Since: 2.30
verifyChainAsync
data TlsDatabaseVerifyChainAsyncMethodInfo Source #
((~) * signature (b -> Text -> Maybe c -> Maybe d -> [TlsDatabaseVerifyFlags] -> Maybe e -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsSocketConnectable c, IsTlsInteraction d, IsCancellable e) => MethodInfo * TlsDatabaseVerifyChainAsyncMethodInfo a signature Source # | |
tlsDatabaseVerifyChainAsync Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsTlsCertificate b, IsSocketConnectable c, IsTlsInteraction d, IsCancellable e) | |
=> a |
|
-> b |
|
-> Text |
|
-> Maybe c |
|
-> Maybe d |
|
-> [TlsDatabaseVerifyFlags] |
|
-> Maybe e |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously verify's a certificate chain after looking up and adding
any missing certificates to the chain. See tlsDatabaseVerifyChain
for more information.
Since: 2.30
verifyChainFinish
data TlsDatabaseVerifyChainFinishMethodInfo Source #
((~) * signature (b -> m [TlsCertificateFlags]), MonadIO m, IsTlsDatabase a, IsAsyncResult b) => MethodInfo * TlsDatabaseVerifyChainFinishMethodInfo a signature Source # | |
tlsDatabaseVerifyChainFinish Source #
:: (HasCallStack, MonadIO m, IsTlsDatabase a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m [TlsCertificateFlags] | Returns: the appropriate |
Finish an asynchronous verify chain operation. See
tlsDatabaseVerifyChain
for more information. *
Since: 2.30