diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2016-11-28 12:08:37 -0500 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2016-11-28 12:08:37 -0500 |
| commit | 692a18ce4cddeaeaaec1cfb8bd8bbec263027a8f (patch) | |
| tree | 44f298775aa78c4c1e06a538efb39db373f2d3d6 /docs/lib/passlib.context.rst | |
| parent | 131bb9c477ce273222f8946130fba638407296b5 (diff) | |
| parent | 210537f1210e13f17efa734ea080f1d70d605603 (diff) | |
| download | passlib-692a18ce4cddeaeaaec1cfb8bd8bbec263027a8f.tar.gz | |
Merge with stable
Diffstat (limited to 'docs/lib/passlib.context.rst')
| -rw-r--r-- | docs/lib/passlib.context.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/lib/passlib.context.rst b/docs/lib/passlib.context.rst index 2c95a74..b2f7248 100644 --- a/docs/lib/passlib.context.rst +++ b/docs/lib/passlib.context.rst @@ -23,7 +23,7 @@ The CryptContext Class ====================== .. class:: CryptContext(schemes=None, \*\*kwds) - Helper for encrypting passwords using different algorithms. + Helper for hashing passwords using different algorithms. At its base, this is a proxy object that makes it easy to use multiple :class:`~passlib.ifc.PasswordHash` objects at the same time. @@ -104,7 +104,7 @@ Options which directly affect the behavior of the CryptContext instance: Specifies the name of the default scheme. This option controls which of the configured - schemes will be used as the default when encrypting + schemes will be used as the default when creating new hashes. This parameter is optional; if omitted, the first non-deprecated algorithm in ``schemes`` will be used. You can use the :meth:`~CryptContext.default_scheme` method @@ -400,7 +400,7 @@ For example, a CryptContext could be set up as follows:: ... sha256_crypt__default_rounds=77000, ... staff__sha256_crypt__default_rounds=88000) - >>> # In this case, calling encrypt with ``category=None`` would result + >>> # In this case, calling hash() with ``category=None`` would result >>> # in a hash that used 77000 sha256-crypt rounds: >>> myctx.hash("password", category=None) '$5$rounds=77000$sj3XI0AbKlEydAKt$BhFvyh4.IoxaUeNlW6rvQ.O0w8BtgLQMYorkCOMzf84' @@ -442,7 +442,7 @@ style methods provided by all the :class:`~passlib.ifc.PasswordHash` objects: Hash Migration -------------- -Applications which want to detect and re-encrypt deprecated +Applications which want to detect and regenerate deprecated hashes will want to use one of the following methods: .. automethod:: CryptContext.verify_and_update |