class documentation

class UnixSSHRealm: (source)

Implements interfaces: twisted.cred.portal.IRealm

View In Hierarchy


Method requestAvatar Return avatar which provides one of the given interfaces.
def requestAvatar(self, username: bytes|Tuple[], mind: object, *interfaces: portal._InterfaceItself) -> Tuple[portal._InterfaceItself, UnixConchUser, Callable[[], None]]: (source)

Return avatar which provides one of the given interfaces.

mind:objectusually None. See the description of mind in Portal.login.
*interfaces:portal._InterfaceItselfthe interface(s) the returned avatar should implement, e.g. IMailAccount. See the description of Portal.login.
avatarIda string that identifies an avatar, as returned by ICredentialsChecker.requestAvatarId (via a Deferred). Alternatively, it may be twisted.cred.checkers.ANONYMOUS.
Tuple[portal._InterfaceItself, UnixConchUser, Callable[[], None]]a deferred which will fire a tuple of (interface, avatarAspect, logout), or the tuple itself. The interface will be one of the interfaces passed in the 'interfaces' argument. The 'avatarAspect' will implement that interface. The 'logout' object is a callable which will detach the mind from the avatar.