Drop-in multifactor authentication subsystem for Django.
Project description
The easiest multi-factor for Django? Ships with opinionated defaults, standalone authentication screens and very simple integration pathway to retrofit onto mature sites.
Supports TOTP, U2F, FIDO2 U2F (WebAuthn), Email Tokens. This is not a passwordless authentication system. django-multifactor is purely additive.
Based on django-mfa2
but quickly diverging.
FIDO2/WebAuthn is the big-ticket item for MFA. It allows the browser to interface with a myriad of biometric and secondary authentication factors.
- Security keys (Firefox 60+, Chrome 67+, Edge 18+),
- Windows Hello (Firefox 67+, Chrome 72+ , Edge) ,
- Apple's Touch ID (Chrome 70+ on Mac OS X ),
- android-safetynet (Chrome 70+)
- NFC devices using PCSC (Not Tested, but as supported in fido2)
This project targets modern stacks. Django 2.2+ and Python 3.5+.
Installation:
Install the package:
pip install django-multifactor
Add multifactor
to settings.INSTALLED_APPS
.
Add and customise the following settings block:
MULTIFACTOR = {
'LOGIN_CALLBACK': False, # False, or dotted import path to function to process after successful authentication
'RECHECK': True, # Invalidate previous authorisations at random intervals
'RECHECK_MIN': 60 * 60 * 3, # No recheks before 3 hours
'RECHECK_MAX': 60 * 60 * 6, # But within 6 hours
'FIDO_SERVER_ID': 'example.com', # Server ID for FIDO request
'FIDO_SERVER_NAME': 'Django App', # Human-readable name for FIDO request
'TOKEN_ISSUER_NAME': 'Django App', # TOTP token issuing name (to be shown in authenticator)
'U2F_APPID': 'https://example.com', # U2F request issuer
}
Ensure that django.contrib.messages
is installed.
Include multifactor.urls
in your URLs. You can do this anywhere but I suggest somewhere similar to your login URLs, or underneath them, eg:
urlpatterns = [
path('admin/multifactor/', include('multifactor.urls')),
path('admin/', admin.site.urls),
...
]
And don't forget to run a ./manage.py collectstatic
before restarting Django.
Usage
At this stage any authenticated user can add a secondary factor to their account by visiting (eg) /admin/multifactor/
, but no view will require secondary authentication. django-multifactor gives you granular control to conditionally require certain users need a secondary factor on certain views. This is accomplished through the multifactor.decorators.multifactor_protected
decorator.
from multifactor.decorators import multifactor_protected
@multifactor_protected(factors=0, user_filter=None, max_age=0, advertise=False)
def my_view(request):
...
factors
is the minimum number of active, authenticated secondary factors. 0 will mean users will only be prompted if they have keys. It can also accept a lambda/function with one request argument that returns a number. This allows you to tune whether factors are required based on custom logic (eg if local IP return 0 else return 1)user_filter
can be a dictonary to be passed toUser.objects.filter()
to see if the current user matches these conditions. If empty or None, it will match all users.max_age=600
will ensure the the user has authenticated with their secondary factor within 10 minutes. You can tweak this for higher security at the cost of inconvenience.advertise=True
will send an info-level message via django.contrib.messages with a link to the main django-multifactor page that allows them to add factors for future use. This is useful to increase optional uptake when introducing multifactor to an organisation.
You can also wrap entire branches of your URLs using django-decorator-include
:
from decorator_include import decorator_include
from multifactor.decorators import multifactor_protected
urlpatterns = [
path('admin/multifactor/', include('multifactor.urls')),
path('admin/', decorator_include(multifactor_protected(factors=1), admin.site.urls)),
...
]
User Admin integration
It's often useful to monitor which of your users is using django-multifactor and, in emergencies, critical to be able to turn their secondary factors off. We ship a opinionated mixin class that you can add to your existing UserAdmin definition.
from multifactor.admin import MultifactorUserAdmin
@admin.register(User)
class StaffAdmin(UserAdmin, MultifactorUserAdmin):
...
It adds a column to show if that user has active factors, a filter to just show those with or without, and an inline to allow admins to turn certain keys off for their users.
TODO
- Allow custom handlers for simple OTP sending.
- Allow settings to limit what can be added.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_multifactor-0.1.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 268594e4854a2932c94ff52b9a90f009997b293b6a432af9df3cb640de2c4f0b |
|
MD5 | 99e203474d03b94c9c99cdb1f62ad803 |
|
BLAKE2b-256 | 91e02d09a39fbcb932ed03f211ea3b03b86392bb4bd2bd4d7b203b67f1150168 |