diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-01-06 05:58:11 +0000 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-01-06 05:58:11 +0000 |
| commit | 1d6c608c2726be7a9e4c14d83fd8373a6db83146 (patch) | |
| tree | 849ddee99e78058443a6d398bd7e466fea4259f6 /docs/lib/passlib.hash.rst | |
| parent | 8987f95ce647e8e8bcffabf66670affa3bc38489 (diff) | |
| download | passlib-1d6c608c2726be7a9e4c14d83fd8373a6db83146.tar.gz | |
removed extra bps docs
Diffstat (limited to 'docs/lib/passlib.hash.rst')
| -rw-r--r-- | docs/lib/passlib.hash.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/lib/passlib.hash.rst b/docs/lib/passlib.hash.rst new file mode 100644 index 0000000..b2f0aa1 --- /dev/null +++ b/docs/lib/passlib.hash.rst @@ -0,0 +1,44 @@ +============================================= +:mod:`bps.security.pwhash` - Password Hashing +============================================= + +.. module:: bps.security.pwhash + :synopsis: password hashing (unix-crypt, md5-crypt, etc) + +Overview +======== +This module handles encrypting and verifying password hashes +(such as from unix shadow files). This module contains implementations of most +of the modern password hashing algorithms, +as well as a complex framework for implementing +new algorithms, managing hashes generated +within different contexts with different supported +algorithms, and other features. + +The algorithms currently supported by default in BPS: + + * Unix-Crypt + * MD5-Crypt + * BCrypt + * SHA-Crypt (256 & 512 bit modes) + + * PostgreSQL & MySQL password hashes + +Sections +======== +The documentation for the pwhash module is broken into the following sections: + +* :doc:`Quick Start <bps.security.pwhash/quickstart>` -- frontend funcs for quickly creating / validating hashes +* :doc:`Crypt Contexts <bps.security.pwhash/contexts>` -- for using just the algorithms your application needs +* :doc:`Crypt Algorithms <bps.security.pwhash/algorithms>` -- details of the algorithms BPS implements +* :doc:`Implementing a Custom Crypt Algorithm <bps.security.pwhash/implementation>` -- Roll your own +* :doc:`Helper Functions <bps.security.pwhash/utils>` + +.. toctree:: + :hidden: + + bps.security.pwhash/quickstart + bps.security.pwhash/contexts + bps.security.pwhash/algorithms + bps.security.pwhash/implementation + bps.security.pwhash/utils |
