johXdZddlmZddlZddlmZmZddlmZm Z m Z ddl m Z ddl mZmZdd lmZdd lmZmZmZdd lmZmZerdd lmZejeZd ZdZdZ dZ!de"dDZ#dZ$d0dZ%d1dZ&d2d#Z'd3d'Z(d4d+Z)Gd,d-Z*Gd.d/Z+dS)5zL Implements the HPACK header compression algorithm as detailed by RFC 7541. ) annotationsN) TYPE_CHECKINGAny)HPACKDecodingErrorInvalidTableSizeErrorOversizedHeaderListError)HuffmanEncoder) REQUEST_CODESREQUEST_CODES_LENGTH)decode_huffman) HeaderTupleHeaderWeaklyTypedNeverIndexedHeaderTuple) HeaderTabletable_entry_size)Iterable@cg|] }d|zdz  S)r).0is 9C:\Projects\DSCons\.venv\Lib\site-packages\hpack\hpack.py rs :::AAFa<::: iheaderrrawboolreturnrct|d}t|d}|s<||d|dS|||S)zj Provides a header as a unicode string if raw is False, otherwise returns it as a bytestring. rrutf-8)bytes __class__decode)r!r"namevalues r_unicode_if_neededr,%ss   D &)  E M G 4 4ell76K6KLLL   D% ( ((rintegerint prefix_bits bytearrayctd|||dkrd|}t||dks|dkrd|}t|t|}||krt |gS|g}||z}|dkr&||dzdz|d z}|dk&||t |S) zi Encodes an integer according to the wacky integer encoding rules defined in the HPACK spec. zEncoding %d with %d bitsrz'Can only encode positive integers, got r)Prefix bits must be between 1 and 8, got )logdebug ValueError_PREFIX_BIT_MAX_NUMBERSr0append)r-r/msg max_numberelementss rencode_integerr?2s II(';???{{AAAooQ+//G+GGoo(5J'###|H zG S..3#-...A  S.. OOG X  rdatabytes | memoryviewtuple[int, int]c|dks|dkrd|}t|t|}d}d}dd|z z } |d|z}||krN ||}|dz }|dkr ||dz |zz }n |||zz }n%|dz }|tkrd |}t|Mn'#t$r} d |}t|| d } ~ wwxYwt d ||||fS) z Decodes an integer according to the wacky integer encoding rules defined in the HPACK spec. Returns a tuple of the decoded integer and the number of bytes that were consumed from ``data`` in order to get that integer. rr2r3rTr4r6z-Variable integer representation is too long: z3Unable to decode HPACK integer representation from NzDecoded %d, consumed %d bytes)r9r:VARINT_MAX_LENGTHr IndexErrorr7r8) r@r/r<r=indexshiftmasknumber next_byteerrs rdecode_integerrMQsPQ+//G+GGoo(5J E E Q_ %D/a4 Z   2 K  ##y3588FFi500F ,,,S$RRC,S111) 2, ///LDLL %%3./II-vu=== 5=sAB B?%B::B? header_dictdict[bytes | str, bytes | str])Iterable[tuple[bytes | str, bytes | str]]c#Kt|ts!dt|}t|t |d}|D]}|||fVdS)z Converts a dictionary to an iterable of key-value tuples. This is a HPACK-specific function because it pulls "special-headers" out first and then emits them. zheader_dict not a dict, but cHt|d S)N:) _to_bytes startswith)ks rz#_dict_to_iterable..s)A,,11$777r)keyN) isinstancedicttype TypeErrorsortedkeys)rNr<r^rXs r_dict_to_iterabler_s k4 ( (@T+->->@@nn  7 7   D$$;s######$$rr+bytes | str | Anyr'ct|}|tur|S|turt|}|dS)zB Convert anything to bytes through a UTF-8 encoded string r&)r[r'strencode)r+ts rrTrTsC U AEzz ||E  <<  rceZdZdZddZeddZejddZ d d!dZd"d#dZ d$dZ d"d%dZ d"d&dZ d'dZ dS)(Encoderzm An HPACK encoder object. This object takes HTTP headers and emits encoded HTTP/2 header blocks. r$Nonecxt|_ttt|_g|_dSN)r header_tabler r r huffman_codertable_size_changesselfs r__init__zEncoder.__init__s6'MM+ /  .0rr.c|jjSz> Controls the size of the HPACK header table. rjmaxsizerms rheader_table_sizezEncoder.header_table_size  ((rr+cn||j_|jjr|j|dSdSri)rjrsresizedrlr;rnr+s rrtzEncoder.header_table_sizesB$)!   $ 2  # * *5 1 1 1 1 1 2 2rTheadersIterable[HeaderTuple | tuple[bytes | str, bytes | str] | tuple[bytes | str, bytes | str, bool | None]] | dict[bytes | str, bytes | str]huffmanr#r'czg}|jjr3||d|j_t |t rt |}n t|}|D]}d}t |tr |j }nt|dkr|d}t|dt|df}|| |||d |}td||S)a Takes a set of headers and encodes them into a HPACK-encoded header block. :param headers: The headers to encode. Must be either an iterable of tuples, an iterable of :class:`HeaderTuple `, or a ``dict``. If an iterable of tuples, the tuples may be either two-tuples or three-tuples. If they are two-tuples, the tuples must be of the format ``(name, value)``. If they are three-tuples, they must be of the format ``(name, value, sensitive)``, where ``sensitive`` is a boolean value indicating whether the header should be added to header tables anywhere. If not present, ``sensitive`` defaults to ``False``. If an iterable of :class:`HeaderTuple `, the tuples must always be two-tuples. Instead of using ``sensitive`` as a third tuple entry, use :class:`NeverIndexedHeaderTuple ` to request that the field never be indexed. .. warning:: HTTP/2 requires that all special headers (headers whose names begin with ``:`` characters) appear at the *start* of the header block. While this method will ensure that happens for ``dict`` subclasses, callers using any other iterable of tuples **must** ensure they place their special headers at the start of the iterable. For efficiency reasons users should prefer to use iterables of two-tuples: fixing the ordering of dictionary headers is an expensive operation that should be avoided if possible. :param huffman: (optional) Whether to Huffman-encode any header sent as a literal value. Except for use when debugging, it is recommended that this be left enabled. :returns: A bytestring containing the HPACK-encoded header block. FrrrrzEncoded header block to %s)rjrwr;_encode_table_size_changerYrZr_iterr indexablelenrTaddjoinr7r8) rnryr{ header_block hpack_headersr! sensitive new_headerencodeds rrczEncoder.encodes=p    $ .    > > @ @ A A A(-D  % gt $ $ *.g66MM &!MMM$ J JFI&+.. & & 00 Vq"1I #F1I.. &)0D0DEJ   Y H H I I I I((<(( .888rFto_addtuple[bytes, bytes]rc|\}}|s|nd}td|||||stnt}|j||}|7|||||} |s|j||| S|\} }} | || } n5| | |||} |s|j||| S)a} Serializes a header key-value tuple. When sensitive is True, the header will not be added to the header table (see https://www.rfc-editor.org/rfc/rfc7541.html#section-7.1.3 for details), furthermore, the header value will be redacted in debug logs, as "SENSITIVE_REDACTED", to prevent accidental exposure of sensitive information. sSENSITIVE_REDACTEDz:Adding %s=%s to the header table, sensitive:%s, huffman:%s) r7r8INDEX_INCREMENTAL INDEX_NEVERrjsearch_encode_literalr_encode_indexed_encode_indexed_literal) rnrrr{r*r+ display_valueindexbitmatchrrGperfects rrz Encoder.add)s$ e%.I4I  H        -6F$$;!((u55 =**4'JJG 3!%%dE222N %tW  **511GG22uhG 3!%%dE222rrGc`t|d}|dxxdzcc<t|S)zD Encodes a header using the indexed representation. r6rr4)r?r')rnrGfields rrzEncoder._encode_indexedas5ua(( aDU||rr*rc|r4|j|}|j|}tt|d}tt|d}|r |dxxdzcc<|dxxdzcc<d|t ||t ||gS)z Encodes a header with a literal name and literal value. If ``indexing`` is True, the header will be added to the header table: otherwise it will not. r6rr4r)rkrcr?rrr')rnr*r+rr{name_len value_lens rrzEncoder._encode_literalis  5%,,T22D&--e44E!#d))Q//"3u::q11  ! QKKK4 KKK aLLLD LLLxx uXeI.>.> F   rc|tkrt|d}nt|d}|dxxt|zcc<|r|j|}tt |d}|r|dxxdzcc<dt|t||gS)zv Encodes a header with an indexed name and a literal value and performs incremental indexing. rr6r4r)rr?ordrkrcrrr')rnrGr+rr{prefixrs rrzEncoder._encode_indexed_literal~s ( ( (#E1--FF#E1--Fq S]]"  5&--e44E"3u::q11  ! aLLLD LLLxxvi(8(8%@AAArcd}|jD]4}t|d}|dxxdzcc<|t|z }5g|_|S)zd Produces the encoded form of all header table size change context updates. rrr )rlr?r')rnblock size_bytesbs rr}z!Encoder._encode_table_size_changes^ 1  Jz1--A aDDDDLDDD U1XX EE"$ rNr$rgr$r.r+r.r$rg)T)ryrzr{r#r$r'F)rrrr#r{r#r$r')rGr.r$r') r*r'r+r'rr'r{r#r$r') rGr.r+r'rr'r{r#r$r')r$r')__name__ __module__ __qualname____doc__ropropertyrtsetterrcrrrrr}rrrrfrfs 0000)))X) 2222 $ kkkkkZ66666p     *BBBBB,      rrfceZdZdZefddZeddZejdd ZdddZ d dZ d!dZ d"dZ d"dZ d"dZd#dZdS)$Decodera  An HPACK decoder object. .. versionchanged:: 2.3.0 Added ``max_header_list_size`` argument. :param max_header_list_size: The maximum decompressed size we will allow for any single header block. This is a protection against DoS attacks that attempt to force the application to expand a relatively small amount of data into a really large header list, allowing enormous amounts of memory to be allocated. If this amount of data is exceeded, a `OversizedHeaderListError ` exception will be raised. At this point the connection should be shut down, as the HPACK state will no longer be usable. Defaults to 64kB. :type max_header_list_size: ``int`` max_header_list_sizer.r$rgc\t|_||_|jj|_dSri)rrjrrsmax_allowed_table_size)rnrs rrozDecoder.__init__s.'MM %9!'+&7&?###rc|jjSrqrrrms rrtzDecoder.header_table_sizerurr+c||j_dSrirrrxs rrtzDecoder.header_table_sizes$)!!!rFr@r'r"r#Iterable[HeaderTuple]ctd|t|}g}t|}d}d}||kr@||}t |dz} t |dz} t |dz} | r!|||d\} } nx| r!|||d\} } nU| r3|rd}t||||d} d} n | ||d\} } | rY| | |t| d| dz }||j krd |j d }t||| z }||k@| fd |DS#t$r}d }t||d}~wwxYw) a Takes an HPACK-encoded header block and decodes it into a header set. :param data: A bytestring representing a complete HPACK-encoded header block. :param raw: (optional) Whether to return the headers as tuples of raw byte strings or to decode them as UTF-8 before returning them. The default value is False, which returns tuples of Unicode strings :returns: A list of two-tuples of ``(name, value)`` representing the HPACK-encoded headers, in the order they were decoded. :raises HPACKDecodingError: If an error is encountered while decoding the header block. z Decoding %srr4@rNz/Table size update not at the start of the blockrzA header list larger than z has been receivedc0g|]}t|Sr)r,)rhr"s rrz"Decoder.decode..-s$@@@1&q#..@@@rz!Unable to decode headers as UTF-8)r7r8 memoryviewrr#_decode_indexed_decode_literal_indexr_update_encoding_context_decode_literal_no_indexr;rrr _assert_valid_table_sizeUnicodeDecodeError)rnr@r"data_memrydata_len inflated_size current_indexcurrentindexed literal_indexencoding_updater!consumedr<rLs ` rr)zDecoder.decodesQ -&&&d##%'t99  h&&=)G7T>**G!400M#7T>22O #'#7#7]^^,$$  #'#=#=]^^,$$ ! 2KC,S11188]^^,$(#@#@]^^,$$  8v&&&!1&)VAY!G!GG  4#<<<dt7PdddC23777 X %M_h&&h %%''' 3@@@@@@@ @! 3 3 35C$S))s 2 3s F++ G 5GG cH|j|jkrd}t|dS)zs Check that the table size set by the encoder is lower than the maximum we expect to have. z3Encoder did not shrink table size to within the maxN)rtrr)rnr<s rrz Decoder._assert_valid_table_size2s1  !D$? ? ?GC',, , @ ?rrAcrt|d\}}||jkrd}t|||_|S)zC Handles a byte that updates the encoding context. rz)Encoder exceeded max allowable table size)rMrrrt)rnr@new_sizerr<s rrz Decoder._update_encoding_context;sF ,D!44( d1 1 1=C',, ,!)rtuple[HeaderTuple, int]ct|d\}}t|j|}td||||fS)zP Decodes a header represented using the indexed representation. r6zDecoded %s, consumed %d)rMrrj get_by_indexr7r8)rnr@rGrr!s rrzDecoder._decode_indexedGsT)q11xd/<>>xrc0||dS)NF should_index_decode_literalrnr@s rrz Decoder._decode_literal_no_indexPs##Du#===rc0||dS)NTrrrs rrzDecoder._decode_literal_indexSs##Dt#<< Decodes a header represented with a literal. r?rFrrNr6zTruncated header blockr4z/Decoded %s, total consumed %d bytes, indexed %s)rYrtobytesr#rMrjrrrr rrrr7r8)rnr@rtotal_consumed indexed_namer not_indexable high_byterGrr*lengthr<r+r!s rrzDecoder._decode_literalVsK dJ ' ' "<<>>D  37T>LH!MMQI$t+LH T!122M  3,T8< *"5))E &8++  .,T599FF u--F  /   ! !$ . . . =       ~%%rN)rr.r$rgrrr)r@r'r"r#r$rr)r@rAr$r.)r@rAr$r)r@rArr#r$r)rrrrDEFAULT_MAX_HEADER_LIST_SIZErorrtrr)rrrrrrrrrrrs#*4P@@@@@8)))X) ****Q3Q3Q3Q3Q3f----        >>>>====O&O&O&O&O&O&rr)r!rr"r#r$r)r-r.r/r.r$r0)r@rAr/r.r$rB)rNrOr$rP)r+r`r$r'),r __future__rloggingtypingrr exceptionsrrr r{r huffman_constantsr r huffman_tabler structrrrtablerrcollections.abcr getLoggerrr7 INDEX_NONErrrEranger:rr,r?rMr_rTrfrrrrrs#"""""%%%%%%%%[[[[[[[[[[######BBBBBBBB))))))KKKKKKKKKK00000000)((((((g!!    ;:q::: ' ) ) ) )>////d$$$$& ! ! ! !}}}}}}}}@C&C&C&C&C&C&C&C&C&C&r