Compare commits

..

3 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
6 changed files with 25 additions and 11 deletions

View File

@@ -1,6 +1,8 @@
# Change Log # Change Log
## 2.2.1 ## 2.3.0
* Fixed: A missing import Thanks @AndreasDickow * 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 ## 2.2.0
* Added: MFA_REDIRECT_AFTER_REGISTRATION settings parameter * Added: MFA_REDIRECT_AFTER_REGISTRATION settings parameter

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,13 +126,14 @@ 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 'example' app For Example, See 'example' app
# Going Passwordless # Going Passwordless
@@ -183,6 +184,7 @@ function some_func() {
* [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) * [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

@@ -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

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
setup( setup(
name='django-mfa2', name='django-mfa2',
version='2.2.0', 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",