Skip to main content

Django MailAuth: Secure login links; no passwords required!

Django Mail Auth

version Documentation Status coverage license

Django Mail Auth is a lightweight authentication backend for Django, that does not require users to remember passwords.

Django Mail Auth features:

  • custom user model support
  • drop in Django admin support
  • drop in Django User replacement
  • drop in Wagtail login replacement
  • extendable SMS support

{alt="screenshot from a login form" width="425px"}

This project was inspired by:

Installation

Run this command to install django-mail-auth:

python3 -m pip install django-mail-auth[wagtail]

Setup

First add mailauth to you installed apps:

INSTALLED_APPS = [
    # Django's builtin apps…
    "mailauth",
    "mailauth.contrib.admin",  # optional
    "mailauth.contrib.user",  # optional
    # optional, must be included before "wagtail.admin"
    "mailauth.contrib.wagtail",
    # other apps…
]

mailauth.contrib.admin is optional and will replace the admin's login with token based authentication too.

mailauth.contrib.user is optional and provides a new Django User model. The new User model needs to be enabled via the AUTH_USER_MODEL setting:

# This setting should be either "EmailUser" or
# any custom subclass of "AbstractEmailUser"
AUTH_USER_MODEL = "mailauth_user.EmailUser"

# optional, Wagtail only
WAGTAILUSERS_PASSWORD_ENABLED = False

Next you will need to add the new authentication backend:

AUTHENTICATION_BACKENDS = (
    # default, but now optional
    # This should be removed if you use mailauth.contrib.user or any other
    # custom user model that does not have a username/password
    "django.contrib.auth.backends.ModelBackend",
    # The new access token based authentication backend
    "mailauth.backends.MailAuthBackend",
)

Django's ModelBackend is only needed, if you still want to support password based authentication. If you don't, simply remove it from the list.

Last but not least, go to your URL root configuration urls.py and add the following:

from django.urls import path


urlpatterns = [
    path("accounts/", include("mailauth.urls")),
    # optional, must be before "wagtail.admin.urls"
    path("", include("mailauth.contrib.wagtail.urls")),
]

That's it!

[!IMPORTANT] Don't forget to setup you Email backend!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_mail_auth-3.5.3.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_mail_auth-3.5.3-py3-none-any.whl (26.7 kB view details)

Uploaded Python 3

File details

Details for the file django_mail_auth-3.5.3.tar.gz.

File metadata

  • Download URL: django_mail_auth-3.5.3.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_mail_auth-3.5.3.tar.gz
Algorithm Hash digest
SHA256 fb2fd1f0652cd5e02a6f2e21c74cf7b01878f05c2a9fd903d2c3122e93df97f3
MD5 50e5e0b9add5184dddebd159f40f9254
BLAKE2b-256 a05f2c30e44f8938e7e072a9eca60d6ac051409b3c78454165a9e6243ad30a61

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_mail_auth-3.5.3.tar.gz:

Publisher: release.yml on codingjoe/django-mail-auth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_mail_auth-3.5.3-py3-none-any.whl.

File metadata

File hashes

Hashes for django_mail_auth-3.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fea8007633644790b7243de09d55e2ced563c68c7a4bd4e2645c2782eacd5def
MD5 c5fb56358455811b1f509fcb8c5ccc4a
BLAKE2b-256 80a585ce4401c6641217daf892324b7faec45160a0e12579b647d076efac30d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_mail_auth-3.5.3-py3-none-any.whl:

Publisher: release.yml on codingjoe/django-mail-auth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

3.5.5

2 files

3.5.4

2 files

This release

3.5.3 This release

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.1

2 files

3.4.0

2 files

3.3.0

2 files

3.2.2

2 files

3.2.1

2 files

3.2.0

2 files

3.1.4

2 files

3.1.3

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.1

2 files

3.0.0

2 files

2.1.3

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page