Releasing v2.2.0

CHANGELOG.md

@@ -1,12 +1,16 @@
 # Change Log
 
+## 2.2.0
+   * Added: MFA_REDIRECT_AFTER_REGISTRATION settings parameter
+   * Fixed: Deprecation error for NULBooleanField
+
 ## 2.1.2
   * Fixed: Getting timestamp on Python 3.7 as ("%s") is raising an exception
   * Upgraded to FIDO 0.9.1
 
 
 ## 2.1.1
-  * Fixed: FIDO2 version in requirments.txt file.
+  * Fixed: FIDO2 version in requirements.txt file.
   
 ## 2.1.0
    * Added Support for Touch ID for Mac OSx and iOS 14 on Safari

README.md

@@ -68,6 +68,8 @@ Depends on
    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_REDIRECT_AFTER_REGISTRATION="mfa_home"   # Allows Changing the page after successful registeration
+   MFA_SUCCESS_REGISTRATION_MSG = "Go to Security Home" # The text of the link
    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
@@ -91,6 +93,8 @@ Depends on
    **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`
 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

@@ -9,8 +9,8 @@ Usually your login function will check for username and password, log the user i
      * 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>
+```python
-    def login(request): # this function handles the login form POST
+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
@@ -19,5 +19,5 @@ Usually your login function will check for username and password, log the user i
              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>
+```
 

example/example/settings.py

@@ -77,10 +77,8 @@ WSGI_APPLICATION = 'example.wsgi.application'
 
 DATABASES = {
     'default': {
-        'ENGINE': 'django.db.backends.mysql',
+        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': 'mfa',
+        'NAME': 'test_db',
-        'USER': 'root',
-        'PASSWORD': 'password',
     }
 }
 
@@ -141,7 +139,9 @@ 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
-MFA_HIDE_DISABLE=('FIDO2',)     # Can the user disable his key (Added in 1.2.0).
+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"
 
 TOKEN_ISSUER_NAME="PROJECT_NAME"      #TOTP Issuer name
 

example/example/templates/home.html

@@ -12,6 +12,9 @@
         </ol>
 
         <!-- Page Content -->
+          {% if registered %}
+              <div class="alert alert-success">Registered Successfully</div>
+          {% endif %}
         <h1>Welcome {{ request.user.username }}!</h1>
         <hr>
 

example/example/urls.py

@@ -22,5 +22,6 @@ urlpatterns = [
     path('auth/login',auth.loginView,name="login"),
     path('auth/logout',auth.logoutView,name="logout"),
 
-    re_path('^$',views.home,name='home')
+    re_path('^$',views.home,name='home'),
+    path('registered/',views.registered,name='registered')
 ]

example/example/views.py

@@ -5,3 +5,7 @@ from django.contrib.auth.decorators import login_required
 @login_required()
 def home(request):
     return render(request,"home.html",{})
+
+@login_required()
+def registered(request):
+    return render(request,"home.html",{"registered":True})

example/requiremnts.txt

@@ -1,2 +1,2 @@
-django==2.0
+django >= 2.2
-django-sslserver
+django_ssl

mfa/Common.py

@@ -1,5 +1,9 @@
 from django.conf import settings
 from django.core.mail import EmailMessage
+try:
+    from django.urls import reverse
+except:
+    from django.core.urlresolver import reverse
 
 def send(to,subject,body):
     from_email_address = settings.EMAIL_HOST_USER
@@ -9,3 +13,7 @@ def send(to,subject,body):
     email = EmailMessage(subject,body,From,to)
     email.content_subtype = "html"
     return email.send(False)
+
+def get_redirect_url():
+    return {"redirect_html": reverse(getattr(settings, 'MFA_REDIRECT_AFTER_REGISTRATION', 'mfa_home')),
+            "reg_success_msg":getattr(settings,"MFA_SUCCESS_REGISTRATION_MSG")}

mfa/Email.py

@@ -7,7 +7,9 @@ from .models import *
 #from django.template.context import RequestContext
 from .views import login
 from .Common import send
+
 def sendEmail(request,username,secret):
+    """Send Email to the user after rendering `mfa_email_token_template`"""
     from django.contrib.auth import get_user_model
     User = get_user_model()
     key = getattr(User, 'USERNAME_FIELD', 'username')
@@ -18,9 +20,10 @@ def sendEmail(request,username,secret):
 
 @never_cache
 def start(request):
+    """Start adding email as a 2nd factor"""
     context = csrf(request)
     if request.method == "POST":
-        if request.session["email_secret"] == request.POST["otp"]:
+        if request.session["email_secret"] == request.POST["otp"]:  #if successful
             uk=User_Keys()
             uk.username=request.user.username
             uk.key_type="Email"
@@ -31,15 +34,16 @@ def start(request):
                 from django.core.urlresolvers import reverse
             except:
                 from django.urls import reverse
-            return HttpResponseRedirect(reverse('mfa_home'))
+            return HttpResponseRedirect(reverse(getattr(settings,'MFA_REDIRECT_AFTER_REGISTRATION','mfa_home')))
         context["invalid"] = True
     else:
-        request.session["email_secret"] = str(randint(0,100000))
+        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)
 @never_cache
 def auth(request):
+    """Authenticating the user by email."""
     context=csrf(request)
     if request.method=="POST":
         if request.session["email_secret"]==request.POST["otp"].strip():

mfa/FIDO2.py

@@ -14,10 +14,12 @@ from fido2.utils import websafe_decode, websafe_encode
 from fido2.ctap2 import AttestedCredentialData
 from .views import login, reset_cookie
 import datetime
+from .Common import get_redirect_url
 from django.utils import timezone
 
 
 def recheck(request):
+    """Starts FIDO2 recheck"""
     context = csrf(request)
     context["mode"] = "recheck"
     request.session["mfa_recheck"] = True
@@ -25,11 +27,13 @@ def recheck(request):
 
 
 def getServer():
+    """Get Server Info from settings and returns a Fido2Server"""
     rp = PublicKeyCredentialRpEntity(settings.FIDO_SERVER_ID, settings.FIDO_SERVER_NAME)
     return Fido2Server(rp)
 
 
 def begin_registeration(request):
+    """Starts registering a new FIDO Device, called from API"""
     server = getServer()
     registration_data, state = server.register_begin({
         u'id': request.user.username.encode("utf8"),
@@ -43,6 +47,7 @@ def begin_registeration(request):
 
 @csrf_exempt
 def complete_reg(request):
+    """Completes the registeration, called by API"""
     try:
         data = cbor.decode(request.body)
 
@@ -72,7 +77,9 @@ def complete_reg(request):
 
 
 def start(request):
+    """Start Registeration a new FIDO Token"""
     context = csrf(request)
+    context.update(get_redirect_url())
     return render(request, "FIDO2/Add.html", context)
 
 

mfa/U2F.py

@@ -76,6 +76,7 @@ def start(request):
     request.session['_u2f_enroll_'] = enroll.json
     context=csrf(request)
     context["token"]=simplejson.dumps(enroll.data_for_client)
+    context.update(get_redirect_url())
     return render(request,"U2F/Add.html",context)
 
 

mfa/__init__.py

@@ -1 +1 @@
-__version__="2.1.2"
+__version__="2.2.0"

mfa/migrations/0011_auto_20210530_0622.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2 on 2021-05-30 06:22
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('mfa', '0010_auto_20201110_0557'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='user_keys',
+            name='owned_by_enterprise',
+            field=models.BooleanField(blank=True, default=None, null=True),
+        ),
+    ]

mfa/models.py

@@ -2,9 +2,9 @@ from django.db import models
 from jsonfield import JSONField
 from jose import jwt
 from django.conf import settings
-from jsonLookup import shasLookup, hasLookup
+#from jsonLookup import shasLookup, hasLookup
-JSONField.register_lookup(shasLookup)
+# JSONField.register_lookup(shasLookup)
-JSONField.register_lookup(hasLookup)
+# JSONField.register_lookup(hasLookup)
 
 
 class User_Keys(models.Model):
@@ -15,7 +15,7 @@ class User_Keys(models.Model):
     enabled=models.BooleanField(default=True)
     expires=models.DateTimeField(null=True,default=None,blank=True)
     last_used=models.DateTimeField(null=True,default=None,blank=True)
-    owned_by_enterprise=models.NullBooleanField(default=None,null=True,blank=True)
+    owned_by_enterprise=models.BooleanField(default=None,null=True,blank=True)
 
     def save(self, force_insert=False, force_update=False, using=None, update_fields=None):
         if self.key_type == "Trusted Device" and self.properties.get("signature","") == "":

mfa/templates/FIDO2/Add.html

@@ -32,7 +32,7 @@
     }).then(function (res)
         {
       if (res["status"] =='OK')
-            $("#res").html("<div class='alert alert-success'>Registered Successfully, <a href='{% url 'mfa_home' %}'> Go to Security Home</a></div>")
+            $("#res").html("<div class='alert alert-success'>Registered Successfully, <a href='{{redirect_html}}'> {{reg_success_msg}}</a></div>")
         else
             $("#res").html("<div class='alert alert-danger'>Registeration 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>")
 

mfa/templates/TOTP/Add.html

@@ -43,7 +43,7 @@
                 else
                 {
                     alert("Your authenticator is added successfully.")
-                    window.location.href="{% url 'mfa_home' %}"
+                    window.location.href="{{ redirect_html }}"
                 }
             }
         })

mfa/templates/U2F/Add.html

@@ -24,7 +24,7 @@
                             if (data == "OK")
                             {
                                 alert("Your device is added successfully.")
-                                window.location.href="{% url 'mfa_home' %}"
+                                window.location.href="{{ redirect_html }}"
                             }
                         }
                     })

mfa/totp.py

@@ -72,4 +72,5 @@ def verify(request):
 
 @never_cache
 def start(request):
-    return render(request,"TOTP/Add.html",{})
+    """Start Adding Time One Time Password (TOTP)"""
+    return render(request,"TOTP/Add.html",get_redirect_url())

requirements.txt

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

setup.py

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='django-mfa2',
-    version='2.1.2',
+    version='2.2.0',
     description='Allows user to add 2FA to their accounts',
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
@@ -34,10 +34,11 @@ setup(
         "Development Status :: 5 - Production/Stable",
         "Environment :: Web Environment",
         "Framework :: Django",
-        "Framework :: Django :: 1.11",
         "Framework :: Django :: 2.0",
         "Framework :: Django :: 2.1",
         "Framework :: Django :: 2.2",
+        "Framework :: Django :: 3.0",
+        "Framework :: Django :: 3.1",
         "Intended Audience :: Developers",
         "Operating System :: OS Independent",
         "Programming Language :: Python",