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
- emitAcceptCertificate
- getCertificate
- getDatabase
- getInteraction
- getPeerCertificate
- getPeerCertificateErrors
- getRehandshakeMode
- getRequireCloseNotify
- getUseSystemCertdb
- handshake
- handshakeAsync
- handshakeFinish
- setCertificate
- setDatabase
- setInteraction
- setRehandshakeMode
- setRequireCloseNotify
- setUseSystemCertdb
- Properties
- Signals
TlsConnection
is the base TLS connection class type, which wraps
a IOStream
and provides TLS encryption on top of it. Its
subclasses, TlsClientConnection
and TlsServerConnection
,
implement client-side and server-side TLS, respectively.
For DTLS (Datagram TLS) support, see DtlsConnection
.
- newtype TlsConnection = TlsConnection (ManagedPtr TlsConnection)
- class GObject o => IsTlsConnection o
- toTlsConnection :: IsTlsConnection o => o -> IO TlsConnection
- noTlsConnection :: Maybe TlsConnection
- data TlsConnectionEmitAcceptCertificateMethodInfo
- tlsConnectionEmitAcceptCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) => a -> b -> [TlsCertificateFlags] -> m Bool
- data TlsConnectionGetCertificateMethodInfo
- tlsConnectionGetCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsCertificate
- data TlsConnectionGetDatabaseMethodInfo
- tlsConnectionGetDatabase :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsDatabase
- data TlsConnectionGetInteractionMethodInfo
- tlsConnectionGetInteraction :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsInteraction
- data TlsConnectionGetPeerCertificateMethodInfo
- tlsConnectionGetPeerCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsCertificate
- data TlsConnectionGetPeerCertificateErrorsMethodInfo
- tlsConnectionGetPeerCertificateErrors :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m [TlsCertificateFlags]
- data TlsConnectionGetRehandshakeModeMethodInfo
- tlsConnectionGetRehandshakeMode :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsRehandshakeMode
- data TlsConnectionGetRequireCloseNotifyMethodInfo
- tlsConnectionGetRequireCloseNotify :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m Bool
- data TlsConnectionGetUseSystemCertdbMethodInfo
- tlsConnectionGetUseSystemCertdb :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m Bool
- data TlsConnectionHandshakeMethodInfo
- tlsConnectionHandshake :: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) => a -> Maybe b -> m ()
- data TlsConnectionHandshakeAsyncMethodInfo
- tlsConnectionHandshakeAsync :: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) => a -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data TlsConnectionHandshakeFinishMethodInfo
- tlsConnectionHandshakeFinish :: (HasCallStack, MonadIO m, IsTlsConnection a, IsAsyncResult b) => a -> b -> m ()
- data TlsConnectionSetCertificateMethodInfo
- tlsConnectionSetCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) => a -> b -> m ()
- data TlsConnectionSetDatabaseMethodInfo
- tlsConnectionSetDatabase :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsDatabase b) => a -> b -> m ()
- data TlsConnectionSetInteractionMethodInfo
- tlsConnectionSetInteraction :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsInteraction b) => a -> Maybe b -> m ()
- data TlsConnectionSetRehandshakeModeMethodInfo
- tlsConnectionSetRehandshakeMode :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> TlsRehandshakeMode -> m ()
- data TlsConnectionSetRequireCloseNotifyMethodInfo
- tlsConnectionSetRequireCloseNotify :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> Bool -> m ()
- data TlsConnectionSetUseSystemCertdbMethodInfo
- tlsConnectionSetUseSystemCertdb :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> Bool -> m ()
- data TlsConnectionBaseIoStreamPropertyInfo
- constructTlsConnectionBaseIoStream :: (IsTlsConnection o, IsIOStream a) => a -> IO (GValueConstruct o)
- getTlsConnectionBaseIoStream :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe IOStream)
- tlsConnectionBaseIoStream :: AttrLabelProxy "baseIoStream"
- data TlsConnectionCertificatePropertyInfo
- constructTlsConnectionCertificate :: (IsTlsConnection o, IsTlsCertificate a) => a -> IO (GValueConstruct o)
- getTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate
- setTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o, IsTlsCertificate a) => o -> a -> m ()
- tlsConnectionCertificate :: AttrLabelProxy "certificate"
- data TlsConnectionDatabasePropertyInfo
- constructTlsConnectionDatabase :: (IsTlsConnection o, IsTlsDatabase a) => a -> IO (GValueConstruct o)
- getTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o) => o -> m TlsDatabase
- setTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o, IsTlsDatabase a) => o -> a -> m ()
- tlsConnectionDatabase :: AttrLabelProxy "database"
- data TlsConnectionInteractionPropertyInfo
- clearTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m ()
- constructTlsConnectionInteraction :: (IsTlsConnection o, IsTlsInteraction a) => a -> IO (GValueConstruct o)
- getTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m TlsInteraction
- setTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o, IsTlsInteraction a) => o -> a -> m ()
- tlsConnectionInteraction :: AttrLabelProxy "interaction"
- data TlsConnectionPeerCertificatePropertyInfo
- getTlsConnectionPeerCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate
- tlsConnectionPeerCertificate :: AttrLabelProxy "peerCertificate"
- data TlsConnectionPeerCertificateErrorsPropertyInfo
- getTlsConnectionPeerCertificateErrors :: (MonadIO m, IsTlsConnection o) => o -> m [TlsCertificateFlags]
- tlsConnectionPeerCertificateErrors :: AttrLabelProxy "peerCertificateErrors"
- data TlsConnectionRehandshakeModePropertyInfo
- constructTlsConnectionRehandshakeMode :: IsTlsConnection o => TlsRehandshakeMode -> IO (GValueConstruct o)
- getTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> m TlsRehandshakeMode
- setTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> TlsRehandshakeMode -> m ()
- tlsConnectionRehandshakeMode :: AttrLabelProxy "rehandshakeMode"
- data TlsConnectionRequireCloseNotifyPropertyInfo
- constructTlsConnectionRequireCloseNotify :: IsTlsConnection o => Bool -> IO (GValueConstruct o)
- getTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> m Bool
- setTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m ()
- tlsConnectionRequireCloseNotify :: AttrLabelProxy "requireCloseNotify"
- data TlsConnectionUseSystemCertdbPropertyInfo
- constructTlsConnectionUseSystemCertdb :: IsTlsConnection o => Bool -> IO (GValueConstruct o)
- getTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> m Bool
- setTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m ()
- tlsConnectionUseSystemCertdb :: AttrLabelProxy "useSystemCertdb"
- type C_TlsConnectionAcceptCertificateCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt
- type TlsConnectionAcceptCertificateCallback = TlsCertificate -> [TlsCertificateFlags] -> IO Bool
- data TlsConnectionAcceptCertificateSignalInfo
- afterTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId
- genClosure_TlsConnectionAcceptCertificate :: TlsConnectionAcceptCertificateCallback -> IO Closure
- mk_TlsConnectionAcceptCertificateCallback :: C_TlsConnectionAcceptCertificateCallback -> IO (FunPtr C_TlsConnectionAcceptCertificateCallback)
- noTlsConnectionAcceptCertificateCallback :: Maybe TlsConnectionAcceptCertificateCallback
- onTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId
- wrap_TlsConnectionAcceptCertificateCallback :: TlsConnectionAcceptCertificateCallback -> Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt
Exported types
newtype TlsConnection Source #
GObject TlsConnection Source # | |
IsObject TlsConnection Source # | |
IsTlsConnection TlsConnection Source # | |
IsIOStream TlsConnection Source # | |
((~) * info (ResolveTlsConnectionMethod t TlsConnection), MethodInfo * info TlsConnection p) => IsLabel t (TlsConnection -> p) Source # | |
((~) * info (ResolveTlsConnectionMethod t TlsConnection), MethodInfo * info TlsConnection p) => IsLabelProxy t (TlsConnection -> p) Source # | |
HasAttributeList * TlsConnection Source # | |
type AttributeList TlsConnection Source # | |
type SignalList TlsConnection Source # | |
class GObject o => IsTlsConnection o Source #
toTlsConnection :: IsTlsConnection o => o -> IO TlsConnection Source #
Methods
emitAcceptCertificate
data TlsConnectionEmitAcceptCertificateMethodInfo Source #
((~) * signature (b -> [TlsCertificateFlags] -> m Bool), MonadIO m, IsTlsConnection a, IsTlsCertificate b) => MethodInfo * TlsConnectionEmitAcceptCertificateMethodInfo a signature Source # | |
tlsConnectionEmitAcceptCertificate Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) | |
=> a |
|
-> b |
|
-> [TlsCertificateFlags] |
|
-> m Bool | Returns: |
Used by TlsConnection
implementations to emit the
TlsConnection
::accept-certificate
signal.
Since: 2.28
getCertificate
data TlsConnectionGetCertificateMethodInfo Source #
((~) * signature (m TlsCertificate), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetCertificateMethodInfo a signature Source # | |
tlsConnectionGetCertificate Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m TlsCertificate | Returns: |
Gets conn
's certificate, as set by
tlsConnectionSetCertificate
.
Since: 2.28
getDatabase
data TlsConnectionGetDatabaseMethodInfo Source #
((~) * signature (m TlsDatabase), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetDatabaseMethodInfo a signature Source # | |
tlsConnectionGetDatabase Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m TlsDatabase | Returns: the certificate database that |
Gets the certificate database that conn
uses to verify
peer certificates. See tlsConnectionSetDatabase
.
Since: 2.30
getInteraction
data TlsConnectionGetInteractionMethodInfo Source #
((~) * signature (m TlsInteraction), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetInteractionMethodInfo a signature Source # | |
tlsConnectionGetInteraction Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> 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.30
getPeerCertificate
data TlsConnectionGetPeerCertificateMethodInfo Source #
((~) * signature (m TlsCertificate), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetPeerCertificateMethodInfo a signature Source # | |
tlsConnectionGetPeerCertificate Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m TlsCertificate | Returns: |
Gets conn
's peer's certificate after the handshake has completed.
(It is not set during the emission of
TlsConnection
::accept-certificate
.)
Since: 2.28
getPeerCertificateErrors
data TlsConnectionGetPeerCertificateErrorsMethodInfo Source #
((~) * signature (m [TlsCertificateFlags]), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetPeerCertificateErrorsMethodInfo a signature Source # | |
tlsConnectionGetPeerCertificateErrors Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m [TlsCertificateFlags] | Returns: |
Gets the errors associated with validating conn
's peer's
certificate, after the handshake has completed. (It is not set
during the emission of TlsConnection
::accept-certificate
.)
Since: 2.28
getRehandshakeMode
data TlsConnectionGetRehandshakeModeMethodInfo Source #
((~) * signature (m TlsRehandshakeMode), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetRehandshakeModeMethodInfo a signature Source # | |
tlsConnectionGetRehandshakeMode Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m TlsRehandshakeMode | Returns: |
Gets conn
rehandshaking mode. See
tlsConnectionSetRehandshakeMode
for details.
Since: 2.28
getRequireCloseNotify
data TlsConnectionGetRequireCloseNotifyMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetRequireCloseNotifyMethodInfo a signature Source # | |
tlsConnectionGetRequireCloseNotify Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m Bool | Returns: |
Tests whether or not conn
expects a proper TLS close notification
when the connection is closed. See
tlsConnectionSetRequireCloseNotify
for details.
Since: 2.28
getUseSystemCertdb
data TlsConnectionGetUseSystemCertdbMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionGetUseSystemCertdbMethodInfo a signature Source # | |
tlsConnectionGetUseSystemCertdb Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m Bool | Returns: whether |
Deprecated: (Since version 2.30)Use tlsConnectionGetDatabase
instead
Gets whether conn
uses the system certificate database to verify
peer certificates. See tlsConnectionSetUseSystemCertdb
.
handshake
data TlsConnectionHandshakeMethodInfo Source #
((~) * signature (Maybe b -> m ()), MonadIO m, IsTlsConnection a, IsCancellable b) => MethodInfo * TlsConnectionHandshakeMethodInfo a signature Source # | |
tlsConnectionHandshake Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> m () | (Can throw |
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,
TlsConnection
will handle this for you automatically when you try
to send or receive data on the connection. However, you can call
tlsConnectionHandshake
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
's output stream, 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 tlsConnectionHandshake
later on to
renegotiate parameters (encryption methods, etc) with the client.
TlsConnection
::accept_certificate
may be emitted during the
handshake.
Since: 2.28
handshakeAsync
data TlsConnectionHandshakeAsyncMethodInfo Source #
((~) * signature (Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsTlsConnection a, IsCancellable b) => MethodInfo * TlsConnectionHandshakeAsyncMethodInfo a signature Source # | |
tlsConnectionHandshakeAsync Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) | |
=> a |
|
-> Int32 |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously performs a TLS handshake on conn
. See
tlsConnectionHandshake
for more information.
Since: 2.28
handshakeFinish
data TlsConnectionHandshakeFinishMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsTlsConnection a, IsAsyncResult b) => MethodInfo * TlsConnectionHandshakeFinishMethodInfo a signature Source # | |
tlsConnectionHandshakeFinish Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Finish an asynchronous TLS handshake operation. See
tlsConnectionHandshake
for more information.
Since: 2.28
setCertificate
data TlsConnectionSetCertificateMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsTlsConnection a, IsTlsCertificate b) => MethodInfo * TlsConnectionSetCertificateMethodInfo a signature Source # | |
tlsConnectionSetCertificate Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) | |
=> a |
|
-> b |
|
-> m () |
This sets the certificate that conn
will present to its peer
during the TLS handshake. For a TlsServerConnection
, it is
mandatory to set this, and that will normally be done at construct
time.
For a TlsClientConnection
, 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
tlsClientConnectionGetAcceptedCas
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 tlsClientConnectionGetAcceptedCas
will return
non-Nothing
.)
Since: 2.28
setDatabase
data TlsConnectionSetDatabaseMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsTlsConnection a, IsTlsDatabase b) => MethodInfo * TlsConnectionSetDatabaseMethodInfo a signature Source # | |
tlsConnectionSetDatabase Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsDatabase b) | |
=> a |
|
-> b |
|
-> 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
TlsConnection
::accept-certificate
will always be emitted on
client-side connections, unless that bit is not set in
TlsClientConnection
:validation-flags
).
Since: 2.30
setInteraction
data TlsConnectionSetInteractionMethodInfo Source #
((~) * signature (Maybe b -> m ()), MonadIO m, IsTlsConnection a, IsTlsInteraction b) => MethodInfo * TlsConnectionSetInteractionMethodInfo a signature Source # | |
tlsConnectionSetInteraction Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsInteraction b) | |
=> a |
|
-> Maybe b |
|
-> 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.30
setRehandshakeMode
data TlsConnectionSetRehandshakeModeMethodInfo Source #
((~) * signature (TlsRehandshakeMode -> m ()), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionSetRehandshakeModeMethodInfo a signature Source # | |
tlsConnectionSetRehandshakeMode Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> TlsRehandshakeMode |
|
-> 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.28
setRequireCloseNotify
data TlsConnectionSetRequireCloseNotifyMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionSetRequireCloseNotifyMethodInfo a signature Source # | |
tlsConnectionSetRequireCloseNotify Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> Bool |
|
-> 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 sometimes omitted. (TLS 1.1 explicitly allows this;
in TLS 1.0 it is technically an error, but often done anyway.) You
can use tlsConnectionSetRequireCloseNotify
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
SocketConnection
, 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 iOStreamClose
itself
on conn
, 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 TlsConnection
:base-io-stream
rather
than closing conn
itself, but note that this may only be done when no other
operations are pending on conn
or the base I/O stream.
Since: 2.28
setUseSystemCertdb
data TlsConnectionSetUseSystemCertdbMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsTlsConnection a) => MethodInfo * TlsConnectionSetUseSystemCertdbMethodInfo a signature Source # | |
tlsConnectionSetUseSystemCertdb Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 2.30)Use tlsConnectionSetDatabase
instead
Sets whether conn
uses the system certificate database to verify
peer certificates. This is True
by default. If set to False
, then
peer certificate validation will always set the
TlsCertificateFlagsUnknownCa
error (meaning
TlsConnection
::accept-certificate
will always be emitted on
client-side connections, unless that bit is not set in
TlsClientConnection
:validation-flags
).
Properties
baseIoStream
data TlsConnectionBaseIoStreamPropertyInfo Source #
constructTlsConnectionBaseIoStream :: (IsTlsConnection o, IsIOStream a) => a -> IO (GValueConstruct o) Source #
getTlsConnectionBaseIoStream :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe IOStream) Source #
tlsConnectionBaseIoStream :: AttrLabelProxy "baseIoStream" Source #
certificate
data TlsConnectionCertificatePropertyInfo Source #
constructTlsConnectionCertificate :: (IsTlsConnection o, IsTlsCertificate a) => a -> IO (GValueConstruct o) Source #
getTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate Source #
setTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o, IsTlsCertificate a) => o -> a -> m () Source #
tlsConnectionCertificate :: AttrLabelProxy "certificate" Source #
database
data TlsConnectionDatabasePropertyInfo Source #
constructTlsConnectionDatabase :: (IsTlsConnection o, IsTlsDatabase a) => a -> IO (GValueConstruct o) Source #
getTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o) => o -> m TlsDatabase Source #
setTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o, IsTlsDatabase a) => o -> a -> m () Source #
tlsConnectionDatabase :: AttrLabelProxy "database" Source #
interaction
data TlsConnectionInteractionPropertyInfo Source #
clearTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m () Source #
constructTlsConnectionInteraction :: (IsTlsConnection o, IsTlsInteraction a) => a -> IO (GValueConstruct o) Source #
getTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m TlsInteraction Source #
setTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o, IsTlsInteraction a) => o -> a -> m () Source #
tlsConnectionInteraction :: AttrLabelProxy "interaction" Source #
peerCertificate
data TlsConnectionPeerCertificatePropertyInfo Source #
getTlsConnectionPeerCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate Source #
tlsConnectionPeerCertificate :: AttrLabelProxy "peerCertificate" Source #
peerCertificateErrors
data TlsConnectionPeerCertificateErrorsPropertyInfo Source #
getTlsConnectionPeerCertificateErrors :: (MonadIO m, IsTlsConnection o) => o -> m [TlsCertificateFlags] Source #
tlsConnectionPeerCertificateErrors :: AttrLabelProxy "peerCertificateErrors" Source #
rehandshakeMode
data TlsConnectionRehandshakeModePropertyInfo Source #
constructTlsConnectionRehandshakeMode :: IsTlsConnection o => TlsRehandshakeMode -> IO (GValueConstruct o) Source #
getTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> m TlsRehandshakeMode Source #
setTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> TlsRehandshakeMode -> m () Source #
tlsConnectionRehandshakeMode :: AttrLabelProxy "rehandshakeMode" Source #
requireCloseNotify
data TlsConnectionRequireCloseNotifyPropertyInfo Source #
constructTlsConnectionRequireCloseNotify :: IsTlsConnection o => Bool -> IO (GValueConstruct o) Source #
getTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> m Bool Source #
setTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m () Source #
tlsConnectionRequireCloseNotify :: AttrLabelProxy "requireCloseNotify" Source #
useSystemCertdb
data TlsConnectionUseSystemCertdbPropertyInfo Source #
constructTlsConnectionUseSystemCertdb :: IsTlsConnection o => Bool -> IO (GValueConstruct o) Source #
getTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> m Bool Source #
setTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m () Source #
tlsConnectionUseSystemCertdb :: AttrLabelProxy "useSystemCertdb" Source #
Signals
acceptCertificate
type C_TlsConnectionAcceptCertificateCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt Source #
type TlsConnectionAcceptCertificateCallback = TlsCertificate -> [TlsCertificateFlags] -> IO Bool Source #
afterTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId Source #
genClosure_TlsConnectionAcceptCertificate :: TlsConnectionAcceptCertificateCallback -> IO Closure Source #
mk_TlsConnectionAcceptCertificateCallback :: C_TlsConnectionAcceptCertificateCallback -> IO (FunPtr C_TlsConnectionAcceptCertificateCallback) Source #
onTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId Source #
wrap_TlsConnectionAcceptCertificateCallback :: TlsConnectionAcceptCertificateCallback -> Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt Source #