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

class documentation

`class CramMD5Credentials: (source)`

Constructor: `CramMD5Credentials(host)`

Implements interfaces: `twisted.cred.credentials.IUsernameHashedPassword`

View In Hierarchy

An encapsulation of some CramMD5 hashed credentials.

Method | `__init__` | Undocumented
Method | `checkPassword` | Validate these credentials against the correct password.
Method | `getChallenge` | Undocumented
Method | `moreChallenges` | Undocumented
Method | `setResponse` | Undocumented
Instance Variable | `challenge` | The challenge to be sent to the client.
Instance Variable | `host` | Undocumented
Instance Variable | `response` | The hashed response from the client.
Instance Variable | `username` | The username from the response from the client.

def __init__(self, host=None): (source)

Undocumented

def checkPassword(self, password): (source)
from `twisted.cred.credentials.IUsernameHashedPassword`

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.

def getChallenge(self): (source)

Undocumented

def moreChallenges(self): (source)

Undocumented

def setResponse(self, response): (source)

Undocumented

challenge: `bytes` = (source)

The challenge to be sent to the client.

host = (source)

Undocumented

response: `bytes` = (source)

The hashed response from the client.

username: `bytes` or `None` if not yet provided. = (source)
from `twisted.cred.credentials.IUsernameHashedPassword`

The username from the response from the client.