twisted.conch.checkers.SSHPublicKeyChecker : API documentation

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

Present Since 15.0.0

Method	__init__	Initializes a `SSHPublicKeyChecker`.
Method	requestAvatarId	Undocumented
Method	_sanityCheckKey	Checks whether the provided credentials are a valid SSH key with a signature (does not actually verify the signature).
Method	_checkKey	Checks the public key against all authorized keys (if any) for the user.
Method	_verifyKey	Checks whether the credentials themselves are valid, now that we know if the key matches the user.

def __init__(self, keydb): (source)

Parameters keydb a provider of IAuthorizedKeysDB (type: IAuthorizedKeysDB provider)

def requestAvatarId(self, credentials): (source)

Undocumented

def _sanityCheckKey(self, credentials): (source)

Checks whether the provided credentials are a valid SSH key with a signature (does not actually verify the signature).

Parameters	credentials	the credentials offered by the user (type: `ISSHPrivateKey` provider)
Returns	the key in the credentials (type: `twisted.conch.ssh.keys.Key`)
Raises	ValidPublicKey	the credentials do not include a signature. See `error.ValidPublicKey` for more information.
	BadKeyError	The key included with the credentials is not recognized as a key.

def _checkKey(self, pubKey, credentials): (source)

Checks the public key against all authorized keys (if any) for the user.

Parameters	pubKey	the key in the credentials (just to prevent it from having to be calculated again) (type: )
	credentials	the credentials offered by the user (type: `ISSHPrivateKey` provider)
Returns	`pubKey` if the key is authorized (type: `twisted.conch.ssh.keys.Key`)
Raises	UnauthorizedLogin	If the key is not authorized, or if there was any error obtaining a list of authorized keys for the user.

def _verifyKey(self, pubKey, credentials): (source)

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

Parameters	pubKey	the key in the credentials (just to prevent it from having to be calculated again) (type: `twisted.conch.ssh.keys.Key`)
	credentials	the credentials offered by the user (type: `ISSHPrivateKey` provider)
Returns	The user's username, if authentication was successful (type: `str`)
Raises	UnauthorizedLogin	If the key signature is invalid or there was any error verifying the signature.

t.c.c.SSHPublicKeyChecker(object) : class documentation