diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-04-25 01:47:45 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-04-25 01:47:45 -0400 |
| commit | e720d332b337be7d9fcc5b3375b80c1352706e74 (patch) | |
| tree | 347b1c241a82f4fd77f3eac04e8cf4bd28a187ae /docs/lib | |
| parent | 977766c0f1612d41233d1708aedd68909e968d05 (diff) | |
| download | passlib-e720d332b337be7d9fcc5b3375b80c1352706e74.tar.gz | |
documentation tweaks
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/passlib.hash.ldap_digests.rst | 46 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.mysql323.rst | 4 | ||||
| -rw-r--r-- | docs/lib/passlib.hash.mysql41.rst | 4 |
3 files changed, 28 insertions, 26 deletions
diff --git a/docs/lib/passlib.hash.ldap_digests.rst b/docs/lib/passlib.hash.ldap_digests.rst index 1f5fabd..8ed38e0 100644 --- a/docs/lib/passlib.hash.ldap_digests.rst +++ b/docs/lib/passlib.hash.ldap_digests.rst @@ -64,40 +64,34 @@ Format & Algorithm ================== All of these classes follow a single basic format [#rfc]_: -ldap_md5 +ldap_md5, ldap_sha1 - These hashes have the format :samp:`{{MD5}}{checksum}`, - where :samp:`{checksum}` is the base64 encoding - of the raw MD5 digest of the password. - An example hash (of ``password``) is ``{MD5}X03MO1qnZdYdgyfeuILPmQ==``. + These hashes have the format :samp:`{prefix}{checksum}`. + * :samp:`{prefix}` is `{MD5}` for ldap_md5, + and `{SHA}` for ldap_sha1. + * :samp:`{checksum}` is the base64 encoding + of the raw message digest of the password, + using the appropriate digest algorithm. -ldap_salted_md5 + An example ldap_md5 hash (of ``password``) is ``{MD5}X03MO1qnZdYdgyfeuILPmQ==``. + An example ldap_sha1 hash (of ``password``) is ``{SHA}W6ph5Mm5Pz8GgiULbPgzG37mj9g=``. - These hashes have the format :samp:`{{SMD5}}{data}`; - where :samp:`{data}` is the base64 encoding of :samp:`{checksum}{salt}`; - and in turn :samp:`{salt}` is a 4 byte binary salt, - and :samp:`{checksum}` is the raw MD5 digest of the - the string :samp:`{password}{salt}`. +ldap_salted_md5, ldap_salted_sha1 + + These hashes have the format :samp:`{prefix}{data}`. + + * :samp:`{prefix}` is `{SMD5}` for ldap_salted_md5, + and `{SSHA}` for ldap_salted_sha1. + * :samp:`{data}` is the base64 encoding of :samp:`{checksum}{salt}`; + and in turn :samp:`{salt}` is a 4 byte binary salt, + and :samp:`{checksum}` is the raw digest of the + the string :samp:`{password}{salt}`, + using the appropriate digest algorithm. An example hash (of ``password``) is ``{SMD5}jNoSMNY0cybfuBWiaGlFw3Mfi/U=``. After decoding, this results in a raw salt string ``s\x1f\x8b\xf5``, and a raw MD5 checksum of ``\x8c\xda\x120\xd64s&\xdf\xb8\x15\xa2hiE\xc3``. -ldap_sha1 - - These hashes have the format :samp:`{{MD5}}{checksum}`, - where :samp:`{checksum}` is the base64 encoding - of the raw MD5 digest of the password. - An example hash (of ``password``) is ``{SHA}W6ph5Mm5Pz8GgiULbPgzG37mj9g=``. - -ldap_salted_sha1 - - These hashes have the format :samp:`{{SSHA}}{data}`; - where :samp:`{data}` is the base64 encoding of :samp:`{checksum}{salt}`; - and in turn :samp:`{salt}` is a 4 byte binary salt, - and :samp:`{checksum}` is the raw SHA1 digest of the - the string :samp:`{password}{salt}`. - An example hash (of ``password``) is ``{SSHA}pKqkNr1tq3wtQqk+UcPyA3HnA2NsU5NJ``. After decoding, this results in a raw salt string ``lS\x93I``, and a raw SHA1 checksum of ``\xa4\xaa\xa46\xbdm\xab|-B\xa9>Q\xc3\xf2\x03q\xe7\x03c``. diff --git a/docs/lib/passlib.hash.mysql323.rst b/docs/lib/passlib.hash.mysql323.rst index a94d197..7bbc129 100644 --- a/docs/lib/passlib.hash.mysql323.rst +++ b/docs/lib/passlib.hash.mysql323.rst @@ -17,6 +17,10 @@ hash algorithm was introduced (see :class:`~passlib.hash.mysql41`). for any purposes besides manipulating existing Mysql 3.2.3-4.0 password hashes. +.. seealso:: + + :mod:`!passlib.apps` for a :ref:`list of premade mysql contexts <mysql-contexts>`. + Usage ===== Users will most likely find the frontends provided by :mod:`passlib.apps` diff --git a/docs/lib/passlib.hash.mysql41.rst b/docs/lib/passlib.hash.mysql41.rst index eaaf89e..de9f64a 100644 --- a/docs/lib/passlib.hash.mysql41.rst +++ b/docs/lib/passlib.hash.mysql41.rst @@ -16,6 +16,10 @@ used by MySQL, and is still in active use under MySQL 5. for any purposes besides manipulating existing Mysql 4.1+ password hashes. +.. seealso:: + + :mod:`!passlib.apps` for a :ref:`list of premade mysql contexts <mysql-contexts>`. + Usage ===== Users will most likely find the frontends provided by :mod:`passlib.apps` |
