twisted.conch.scripts.tkconch.SSHUserAuthClient : API documentation

Method	getPassword	Return a `Deferred` that will be called back with a password.
Method	getPublicKey	Return a public key for the user. If no more public keys are
Method	getPrivateKey	Return a `Deferred` that will be called back with the private key
Method	_cbGetPrivateKey	Undocumented

Inherited from SSHUserAuthClient:

Method	__init__	Undocumented
Method	serviceStarted	called when the service is active on the transport.
Method	askForAuth	Send a MSG_USERAUTH_REQUEST.
Method	tryAuth	Dispatch to an authentication method.
Method	ssh_USERAUTH_SUCCESS	We received a MSG_USERAUTH_SUCCESS. The server has accepted our
Method	ssh_USERAUTH_FAILURE	We received a MSG_USERAUTH_FAILURE. Payload:
Method	ssh_USERAUTH_PK_OK	This message (number 60) can mean several different messages depending
Method	ssh_USERAUTH_PK_OK_publickey	This is MSG_USERAUTH_PK. Our public key is valid, so we create a
Method	ssh_USERAUTH_PK_OK_password	This is MSG_USERAUTH_PASSWD_CHANGEREQ. The password given has expired.
Method	ssh_USERAUTH_PK_OK_keyboard_interactive	This is MSG_USERAUTH_INFO_RESPONSE. The server has sent us the
Method	auth_publickey	Try to authenticate with a public key. Ask the user for a public key;
Method	auth_password	Try to authenticate with a password. Ask the user for a password.
Method	auth_keyboard_interactive	Try to authenticate with keyboard-interactive authentication. Send
Method	signData	Sign the given data with the given public key.
Method	getGenericAnswers	Returns a `Deferred` with the responses to the promopts.
Method	_ebAuth	Generic callback for a failed authentication attempt. Respond by
Method	_cbUserauthFailure	Undocumented
Method	_cbSignedData	Called back out of self.signData with the signed data. Send the
Method	_setOldPass	Called back when we are choosing a new password. Simply store the old
Method	_setNewPass	Called back when we are choosing a new password. Get the old password
Method	_cbGenericAnswers	Called back when we are finished answering keyboard-interactive
Method	_cbGetPublicKey	Undocumented
Method	_cbPassword	Called back when the user gives a password. Send the request to the
Method	_cbSignData	Called back when the private key is returned. Sign the data and

Inherited from SSHService (via SSHUserAuthClient):

Method	serviceStopped	called when the service is stopped, either by the connection ending
Method	logPrefix	Override this method to insert custom logging behavior. Its
Method	packetReceived	called when we receive a packet on the transport

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

overrides twisted.conch.ssh.userauth.SSHUserAuthClient.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: '.

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

def getPublicKey(self): (source)

overrides twisted.conch.ssh.userauth.SSHUserAuthClient.getPublicKey

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

This implementation always returns None. Override it in a subclass to actually find and return a public key object.

Returns (type: Key or NoneType )

def getPrivateKey(self): (source)

overrides twisted.conch.ssh.userauth.SSHUserAuthClient.getPrivateKey

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

Returns (type: Deferred called back with Key )

t.c.s.t.SSHUserAuthClient(userauth.SSHUserAuthClient) : class documentation