Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- Overloaded methods
- emitAcceptCertificate
- getCertificate
- getDatabase
- getInteraction
- getNegotiatedProtocol
- getPeerCertificate
- getPeerCertificateErrors
- getRehandshakeMode
- getRequireCloseNotify
- getUseSystemCertdb
- handshake
- handshakeAsync
- handshakeFinish
- setAdvertisedProtocols
- 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
.
Since: 2.28
Synopsis
- newtype TlsConnection = TlsConnection (ManagedPtr TlsConnection)
- class (GObject o, IsDescendantOf TlsConnection o) => IsTlsConnection o
- toTlsConnection :: (MonadIO m, IsTlsConnection o) => o -> m TlsConnection
- tlsConnectionEmitAcceptCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) => a -> b -> [TlsCertificateFlags] -> m Bool
- tlsConnectionGetCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsCertificate
- tlsConnectionGetDatabase :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsDatabase
- tlsConnectionGetInteraction :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsInteraction
- tlsConnectionGetNegotiatedProtocol :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m (Maybe Text)
- tlsConnectionGetPeerCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsCertificate
- tlsConnectionGetPeerCertificateErrors :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m [TlsCertificateFlags]
- tlsConnectionGetRehandshakeMode :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m TlsRehandshakeMode
- tlsConnectionGetRequireCloseNotify :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m Bool
- tlsConnectionGetUseSystemCertdb :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> m Bool
- tlsConnectionHandshake :: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) => a -> Maybe b -> m ()
- tlsConnectionHandshakeAsync :: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) => a -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- tlsConnectionHandshakeFinish :: (HasCallStack, MonadIO m, IsTlsConnection a, IsAsyncResult b) => a -> b -> m ()
- tlsConnectionSetAdvertisedProtocols :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> Maybe [Text] -> m ()
- tlsConnectionSetCertificate :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) => a -> b -> m ()
- tlsConnectionSetDatabase :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsDatabase b) => a -> b -> m ()
- tlsConnectionSetInteraction :: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsInteraction b) => a -> Maybe b -> m ()
- tlsConnectionSetRehandshakeMode :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> TlsRehandshakeMode -> m ()
- tlsConnectionSetRequireCloseNotify :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> Bool -> m ()
- tlsConnectionSetUseSystemCertdb :: (HasCallStack, MonadIO m, IsTlsConnection a) => a -> Bool -> m ()
- clearTlsConnectionAdvertisedProtocols :: (MonadIO m, IsTlsConnection o) => o -> m ()
- constructTlsConnectionAdvertisedProtocols :: (IsTlsConnection o, MonadIO m) => [Text] -> m (GValueConstruct o)
- getTlsConnectionAdvertisedProtocols :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe [Text])
- setTlsConnectionAdvertisedProtocols :: (MonadIO m, IsTlsConnection o) => o -> [Text] -> m ()
- constructTlsConnectionBaseIoStream :: (IsTlsConnection o, MonadIO m, IsIOStream a) => a -> m (GValueConstruct o)
- getTlsConnectionBaseIoStream :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe IOStream)
- constructTlsConnectionCertificate :: (IsTlsConnection o, MonadIO m, IsTlsCertificate a) => a -> m (GValueConstruct o)
- getTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate
- setTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o, IsTlsCertificate a) => o -> a -> m ()
- constructTlsConnectionDatabase :: (IsTlsConnection o, MonadIO m, IsTlsDatabase a) => a -> m (GValueConstruct o)
- getTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o) => o -> m TlsDatabase
- setTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o, IsTlsDatabase a) => o -> a -> m ()
- clearTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m ()
- constructTlsConnectionInteraction :: (IsTlsConnection o, MonadIO m, IsTlsInteraction a) => a -> m (GValueConstruct o)
- getTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m TlsInteraction
- setTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o, IsTlsInteraction a) => o -> a -> m ()
- getTlsConnectionNegotiatedProtocol :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe Text)
- getTlsConnectionPeerCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate
- getTlsConnectionPeerCertificateErrors :: (MonadIO m, IsTlsConnection o) => o -> m [TlsCertificateFlags]
- constructTlsConnectionRehandshakeMode :: (IsTlsConnection o, MonadIO m) => TlsRehandshakeMode -> m (GValueConstruct o)
- getTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> m TlsRehandshakeMode
- setTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> TlsRehandshakeMode -> m ()
- constructTlsConnectionRequireCloseNotify :: (IsTlsConnection o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> m Bool
- setTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m ()
- constructTlsConnectionUseSystemCertdb :: (IsTlsConnection o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> m Bool
- setTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m ()
- type C_TlsConnectionAcceptCertificateCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt
- type TlsConnectionAcceptCertificateCallback = TlsCertificate -> [TlsCertificateFlags] -> IO Bool
- afterTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId
- genClosure_TlsConnectionAcceptCertificate :: MonadIO m => TlsConnectionAcceptCertificateCallback -> m (GClosure C_TlsConnectionAcceptCertificateCallback)
- mk_TlsConnectionAcceptCertificateCallback :: C_TlsConnectionAcceptCertificateCallback -> IO (FunPtr C_TlsConnectionAcceptCertificateCallback)
- noTlsConnectionAcceptCertificateCallback :: Maybe TlsConnectionAcceptCertificateCallback
- onTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId
- wrap_TlsConnectionAcceptCertificateCallback :: TlsConnectionAcceptCertificateCallback -> C_TlsConnectionAcceptCertificateCallback
Exported types
newtype TlsConnection Source #
Memory-managed wrapper type.
Instances
Eq TlsConnection Source # | |
Defined in GI.Gio.Objects.TlsConnection (==) :: TlsConnection -> TlsConnection -> Bool # (/=) :: TlsConnection -> TlsConnection -> Bool # | |
IsGValue TlsConnection Source # | Convert |
Defined in GI.Gio.Objects.TlsConnection toGValue :: TlsConnection -> IO GValue # fromGValue :: GValue -> IO TlsConnection # | |
ManagedPtrNewtype TlsConnection Source # | |
Defined in GI.Gio.Objects.TlsConnection | |
TypedObject TlsConnection Source # | |
Defined in GI.Gio.Objects.TlsConnection | |
GObject TlsConnection Source # | |
Defined in GI.Gio.Objects.TlsConnection | |
HasParentTypes TlsConnection Source # | |
Defined in GI.Gio.Objects.TlsConnection | |
type ParentTypes TlsConnection Source # | |
Defined in GI.Gio.Objects.TlsConnection |
class (GObject o, IsDescendantOf TlsConnection o) => IsTlsConnection o Source #
Type class for types which can be safely cast to TlsConnection
, for instance with toTlsConnection
.
Instances
(GObject o, IsDescendantOf TlsConnection o) => IsTlsConnection o Source # | |
Defined in GI.Gio.Objects.TlsConnection |
toTlsConnection :: (MonadIO m, IsTlsConnection o) => o -> m TlsConnection Source #
Cast to TlsConnection
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
emitAcceptCertificate
tlsConnectionEmitAcceptCertificate Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) | |
=> a |
|
-> b |
|
-> [TlsCertificateFlags] |
|
-> m Bool | Returns: |
Used by TlsConnection
implementations to emit the
acceptCertificate signal.
Since: 2.28
getCertificate
tlsConnectionGetCertificate Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m TlsCertificate | Returns: |
Gets conn
's certificate, as set by
tlsConnectionSetCertificate
.
Since: 2.28
getDatabase
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
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
getNegotiatedProtocol
tlsConnectionGetNegotiatedProtocol Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m (Maybe Text) | Returns: the negotiated protocol, or |
Gets the name of the application-layer protocol negotiated during the handshake.
If the peer did not use the ALPN extension, or did not advertise a
protocol that matched one of conn
's protocols, or the TLS backend
does not support ALPN, then this will be Nothing
. See
tlsConnectionSetAdvertisedProtocols
.
Since: 2.60
getPeerCertificate
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
acceptCertificate.)
Since: 2.28
getPeerCertificateErrors
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 acceptCertificate.)
Since: 2.28
getRehandshakeMode
tlsConnectionGetRehandshakeMode Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> m TlsRehandshakeMode | Returns: |
Deprecated: (Since version 2.60.)Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3.
Gets conn
rehandshaking mode. See
tlsConnectionSetRehandshakeMode
for details.
Since: 2.28
getRequireCloseNotify
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
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
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),
TlsConnection
will handle this for you automatically when you try
to send or receive data on the connection. You can call
tlsConnectionHandshake
manually if you want to know whether
the initial handshake succeeded or failed (as opposed to just
immediately trying to use conn
to read or write, in which case,
if it fails, it may not be possible to tell if it failed before or
after completing the handshake), but beware that servers may reject
client authentication after the handshake has completed, so a
successful handshake does not indicate the connection will be usable.
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.
Previously, calling tlsConnectionHandshake
after the initial
handshake would trigger a rehandshake; however, this usage was
deprecated in GLib 2.60 because rehandshaking was removed from the
TLS protocol in TLS 1.3. Since GLib 2.64, calling this function after
the initial handshake will no longer do anything.
When using a TlsConnection
created by SocketClient
, the
SocketClient
performs the initial handshake, so calling this
function manually is not recommended.
TlsConnection
::accept_certificate
may be emitted during the
handshake.
Since: 2.28
handshakeAsync
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
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
setAdvertisedProtocols
tlsConnectionSetAdvertisedProtocols Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> Maybe [Text] |
|
-> m () |
Sets the list of application-layer protocols to advertise that the
caller is willing to speak on this connection. The
Application-Layer Protocol Negotiation (ALPN) extension will be
used to negotiate a compatible protocol with the peer; use
tlsConnectionGetNegotiatedProtocol
to find the negotiated
protocol after the handshake. Specifying Nothing
for the the value
of protocols
will disable ALPN negotiation.
See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs.
Since: 2.60
setCertificate
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
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
acceptCertificate will always be emitted on
client-side connections, unless that bit is not set in
TlsClientConnection
:validation-flags
).
Since: 2.30
setInteraction
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
tlsConnectionSetRehandshakeMode Source #
:: (HasCallStack, MonadIO m, IsTlsConnection a) | |
=> a |
|
-> TlsRehandshakeMode |
|
-> m () |
Deprecated: (Since version 2.60.)Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3.
Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations.
Since: 2.28
setRequireCloseNotify
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
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
acceptCertificate will always be emitted on
client-side connections, unless that bit is not set in
TlsClientConnection
:validation-flags
).
Properties
advertisedProtocols
The list of application-layer protocols that the connection
advertises that it is willing to speak. See
tlsConnectionSetAdvertisedProtocols
.
Since: 2.60
clearTlsConnectionAdvertisedProtocols :: (MonadIO m, IsTlsConnection o) => o -> m () Source #
Set the value of the “advertised-protocols
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#advertisedProtocols
constructTlsConnectionAdvertisedProtocols :: (IsTlsConnection o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “advertised-protocols
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionAdvertisedProtocols :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe [Text]) Source #
Get the value of the “advertised-protocols
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #advertisedProtocols
setTlsConnectionAdvertisedProtocols :: (MonadIO m, IsTlsConnection o) => o -> [Text] -> m () Source #
Set the value of the “advertised-protocols
” property.
When overloading is enabled, this is equivalent to
set
tlsConnection [ #advertisedProtocols:=
value ]
baseIoStream
The IOStream
that the connection wraps. The connection holds a reference
to this stream, and may run operations on the stream from other threads
throughout its lifetime. Consequently, after the IOStream
has been
constructed, application code may only run its own operations on this
stream when no IOStream
operations are running.
Since: 2.28
constructTlsConnectionBaseIoStream :: (IsTlsConnection o, MonadIO m, IsIOStream a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “base-io-stream
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionBaseIoStream :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe IOStream) Source #
Get the value of the “base-io-stream
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #baseIoStream
certificate
The connection's certificate; see
tlsConnectionSetCertificate
.
Since: 2.28
constructTlsConnectionCertificate :: (IsTlsConnection o, MonadIO m, IsTlsCertificate a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “certificate
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate Source #
Get the value of the “certificate
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #certificate
setTlsConnectionCertificate :: (MonadIO m, IsTlsConnection o, IsTlsCertificate a) => o -> a -> m () Source #
Set the value of the “certificate
” property.
When overloading is enabled, this is equivalent to
set
tlsConnection [ #certificate:=
value ]
database
The certificate database to use when verifying this TLS connection.
If no certificate database is set, then the default database will be
used. See tlsBackendGetDefaultDatabase
.
Since: 2.30
constructTlsConnectionDatabase :: (IsTlsConnection o, MonadIO m, IsTlsDatabase a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “database
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o) => o -> m TlsDatabase Source #
Get the value of the “database
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #database
setTlsConnectionDatabase :: (MonadIO m, IsTlsConnection o, IsTlsDatabase a) => o -> a -> m () Source #
Set the value of the “database
” property.
When overloading is enabled, this is equivalent to
set
tlsConnection [ #database:=
value ]
interaction
A TlsInteraction
object to be used when the connection or certificate
database need to interact with the user. This will be used to prompt the
user for passwords where necessary.
Since: 2.30
clearTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m () Source #
Set the value of the “interaction
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#interaction
constructTlsConnectionInteraction :: (IsTlsConnection o, MonadIO m, IsTlsInteraction a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “interaction
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o) => o -> m TlsInteraction Source #
Get the value of the “interaction
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #interaction
setTlsConnectionInteraction :: (MonadIO m, IsTlsConnection o, IsTlsInteraction a) => o -> a -> m () Source #
Set the value of the “interaction
” property.
When overloading is enabled, this is equivalent to
set
tlsConnection [ #interaction:=
value ]
negotiatedProtocol
The application-layer protocol negotiated during the TLS
handshake. See tlsConnectionGetNegotiatedProtocol
.
Since: 2.60
getTlsConnectionNegotiatedProtocol :: (MonadIO m, IsTlsConnection o) => o -> m (Maybe Text) Source #
Get the value of the “negotiated-protocol
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #negotiatedProtocol
peerCertificate
The connection's peer's certificate, after the TLS handshake has completed and the certificate has been accepted. Note in particular that this is not yet set during the emission of acceptCertificate.
(You can watch for a notify signal on this property to detect when a handshake has occurred.)
Since: 2.28
getTlsConnectionPeerCertificate :: (MonadIO m, IsTlsConnection o) => o -> m TlsCertificate Source #
Get the value of the “peer-certificate
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #peerCertificate
peerCertificateErrors
The errors noticed-and-ignored while verifying
TlsConnection
:peer-certificate
. Normally this should be 0, but
it may not be if TlsClientConnection
:validation-flags
is not
TlsCertificateFlagsValidateAll
, or if
acceptCertificate overrode the default
behavior.
Since: 2.28
getTlsConnectionPeerCertificateErrors :: (MonadIO m, IsTlsConnection o) => o -> m [TlsCertificateFlags] Source #
Get the value of the “peer-certificate-errors
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #peerCertificateErrors
rehandshakeMode
The rehandshaking mode. See
tlsConnectionSetRehandshakeMode
.
Since: 2.28
constructTlsConnectionRehandshakeMode :: (IsTlsConnection o, MonadIO m) => TlsRehandshakeMode -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “rehandshake-mode
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> m TlsRehandshakeMode Source #
Get the value of the “rehandshake-mode
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #rehandshakeMode
setTlsConnectionRehandshakeMode :: (MonadIO m, IsTlsConnection o) => o -> TlsRehandshakeMode -> m () Source #
Set the value of the “rehandshake-mode
” property.
When overloading is enabled, this is equivalent to
set
tlsConnection [ #rehandshakeMode:=
value ]
requireCloseNotify
Whether or not proper TLS close notification is required.
See tlsConnectionSetRequireCloseNotify
.
Since: 2.28
constructTlsConnectionRequireCloseNotify :: (IsTlsConnection o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “require-close-notify
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> m Bool Source #
Get the value of the “require-close-notify
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #requireCloseNotify
setTlsConnectionRequireCloseNotify :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m () Source #
Set the value of the “require-close-notify
” property.
When overloading is enabled, this is equivalent to
set
tlsConnection [ #requireCloseNotify:=
value ]
useSystemCertdb
Whether or not the system certificate database will be used to
verify peer certificates. See
tlsConnectionSetUseSystemCertdb
.
constructTlsConnectionUseSystemCertdb :: (IsTlsConnection o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “use-system-certdb
” property. This is rarely needed directly, but it is used by new
.
getTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> m Bool Source #
Get the value of the “use-system-certdb
” property.
When overloading is enabled, this is equivalent to
get
tlsConnection #useSystemCertdb
setTlsConnectionUseSystemCertdb :: (MonadIO m, IsTlsConnection o) => o -> Bool -> m () Source #
Set the value of the “use-system-certdb
” property.
When overloading is enabled, this is equivalent to
set
tlsConnection [ #useSystemCertdb:=
value ]
Signals
acceptCertificate
type C_TlsConnectionAcceptCertificateCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type TlsConnectionAcceptCertificateCallback Source #
= TlsCertificate |
|
-> [TlsCertificateFlags] |
|
-> IO Bool | Returns: |
Emitted during the TLS handshake after the peer certificate has
been received. You can examine peerCert
's certification path by
calling tlsCertificateGetIssuer
on it.
For a client-side connection, peerCert
is the server's
certificate, and the signal will only be emitted if the
certificate was not acceptable according to conn
's
TlsClientConnection
:validation_flags
. If you would like the
certificate to be accepted despite errors
, return True
from the
signal handler. Otherwise, if no handler accepts the certificate,
the handshake will fail with TlsErrorBadCertificate
.
For a server-side connection, peerCert
is the certificate
presented by the client, if this was requested via the server's
TlsServerConnection
:authentication_mode
. On the server side,
the signal is always emitted when the client presents a
certificate, and the certificate will only be accepted if a
handler returns True
.
Note that if this signal is emitted as part of asynchronous I/O
in the main thread, then you should not attempt to interact with
the user before returning from the signal handler. If you want to
let the user decide whether or not to accept the certificate, you
would have to return False
from the signal handler on the first
attempt, and then after the connection attempt returns a
TlsErrorBadCertificate
, you can interact with the user, and
if the user decides to accept the certificate, remember that fact,
create a new connection, and return True
from the signal handler
the next time.
If you are doing I/O in another thread, you do not need to worry about this, and can simply block in the signal handler until the UI thread returns an answer.
Since: 2.28
afterTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId Source #
Connect a signal handler for the acceptCertificate signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
tlsConnection #acceptCertificate callback
genClosure_TlsConnectionAcceptCertificate :: MonadIO m => TlsConnectionAcceptCertificateCallback -> m (GClosure C_TlsConnectionAcceptCertificateCallback) Source #
Wrap the callback into a GClosure
.
mk_TlsConnectionAcceptCertificateCallback :: C_TlsConnectionAcceptCertificateCallback -> IO (FunPtr C_TlsConnectionAcceptCertificateCallback) Source #
Generate a function pointer callable from C code, from a C_TlsConnectionAcceptCertificateCallback
.
noTlsConnectionAcceptCertificateCallback :: Maybe TlsConnectionAcceptCertificateCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TlsConnectionAcceptCertificateCallback
onTlsConnectionAcceptCertificate :: (IsTlsConnection a, MonadIO m) => a -> TlsConnectionAcceptCertificateCallback -> m SignalHandlerId Source #
Connect a signal handler for the acceptCertificate signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
tlsConnection #acceptCertificate callback