Part of twisted.cred.checkers View Source View In Hierarchy
Implements interfaces: twisted.cred.checkers.ICredentialsChecker
A file-based, text-based username/password database.Records in the datafile for this class are delimited by a particular string. The username appears in a fixed field of the columns delimited by this string, as does the password. Both fields are specifiable. If the passwords are not stored plaintext, a hash function must be supplied to convert plaintext passwords to the form stored on disk and this CredentialsChecker will only be able to check IUsernamePassword credentials. If the passwords are stored plaintext, IUsernameHashedPassword credentials will be checkable as well.
|Parameters||filename||The name of the file from which to read username and password
|delim||The field delimiter used in the file.
|usernameField||The index of the username after splitting a line on the delimiter.
|passwordField||The index of the password after splitting a line on the delimiter.
|caseSensitive||If true, consider the case of the username when performing a lookup.
Ignore it otherwise.
|hash||A function used to transform the plaintext password received over the
network to a format suitable for comparison against the version stored on
disk. The arguments to the callable are the username, the network-supplied
password, and the in-file version of the password. If the return value
compares equal to the version stored on disk, the credentials are
(type: Three-argument callable or |
|cache||If true, maintain an in-memory cache of the contents of the password
file. On lookups, the mtime of the file will be checked, and the file will
only be re-parsed if the mtime is newer than when the cache was
|Parameters||credentials||something which implements one of the interfaces in self.credentialInterfaces.|
|Returns||a Deferred which will fire a string which identifies an avatar, an empty tuple to specify an authenticated anonymous user (provided as checkers.ANONYMOUS) or fire a Failure(UnauthorizedLogin). Alternatively, return the result itself.|