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

interface documentation

`class IUsernamePassword(ICredentials): (source)`

Known implementations: `twisted.cred.credentials.UsernamePassword`

View In Hierarchy

I encapsulate a username and a plaintext password.

This encapsulates the case where the password received over the network has been hashed with the identity function (That is, not at all). The CredentialsChecker may store the password in whatever format it desires, it need only transform the stored password in a similar way before performing the comparison.

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

def checkPassword(password: `bytes`) -> `bool`: (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.

password: `bytes` = (source)

The password associated with these credentials.

username: `bytes` = (source)

The username associated with these credentials.