File tree Expand file tree Collapse file tree 2 files changed +16
-3
lines changed
Expand file tree Collapse file tree 2 files changed +16
-3
lines changed Original file line number Diff line number Diff line change @@ -14,15 +14,22 @@ Introduction
1414 :alt: Build Status
1515
1616JSON Web Token (JWT) Authentication module for CircuitPython. JSON Web Tokens are an open, industry standard
17- `RFC 7519 <https://tools.ietf.org/html/rfc7519 >`_ method for representing claims securely between two parties. Module
18- includes methods for JWT generation and verification.
17+ `RFC 7519 <https://tools.ietf.org/html/rfc7519 >`_ method for representing claims securely between two parties.
18+
19+ This library currently supports the following signature algorithms:
20+ * No encoding, "none"
21+ * RS256/SHA-256 (via `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA >`_)
22+ * RS384/SHA-384 (via `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA >`_)
23+ * RS512/SHA-512 (via `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA >`_)
1924
2025
2126Dependencies
2227=============
2328This driver depends on:
2429
2530* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython >`_
31+ * `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA >`_
32+ * `Adafruit_CircuitPython_binascii <https://github.com/adafruit/Adafruit_CircuitPython_binascii >`_
2633
2734Please ensure all dependencies are available on the CircuitPython filesystem.
2835This is easily achieved by downloading
@@ -58,7 +65,9 @@ To install in a virtual environment in your current project:
5865 Usage Example
5966=============
6067
61- .. todo :: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
68+ .. code-block :: python
69+
70+
6271
6372 Contributing
6473============
Original file line number Diff line number Diff line change 3939
4040* Adafruit's RSA library:
4141 https://github.com/adafruit/Adafruit_CircuitPython_RSA
42+
43+ * Adafruit's binascii library:
44+ https://github.com/adafruit/Adafruit_CircuitPython_RSA
45+
4246"""
4347import io
4448import json
You can’t perform that action at this time.
0 commit comments