Skip to main content

JSON Web Token Authentication

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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.

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

adafruit_circuitpython_jwt-1.2.20.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_jwt-1.2.20.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_jwt-1.2.20.tar.gz
Algorithm Hash digest
SHA256 c738ab3547dfd636a154865309eddcde483b1be0ab30c0bf47eaf75269a5cfed
MD5 be3816373147f8fe67e0407f1bc5cd04
BLAKE2b-256 f9895a0ee24a936bdbec6f1fae56624a65914440f473e0753b182089966d4c25

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_jwt-1.2.20-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_jwt-1.2.20-py3-none-any.whl
Algorithm Hash digest
SHA256 511994e246a174f6123597f00a63475974af35ba2feff0ce94ff084ba24ade20
MD5 c695ff6beb2b5239067d8ab6401fa4cc
BLAKE2b-256 0c635d24088005f305a3ee3962d1ee77d702fb3c01256807d0ac6622bf07993e

See more details on using hashes here.

Supported by

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