8. Django Integration

Warning

Because Krptn uses a strict security model, the Django Admin cannot change the user’s password, or any other attributes. Any attempt to do so will fail. To avoid tempting administrators to try anyway, it may be a good idea to remove these forms from the admin site.

Note

In order for this to make sense please read User Auth first. It it also useful to have a knowledge of the Django webframework.

You can check our example implementation on GitHub.

As you will notice, Krptn does not integrate with Django’s Authentication but rather serves as a replacement. However, this comes with the limitation that (whitout extra programming) you cannot login with a Krptn account into the Django admin site. For that, you need to create a Django account.

Also, Krptn accounts, because of our strict security model, will have issues with Django’s permissions. Avoid using built-in Django permision management and instead do permision checks manually. The only exception to this is the login_required decorator, but this is only valid, if you have your custom login page configured (/accounts/login).

8.1. Middleware

In order to use Krptn’s user model as request.user in your view, you need to install the middleware.

Please add Krptn middleware to the end of the list.

For exmaple:

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'krypton.auth.django.middleware.kryptonLoginMiddleware' ## <-- Like here
]

Inside your views:

def aRandomView(request):
    request.user.
    # request.user is a krypton.auth.django.users.djangoUser object
    # djangoUser object has the same interface as a standardUser objects

If you want to use type annotations, since the default Django HttpRequest is no longer valid, you can do something like this:

from krypton.auth.django.types import KrHttpRequest

def aRandomView(request: KrHttpRequest) -> HttpResponse:
    ## Your logic in here

After that type analysis in IDEs should work properly.

The only thing that KrHttpRequest does is override the user property in django.http.HttpRequest to point to Krptn’s djangoUser.

8.2. Forms

Krptn requires custom forms for user management (e.g.: creation, password reset, etc..). You need to configure the forms. Because everyone has a wide variety of needs regarding user creation, there is no single form to use. You need to create these forms according to your needs.

We will briefly discuss how to create these forms.

8.2.1. Create User

from django import forms
from krypton.auth.django import users

class UserCreationForm(forms.Form):
    Password = forms.CharField(widget=forms.PasswordInput)
    userName = forms.CharField(label = "User Name")
    age = forms.CharField(label = "Age")
    def save(self, commit=True):
        user = users.djangoUser(None)
        token = user.saveNewUser(pwd=self.cleaned_data["Password"], name=self.cleaned_data["userName"])
        user.setData("Age", self.cleaned_data["age"])
        return token, user.id

Do not forget to set token and user.id as cookies in any view that handles authentication!! Otherwise, the middleware will have issues!

response.set_cookie("_KryptonUserID", UserId)
response.set_cookie("_KryptonSessionToken", token, 15*60) # set token for 15 minutes

The cookies have to have the same name as in the above example.

Again, you will need to customise this form to include fields that you need.

As you can see we use Krptn’s User Auth inside the forms save method.

8.2.2. Login

This form depends on whether you are using MFA and whether you use FIDO or TOTP MFA.

In this example, we will use TOTP.

class LoginForm(forms.Form):
    userName = forms.CharField(label = "User Name")
    password = forms.CharField(widget=forms.PasswordInput)
    totp = forms.IntegerField(label = "TOTP")
    def save(self, commit=True):
        user = users.djangoUser(self.cleaned_data["userName"])
        token = user.login(pwd=self.cleaned_data["userName"], mfaToken=str(self.cleaned_data["totp"]))
        return token, user.id

Do not forget to set token and user.id as cookies in any view that handles authentication!! Otherwise, the middleware will have issues!

response.set_cookie("_KryptonUserID", UserId)
response.set_cookie("_KryptonSessionToken", token, 15*60) # set token for 15 minutes

The cookies have to have the same name as in the above example.

8.2.3. Other forms

There are plenty of other possible forms. For example, enabling MFA, password resets, etc.. However, we will not discuess them.

In case of any doubt, you can check our example on GitHub or reach out to us.