GI.Soup.Objects.AuthDomainDigest

No description available in the introspection data.

Exported types

newtype AuthDomainDigest

Memory-managed wrapper type.

Constructors

AuthDomainDigest (ManagedPtr AuthDomainDigest)

Instances

GObject AuthDomainDigest

Defined in GI.Soup.Objects.AuthDomainDigest

Methods

gobjectType :: IO GType

HasParentTypes AuthDomainDigest

Defined in GI.Soup.Objects.AuthDomainDigest

type ParentTypes AuthDomainDigest

Defined in GI.Soup.Objects.AuthDomainDigest

type ParentTypes AuthDomainDigest = AuthDomain ': (Object ': ([] :: [Type]))

class (GObject o, IsDescendantOf AuthDomainDigest o) => IsAuthDomainDigest o

Type class for types which can be safely cast to AuthDomainDigest, for instance with toAuthDomainDigest.

Instances

(GObject o, IsDescendantOf AuthDomainDigest o) => IsAuthDomainDigest o

Defined in GI.Soup.Objects.AuthDomainDigest

toAuthDomainDigest :: (MonadIO m, IsAuthDomainDigest o) => o -> m AuthDomainDigest

Cast to AuthDomainDigest, for types for which this is known to be safe. For general casts, use castTo.

noAuthDomainDigest :: Maybe AuthDomainDigest

A convenience alias for Nothing :: Maybe AuthDomainDigest.

Methods

encodePassword

authDomainDigestEncodePassword

Arguments

:: (HasCallStack, MonadIO m)

=> Text

username: a username

-> Text

realm: an auth realm name

-> Text

password: the password for username in realm

-> m Text

Returns: the encoded password

Encodes the username/realm/password triplet for Digest authentication. (That is, it returns a stringified MD5 hash of username, realm, and password concatenated together). This is the form that is needed as the return value of 'GI.Soup.Objects.AuthDomainDigest.AuthDomainDigest'\'s auth handler.

For security reasons, you should store the encoded hash, rather than storing the cleartext password itself and calling this method only when you need to verify it. This way, if your server is compromised, the attackers will not gain access to cleartext passwords which might also be usable at other sites. (Note also that the encoded password returned by this method is identical to the encoded password stored in an Apache .htdigest file.)

setAuthCallback

authDomainDigestSetAuthCallback

Arguments

:: (HasCallStack, MonadIO m, IsAuthDomainDigest a)

=> a

domain: the domain

-> AuthDomainDigestAuthCallback

callback: the callback

-> m ()

Sets the callback that domain will use to authenticate incoming requests. For each request containing authorization, domain will invoke the callback, and then either accept or reject the request based on callback's return value.

You can also set the auth callback by setting the AUTH_DOMAIN_DIGEST_AUTH_CALLBACK and AUTH_DOMAIN_DIGEST_AUTH_DATA properties, which can also be used to set the callback at construct time.

Properties

authCallback

The AuthDomainDigestAuthCallback

clearAuthDomainDigestAuthCallback :: (MonadIO m, IsAuthDomainDigest o) => o -> m ()

Set the value of the “auth-callback” property to Nothing. When overloading is enabled, this is equivalent to

clear #authCallback

constructAuthDomainDigestAuthCallback :: IsAuthDomainDigest o => FunPtr C_AuthDomainDigestAuthCallback -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “auth-callback” property. This is rarely needed directly, but it is used by new.

getAuthDomainDigestAuthCallback :: (MonadIO m, IsAuthDomainDigest o) => o -> m (Maybe AuthDomainDigestAuthCallback_WithClosures)

Get the value of the “auth-callback” property. When overloading is enabled, this is equivalent to

get authDomainDigest #authCallback

setAuthDomainDigestAuthCallback :: (MonadIO m, IsAuthDomainDigest o) => o -> FunPtr C_AuthDomainDigestAuthCallback -> m ()

Set the value of the “auth-callback” property. When overloading is enabled, this is equivalent to

set authDomainDigest [ #authCallback := value ]

authData

The data to pass to the AuthDomainDigestAuthCallback

constructAuthDomainDigestAuthData :: IsAuthDomainDigest o => Ptr () -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “auth-data” property. This is rarely needed directly, but it is used by new.

getAuthDomainDigestAuthData :: (MonadIO m, IsAuthDomainDigest o) => o -> m (Ptr ())

Get the value of the “auth-data” property. When overloading is enabled, this is equivalent to

get authDomainDigest #authData

setAuthDomainDigestAuthData :: (MonadIO m, IsAuthDomainDigest o) => o -> Ptr () -> m ()

Set the value of the “auth-data” property. When overloading is enabled, this is equivalent to

set authDomainDigest [ #authData := value ]