Provide ICredentialsChecker implementations to be used in Conch protocols.
| Variable | pwd | Undocumented |
| Variable | spwd | Undocumented |
| Class | UNIXPasswordDatabase | A checker which validates users out of the UNIX password databases, or databases of a compatible format. |
| Class | SSHPublicKeyDatabase | Checker that authenticates SSH public keys, based on public keys listed in authorized_keys and authorized_keys2 files in user .ssh/ directories. |
| Class | SSHProtocolChecker | SSHProtocolChecker is a checker that requires multiple authentications to succeed. To add a checker, call my registerChecker method with the checker and the interface. |
| Interface | IAuthorizedKeysDB | An object that provides valid authorized ssh keys mapped to usernames. |
| Function | readAuthorizedKeyFile | Reads keys from an authorized keys file. Any non-comment line that cannot be parsed as a key will be ignored, although that particular line will be logged. |
| Class | InMemorySSHKeyDB | Object that provides SSH public keys based on a dictionary of usernames mapped to twisted.conch.ssh.keys.Keys. |
| Class | UNIXAuthorizedKeysFiles | No summary |
| Class | SSHPublicKeyChecker | Checker that authenticates SSH public keys, based on public keys listed in authorized_keys and authorized_keys2 files in user .ssh/ directories. |
| Variable | _log | Undocumented |
| Function | _pwdGetByName | Look up a user in the /etc/passwd database using the pwd module. If the pwd module is not available, return None. |
| Function | _shadowGetByName | Look up a user in the /etc/shadow database using the spwd module. If it is not available, return None. |
| Function | _keysFromFilepaths | Helper function that turns an iterable of filepaths into a generator of keys. If any file cannot be read, a message is logged but it is otherwise ignored. |
Look up a user in the /etc/passwd database using the pwd module. If the pwd module is not available, return None.
| Parameters | username | the username of the user to return the passwd database information for. (type: str) |
Reads keys from an authorized keys file. Any non-comment line that cannot be parsed as a key will be ignored, although that particular line will be logged.
| Parameters | fileobj | something from which to read lines which can be parsed as keys (type: BinaryIO) |
| parseKey | a callable that takes bytes and returns a twisted.conch.ssh.keys.Key, mainly to be used for testing. The default is twisted.conch.ssh.keys.Key.fromString. (type: Callable[[bytes], keys.Key]) | |
| Returns | an iterable of twisted.conch.ssh.keys.Key (type: Iterator[keys.Key]) | |
| Present Since | 15.0 | |
Helper function that turns an iterable of filepaths into a generator of keys. If any file cannot be read, a message is logged but it is otherwise ignored.
| Parameters | filepaths | iterable of twisted.python.filepath.FilePath. (type: iterable) |
| parseKey | a callable that takes a string and returns a twisted.conch.ssh.keys.Key (type: callable) | |
| Returns | generator of twisted.conch.ssh.keys.Key (type: generator) | |
| Present Since | 15.0 | |