litestar-keycloak 0.1.0__tar.gz

litestar_keycloak-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,96 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Ruff check
+        run: uv run ruff check .
+
+      - name: Ruff format
+        run: uv run ruff format --check .
+
+      - name: Mypy
+        run: uv run mypy src/
+
+      - name: Pytest
+        run: uv run pytest
+
+  integration-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Pytest (integration)
+        run: uv run pytest -m integration -v --timeout=120
+
+  build-docs:
+    runs-on: ubuntu-latest
+    needs: lint-and-test
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build MkDocs
+        run: uv run mkdocs build
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy-pages:
+    runs-on: ubuntu-latest
+    needs: build-docs
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

litestar_keycloak-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,74 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Ruff check
+        run: uv run ruff check .
+
+      - name: Ruff format
+        run: uv run ruff format --check .
+
+      - name: Mypy
+        run: uv run mypy src/
+
+      - name: Pytest
+        run: uv run pytest
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      id-token: write
+    environment: pypi
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

litestar_keycloak-0.1.0/.gitignore

@@ -0,0 +1,212 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# MacOS
+
+.DS_Store
+.python-version

litestar_keycloak-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+# See https://pre-commit.com for more information
+# Ruff and ruff-format run via uv so they use the same version as CI (uv run ruff).
+repos:
+  - repo: local
+    hooks:
+      - id: ruff
+        name: ruff
+        entry: uv run ruff check
+        language: system
+        types: [python]
+      - id: ruff-format
+        name: ruff-format
+        entry: uv run ruff format
+        language: system
+        types: [python]
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: uv run mypy src/
+        language: system
+        pass_filenames: false
+
+      - id: pytest
+        name: pytest (unit)
+        entry: uv run pytest -m "not integration"
+        language: system
+        pass_filenames: false
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ["--maxkb=1000"]

litestar_keycloak-0.1.0/Makefile

@@ -0,0 +1,18 @@
+.PHONY: check test test-unit test-integration test-examples
+
+check:
+	uv run ruff check .
+	uv run ruff format --check .
+	uv run mypy src/
+	uv run pytest -m "not integration"
+
+test-unit:
+	uv run pytest
+
+test-integration:
+	uv run pytest -m integration -v --timeout=120
+
+test: test-unit test-integration
+
+test-examples:
+	./examples/test.sh

litestar_keycloak-0.1.0/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: litestar-keycloak
+Version: 0.1.0
+Summary: Keycloak OIDC/OAuth2 authentication plugin for Litestar
+Project-URL: Homepage, https://github.com/smirnoffmg/litestar-keycloak
+Project-URL: Documentation, https://smirnoffmg.github.io/litestar-keycloak/
+Project-URL: Repository, https://github.com/smirnoffmg/litestar-keycloak
+Project-URL: Issues, https://github.com/smirnoffmg/litestar-keycloak/issues
+Project-URL: Changelog, https://github.com/smirnoffmg/litestar-keycloak/releases
+Author-email: Maksim Smirnov <smirnoffmg@gmail.com>
+License-Expression: MIT
+Keywords: authentication,jwt,keycloak,litestar,oauth2,oidc
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: litestar>=2.0
+Requires-Dist: pyjwt[crypto]>=2.0
+Description-Content-Type: text/markdown
+
+# litestar-keycloak
+
+Keycloak authentication plugin for [Litestar](https://litestar.dev/).
+OIDC/OAuth2 integration using Litestar's native plugin protocol, dependency injection, and guard system.
+
+## Features
+
+- OIDC discovery and JWKS caching with automatic key rotation
+- Bearer token validation (header or cookie)
+- Realm and client role guards
+- Scope-based access control
+- `KeycloakUser` injection via Litestar DI
+- Optional login/callback/logout route group
+- Async HTTP via aiohttp for token exchange and JWKS requests
+
+## Installation
+
+```bash
+pip install litestar-keycloak
+```
+
+## Quick Start
+
+```python
+from litestar import Litestar, get
+from litestar_keycloak import KeycloakPlugin, KeycloakConfig, KeycloakUser
+
+@get("/me")
+async def me(current_user: KeycloakUser) -> dict:
+    return {
+        "sub": current_user.sub,
+        "username": current_user.preferred_username,
+        "roles": current_user.realm_roles,
+    }
+
+app = Litestar(
+    route_handlers=[me],
+    plugins=[KeycloakPlugin(
+        KeycloakConfig(
+            server_url="https://keycloak.example.com",
+            realm="my-realm",
+            client_id="my-app",
+        )
+    )],
+)
+```
+
+Any route that declares `current_user: KeycloakUser` automatically requires a valid Bearer token.
+
+## Guards
+
+Restrict access by roles or scopes:
+
+```python
+from litestar import get
+from litestar_keycloak import require_roles, require_scopes
+
+@get("/admin", guards=[require_roles("admin")])
+async def admin_panel() -> dict:
+    return {"msg": "welcome, admin"}
+
+@get("/reports", guards=[require_scopes("reports:read")])
+async def reports() -> dict:
+    return {"msg": "here are your reports"}
+```
+
+## Configuration
+
+```python
+KeycloakConfig(
+    server_url="https://keycloak.example.com",
+    realm="my-realm",
+    client_id="my-app",
+    client_secret="secret",            # confidential clients
+    token_location=TokenLocation.HEADER,  # HEADER (default) or COOKIE
+    jwks_cache_ttl=3600,               # JWKS cache lifetime in seconds
+    algorithms=("RS256",),             # JWT signing algorithms
+    include_routes=False,              # mount /auth/login, /callback, /logout
+    optional_audiences=frozenset({"my-service"}),  # accept service tokens too
+)
+```
+
+Full option list: [docs/configuration.md](docs/configuration.md).
+
+When `include_routes=True`, the plugin mounts:
+
+| Endpoint             | Description                        |
+| -------------------- | ---------------------------------- |
+| `GET /auth/login`    | Redirect to Keycloak authorize     |
+| `GET /auth/callback` | Handle authorization code exchange |
+| `POST /auth/logout`  | End session (Keycloak + local)     |
+| `POST /auth/refresh` | Refresh access token               |
+
+## Testing
+
+### Unit tests (no Keycloak required)
+
+Test utilities live in `tests/conftest.py`: `create_test_token()` and `MockKeycloakPlugin()`. Use them in your tests (e.g. when running pytest from this repo, or import from conftest):
+
+```python
+from tests.conftest import create_test_token, MockKeycloakPlugin
+
+# Mint a fake JWT with arbitrary claims
+token = create_test_token(sub="user-1", realm_roles=["admin"])
+
+# Use MockKeycloakPlugin to skip real JWKS validation
+app = Litestar(
+    route_handlers=[...],
+    plugins=[MockKeycloakPlugin()],
+)
+```
+
+### Integration tests (real Keycloak via testcontainers)
+
+```python
+from testcontainers.keycloak import KeycloakContainer
+
+kc = (
+    KeycloakContainer("quay.io/keycloak/keycloak:26.0")
+    .with_command("start-dev --import-realm")
+    .with_volume_mapping(
+        "tests/fixtures/realm-export.json",
+        "/opt/keycloak/data/import/realm-export.json",
+        "ro",
+    )
+)
+kc.start()
+```
+
+See `tests/fixtures/realm-export.json` for a pre-configured realm with test users and roles.
+
+## Service-to-service
+
+To accept tokens from a service client (e.g. client_credentials), add its client ID to **optional_audiences**. Use the **raw_token** dependency to forward the caller's token to downstream APIs. See [Service-to-service](docs/guides/service-to-service.md).
+
+## Documentation
+
+- **Guides**: [Configuration](docs/configuration.md), [Guards](docs/guides/guards.md), [OIDC routes](docs/guides/oidc-routes.md), [Testing](docs/guides/testing.md). Build the site with `mkdocs build` (or `mkdocs serve`).
+- **Example app** with docker-compose and smoke tests: [examples/](examples/).
+
+## Dependencies
+
+| Package                    | Purpose                         |
+| -------------------------- | ------------------------------- |
+| `litestar[standard]` ≥ 2.0 | Web framework (plugin target)   |
+| `aiohttp`                  | Async HTTP for token/JWKS calls |
+| `PyJWT[crypto]`            | JWT validation                  |
+
+## License
+
+MIT