summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2012-03-10 18:32:30 -0500
committerEli Collins <elic@assurancetechnologies.com>2012-03-10 18:32:30 -0500
commita4d76940ed6b03db079960473e756df4f03fd36b (patch)
tree5ce8b64f2b0e9717ee65e866d892fb1327ef8d13 /docs
parent4b622bf43781a95dfecf42b1998d2fb78de90594 (diff)
downloadpasslib-a4d76940ed6b03db079960473e756df4f03fd36b.tar.gz
doc tweaks
Diffstat (limited to 'docs')
-rw-r--r--docs/lib/passlib.hash.oracle10.rst7
-rw-r--r--docs/lib/passlib.utils.rst9
-rw-r--r--docs/password_hash_api.rst14
3 files changed, 14 insertions, 16 deletions
diff --git a/docs/lib/passlib.hash.oracle10.rst b/docs/lib/passlib.hash.oracle10.rst
index 15deac3..2ef4124 100644
--- a/docs/lib/passlib.hash.oracle10.rst
+++ b/docs/lib/passlib.hash.oracle10.rst
@@ -41,7 +41,7 @@ a username for all encrypt/verify operations)::
True
>>> or10.verify("password", h, "somebody") #verify correct password w/ wrong username
False
- >>> or10.verify("password", h, "username") #verify incorrect password
+ >>> or10.verify("letmein", h, "username") #verify incorrect password
False
Interface
@@ -83,10 +83,10 @@ Oracle10 account passwords, due to the following flaws [#flaws]_:
weakening the effectiveness of the salt in foiling pre-computed tables.
* The fact that it is case insensitive, and simply concatenates the username
- and password, greatly reduces the keyspace that must be searched by
+ and password, greatly reduces the keyspace that must be searched by
brute-force or pre-computed attacks.
-* It's simplicity, and decades of research on high-speed DES
+* It's simplicity, and decades of research on high-speed DES
implementations, makes efficient brute force attacks much more feasible.
Deviations
@@ -118,4 +118,3 @@ There is only one known issue:
.. [#] Description of Oracle10g and Oracle11g algorithms -
`<http://www.notesbit.com/index.php/scripts-oracle/oracle-11g-new-password-algorithm-is-revealed-by-seclistsorg/>`_.
-
diff --git a/docs/lib/passlib.utils.rst b/docs/lib/passlib.utils.rst
index ca82c57..afd27de 100644
--- a/docs/lib/passlib.utils.rst
+++ b/docs/lib/passlib.utils.rst
@@ -117,16 +117,17 @@ Predefined Instances
was replaced by the the ``h64`` and ``h64big`` instances;
the interface remains mostly unchanged.
+Other
+-----
+.. autofunction:: ab64_encode
+.. autofunction:: ab64_decode
+
..
.. data:: AB64_CHARS
Variant of standard Base64 character map used by some
custom Passlib hashes (see :func:`ab64_encode`).
- Other
- -----
- .. autofunction:: ab64_encode
- .. autofunction:: ab64_decode
..
Host OS
diff --git a/docs/password_hash_api.rst b/docs/password_hash_api.rst
index a9aa2c8..67f9ba6 100644
--- a/docs/password_hash_api.rst
+++ b/docs/password_hash_api.rst
@@ -235,16 +235,14 @@ which scheme a hash belongs to when multiple schemes are in use.
.. classmethod:: PasswordHash.identify(hash)
- identify if a hash string belongs to this algorithm.
+ Quickly identify if a hash string belongs to this algorithm.
:arg hash:
the candidate hash string to check
:returns:
- * ``True`` if input appears to be a hash string belonging to this algorithm.
- * ``True`` if input appears to be a configuration string belonging to this algorithm.
- * ``False`` if no input is an empty string or ``None``.
- * ``False`` if none of the above conditions was met.
+ ``True`` if the input appears to be a hash or configuration string
+ which belongs to this algorithm, otherwise ``False``.
.. note::
@@ -278,9 +276,9 @@ which scheme a hash belongs to when multiple schemes are in use.
:raises TypeError: if :samp:`{secret}` is not a bytes or unicode instance.
:raises ValueError:
- * if the hash not specified.
- * if the hash does not match this algorithm's hash format.
- * if the provided secret contains forbidden characters (see
+ * if no hash is provided, or the hash does not match this
+ algorithm's hash format.
+ * if the secret contains forbidden characters (see
:meth:`~PasswordHash.encrypt`).
* if a configuration string from :meth:`~PasswordHash.genconfig`
is passed in as the value for *hash*.