Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 2.36 KB

README.md

File metadata and controls

70 lines (51 loc) · 2.36 KB
Raw

esteid authentication

The idea: have a clear, extensible API that is easy to integrate.

Solution: One view, Pluggable authenticators (not 100% achievable, see below)

Contents

Quickstart

# views_mixin.py
class MyAuthMixin:
    def on_auth_success(self, request, data):
        """For instance, save the authentication data to session"""
        request.session['username'] = f"{data.given_name} {data.surname}"


# views.py - Pure Django
from django.views.generic import View
from esteid.authentication import AuthenticationViewDjangoMixin

class MyAuthView(MyAuthMixin, AuthenticationViewDjangoMixin, View):
    pass

# Or: views.py - Rest Framework
from rest_framework.views import APIView
from esteid.authentication import AuthenticationViewRestMixin

class MyRestAuthView(MyAuthMixin, AuthenticationViewRestMixin, APIView):
    pass

# urls.py
from django.urls.conf import re_path

from esteid.idcard import IdCardAuthenticator
from esteid.mobileid import MobileIdAuthenticator
from esteid.smartid import SmartIdAuthenticator
from .views import MyAuthView
    
urlpatterns = [
    re_path(rf"^/authenticate/{auth_class.get_method_name()}/", 
            MyAuthView.as_view(authenticator=auth_class), 
            name=f"auth-{auth_class.get_method_name()}")
    for auth_class in [IdCardAuthenticator, MobileIdAuthenticator, SmartIdAuthenticator]
]

Testing Authentication with the Library

To test IDCard, SmartID and MobileID:

  • Install, if necessary, and activate the library's virtualenv
  • Start the server locally: ./manage.py runserver 8765
  • Open the auth testing page

To test ID card authentication you must use HTTPS as the browser extension refuses to work without HTTPS. Simple way to get https to work locally is to use ngrok. For example: ngrok http 8000 will create an https proxy to the dev server running on your local machine. See here for more info.

Pluggable Authenticator

The outline of the flow implementation is the Dependency Inversion pattern: instead of the view explicitly calling an implementation, the view interacts with an Authenticator class, which loads a pluggable implementation based on the method selected by user.