django-helseid 1.0.3

A Django app for HelseID authentication.

django-helseid

Django application for authenticating users with HelseID

Installation

⚠️ WARNING: This project is currently under development and is NOT production-ready. It is intended for demonstration and testing purposes only. Do not use in a production environment without thorough security review and further development. ⚠️

Requirements: Python 3.12+, Django 6.0+

1. Install the package:

   pip install django-helseid
   

   Or locally for development:

   uv pip install -e .
   

2. Add helseid to your INSTALLED_APPS in settings.py:

   INSTALLED_APPS = [
       ...
       'helseid',
   ]
   

3. Add the authentication backend:

   AUTHENTICATION_BACKENDS = [
       'django.contrib.auth.backends.ModelBackend',
       'helseid.backends.HelseIDBackend',
   ]
   

4. Configure HELSEID settings:

   HELSEID = {
       'CLIENT_ID': 'your-client-id',
       'CLIENT_SECRET': { ... },  # JWK dict (private key)
       'SCOPE': ['openid', 'profile', ...],
       'ENVIRONMENT': 'production',  # 'test' or 'production'
   }
   

   ENVIRONMENT sets the HelseID server URL and JWT audience automatically:

   • 'test' → https://helseid-sts.test.nhn.no
   • 'production' → https://helseid-sts.nhn.no

   For non-standard deployments you can override the URL explicitly instead:

   HELSEID = {
       ...
       'SERVER_METADATA_URL': 'https://helseid-sts.nhn.no/.well-known/openid-configuration',
   }
   

5. Include the URL configuration in your urls.py:

   from django.urls import path, include
   
   urlpatterns = [
       ...
       path('', include('helseid.urls')),
   ]
   

   This registers the following routes:

   • GET /login/ — initiates the HelseID authentication flow
   • GET /authorize/ — handles the OAuth2 callback
   • GET /logout/ — clears the local session