diff options
author | Eli Collins <elic@assurancetechnologies.com> | 2012-05-01 16:43:32 -0400 |
---|---|---|
committer | Eli Collins <elic@assurancetechnologies.com> | 2012-05-01 16:43:32 -0400 |
commit | af8b00870e6c32373dd7e2d96da40cf63a09d807 (patch) | |
tree | eed47fb127cdfd15821c486859700896e8598530 | |
parent | cb2217e45f43cbcc53dcb90683a20a5ce761bc14 (diff) | |
download | passlib-af8b00870e6c32373dd7e2d96da40cf63a09d807.tar.gz |
last minute documentation updates
-rw-r--r-- | CHANGES | 11 | ||||
-rw-r--r-- | LICENSE | 2 | ||||
-rw-r--r-- | docs/lib/passlib.hash.bcrypt.rst | 4 | ||||
-rw-r--r-- | docs/lib/passlib.hash.scram.rst | 3 | ||||
-rw-r--r-- | docs/lib/passlib.utils.rst | 11 | ||||
-rw-r--r-- | passlib/exc.py | 5 |
6 files changed, 20 insertions, 16 deletions
@@ -59,12 +59,12 @@ New Hashes :doc:`lmhash <lib/passlib.hash.lmhash>`, :doc:`nthash <lib/passlib.hash.nthash>` Microsoft's legacy "Lan Manager" hash, and the replacement - "NT password hash". *(the old* ``nthash`` *algorithm in Passlib 1.5 has been renamed to* + NT password hash. *(the old* ``nthash`` *algorithm in Passlib 1.5 has been renamed to* :class:`~passlib.hash.bsd_nthash` *, to reflect it's lineage)*. :doc:`msdcc <lib/passlib.hash.msdcc>`, :doc:`msdcc2 <lib/passlib.hash.msdcc2>` Microsoft Windows' Domain Cached Credentials, versions 1 and 2. - This algorithm also goes by the names "DCC", "MSCache", and "MSCash". + These algorithms also go by the names "DCC", "MSCache", and "MSCash". :doc:`mssql2000 <lib/passlib.hash.mssql2000>`, :doc:`mssql2005 <lib/passlib.hash.mssql2005>` Hash algorithms used by MS SQL Server 2000 and later. @@ -107,11 +107,11 @@ Existing Hashes .. [#consteq] "constant time" is a misnomer, it actually takes ``THETA(len(righthand_value))`` time. :doc:`bcrypt <lib/passlib.hash.bcrypt>` - The BCrypt hash now supports the *crypt_blowfish* project's + The BCrypt hash now supports the `crypt_blowfish <http://www.openwall.com/crypt/>`_ project's ``$2y$`` hash prefix. - As well, Passlib now offers an (experimental) pure-python BCrypt - implementation. Unfortunately, it's still *way too slow* to be + As well, Passlib now offers an (experimental) pure-python implementation + of BCrypt. Unfortunately, it's still *way too slow* to be suitable for production use; and is disabled by default. If you really need it, see the BCrypt :ref:`documentation <bcrypt-backends>` for how to enable it. @@ -213,7 +213,6 @@ Other Modules Bugfixes -------- - * Handle platform-specific error strings that may be returned by the :func:`!crypt` methods of some OSes. @@ -10,7 +10,7 @@ Passlib is (c) `Assurance Technologies <http://www.assurancetechnologies.com>`_, and is released under the `BSD license <http://www.opensource.org/licenses/bsd-license.php>`_:: Passlib - Copyright (c) 2008-2011 Assurance Technologies, LLC. + Copyright (c) 2008-2012 Assurance Technologies, LLC. All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/docs/lib/passlib.hash.bcrypt.rst b/docs/lib/passlib.hash.bcrypt.rst index 0bfd9c7..9c7b339 100644 --- a/docs/lib/passlib.hash.bcrypt.rst +++ b/docs/lib/passlib.hash.bcrypt.rst @@ -52,12 +52,12 @@ Interface 2. `bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_, if installed. 3. stdlib's :func:`crypt.crypt()`, if the host OS supports BCrypt (primarily BSD-derived systems). - 4. A *slow* pure-python implementation of BCrypt, built into Passlib. + 4. A pure-python implementation of BCrypt, built into Passlib (disabled by default). It should be noted that the pure-python implementation (#4) is too slow to be useable, given the number of rounds currently required for security. Because of this, it is disabled by default, unless the environment variable - ``PASSLIB_BUILTIN_BCRYPT="enabled"`` is set before Passlib is first loaded. + ``PASSLIB_BUILTIN_BCRYPT="enabled"`` is set. If the first three backends are not available, and the builtin backend has not been enabled, :meth:`encrypt` and :meth:`verify` diff --git a/docs/lib/passlib.hash.scram.rst b/docs/lib/passlib.hash.scram.rst index e9c0205..a186685 100644 --- a/docs/lib/passlib.hash.scram.rst +++ b/docs/lib/passlib.hash.scram.rst @@ -57,6 +57,9 @@ This class can be used like any other Passlib hash, as follows:: See the generic :ref:`PasswordHash usage examples <password-hash-examples>` for more details on how to use the common hash interface. + +---- + Additionally, this class provides a number of useful methods for SCRAM-specific actions: * You can override the default list of digests, and/or the number of iterations:: diff --git a/docs/lib/passlib.utils.rst b/docs/lib/passlib.utils.rst index 9ecafda..dc9a12f 100644 --- a/docs/lib/passlib.utils.rst +++ b/docs/lib/passlib.utils.rst @@ -128,12 +128,13 @@ Predefined Instances the :class:`Base64Engine` class; the interface remains mostly unchanged. -.. - Other - ----- - .. autofunction:: ab64_encode - .. autofunction:: ab64_decode +Other +----- +.. autofunction:: ab64_encode +.. autofunction:: ab64_decode + +.. .. data:: AB64_CHARS Variant of standard Base64 character map used by some diff --git a/passlib/exc.py b/passlib/exc.py index 3fd64fe..565b1aa 100644 --- a/passlib/exc.py +++ b/passlib/exc.py @@ -9,8 +9,9 @@ class MissingBackendError(RuntimeError): :exc:`!MissingBackendError` derives from :exc:`RuntimeError`, since this usually indicates lack of an external library or OS feature. - This is primarily used by handlers which derive - from :class:`~passlib.utils.handlers.HasManyBackends`. + This is primarily raised by handlers which depend on + external libraries -- which is currently just + :class:`~passlib.hash.bcrypt`. """ class PasswordSizeError(ValueError): |