diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-06-02 17:32:07 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-06-02 17:32:07 -0400 |
| commit | 5848cc270b153792e46461bed71ca99cb25dc65c (patch) | |
| tree | a4f792796b4512b60914ab30661e7f5d444c926d /docs/lib | |
| parent | 60e787346ab060440854e83da60d815d2222be00 (diff) | |
| download | passlib-5848cc270b153792e46461bed71ca99cb25dc65c.tar.gz | |
kdf enhancements
* renamed _resolve_prf() to get_prf(), documented interface
* added pbkdf1 support
* added 'encoding' kwd to pbkdf1 & pbkdf2, for easier handling of unicode inputs
*
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/passlib.utils.pbkdf2.rst | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/lib/passlib.utils.pbkdf2.rst b/docs/lib/passlib.utils.pbkdf2.rst index 2bade1c..d4fb46e 100644 --- a/docs/lib/passlib.utils.pbkdf2.rst +++ b/docs/lib/passlib.utils.pbkdf2.rst @@ -3,13 +3,30 @@ ============================================================= .. module:: passlib.utils.pbkdf2 - :synopsis: PBKDF2 key derivation algorithm + :synopsis: PBKDF2 and related key derivation algorithms -This module provides a single function, :func:`pbkdf2`, +This module provides a couple of key derivation functions, +as well as supporting utilities. +Primarily, it offers :func:`pbkdf2`, which provides the ability to generate an arbitrary length key using the PBKDF2 key derivation algorithm, as specified in `rfc 2898 <http://tools.ietf.org/html/rfc2898>`_. This function can be helpful in creating password hashes using schemes which have been based around the pbkdf2 algorithm. +PKCS#5 Key Derivation Functions +=============================== +.. autofunction:: pbkdf1 .. autofunction:: pbkdf2 + +.. note:: + + The details of PBKDF1 and PBKDF2 are specified in :rfc:`2898`. + +Helper Functions +================ +.. autofunction:: get_prf + +.. + given how this module is expanding in scope, + perhaps it should be renamed "kdf"? |