class documentation
class _UserAuth(SSHUserAuthClient): (source)
Method | connect |
Set up a connection to the authentication agent and trigger its initialization. |
Method | get |
Get the password to use for authentication. |
Method | get |
Get the private part of a key pair to use for authentication. The key corresponds to the public part most recently returned from getPublicKey. |
Method | get |
Retrieve the next public key object to offer to the server, possibly delegating to an authentication agent if there is one. |
Method | lose |
Disconnect the agent. |
Method | sign |
Extend the base signing behavior by using an SSH agent to sign the data, if one is available. |
Method | ssh_ |
Handle user authentication success in the normal way, but also make a note of the state change on the _CommandTransport . |
Class Variable | agent |
Undocumented |
Class Variable | keys |
Undocumented |
Class Variable | password |
Undocumented |
Instance Variable | key |
Undocumented |
Inherited from SSHUserAuthClient
:
Method | __init__ |
Undocumented |
Method | ask |
Send a MSG_USERAUTH_REQUEST. |
Method | auth |
Try to authenticate with keyboard-interactive authentication. Send the request to the server and return True. |
Method | auth |
Try to authenticate with a password. Ask the user for a password. If the user will return a password, return True. Otherwise, return False. |
Method | auth |
Try to authenticate with a public key. Ask the user for a public key; if the user has one, send the request to the server and return True. Otherwise, return False. |
Method | get |
Returns a Deferred with the responses to the promopts. |
Method | service |
called when the service is active on the transport. |
Method | ssh_ |
We received a MSG_USERAUTH_FAILURE. Payload: |
Method | ssh_ |
This message (number 60) can mean several different messages depending on the current authentication type. We dispatch to individual methods in order to handle this request. |
Method | ssh_ |
This is MSG_USERAUTH_INFO_RESPONSE. The server has sent us the questions it wants us to answer, so we ask the user and sent the responses. |
Method | ssh_ |
This is MSG_USERAUTH_PASSWD_CHANGEREQ. The password given has expired. We ask for an old password and a new password, then send both back to the server. |
Method | ssh_ |
This is MSG_USERAUTH_PK. Our public key is valid, so we create a signature and try to authenticate with it. |
Method | try |
Dispatch to an authentication method. |
Instance Variable | authenticated |
a list of strings of authentication methods we've tried |
Instance Variable | instance |
the service to start after authentication has finished |
Instance Variable | last |
Undocumented |
Instance Variable | last |
the last public key object we've tried to authenticate with |
Instance Variable | name |
the name of this service: 'ssh-userauth' |
Instance Variable | preferred |
a list of authentication methods that should be used first, in order of preference, if supported by the server |
Instance Variable | tried |
a list of public key objects that we've tried to authenticate with |
Instance Variable | user |
the name of the user to authenticate as |
Method | _cb |
Called back when we are finished answering keyboard-interactive questions. Send the info back to the server in a MSG_USERAUTH_INFO_RESPONSE. |
Method | _cb |
Undocumented |
Method | _cb |
Called back when the user gives a password. Send the request to the server. |
Method | _cb |
Called back when the private key is returned. Sign the data and return the signature. |
Method | _cb |
Called back out of self.signData with the signed data. Send the authentication request with the signature. |
Method | _cb |
Undocumented |
Method | _eb |
Generic callback for a failed authentication attempt. Respond by asking for the list of accepted methods (the 'none' method) |
Method | _set |
Called back when we are choosing a new password. Get the old password and send the authentication message with both. |
Method | _set |
Called back when we are choosing a new password. Simply store the old password for now. |
Instance Variable | _new |
Undocumented |
Instance Variable | _old |
Undocumented |
Inherited from SSHService
(via SSHUserAuthClient
):
Method | log |
Undocumented |
Method | packet |
called when we receive a packet on the transport |
Method | service |
called when the service is stopped, either by the connection ending or by another service being started |
Class Variable | protocol |
Undocumented |
Class Variable | transport |
Undocumented |
Class Variable | _log |
Undocumented |
Set up a connection to the authentication agent and trigger its initialization.
Parameters | |
endpoint:IStreamClientEndpoint provider | An endpoint which can be used to connect to the authentication agent. |
Returns | |
A Deferred which fires when the agent connection is ready for use. |
Retrieve the next public key object to offer to the server, possibly delegating to an authentication agent if there is one.
Returns | |
twisted.conch.ssh.keys.Key or None | The public part of a key pair that could be used to authenticate with the server, or None if there are no more public keys to try. |
Handle user authentication success in the normal way, but also make a note of the state change on the _CommandTransport
.