apikeyauth 0.1.0

Drop-in API key authentication for FastAPI

apikeyauth

Drop-in API key authentication for FastAPI

---

Install

pip install apikeyauth

Usage

from fastapi import FastAPI, Depends
from apikeyauth import APIKeyAuth, MemoryKeyStore, KeyInfo

store = MemoryKeyStore({
    "sk_live_abc123": KeyInfo(name="Production App", scopes=["read", "write"]),
    "sk_test_xyz789": KeyInfo(name="Test App", scopes=["read"]),
})
auth = APIKeyAuth(store)

app = FastAPI()

@app.get("/data")
async def get_data(key: KeyInfo = Depends(auth)):
    return {"hello": key.name, "scopes": key.scopes}

Clients authenticate via header or query param:

# Header
curl -H "X-API-Key: sk_live_abc123" http://localhost:8000/data

# Query param
curl http://localhost:8000/data?api_key=sk_live_abc123

Features

Feature	Description
Header auth	X-API-Key header (configurable name)
Query auth	?api_key= query param (configurable name)
Flexible auth	Checks header first, falls back to query
Key metadata	Name, scopes, rate limit, owner, custom metadata
Pluggable store	Implement KeyStore for database/Redis backends
Memory store	Built-in dict-based store with add/revoke

Custom Backend

from apikeyauth import KeyStore, KeyInfo

class DatabaseKeyStore(KeyStore):
    async def validate(self, key: str) -> KeyInfo | None:
        row = await db.fetch_one("SELECT * FROM api_keys WHERE key_hash = $1", hash(key))
        if row:
            return KeyInfo(name=row["name"], scopes=row["scopes"].split(","))
        return None

License

MIT