twisted.conch.endpoints._CommandTransport(SSHClientTransport) class documentation

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

_CommandTransport is an SSH client transport which includes a host key verification step before it will proceed to secure the connection.

_CommandTransport also knows how to set up a connection to an authentication agent if it is told where it can connect to one.

Method __init__
Method verifyHostKey Ask the KnownHostsFile provider available on the factory which created this protocol this protocol to verify the given host key.
Method connectionSecure When the connection is secure, start the authentication process.
Method connectionLost When the underlying connection to the SSH server is lost, if there were any connection setup errors, propagate them. Also, clean up the connection to the ssh agent if one was created.
Instance Variable _userauth The _UserAuth instance which is in charge of the overall authentication process or None if the SSH connection has not reach yet the user-auth service. (type: _UserAuth)
Method _saveHostKeyFailure When host key verification fails, record the reason for the failure in order to fire a Deferred with it later.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method makeConnection Make a connection to a transport and a server.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method makeConnection Make a connection to a transport and a server.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method makeConnection Make a connection to a transport and a server.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method makeConnection Make a connection to a transport and a server.
_userauth =
The _UserAuth instance which is in charge of the overall authentication process or None if the SSH connection has not reach yet the user-auth service. (type: _UserAuth)
def __init__(self, creator): (source)
ParameterscreatorThe _NewConnectionHelper that created this connection. (type: _NewConnectionHelper.)
def verifyHostKey(self, hostKey, fingerprint): (source)
overrides twisted.conch.ssh.transport.SSHClientTransport.verifyHostKey

Ask the KnownHostsFile provider available on the factory which created this protocol this protocol to verify the given host key.

ReturnsA Deferred which fires with the result of KnownHostsFile.verifyHostKey.
def _saveHostKeyFailure(self, reason): (source)

When host key verification fails, record the reason for the failure in order to fire a Deferred with it later.

ParametersreasonThe cause of the host key verification failure. (type: Failure)
Returnsreason (type: Failure)
def connectionSecure(self): (source)
overrides twisted.conch.ssh.transport.SSHClientTransport.connectionSecure

When the connection is secure, start the authentication process.

def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.conch.ssh.transport.SSHTransportBase.connectionLost

When the underlying connection to the SSH server is lost, if there were any connection setup errors, propagate them. Also, clean up the connection to the ssh agent if one was created.

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