Ajz@sdZddlmZmZmZddlmZmZmZ m Z ddl m Z mZmZddlZejeZddlmZddlmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#ddl$m%Z%d d d d d ddddddddddddddddgZ&e!dZ'e!dZ(e!d Z)e!d!Z*e'e!d"Z+e!d#Z,e!d$Z-e!d%Z.eed&Z/d'Z0d(Z1d)Z2e3ee/Z4dd*dZ5d+dZ6d,dZ7d-Z8d)Z9d.Z:d/dZ;d0dZ<d1dZ e5d2d3d4d5iZ=e2d6Z>d7dZGd8dde?Z@Gd9dde@ZAeAe)ZBeAe)d:d;ZCeAe*d:d;ZDdS) output byte (str or int). :param source: optional existing byte translation string to use as base. (must be 255-length byte string). defaults to identity mapping. :returns: 255-length byte string for passing to bytes().translate. Nrr.ascii)_TRANSLATE_SOURCE isinstancebyteslenAssertionErrorlistritemsrordintrencodeB_EMPTYjoin)mappingsourcetargetkvrE../../passlib/utils/binary.pyr#ns ' 1'cCst|jtS)zr encode using shortened base64 format which omits padding & whitespace. uses default ``+/`` altchars. )r rstrip _BASE64_STRIP)datarErErFr&scCst|trIy|jd}Wn$tk rHttdYnXt|d@}|dkrhn>|dkr|t7}n%|dkr|t7}n tdyt |SWn7t k r}ztt |WYdd}~XnXdS)zq decode from shortened base64 format which omits padding & whitespace. uses default ``+/`` altchars. r2z4string argument should contain only ASCII charactersrzinvalid base64 inputN) r5rr=UnicodeEncodeErrorr ValueErrorr7 _BASE64_PAD2 _BASE64_PAD1r _BinAsciiError TypeError)rIofferrrErErFr's"       s= s==cCst|jddS)z encode using shortened base64 format which omits padding & whitespace. uses custom ``./`` altchars. it is primarily used by Passlib's custom pbkdf2 hashes. +.)r&replace)rIrErErFr$sc Cs_t|trIy|jd}Wn$tk rHttdYnXt|jddS)z decode from shortened base64 format which omits padding & whitespace. uses custom ``./`` altchars, but supports decoding normal ``+/`` altchars as well. it is primarily used by Passlib's custom pbkdf2 hashes. r2z4string argument should contain only ASCII charactersrUrT)r5rr=rLrrMr'rV)rIrErErFr%s  cCstt|jtS)zh wrapper around :func:`base64.b32encode` which strips padding, and returns a native string. )r _b32encoderGB_EQUAL)rArErErFrs8B0OcCset|tr|jd}|jt}t|d@}|rX|td| 7}t|dS)z wrapper around :func:`base64.b32decode` which handles common mistyped chars. padding optional, ignored if present. r2NT)r5rr= translate_b32_translater7_b32_decode_pad _b32decode)rAZ remainderrErErFrsc@seZdZdZdZdZdZdZdZdZ dddZ e ddZ dd Z d d Zd d ZddZddZddZddZeddZeddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Z d.d/Z!d0d1Z"d2d3Z#d4d5Z$d6d7Z%d8d9Z&dS):r(acProvides routines for encoding/decoding base64 data using arbitrary character mappings, selectable endianness, etc. :arg charmap: A string of 64 unique characters, which will be used to encode successive 6-bit chunks of data. A character's position within the string should correspond to its 6-bit value. :param big: Whether the encoding should be big-endian (default False). .. note:: This class does not currently handle base64's padding characters in any way what so ever. Raw Bytes <-> Encoded Bytes =========================== The following methods convert between raw bytes, and strings encoded using the engine's specific base64 variant: .. automethod:: encode_bytes .. automethod:: decode_bytes .. automethod:: encode_transposed_bytes .. automethod:: decode_transposed_bytes .. .. automethod:: check_repair_unused .. automethod:: repair_unused Integers <-> Encoded Bytes ========================== The following methods allow encoding and decoding unsigned integers to and from the engine's specific base64 variant. Endianess is determined by the engine's ``big`` constructor keyword. .. automethod:: encode_int6 .. automethod:: decode_int6 .. automethod:: encode_int12 .. automethod:: decode_int12 .. automethod:: encode_int24 .. automethod:: decode_int24 .. automethod:: encode_int64 .. automethod:: decode_int64 Informational Attributes ======================== .. attribute:: charmap unicode string containing list of characters used in encoding; position in string matches 6bit value of character. .. attribute:: bytemap bytes version of :attr:`charmap` .. attribute:: big boolean flag indicating this using big-endian encoding. NFcCs t|tr!|jd}n!t|tsBtj|dt|dkr`tdtt|dkrtd||_ |j |_ t ddt |D}|j |_||_|r|j|_|j|_n|j|_|j|_dS)Nzlatin-1charmap@z'charmap must be 64 characters in lengthz-charmap must not contain duplicate characterscss!|]\}}||fVqdS)NrE).0idxvaluerErErF ]sz(Base64Engine.__init__..)r5rr=r6r ExpectedStringErrorr7rMsetbytemap __getitem__ _encode64dict enumerate _decode64big_encode_bytes_big _encode_bytes_decode_bytes_big _decode_bytes_encode_bytes_little_decode_bytes_little)selfrcrqlookuprErErF__init__Qs$        zBase64Engine.__init__cCs|jjdS)zcharmap as unicodezlatin-1)rkdecode)rxrErErFrcsszBase64Engine.charmapcCst|ts(tdt|ftt|d\}}tr^tt|}ntdd|D}|j |||}t t |j |}|S)zencode bytes to base64 string. :arg source: byte string to encode. :returns: byte string containing encoded data. zsource must be bytes, not %srJcss|]}t|VqdS)N)r;)reelemrErErFrhsz,Base64Engine.encode_bytes..) r5r6rQtypedivmodr7r riterrsrrrm)rxrAchunkstail next_valuegenoutrErErF encode_bytes{szBase64Engine.encode_bytesccsd}xq||kry|}|}|}|d@V|d@d>|d?BV|d@d>|d?BV|d?V|d7}q W|r|}|dkr|d@V|d?VnB|dkst|}|d@V|d@d>|d?BV|d?Vd S) z>helper used by encode_bytes() to handle little-endian encodingr?rKrJr3N)r8)rxrrrrfv1v2v3rErErFrvs(           z!Base64Engine._encode_bytes_littleccsd}xq||kry|}|}|}|d?V|d@d>|d?BV|d@d>|d?BV|d@V|d7}q W|r|}|dkr|d?V|d@d>VnF|dkst|}|d?V|d@d>|d?BV|d@d>Vd S) z;helper used by encode_bytes() to handle big-endian encodingrrKrJrrrrr3N)r8)rxrrrrfrrrrErErFrrs(          zBase64Engine._encode_bytes_bigcCst|ts(tdt|ftt|d\}}|dkr[tdtt|j |}yt |j |||SWn?t k r}ztd|j dfWYdd}~XnXdS)zdecode bytes from base64 string. :arg source: byte string to decode. :returns: byte string containing decoded data. zsource must be bytes, not %srr3z(input string length cannot be == 1 mod 4zinvalid character: %rrN)r5r6rQr}r~r7rMrrrprruKeyErrorargs)rxrArrrrSrErErF decode_bytess  zBase64Engine.decode_bytesc csd}xu||kr}|}|}|}|}||d@d>BV|d?|d@d>BV|d?|d>BV|d7}q W|r|}|}||d@d>BV|dkr|}|d?|d@d>BVdS) z>helper used by decode_bytes() to handle little-endian encodingrrJrrKrrr3NrE) rxrrrrfrrrv4rErErFrws"        z!Base64Engine._decode_bytes_littlec csd}xu||kr}|}|}|}|}|d>|d?BV|d@d>|d?BV|d@d>|BV|d7}q W|r|}|}|d>|d?BV|dkr|}|d@d>|d?BVdS) z;helper used by decode_bytes() to handle big-endian encodingrrKrrrJrr3NrE) rxrrrrfrrrrrErErFrts"        zBase64Engine._decode_bytes_bigcs[tfddt|jD}|jfddt|jDt|S)z2helper to generate set of valid last chars & bytesc3s%|]\}}|@s|VqdS)NrE)reic)bitsrErFrhGsz-Base64Engine.__make_padset..c3s%|]\}}|@s|VqdS)NrE)rerr)rrErFrhHs)rjrorkupdaterc frozenset)rxrZpsetrE)rrFZ __make_padsetEs()zBase64Engine.__make_padsetcCs)|jrdnd}||j|fS)zDmask to clear padding bits, and valid last bytes (for strings 2 % 4)rrK<)rq_Base64Engine__make_padset)rxrrErErF _padinfo2KszBase64Engine._padinfo2cCs)|jrdnd}||j|fS)zDmask to clear padding bits, and valid last bytes (for strings 3 % 4)rJr0)rqr)rxrrErErF _padinfo3RszBase64Engine._padinfo3cCs3t|d@}|dkr.|j\}}n:|dkrL|j\}}n|s\d|fStd|d }||krd|fSt|tr|j}||j||@}||kstdnI|j |j ||@}||kstdt rt |g}d|dd |fS) ahelper to detect & clear invalid unused bits in last character. :arg source: encoded data (as ascii bytes or unicode). :returns: `(True, result)` if the string was repaired, `(False, source)` if the string was ok as-is. rJrKFzsource length must != 1 mod 4r3z%failed to generate valid padding charTNr) r7rrrMr5rrcindexr8rmrpr r6)rxrArmaskZpadsetlastcmrErErFcheck_repair_unusedYs(         z Base64Engine.check_repair_unusedcCs|j|dS)Nr3)r)rxrArErErF repair_unusedszBase64Engine.repair_unusedcsTtts(tdtftfdd|D}|j|S)z>encode byte string, first transposing source using offset listzsource must be bytes, not %sc3s|]}|VqdS)NrE)rerR)rArErFrhsz7Base64Engine.encode_transposed_bytes..)r5r6rQr}rr)rxrAoffsetstmprE)rArFencode_transposed_bytessz$Base64Engine.encode_transposed_bytescCsV|j|}dgt|}x't||D]\}}|||||}qWWn%t k rtd|fYnX|r |r||L}n|d|>dM}|S)adecode base64 string -> integer :arg source: base64 string to decode. :arg bits: number of bits in resulting integer. :raises ValueError: * if the string contains invalid base64 characters. * if the string is not long enough - it must be at least ``int(ceil(bits/6))`` in length. :returns: a integer in the range ``0 <= n < 2**bits`` zsource must be bytes, not %srzsource must be %d charsrzinvalid character in string: %rr3) r5r6rQr}rqr7rMrpreversedr) rxrArrqpadcharsr{rrrErErF _decode_ints&     zBase64Engine._decode_intc Cst|ts(tdt|ft|dkrFtdtrV|d}y|j|SWntk rtdYnXdS)z(decode single character -> 6 bit integerzsource must be bytes, not %sr3zsource must be exactly 1 byterzinvalid characterN) r5r6rQr}r7rMr rpr)rxrArErErF decode_int6s   zBase64Engine.decode_int6c Cst|ts(tdt|ft|dkrFtd|j}yM|jr{||d||dd>S||d||dd>SWntk rtdYnXdS) z'decodes 2 char string -> 12-bit integerzsource must be bytes, not %srKzsource must be exactly 2 bytesr3rrzinvalid characterN) r5r6rQr}r7rMrprqr)rxrAr{rErErF decode_int12s    $ zBase64Engine.decode_int12c Cs t|ts(tdt|ft|dkrFtd|j}y|jr||d||dd>||dd>||d d >S||d ||dd>||dd>||dd >SWntk rtd YnXd S) z'decodes 4 char string -> 24-bit integerzsource must be bytes, not %srzsource must be exactly 4 bytesrJrKrr3 rzinvalid characterN) r5r6rQr}r7rMrprqr)rxrAr{rErErF decode_int24s   DH zBase64Engine.decode_int24cCs|j|dS)z&decode 5 char string -> 30 bit integer)r)rxrArErErF decode_int30szBase64Engine.decode_int30cCs|j|dS)zdecode 11 char base64 string -> 64-bit integer this format is used primarily by des-crypt & variants to encode the DES output value used as a checksum. rd)r)rxrArErErF decode_int64szBase64Engine.decode_int64csdkstd| d}||7}|jrYt|ddd}|Kntd|d}tt|jfdd|DS)zencode integer into base64 format :arg value: non-negative integer to encode :arg bits: number of bits to encode :returns: a string of length ``int(ceil(bits/6.0))``. rzcaller did not sanitize inputrc3s|]}|?d@VqdS)rNrE)rerR)rgrErFrh"sz+Base64Engine._encode_int..ii)r8rqrrrrm)rxrgrritrrE)rgrF _encode_ints      zBase64Engine._encode_intcCsP|dks|dkr$tdtr?|j||dS|j|SdS)z0encodes 6-bit integer -> single hash64 characterrrzvalue out of ranger3N)rMr rkrm)rxrgrErErF encode_int6(s  zBase64Engine.encode_int6cCsg|dks|dkr$td|d@|d?d@g}|jrQt|}tt|j|S)z'encodes 12-bit integer -> 2 char stringrizvalue out of rangerr)rMrqrrrrm)rxrgrawrErErF encode_int121s    zBase64Engine.encode_int12cCs}|dks|dkr$td|d@|d?d@|d?d@|d?d@g}|jrgt|}tt|j|S)z'encodes 24-bit integer -> 4 char stringrizvalue out of rangerrrr)rMrqrrrrm)rxrgrrErErF encode_int24:s   zBase64Engine.encode_int24cCs4|dks|dkr$td|j|dS)z&decode 5 char string -> 30 bit integerri?zvalue out of ranger)rMr)rxrgrErErF encode_int30Ds zBase64Engine.encode_int30cCs4|dks|dkr$td|j|dS)zencode 64-bit integer -> 11 char hash64 string this format is used primarily by des-crypt & variants to encode the DES output value used as a checksum. rlzvalue out of rangerd)rMr)rxrgrErErF encode_int64Js zBase64Engine.encode_int64)'__name__ __module__ __qualname____doc__rkrqrmrprsrurzpropertyrcrrvrrrrwrtrrrrrrrrrrrrrrrrrrrrrErErErFr(sD ?"  ' +  # *  )    (      csFeZdZdZdZddZfddZddZS) r)zZB_NULLrXr9r4r#r&r'rHrOrNr$r%r`rarr(r)r*r+r,rErErErFsn" R        !      ]