interface documentation

class twisted.cred.checkers.ICredentialsChecker(Interface): (source)

Known implementations: twisted.conch.checkers.SSHProtocolChecker, twisted.conch.checkers.SSHPublicKeyChecker, twisted.conch.checkers.SSHPublicKeyDatabase, twisted.conch.checkers.UNIXPasswordDatabase, twisted.cred.checkers.AllowAnonymousAccess, twisted.cred.checkers.FilePasswordDB, twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse, twisted.mail.maildir.DirdbmDatabase, twisted.plugins.cred_unix.UNIXChecker

View In Hierarchy

An object that can check sub-interfaces of ICredentials.

Attribute credentialInterfaces A list of sub-interfaces of ICredentials which specifies which I may check.
Method requestAvatarId Validate credentials and produce an avatar ID.
credentialInterfaces = (source)

A list of sub-interfaces of ICredentials which specifies which I may check.

def requestAvatarId(credentials): (source)

Validate credentials and produce an avatar ID.

Parameterscredentialssomething which implements one of the interfaces in credentialInterfaces.
Returnsa 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 Alsotwisted.cred.credentials
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.