관리-도구
편집 파일: context.cpython-39.opt-1.pyc
a f�Wc�� � @ s� d Z ddlmZ ddlZddlZe�e�ZddlZddl Z ddl m Z ddl m Z ddlmZmZmZ ddlmZmZ ddlmZmZmZmZmZm Z m Z m Z dd l m Z dd l!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z, dd l-m.Z.m/Z/ g d �Z0e1� Z2d d� Z3e4dg�Z5e6e7e7e7e3e7d�Z8dd� Z9e:d dd��Z;e4ddg�Z<dZ=G dd� de1�Z>G dd� de1�Z?G d d � d e1�Z@G d d � d e@�ZAdS )!z-passlib.context - CryptContext implementation� )�with_statementN)�warn)�exc)�ExpectedStringError�ExpectedTypeError�PasslibConfigWarning)�get_crypt_handler�_validate_handler_name)�handlers�to_bytes� to_unicode� splitcomma�as_bool�timer�rng� getrandstr)� BASE64_CHARS) � iteritems� num_types�irange�PY2�PY3�unicode�SafeConfigParser�NativeStringIO�BytesIO�unicode_or_bytes_types�native_string_types)�deprecated_method�memoized_property)� CryptContext�LazyCryptContext� CryptPolicyc C sF | � d�r t| �d��d S z t| �W S ty@ t| � Y S 0 dS )z>parse vary_rounds string to percent as [0,1) float, or integer�%�{�G�z�?N)�endswith�float�rstrip�int� ValueError��value� r, �3/usr/lib/python3.9/site-packages/passlib/context.py�_coerce_vary_rounds* s r. Zsalt)Z min_roundsZ max_roundsZdefault_rounds� vary_roundsZ salt_sizec C s t | jd�| u S )z3detect if handler is registered or a custom handlerN)r �name��handlerr, r, r- �_is_handler_registeredC s r3 c C s dS )z dummy function patched into handler.needs_update() by _CryptConfig when hash alg has been deprecated for context. Tr, )�hash�secretr, r, r- �_always_needs_updateG s r6 Ztruncate_errorr/ zaThe CryptPolicy class has been deprecated as of Passlib 1.6, and will be removed in Passlib 1.8. c @ s� e Zd ZdZed)dd��Zed*dd��Zed+d d ��Zed,d d ��Zd d� Z dZ dZ dd� Z dd� Z dd� Zd-dd�Zd.dd�Zd/dd �Zd0d d �Zd1d d �Zd2d!d"�Zd3d#d$�Zd4d%d&�Zd5d'd(�ZdS )6r" a .. deprecated:: 1.6 This class has been deprecated, and will be removed in Passlib 1.8. All of its functionality has been rolled into :class:`CryptContext`. This class previously stored the configuration options for the CryptContext class. In the interest of interface simplification, all of this class' functionality has been rolled into the CryptContext class itself. The documentation for this class is now focused on documenting how to migrate to the new api. Additionally, where possible, the deprecation warnings issued by the CryptPolicy methods will list the replacement call that should be used. Constructors ============ CryptPolicy objects can be constructed directly using any of the keywords accepted by :class:`CryptContext`. Direct uses of the :class:`!CryptPolicy` constructor should either pass the keywords directly into the CryptContext constructor, or to :meth:`CryptContext.update` if the policy object was being used to update an existing context object. In addition to passing in keywords directly, CryptPolicy objects can be constructed by the following methods: .. automethod:: from_path .. automethod:: from_string .. automethod:: from_source .. automethod:: from_sources .. automethod:: replace Introspection ============= All of the informational methods provided by this class have been deprecated by identical or similar methods in the :class:`CryptContext` class: .. automethod:: has_schemes .. automethod:: schemes .. automethod:: iter_handlers .. automethod:: get_handler .. automethod:: get_options .. automethod:: handler_is_deprecated .. automethod:: get_min_verify_time Exporting ========= .. automethod:: iter_config .. automethod:: to_dict .. automethod:: to_file .. automethod:: to_string .. note:: CryptPolicy are immutable. Use the :meth:`replace` method to mutate existing instances. .. deprecated:: 1.6 �passlib�utf-8c C s& t td tdd� | t�|||�d�S )aW create a CryptPolicy instance from a local file. .. deprecated:: 1.6 Creating a new CryptContext from a file, which was previously done via ``CryptContext(policy=CryptPolicy.from_path(path))``, can now be done via ``CryptContext.from_path(path)``. See :meth:`CryptContext.from_path` for details. Updating an existing CryptContext from a file, which was previously done ``context.policy = CryptPolicy.from_path(path)``, can now be done via ``context.load_path(path)``. See :meth:`CryptContext.load_path` for details. z�Instead of ``CryptPolicy.from_path(path)``, use ``CryptContext.from_path(path)`` or ``context.load_path(path)`` for an existing CryptContext.� �� stacklevel��_internal_context)r � _preamble�DeprecationWarningr � from_path)�cls�path�section�encodingr, r, r- r@ � s �� �zCryptPolicy.from_pathc C s& t td tdd� | t�|||�d�S )aU create a CryptPolicy instance from a string. .. deprecated:: 1.6 Creating a new CryptContext from a string, which was previously done via ``CryptContext(policy=CryptPolicy.from_string(data))``, can now be done via ``CryptContext.from_string(data)``. See :meth:`CryptContext.from_string` for details. Updating an existing CryptContext from a string, which was previously done ``context.policy = CryptPolicy.from_string(data)``, can now be done via ``context.load(data)``. See :meth:`CryptContext.load` for details. z�Instead of ``CryptPolicy.from_string(source)``, use ``CryptContext.from_string(source)`` or ``context.load(source)`` for an existing CryptContext.r9 r: r< )r r> r? r � from_string)rA �sourcerC rD r, r, r- rE � s �� �zCryptPolicy.from_stringTc s� |rt td tdd� t� t�r$� S t� t�rB| tf i � ��d�S t� ttf�sdt dt � �f ��n@t � fdd�dD ��s�� � d �s�| t� � �d�S | t�� �d�S d S ) a� create a CryptPolicy instance from some source. this method autodetects the source type, and invokes the appropriate constructor automatically. it attempts to detect whether the source is a configuration string, a filepath, a dictionary, or an existing CryptPolicy instance. .. deprecated:: 1.6 Create a new CryptContext, which could previously be done via ``CryptContext(policy=CryptPolicy.from_source(source))``, should now be done using an explicit method: the :class:`CryptContext` constructor itself, :meth:`CryptContext.from_path`, or :meth:`CryptContext.from_string`. Updating an existing CryptContext, which could previously be done via ``context.policy = CryptPolicy.from_source(source)``, should now be done using an explicit method: :meth:`CryptContext.update`, or :meth:`CryptContext.load`. z�Instead of ``CryptPolicy.from_source()``, use ``CryptContext.from_string(path)`` or ``CryptContext.from_path(source)``, as appropriate.r9 r: r< zAsource must be CryptPolicy, dict, config string, or file path: %rc 3 s | ]}|� v V qd S �Nr, )�.0�c�rF r, r- � <genexpr>� � z*CryptPolicy.from_source.<locals>.<genexpr>z z ./;:N)r r> r? � isinstancer" �dictr �bytesr � TypeError�type�any�striprE r@ )rA rF �_warnr, rJ r- � from_source� s" �� � zCryptPolicy.from_sourcec C s� |rt td tdd� t|�dkr*td��t|�dkrH| j|d dd�S i }|D ]"}|�| j|dd�jjd d �� qP| t f i |��d �S ) a� create a CryptPolicy instance by merging multiple sources. each source is interpreted as by :meth:`from_source`, and the results are merged together. .. deprecated:: 1.6 Instead of using this method to merge multiple policies together, a :class:`CryptContext` instance should be created, and then the multiple sources merged together via :meth:`CryptContext.load`. zwInstead of ``CryptPolicy.from_sources()``, use the various CryptContext constructors followed by ``context.update()``.r9 r: r zno sources specified� F�rT T��resolver< ) r r> r? �lenr) rU �update�_context�to_dictr )rA �sourcesrT �kwdsrF r, r, r- � from_sources� s �� zCryptPolicy.from_sourcesc O s\ | j rttd tdd� nttd tdd� | g}|r@|�|� |rN|�|� tj|dd�S )z�create a new CryptPolicy, optionally updating parts of the existing configuration. .. deprecated:: 1.6 Callers of this method should :meth:`CryptContext.update` or :meth:`CryptContext.copy` instead. zXInstead of ``context.policy.replace()``, use ``context.update()`` or ``context.copy()``.r9 r: zzInstead of ``CryptPolicy().replace()``, create a CryptContext instance and use ``context.update()`` or ``context.copy()``.FrW )� _stub_policyr r> r? �extend�appendr" r` )�self�argsr_ r^ r, r, r- �replace s" ���� zCryptPolicy.replaceNFc O sx |� dd �}|r&|| _|� dd�| _nN|rRt|�dkr>td��|rJtd��|d }ttd td d � tf i |��| _d S ) Nr= ra FrV z%only one positional argument acceptedz&cannot specify positional arg and kwdsr z�Instead of constructing a CryptPolicy instance, create a CryptContext directly, or use ``context.update()`` and ``context.load()`` to reconfigure existing CryptContext instances.r9 r: ) �popr\ ra rZ rP r r> r? r )rd re r_ �contextr, r, r- �__init__1 s" ��zCryptPolicy.__init__c C s: | j rttd tdd� nttd tdd� t| j�� �S )z�return True if policy defines *any* schemes for use. .. deprecated:: 1.6 applications should use ``bool(context.schemes())`` instead. see :meth:`CryptContext.schemes`. zMInstead of ``context.policy.has_schemes()``, use ``bool(context.schemes())``.r9 r: zoInstead of ``CryptPolicy().has_schemes()``, create a CryptContext instance and use ``bool(context.schemes())``.)ra r r> r? �boolr\ �schemes�rd r, r, r- � has_schemesJ s ����zCryptPolicy.has_schemesc C s< | j rttd tdd� nttd tdd� | jjddd�S )z�return iterator over handlers defined in policy. .. deprecated:: 1.6 applications should use ``context.schemes(resolve=True))`` instead. see :meth:`CryptContext.schemes`. zUInstead of ``context.policy.iter_handlers()``, use ``context.schemes(resolve=True)``.r9 r: zwInstead of ``CryptPolicy().iter_handlers()``, create a CryptContext instance and use ``context.schemes(resolve=True)``.T�rY � unconfigured)ra r r> r? r\ rk rl r, r, r- � iter_handlers^ s ����zCryptPolicy.iter_handlersc C s@ | j rttd tdd� nttd tdd� t| jj|dd��S )z�return list of schemes defined in policy. .. deprecated:: 1.6 applications should use :meth:`CryptContext.schemes` instead. zCInstead of ``context.policy.schemes()``, use ``context.schemes()``.r9 r: zeInstead of ``CryptPolicy().schemes()``, create a CryptContext instance and use ``context.schemes()``.Trn )ra r r> r? �listr\ rk �rd rY r, r, r- rk r s ����zCryptPolicy.schemesc C sf | j rttd tdd� nttd tdd� z| jj||dd�W S ty` |rV� nY dS Y n0 dS )a8 return handler as specified by name, or default handler. .. deprecated:: 1.6 applications should use :meth:`CryptContext.handler` instead, though note that the ``required`` keyword has been removed, and the new method will always act as if ``required=True``. zGInstead of ``context.policy.get_handler()``, use ``context.handler()``.r9 r: ziInstead of ``CryptPolicy().get_handler()``, create a CryptContext instance and use ``context.handler()``.T�ro N)ra r r> r? r\ r2 �KeyError)rd r0 �category�requiredr, r, r- � get_handler� s" ���� zCryptPolicy.get_handlerc C s t dtdd� dS )ar get min_verify_time setting for policy. .. deprecated:: 1.6 min_verify_time option will be removed entirely in passlib 1.8 .. versionchanged:: 1.7 this method now always returns the value automatically calculated by :meth:`CryptContext.min_verify_time`, any value specified by policy is ignored. znget_min_verify_time() and min_verify_time option is deprecated and ignored, and will be removed in Passlib 1.8r9 r: r )r r? )rd ru r, r, r- �get_min_verify_time� s �z CryptPolicy.get_min_verify_timec C sP | j rttd tdd� nttd tdd� t|d�r<|j}| jj�||�d S )aL return dictionary of options specific to a given handler. .. deprecated:: 1.6 this method has no direct replacement in the 1.6 api, as there is not a clearly defined use-case. however, examining the output of :meth:`CryptContext.to_dict` should serve as the closest alternative. z=``context.policy.get_options()`` will no longer be available.r9 r: z<``CryptPolicy().get_options()`` will no longer be available.r0 r ) ra r r> r? �hasattrr0 r\ �_config� _get_record_options_with_flag�rd r0 ru r, r, r- � get_options� s ���� zCryptPolicy.get_optionsc C sL | j rttd tdd� nttd tdd� t|d�r<|j}| j�||�jS )aB check if handler has been deprecated by policy. .. deprecated:: 1.6 this method has no direct replacement in the 1.6 api, as there is not a clearly defined use-case. however, examining the output of :meth:`CryptContext.to_dict` should serve as the closest alternative. zG``context.policy.handler_is_deprecated()`` will no longer be available.r9 r: zF``CryptPolicy().handler_is_deprecated()`` will no longer be available.r0 ) ra r r> r? ry r0 r\ r2 � deprecatedr| r, r, r- �handler_is_deprecated� s ���� z!CryptPolicy.handler_is_deprecatedc sz | j rttd tdd� nttd tdd� | j� |rP� fdd��dd� �d }n� j�d d � ���fd d �� j�|�D �S )z�iterate over key/value pairs representing the policy object. .. deprecated:: 1.6 applications should use :meth:`CryptContext.to_dict` instead. zOInstead of ``context.policy.iter_config()``, use ``context.to_dict().items()``.r9 r: zqInstead of ``CryptPolicy().iter_config()``, create a CryptContext instance and use ``context.to_dict().items()``.c s � � | ��dd�S )N�__�.)�_render_config_keyrf )�key)rh r, r- � render_key� s z+CryptPolicy.iter_config.<locals>.render_keyc S s t | ttf�rd�| �} | S )N�, )rM rq �tuple�joinr* r, r, r- � render_value� s z-CryptPolicy.iter_config.<locals>.render_valueFc S s | S rG r, r* r, r, r- �<lambda>� rL z)CryptPolicy.iter_config.<locals>.<lambda>c 3 s" | ]\}}� |��|�fV qd S rG r, �rH r� r+ )r� r� r, r- rK � s �z*CryptPolicy.iter_config.<locals>.<genexpr>)ra r r> r? r\ r� rz � iter_config)rd ZinirY r, )rh r� r� r- r� � s* ���� �zCryptPolicy.iter_configc C s8 | j rttd tdd� nttd tdd� | j�|�S )z�export policy object as dictionary of options. .. deprecated:: 1.6 applications should use :meth:`CryptContext.to_dict` instead. zCInstead of ``context.policy.to_dict()``, use ``context.to_dict()``.r9 r: zeInstead of ``CryptPolicy().to_dict()``, create a CryptContext instance and use ``context.to_dict()``.)ra r r> r? r\ r] rr r, r, r- r] s ����zCryptPolicy.to_dictc C sV | j rttd tdd� nttd tdd� | jj|d�}trH|�d�}|�|� dS )z�export policy to file. .. deprecated:: 1.6 applications should use :meth:`CryptContext.to_string` instead, and then write the output to a file as desired. zYInstead of ``context.policy.to_file(stream)``, use ``stream.write(context.to_string())``.r9 r: z{Instead of ``CryptPolicy().to_file(stream)``, create a CryptContext instance and use ``stream.write(context.to_string())``.�rC r8 N) ra r r> r? r\ � to_stringr �encode�write)rd �streamrC �outr, r, r- �to_file s ���� zCryptPolicy.to_filec C sL | j rttd tdd� nttd tdd� | jj|d�}|rH|�|�}|S )z�export policy to file. .. deprecated:: 1.6 applications should use :meth:`CryptContext.to_string` instead. zGInstead of ``context.policy.to_string()``, use ``context.to_string()``.r9 r: ziInstead of ``CryptPolicy().to_string()``, create a CryptContext instance and use ``context.to_string()``.r� )ra r r> r? r\ r� r� )rd rC rD r� r, r, r- r� . s ���� zCryptPolicy.to_string)r7 r8 )r7 r8 )T)T)F)NNF)N)N)N)FF)F)r7 )r7 N)�__name__� __module__� __qualname__�__doc__� classmethodr@ rE rU r` rf r\ ra ri rm rp rk rw rx r} r r� r] r� r� r, r, r, r- r" X s0 < ' $ r" c @ s e Zd ZdZdZdZdZdZdZdZ dZ dZ dZ dd� Z dd� Zdd� Zd d � Zd d � Zi fd d�Zdd� Zi fdd�Zdd� Zedd� �Zdd� Zdd� Zdd � Zd d � Zd d � Z ed1d"d#��Z d$d%� Z d&d'� Z d2d(d)�Z d3d+d,�Z!e"d-d.� �Z#d4d/d0�Z$dS )5� _CryptConfiga parses, validates, and stores CryptContext config this is a helper used internally by CryptContext to handle parsing, validation, and serialization of its config options. split out from the main class, but not made public since that just complicates interface too much (c.f. CryptPolicy) :arg source: config as dict mapping ``(cat,scheme,option) -> value`` Nc C s. | � |�d�� | �|� | �� | �� d S )N�NNrk )�_init_scheme_list�get� _init_options�_init_default_schemes� _init_records)rd rF r, r, r- ri z s z_CryptConfig.__init__c C s� g }g }t |t�rt|�}|p dD ]v}t|d�rD|}|j}t|� n*t |t�r^t|�}|j}ntdt|� ��||v r�t d|f ��|� |� |� |� q"t |�| _ t |�| _ dS )z,initialize .handlers and .schemes attributesr, r0 z+scheme must be name or CryptHandler, not %rz$multiple handlers with same name: %rN)rM r r ry r0 r r rP rQ rt rc r� r rk )rd �datar rk �elemr2 �schemer, r, r- r� � s. �� z _CryptConfig._init_scheme_listc C s� | j }| j}i | _}i | _}t� }t|�D �]H\\}}} } |�|� |} |s`|s`| tv r`d}|�r|| | �\} } |dkr�| tvr�td| f t � | dkr�tdt � z || } W n" t y� || | ii||< Y n80 z | | } W n t �y | | i| |< Y n 0 | | | < q.|�r&| dk�r&t d��||| | �\} } | dk�rBq.z || } W n t �yn || i|| < Y q.0 | | |< q.|� d� t t|��| _dS )zYload config dict into internal representation, and init .categories attr �allz}The '%s' option should be configured per-algorithm, and not set globally in the context; This will be an error in Passlib 2.0z�The 'all' scheme is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0; Please configure options on a per-algorithm basis.rk z4'schemes' context option is not allowed per category�min_verify_timeN)�_norm_scheme_option�_norm_context_option�_scheme_options�_context_options�setr �add�_global_settingsr r r? rt �discardr� �sorted� categories)rd rF Znorm_scheme_optionZnorm_context_option�scheme_options�context_optionsr� �catr� r� r+ Zexplicit_scheme� category_mapZ option_mapr, r, r- r� � sV ��� z_CryptConfig._init_optionsc C s> |t v rtd|f ��t|t�r6t�|�}|r6||�}||fS )Nz3%r option not allowed in CryptContext configuration)�_forbidden_scheme_optionsrt rM r �_coerce_scheme_optionsr� )rd r� r+ �funcr, r, r- r� � s � z _CryptConfig._norm_scheme_optionc C s& | j }|dkrLt|d�r |j}nt|t�s6t|dd��|rJ||vrJtd��n�|dkr�t|t�rht|�}nt|tt f�s�t|dd��d|v r�t |�dkr�t d ��n:|r�|D ]0}t|t�s�t|dd ��||vr�td |f ��q�nB|d kr�t d t � n.|dk�rt dt � n|dk�r td|f ��||fS )N�defaultr0 �strz"default scheme not found in policyr~ z str or seq�autorV z<cannot list other schemes if ``deprecated=['auto']`` is usedzdeprecated elementz)deprecated scheme not found in policy: %rr� z^'min_verify_time' was deprecated in Passlib 1.6, is ignored in 1.7, and will be removed in 1.8� harden_verifyzX'harden_verify' is deprecated & ignored as of Passlib 1.7.1, and will be removed in 1.8rk z unknown CryptContext keyword: %r)rk ry r0 rM r r rt r rq r� rZ r) r r? )rd r� r� r+ rk r� r, r, r- r� � sF � � � z!_CryptConfig._norm_context_optionc C s | j �||�S )zreturn dict mapping category->value for specific context option. .. warning:: treat return value as readonly! )r� r� )rd r� Z_defaultr, r, r- �get_context_optionmap& s z"_CryptConfig.get_context_optionmapc C sr z| j | }W n ty" Y dS 0 |�d�}|rjz || }W n tyP Y n0 |du sb||krj|dfS |dfS )z�return value of specific option, handling category inheritance. also returns flag indicating whether value is category-specific. )NFNTF)r� rt r� )rd ru r� r� r+ �altr, r, r- � get_context_option_with_flag- s z)_CryptConfig.get_context_option_with_flagc C s, z| j | | W S ty& | Y S 0 dS )zsreturn all options for (scheme,category) combination .. warning:: treat return value as readonly! N)r� rt )rd r� ru r� r, r, r- �_get_scheme_optionmapC s z"_CryptConfig._get_scheme_optionmapc C s | j | j�|� S rG )r rk �index)rd r� r, r, r- �get_base_handlerM s z _CryptConfig.get_base_handlerc C s | j }d| j v r |tjj7 }|S )N�rounds)� setting_kwds�uhZ HasRoundsZusing_rounds_kwds)r2 r� r, r, r- �expand_settingsP s z _CryptConfig.expand_settingsc C s� | j }|dd��� }d}|r4|�� }|�|d|�� | �| �|��}t|��|�D ]}|�|� qR|r�t|��|�D ]}|�|� qt||d�} |�| � |r�|�| � |�|||�� ||kr�d}||fS )z�return composite dict of all options set for scheme. includes options inherited from 'all' and from default category. result can be modified. returns (kwds, has_cat_specific_options) r� NFT)r� �copyr[ r� r� r� � differencerg ) rd r� ru � get_optionmapr_ �has_cat_optionsZdefkwdsZallowed_settingsr� �otherr, r, r- � get_scheme_options_with_flagY s( z)_CryptConfig.get_scheme_options_with_flagc C s� | j }|d��� }| _|d�}| j}|s.dS |�d�p:d}|�d�}|sr|D ]}||vrN||d< q�qNtd��n||v r�td��| jD ]`}|�||�} |�||�} | s�|D ]}|| vr�|||< q�q�td| ��q�| | v r�td| ��q�dS ) z�initialize maps containing default scheme for each category. have to do this after _init_options(), since the default scheme is affected by the list of deprecated schemes. r� r~ Nr, z,must have at least one non-deprecated schemez#default scheme cannot be deprecatedz<must have at least one non-deprecated scheme for %r categoryz3default scheme for %r category cannot be deprecated)r� r� �_default_schemesrk r� r) r� ) rd r� Z default_mapZdep_maprk Zdepsr� r� r� ZcdepsZcdefaultr, r, r- r� � s> ��z"_CryptConfig._init_default_schemesc C s: | j }z || W S ty" Y n0 | js2td��|d S )z+return default scheme for specific categoryz9no hash schemes configured for this CryptContext instanceN)r� rt rk )rd ru �defaultsr, r, r- �default_scheme� s z_CryptConfig.default_schemec sR �� d�� � ��fdd�}|d�p$d}|rJ||�}|durJ||krJ|dfS |dfS )z/is scheme deprecated under particular category?r~ c s@ � � | � � d ��}|d u r d S d|v r4���| �kS �|v S d S )Nr� )r� r� )r� rF �Zdepmapr� rd r, r- �test� s z2_CryptConfig.is_deprecated_with_flag.<locals>.testNFT)r� )rd r� ru r� r+ r� r, r� r- �is_deprecated_with_flag� s z$_CryptConfig.is_deprecated_with_flagc C s� i | _ i }| _t� }| _| j}d| j }| jD ]V}|j}|�|j� |D ]:}|||�\}} |d u sj| rL| j ||fi |��|||f< qLq2d S )NrG ) � _record_lists�_recordsr� � context_kwdsr{ r� r r0 r[ �_create_record) rd ZrecordsZall_context_kwdsr} r� r2 r� r� r_ r� r, r, r- r� � s z_CryptConfig._init_recordsFc K s� z| j f ddi|��}W nd ty| } zLt�dt|��}|rf|�d�|v rf|�d�}td| j|f ��� W Y d }~n d }~0 0 | |_||_ |S )NZrelaxedTz&.* unexpected keyword argument '(.*)'$rV z'keyword not supported by %s handler: %r) �usingrP �re�matchr� �grouprt r0 �_Context__orig_handlerr~ )r2 ru r~ �settings�subcls�err�mr� r, r, r- r� � s �z_CryptConfig._create_recordc C s< | � ||�\}}| �||�\}}|r,d|d< |r4d}||fS )a� return composite dict of options for given scheme + category. this is currently a private method, though some variant of its output may eventually be made public. given a scheme & category, it returns two things: a set of all the keyword options to pass to :meth:`_create_record`, and a bool flag indicating whether any of these options were specific to the named category. if this flag is false, the options are identical to the options for the default category. the options dict includes all the scheme-specific settings, as well as optional *deprecated* keyword. Tr~ )r� r� )rd r� ru r_ r� r+ Z not_inheritedr, r, r- r{ � s z*_CryptConfig._get_record_options_with_flagc C s� z| j ||f W S ty" Y n0 |durbt|t�sbtrVt|t�rV| �||�d��S t|dd��|dur�t|t�s�t|dd��|s�| � |�}| �||� }| j d|f< |S |r�z$| j }||df }|||f< |W S ty� Y n0 td|f ��dS )z5return record for specific scheme & category (cached)Nr8 z str or Noneru r� z'crypt algorithm not found in policy: %r) r� rt rM r r r � get_recordr� r r� )rd r� ru r� �record�cacher, r, r- r� s0 � z_CryptConfig.get_recordc sD z �j � W S ty Y n0 � �fdd��jD � }�j � < |S )zxreturn list of records for category (cached) this is an internal helper used only by identify_record() c s g | ]}�� |� ��qS r, )r� �rH r� �ru rd r, r- � <listcomp>P s �z1_CryptConfig._get_record_list.<locals>.<listcomp>)r� rt rk )rd ru r+ r, r� r- �_get_record_listD s �z _CryptConfig._get_record_listTc C s\ t |t�st|d��| �|�D ]}|�|�r | S q |s>dS | jsNtd��n t�d��dS )z?internal helper to identify appropriate custom handler for hashr4 Nz no crypt algorithms supportedz hash could not be identified) rM r r r� �identifyrk rt r ZUnknownHashError)rd r4 ru rv r� r, r, r- �identify_recordV s z _CryptConfig.identify_recordc C s* | � d �D ]}|jr | S q td��d S )NzLno disabled hasher present (perhaps add 'unix_disabled' to list of schemes?))r� � is_disabled� RuntimeError)rd r� r, r, r- �disabled_recordn s z _CryptConfig.disabled_recordc c s | j }| j}t|�}t|�}d|v r.|�d� |r8| jn| j}|rPdt|�fV d| j D ]�}|D ]J}z|| | }W n ty� Y qb0 t |t�r�t|�}|d|f|fV qb|D ]J} z|| | } W n ty� Y q�0 t| �D ]}|| |f| | fV q�q�qZdS )a� regenerate original config. this is an iterator which yields ``(cat,scheme,option),value`` items, in the order they generally appear inside an INI file. if interpreted as a dictionary, it should match the original keywords passed to the CryptContext (aside from any canonization). it's mainly used as the internal backend for most of the public serialization methods. rk r� rG N) r� r� r� �remover rk rq r� rt rM ) rd rY r� r� Z scheme_keysZ context_keysr+ r� r� r� r_ r, r, r- r� y s2 z_CryptConfig.iter_config)NF)N)T)F)%r� r� r� r� r� r� r rk r� r� r� r� r� ri r� r� r� r� r� r� r� r� � staticmethodr� r� r� r� r� r� r� r{ r� r� r� r r� r� r, r, r, r- r� K sF &I + ++ + r� c @ s& e Zd ZdZdZdZdZedd� �Zedldd��Z edmd d ��Z d d � Z d d� Z dd� Z dedfdd�Zdd� Zdd� Zdd� Zeeedd�Zed d � �Zdnd d �Zdod!d"�Zed#d$� �Zd%d&� Zdpd'd(�Zdqd)d*�Z drd+d,�Z d-d.� Z ed/d0� �Z ed1d2� �Z ed3d4� �Z!dsd5d6�Z"d7d8� Z#dtd9d:�Z$d;Z%d<Z&d=Z'd>Z(dZ)d?Z*d@dA� Z+dudBdC�Z,dDdE� Z-dvdFdG�Z.e/dHdIdJdK�dwdLdM��Z0e/dNdIdO�dxdPdQ��Z1e/dNdIdO�dydRdS��Z2dzdTdU�Z3d{dVdW�Z4e/dNdIdXdK�dYdZ� �Z5d|d[d\�Z6d}d]d^�Z7d_Z8e9d`da� �Z:dbdc� Z;d~ddde�Z<dfdg� Z=ddhdi�Z>djdk� Z?dS )�r a- Helper for hashing & verifying passwords using multiple algorithms. Instances of this class allow applications to choose a specific set of hash algorithms which they wish to support, set limits and defaults for the rounds and salt sizes those algorithms should use, flag which algorithms should be deprecated, and automatically handle migrating users to stronger hashes when they log in. Basic usage:: >>> ctx = CryptContext(schemes=[...]) See the Passlib online documentation for details and full documentation. Nc C s> t |t�r| f i |��S t || �r&|S | � }|�|� |S dS )z2internal helper - accepts string, dict, or contextN)rM rN �load)rA rF rd r, r, r- � _norm_source� s zCryptContext._norm_sourcer7 r8 c C s4 t |t�st|dd��| dd�}|j|||d� |S )a� create new CryptContext instance from an INI-formatted string. :type source: unicode or bytes :arg source: string containing INI-formatted content. :type section: str :param section: option name of section to read from, defaults to ``"passlib"``. :type encoding: str :arg encoding: optional encoding used when source is bytes, defaults to ``"utf-8"``. :returns: new :class:`CryptContext` instance, configured based on the parameters in the *source* string. Usage example:: >>> from passlib.context import CryptContext >>> context = CryptContext.from_string(''' ... [passlib] ... schemes = sha256_crypt, des_crypt ... sha256_crypt__default_rounds = 30000 ... ''') .. versionadded:: 1.6 .. seealso:: :meth:`to_string`, the inverse of this constructor. zunicode or bytesrF F�� _autoload�rC rD )rM r r r� )rA rF rC rD rd r, r, r- rE � s ! zCryptContext.from_stringc C s | dd�}|j |||d� |S )a create new CryptContext instance from an INI-formatted file. this functions exactly the same as :meth:`from_string`, except that it loads from a local file. :type path: str :arg path: path to local file containing INI-formatted config. :type section: str :param section: option name of section to read from, defaults to ``"passlib"``. :type encoding: str :arg encoding: encoding used to load file, defaults to ``"utf-8"``. :returns: new CryptContext instance, configured based on the parameters stored in the file *path*. .. versionadded:: 1.6 .. seealso:: :meth:`from_string` for an equivalent usage example. Fr� r� )� load_path)rA rB rC rD rd r, r, r- r@ s zCryptContext.from_pathc K s* t dd�}|�| � |r&|j|dd� |S )a6 Return copy of existing CryptContext instance. This function returns a new CryptContext instance whose configuration is exactly the same as the original, with the exception that any keywords passed in will take precedence over the original settings. As an example:: >>> from passlib.context import CryptContext >>> # given an existing context... >>> ctx1 = CryptContext(["sha256_crypt", "md5_crypt"]) >>> # copy can be used to make a clone, and update >>> # some of the settings at the same time... >>> ctx2 = custom_app_context.copy(default="md5_crypt") >>> # and the original will be unaffected by the change >>> ctx1.default_scheme() "sha256_crypt" >>> ctx2.default_scheme() "md5_crypt" .. versionadded:: 1.6 This method was previously named :meth:`!replace`. That alias has been deprecated, and will be removed in Passlib 1.8. .. seealso:: :meth:`update` Fr� T�r[ )r r� )rd r_ r� r, r, r- r� , s zCryptContext.copyc K s | j f i |��S )zG alias for :meth:`copy`, to match PasswordHash.using() )r� �rd r_ r, r, r- r� R s zCryptContext.usingc K s t dtdd� | jf i |��S )z deprecated alias of :meth:`copy`z�CryptContext().replace() has been deprecated in Passlib 1.6, and will be removed in Passlib 1.8, it has been renamed to CryptContext().copy()r9 r: )r r? r� r� r, r, r- rf X s �zCryptContext.replaceTc K sv |d ur||d< |t urbtdt� |d u r6| �|� qrt|t�rX| �|j� | �|� qrtd��n|rr| �|� n d S )Nrk z�The CryptContext ``policy`` keyword has been deprecated as of Passlib 1.6, and will be removed in Passlib 1.8; please use ``CryptContext.from_string()` or ``CryptContext.from_path()`` instead.z%policy must be a CryptPolicy instance) �_UNSETr r? r� rM r" r\ r[ rP )rd rk �policyr� r_ r, r, r- ri c s � zCryptContext.__init__c C s dt | � S )Nz<CryptContext at 0x%0x>)�idrl r, r, r- �__repr__� s zCryptContext.__repr__c C s t | �� dd�S )NT)r= ra )r" r� rl r, r, r- � _get_policy� s zCryptContext._get_policyc C s2 t dtdd� t|t�r&| �|j� ntd��d S )Nz�The CryptPolicy class and the ``context.policy`` attribute have been deprecated as of Passlib 1.6, and will be removed in Passlib 1.8; please use the ``context.load()`` and ``context.update()`` methods instead.r9 r: z expected CryptPolicy instance)r r? rM r" r� r\ rP )rd r� r, r, r- � _set_policy� s � zCryptContext._set_policyzC[deprecated] returns CryptPolicy instance tied to this CryptContext)�docc C s2 t � }tr|�| |� n |�| |� t|�|��S )z<helper read INI from stream, extract passlib section as dict)r r Z read_fileZreadfprN �items)r� rC �filename�pr, r, r- �_parse_ini_stream� s z CryptContext._parse_ini_streamFc s� � ���fdd�}t rNt� d|d��}||�W d � S 1 sB0 Y n�|dv r�t� d��}||�W d � S 1 s~0 Y nJt� d��0}|�� �|��d�}|t|��W d � S 1 s�0 Y dS ) a� Load new configuration into CryptContext from a local file. This function is a wrapper for :meth:`load` which loads a configuration string from the local file *path*, instead of an in-memory source. Its behavior and options are otherwise identical to :meth:`!load` when provided with an INI-formatted string. .. versionadded:: 1.6 c s �� | �� �}�j|�d�S )Nr� )r� r� )r� r_ �rB rC rd r[ r, r- �helper� s z&CryptContext.load_path.<locals>.helperZrt)rD N)r8 �ascii�rbr8 )r �open�read�decoder� r ) rd rB r[ rC rD r� r� Zfh�tmpr, r� r- r� � s ( ( zCryptContext.load_pathc s d}t |t�rFtr"t||dd�}nt|d|dd�}| �t|�|d�}n8t |t�rht|j j dd��}d}nt |d �s~t |d d��|r�| j � t� fd d �t|�D ��}|r�| j d ur�|s�d S |}t| j j dd��}|�|� t|�}|| _ | �� |j| _|j| _|j�r| j�dd � nd | _d S )a� Load new configuration into CryptContext, replacing existing config. :arg source: source of new configuration to load. this value can be a number of different types: * a :class:`!dict` object, or compatible Mapping the key/value pairs will be interpreted the same keywords for the :class:`CryptContext` class constructor. * a :class:`!unicode` or :class:`!bytes` string this will be interpreted as an INI-formatted file, and appropriate key/value pairs will be loaded from the specified *section*. * another :class:`!CryptContext` object. this will export a snapshot of its configuration using :meth:`to_dict`. :type update: bool :param update: By default, :meth:`load` will replace the existing configuration entirely. If ``update=True``, it will preserve any existing configuration options that are not overridden by the new source, much like the :meth:`update` method. :type section: str :param section: When parsing an INI-formatted string, :meth:`load` will look for a section named ``"passlib"``. This option allows an alternate section name to be used. Ignored when loading from a dictionary. :type encoding: str :param encoding: Encoding to use when **source** is bytes. Defaults to ``"utf-8"``. Ignored when loading from a dictionary. .. deprecated:: 1.8 This keyword, and support for bytes input, will be dropped in Passlib 2.0 :raises TypeError: * If the source cannot be identified. * If an unknown / malformed keyword is encountered. :raises ValueError: If an invalid keyword value is encountered. .. note:: If an error occurs during a :meth:`!load` call, the :class:`!CryptContext` instance will be restored to the configuration it was in before the :meth:`!load` call was made; this is to ensure it is *never* left in an inconsistent state due to a load error. .. versionadded:: 1.6 TrF )�paramr8 )Zsource_encodingr z&<string passed to CryptContext.load()>rX Fr� zstring or dictc 3 s | ]\}}� |�|fV qd S rG r, r� ��parser, r- rK / s �z$CryptContext.load.<locals>.<genexpr>N�_strip_unused_context_kwds)rM r r r r r� r r rN rz r� ry r �_parse_config_keyr r[ r� �_reset_dummy_verifyr� � _get_recordr� �_identify_recordr� �__dict__rg r )rd rF r[ rC rD Z parse_keysr �configr, r r- r� � sD @ � � � zCryptContext.loadc C s� | � dd��d�}t|�}|dkr8dd|d }}}n8|dkrNd}|\}}n"|dkrb|\}}}ntd| f ��|d kr~d}n|s�|dur�td | ��|d kr�d}n|s�|dur�td | ��|s�td | ��|||fS )z>helper used to parse ``cat__scheme__option`` keys into a tupler� r� rV Nr r9 � z)keys must have less than 3 separators: %rr� zempty category: %rrh zempty scheme: %rzempty option: %r)rf �splitrZ rP )Zckey�parts�countr� r� r� r, r, r- r I s. � z CryptContext._parse_config_keyc O sN |r8t |�dkrtd��|r$td��| j|d dd� n|rJ| j|dd� dS )a� Helper for quickly changing configuration. This acts much like the :meth:`!dict.update` method: it updates the context's configuration, replacing the original value(s) for the specified keys, and preserving the rest. It accepts any :ref:`keyword <context-options>` accepted by the :class:`!CryptContext` constructor. .. versionadded:: 1.6 .. seealso:: :meth:`copy` rV z(expected at most one positional argumentz.positional arg and keywords mutually exclusiver Tr� N)rZ rP r� �rd re r_ r, r, r- r[ g s zCryptContext.updatec s. �j j}|r&t� ��fdd�|D ��S |S dS )a; return schemes loaded into this CryptContext instance. :type resolve: bool :arg resolve: if ``True``, will return a tuple of :class:`~passlib.ifc.PasswordHash` objects instead of their names. :returns: returns tuple of the schemes configured for this context via the *schemes* option. .. versionadded:: 1.6 This was previously available as ``CryptContext().policy.schemes()`` .. seealso:: the :ref:`schemes <context-schemes-option>` option for usage example. c 3 s | ]}�j |� �d �V qdS )rs Nr1 r� �ru rd ro r, r- rK � s �z'CryptContext.schemes.<locals>.<genexpr>N)rz rk r� )rd rY ru ro rk r, r r- rk � s �zCryptContext.schemesc C s | j d||d�}|r|S |jS )ah return name of scheme that :meth:`hash` will use by default. :type resolve: bool :arg resolve: if ``True``, will return a :class:`~passlib.ifc.PasswordHash` object instead of the name. :type category: str or None :param category: Optional :ref:`user category <user-categories>`. If specified, this will return the catgory-specific default scheme instead. :returns: name of the default scheme. .. seealso:: the :ref:`default <context-default-option>` option for usage example. .. versionadded:: 1.6 .. versionchanged:: 1.7 This now returns a hasher configured with any CryptContext-specific options (custom rounds settings, etc). Previously this returned the base hasher from :mod:`passlib.hash`. Nrs )r2 r0 )rd ru rY ro �hasherr, r, r- r� � s zCryptContext.default_schemec C sZ z"| � ||�}|r|jW S |W S W n ty4 Y n0 | jjrNtd|f ��ntd��dS )a� helper to resolve name of scheme -> :class:`~passlib.ifc.PasswordHash` object used by scheme. :arg scheme: This should identify the scheme to lookup. If omitted or set to ``None``, this will return the handler for the default scheme. :arg category: If a user category is specified, and no scheme is provided, it will use the default for that category. Otherwise this parameter is ignored. :param unconfigured: By default, this returns a handler object whose .hash() and .needs_update() methods will honor the configured provided by CryptContext. See ``unconfigured=True`` to get the underlying handler from before any context-specific configuration was applied. :raises KeyError: If the scheme does not exist OR is not being used within this context. :returns: :class:`~passlib.ifc.PasswordHash` object used to implement the named scheme within this context (this will usually be one of the objects from :mod:`passlib.hash`) .. versionadded:: 1.6 This was previously available as ``CryptContext().policy.get_handler()`` .. versionchanged:: 1.7 This now returns a hasher configured with any CryptContext-specific options (custom rounds settings, etc). Previously this returned the base hasher from :mod:`passlib.hash`. z;crypt algorithm not found in this CryptContext instance: %rz8no crypt algorithms loaded in this CryptContext instanceN)r r� rt rz r )rd r� ru ro r r, r, r- r2 � s & �zCryptContext.handlerc C s t dd� | jjD ��S )zCcheck if any handlers in this context aren't in the global registryc s s | ]}t |�s|V qd S rG )r3 �rH r2 r, r, r- rK 2 s �z:CryptContext._get_unregistered_handlers.<locals>.<genexpr>)r� rz r rl r, r, r- �_get_unregistered_handlers0 s z'CryptContext._get_unregistered_handlersc C s | j jS )z� return :class:`!set` containing union of all :ref:`contextual keywords <context-keywords>` supported by the handlers in this context. .. versionadded:: 1.6.6 )rz r� rl r, r, r- r� 5 s zCryptContext.context_kwdsc C s8 | \}}}|r d||pd|f S |r0d||f S |S dS )z*convert 3-part config key to single stringz %s__%s__%srh z%s__%sNr, )r� r� r� �optionr, r, r- r� B s z CryptContext._render_config_keyc C sf t |ttf�rd�|�}n@t |t�rZt |t�rR| d dkrR|rLd| �d�nd}nt|�}|�dd�S )z,render value to string suitable for INI filer� r9 r/ z%.2f�0r# z%%) rM rq r� r� r r& r' r� rf )r� r+ r, r, r- �_render_ini_valueM s z CryptContext._render_ini_valuec s$ | j � t� fdd�| j�|�D ��S )ag Return current configuration as a dictionary. :type resolve: bool :arg resolve: if ``True``, the ``schemes`` key will contain a list of a :class:`~passlib.ifc.PasswordHash` objects instead of just their names. This method dumps the current configuration of the CryptContext instance. The key/value pairs should be in the format accepted by the :class:`!CryptContext` class constructor, in fact ``CryptContext(**myctx.to_dict())`` will create an exact copy of ``myctx``. As an example:: >>> # you can dump the configuration of any crypt context... >>> from passlib.apps import ldap_nocrypt_context >>> ldap_nocrypt_context.to_dict() {'schemes': ['ldap_salted_sha1', 'ldap_salted_md5', 'ldap_sha1', 'ldap_md5', 'ldap_plaintext']} .. versionadded:: 1.6 This was previously available as ``CryptContext().policy.to_dict()`` .. seealso:: the :ref:`context-serialization-example` example in the tutorial. c 3 s | ]\}}� |�|fV qd S rG r, r� �r� r, r- rK � s �z'CryptContext.to_dict.<locals>.<genexpr>)r� rN rz r� rr r, r r- r] b s �zCryptContext.to_dictc C sN | j }| j}|�|� | j�� D ](\}}|||�}||�}|�|||� q dS )z(helper to write to ConfigParser instanceN)r� r Z add_sectionrz r� r� )rd �parserrC r� r� �k�vr, r, r- �_write_to_parser� s z CryptContext._write_to_parserc C sf t � }| �||� t� }|�|� | �� }|rL|�dd�dd� |D �� � |�� }tsb|�d�}|S )aH serialize to INI format and return as unicode string. :param section: name of INI section to output, defaults to ``"passlib"``. :returns: CryptContext configuration, serialized to a INI unicode string. This function acts exactly like :meth:`to_dict`, except that it serializes all the contents into a single human-readable string, which can be hand edited, and/or stored in a file. The output of this method is accepted by :meth:`from_string`, :meth:`from_path`, and :meth:`load`. As an example:: >>> # you can dump the configuration of any crypt context... >>> from passlib.apps import ldap_nocrypt_context >>> print ldap_nocrypt_context.to_string() [passlib] schemes = ldap_salted_sha1, ldap_salted_md5, ldap_sha1, ldap_md5, ldap_plaintext .. versionadded:: 1.6 This was previously available as ``CryptContext().policy.to_string()`` .. seealso:: the :ref:`context-serialization-example` example in the tutorial. z�# NOTE: the %s handler(s) are not registered with Passlib, # this string may not correctly reproduce the current configuration. r� c s s | ]}t |j�V qd S rG )�reprr0 r r, r, r- rK � rL z)CryptContext.to_string.<locals>.<genexpr>r8 ) r r r r� r r� �getvaluer r )rd rC r �bufZ unregisteredr� r, r, r- r� � s � zCryptContext.to_string� � r9 r$ r c C s | � � d S rG )r rl r, r, r- �reset_min_verify_time� s z"CryptContext.reset_min_verify_timec C s4 |r$t |t�st|d��| �||�S | �||�S dS )zCreturn record based on scheme, or failing that, by identifying hashr4 N)rM r r r r �rd r4 r� ru r, r, r- �_get_or_identify_record� s z$CryptContext._get_or_identify_recordc C s2 |sdS | j j�|j�}|D ]}|�|d� q dS )af helper which removes any context keywords from **kwds** that are known to be used by another scheme in this context, but are NOT supported by handler specified by **record**. .. note:: as optimization, load() will set this method to None on a per-instance basis if there are no context kwds. N)rz r� r� rg )rd r_ r� Z unused_kwdsr� r, r, r- r � s z'CryptContext._strip_unused_context_kwdsc C s4 |durt dt� | �|||�}|jp2|j||d�S )a� Check if hash needs to be replaced for some reason, in which case the secret should be re-hashed. This function is the core of CryptContext's support for hash migration: This function takes in a hash string, and checks the scheme, number of rounds, and other properties against the current policy. It returns ``True`` if the hash is using a deprecated scheme, or is otherwise outside of the bounds specified by the policy (e.g. the number of rounds is lower than :ref:`min_rounds <context-min-rounds-option>` configuration for that algorithm). If so, the password should be re-hashed using :meth:`hash` Otherwise, it will return ``False``. :type hash: unicode or bytes :arg hash: The hash string to examine. :type scheme: str or None :param scheme: Optional scheme to use. Scheme must be one of the ones configured for this context (see the :ref:`schemes <context-schemes-option>` option). If no scheme is specified, it will be identified based on the value of *hash*. .. deprecated:: 1.7 Support for this keyword is deprecated, and will be removed in Passlib 2.0. :type category: str or None :param category: Optional :ref:`user category <user-categories>`. If specified, this will cause any category-specific defaults to be used when determining if the hash needs to be updated (e.g. is below the minimum rounds). :type secret: unicode, bytes, or None :param secret: Optional secret associated with the provided ``hash``. This is not required, or even currently used for anything... it's for forward-compatibility with any future update checks that might need this information. If provided, Passlib assumes the secret has already been verified successfully against the hash. .. versionadded:: 1.6 :returns: ``True`` if hash should be replaced, otherwise ``False``. :raises ValueError: If the hash did not match any of the configured :meth:`schemes`. .. versionadded:: 1.6 This method was previously named :meth:`hash_needs_update`. .. seealso:: the :ref:`context-migration-example` example in the tutorial. NzqCryptContext.needs_update(): 'scheme' keyword is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0�r5 )r r? r' r~ � needs_update)rd r4 r� ru r5 r� r, r, r- r) s ;�zCryptContext.needs_updatez1.6z2.0zCryptContext.needs_update())r~ �removedZ replacementc C s | � |||�S )a Legacy alias for :meth:`needs_update`. .. deprecated:: 1.6 This method was renamed to :meth:`!needs_update` in version 1.6. This alias will be removed in version 2.0, and should only be used for compatibility with Passlib 1.3 - 1.5. )r) r& r, r, r- �hash_needs_updateF s z CryptContext.hash_needs_updatez1.7)r~ r* c K s0 | � ||�}| j}|r |||� |jf i |��S )z�Generate a config string for specified scheme. .. deprecated:: 1.7 This method will be removed in version 2.0, and should only be used for compatibility with Passlib 1.3 - 1.6. )r r � genconfig)rd r� ru r� r� � strip_unusedr, r, r- r, Q s zCryptContext.genconfigc K s6 | � |||�}| j}|r"|||� |j||fi |��S )z�Generate hash for the specified secret using another hash. .. deprecated:: 1.7 This method will be removed in version 2.0, and should only be used for compatibility with Passlib 1.3 - 1.6. )r' r �genhash)rd r5 r r� ru r_ r� r- r, r, r- r. ` s zCryptContext.genhashc C s8 | � |||�}|du rdS |r.|r(|jS |S n|jS dS )a� Attempt to identify which algorithm the hash belongs to. Note that this will only consider the algorithms currently configured for this context (see the :ref:`schemes <context-schemes-option>` option). All registered algorithms will be checked, from first to last, and whichever one positively identifies the hash first will be returned. :type hash: unicode or bytes :arg hash: The hash string to test. :type category: str or None :param category: Optional :ref:`user category <user-categories>`. Ignored by this function, this parameter is provided for symmetry with the other methods. :type resolve: bool :param resolve: If ``True``, returns the hash handler itself, instead of the name of the hash. :type required: bool :param required: If ``True``, this will raise a ValueError if the hash cannot be identified, instead of returning ``None``. :returns: The handler which first identifies the hash, or ``None`` if none of the algorithms identify the hash. N)r r� r0 )rd r4 ru rY rv ro r� r, r, r- r� o s "zCryptContext.identifyc K sD |durt dt� | �||�}| j}|r2|||� |j|fi |��S )aZ run secret through selected algorithm, returning resulting hash. :type secret: unicode or bytes :arg secret: the password to hash. :type scheme: str or None :param scheme: Optional scheme to use. Scheme must be one of the ones configured for this context (see the :ref:`schemes <context-schemes-option>` option). If no scheme is specified, the configured default will be used. .. deprecated:: 1.7 Support for this keyword is deprecated, and will be removed in Passlib 2.0. :type category: str or None :param category: Optional :ref:`user category <user-categories>`. If specified, this will cause any category-specific defaults to be used when hashing the password (e.g. different default scheme, different default rounds values, etc). :param \*\*kwds: All other keyword options are passed to the selected algorithm's :meth:`PasswordHash.hash() <passlib.ifc.PasswordHash.hash>` method. :returns: The secret as encoded by the specified algorithm and options. The return value will always be a :class:`!str`. :raises TypeError, ValueError: * If any of the arguments have an invalid type or value. This includes any keywords passed to the underlying hash's :meth:`PasswordHash.hash() <passlib.ifc.PasswordHash.hash>` method. .. seealso:: the :ref:`context-basic-example` example in the tutorial NziCryptContext.hash(): 'scheme' keyword is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0)r r? r r r4 )rd r5 r� ru r_ r� r- r, r, r- r4 � s +� zCryptContext.hashzCryptContext.hash()c O s | j |i |��S )a Legacy alias for :meth:`hash`. .. deprecated:: 1.7 This method was renamed to :meth:`!hash` in version 1.7. This alias will be removed in version 2.0, and should only be used for compatibility with Passlib 1.3 - 1.6. )r4 r r, r, r- �encrypt� s zCryptContext.encryptc K s\ |durt dt� |du r&| �� dS | �|||�}| j}|rH|||� |j||fi |��S )a� verify secret against an existing hash. If no scheme is specified, this will attempt to identify the scheme based on the contents of the provided hash (limited to the schemes configured for this context). It will then check whether the password verifies against the hash. :type secret: unicode or bytes :arg secret: the secret to verify :type hash: unicode or bytes :arg hash: hash string to compare to if ``None`` is passed in, this will be treated as "never verifying" :type scheme: str :param scheme: Optionally force context to use specific scheme. This is usually not needed, as most hashes can be unambiguously identified. Scheme must be one of the ones configured for this context (see the :ref:`schemes <context-schemes-option>` option). .. deprecated:: 1.7 Support for this keyword is deprecated, and will be removed in Passlib 2.0. :type category: str or None :param category: Optional :ref:`user category <user-categories>` string. This is mainly used when generating new hashes, it has little effect when verifying; this keyword is mainly provided for symmetry. :param \*\*kwds: All additional keywords are passed to the appropriate handler, and should match its :attr:`~passlib.ifc.PasswordHash.context_kwds`. :returns: ``True`` if the password matched the hash, else ``False``. :raises ValueError: * if the hash did not match any of the configured :meth:`schemes`. * if any of the arguments have an invalid value (this includes any keywords passed to the underlying hash's :meth:`PasswordHash.verify() <passlib.ifc.PasswordHash.verify>` method). :raises TypeError: * if any of the arguments have an invalid type (this includes any keywords passed to the underlying hash's :meth:`PasswordHash.verify() <passlib.ifc.PasswordHash.verify>` method). .. seealso:: the :ref:`context-basic-example` example in the tutorial N�kCryptContext.verify(): 'scheme' keyword is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0F)r r? � dummy_verifyr' r �verify)rd r5 r4 r� ru r_ r� r- r, r, r- r2 � s ;� zCryptContext.verifyc K s� |durt dt� |du r&| �� dS | �|||�}| j}|rV|rV|�� }|||� n|}|j||fi |��srdS |js�|j||d�r�d| j |fd|i|��fS dS dS )a� verify password and re-hash the password if needed, all in a single call. This is a convenience method which takes care of all the following: first it verifies the password (:meth:`~CryptContext.verify`), if this is successfull it checks if the hash needs updating (:meth:`~CryptContext.needs_update`), and if so, re-hashes the password (:meth:`~CryptContext.hash`), returning the replacement hash. This series of steps is a very common task for applications which wish to update deprecated hashes, and this call takes care of all 3 steps efficiently. :type secret: unicode or bytes :arg secret: the secret to verify :type secret: unicode or bytes :arg hash: hash string to compare to. if ``None`` is passed in, this will be treated as "never verifying" :type scheme: str :param scheme: Optionally force context to use specific scheme. This is usually not needed, as most hashes can be unambiguously identified. Scheme must be one of the ones configured for this context (see the :ref:`schemes <context-schemes-option>` option). .. deprecated:: 1.7 Support for this keyword is deprecated, and will be removed in Passlib 2.0. :type category: str or None :param category: Optional :ref:`user category <user-categories>`. If specified, this will cause any category-specific defaults to be used if the password has to be re-hashed. :param \*\*kwds: all additional keywords are passed to the appropriate handler, and should match that hash's :attr:`PasswordHash.context_kwds <passlib.ifc.PasswordHash.context_kwds>`. :returns: This function returns a tuple containing two elements: ``(verified, replacement_hash)``. The first is a boolean flag indicating whether the password verified, and the second an optional replacement hash. The tuple will always match one of the following 3 cases: * ``(False, None)`` indicates the secret failed to verify. * ``(True, None)`` indicates the secret verified correctly, and the hash does not need updating. * ``(True, str)`` indicates the secret verified correctly, but the current hash needs to be updated. The :class:`!str` will be the freshly generated hash, to replace the old one. :raises TypeError, ValueError: For the same reasons as :meth:`verify`. .. seealso:: the :ref:`context-migration-example` example in the tutorial. Nr0 )FNr( Tru )TN) r r? r1 r' r r� r2 r~ r) r4 ) rd r5 r4 r� ru r_ r� r- Z clean_kwdsr, r, r- �verify_and_update- s$ @� z CryptContext.verify_and_updateztoo many secretsc C s | � | j�S )z> precalculated hash for dummy_verify() to use )r4 � _dummy_secretrl r, r, r- � _dummy_hash� s zCryptContext._dummy_hashc C s t | �j�| � dS )z> flush memoized values used by dummy_verify() N)rQ r5 � clear_cacherl r, r, r- r � s z CryptContext._reset_dummy_verifyc C s | � | j| j� dS )a� Helper that applications can call when user wasn't found, in order to simulate time it would take to hash a password. Runs verify() against a dummy hash, to simulate verification of a real account password. :param elapsed: .. deprecated:: 1.7.1 this option is ignored, and will be removed in passlib 1.8. .. versionadded:: 1.7 F)r2 r4 r5 )rd �elapsedr, r, r- r1 � s zCryptContext.dummy_verifyc C s | � |d�j S )an test if hash represents a usuable password -- i.e. does not represent an unusuable password such as ``"!"``, which is recognized by the :class:`~passlib.hash.unix_disabled` hash. :raises ValueError: if the hash is not recognized (typically solved by adding ``unix_disabled`` to the list of schemes). N)r r� )rd r4 r, r, r- � is_enabled� s zCryptContext.is_enabledc C s | j j}|�|�S )a� return a string to disable logins for user, usually by returning a non-verifying string such as ``"!"``. :param hash: Callers can optionally provide the account's existing hash. Some disabled handlers (such as :class:`!unix_disabled`) will encode this into the returned value, so that it can be recovered via :meth:`enable`. :raises RuntimeError: if this function is called w/o a disabled hasher (such as :class:`~passlib.hash.unix_disabled`) included in the list of schemes. :returns: hash string which will be recognized as valid by the context, but is guaranteed to not validate against *any* password. )rz r� �disable�rd r4 r� r, r, r- r9 � s zCryptContext.disablec C s$ | � |d�}|jr |�|�S |S dS )a� inverse of :meth:`disable` -- attempts to recover original hash which was converted by a :meth:`!disable` call into a disabled hash -- thus restoring the user's original password. :raises ValueError: if original hash not present, or if the disabled handler doesn't support encoding the original hash (e.g. ``django_disabled``) :returns: the original hash. N)r r� �enabler: r, r, r- r; � s zCryptContext.enable)r7 r8 )r7 r8 )Fr7 r8 )Fr7 r8 )FNF)NFF)NNF)F)r7 )NN)NNN)NN)NN)NN)NFFF)NN)NN)NN)r )N)@r� r� r� r� rz r r r� r� rE r@ r� r� rf r� ri r� r� r� �propertyr� r� r� r� r� r r[ rk r� r2 r r� r� r r] r r� Zmvt_estimate_max_samplesZmvt_estimate_min_samplesZmvt_estimate_max_timeZmvt_estimate_resolutionr� r� r% r' r r) r r+ r, r. r� r4 r/ r2 r3 r4 r r5 r r1 r8 r9 r; r, r, r, r- r � s� & & � " � s E 1 5 # = E � - 8 M a r c s6 e Zd ZdZdZd dd�Z� fdd�Zdd� Z� ZS ) r! a� CryptContext subclass which doesn't load handlers until needed. This is a subclass of CryptContext which takes in a set of arguments exactly like CryptContext, but won't import any handlers (or even parse its arguments) until the first time one of its methods is accessed. :arg schemes: The first positional argument can be a list of schemes, or omitted, just like CryptContext. :param onload: If a callable is passed in via this keyword, it will be invoked at lazy-load time with the following signature: ``onload(**kwds) -> kwds``; where ``kwds`` is all the additional kwds passed to LazyCryptContext. It should perform any additional deferred initialization, and return the final dict of options to be passed to CryptContext. .. versionadded:: 1.6 :param create_policy: .. deprecated:: 1.6 This option will be removed in Passlib 1.8, applications should use ``onload`` instead. :param kwds: All additional keywords are passed to CryptContext; or to the *onload* function (if provided). This is mainly used internally by modules such as :mod:`passlib.apps`, which define a large number of contexts, but only a few of them will be needed at any one time. Use of this class saves the memory needed to import the specified handlers until the context instance is actually accessed. As well, it allows constructing a context at *module-init* time, but using :func:`!onload()` to provide dynamic configuration at *application-run* time. .. note:: This class is only useful if you're referencing handler objects by name, and don't want them imported until runtime. If you want to have the config validated before your application runs, or are passing in already-imported handler instances, you should use :class:`CryptContext` instead. .. versionadded:: 1.4 Nc K s |d ur||d< || _ d S )Nrk )� _lazy_kwds)rd rk r_ r, r, r- ri - s zLazyCryptContext.__init__c s� | j }d|v rJtdt� |�d�}|f i |��}tj|dd�}|j�� }n d|v rj|�d�}|f i |��}| ` tt | �j f i |�� t | _ d S )N� create_policyz�The CryptPolicy class, and LazyCryptContext's ``create_policy`` keyword have been deprecated as of Passlib 1.6, and will be removed in Passlib 1.8; please use the ``onload`` keyword instead.FrW �onload) r= r r? rg r" rU r\ r] �superr! ri r � __class__)rd r_ r> �resultr� r? �rA r, r- � _lazy_init2 s � zLazyCryptContext._lazy_initc C s2 |� d�r|� d�r&| jd ur&| �� t�| |�S )N�_r� )� startswithr= rD �object�__getattribute__)rd �attrr, r, r- rH E s �z!LazyCryptContext.__getattribute__)N) r� r� r� r� r= ri rD rH � __classcell__r, r, rC r- r! � s 2 r! )N)Br� Z __future__r r� ZloggingZ getLoggerr� �log� threading�time�warningsr r7 r Z passlib.excr r r Zpasslib.registryr r Z passlib.utilsr r� r r r r r r r Zpasslib.utils.binaryr Zpasslib.utils.compatr r r r r r r r r r r Zpasslib.utils.decorr r �__all__rG r� r. r� r� rN r( r� r3 r� r6 r� r> r" r� r r! r, r, r, r- �<module> sd ( 4 � v i L