a@#bdZddlZddlmZddlmZmZmZmZddl m Z m Z m Z m Z GddeZy)z& Implementation of an SSH2 "message". N)util) zero_bytemax_byteone_byteasbytes)longBytesIOu integer_typesceZdZdZedZd!dZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ!d Z"y)"Messagea 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. l~NcH|t||_yt|_y)z Create a new SSH2 message. :param str content: the byte stream to use as the message content (passed in only when decomposing a message). N)r packet)selfcontents 0lib/python3.12/site-packages/paramiko/message.py__init__zMessage.__init__+s  !'*DK!)DKc"|jS)zX Return the byte stream content of this message, as a string/bytes obj. )rrs r__str__zMessage.__str__8s||~rcTdt|jjzdzS)zP Returns a string representation of this object, for debugging. zparamiko.Message())reprrgetvaluers r__repr__zMessage.__repr__>s&#T$++*>*>*@%AACGGrc6|jjS)zK Return the byte stream content of this Message, as bytes. )rrrs rrzMessage.asbytesDs{{##%%rc:|jjdy)zk Rewind the message to the beginning as if no items had been parsed out of it yet. rN)rseekrs rrewindzMessage.rewindJs rc|jj}|jj}|jj||S)zv Return the bytes (as a `str`) of this message that haven't already been parsed and returned. )rtellreadr)rposition remainders r get_remainderzMessage.get_remainderQs@ ;;##%KK$$&  "rc|jj}|j|jj|S)z Returns the `str` bytes of this message that have been parsed and returned. The string passed into a message's constructor can be regenerated by concatenating ``get_so_far`` and `get_remainder`. )rr"r r#)rr$s r get_so_farzMessage.get_so_far[s4 ;;##% {{))rc|jj|}d}t||cxkr|krn|S|t|t|z zzS|S)a Return the next ``n`` bytes of the message (as a `str`), without decomposing into an int, decoded string, etc. Just the raw bytes are returned. Returns a string of ``n`` zero bytes if there weren't ``n`` bytes remaining in the message. i)rr#lenr)rnb max_pad_sizes r get_byteszMessage.get_bytesesR KK  Q  q6A $ $yAAJ// /rc$|jdS)a  Return the next byte of the message, without decomposing it. This is equivalent to `get_bytes(1) `. :return: the next (`str`) byte of the message, or ``''`` if there aren't any bytes remaining. )r.rs rget_bytezMessage.get_byters~~a  rc6|jd}|tk7S)z2 Fetch a boolean from the stream. r0)r.rrr,s r get_booleanzMessage.get_boolean}s NN1 I~rc|jd}|tk(r#tj|j S||jdz }t j d|dS)zZ Fetch an int from the stream. :return: a 32-bit unsigned `int`. r0>Ir)r.rr inflate_long get_binarystructunpack)rbytes rget_adaptive_intzMessage.get_adaptive_ints[ ~~a  8 $$T__%67 7 q!!}}T4(++rcRtjd|jddS)z/ Fetch an int from the stream. r7rr:r;r.rs rget_intzMessage.get_ints#}}T4>>!#45a88rcRtjd|jddS)zk Fetch a 64-bit int from the stream. :return: a 64-bit unsigned integer (`long`). >Qrr@rs r get_int64zMessage.get_int64s# }}T4>>!#45a88rcHtj|jS)zs Fetch a long int (mpint) from the stream. :return: an arbitrary-length integer (`long`). )rr8r9rs r get_mpintzMessage.get_mpints   !233rc@|j|jS)z Fetch a `str` 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.) r.rArs r get_stringzMessage.get_string ~~dlln--rc4t|jS)z9 Fetch a Unicode string from the stream. )r rJrs rget_textzMessage.get_texts"##rc@|j|jS)z 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.) rIrs rr9zMessage.get_binaryrKrc@|jjdS)z Fetch a list of `strings ` from the stream. These are trivially encoded as comma-separated values in a string. ,)rMsplitrs rget_listzMessage.get_lists }}$$S))rc<|jj||S)zh Write bytes to the stream, without any formatting. :param str b: bytes to add rwriter3s r add_byteszMessage.add_bytes ! rc<|jj||S)zo Write a single byte to the stream, without any formatting. :param str b: byte to add rTr3s radd_bytezMessage.add_byterWrc|r!|jjt|S|jjt|S)za Add a boolean value to the stream. :param bool b: boolean value to add )rrUrrr3s r add_booleanzMessage.add_booleans9 KK  h '  KK  i ( rcd|jjtjd||SzU Add an integer to the stream. :param int n: integer to add r7rrUr:packrr+s radd_intzMessage.add_int& &++dA./ rc|tjk\rE|jjt|j t j||S|jjtjd||Sr]) r big_intrrUr add_stringr deflate_longr:r_r`s radd_adaptive_intzMessage.add_adaptive_intsd   KK  h ' OOD--a0 1  KK  fkk$2 3 rcd|jjtjd||S)zY Add a 64-bit int to the stream. :param long n: long int to add rCr^r`s r add_int64zMessage.add_int64rbrcN|jtj||S)z Add a long int to the stream, encoded as an infinite-precision integer. This method only works on positive numbers. :param long z: long int to add )rerrf)rzs r add_mpintzMessage.add_mpints  ))!,- rct|}|jt||jj ||S)zR Add a string to the stream. :param str s: string to add )rrar*rrU)rss rrezMessage.add_string s4 AJ SV ! rcF|jdj||S)z 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.) :param l: list of strings to add rP)rejoin)rls radd_listzMessage.add_lists  $ rct|tur|j|St|tr|j |St|t ur|j|S|j|SN) typeboolr[ isinstancer rglistrrre)ris r_addz Message._add!sb 7d?##A& & = )((+ + !W_==# #??1% %rc4|D]}|j|y)a Add a sequence of items to the stream. The values are encoded based on their type: str, int, bool, list, or long. .. warning:: Longs are encoded non-deterministically. Don't use this method. :param seq: the sequence of items N)rz)rseqitems raddz Message.add+s D IIdO rrt)#__name__ __module__ __qualname____doc__rrdrrrrr r&r(r.r1r4r=rArErGrJrMr9rRrVrYr[rargrirlrerrrzr~rrr r s:G $ H & *  ! ,9 94.$ .*    & rr )rr:paramikorparamiko.commonrrrrparamiko.py3compatrr r r objectr rrrrs,&BB>>XfXr