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.Objects.TlsInteraction

Contents

Exported types
Methods

Description

GTlsInteraction provides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user for passwords.

To use a GTlsInteraction with a TLS connection use tlsConnectionSetInteraction.

Callers should instantiate a derived class that implements the various interaction methods to show the required dialogs.

Callers should use the 'invoke' functions like tlsInteractionInvokeAskPassword to run interaction methods. These functions make sure that the interaction is invoked in the main loop and not in the current thread, if the current thread is not running the main loop.

Derived classes can choose to implement whichever interactions methods they’d like to support by overriding those virtual methods in their class initialization function. Any interactions not implemented will return G_TLS_INTERACTION_UNHANDLED. If a derived class implements an async method, it must also implement the corresponding finish method.

Since: 2.30

Synopsis

newtype TlsInteraction = TlsInteraction (ManagedPtr TlsInteraction)
class (GObject o, IsDescendantOf TlsInteraction o) => IsTlsInteraction o
toTlsInteraction :: (MonadIO m, IsTlsInteraction o) => o -> m TlsInteraction
type family ResolveTlsInteractionMethod (t :: Symbol) o where ...
data TlsInteractionAskPasswordMethodInfo
tlsInteractionAskPassword :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c) => a -> b -> Maybe c -> m TlsInteractionResult
data TlsInteractionAskPasswordAsyncMethodInfo
tlsInteractionAskPasswordAsync :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c) => a -> b -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data TlsInteractionAskPasswordFinishMethodInfo
tlsInteractionAskPasswordFinish :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsAsyncResult b) => a -> b -> m TlsInteractionResult
data TlsInteractionInvokeAskPasswordMethodInfo
tlsInteractionInvokeAskPassword :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c) => a -> b -> Maybe c -> m TlsInteractionResult
data TlsInteractionInvokeRequestCertificateMethodInfo
tlsInteractionInvokeRequestCertificate :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c) => a -> b -> TlsCertificateRequestFlags -> Maybe c -> m TlsInteractionResult
data TlsInteractionRequestCertificateMethodInfo
tlsInteractionRequestCertificate :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c) => a -> b -> TlsCertificateRequestFlags -> Maybe c -> m TlsInteractionResult
data TlsInteractionRequestCertificateAsyncMethodInfo
tlsInteractionRequestCertificateAsync :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c) => a -> b -> TlsCertificateRequestFlags -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data TlsInteractionRequestCertificateFinishMethodInfo
tlsInteractionRequestCertificateFinish :: (HasCallStack, MonadIO m, IsTlsInteraction a, IsAsyncResult b) => a -> b -> m TlsInteractionResult

Exported types

newtype TlsInteraction Source #

Memory-managed wrapper type.

Constructors

TlsInteraction (ManagedPtr TlsInteraction)

Instances

Instances details

Eq TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods (==) :: TlsInteraction -> TlsInteraction -> Bool # (/=) :: TlsInteraction -> TlsInteraction -> Bool #
GObject TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction
ManagedPtrNewtype TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods toManagedPtr :: TlsInteraction -> ManagedPtr TlsInteraction #
TypedObject TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods glibType :: IO GType #
HasParentTypes TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction
HasAttributeList TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction
(info ~ ResolveTlsInteractionMethod t TlsInteraction, OverloadedMethod info TlsInteraction p, HasField t TlsInteraction p) => HasField (t :: Symbol) TlsInteraction (p :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods getField :: TlsInteraction -> p #
(info ~ ResolveTlsInteractionMethod t TlsInteraction, OverloadedMethodInfo info TlsInteraction) => IsLabel t (MethodProxy info TlsInteraction) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods fromLabel :: MethodProxy info TlsInteraction #
(info ~ ResolveTlsInteractionMethod t TlsInteraction, OverloadedMethod info TlsInteraction p) => IsLabel t (TlsInteraction -> p) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods fromLabel :: TlsInteraction -> p #
IsGValue (Maybe TlsInteraction) Source #	Convert `TlsInteraction` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe TlsInteraction -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe TlsInteraction) #
type AttributeList TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction type AttributeList TlsInteraction
type ParentTypes TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction type ParentTypes TlsInteraction = '[Object]
type SignalList TlsInteraction Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction type SignalList TlsInteraction

class (GObject o, IsDescendantOf TlsInteraction o) => IsTlsInteraction o Source #

Type class for types which can be safely cast to TlsInteraction, for instance with toTlsInteraction.

Instances

Instances details

(GObject o, IsDescendantOf TlsInteraction o) => IsTlsInteraction o Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction

toTlsInteraction :: (MonadIO m, IsTlsInteraction o) => o -> m TlsInteraction Source #

Cast to TlsInteraction, 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

Expand

Equations

ResolveTlsInteractionMethod "askPassword" o = TlsInteractionAskPasswordMethodInfo
ResolveTlsInteractionMethod "askPasswordAsync" o = TlsInteractionAskPasswordAsyncMethodInfo
ResolveTlsInteractionMethod "askPasswordFinish" o = TlsInteractionAskPasswordFinishMethodInfo
ResolveTlsInteractionMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveTlsInteractionMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveTlsInteractionMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveTlsInteractionMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveTlsInteractionMethod "getv" o = ObjectGetvMethodInfo
ResolveTlsInteractionMethod "invokeAskPassword" o = TlsInteractionInvokeAskPasswordMethodInfo
ResolveTlsInteractionMethod "invokeRequestCertificate" o = TlsInteractionInvokeRequestCertificateMethodInfo
ResolveTlsInteractionMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveTlsInteractionMethod "notify" o = ObjectNotifyMethodInfo
ResolveTlsInteractionMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveTlsInteractionMethod "ref" o = ObjectRefMethodInfo
ResolveTlsInteractionMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveTlsInteractionMethod "requestCertificate" o = TlsInteractionRequestCertificateMethodInfo
ResolveTlsInteractionMethod "requestCertificateAsync" o = TlsInteractionRequestCertificateAsyncMethodInfo
ResolveTlsInteractionMethod "requestCertificateFinish" o = TlsInteractionRequestCertificateFinishMethodInfo
ResolveTlsInteractionMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveTlsInteractionMethod "stealData" o = ObjectStealDataMethodInfo
ResolveTlsInteractionMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveTlsInteractionMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveTlsInteractionMethod "unref" o = ObjectUnrefMethodInfo
ResolveTlsInteractionMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveTlsInteractionMethod "getData" o = ObjectGetDataMethodInfo
ResolveTlsInteractionMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveTlsInteractionMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveTlsInteractionMethod "setData" o = ObjectSetDataMethodInfo
ResolveTlsInteractionMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveTlsInteractionMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveTlsInteractionMethod l o = MethodResolutionFailed l o :: Type

askPassword

data TlsInteractionAskPasswordMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Maybe c -> m TlsInteractionResult), MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c) => OverloadedMethod TlsInteractionAskPasswordMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionAskPasswordMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionAskPassword Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c)
=> a	`interaction`: a `TlsInteraction` object
-> b	`password`: a `TlsPassword` object
-> Maybe c	`cancellable`: an optional `Cancellable` cancellation object
-> m TlsInteractionResult	Returns: The status of the ask password interaction. (Can throw `GError`)

Run synchronous interaction to ask the user for a password. In general, tlsInteractionInvokeAskPassword should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResultFailed will be returned with an error that contains a IOErrorEnumCancelled error code. Certain implementations may not support immediate cancellation.

Since: 2.30

askPasswordAsync

data TlsInteractionAskPasswordAsyncMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c) => OverloadedMethod TlsInteractionAskPasswordAsyncMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionAskPasswordAsyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionAskPasswordAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c)
=> a	`interaction`: a `TlsInteraction` object
-> b	`password`: a `TlsPassword` object
-> Maybe c	`cancellable`: an optional `Cancellable` cancellation object
-> Maybe AsyncReadyCallback	`callback`: will be called when the interaction completes
-> m ()

Run asynchronous interaction to ask the user for a password. In general, tlsInteractionInvokeAskPassword should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResultFailed will be returned with an error that contains a IOErrorEnumCancelled error code. Certain implementations may not support immediate cancellation.

Certain implementations may not support immediate cancellation.

Since: 2.30

askPasswordFinish

data TlsInteractionAskPasswordFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m TlsInteractionResult), MonadIO m, IsTlsInteraction a, IsAsyncResult b) => OverloadedMethod TlsInteractionAskPasswordFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionAskPasswordFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionAskPasswordFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsAsyncResult b)
=> a	`interaction`: a `TlsInteraction` object
-> b	`result`: the result passed to the callback
-> m TlsInteractionResult	Returns: The status of the ask password interaction. (Can throw `GError`)

Complete an ask password user interaction request. This should be once the tlsInteractionAskPasswordAsync completion callback is called.

If TlsInteractionResultHandled is returned, then the TlsPassword passed to tlsInteractionAskPassword will have its password filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResultFailed will be returned with an error that contains a IOErrorEnumCancelled error code.

Since: 2.30

invokeAskPassword

data TlsInteractionInvokeAskPasswordMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Maybe c -> m TlsInteractionResult), MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c) => OverloadedMethod TlsInteractionInvokeAskPasswordMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionInvokeAskPasswordMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionInvokeAskPassword Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsPassword b, IsCancellable c)
=> a	`interaction`: a `TlsInteraction` object
-> b	`password`: a `TlsPassword` object
-> Maybe c	`cancellable`: an optional `Cancellable` cancellation object
-> m TlsInteractionResult	Returns: The status of the ask password interaction. (Can throw `GError`)

Invoke the interaction to ask the user for a password. It invokes this interaction in the main loop, specifically the MainContext returned by mainContextGetThreadDefault when the interaction is created. This is called by called by TlsConnection or TlsDatabase to ask the user for a password.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

The implementation can either be a synchronous (eg: modal dialog) or an asynchronous one (eg: modeless dialog). This function will take care of calling which ever one correctly.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResultFailed will be returned with an error that contains a IOErrorEnumCancelled error code. Certain implementations may not support immediate cancellation.

Since: 2.30

invokeRequestCertificate

data TlsInteractionInvokeRequestCertificateMethodInfo Source #

Instances

Instances details

(signature ~ (b -> TlsCertificateRequestFlags -> Maybe c -> m TlsInteractionResult), MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c) => OverloadedMethod TlsInteractionInvokeRequestCertificateMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionInvokeRequestCertificateMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionInvokeRequestCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c)
=> a	`interaction`: a `TlsInteraction` object
-> b	`connection`: a `TlsConnection` object
-> TlsCertificateRequestFlags	`flags`: flags providing more information about the request
-> Maybe c	`cancellable`: an optional `Cancellable` cancellation object
-> m TlsInteractionResult	Returns: The status of the certificate request interaction. (Can throw `GError`)

Invoke the interaction to ask the user to choose a certificate to use with the connection. It invokes this interaction in the main loop, specifically the MainContext returned by mainContextGetThreadDefault when the interaction is created. This is called by called by TlsConnection when the peer requests a certificate during the handshake.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. Alternatively the user may abort this certificate request, which may or may not abort the TLS connection.

The implementation can either be a synchronous (eg: modal dialog) or an asynchronous one (eg: modeless dialog). This function will take care of calling which ever one correctly.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResultFailed will be returned with an error that contains a IOErrorEnumCancelled error code. Certain implementations may not support immediate cancellation.

Since: 2.40

requestCertificate

data TlsInteractionRequestCertificateMethodInfo Source #

Instances

Instances details

(signature ~ (b -> TlsCertificateRequestFlags -> Maybe c -> m TlsInteractionResult), MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c) => OverloadedMethod TlsInteractionRequestCertificateMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionRequestCertificateMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionRequestCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c)
=> a	`interaction`: a `TlsInteraction` object
-> b	`connection`: a `TlsConnection` object
-> TlsCertificateRequestFlags	`flags`: flags providing more information about the request
-> Maybe c	`cancellable`: an optional `Cancellable` cancellation object
-> m TlsInteractionResult	Returns: The status of the request certificate interaction. (Can throw `GError`)

Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, tlsInteractionInvokeRequestCertificate should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

If TlsInteractionResultHandled is returned, then the TlsConnection passed to tlsInteractionRequestCertificate will have had its TlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResultFailed will be returned with an error that contains a IOErrorEnumCancelled error code. Certain implementations may not support immediate cancellation.

Since: 2.40

requestCertificateAsync

data TlsInteractionRequestCertificateAsyncMethodInfo Source #

Instances

Instances details

(signature ~ (b -> TlsCertificateRequestFlags -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c) => OverloadedMethod TlsInteractionRequestCertificateAsyncMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionRequestCertificateAsyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionRequestCertificateAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsTlsConnection b, IsCancellable c)
=> a	`interaction`: a `TlsInteraction` object
-> b	`connection`: a `TlsConnection` object
-> TlsCertificateRequestFlags	`flags`: flags providing more information about the request
-> Maybe c	`cancellable`: an optional `Cancellable` cancellation object
-> Maybe AsyncReadyCallback	`callback`: will be called when the interaction completes
-> m ()

Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, tlsInteractionInvokeRequestCertificate should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. callback will be called when the operation completes. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

Since: 2.40

requestCertificateFinish

data TlsInteractionRequestCertificateFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m TlsInteractionResult), MonadIO m, IsTlsInteraction a, IsAsyncResult b) => OverloadedMethod TlsInteractionRequestCertificateFinishMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo TlsInteractionRequestCertificateFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.TlsInteraction Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

tlsInteractionRequestCertificateFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsInteraction a, IsAsyncResult b)
=> a	`interaction`: a `TlsInteraction` object
-> b	`result`: the result passed to the callback
-> m TlsInteractionResult	Returns: The status of the request certificate interaction. (Can throw `GError`)

Complete a request certificate user interaction request. This should be once the tlsInteractionRequestCertificateAsync completion callback is called.

If TlsInteractionResultHandled is returned, then the TlsConnection passed to tlsInteractionRequestCertificateAsync will have had its TlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResultFailed will be returned with an error that contains a IOErrorEnumCancelled error code.

Since: 2.40

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

askPassword

Instances

askPasswordAsync

Instances

askPasswordFinish

Instances

invokeAskPassword

Instances

invokeRequestCertificate

Instances

requestCertificate

Instances

requestCertificateAsync

Instances

requestCertificateFinish

Instances