diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-05-04 13:57:48 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-05-04 13:57:48 -0400 |
| commit | 8c5671863c451a82af573a8b320ecd921538d374 (patch) | |
| tree | 6e15077d8f212d0a371985686dd1a0200b289662 /docs/lib | |
| parent | 44dff15028f381077435792337690bcf10938dd0 (diff) | |
| download | passlib-8c5671863c451a82af573a8b320ecd921538d374.tar.gz | |
various documentation updates
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/passlib.apps.rst | 13 | ||||
| -rw-r--r-- | docs/lib/passlib.context.rst | 7 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.pbkdf2_digest.rst | 4 |
3 files changed, 15 insertions, 9 deletions
diff --git a/docs/lib/passlib.apps.rst b/docs/lib/passlib.apps.rst index 56ab1da..3d97cda 100644 --- a/docs/lib/passlib.apps.rst +++ b/docs/lib/passlib.apps.rst @@ -143,20 +143,23 @@ PostgreSQL Roundup ======= -The `Roundup Issue Tracker <http://www.roundup-tracker.org>` has long +The `Roundup Issue Tracker <http://www.roundup-tracker.org>`_ has long supported a series of different methods for encoding passwords. +The following contexts are available for reading Roundup password hash fields: .. data:: roundup10_context This object should recognize all password hashes used by Roundup: - :class:`ldap_hex_sha1` (the default), :class:`ldap_hex_md5`, :class:`ldap_des_crypt`, - and :class:`roundup_plaintext`. + :class:`~passlib.hash.ldap_hex_sha1` (the default), + :class:`~passlib.hash.ldap_hex_md5`, :class:`~passlib.hash.ldap_des_crypt`, + and :class:`~passlib.hash.roundup_plaintext`. .. data:: roundup15_context As of 2011-04-28, the next release of Roundup will add support - for :class:`ldap_pbkdf2_sha1`. This context supports all the :data:`roundup10_context` - hashes, but adds this hash as well (as uses it as the default). + for :class:`~passlib.hash.ldap_pbkdf2_sha1`. This context supports + all the :data:`roundup10_context` hashes, but adds this hash as well + (and uses it as the default). .. note:: diff --git a/docs/lib/passlib.context.rst b/docs/lib/passlib.context.rst index ecc795e..1f40571 100644 --- a/docs/lib/passlib.context.rst +++ b/docs/lib/passlib.context.rst @@ -9,6 +9,8 @@ .. module:: passlib.context :synopsis: CryptContext class for managing multiple password hash schemes +Motivation +========== Though there is a wide range of password hashing schemes, within a specific context (like a linux "shadow" file) only a select list of schemes will be used. @@ -28,10 +30,13 @@ Passlib also offers a number of predefined :class:`!CryptContext` instances which can be used out-of-the box (see :mod:`passlib.apps` and :mod:`passlib.hosts`), or :ref:`modified <using-predefined-contexts>` to suit the application. +Subtopics +========= New users should see the usage examples -to get a feel for how the :class:`!CryptContext` class works. +in the next section to get a feel for how the :class:`!CryptContext` class works. .. toctree:: + :maxdepth: 1 passlib.context-usage passlib.context-interface diff --git a/docs/lib/passlib.hash.pbkdf2_digest.rst b/docs/lib/passlib.hash.pbkdf2_digest.rst index fac5ca9..a87a338 100644 --- a/docs/lib/passlib.hash.pbkdf2_digest.rst +++ b/docs/lib/passlib.hash.pbkdf2_digest.rst @@ -2,7 +2,7 @@ :samp:`passlib.hash.pbkdf2_{digest}` - Generic PBKDF2 Hashes =============================================================== -.. index:: pbkdf2 hash; generic mcf +.. index:: pbkdf2 hash; generic mcf .. currentmodule:: passlib.hash @@ -42,8 +42,6 @@ Interface .. autoclass:: pbkdf2_sha512() -.. rst-class:: html-toggle - Format & Algorithm ================== An example :class:`!pbkdf2_sha256` hash (of ``password``):: |