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

interface documentation

`class ISSHPrivateKey(ICredentials): (source)`

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

View In Hierarchy

`ISSHPrivateKey` credentials encapsulate an SSH public key to be checked against a user's private key.

Instance Variable | `algName` | The algorithm name for the blob.
Instance Variable | `blob` | The public key blob as sent by the client.
Instance Variable | `sigData` | The data the signature was made from.
Instance Variable | `signature` | The signed data. This is checked to verify that the user owns the private key.
Instance Variable | `username` | The username associated with these credentials.

algName: `bytes` = (source)

The algorithm name for the blob.

blob: `bytes` = (source)

The public key blob as sent by the client.

sigData: `bytes` = (source)

The data the signature was made from.

signature: `bytes` or `None` = (source)

The signed data. This is checked to verify that the user owns the private key.

username: `bytes` = (source)

The username associated with these credentials.