twisted.conch.client.default.SSHUserAuthClient : API documentation

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 or by another service being started
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	getPublicKey	Get a public key from the key agent if possible, otherwise look in the next configured identity file for one.
Method	signData	Extend the base signing behavior by using an SSH agent to sign the data, if one is available.
Method	getPrivateKey	Try to load the private key from the last used file identified by `getPublicKey`, potentially asking for the passphrase if the key is encrypted.
Method	getGenericAnswers	Returns a `Deferred` with the responses to the promopts.
Method	_setAgent	Undocumented
Method	_ebSetAgent	Undocumented
Method	_getPassword	Prompt for a password using `getpass.getpass`.
Class Method	_openTty	Open /dev/tty as two streams one in read, one in write mode, and return them.
Class Method	_replaceStdoutStdin	Contextmanager that replaces stdout and stdin with /dev/tty and resets them when it is done.

Inherited from SSHService (via SSHUserAuthClient):

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	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 __init__(self, user, options, *args): (source)

overrides twisted.conch.ssh.userauth.SSHUserAuthClient.__init__

Undocumented

def serviceStarted(self): (source)

overrides twisted.conch.ssh.userauth.SSHUserAuthClient.serviceStarted

called when the service is active on the transport.

def serviceStopped(self): (source)

overrides twisted.conch.ssh.service.SSHService.serviceStopped

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)

Prompt for a password using getpass.getpass.

Parameters	prompt	Written on tty to ask for the input. (type: `str`)
Returns	The input. (type: `str`)

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: '.

Returns (type: defer.Deferred)

def getPublicKey(self): (source)

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

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)

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

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)

overrides twisted.conch.ssh.userauth.SSHUserAuthClient.getGenericAnswers

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.

@classmethod
def _openTty(cls): (source)

Open /dev/tty as two streams one in read, one in write mode, and return them.

Returns File objects for reading and writing to /dev/tty, corresponding to standard input and standard output. (type: A tuple of io.TextIOWrapper on Python 3. A tuple of binary files on Python 2.)

@classmethod
@contextlib.contextmanager
def _replaceStdoutStdin(cls): (source)

Contextmanager that replaces stdout and stdin with /dev/tty and resets them when it is done.

twisted.conch.client.default.SSHUserAuthClient(userauth.SSHUserAuthClient) class documentation

`twisted.conch.client.default.SSHUserAuthClient(userauth.SSHUserAuthClient)` class documentation