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

Trying Code Block

Browse Source
This commit is contained in:
Mohamed El-Kalioby
2019-01-26 00:12:20 +03:00
parent 6ccaec59bd
commit 0fa8520e66
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/installation.md
View File

@@ -1,4 +1,4 @@
# Installation # Installation & Configuration
1. Install the package 1. Install the package
```sh ```sh
pip install django-mfa2 pip install django-mfa2
@@ -11,7 +11,7 @@
'......') '......')
``` ```
1. Add the following settings to your file 1. Add the following settings to your file
```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
MFA_LOGIN_CALLBACK="" # A function that should be called by username to login the user in session MFA_LOGIN_CALLBACK="" # A function that should be called by username to login the user in session
MFA_RECHECK=True # Allow random rechecking of the user MFA_RECHECK=True # Allow random rechecking of the user
@@ -25,7 +25,7 @@
FIDO_SERVER_ID=u"localehost" # Server rp id for FIDO2, it the full domain of your project FIDO_SERVER_ID=u"localehost" # Server rp id for FIDO2, it the full domain of your project
FIDO_SERVER_NAME=u"PROJECT_NAME" FIDO_SERVER_NAME=u"PROJECT_NAME"
FIDO_LOGIN_URL=BASE_URL FIDO_LOGIN_URL=BASE_URL
```
**Method Names** **Method Names**
* U2F * U2F
@@ -38,6 +38,7 @@
1. Add mfa to urls.py 1. Add mfa to urls.py
```python
import mfa import mfa
import mfa.TrustedDevice import mfa.TrustedDevice
urls_patterns= [ urls_patterns= [
@@ -46,7 +47,7 @@
url(r'devices/add$', mfa.TrustedDevice.add,name="mfa_add_new_trusted_device"), # This short link to add new trusted device url(r'devices/add$', mfa.TrustedDevice.add,name="mfa_add_new_trusted_device"), # This short link to add new trusted device
'....', '....',
] ]
```
1. Provide `mfa_auth_base.html` in your templaes with block called 'head' and 'content' 1. Provide `mfa_auth_base.html` in your templaes with block called 'head' and 'content'
The template will be included during the user login. 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`.

2
mkdocs.yml
View File

@@ -2,3 +2,5 @@ site_name: MkLorum
nav: nav:
- Home: index.md - Home: index.md
theme: readthedocs theme: readthedocs
markdown_extensions:
- fenced_code