dj-jwt-auth 0.3.1

A Django package for JSON Web Token validation and verification. Using PyJWT.

Django-JWT

This is a package to verify and validate JSON Web Tokens (JWT) in Django.

Installation

1. Install the package using pip.

2. Add "django_jwt" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'django_jwt',
    ]

3. Add "django_jwt.middleware.JWTAuthMiddleware" to your MIDDLEWARE setting like this::

    MIDDLEWARE = [
        ...
        'django_jwt.middleware.JWTAuthMiddleware',
    ]

Configuration:

Required variables:

• JWT_CERTS_URL - certificate endpoint, like https://keyCloak/realms/h/protocol/openid-connect/certs

Optional variables:

• JWT_ALGORITHM - by default ES256

• JWT_AUDIENCE - by default ["account", "broker"]

• JWT_USER_UID - User model' unique identifier, by default kc_id

• JWT_USER_MAPPING - mapping between JWT claims and user model fields, by default:

    JWT_USER_MAPPING = {
        'first_name': 'first_name',
        'last_name': 'last_name',
        'username': 'username',
    }

• JWT_USER_DEFAULTS - default values for user model fields, by default:

    JWT_USER_DEFAULTS = {
        'is_active': True,
    }

• JWT_USER_ON_CREATE and JWT_USER_ON_UPDATE - functions to be called on user creation and update, by default:

    JWT_USER_ON_CREATE = None
    JWT_USER_ON_UPDATE = None

These functions should accept two arguments: user and request.

Testing:

Run command python runtests.py to run tests.