Skip to content

Commit

Permalink
[4.1.x] Doc's check_password()'s setter and preferred arguments.
Browse files Browse the repository at this point in the history
Follow up to 90e05aa.
Backport of 662497c from main
  • Loading branch information
felixxm committed Nov 28, 2022
1 parent 8a623d1 commit 44f7550
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions docs/topics/auth/passwords.txt
Expand Up @@ -485,14 +485,18 @@ The :mod:`django.contrib.auth.hashers` module provides a set of functions
to create and validate hashed passwords. You can use them independently
from the ``User`` model.

.. function:: check_password(password, encoded)
.. function:: check_password(password, encoded, setter=None, preferred="default")

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:`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.
function :func:`check_password`. It takes two mandatory arguments: the
plain-text password to check, and the full value of a user's ``password``
field in the database to check against. It returns ``True`` if they match,
``False`` otherwise. Optionally, you can pass a callable ``setter`` that
takes the password and will be called when you need to regenerate it. You
can also pass ``preferred`` to change a hashing algorithm if you don't want
to use the default (first entry of ``PASSWORD_HASHERS`` setting). See
:ref:`auth-included-hashers` for the algorithm name of each hasher.

.. function:: make_password(password, salt=None, hasher='default')

Expand Down

0 comments on commit 44f7550

Please sign in to comment.