Skip to main content

A drop-in replacement for Starlette session middleware, using authlib's jwt

Project description

Starlette Authlib Middleware

codecov Package version PyPI - Downloads

Introduction

A drop-in replacement for Starlette session middleware, using authlib's jwt.

Rationale

It is sometimes necessary to integrate a Starlette-based application into more complex scenarios where other actors need to make decisions based on session data. This middleware makes this possible by using a standard JWT token instead of the Starlette-encrypted one, thus simplifying interaction with third-party components.

Requirements

  • Python 3.7+
  • Starlette 0.9+

Installation

pip install starlette-authlib

Usage

A complete example where we drop-in replace standard session middleware:

from starlette.applications import Starlette

from starlette_authlib.middleware import AuthlibMiddleware as SessionMiddleware


app = Starlette()

app.add_middleware(SessionMiddleware, secret='secret')

Other things you can configure either via environment variables or .env file:

  • DOMAIN - declare cookie domain. App must be under this domain. If empty, the cookie is restricted to the subdomain of the app (this is useful when you write eg. SSO portals)
  • JWT_ALG - one of authlib JWT supported algorithms
  • JWT_SECRET - jwt secret. Only useful for HS* algorithms, see the sample_app folder for middleware usage w/ crypto keys.

See it in action: sample application

A sample application is included, and you can run it with either Starlette-based session middleware or this one, just by setting a variable:

# run with vanilla Starlette-based session middleware
VANILLA=1 uvicorn sample_app.app:app

# run with this drop-in replacement
uvicorn sample_app.app:app

As you can notice in code here, the only difference is an import name, based on this VANILLA env var.

Contributing

This project is absolutely open to contributions so if you have a nice idea, create an issue to let the community discuss it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starlette_authlib-0.1.30.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

starlette_authlib-0.1.30-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file starlette_authlib-0.1.30.tar.gz.

File metadata

  • Download URL: starlette_authlib-0.1.30.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/5.15.0-1041-azure

File hashes

Hashes for starlette_authlib-0.1.30.tar.gz
Algorithm Hash digest
SHA256 ea7124305d40de13ef72f0666a7d7665ed86048781cddf64b8a446896017ce5f
MD5 3b0274d7d38746ff5b0221198cbeb40b
BLAKE2b-256 418745907250bb321cb0aa701b8a69cec0d59a031edf444316149ee38ea497a1

See more details on using hashes here.

File details

Details for the file starlette_authlib-0.1.30-py3-none-any.whl.

File metadata

  • Download URL: starlette_authlib-0.1.30-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/5.15.0-1041-azure

File hashes

Hashes for starlette_authlib-0.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 8fc28c43db19aa3665903c4b225f23ff3cbf7f536c1028c23f91663882a4e89d
MD5 87223988d2453b8f78803870f7d2f336
BLAKE2b-256 05c14af2eef7b518b999b6875b8b93cd0a4b0c1f073e8d87d9f8e2751e6f0bc2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page