twisted.web2.auth.digest.DigestCredentialFactory : API documentation

Support for RFC2617 HTTP Digest Authentication

Instance Variables	privateKey	A random string used for generating the secure opaque.
Class Variables	CHALLENGE_LIFETIME_SECS	The number of seconds for which an opaque should be valid.

Method	__init__
Method	generateNonce	Undocumented
Method	generateOpaque	Generate an opaque to be returned to the client.
Method	verifyOpaque	Given the opaque and nonce from the request, as well as the clientip
Method	getChallenge	Generate the challenge for use in the WWW-Authenticate header
Method	decode	Decode the given response and attempt to generate a
Method	_getTime	Parameterize the time based seed used in generateOpaque

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

Parameters	algorithm	case insensitive string that specifies the hash algorithm used, should be either, md5, md5-sess or sha (type: `str` )
	realm	case sensitive string that specifies the realm portion of the challenge (type: `str` )

def generateNonce(self): (source)

Undocumented

def _getTime(self): (source)

Parameterize the time based seed used in generateOpaque so we can deterministically unittest it's behavior.

def generateOpaque(self, nonce, clientip): (source)

Generate an opaque to be returned to the client. This should be a unique string that can be returned to us and verified.

def verifyOpaque(self, opaque, nonce, clientip): (source)

Given the opaque and nonce from the request, as well as the clientip that made the request, verify that the opaque was generated by us. And that it's not too old.

Parameters	opaque	The opaque value from the Digest response
	nonce	The nonce value from the Digest response
	clientip	The remote IP address of the client making the request
Returns	`True` if the opaque was successfully verified.
Raises	error.LoginFailed	if `opaque` could not be parsed or contained the wrong values.

def getChallenge(self, peer): (source)

from twisted.web2.auth.interfaces.ICredentialFactory

Generate the challenge for use in the WWW-Authenticate header

Parameters	peer	The `IAddress` of the requesting client.
Returns	The `dict` that can be used to generate a WWW-Authenticate header.

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

from twisted.web2.auth.interfaces.ICredentialFactory

Decode the given response and attempt to generate a DigestedCredentials from it.

Parameters	response	A string of comma seperated key=value pairs (type: `str` )
	request	the request being processed (type: `twisted.web2.server.Request` )
Returns	`DigestedCredentials`
Raises	`error.LoginFailed` if the response does not contain a username, a nonce, an opaque, or if the opaque is invalid.

t.w.a.d.DigestCredentialFactory(object) : class documentation