# ``twisted`.`web`.`guard`.`BasicCredentialFactory``

class documentation

`class BasicCredentialFactory: (source)`

Implements interfaces: `twisted.web.iweb.ICredentialFactory`

View In Hierarchy

Credential Factory for HTTP Basic Authentication

Method | `__init__` | Undocumented
Method | `decode` | Parse the base64-encoded, colon-separated username and password into a `credentials.UsernamePassword` instance.
Method | `getChallenge` | Return a challenge including the HTTP authentication realm with which this factory was created.
Class Variable | `scheme` | A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.
Instance Variable | `authenticationRealm` | The HTTP authentication realm which will be issued in challenges.

def __init__(self, authenticationRealm): (source)

Undocumented

def decode(self, response, request): (source)
from `twisted.web.iweb.ICredentialFactory`
Parse the base64-encoded, colon-separated username and password into a `credentials.UsernamePassword` instance.
def getChallenge(self, request): (source)
from `twisted.web.iweb.ICredentialFactory`
Return a challenge including the HTTP authentication realm with which this factory was created.
scheme: `bytes` = (source)
from `twisted.web.iweb.ICredentialFactory`
A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.
authenticationRealm: `bytes` = (source)
The HTTP authentication realm which will be issued in challenges.