Add a verifier for token status list, as well as issuer and verifier for bitstring status list.

.gitignore

@@ -129,6 +129,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.vscode
 
 # Spyder project settings
 .spyderproject

README.md

@@ -1 +1,22 @@
 # token-status-list
+
+This is an implementation of [Token Status List Draft 6][spec] and [Bitstring Status List](https://www.w3.org/TR/vc-bitstring-status-list/).
+
+[spec]: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-status-list-06
+
+
+## Features
+
+- Support for 1, 2, 4, and 8 bits.
+- Compression as required by the Specification (ZLIB at level 9)
+- Formatting, signing, and verifying Status Lists as either JWT or CWT
+    - A `TokenSigner` and `TokenVerifier` protocol is defined so the user can Bring Their Own Crypto implementation
+    - Alternatively, methods for preparing payloads and assembling payload and signature bytes into the final token is also supported.
+- Two Index Allocation strategies, Linear and Random
+    - Linear strategy will allocate indices serially
+    - Random strategy will allocate indices pseudo-randomly (as the list fills, speed is favored over randomness)
+    - Allocators contain state that must be persisted along side the status list itself
+    - IssuerStatusList and Allocators are serializeable so the user can persist them to the backend of their choice
+- Basic example using Nginx web server as an issuer to simulate fetching and verifying a Status List
+    - Run using `docker-compose up -d && pytest tests/test_web_server.py`
+    - Scripts that are issued, as well as other information about issuer are in `tests/test_web_server`

docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  issuer:
+    build:
+      context: .
+      dockerfile: tests/test_web_server/Dockerfile
+    ports:
+      - "3001:80"
+    restart: unless-stopped

pyproject.toml

@@ -5,7 +5,7 @@ description = "Implementation of IETF Token Status List"
 authors = [
     {name = "Daniel Bluhm", email = "[email protected]"},
 ]
-dependencies = []
+dependencies = ["google-auth>=2.36.0", "requests>=2.32.3", "cryptography>=44.0.0", "overloading>=0.5.0", "aiohttp>=3.11.11", "pytest-asyncio>=0.25.2"]
 requires-python = ">=3.10"
 readme = "README.md"
 license = {text = "Apache-2.0"}