class documentation

class InMemoryUsernamePasswordDatabaseDontUse: (source)

Implements interfaces: twisted.cred.checkers.ICredentialsChecker

View In Hierarchy

An extremely simple credentials checker.

This is only of use in one-off test programs or examples which don't want to focus too much on how credentials are verified.

You really don't want to use this for anything else. It is, at best, a toy. If you need a simple credentials checker for a real application, see FilePasswordDB.

Method __init__ Initialize the in-memory database.
Method addUser Set a user's password.
Method requestAvatarId Validate credentials and produce an avatar ID.
Class Variable credentialInterfaces Tuple of IUsernamePassword and IUsernameHashedPassword.
Instance Variable users Mapping of usernames to passwords.
Method _cbPasswordMatch Undocumented
def __init__(self, **users): (source)

Initialize the in-memory database.

For example:

    db = InMemoryUsernamePasswordDatabaseDontUse(
users:dict of str to bytesUsernames and passwords to seed the database with. Each username given as a keyword is encoded to bytes as ASCII. Passwords must be given as bytes.
def addUser(self, username, password): (source)
Set a user's password.
username:bytesName of the user.
password:bytesPassword to associate with the username.
def requestAvatarId(self, credentials): (source)
Validate credentials and produce an avatar ID.
credentialssomething which implements one of the interfaces in credentialInterfaces.
a Deferred which will fire with a bytes that identifies an avatar, an empty tuple to specify an authenticated anonymous user (provided as twisted.cred.checkers.ANONYMOUS) or fail with UnauthorizedLogin. Alternatively, return the result itself.
See Also
users: dict mapping bytes to bytes = (source)
Mapping of usernames to passwords.
def _cbPasswordMatch(self, matched, username): (source)