p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Doc's check_password()'s setter and preferred arguments. 

Follow up to 90e05aaeac.
This commit is contained in:
Mariusz Felisiak 2022-11-28 08:13:51 +01:00 committed by GitHub
parent 64b3c413da
commit 662497cece
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/topics/auth/passwords.txt
View File

@ -474,14 +474,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')