Skip to main content

Shared, hardened JWT verification core for OIDC/JWKS issuers

Project description

oidc-jwt-verifier

PyPI version Python versions Tests codecov Documentation License

oidc-jwt-verifier is a small, framework-agnostic JWT verification core for OIDC/JWKS issuers.

It is designed to be shared by higher-level adapters (Dash, Bottle, Lambda, FastAPI) while keeping security decisions centralized and consistent.

Install

pip install oidc-jwt-verifier

For development:

uv pip install -e ".[dev]"

Quickstart

from oidc_jwt_verifier import AuthConfig, JWTVerifier

config = AuthConfig(
    issuer="https://example-issuer/",
    audience="https://example-api",
    jwks_url="https://example-issuer/.well-known/jwks.json",
    allowed_algs=("RS256",),
    required_scopes=("read:users",),
)

verifier = JWTVerifier(config)
claims = verifier.verify_access_token(token)

Secure-by-default behavior

The verifier:

  • Verifies signature, iss, aud, exp, and nbf (when present).
  • Uses an explicit algorithm allowlist and rejects alg=none.
  • Enforces minimum cryptographic key lengths by default (configurable via enforce_minimum_key_length).
  • Fails closed on malformed tokens, JWKS fetch errors, timeouts, missing keys, and missing kid.
  • Never derives a JWKS URL from token headers, and rejects tokens that include jku, x5u, or crit.
  • Supports Auth0-style multi-audience tokens (aud as an array) and enforces required scopes and permissions.

Auth0 guidance for API token validation calls out validating the JWT and then checking aud and scopes in the scope claim. See the Auth0 docs for details.

Error handling

The public exception type is AuthError.

AuthError carries:

  • code: stable, machine-readable reason
  • status_code: 401 (authentication) or 403 (authorization)
  • www_authenticate_header(): an RFC 6750 compatible WWW-Authenticate value for Bearer auth
from oidc_jwt_verifier import AuthError

try:
    claims = verifier.verify_access_token(token)
except AuthError as err:
    status = err.status_code
    www_authenticate = err.www_authenticate_header()

Why this library

JWT verification for APIs is easy to get mostly right while still missing important security and interoperability details. This library is a small, framework-agnostic core that centralizes conservative verification policy (claims, algorithms, header handling) and authorization checks (scopes/permissions) so you can reuse it across projects.

For comparisons against common alternatives (PyJWT directly, discovery-driven verifiers, framework integrations), see docs/alternatives.md.

Contributing

We use Conventional Commits to automate releases via release-please.

Commit prefixes:

  • feat: - New feature (bumps PATCH pre-v1.0)
  • feat!: - Breaking change (bumps MINOR pre-v1.0)
  • fix: - Bug fix (bumps PATCH)
  • docs: - Documentation only
  • chore: - Maintenance tasks
  • refactor: - Code refactoring
  • test: - Test changes
  • perf: - Performance improvements

PRs without conventional commit prefixes will not trigger releases.

References

  • Auth0: Validate Access Tokens: https://auth0.com/docs/secure/tokens/access-tokens/validate-access-tokens
  • Auth0: Validate JSON Web Tokens: https://auth0.com/docs/secure/tokens/json-web-tokens/validate-json-web-tokens
  • RFC 8725: JSON Web Token Best Current Practices: https://datatracker.ietf.org/doc/html/rfc8725
  • RFC 9700: Best Current Practice for OAuth 2.0 Security: https://www.rfc-editor.org/info/rfc9700
  • PyJWT docs and examples: https://pyjwt.readthedocs.io/en/stable/usage.html

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

oidc_jwt_verifier-0.1.4.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oidc_jwt_verifier-0.1.4-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file oidc_jwt_verifier-0.1.4.tar.gz.

File metadata

  • Download URL: oidc_jwt_verifier-0.1.4.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for oidc_jwt_verifier-0.1.4.tar.gz
Algorithm Hash digest
SHA256 93a789c522e197d52b3d6394a6ff9ae04ca82901438ef8935492686217d69ca5
MD5 53a69e4247640f1f97f6d811000afa32
BLAKE2b-256 73f23b29a8657b3ea7154a084c3d57dd9ab3769781cee4e286c6f67d5892e69e

See more details on using hashes here.

Provenance

The following attestation bundles were made for oidc_jwt_verifier-0.1.4.tar.gz:

Publisher: release.yml on BjornMelin/oidc-jwt-verifier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file oidc_jwt_verifier-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for oidc_jwt_verifier-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 67f84d3e5ab2a273a5f601a798633d904890033ff2f9101cc033140fccf5ce21
MD5 35036b1f3dac8daff9c2f42d2ad8d0ee
BLAKE2b-256 cdf8c1410e966662dab36cc275a1920542f37c80416fd689dc25494a4c949d23

See more details on using hashes here.

Provenance

The following attestation bundles were made for oidc_jwt_verifier-0.1.4-py3-none-any.whl:

Publisher: release.yml on BjornMelin/oidc-jwt-verifier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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