class documentation

class twisted.conch.ssh.transport.SSHTransportBase(protocol.Protocol): (source)

Known subclasses: twisted.conch.ssh.transport.SSHClientTransport, twisted.conch.ssh.transport.SSHServerTransport

View In Hierarchy

Protocol supporting basic SSH functionality: sending/receiving packets and message dispatch. To connect to or run a server, you must use SSHClientTransport or SSHServerTransport.

Instance Variable protocolVersion A string representing the version of the SSH protocol we support. Currently defaults to '2.0'.
Instance Variable version A string representing the version of the server or client. Currently defaults to 'Twisted'.
Instance Variable comment An optional string giving more information about the server or client.
Instance Variable supportedCiphers A list of strings representing the encryption algorithms supported, in order 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 supportedKeyExchanges A list of strings representing the key exchanges supported, in order from most-preferred to least.
Instance Variable supportedPublicKeys A list of strings representing the public key types 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 supportedLanguages A list of strings representing languages supported, from most-preferred to least.
Instance Variable supportedVersions A container of strings representing supported ssh protocol version numbers.
Instance Variable isClient A boolean indicating whether this is a client or server.
Instance Variable gotVersion A boolean indicating whether we have received the version string from the other side.
Instance Variable buf Data we've received but hasn't been parsed into a packet.
Instance Variable outgoingPacketSequence the sequence number of the next packet we will send.
Instance Variable incomingPacketSequence the sequence number of the next packet we are expecting from the other side.
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 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 ourVersionString the version string that we sent to the other side. 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 otherKexInitPayload the MSG_KEXINIT payload we received. Used in the key exchange
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 service an SSHService instance, or None. If it's set to an object, it's the currently running service.
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 currentEncryptions an SSHCiphers instance. It represents the current encryption and authentication options for the transport.
Instance Variable nextEncryptions an SSHCiphers instance. Held here until the MSG_NEWKEYS messages are exchanged, when nextEncryptions is transitioned to currentEncryptions.
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.
Method connectionLost When the underlying connection is closed, stop the running service (if any), and log out the avatar (if any).
Method connectionMade Called when the connection is made to the other side. We sent our version and the MSG_KEXINIT packet.
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 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 getPeer Returns an SSHTransportAddress corresponding to the other (peer) side of this transport.
Method getHost Returns an SSHTransportAddress corresponding to the this side of transport.
Method kexAlg.setter Set the key exchange algorithm name.
Method ssh_KEXINIT No summary
Method ssh_DISCONNECT Called when we receive a MSG_DISCONNECT message. Payload:: long code string description
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:: long packet
Method ssh_DEBUG No summary
Method setService Set our service to service and start it running. If we were running a service previously, stop it first.
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 sendDisconnect Send a disconnect message to the other side and then disconnect.
Instance Variable dhSecretKey Undocumented
Instance Variable dhSecretKeyPublicMP Undocumented
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 loseConnection Lose the connection to the other side, sending a DISCONNECT_CONNECTION_LOST message.
Method receiveError Called when we receive a disconnect error message from the other side.
Method receiveUnimplemented Called when we receive an unimplemented packet message from the other side.
Method receiveDebug Called when we receive a debug message from the other side.
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 if this side of the connection initiated a key exchange, and _KEY_EXCHANGE_PROGRESSING if the other side of the connection initiated a key exchange. _KEY_EXCHANGE_NONE is the initial value (however SSH connections begin with key exchange, so it will quickly change to another state).
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. When the key exchange completes, another attempt is made to send these messages.
Class Variable _log Undocumented
Class Variable _KEY_EXCHANGE_NONE Undocumented
Class Variable _KEY_EXCHANGE_REQUESTED Undocumented
Class Variable _KEY_EXCHANGE_PROGRESSING Undocumented
Method _allowedKeyExchangeMessageType Determine if the given message type may be sent while key exchange is in progress.
Method _unsupportedVersionReceived Called when an unsupported version of the ssh protocol is received from the remote endpoint.
Instance Variable _kexAlg Undocumented
Method _startEphemeralDH Prepares for a Diffie-Hellman key agreement exchange.
Method _finishEphemeralDH Completes the Diffie-Hellman key agreement started by _startEphemeralDH, and forgets the ephemeral secret key.
Method _getKey Get one of the keys for authentication/encryption.
Method _keySetup Set up the keys for the connection and sends MSG_NEWKEYS when finished,
Method _newKeys No summary
Method _generateECPrivateKey Generate an private key for ECDH key exchange.
Method _encodeECPublicKey Encode an elliptic curve public key to bytes.
Method _generateECSharedSecret Generate a shared secret for ECDH key exchange.

Inherited from Protocol:

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

Inherited from BaseProtocol (via Protocol):

Instance Variable connected Undocumented
Instance Variable transport Undocumented
Method makeConnection Make a connection to a transport and a server.
protocolVersion = (source)
A string representing the version of the SSH protocol we support. Currently defaults to '2.0'.
(type: bytes)
version = (source)
A string representing the version of the server or client. Currently defaults to 'Twisted'.
comment = (source)
An optional string giving more information about the server or client.
(type: bytes)
supportedCiphers = (source)
A list of strings representing the encryption algorithms supported, in order from most-preferred to least.
supportedMACs = (source)
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,
(type: list[bytes])
supportedKeyExchanges = (source)
A list of strings representing the key exchanges supported, in order from most-preferred to least.
supportedPublicKeys = (source)
A list of strings representing the public key types supported, in order from most-preferred to least.
(type: list)
supportedCompressions = (source)
A list of strings representing compression types supported, from most-preferred to least.
(type: list[bytes])
supportedLanguages = (source)
A list of strings representing languages supported, from most-preferred to least.
(type: tuple)
supportedVersions = (source)
A container of strings representing supported ssh protocol version numbers.
(type: tuple[bytes, ...])
isClient = (source)
A boolean indicating whether this is a client or server.
(type: bool)
gotVersion = (source)
A boolean indicating whether we have received the version string from the other side.
(type: bool)
Data we've received but hasn't been parsed into a packet.
outgoingPacketSequence = (source)
the sequence number of the next packet we will send.
(type: int)
incomingPacketSequence = (source)
the sequence number of the next packet we are expecting from the other side.
(type: int)
outgoingCompression = (source)
an object supporting the .compress(str) and .flush() methods, or None if there is no outgoing compression. Used to compress outgoing data.
outgoingCompressionType = (source)
A string representing the outgoing compression type.
incomingCompression = (source)
an object supporting the .decompress(str) method, or None if there is no incoming compression. Used to decompress incoming data.
incomingCompressionType = (source)
A string representing the incoming compression type.
ourVersionString = (source)
the version string that we sent to the other side. Used in the key exchange.
otherVersionString = (source)
the version string sent by the other side. Used in the key exchange.
ourKexInitPayload = (source)
the MSG_KEXINIT payload we sent. Used in the key exchange.
otherKexInitPayload = (source)
the MSG_KEXINIT payload we received. Used in the key exchange
sessionID = (source)
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.
service = (source)
an SSHService instance, or None. If it's set to an object, it's the currently running service.
@property
kexAlg = (source)

The key exchange algorithm name agreed between client and server.

keyAlg = (source)
the agreed-upon public key type for the key exchange.
currentEncryptions = (source)
an SSHCiphers instance. It represents the current encryption and authentication options for the transport.
nextEncryptions = (source)
an SSHCiphers instance. Held here until the MSG_NEWKEYS messages are exchanged, when nextEncryptions is transitioned to currentEncryptions.
first = (source)
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.
_keyExchangeState = (source)
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 if this side of the connection initiated a key exchange, and _KEY_EXCHANGE_PROGRESSING if the other side of the connection initiated a key exchange. _KEY_EXCHANGE_NONE is the initial value (however SSH connections begin with key exchange, so it will quickly change to another state).
_blockedByKeyExchange = (source)
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. When the key exchange completes, another attempt is made to send these messages.
_log = (source)

Undocumented

_KEY_EXCHANGE_NONE = (source)

Undocumented

(type: str)
_KEY_EXCHANGE_REQUESTED = (source)

Undocumented

(type: str)
_KEY_EXCHANGE_PROGRESSING = (source)

Undocumented

(type: str)
def connectionLost(self, reason): (source)

When the underlying connection is closed, stop the running service (if any), and log out the avatar (if any).

ParametersreasonThe cause of the connection being closed. (type: twisted.python.failure.Failure)
def connectionMade(self): (source)

Called when the connection is made to the other side. We sent our version and the MSG_KEXINIT packet.

def sendKexInit(self): (source)

Send a KEXINIT message to initiate key exchange or to respond to a key exchange initiated by the peer.

ReturnsNone
RaisesRuntimeErrorIf a key exchange has already been started and it is not appropriate to send a KEXINIT message at this time.
def _allowedKeyExchangeMessageType(self, messageType): (source)

Determine if the given message type may be sent while key exchange is in progress.

ParametersmessageTypeThe type of message (type: int)
ReturnsTrue if the given type of message may be sent while key exchange is in progress, False if it may not. (type: bool)
See Alsohttp://tools.ietf.org/html/rfc4253#section-7.1
def sendPacket(self, messageType, payload): (source)

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.

ParametersmessageTypeThe type of the packet; generally one of the MSG_* values. (type: int)
payloadThe payload for the message. (type: str)
def getPacket(self): (source)

Try to return a decrypted, authenticated, and decompressed packet out of the buffer. If there is not enough data, return None.

ReturnsThe decoded packet, if any. (type: str or None)
def _unsupportedVersionReceived(self, remoteVersion): (source)

Called when an unsupported version of the ssh protocol is received from the remote endpoint.

ParametersremoteVersionremote ssh protocol version which is unsupported by us. (type: str)
def dataReceived(self, data): (source)

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.

ParametersdataThe data that was received. (type: bytes)
def dispatchMessage(self, messageNum, payload): (source)

Send a received message to the appropriate method.

ParametersmessageNumThe message number. (type: int)
payloadThe message payload. (type: bytes)
def getPeer(self): (source)

Returns an SSHTransportAddress corresponding to the other (peer) side of this transport.

ReturnsSSHTransportAddress for the peer (type: SSHTransportAddress)
Present Since12.1
def getHost(self): (source)

Returns an SSHTransportAddress corresponding to the this side of transport.

ReturnsSSHTransportAddress for the peer (type: SSHTransportAddress)
Present Since12.1
@kexAlg.setter
def kexAlg(self, value): (source)

Set the key exchange algorithm name.

_kexAlg = (source)

Undocumented

def ssh_KEXINIT(self, packet): (source)

Called when we receive a MSG_KEXINIT message. Payload:

    bytes[16] cookie
    string keyExchangeAlgorithms
    string keyAlgorithms
    string incomingEncryptions
    string outgoingEncryptions
    string incomingAuthentications
    string outgoingAuthentications
    string incomingCompressions
    string outgoingCompressions
    string incomingLanguages
    string outgoingLanguages
    bool firstPacketFollows
    unit32 0 (reserved)

Starts setting up the key exchange, keys, encryptions, and authentications. Extended by ssh_KEXINIT in SSHServerTransport and SSHClientTransport.

ParameterspacketThe message data. (type: bytes)
ReturnsA tuple of negotiated key exchange algorithms, key algorithms, and unhandled data, or None if something went wrong.
def ssh_DISCONNECT(self, packet): (source)

Called when we receive a MSG_DISCONNECT message. Payload:

    long code
    string description

This means that the other side has disconnected. Pass the message up and disconnect ourselves.

ParameterspacketThe message data. (type: bytes)
def ssh_IGNORE(self, packet): (source)

Called when we receive a MSG_IGNORE message. No payload. This means nothing; we simply return.

ParameterspacketThe message data. (type: bytes)
def ssh_UNIMPLEMENTED(self, packet): (source)

Called when we receive a MSG_UNIMPLEMENTED message. Payload:

    long packet

This means that the other side did not implement one of our packets.

ParameterspacketThe message data. (type: bytes)
def ssh_DEBUG(self, packet): (source)

Called when we receive a MSG_DEBUG message. Payload:

    bool alwaysDisplay
    string message
    string language

This means the other side has passed along some debugging info.

ParameterspacketThe message data. (type: bytes)
def setService(self, service): (source)

Set our service to service and start it running. If we were running a service previously, stop it first.

ParametersserviceThe service to attach. (type: SSHService)
def sendDebug(self, message, alwaysDisplay=False, language=b''): (source)

Send a debug message to the other side.

Parametersmessagethe message to send. (type: str)
alwaysDisplayif True, tell the other side to always display this message. (type: bool)
languageoptionally, the language the message is in. (type: str)
def sendIgnore(self, message): (source)

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.

Parametersmessagedata to send with the message (type: str)
def sendUnimplemented(self): (source)

Send a message to the other side that the last packet was not understood.

def sendDisconnect(self, reason, desc): (source)

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 _startEphemeralDH(self): (source)

Prepares for a Diffie-Hellman key agreement exchange.

Creates an ephemeral keypair in the group defined by (self.g, self.p) and stores it.

dhSecretKey = (source)

Undocumented

dhSecretKeyPublicMP = (source)

Undocumented

def _finishEphemeralDH(self, remoteDHpublicKey): (source)

Completes the Diffie-Hellman key agreement started by _startEphemeralDH, and forgets the ephemeral secret key.

ParametersremoteDHpublicKeyUndocumented (type: int)
ReturnsThe new shared secret, in SSH mpint format. (type: bytes)
def _getKey(self, c, sharedSecret, exchangeHash): (source)

Get one of the keys for authentication/encryption.

ParameterscThe letter identifying which key this is. (type: bytes)
sharedSecretThe shared secret K. (type: bytes)
exchangeHashThe hash H from key exchange. (type: bytes)
ReturnsThe derived key. (type: bytes)
def _keySetup(self, sharedSecret, exchangeHash): (source)

Set up the keys for the connection and sends MSG_NEWKEYS when finished,

ParameterssharedSecreta secret string agreed upon using a Diffie- Hellman exchange, so it is only shared between the server and the client. (type: str)
exchangeHashA hash of various data known by both sides. (type: str)
def _newKeys(self): (source)

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.

def isEncrypted(self, direction='out'): (source)

Check if the connection is encrypted in the given direction.

ParametersdirectionThe direction: one of 'out', 'in', or 'both'. (type: str)
ReturnsTrue if it is encrypted. (type: bool)
def isVerified(self, direction='out'): (source)

Check if the connection is verified/authentication in the given direction.

ParametersdirectionThe direction: one of 'out', 'in', or 'both'. (type: str)
ReturnsTrue if it is verified. (type: bool)
def loseConnection(self): (source)

Lose the connection to the other side, sending a DISCONNECT_CONNECTION_LOST message.

def receiveError(self, reasonCode, description): (source)

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 receiveUnimplemented(self, seqnum): (source)

Called when we receive an unimplemented packet message from the other side.

Parametersseqnumthe sequence number that was not understood. (type: int)
def receiveDebug(self, alwaysDisplay, message, lang): (source)

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 _generateECPrivateKey(self): (source)

Generate an private key for ECDH key exchange.

ReturnsThe generated private key. (type: The appropriate private key type matching self.kexAlg: ec.EllipticCurvePrivateKey for ecdh-sha2-nistp*, or x25519.X25519PrivateKey for curve25519-sha256.)
def _encodeECPublicKey(self, ecPub): (source)

Encode an elliptic curve public key to bytes.

ParametersecPubThe public key to encode. (type: The appropriate public key type matching self.kexAlg: ec.EllipticCurvePublicKey for ecdh-sha2-nistp*, or x25519.X25519PublicKey for curve25519-sha256.)
ReturnsThe encoded public key. (type: bytes)
def _generateECSharedSecret(self, ecPriv, theirECPubBytes): (source)

Generate a shared secret for ECDH key exchange.

ParametersecPrivOur private key. (type: The appropriate private key type matching self.kexAlg: ec.EllipticCurvePrivateKey for ecdh-sha2-nistp*, or x25519.X25519PrivateKey for curve25519-sha256.)
theirECPubBytesUndocumented
ReturnsThe generated shared secret, as an SSH multiple-precision integer. (type: bytes)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.