summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-07-27 12:04:56 -0400
committerEli Collins <elic@assurancetechnologies.com>2011-07-27 12:04:56 -0400
commitfb0750de1f7b52adb0dc0aa7227300d358a69108 (patch)
tree28312c34bd6845c4d03fc900907e4c5b85d05bfc
parent151afc5d6a057f0eac75badfcd0eb808258fa1ea (diff)
downloadpasslib-fb0750de1f7b52adb0dc0aa7227300d358a69108.tar.gz
tweaked fshp documentation
-rw-r--r--docs/install.rst2
-rw-r--r--docs/lib/passlib.hash.fshp.rst6
-rw-r--r--passlib/handlers/fshp.py10
3 files changed, 8 insertions, 10 deletions
diff --git a/docs/install.rst b/docs/install.rst
index 28a9172..4bb4558 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -5,7 +5,7 @@ Installation
Supported Platforms
===================
Passlib requires Python 2 (>= 2.5) or Python 3.
-It should work with the following Python implementations:
+It is known to work with the following Python implementations:
* CPython 2 -- 2.5 or newer.
* CPython 3 -- all versions.
diff --git a/docs/lib/passlib.hash.fshp.rst b/docs/lib/passlib.hash.fshp.rst
index fe1ffdf..ce596da 100644
--- a/docs/lib/passlib.hash.fshp.rst
+++ b/docs/lib/passlib.hash.fshp.rst
@@ -13,9 +13,9 @@ hashes from SHA-1 up to SHA-512.
.. note::
- While the SHA-2 variants have no critical security vulnerabilities,
- PBKDF1 has been deprecated in favor of PBKDF2 due to various general weaknesses,
- and FSHP has been listed as insecure by it's author;
+ While the SHA-2 variants of PBKDF1 have no critical security vulnerabilities,
+ PBKDF1 itself has been deprecated in favor of it's successor, PBKDF2.
+ Furthermore, FSHP has been listed as insecure by it's author (for unspecified reasons);
so this scheme should probably only be used to support existing hashes.
Usage
diff --git a/passlib/handlers/fshp.py b/passlib/handlers/fshp.py
index edf58e1..9ca7ecb 100644
--- a/passlib/handlers/fshp.py
+++ b/passlib/handlers/fshp.py
@@ -43,12 +43,10 @@ class fshp(uh.HasRounds, uh.HasRawSalt, uh.HasRawChecksum, uh.GenericHandler):
:param variant:
Optionally specifies variant of FSHP to use.
- * ``0`` - uses SHA-1 digest (deprecated)
- * ``1`` - uses SHA-2/256 digest (default)
- * ``2`` - uses SHA-2/384 digest
- * ``3`` - uses SHA-2/512 digest
-
- Aliases ``sha1``, ``sha256`` etc are also allowed.
+ * ``0`` - uses SHA-1 digest (deprecated).
+ * ``1`` - uses SHA-2/256 digest (default).
+ * ``2`` - uses SHA-2/384 digest.
+ * ``3`` - uses SHA-2/512 digest.
"""
#=========================================================