Implementation of an SSH2 “message”.
An SSH2 message is a stream of bytes that encodes some combination of strings, integers, bools, and infinite-precision integers (known in Python as longs). This class builds or breaks down such a byte stream.
Normally you don’t need to deal with anything this low-level, but it’s exposed for people implementing custom extensions, or features that paramiko doesn’t support yet.
Create a new SSH2 message.
Parameters: content (str) – the byte stream to use as the message content (passed in only when decomposing a message).
Returns a string representation of this object, for debugging.
Return the byte stream content of this message, as a string/bytes obj.
list of weak references to the object (if defined)
Add a sequence of items to the stream. The values are encoded based on their type: str, int, bool, list, or long.
Longs are encoded non-deterministically. Don’t use this method.
Parameters: seq – the sequence of items
Write a single byte to the stream, without any formatting.
Parameters: b (str) – byte to add
Add a list of strings to the stream. They are encoded identically to a single string of values separated by commas. (Yes, really, that’s how SSH2 does it.)
Parameters: l (list) – list of strings to add
Add a long int to the stream, encoded as an infinite-precision integer. This method only works on positive numbers.
Parameters: z (long) – long int to add
Return the byte stream content of this Message, as bytes.
Fetch a string from the stream. This could be a byte string and may contain unprintable characters. (It’s not unheard of for a string to contain another byte-stream Message.)
Fetch a boolean from the stream.
Return the next byte of the message, without decomposing it. This is equivalent to
Returns: the next (
str) byte of the message, or
'\'if there aren’t any bytes remaining.
Return the next
nbytes of the message (as a
str), without decomposing into an int, decoded string, etc. Just the raw bytes are returned. Returns a string of
nzero bytes if there weren’t
nbytes remaining in the message.
Fetch an int from the stream.
These are trivially encoded as comma-separated values in a string.
Return the bytes (as a
str) of this message that haven’t already been parsed and returned.
strfrom the stream. This could be a byte string and may contain unprintable characters. (It’s not unheard of for a string to contain another byte-stream message.)
Fetch a Unicode string from the stream.
Rewind the message to the beginning as if no items had been parsed out of it yet.