twisted.conch.checkers.UNIXAuthorizedKeysFiles

class documentation

class UNIXAuthorizedKeysFiles: (source)

Constructor: UNIXAuthorizedKeysFiles(userdb, parseKey)

Implements interfaces: twisted.conch.checkers.IAuthorizedKeysDB

View In Hierarchy

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.

Present Since
15.0
Method __init__ Initializes a new UNIXAuthorizedKeysFiles.
Method getAuthorizedKeys Gets an iterable of authorized keys that are valid for the given avatarId.
Instance Variable _parseKey Undocumented
Instance Variable _userdb Undocumented
def __init__(self, userdb: UserDB | None = None, parseKey: Callable[[bytes], keys.Key] = keys.Key.fromString): (source)

Initializes a new UNIXAuthorizedKeysFiles.

Parameters
userdb:UserDB | Noneaccess to the Unix user account and password database (default is the Python module pwd, if available)
parseKey:Callable[[bytes], keys.Key]a callable that takes a string and returns a twisted.conch.ssh.keys.Key, mainly to be used for testing. The default is twisted.conch.ssh.keys.Key.fromString.
def getAuthorizedKeys(self, username: bytes) -> Iterable[keys.Key]: (source)
from twisted.conch.checkers.IAuthorizedKeysDB

Gets an iterable of authorized keys that are valid for the given avatarId.

Parameters
username:bytesUndocumented
avatarId:valid return value of twisted.cred.checkers.ICredentialsChecker.requestAvatarIdthe ID of the avatar
Returns
Iterable[keys.Key]an iterable of twisted.conch.ssh.keys.Key
_parseKey = (source)

Undocumented

_userdb: UserDB = (source)

Undocumented