Soup.AuthDomainDigest¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
Password-finding callback |
||
r/w |
Data to pass to authentication callback |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Soup.AuthDomainDigest(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Server-side “Digest” authentication.
Soup.AuthDomainDigest
handles the server side of HTTP “Digest” authentication.- classmethod encode_password(username, realm, password)¶
- Parameters:
- Returns:
the encoded password
- Return type:
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
Soup.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.)
- set_auth_callback(callback, *user_data)¶
- Parameters:
callback (
Soup.AuthDomainDigestAuthCallback
) – the callback
Sets the callback that self will use to authenticate incoming requests.
For each request containing authorization, self 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 [property`AuthDomainDigest`:py:data::auth-callback<Soup.AuthDomainDigest.props.auth_callback>] and [property`AuthDomainDigest`:py:data::auth-data<Soup.AuthDomainDigest.props.auth_data>] properties, which can also be used to set the callback at construct time.
Property Details¶
- Soup.AuthDomainDigest.props.auth_callback¶
-
The [callback`AuthDomainDigestAuthCallback`].