Current File : //lib/python2.7/site-packages/passlib/context.pyo
�
j^�Xc @� s) d Z d d l m Z d d l Z d d l Z e j e � Z d d l Z d d l Z d d l
m Z d d l m
Z
m Z m Z d d l m Z m Z d d l m Z m Z m Z m Z m Z m Z m Z m Z d d l m Z d d l m Z m! Z! m" Z" m# Z# m$ Z$ m% Z% m& Z& m' Z' m( Z( m) Z) m* Z* d d
l+ m, Z, m- Z- d d d
g Z. e/ � Z0 d � Z1 e2 d g � Z3 e4 d e5 d e5 d e5 d e1 d e5 � Z6 d � Z7 e8 e9 d � � Z: e2 d d g � Z; d Z< d
e/ f d � � YZ= d e/ f d � � YZ> d e/ f d � � YZ? d e? f d � � YZ@ d S( s- passlib.context - CryptContext implementationi����( t with_statementN( t warn( t ExpectedStringErrort ExpectedTypeErrort PasslibConfigWarning( t get_crypt_handlert _validate_handler_name( t handlerst to_bytest
to_unicodet
splitcommat as_boolt timert rngt
getrandstr( t BASE64_CHARS( t iteritemst num_typest iranget PY2t PY3t unicodet SafeConfigParsert NativeStringIOt BytesIOt unicode_or_bytes_typest native_string_types( t deprecated_methodt memoized_propertyt CryptContextt LazyCryptContextt CryptPolicyc C� sS | j d � r& t | j d � � d Sy t | � SWn t k
rN t | � SXd S( s> parse vary_rounds string to percent as [0,1) float, or integert %g{�G�z�?N( t endswitht floatt rstript intt
ValueError( t value( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _coerce_vary_rounds) s
t saltt
min_roundst
max_roundst default_roundst vary_roundst salt_sizec C� s t | j d � | k S( s3 detect if handler is registered or a custom handlerN( R t namet None( t handler( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _is_handler_registeredB s c C� s t S( s
dummy function patched into handler.needs_update() by _CryptConfig
when hash alg has been deprecated for context.
( t True( t hasht secret( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _always_needs_updateF s t truncate_errorsa The CryptPolicy class has been deprecated as of Passlib 1.6, and will be removed in Passlib 1.8. c B� s e Z d Z e d d d � � Z e d d d � � Z e e d � � Z e e d � � Z d � Z d Z e Z
d � Z d � Z d
� Z e d � Z d d e d � Z d d
� Z d d � Z d d � Z e e d � Z e d � Z d d � Z d d d � Z RS( s
.. 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
t passlibs utf-8c C� s3 t t d t d d �| d t j | | | � � S( sW 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.
s� Instead of ``CryptPolicy.from_path(path)``, use ``CryptContext.from_path(path)`` or ``context.load_path(path)`` for an existing CryptContext.t
stackleveli t _internal_context( R t _preamblet DeprecationWarningR t from_path( t clst patht sectiont encoding( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR< � s
c C� s3 t t d t d d �| d t j | | | � � S( sU 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.
s� Instead of ``CryptPolicy.from_string(source)``, use ``CryptContext.from_string(source)`` or ``context.load(source)`` for an existing CryptContext.R8 i R9 ( R R: R; R t from_string( R= t sourceR? R@ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRA � s
c � s� | r t t d t d d �n t � t � r3 � St � t � rU | d t � � � St � t t f � s� t d t
� � f � � nX t � f d � d D� � s� � j d � r� | d t j
� � � S| d t j � � � Sd S(
s� 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`.
s� Instead of ``CryptPolicy.from_source()``, use ``CryptContext.from_string(path)`` or ``CryptContext.from_path(source)``, as appropriate.R8 i R9 sA source must be CryptPolicy, dict, config string, or file path: %rc 3� s | ] } | � k Vq d S( N( ( t .0t c( RB ( s3 /usr/lib/python2.7/site-packages/passlib/context.pys <genexpr>� s s
s ./\;:N( R R: R; t
isinstanceR t dictR t bytesR t TypeErrort typet anyt stripRA R< ( R= RB t _warn( ( RB s3 /usr/lib/python2.7/site-packages/passlib/context.pyt from_source� s ,c C� s� | r t t d t d d �n t | � d k rA t d � � n t | � d k rj | j | d d t �Si } x9 | D]1 } | j | j | d t �j j d t
� � qw W| d t | � � S(
s� 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`.
sw Instead of ``CryptPolicy.from_sources()``, use the various CryptContext constructors followed by ``context.update()``.R8 i i s no sources specifiedi RL t resolveR9 ( R R: R; t lenR% RM t Falset updatet _contextt to_dictR2 R ( R= t sourcesRL t kwdsRB ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt from_sources� s
/c O� s� | j r# t t d t d d �n t t d t d d �| g } | rY | j | � n | ro | j | � n t j | d t �S( s� 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.
sX Instead of ``context.policy.replace()``, use ``context.update()`` or ``context.copy()``.R8 i sz Instead of ``CryptPolicy().replace()``, create a CryptContext instance and use ``context.update()`` or ``context.copy()``.RL ( t _stub_policyR R: R; t extendt appendR RV RP ( t selft argsRU RT ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt replace s
c O� s� | j d d � } | r9 | | _ | j d t � | _ no | r� t | � d k r` t d � � n | ru t d � � n | d } n t t d t d d �t
| � | _ d S(
NR9 RW i s% only one positional argument accepteds& cannot specify positional arg and kwdsi s� Instead of constructing a CryptPolicy instance, create a CryptContext directly, or use ``context.update()`` and ``context.load()`` to reconfigure existing CryptContext instances.R8 i ( t popR/ RR RP RW RO RH R R: R; R ( RZ R[ RU t context( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt __init__0 s
c C� sM | j r# t t d t d d �n t t d t d d �t | j j � � S( s� return True if policy defines *any* schemes for use.
.. deprecated:: 1.6
applications should use ``bool(context.schemes())`` instead.
see :meth:`CryptContext.schemes`.
sM Instead of ``context.policy.has_schemes()``, use ``bool(context.schemes())``.R8 i so Instead of ``CryptPolicy().has_schemes()``, create a CryptContext instance and use ``bool(context.schemes())``.( RW R R: R; t boolRR t schemes( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt has_schemesI s
c C� sS | j r# t t d t d d �n t t d t d d �| j j d t d t � S( s� return iterator over handlers defined in policy.
.. deprecated:: 1.6
applications should use ``context.schemes(resolve=True))`` instead.
see :meth:`CryptContext.schemes`.
sU Instead of ``context.policy.iter_handlers()``, use ``context.schemes(resolve=True)``.R8 i sw Instead of ``CryptPolicy().iter_handlers()``, create a CryptContext instance and use ``context.schemes(resolve=True)``.RN t unconfigured( RW R R: R; RR Ra R2 ( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt
iter_handlers] s
c C� sY | j r# t t d t d d �n t t d t d d �t | j j d | d t � � S( s� return list of schemes defined in policy.
.. deprecated:: 1.6
applications should use :meth:`CryptContext.schemes` instead.
sC Instead of ``context.policy.schemes()``, use ``context.schemes()``.R8 i se Instead of ``CryptPolicy().schemes()``, create a CryptContext instance and use ``context.schemes()``.RN Rc ( RW R R: R; t listRR Ra R2 ( RZ RN ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRa q s
c C� s | j r# t t d t d d �n t t d t d d �y | j j | | d t �SWn! t k
rz | rs � q{ d Sn Xd S( s8 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``.
sG Instead of ``context.policy.get_handler()``, use ``context.handler()``.R8 i si Instead of ``CryptPolicy().get_handler()``, create a CryptContext instance and use ``context.handler()``.Rc N( RW R R: R; RR R0 R2 t KeyErrorR/ ( RZ R. t categoryt required( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt get_handler� s
c C� s t d t d d �d S( sr 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.
sn get_min_verify_time() and min_verify_time option is deprecated and ignored, and will be removed in Passlib 1.8R8 i i ( R R; ( RZ Rg ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt get_min_verify_time� s c C� so | j r# t t d t d d �n t t d t d d �t | d � rU | j } n | j j j | | � d S( sL 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.
s= ``context.policy.get_options()`` will no longer be available.R8 i s< ``CryptPolicy().get_options()`` will no longer be available.R. i ( RW R R: R; t hasattrR. RR t _configt _get_record_options_with_flag( RZ R. Rg ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt get_options� s
c C� sk | j r# t t d t d d �n t t d t d d �t | d � rU | j } n | j j | | � j S( sB 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.
sG ``context.policy.handler_is_deprecated()`` will no longer be available.R8 i sF ``CryptPolicy().handler_is_deprecated()`` will no longer be available.R. ( RW R R: R; Rk R. RR R0 t
deprecated( RZ R. Rg ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt handler_is_deprecated� s
c � s� | j r# t t d t d d �n t t d t d d �| j � | rj � f d � � d � � t } n � j � d � � � � f d � � j j | � D� S( s� iterate over key/value pairs representing the policy object.
.. deprecated:: 1.6
applications should use :meth:`CryptContext.to_dict` instead.
sO Instead of ``context.policy.iter_config()``, use ``context.to_dict().items()``.R8 i sq Instead of ``CryptPolicy().iter_config()``, create a CryptContext instance and use ``context.to_dict().items()``.c � s � j | � j d d � S( Nt __t .( t _render_config_keyR\ ( t key( R^ ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt
render_key� s c S� s+ t | t t f � r' d j | � } n | S( Ns , ( RE Re t tuplet join( R& ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt render_value� s c S� s | S( N( ( R& ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt <lambda>� s c 3� s- | ]# \ } } � | � � | � f Vq d S( N( ( RC Rt R& ( Ru Rx ( s3 /usr/lib/python2.7/site-packages/passlib/context.pys <genexpr>� s ( RW R R: R; RR RP Rs Rl t iter_config( RZ t iniRN ( ( R^ Ru Rx s3 /usr/lib/python2.7/site-packages/passlib/context.pyRz � s
c C� sJ | j r# t t d t d d �n t t d t d d �| j j | � S( s� export policy object as dictionary of options.
.. deprecated:: 1.6
applications should use :meth:`CryptContext.to_dict` instead.
sC Instead of ``context.policy.to_dict()``, use ``context.to_dict()``.R8 i se Instead of ``CryptPolicy().to_dict()``, create a CryptContext instance and use ``context.to_dict()``.( RW R R: R; RR RS ( RZ RN ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRS s
c C� sx | j r# t t d t d d �n t t d t d d �| j j d | � } t rg | j d � } n | j | � d S( s� 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.
sY Instead of ``context.policy.to_file(stream)``, use ``stream.write(context.to_string())``.R8 i s{ Instead of ``CryptPolicy().to_file(stream)``, create a CryptContext instance and use ``stream.write(context.to_string())``.R? s utf-8N( RW R R: R; RR t to_stringR t encodet write( RZ t streamR? t out( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt to_file s
c C� sk | j r# t t d t d d �n t t d t d d �| j j d | � } | rg | j | � } n | S( s� export policy to file.
.. deprecated:: 1.6
applications should use :meth:`CryptContext.to_string` instead.
sG Instead of ``context.policy.to_string()``, use ``context.to_string()``.R8 i si Instead of ``CryptPolicy().to_string()``, create a CryptContext instance and use ``context.to_string()``.R? ( RW R R: R; RR R| R} ( RZ R? R@ R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR| - s
N( t __name__t
__module__t __doc__t classmethodR< RA R2 RM RV R\ R/ RR RP RW R_ Rb Rd Ra Ri Rj Rn Rp Rz RS R� R| ( ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR W s0 9' $ t _CryptConfigc B� s1 e Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d � Z
d � Z d � Z d � Z d � Z i d � Z d � Z i d � Z d � Z e d
� � Z d � Z d � Z d
� Z d � Z d � Z e d e d � � Z d � Z d � Z d d � Z! e" d � Z# e$ d � � Z% e d � Z& RS( s 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``
c C� s; | j | j d � � | j | � | j � | j � d S( NRa ( NNs schemes( t _init_scheme_listt getR/ t
_init_optionst _init_default_schemest
_init_records( RZ RB ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR_ y s
c C� s g } g } t | t � r* t | � } n x� | p6 d D]� } t | d � rh | } | j } t | � n= t | t � r� t | � } | j } n t d t | � � � | | k r� t d | f � � n | j
| � | j
| � q7 Wt | � | _ t | � | _
d S( s, initialize .handlers and .schemes attributesR. s+ scheme must be name or CryptHandler, not %rs$ multiple handlers with same name: %rN( ( RE R R
Rk R. R R RH RI Rf RY Rv R Ra ( RZ t dataR Ra t elemR0 t scheme( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� s*
c C� s | j } | j } i | _ } i | _ } t � } x�t | � D]�\ \ } } } }
| j | � | } | r� | r� | t k r� d } n | rm| | |
� \ } }
| d k r� | t k r� t d | f t � n | d k r� t d t
� n y | | } Wn) t k
r,i i |
| 6| 6| | <q�Xy | | }
Wn" t k
r_i |
| 6| | <q�X|
|
| <qB | r�| d k r�t d � � n | | | |
� \ } }
| d k r�qB n y | | } Wn" t k
r�i |
| 6| | <qB X|
| | <qB W| j d � t t | � � | _ d S( sY load config dict into internal representation,
and init .categories attr
t alls} The '%s' option should be configured per-algorithm, and not set globally in the context; This will be an error in Passlib 2.0s� 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.Ra s4 'schemes' context option is not allowed per categoryt min_verify_timeN( t _norm_scheme_optiont _norm_context_optiont _scheme_optionst _context_optionst setR t addt _global_settingsR R R; Rf t discardR/ Rv t sortedt
categories( RZ RB t norm_scheme_optiont norm_context_optiont scheme_optionst context_optionsR� t catR� Rt R& t explicit_schemet category_mapt
option_map( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � sN
"
c C� sb | t k r" t d | f � � n t | t � rX t j | � } | rX | | � } qX n | | f S( Ns3 %r option not allowed in CryptContext configuration( t _forbidden_scheme_optionsRf RE R t _coerce_scheme_optionsR� ( RZ Rt R& t func( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s c C� s� | j } | d k rx t | d � r0 | j } n$ t | t � sT t | d d � � n | r�| | k r�t d � � q�nA| d k r_t | t � r� t | � } n* t | t t f � s� t | d d � � n d | k r� t
| � d k r\t d � � q\q�| r�xW | D]L } t | t � s3t | d d
� � n | | k r t d | f � � q q Wq�nZ | d k r{t d
t
� n> | d k r�t d t
� n" | d k r�t d | f � � n | | f S( Nt defaultR. t strs" default scheme not found in policyRo s
str or seqt autoi s< cannot list other schemes if ``deprecated=['auto']`` is useds deprecated elements) deprecated scheme not found in policy: %rR� s^ 'min_verify_time' was deprecated in Passlib 1.6, is ignored in 1.7, and will be removed in 1.8t
harden_verifysX 'harden_verify' is deprecated & ignored as of Passlib 1.7.1, and will be removed in 1.8Ra s unknown CryptContext keyword: %r( Ra Rk R. RE R R Rf R
Re Rv RO R% R R; ( RZ R� Rt R& Ra R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s@
c C� s | j j | | � S( s return dict mapping category->value for specific context option.
.. warning:: treat return value as readonly!
( R� R� ( RZ Rt t _default( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt get_context_optionmap% s c C� s� y | j | } Wn t k
r+ d t f SX| j d � } | r� y | | } Wn t k
rb q� X| d k s{ | | k r� | t f Sn | t f S( s� return value of specific option, handling category inheritance.
also returns flag indicating whether value is category-specific.
N( R� Rf R/ RP R� R2 ( RZ Rg Rt R� R& t alt( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt get_context_option_with_flag, s
c C� s, y | j | | SWn t k
r' | SXd S( ss return all options for (scheme,category) combination
.. warning:: treat return value as readonly!
N( R� Rf ( RZ R� Rg R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _get_scheme_optionmapB s
c C� s | j | j j | � S( N( R Ra t index( RZ R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt get_base_handlerL s c C� s/ | j } d | j k r+ | t j j 7} n | S( Nt rounds( t setting_kwdst uht HasRoundst using_rounds_kwds( R0 R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt expand_settingsO s c
C� s1 | j } | d d � j � } t } | rO | j � } | j | d | � � n | j | j | � � } x* t | � j | � D] } | j | � q} W| r� x- t | � j | � D] } | j | � q� Wn | | d � } | j | � | r'| j | � | j | | | � � | | k r't
} q'n | | f S( s� 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� N( R� R/ t copyRP RQ R� R� R� t
differenceR] R2 (
RZ R� Rg t
get_optionmapRU t has_cat_optionst defkwdst allowed_settingsRt t other( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt get_scheme_options_with_flagX s(
c C� s_ | j } | d � j � } | _ | d � } | j } | sA d S| j d � pS d } | j d � } | s� xR | D] } | | k rr | | d <Pqr qr Wt d � � n | | k r� t d � � n x� | j D]� } | j | | � } | j | | � }
|
s8xZ | D] } | | k r| | | <PqqWt d | � � q� |
| k r� t d | � � q� q� Wd S( s� 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� Ro Ns, must have at least one non-deprecated schemes# default scheme cannot be deprecateds< must have at least one non-deprecated scheme for %r categorys3 default scheme for %r category cannot be deprecated( ( R� R� t _default_schemesRa R� R/ R% R� ( RZ R� t default_mapt dep_mapRa t depsR� R� R� t cdepst cdefault( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s:
c C� sI | j } y | | SWn t k
r( n X| j sA t d � � n | d S( s+ return default scheme for specific categorys9 no hash schemes configured for this CryptContext instanceN( R� Rf Ra R/ ( RZ Rg t defaults( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt default_scheme� s
c � sw � j d � � � � � f d � } | d � p3 t } | rm | | � } | d k rm | | k rm | t f Sn | t f S( s/ is scheme deprecated under particular category?Ro c � sX � j | � j d � � } | d k r+ d Sd | k rJ � � j | � k S� | k Sd S( NR� ( R� R/ R� ( R� RB ( t depmapR� RZ ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt test� s N( R� R/ RP R2 ( RZ R� Rg R� R& R� ( ( R� R� RZ s3 /usr/lib/python2.7/site-packages/passlib/context.pyt is_deprecated_with_flag� s
c
C� s� i | _ i } | _ t � } | _ | j } d | j } x� | j D]y } | j } | j | j � xW | D]O } | | | � \ } } | d k s� | rl | j
| | | � | | | f <ql ql WqF Wd S( N( N( t
_record_listst _recordsR� t context_kwdsRm R/ R� R R. RQ t _create_record(
RZ t recordst all_context_kwdsRn R� R0 R� R� RU R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s
c K� s� y | j d t | � } Wnt t k
r� } t j d t | � � } | r� | j d � | k r� | j d � } t d | j | f � � n � n X| | _ | | _
| S( Nt relaxeds& .* unexpected keyword argument '(.*)'$i s' keyword not supported by %s handler: %r( t usingR2 RH t ret matchR� t groupRf R. t _Context__orig_handlerRo ( R0 Rg Ro t settingst subclst errt mRt ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s c C� s\ | j | | � \ } } | j | | � \ } } | rC t | d <n | rR t } n | | f S( s� 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.
Ro ( R� R� R2 ( RZ R� Rg RU R� R& t
not_inherited( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRm � s
c C� sX y | j | | f SWn t k
r( n X| d k r� t | t � r� t rs t | t � rs | j | | j d � � St | d d � � n | d k r� t | t � r� t | d d � � n | s� | j
| � } | j | | � } | j d | f <| S| rAy/ | j } | | d f } | | | f <| SWqAt k
r=qAXn t d | f � � d S( s5 return record for specific scheme & category (cached)s utf-8s str or NoneRg R� s' crypt algorithm not found in policy: %rN( R� Rf R/ RE R R R t
get_recordR} R R� ( RZ R� Rg R� t recordt cache( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� s.
c C� sZ y | j | SWn t k
r" n Xg | j D] } | j | | � ^ q- } | j | <| S( sx return list of records for category (cached)
this is an internal helper used only by identify_record()
( R� Rf Ra R� ( RZ Rg R� R& ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _get_record_listC s
0c C� s� t | t � s! t | d � � n x* | j | � D] } | j | � r1 | Sq1 W| sX d S| j sp t d � � n t d � � d S( s? internal helper to identify appropriate custom handler for hashR3 s no crypt algorithms supporteds hash could not be identifiedN( RE R R R� t identifyR/ Ra Rf R% ( RZ R3 Rg Rh R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt identify_recordU s c C� s7 x$ | j d � D] } | j r | Sq Wt d � � d S( NsL no disabled hasher present (perhaps add 'unix_disabled' to list of schemes?)( R� R/ t is_disabledt RuntimeError( RZ R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt disabled_recordm s c c� sc | j } | j } t | � } t | � } d | k rF | j d � n | rU | j n | j } | rx d t | � f Vn x� d | j D]� } xf | D]^ } y | | | } Wn t k
r� q� Xt
| t � r� t | � } n | d | f | f Vq� Wxc | D][ } y | | | }
Wn t k
r'q� Xx, t |
� D] } | | | f |
| f Vq5Wq� Wq� Wd S( s� 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.
Ra N( NNs schemes( N( R� R� R� t removeR Ra R/ Re R� Rf RE ( RZ RN R� R� t scheme_keyst context_keysR& R� Rt R� RU ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRz x s2
N(' R� R� R� R/ R� R� R Ra R� R� R� R� R� R_ R� R� R� R� R� R� R� R� t staticmethodR� R� R� R� R� R� RP R� Rm R� R� R2 R� R R� Rz ( ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� J sB & I +
+ + + c B� s e Z d Z d> Z d> Z d> Z e d � � Z e d d d � � Z e d d d � � Z
d � Z d � Z d � Z
d> e e d � Z d
� Z d � Z d � Z e e e d
d �Z e d � � Z e d d d � Z e d d d � Z e d � � Z d � Z e d> e d � Z d> e e d � Z d> d> e d � Z d � Z e d � � Z! e d � � Z" e d � � Z# e d � Z$ d � Z% d d � Z& d Z' d Z( d Z) d! Z* d> Z+ d" Z, d# � Z- d> d> d$ � Z. d% � Z/ d> d> d> d& � Z0 e1 d' d( d) d* d+ d, � d> d> d- � � Z2 e1 d' d. d) d* � d> d> d/ � � Z3 e1 d' d. d) d* � d> d> d0 � � Z4 d> e e e d1 � Z5 d> d> d2 � Z6 e1 d' d. d) d* d+ d3 � d4 � � Z7 d> d> d5 � Z8 d> d> d6 � Z9 d7 Z: e; d8 � � Z< d9 � Z= d" d: � Z> d; � Z? d> d< � Z@ d= � ZA RS(? s- 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.
c C� sJ t | t � r | | � St | | � r, | S| � } | j | � | Sd S( s2 internal helper - accepts string, dict, or contextN( RE RF t load( R= RB RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _norm_source� s
R7 s utf-8c C� sP t | t � s$ t | d d � � n | d t � } | j | d | d | �| S( s� 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.
s unicode or bytesRB t _autoloadR? R@ ( RE R R RP R� ( R= RB R? R@ RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRA � s
!c C� s, | d t � } | j | d | d | �| S( s 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.
R� R? R@ ( RP t load_path( R= R> R? R@ RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR< s c K� s< t d t � } | j | � | r8 | j | d t �n | S( s6 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`
R� RQ ( R RP R� R2 ( RZ RU R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� + s
c K� s
| j | � S( sG
alias for :meth:`copy`, to match PasswordHash.using()
( R� ( RZ RU ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� Q s c K� s t d t d d �| j | � S( s deprecated alias of :meth:`copy`s� CryptContext().replace() has been deprecated in Passlib 1.6, and will be removed in Passlib 1.8, it has been renamed to CryptContext().copy()R8 i ( R R; R� ( RZ RU ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR\ W s
c K� s� | d k r | | d <n | t k r� t d t � | d k rN | j | � q� t | t � r} | j | j � | j | � q� t d � � n | r� | j | � n d S( NRa s� 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.s% policy must be a CryptPolicy instance(
R/ t _UNSETR R; R� RE R RR RQ RH ( RZ Ra t policyR� RU ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR_ b s
c C� s d t | � S( Ns <CryptContext at 0x%0x>( t id( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt __repr__� s c C� s t d | j � d t � S( NR9 RW ( R R� R2 ( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _get_policy� s c C� sE t d t d d �t | t � r5 | j | j � n t d � � d S( Ns� 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.R8 i s expected CryptPolicy instance( R R; RE R R� RR RH ( RZ R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _set_policy� s
t docsC [deprecated] returns CryptPolicy instance tied to this CryptContextc C� sE t � } t r" | j | | � n | j | | � t | j | � � S( s< helper read INI from stream, extract passlib section as dict( R R t read_filet readfpRF t items( R R? t filenamet p( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _parse_ini_stream� s
c � s� � � � � f d � } t rI t � d d | �� } | | � SWd QXnw | d k rz t � d � � } | | � SWd QXnF t � d � �5 } | j � j | � j d � } | t | � � SWd QXd S( s� 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 | � � � } � j | d � �S( NRQ ( R� R� ( R RU ( R> R? RZ RQ ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt helper� s t rtR@ Ns utf-8t asciit rb( s utf-8s ascii( R t opent readt decodeR} R ( RZ R> RQ R? R@ R� R t fht tmp( ( R> R? RZ RQ s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s c � s� t } t | t � rl t r3 t | | d d �} n t | d d | d d �} | j t | � | d � } nW t | t � r� t | j
j d t � � } t } n$ t
| d � s� t | d d � � n | r� | j � t � f d � t | � D� � } n | rG| j
d
k rG| sd
S| } t | j
j d t � � } | j | � n t | � } | | _
| j � | j | _ | j | _ | j r�| j j d d
� n d
| _ d
S( s� 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 decode bytes from string.
Defaults to ``"utf-8"``. Ignoring when loading from a dictionary.
: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
t paramRB s utf-8t source_encodings& <string passed to CryptContext.load()>RN R� s string or dictc 3� s' | ] \ } } � | � | f Vq d S( N( ( RC Rt R& ( t parse( s3 /usr/lib/python2.7/site-packages/passlib/context.pys <genexpr>* s Nt _strip_unused_context_kwds( R2 RE R R R R R� R R RF Rl Rz RP Rk R t _parse_config_keyR R/ RQ R� t _reset_dummy_verifyR� t _get_recordR� t _identify_recordR� t __dict__R] R ( RZ RB RQ R? R@ t
parse_keysR t config( ( R s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s> <
c C� s< | j d d � j d � } t | � } | d k rN d
d
| d } } } nR | d k ro d
} | \ } } n1 | d k r� | \ } } } n t d | f � � | d k r� d
} n& | r� | d
k r� t d | � � n | d
k r� d
} n& | r| d
k rt d | � � n | s/t d | � � n | | | f S( s> helper used to parse ``cat__scheme__option`` keys into a tupleRr Rq i i i i s) keys must have less than 3 separators: %rR� s empty category: %rR^ s empty scheme: %rs empty option: %rN( R\ t splitRO R/ RH ( t ckeyt partst countR� R� Rt ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR D s,
c O� sv | rV t | � d k r' t d � � n | r< t d � � n | j | d d t �n | rr | j | d t �n d S( s� 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`
i s( expected at most one positional arguments. positional arg and keywords mutually exclusivei RQ N( RO RH R� R2 ( RZ R[ RU ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRQ b s c � s: � j j } | r2 t � � � f d � | D� � S| Sd S( s; 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 � �Vq d S( Rc N( R0 ( RC R� ( Rg RZ Rc ( s3 /usr/lib/python2.7/site-packages/passlib/context.pys <genexpr>� s N( Rl Ra Rv ( RZ RN Rg Rc Ra ( ( Rg RZ Rc s3 /usr/lib/python2.7/site-packages/passlib/context.pyRa � s
c C� s) | j d | d | �} | r" | S| j S( sh 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`.
Rc N( R0 R/ R. ( RZ Rg RN Rc t hasher( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� � s c C� sm y' | j | | � } | r" | j S| SWn t k
r: n X| j j r] t d | f � � n t d � � d S( s� 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`.
s; crypt algorithm not found in this CryptContext instance: %rs8 no crypt algorithms loaded in this CryptContext instanceN( R R� Rf Rl R ( RZ R� Rg Rc R ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR0 � s &
c C� s t d � | j j D� � S( sC check if any handlers in this context aren't in the global registryc s� s! | ] } t | � s | Vq d S( N( R1 ( RC R0 ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pys <genexpr>- s ( Rv Rl R ( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _get_unregistered_handlers+ s c C� s
| j j S( s�
return :class:`!set` containing union of all :ref:`contextual keywords <context-keywords>`
supported by the handlers in this context.
.. versionadded:: 1.6.6
( Rl R� ( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� 0 s c C� sH | \ } } } | r, d | | p$ d | f S| r@ d | | f S| Sd S( s* convert 3-part config key to single strings
%s__%s__%sR^ s %s__%sN( ( Rt R� R� t option( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRs = s c C� s� t | t t f � r' d j | � } n_ t | t � r� t | t � rw | d d k rw | rn d | j d � n d } q� t | � } n | j d d � S( s, render value to string suitable for INI files , i R, s %.2ft 0R s %%( RE Re Rv Rw R R" R# R� R\ ( Rt R& ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _render_ini_valueH s "c � s/ | j � t � f d � | j j | � D� � S( sg 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' | ] \ } } � | � | f Vq d S( N( ( RC Rt R& ( Ru ( s3 /usr/lib/python2.7/site-packages/passlib/context.pys <genexpr>} s ( Rs RF Rl Rz ( RZ RN ( ( Ru s3 /usr/lib/python2.7/site-packages/passlib/context.pyRS ] s c C� sq | j } | j } | j | � xK | j j � D]: \ } } | | | � } | | � } | j | | | � q/ Wd S( s( helper to write to ConfigParser instanceN( Rs R t add_sectionRl Rz R� ( RZ t parserR? Ru Rx t kt v( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _write_to_parser� s
c C� s� t � } | j | | � t � } | j | � | j � } | rh | j d d j d � | D� � � n | j � } t s� | j d � } n | S( sH 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.
s� # NOTE: the %s handler(s) are not registered with Passlib,
# this string may not correctly reproduce the current configuration.
s , c s� s | ] } t | j � Vq d S( N( t reprR. ( RC R0 ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pys <genexpr>� s s utf-8( R R R R~ R Rw t getvalueR R� ( RZ R? R t buft unregisteredR� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR| � s
i i
i g{�G�z�?i c C� s | j � d S( N( R ( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt reset_min_verify_time� s c C� sK | r7 t | t � s' t | d � � n | j | | � S| j | | � Sd S( sC return record based on scheme, or failing that, by identifying hashR3 N( RE R R R R ( RZ R3 R� Rg ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _get_or_identify_record� s
c C� sG | s
d S| j j j | j � } x | D] } | j | d � q) Wd S( sf
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( Rl R� R� R] R/ ( RZ RU R� t unused_kwdsRt ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR � s
c C� sM | d k r t d t � n | j | | | � } | j pL | j | d | �S( s� 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.
sq CryptContext.needs_update(): 'scheme' keyword is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0R4 N( R/ R R; R Ro t needs_update( RZ R3 R� Rg R4 R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR" � s
;
Ro s 1.6t removeds 2.0t replacements CryptContext.needs_update()c C� s | j | | | � S( s 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" ( RZ R3 R� Rg ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt hash_needs_updateA s s 1.7c K� s> | j | | � } | j } | r1 | | | � n | j | � S( s� 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 t genconfig( RZ R� Rg R� R� t strip_unused( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR& L s
c K� sG | j | | | � } | j } | r4 | | | � n | j | | | � S( s� 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 t genhash( RZ R4 R R� Rg RU R� R' ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR( [ s
c C� sJ | j | | | � } | d k r% d S| r? | r8 | j S| Sn | j Sd S( s� 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/ R� R. ( RZ R3 Rg RN Rh Rc R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR� j s " c K� s] | d k r t d t � n | j | | � } | j } | rM | | | � n | j | | � S( sZ 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
si CryptContext.hash(): 'scheme' keyword is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0N( R/ R R; R R R3 ( RZ R4 R� Rg RU R� R' ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR3 � s +
s CryptContext.hash()c O� s | j | | � S( s
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.
( R3 ( RZ R[ RU ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt encrypt� s
c K� s} | d k r t d t � n | d k r6 | j � t S| j | | | � } | j } | rj | | | � n | j | | | � S( s� 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
sk CryptContext.verify(): 'scheme' keyword is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0N( R/ R R; t dummy_verifyRP R R t verify( RZ R4 R3 R� Rg RU R� R' ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR+ � s ;
c K� s� | d k r t d t � n | d k r< | j � t d f S| j | | | � } | j } | r� | r� | j � } | | | � n | } | j | | | � s� t d f S| j s� | j
| d | �r� t | j | d | | �f St d f Sd S( s�
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.
sk CryptContext.verify(): 'scheme' keyword is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0R4 Rg N(
R/ R R; R* RP R R R� R+ Ro R" R2 R3 ( RZ R4 R3 R� Rg RU R� R' t
clean_kwds( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt verify_and_update( s" @
s too many secretsc C� s | j | j � S( s>
precalculated hash for dummy_verify() to use
( R3 t
_dummy_secret( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt _dummy_hash� s c C� s t | � j j | � d S( s>
flush memoized values used by dummy_verify()
N( RI R/ t clear_cache( RZ ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR � s c C� s | j | j | j � t S( s�
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
( R+ R. R/ RP ( RZ t elapsed( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR* � s c C� s | j | d � j S( sn
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/ R� ( RZ R3 ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt
is_enabled� s
c C� s | j j } | j | � S( s�
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.
( Rl R� t disable( RZ R3 R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR3 � s c C� s0 | j | d � } | j r( | j | � S| Sd S( s�
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/ R� t enable( RZ R3 R� ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR4 � s
N(B R� R� R� R/ Rl R R R� R� RA R< R� R� R\ R� R2 R_ R� R� R� t propertyR� R� R� RP R� R� R RQ Ra R� R0 R R� Rs R RS R R| t mvt_estimate_max_samplest mvt_estimate_min_samplest mvt_estimate_max_timet mvt_estimate_resolutionR� R� R R R R" R R% R& R( R� R3 R) R+ R- R. R R/ R R* R2 R3 R4 ( ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR � s� & &
o E 15
#
=
E
,8$ Ma c B� s2 e Z d Z d Z d d � Z d � Z d � Z RS( s� 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
c K� s& | d k r | | d <n | | _ d S( NRa ( R/ t
_lazy_kwds( RZ Ra RU ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR_ (
s
c C� s� | j } d | k rd t d t � | j d � } | | � } t j | d t �} | j j � } n* d | k r� | j d � } | | � } n | ` t t
| � j | � t | _
d S( Nt
create_policys� 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.RL t onload( R: R R; R] R RM RP RR RS t superR R_ R t __class__( RZ RU R; t resultR� R< ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt
_lazy_init-
s c C� sK | j d � s | j d � r; | j d k r; | j � n t j | | � S( Nt _Rq ( t
startswithR: R/ R@ t objectt __getattribute__( RZ t attr( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyRD @
s
N( R� R� R� R/ R: R_ R@ RD ( ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyR � s
2 (A R� t
__future__R R� t loggingt getLoggerR� t logt threadingt timet warningsR t passlib.excR R R t passlib.registryR R t
passlib.utilsR R� R R R
R R R
R t passlib.utils.binaryR t passlib.utils.compatR R R R R R R R R R R t passlib.utils.decorR R t __all__RC R� R' R� R� RF R$ R� R1 R� R/ R5 R� R: R R� R R ( ( ( s3 /usr/lib/python2.7/site-packages/passlib/context.pyt <module> sT :L � �� � g� � � � � C
Mini Shell