JOSE RFC¶
joserfc is a Python library that provides a comprehensive implementation of
several essential JSON Object Signing and Encryption (JOSE) standards, including
JWS (JSON Web Signature), JWE (JSON Web Encryption), JWK (JSON Web Key),
JWA (JSON Web Algorithms), and JWT (JSON Web Tokens).
It is derived from Authlib, but features a redesigned API specific to JOSE functionality.
Usage¶
A quick and simple JWT encoding and decoding would look something like this:
>>> from joserfc import jwt, jwk
>>> key = jwk.import_key("your-secret-key", "oct")
>>> encoded = jwt.encode({"alg": "HS256"}, {"k": "value"}, key)
>>> encoded
'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJrIjoidmFsdWUifQ._M8ViO_GK6TnZ9G9eqdlS7IpNWzhoGwaYYDQ3hEwwmA'
>>> token = jwt.decode(encoded, key)
>>> token.header
{'alg': 'HS256', 'typ': 'JWT'}
>>> token.claims
{'k': 'value'}
You would find more details and advanced usage in JSON Web Token section.
Important
The string "your-secret-key" employed in the above example is solely intended for
demonstration purposes. In a production environment, it is crucial to use a highly secure
secret key to ensure robust security measures.
RFCs¶
It follows RFCs with extensible API. The module has implementations of:
RFC 7520: Examples of Protecting Content Using JSON Object Signing and Encryption
RFC 7638:
thumbprintfor JWKRFC 7797: JSON Web Signature (JWS) Unencoded Payload Option
RFC 8812:
ES256Kalgorithm andECKeywith curvesecp256k1RFC 9278: JWK Thumbprint URI (
thumbprint_uri)RFC 9864:
Ed25519andEd448algorithms
And draft RFCs implementation of:
Hint
RFC7520 is implemented as test cases.
Next¶
Explore the following sections to discover more about joserfc and its features.