twisted.conch.test.test_userauth.FakeTransport

class documentation

class FakeTransport(transport.SSHTransportBase): (source)

View In Hierarchy

userauth.SSHUserAuthServer expects an SSH transport which has a factory attribute which has a portal attribute. Because the portal is important for testing authentication, we need to be able to provide an interesting portal object to the SSHUserAuthServer.

In addition, we want to be able to capture any packets sent over the transport.

Parameters
lostConnecionTrue if loseConnection has been called on us.
Class Factory A mock factory, representing the factory that spawned this user auth service.
Class Service A mock service, representing the other service offered by the server.
Method __init__ Undocumented
Method isEncrypted Pretend that this transport encrypts traffic in both directions. The SSHUserAuthServer disables password authentication if the transport isn't encrypted.
Method loseConnection Lose the connection to the other side, sending a DISCONNECT_CONNECTION_LOST message.
Method sendPacket Record the packet sent by the service.
Instance Variable factory Undocumented
Instance Variable lostConnection Undocumented
Instance Variable packets a list of 2-tuples: (messageType, data). Each 2-tuple is a sent packet.
Instance Variable transport Undocumented

Inherited from SSHTransportBase:

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 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 isVerified Check if the connection is verified/authentication in the given direction.
Method kexAlg.setter Set the key exchange algorithm name.
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 receiveUnimplemented Called when we receive an unimplemented packet message from the other side.
Method sendDebug Send a debug message to the other side.
Method sendDisconnect Send a disconnect message to the other side and then disconnect.
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 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_KEXINIT Called when we receive a MSG_KEXINIT message. Payload:
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 isClient A boolean indicating whether this is a client or server.
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 _keySetup Set up the keys for the connection and sends MSG_NEWKEYS when finished,
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 SSHTransportBase):

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

Inherited from BaseProtocol (via SSHTransportBase, Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
def __init__(self, portal): (source)

Undocumented

def isEncrypted(self, direction): (source)
overrides twisted.conch.ssh.transport.SSHTransportBase.isEncrypted

Pretend that this transport encrypts traffic in both directions. The SSHUserAuthServer disables password authentication if the transport isn't encrypted.

def loseConnection(self): (source)
overrides twisted.conch.ssh.transport.SSHTransportBase.loseConnection

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

def sendPacket(self, messageType, message): (source)
overrides twisted.conch.ssh.transport.SSHTransportBase.sendPacket

Record the packet sent by the service.

factory = (source)
overrides twisted.internet.protocol.Protocol.factory

Undocumented

lostConnection: bool = (source)

Undocumented

packets: list = (source)

a list of 2-tuples: (messageType, data). Each 2-tuple is a sent packet.

transport = (source)
overrides twisted.internet.protocol.BaseProtocol.transport

Undocumented