summaryrefslogtreecommitdiff
path: root/passlib/handlers/fshp.py
diff options
context:
space:
mode:
Diffstat (limited to 'passlib/handlers/fshp.py')
-rw-r--r--passlib/handlers/fshp.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/passlib/handlers/fshp.py b/passlib/handlers/fshp.py
index b95f034..fe82415 100644
--- a/passlib/handlers/fshp.py
+++ b/passlib/handlers/fshp.py
@@ -50,6 +50,16 @@ class fshp(uh.HasRounds, uh.HasRawSalt, uh.HasRawChecksum, uh.GenericHandler):
* ``1`` - uses SHA-2/256 digest (default).
* ``2`` - uses SHA-2/384 digest.
* ``3`` - uses SHA-2/512 digest.
+
+ :type relaxed: bool
+ :param relaxed:
+ By default, providing an invalid value for one of the other
+ keywords will result in a :exc:`ValueError`. If ``relaxed=True``,
+ and the error can be corrected, a :exc:`~passlib.exc.PasslibHashWarning`
+ will be issued instead. Correctable errors include ``rounds``
+ that are too small or too large, and ``salt`` strings that are too long.
+
+ .. versionadded:: 1.6
"""
#=========================================================