diff options
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/passlib.hash.apr_md5_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.bigcrypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.bsdi_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.crypt16.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.des_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.md5_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.oracle11.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.phpass.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.scram.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.sha1_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.sha256_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.sha512_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.sun_md5_crypt.rst | 2 | ||||
| -rw-r--r-- | docs/lib/passlib.utils.handlers.rst | 9 | ||||
| -rw-r--r-- | docs/lib/passlib.utils.rst | 9 |
15 files changed, 23 insertions, 21 deletions
diff --git a/docs/lib/passlib.hash.apr_md5_crypt.rst b/docs/lib/passlib.hash.apr_md5_crypt.rst index 6ae5361..ee4ac73 100644 --- a/docs/lib/passlib.hash.apr_md5_crypt.rst +++ b/docs/lib/passlib.hash.apr_md5_crypt.rst @@ -20,7 +20,7 @@ see that class for details. Interface ========= -.. autoclass:: apr_md5_crypt(checksum=None, salt=None, strict=False) +.. autoclass:: apr_md5_crypt() Format & Algorithm ================== diff --git a/docs/lib/passlib.hash.bigcrypt.rst b/docs/lib/passlib.hash.bigcrypt.rst index e16c261..5f2429e 100644 --- a/docs/lib/passlib.hash.bigcrypt.rst +++ b/docs/lib/passlib.hash.bigcrypt.rst @@ -20,7 +20,7 @@ This class can be used in exactly the same manner as :class:`~passlib.hash.des_c Interface ========= -.. autoclass:: bigcrypt(checksum=None, salt=None, strict=False) +.. autoclass:: bigcrypt() Format ====== diff --git a/docs/lib/passlib.hash.bsdi_crypt.rst b/docs/lib/passlib.hash.bsdi_crypt.rst index 6a60f79..99e7231 100644 --- a/docs/lib/passlib.hash.bsdi_crypt.rst +++ b/docs/lib/passlib.hash.bsdi_crypt.rst @@ -35,7 +35,7 @@ This class can be used directly as follows:: Interface ========= -.. autoclass:: bsdi_crypt(checksum=None, salt=None, rounds=None, strict=False) +.. autoclass:: bsdi_crypt() Format ====== diff --git a/docs/lib/passlib.hash.crypt16.rst b/docs/lib/passlib.hash.crypt16.rst index 2cdd5eb..43f63c6 100644 --- a/docs/lib/passlib.hash.crypt16.rst +++ b/docs/lib/passlib.hash.crypt16.rst @@ -25,7 +25,7 @@ This class can be used in exactly the same manner as :class:`~passlib.hash.des_c Interface ========= -.. autoclass:: crypt16(checksum=None, salt=None, strict=False) +.. autoclass:: crypt16() Format ====== diff --git a/docs/lib/passlib.hash.des_crypt.rst b/docs/lib/passlib.hash.des_crypt.rst index ba5202e..1c808c5 100644 --- a/docs/lib/passlib.hash.des_crypt.rst +++ b/docs/lib/passlib.hash.des_crypt.rst @@ -34,7 +34,7 @@ This class can be used directly as follows:: Interface ========= -.. autoclass:: des_crypt(checksum=None, salt=None, strict=False) +.. autoclass:: des_crypt() Format ====== diff --git a/docs/lib/passlib.hash.md5_crypt.rst b/docs/lib/passlib.hash.md5_crypt.rst index a75187f..538ced5 100644 --- a/docs/lib/passlib.hash.md5_crypt.rst +++ b/docs/lib/passlib.hash.md5_crypt.rst @@ -33,7 +33,7 @@ PassLib provides an md5_crypt class, which can be can be used directly as follow Interface ========= -.. autoclass:: md5_crypt(checksum=None, salt=None, strict=False) +.. autoclass:: md5_crypt() Format ====== diff --git a/docs/lib/passlib.hash.oracle11.rst b/docs/lib/passlib.hash.oracle11.rst index c879bc0..9f5ea02 100644 --- a/docs/lib/passlib.hash.oracle11.rst +++ b/docs/lib/passlib.hash.oracle11.rst @@ -38,7 +38,7 @@ PassLib provides an oracle11 class, which can be can be used directly as follows Interface ========= -.. autoclass:: oracle11(checksum=None, salt=None, strict=False) +.. autoclass:: oracle11() Format & Algorithm ================== diff --git a/docs/lib/passlib.hash.phpass.rst b/docs/lib/passlib.hash.phpass.rst index 20a3bb0..ee5c036 100644 --- a/docs/lib/passlib.hash.phpass.rst +++ b/docs/lib/passlib.hash.phpass.rst @@ -21,7 +21,7 @@ this scheme is used in exactly the same way as :doc:`bcrypt <passlib.hash.bcrypt Interface ========= -.. autoclass:: phpass(checksum=None, salt=None, rounds=None, strict=False) +.. autoclass:: phpass() Format ================== diff --git a/docs/lib/passlib.hash.scram.rst b/docs/lib/passlib.hash.scram.rst index fff87bf..397f743 100644 --- a/docs/lib/passlib.hash.scram.rst +++ b/docs/lib/passlib.hash.scram.rst @@ -94,7 +94,7 @@ for SCRAM-specific actions:: Interface ========= -.. autoclass:: scram(algs=None, salt=None, rounds=None, strict=False) +.. autoclass:: scram() .. rst-class:: html-toggle diff --git a/docs/lib/passlib.hash.sha1_crypt.rst b/docs/lib/passlib.hash.sha1_crypt.rst index fa80a6b..639429d 100644 --- a/docs/lib/passlib.hash.sha1_crypt.rst +++ b/docs/lib/passlib.hash.sha1_crypt.rst @@ -15,7 +15,7 @@ this scheme is used in exactly the same way as :doc:`sha512_crypt <passlib.hash. Functions ========= -.. autoclass:: sha1_crypt(checksum=None, salt=None, rounds=None, strict=False) +.. autoclass:: sha1_crypt() Format ====== diff --git a/docs/lib/passlib.hash.sha256_crypt.rst b/docs/lib/passlib.hash.sha256_crypt.rst index 2ae3243..9b7adce 100644 --- a/docs/lib/passlib.hash.sha256_crypt.rst +++ b/docs/lib/passlib.hash.sha256_crypt.rst @@ -17,7 +17,7 @@ This class can be used in exactly the same manner as :class:`~passlib.hash.sha51 Interface ========= -.. autoclass:: sha256_crypt(checksum=None, salt=None, rounds=None, strict=False) +.. autoclass:: sha256_crypt() Format & Algorithm ================== diff --git a/docs/lib/passlib.hash.sha512_crypt.rst b/docs/lib/passlib.hash.sha512_crypt.rst index f9e438c..963c61f 100644 --- a/docs/lib/passlib.hash.sha512_crypt.rst +++ b/docs/lib/passlib.hash.sha512_crypt.rst @@ -42,7 +42,7 @@ This class can be used directly as follows:: Interface ========= -.. autoclass:: sha512_crypt(checksum=None, salt=None, rounds=None, strict=False) +.. autoclass:: sha512_crypt() Format & Algorithm ================== diff --git a/docs/lib/passlib.hash.sun_md5_crypt.rst b/docs/lib/passlib.hash.sun_md5_crypt.rst index b3b891a..2a5cf4b 100644 --- a/docs/lib/passlib.hash.sun_md5_crypt.rst +++ b/docs/lib/passlib.hash.sun_md5_crypt.rst @@ -25,7 +25,7 @@ as :doc:`SHA-512 Crypt <passlib.hash.sha512_crypt>`. Interface ========= -.. autoclass:: sun_md5_crypt(checksum=None, salt=None, rounds=None, bare_salt=False, strict=False) +.. autoclass:: sun_md5_crypt() Format ====== diff --git a/docs/lib/passlib.utils.handlers.rst b/docs/lib/passlib.utils.handlers.rst index 301448c..385e5a2 100644 --- a/docs/lib/passlib.utils.handlers.rst +++ b/docs/lib/passlib.utils.handlers.rst @@ -14,6 +14,11 @@ definitely need to be rewritten for clarity. They are not yet organized, and may leave out some important details. +.. note:: + + Since this module is primarily a support module used internally + by Passlib, it's interface may change slightly between major releases. + Implementing Custom Handlers ============================ All that is required in order to write a custom handler that will work with @@ -45,7 +50,7 @@ workflow for hashes is some combination of the following: 1. parse hash into constituent parts - performed by :meth:`~GenericHandler.from_string`. 2. validate constituent parts - performed by :class:`!GenericHandler`'s constructor, - and the normalization functions such as :meth:`~GenericHandler.norm_checksum` and :meth:`~HasSalt.norm_salt` + and the normalization functions such as :meth:`~GenericHandler._norm_checksum` and :meth:`~HasSalt._norm_salt` which are provided by it's related mixin classes. 3. calculate the raw checksum for a specific password - performed by :meth:`~GenericHandler.calc_checksum`. 4. assemble hash, including new checksum, into a new string - performed by :meth:`~GenericHandler.to_string`. @@ -157,7 +162,7 @@ checking if a handler adheres to the :ref:`password-hash-api`. Usage ----- As an example of how to use :class:`!HandlerCase`, -the following is an annoted version +the following is an annotated version of the unittest for :class:`passlib.hash.des_crypt`:: from passlib.hash import des_crypt diff --git a/docs/lib/passlib.utils.rst b/docs/lib/passlib.utils.rst index 5508191..ca82c57 100644 --- a/docs/lib/passlib.utils.rst +++ b/docs/lib/passlib.utils.rst @@ -35,7 +35,6 @@ Constants are known to support which hashes. .. - PYPY JYTHON rounds_cost_values @@ -105,16 +104,15 @@ Predefined Instances Predefined instance of :class:`Base64Engine` which uses the :data:`!HASH64_CHARS` character map and little-endian encoding. - (see :data:`!HASH64_CHARS` for more details). + (see :data:`HASH64_CHARS` for more details). .. data:: h64big Predefined variant of :data:`h64` which uses big-endian encoding. This is mainly used by :class:`~passlib.hash.des_crypt`. -.. note:: - - *changed in Passlib 1.6:* Previous versions of Passlib contained +.. versionchanged:: 1.6 + Previous versions of Passlib contained a module named :mod:`!passlib.utils.h64`; As of Passlib 1.6 this was replaced by the the ``h64`` and ``h64big`` instances; the interface remains mostly unchanged. @@ -173,5 +171,4 @@ There are also a few sub modules which provide additional utility functions: passlib.utils.pbkdf2 .. - passlib.utils.compat |