Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gio.Interfaces.DtlsConnection
Contents
- Exported types
- Methods
- close
- closeAsync
- closeFinish
- emitAcceptCertificate
- getCertificate
- getChannelBindingData
- getCiphersuiteName
- getDatabase
- getInteraction
- getNegotiatedProtocol
- getPeerCertificate
- getPeerCertificateErrors
- getProtocolVersion
- getRehandshakeMode
- getRequireCloseNotify
- handshake
- handshakeAsync
- handshakeFinish
- setAdvertisedProtocols
- setCertificate
- setDatabase
- setInteraction
- setRehandshakeMode
- setRequireCloseNotify
- shutdown
- shutdownAsync
- shutdownFinish
- Properties
- Signals
Description
GDtlsConnection
is the base DTLS connection class type, which wraps
a DatagramBased
and provides DTLS encryption on top of it. Its
subclasses, DtlsClientConnection
and
DtlsServerConnection
, implement client-side and server-side DTLS,
respectively.
For TLS support, see TlsConnection
.
As DTLS is datagram based, GDtlsConnection
implements
DatagramBased
, presenting a datagram-socket-like API for the
encrypted connection. This operates over a base datagram connection, which is
also a GDatagramBased
(DtlsConnection:baseSocket).
To close a DTLS connection, use dtlsConnectionClose
.
Neither DtlsServerConnection
or DtlsClientConnection
set the peer address on their base DatagramBased
if it is a
Socket
— it is up to the caller to do that if they wish. If they
do not, and socketClose
is called on the base socket, the
GDtlsConnection
will not raise a G_IO_ERROR_NOT_CONNECTED
error on
further I/O.
Since: 2.48
Synopsis
- newtype DtlsConnection = DtlsConnection (ManagedPtr DtlsConnection)
- class (GObject o, IsDescendantOf DtlsConnection o) => IsDtlsConnection o
- toDtlsConnection :: (MonadIO m, IsDtlsConnection o) => o -> m DtlsConnection
- type family ResolveDtlsConnectionMethod (t :: Symbol) o where ...
- data DtlsConnectionCloseMethodInfo
- dtlsConnectionClose :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Maybe b -> m ()
- data DtlsConnectionCloseAsyncMethodInfo
- dtlsConnectionCloseAsync :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data DtlsConnectionCloseFinishMethodInfo
- dtlsConnectionCloseFinish :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) => a -> b -> m ()
- data DtlsConnectionEmitAcceptCertificateMethodInfo
- dtlsConnectionEmitAcceptCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) => a -> b -> [TlsCertificateFlags] -> m Bool
- data DtlsConnectionGetCertificateMethodInfo
- dtlsConnectionGetCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m (Maybe TlsCertificate)
- data DtlsConnectionGetChannelBindingDataMethodInfo
- dtlsConnectionGetChannelBindingData :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> TlsChannelBindingType -> m ByteString
- data DtlsConnectionGetCiphersuiteNameMethodInfo
- dtlsConnectionGetCiphersuiteName :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m (Maybe Text)
- data DtlsConnectionGetDatabaseMethodInfo
- dtlsConnectionGetDatabase :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m (Maybe TlsDatabase)
- data DtlsConnectionGetInteractionMethodInfo
- dtlsConnectionGetInteraction :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m (Maybe TlsInteraction)
- data DtlsConnectionGetNegotiatedProtocolMethodInfo
- dtlsConnectionGetNegotiatedProtocol :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m (Maybe Text)
- data DtlsConnectionGetPeerCertificateMethodInfo
- dtlsConnectionGetPeerCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m (Maybe TlsCertificate)
- data DtlsConnectionGetPeerCertificateErrorsMethodInfo
- dtlsConnectionGetPeerCertificateErrors :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m [TlsCertificateFlags]
- data DtlsConnectionGetProtocolVersionMethodInfo
- dtlsConnectionGetProtocolVersion :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m TlsProtocolVersion
- data DtlsConnectionGetRehandshakeModeMethodInfo
- dtlsConnectionGetRehandshakeMode :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m TlsRehandshakeMode
- data DtlsConnectionGetRequireCloseNotifyMethodInfo
- dtlsConnectionGetRequireCloseNotify :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> m Bool
- data DtlsConnectionHandshakeMethodInfo
- dtlsConnectionHandshake :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Maybe b -> m ()
- data DtlsConnectionHandshakeAsyncMethodInfo
- dtlsConnectionHandshakeAsync :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data DtlsConnectionHandshakeFinishMethodInfo
- dtlsConnectionHandshakeFinish :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) => a -> b -> m ()
- data DtlsConnectionSetAdvertisedProtocolsMethodInfo
- dtlsConnectionSetAdvertisedProtocols :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> Maybe [Text] -> m ()
- data DtlsConnectionSetCertificateMethodInfo
- dtlsConnectionSetCertificate :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) => a -> b -> m ()
- data DtlsConnectionSetDatabaseMethodInfo
- dtlsConnectionSetDatabase :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsDatabase b) => a -> Maybe b -> m ()
- data DtlsConnectionSetInteractionMethodInfo
- dtlsConnectionSetInteraction :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsInteraction b) => a -> Maybe b -> m ()
- data DtlsConnectionSetRehandshakeModeMethodInfo
- dtlsConnectionSetRehandshakeMode :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> TlsRehandshakeMode -> m ()
- data DtlsConnectionSetRequireCloseNotifyMethodInfo
- dtlsConnectionSetRequireCloseNotify :: (HasCallStack, MonadIO m, IsDtlsConnection a) => a -> Bool -> m ()
- data DtlsConnectionShutdownMethodInfo
- dtlsConnectionShutdown :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Bool -> Bool -> Maybe b -> m ()
- data DtlsConnectionShutdownAsyncMethodInfo
- dtlsConnectionShutdownAsync :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) => a -> Bool -> Bool -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data DtlsConnectionShutdownFinishMethodInfo
- dtlsConnectionShutdownFinish :: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) => a -> b -> m ()
- data DtlsConnectionAdvertisedProtocolsPropertyInfo
- clearDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m ()
- constructDtlsConnectionAdvertisedProtocols :: (IsDtlsConnection o, MonadIO m) => [Text] -> m (GValueConstruct o)
- dtlsConnectionAdvertisedProtocols :: AttrLabelProxy "advertisedProtocols"
- getDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe [Text])
- setDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> [Text] -> m ()
- data DtlsConnectionBaseSocketPropertyInfo
- constructDtlsConnectionBaseSocket :: (IsDtlsConnection o, MonadIO m, IsDatagramBased a) => a -> m (GValueConstruct o)
- dtlsConnectionBaseSocket :: AttrLabelProxy "baseSocket"
- getDtlsConnectionBaseSocket :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe DatagramBased)
- data DtlsConnectionCertificatePropertyInfo
- constructDtlsConnectionCertificate :: (IsDtlsConnection o, MonadIO m, IsTlsCertificate a) => a -> m (GValueConstruct o)
- dtlsConnectionCertificate :: AttrLabelProxy "certificate"
- getDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsCertificate)
- setDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o, IsTlsCertificate a) => o -> a -> m ()
- data DtlsConnectionCiphersuiteNamePropertyInfo
- dtlsConnectionCiphersuiteName :: AttrLabelProxy "ciphersuiteName"
- getDtlsConnectionCiphersuiteName :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe Text)
- data DtlsConnectionDatabasePropertyInfo
- clearDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o) => o -> m ()
- constructDtlsConnectionDatabase :: (IsDtlsConnection o, MonadIO m, IsTlsDatabase a) => a -> m (GValueConstruct o)
- dtlsConnectionDatabase :: AttrLabelProxy "database"
- getDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsDatabase)
- setDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o, IsTlsDatabase a) => o -> a -> m ()
- data DtlsConnectionInteractionPropertyInfo
- clearDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m ()
- constructDtlsConnectionInteraction :: (IsDtlsConnection o, MonadIO m, IsTlsInteraction a) => a -> m (GValueConstruct o)
- dtlsConnectionInteraction :: AttrLabelProxy "interaction"
- getDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsInteraction)
- setDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o, IsTlsInteraction a) => o -> a -> m ()
- data DtlsConnectionNegotiatedProtocolPropertyInfo
- dtlsConnectionNegotiatedProtocol :: AttrLabelProxy "negotiatedProtocol"
- getDtlsConnectionNegotiatedProtocol :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe Text)
- data DtlsConnectionPeerCertificatePropertyInfo
- dtlsConnectionPeerCertificate :: AttrLabelProxy "peerCertificate"
- getDtlsConnectionPeerCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsCertificate)
- data DtlsConnectionPeerCertificateErrorsPropertyInfo
- dtlsConnectionPeerCertificateErrors :: AttrLabelProxy "peerCertificateErrors"
- getDtlsConnectionPeerCertificateErrors :: (MonadIO m, IsDtlsConnection o) => o -> m [TlsCertificateFlags]
- data DtlsConnectionProtocolVersionPropertyInfo
- dtlsConnectionProtocolVersion :: AttrLabelProxy "protocolVersion"
- getDtlsConnectionProtocolVersion :: (MonadIO m, IsDtlsConnection o) => o -> m TlsProtocolVersion
- data DtlsConnectionRehandshakeModePropertyInfo
- constructDtlsConnectionRehandshakeMode :: (IsDtlsConnection o, MonadIO m) => TlsRehandshakeMode -> m (GValueConstruct o)
- dtlsConnectionRehandshakeMode :: AttrLabelProxy "rehandshakeMode"
- getDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> m TlsRehandshakeMode
- setDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> TlsRehandshakeMode -> m ()
- data DtlsConnectionRequireCloseNotifyPropertyInfo
- constructDtlsConnectionRequireCloseNotify :: (IsDtlsConnection o, MonadIO m) => Bool -> m (GValueConstruct o)
- dtlsConnectionRequireCloseNotify :: AttrLabelProxy "requireCloseNotify"
- getDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> m Bool
- setDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> Bool -> m ()
- type DtlsConnectionAcceptCertificateCallback = TlsCertificate -> [TlsCertificateFlags] -> IO Bool
- data DtlsConnectionAcceptCertificateSignalInfo
- afterDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> ((?self :: a) => DtlsConnectionAcceptCertificateCallback) -> m SignalHandlerId
- onDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> ((?self :: a) => DtlsConnectionAcceptCertificateCallback) -> m SignalHandlerId
Exported types
newtype DtlsConnection Source #
Memory-managed wrapper type.
Constructors
DtlsConnection (ManagedPtr DtlsConnection) |
Instances
class (GObject o, IsDescendantOf DtlsConnection o) => IsDtlsConnection o Source #
Type class for types which can be safely cast to DtlsConnection
, for instance with toDtlsConnection
.
Instances
(GObject o, IsDescendantOf DtlsConnection o) => IsDtlsConnection o Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection |
toDtlsConnection :: (MonadIO m, IsDtlsConnection o) => o -> m DtlsConnection Source #
Cast to DtlsConnection
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, close, closeAsync, closeFinish, conditionCheck, conditionWait, createSource, emitAcceptCertificate, forceFloating, freezeNotify, getv, handshake, handshakeAsync, handshakeFinish, isFloating, notify, notifyByPspec, receiveMessages, ref, refSink, runDispose, sendMessages, shutdown, shutdownAsync, shutdownFinish, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCertificate, getChannelBindingData, getCiphersuiteName, getData, getDatabase, getInteraction, getNegotiatedProtocol, getPeerCertificate, getPeerCertificateErrors, getProperty, getProtocolVersion, getQdata, getRehandshakeMode, getRequireCloseNotify.
Setters
setAdvertisedProtocols, setCertificate, setData, setDataFull, setDatabase, setInteraction, setProperty, setRehandshakeMode, setRequireCloseNotify.
type family ResolveDtlsConnectionMethod (t :: Symbol) o where ... Source #
Equations
close
data DtlsConnectionCloseMethodInfo Source #
Instances
(signature ~ (Maybe b -> m ()), MonadIO m, IsDtlsConnection a, IsCancellable b) => OverloadedMethod DtlsConnectionCloseMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionCloseMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> m () | (Can throw |
Close the DTLS connection. This is equivalent to calling
dtlsConnectionShutdown
to shut down both sides of the connection.
Closing a DtlsConnection
waits for all buffered but untransmitted data to
be sent before it completes. It then sends a close_notify
DTLS alert to the
peer and may wait for a close_notify
to be received from the peer. It does
not close the underlying DtlsConnection:baseSocket; that must be closed
separately.
Once conn
is closed, all other operations will return IOErrorEnumClosed
.
Closing a DtlsConnection
multiple times will not return an error.
GDtlsConnections
will be automatically closed when the last reference is
dropped, but you might want to call this function to make sure resources are
released as early as possible.
If cancellable
is cancelled, the DtlsConnection
may be left
partially-closed and any pending untransmitted data may be lost. Call
dtlsConnectionClose
again to complete closing the DtlsConnection
.
Since: 2.48
closeAsync
data DtlsConnectionCloseAsyncMethodInfo Source #
Instances
(signature ~ (Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsDtlsConnection a, IsCancellable b) => OverloadedMethod DtlsConnectionCloseAsyncMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionCloseAsyncMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionCloseAsync Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) | |
=> a |
|
-> Int32 |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously close the DTLS connection. See dtlsConnectionClose
for
more information.
Since: 2.48
closeFinish
data DtlsConnectionCloseFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsDtlsConnection a, IsAsyncResult b) => OverloadedMethod DtlsConnectionCloseFinishMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionCloseFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionCloseFinish Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Finish an asynchronous TLS close operation. See dtlsConnectionClose
for more information.
Since: 2.48
emitAcceptCertificate
data DtlsConnectionEmitAcceptCertificateMethodInfo Source #
Instances
(signature ~ (b -> [TlsCertificateFlags] -> m Bool), MonadIO m, IsDtlsConnection a, IsTlsCertificate b) => OverloadedMethod DtlsConnectionEmitAcceptCertificateMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionEmitAcceptCertificateMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionEmitAcceptCertificate Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) | |
=> a |
|
-> b |
|
-> [TlsCertificateFlags] |
|
-> m Bool | Returns: |
Used by DtlsConnection
implementations to emit the
DtlsConnection::acceptCertificate signal.
Since: 2.48
getCertificate
data DtlsConnectionGetCertificateMethodInfo Source #
Instances
(signature ~ m (Maybe TlsCertificate), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetCertificateMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetCertificateMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetCertificate Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m (Maybe TlsCertificate) | Returns: |
Gets conn
's certificate, as set by
dtlsConnectionSetCertificate
.
Since: 2.48
getChannelBindingData
data DtlsConnectionGetChannelBindingDataMethodInfo Source #
Instances
(signature ~ (TlsChannelBindingType -> m ByteString), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetChannelBindingDataMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetChannelBindingDataMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetChannelBindingData Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> TlsChannelBindingType |
|
-> m ByteString | (Can throw |
Query the TLS backend for TLS channel binding data of type
for conn
.
This call retrieves TLS channel binding data as specified in RFC
5056, RFC
5929, and related RFCs. The
binding data is returned in data
. The data
is resized by the callee
using ByteArray
buffer management and will be freed when the data
is destroyed by byteArrayUnref
. If data
is Nothing
, it will only
check whether TLS backend is able to fetch the data (e.g. whether type
is supported by the TLS backend). It does not guarantee that the data
will be available though. That could happen if TLS connection does not
support type
or the binding data is not available yet due to additional
negotiation or input required.
Since: 2.66
getCiphersuiteName
data DtlsConnectionGetCiphersuiteNameMethodInfo Source #
Instances
(signature ~ m (Maybe Text), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetCiphersuiteNameMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetCiphersuiteNameMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetCiphersuiteName Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m (Maybe Text) | Returns: The name of the current DTLS ciphersuite, or |
Returns the name of the current DTLS ciphersuite, or Nothing
if the
connection has not handshaked or has been closed. Beware that the TLS
backend may use any of multiple different naming conventions, because
OpenSSL and GnuTLS have their own ciphersuite naming conventions that
are different from each other and different from the standard, IANA-
registered ciphersuite names. The ciphersuite name is intended to be
displayed to the user for informative purposes only, and parsing it
is not recommended.
Since: 2.70
getDatabase
data DtlsConnectionGetDatabaseMethodInfo Source #
Instances
(signature ~ m (Maybe TlsDatabase), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetDatabaseMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetDatabaseMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetDatabase Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m (Maybe TlsDatabase) | Returns: the certificate database that |
Gets the certificate database that conn
uses to verify
peer certificates. See dtlsConnectionSetDatabase
.
Since: 2.48
getInteraction
data DtlsConnectionGetInteractionMethodInfo Source #
Instances
(signature ~ m (Maybe TlsInteraction), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetInteractionMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetInteractionMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetInteraction Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m (Maybe 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.48
getNegotiatedProtocol
data DtlsConnectionGetNegotiatedProtocolMethodInfo Source #
Instances
(signature ~ m (Maybe Text), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetNegotiatedProtocolMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetNegotiatedProtocolMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetNegotiatedProtocol Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection 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
dtlsConnectionSetAdvertisedProtocols
.
Since: 2.60
getPeerCertificate
data DtlsConnectionGetPeerCertificateMethodInfo Source #
Instances
(signature ~ m (Maybe TlsCertificate), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetPeerCertificateMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetPeerCertificateMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetPeerCertificate Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m (Maybe TlsCertificate) | Returns: |
Gets conn
's peer's certificate after the handshake has completed
or failed. (It is not set during the emission of
DtlsConnection::acceptCertificate.)
Since: 2.48
getPeerCertificateErrors
data DtlsConnectionGetPeerCertificateErrorsMethodInfo Source #
Instances
(signature ~ m [TlsCertificateFlags], MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetPeerCertificateErrorsMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetPeerCertificateErrorsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetPeerCertificateErrors Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m [TlsCertificateFlags] | Returns: |
Gets the errors associated with validating conn
's peer's
certificate, after the handshake has completed or failed. (It is
not set during the emission of DtlsConnection::acceptCertificate.)
Since: 2.48
getProtocolVersion
data DtlsConnectionGetProtocolVersionMethodInfo Source #
Instances
(signature ~ m TlsProtocolVersion, MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetProtocolVersionMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetProtocolVersionMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetProtocolVersion Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m TlsProtocolVersion | Returns: The current DTLS protocol version |
Returns the current DTLS protocol version, which may be
TlsProtocolVersionUnknown
if the connection has not handshaked, or
has been closed, or if the TLS backend has implemented a protocol version
that is not a recognized TlsProtocolVersion
.
Since: 2.70
getRehandshakeMode
data DtlsConnectionGetRehandshakeModeMethodInfo Source #
Instances
(signature ~ m TlsRehandshakeMode, MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetRehandshakeModeMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetRehandshakeModeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetRehandshakeMode Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m TlsRehandshakeMode | Returns: |
Deprecated: (Since version 2.64.)Changing the rehandshake mode is no longerrequired for compatibility. Also, rehandshaking has been removedfrom the TLS protocol in TLS 1.3.
Gets conn
rehandshaking mode. See
dtlsConnectionSetRehandshakeMode
for details.
Since: 2.48
getRequireCloseNotify
data DtlsConnectionGetRequireCloseNotifyMethodInfo Source #
Instances
(signature ~ m Bool, MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionGetRequireCloseNotifyMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionGetRequireCloseNotifyMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionGetRequireCloseNotify Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> m Bool | Returns: |
Tests whether or not conn
expects a proper TLS close notification
when the connection is closed. See
dtlsConnectionSetRequireCloseNotify
for details.
Since: 2.48
handshake
data DtlsConnectionHandshakeMethodInfo Source #
Instances
(signature ~ (Maybe b -> m ()), MonadIO m, IsDtlsConnection a, IsCancellable b) => OverloadedMethod DtlsConnectionHandshakeMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionHandshakeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionHandshake Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection 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, DtlsConnection
will handle this for you automatically
when you try to send or receive data on the connection. You can call
dtlsConnectionHandshake
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 dtlsConnectionHandshake
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.
DtlsConnection
::accept_certificate
may be emitted during the
handshake.
Since: 2.48
handshakeAsync
data DtlsConnectionHandshakeAsyncMethodInfo Source #
Instances
(signature ~ (Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsDtlsConnection a, IsCancellable b) => OverloadedMethod DtlsConnectionHandshakeAsyncMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionHandshakeAsyncMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionHandshakeAsync Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) | |
=> a |
|
-> Int32 |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously performs a TLS handshake on conn
. See
dtlsConnectionHandshake
for more information.
Since: 2.48
handshakeFinish
data DtlsConnectionHandshakeFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsDtlsConnection a, IsAsyncResult b) => OverloadedMethod DtlsConnectionHandshakeFinishMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionHandshakeFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionHandshakeFinish Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Finish an asynchronous TLS handshake operation. See
dtlsConnectionHandshake
for more information.
Since: 2.48
setAdvertisedProtocols
data DtlsConnectionSetAdvertisedProtocolsMethodInfo Source #
Instances
(signature ~ (Maybe [Text] -> m ()), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionSetAdvertisedProtocolsMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionSetAdvertisedProtocolsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionSetAdvertisedProtocols Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection 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
dtlsConnectionGetNegotiatedProtocol
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
data DtlsConnectionSetCertificateMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsDtlsConnection a, IsTlsCertificate b) => OverloadedMethod DtlsConnectionSetCertificateMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionSetCertificateMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionSetCertificate Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsCertificate b) | |
=> a |
|
-> b |
|
-> m () |
This sets the certificate that conn
will present to its peer
during the TLS handshake. For a DtlsServerConnection
, it is
mandatory to set this, and that will normally be done at construct
time.
For a DtlsClientConnection
, 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
dtlsClientConnectionGetAcceptedCas
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 dtlsClientConnectionGetAcceptedCas
will return
non-Nothing
.)
Since: 2.48
setDatabase
data DtlsConnectionSetDatabaseMethodInfo Source #
Instances
(signature ~ (Maybe b -> m ()), MonadIO m, IsDtlsConnection a, IsTlsDatabase b) => OverloadedMethod DtlsConnectionSetDatabaseMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionSetDatabaseMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionSetDatabase Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsTlsDatabase b) | |
=> a |
|
-> Maybe 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
DtlsConnection::acceptCertificate will always be emitted on
client-side connections, unless that bit is not set in
DtlsClientConnection:validationFlags).
There are nonintuitive security implications when using a non-default database. See DtlsConnection:database for details.
Since: 2.48
setInteraction
data DtlsConnectionSetInteractionMethodInfo Source #
Instances
(signature ~ (Maybe b -> m ()), MonadIO m, IsDtlsConnection a, IsTlsInteraction b) => OverloadedMethod DtlsConnectionSetInteractionMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionSetInteractionMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionSetInteraction Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection 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.48
setRehandshakeMode
data DtlsConnectionSetRehandshakeModeMethodInfo Source #
Instances
(signature ~ (TlsRehandshakeMode -> m ()), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionSetRehandshakeModeMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionSetRehandshakeModeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionSetRehandshakeMode Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a) | |
=> a |
|
-> TlsRehandshakeMode |
|
-> m () |
Deprecated: (Since version 2.60.)Changing the rehandshake mode is no longerrequired for compatibility. Also, rehandshaking has been removedfrom 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.48
setRequireCloseNotify
data DtlsConnectionSetRequireCloseNotifyMethodInfo Source #
Instances
(signature ~ (Bool -> m ()), MonadIO m, IsDtlsConnection a) => OverloadedMethod DtlsConnectionSetRequireCloseNotifyMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionSetRequireCloseNotifyMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionSetRequireCloseNotify Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection 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 may be omitted. You
can use dtlsConnectionSetRequireCloseNotify
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
DatagramBased
, 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 dtlsConnectionCloseAsync
on
conn
itself, 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 DtlsConnection:baseSocket rather
than closing conn
itself.
Since: 2.48
shutdown
data DtlsConnectionShutdownMethodInfo Source #
Instances
(signature ~ (Bool -> Bool -> Maybe b -> m ()), MonadIO m, IsDtlsConnection a, IsCancellable b) => OverloadedMethod DtlsConnectionShutdownMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionShutdownMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionShutdown Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) | |
=> a |
|
-> Bool |
|
-> Bool |
|
-> Maybe b |
|
-> m () | (Can throw |
Shut down part or all of a DTLS connection.
If shutdownRead
is True
then the receiving side of the connection is shut
down, and further reading is disallowed. Subsequent calls to
datagramBasedReceiveMessages
will return IOErrorEnumClosed
.
If shutdownWrite
is True
then the sending side of the connection is shut
down, and further writing is disallowed. Subsequent calls to
datagramBasedSendMessages
will return IOErrorEnumClosed
.
It is allowed for both shutdownRead
and shutdownWrite
to be TRUE — this
is equivalent to calling dtlsConnectionClose
.
If cancellable
is cancelled, the DtlsConnection
may be left
partially-closed and any pending untransmitted data may be lost. Call
dtlsConnectionShutdown
again to complete closing the DtlsConnection
.
Since: 2.48
shutdownAsync
data DtlsConnectionShutdownAsyncMethodInfo Source #
Instances
(signature ~ (Bool -> Bool -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsDtlsConnection a, IsCancellable b) => OverloadedMethod DtlsConnectionShutdownAsyncMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionShutdownAsyncMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionShutdownAsync Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsCancellable b) | |
=> a |
|
-> Bool |
|
-> Bool |
|
-> Int32 |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously shut down part or all of the DTLS connection. See
dtlsConnectionShutdown
for more information.
Since: 2.48
shutdownFinish
data DtlsConnectionShutdownFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsDtlsConnection a, IsAsyncResult b) => OverloadedMethod DtlsConnectionShutdownFinishMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo DtlsConnectionShutdownFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsConnection Methods |
dtlsConnectionShutdownFinish Source #
Arguments
:: (HasCallStack, MonadIO m, IsDtlsConnection a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Finish an asynchronous TLS shutdown operation. See
dtlsConnectionShutdown
for more information.
Since: 2.48
Properties
advertisedProtocols
The list of application-layer protocols that the connection
advertises that it is willing to speak. See
dtlsConnectionSetAdvertisedProtocols
.
Since: 2.60
data DtlsConnectionAdvertisedProtocolsPropertyInfo Source #
Instances
clearDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m () Source #
Set the value of the “advertised-protocols
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#advertisedProtocols
constructDtlsConnectionAdvertisedProtocols :: (IsDtlsConnection 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
.
dtlsConnectionAdvertisedProtocols :: AttrLabelProxy "advertisedProtocols" Source #
getDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe [Text]) Source #
Get the value of the “advertised-protocols
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #advertisedProtocols
setDtlsConnectionAdvertisedProtocols :: (MonadIO m, IsDtlsConnection o) => o -> [Text] -> m () Source #
Set the value of the “advertised-protocols
” property.
When overloading is enabled, this is equivalent to
set
dtlsConnection [ #advertisedProtocols:=
value ]
baseSocket
The DatagramBased
that the connection wraps. Note that this may be any
implementation of DatagramBased
, not just a Socket
.
Since: 2.48
data DtlsConnectionBaseSocketPropertyInfo Source #
Instances
AttrInfo DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionBaseSocketPropertyInfo o => o -> IO (AttrGetType DtlsConnectionBaseSocketPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionBaseSocketPropertyInfo o, AttrSetTypeConstraint DtlsConnectionBaseSocketPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionBaseSocketPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionBaseSocketPropertyInfo o, AttrSetTypeConstraint DtlsConnectionBaseSocketPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionBaseSocketPropertyInfo o, AttrTransferTypeConstraint DtlsConnectionBaseSocketPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionBaseSocketPropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionBaseSocketPropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructDtlsConnectionBaseSocket :: (IsDtlsConnection o, MonadIO m, IsDatagramBased a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “base-socket
” property. This is rarely needed directly, but it is used by new
.
dtlsConnectionBaseSocket :: AttrLabelProxy "baseSocket" Source #
getDtlsConnectionBaseSocket :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe DatagramBased) Source #
Get the value of the “base-socket
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #baseSocket
certificate
The connection's certificate; see
dtlsConnectionSetCertificate
.
Since: 2.48
data DtlsConnectionCertificatePropertyInfo Source #
Instances
AttrInfo DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionCertificatePropertyInfo o => o -> IO (AttrGetType DtlsConnectionCertificatePropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionCertificatePropertyInfo o, AttrSetTypeConstraint DtlsConnectionCertificatePropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionCertificatePropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionCertificatePropertyInfo o, AttrSetTypeConstraint DtlsConnectionCertificatePropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionCertificatePropertyInfo o, AttrTransferTypeConstraint DtlsConnectionCertificatePropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionCertificatePropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructDtlsConnectionCertificate :: (IsDtlsConnection 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
.
dtlsConnectionCertificate :: AttrLabelProxy "certificate" Source #
getDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsCertificate) Source #
Get the value of the “certificate
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #certificate
setDtlsConnectionCertificate :: (MonadIO m, IsDtlsConnection o, IsTlsCertificate a) => o -> a -> m () Source #
Set the value of the “certificate
” property.
When overloading is enabled, this is equivalent to
set
dtlsConnection [ #certificate:=
value ]
ciphersuiteName
The name of the DTLS ciphersuite in use. See dtlsConnectionGetCiphersuiteName
.
Since: 2.70
data DtlsConnectionCiphersuiteNamePropertyInfo Source #
Instances
AttrInfo DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo o => o -> IO (AttrGetType DtlsConnectionCiphersuiteNamePropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo o, AttrSetTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo o, AttrSetTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo o, AttrTransferTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionCiphersuiteNamePropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionCiphersuiteNamePropertyInfo Source # | |||||||||||||||||||||||||||||||||
dtlsConnectionCiphersuiteName :: AttrLabelProxy "ciphersuiteName" Source #
getDtlsConnectionCiphersuiteName :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe Text) Source #
Get the value of the “ciphersuite-name
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #ciphersuiteName
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
.
When using a non-default database, DtlsConnection
must fall back to using
the TlsDatabase
to perform certificate verification using
tlsDatabaseVerifyChain
, which means certificate verification will
not be able to make use of TLS session context. This may be less secure.
For example, if you create your own TlsDatabase
that just wraps the
default TlsDatabase
, you might expect that you have not changed anything,
but this is not true because you may have altered the behavior of
DtlsConnection
by causing it to use tlsDatabaseVerifyChain
. See the
documentation of tlsDatabaseVerifyChain
for more details on specific
security checks that may not be performed. Accordingly, setting a
non-default database is discouraged except for specialty applications with
unusual security requirements.
Since: 2.48
data DtlsConnectionDatabasePropertyInfo Source #
Instances
AttrInfo DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionDatabasePropertyInfo o => o -> IO (AttrGetType DtlsConnectionDatabasePropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionDatabasePropertyInfo o, AttrSetTypeConstraint DtlsConnectionDatabasePropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionDatabasePropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionDatabasePropertyInfo o, AttrSetTypeConstraint DtlsConnectionDatabasePropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionDatabasePropertyInfo o, AttrTransferTypeConstraint DtlsConnectionDatabasePropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionDatabasePropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection type AttrAllowedOps DtlsConnectionDatabasePropertyInfo = '['AttrSet, 'AttrConstruct, 'AttrGet, 'AttrClear] | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionDatabasePropertyInfo Source # | |||||||||||||||||||||||||||||||||
clearDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o) => o -> m () Source #
Set the value of the “database
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#database
constructDtlsConnectionDatabase :: (IsDtlsConnection 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
.
dtlsConnectionDatabase :: AttrLabelProxy "database" Source #
getDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsDatabase) Source #
Get the value of the “database
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #database
setDtlsConnectionDatabase :: (MonadIO m, IsDtlsConnection o, IsTlsDatabase a) => o -> a -> m () Source #
Set the value of the “database
” property.
When overloading is enabled, this is equivalent to
set
dtlsConnection [ #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.48
data DtlsConnectionInteractionPropertyInfo Source #
Instances
AttrInfo DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionInteractionPropertyInfo o => o -> IO (AttrGetType DtlsConnectionInteractionPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionInteractionPropertyInfo o, AttrSetTypeConstraint DtlsConnectionInteractionPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionInteractionPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionInteractionPropertyInfo o, AttrSetTypeConstraint DtlsConnectionInteractionPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionInteractionPropertyInfo o, AttrTransferTypeConstraint DtlsConnectionInteractionPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionInteractionPropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection type AttrAllowedOps DtlsConnectionInteractionPropertyInfo = '['AttrSet, 'AttrConstruct, 'AttrGet, 'AttrClear] | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionInteractionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
clearDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m () Source #
Set the value of the “interaction
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#interaction
constructDtlsConnectionInteraction :: (IsDtlsConnection 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
.
dtlsConnectionInteraction :: AttrLabelProxy "interaction" Source #
getDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsInteraction) Source #
Get the value of the “interaction
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #interaction
setDtlsConnectionInteraction :: (MonadIO m, IsDtlsConnection o, IsTlsInteraction a) => o -> a -> m () Source #
Set the value of the “interaction
” property.
When overloading is enabled, this is equivalent to
set
dtlsConnection [ #interaction:=
value ]
negotiatedProtocol
The application-layer protocol negotiated during the TLS
handshake. See dtlsConnectionGetNegotiatedProtocol
.
Since: 2.60
data DtlsConnectionNegotiatedProtocolPropertyInfo Source #
Instances
AttrInfo DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo o => o -> IO (AttrGetType DtlsConnectionNegotiatedProtocolPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo o, AttrSetTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo o, AttrSetTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo o, AttrTransferTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionNegotiatedProtocolPropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionNegotiatedProtocolPropertyInfo Source # | |||||||||||||||||||||||||||||||||
dtlsConnectionNegotiatedProtocol :: AttrLabelProxy "negotiatedProtocol" Source #
getDtlsConnectionNegotiatedProtocol :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe Text) Source #
Get the value of the “negotiated-protocol
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #negotiatedProtocol
peerCertificate
The connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of DtlsConnection::acceptCertificate.
(You can watch for a Object::notify signal on this property to detect when a handshake has occurred.)
Since: 2.48
data DtlsConnectionPeerCertificatePropertyInfo Source #
Instances
AttrInfo DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionPeerCertificatePropertyInfo o => o -> IO (AttrGetType DtlsConnectionPeerCertificatePropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionPeerCertificatePropertyInfo o, AttrSetTypeConstraint DtlsConnectionPeerCertificatePropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionPeerCertificatePropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionPeerCertificatePropertyInfo o, AttrSetTypeConstraint DtlsConnectionPeerCertificatePropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionPeerCertificatePropertyInfo o, AttrTransferTypeConstraint DtlsConnectionPeerCertificatePropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionPeerCertificatePropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionPeerCertificatePropertyInfo Source # | |||||||||||||||||||||||||||||||||
dtlsConnectionPeerCertificate :: AttrLabelProxy "peerCertificate" Source #
getDtlsConnectionPeerCertificate :: (MonadIO m, IsDtlsConnection o) => o -> m (Maybe TlsCertificate) Source #
Get the value of the “peer-certificate
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #peerCertificate
peerCertificateErrors
The errors noticed while verifying
DtlsConnection:peerCertificate. Normally this should be 0, but
it may not be if DtlsClientConnection:validationFlags is not
TlsCertificateFlagsValidateAll
, or if
DtlsConnection::acceptCertificate overrode the default
behavior.
GLib guarantees that if certificate verification fails, at least
one error will be set, but it does not guarantee that all possible
errors will be set. Accordingly, you may not safely decide to
ignore any particular type of error. For example, it would be
incorrect to mask TlsCertificateFlagsExpired
if you want to allow
expired certificates, because this could potentially be the only
error flag set even if other problems exist with the certificate.
Since: 2.48
data DtlsConnectionPeerCertificateErrorsPropertyInfo Source #
Instances
AttrInfo DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo o => o -> IO (AttrGetType DtlsConnectionPeerCertificateErrorsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo o, AttrSetTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo o, AttrSetTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo o, AttrTransferTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionPeerCertificateErrorsPropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionPeerCertificateErrorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
dtlsConnectionPeerCertificateErrors :: AttrLabelProxy "peerCertificateErrors" Source #
getDtlsConnectionPeerCertificateErrors :: (MonadIO m, IsDtlsConnection o) => o -> m [TlsCertificateFlags] Source #
Get the value of the “peer-certificate-errors
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #peerCertificateErrors
protocolVersion
The DTLS protocol version in use. See dtlsConnectionGetProtocolVersion
.
Since: 2.70
data DtlsConnectionProtocolVersionPropertyInfo Source #
Instances
AttrInfo DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionProtocolVersionPropertyInfo o => o -> IO (AttrGetType DtlsConnectionProtocolVersionPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionProtocolVersionPropertyInfo o, AttrSetTypeConstraint DtlsConnectionProtocolVersionPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionProtocolVersionPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionProtocolVersionPropertyInfo o, AttrSetTypeConstraint DtlsConnectionProtocolVersionPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionProtocolVersionPropertyInfo o, AttrTransferTypeConstraint DtlsConnectionProtocolVersionPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionProtocolVersionPropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionProtocolVersionPropertyInfo Source # | |||||||||||||||||||||||||||||||||
dtlsConnectionProtocolVersion :: AttrLabelProxy "protocolVersion" Source #
getDtlsConnectionProtocolVersion :: (MonadIO m, IsDtlsConnection o) => o -> m TlsProtocolVersion Source #
Get the value of the “protocol-version
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #protocolVersion
rehandshakeMode
The rehandshaking mode. See
dtlsConnectionSetRehandshakeMode
.
Since: 2.48
data DtlsConnectionRehandshakeModePropertyInfo Source #
Instances
AttrInfo DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionRehandshakeModePropertyInfo o => o -> IO (AttrGetType DtlsConnectionRehandshakeModePropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionRehandshakeModePropertyInfo o, AttrSetTypeConstraint DtlsConnectionRehandshakeModePropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionRehandshakeModePropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionRehandshakeModePropertyInfo o, AttrSetTypeConstraint DtlsConnectionRehandshakeModePropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionRehandshakeModePropertyInfo o, AttrTransferTypeConstraint DtlsConnectionRehandshakeModePropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionRehandshakeModePropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionRehandshakeModePropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructDtlsConnectionRehandshakeMode :: (IsDtlsConnection 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
.
dtlsConnectionRehandshakeMode :: AttrLabelProxy "rehandshakeMode" Source #
getDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> m TlsRehandshakeMode Source #
Get the value of the “rehandshake-mode
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #rehandshakeMode
setDtlsConnectionRehandshakeMode :: (MonadIO m, IsDtlsConnection o) => o -> TlsRehandshakeMode -> m () Source #
Set the value of the “rehandshake-mode
” property.
When overloading is enabled, this is equivalent to
set
dtlsConnection [ #rehandshakeMode:=
value ]
requireCloseNotify
Whether or not proper TLS close notification is required.
See dtlsConnectionSetRequireCloseNotify
.
Since: 2.48
data DtlsConnectionRequireCloseNotifyPropertyInfo Source #
Instances
AttrInfo DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo o => o -> IO (AttrGetType DtlsConnectionRequireCloseNotifyPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo o, AttrSetTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo o, AttrSetTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo o, AttrTransferTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsConnectionRequireCloseNotifyPropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsConnection | |||||||||||||||||||||||||||||||||
type AttrOrigin DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint DtlsConnectionRequireCloseNotifyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructDtlsConnectionRequireCloseNotify :: (IsDtlsConnection 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
.
dtlsConnectionRequireCloseNotify :: AttrLabelProxy "requireCloseNotify" Source #
getDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> m Bool Source #
Get the value of the “require-close-notify
” property.
When overloading is enabled, this is equivalent to
get
dtlsConnection #requireCloseNotify
setDtlsConnectionRequireCloseNotify :: (MonadIO m, IsDtlsConnection o) => o -> Bool -> m () Source #
Set the value of the “require-close-notify
” property.
When overloading is enabled, this is equivalent to
set
dtlsConnection [ #requireCloseNotify:=
value ]
Signals
acceptCertificate
type DtlsConnectionAcceptCertificateCallback Source #
Arguments
= 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
DtlsClientConnection
: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
.
GLib guarantees that if certificate verification fails, this signal
will be emitted with at least one error will be set in errors
, but
it does not guarantee that all possible errors will be set.
Accordingly, you may not safely decide to ignore any particular
type of error. For example, it would be incorrect to ignore
TlsCertificateFlagsExpired
if you want to allow expired
certificates, because this could potentially be the only error flag
set even if other problems exist with the certificate.
For a server-side connection, peerCert
is the certificate
presented by the client, if this was requested via the server's
DtlsServerConnection
: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.48
data DtlsConnectionAcceptCertificateSignalInfo Source #
Instances
SignalInfo DtlsConnectionAcceptCertificateSignalInfo Source # | |||||
Defined in GI.Gio.Interfaces.DtlsConnection Associated Types
Methods connectSignal :: GObject o => o -> (o -> HaskellCallbackType DtlsConnectionAcceptCertificateSignalInfo) -> SignalConnectMode -> Maybe Text -> IO SignalHandlerId # | |||||
type HaskellCallbackType DtlsConnectionAcceptCertificateSignalInfo Source # | |||||
afterDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> ((?self :: a) => DtlsConnectionAcceptCertificateCallback) -> 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
dtlsConnection #acceptCertificate callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onDtlsConnectionAcceptCertificate :: (IsDtlsConnection a, MonadIO m) => a -> ((?self :: a) => DtlsConnectionAcceptCertificateCallback) -> 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
dtlsConnection #acceptCertificate callback