summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2020-10-06 15:52:42 -0400
committerEli Collins <elic@assurancetechnologies.com>2020-10-06 15:52:42 -0400
commit49eb92ea545e69184bbea041d979325b2c715600 (patch)
treeb3644c6e07337ba326f88a02c6e79fe1aa369d43 /docs
parent16766a60eb7794f4adee19a4c914f6b1a9f5d480 (diff)
downloadpasslib-49eb92ea545e69184bbea041d979325b2c715600.tar.gz
passlib.hash.bcrypt: remove support for "bcryptor" backend
Diffstat (limited to 'docs')
-rw-r--r--docs/install.rst27
-rw-r--r--docs/lib/passlib.hash.bcrypt.rst7
2 files changed, 9 insertions, 25 deletions
diff --git a/docs/install.rst b/docs/install.rst
index 644c12c..f48af45 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -37,25 +37,12 @@ Google App Engine is supported as well.
Optional Libraries
==================
-* `bcrypt <https://pypi.python.org/pypi/bcrypt>`_,
- `py-bcrypt <https://pypi.python.org/pypi/py-bcrypt>`_, or
- `bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_
+* `bcrypt <https://pypi.python.org/pypi/bcrypt>`_
- .. rst-class:: float-right
-
- .. warning::
-
- Support for ``py-bcrypt`` and ``bcryptor`` will be dropped in Passlib 1.8,
- as these libraries are unmaintained.
-
- If any of these packages are installed, they will be used to provide
- support for the BCrypt hash algorithm.
- This is required if you want to handle BCrypt hashes,
- and your OS does not provide native BCrypt support
- via stdlib's :mod:`!crypt` (which includes pretty much all non-BSD systems).
-
- `bcrypt <https://pypi.python.org/pypi/bcrypt>`_ is currently the recommended
- option -- it's actively maintained, and compatible with both CPython and PyPy.
+ If installed, this will be used to handle :class:~passlib.hash.bcrypt` and
+ :class:`~passlib.hash.bcrypt_sha256` hashes. If your system lacks :func:`crypt.crypt()`
+ support for bcrypt hashes, this library is *required* in order for passlib to provide
+ bcrypt support.
Use ``pip install passlib[bcrypt]`` to get the recommended bcrypt setup.
@@ -86,6 +73,10 @@ Optional Libraries
If installed, this will be used to provide support for the :class:`~passlib.hash.scrypt`
hash algorithm. If not installed, a MUCH slower builtin reference implementation will be used.
+.. versionchanged:: 1.8
+
+ Dropped support for ``py-bcrypt`` and ``bcryptor`` backends.
+
.. versionchanged:: 1.7
Added fastpbkdf2, cryptography, argon2_cffi, argon2pure, and scrypt support.
diff --git a/docs/lib/passlib.hash.bcrypt.rst b/docs/lib/passlib.hash.bcrypt.rst
index 436148c..3bb5865 100644
--- a/docs/lib/passlib.hash.bcrypt.rst
+++ b/docs/lib/passlib.hash.bcrypt.rst
@@ -50,17 +50,10 @@ Bcrypt Backends
.. rst-class:: float-center
-.. warning::
-
- Support for ``py-bcrypt`` and ``bcryptor`` will be dropped in Passlib 1.8,
- as these libraries are unmaintained.
-
This class will use the first available of five possible backends:
1. `bcrypt <https://pypi.python.org/pypi/bcrypt>`_, if installed.
-2. `py-bcrypt <https://pypi.python.org/pypi/py-bcrypt>`_, if installed (DEPRECATED)
-3. `bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_, if installed (DEPRECATED).
4. stdlib's :func:`crypt.crypt()`, if the host OS supports BCrypt
(primarily BSD-derived systems).
5. A pure-python implementation of BCrypt, built into Passlib.