Merge branch 'master' of https://github.com/mkalioby/django-mfa2

.gitignore

@@ -104,3 +104,4 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+example/test_db

CHANGELOG.md

@@ -1,4 +1,29 @@
 # Change Log
+## 2.8.0
+* Support For Django 4.0+ JSONField
+* Removed jsonfield package from requirements
+
+## 2.7.0 
+* Fixed #70
+* Add QR Code for trusted device link
+* Better formatting for trusted device start page.
+## 2.6.1
+* Fix: CVE-2022-42731: related to the possibility of registration replay attack.
+  Thanks to 'SSE (Secure Systems Engineering)'
+
+## 2.5.1
+* Fix: CVE-2022-42731: related to the possibility of registration replay attack.
+  Thanks to 'SSE (Secure Systems Engineering)' 
+
+## 2.6.0
+   * Adding Backup Recovery Codes (Recovery) as a method.
+     Thanks to @Spitfireap for work, and  @peterthomassen for guidance.
+   * Added: `RECOVERY_ITERATION` to set the number of iteration when hashing recovery token
+   * Added: `MFA_ENFORCE_RECOVERY_METHOD` to enforce the user to enroll in the recovery code method once, they add any other method,
+   * Added: `MFA_ALWAYS_GO_TO_LAST_METHOD` to the settings which redirects the user automatically to the last used method when logging in
+   * Added: `MFA_RENAME_METHODS` to be able to rename the methods for the user.
+   * Fix: Alot of CSS fixes for the example application
+
 ## 2.5.0
 
    * Fixed: issue in the 'Authorize' button don't show on Firefox and Chrome on iOS.

EXAMPLE.md

@@ -4,5 +4,15 @@
 `virtualenv venv`
 1. activate env `source venv/bin/activate`
 1. install requirements `pip install -r requirements.txt`
+1. cd to example project `cd example`
 1. migrate `python manage.py migrate`
-1. create super user 'python manage.py createsuperuser' 
+1. create super user `python manage.py createsuperuser`
+1. start the server `python manage.py runserver`
+
+# Notes for SSL
+
+To test FIDO2 you need to use HTTPS, after the above steps are done:
+
+1. stop the server
+1. install requirements `pip install -r example-ssl-requirements.txt`
+1. start the ssl server `python manage.py runsslserver`

README.md

@@ -1,6 +1,7 @@
 # django-mfa2
-A Django app that handles MFA, it supports TOTP, U2F, FIDO2 U2F (Web Authn), Email Tokens , and Trusted Devices
+A Django app that handles MFA, it supports TOTP, U2F, FIDO2 U2F (Web Authn), Email Tokens , Trusted  Devices and backup codes.
 
+[![Works with PassKeys](https://github.com/mkalioby/django-mfa2/raw/master/img/Works%20with%20PassKeys-black.png)](https://fidoalliance.org/passkeys/)
 ### Pip Stats
 [![PyPI version](https://badge.fury.io/py/django-mfa2.svg)](https://badge.fury.io/py/django-mfa2)
 [![Downloads Count](https://static.pepy.tech/personalized-badge/django-mfa2?period=total&units=international_system&left_color=black&right_color=green&left_text=Downloads)](https://pepy.tech/project/django-mfa2)
@@ -16,12 +17,14 @@ Web Authencation API (WebAuthn) is state-of-the art techology that is expected t
 
 For FIDO2, the following are supported
  * **security keys** (Firefox 60+, Chrome 67+, Edge 18+, Safari 13 on Mac OS, Chrome on Andriod, Safari on iOS 13.3+),
- * **Windows Hello** (Firefox 67+, Chrome 72+ , Edge) ,
+ * **Windows Hello** (Firefox 67+, Chrome 72+ , Edge),
  * **Apple's Touch ID/Face ID** (Chrome 70+ on Mac OS X, Safari on macOS Big Sur, Safari on iOS 14.0+ ),
  * **android-safetynet** (Chrome 70+, Firefox 68+)
  * **NFC devices using PCSC** (Not Tested, but as supported in fido2)
  * **Soft Tokens** 
-    * [krypt.co](https://krypt.co/): Login by a notification on your phone.
+    * ~~[krypt.co](https://krypt.co/): Login by a notification on your phone.~~
+
+**Update**: Dec 2022, krypt.co has been killed by Google for Passkeys.
 
 In English :), It allows you to verify the user by security keys on PC, Laptops or Mobiles, Windows Hello (Fingerprint, PIN) on Windows 10 Build 1903+ (May 2019 Update) Touch/Face ID on Macbooks (Chrome, Safari), Touch/Face ID on iPhone and iPad and Fingerprint/Face/Iris/PIN on Android Phones.
 
@@ -31,6 +34,8 @@ Trusted device is a mode for the user to add a device that doesn't support secur
 
 Package tested with Django 1.8, Django 2.2 on Python 2.7 and Python 3.5+ but it was not checked with any version in between but open for issues.
 
+If you just need WebAuthn and Passkeys, you can use **[django-passkeys](https://github.com/mkalioby/django-passkeys)**, which is a slim-down of this app and much easier to integrate.
+
 Depends on
 
 * pyotp
@@ -42,8 +47,12 @@ Depends on
 
 # Installation
 1. using pip 
-
+    * For Django >= 4.0
-    `pip install django-mfa2`
+       
+        `pip install django-mfa2`
+    * For Django < 4.0
+           
+      `pip install django-mfa2 jsonfield`
 2. Using Conda forge 
    
    `conda config --add channels conda-forge`
@@ -66,8 +75,9 @@ Depends on
 `python manage.py collectstatic`
 3. Add the following settings to your file
 
-   ```python 
+   ```python
-   MFA_UNALLOWED_METHODS=()   # Methods that shouldn't be allowed for the user
+   from django.conf.global_settings import PASSWORD_HASHERS as DEFAULT_PASSWORD_HASHERS #Preferably at the same place where you import your other modules
+   MFA_UNALLOWED_METHODS=()   # Methods that shouldn't be allowed for the user e.g ('TOTP','U2F',)
    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_REDIRECT_AFTER_REGISTRATION="mfa_home"   # Allows Changing the page after successful registeration
@@ -75,15 +85,19 @@ Depends on
    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
+   MFA_ALWAYS_GO_TO_LAST_METHOD = False # Always redirect the user to the last method used to save a click (Added in 2.6.0).
+   MFA_RENAME_METHODS={} #Rename the methods in a more user-friendly way e.g {"RECOVERY":"Backup Codes"} (Added in 2.6.0)
    MFA_HIDE_DISABLE=('FIDO2',)     # Can the user disable his key (Added in 1.2.0).
    MFA_OWNED_BY_ENTERPRISE = FALSE  # Who owns security keys   
+   PASSWORD_HASHERS = DEFAULT_PASSWORD_HASHERS # Comment if PASSWORD_HASHER already set in your settings.py
+   PASSWORD_HASHERS += ['mfa.recovery.Hash'] 
+   RECOVERY_ITERATION = 350000 #Number of iteration for recovery code, higher is more secure, but uses more resources for generation and check...
 
    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_ID=u"localehost"      # Server rp id for FIDO2, it is the full domain of your project
    FIDO_SERVER_NAME=u"PROJECT_NAME"
-   FIDO_LOGIN_URL=BASE_URL
    ```
    **Method Names**
    * U2F
@@ -91,12 +105,15 @@ Depends on
    * TOTP
    * Trusted_Devices
    * Email
+   * RECOVERY
    
    **Notes**:
     * Starting version 1.1, ~~FIDO_LOGIN_URL~~ isn't required for FIDO2 anymore.
     * Starting version 1.7.0, Key owners can be specified.
     * Starting version 2.2.0
         * Added: `MFA_SUCCESS_REGISTRATION_MSG` & `MFA_REDIRECT_AFTER_REGISTRATION`
+    Start version 2.6.0
+        * Added: `MFA_ALWAYS_GO_TO_LAST_METHOD`, `MFA_RENAME_METHODS`, `MFA_ENFORCE_RECOVERY_METHOD` & `RECOVERY_ITERATION`
 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
@@ -136,7 +153,7 @@ Depends on
 ```<li><a href="{% url 'mfa_home' %}">Security</a> </li>```
 
 
-For Example, See 'example' app
+For Example, See 'example' app and look at EXAMPLE.md to see how to set it up.
 
 # Going Passwordless
 
@@ -188,6 +205,8 @@ function some_func() {
 * [AndreasDickow](https://github.com/AndreasDickow)
 * [mnelson4](https://github.com/mnelson4)
 * [ezrajrice](https://github.com/ezrajrice)
+* [Spitfireap](https://github.com/Spitfireap)
+* [peterthomassen](https://github.com/peterthomassen)
 
 
  # Security contact information

example/example-ssl-requirements.txt

@@ -0,0 +1 @@
+django-sslserver

example/example/settings.py

@@ -11,6 +11,7 @@ https://docs.djangoproject.com/en/2.0/ref/settings/
 """
 
 import os
+from django.conf.global_settings import PASSWORD_HASHERS as DEFAULT_PASSWORD_HASHERS
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -142,9 +143,14 @@ MFA_QUICKLOGIN=True        # Allow quick login for returning users by provide on
 MFA_HIDE_DISABLE=('',)     # Can the user disable his key (Added in 1.2.0).
 MFA_REDIRECT_AFTER_REGISTRATION="registered"
 MFA_SUCCESS_REGISTRATION_MSG="Go to Home"
-
+MFA_ALWAYS_GO_TO_LAST_METHOD = True
+MFA_ENFORCE_RECOVERY_METHOD = True
+MFA_RENAME_METHODS = {"RECOVERY":"Backup Codes","FIDO2":"Biometric Authentication"}
+PASSWORD_HASHERS = DEFAULT_PASSWORD_HASHERS #Comment if PASSWORD_HASHER already set
+PASSWORD_HASHERS += ['mfa.recovery.Hash']
+RECOVERY_ITERATION = 1 #Number of iteration for recovery code, higher is more secure, but uses more resources for generation and check...
 TOKEN_ISSUER_NAME="PROJECT_NAME"      #TOTP Issuer name
 
-U2F_APPID="https://localhost"    #URL For U2F
+U2F_APPID="https://localhost:9000"    #URL For U2F
 FIDO_SERVER_ID="localhost"      # Server rp id for FIDO2, it the full domain of your project
 FIDO_SERVER_NAME="TestApp"

example/example/templates/base.html

@@ -10,7 +10,7 @@
   <meta name="description" content="">
   <meta name="author" content="">
 
-  <title>SB Admin - Blank Page</title>
+  <title>Django-mfa2 Example</title>
 
   <!-- Custom fonts for this template-->
   <link href="{% static 'vendor/fontawesome-free/css/all.min.css'%}" rel="stylesheet" type="text/css">

example/example/urls.py

@@ -16,12 +16,13 @@ Including another URLconf
 from django.contrib import admin
 from django.urls import path,re_path,include
 from . import views,auth
+from mfa import TrustedDevice
 urlpatterns = [
     path('admin/', admin.site.urls),
     path('mfa/', include('mfa.urls')),
     path('auth/login',auth.loginView,name="login"),
     path('auth/logout',auth.logoutView,name="logout"),
-
+    path('devices/add/', TrustedDevice.add,name="add_trusted_device"),
     re_path('^$',views.home,name='home'),
     path('registered/',views.registered,name='registered')
 ]

example/requiremnts.txt

@@ -1,2 +0,0 @@
-django >= 2.2
-django_ssl

mfa/Email.py

@@ -34,10 +34,16 @@ def start(request):
                 from django.core.urlresolvers import reverse
             except:
                 from django.urls import reverse
-            return HttpResponseRedirect(reverse(getattr(settings,'MFA_REDIRECT_AFTER_REGISTRATION','mfa_home')))
+            if getattr(settings, 'MFA_ENFORCE_RECOVERY_METHOD', False) and not User_Keys.objects.filter(
+                    key_type="RECOVERY", username=request.user.username).exists():
+                request.session["mfa_reg"] = {"method": "Email",
+                                              "name": getattr(settings, "MFA_RENAME_METHODS", {}).get("Email", "Email")}
+            else:
+                return HttpResponseRedirect(reverse(getattr(settings,'MFA_REDIRECT_AFTER_REGISTRATION','mfa_home')))
         context["invalid"] = True
     else:
         request.session["email_secret"] = str(randint(0,100000))  #generate a random integer
+
         if sendEmail(request, request.user.username, request.session["email_secret"]):
             context["sent"] = True
     return render(request,"Email/Add.html", context)

mfa/FIDO2.py

@@ -68,7 +68,11 @@ def complete_reg(request):
         uk.owned_by_enterprise = getattr(settings, "MFA_OWNED_BY_ENTERPRISE", False)
         uk.key_type = "FIDO2"
         uk.save()
-        return HttpResponse(simplejson.dumps({'status': 'OK'}))
+        if getattr(settings, 'MFA_ENFORCE_RECOVERY_METHOD', False) and not User_Keys.objects.filter(key_type = "RECOVERY", username=request.user.username).exists():
+            request.session["mfa_reg"] = {"method":"FIDO2","name": getattr(settings, "MFA_RENAME_METHODS", {}).get("FIDO2", "FIDO2")}
+            return HttpResponse(simplejson.dumps({'status': 'RECOVERY'}))
+        else:
+            return HttpResponse(simplejson.dumps({'status': 'OK'}))
     except Exception as exp:
         import traceback
         print(traceback.format_exc())
@@ -81,9 +85,11 @@ def complete_reg(request):
 
 
 def start(request):
-    """Start Registeration a new FIDO Token"""
+    """Start Registration a new FIDO Token"""
     context = csrf(request)
     context.update(get_redirect_url())
+    context["method"] = {"name":getattr(settings,"MFA_RENAME_METHODS",{}).get("FIDO2","FIDO2 Security Key")}
+    context["RECOVERY_METHOD"]=getattr(settings,"MFA_RENAME_METHODS",{}).get("RECOVERY","Recovery codes")
     return render(request, "FIDO2/Add.html", context)
 
 
@@ -139,7 +145,7 @@ def authenticate_complete(request):
             except:
                 pass
             return HttpResponse(simplejson.dumps({'status': "ERR",
-                                                  "message": excep.message}),
+                                                  "message": str(excep)}),
                                 content_type = "application/json")
 
         if request.session.get("mfa_recheck", False):

mfa/TrustedDevice.py

@@ -7,10 +7,11 @@ from django.template.context_processors import csrf
 from .models import *
 import user_agents
 from django.utils import timezone
+from django.urls import reverse
 
 def id_generator(size=6, chars=string.ascii_uppercase + string.digits):
     x=''.join(random.choice(chars) for _ in range(size))
-    if not User_Keys.objects.filter(properties__shas="$.key="+x).exists(): return x
+    if not User_Keys.objects.filter(properties__icontains='"key": "%s"'%x).exists(): return x
     else: return id_generator(size,chars)
 
 def getUserAgent(request):
@@ -57,12 +58,13 @@ def getCookie(request):
 def add(request):
     context=csrf(request)
     if request.method=="GET":
+        context.update({"username":request.GET.get('u',''),"key":request.GET.get('k','')})
         return render(request,"TrustedDevices/Add.html",context)
     else:
         key=request.POST["key"].replace("-","").replace(" ","").upper()
         context["username"] = request.POST["username"]
         context["key"] = request.POST["key"]
-        trusted_keys=User_Keys.objects.filter(username=request.POST["username"],properties__has="$.key="+key)
+        trusted_keys=User_Keys.objects.filter(username=request.POST["username"],properties__icontains='"key": "%s"'%key)
         cookie=False
         if trusted_keys.exists():
             tk=trusted_keys[0]
@@ -97,7 +99,7 @@ def start(request):
         request.session["td_id"]=td.id
     try:
         if td==None: td=User_Keys.objects.get(id=request.session["td_id"])
-        context={"key":td.properties["key"]}
+        context={"key":td.properties["key"],"url":request.scheme+"://"+request.get_host() + reverse('add_trusted_device')}
     except:
         del request.session["td_id"]
         return start(request)
@@ -124,12 +126,14 @@ def verify(request):
         json= jwt.decode(request.COOKIES.get('deviceid'),settings.SECRET_KEY)
         if json["username"].lower()== request.session['base_username'].lower():
             try:
-                uk = User_Keys.objects.get(username=request.POST["username"].lower(), properties__has="$.key=" + json["key"])
+                uk = User_Keys.objects.get(username=request.POST["username"].lower(), properties__icontains='"key": "%s"'%json["key"])
                 if uk.enabled and uk.properties["status"] == "trusted":
                     uk.last_used=timezone.now()
                     uk.save()
                     request.session["mfa"] = {"verified": True, "method": "Trusted Device","id":uk.id}
                     return True
             except:
+                import traceback
+                print(traceback.format_exc())
                 return False
     return False

mfa/U2F.py

@@ -52,25 +52,29 @@ def validate(request,username):
 
     challenge = request.session.pop('_u2f_challenge_')
     device, c, t = complete_authentication(challenge, data, [settings.U2F_APPID])
+    try:
+        key=User_Keys.objects.get(username=username,properties__icontains='"publicKey": "%s"'%device["publicKey"])
+        key.last_used=timezone.now()
+        key.save()
+        mfa = {"verified": True, "method": "U2F","id":key.id}
+        if getattr(settings, "MFA_RECHECK", False):
+            mfa["next_check"] = datetime.datetime.timestamp((datetime.datetime.now()
+                                     + datetime.timedelta(
+                        seconds=random.randint(settings.MFA_RECHECK_MIN, settings.MFA_RECHECK_MAX))))
+        request.session["mfa"] = mfa
+        return True
+    except:
+        return False
+
 
-    key=User_Keys.objects.get(username=username,properties__shas="$.device.publicKey=%s"%device["publicKey"])
-    key.last_used=timezone.now()
-    key.save()
-    mfa = {"verified": True, "method": "U2F","id":key.id}
-    if getattr(settings, "MFA_RECHECK", False):
-        mfa["next_check"] = datetime.datetime.timestamp((datetime.datetime.now()
-                                 + datetime.timedelta(
-                    seconds=random.randint(settings.MFA_RECHECK_MIN, settings.MFA_RECHECK_MAX))))
-    request.session["mfa"] = mfa
-    return True
 
 def auth(request):
     context=csrf(request)
     s=sign(request.session["base_username"])
     request.session["_u2f_challenge_"]=s[0]
     context["token"]=s[1]
-
+    context["method"] = {"name": getattr(settings, "MFA_RENAME_METHODS", {}).get("U2F", "Classical Security Key")}
-    return render(request,"U2F/Auth.html")
+    return render(request,"U2F/Auth.html",context)
 
 def start(request):
     enroll = begin_registration(settings.U2F_APPID, [])
@@ -78,6 +82,8 @@ def start(request):
     context=csrf(request)
     context["token"]=simplejson.dumps(enroll.data_for_client)
     context.update(get_redirect_url())
+    context["method"] = {"name": getattr(settings, "MFA_RENAME_METHODS", {}).get("U2F", "Classical Security Key")}
+    context["RECOVERY_METHOD"] = getattr(settings, "MFA_RENAME_METHODS", {}).get("RECOVERY", "Recovery codes")
     return render(request,"U2F/Add.html",context)
 
 
@@ -98,6 +104,11 @@ def bind(request):
     uk.properties = {"device":simplejson.loads(device.json),"cert":cert_hash}
     uk.key_type = "U2F"
     uk.save()
+    if getattr(settings, 'MFA_ENFORCE_RECOVERY_METHOD', False) and not User_Keys.objects.filter(key_type="RECOVERY",
+                                                                                                username=request.user.username).exists():
+        request.session["mfa_reg"] = {"method": "U2F",
+                                      "name": getattr(settings, "MFA_RENAME_METHODS", {}).get("U2F", "Classical Security Key")}
+        return HttpResponse('RECOVERY')
     return HttpResponse("OK")
 
 def sign(username):

mfa/migrations/0005_auto_20181115_2014.py

@@ -2,7 +2,14 @@
 from __future__ import unicode_literals
 
 from django.db import models, migrations
-import jsonfield.fields
+try:
+    from django.db.models import JSONField
+except ImportError:
+    try:
+        from jsonfield.fields import JSONField
+    except ImportError:
+        raise ImportError("Can't find a JSONField implementation, please install jsonfield if django < 4.0")
+
 
 
 def modify_json(apps, schema_editor):
@@ -24,7 +31,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='user_keys',
             name='properties',
-            field=jsonfield.fields.JSONField(null=True),
+            field=JSONField(null=True),
         ),
         migrations.RunPython(modify_json)
     ]

mfa/models.py

@@ -1,5 +1,12 @@
 from django.db import models
-from jsonfield import JSONField
+try:
+    from django.db.models import JSONField
+except ModuleNotFoundError:
+    try:
+        from jsonfield import JSONField
+    except ModuleNotFoundError:
+        raise ModuleNotFoundError("Can't find a JSONField implementation, please install jsonfield if django < 4.0")
+
 from jose import jwt
 from django.conf import settings
 #from jsonLookup import shasLookup, hasLookup

mfa/recovery.py

@@ -0,0 +1,122 @@
+from django.shortcuts import render
+from django.views.decorators.cache import never_cache
+from django.template.context_processors import csrf
+from django.contrib.auth.hashers import make_password, PBKDF2PasswordHasher
+from django.http import HttpResponse
+from .Common import get_redirect_url
+from .models import *
+import simplejson
+import random
+import string
+import datetime
+from django.utils import timezone
+
+USER_FRIENDLY_NAME = "Recovery Codes"
+
+class Hash(PBKDF2PasswordHasher):
+    algorithm = 'pbkdf2_sha256_custom'
+    iterations = getattr(settings,"RECOVERY_ITERATION",1)
+
+def delTokens(request):
+    #Only when all MFA have been deactivated, or to generate new !
+    #We iterate only to clean if any error happend and multiple entry of RECOVERY created for one user
+    for key in User_Keys.objects.filter(username=request.user.username, key_type = "RECOVERY"):
+        if key.username == request.user.username:
+            key.delete()
+
+def randomGen(n):
+    return ''.join(random.choice(string.ascii_uppercase + string.ascii_lowercase + string.digits) for _ in range(n))
+
+@never_cache
+def genTokens(request):
+    #Delete old ones
+    delTokens(request)
+    #Then generate new one
+    salt = randomGen(15)
+    hashedKeys = []
+    clearKeys = []
+    for i in range(5):
+            token = randomGen(5) + "-" + randomGen(5)
+            hashedToken = make_password(token, salt, 'pbkdf2_sha256_custom')
+            hashedKeys.append(hashedToken)
+            clearKeys.append(token)
+    uk=User_Keys()
+
+    uk.username = request.user.username
+    uk.properties={"secret_keys":hashedKeys, "salt":salt}
+    uk.key_type="RECOVERY"
+    uk.enabled = True
+    uk.save()
+    return HttpResponse(simplejson.dumps({"keys":clearKeys}))
+
+
+def verify_login(request, username, token):
+    for key in User_Keys.objects.filter(username=username, key_type = "RECOVERY"):
+        secret_keys = key.properties["secret_keys"]
+        salt = key.properties["salt"]
+        hashedToken = make_password(token, salt, "pbkdf2_sha256_custom")
+        for i,token in enumerate(secret_keys):
+            if hashedToken == token:
+                secret_keys.pop(i)
+                key.properties["secret_keys"] = secret_keys
+                key.last_used= timezone.now()
+                key.save()
+                return [True, key.id, len(secret_keys) == 0]
+    return [False]
+
+def getTokenLeft(request):
+    uk = User_Keys.objects.filter(username=request.user.username, key_type = "RECOVERY")
+    keyLeft=0
+    for key in uk:
+        keyLeft += len(key.properties["secret_keys"])
+    return HttpResponse(simplejson.dumps({"left":keyLeft}))
+
+def recheck(request):
+    context = csrf(request)
+    context["mode"]="recheck"
+    if request.method == "POST":
+        if verify_login(request,request.user.username, token=request.POST["recovery"])[0]:
+            import time
+            request.session["mfa"]["rechecked_at"] = time.time()
+            return HttpResponse(simplejson.dumps({"recheck": True}), content_type="application/json")
+        else:
+            return HttpResponse(simplejson.dumps({"recheck": False}), content_type="application/json")
+    return render(request,"RECOVERY/recheck.html", context)
+
+@never_cache
+def auth(request):
+    from .views import login
+    context=csrf(request)
+    if request.method=="POST":
+        tokenLength = len(request.POST["recovery"])
+        if tokenLength == 11 and "RECOVERY" not in settings.MFA_UNALLOWED_METHODS:
+            #Backup code check
+            resBackup=verify_login(request, request.session["base_username"], token=request.POST["recovery"])
+            if resBackup[0]:
+                mfa = {"verified": True, "method": "RECOVERY","id":resBackup[1], "lastBackup":resBackup[2]}
+                # if getattr(settings, "MFA_RECHECK", False):
+                #     mfa["next_check"] = datetime.datetime.timestamp((datetime.datetime.now()
+                #                             + datetime.timedelta(
+                #                 seconds=random.randint(settings.MFA_RECHECK_MIN, settings.MFA_RECHECK_MAX))))
+                request.session["mfa"] = mfa
+                if resBackup[2]:
+                    #If the last bakup code has just been used, we return a response insead of redirecting to login
+                    context["lastBackup"] = True
+                    return render(request,"RECOVERY/Auth.html", context)                
+                return login(request)
+        context["invalid"]=True
+
+    elif request.method=="GET":
+        mfa = request.session.get("mfa")
+        if mfa and mfa["verified"] and mfa["lastBackup"]:
+            return login(request)
+
+    return render(request,"RECOVERY/Auth.html", context)
+
+@never_cache
+def start(request):
+    """Start Managing recovery tokens"""
+    context = get_redirect_url()
+    if "mfa_reg" in request.session:
+        context["mfa_redirect"] = request.session["mfa_reg"]["name"]
+    return render(request,"RECOVERY/Add.html",context)

mfa/templates/FIDO2/Add.html

@@ -32,9 +32,14 @@
     }).then(function (res)
         {
       if (res["status"] =='OK')
-            $("#res").html("<div class='alert alert-success'>Registered Successfully, <a href='{{redirect_html}}'> {{reg_success_msg}}</a></div>")
+        $("#res").html("<div class='alert alert-success'>Registered Successfully, <a href='{{redirect_html}}'> {{reg_success_msg}}</a></div>")
-        else
+      else if (res['status'] = "RECOVERY")
-            $("#res").html("<div class='alert alert-danger'>Registration Failed as " + res["message"] + ", <a href='javascript:void(0)' onclick='begin_reg()'> try again or <a href='{% url 'mfa_home' %}'> Go to Security Home</a></div>")
+      {
+          setTimeout(function (){location.href="{% url 'manage_recovery_codes' %}"},2500)
+        $("#res").html("<div class='alert alert-success'>Registered Successfully, but <a href='{% url 'manage_recovery_codes' %}'>redirecting to {{ RECOVERY_METHOD }} method</a></div>")
+      }
+      else
+        $("#res").html("<div class='alert alert-danger'>Registration Failed as " + res["message"] + ", <a href='javascript:void(0)' onclick='begin_reg()'> try again or <a href='{% url 'mfa_home' %}'> Go to Security Home</a></div>")
 
 
     }, function(reason) {
@@ -61,7 +66,7 @@
      <div class="container">
      <div class="panel panel-default card">
       <div class="panel-heading card-header">
-	      <strong> FIDO2 Security Key</strong>
+	      <strong> Adding a New {{ method.name }}</strong>
       </div>
       <div class="panel-body card-body">
 

mfa/templates/FIDO2/recheck.html

@@ -3,7 +3,7 @@
 <script type="application/javascript" src="{% static 'mfa/js/ua-parser.min.js' %}"></script>
 <div class="row">
 
-<div class="col-sm-10 col-sm-offset-1 col-xs-12 col-md-10 col-md-offset-1 col-lg-8 col-lg-offset-2">
+<div class="col-sm-10 col-sm-offset-1 col-xs-12 col-md-10 col-md-offset-1 col-lg-8 col-lg-offset-2 offset-2 col-8">
 <div class="panel panel-default card">
       <div class="panel-heading card-header">
 	      <strong> Security Key</strong>
@@ -35,10 +35,10 @@
           </div>
 
           <div class="row">
-          <div class="col-md-12 mb-3" style="padding-left: 15px">
+          <div class="col-md-12 mb-3" style="padding-left: 25px">
 
             {% if request.session.mfa_methods|length > 1 %}
-                <a href="{%  url 'mfa_methods_list' %}">Select Another Method</a>
+               <a href="{%  url 'mfa_methods_list' %}">Select Another Method</a>
             {% endif %}
           </div>
         </div>

mfa/templates/MFA.html

@@ -45,31 +45,31 @@
     <br/>
     <div class="container">
     <div class="row">
-        <div align="center">
+        <div class="offset-5 col-2" style="text-align: center">
             <div class="btn-group">
             <button class="btn btn-success dropdown-toggle" data-toggle="dropdown" data-bs-toggle="dropdown">
                 Add Method&nbsp;<span class="caret"></span>
             </button>
             <ul class="dropdown-menu">
                 {% if not 'TOTP' in UNALLOWED_AUTHEN_METHODS %}
-                    <li><a class="dropdown-item" href="{% url 'start_new_otop' %}">Authenticator app</a></li>
+                    <li><a class="dropdown-item" href="{% url 'start_new_otop' %}">{% if 'TOTP' in RENAME_METHODS.keys %}{{ RENAME_METHODS.TOTP }}{% else %}Authenticator app{% endif %}</a></li>
                 {% endif %}
                 {% if not 'Email' in UNALLOWED_AUTHEN_METHODS %}
-                    <li><a class="dropdown-item" href="{% url 'start_email' %}">Email Token</a></li>
+                    <li><a class="dropdown-item" href="{% url 'start_email' %}">{% if 'Email' in RENAME_METHODS.keys %}{{ RENAME_METHODS.Email }}{% else %}Email Token{% endif %}</a></li>
                 {% endif %}
                 {% if not 'U2F' in UNALLOWED_AUTHEN_METHODS %}
-                    <li><a class="dropdown-item" href="{% url 'start_u2f' %}">Security Key</a></li>
+                    <li><a class="dropdown-item" href="{% url 'start_u2f' %}">{% if 'U2F' in RENAME_METHODS.keys %}{{ RENAME_METHODS.U2F }}{% else %}Security Key{% endif %}</a></li>
                 {% endif %}
-            {% if not 'FIDO2' in UNALLOWED_AUTHEN_METHODS %}
+                {% if not 'FIDO2' in UNALLOWED_AUTHEN_METHODS %}
-                    <li><a class="dropdown-item" href="{% url 'start_fido2' %}">FIDO2 Security Key</a></li>
+                    <li><a class="dropdown-item" href="{% url 'start_fido2' %}">{% if 'FIDO2' in RENAME_METHODS.keys %}{{ RENAME_METHODS.FIDO2 }}{% else %}FIDO2 Security Key{% endif %}</a></li>
                 {% endif %}
-            {% if not 'Trusted_Devices' in UNALLOWED_AUTHEN_METHODS %}
+                {% if not 'Trusted_Devices' in UNALLOWED_AUTHEN_METHODS %}
-                    <li><a class="dropdown-item" href="{% url 'start_td' %}">Trusted Device</a></li>
+                    <li><a class="dropdown-item" href="{% url 'start_td' %}">{% if 'Trusted_Devices' in  RENAME_METHODS.keys %}{{ RENAME_METHODS.Trusted_Devices }}{% else %}Trusted Device{% endif %}</a></li>
                 {% endif %}
             </ul>
             </div>
         </div>
-    <br/>
+    </div>
     <br/>
        <table class="table table-striped">
            <tr>
@@ -82,28 +82,42 @@
                <th>Status</th>
                <th>Delete</th>
            </tr>
-        {% for key in keys %}
+        {% if keys %}
-           <tr>
+            {% for key in keys %}
+            <tr>
 
-               <td>{{ key.key_type }}</td>
+                <td>{{ key.name }}</td>
-               <td>{{ key.added_on }}</td>
+                <td>{{ key.added_on }}</td>
-               <td>{{ key.expires }}</td>
+                <td>{% if key.expires %}{{ key.expires }}{% else %}N/A{% endif %}</td>
-               <td>{% if key.device %}{{ key.device }}{% endif %}</td>
+                <td>{% if key.device %}{{ key.device }}{% endif %}</td>
-               <td>{{ key.last_used }}</td>
+                <td>{% if key.last_used %}{{ key.last_used }}{% else %}Never{% endif %}</td>
-                {% if key.key_type in HIDE_DISABLE %}
+                    {% if key.key_type in HIDE_DISABLE %}
-                    <td>{% if key.enabled %}On{% else %} Off{% endif %}</td>
+                        <td>{% if key.enabled %}On{% else %} Off{% endif %}</td>
-                {% else %}
+                    {% else %}
-                    <td><input type="checkbox" id="toggle_{{ key.id }}" {% if key.enabled %}checked{% endif %} data-onstyle="success" data-offstyle="danger"  onchange="toggleKey({{ key.id }})" data-toggle="toggle" class="status_chk"></td>
+                        <td><input type="checkbox" id="toggle_{{ key.id }}" {% if key.enabled %}checked{% endif %} data-onstyle="success" data-offstyle="danger"  onchange="toggleKey({{ key.id }})" data-toggle="toggle" class="status_chk"></td>
-                {% endif %}
-               <td>{% if key.key_type in HIDE_DISABLE %}
-                   ----
-                   {% else %}
-                    <a href="javascript:void(0)" onclick="deleteKey({{ key.id }},'{{ key.key_type }}')"> <span class="fa fa-trash fa-solid fa-trash-can bi bi-trash-fill"></span></a></td>
                     {% endif %}
-           </tr>
+                <td>{% if key.key_type in HIDE_DISABLE %}
-       {% empty %}
+                    ----
+                    {% else %}
+                        <a href="javascript:void(0)" onclick="deleteKey({{ key.id }},'{{ key.key_type }}')"> <span class="fa fa-trash fa-solid fa-trash-can bi bi-trash-fill"></span></a></td>
+                        {% endif %}
+            </tr>
+            {% endfor %}
+            {% if "RECOVERY" not in UNALLOWED_AUTHEN_METHODS %}
+            <tr>
+
+                <td>{{ recovery.name }}</td>
+                <td>{{ recovery.added_on }}</td>
+                <td>N/A</td>
+                <td>N/A</td>
+                <td>{% if recovery.last_used %}{{ recovery.last_used }}{% else %}Never{% endif %}</td>
+                <td>On</td>
+                <td><a href="{% url 'manage_recovery_codes' %}"> <span class="fa fa-wrench fa-solid fa-wrench bi bi-wrench-fill"></span></a></td>
+            </tr>
+            {% endif %}
+        {% else %}
            <tr><td colspan="7" align="center">You didn't have any keys yet.</td> </tr>
-       {% endfor %}
+       {% endif %}
         </table>
     </div>
     </div>

mfa/templates/RECOVERY/Add.html

@@ -0,0 +1,134 @@
+
+{% extends "base.html" %}
+{% load static %}
+{% block head %}
+<style>
+    #two-factor-steps {
+	border: 1px solid #ccc;
+	border-radius: 3px;
+	padding: 15px;
+    }
+    .tokenrow{
+        margin-top: 10px;
+        margin-left: 5px;
+    }
+    .row{
+        margin: 3px;
+    }
+    .toolbtn {
+        border-radius: 7px;
+        cursor: pointer;
+    }
+    .toolbtn:hover {
+        background-color: gray;
+        transition: 0.2s;
+    }
+    .toolbtn:active {
+        background-color: green;
+        transition: 0.2s;
+    }
+</style>
+
+<script src="{% static 'mfa/js/qrious.min.js' %}" type="text/javascript"></script>
+<script type="text/javascript">
+    var clearCodes;
+    $(document).ready(function checkTokenLeft() {
+        $.ajax({"url":"{% url 'get_recovery_token_left' %}", dataType:"JSON",
+        success:function (data) {
+            tokenLeft = data.left
+            html = ""
+            {% if mfa_redirect %}
+                html += "<div class='alert alert-success'>You have enrolled successfully in {{ mfa_redirect }} method, please generate recovery codes so that you can use in case you lost access to all your verification methods.</div>"
+            {% endif %}
+            if (tokenLeft == 0) {
+                html += "<h6>You don't have any backup code linked to your account, please generate new ones !</h6>"
+                
+            }
+            else {
+                html += "<p>You still have "+tokenLeft+" backup code left."
+            }
+            document.getElementById('tokens').innerHTML = html
+        }})
+    });
+    function confirmRegenerateTokens() {
+        htmlModal = "<h6>Caution! you can only view these token now, else you will need to generate new ones.</h6><div align='center'><button onclick='regenerateTokens()' class='btn btn-success'>Regenerate</button></div>"
+        $("#modal-title").html("Regenerate your recovery Codes?")
+        $("#modal-body").html(htmlModal)
+        $("#popUpModal").modal('show')
+    }
+    function copy() {
+        navigator.clipboard.writeText($("#recovery_codes").text());
+    }
+    function regenerateTokens() {
+        $.ajax({
+            "url":"{% url 'regen_recovery_tokens' %}", dataType:"JSON",
+            success:function (data) {
+                let htmlkey=`<p>Here are the recovery codes, you have to save them now as you won't able to view them again.</p>
+                <div class='row'><div class='offset-4 col-md-4' style='background-color:#f0f0f0;padding: 10px'>
+                    <div class='row'>
+                    <div class="col-6 offset-6">
+                    <span onclick='download_recovery()' class='fa fa-download toolbtn' title="Download"></span>&nbsp;&nbsp;
+                    <span class='fa fa-clipboard toolbtn' title="Copy" onclick="copy()"></span>
+                    </div></div><div id='recovery_codes'><pre>`;
+                for (let i = 0; i < data.keys.length; i++) {
+                        htmlkey +="- " +data.keys[i] + "\n"
+                }
+                document.getElementById('tokens').innerHTML = htmlkey+"</pre></div></div></div>"
+                $("#popUpModal").modal('hide')
+                clearCodes = data.keys
+            }
+        })
+    }
+    function download_recovery() {
+        var element = document.createElement('a');
+        var text = "";
+        for(let i = 0; i < clearCodes.length; i++)
+        {
+            text = text + clearCodes[i] 
+            if (i < clearCodes.length - 1) { text = text + "\n"}
+        }
+        element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(text));
+        element.setAttribute('download', 'Recovery Codes.txt');
+        element.style.display = 'none';
+        document.body.appendChild(element);
+        element.click();
+        console.log(element.innerHTML)
+        document.body.removeChild(element);
+    }
+    </script>
+{% endblock %}
+{% block content %}
+<br/>
+<br/>
+<div class="container d-flex justify-content-center">
+    <div class="col-md-6 col-md-offset-3" id="two-factor-steps">
+        
+        <div class="row">
+            
+            <h4>Recovery Codes List</h4>
+        
+        </div>
+            
+        <div class="tokenrow" id="tokens">
+        
+        </div>
+         <br/>
+            <br/>
+        <div class="row">
+
+            <div class="col-md-4 col-md-offset-4" style="padding-left: 0px" align="center">
+
+                <button onclick="confirmRegenerateTokens()" class="btn btn-success">Regenerate</button>
+                
+            </div>
+
+            <div class="col-md-6"  align="right" style="padding-right: 30px">
+
+                <a href="{{redirect_html}}" class="btn btn-default btn-secondary" role="button"> {{reg_success_msg}}</a>
+
+            </div>
+        </div>
+    </div>
+</div>
+{% include "modal.html" %}
+{% endblock %}

mfa/templates/RECOVERY/Auth.html

@@ -0,0 +1,14 @@
+{% extends "mfa_auth_base.html" %}
+{% block head %}
+    <style>
+    .row{
+        margin-left: 15px;
+    }
+    </style>
+{% endblock %}
+{% block content %}
+<br/>
+<br/>
+{% include "RECOVERY/recheck.html" with mode='auth' %}
+
+  {% endblock %}

mfa/templates/RECOVERY/recheck.html

@@ -0,0 +1,85 @@
+<script type="application/javascript">
+    $(document).ready(function showWarningLastBackup() {
+        {% if lastBackup %}
+        $("#modal-title").html("Last backup code used !")
+        $("#modal-body").html("Don't forget to regenerate new backup code after login !")
+        $('#modal-footer').html(`<FORM METHOD="GET" ACTION="{% url 'recovery_auth' %}" Id="confirmLogin" onSubmit="" name="recoveryLastBackupConfirm">
+        <input type='submit'class='btn btn-lg btn-success btn-block' value='Continue'>`)
+        $("#popUpModal").modal('show')
+        {% endif %}
+        return
+    });
+    function send_recovery() {
+        $.ajax({"url":"{% url 'recovery_recheck' %}", method:"POST",dataType:"JSON",
+            data:{"csrfmiddlewaretoken":"{{ csrf_token }}","recovery":$("#recovery").val()},
+         success:function (data) {
+                            if (data["recheck"])
+                                mfa_success_function();
+                            else {
+                                mfa_failed_function();
+                            }
+                        }
+        })
+    }
+</script>
+<div class="row">
+<div class="col-sm-10 col-sm-offset-1 col-xs-12 col-md-10 col-md-offset-1 col-lg-10 col-lg-offset-1">
+<div class="panel panel-default card">
+      <div class="panel-heading card-header">
+	      <strong> Recovery code</strong>
+      </div>
+      <div class="panel-body card-body">
+
+      <FORM METHOD="POST" ACTION="{% url 'recovery_auth' %}" Id="formLogin" onSubmit="" name="FrontPage_Form1">
+
+
+      {% csrf_token %}
+          {%  if invalid %}
+          <div class="alert alert-danger">
+              Sorry, The provided code is not valid, or has already been used.
+          </div>
+          {% endif %}
+      {% if quota %}
+          <div class="alert alert-warning">
+              {{ quota }}
+          </div>
+      {% endif %}
+      <fieldset>
+      <div class="row">
+      <div class="col-sm-12 col-md-12">
+        <p>Enter the 11-digits on your authenticator. Or input a recovery code</p>
+      </div>
+      </div>
+
+      <div class="row">
+	  <div class="col-sm-12 col-md-12">
+	    <div class="form-group">
+	      <div class="input-group mb-3">
+		<span class="input-group-addon input-group-text">
+		<i class="glyphicon glyphicon-lock bi bi-lock"></i>
+		</span>
+		<input class="form-control" size="11" MaxLength="11" value="" placeholder="e.g abcde-fghij" name="recovery" type="text" id="recovery" autofocus>
+
+	      </div>
+	    </div>
+
+          <div class="form-group d-grid gap-2">
+
+            <input type="{% if mode == "auth" %}submit{% elif mode == 'recheck'  %}button{% endif %}" {% if mode == "recheck" %}onclick="send_recovery()" {% endif %} class="btn btn-lg btn-success btn-block" value="Sign in">
+	      </div>
+      </div>
+      </fieldset>
+      </FORM>
+      </div>
+        <div class="row">
+        <div class="col-md-12 mb-3" style="padding-left: 25px">
+            {% if request.session.mfa_methods|length > 1 %}
+                <a href="{%  url 'mfa_methods_list' %}">Select Another Method</a>
+            {% endif %}
+        </div>
+        </div>
+	      </div>
+              </div>
+</div>
+</div>
+{% include "modal.html" %}

mfa/templates/TOTP/Add.html

@@ -7,10 +7,22 @@
 	border: 1px solid #ccc;
 	border-radius: 3px;
 	padding: 15px;
-}
+    }
     .row{
         margin: 0px;
     }
+    .toolbtn {
+        border-radius: 7px;
+        cursor: pointer;
+    }
+    .toolbtn:hover {
+        background-color: gray;
+        transition: 0.2s;
+    }
+    .toolbtn:active {
+        background-color: green;
+        transition: 0.2s;
+    }
     </style>
 <script src="{% static 'mfa/js/qrious.min.js' %}" type="text/javascript"></script>
 <script type="text/javascript">
@@ -29,8 +41,17 @@
         })
     });
     function showKey() {
+        const htmlkey = `
+            <div class="row">
+                <div class="col-11">
+                    <pre id="totp_secret">`+window.key+`</pre>
+                </div>
+                <div class="col-1">
+                    <span onclick=navigator.clipboard.writeText($("#totp_secret").text()) class="fa fa-clipboard toolbtn"></span>
+                </div>
+            </div>`
         $("#modal-title").html("Your Secret Key")
-        $("#modal-body").html("<pre>"+window.key+"</pre")
+        $("#modal-body").html(htmlkey)
         $("#popUpModal").modal('show')
     }
     function verify() {
@@ -38,13 +59,16 @@
         $.ajax({
             "url":"{% url 'verify_otop' %}?key="+key+ "&answer="+answer,
             success:function (data) {
-                if (data == "Error")
+            if (data =='Success')
-                    alert("You entered wrong numbers, please try again")
+                $("#res").html("<div class='alert alert-success'>Your authenticator is registered successfully, <a href='{{redirect_html}}'> {{reg_success_msg}}</a></div>")
-                else
+      else if (data == "RECOVERY")
-                {
+      {
-                    alert("Your authenticator is added successfully.")
+         setTimeout(function (){location.href="{% url 'manage_recovery_codes' %}"},2500)
-                    window.location.href="{{ redirect_html }}"
+        $("#res").html("<div class='alert alert-success'>Your authenticator is registered successfully, but <a href='{% url 'manage_recovery_codes' %}'>redirecting to {{ RECOVERY_METHOD }} method</a></div>")
-                }
+      }
+      else
+        $("#res").html("<div class='alert alert-danger'>The code provided doesn't match the key, please try again or <a href='{% url 'mfa_home' %}'> Go to Security Home</a></div>")
+
             }
         })
     }
@@ -66,21 +90,24 @@
 <div class="container d-flex justify-content-center">
     <div class="col-md-6 col-md-offset-3" id="two-factor-steps">
         <div class="row" align="center">
-            <h4>Adding Authenticator</h4>
+            <h4>Adding a new {{ method.name }}</h4>
         </div>
         <div class="row">
 
             <p>Scan the image below with the two-factor authentication app on your <a href="javascript:void(0)" onclick="showTOTP()">phone/PC</a>. If you can’t use a barcode,
                 <a href="javascript:void(0)" onclick="showKey()">enter this text</a> instead. </p>
         </div>
+        <div id="res">
 
-        <div class="row">
+        </div>
+        <div class="row" style="text-align: center">
 
-            <div align="center" style="display: none" id="second_step">
+            <div align="center" style="display: none;text-align: center;align-content: center" id="second_step">
 
                 <img id="qr"/>
 
             </div>
+        </div>
             <div class="row">
 
                 <p><b>Enter the six-digit code from the application</b></p>
@@ -88,16 +115,13 @@
 
             </div>
             <div class="row">
-
+                <div class="offset-md-4 col-md-4">
-
                 <input style="display: inline;width: 95%" maxlength="6" size="6" class="form-control" id="answer" placeholder="e.g 785481"/>
-
+                </div>
             </div>
             <div class="row" style="padding-top: 10px;">
-                <div class="col-md-6" style="padding-left: 0px">
+                <div class="col-md-4 offset-md-4" style="padding-left: 0px">
                     <button class="btn btn-success" onclick="verify()">Enable</button>
-                </div>
-                <div class="col-md-6" align="right" style="padding-right: 30px">
                     <a href="{% url 'mfa_home' %}" class="btn btn-default btn-secondary" role="button">Cancel</a>
                 </div>
             </div>

mfa/templates/TOTP/recheck.html

@@ -10,7 +10,6 @@
                             }
                         }
         })
-
     }
 </script>
 <div class='container'>
@@ -40,7 +39,7 @@
       <fieldset>
       <div class="row">
       <div class="col-sm-12 col-md-12">
-        <p>Enter the 6-digits on your authenticator.</p>
+        <p>Enter the 6-digits on your authenticator</p>
       </div>
       </div>
 
@@ -58,8 +57,7 @@
 
           <div class="form-group d-grid gap-2">
 
-	      <input type="{% if mode == "auth" %}submit{% elif mode == 'recheck'  %}button{% endif %}" {% if mode == "recheck" %}onclick="send_totp()" {% endif %} class="btn btn-lg btn-success btn-block" value="Sign in">
+            <input type="{% if mode == "auth" %}submit{% elif mode == 'recheck'  %}button{% endif %}" {% if mode == "recheck" %}onclick="send_totp()" {% endif %} class="btn btn-lg btn-success btn-block" value="Sign in">	      </div>
-	      </div>
       </div>
       </fieldset>
       </FORM>
@@ -76,3 +74,4 @@
 	      </div>
 	      </div>
 </div>
+{% include "modal.html" %}

mfa/templates/TrustedDevices/start.html

@@ -1,5 +1,7 @@
 {% extends "base.html" %}
+{% load static %}
 {% block head %}
+    <script src="{% static 'mfa/js/qrious.min.js' %}" type="text/javascript"></script>
     <style>
     #two-factor-steps {
 	border: 1px solid #ccc;
@@ -12,6 +14,12 @@
     </style>
 
     <script type="text/javascript">
+    $(document).ready(function (){
+        var qr = new QRious({
+          element: document.getElementById('qr'),
+          value: "{{ url }}?u={{ request.user.username }}&k={{ key }}"
+        });
+    })
     function sendEmail() {
         $("#modal-title").html("Send Link")
         $("#modal-body").html("Sending Email, Please wait....");
@@ -82,21 +90,52 @@
         {%  if not_allowed %}
             <div class="alert alert-danger">You can't add any more devices, you need to remove previously trusted devices first.</div>
         {% else %}
-    <p style="color: green">Allow access from mobile phone and tables.</p>
+    <p style="color: green">Allow access from mobile phone and tables.</p><br/>
-    <h5>Steps:</h5>
+            <br/>
-        <ol>
+            </div>
+            <div class="row">
+                <h5>Steps:</h5>
+            </div>
+
+            <div class="row">
+                <div class="col-md-6">
+                    <h5>Using Camera</h5>
+                    <ol>
             <li>Using your mobile/table, open Chrome/Firefox.</li>
-            <li>Go to <b>{{ HOST }}{{ BASE_URL }}devices/add</b>&nbsp;&nbsp;<a href="javascript:void(0)" onclick="sendEmail()" title="Send to my email"><i class="fas fa-paper-plane"></i></a></li>
+            <li>Scan the following barcode <br/>
+                <img id="qr"/> <br/>
+            </li>
+            <li>Confirm the consent and submit form.</li>
+        </ol>
+                </div>
+
+
+            <div class="col-md-6">
+            <h5>Manual</h5>
+            <ol>
+            <li>Using your mobile/table, open Chrome/Firefox.</li>
+                <li>Go to <b>{{ url }}</b>&nbsp;&nbsp;</li>
             <li>Enter your username & following 6 digits<br/>
                 <span style="font-size: 16px;font-weight: bold; margin-left: 50px">{{ key|slice:":3" }} - {{ key|slice:"3:" }}</span>
             </li>
-            <li>This window will ask to confirm the device.</li>
+                <li>Confirm the consent and submit form.</li>
+                </div>
+            </div>
+            <div class="row">
+            <div class="col-md-8 offset-2">
+           This window will ask to confirm the device.
+            </div>
+            </div>
+
 
-        </ol>
     {% endif %}
     </div>
         </div>
-    </div>
+
+    <br/>
+        <br/>
+        <br/>
+        <br/>
     {% include "modal.html" %}
     {% include 'mfa_check.html' %}
 {% endblock %}

mfa/templates/U2F/Add.html

@@ -13,7 +13,7 @@
     </style>
     <script src="{% static 'mfa/js/u2f-api.js' %}" type="text/javascript"></script>
     <script type="text/javascript">
-    $(document).ready(function addToken() {
+    function addToken() {
                 data=JSON.parse('{{ token|safe }}')
                 console.log(data)
                 u2f.register(data.appId,data.registerRequests,data.registeredKeys,function (response) {
@@ -21,15 +21,24 @@
                         "url":"{% url 'bind_u2f' %}",method:"POST",
                         data:{"csrfmiddlewaretoken":"{{ csrf_token }}","response":JSON.stringify(response)},
                         success:function (data) {
-                            if (data == "OK")
+                        if (data =='OK')
-                            {
+                            $("#res").html("<div class='alert alert-success'>Your device is registered successfully, <a href='{{redirect_html}}'> {{reg_success_msg}}</a></div>")
-                                alert("Your device is added successfully.")
+                        else if (data == "RECOVERY")
-                                window.location.href="{{ redirect_html }}"
+                        {
-                            }
+                            setTimeout(function (){location.href="{% url 'manage_recovery_codes' %}"},2500)
+                            $("#res").html("<div class='alert alert-success'>Your device is registered successfully, but <a href='{% url 'manage_recovery_codes' %}'>redirecting to {{ RECOVERY_METHOD }} method</a></div>")
+                        }
+                        else
+                            $("#res").html("<div class='alert alert-danger'>Registration failed, please <a href='javascript:void(0)' onclick='addToken()'>try again</a> or <a href='{% url 'mfa_home' %}'> Go to Security Home</a></div>")
+                    },
+                        error: function (data)
+                        {
+                             $("#res").html("<div class='alert alert-danger'>Registration failed, please <a href='javascript:void(0)' onclick='addToken()'>try again</a> or <a href='{% url 'mfa_home' %}'> Go to Security Home</a></div>")
                         }
                     })
                 },5000)
-            })
+            }
+    $(document).ready(addToken())
 
     </script>
 {% endblock %}
@@ -37,9 +46,11 @@
       <br/>
     <br/>
     <div class="container">
+
         <div class="col-md-6 col-md-offset-3" id="two-factor-steps">
+            <div id="res"></div>
             <div class="row" align="center">
-                <h4>Adding Security Key</h4>
+                <h4>Adding {{ method.name}}</h4>
             </div>
     <div class="row">
     <p style="color: green">Your secure Key should be flashing now, please press on button.</p>

mfa/templates/U2F/recheck.html

@@ -4,7 +4,7 @@
 <div class="col-sm-10 col-sm-offset-1 col-xs-12 col-md-10 col-md-offset-1 col-lg-8 col-lg-offset-2">
 <div class="panel panel-default card">
       <div class="panel-heading card-header">
-	      <strong> Security Key</strong>
+	      <strong> Verify your identity using {{ method.name }}</strong>
       </div>
       <div class="panel-body card-body">
 

mfa/templates/select_mfa_method.html

@@ -1,11 +1,10 @@
 {% extends "mfa_auth_base.html" %}
 {% block content %}
-    <br/>
 <br/>
 <div class='container'>
 <div class="row">
 
-<div class="col-sm-10 col-sm-offset-1 col-xs-12 col-md-10 col-md-offset-1 col-lg-8 col-lg-offset-2">
+<div class="col-sm-10 col-sm-offset-1 col-xs-12 col-md-10 col-md-offset-1 col-lg-8 col-lg-offset-2 offset-2 col-8">
 <div class="panel panel-default card">
       <div class="panel-heading card-header">
 	      <strong> Select Second Verification Method</strong>
@@ -15,10 +14,11 @@
               {% for method in request.session.mfa_methods %}
 
               <li><a href="{% url "mfa_goto" method %}">
-                  {% if method == "TOTP" %}Authenticator App
+                  {% if method == "TOTP" %}{% if 'TOTP' in RENAME_METHODS %}{{ RENAME_METHODS.TOTP }}{% else %}Authenticator App{% endif %}
-                  {% elif method == "Email" %}Send OTP by Email
+                  {% elif method == "Email" %}{% if 'Email' in RENAME_METHODS %}{{ RENAME_METHODS.Email }}{% else %}Send OTP by Email{% endif %}
-                  {% elif method == "U2F" %}Secure Key
+                  {% elif method == "U2F" %}{% if 'U2F' in RENAME_METHODS %}{{ RENAME_METHODS.U2F }}{% else %}Secure Key{% endif %}
-                  {% elif method == "FIDO2" %}FIDO2 Secure Key
+                  {% elif method == "FIDO2" %}{% if 'FIDO2' in RENAME_METHODS %}{{ RENAME_METHODS.FIDO2 }}{% else %}FIDO2 Secure Key{% endif %}
+                  {% elif method == "RECOVERY" %}{% if 'RECOVERY' in RENAME_METHODS %}{{ RENAME_METHODS.RECOVERY }}{% else %}Recovery Code{% endif %}
                   {% endif %}
               </a> </li>
               {% endfor %}

mfa/totp.py

@@ -5,13 +5,14 @@ from .Common import get_redirect_url
 from .models import *
 from django.template.context_processors import csrf
 import simplejson
-from django.template.context import RequestContext
 from django.conf import settings
 import pyotp
 from .views import login
 import datetime
 from django.utils import timezone
 import random
+
+
 def verify_login(request,username,token):
     for key in User_Keys.objects.filter(username=username,key_type = "TOTP"):
         totp = pyotp.TOTP(key.properties["secret_key"])
@@ -25,7 +26,7 @@ def recheck(request):
     context = csrf(request)
     context["mode"]="recheck"
     if request.method == "POST":
-        if verify_login(request,request.user.username, token=request.POST["otp"]):
+        if verify_login(request,request.user.username, token=request.POST["otp"])[0]:
             import time
             request.session["mfa"]["rechecked_at"] = time.time()
             return HttpResponse(simplejson.dumps({"recheck": True}), content_type="application/json")
@@ -37,15 +38,18 @@ def recheck(request):
 def auth(request):
     context=csrf(request)
     if request.method=="POST":
-        res=verify_login(request,request.session["base_username"],token = request.POST["otp"])
+        tokenLength = len(request.POST["otp"])
-        if res[0]:
+        if tokenLength == 6:
-            mfa = {"verified": True, "method": "TOTP","id":res[1]}
+            #TOTO code check
-            if getattr(settings, "MFA_RECHECK", False):
+            res=verify_login(request,request.session["base_username"],token = request.POST["otp"])
-                mfa["next_check"] = datetime.datetime.timestamp((datetime.datetime.now()
+            if res[0]:
-                                         + datetime.timedelta(
+                mfa = {"verified": True, "method": "TOTP","id":res[1]}
-                            seconds=random.randint(settings.MFA_RECHECK_MIN, settings.MFA_RECHECK_MAX))))
+                if getattr(settings, "MFA_RECHECK", False):
-            request.session["mfa"] = mfa
+                    mfa["next_check"] = datetime.datetime.timestamp((datetime.datetime.now()
-            return login(request)
+                                            + datetime.timedelta(
+                                seconds=random.randint(settings.MFA_RECHECK_MIN, settings.MFA_RECHECK_MAX))))
+                request.session["mfa"] = mfa
+                return login(request)
         context["invalid"]=True
     return render(request,"TOTP/Auth.html", context)
 
@@ -68,10 +72,19 @@ def verify(request):
         #uk.name="Authenticatior #%s"%User_Keys.objects.filter(username=user.username,type="TOTP")
         uk.key_type="TOTP"
         uk.save()
-        return HttpResponse("Success")
+        if getattr(settings, 'MFA_ENFORCE_RECOVERY_METHOD', False) and not User_Keys.objects.filter(key_type="RECOVERY",
+                                                                                                    username=request.user.username).exists():
+            request.session["mfa_reg"] = {"method": "TOTP",
+                                          "name": getattr(settings, "MFA_RENAME_METHODS", {}).get("TOTP", "TOTP")}
+            return HttpResponse("RECOVERY")
+        else:
+            return HttpResponse("Success")
     else: return HttpResponse("Error")
 
 @never_cache
 def start(request):
     """Start Adding Time One Time Password (TOTP)"""
-    return render(request,"TOTP/Add.html",get_redirect_url())
+    context = get_redirect_url()
+    context["RECOVERY_METHOD"] = getattr(settings, "MFA_RENAME_METHODS", {}).get("RECOVERY", "Recovery codes")
+    context["method"] = {"name":getattr(settings,"MFA_RENAME_METHODS",{}).get("TOTP","Authenticator")}
+    return render(request,"TOTP/Add.html",context)

mfa/urls.py

@@ -1,4 +1,4 @@
-from . import views,totp,U2F,TrustedDevice,helpers,FIDO2,Email
+from . import views,totp,U2F,TrustedDevice,helpers,FIDO2,Email,recovery
 #app_name='mfa'
 
 try:
@@ -12,6 +12,12 @@ urlpatterns = [
     url(r'totp/auth', totp.auth, name="totp_auth"),
     url(r'totp/recheck', totp.recheck, name="totp_recheck"),
 
+    url(r'recovery/start', recovery.start, name="manage_recovery_codes"),
+    url(r'recovery/getTokenLeft', recovery.getTokenLeft, name="get_recovery_token_left"),
+    url(r'recovery/genTokens', recovery.genTokens, name="regen_recovery_tokens"),
+    url(r'recovery/auth', recovery.auth, name="recovery_auth"),
+    url(r'recovery/recheck', recovery.recheck, name="recovery_recheck"),
+
     url(r'email/start/', Email.start , name="start_email"),
     url(r'email/auth/', Email.auth , name="email_auth"),
 

mfa/views.py

@@ -1,3 +1,5 @@
+import importlib
+
 from django.shortcuts import render
 from django.http import HttpResponse,HttpResponseRedirect
 from .models import *
@@ -16,12 +18,16 @@ from user_agents import parse
 def index(request):
     keys=[]
     context={"keys":User_Keys.objects.filter(username=request.user.username),"UNALLOWED_AUTHEN_METHODS":settings.MFA_UNALLOWED_METHODS
-             ,"HIDE_DISABLE":getattr(settings,"MFA_HIDE_DISABLE",[])}
+             ,"HIDE_DISABLE":getattr(settings,"MFA_HIDE_DISABLE",[]),'RENAME_METHODS':getattr(settings,'MFA_RENAME_METHODS',{})}
     for k in context["keys"]:
-        if k.key_type =="Trusted Device" :
+        k.name = getattr(settings,'MFA_RENAME_METHODS',{}).get(k.key_type,k.key_type)
+        if k.key_type =="Trusted Device":
             setattr(k,"device",parse(k.properties.get("user_agent","-----")))
         elif k.key_type == "FIDO2":
             setattr(k,"device",k.properties.get("type","----"))
+        elif k.key_type == "RECOVERY":
+            context["recovery"] = k
+            continue
         keys.append(k)
     context["keys"]=keys
     return render(request,"MFA.html",context)
@@ -37,17 +43,23 @@ def verify(request,username):
             return login(request)
         methods.remove("Trusted Device")
     request.session["mfa_methods"] = methods
+
     if len(methods)==1:
         return HttpResponseRedirect(reverse(methods[0].lower()+"_auth"))
+    if getattr(settings,"MFA_ALWAYS_GO_TO_LAST_METHOD",False):
+        keys = keys.exclude(last_used__isnull=True).order_by("last_used")
+        if keys.count()>0:
+            return HttpResponseRedirect(reverse(keys[0].key_type.lower() + "_auth"))
     return show_methods(request)
 
 def show_methods(request):
-    return render(request,"select_mfa_method.html", {})
+    return render(request,"select_mfa_method.html", {'RENAME_METHODS':getattr(settings,'MFA_RENAME_METHODS',{})})
 
 def reset_cookie(request):
     response=HttpResponseRedirect(settings.LOGIN_URL)
     response.delete_cookie("base_username")
     return response
+
 def login(request):
     from django.contrib import auth
     from django.conf import settings

requirements.txt

@@ -1,4 +1,4 @@
-django >= 2.0
+django >= 2.2
 jsonfield
 simplejson
 pyotp
@@ -6,5 +6,5 @@ python-u2flib-server
 ua-parser
 user-agents
 python-jose
-fido2 == 0.9.1
+fido2 == 1.0.0
 jsonLookup

setup.py

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='django-mfa2',
-    version='2.5.0',
+    version='2.8.0',
     description='Allows user to add 2FA to their accounts',
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
@@ -17,7 +17,6 @@ setup(
     packages=find_packages(),
     install_requires=[
         'django >= 2.0',
-        'jsonfield',
         'simplejson',
         'pyotp',
         'python-u2flib-server',
@@ -25,13 +24,13 @@ setup(
         'user-agents',
         'python-jose',
         'fido2 == 1.0.0',
-        'jsonLookup'
       ],
     python_requires=">=3.5",
     include_package_data=True,
     zip_safe=False, # because we're including static files
     classifiers=[
         "Development Status :: 5 - Production/Stable",
+        #"Development Status :: 4 - Beta",
         "Environment :: Web Environment",
         "Framework :: Django",
         "Framework :: Django :: 2.0",
@@ -41,6 +40,7 @@ setup(
         "Framework :: Django :: 3.1",
         "Framework :: Django :: 3.2",
         "Framework :: Django :: 4.0",
+        "Framework :: Django :: 4.1",
         "Intended Audience :: Developers",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
@@ -51,6 +51,7 @@ setup(
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 )