diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2012-03-12 22:38:41 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2012-03-12 22:38:41 -0400 |
| commit | 4307162072d9b1c65f41990752b39ad4483c0a00 (patch) | |
| tree | 5ff0359aecb90b8b2fd8d7a6fcf6d7743527ab5d /docs | |
| parent | 3913a59ad033462e6a389544ffcdf8055db7ad9c (diff) | |
| download | passlib-4307162072d9b1c65f41990752b39ad4483c0a00.tar.gz | |
doc tweaks
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/lib/passlib.apps.rst | 9 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.bcrypt.rst | 8 | ||||
| -rw-r--r-- | docs/lib/passlib.utils.compat.rst | 5 | ||||
| -rw-r--r-- | docs/new_app_quickstart.rst | 4 |
4 files changed, 19 insertions, 7 deletions
diff --git a/docs/lib/passlib.apps.rst b/docs/lib/passlib.apps.rst index 40d3b7a..a47df43 100644 --- a/docs/lib/passlib.apps.rst +++ b/docs/lib/passlib.apps.rst @@ -54,7 +54,14 @@ Django password hashes, as used by Django's ``django.contrib.auth`` module. It recognizes all the :doc:`builtin Django hashes <passlib.hash.django_std>`. It defaults to using the :class:`~passlib.hash.django_salted_sha1` hash. - + + .. note:: + + This object may not match the hashes in your database if a third-party + library has been used to patch Django to support alternate hash formats. + This includes the `django-bcrypt <http://pypi.python.org/pypi/django-bcrypt>`_ + plugin, or Passlib's builtin :mod:`django extension <passlib.ext.django>`. + .. _ldap-contexts: LDAP diff --git a/docs/lib/passlib.hash.bcrypt.rst b/docs/lib/passlib.hash.bcrypt.rst index 11c1a25..50eba4f 100644 --- a/docs/lib/passlib.hash.bcrypt.rst +++ b/docs/lib/passlib.hash.bcrypt.rst @@ -14,7 +14,7 @@ for new applications. .. note:: It is strongly recommended to install - :ref:`PyBcrypt or BCryptor <optional-libraries>` + :ref:`py-bcrypt or bcryptor <optional-libraries>` if this algorithm is going to be used. Usage @@ -63,7 +63,7 @@ Bcrypt hashes have the format :samp:`$2a${rounds}${salt}{checksum}`, where: * :samp:`{checksum}` is the 31 character checksum, using the same characters as the salt (``AnUtN/LRfe1JsBm1Xu6LE3059z5Tr8m`` in the example). While BCrypt's basic algorithm is described in it's design document [#f1]_, -the OpenBSD implementation [#f2]_ is considered the canonical reference, even +the OpenBSD implementation [#f2]_ is considered the canonical reference, even though it differs from the design document in a few small ways. Deviations @@ -118,7 +118,7 @@ This implementation of bcrypt differs from others in a few ways: ``$2y$``, the default for crypt_blowfish 1.1 and newer, indicates the hash was generated with the canonical OpenBSD-compatible algorithm, - and should match *correctly* generated ``$2a$`` hashes. + and should match *correctly* generated ``$2a$`` hashes. Passlib 1.6 can generate and verify these hashes. As well, crypt_blowfish 1.2 modified the way it generates ``$2a$`` hashes, @@ -134,5 +134,5 @@ This implementation of bcrypt differs from others in a few ways: .. [#f2] the OpenBSD BCrypt source - `<http://www.openbsd.org/cgi-bin/cvsweb/src/lib/libc/crypt/bcrypt.c>`_ -.. [#eight] The flaw in pre-1.1 crypt_blowfish is described here - +.. [#eight] The flaw in pre-1.1 crypt_blowfish is described here - `CVE-2011-2483 <http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2011-2483>`_ diff --git a/docs/lib/passlib.utils.compat.rst b/docs/lib/passlib.utils.compat.rst index 2536b0a..6ee6a19 100644 --- a/docs/lib/passlib.utils.compat.rst +++ b/docs/lib/passlib.utils.compat.rst @@ -54,3 +54,8 @@ Bytes Helpers .. function:: byte_elem_value Function to convert byte element to integer (a no-op under PY3) + +.. function:: iter_byte_values + + Function to iterate over a byte string as a series of integers. + (This is just the native bytes iterator under PY3). diff --git a/docs/new_app_quickstart.rst b/docs/new_app_quickstart.rst index d18afb3..32df641 100644 --- a/docs/new_app_quickstart.rst +++ b/docs/new_app_quickstart.rst @@ -66,7 +66,7 @@ All three password hashes share the following properties: The following comparison should help you choose which hash is most appropriate for your application; if in doubt, any of these is a good choice, though PBKDF2 is probably the best -for portability. +for portability. .. rst-class:: html-toggle @@ -96,7 +96,7 @@ of simultaneous logon attempts (eg web apps). For BCrypt support on non-BSD systems, Passlib requires a C-extension module provided by the external - :ref:`PyBcrypt or BCryptor <optional-libraries>` packages. + :ref:`py-bcrypt or bcryptor <optional-libraries>` packages. Neither of these currently supports Python 3. SHA512-Crypt |
