diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-03-23 13:22:27 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-03-23 13:22:27 -0400 |
| commit | 80eb568ade54f66406f6a663dee0fc3d3edb35e9 (patch) | |
| tree | 0842aaf5992070e1fe648dcfba14eb7f8c93d338 /docs | |
| parent | 06dffad24619c563845fe85cbe7e498290d1a92a (diff) | |
| download | passlib-80eb568ade54f66406f6a663dee0fc3d3edb35e9.tar.gz | |
misc doc changes
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contents.rst | 11 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.rst | 2 | ||||
| -rw-r--r-- | docs/password_hash_api.rst | 13 |
4 files changed, 20 insertions, 8 deletions
diff --git a/docs/contents.rst b/docs/contents.rst index 5212855..0388691 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -8,12 +8,15 @@ Table Of Contents install overview - password_hash_api - lib/passlib.hash - lib/passlib.base + lib/passlib.context + lib/passlib.apps lib/passlib.apache lib/passlib.hosts - lib/passlib.servers + + password_hash_api + lib/passlib.hash + lib/passlib.registry + lib/passlib.utils history diff --git a/docs/index.rst b/docs/index.rst index 45efdf1..849df09 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ PassLib is a library for encrypting, verifying, and managing password hashes. It supports over 20 current and historical password hash schemes. It can be used for a variety of purposes: -* cross-platform replacement for stdlib's ``crypt()``. +* cross-platform replacement for stdlib's :func:`!crypt`. * encrypting & verifying most known hash formats used by: - Linux & BSD shadow files - Apache htpasswd & htdigest files diff --git a/docs/lib/passlib.hash.rst b/docs/lib/passlib.hash.rst index b7a9479..27bcb4b 100644 --- a/docs/lib/passlib.hash.rst +++ b/docs/lib/passlib.hash.rst @@ -3,7 +3,7 @@ ============================================ .. module:: passlib.hash - :synopsis: package containing all builtin password hashes + :synopsis: all password hashes provided by PassLib This module contains classes implementing each of the password hashes built into passlib. As well, any external hashes registered using :func:`register_crypt_handler` diff --git a/docs/password_hash_api.rst b/docs/password_hash_api.rst index 37e36fc..878a081 100644 --- a/docs/password_hash_api.rst +++ b/docs/password_hash_api.rst @@ -26,7 +26,7 @@ The `application interface`_ The `crypt interface`_ This consists of the :meth:`~PasswordHash.genconfig`, :meth:`~PasswordHash.genhash`. This mimics the standard unix crypt interface, - but is usually used directly by applications. + but is not usually needed by applications. The `optional informational attributes`_ These attributes provide additional information @@ -100,7 +100,7 @@ Required Informational Attributes While each class may support a variety of options, each with their own meaning and semantics, the following keywords should have the same behavior - across all schemes: + across all schemes which use them: ``salt`` If present, this means the algorithm contains some number of bits of salt @@ -141,6 +141,15 @@ Required Informational Attributes this tuple will usually be empty, and references to context keywords can be ignored for all but a few classes. + While each class may support a variety of options, each with their own meaning + and semantics, the following keywords should have the same behavior + across all schemes which use them: + + ``user`` + + If present, the class requires a username be specified whenever + performing a hash calculation (eg: postgres_md5 and oracle10). + .. _application-interface: Application Interface |