module documentation
Provide ICredentialsChecker
implementations to be used in Conch protocols.
Interface |
|
An object that provides valid authorized ssh keys mapped to usernames. |
Class |
|
A sequence where the item at index 1 may be a crypted password. |
Class |
|
Object that provides SSH public keys based on a dictionary of usernames mapped to twisted.conch.ssh.keys.Key s. |
Class |
|
SSHProtocolChecker is a checker that requires multiple authentications to succeed. To add a checker, call my registerChecker method with the checker and the interface. |
Class |
|
Checker that authenticates SSH public keys, based on public keys listed in authorized_keys and authorized_keys2 files in user .ssh/ directories. |
Class |
|
Checker that authenticates SSH public keys, based on public keys listed in authorized_keys and authorized_keys2 files in user .ssh/ directories. |
Class |
|
Object that provides SSH public keys based on public keys listed in authorized_keys and authorized_keys2 files in UNIX user .ssh/ directories. If any of the files cannot be read, a message is logged but that file is otherwise ignored. |
Class |
|
A checker which validates users out of the UNIX password databases, or databases of a compatible format. |
Class |
|
A database of users by name, like the stdlib pwd module. |
Class |
|
A record in a UNIX-style password database. See pwd for field details. |
Function | read |
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. |
Variable | pwd |
Undocumented |
Function | _keys |
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. |
Function | _lookup |
Lookup a user by name in a pwd -style database. |
Function | _pwd |
Look up a user in the /etc/passwd database using the pwd module. If the pwd module is not available, return None. |
Function | _shadow |
Look up a user in the /etc/shadow database using the spwd module. If it is not available, return None . |
Variable | _log |
Undocumented |
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:IO[ | something from which to read lines which can be parsed as keys |
parseCallable[ | 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 . |
Returns | |
Iterator[ | an iterable of twisted.conch.ssh.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 | iterable of twisted.python.filepath.FilePath . |
parsecallable | a callable that takes a string and returns a twisted.conch.ssh.keys.Key |
Returns | |
Iterable[ | generator of twisted.conch.ssh.keys.Key |
Present Since | |
15.0 |
Look up a user in the /etc/passwd database using the pwd module. If the pwd module is not available, return None.
Parameters | |
username:str | the username of the user to return the passwd database information for. |
Returns | |
Optional[ | A pwd.struct_passwd , where field 1 may contain a crypted password, or None when the pwd database is unavailable. |
Raises | |
KeyError | when no such user exists |
Look up a user in the /etc/shadow database using the spwd module. If it is not available, return None
.
Parameters | |
username:str | the username of the user to return the shadow database information for. |
Returns | |
Optional[ | A spwd.struct_spwd , where field 1 may contain a crypted password, or None when the spwd database is unavailable. |
Raises | |
KeyError | when no such user exists |