o 5 hp@sdZddlmZmZmZmZddlZddlmZzddl m Z Wne y/ddlm Z Ynwddl m Z mZddlZeeZddlZddlZddlmZddlmZmZmZmZdd lmZmZmZdd l m!Z!gd Z"e#d d ddddZ$ddZ%ddZ&d0ddZ'e(e)fZ*e+e,fZ-e+Z.d1ddZ/Gddde0Z1e#dddd d!Z2Gd"d#d#e1Z3d2d$d%Z4d&d'Z5Gd(d)d)e Z6e6Z7d*8D] Z9e7:e9d+e9qGd,d-d-e1Z;d2d.d/Z_z"_self_info_rate..)len TypeErrorrintvaluessumr r,)sourcesizecountscharr4r(r(r)_self_info_rate>s    r:cCsZ|r t|t|Stj|rt|dS|d\}}}|s'td|ft ||S)a :param asset_path: string containing absolute path to file, or package-relative path using format ``"python.module:relative/file/path"``. :returns: filehandle opened in 'rb' mode (unless encoding explicitly specified) rb:zKasset path must be absolute file path or use 'pkg.name:sub/path' format: %r) codecs getreader_open_asset_pathospathisabsopen partition ValueError pkg_resourcesresource_stream)rAencodingpackagesepsubpathr(r(r)r?js    r?r6c Cst}d}z ||vr WdSWn tyd}Ynwt|ts(tt|t|kr?|r=z||WdSty<YdSwdSt}t}|D] }||vrO|n||qGt|}d}t||krcd}ddd|d|D}t||kr|d t||7}t d ||f) z helper for generators -- Throws ValueError if source elements aren't unique. Error message will display (abbreviated) repr of the duplicates in a string/list TF, css|] }tt|VqdSN)reprstrr-wordr(r(r)r/sz!_ensure_unique..Nz, ... plus %d othersz*`%s` cannot contain duplicate elements: %s) _ensure_unique_cacher2 isinstance _set_typesr1setaddsortedjoinrE) r6paramcachehashableseendupselemtruncdup_reprr(r(r)_ensure_uniquesB     rccsxeZdZdZdZdZeZdZdfdd Ze ddZ e dd Z d d Z dd d Z ddZer8ddZZSZS)SequenceGeneratoraY Base class used by word & phrase generators. These objects take a series of options, corresponding to those of the :func:`generate` function. They act as callables which can be used to generate a password or a list of 1+ passwords. They also expose some read-only informational attributes. Parameters ---------- :param entropy: Optionally specify the amount of entropy the resulting passwords should contain (as measured with respect to the generator itself). This will be used to auto-calculate the required password size. :param length: Optionally specify the length of password to generate, measured as count of whatever symbols the subclass uses (characters or words). Note if ``entropy`` requires a larger minimum length, that will be used instead. :param rng: Optionally provide a custom RNG source to use. Should be an instance of :class:`random.Random`, defaults to :class:`random.SystemRandom`. Attributes ---------- .. autoattribute:: length .. autoattribute:: symbol_count .. autoattribute:: entropy_per_symbol .. autoattribute:: entropy Subclassing ----------- Subclasses must implement the ``.__next__()`` method, and set ``.symbol_count`` before calling base ``__init__`` method. Nrc s|jdus Jd|dus|dur9|dur|j}t||}|dkr&tdtt||j}|dus7||kr9|}||_|dkrDtd||_|durN||_ |rct |t t fkrct dd|tt |jdi|dS) Nzsubclass must set .symbol_countrz!`entropy` must be positive numberr!z!`length` must be positive integerzUnexpected keyword(s): %srNr() symbol_countrequested_entropyentropy_aliasesgetrEr3rentropy_per_symbollengthrr*rdobjectr2rZkeyssuper__init__)selfentropyrjrkwds min_length __class__r(r)rns& zSequenceGenerator.__init__cCs t|jdS)zZ Average entropy per symbol (assuming all symbols have equal probability) r+)r,reror(r(r)ris z$SequenceGenerator.entropy_per_symbolcCs |j|jS)a+ Effective entropy of generated passwords. This value will always be a multiple of :attr:`entropy_per_symbol`. If entropy is specified in constructor, :attr:`length` will be chosen so so that this value is the smallest multiple >= :attr:`requested_entropy`. )rjrirur(r(r)rps zSequenceGenerator.entropycCstd)z;main generation function, should create one password/phrasezimplement in subclass)NotImplementedErrorrur(r(r)__next__)szSequenceGenerator.__next__csJ|durtSt|trfddt|DS|turSt|dd)zN frontend used by genword() / genphrase() to create passwords Ncsg|]}tqSr()nextr-_rur(r) 4sz.SequenceGenerator.__call__..z, int, or returns)rxrUrr iterr ExpectedTypeError)ror|r(rur)__call__-s zSequenceGenerator.__call__cCs|SrOr(rur(r(r)__iter__:szSequenceGenerator.__iter__cCs|SrO)rwrur(r(r)rx>szSequenceGenerator.nextNNNrO)__name__ __module__ __qualname____doc__rjrfrrernrrirprwrrr rx __classcell__r(r(rsr)rds",#    rdzH0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!@#$%^&*?/>0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ2234679abcdefghjkmnpqrstuvwxyzACDEFGHJKMNPQRTUVWXYZ0123456789abcdef)ascii_72ascii_62ascii_50hexcs>eZdZdZdZdZd fdd ZeddZdd Z Z S) WordGeneratora Class which generates passwords by randomly choosing from a string of unique characters. Parameters ---------- :param chars: custom character string to draw from. :param charset: predefined charset to draw from. :param \*\*kwds: all other keywords passed to the :class:`SequenceGenerator` parent class. Attributes ---------- .. autoattribute:: chars .. autoattribute:: charset .. autoattribute:: default_charsets rNc sj|r |rtdn |s|j}|sJt|}||_t|dd}t|dd||_tt|jdi|dS)Nz,`chars` and `charset` are mutually exclusivecharsr[r() r2charsetrrrcrrmrrn)rorrrqrsr(r)rn~s  zWordGenerator.__init__cC t|jSrO)r1rrur(r(r)re zWordGenerator.symbol_countcCst|j|j|jSrO)rrrrjrur(r(r)rwszWordGenerator.__next__)NN) rrrrrrrnrrerwrr(r(rsr)r\s rcKstd||d|}||S)a Generate one or more random passwords. This function uses :mod:`random.SystemRandom` to generate one or more passwords using various character sets. The complexity of the password can be specified by size, or by the desired amount of entropy. Usage Example:: >>> # generate a random alphanumeric string with 48 bits of entropy (the default) >>> from passlib import pwd >>> pwd.genword() 'DnBHvDjMK6' >>> # generate a random hexadecimal string with 52 bits of entropy >>> pwd.genword(entropy=52, charset="hex") '310f1a7ac793f' :param entropy: Strength of resulting password, measured in 'guessing entropy' bits. An appropriate **length** value will be calculated based on the requested entropy amount, and the size of the character set. This can be a positive integer, or one of the following preset strings: ``"weak"`` (24), ``"fair"`` (36), ``"strong"`` (48), and ``"secure"`` (56). If neither this or **length** is specified, **entropy** will default to ``"strong"`` (48). :param length: Size of resulting password, measured in characters. If omitted, the size is auto-calculated based on the **entropy** parameter. If both **entropy** and **length** are specified, the stronger value will be used. :param returns: Controls what this function returns: * If ``None`` (the default), this function will generate a single password. * If an integer, this function will return a list containing that many passwords. * If the ``iter`` constant, will return an iterator that yields passwords. :param chars: Optionally specify custom string of characters to use when randomly generating a password. This option cannot be combined with **charset**. :param charset: The predefined character set to draw from (if not specified by **chars**). There are currently four presets available: * ``"ascii_62"`` (the default) -- all digits and ascii upper & lowercase letters. Provides ~5.95 entropy per character. * ``"ascii_50"`` -- subset which excludes visually similar characters (``1IiLl0Oo5S8B``). Provides ~5.64 entropy per character. * ``"ascii_72"`` -- all digits and ascii upper & lowercase letters, as well as some punctuation. Provides ~6.17 entropy per character. * ``"hex"`` -- Lower case hexadecimal. Providers 4 bits of entropy per character. :returns: :class:`!unicode` string containing randomly generated password; or list of 1+ passwords if :samp:`returns={int}` is specified. )rjrpNr()rrprjr|rqgenr(r(r)rsFrcCs`t|d}dd|D}tdd|D}Wdn1s wYtdt|||S)a2 load wordset from compressed datafile within package data. file should be utf-8 encoded :param asset_path: string containing absolute path to wordset file, or "python.module:relative/file/path". :returns: tuple of words, as loaded from specified words file. zutf-8css|]}|VqdSrO)striprRr(r(r)r/z _load_wordset..css|]}|r|VqdSrOr(rRr(r(r)r/rNz!loaded %d-element wordset from %r)r?tupler debugr1) asset_pathfhrwordsr(r(r) _load_wordsets rcsleZdZdZdZdZfddZddZddZd d Z d d Z e d dZ ddZ ddZddZZS) WordsetDictz Special mapping used to store dictionary of wordsets. Different from a regular dict in that some wordsets may be lazy-loaded from an asset path. Ncs&i|_i|_tt|j|i|dSrO)paths_loadedrmrrn)roargsrqrsr(r)rn%szWordsetDict.__init__cCs@z|j|WStyYnw|j|}t|}|j|<|SrO)rKeyErrorrr)rokeyrAr.r(r(r) __getitem__*s   zWordsetDict.__getitem__cCs||j|<dS)z; set asset path to lazy-load wordset from. N)r)rorrAr(r(r)set_path3szWordsetDict.set_pathcCs||j|<dSrO)r)rorr.r(r(r) __setitem__9szWordsetDict.__setitem__cCs.||vr|j|=|j|ddS|j|=dSrO)rrpoprorr(r(r) __delitem__<s zWordsetDict.__delitem__cCst|j}||j|SrO)rWrupdater)rorlr(r(r)_keysetCs  zWordsetDict._keysetcCrrO)r}rrur(r(r)rI zWordsetDict.__iter__cCrrO)r1rrur(r(r)__len__LrzWordsetDict.__len__cCs||jvp ||jvSrO)rrrr(r(r) __contains__PszWordsetDict.__contains__)rrrrrrrnrrrrpropertyrrrrrr(r(rsr)rs   rz%eff_long eff_short eff_prefixed bip39zpasslib:_data/wordsets/%s.txtcsBeZdZdZdZdZdZd fdd ZeddZ d d Z Z S) PhraseGeneratoraclass which generates passphrases by randomly choosing from a list of unique words. :param wordset: wordset to draw from. :param preset: name of preset wordlist to use instead of ``wordset``. :param spaces: whether to insert spaces between words in output (defaults to ``True``). :param \*\*kwds: all other keywords passed to the :class:`SequenceGenerator` parent class. .. autoattribute:: wordset eff_longN c s|dur |dur tdn|dur|j}|sJt|}||_t|ts(t|}t|dd||_|dur8|j}t |dd}||_t t |j di|dS)Nz,`words` and `wordset` are mutually exclusiverrrJr() r2wordsetrrU_sequence_typesrrcrrJrrmrrn)rorrrJrqrsr(r)rn~s$   zPhraseGenerator.__init__cCrrO)r1rrur(r(r)rerzPhraseGenerator.symbol_countcs$fddtjD}j|S)Nc3s|] }jjVqdSrO)rchoicerryrur(r)r/r0z+PhraseGenerator.__next__..)r rjrJrZ)rorr(rur)rws zPhraseGenerator.__next__r) rrrrrrrJrnrrerwrr(r(rsr)r_s" rcKstd||d|}||S)amGenerate one or more random password / passphrases. This function uses :mod:`random.SystemRandom` to generate one or more passwords; it can be configured to generate alphanumeric passwords, or full english phrases. The complexity of the password can be specified by size, or by the desired amount of entropy. Usage Example:: >>> # generate random phrase with 48 bits of entropy >>> from passlib import pwd >>> pwd.genphrase() 'gangly robbing salt shove' >>> # generate a random phrase with 52 bits of entropy >>> # using a particular wordset >>> pwd.genword(entropy=52, wordset="bip39") 'wheat dilemma reward rescue diary' :param entropy: Strength of resulting password, measured in 'guessing entropy' bits. An appropriate **length** value will be calculated based on the requested entropy amount, and the size of the word set. This can be a positive integer, or one of the following preset strings: ``"weak"`` (24), ``"fair"`` (36), ``"strong"`` (48), and ``"secure"`` (56). If neither this or **length** is specified, **entropy** will default to ``"strong"`` (48). :param length: Length of resulting password, measured in words. If omitted, the size is auto-calculated based on the **entropy** parameter. If both **entropy** and **length** are specified, the stronger value will be used. :param returns: Controls what this function returns: * If ``None`` (the default), this function will generate a single password. * If an integer, this function will return a list containing that many passwords. * If the ``iter`` builtin, will return an iterator that yields passwords. :param words: Optionally specifies a list/set of words to use when randomly generating a passphrase. This option cannot be combined with **wordset**. :param wordset: The predefined word set to draw from (if not specified by **words**). There are currently four presets available: ``"eff_long"`` (the default) Wordset containing 7776 english words of ~7 letters. Constructed by the EFF, it offers ~12.9 bits of entropy per word. This wordset (and the other ``"eff_"`` wordsets) were `created by the EFF `_ to aid in generating passwords. See their announcement page for more details about the design & properties of these wordsets. ``"eff_short"`` Wordset containing 1296 english words of ~4.5 letters. Constructed by the EFF, it offers ~10.3 bits of entropy per word. ``"eff_prefixed"`` Wordset containing 1296 english words of ~8 letters, selected so that they each have a unique 3-character prefix. Constructed by the EFF, it offers ~10.3 bits of entropy per word. ``"bip39"`` Wordset of 2048 english words of ~5 letters, selected so that they each have a unique 4-character prefix. Published as part of Bitcoin's `BIP 39 `_, this wordset has exactly 11 bits of entropy per word. This list offers words that are typically shorter than ``"eff_long"`` (at the cost of slightly less entropy); and much shorter than ``"eff_prefixed"`` (at the cost of a longer unique prefix). :param sep: Optional separator to use when joining words. Defaults to ``" "`` (a space), but can be an empty string, a hyphen, etc. :returns: :class:`!unicode` string containing randomly generated passphrase; or list of 1+ passphrases if :samp:`returns={int}` is specified. )rprjNr()rrr(r(r)rsarrO)r6r)=r __future__rrrrr= collectionsrcollections.abcr ImportErrormathrr r,logging getLoggerrrFr@passlibr passlib.utils.compatr r r r passlib.utilsrrrpasslib.utils.decorr__all__dictrgr*r:r?listrrrW frozensetrVrTrcrkrdrrrrrrsplitnamerrrr(r(r(r)sb      , . LM#> R