Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`web`.`guard`.`DigestCredentialFactory``

class documentation

`class DigestCredentialFactory: (source)`

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

View In Hierarchy

Wrapper for `digest.DigestCredentialFactory` that implements the `ICredentialFactory` interface.

Method | `__init__` | Create the digest credential factory that this object wraps.
Method | `decode` | Create a `twisted.cred.credentials.DigestedCredentials` object from the given response and request.
Method | `getChallenge` | Generate the challenge for use in the WWW-Authenticate header
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 | `digest` | Undocumented

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

Create the digest credential factory that this object wraps.

def decode(self, response, request): (source)
from `twisted.web.iweb.ICredentialFactory`

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

See Also
`ICredentialFactory.decode`

def getChallenge(self, request): (source)
from `twisted.web.iweb.ICredentialFactory`

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.

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'`.

digest = (source)

Undocumented