| 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.DtlsClientConnection
Description
GDtlsClientConnection is the client-side subclass of
DtlsConnection, representing a client-side DTLS connection.
Since: 2.48
Synopsis
- newtype DtlsClientConnection = DtlsClientConnection (ManagedPtr DtlsClientConnection)
- class (GObject o, IsDescendantOf DtlsClientConnection o) => IsDtlsClientConnection o
- toDtlsClientConnection :: (MonadIO m, IsDtlsClientConnection o) => o -> m DtlsClientConnection
- type family ResolveDtlsClientConnectionMethod (t :: Symbol) o where ...
- data DtlsClientConnectionGetAcceptedCasMethodInfo
- dtlsClientConnectionGetAcceptedCas :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) => a -> m [ByteString]
- data DtlsClientConnectionGetServerIdentityMethodInfo
- dtlsClientConnectionGetServerIdentity :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) => a -> m SocketConnectable
- data DtlsClientConnectionGetValidationFlagsMethodInfo
- dtlsClientConnectionGetValidationFlags :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) => a -> m [TlsCertificateFlags]
- dtlsClientConnectionNew :: (HasCallStack, MonadIO m, IsDatagramBased a, IsSocketConnectable b) => a -> Maybe b -> m DtlsClientConnection
- data DtlsClientConnectionSetServerIdentityMethodInfo
- dtlsClientConnectionSetServerIdentity :: (HasCallStack, MonadIO m, IsDtlsClientConnection a, IsSocketConnectable b) => a -> b -> m ()
- data DtlsClientConnectionSetValidationFlagsMethodInfo
- dtlsClientConnectionSetValidationFlags :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) => a -> [TlsCertificateFlags] -> m ()
- data DtlsClientConnectionAcceptedCasPropertyInfo
- dtlsClientConnectionAcceptedCas :: AttrLabelProxy "acceptedCas"
- getDtlsClientConnectionAcceptedCas :: (MonadIO m, IsDtlsClientConnection o) => o -> m [Ptr ()]
- data DtlsClientConnectionServerIdentityPropertyInfo
- constructDtlsClientConnectionServerIdentity :: (IsDtlsClientConnection o, MonadIO m, IsSocketConnectable a) => a -> m (GValueConstruct o)
- dtlsClientConnectionServerIdentity :: AttrLabelProxy "serverIdentity"
- getDtlsClientConnectionServerIdentity :: (MonadIO m, IsDtlsClientConnection o) => o -> m SocketConnectable
- setDtlsClientConnectionServerIdentity :: (MonadIO m, IsDtlsClientConnection o, IsSocketConnectable a) => o -> a -> m ()
- data DtlsClientConnectionValidationFlagsPropertyInfo
- constructDtlsClientConnectionValidationFlags :: (IsDtlsClientConnection o, MonadIO m) => [TlsCertificateFlags] -> m (GValueConstruct o)
- dtlsClientConnectionValidationFlags :: AttrLabelProxy "validationFlags"
- getDtlsClientConnectionValidationFlags :: (MonadIO m, IsDtlsClientConnection o) => o -> m [TlsCertificateFlags]
- setDtlsClientConnectionValidationFlags :: (MonadIO m, IsDtlsClientConnection o) => o -> [TlsCertificateFlags] -> m ()
Exported types
newtype DtlsClientConnection Source #
Memory-managed wrapper type.
Constructors
| DtlsClientConnection (ManagedPtr DtlsClientConnection) |
Instances
class (GObject o, IsDescendantOf DtlsClientConnection o) => IsDtlsClientConnection o Source #
Type class for types which can be safely cast to DtlsClientConnection, for instance with toDtlsClientConnection.
Instances
| (GObject o, IsDescendantOf DtlsClientConnection o) => IsDtlsClientConnection o Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection | |
toDtlsClientConnection :: (MonadIO m, IsDtlsClientConnection o) => o -> m DtlsClientConnection Source #
Cast to DtlsClientConnection, 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
getAcceptedCas, getCertificate, getChannelBindingData, getCiphersuiteName, getData, getDatabase, getInteraction, getNegotiatedProtocol, getPeerCertificate, getPeerCertificateErrors, getProperty, getProtocolVersion, getQdata, getRehandshakeMode, getRequireCloseNotify, getServerIdentity, getValidationFlags.
Setters
setAdvertisedProtocols, setCertificate, setData, setDataFull, setDatabase, setInteraction, setProperty, setRehandshakeMode, setRequireCloseNotify, setServerIdentity, setValidationFlags.
type family ResolveDtlsClientConnectionMethod (t :: Symbol) o where ... Source #
Equations
getAcceptedCas
data DtlsClientConnectionGetAcceptedCasMethodInfo Source #
Instances
| (signature ~ m [ByteString], MonadIO m, IsDtlsClientConnection a) => OverloadedMethod DtlsClientConnectionGetAcceptedCasMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo DtlsClientConnectionGetAcceptedCasMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods | |
dtlsClientConnectionGetAcceptedCas Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) | |
| => a |
|
| -> m [ByteString] | Returns: the list of
CA DNs. You should unref each element with |
Gets the list of distinguished names of the Certificate Authorities
that the server will accept certificates from. This will be set
during the TLS handshake if the server requests a certificate.
Otherwise, it will be Nothing.
Each item in the list is a ByteArray which contains the complete
subject DN of the certificate authority.
Since: 2.48
getServerIdentity
data DtlsClientConnectionGetServerIdentityMethodInfo Source #
Instances
| (signature ~ m SocketConnectable, MonadIO m, IsDtlsClientConnection a) => OverloadedMethod DtlsClientConnectionGetServerIdentityMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo DtlsClientConnectionGetServerIdentityMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods | |
dtlsClientConnectionGetServerIdentity Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) | |
| => a |
|
| -> m SocketConnectable | Returns: a |
Gets conn's expected server identity
Since: 2.48
getValidationFlags
data DtlsClientConnectionGetValidationFlagsMethodInfo Source #
Instances
| (signature ~ m [TlsCertificateFlags], MonadIO m, IsDtlsClientConnection a) => OverloadedMethod DtlsClientConnectionGetValidationFlagsMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo DtlsClientConnectionGetValidationFlagsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods | |
dtlsClientConnectionGetValidationFlags Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) | |
| => a |
|
| -> m [TlsCertificateFlags] | Returns: the validation flags |
Deprecated: (Since version 2.74)Do not attempt to ignore validation errors.
Gets conn's validation flags
This function does not work as originally designed and is impossible to use correctly. See DtlsClientConnection:validationFlags for more information.
Since: 2.48
new
dtlsClientConnectionNew Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDatagramBased a, IsSocketConnectable b) | |
| => a |
|
| -> Maybe b |
|
| -> m DtlsClientConnection | Returns: the new
|
Creates a new DtlsClientConnection wrapping baseSocket which is
assumed to communicate with the server identified by serverIdentity.
Since: 2.48
setServerIdentity
data DtlsClientConnectionSetServerIdentityMethodInfo Source #
Instances
| (signature ~ (b -> m ()), MonadIO m, IsDtlsClientConnection a, IsSocketConnectable b) => OverloadedMethod DtlsClientConnectionSetServerIdentityMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo DtlsClientConnectionSetServerIdentityMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods | |
dtlsClientConnectionSetServerIdentity Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDtlsClientConnection a, IsSocketConnectable b) | |
| => a |
|
| -> b |
|
| -> m () |
Sets conn's expected server identity, which is used both to tell
servers on virtual hosts which certificate to present, and also
to let conn know what name to look for in the certificate when
performing TlsCertificateFlagsBadIdentity validation, if enabled.
Since: 2.48
setValidationFlags
data DtlsClientConnectionSetValidationFlagsMethodInfo Source #
Instances
| (signature ~ ([TlsCertificateFlags] -> m ()), MonadIO m, IsDtlsClientConnection a) => OverloadedMethod DtlsClientConnectionSetValidationFlagsMethodInfo a signature Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo DtlsClientConnectionSetValidationFlagsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Interfaces.DtlsClientConnection Methods | |
dtlsClientConnectionSetValidationFlags Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDtlsClientConnection a) | |
| => a |
|
| -> [TlsCertificateFlags] |
|
| -> m () |
Deprecated: (Since version 2.74)Do not attempt to ignore validation errors.
Sets conn's validation flags, to override the default set of
checks performed when validating a server certificate. By default,
TlsCertificateFlagsValidateAll is used.
This function does not work as originally designed and is impossible to use correctly. See DtlsClientConnection:validationFlags for more information.
Since: 2.48
Properties
acceptedCas
A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes.
Each item in the list is a ByteArray which contains the complete
subject DN of the certificate authority.
Since: 2.48
data DtlsClientConnectionAcceptedCasPropertyInfo Source #
Instances
dtlsClientConnectionAcceptedCas :: AttrLabelProxy "acceptedCas" Source #
getDtlsClientConnectionAcceptedCas :: (MonadIO m, IsDtlsClientConnection o) => o -> m [Ptr ()] Source #
Get the value of the “accepted-cas” property.
When overloading is enabled, this is equivalent to
get dtlsClientConnection #acceptedCas
serverIdentity
A SocketConnectable describing the identity of the server that
is expected on the other end of the connection.
If the TlsCertificateFlagsBadIdentity flag is set in
DtlsClientConnection:validationFlags, this object will be used
to determine the expected identify of the remote end of the
connection; if DtlsClientConnection:serverIdentity is not set,
or does not match the identity presented by the server, then the
TlsCertificateFlagsBadIdentity validation will fail.
In addition to its use in verifying the server certificate, this is also used to give a hint to the server about what certificate we expect, which is useful for servers that serve virtual hosts.
Since: 2.48
data DtlsClientConnectionServerIdentityPropertyInfo Source #
Instances
| AttrInfo DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsClientConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo o => o -> IO (AttrGetType DtlsClientConnectionServerIdentityPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo o, AttrSetTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo o, AttrSetTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo o, AttrTransferTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsClientConnectionServerIdentityPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrLabel DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsClientConnection | |||||||||||||||||||||||||||||||||
| type AttrOrigin DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferType DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint DtlsClientConnectionServerIdentityPropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructDtlsClientConnectionServerIdentity :: (IsDtlsClientConnection o, MonadIO m, IsSocketConnectable a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “server-identity” property. This is rarely needed directly, but it is used by new.
dtlsClientConnectionServerIdentity :: AttrLabelProxy "serverIdentity" Source #
getDtlsClientConnectionServerIdentity :: (MonadIO m, IsDtlsClientConnection o) => o -> m SocketConnectable Source #
Get the value of the “server-identity” property.
When overloading is enabled, this is equivalent to
get dtlsClientConnection #serverIdentity
setDtlsClientConnectionServerIdentity :: (MonadIO m, IsDtlsClientConnection o, IsSocketConnectable a) => o -> a -> m () Source #
Set the value of the “server-identity” property.
When overloading is enabled, this is equivalent to
setdtlsClientConnection [ #serverIdentity:=value ]
validationFlags
What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in any of the ways indicated here will be rejected unless the application overrides the default via DtlsConnection::acceptCertificate.
GLib guarantees that if certificate verification fails, at least one
flag will be set, but it does not guarantee that all possible flags
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. Therefore, there is no
safe way to use this property. This is not a horrible problem,
though, because you should not be attempting to ignore validation
errors anyway. If you really must ignore TLS certificate errors,
connect to DtlsConnection::acceptCertificate.
Since: 2.48
data DtlsClientConnectionValidationFlagsPropertyInfo Source #
Instances
| AttrInfo DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsClientConnection Associated Types
Methods attrGet :: AttrBaseTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo o => o -> IO (AttrGetType DtlsClientConnectionValidationFlagsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo o, AttrSetTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo o, AttrSetTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo o, AttrTransferTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DtlsClientConnectionValidationFlagsPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrLabel DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Interfaces.DtlsClientConnection | |||||||||||||||||||||||||||||||||
| type AttrOrigin DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferType DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint DtlsClientConnectionValidationFlagsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructDtlsClientConnectionValidationFlags :: (IsDtlsClientConnection o, MonadIO m) => [TlsCertificateFlags] -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “validation-flags” property. This is rarely needed directly, but it is used by new.
dtlsClientConnectionValidationFlags :: AttrLabelProxy "validationFlags" Source #
getDtlsClientConnectionValidationFlags :: (MonadIO m, IsDtlsClientConnection o) => o -> m [TlsCertificateFlags] Source #
Get the value of the “validation-flags” property.
When overloading is enabled, this is equivalent to
get dtlsClientConnection #validationFlags
setDtlsClientConnectionValidationFlags :: (MonadIO m, IsDtlsClientConnection o) => o -> [TlsCertificateFlags] -> m () Source #
Set the value of the “validation-flags” property.
When overloading is enabled, this is equivalent to
setdtlsClientConnection [ #validationFlags:=value ]