twisted.web.guard.DigestCredentialFactory : API documentation

class documentation

class twisted.web.guard.DigestCredentialFactory: (source)

Class Variable	scheme	A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.
Method	__init__	Create the digest credential factory that this object wraps.
Instance Variable	digest	Undocumented
Method	getChallenge	Generate the challenge for use in the WWW-Authenticate header
Method	decode	Create a `twisted.cred.credentials.DigestedCredentials` object from the given response and request.

A str giving the name of the authentication scheme with which this factory is associated. For example, 'basic' or 'digest'.

(type: bytes)

def __init__(self, algorithm, authenticationRealm): (source)

Create the digest credential factory that this object wraps.

Undocumented

def getChallenge(self, request): (source)

Generate the challenge for use in the WWW-Authenticate header

Parameters	request	The `IRequest` to with access was denied and for the response to which this challenge is being generated.
Returns	The `dict` that can be used to generate a WWW-Authenticate header.

def decode(self, response, request): (source)

Create a twisted.cred.credentials.DigestedCredentials object from the given response and request.