Minimal JWT creation and validation with HMAC and RSA signing.
Project description
philiprehberger-jwt-lite
Minimal JWT creation and validation with HMAC and RSA signing.
Installation
pip install philiprehberger-jwt-lite
Usage
from philiprehberger_jwt_lite import create_token, verify_token
token = create_token({"sub": "user123"}, "my-secret")
payload = verify_token(token, "my-secret")
Token Expiration
from philiprehberger_jwt_lite import create_token, verify_token, ExpiredTokenError
token = create_token({"sub": "user123"}, "my-secret", expires_in=3600)
try:
payload = verify_token(token, "my-secret")
except ExpiredTokenError:
print("Token has expired")
Custom Algorithm
from philiprehberger_jwt_lite import create_token, verify_token
token = create_token({"sub": "user123"}, "my-secret", algorithm="HS512")
payload = verify_token(token, "my-secret", algorithm="HS512")
RS256 (RSA) Signing
from philiprehberger_jwt_lite import create_token, verify_token
token = create_token({"sub": "user123"}, private_pem, algorithm="RS256")
payload = verify_token(token, public_pem, algorithm="RS256")
Custom Claims Validation
from philiprehberger_jwt_lite import create_token, verify_token, ClaimValidationError
token = create_token({"sub": "user123", "role": "admin"}, "my-secret")
payload = verify_token(
token,
"my-secret",
validators={"role": lambda r: r == "admin"},
)
Token Refresh
from philiprehberger_jwt_lite import create_token, refresh_token
token = create_token({"sub": "user123"}, "my-secret", expires_in=3600)
new_token = refresh_token(token, "my-secret", extends_by=7200)
JTI Auto-Generation
from philiprehberger_jwt_lite import create_token, decode_token
token = create_token({"sub": "user123"}, "my-secret", include_jti=True)
payload = decode_token(token)
print(payload["jti"]) # e.g. "a1b2c3d4-..."
Token Revocation
from philiprehberger_jwt_lite import create_token, verify_token, TokenRevokedError
revoked: set[str] = set()
token = create_token({"sub": "user123"}, "my-secret", include_jti=True)
# Later, revoke the token by its jti
# revoked.add(jti)
try:
payload = verify_token(token, "my-secret", is_revoked=lambda jti: jti in revoked)
except TokenRevokedError:
print("Token has been revoked")
Decode Header
from philiprehberger_jwt_lite import decode_header
header = decode_header(token)
print(header["alg"]) # "HS256"
Decode Without Verification
from philiprehberger_jwt_lite import decode_unverified
header, payload = decode_unverified(token)
print(header["alg"]) # "HS256"
JWK Set Key Management
from philiprehberger_jwt_lite import JWKSet
jwks = JWKSet()
jwks.add_hmac_key("hmac-1", "my-secret")
jwks.add_rsa_key("rsa-1", private_pem=priv, public_pem=pub)
token = jwks.create_token({"sub": "user123"}, "hmac-1", expires_in=3600)
payload = jwks.verify_token(token)
API
| Function / Class | Description |
|---|---|
create_token(payload, secret, algorithm, expires_in, include_jti) |
Create a signed JWT token (HS256, HS384, HS512, RS256) |
verify_token(token, secret, algorithm, validators, is_revoked) |
Verify signature and expiration, run custom claim validators, return payload |
refresh_token(token, secret, extends_by, algorithm) |
Verify and re-sign a token with a new expiration |
decode_token(token) |
Decode payload without signature verification |
decode_header(token) |
Decode header without signature verification |
decode_unverified(token) |
Decode header and payload without signature validation |
JWKSet |
Key set for managing multiple named signing keys |
JWKSet.add_hmac_key(kid, secret, algorithm) |
Register an HMAC key in the set |
JWKSet.add_rsa_key(kid, private_pem, public_pem, algorithm) |
Register an RSA key pair in the set |
JWKSet.create_token(payload, kid, expires_in, include_jti) |
Create a token signed with a key from the set |
JWKSet.verify_token(token, validators, is_revoked) |
Verify a token using the kid in its header |
ExpiredTokenError |
Raised when a token's exp claim is in the past |
InvalidTokenError |
Raised when a token is malformed or signature is invalid |
ClaimValidationError |
Raised when a custom claim validator fails (subclass of InvalidTokenError) |
TokenRevokedError |
Raised when a token has been revoked |
Development
pip install -e .
python -m pytest tests/ -v
Support
If you find this project useful:
License
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file philiprehberger_jwt_lite-0.4.0.tar.gz.
File metadata
- Download URL: philiprehberger_jwt_lite-0.4.0.tar.gz
- Upload date:
- Size: 13.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b345f04dc3e58da726504c5eba9121b705ec68a63570f982b7a5a75a7545517a
|
|
| MD5 |
a8603c52a147c5bf6c3802ef42360928
|
|
| BLAKE2b-256 |
69dd012ce080c417c65779cf31a4ce5d64f5520c7dfe799f710629025609cd09
|
File details
Details for the file philiprehberger_jwt_lite-0.4.0-py3-none-any.whl.
File metadata
- Download URL: philiprehberger_jwt_lite-0.4.0-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f03d322fe3be0a8c5ce45899acb4eb091db15c85c559bd71acdff627994a0cc2
|
|
| MD5 |
ad86d2fe74b18624a37b163ec5f3d087
|
|
| BLAKE2b-256 |
8b1718655bab936edc5e209f5757a8baae5f2fd1281bf2229ec101634a830b93
|