twisted.conch.ssh.userauth.SSHUserAuthClient : API documentation

def __init__(self, user, instance): (source)

overridden in twisted.conch.client.default.SSHUserAuthClient

Undocumented

def serviceStarted(self): (source)

overrides twisted.conch.ssh.service.SSHService.serviceStarted

overridden in twisted.conch.client.default.SSHUserAuthClient

called when the service is active on the transport.

def askForAuth(self, kind, extraData): (source)

Undocumented

def tryAuth(self, kind): (source)

Undocumented

def _ebAuth(self, ignored, *args): (source)

Undocumented

def ssh_USERAUTH_SUCCESS(self, packet): (source)

Undocumented

def ssh_USERAUTH_FAILURE(self, packet): (source)

Undocumented

def ssh_USERAUTH_PK_OK(self, packet): (source)

Undocumented

def _cbSignedData(self, signedData): (source)

Undocumented

def _setOldPass(self, op): (source)

Undocumented

def _setNewPass(self, np): (source)

Undocumented

def _cbGenericAnswers(self, responses): (source)

Undocumented

def auth_publickey(self): (source)

Undocumented

def auth_password(self): (source)

Undocumented

def auth_keyboard_interactive(self): (source)

Undocumented

def _cbPassword(self, password): (source)

Undocumented

def signData(self, publicKey, signData): (source)

overridden in twisted.conch.client.default.SSHUserAuthClient

Sign the given data with the given public key blob. By default, this will call getPrivateKey to get the private key, the sign the data using keys.signData. However, this is factored out so that it can use alternate methods, such as a key agent.

def _cbSignData(self, privateKey, signData): (source)

Undocumented

def getPublicKey(self): (source)

overridden in twisted.conch.client.default.SSHUserAuthClient, twisted.conch.scripts.tkconch.SSHUserAuthClient

Return a public key for the user. If no more public keys are available, return None.

Returns (type: str/None )

def getPrivateKey(self): (source)

overridden in twisted.conch.client.default.SSHUserAuthClient, twisted.conch.scripts.tkconch.SSHUserAuthClient

Return a Deferred that will be called back with the private key corresponding to the last public key from getPublicKey(). If the private key is not available, errback on the Deferred.

Returns (type: Deferred )

def getPassword(self, prompt=None): (source)

overridden in twisted.conch.client.default.SSHUserAuthClient, twisted.conch.scripts.tkconch.SSHUserAuthClient

Return a Deferred that will be called back with a password. prompt is a string to display for the password, or None for a generic 'user@hostname's password: '.

Parameters	prompt	(type: `str`/`None` )
Returns	(type: `Deferred` )

def getGenericAnswers(self, name, instruction, prompts): (source)

overridden in twisted.conch.client.default.SSHUserAuthClient

Returns a Deferred with the responses to the promopts.

Parameters	name	The name of the authentication currently in progress.
	instruction	Describes what the authentication wants.
	prompts	A list of (prompt, echo) pairs, where prompt is a string to display and echo is a boolean indicating whether the user's response should be echoed as they type it.

Method	serviceStopped	called when the service is stopped, either by the connection ending or by another service being started
Method	logPrefix	Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
Method	packetReceived	called when we receive a packet on the transport

Method	__init__	Undocumented
Method	serviceStarted	called when the service is active on the transport.
Method	askForAuth	Undocumented
Method	tryAuth	Undocumented
Method	ssh_USERAUTH_SUCCESS	Undocumented
Method	ssh_USERAUTH_FAILURE	Undocumented
Method	ssh_USERAUTH_PK_OK	Undocumented
Method	auth_publickey	Undocumented
Method	auth_password	Undocumented
Method	auth_keyboard_interactive	Undocumented
Method	signData	No summary
Method	getPublicKey	Return a public key for the user. If no more public keys are available, return None.
Method	getPrivateKey	Return a `Deferred` that will be called back with the private key corresponding to the last public key from getPublicKey(). If the private key is not available, errback on the Deferred.
Method	getPassword	Return a `Deferred` that will be called back with a password. prompt is a string to display for the password, or None for a generic 'user@hostname's password: '.
Method	getGenericAnswers	Returns a `Deferred` with the responses to the promopts.
Method	_ebAuth	Undocumented
Method	_cbSignedData	Undocumented
Method	_setOldPass	Undocumented
Method	_setNewPass	Undocumented
Method	_cbGenericAnswers	Undocumented
Method	_cbPassword	Undocumented
Method	_cbSignData	Undocumented

t.c.s.u.SSHUserAuthClient(service.SSHService) : class documentation