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`.`checkers`.`ICredentialsChecker``

interface documentation

`class ICredentialsChecker(Interface): (source)`

Known implementations: `twisted.conch.checkers.SSHProtocolChecker`, `twisted.conch.checkers.SSHPublicKeyChecker`, `twisted.conch.checkers.SSHPublicKeyDatabase`, `twisted.conch.checkers.UNIXPasswordDatabase`, `twisted.cred.checkers.AllowAnonymousAccess`, `twisted.cred.checkers.FilePasswordDB`, `twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse`, `twisted.mail.maildir.DirdbmDatabase`, `twisted.plugins.cred_unix.UNIXChecker`

View In Hierarchy

An object that can check sub-interfaces of `ICredentials`.

Method | `requestAvatarId` | Validate credentials and produce an avatar ID.
Attribute | `credentialInterfaces` | A list of sub-interfaces of `ICredentials` which specifies which I may check.

def requestAvatarId(credentials: `Any`) -> `Deferred[Union[bytes, Tuple[]]]`: (source)

Validate credentials and produce an avatar ID.

Parameters
credentials:`Any` | something which implements one of the interfaces in `credentialInterfaces`.
Returns
`Deferred[Union[bytes, Tuple[]]]` | a `Deferred` which will fire with a `bytes` that identifies an avatar, an empty tuple to specify an authenticated anonymous user (provided as `twisted.cred.checkers.ANONYMOUS`) or fail with `UnauthorizedLogin`. Alternatively, return the result itself.
See Also
`twisted.cred.credentials`

credentialInterfaces = (source)

A list of sub-interfaces of `ICredentials` which specifies which I may check.