Plain is headed towards 1.0! Subscribe for development updates →

plain.password

Password authentication for Plain.

Usage

To enable password authentication in your Plain application, add the PasswordLoginView to your urls.py:

# app/urls.py
from plain.urls import path
from plain.passwords.views import PasswordLoginView

urlpatterns = [
    path('login/', PasswordLoginView.as_view(), name='login'),
    # ...
]

This sets up a basic login view where users can authenticate using their username and password.

FAQs

How do I customize the login form?

To customize the login form, you can subclass PasswordLoginForm and override its fields or methods as needed. Then, set the form_class attribute in your PasswordLoginView to use your custom form.

# app/forms.py
from plain.passwords.forms import PasswordLoginForm

class MyCustomLoginForm(PasswordLoginForm):
    # Add custom fields or override methods here
    pass
# app/views.py
from plain.passwords.views import PasswordLoginView
from .forms import MyCustomLoginForm

class MyPasswordLoginView(PasswordLoginView):
    form_class = MyCustomLoginForm

Update your urls.py to use your custom view:

# app/urls.py
from plain.urls import path
from .views import MyPasswordLoginView

urlpatterns = [
    path('login/', MyPasswordLoginView.as_view(), name='login'),
    # ...
]
 1from .hashers import check_password, hash_password
 2
 3
 4def check_user_password(user, password):
 5    # Run the default password hasher once to reduce the timing
 6    # difference between an existing and a nonexistent user (#20760).
 7    hash_password(password)
 8
 9    # Update the stored hashed password if the hashing algorithm changed
10    def setter(raw_password):
11        user.password = raw_password
12        user.save(update_fields=["password"])
13
14    password_is_correct = check_password(password, user.password, setter)
15
16    return password_is_correct