added documentation for roundup hashes & context

3 files changed, 87 insertions, 4 deletions

diff --git a/docs/lib/passlib.apps.rst b/docs/lib/passlib.apps.rst
index 3af39f1..ffcb9c6 100644
--- a/docs/lib/passlib.apps.rst
+++ b/docs/lib/passlib.apps.rst
@@ -134,3 +134,32 @@ PostgreSQL
         True
         >>> postgres_context.verify("wrongpass", 'md578ed0f0ab2be0386645c1b74282917e7', user="dbadmin")
         False
+
+.. index:: roundup; crypt context
+
+Roundup
+=======
+The `Roundup Issue Tracker <http://www.roundup-tracker.org>` has long
+supported a series of different methods for encoding passwords.
+
+.. data:: roundup10_context
+
+    This object should recognize all password hashes used by Roundup:
+    :class:`ldap_hex_sha1` (the default), :class:`ldap_hex_md5`, :class:`ldap_des_crypt`,
+    and :class:`roundup_plaintext`.
+
+.. data:: roundup15_context
+
+    As of 2011-04-28, the next release of Roundup will add support
+    for :class:`ldap_pbkdf2_sha1`. This context supports all the :data:`roundup10_context`
+    hashes, but adds this hash as well (as uses it as the default).
+
+    .. note::
+
+        This version of Roundup has not been released yet,
+        databases using Roundup 1.4.16 and earlier should use the :data:`roundup10_context` instead.
+
+.. data:: roundup_context
+
+    this is an alias for the latest version-specific roundup context supported
+    by passlib, currently the :data:`!roundup15_context`.
diff --git a/docs/lib/passlib.hash.ldap_other.rst b/docs/lib/passlib.hash.ldap_other.rst
new file mode 100644
index 0000000..bd0200b
--- /dev/null
+++ b/docs/lib/passlib.hash.ldap_other.rst
@@ -0,0 +1,49 @@
+===============================================================
+:samp:`passlib.hash.ldap_{other}` - Non-Standard RFC2307 Hashes
+===============================================================
+
+.. currentmodule:: passlib.hash
+
+This section as a catch-all for a number of password hash
+formats supported by Passlib which use :rfc:`2307` style encoding,
+but are not part of any standard.
+
+.. seealso::
+
+    :ref:`ldap-hashes` for a full list of RFC 2307 style hashes.
+
+Hexidecimal Digests
+===================
+All of the digests specified in RFC 2307 use base64 encoding.
+The following are non-standard versions which use hexdecimal
+encoding, as is found in some applications.
+
+.. class:: ldap_hex_md5
+
+    hexidecimal version of :class:`ldap_md5`,
+    this is just the md5 digest of the password.
+
+    an example hash (of ``password``) is ``{MD5}5f4dcc3b5aa765d61d8327deb882cf99``.
+
+.. class:: ldap_hex_sha1
+
+    hexidecimal version of :class:`ldap_sha1`,
+    this is just the sha1 digest of the password.
+
+    an example hash (of ``password``) is ``{SHA}5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8``.
+
+Other Hashes
+============
+.. class:: roundup_plaintext
+
+    RFC 2307 specifies plaintext passwords should be stored
+    without any identifying prefix.
+    This class implements an alternate method used by the Roundup Issue Tracker [#roundup]_,
+    which (when storing plaintext passwords) uses the identifying prefix ``{plaintext}``.
+
+    an example hash (of ``password``) is ``{plaintext}password``.
+
+References
+==========
+
+.. [#roundup] Roundup Issue Tracker homepage - `<http://www.roundup-tracker.org>`_.
diff --git a/docs/lib/passlib.hash.rst b/docs/lib/passlib.hash.rst
index 47297cc..428283b 100644
--- a/docs/lib/passlib.hash.rst
+++ b/docs/lib/passlib.hash.rst
@@ -142,15 +142,20 @@ None of the following schemes are actually used by LDAP,
 but follow the LDAP format:
 
 .. toctree::
+    :hidden:
+
+    passlib.hash.ldap_other
+
+* :class:`ldap_hex_md5` - Hex-encoded MD5 Digest
+* :class:`ldap_hex_sha1` - Hex-encoded SHA1 Digest
+
+.. toctree::
     :maxdepth: 1
 
     passlib.hash.ldap_pbkdf2_digest
     passlib.hash.atlassian_pbkdf2_sha1
 
-..
-    passlib.hash.roundup_plaintext
-    passlib.hash.ldap_hex_md5
-    passlib.hash.ldap_hex_sha1
+* :class:`roundup_plaintext` - Roundup-specific LDAP Plaintext Handler
 
 .. _database-hashes: