t.c.c.SSHPublicKeyDatabase : class documentation

Part of twisted.conch.checkers View Source View In Hierarchy

Implements interfaces: twisted.cred.checkers.ICredentialsChecker

Checker that authenticates SSH public keys, based on public keys listed in authorized_keys and authorized_keys2 files in user .ssh/ directories.

Method	requestAvatarId
Method	checkKey	Retrieve the keys of the user specified by the credentials, and check if one matches the blob in the credentials.
Method	_cbRequestAvatarId	Check whether the credentials themselves are valid, now that we know if the key matches the user.
Method	_ebRequestAvatarId	Undocumented

def requestAvatarId(self, credentials): (source)

from twisted.cred.checkers.ICredentialsChecker

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.
See Also	`twisted.cred.credentials`

def _cbRequestAvatarId(self, validKey, credentials): (source)

Check whether the credentials themselves are valid, now that we know if the key matches the user.

Parameters	validKey	A boolean indicating whether or not the public key matches a key in the user's authorized_keys file.
	credentials	The credentials offered by the user. (type: `ISSHPrivateKey` provider )
Returns	The user's username, if authentication was successful.
Raises	UnauthorizedLogin	(as a failure) if the key does not match the user in `credentials`. Also raised if the user provides an invalid signature.
	ValidPublicKey	(as a failure) if the key matches the user but the credentials do not include a signature. See `error.ValidPublicKey` for more information.

def checkKey(self, credentials): (source)

Retrieve the keys of the user specified by the credentials, and check if one matches the blob in the credentials.

def _ebRequestAvatarId(self, f): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:07:41.