summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-04-29 16:20:13 -0400
committerEli Collins <elic@assurancetechnologies.com>2011-04-29 16:20:13 -0400
commit9f8905d70790d59c9d36150a5765d496a31119cb (patch)
tree5834ec8d1690b847783517e3f8fbdfe4ab27104e /docs
parentca12d426c495ff2823aa901ff00c9f101e5a4194 (diff)
downloadpasslib-9f8905d70790d59c9d36150a5765d496a31119cb.tar.gz
added some index entries; minor doc tweaks
Diffstat (limited to 'docs')
-rw-r--r--docs/lib/passlib.apache.rst4
-rw-r--r--docs/lib/passlib.apps.rst6
-rw-r--r--docs/lib/passlib.hash.apr_md5_crypt.rst2
-rw-r--r--docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst5
-rw-r--r--docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst2
-rw-r--r--docs/lib/passlib.hash.grub_pbkdf2_sha512.rst2
-rw-r--r--docs/lib/passlib.hash.mysql323.rst2
-rw-r--r--docs/lib/passlib.hash.mysql41.rst2
-rw-r--r--docs/lib/passlib.hash.phpass.rst2
-rw-r--r--docs/lib/passlib.hash.postgres_md5.rst4
-rw-r--r--docs/lib/passlib.hash.rst6
-rw-r--r--docs/password_hash_api.rst8
12 files changed, 33 insertions, 12 deletions
diff --git a/docs/lib/passlib.apache.rst b/docs/lib/passlib.apache.rst
index 0826246..3e12a2d 100644
--- a/docs/lib/passlib.apache.rst
+++ b/docs/lib/passlib.apache.rst
@@ -8,6 +8,8 @@
This module provides utilities for reading and writing Apache's
htpasswd and htdigest files; though the use of two helper classes.
+.. index:: apache; htpasswd
+
Htpasswd Files
==============
The :class:`!HTpasswdFile` class allows managing of htpasswd files.
@@ -44,6 +46,8 @@ A quick summary of it's usage::
.. autoclass:: HtpasswdFile(path, default=None, autoload=True)
+.. index:: apache; htdigest
+
Htdigest Files
==============
The :class:`!HtdigestFile` class allows management of htdigest files
diff --git a/docs/lib/passlib.apps.rst b/docs/lib/passlib.apps.rst
index ffcb9c6..56ab1da 100644
--- a/docs/lib/passlib.apps.rst
+++ b/docs/lib/passlib.apps.rst
@@ -70,6 +70,8 @@ Passlib provides two contexts related to ldap hashes:
This object recognizes all the standard ldap schemes that :data:`!ldap_context`
does, *except* for the ``{CRYPT}``-based schemes.
+.. index:: mysql; crypt context
+
.. _mysql-contexts:
MySQL
@@ -93,7 +95,7 @@ for handling MySQL user passwords:
This should be used only with MySQL version 3.2.3 - 4.0.
-.. index:: drupal, wordpress, phpbb, phpass
+.. index:: drupal; crypt context, wordpress; crypt context, phpbb3; crypt context, phpass; crypt context
PHPass
======
@@ -114,6 +116,8 @@ It is found in a wide range of PHP applications, including Drupal and Wordpress.
This object supports phpbb3 password hashes, which use a variant of :class:`~passlib.hash.phpass`.
+.. index:: postgres; crypt context
+
PostgreSQL
==========
.. data:: postgres_context
diff --git a/docs/lib/passlib.hash.apr_md5_crypt.rst b/docs/lib/passlib.hash.apr_md5_crypt.rst
index 5203752..a7ad2af 100644
--- a/docs/lib/passlib.hash.apr_md5_crypt.rst
+++ b/docs/lib/passlib.hash.apr_md5_crypt.rst
@@ -1,3 +1,5 @@
+.. index:: apache; md5 password hash
+
======================================================================
:class:`passlib.hash.apr_md5_crypt` - Apache's MD5-Crypt variant
======================================================================
diff --git a/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst b/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
index beed5ca..d6edadb 100644
--- a/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
+++ b/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
@@ -2,8 +2,9 @@
:class:`passlib.hash.atlassian_pbkdf2_sha1` - Atlassian's PBKDF2-based Hash
===========================================================================
-.. index:: atlassian, pbkdf2; password hash
-
+.. index::
+ pair: atlassian; pbkdf2 hash
+
.. currentmodule:: passlib.hash
This class provides an implementation of
diff --git a/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst b/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst
index c220c9f..7b61146 100644
--- a/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst
+++ b/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst
@@ -2,7 +2,7 @@
:class:`passlib.hash.dlitz_pbkdf2_sha1` - Dwayne Litzenger's PBKDF2 hash
========================================================================
-.. index:: pbkdf2; password hash
+.. index:: pbkdf2 hash; dlitz
.. currentmodule:: passlib.hash
diff --git a/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst b/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst
index a9673d3..bde4f70 100644
--- a/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst
+++ b/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst
@@ -2,7 +2,7 @@
:class:`passlib.hash.grub_pbkdf2_sha512` - Grub's PBKDF2 Hash
=============================================================
-.. index:: pbkdf2; password hash
+.. index:: pbkdf2 hash; grub
.. currentmodule:: passlib.hash
diff --git a/docs/lib/passlib.hash.mysql323.rst b/docs/lib/passlib.hash.mysql323.rst
index 81adb09..d6ff729 100644
--- a/docs/lib/passlib.hash.mysql323.rst
+++ b/docs/lib/passlib.hash.mysql323.rst
@@ -1,3 +1,5 @@
+.. index:: mysql; OLD_PASSWORD()
+
========================================================================
:class:`passlib.hash.mysql323` - MySQL 3.2.3 password hash
========================================================================
diff --git a/docs/lib/passlib.hash.mysql41.rst b/docs/lib/passlib.hash.mysql41.rst
index de9f64a..ad1b7cf 100644
--- a/docs/lib/passlib.hash.mysql41.rst
+++ b/docs/lib/passlib.hash.mysql41.rst
@@ -1,3 +1,5 @@
+.. index:: mysql; PASSWORD()
+
=====================================================================
:class:`passlib.hash.mysql41` - MySQL 4.1 password hash
=====================================================================
diff --git a/docs/lib/passlib.hash.phpass.rst b/docs/lib/passlib.hash.phpass.rst
index a185a8c..46378c5 100644
--- a/docs/lib/passlib.hash.phpass.rst
+++ b/docs/lib/passlib.hash.phpass.rst
@@ -1,4 +1,4 @@
-.. index:: phpass; portable hash
+.. index:: phpass; portable hash, phpbb3; phpass hash
==================================================================
:class:`passlib.hash.phpass` - PHPass' Portable Hash
diff --git a/docs/lib/passlib.hash.postgres_md5.rst b/docs/lib/passlib.hash.postgres_md5.rst
index 2aa1c66..3c24f07 100644
--- a/docs/lib/passlib.hash.postgres_md5.rst
+++ b/docs/lib/passlib.hash.postgres_md5.rst
@@ -1,3 +1,5 @@
+.. index:: postgres; md5 hash
+
==================================================================
:class:`passlib.hash.postgres_md5` - PostgreSQL MD5 password hash
==================================================================
@@ -57,7 +59,7 @@ PostgreSQL account passwords, due to the following flaws:
(eg ``admin``, ``root``, ``postgres``) will occur more frequently as salts,
weakening the effectiveness of the salt in foiling pre-computed tables.
-* Since the keyspace of ``user+password`` is still a subset of ascii characters,
+* Since the keyspace of ``user+password`` is still a subset of ascii characters,
existing MD5 lookup tables have an increased chance of being able to reverse common hashes.
* It's simplicity makes high-speed brute force attacks much more feasible.
diff --git a/docs/lib/passlib.hash.rst b/docs/lib/passlib.hash.rst
index 428283b..4824b6a 100644
--- a/docs/lib/passlib.hash.rst
+++ b/docs/lib/passlib.hash.rst
@@ -29,8 +29,8 @@ as in the following example::
.. seealso::
- * the :ref:`password hash api <password-hash-api>` for details of the
- interface used by all password hashes in this module.
+ the :ref:`password-hash-api` details the
+ interface used by all password hashes in this module.
.. _mcf-hashes:
@@ -132,8 +132,6 @@ and are supported by OpenLDAP.
passlib.hash.ldap_crypt
-Also present is a special handler for LDAP plaintext passwords:
-
* :class:`passlib.hash.ldap_plaintext` - LDAP-Aware Plaintext Handler
Non-Standard LDAP Schemes
diff --git a/docs/password_hash_api.rst b/docs/password_hash_api.rst
index e5eb59b..09c4505 100644
--- a/docs/password_hash_api.rst
+++ b/docs/password_hash_api.rst
@@ -12,7 +12,7 @@ Password Hash API
Overview
========
-All of the hashes supported by PassLib are implemented using classes
+All of the hashes supported by PassLib are implemented using classes [#otypes]_
which support an identical interface; this document describes that
interface in terms of a non-existent abstract class called :class:`!PasswordHash`.
All of the supported password hashes [#supported]_ expose (at a minimum) the following:
@@ -458,5 +458,11 @@ the following attributes are usually exposed.
Footnotes
=========
+.. [#otypes] While this specification is written referring to classes and classmethods,
+ password hash handlers can be any type of object (instance, module, etc),
+ so long as they offer attributes and functions with the required
+ signatures. For example, some of the handlers in Passlib are
+ instances of the :class:`~passlib.utils.handlers.PrefixWrapper` class.
+
.. [#supported] all supported password hashes, whether builtin or registered
from an external source can be found in the :mod:`passlib.hash` module.