Skip to main content

multikeyjwt

Verify JWTs with multiple public keys, FastAPI middleware for auth

NOTE: Due to https://github.com/encode/starlette/discussions/2446 .env file is no longer supported for configuration.

Verifying audiences

Pass an expected audience explicitly when verifying a token:

from pathlib import Path
from multikeyjwt import Verifier

verifier = Verifier(pubkeypath=Path("public-keys"))
payload = verifier.decode(token, audience="service-a")
payload = verifier.decode(token, audience=("service-a", "service-b"))

Audience matching follows PyJWT’s case-sensitive string/list rules. A supplied expectation requires a matching aud claim. Empty expectations are errors. decode(token) keeps its existing behavior: tokens without an audience work, while a nonempty aud requires an explicit expectation. Audience verification is never disabled implicitly. JWT_AUDIENCE configures issuing only; it does not set verifier or middleware policy.

The verify command accepts repeated audience options:

multikeyjwt verify -k public-keys/ --audience service-a < token.txt
multikeyjwt verify -k public-keys/ --audience service-a --audience service-b < token.txt

FastAPI authentication

Each dependency can set its own audience without changing the shared verifier:

from fastapi import Depends
from multikeyjwt.middleware import JWTBearer, JWTPayload

async def endpoint(jwt: JWTPayload = Depends(JWTBearer(audience="service-a"))):
    return jwt

An Authorization header takes precedence over the cookie configured by JWT_COOKIE_NAME. If a header is present but invalid, empty or uses another scheme, authentication fails; it never falls back to a valid cookie. Cookies are used only when the header is absent. Bearer scheme matching is case-insensitive.

Compatibility changes: headers now take precedence over cookies, and JWTBearer(auto_error=False) returns None for missing or invalid credentials. The default still raises HTTP 403 on authentication failure. request.state.jwt contains the verified payload on success and None on failure. Routes requiring header-only authentication must additionally reject requests without a header.

Creating signing keys

multikeyjwt genkey ./jwtsign.key

see –help for more info

Docker

For more controlled deployments and to get rid of “works on my computer” -syndrome, we always make sure our software works under docker.

It’s also a quick way to get started with a standard development environment.

SSH agent forwarding

We need buildkit:

export DOCKER_BUILDKIT=1

And also the exact way for forwarding agent to running instance is different on OSX:

export DOCKER_SSHAGENT="-v /run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock -e SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock"

and Linux:

export DOCKER_SSHAGENT="-v $SSH_AUTH_SOCK:$SSH_AUTH_SOCK -e SSH_AUTH_SOCK"

Creating a development container

Build image, create container and start it:

docker build --ssh default --target devel_shell -t multikeyjwt:devel_shell .
docker create --name multikeyjwt_devel -v `pwd`":/app" -it `echo $DOCKER_SSHAGENT` multikeyjwt:devel_shell
docker start -i multikeyjwt_devel

pre-commit considerations

If working in Docker instead of native env you need to run the pre-commit checks in docker too:

docker exec -i multikeyjwt_devel /bin/bash -c "pre-commit install"
docker exec -i multikeyjwt_devel /bin/bash -c "pre-commit run --all-files"

You need to have the container running, see above. Or alternatively use the docker run syntax but using the running container is faster:

docker run --rm -it -v `pwd`":/app" multikeyjwt:devel_shell -c "pre-commit run --all-files"

Test suite

You can use the devel shell to run py.test when doing development, for CI use the “tox” target in the Dockerfile:

docker build --ssh default --target tox -t multikeyjwt:tox .
docker run --rm -it -v `pwd`":/app" `echo $DOCKER_SSHAGENT` multikeyjwt:tox

Production docker

There’s a “production” target as well for running the application, remember to change that architecture tag to arm64 if building on ARM:

docker build --ssh default --target production -t multikeyjwt:latest .
docker run -it --name multikeyjwt multikeyjwt:amd64-latest

Development

TLDR:

  • Create and activate a Python 3.11 virtualenv (assuming virtualenvwrapper):

    mkvirtualenv -p `which python3.11` my_virtualenv
  • change to a branch:

    git checkout -b my_branch
  • install Poetry: https://python-poetry.org/docs/#installation

  • Install project deps and pre-commit hooks:

    poetry install
    pre-commit install
    pre-commit run --all-files
  • Ready to go.

Remember to activate your virtualenv whenever working on the repo, this is needed because pylint and mypy pre-commit hooks use the “system” python for now (because reasons).

Metadata

Release files for multikeyjwt 1.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for multikeyjwt 1.8.0
File Size Uploaded Provenance Actions
multikeyjwt-1.8.0.tar.gz 12.1 kB Without provenance Details for multikeyjwt-1.8.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for multikeyjwt 1.8.0
File Interpreter ABI Platform Actions
multikeyjwt-1.8.0-py3-none-any.whl Python 3 none any Details for multikeyjwt-1.8.0-py3-none-any.whl

Total release size: 26.1 kB

Release files / multikeyjwt-1.8.0.tar.gz

Download URL multikeyjwt-1.8.0.tar.gz
Size 12.1 kB
Tags Source
SHA-256 checksum
How to use checksums
b24146c114e3da1bd4882a82c9b02e3cb5a5923d7f240f0bfe0852b7d2a35ae4
BLAKE2b-256 checksum
How to use checksums
01a1f1ee803bf52d8291446f460a87c21283cbc89f06351cd348fbb37879a090
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0

Release files / multikeyjwt-1.8.0-py3-none-any.whl

Download URL multikeyjwt-1.8.0-py3-none-any.whl
Size 14.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
46b5af19189c039862fbbdcc4702f32820629d51912f94b47078c2c20a35793e
BLAKE2b-256 checksum
How to use checksums
f32b758f4d5a0bb8cbce0099529b191b0bc831e3b9e76267353dc8cab3ed01c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0

Security for multikeyjwt 1.8.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page