diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-06-29 13:57:35 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-06-29 13:57:35 -0400 |
| commit | 62991573b68a5db0815db0f48532ef967380422e (patch) | |
| tree | f2801320703c9de2d1bcffc37f8eeb2af086da4e /docs/overview.rst | |
| parent | 83440e9240061d538c2daed6ec9e38171be66e4f (diff) | |
| download | passlib-62991573b68a5db0815db0f48532ef967380422e.tar.gz | |
updated changelog to include python 3 compat; various other documentation updates
Diffstat (limited to 'docs/overview.rst')
| -rw-r--r-- | docs/overview.rst | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/docs/overview.rst b/docs/overview.rst index 4d83ad5..c9aad2c 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -2,15 +2,20 @@ Library Overview ================ -PassLib is a collection of routines for managing password hashes -as found in unix /etc/shadow files, as returned by stdlib `crypt()`, +Passlib is a collection of routines for managing password hashes +such as found in unix "shadow" files, as returned by stdlib's :func:`!crypt`, as stored in mysql and postgres, and various other places. -PassLib's contents can be roughly grouped into three categories: +Passlib's contents can be roughly grouped into three categories: password hashes, password contexts, and utility functions. +.. note:: + + New applications which just need drop-in password hashing support + should see the :doc:`new_app_quickstart`. + Password Hashes =============== -All of the hash schemes supported by passlib are implemented +All of the hash schemes supported by Passlib are implemented as classes importable from the :mod:`passlib.hash` module. All of these classes support a single uniform interface of standard class methods. These methods are documented in detail by the :ref:`password hash api <password-hash-api>`. @@ -74,16 +79,9 @@ A quick example of how a password context can be used:: >>> lc.verify('password', 'q1Oyx5r9mdGZ2') True -.. note:: - - For new applications which just need drop-in support for some manner - of password encryption, so they can secure store passwords - and then forget about it, they should use - the :data:`passlib.apps.custom_app_context` object. - Predefined Password Contexts ============================ -In addition to the :mod:`passlib.context` module, +In addition to the :mod:`!passlib.context` module, PassLib provides a number of pre-configured :class:`!CryptContext` instances in order to get users started quickly: |