class twisted.web.iweb.ICredentialFactory(Interface): (source)
Known implementations: twisted.web.guard.BasicCredentialFactory, twisted.web.guard.DigestCredentialFactory
A credential factory defines a way to generate a particular kind of authentication challenge and a way to interpret the responses to these challenges. It creates ICredentials providers from responses. These objects will be used with twisted.cred to authenticate an authorize requests.
| Attribute | scheme | A str giving the name of the authentication scheme with which this factory is associated. For example, 'basic' or 'digest'. |
| Method | getChallenge | Generate a new challenge to be sent to a client. |
| Method | decode | Create a credentials object from the given response. |
A str giving the name of the authentication scheme with which this factory is associated. For example, 'basic' or 'digest'.
Generate a new challenge to be sent to a client.
| Parameters | request | The request the response to which this challenge will be included. (type: twisted.web.http.Request) |
| Returns | A mapping from str challenge fields to associated str values. (type: dict) | |
Create a credentials object from the given response.
| Parameters | response | scheme specific response string (type: str) |
| request | The request being processed (from which the response was taken). (type: twisted.web.http.Request) | |
| Returns | The credentials represented by the given response. (type: twisted.cred.credentials.ICredentials provider) | |
| Raises | twisted.cred.error.LoginFailed | If the response is invalid. |