U h X@sdZddlZeeZddlmZmZmZm Z ddl m Z m Z ddl mZmZmZmZddlmZmZddlmmZdgZGdddejejejejZdS) z:passlib.handlers.scram - hash for SCRAM credential storageN)consteqsaslprep to_native_str splitcomma) ab64_decode ab64_encode) bascii_to_str iteritemsunative_string_types) pbkdf2_hmacnorm_hash_namescramcseZdZdZdZdZedZdZdZ dZ dZ dZ d Z d d d gZd d d dd gZdZeddZed*ddZeddZeddZddZed+fdd Zd,fdd Zd-d d!Zed"d#Zfd$d%Zd.d&d'Zed/d(d)ZZS)0raZThis class provides a format for storing SCRAM passwords, and follows the :ref:`password-hash-api`. It supports a variable-length salt, and a variable number of rounds. The :meth:`~passlib.ifc.PasswordHash.using` method accepts the following optional keywords: :type salt: bytes :param salt: Optional salt bytes. If specified, the length must be between 0-1024 bytes. If not specified, a 12 byte salt will be autogenerated (this is recommended). :type salt_size: int :param salt_size: Optional number of bytes to use when autogenerating new salts. Defaults to 12 bytes, but can be any value between 0 and 1024. :type rounds: int :param rounds: Optional number of rounds to use. Defaults to 100000, but must be within ``range(1,1<<32)``. :type algs: list of strings :param algs: Specify list of digest algorithms to use. By default each scram hash will contain digests for SHA-1, SHA-256, and SHA-512. This can be overridden by specify either be a list such as ``["sha-1", "sha-256"]``, or a comma-separated string such as ``"sha-1, sha-256"``. Names are case insensitive, and may use :mod:`!hashlib` or `IANA `_ hash names. :type relaxed: bool :param relaxed: By default, providing an invalid value for one of the other keywords will result in a :exc:`ValueError`. If ``relaxed=True``, and the error can be corrected, a :exc:`~passlib.exc.PasslibHashWarning` will be issued instead. Correctable errors include ``rounds`` that are too small or too large, and ``salt`` strings that are too long. .. versionadded:: 1.6 In addition to the standard :ref:`password-hash-api` methods, this class also provides the following methods for manipulating Passlib scram hashes in ways useful for pluging into a SCRAM protocol stack: .. automethod:: extract_digest_info .. automethod:: extract_digest_algs .. automethod:: derive_digest )saltZ salt_sizeroundsalgs$scram$ iilZlinearsha-1zsha-256zsha-512zsha-224zsha-384NcCs8t|d}||}|j}|s&td|j|j||fS)areturn (salt, rounds, digest) for specific hash algorithm. :type hash: str :arg hash: :class:`!scram` hash stored for desired user :type alg: str :arg alg: Name of digest algorithm (e.g. ``"sha-1"``) requested by client. This value is run through :func:`~passlib.crypto.digest.norm_hash_name`, so it is case-insensitive, and can be the raw SCRAM mechanism name (e.g. ``"SCRAM-SHA-1"``), the IANA name, or the hashlib name. :raises KeyError: If the hash does not contain an entry for the requested digest algorithm. :returns: A tuple containing ``(salt, rounds, digest)``, where *digest* matches the raw bytes returned by SCRAM's :func:`Hi` function for the stored password, the provided *salt*, and the iteration count (*rounds*). *salt* and *digest* are both raw (unencoded) bytes. ianazscram hash contains no digests)r from_stringchecksum ValueErrorrr)clshashalgselfchkmapr<./venv/lib/python3.8/site-packages/passlib/handlers/scram.pyextract_digest_info|s   zscram.extract_digest_inforcs.||j}dkr|Sfdd|DSdS)aReturn names of all algorithms stored in a given hash. :type hash: str :arg hash: The :class:`!scram` hash to parse :type format: str :param format: This changes the naming convention used by the returned algorithm names. By default the names are IANA-compatible; possible values are ``"iana"`` or ``"hashlib"``. :returns: Returns a list of digest algorithms; e.g. ``["sha-1"]`` rcsg|]}t|qSrr .0rformatrr sz-scram.extract_digest_algs..N)rr)rrr&rrr%r extract_digest_algss zscram.extract_digest_algscCs&t|tr|d}t|t|||S)a;helper to create SaltedPassword digest for SCRAM. This performs the step in the SCRAM protocol described as:: SaltedPassword := Hi(Normalize(password), salt, i) :type password: unicode or utf-8 bytes :arg password: password to run through digest :type salt: bytes :arg salt: raw salt data :type rounds: int :arg rounds: number of iterations. :type alg: str :arg alg: name of digest to use (e.g. ``"sha-1"``). :returns: raw bytes of ``SaltedPassword`` zutf-8) isinstancebytesdecoder r)rZpasswordrrrrrr derive_digests  zscram.derive_digestc Cs@t|dd}|ds"tj||ddd}t|dkrLtj||\}}}t|}|t |krvtj|zt | d}Wn t k rtj|YnX|stj|ntd|kr(d}i} |dD]L} | d\} } zt | d| | <Wqt k r"tj|YqXqn|}d} |||| |d S) Nasciirr$=,)rrrr) r startswithuhexcZInvalidHashErrorsplitlenZMalformedHashErrorintstrrencode TypeError) rrpartsZ rounds_strZsalt_strchk_strrrrrZpairrdigestrrr rsB         zscram.from_stringcs>tt|j}|jdfdd|jD}d|j||fS)Nr2c3s&|]}d|tt|fVqdS)z%s=%sN)rrr#rrr sz"scram.to_string..z$scram$%d$%s$%s)rrrrjoinrr)rrr=rr?r to_string s zscram.to_stringc sB|dk r|dkst|}tt|jf|}|dk r>|||_|SN)AssertionErrorsuperrusing _norm_algs default_algs)rrHrkwdssubcls __class__rr rFs  z scram.usingc stt|jf||j}|dk r<|dk r0td||}nN|dk rT||}n6|jrt|j }|||kst d|fnt d||_ dS)Nz+checksum & algs kwds are mutually exclusivezinvalid default algs: %rzno algs list specified) rEr__init__r RuntimeErrorrGkeysZ use_defaultslistrHrDr;r)rrrIZ digest_maprKrr rM+s  zscram.__init__FcCst|tstj|ddt|D]X\}}|t|dkrFtd|ft|dkr`td|ft|t s"tj|ddq"d |krtd |S) Ndictrrz*malformed algorithm name in scram hash: %r z0SCRAM limits algorithm names to 9 characters: %rz raw bytesZdigestsr-sha-1 must be in algorithm list of scram hash) r)rQr4r5ZExpectedTypeErrorr r rr7r*)rrZrelaxedrr>rrr _norm_checksum>s    zscram._norm_checksumcCsRt|trt|}tdd|D}tdd|Dr>tdd|krNtd|S)znormalize algs parametercss|]}t|dVqdS)rNr"r#rrr r@Usz#scram._norm_algs..css|]}t|dkVqdS)rRN)r7r#rrr r@Vsz-SCRAM limits alg names to max of 9 charactersrrS)r)r rsortedanyr)rrrrr rGPs zscram._norm_algsc s(t|j|jsdStt|jf|S)NT)setr issupersetrHrEr_calc_needs_update)rrIrKrr rY`szscram._calc_needs_updatecsF|j|j|j|r$|Stfdd|jDSdS)Nc3s |]}||fVqdSrCrr#rrrsecretrr r@vsz'scram._calc_checksum..)rrr,rQr)rr[rrrZr _calc_checksummszscram._calc_checksumc Cst|||}|j}|s2td|j|jf|rd}}t|D]R\}} |||} t| t| krtd|t| t| ft | | rd}qFd}qF|r|rtdq|Sn:|j D]*}||kr|||} t | ||Sqt ddS)Nz.expected %s hash, got %s config string insteadFz+mis-sized %s digest in scram hash: %r != %rTz4scram hash verified inconsistently, may be corruptedzsha-1 digest not found!) r4Zvalidate_secretrrrnamer r\r7r _verify_algsrD) rr[rZfullrrZcorrectZfailedrr>otherrrr verify{s4        z scram.verify)r)NN)N)F)N)F)__name__ __module__ __qualname____doc__r]Z setting_kwdsr identZdefault_salt_sizeZ max_salt_sizeZdefault_roundsZ min_roundsZ max_roundsZ rounds_costrHr^r classmethodr!r(r,rrBrFrMrTrGrYr\r` __classcell__rrrKr rs@A   %   /    )rdZloggingZ getLoggerralogZ passlib.utilsrrrrZpasslib.utils.binaryrrZpasslib.utils.compatrr r r Zpasslib.crypto.digestr r Zpasslib.utils.handlersZutilsZhandlersr4__all__Z HasRoundsZ HasRawSaltZHasRawChecksumZGenericHandlerrrrrr s