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

Part of twisted.conch.client.default View Source View In Hierarchy

No class docstring
Method __init__ Undocumented
Method serviceStarted called when the service is active on the transport.
Method serviceStopped called when the service is stopped, either by the connection ending
Method getPassword Return a Deferred that will be called back with a password.
Method getPublicKey Get a public key from the key agent if possible, otherwise look in
Method signData Extend the base signing behavior by using an SSH agent to sign the
Method getPrivateKey Try to load the private key from the last used file identified by
Method getGenericAnswers Returns a Deferred with the responses to the promopts.
Method _setAgent Undocumented
Method _ebSetAgent Undocumented
Method _getPassword Undocumented

Inherited from SSHUserAuthClient:

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 _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 logPrefix Override this method to insert custom logging behavior. Its
Method packetReceived called when we receive a packet on the transport
def __init__(self, user, options, *args): (source)
Undocumented
def serviceStarted(self): (source)
called when the service is active on the transport.
def serviceStopped(self): (source)
called when the service is stopped, either by the connection ending or by another service being started
def _setAgent(self, a): (source)
Undocumented
def _ebSetAgent(self, f): (source)
Undocumented
def _getPassword(self, prompt): (source)
Undocumented
def getPassword(self, prompt=None): (source)
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: '.
Parametersprompt (type: str/None )
Returns (type: defer.Deferred )
def getPublicKey(self): (source)
Get a public key from the key agent if possible, otherwise look in the next configured identity file for one.
def signData(self, publicKey, signData): (source)
Extend the base signing behavior by using an SSH agent to sign the data, if one is available.
ParameterspublicKey (type: Key )
signData (type: str )
def getPrivateKey(self): (source)
Try to load the private key from the last used file identified by getPublicKey, potentially asking for the passphrase if the key is encrypted.
def getGenericAnswers(self, name, instruction, prompts): (source)
Returns a Deferred with the responses to the promopts.
ParametersnameThe name of the authentication currently in progress.
instructionDescribes what the authentication wants.
promptsA 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.
API Documentation for Twisted, generated by pydoctor at 2010-07-05 15:03:32.