t.c.c.d.SSHClientTransport(transport.SSHClientTransport) : class documentation

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

Undocumented
Method __init__ Undocumented
Method connectionLost Called when the connection is shut down.
Method receiveError Called when we receive a disconnect error message from the other side.
Method sendDisconnect Send a disconnect message to the other side and then disconnect.
Method receiveDebug Called when we receive a debug message from the other side.
Method verifyHostKey Returns a Deferred that gets a callback if it is a valid key, or an errback if not.
Method setService Set our service to service and start it running. If we were running a service previously, stop it first.
Method connectionSecure Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.

Inherited from SSHClientTransport:

Method connectionMade Called when the connection is started with the server. Just sets up a private instance variable.
Method ssh_KEXINIT No summary
Method ssh_KEX_DH_GEX_GROUP No summary
Method ssh_KEX_DH_GEX_REPLY Called when we receieve a MSG_KEX_DH_GEX_REPLY message. Payload:: string server host key integer f (server DH public key)
Method ssh_NEWKEYS Called when we receieve a MSG_NEWKEYS message. No payload. If we've finished setting up our own keys, start using them. Otherwise, remeber that we've receieved this message.
Method ssh_SERVICE_ACCEPT Called when we receieve a MSG_SERVICE_ACCEPT message. Payload:: string service name
Method requestService Request that a service be run over this transport.
Method _continueKEXDH_REPLY The host key has been verified, so we generate the keys.
Method _continueGEX_REPLY The host key has been verified, so we generate the keys.
Method _keySetup See SSHTransportBase._keySetup().

Inherited from SSHTransportBase (via SSHClientTransport):

Method sendKexInit Undocumented
Method sendPacket Sends a packet. If it's been set up, compress the data, encrypt it, and authenticate it before sending.
Method getPacket Try to return a decrypted, authenticated, and decompressed packet out of the buffer. If there is not enough data, return None.
Method dataReceived First, check for the version string (SSH-2.0-*). After that has been received, this method adds data to the buffer, and pulls out any packets.
Method dispatchMessage Send a received message to the appropriate method.
Method ssh_DISCONNECT Called when we receive a MSG_DISCONNECT message. Payload:: long code string description
Method ssh_IGNORE Called when we receieve a MSG_IGNORE message. No payload. This means nothing; we simply return.
Method ssh_UNIMPLEMENTED Called when we receieve a MSG_UNIMPLEMENTED message. Payload:: long packet
Method ssh_DEBUG No summary
Method sendDebug Send a debug message to the other side.
Method sendIgnore Send a message that will be ignored by the other side. This is useful to fool attacks based on guessing packet sizes in the encrypted stream.
Method sendUnimplemented Send a message to the other side that the last packet was not understood.
Method isEncrypted Return True if the connection is encrypted in the given direction. Direction must be one of ["out", "in", "both"].
Method isVerified Return True if the connecction is verified/authenticated in the given direction. Direction must be one of ["out", "in", "both"].
Method loseConnection Lose the connection to the other side, sending a DISCONNECT_CONNECTION_LOST message.
Method receiveUnimplemented Called when we receive an unimplemented packet message from the other side.
Method _unsupportedVersionReceived Called when an unsupported version of the ssh protocol is received from the remote endpoint.
Method _getKey Get one of the keys for authentication/encryption.

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

Method makeConnection Make a connection to a transport and a server.
def __init__(self, factory): (source)
Undocumented
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.conch.ssh.transport.SSHTransportBase.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
def receiveError(self, code, desc): (source)
overrides twisted.conch.ssh.transport.SSHTransportBase.receiveError
Called when we receive a disconnect error message from the other side.
ParametersreasonCodethe reason for the disconnect, one of the DISCONNECT_ values. (type: int )
descriptiona human-readable description of the disconnection. (type: str )
def sendDisconnect(self, code, reason): (source)
overrides twisted.conch.ssh.transport.SSHTransportBase.sendDisconnect
Send a disconnect message to the other side and then disconnect.
Parametersreasonthe reason for the disconnect. Should be one of the DISCONNECT_* values. (type: int )
desca descrption of the reason for the disconnection. (type: str )
def receiveDebug(self, alwaysDisplay, message, lang): (source)
overrides twisted.conch.ssh.transport.SSHTransportBase.receiveDebug
Called when we receive a debug message from the other side.
ParametersalwaysDisplayif True, this message should always be displayed. (type: bool )
messagethe debug message (type: str )
langoptionally the language the message is in. (type: str )
def verifyHostKey(self, pubKey, fingerprint): (source)
overrides twisted.conch.ssh.transport.SSHClientTransport.verifyHostKey
Returns a Deferred that gets a callback if it is a valid key, or an errback if not.
ParametershostKey (type: str )
fingerprint (type: str )
Returns (type: twisted.internet.defer.Deferred )
def setService(self, service): (source)
overrides twisted.conch.ssh.transport.SSHTransportBase.setService
Set our service to service and start it running. If we were running a service previously, stop it first.
Parametersservice (type: SSHService )
def connectionSecure(self): (source)
overrides twisted.conch.ssh.transport.SSHClientTransport.connectionSecure
Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.