Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`scripts`.`tkconch`.`SSHClientTransport``

class documentation

`class SSHClientTransport(transport.SSHClientTransport): (source)`

View In Hierarchy

Undocumented

Method | `connectionSecure` | Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.
Method | `receiveDebug` | Called when we receive a debug message from the other side.
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 | `verifyHostKey` | Returns a Deferred that gets a callback if it is a valid key, or an errback if not.
Method | `_cbVerifyHostKey` | Undocumented

Inherited from `SSHClientTransport`:

Method | `connectionMade` | Called when the connection is started with the server. Just sets up a private instance variable.
Method | `requestService` | Request that a service be run over this transport.
Method | `ssh_KEX_DH_GEX_GROUP` | This handles different messages which share an integer value.
Method | `ssh_KEX_DH_GEX_REPLY` | Called when we receive a MSG_KEX_DH_GEX_REPLY message. Payload:
Method | `ssh_KEXINIT` | Called when we receive a MSG_KEXINIT message. For a description of the packet, see SSHTransportBase.ssh_KEXINIT(). Additionally, this method sends the first key exchange packet.
Method | `ssh_NEWKEYS` | Called when we receive a MSG_NEWKEYS message. No payload. If we've finished setting up our own keys, start using them. Otherwise, remember that we've received this message.
Method | `ssh_SERVICE_ACCEPT` | Called when we receive a MSG_SERVICE_ACCEPT message. Payload:
Instance Variable | `e` | our Diffie-Hellman public key.
Instance Variable | `ecPriv` | Undocumented
Instance Variable | `ecPub` | Undocumented
Instance Variable | `g` | the Diffie-Hellman group generator.
Instance Variable | `instance` | the SSHService object we are requesting.
Instance Variable | `isClient` | since we are always the client, this is always True.
Instance Variable | `p` | the Diffie-Hellman group prime
Instance Variable | `x` | our Diffie-Hellman private key.
Method | `_continueGEX_REPLY` | The host key has been verified, so we generate the keys.
Method | `_continueKEXDH_REPLY` | The host key has been verified, so we generate the keys.
Method | `_keySetup` | See SSHTransportBase._keySetup().
Method | `_ssh_KEX_ECDH_REPLY` | Called to handle a reply to a ECDH exchange message(KEX_ECDH_INIT).
Method | `_ssh_KEXDH_REPLY` | Called to handle a reply to a non-group key exchange message (KEXDH_INIT).
Instance Variable | `_dhMaximalGroupSize` | Maximal acceptable group size advertised by the client in MSG_KEX_DH_GEX_REQUEST.
Instance Variable | `_dhMinimalGroupSize` | Minimal acceptable group size advertised by the client in MSG_KEX_DH_GEX_REQUEST.
Instance Variable | `_dhPreferredGroupSize` | Preferred group size advertised by the client in MSG_KEX_DH_GEX_REQUEST.
Instance Variable | `_gotNewKeys` | if we receive a MSG_NEWKEYS message before we are ready to transition to the new keys, this is set to True so we can transition when the keys are ready locally.

Inherited from `SSHTransportBase` (via `SSHClientTransport`):

Method | `connectionLost` | When the underlying connection is closed, stop the running service (if any), and log out the avatar (if any).
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 | `getHost` | Returns an `SSHTransportAddress` corresponding to the this side of transport.
Method | `getPacket` | Try to return a decrypted, authenticated, and decompressed packet out of the buffer. If there is not enough data, return None.
Method | `getPeer` | Returns an `SSHTransportAddress` corresponding to the other (peer) side of this transport.
Method | `isEncrypted` | Check if the connection is encrypted in the given direction.
Method | `isVerified` | Check if the connection is verified/authentication in the given direction.
Method | `kexAlg.setter` | Set the key exchange algorithm name.
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 | `sendDebug` | Send a debug message to the other side.
Method | `sendExtInfo` | Send an RFC 8308 extension advertisement to the remote peer.
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 | `sendKexInit` | Send a KEXINIT message to initiate key exchange or to respond to a key exchange initiated by the peer.
Method | `sendPacket` | Sends a packet. If it's been set up, compress the data, encrypt it, and authenticate it before sending. If key exchange is in progress and the message is not part of key exchange, queue it to be sent later.
Method | `sendUnimplemented` | Send a message to the other side that the last packet was not understood.
Method | `setService` | Set our service to service and start it running. If we were running a service previously, stop it first.
Method | `ssh_DEBUG` | Called when we receive a MSG_DEBUG message. Payload:
Method | `ssh_DISCONNECT` | Called when we receive a MSG_DISCONNECT message. Payload:
Method | `ssh_EXT_INFO` | Called when we get a MSG_EXT_INFO message. Payload:
Method | `ssh_IGNORE` | Called when we receive a MSG_IGNORE message. No payload. This means nothing; we simply return.
Method | `ssh_UNIMPLEMENTED` | Called when we receive a MSG_UNIMPLEMENTED message. Payload:
Instance Variable | `buf` | Data we've received but hasn't been parsed into a packet.
Instance Variable | `comment` | An optional string giving more information about the server or client.
Instance Variable | `currentEncryptions` | an SSHCiphers instance. It represents the current encryption and authentication options for the transport.
Instance Variable | `dhSecretKey` | Undocumented
Instance Variable | `dhSecretKeyPublicMP` | Undocumented
Instance Variable | `first` | the first bytes of the next packet. In order to avoid decrypting data twice, the first bytes are decrypted and stored until the whole packet is available.
Instance Variable | `gotVersion` | A boolean indicating whether we have received the version string from the other side.
Instance Variable | `incomingCompression` | an object supporting the .decompress(str) method, or None if there is no incoming compression. Used to decompress incoming data.
Instance Variable | `incomingCompressionType` | A string representing the incoming compression type.
Instance Variable | `incomingPacketSequence` | the sequence number of the next packet we are expecting from the other side.
Instance Variable | `kexAlg` | The key exchange algorithm name agreed between client and server.
Instance Variable | `keyAlg` | the agreed-upon public key type for the key exchange.
Instance Variable | `nextEncryptions` | an SSHCiphers instance. Held here until the MSG_NEWKEYS messages are exchanged, when nextEncryptions is transitioned to currentEncryptions.
Instance Variable | `otherKexInitPayload` | the MSG_KEXINIT payload we received. Used in the key exchange
Instance Variable | `otherVersionString` | the version string sent by the other side. Used in the key exchange.
Instance Variable | `ourKexInitPayload` | the MSG_KEXINIT payload we sent. Used in the key exchange.
Instance Variable | `ourVersionString` | the version string that we sent to the other side. Used in the key exchange.
Instance Variable | `outgoingCompression` | an object supporting the .compress(str) and .flush() methods, or None if there is no outgoing compression. Used to compress outgoing data.
Instance Variable | `outgoingCompressionType` | A string representing the outgoing compression type.
Instance Variable | `outgoingPacketSequence` | the sequence number of the next packet we will send.
Instance Variable | `peerExtensions` | a dict of extensions supported by the other side of the connection.
Instance Variable | `protocolVersion` | A string representing the version of the SSH protocol we support. Currently defaults to '2.0'.
Instance Variable | `service` | an SSHService instance, or None. If it's set to an object, it's the currently running service.
Instance Variable | `sessionID` | a string that is unique to this SSH session. Created as part of the key exchange, sessionID is used to generate the various encryption and authentication keys.
Instance Variable | `supportedCiphers` | A list of strings representing the encryption algorithms supported, in order from most-preferred to least.
Instance Variable | `supportedCompressions` | A list of strings representing compression types supported, from most-preferred to least.
Instance Variable | `supportedKeyExchanges` | A list of strings representing the key exchanges supported, in order from most-preferred to least.
Instance Variable | `supportedLanguages` | A list of strings representing languages supported, from most-preferred to least.
Instance Variable | `supportedMACs` | A list of strings representing the message authentication codes (hashes) supported, in order from most-preferred to least. Both this and supportedCiphers can include 'none' to use no encryption or authentication, but that must be done manually,...
Instance Variable | `supportedPublicKeys` | A list of strings representing the public key algorithms supported, in order from most-preferred to least.
Instance Variable | `supportedVersions` | A container of strings representing supported ssh protocol version numbers.
Instance Variable | `version` | A string representing the version of the server or client. Currently defaults to 'Twisted'.
Method | `_allowedKeyExchangeMessageType` | Determine if the given message type may be sent while key exchange is in progress.
Method | `_encodeECPublicKey` | Encode an elliptic curve public key to bytes.
Method | `_finishEphemeralDH` | Completes the Diffie-Hellman key agreement started by _startEphemeralDH, and forgets the ephemeral secret key.
Method | `_generateECPrivateKey` | Generate an private key for ECDH key exchange.
Method | `_generateECSharedSecret` | Generate a shared secret for ECDH key exchange.
Method | `_getKey` | Get one of the keys for authentication/encryption.
Method | `_newKeys` | Called back by a subclass once a MSG_NEWKEYS message has been received. This indicates key exchange has completed and new encryption and compression parameters should be adopted. Any messages which were queued during key exchange will also be flushed.
Method | `_startEphemeralDH` | Prepares for a Diffie-Hellman key agreement exchange.
Method | `_unsupportedVersionReceived` | Called when an unsupported version of the ssh protocol is received from the remote endpoint.
Constant | `_EXT_INFO_C` | Undocumented
Constant | `_EXT_INFO_S` | Undocumented
Constant | `_KEY_EXCHANGE_NONE` | Undocumented
Constant | `_KEY_EXCHANGE_PROGRESSING` | Undocumented
Constant | `_KEY_EXCHANGE_REQUESTED` | Undocumented
Class Variable | `_log` | Undocumented
Instance Variable | `_blockedByKeyExchange` | Whenever `_keyExchangeState` is not `_KEY_EXCHANGE_NONE`, this is a `list` of pending messages which were passed to `sendPacket` but could not be sent because it is not legal to send them while a key exchange is in progress...
Instance Variable | `_kexAlg` | Undocumented
Instance Variable | `_keyExchangeState` | The current protocol state with respect to key exchange. This is either `_KEY_EXCHANGE_NONE` if no key exchange is in progress (and returns to this value after any key exchange completqes), `_KEY_EXCHANGE_REQUESTED`...
Instance Variable | `_peerSupportsExtensions` | a boolean indicating whether the other side of the connection supports RFC 8308 extension negotiation.

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

Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable | `factory` | Undocumented

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

Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

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.

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.

Parameters
alwaysDisplay:`bool` | if True, this message should always be displayed.
message:`str` | the debug message
lang:`str` | optionally the language the message is in.

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.

Parameters
code | Undocumented
desc | Undocumented
reasonCode:`int` | the reason for the disconnect, one of the DISCONNECT_ values.
description:`str` | a human-readable description of the disconnection.

def sendDisconnect(self, code, reason): (source)
overrides `twisted.conch.ssh.transport.SSHTransportBase.sendDisconnect`

Send a disconnect message to the other side and then disconnect.

Parameters
code | Undocumented
reason:`int` | the reason for the disconnect. Should be one of the DISCONNECT_* values.
desc:`str` | a descrption of the reason for the disconnection.

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.

Parameters
pubKey | Undocumented
fingerprint:`bytes` | The fingerprint of the key.
hostKey:`bytes` | The host key to verify.
Returns
A deferred firing with `True` if the key is valid.

def _cbVerifyHostKey(self, ans, pubKey, khHost, keyType): (source)

Undocumented