josh/django-mfa2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

v2.3.0 #done

Browse Source
This commit is contained in:
Mohamed ElKalioby
2021-09-21 20:23:39 +03:00
parent 7415b169c9
commit 85b4a25956
6 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -60,9 +60,9 @@ Depends on
'mfa',
'......')
```
1. Collect Static Files
2. Collect Static Files
`python manage.py collectstatic`
1. Add the following settings to your file
3. Add the following settings to your file
```python
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 2.2.0
* 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
@@ -115,7 +115,7 @@ Depends on
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
```
1. Add mfa to urls.py
5. Add mfa to urls.py
```python
import mfa
import mfa.TrustedDevice
@@ -126,13 +126,14 @@ Depends on
'....',
]
```
1. Provide `mfa_auth_base.html` in your templaes with block called 'head' and 'content'
The template will be included during the user login.
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.
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.
1. Somewhere in your app, add a link to 'mfa_home'
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.
**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>```
For Example, See 'example' app
# Going Passwordless
@@ -183,6 +184,7 @@ function some_func() {
* [unramk](https://github.com/unramk)
* [willingham](https://github.com/willingham)
* [AndreasDickow](https://github.com/AndreasDickow)
* [mnelson4](https://github.com/mnelson4)
# Security contact information