Yet Another Implementation of One-Time-Password-Authentication for Django
Project description
[![CI]][CI Link] [![CovSt]][CovStLink] [![GPA]][GPALink] [CI]: https://travis-ci.org/hiroaki-yamamoto/django-good-otp.svg?branch=master [CI Link]: https://travis-ci.org/hiroaki-yamamoto/django-good-otp [CovSt]: https://coveralls.io/repos/github/hiroaki-yamamoto/django-good-otp/badge.svg?branch=master [CovStLink]: https://coveralls.io/github/hiroaki-yamamoto/django-good-otp?branch=master [GPA]: https://codeclimate.com/github/hiroaki-yamamoto/django-good-otp/badges/gpa.svg [GPALink]: https://codeclimate.com/github/hiroaki-yamamoto/django-good-otp
What This?
This script is “Yet Another Implementation” of 2 factor authentication.
Why I re-invent?
First, I tried Django OTP, but 2 FA code is required though it should be optional. Moreover, Admin Panel to edit/fix secret key is not provided.
Then, I tried django-two-factor-auth, but I found it is the wrapper of Django OTP that requires 2FA code to the user who doesn’t have 2FA enabled.
How to use
Install this script. There’s pip package and you can install it by pip install django_good_otp.
Create a Django project as usual.
Edit settings.py. You will need to edit INSTALLED_APPS and AUTHENTICATION_BACKENDS. For detail, refer Edit Settings section.
Run migration as usual.
Edit url.py of your root URL config to enable QR Code. For details, Check out URL Routing section.
To enable admin panel, you will need to write very small code. For details, Check out Enable Admin Panel section.
To use 2FA on Admin panel login, you will also need to write very simple code. For details, Check out Enable Admin Panel section.
Edit settings
You will need to edit configuration such settings.py. The variable to edit is INSTALLED_APPS and AUTHENTICATION_BACKENDS.
INSTALLED_APPS
You will just need to add 'django_otp.DjangoOTP' after 'django.contrib.auth' i.e. it should be like this:
settings.py python INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', "django_otp.DjangoOTP" ]
Note that this depends on the case. i.e. If you have more apps installed/uninstalled, your INSTALLED_APPS list might be longer/shorter than this.
AUTHENTICATION_BACKENDS
To use 2 FA, you will need to replace authentication backend with the backend this module provides. i.e. just set AUTHENTICATION_BACKENDS in settings.py to ("django_otp.backends.OTPAuthBackend", ). i.e. like this:
settings.py python AUTHENTICATION_BACKENDS = ("django_otp.backends.OTPAuthBackend", )
URL Routing
This module supports QRCode to transfer Secret Key to your device. To use it, you will need to add django_otp.urls with include function like this:
urls.py ```python from django.conf.urls import url, include from django.contrib import admin
urlpatterns = [ url(r’^admin/’, admin.site.urls), url(r’^qr/’, include(“django_otp.urls”)) ] ```
Enable Admin Panel
Admin Panel
By default, Admin Panel of the model that stores secret key is disabled. To enable Admin Panel, you will need to call OTPAdmin.enable() method like this:
urls.py ```python from django.conf.urls import url, include from django.contrib import admin from django_otp.admin import OTPAdmin
OTPAdmin.enable()
urlpatterns = [ url(r’^admin/’, admin.site.urls), url(r’^qr/’, include(“django_otp.urls”)) ] ```
Using 2FA form on adminsite
Unfortunately, login template of administration site doesn’t handle custom login form. Therefore, to use 2FA-ready admin form, you will need to replace admin.site with django_otp.admin.AdminSite. i.e. like this:
urls.py ```python from django.conf.urls import url, include from django.contrib import admin
from django_otp.admin import AdminSite
OTPAdmin.enable()
urlpatterns = [ url(r’^admin/’, admin.site.urls), url(r’^qr/’, include(“django_otp.urls”)) ] ```
Other stuff
For other stuff that is not documented here, please refer the source code.
Contribution
The code is on Github and you can create issues/PRs. Making issues is appreciated, however, making PRs is more appreciated.
License (MIT)
The MIT License (MIT) Copyright (c) 2016- Hiroaki Yamamoto
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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.
