Metadata-Version: 2.1
Name: django-multifactor
Version: 0.3.3
Summary: Drop-in multifactor authentication subsystem for Django.
Home-page: https://github.com/oliwarner/django-multifactor
Author: Oli Warner
Author-email: oli@thepcspy.com
License: MIT
Download-URL: https://github.com/oliwarner/django-multifactor
Description: # ![django-multifactor - Easy multi-factor authentication for Django](https://raw.githubusercontent.com/oliwarner/django-multifactor/master/logo3.png)
        
        Probably the easiest multi-factor for Django. Ships with standalone views, opinionated defaults 
        and a very simple integration pathway to retrofit onto mature sites. Supports [FIDO2/WebAuthn](https://en.wikipedia.org/wiki/WebAuthn)
        [U2F](https://en.wikipedia.org/wiki/Universal_2nd_Factor) and [TOTP authenticators](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm), with removable fallbacks options for email, SMS, carrier pigeon, or whatever other token
        exchange you can think of.
        
        This is ***not*** a passwordless authentication system. django-multifactor is a second layer of defence.
        
        Based on [`django-mfa2`](https://pypi.org/project/django-mfa2/) but quickly diverging.
        
        [![PyPI version](https://badge.fury.io/py/django-multifactor.svg)](https://badge.fury.io/py/django-multifactor)
        
        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` and override whichever setting you need.
        
            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`](https://docs.djangoproject.com/en/2.2/ref/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 to `User.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`](https://pypi.org/project/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)),
                ...
            ]
        
        
        ## Don't want to allow TOTP or U2F? Turn them off.
        
        You can control the factors users can pick from in `settings.MULTIFACTOR`:
        
            MULTIFACTOR = {
                # ...
                'FACTORS': ['FIDO2', 'U2F', 'TOTP'],  # <- this is the default
            }
        
        
        ## Extending OTP fallback with custom transports
        
        `django-multifactor` has a fallback system that allows the user to be contacted via a number of sub-secure methods **simultaneously**. The rationale is that if somebody hacks their email account, they'll still know something is going on when they get an SMS. Providing sane options for your users is critical to security here. A poor fallback can undermine otherwise solid factors.
        
        The included fallback uses `user.email` to send an email. You can plumb in additional functions to carry the OTP message over any
        other system you like. The function should look something like:
        
            def send_carrier_pigeon(user, message):
                bird = find_bird()
                bird.attach(message)
                bird.send(user.address)
                return True  # to indicate it sent
        
        Then hook that into `settings.MULTIFACTOR`:
        
            MULTIFACTOR = {
                # ...
                'FALLBACKS': {
                    'email': (lambda user: user.email, 'multifactor.factors.fallback.send_email'),
                    'pigeon': (lambda user: user.address, 'path.to.send_carrier_pigeon'),
                }
            }
        
        Now if the user selects the fallback option, they will receive an email *and* a pigeon. You can remove email by omitting that line. You can disable fallback entirely by setting FALLBACKS to an empty dict.
        
        
        ## UserAdmin 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.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5
Description-Content-Type: text/markdown
