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

Trying Code blick

Browse Source
This commit is contained in:
Mohamed El-Kalioby
2019-01-26 00:06:00 +03:00
parent 8c413083d5
commit 6ccaec59bd
1 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/installation.md
View File

@@ -12,21 +12,21 @@
``` ```
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 MFA_RECHECK_MIN=10 # Minimum interval in seconds
MFA_RECHECK_MIN=10 # Minimum interval in seconds MFA_RECHECK_MAX=30 # Maximum in seconds
MFA_RECHECK_MAX=30 # Maximum in seconds MFA_QUICKLOGIN=True # Allow quick login for returning users by provide only their 2FA
MFA_QUICKLOGIN=True # Allow quick login for returning users by provide only their 2FA
TOKEN_ISSUER_NAME="PROJECT_NAME" #TOTP Issuer name
U2F_APPID="https://localhost" #URL For U2
FIDO_SERVER_ID=u"localehost" # Server rp id for FIDO2, it the full domain of your project
FIDO_SERVER_NAME=u"PROJECT_NAME"
FIDO_LOGIN_URL=BASE_URL
TOKEN_ISSUER_NAME="PROJECT_NAME" #TOTP Issuer name
U2F_APPID="https://localhost" #URL For U2F
FIDO_SERVER_ID=u"localehost" # Server rp id for FIDO2, it the full domain of your project
FIDO_SERVER_NAME=u"PROJECT_NAME"
FIDO_LOGIN_URL=BASE_URL
```
**Method Names** **Method Names**
* U2F * U2F
* FIDO2 * FIDO2
@@ -37,16 +37,16 @@
**Note**: Starting version 1.1, ~~FIDO_LOGIN_URL~~ isn't required for FIDO2 anymore. **Note**: Starting version 1.1, ~~FIDO_LOGIN_URL~~ isn't required for FIDO2 anymore.
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= [
'...', '...',
url(r'^mfa/', include('mfa.urls')), url(r'^mfa/', include('mfa.urls')),
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`.