summaryrefslogtreecommitdiff
path: root/docs/lib/passlib.context-options.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/lib/passlib.context-options.rst')
-rw-r--r--docs/lib/passlib.context-options.rst36
1 files changed, 0 insertions, 36 deletions
diff --git a/docs/lib/passlib.context-options.rst b/docs/lib/passlib.context-options.rst
index ece9033..52146a4 100644
--- a/docs/lib/passlib.context-options.rst
+++ b/docs/lib/passlib.context-options.rst
@@ -138,42 +138,6 @@ and :samp:`{option}` is the name of the specific options being set.
These are configurable per-context limits,
they will be clipped by any hard limits set in the hash algorithm itself.
-.. _passprep:
-
-:samp:`{hash}__passprep`
-
- Normalize unicode passwords before passing them to the underlying
- hash algorithm. This is primarily useful if users are likely
- to use non-ascii characters in their password (e.g. vowels characters
- with accent marks), which unicode offers multiple representations for.
-
- This may be one of the following values:
-
- * ``"raw"`` - use all unicode inputs as-is (the default).
- unnormalized unicode input may not verify against a hash
- generated from normalized unicode input (or vice versa).
-
- * ``"saslprep"`` - run all passwords through the SASLPrep
- unicode normalization algorithm (:rfc:`4013`) before hashing.
- this is recommended for new deployments, particularly
- in non-ascii environments.
-
- * ``"saslprep,raw"`` - compatibility mode: encryption of new passwords
- will be run through SASLPrep; but verification will be done
- against the SASLPrep *and* raw versions of the password. This allows
- existing hashes that were generated from unnormalized input
- to continue to work.
-
- .. note::
-
- It is recommended to set this for all hashes via ``all__passprep``,
- instead of settings it per algorithm.
-
- .. note::
-
- Due to a missing :mod:`!stringprep` module, this feature
- is not available on Jython.
-
:samp:`{hash}__{setting}`
Any other option values, which match the name of a parameter listed