twisted.web2.auth.wrapper.HTTPAuthResource : API documentation

Method	__init__
Method	login
Method	authenticate	Attempt to authenticate the givin request
Method	locateChild	Authenticate the request then return the `self.wrappedResource` and the unmodified segments.
Method	renderHTTP	Authenticate the request then return the result of calling renderHTTP on `self.wrappedResource`
Method	_loginSucceeded	Callback for successful login.
Method	_loginFailed	Errback for failed login.

def __init__(self, wrappedResource, credentialFactories, portal, interfaces): (source)

Parameters	wrappedResource	A `twisted.web2.iweb.IResource` to be returned from locateChild and render upon successful authentication.
	credentialFactories	A list of instances that implement `ICredentialFactory`. (type: `list` )
	portal	Portal to handle logins for this resource. (type: `twisted.cred.portal.Portal` )
	interfaces	the interfaces that are allowed to log in via the given portal (type: `tuple` )

def _loginSucceeded(self, avatar, request): (source)

Callback for successful login.

Parameters	avatar	A tuple of the form (interface, avatar) as returned by your realm.
	request	`IRequest` that encapsulates this auth attempt.
Returns	the IResource in `self.wrappedResource`

def _loginFailed(self, result, request): (source)

Errback for failed login.

Parameters	result	`Failure` returned by portal.login
	request	`IRequest` that encapsulates this auth attempt.
Returns	A `Failure` containing an `HTTPError` containing the `UnauthorizedResponse` if `result` is an `UnauthorizedLogin` or `UnhandledCredentials` error

def login(self, factory, response, request): (source)

Parameters	factory	An `ICredentialFactory` that understands the given response.
	response	The client's authentication response as a string.
	request	The request that prompted this authentication attempt.
Returns	A `Deferred` that fires with the wrappedResource on success or a failure containing an `UnauthorizedResponse`

def authenticate(self, request): (source)

Attempt to authenticate the givin request

Parameters request An IRequest to be authenticated.

def locateChild(self, request, seg): (source)

Authenticate the request then return the self.wrappedResource and the unmodified segments.

def renderHTTP(self, request): (source)

Authenticate the request then return the result of calling renderHTTP on self.wrappedResource

t.w.a.w.HTTPAuthResource(object) : class documentation