Django Two-Factor Authentication

Complete Two-Factor Authentication for Django. Built on top of the one-time password framework django-otp and Django’s built-in authentication framework django.contrib.auth for providing the easiest integration into most Django projects. Inspired by the user experience of Google’s Two-Step Authentication, allowing users to authenticate through call, text messages (SMS), by using a token generator app like Google Authenticator or a YubiKey hardware token generator (optional).

I would love to hear your feedback on this package. If you run into problems, please file an issue on GitHub, or contribute to the project by forking the repository and sending some pull requests. The package is currently translated into English, Dutch, Hebrew and Arabic. Please contribute your own language using Transifex.

Test drive this app through the online example app, hosted by Heroku. It demos most features except the Twilio integration. The example also includes django-user-sessions for providing Django sessions with a foreign key to the user. Although the package is optional, it improves account security control over django.contrib.sessions.

Compatible with Django 1.4, 1.5, 1.6 and 1.7 on Python 2.6, 2.7, 3.2, 3.3 and 3.4. Documentation is available at readthedocs.org.

Installation

Installation with pip:

$ pip install django-two-factor-auth

Add the following apps to the INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_otp',
    'django_otp.plugins.otp_static',
    'django_otp.plugins.otp_totp',
    'two_factor',
)

Add django_otp.middleware.OTPMiddleware to MIDDLEWARE_CLASSES. It must be installed after AuthenticationMiddleware:

MIDDLEWARE_CLASSES = [
    'django.middleware.common.CommonMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django_otp.middleware.OTPMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
]

Configure a few urls:

from django.core.urlresolvers import reverse_lazy
LOGIN_URL = reverse_lazy('two_factor:login')

Add the url routes:

urlpatterns = patterns('',
    ...
    url(r'', include('two_factor.urls', 'two_factor')),
)

Be sure to remove any other login routes, otherwise the two-factor authentication might be circumvented. The admin interface should be automatically patched to use the new login method.

Support for YubiKey is disabled by default, but enabling is easy. Please refer to the documentation for instructions.

Contribute

Submit issues to the issue tracker on Github
Fork the source code at Github
Run the tests.
Send a pull request with your changes.
Provide a translation using Transifex.

Running tests

This project aims for full code-coverage, this means that your code should be well-tested. Also test branches for hardened code. You can run the full test suite with:

make test

Or run a specific test with:

make test TARGET=tests.tests.TwilioGatewayTest

For Python compatibility, tox is used. You can run the full test suite with:

tox

License

The project is licensed under the MIT license.

Release files for django-two-factor-auth 1.0.0-beta1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-two-factor-auth 1.0.0-beta1
File	Size	Uploaded
django-two-factor-auth-1.0.0-beta1.tar.gz	63.3 kB	Jun 1, 2014	Details

Built distribution (wheel)

Table of built distributions (wheels) for django-two-factor-auth 1.0.0-beta1
File	Interpreter	ABI	Platform	Reset
django_two_factor_auth-1.0.0_beta1-py2.py3-none-any.whl 134.4 kB Jun 1, 2014	Python 2, Python 3	none	any	Details

Total release size: 197.7 kB

Release files / django-two-factor-auth-1.0.0-beta1.tar.gz

Download URL	django-two-factor-auth-1.0.0-beta1.tar.gz
Size	63.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`45465871acb011170dec5b896cf436569e82324556c0456374eecd2de4f9be86`
BLAKE2b-256 checksum How to use checksums	`3abab38ddecbb3cc211505c8ac3b11976e68683e33843c3c2b5934626a950cea`
Upload date	Jun 1, 2014
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / django_two_factor_auth-1.0.0_beta1-py2.py3-none-any.whl

Download URL	django_two_factor_auth-1.0.0_beta1-py2.py3-none-any.whl
Size	134.4 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`7949e68f5c3527d407181b7fdbfca711861aa62f472b2718c125bc4ba47d0dcc`
BLAKE2b-256 checksum How to use checksums	`c82b39ea8776d2c938e17a27d3a47c0bf67e14143723cd4702382cd3aff04913`
Upload date	Jun 1, 2014
Uploaded using Trusted Publishing? What is trusted publishing?	No