Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gio.Interfaces.TlsClientConnection

Contents

Exported types
Methods
Properties

Description

TlsClientConnection is the client-side subclass of TlsConnection, representing a client-side TLS connection.

Synopsis

Exported types

newtype TlsClientConnection Source #

Constructors

TlsClientConnection (ManagedPtr TlsClientConnection)

Instances

GObject TlsClientConnection Source #
Methods gobjectType :: TlsClientConnection -> IO GType #
IsObject TlsClientConnection Source #

IsTlsConnection TlsClientConnection Source #

IsIOStream TlsClientConnection Source #

IsTlsClientConnection TlsClientConnection Source #

((~) * info (ResolveTlsClientConnectionMethod t TlsClientConnection), MethodInfo * info TlsClientConnection p) => IsLabel t (TlsClientConnection -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> TlsClientConnection -> p #
((~) * info (ResolveTlsClientConnectionMethod t TlsClientConnection), MethodInfo * info TlsClientConnection p) => IsLabelProxy t (TlsClientConnection -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> TlsClientConnection -> p #
HasAttributeList * TlsClientConnection Source #

type AttributeList TlsClientConnection Source #
type AttributeList TlsClientConnection
type SignalList TlsClientConnection Source #
type SignalList TlsClientConnection

noTlsClientConnection :: Maybe TlsClientConnection Source #

class GObject o => IsTlsClientConnection o Source #

Instances

(GObject a, UnknownAncestorError Constraint TlsClientConnection a) => IsTlsClientConnection a Source #

IsTlsClientConnection TlsClientConnection Source #

toTlsClientConnection :: IsTlsClientConnection o => o -> IO TlsClientConnection Source #

Methods

copySessionState

data TlsClientConnectionCopySessionStateMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsTlsClientConnection a, IsTlsClientConnection b) => MethodInfo * TlsClientConnectionCopySessionStateMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionCopySessionStateMethodInfo a -> signature -> s #

tlsClientConnectionCopySessionState Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a, IsTlsClientConnection b)
=> a	`conn`: a `TlsClientConnection`
-> b	`source`: a `TlsClientConnection`
-> m ()

Copies session state from one connection to another. This is not normally needed, but may be used when the same session needs to be used between different endpoints as is required by some protocols such as FTP over TLS. source should have already completed a handshake, and conn should not have completed a handshake.

Since: 2.46

getAcceptedCas

data TlsClientConnectionGetAcceptedCasMethodInfo Source #

Instances

((~) * signature (m [ByteString]), MonadIO m, IsTlsClientConnection a) => MethodInfo * TlsClientConnectionGetAcceptedCasMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionGetAcceptedCasMethodInfo a -> signature -> s #

tlsClientConnectionGetAcceptedCas Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a)
=> a	`conn`: the `TlsClientConnection`
-> m [ByteString]	Returns: the list of CA DNs. You should unref each element with `byteArrayUnref` and then the free the list with `g_list_free()`.

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.28

getServerIdentity

data TlsClientConnectionGetServerIdentityMethodInfo Source #

Instances

((~) * signature (m SocketConnectable), MonadIO m, IsTlsClientConnection a) => MethodInfo * TlsClientConnectionGetServerIdentityMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionGetServerIdentityMethodInfo a -> signature -> s #

tlsClientConnectionGetServerIdentity Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a)
=> a	`conn`: the `TlsClientConnection`
-> m SocketConnectable	Returns: a `SocketConnectable` describing the expected server identity, or `Nothing` if the expected identity is not known.

Gets conn's expected server identity

Since: 2.28

getUseSsl3

data TlsClientConnectionGetUseSsl3MethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsTlsClientConnection a) => MethodInfo * TlsClientConnectionGetUseSsl3MethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionGetUseSsl3MethodInfo a -> signature -> s #

tlsClientConnectionGetUseSsl3 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a)
=> a	`conn`: the `TlsClientConnection`
-> m Bool	Returns: whether `conn` will use SSL 3.0

Gets whether conn will use SSL 3.0 rather than the highest-supported version of TLS; see tlsClientConnectionSetUseSsl3.

Since: 2.28

getValidationFlags

data TlsClientConnectionGetValidationFlagsMethodInfo Source #

Instances

((~) * signature (m [TlsCertificateFlags]), MonadIO m, IsTlsClientConnection a) => MethodInfo * TlsClientConnectionGetValidationFlagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionGetValidationFlagsMethodInfo a -> signature -> s #

tlsClientConnectionGetValidationFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a)
=> a	`conn`: the `TlsClientConnection`
-> m [TlsCertificateFlags]	Returns: the validation flags

Gets conn's validation flags

Since: 2.28

new

tlsClientConnectionNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsIOStream a, IsSocketConnectable b)
=> a	`baseIoStream`: the `IOStream` to wrap
-> Maybe b	`serverIdentity`: the expected identity of the server
-> m TlsClientConnection	Returns: the new `TlsClientConnection`, or `Nothing` on error (Can throw `GError`)

Creates a new TlsClientConnection wrapping baseIoStream (which must have pollable input and output streams) which is assumed to communicate with the server identified by serverIdentity.

See the documentation for TlsConnection:base-io-stream for restrictions on when application code can run operations on the baseIoStream after this function has returned.

Since: 2.28

setServerIdentity

data TlsClientConnectionSetServerIdentityMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsTlsClientConnection a, IsSocketConnectable b) => MethodInfo * TlsClientConnectionSetServerIdentityMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionSetServerIdentityMethodInfo a -> signature -> s #

tlsClientConnectionSetServerIdentity Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a, IsSocketConnectable b)
=> a	`conn`: the `TlsClientConnection`
-> b	`identity`: a `SocketConnectable` describing the expected server identity
-> 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.28

setUseSsl3

data TlsClientConnectionSetUseSsl3MethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsTlsClientConnection a) => MethodInfo * TlsClientConnectionSetUseSsl3MethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionSetUseSsl3MethodInfo a -> signature -> s #

tlsClientConnectionSetUseSsl3 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a)
=> a	`conn`: the `TlsClientConnection`
-> Bool	`useSsl3`: whether to use SSL 3.0
-> m ()

If useSsl3 is True, this forces conn to use SSL 3.0 rather than trying to properly negotiate the right version of TLS or SSL to use. This can be used when talking to servers that do not implement the fallbacks correctly and which will therefore fail to handshake with a "modern" TLS handshake attempt.

Since: 2.28

setValidationFlags

data TlsClientConnectionSetValidationFlagsMethodInfo Source #

Instances

((~) * signature ([TlsCertificateFlags] -> m ()), MonadIO m, IsTlsClientConnection a) => MethodInfo * TlsClientConnectionSetValidationFlagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy TlsClientConnectionSetValidationFlagsMethodInfo a -> signature -> s #

tlsClientConnectionSetValidationFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsClientConnection a)
=> a	`conn`: the `TlsClientConnection`
-> [TlsCertificateFlags]	`flags`: the `TlsCertificateFlags` to use
-> m ()

Sets conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, TlsCertificateFlagsValidateAll is used.

Since: 2.28

Properties

acceptedCas

data TlsClientConnectionAcceptedCasPropertyInfo Source #

Instances

AttrInfo TlsClientConnectionAcceptedCasPropertyInfo Source #
Associated Types type AttrAllowedOps TlsClientConnectionAcceptedCasPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo :: * -> Constraint # type AttrGetType TlsClientConnectionAcceptedCasPropertyInfo :: * # type AttrLabel TlsClientConnectionAcceptedCasPropertyInfo :: Symbol # type AttrOrigin TlsClientConnectionAcceptedCasPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo o => Proxy * TlsClientConnectionAcceptedCasPropertyInfo -> o -> IO (AttrGetType TlsClientConnectionAcceptedCasPropertyInfo) # attrSet :: (AttrBaseTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo o, AttrSetTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo b) => Proxy * TlsClientConnectionAcceptedCasPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo o => Proxy * TlsClientConnectionAcceptedCasPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo o, AttrSetTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo b) => Proxy * TlsClientConnectionAcceptedCasPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin TlsClientConnectionAcceptedCasPropertyInfo Source #
type AttrOrigin TlsClientConnectionAcceptedCasPropertyInfo = TlsClientConnection
type AttrLabel TlsClientConnectionAcceptedCasPropertyInfo Source #
type AttrLabel TlsClientConnectionAcceptedCasPropertyInfo = "accepted-cas"
type AttrGetType TlsClientConnectionAcceptedCasPropertyInfo Source #
type AttrGetType TlsClientConnectionAcceptedCasPropertyInfo = [Ptr ()]
type AttrBaseTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo Source #
type AttrBaseTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo = IsTlsClientConnection
type AttrSetTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo Source #
type AttrSetTypeConstraint TlsClientConnectionAcceptedCasPropertyInfo = * ~ ()
type AttrAllowedOps TlsClientConnectionAcceptedCasPropertyInfo Source #
type AttrAllowedOps TlsClientConnectionAcceptedCasPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getTlsClientConnectionAcceptedCas :: (MonadIO m, IsTlsClientConnection o) => o -> m [Ptr ()] Source #

tlsClientConnectionAcceptedCas :: AttrLabelProxy "acceptedCas" Source #

serverIdentity

data TlsClientConnectionServerIdentityPropertyInfo Source #

Instances

AttrInfo TlsClientConnectionServerIdentityPropertyInfo Source #
Associated Types type AttrAllowedOps TlsClientConnectionServerIdentityPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint TlsClientConnectionServerIdentityPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint TlsClientConnectionServerIdentityPropertyInfo :: * -> Constraint # type AttrGetType TlsClientConnectionServerIdentityPropertyInfo :: * # type AttrLabel TlsClientConnectionServerIdentityPropertyInfo :: Symbol # type AttrOrigin TlsClientConnectionServerIdentityPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint TlsClientConnectionServerIdentityPropertyInfo o => Proxy * TlsClientConnectionServerIdentityPropertyInfo -> o -> IO (AttrGetType TlsClientConnectionServerIdentityPropertyInfo) # attrSet :: (AttrBaseTypeConstraint TlsClientConnectionServerIdentityPropertyInfo o, AttrSetTypeConstraint TlsClientConnectionServerIdentityPropertyInfo b) => Proxy * TlsClientConnectionServerIdentityPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint TlsClientConnectionServerIdentityPropertyInfo o => Proxy * TlsClientConnectionServerIdentityPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint TlsClientConnectionServerIdentityPropertyInfo o, AttrSetTypeConstraint TlsClientConnectionServerIdentityPropertyInfo b) => Proxy * TlsClientConnectionServerIdentityPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin TlsClientConnectionServerIdentityPropertyInfo Source #
type AttrOrigin TlsClientConnectionServerIdentityPropertyInfo = TlsClientConnection
type AttrLabel TlsClientConnectionServerIdentityPropertyInfo Source #
type AttrLabel TlsClientConnectionServerIdentityPropertyInfo = "server-identity"
type AttrGetType TlsClientConnectionServerIdentityPropertyInfo Source #
type AttrGetType TlsClientConnectionServerIdentityPropertyInfo = SocketConnectable
type AttrBaseTypeConstraint TlsClientConnectionServerIdentityPropertyInfo Source #
type AttrBaseTypeConstraint TlsClientConnectionServerIdentityPropertyInfo = IsTlsClientConnection
type AttrSetTypeConstraint TlsClientConnectionServerIdentityPropertyInfo Source #
type AttrSetTypeConstraint TlsClientConnectionServerIdentityPropertyInfo = IsSocketConnectable
type AttrAllowedOps TlsClientConnectionServerIdentityPropertyInfo Source #
type AttrAllowedOps TlsClientConnectionServerIdentityPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructTlsClientConnectionServerIdentity :: (IsTlsClientConnection o, IsSocketConnectable a) => a -> IO (GValueConstruct o) Source #

getTlsClientConnectionServerIdentity :: (MonadIO m, IsTlsClientConnection o) => o -> m SocketConnectable Source #

setTlsClientConnectionServerIdentity :: (MonadIO m, IsTlsClientConnection o, IsSocketConnectable a) => o -> a -> m () Source #

tlsClientConnectionServerIdentity :: AttrLabelProxy "serverIdentity" Source #

useSsl3

data TlsClientConnectionUseSsl3PropertyInfo Source #

Instances

AttrInfo TlsClientConnectionUseSsl3PropertyInfo Source #
Associated Types type AttrAllowedOps TlsClientConnectionUseSsl3PropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint TlsClientConnectionUseSsl3PropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint TlsClientConnectionUseSsl3PropertyInfo :: * -> Constraint # type AttrGetType TlsClientConnectionUseSsl3PropertyInfo :: * # type AttrLabel TlsClientConnectionUseSsl3PropertyInfo :: Symbol # type AttrOrigin TlsClientConnectionUseSsl3PropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint TlsClientConnectionUseSsl3PropertyInfo o => Proxy * TlsClientConnectionUseSsl3PropertyInfo -> o -> IO (AttrGetType TlsClientConnectionUseSsl3PropertyInfo) # attrSet :: (AttrBaseTypeConstraint TlsClientConnectionUseSsl3PropertyInfo o, AttrSetTypeConstraint TlsClientConnectionUseSsl3PropertyInfo b) => Proxy * TlsClientConnectionUseSsl3PropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint TlsClientConnectionUseSsl3PropertyInfo o => Proxy * TlsClientConnectionUseSsl3PropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint TlsClientConnectionUseSsl3PropertyInfo o, AttrSetTypeConstraint TlsClientConnectionUseSsl3PropertyInfo b) => Proxy * TlsClientConnectionUseSsl3PropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin TlsClientConnectionUseSsl3PropertyInfo Source #
type AttrOrigin TlsClientConnectionUseSsl3PropertyInfo = TlsClientConnection
type AttrLabel TlsClientConnectionUseSsl3PropertyInfo Source #
type AttrLabel TlsClientConnectionUseSsl3PropertyInfo = "use-ssl3"
type AttrGetType TlsClientConnectionUseSsl3PropertyInfo Source #
type AttrGetType TlsClientConnectionUseSsl3PropertyInfo = Bool
type AttrBaseTypeConstraint TlsClientConnectionUseSsl3PropertyInfo Source #
type AttrBaseTypeConstraint TlsClientConnectionUseSsl3PropertyInfo = IsTlsClientConnection
type AttrSetTypeConstraint TlsClientConnectionUseSsl3PropertyInfo Source #
type AttrSetTypeConstraint TlsClientConnectionUseSsl3PropertyInfo = * ~ Bool
type AttrAllowedOps TlsClientConnectionUseSsl3PropertyInfo Source #
type AttrAllowedOps TlsClientConnectionUseSsl3PropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructTlsClientConnectionUseSsl3 :: IsTlsClientConnection o => Bool -> IO (GValueConstruct o) Source #

getTlsClientConnectionUseSsl3 :: (MonadIO m, IsTlsClientConnection o) => o -> m Bool Source #

setTlsClientConnectionUseSsl3 :: (MonadIO m, IsTlsClientConnection o) => o -> Bool -> m () Source #

tlsClientConnectionUseSsl3 :: AttrLabelProxy "useSsl3" Source #

validationFlags

data TlsClientConnectionValidationFlagsPropertyInfo Source #

Instances

AttrInfo TlsClientConnectionValidationFlagsPropertyInfo Source #
Associated Types type AttrAllowedOps TlsClientConnectionValidationFlagsPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo :: * -> Constraint # type AttrGetType TlsClientConnectionValidationFlagsPropertyInfo :: * # type AttrLabel TlsClientConnectionValidationFlagsPropertyInfo :: Symbol # type AttrOrigin TlsClientConnectionValidationFlagsPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo o => Proxy * TlsClientConnectionValidationFlagsPropertyInfo -> o -> IO (AttrGetType TlsClientConnectionValidationFlagsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo o, AttrSetTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo b) => Proxy * TlsClientConnectionValidationFlagsPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo o => Proxy * TlsClientConnectionValidationFlagsPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo o, AttrSetTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo b) => Proxy * TlsClientConnectionValidationFlagsPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin TlsClientConnectionValidationFlagsPropertyInfo Source #
type AttrOrigin TlsClientConnectionValidationFlagsPropertyInfo = TlsClientConnection
type AttrLabel TlsClientConnectionValidationFlagsPropertyInfo Source #
type AttrLabel TlsClientConnectionValidationFlagsPropertyInfo = "validation-flags"
type AttrGetType TlsClientConnectionValidationFlagsPropertyInfo Source #
type AttrGetType TlsClientConnectionValidationFlagsPropertyInfo = [TlsCertificateFlags]
type AttrBaseTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo Source #
type AttrBaseTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo = IsTlsClientConnection
type AttrSetTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo Source #
type AttrSetTypeConstraint TlsClientConnectionValidationFlagsPropertyInfo = * ~ [TlsCertificateFlags]
type AttrAllowedOps TlsClientConnectionValidationFlagsPropertyInfo Source #
type AttrAllowedOps TlsClientConnectionValidationFlagsPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructTlsClientConnectionValidationFlags :: IsTlsClientConnection o => [TlsCertificateFlags] -> IO (GValueConstruct o) Source #

getTlsClientConnectionValidationFlags :: (MonadIO m, IsTlsClientConnection o) => o -> m [TlsCertificateFlags] Source #

setTlsClientConnectionValidationFlags :: (MonadIO m, IsTlsClientConnection o) => o -> [TlsCertificateFlags] -> m () Source #

tlsClientConnectionValidationFlags :: AttrLabelProxy "validationFlags" Source #