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

module documentation
(source)

This module defines `ICredentials`, an interface for objects that represent authentication credentials to provide, and also includes a number of useful implementations of that interface.

Interface | `IAnonymous` | I am an explicitly anonymous request for access.
Interface | `ICredentials` | I check credentials.
Interface | `ISSHPrivateKey` | `ISSHPrivateKey` credentials encapsulate an SSH public key to be checked against a user's private key.
Interface | `IUsernameHashedPassword` | I encapsulate a username and a hashed password.
Interface | `IUsernamePassword` | I encapsulate a username and a plaintext password.
Class | `Anonymous` | Undocumented
Class | `CramMD5Credentials` | An encapsulation of some CramMD5 hashed credentials.
Class | `DigestCredentialFactory` | Support for RFC2617 HTTP Digest Authentication
Class | `DigestedCredentials` | Yet Another Simple HTTP Digest authentication scheme.
Class | `SSHPrivateKey` | Undocumented
Class | `UsernameHashedPassword` | Undocumented
Class | `UsernamePassword` | Undocumented