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`.`cred`.`credentials`.`IUsernameHashedPassword``

interface documentation

`class IUsernameHashedPassword(ICredentials): (source)`

Known implementations: `twisted.cred.credentials.CramMD5Credentials`, `twisted.cred.credentials.DigestedCredentials`, `twisted.cred.credentials.UsernameHashedPassword`, `twisted.mail.pop3.APOPCredentials`, `twisted.spread.pb._PortalAuthChallenger`

View In Hierarchy

I encapsulate a username and a hashed password.

This credential is used when a hashed password is received from the party requesting authentication. CredentialCheckers which check this kind of credential must store the passwords in plaintext (or as password-equivalent hashes) form so that they can be hashed in a manner appropriate for the particular credentials class.

Method | `checkPassword` | Validate these credentials against the correct password.
Instance Variable | `username` | The username associated with these credentials.

def checkPassword(password): (source)

Validate these credentials against the correct password.

Parameters
password:`bytes` | The correct, plaintext password against which to check.
Returns
`bool` or `Deferred` | `True` if the credentials represented by this object match the given password, `False` if they do not, or a `Deferred` which will be called back with one of these values.

username: `bytes` = (source)

The username associated with these credentials.