twisted.conch.endpoints._UserAuth(SSHUserAuthClient) class documentation

Part of twisted.conch.endpoints View Source (View In Hierarchy)

_UserAuth implements the client part of SSH user authentication in the convenient way a user might expect if they are familiar with the interactive ssh command line client.

_UserAuth supports key-based authentication, password-based authentication, and delegating authentication to an agent.

Method getPublicKey Retrieve the next public key object to offer to the server, possibly delegating to an authentication agent if there is one.
Method signData Extend the base signing behavior by using an SSH agent to sign the data, if one is available.
Method getPrivateKey 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 getPassword Get the password to use for authentication.
Method ssh_USERAUTH_SUCCESS Handle user authentication success in the normal way, but also make a note of the state change on the _CommandTransport.
Method connectToAgent Set up a connection to the authentication agent and trigger its initialization.
Method loseAgentConnection Disconnect the agent.

Inherited from SSHService (via SSHUserAuthClient):

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

Inherited from SSHService (via SSHUserAuthClient):

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
def getPublicKey(self): (source)
overrides twisted.conch.ssh.userauth.SSHUserAuthClient.getPublicKey

Retrieve the next public key object to offer to the server, possibly delegating to an authentication agent if there is one.

ReturnsThe 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. (type: twisted.conch.ssh.keys.Key or None)
def signData(self, publicKey, signData): (source)
overrides twisted.conch.ssh.userauth.SSHUserAuthClient.signData

Extend the base signing behavior by using an SSH agent to sign the data, if one is available.

def getPrivateKey(self): (source)
overrides twisted.conch.ssh.userauth.SSHUserAuthClient.getPrivateKey

Get the private part of a key pair to use for authentication. The key corresponds to the public part most recently returned from getPublicKey.

ReturnsA Deferred which fires with the private key. (type: Deferred)
def getPassword(self): (source)
overrides twisted.conch.ssh.userauth.SSHUserAuthClient.getPassword

Get the password to use for authentication.

ReturnsA Deferred which fires with the password, or None if the password was not specified.
def ssh_USERAUTH_SUCCESS(self, packet): (source)
overrides twisted.conch.ssh.userauth.SSHUserAuthClient.ssh_USERAUTH_SUCCESS

Handle user authentication success in the normal way, but also make a note of the state change on the _CommandTransport.

def connectToAgent(self, endpoint): (source)

Set up a connection to the authentication agent and trigger its initialization.

ParametersendpointAn endpoint which can be used to connect to the authentication agent. (type: IStreamClientEndpoint provider)
ReturnsA Deferred which fires when the agent connection is ready for use.
def loseAgentConnection(self): (source)

Disconnect the agent.

API Documentation for Twisted, generated by pydoctor at 2017-06-11 10:59:01.