GI.Soup.Objects.Auth

The abstract base class for handling authentication. Specific HTTP Authentication mechanisms are implemented by its subclasses, but applications never need to be aware of the specific subclasses being used.

Exported types

newtype Auth

Constructors

Auth (ManagedPtr Auth)

Instances

GObject Auth

Methods

gobjectType :: Auth -> IO GType

IsObject Auth

IsAuth Auth

((~) * info (ResolveAuthMethod t Auth), MethodInfo * info Auth p) => IsLabel t (Auth -> p)

Methods

fromLabel :: Proxy# Symbol t -> Auth -> p

((~) * info (ResolveAuthMethod t Auth), MethodInfo * info Auth p) => IsLabelProxy t (Auth -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Auth -> p

HasAttributeList * Auth

type AttributeList Auth

type AttributeList Auth

type SignalList Auth

type SignalList Auth

class GObject o => IsAuth o

Instances

(GObject a, UnknownAncestorError Constraint Auth a) => IsAuth a

IsAuth Auth

IsAuth AuthBasic

IsAuth AuthDigest

IsAuth AuthNTLM

IsAuth AuthNegotiate

toAuth :: IsAuth o => o -> IO Auth

noAuth :: Maybe Auth

Methods

authenticate

data AuthAuthenticateMethodInfo

Instances

((~) * signature (Text -> Text -> m ()), MonadIO m, IsAuth a) => MethodInfo * AuthAuthenticateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthAuthenticateMethodInfo a -> signature -> s

authAuthenticate

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> Text

username: the username provided by the user or client

-> Text

password: the password provided by the user or client

-> m ()

Call this on an auth to authenticate it; normally this will cause the auth's message to be requeued with the new authentication info.

canAuthenticate

data AuthCanAuthenticateMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsAuth a) => MethodInfo * AuthCanAuthenticateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthCanAuthenticateMethodInfo a -> signature -> s

authCanAuthenticate

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> m Bool

Returns: True if auth is able to accept credentials.

Tests if auth is able to authenticate by providing credentials to the authAuthenticate.

Since: 2.54

getAuthorization

data AuthGetAuthorizationMethodInfo

Instances

((~) * signature (b -> m Text), MonadIO m, IsAuth a, IsMessage b) => MethodInfo * AuthGetAuthorizationMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetAuthorizationMethodInfo a -> signature -> s

authGetAuthorization

Arguments

:: (HasCallStack, MonadIO m, IsAuth a, IsMessage b)

=> a

auth: a Auth

-> b

msg: the Message to be authorized

-> m Text

Returns: the "Authorization" header, which must be freed.

Generates an appropriate "Authorization" header for msg. (The session will only call this if authIsAuthenticated returned True.)

getHost

data AuthGetHostMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsAuth a) => MethodInfo * AuthGetHostMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetHostMethodInfo a -> signature -> s

authGetHost

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> m Text

Returns: the hostname

Returns the host that auth is associated with.

getInfo

data AuthGetInfoMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsAuth a) => MethodInfo * AuthGetInfoMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetInfoMethodInfo a -> signature -> s

authGetInfo

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> m Text

Returns: the identifier

Gets an opaque identifier for auth, for use as a hash key or the like. Auth objects from the same server with the same identifier refer to the same authentication domain (eg, the URLs associated with them take the same usernames and passwords).

getProtectionSpace

data AuthGetProtectionSpaceMethodInfo

Instances

((~) * signature (URI -> m [Text]), MonadIO m, IsAuth a) => MethodInfo * AuthGetProtectionSpaceMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetProtectionSpaceMethodInfo a -> signature -> s

authGetProtectionSpace

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> URI

sourceUri: the URI of the request that auth was generated in response to.

-> m [Text]

Returns: the list of paths, which can be freed with soup_auth_free_protection_space().

Returns a list of paths on the server which auth extends over. (All subdirectories of these paths are also assumed to be part of auth's protection space, unless otherwise discovered not to be.)

getRealm

data AuthGetRealmMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsAuth a) => MethodInfo * AuthGetRealmMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetRealmMethodInfo a -> signature -> s

authGetRealm

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> m Text

Returns: the realm name

Returns auth's realm. This is an identifier that distinguishes separate authentication spaces on a given server, and may be some string that is meaningful to the user. (Although it is probably not localized.)

getSavedPassword

data AuthGetSavedPasswordMethodInfo

Instances

((~) * signature (Text -> m Text), MonadIO m, IsAuth a) => MethodInfo * AuthGetSavedPasswordMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetSavedPasswordMethodInfo a -> signature -> s

authGetSavedPassword :: (HasCallStack, MonadIO m, IsAuth a) => a -> Text -> m Text

No description available in the introspection data.

getSavedUsers

data AuthGetSavedUsersMethodInfo

Instances

((~) * signature (m [Text]), MonadIO m, IsAuth a) => MethodInfo * AuthGetSavedUsersMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetSavedUsersMethodInfo a -> signature -> s

authGetSavedUsers :: (HasCallStack, MonadIO m, IsAuth a) => a -> m [Text]

No description available in the introspection data.

getSchemeName

data AuthGetSchemeNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsAuth a) => MethodInfo * AuthGetSchemeNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthGetSchemeNameMethodInfo a -> signature -> s

authGetSchemeName

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> m Text

Returns: the scheme name

Returns auth's scheme name. (Eg, "Basic", "Digest", or "NTLM")

hasSavedPassword

data AuthHasSavedPasswordMethodInfo

Instances

((~) * signature (Text -> Text -> m ()), MonadIO m, IsAuth a) => MethodInfo * AuthHasSavedPasswordMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthHasSavedPasswordMethodInfo a -> signature -> s

authHasSavedPassword :: (HasCallStack, MonadIO m, IsAuth a) => a -> Text -> Text -> m ()

No description available in the introspection data.

isAuthenticated

data AuthIsAuthenticatedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsAuth a) => MethodInfo * AuthIsAuthenticatedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthIsAuthenticatedMethodInfo a -> signature -> s

authIsAuthenticated

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> m Bool

Returns: True if auth has been given a username and password

Tests if auth has been given a username and password

isForProxy

data AuthIsForProxyMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsAuth a) => MethodInfo * AuthIsForProxyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthIsForProxyMethodInfo a -> signature -> s

authIsForProxy

Arguments

:: (HasCallStack, MonadIO m, IsAuth a)

=> a

auth: a Auth

-> m Bool

Returns: True or False

Tests whether or not auth is associated with a proxy server rather than an "origin" server.

isReady

data AuthIsReadyMethodInfo

Instances

((~) * signature (b -> m Bool), MonadIO m, IsAuth a, IsMessage b) => MethodInfo * AuthIsReadyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthIsReadyMethodInfo a -> signature -> s

authIsReady

Arguments

:: (HasCallStack, MonadIO m, IsAuth a, IsMessage b)

=> a

auth: a Auth

-> b

msg: a Message

-> m Bool

Returns: True if auth is ready to make a request with.

Tests if auth is ready to make a request for msg with. For most auths, this is equivalent to authIsAuthenticated, but for some auth types (eg, NTLM), the auth may be sendable (eg, as an authentication request) even before it is authenticated.

Since: 2.42

new

authNew

Arguments

:: (HasCallStack, MonadIO m, IsMessage a)

=> GType

type: the type of auth to create (a subtype of Auth)

-> a

msg: the Message the auth is being created for

-> Text

authHeader: the WWW-Authenticate/Proxy-Authenticate header

-> m (Maybe Auth)

Returns: the new Auth, or Nothing if it could not be created

Creates a new Auth of type type with the information from msg and authHeader.

This is called by Session; you will normally not create auths yourself.

savePassword

data AuthSavePasswordMethodInfo

Instances

((~) * signature (Text -> Text -> m ()), MonadIO m, IsAuth a) => MethodInfo * AuthSavePasswordMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthSavePasswordMethodInfo a -> signature -> s

authSavePassword :: (HasCallStack, MonadIO m, IsAuth a) => a -> Text -> Text -> m ()

No description available in the introspection data.

update

data AuthUpdateMethodInfo

Instances

((~) * signature (b -> Text -> m Bool), MonadIO m, IsAuth a, IsMessage b) => MethodInfo * AuthUpdateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AuthUpdateMethodInfo a -> signature -> s

authUpdate

Arguments

:: (HasCallStack, MonadIO m, IsAuth a, IsMessage b)

=> a

auth: a Auth

-> b

msg: the Message auth is being updated for

-> Text

authHeader: the WWW-Authenticate/Proxy-Authenticate header

-> m Bool

Returns: True if auth is still a valid (but potentially unauthenticated) Auth. False if something about authParams could not be parsed or incorporated into auth at all.

Updates auth with the information from msg and authHeader, possibly un-authenticating it. As with authNew, this is normally only used by Session.

Properties

host

data AuthHostPropertyInfo

Instances

AttrInfo AuthHostPropertyInfo

Associated Types

type AttrAllowedOps AuthHostPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AuthHostPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AuthHostPropertyInfo :: * -> Constraint

type AttrGetType AuthHostPropertyInfo :: *

type AttrLabel AuthHostPropertyInfo :: Symbol

type AttrOrigin AuthHostPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AuthHostPropertyInfo o => Proxy * AuthHostPropertyInfo -> o -> IO (AttrGetType AuthHostPropertyInfo)

attrSet :: (AttrBaseTypeConstraint AuthHostPropertyInfo o, AttrSetTypeConstraint AuthHostPropertyInfo b) => Proxy * AuthHostPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AuthHostPropertyInfo o => Proxy * AuthHostPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AuthHostPropertyInfo o, AttrSetTypeConstraint AuthHostPropertyInfo b) => Proxy * AuthHostPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AuthHostPropertyInfo

type AttrOrigin AuthHostPropertyInfo = Auth

type AttrLabel AuthHostPropertyInfo

type AttrLabel AuthHostPropertyInfo = "host"

type AttrGetType AuthHostPropertyInfo

type AttrGetType AuthHostPropertyInfo = Text

type AttrBaseTypeConstraint AuthHostPropertyInfo

type AttrBaseTypeConstraint AuthHostPropertyInfo = IsAuth

type AttrSetTypeConstraint AuthHostPropertyInfo

type AttrSetTypeConstraint AuthHostPropertyInfo = * ~ Text

type AttrAllowedOps AuthHostPropertyInfo

type AttrAllowedOps AuthHostPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

authHost :: AttrLabelProxy "host"

clearAuthHost :: (MonadIO m, IsAuth o) => o -> m ()

constructAuthHost :: IsAuth o => Text -> IO (GValueConstruct o)

getAuthHost :: (MonadIO m, IsAuth o) => o -> m Text

setAuthHost :: (MonadIO m, IsAuth o) => o -> Text -> m ()

isAuthenticated

data AuthIsAuthenticatedPropertyInfo

Instances

AttrInfo AuthIsAuthenticatedPropertyInfo

Associated Types

type AttrAllowedOps AuthIsAuthenticatedPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AuthIsAuthenticatedPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AuthIsAuthenticatedPropertyInfo :: * -> Constraint

type AttrGetType AuthIsAuthenticatedPropertyInfo :: *

type AttrLabel AuthIsAuthenticatedPropertyInfo :: Symbol

type AttrOrigin AuthIsAuthenticatedPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AuthIsAuthenticatedPropertyInfo o => Proxy * AuthIsAuthenticatedPropertyInfo -> o -> IO (AttrGetType AuthIsAuthenticatedPropertyInfo)

attrSet :: (AttrBaseTypeConstraint AuthIsAuthenticatedPropertyInfo o, AttrSetTypeConstraint AuthIsAuthenticatedPropertyInfo b) => Proxy * AuthIsAuthenticatedPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AuthIsAuthenticatedPropertyInfo o => Proxy * AuthIsAuthenticatedPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AuthIsAuthenticatedPropertyInfo o, AttrSetTypeConstraint AuthIsAuthenticatedPropertyInfo b) => Proxy * AuthIsAuthenticatedPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AuthIsAuthenticatedPropertyInfo

type AttrOrigin AuthIsAuthenticatedPropertyInfo = Auth

type AttrLabel AuthIsAuthenticatedPropertyInfo

type AttrLabel AuthIsAuthenticatedPropertyInfo = "is-authenticated"

type AttrGetType AuthIsAuthenticatedPropertyInfo

type AttrGetType AuthIsAuthenticatedPropertyInfo = Bool

type AttrBaseTypeConstraint AuthIsAuthenticatedPropertyInfo

type AttrBaseTypeConstraint AuthIsAuthenticatedPropertyInfo = IsAuth

type AttrSetTypeConstraint AuthIsAuthenticatedPropertyInfo

type AttrSetTypeConstraint AuthIsAuthenticatedPropertyInfo = * ~ ()

type AttrAllowedOps AuthIsAuthenticatedPropertyInfo

type AttrAllowedOps AuthIsAuthenticatedPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getAuthIsAuthenticated :: (MonadIO m, IsAuth o) => o -> m Bool

isForProxy

data AuthIsForProxyPropertyInfo

Instances

AttrInfo AuthIsForProxyPropertyInfo

Associated Types

type AttrAllowedOps AuthIsForProxyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AuthIsForProxyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AuthIsForProxyPropertyInfo :: * -> Constraint

type AttrGetType AuthIsForProxyPropertyInfo :: *

type AttrLabel AuthIsForProxyPropertyInfo :: Symbol

type AttrOrigin AuthIsForProxyPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AuthIsForProxyPropertyInfo o => Proxy * AuthIsForProxyPropertyInfo -> o -> IO (AttrGetType AuthIsForProxyPropertyInfo)

attrSet :: (AttrBaseTypeConstraint AuthIsForProxyPropertyInfo o, AttrSetTypeConstraint AuthIsForProxyPropertyInfo b) => Proxy * AuthIsForProxyPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AuthIsForProxyPropertyInfo o => Proxy * AuthIsForProxyPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AuthIsForProxyPropertyInfo o, AttrSetTypeConstraint AuthIsForProxyPropertyInfo b) => Proxy * AuthIsForProxyPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AuthIsForProxyPropertyInfo

type AttrOrigin AuthIsForProxyPropertyInfo = Auth

type AttrLabel AuthIsForProxyPropertyInfo

type AttrLabel AuthIsForProxyPropertyInfo = "is-for-proxy"

type AttrGetType AuthIsForProxyPropertyInfo

type AttrGetType AuthIsForProxyPropertyInfo = Bool

type AttrBaseTypeConstraint AuthIsForProxyPropertyInfo

type AttrBaseTypeConstraint AuthIsForProxyPropertyInfo = IsAuth

type AttrSetTypeConstraint AuthIsForProxyPropertyInfo

type AttrSetTypeConstraint AuthIsForProxyPropertyInfo = * ~ Bool

type AttrAllowedOps AuthIsForProxyPropertyInfo

type AttrAllowedOps AuthIsForProxyPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructAuthIsForProxy :: IsAuth o => Bool -> IO (GValueConstruct o)

getAuthIsForProxy :: (MonadIO m, IsAuth o) => o -> m Bool

setAuthIsForProxy :: (MonadIO m, IsAuth o) => o -> Bool -> m ()

realm

data AuthRealmPropertyInfo

Instances

AttrInfo AuthRealmPropertyInfo

Associated Types

type AttrAllowedOps AuthRealmPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AuthRealmPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AuthRealmPropertyInfo :: * -> Constraint

type AttrGetType AuthRealmPropertyInfo :: *

type AttrLabel AuthRealmPropertyInfo :: Symbol

type AttrOrigin AuthRealmPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AuthRealmPropertyInfo o => Proxy * AuthRealmPropertyInfo -> o -> IO (AttrGetType AuthRealmPropertyInfo)

attrSet :: (AttrBaseTypeConstraint AuthRealmPropertyInfo o, AttrSetTypeConstraint AuthRealmPropertyInfo b) => Proxy * AuthRealmPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AuthRealmPropertyInfo o => Proxy * AuthRealmPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AuthRealmPropertyInfo o, AttrSetTypeConstraint AuthRealmPropertyInfo b) => Proxy * AuthRealmPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AuthRealmPropertyInfo

type AttrOrigin AuthRealmPropertyInfo = Auth

type AttrLabel AuthRealmPropertyInfo

type AttrLabel AuthRealmPropertyInfo = "realm"

type AttrGetType AuthRealmPropertyInfo

type AttrGetType AuthRealmPropertyInfo = Text

type AttrBaseTypeConstraint AuthRealmPropertyInfo

type AttrBaseTypeConstraint AuthRealmPropertyInfo = IsAuth

type AttrSetTypeConstraint AuthRealmPropertyInfo

type AttrSetTypeConstraint AuthRealmPropertyInfo = * ~ Text

type AttrAllowedOps AuthRealmPropertyInfo

type AttrAllowedOps AuthRealmPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

authRealm :: AttrLabelProxy "realm"

clearAuthRealm :: (MonadIO m, IsAuth o) => o -> m ()

constructAuthRealm :: IsAuth o => Text -> IO (GValueConstruct o)

getAuthRealm :: (MonadIO m, IsAuth o) => o -> m Text

setAuthRealm :: (MonadIO m, IsAuth o) => o -> Text -> m ()

schemeName

data AuthSchemeNamePropertyInfo

Instances

AttrInfo AuthSchemeNamePropertyInfo

Associated Types

type AttrAllowedOps AuthSchemeNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AuthSchemeNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AuthSchemeNamePropertyInfo :: * -> Constraint

type AttrGetType AuthSchemeNamePropertyInfo :: *

type AttrLabel AuthSchemeNamePropertyInfo :: Symbol

type AttrOrigin AuthSchemeNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AuthSchemeNamePropertyInfo o => Proxy * AuthSchemeNamePropertyInfo -> o -> IO (AttrGetType AuthSchemeNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint AuthSchemeNamePropertyInfo o, AttrSetTypeConstraint AuthSchemeNamePropertyInfo b) => Proxy * AuthSchemeNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AuthSchemeNamePropertyInfo o => Proxy * AuthSchemeNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AuthSchemeNamePropertyInfo o, AttrSetTypeConstraint AuthSchemeNamePropertyInfo b) => Proxy * AuthSchemeNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AuthSchemeNamePropertyInfo

type AttrOrigin AuthSchemeNamePropertyInfo = Auth

type AttrLabel AuthSchemeNamePropertyInfo

type AttrLabel AuthSchemeNamePropertyInfo = "scheme-name"

type AttrGetType AuthSchemeNamePropertyInfo

type AttrGetType AuthSchemeNamePropertyInfo = Text

type AttrBaseTypeConstraint AuthSchemeNamePropertyInfo

type AttrBaseTypeConstraint AuthSchemeNamePropertyInfo = IsAuth

type AttrSetTypeConstraint AuthSchemeNamePropertyInfo

type AttrSetTypeConstraint AuthSchemeNamePropertyInfo = * ~ ()

type AttrAllowedOps AuthSchemeNamePropertyInfo

type AttrAllowedOps AuthSchemeNamePropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

authSchemeName :: AttrLabelProxy "schemeName"

getAuthSchemeName :: (MonadIO m, IsAuth o) => o -> m Text