Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/betagouv/django-magicauth
Password-less authentication for Django. An email with a magic link allows a secure login
https://github.com/betagouv/django-magicauth
Last synced: 12 days ago
JSON representation
Password-less authentication for Django. An email with a magic link allows a secure login
- Host: GitHub
- URL: https://github.com/betagouv/django-magicauth
- Owner: betagouv
- License: mit
- Created: 2019-09-05T09:32:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-17T07:40:50.000Z (8 months ago)
- Last Synced: 2024-04-17T22:48:34.530Z (8 months ago)
- Language: Python
- Size: 166 KB
- Stars: 64
- Watchers: 9
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Magicauth
Django Magicauth brings password-less authentication to your project.
*How it works*
- The user inputs their email address (and optionnally an OTP).
- An email is sent to the user with a link that contains a one-time token.
- Once they click on this link, they are logged in to the service.
For a detailed step-by-step with screenshots of the default templates, see [Step-by-step in pictures](#step-by-step-in-pictures).
## Fonctionnement (FR)
Authentifiez vos utilisateurs sans mot de passe avec Django Magicauth.
*Comment ça marche*
- Les utilisateurs renseignent leur adresse email (et en option un OTP).
- Ils reçoivent alors un email avec un lien de connexion.
- Lorsqu'ils cliquent sur le lien, ils sont authentifiés et redirigés sur le service.
Pour un détail du fonctionnement en image, voir le [déroulé en images](#step-by-step-in-pictures).
# Installations and testing instructions
## Quick start
1. Install Magicauth
```sh
pip install git+https://github.com/betagouv/django-magicauth.git
```
2. Add "magicauth" to your INSTALLED_APPS in `settings.py`
```python
INSTALLED_APPS = [
# all your apps
"magicauth",
]
```
2. Include the magicauth URLconf in your app's `url.py`
```python
# After your previous imports
from magicauth import views as magicauth_views
from magicauth.urls import urlpatterns as magicauth_urls
urlpatterns = [
# here are your URL patterns
]
urlpatterns.extend(magicauth_urls)
```
3. Add the following items in your project's settings.py`
```
MAGICAUTH_FROM_EMAIL = '[email protected]'
MAGICAUTH_LOGGED_IN_REDIRECT_URL_NAME = 'home'
```
4. Run `python manage.py migrate` to create the polls models.
5. Setup your [mailer](https://docs.djangoproject.com/en/2.2/topics/email/#console-backend) in `settings.py`
In dev mode, you can use a [console mailer](https://docs.djangoproject.com/en/2.2/topics/email/#console-backend)
6. Make sure you have the following middlewares
```
MIDDLEWARE = [
# [...] other middleware you may have
"django.contrib.sessions.middleware.SessionMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.sites.middleware.CurrentSiteMiddleware",
]
```
## Two-Factor Authentication (2FA) using One Time Passwords (OTP)
Two-Factor Authentication means you ask for two different passwords from your user : their normal password and an OTP. (See https://en.wikipedia.org/wiki/Multi-factor_authentication)
They will get the magic link only if the two are valid, else they get an error and the link is not sent.
What is a OTP ? It is a short code (6 to 8 digits), usually generated by a dedicated app on a user's device (smartphone, hardware). See https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm
### How to enable OTPs
We use the [django-otp](https://django-otp-official.readthedocs.io/en/stable/) package. You must have it installed and configured in your project.
1. install django_otp : `pip install django_otp` (or whatever package manager you use)
2. add the required apps in INSTALLED_APPS : `'django_otp'`, `'django_otp.plugins.otp_totp'`
3. run the migrations in your project : `python manage.py migrate`
4. Set `MAGICAUTH_ENABLE_2FA = True` in your settings.py
If you use the default login template, an OTP input will show up in the login page, below the Email. (To check your install has worked, you can revert to the default template and see if the field appears : remove your MAGICAUTH_LOGIN_VIEW_TEMPLATE var.)
If you have a custom login template, you will have to add the field for entering OTPs, in an `OTP_form`. See the default login template for an example : templates/magicauth/login.html`
For testing purposes, you can generate OTPs for a given user from the command line :
- Add 'django_otp.plugins.otp_static' to INSTALLED_APPS.
- Then you can use [addstatictoken](https://django-otp-official.readthedocs.io/en/stable/overview.html#addstatictoken) from command line. E.g :
`python manage.py addstatictoken -t 123456 "[email protected]"`
## Contribute to Magicauth
To contribute to Magicauth, you can install the package in the "editable" mode
```
pip uninstall django-magicauth # just in case...
pip install -e git+https://github.com/betagouv/django-magicauth.git#egg=django-magicauth
```
You can also install a specific branch, for instance for testing a PR. To install branch `my-branch`:
```
pip install -e git+https://github.com/betagouv/django-magicauth.git@my-branch#egg=django-magicauth
```
Django-magicauth is now a dependency of your project, and you can edit the code located here:
```
cd src/django-magicauth
```
### run tests
Create a virtual env for the project or reuse one and source it.
Install dependencies and run `tox`
```
cd src/django-magicauth
pip install -r -U dev-requirements.txt
tox
```
We use `pre-commit` to ensure code correctness. You should install it:
```shell
pre-commit install
```
### Release process
The follwing dependencies need to be installed: `pip setuptools wheel twine`:
```shell
python -m pip install --upgrade pip setuptools wheel twine
```
First, ensure code is clean:
```shell
pip install -U pre-commit
pre-commit install
pre-commit autoupdate
pre-commit
```
1. Create a new MD file under `docs/releases` named after the new version and fill the file with the changes
2. Change the version in `pyproject.toml`
3. Create a commit named *Release version *
4. Open and merge the PR for that release
5. Create a new release at https://github.com/betagouv/django-magicauth/releases/new
6. Publish the new version on PyPI:
```shell
python setup.py sdist bdist_wheel
twine upload dist/*
```
# Projects using Magicauth
https://github.com/betagouv/e-controle/
https://github.com/betagouv/Aidants_Connect
https://github.com/betagouv/peps
https://github.com/betagouv/urbanvitaliz-django
Join us !
# Security contact
If you think you found a security problem on `django-magicauth`, you can contact us at [email protected]
# Step-by-step in pictures
Note : the screenshots below use the default templates, which don't look very nice. It is expected that you replace them with your own better-looking ones.
Step 1 : the user goes to the login page. (see `LoginView` in `magicauth/views.py`)
Step 2 : The user inputs their email address in the login page.
Step 3 : The user sees a confirmation page (`EmailSentView`), explaining that an email has been sent.
An email is sent to the user with a link that contains a one-time token.
The link looks something like this :
Step 4 : once they click on the button and follow the link, the user is directed to a wait page (this is optional) (`WaitView`)
Step 5 : the user is logged in to the service (`ValidateTokenView`) and redirected to the landing page.
