diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-03-22 19:18:14 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-03-22 19:18:14 -0400 |
| commit | cce3a27b515c15410512bc7fbf7ddd6b2ff2af44 (patch) | |
| tree | c0f998a5404dd29389b387202a3554b0fe3fc8c9 /docs | |
| parent | bdc2cb5e4fb61829547ad5122b15853bc1f4c019 (diff) | |
| download | passlib-cce3a27b515c15410512bc7fbf7ddd6b2ff2af44.tar.gz | |
split passlib.base into passlib.registry & passlib.context - the two have little to do with eachother
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/lib/passlib.context.rst (renamed from docs/lib/passlib.base.rst) | 7 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.hex_digests.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.ldap_digests.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.plaintext.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.unix_fallback.rst | 2 | ||||
| -rw-r--r-- | docs/overview.rst | 2 | ||||
| -rw-r--r-- | docs/password_hash_api.rst | 2 |
7 files changed, 11 insertions, 8 deletions
diff --git a/docs/lib/passlib.base.rst b/docs/lib/passlib.context.rst index 9c09eb2..138452e 100644 --- a/docs/lib/passlib.base.rst +++ b/docs/lib/passlib.context.rst @@ -1,8 +1,11 @@ ============================================= -:mod:`passlib.base` - Crypt Contexts +:mod:`passlib.context` - CryptContext class ============================================= -.. module:: passlib.base +.. module:: passlib.context + +The :mod:`!passlib.base` module contains a number of core + .. autoclass:: CryptContext diff --git a/docs/lib/passlib.hash.hex_digests.rst b/docs/lib/passlib.hash.hex_digests.rst index cbd1b1a..9bc3653 100644 --- a/docs/lib/passlib.hash.hex_digests.rst +++ b/docs/lib/passlib.hash.hex_digests.rst @@ -14,7 +14,7 @@ PassLib provides wrappers for few of the common hashes. Usage ===== These classes all wrap the underlying hashlib implementations, -and are mainly useful only for plugging them into a :class:`passlib.base.CryptContext`. +and are mainly useful only for plugging them into a :class:`~passlib.context.CryptContext`. However, they can be used directly as follows:: >>> from passlib.hash import hex_sha1 as hs diff --git a/docs/lib/passlib.hash.ldap_digests.rst b/docs/lib/passlib.hash.ldap_digests.rst index 7b9f418..a0730b7 100644 --- a/docs/lib/passlib.hash.ldap_digests.rst +++ b/docs/lib/passlib.hash.ldap_digests.rst @@ -17,7 +17,7 @@ are very insecure, and should not be used except when required. Usage ===== These classes all wrap the underlying hashlib implementations, -and are mainly useful only for plugging them into a :class:`passlib.base.CryptContext`. +and are mainly useful only for plugging them into a :class:`~passlib.context.CryptContext`. However, they can be used directly as follows:: >>> from passlib.hash import ldap_salted_md5 as lsm diff --git a/docs/lib/passlib.hash.plaintext.rst b/docs/lib/passlib.hash.plaintext.rst index d0ad62d..d8ad3ac 100644 --- a/docs/lib/passlib.hash.plaintext.rst +++ b/docs/lib/passlib.hash.plaintext.rst @@ -11,7 +11,7 @@ existing applications. *It should not be used* for any other purpose. Usage ===== -This class is mainly useful only for plugging into a :class:`passlib.base.CryptContext`. +This class is mainly useful only for plugging into a :class:`~passlib.context.CryptContext`. When used, it should always be the last scheme in the list, as it will recognize all hashes. It can be used directly as follows:: diff --git a/docs/lib/passlib.hash.unix_fallback.rst b/docs/lib/passlib.hash.unix_fallback.rst index d534546..982e55f 100644 --- a/docs/lib/passlib.hash.unix_fallback.rst +++ b/docs/lib/passlib.hash.unix_fallback.rst @@ -10,7 +10,7 @@ password fields as found in unix ``/etc/shadow`` files. Usage ===== -This class is mainly useful only for plugging into a :class:`passlib.base.CryptContext`. +This class is mainly useful only for plugging into a :class:`~passlib.context.CryptContext`. When used, it should always be the last scheme in the list, as it is designed to provide a fallback behavior. It can be used directly as follows:: diff --git a/docs/overview.rst b/docs/overview.rst index 8102020..c9ce82a 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -52,7 +52,7 @@ deprecated schemes, hashes using strong schemes but weak individual configuratio and other border cases. PassLib provides an advanced support framework, based around -the :doc:`CryptContext <lib/passlib.base>` class, which takes care of +the :doc:`CryptContext <lib/passlib.context>` class, which takes care of many of these issues. Each :class:`!CryptContext` instance can be configured with a list of known hashes, as well as configuration of policy requirements such as which hash is the default, which ones are deprecated, and other features. diff --git a/docs/password_hash_api.rst b/docs/password_hash_api.rst index b932096..37e36fc 100644 --- a/docs/password_hash_api.rst +++ b/docs/password_hash_api.rst @@ -34,7 +34,7 @@ The `optional informational attributes`_ Usage ===== -While most uses of PassLib are done through a :class:`~passlib.base.CryptContext` class, +While most uses of PassLib are done through a :class:`~passlib.context.CryptContext` class, the various :class:`!PasswordHash` classes can be used directly to manipulate passwords:: |
