Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

JSON Web Token (JWT) Authentication module for CircuitPython. JSON Web Tokens are an open, industry standard RFC 7519 method for representing claims securely between two parties.

This library currently supports the following signature algorithms for JWT generation and verification:

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-jwt

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-jwt

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-jwt

Usage Example

Generating encoded JWT

from os import getenv
import adafruit_jwt

# Import Private RSA key from a settings.toml file
private_key = getenv["private_key"]

# Create JWT Claims
claims = {"iss": "joe",
        "exp": 1300819380,
        "name": "John Doe",
        "admin": True}

# Generate JWT, sign with RSA private key and RS-256
encoded_jwt = adafruit_jwt.JWT.generate(
    claims, private_key, algo="RS256")
print("Encoded JWT: ", encoded_jwt)

Validating a generated JWT, encoded_jwt.

import adafruit_jwt
decoded_jwt = adafruit_jwt.JWT.validate(encoded_jwt)
# The decoded JWT's JOSE header and claims set are returned as a tuple
print('JOSE Header: {}\nJWT Claims: {}'.format(decoded_jwt[0], decoded_jwt[1]))

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Metadata

Release files for adafruit-circuitpython-jwt 1.2.25

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

Source distribution (sdist)

Source distribution for adafruit-circuitpython-jwt 1.2.25
File Size Uploaded
adafruit_circuitpython_jwt-1.2.25.tar.gz 28.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-jwt 1.2.25
File Interpreter ABI Platform
adafruit_circuitpython_jwt-1.2.25-py3-none-any.whl Python 3 none any Details

Total release size: 35.4 kB

Release files / adafruit_circuitpython_jwt-1.2.25.tar.gz

Download URL adafruit_circuitpython_jwt-1.2.25.tar.gz
Size 28.8 kB
Tags Source
SHA-256 checksum
How to use checksums
00bed82c699fa42ebc6d5d973d64ca6644935066a31df472d123c96adbfe8526
BLAKE2b-256 checksum
How to use checksums
65645a44c13b5fae21c98b63691cbab2d7b313a9687a00d1aef2d535163fa6c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_jwt-1.2.25-py3-none-any.whl

Download URL adafruit_circuitpython_jwt-1.2.25-py3-none-any.whl
Size 6.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a572590d364093eb4fc9a6f2bf70666b8308fa789d77d12d1a1c2e51dba40e2a
BLAKE2b-256 checksum
How to use checksums
b23e1387c5bdbf4141be390b66ed67ef3f7de3cfe1f72108720dd3dda671740b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.2.25 This release

2 release files

1.2.24

2 release files

1.2.23

2 release files

1.2.22

2 release files

1.2.21

2 release files

1.2.20

2 release files

1.2.19

2 release files

1.2.16

2 release files

1.2.15

2 release files

1.2.14

2 release files

1.2.13

2 release files

1.2.12

2 release files

1.2.11

2 release files

1.2.9

1 release file

1.2.8

1 release file

1.2.7

1 release file

1.2.6

1 release file

1.2.5

1 release file

1.2.4

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.1

1 release file

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