summaryrefslogtreecommitdiff
path: root/docs/lib
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2013-12-28 17:25:14 -0500
committerEli Collins <elic@assurancetechnologies.com>2013-12-28 17:25:14 -0500
commit30eae47675609b00138c371c48b295eb72888231 (patch)
tree44029fea3517b9236dad35de916d3a29e48ef339 /docs/lib
parent2aa0105f6471a1df4bc528639dd3ced5a1666ea5 (diff)
parent1983b0d866f6c765acdc933d506d98f5e7066c0c (diff)
downloadpasslib-30eae47675609b00138c371c48b295eb72888231.tar.gz
Merge with stable
Diffstat (limited to 'docs/lib')
-rw-r--r--docs/lib/passlib.hash.rst1
-rw-r--r--docs/lib/passlib.pwd.rst48
-rw-r--r--docs/lib/passlib.utils.pbkdf2.rst3
3 files changed, 51 insertions, 1 deletions
diff --git a/docs/lib/passlib.hash.rst b/docs/lib/passlib.hash.rst
index c4d7574..8fbea1d 100644
--- a/docs/lib/passlib.hash.rst
+++ b/docs/lib/passlib.hash.rst
@@ -123,7 +123,6 @@ they can be used compatibly along side other modular crypt format hashes.
:maxdepth: 1
passlib.hash.apr_md5_crypt
- passlib.hash.bcrypt_sha256
passlib.hash.phpass
passlib.hash.pbkdf2_digest
passlib.hash.cta_pbkdf2_sha1
diff --git a/docs/lib/passlib.pwd.rst b/docs/lib/passlib.pwd.rst
new file mode 100644
index 0000000..48441df
--- /dev/null
+++ b/docs/lib/passlib.pwd.rst
@@ -0,0 +1,48 @@
+.. module:: passlib.pwd
+ :synopsis: password generation helpers
+
+=================================================
+:mod:`passlib.pwd` -- password generation helpers
+=================================================
+
+.. versionadded:: 1.7
+
+.. todo::
+ This module is still a work in progress, it's API may change
+ before release. See module source for detailed todo list.
+
+Generation
+==========
+.. warning::
+
+ Before using these routines, be sure your system's RNG state is safe,
+ and that you use a sufficiently high ``entropy`` value for
+ the intended purpose.
+
+.. autofunction:: generate(size=None, entropy=None, count=None, preset=None, charset=None, wordset=None, spaces=True)
+
+.. rst-class:: html-toggle
+
+Generator Backends
+------------------
+The following classes are used by the :func:`generate` function behind the scenes,
+to perform word- and phrase- generation. They are useful for folks who want
+a little more information about the password generation process, and/or
+want to use a preconfigured generator.
+
+.. autoclass:: SecretGenerator
+.. autoclass:: WordGenerator
+.. autoclass:: PhraseGenerator
+
+Analysis
+========
+.. warning::
+
+ *Disclaimer:*
+ There can be no accurate estimate of the quality of a password,
+ because it depends on too many conditions that are unknowable from just
+ looking at the password. This code attempts to rule out the worst passwords,
+ and identify potentially-weak passwords, but should be used only as a guide.
+
+.. autofunction:: strength
+.. autofunction:: classify
diff --git a/docs/lib/passlib.utils.pbkdf2.rst b/docs/lib/passlib.utils.pbkdf2.rst
index f8eb89f..7fa9f98 100644
--- a/docs/lib/passlib.utils.pbkdf2.rst
+++ b/docs/lib/passlib.utils.pbkdf2.rst
@@ -26,7 +26,10 @@ PKCS#5 Key Derivation Functions
Helper Functions
================
.. autofunction:: norm_hash_name
+.. autofunction:: get_hash_info
+
.. autofunction:: get_prf
+.. autofunction:: get_keyed_prf
..
given how this module is expanding in scope,