summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul McMillan <Paul@McMillan.ws>2012-03-02 05:03:52 +0000
committerPaul McMillan <Paul@McMillan.ws>2012-03-02 05:03:52 +0000
commita255d3933828ea5ab5173bc41336a64f446057bb (patch)
tree6d9b9c19f834f13343975442225a074b342ed9d9 /docs
parent84dd83f0185687adfe44452afb2fc9cff15ba594 (diff)
Fixed 17764. Improved auth docs.
Thanks mbt for the report and patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@17620 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/releases/1.4.txt2
-rw-r--r--docs/topics/auth.txt12
2 files changed, 8 insertions, 6 deletions
diff --git a/docs/releases/1.4.txt b/docs/releases/1.4.txt
index de4cdadc3c..53387c1726 100644
--- a/docs/releases/1.4.txt
+++ b/docs/releases/1.4.txt
@@ -536,7 +536,7 @@ Django 1.4 also includes several smaller improvements worth noting:
page.
* The :func:`django.contrib.auth.models.check_password` function has been moved
- to the :mod:`django.contrib.auth.utils` module. Importing it from the old
+ to the :mod:`django.contrib.auth.hashers` module. Importing it from the old
location will still work, but you should update your imports.
* The :djadmin:`collectstatic` management command now has a ``--clear`` option
diff --git a/docs/topics/auth.txt b/docs/topics/auth.txt
index 3b6ad1b77d..08a8f342c5 100644
--- a/docs/topics/auth.txt
+++ b/docs/topics/auth.txt
@@ -760,18 +760,20 @@ Django provides two functions in :mod:`django.contrib.auth`:
Manually managing a user's password
-----------------------------------
-.. currentmodule:: django.contrib.auth.utils
+.. currentmodule:: django.contrib.auth.hashers
.. versionadded:: 1.4
- The :mod:`django.contrib.auth.utils` module provides a set of functions
+ The :mod:`django.contrib.auth.hashers` module provides a set of functions
to create and validate hashed password. You can use them independently
from the ``User`` model.
.. function:: check_password()
+ .. versionadded:: 1.4
+
If you'd like to manually authenticate a user by comparing a plain-text
password to the hashed password in the database, use the convenience
- function :func:`django.contrib.auth.utils.check_password`. It takes two
+ function :func:`django.contrib.auth.hashers.check_password`. It takes two
arguments: the plain-text password to check, and the full value of a
user's ``password`` field in the database to check against, and returns
``True`` if they match, ``False`` otherwise.
@@ -785,14 +787,14 @@ Manually managing a user's password
Currently supported algorithms are: ``'sha1'``, ``'md5'`` and ``'crypt'``
if you have the ``crypt`` library installed. If the second argument is
``None``, an unusable password is returned (a one that will be never
- accepted by :func:`django.contrib.auth.utils.check_password`).
+ accepted by :func:`django.contrib.auth.hashers.check_password`).
.. function:: is_password_usable()
.. versionadded:: 1.4
Checks if the given string is a hashed password that has a chance
- of being verified against :func:`django.contrib.auth.utils.check_password`.
+ of being verified against :func:`django.contrib.auth.hashers.check_password`.
How to log a user out