Compare commits

...

9 Commits

Author SHA1 Message Date
Mohamed ElKalioby
85b4a25956 v2.3.0 #done 2021-09-21 20:23:39 +03:00
Mohamed ElKalioby
7415b169c9 Merge branch 'mnelson4-use-super-block' into v2.2.1 2021-09-21 19:52:55 +03:00
Mike Nelson
3d8d970701 use block.super for more friendly overriding of parent blocks 2021-09-16 14:38:38 -07:00
Mohamed El-Kalioby
3f41cff8c3 Add AndreasDickow to Contributors 2021-09-05 12:01:50 +03:00
Mohamed El-Kalioby
1c95f196fe Update CHANGELOG.md 2021-09-05 12:00:38 +03:00
Mohamed El-Kalioby
a841bde6cc Merge pull request #52 from AndreasDickow/master 2021-08-11 12:22:47 +03:00
Andreas Dickow
41b7bd2929 Fix missing import of get_redirect_url in totp and U2F 2021-08-11 11:18:12 +02:00
Mohamed El-Kalioby
6cfc4ff5d4 Fix example link 2021-06-25 10:18:53 +03:00
Mohamed ElKalioby
7a154cfa34 Releasing v2.2.0 2021-05-30 09:24:25 +03:00
11 changed files with 57 additions and 17 deletions

View File

@@ -1,7 +1,12 @@
# Change Log # Change Log
## 2.3.0
* Fixed: A missing import Thanks @AndreasDickow
* Fixed: `MFA.html` now call `{{block.super}}` for head and content blocks
* Added: #55 introduced `mfa_base.html` which will be extended by `MFA.html` for better styling
## 2.2.0 (Not released) ## 2.2.0
* Added: MFA_REDIRECT_AFTER_REGISTRATION settings parameter * Added: MFA_REDIRECT_AFTER_REGISTRATION settings parameter
* Fixed: Deprecation error for NULBooleanField
## 2.1.2 ## 2.1.2
* Fixed: Getting timestamp on Python 3.7 as ("%s") is raising an exception * Fixed: Getting timestamp on Python 3.7 as ("%s") is raising an exception
@@ -9,7 +14,7 @@
## 2.1.1 ## 2.1.1
* Fixed: FIDO2 version in requirments.txt file. * Fixed: FIDO2 version in requirements.txt file.
## 2.1.0 ## 2.1.0
* Added Support for Touch ID for Mac OSx and iOS 14 on Safari * Added Support for Touch ID for Mac OSx and iOS 14 on Safari

View File

@@ -60,9 +60,9 @@ Depends on
'mfa', 'mfa',
'......') '......')
``` ```
1. Collect Static Files 2. Collect Static Files
`python manage.py collectstatic` `python manage.py collectstatic`
1. Add the following settings to your file 3. Add the following settings to your file
```python ```python
MFA_UNALLOWED_METHODS=() # Methods that shouldn't be allowed for the user MFA_UNALLOWED_METHODS=() # Methods that shouldn't be allowed for the user
@@ -95,7 +95,7 @@ Depends on
* Starting version 1.7.0, Key owners can be specified. * Starting version 1.7.0, Key owners can be specified.
* Starting version 2.2.0 * Starting version 2.2.0
* Added: `MFA_SUCCESS_REGISTRATION_MSG` & `MFA_REDIRECT_AFTER_REGISTRATION` * Added: `MFA_SUCCESS_REGISTRATION_MSG` & `MFA_REDIRECT_AFTER_REGISTRATION`
1. Break your login function 4. Break your login function
Usually your login function will check for username and password, log the user in if the username and password are correct and create the user session, to support mfa, this has to change Usually your login function will check for username and password, log the user in if the username and password are correct and create the user session, to support mfa, this has to change
@@ -115,7 +115,7 @@ Depends on
return log_user_in(request,username=user.username) return log_user_in(request,username=user.username)
#log_user_in is a function that handles creatung user session, it should be in the setting file as MFA_CALLBACK #log_user_in is a function that handles creatung user session, it should be in the setting file as MFA_CALLBACK
``` ```
1. Add mfa to urls.py 5. Add mfa to urls.py
```python ```python
import mfa import mfa
import mfa.TrustedDevice import mfa.TrustedDevice
@@ -126,14 +126,15 @@ Depends on
'....', '....',
] ]
``` ```
1. Provide `mfa_auth_base.html` in your templaes with block called 'head' and 'content' 6. Provide `mfa_auth_base.html` in your templates with block called 'head' and 'content', The template will be included during the user login, the template shall be close to the login template.
The template will be included during the user login.
If you will use Email Token method, then you have to provide template named `mfa_email_token_template.html` that will content the format of the email with parameter named `user` and `otp`. If you will use Email Token method, then you have to provide template named `mfa_email_token_template.html` that will content the format of the email with parameter named `user` and `otp`.
1. To match the look and feel of your project, MFA includes `base.html` but it needs blocks named `head` & `content` to added its content to it. 7. To match the look and feel of your project, MFA includes `base.html` but it needs blocks named `head` & `content` to added its content to it.
1. Somewhere in your app, add a link to 'mfa_home' **Note:** Starting v2.3.0, a new template `mfa_base.html` is introduced, this template is used by `MFA.html` so you can control the styling better and current `mfa_base.html` extends `base.html`
8. Somewhere in your app, add a link to 'mfa_home'
```<li><a href="{% url 'mfa_home' %}">Security</a> </li>``` ```<li><a href="{% url 'mfa_home' %}">Security</a> </li>```
For Example, See https://github.com/mkalioby/AutoDeploy/commit/5f1d94b1804e0aa33c79e9e8530ce849d9eb78cc in AutDeploy Project
For Example, See 'example' app
# Going Passwordless # Going Passwordless
@@ -182,6 +183,8 @@ function some_func() {
* [swainn](https://github.com/swainn) * [swainn](https://github.com/swainn)
* [unramk](https://github.com/unramk) * [unramk](https://github.com/unramk)
* [willingham](https://github.com/willingham) * [willingham](https://github.com/willingham)
* [AndreasDickow](https://github.com/AndreasDickow)
* [mnelson4](https://github.com/mnelson4)
# Security contact information # Security contact information

View File

@@ -28,6 +28,7 @@
<div class="card-header">Login</div> <div class="card-header">Login</div>
<div class="card-body"> <div class="card-body">
{% block content %} {% block content %}
{% endblock %} {% endblock %}
</div> </div>
</div> </div>

View File

@@ -12,6 +12,7 @@ from django.conf import settings
from django.http import HttpResponse from django.http import HttpResponse
from .models import * from .models import *
from .views import login from .views import login
from .Common import get_redirect_url
import datetime import datetime
from django.utils import timezone from django.utils import timezone

View File

@@ -1 +1 @@
__version__="2.2.0b1" __version__="2.2.0"

View File

@@ -0,0 +1,18 @@
# Generated by Django 2.2 on 2021-05-30 06:22
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('mfa', '0010_auto_20201110_0557'),
]
operations = [
migrations.AlterField(
model_name='user_keys',
name='owned_by_enterprise',
field=models.BooleanField(blank=True, default=None, null=True),
),
]

View File

@@ -15,7 +15,7 @@ class User_Keys(models.Model):
enabled=models.BooleanField(default=True) enabled=models.BooleanField(default=True)
expires=models.DateTimeField(null=True,default=None,blank=True) expires=models.DateTimeField(null=True,default=None,blank=True)
last_used=models.DateTimeField(null=True,default=None,blank=True) last_used=models.DateTimeField(null=True,default=None,blank=True)
owned_by_enterprise=models.NullBooleanField(default=None,null=True,blank=True) owned_by_enterprise=models.BooleanField(default=None,null=True,blank=True)
def save(self, force_insert=False, force_update=False, using=None, update_fields=None): def save(self, force_insert=False, force_update=False, using=None, update_fields=None):
if self.key_type == "Trusted Device" and self.properties.get("signature","") == "": if self.key_type == "Trusted Device" and self.properties.get("signature","") == "":

View File

@@ -1,6 +1,7 @@
{% extends "base.html" %} {% extends "mfa_base.html" %}
{% load static %} {% load static %}
{% block head %} {% block head %}
{{block.super}}
<script type="text/javascript"> <script type="text/javascript">
function confirmDel(id) { function confirmDel(id) {
$.ajax({ $.ajax({
@@ -39,6 +40,7 @@
<script src="{% static 'mfa/js/bootstrap-toggle.min.js'%}"></script> <script src="{% static 'mfa/js/bootstrap-toggle.min.js'%}"></script>
{% endblock %} {% endblock %}
{% block content %} {% block content %}
{{block.super}}
<br/> <br/>
<br/> <br/>
<div class="container"> <div class="container">

View File

@@ -0,0 +1,7 @@
{% extends 'base.html' %}
{% block head %}
{{ block.super }}
{% endblock %}
{% block content %}
{{ block.super }}
{% endblock %}

View File

@@ -1,6 +1,7 @@
from django.shortcuts import render from django.shortcuts import render
from django.views.decorators.cache import never_cache from django.views.decorators.cache import never_cache
from django.http import HttpResponse from django.http import HttpResponse
from .Common import get_redirect_url
from .models import * from .models import *
from django.template.context_processors import csrf from django.template.context_processors import csrf
import simplejson import simplejson

View File

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
setup( setup(
name='django-mfa2', name='django-mfa2',
version='2.2.0b1', version='2.3.0',
description='Allows user to add 2FA to their accounts', description='Allows user to add 2FA to their accounts',
long_description=open("README.md").read(), long_description=open("README.md").read(),
long_description_content_type="text/markdown", long_description_content_type="text/markdown",
@@ -31,12 +31,14 @@ setup(
include_package_data=True, include_package_data=True,
zip_safe=False, # because we're including static files zip_safe=False, # because we're including static files
classifiers=[ classifiers=[
"Development Status :: 4 - Beta", "Development Status :: 5 - Production/Stable",
"Environment :: Web Environment", "Environment :: Web Environment",
"Framework :: Django", "Framework :: Django",
"Framework :: Django :: 2.0", "Framework :: Django :: 2.0",
"Framework :: Django :: 2.1", "Framework :: Django :: 2.1",
"Framework :: Django :: 2.2", "Framework :: Django :: 2.2",
"Framework :: Django :: 3.0",
"Framework :: Django :: 3.1",
"Intended Audience :: Developers", "Intended Audience :: Developers",
"Operating System :: OS Independent", "Operating System :: OS Independent",
"Programming Language :: Python", "Programming Language :: Python",