⚡ OxyJWT

✨ Features

• 🚀 Blazing Fast: Up to 4× faster encoding and 3.3× faster decoding than PyJWT for HS256 and EdDSA. Built with a single-pass Rust parser, fast Python dispatch, and fat Link-Time Optimization (LTO).
• 🔄 Drop-in PyJWT Replacement: Fully compatible API for encode, decode, decode_complete, get_unverified_header, PyJWKClient, and standard claim validation options.
• 🛡️ Secure by Default: Mandatory server-side algorithm allowlists, strictly rejects alg: "none", constant-time signature comparisons, and SSRF-hardened JWKS client with cache and rate limits.
• 🔑 Modern Cryptography: Powered by aws-lc-rs (AWS Libcrypto). Supports HMAC, RSA, RSA-PSS, ECDSA, and EdDSA (Ed25519).
• ⚡ High-Speed Serialization: Deep integration with orjson for ultrafast JSON parsing and serialization.
• 📦 Batteries Included: Pre-built binary wheels available for Linux (x86_64, aarch64), macOS (Apple Silicon, Intel), and Windows.

📊 Performance Benchmarks

Measured on modern Linux hardware comparing median operations per second (ops/sec) across libraries (higher is better):

📦 Installation

pip install oxyjwt

Requires Python 3.10+. Binary wheels include pre-compiled Rust extensions for all major operating systems.

🚀 Quick Start

1. HMAC (Symmetric)

import time
import oxyjwt

secret = "your-256-bit-secret"
payload = {
    "sub": "user_42",
    "role": "admin",
    "iss": "https://auth.example.com",
    "aud": "https://api.example.com",
    "exp": int(time.time()) + 3600,
}

# Encode a token
token = oxyjwt.encode(payload, secret, algorithm="HS256", headers={"kid": "key-2026"})

# Decode and validate claims
claims = oxyjwt.decode(
    token,
    secret,
    algorithms=["HS256"],  # Fixed allow-list is required
    audience="https://api.example.com",
    issuer="https://auth.example.com",
)
print(claims["sub"])  # "user_42"

2. Asymmetric Keys (RSA, ECDSA, EdDSA)

For asymmetric cryptography, parse keys once using explicit constructors:

import oxyjwt

# Load keys
signing_key = oxyjwt.EncodingKey.from_rsa_pem(private_pem_bytes)
verifying_key = oxyjwt.DecodingKey.from_rsa_pem(public_pem_bytes)

# Sign with RS256
token = oxyjwt.encode({"sub": "user_42"}, signing_key, algorithm="RS256")

# Verify with RS256
claims = oxyjwt.decode(token, verifying_key, algorithms=["RS256"])

OxyJWT also supports Ed25519 (EdDSA):

signing_key = oxyjwt.EncodingKey.from_ed_pem(ed25519_private_pem)
verifying_key = oxyjwt.DecodingKey.from_ed_pem(ed25519_public_pem)

token = oxyjwt.encode({"sub": "service-worker"}, signing_key, algorithm="EdDSA")
claims = oxyjwt.decode(token, verifying_key, algorithms=["EdDSA"])

3. JWKS Client Integration

Fetch and cache remote JSON Web Key Sets (e.g., Auth0, Keycloak, Cognito, Okta) seamlessly:

from oxyjwt import PyJWKClient
import oxyjwt

jwks_client = PyJWKClient(
    "https://your-domain.auth0.com/.well-known/jwks.json",
    cache_keys=True,
    max_cached_keys=16,
    cache_jwk_set=True,
    lifespan=3600,  # 1 hour cache
)

# Automatically resolve the signing key using the token's header `kid`
signing_key = jwks_client.get_signing_key_from_jwt(token)

claims = oxyjwt.decode(
    token,
    signing_key.key,
    algorithms=["RS256"],
    audience="https://api.example.com",
)

4. Complete Inspection & Fast Path

import oxyjwt

# Inspect headers without verifying signature (debugging only)
header = oxyjwt.get_unverified_header(token)

# Retrieve header, claims payload, and raw signature together
token_data = oxyjwt.decode_complete(token, key, algorithms=["HS256"])
print(token_data["header"])
print(token_data["payload"])
print(token_data["signature"])

5. Pre-Serialized High-Throughput Encoding (encode_json)

For high-throughput pipelines where payloads are already serialized as JSON bytes or strings:

import orjson
import oxyjwt

payload_bytes = orjson.dumps({"sub": "user_42", "exp": 1893456000})
token = oxyjwt.encode_json(payload_bytes, "secret", algorithm="HS256")

🛡️ Exception Hierarchy

OxyJWT provides a predictable exception tree that mirrors PyJWT for easy catch blocks:

import oxyjwt

try:
    claims = oxyjwt.decode(token, key, algorithms=["HS256"])
except oxyjwt.ExpiredSignatureError:
    # Token has expired (exp claim)
    ...
except oxyjwt.ImmatureSignatureError:
    # Token is not yet valid (nbf claim)
    ...
except oxyjwt.InvalidAudienceError:
    # Audience claim mismatch (aud claim)
    ...
except oxyjwt.InvalidIssuerError:
    # Issuer mismatch (iss claim)
    ...
except oxyjwt.InvalidSignatureError:
    # Signature verification failed
    ...
except oxyjwt.InvalidTokenError:
    # Malformed token or general decoding error
    ...
except oxyjwt.OxyJWTError:
    # Base class for all OxyJWT exceptions
    ...

🔒 Supported Algorithms

🛡️ Security by Default

1. Fixed Algorithm Allow-List: Passing an algorithms parameter to decode is mandatory when signature verification is active.
2. No alg: "none": Unsigned tokens are fundamentally disallowed.
3. Constant-Time Verification: Cryptographic comparisons are protected against timing attacks.
4. Hardened JWKS Client: Protects against SSRF, limits downloaded key sizes, and enforces key rate-limiting.
5. No Key Confusion: Asymmetric algorithms require explicit typed EncodingKey / DecodingKey structures to prevent HMAC key confusion attacks.

📖 Documentation & Local Development

Full documentation is available at oxyjwt.queryahub.com.

Local Setup & Testing

# Clone and setup environment
git clone https://github.com/QueryaHub/OxyJWT.git
cd OxyJWT
python -m venv .venv
source .venv/bin/activate

# Install build & test dependencies
pip install -U pip maturin pytest pytest-cov cryptography pyjwt authlib python-jose

# Compile Rust extension and run tests
maturin develop --release
pytest

# Run extended performance benchmarks
OXYJWT_BENCHMARK=1 pytest tests/test_benchmark_jwt_libraries.py -v

Documentation Preview

pip install -r docs-site/requirements.txt
mkdocs serve -f docs-site/mkdocs.yml

🤝 Contributing & Security

• Contributions are welcome! Please read our CONTRIBUTING.md for development guidelines and code standards.
• To report security vulnerabilities, please refer to SECURITY.md.

📄 License

This project is licensed under the MIT License.