Allowing Session email address

README.md

@@ -1,12 +1,15 @@
 # django-mfa2
 A Django app that handles MFA, it supports TOTP, U2F, FIDO2 U2F (Web Authn), Email Tokens , and Trusted Devices
 
-Web Authencation API (Webauthn) is state-of-the art techology that is expected to replace passwords.
+[![PyPI version](https://badge.fury.io/py/django-mfa2.svg)](https://badge.fury.io/py/django-mfa2)
+
+Web Authencation API (WebAuthn) is state-of-the art techology that is expected to replace passwords.
 
 ![Andriod Fingerprint](https://cdn-images-1.medium.com/max/800/1*1FWkRE8D7NTA2Kn1DrPjPA.png)
 
+For FIDO2, **security keys**, **Apple's Touch ID (Chrome)** and **android-safetynet** are supported.
 
-For FIDO2, both security keys and android-safetynet are supported.
+In English :), It allows you to verify the user by security keys on PC, Laptops, Touch ID on Macboks (Chrome) and Fingerprint/PIN on Andriod Phones.
 
 Trusted device is a mode for the user to add a device that doesn't support security keys like iOS and andriod without fingerprints or NFC.
 
@@ -57,6 +60,8 @@ Depends on
    * Trusted_Devices
    * Email
    
+   **Note**: Starting version 1.1, ~~FIDO_LOGIN_URL~~ isn't required for FIDO2 anymore.
+   
 1. 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

docs/change_login.md

@@ -0,0 +1,23 @@
+# Change of login function
+
+## 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
+ 
+ * authenticate the user
+ * if username and password are correct , check if the user has mfa or not
+     * if user has mfa then redirect to mfa page
+      * if user doesn't have mfa then call your function to create the user session
+
+<code>
+    def login(request): # this function handles the login form POST
+       user = auth.authenticate(username=username, password=password)  
+       if user is not None: # if the user object exist
+            from mfa.helpers import has_mfa
+            res =  has_mfa(username = username,request=request) # has_mfa returns false or HttpResponseRedirect
+            if res:
+                return res
+            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
+</code>
+

docs/index.md

@@ -0,0 +1,36 @@
+# django-mfa2
+A Django app that handles MFA, it supports TOTP, U2F, FIDO2 U2F (Web Authn), Email Tokens , and Trusted Devices
+
+[![PyPI version](https://badge.fury.io/py/django-mfa2.svg)](https://badge.fury.io/py/django-mfa2)
+
+Web Authencation API (WebAuthn) is state-of-the art techology that is expected to replace passwords.
+
+![Andriod Fingerprint](https://cdn-images-1.medium.com/max/800/1*1FWkRE8D7NTA2Kn1DrPjPA.png)
+
+For FIDO2, both security keys and android-safetynet are supported.
+
+In English :), It allows you to verify the user by security keys on PC, Laptops and Fingerprint/PIN on Andriod Phones.
+
+Trusted device is a mode for the user to add a device that doesn't support security keys like iOS and andriod without fingerprints or NFC.
+
+**Note**: `U2F and FIDO2 can only be served under secure context (https)`
+
+Package tested with Django 1.8, Django 2.1 on Python 2.7 and Python 3.5+ but it was not checked with any version in between but open for issues.
+
+Depends on
+
+* pyotp
+* python-u2flib-server
+* ua-parser
+* user-agents
+* python-jose
+* fido2==0.5
+
+# Example
+
+For Example, See https://github.com/mkalioby/AutoDeploy/commit/5f1d94b1804e0aa33c79e9e8530ce849d9eb78cc in AutDeploy Project
+
+# Table of Contents
+* [Installation](installation.md)
+* [Change Login Code](change_login.md)
+

docs/installation.md

@@ -0,0 +1,58 @@
+# Installation & Configuration
+1. Install the package 
+  ```sh
+   pip install django-mfa2
+   ```
+1. in your settings.py add the application to your installed apps
+   ```python
+   INSTALLED_APPS=(
+   '......',
+   'mfa',
+   '......')
+   ```
+1. Add the following settings to your file
+    ```python
+    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_RECHECK=True           # Allow random rechecking of the user
+    MFA_RECHECK_MIN=10         # Minimum interval in seconds
+    MFA_RECHECK_MAX=30         # Maximum in seconds
+    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
+   ```
+   
+   **Method Names**
+   * U2F
+   * FIDO2
+   * TOTP
+   * Trusted_Devices
+   * Email
+   
+   **Note**: Starting version 1.1, ~~FIDO_LOGIN_URL~~ isn't required for FIDO2 anymore.
+   
+1. Add mfa to urls.py
+    
+    ```python
+    import mfa
+    import mfa.TrustedDevice
+    urls_patterns= [
+    '...',
+    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
+    '....',
+    ]
+    ```
+1. Provide `mfa_auth_base.html` in your templaes with block called 'head' and 'content'
+    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`.
+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'
+```<li><a href="{% url 'mfa_home' %}">Security</a> </li>```
+
+Next, you need to [change your login code](change_login.md)

mfa/FIDO2.py

@@ -112,6 +112,6 @@ def authenticate_complete(request):
                 mfa["next_check"] = int((datetime.datetime.now()+ datetime.timedelta(
                 seconds=random.randint(settings.MFA_RECHECK_MIN, settings.MFA_RECHECK_MAX))).strftime("%s"))
             request.session["mfa"] = mfa
-            login(request)
-            return HttpResponse(simplejson.dumps({'status':"OK","redirect":settings.FIDO_LOGIN_URL}),content_type="application/json")
+            res=login(request)
+            return HttpResponse(simplejson.dumps({'status':"OK","redirect":res["location"]}),content_type="application/json")
     return HttpResponse(simplejson.dumps({'status': "err"}),content_type="application/json")

mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: MkLorum
+nav:
+    - Home: index.md
+theme: readthedocs
+markdown_extensions:
+    - fenced_code

setup.py

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='django-mfa2',
-    version='1.0.5',
+    version='1.1.2',
     description='Allows user to add 2FA to their accounts',
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
@@ -12,7 +12,6 @@ setup(
     author='Mohamed El-Kalioby',
     author_email = 'mkalioby@mkalioby.com',
     url = 'https://github.com/mkalioby/django-mfa2/',
-
     download_url='https://github.com/mkalioby/django-mfa2/',
     license='MIT',
     packages=find_packages(),