Authorization via with_route

.gitea/workflows/test_before_merge.yaml

@@ -0,0 +1,26 @@
+name: Test before pr merge
+run-name: Test before pr merge
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+      - ready_for_review
+
+jobs:
+  test-lint:
+    runs-on: [ runner ]
+    container: git.sh-edraft.de/sh-edraft.de/act-runner:latest
+    steps:
+      - name: Clone Repository
+        uses: https://github.com/actions/checkout@v3
+        with:
+          token: ${{ secrets.CI_ACCESS_TOKEN }}
+
+      - name: Installing black
+        run: python3.12 -m pip install black
+
+      - name: Checking black
+        run: python3.12 -m black src --check

install.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Find and combine requirements from src/cpl-*/requirements.txt,
+# filtering out lines whose *package name* starts with "cpl-".
+# Works with pinned versions, extras, markers, editable installs, and VCS refs.
+
+shopt -s nullglob
+
+req_files=(src/cpl-*/requirements.txt)
+if ((${#req_files[@]} == 0)); then
+  echo "No requirements files found at src/cpl-*/requirements.txt" >&2
+  exit 1
+fi
+
+tmp_combined="$(mktemp)"
+trap 'rm -f "$tmp_combined"' EXIT
+
+# Concatenate, trim comments/whitespace, filter out cpl-* packages, dedupe.
+# We keep non-package options/flags/constraints as-is.
+awk '
+  function trim(s){ sub(/^[[:space:]]+/,"",s); sub(/[[:space:]]+$/,"",s); return s }
+
+  {
+    line=$0
+    # drop full-line comments and strip inline comments
+    if (line ~ /^[[:space:]]*#/) next
+    sub(/#[^!].*$/,"",line)  # strip trailing comment (simple heuristic)
+    line=trim(line)
+    if (line == "") next
+
+    # Determine the package *name* even for "-e", extras, pins, markers, or VCS "@"
+    e = line
+    sub(/^-e[[:space:]]+/,"",e)           # remove editable prefix
+    # Tokenize up to the first of these separators: space, [ < > = ! ~ ; @
+    token = e
+    sub(/\[.*/,"",token)                  # remove extras quickly
+    n = split(token, a, /[<>=!~;@[:space:]]/)
+    name = tolower(a[1])
+
+    # If the first token (name) starts with "cpl-", skip this requirement
+    if (name ~ /^cpl-/) next
+
+    print line
+  }
+' "${req_files[@]}" | sort -u > "$tmp_combined"
+
+if ! [ -s "$tmp_combined" ]; then
+  echo "Nothing to install after filtering out cpl-* packages." >&2
+  exit 0
+fi
+
+echo "Installing dependencies (excluding cpl-*) from:"
+printf '  - %s\n' "${req_files[@]}"
+echo
+echo "Final set to install:"
+cat "$tmp_combined"
+echo
+
+# Use python -m pip for reliability; change to python3 if needed.
+python -m pip install -r "$tmp_combined"

src/cpl-api/cpl/api/__init__.py

@@ -0,0 +1,32 @@
+from cpl.dependency.service_collection import ServiceCollection as _ServiceCollection
+
+
+def add_api(collection: _ServiceCollection):
+    try:
+        from cpl.database import mysql
+
+        collection.add_module(mysql)
+    except ImportError as e:
+        from cpl.core.errors import dependency_error
+
+        dependency_error("cpl-database", e)
+
+    try:
+        from cpl import auth
+        from cpl.auth import permission
+
+        collection.add_module(auth)
+        collection.add_module(permission)
+    except ImportError as e:
+        from cpl.core.errors import dependency_error
+
+        dependency_error("cpl-auth", e)
+
+    from cpl.api.registry.policy import PolicyRegistry
+    from cpl.api.registry.route import RouteRegistry
+
+    collection.add_singleton(PolicyRegistry)
+    collection.add_singleton(RouteRegistry)
+
+
+_ServiceCollection.with_module(add_api, __name__)

src/cpl-api/cpl/api/abc/asgi_middleware_abc.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+from starlette.types import Scope, Receive, Send
+
+
+class ASGIMiddleware(ABC):
+    @abstractmethod
+    def __init__(self, app):
+        self._app = app
+
+    def _call_next(self, scope: Scope, receive: Receive, send: Send):
+        return self._app(scope, receive, send)
+
+    @abstractmethod
+    async def __call__(self, scope: Scope, receive: Receive, send: Send): ...

src/cpl-api/cpl/api/application/web_app.py

@@ -0,0 +1,249 @@
+import os
+from enum import Enum
+from typing import Mapping, Any, Callable, Self, Union
+
+import uvicorn
+from starlette.applications import Starlette
+from starlette.middleware import Middleware
+from starlette.middleware.cors import CORSMiddleware
+from starlette.requests import Request
+from starlette.responses import JSONResponse
+from starlette.types import ExceptionHandler
+
+from cpl import api, auth
+from cpl.api.error import APIError
+from cpl.api.logger import APILogger
+from cpl.api.middleware.authentication import AuthenticationMiddleware
+from cpl.api.middleware.authorization import AuthorizationMiddleware
+from cpl.api.middleware.logging import LoggingMiddleware
+from cpl.api.middleware.request import RequestMiddleware
+from cpl.api.model.api_route import ApiRoute
+from cpl.api.model.policy import Policy
+from cpl.api.model.validation_match import ValidationMatch
+from cpl.api.registry.policy import PolicyRegistry
+from cpl.api.registry.route import RouteRegistry
+from cpl.api.router import Router
+from cpl.api.settings import ApiSettings
+from cpl.api.typing import HTTPMethods, PartialMiddleware, PolicyResolver
+from cpl.application.abc.application_abc import ApplicationABC
+from cpl.core.configuration import Configuration
+from cpl.dependency.service_provider_abc import ServiceProviderABC
+
+_logger = APILogger("API")
+
+PolicyInput = Union[dict[str, PolicyResolver], Policy]
+
+
+class WebApp(ApplicationABC):
+    def __init__(self, services: ServiceProviderABC):
+        super().__init__(services, [auth, api])
+        self._app: Starlette | None = None
+
+        self._api_settings = Configuration.get(ApiSettings)
+        self._policies = services.get_service(PolicyRegistry)
+        self._routes = services.get_service(RouteRegistry)
+
+        self._middleware: list[Middleware] = [
+            Middleware(RequestMiddleware),
+            Middleware(LoggingMiddleware),
+        ]
+        self._exception_handlers: Mapping[Any, ExceptionHandler] = {
+            Exception: self._handle_exception,
+            APIError: self._handle_exception,
+        }
+
+    @staticmethod
+    async def _handle_exception(request: Request, exc: Exception):
+        if isinstance(exc, APIError):
+            _logger.error(exc)
+            return JSONResponse({"error": str(exc)}, status_code=exc.status_code)
+
+        if hasattr(request.state, "request_id"):
+            _logger.error(f"Request {request.state.request_id}", exc)
+        else:
+            _logger.error("Request unknown", exc)
+
+        return JSONResponse({"error": str(exc)}, status_code=500)
+
+    def _get_allowed_origins(self):
+        origins = self._api_settings.allowed_origins
+
+        if origins is None or origins == "":
+            _logger.warning("No allowed origins specified, allowing all origins")
+            return ["*"]
+
+        _logger.debug(f"Allowed origins: {origins}")
+        return origins.split(",")
+
+    def with_database(self) -> Self:
+        self.with_migrations()
+        self.with_seeders()
+        return self
+
+    def with_app(self, app: Starlette) -> Self:
+        assert app is not None, "app must not be None"
+        assert isinstance(app, Starlette), "app must be an instance of Starlette"
+        self._app = app
+        return self
+
+    def _check_for_app(self):
+        if self._app is not None:
+            raise ValueError("App is already set, cannot add routes or middleware")
+
+    def with_routes_directory(self, directory: str) -> Self:
+        self._check_for_app()
+        assert directory is not None, "directory must not be None"
+
+        base = directory.replace("/", ".").replace("\\", ".")
+
+        for filename in os.listdir(directory):
+            if not filename.endswith(".py") or filename == "__init__.py":
+                continue
+
+            __import__(f"{base}.{filename[:-3]}")
+
+        return self
+
+    def with_routes(
+        self,
+        routes: list[ApiRoute],
+        method: HTTPMethods,
+        authentication: bool = False,
+        roles: list[str | Enum] = None,
+        permissions: list[str | Enum] = None,
+        policies: list[str] = None,
+        match: ValidationMatch = None,
+    ) -> Self:
+        self._check_for_app()
+        assert self._routes is not None, "routes must not be None"
+        assert all(isinstance(route, ApiRoute) for route in routes), "all routes must be of type ApiRoute"
+        for route in routes:
+            self.with_route(
+                route.path,
+                route.fn,
+                method,
+                authentication,
+                roles,
+                permissions,
+                policies,
+                match,
+            )
+        return self
+
+    def with_route(
+        self,
+        path: str,
+        fn: Callable[[Request], Any],
+        method: HTTPMethods,
+        authentication: bool = False,
+        roles: list[str | Enum] = None,
+        permissions: list[str | Enum] = None,
+        policies: list[str] = None,
+        match: ValidationMatch = None,
+    ) -> Self:
+        self._check_for_app()
+        assert path is not None, "path must not be None"
+        assert fn is not None, "fn must not be None"
+        assert method in [
+            "GET",
+            "HEAD",
+            "POST",
+            "PUT",
+            "PATCH",
+            "DELETE",
+            "OPTIONS",
+        ], "method must be a valid HTTP method"
+
+        Router.route(path, method, registry=self._routes)(fn)
+
+        if authentication:
+            Router.authenticate()(fn)
+
+        if roles or permissions or policies:
+            Router.authorize(roles, permissions, policies, match)(fn)
+
+        return self
+
+    def with_middleware(self, middleware: PartialMiddleware) -> Self:
+        self._check_for_app()
+
+        if isinstance(middleware, Middleware):
+            self._middleware.append(middleware)
+        elif callable(middleware):
+            self._middleware.append(Middleware(middleware))
+        else:
+            raise ValueError("middleware must be of type starlette.middleware.Middleware or a callable")
+
+        return self
+
+    def with_authentication(self) -> Self:
+        self.with_middleware(AuthenticationMiddleware)
+        return self
+
+    def with_authorization(self, *policies: list[PolicyInput] | PolicyInput) -> Self:
+        if policies:
+            _policies = []
+
+            if not isinstance(policies, list):
+                policies = list(policies)
+
+            for i, policy in enumerate(policies):
+                if isinstance(policy, dict):
+                    for name, resolver in policy.items():
+                        if not isinstance(name, str):
+                            _logger.warning(f"Skipping policy at index {i}, name must be a string")
+                            continue
+
+                        if not callable(resolver):
+                            _logger.warning(f"Skipping policy {name}, resolver must be callable")
+                            continue
+
+                        _policies.append(Policy(name, resolver))
+                    continue
+
+                _policies.append(policy)
+
+            self._policies.extend_policies(_policies)
+
+        self.with_middleware(AuthorizationMiddleware)
+        return self
+
+    def _validate_policies(self):
+        for rule in Router.get_authorization_rules():
+            for policy_name in rule["policies"]:
+                policy = self._policies.get(policy_name)
+                if not policy:
+                    _logger.fatal(f"Authorization policy '{policy_name}' not found")
+
+    async def main(self):
+        _logger.debug(f"Preparing API")
+        self._validate_policies()
+
+        if self._app is None:
+            routes = [route.to_starlette(self._services.inject) for route in self._routes.all()]
+
+            app = Starlette(
+                routes=routes,
+                middleware=[
+                    *self._middleware,
+                    Middleware(
+                        CORSMiddleware,
+                        allow_origins=self._get_allowed_origins(),
+                        allow_methods=["*"],
+                        allow_headers=["*"],
+                    ),
+                ],
+                exception_handlers=self._exception_handlers,
+            )
+        else:
+            app = self._app
+
+        _logger.info(f"Start API on {self._api_settings.host}:{self._api_settings.port}")
+
+        config = uvicorn.Config(
+            app, host=self._api_settings.host, port=self._api_settings.port, log_config=None, loop="asyncio"
+        )
+        server = uvicorn.Server(config)
+        await server.serve()
+
+        _logger.info("Shutdown API")

src/cpl-api/cpl/api/error.py

@@ -1,9 +1,30 @@
 from http.client import HTTPException
 
+from starlette.responses import JSONResponse
+from starlette.types import Scope, Receive, Send
+
 
 class APIError(HTTPException):
     status_code = 500
 
+    def __init__(self, message: str = ""):
+        super().__init__(self.status_code, message)
+        self._message = message
+
+    @property
+    def error_message(self) -> str:
+        if self._message:
+            return f"{type(self).__name__}: {self._message}"
+
+        return f"{type(self).__name__}"
+
+    async def asgi_response(self, scope: Scope, receive: Receive, send: Send):
+        r = JSONResponse({"error": self.error_message}, status_code=self.status_code)
+        return await r(scope, receive, send)
+
+    def response(self):
+        return JSONResponse({"error": self.error_message}, status_code=self.status_code)
+
 
 class Unauthorized(APIError):
     status_code = 401

src/cpl-api/cpl/api/middleware/authentication.py

@@ -0,0 +1,80 @@
+from keycloak import KeycloakAuthenticationError
+from starlette.types import Scope, Receive, Send
+
+from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
+from cpl.api.logger import APILogger
+from cpl.api.error import Unauthorized
+from cpl.api.middleware.request import get_request
+from cpl.api.router import Router
+from cpl.auth.keycloak import KeycloakClient
+from cpl.auth.schema import AuthUserDao, AuthUser
+from cpl.core.ctx import set_user
+from cpl.dependency import ServiceProviderABC
+
+_logger = APILogger(__name__)
+
+
+class AuthenticationMiddleware(ASGIMiddleware):
+
+    @ServiceProviderABC.inject
+    def __init__(self, app, keycloak: KeycloakClient, user_dao: AuthUserDao):
+        ASGIMiddleware.__init__(self, app)
+
+        self._keycloak = keycloak
+        self._user_dao = user_dao
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send):
+        request = get_request()
+        url = request.url.path
+
+        if url not in Router.get_auth_required_routes():
+            _logger.trace(f"No authentication required for {url}")
+            return await self._app(scope, receive, send)
+
+        if not request.headers.get("Authorization"):
+            _logger.debug(f"Unauthorized access to {url}, missing Authorization header")
+            return await Unauthorized(f"Missing header Authorization").asgi_response(scope, receive, send)
+
+        auth_header = request.headers.get("Authorization", None)
+        if not auth_header or not auth_header.startswith("Bearer "):
+            return await Unauthorized("Invalid Authorization header").asgi_response(scope, receive, send)
+
+        token = auth_header.split("Bearer ")[1]
+        if not await self._verify_login(token):
+            _logger.debug(f"Unauthorized access to {url}, invalid token")
+            return await Unauthorized("Invalid token").asgi_response(scope, receive, send)
+
+        # check user exists in db, if not create
+        keycloak_id = self._keycloak.get_user_id(token)
+        if keycloak_id is None:
+            return await Unauthorized("Failed to get user id from token").asgi_response(scope, receive, send)
+
+        user = await self._get_or_crate_user(keycloak_id)
+        if user.deleted:
+            _logger.debug(f"Unauthorized access to {url}, user is deleted")
+            return await Unauthorized("User is deleted").asgi_response(scope, receive, send)
+
+        request.state.user = user
+        set_user(user)
+
+        return await self._call_next(scope, receive, send)
+
+    async def _get_or_crate_user(self, keycloak_id: str) -> AuthUser:
+        existing = await self._user_dao.find_by_keycloak_id(keycloak_id)
+        if existing is not None:
+            return existing
+
+        user = AuthUser(0, keycloak_id)
+        uid = await self._user_dao.create(user)
+        return await self._user_dao.get_by_id(uid)
+
+    async def _verify_login(self, token: str) -> bool:
+        try:
+            token_info = self._keycloak.introspect(token)
+            return token_info.get("active", False)
+        except KeycloakAuthenticationError as e:
+            _logger.debug(f"Keycloak authentication error: {e}")
+            return False
+        except Exception as e:
+            _logger.error(f"Unexpected error during token verification: {e}")
+            return False

src/cpl-api/cpl/api/middleware/authorization.py

@@ -0,0 +1,73 @@
+from starlette.types import Scope, Receive, Send
+
+from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
+from cpl.api.error import Unauthorized, Forbidden
+from cpl.api.logger import APILogger
+from cpl.api.middleware.request import get_request
+from cpl.api.model.validation_match import ValidationMatch
+from cpl.api.registry.policy import PolicyRegistry
+from cpl.api.router import Router
+from cpl.auth.schema._administration.auth_user_dao import AuthUserDao
+from cpl.core.ctx.user_context import get_user
+from cpl.dependency.service_provider_abc import ServiceProviderABC
+
+_logger = APILogger(__name__)
+
+
+class AuthorizationMiddleware(ASGIMiddleware):
+
+    @ServiceProviderABC.inject
+    def __init__(self, app, policies: PolicyRegistry, user_dao: AuthUserDao):
+        ASGIMiddleware.__init__(self, app)
+
+        self._policies = policies
+        self._user_dao = user_dao
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send):
+        request = get_request()
+        url = request.url.path
+
+        if url not in Router.get_authorization_rules_paths():
+            _logger.trace(f"No authorization required for {url}")
+            return await self._app(scope, receive, send)
+
+        user = get_user()
+        if not user:
+            return await Unauthorized(f"Unknown user").asgi_response(scope, receive, send)
+
+        roles = await user.roles
+        request.state.roles = roles
+        role_names = [r.name for r in roles]
+
+        perms = await user.permissions
+        request.state.permissions = perms
+        perm_names = [p.name for p in perms]
+
+        for rule in Router.get_authorization_rules():
+            match = rule["match"]
+            if rule["roles"]:
+                if match == ValidationMatch.all and not all(r in role_names for r in rule["roles"]):
+                    return await Forbidden(f"missing roles: {rule["roles"]}").asgi_response(scope, receive, send)
+                if match == ValidationMatch.any and not any(r in role_names for r in rule["roles"]):
+                    return await Forbidden(f"missing roles: {rule["roles"]}").asgi_response(scope, receive, send)
+
+            if rule["permissions"]:
+                if match == ValidationMatch.all and not all(p in perm_names for p in rule["permissions"]):
+                    return await Forbidden(f"missing permissions: {rule["permissions"]}").asgi_response(
+                        scope, receive, send
+                    )
+                if match == ValidationMatch.any and not any(p in perm_names for p in rule["permissions"]):
+                    return await Forbidden(f"missing permissions: {rule["permissions"]}").asgi_response(
+                        scope, receive, send
+                    )
+
+            for policy_name in rule["policies"]:
+                policy = self._policies.get(policy_name)
+                if not policy:
+                    _logger.warning(f"Authorization policy '{policy_name}' not found")
+                    continue
+
+                if not await policy.resolve(user):
+                    return await Forbidden(f"policy {policy.name} failed").asgi_response(scope, receive, send)
+
+        return await self._call_next(scope, receive, send)

src/cpl-api/cpl/api/middleware/logging.py

@@ -1,21 +1,44 @@
 import time
 
-from starlette.middleware.base import BaseHTTPMiddleware
 from starlette.requests import Request
-from starlette.responses import Response
+from starlette.types import Receive, Scope, Send
 
-from cpl.api.api_logger import APILogger
+from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
+from cpl.api.logger import APILogger
+from cpl.api.middleware.request import get_request
 
 _logger = APILogger(__name__)
 
 
-class LoggingMiddleware(BaseHTTPMiddleware):
+class LoggingMiddleware(ASGIMiddleware):
-    async def dispatch(self, request: Request, call_next):
-        await self._log_request(request)
-        response = await call_next(request)
-        await self._log_after_request(request, response)
 
-        return response
+    def __init__(self, app):
+        ASGIMiddleware.__init__(self, app)
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send):
+        if scope["type"] != "http":
+            await self._call_next(scope, receive, send)
+            return
+
+        request = get_request()
+        await self._log_request(request)
+        start_time = time.time()
+
+        response_body = b""
+        status_code = 500
+
+        async def send_wrapper(message):
+            nonlocal response_body, status_code
+            if message["type"] == "http.response.start":
+                status_code = message["status"]
+            if message["type"] == "http.response.body":
+                response_body += message.get("body", b"")
+            await send(message)
+
+        await self._call_next(scope, receive, send_wrapper)
+
+        duration = (time.time() - start_time) * 1000
+        await self._log_after_request(request, status_code, duration)
 
     @staticmethod
     def _filter_relevant_headers(headers: dict) -> dict:
@@ -33,7 +56,7 @@ class LoggingMiddleware(BaseHTTPMiddleware):
     @classmethod
     async def _log_request(cls, request: Request):
         _logger.debug(
-            f"Request {request.state.request_id}: {request.method}@{request.url.path} from {request.client.host}"
+            f"Request {getattr(request.state, 'request_id', '-')}: {request.method}@{request.url.path} from {request.client.host}"
         )
 
         from cpl.core.ctx.user_context import get_user
@@ -55,11 +78,10 @@ class LoggingMiddleware(BaseHTTPMiddleware):
             ),
         }
 
-        _logger.trace(f"Request {request.state.request_id}: {request_info}")
+        _logger.trace(f"Request {getattr(request.state, 'request_id', '-')}: {request_info}")
 
     @staticmethod
-    async def _log_after_request(request: Request, response: Response):
+    async def _log_after_request(request: Request, status_code: int, duration: float):
-        duration = (time.time() - request.state.start_time) * 1000
         _logger.info(
-            f"Request finished {request.state.request_id}: {response.status_code}-{request.method}@{request.url.path} from {request.client.host} in {duration:.2f}ms"
+            f"Request finished {getattr(request.state, 'request_id', '-')}: {status_code}-{request.method}@{request.url.path} from {request.client.host} in {duration:.2f}ms"
         )

src/cpl-api/cpl/api/middleware/request.py

@@ -3,10 +3,11 @@ from contextvars import ContextVar
 from typing import Optional, Union
 from uuid import uuid4
 
-from starlette.middleware.base import BaseHTTPMiddleware
+from starlette.requests import Request
-from starlette.websockets import WebSocket
+from starlette.types import Scope, Receive, Send
 
-from cpl.api.api_logger import APILogger
+from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
+from cpl.api.logger import APILogger
 from cpl.api.typing import TRequest
 
 _request_context: ContextVar[Union[TRequest, None]] = ContextVar("request", default=None)
@@ -14,35 +15,39 @@ _request_context: ContextVar[Union[TRequest, None]] = ContextVar("request", defa
 _logger = APILogger(__name__)
 
 
-class RequestMiddleware(BaseHTTPMiddleware):
+class RequestMiddleware(ASGIMiddleware):
-    _request_token = {}
-    _user_token = {}
 
-    @classmethod
+    def __init__(self, app):
-    async def set_request_data(cls, request: TRequest):
+        ASGIMiddleware.__init__(self, app)
+        self._ctx_token = None
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send):
+        request = Request(scope, receive, send)
+        await self.set_request_data(request)
+
+        try:
+            await self._app(scope, receive, send)
+        finally:
+            await self.clean_request_data()
+
+    async def set_request_data(self, request: TRequest):
         request.state.request_id = uuid4()
         request.state.start_time = time.time()
         _logger.trace(f"Set new current request: {request.state.request_id}")
 
-        cls._request_token[request.state.request_id] = _request_context.set(request)
+        self._ctx_token = _request_context.set(request)
 
-    @classmethod
+    async def clean_request_data(self):
-    async def clean_request_data(cls):
         request = get_request()
         if request is None:
             return
 
-        if request.state.request_id in cls._request_token:
+        if self._ctx_token is None:
-            _request_context.reset(cls._request_token[request.state.request_id])
+            return
 
-    async def dispatch(self, request: TRequest, call_next):
+        _logger.trace(f"Clearing current request: {request.state.request_id}")
-        await self.set_request_data(request)
+        _request_context.reset(self._ctx_token)
-        try:
-            response = await call_next(request)
-            return response
-        finally:
-            await self.clean_request_data()
 
 
-def get_request() -> Optional[Union[TRequest, WebSocket]]:
+def get_request() -> Optional[TRequest]:
     return _request_context.get()

src/cpl-api/cpl/api/model/api_route.py

@@ -0,0 +1,43 @@
+from typing import Callable
+
+from starlette.routing import Route
+
+from cpl.api.typing import HTTPMethods
+
+
+class ApiRoute:
+
+    def __init__(self, path: str, fn: Callable, method: HTTPMethods, **kwargs):
+        self._path = path
+        self._fn = fn
+        self._method = method
+
+        self._kwargs = kwargs
+
+    @property
+    def name(self) -> str:
+        return self._fn.__name__
+
+    @property
+    def fn(self) -> Callable:
+        return self._fn
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def method(self) -> HTTPMethods:
+        return self._method
+
+    @property
+    def kwargs(self) -> dict:
+        return self._kwargs
+
+    def to_starlette(self, wrap_endpoint: Callable = None) -> Route:
+        return Route(
+            self._path,
+            self._fn if not wrap_endpoint else wrap_endpoint(self._fn),
+            methods=[self._method],
+            **self._kwargs,
+        )

src/cpl-api/cpl/api/model/policy.py

@@ -0,0 +1,34 @@
+from asyncio import iscoroutinefunction
+from typing import Optional, Any, Coroutine, Awaitable
+
+from cpl.api.typing import PolicyResolver
+from cpl.core.ctx import get_user
+
+
+class Policy:
+    def __init__(
+        self,
+        name: str,
+        resolver: PolicyResolver = None,
+    ):
+        self._name = name
+        self._resolver: Optional[PolicyResolver] = resolver
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def resolvers(self) -> PolicyResolver:
+        return self._resolver
+
+    async def resolve(self, *args, **kwargs) -> bool:
+        if not self._resolver:
+            return True
+
+        if callable(self._resolver):
+            if iscoroutinefunction(self._resolver):
+                return await self._resolver(get_user())
+
+            return self._resolver(get_user())
+        return False

src/cpl-api/cpl/api/model/validation_match.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class ValidationMatch(Enum):
+    any = "any"
+    all = "all"

src/cpl-api/cpl/api/registry/policy.py

@@ -0,0 +1,28 @@
+from typing import Optional
+
+from cpl.api.model.policy import Policy
+from cpl.core.abc.registry_abc import RegistryABC
+
+
+class PolicyRegistry(RegistryABC):
+
+    def __init__(self):
+        RegistryABC.__init__(self)
+
+    def extend(self, items: list[Policy]):
+        for policy in items:
+            self.add(policy)
+
+    def add(self, item: Policy):
+        assert isinstance(item, Policy), "policy must be an instance of Policy"
+
+        if item.name in self._items:
+            raise ValueError(f"Policy {item.name} is already registered")
+
+        self._items[item.name] = item
+
+    def get(self, key: str) -> Optional[Policy]:
+        return self._items.get(key)
+
+    def all(self) -> list[Policy]:
+        return list(self._items.values())

src/cpl-api/cpl/api/registry/route.py

@@ -0,0 +1,33 @@
+from typing import Optional
+
+from cpl.api.model.policy import Policy
+from cpl.api.model.api_route import ApiRoute
+from cpl.core.abc.registry_abc import RegistryABC
+
+
+class RouteRegistry(RegistryABC):
+
+    def __init__(self):
+        RegistryABC.__init__(self)
+
+    def extend(self, items: list[ApiRoute]):
+        for policy in items:
+            self.add(policy)
+
+    def add(self, item: ApiRoute):
+        assert isinstance(item, ApiRoute), "route must be an instance of ApiRoute"
+
+        if item.path in self._items:
+            raise ValueError(f"ApiRoute {item.path} is already registered")
+
+        self._items[item.path] = item
+
+    def set(self, item: ApiRoute):
+        assert isinstance(item, ApiRoute), "route must be an instance of ApiRoute"
+        self._items[item.path] = item
+
+    def get(self, key: str) -> Optional[ApiRoute]:
+        return self._items.get(key)
+
+    def all(self) -> list[ApiRoute]:
+        return list(self._items.values())

src/cpl-api/cpl/api/router.py

@@ -1,41 +1,135 @@
-from starlette.routing import Route
+from enum import Enum
+
+from cpl.api.model.validation_match import ValidationMatch
+from cpl.api.registry.route import RouteRegistry
+from cpl.api.typing import HTTPMethods
 
 
 class Router:
-    _registered_routes: list[Route] = []
+    _auth_required: list[str] = []
+    _authorization_rules: dict[str, dict] = {}
 
     @classmethod
-    def get_routes(cls) -> list[Route]:
+    def get_auth_required_routes(cls) -> list[str]:
-        return cls._registered_routes
+        return cls._auth_required
 
     @classmethod
-    def route(cls, path=None, **kwargs):
+    def get_authorization_rules_paths(cls) -> list[str]:
+        return list(cls._authorization_rules.keys())
+
+    @classmethod
+    def get_authorization_rules(cls) -> list[dict]:
+        return list(cls._authorization_rules.values())
+
+    @classmethod
+    def authenticate(cls):
+        """
+        Decorator to mark a route as requiring authentication.
+        Usage:
+            @Route.authenticate()
+            @Route.get("/example")
+            async def example_endpoint(request: TRequest):
+                ...
+        """
+
         def inner(fn):
-            cls._registered_routes.append(Route(path, fn, **kwargs))
+            route_path = getattr(fn, "_route_path", None)
+            if route_path and route_path not in cls._auth_required:
+                cls._auth_required.append(route_path)
+            return fn
+
+        return inner
+
+    @classmethod
+    def authorize(
+        cls,
+        roles: list[str | Enum] = None,
+        permissions: list[str | Enum] = None,
+        policies: list[str] = None,
+        match: ValidationMatch = None,
+    ):
+        """
+        Decorator to mark a route as requiring authorization.
+        Usage:
+            @Route.authorize()
+            @Route.get("/example")
+            async def example_endpoint(request: TRequest):
+                ...
+        """
+        assert roles is None or isinstance(roles, list), "roles must be a list of strings"
+        assert permissions is None or isinstance(permissions, list), "permissions must be a list of strings"
+        assert policies is None or isinstance(policies, list), "policies must be a list of strings"
+        assert match is None or isinstance(match, ValidationMatch), "match must be an instance of ValidationMatch"
+
+        if roles is not None:
+            for role in roles:
+                if isinstance(role, Enum):
+                    roles[roles.index(role)] = role.value
+
+        if permissions is not None:
+            for perm in permissions:
+                if isinstance(perm, Enum):
+                    permissions[permissions.index(perm)] = perm.value
+
+        def inner(fn):
+            path = getattr(fn, "_route_path", None)
+            if not path:
+                return fn
+
+            if path in cls._authorization_rules:
+                raise ValueError(f"Route {path} is already registered for authorization")
+
+            cls._authorization_rules[path] = {
+                "roles": roles or [],
+                "permissions": permissions or [],
+                "policies": policies or [],
+                "match": match or ValidationMatch.all,
+            }
+
+            return fn
+
+        return inner
+
+    @classmethod
+    def route(cls, path: str, method: HTTPMethods, registry: RouteRegistry = None, **kwargs):
+        if not registry:
+            from cpl.api.model.api_route import ApiRoute
+            from cpl.dependency.service_provider_abc import ServiceProviderABC
+
+            routes = ServiceProviderABC.get_global_service(RouteRegistry)
+        else:
+            routes = registry
+
+        def inner(fn):
+            routes.add(ApiRoute(path, fn, method, **kwargs))
             setattr(fn, "_route_path", path)
             return fn
 
         return inner
 
     @classmethod
-    def get(cls, path=None, **kwargs):
+    def get(cls, path: str, **kwargs):
-        return cls.route(path, methods=["GET"], **kwargs)
+        return cls.route(path, "GET", **kwargs)
 
     @classmethod
-    def post(cls, path=None, **kwargs):
+    def head(cls, path: str, **kwargs):
-        return cls.route(path, methods=["POST"], **kwargs)
+        return cls.route(path, "HEAD", **kwargs)
 
     @classmethod
-    def head(cls, path=None, **kwargs):
+    def post(cls, path: str, **kwargs):
-        return cls.route(path, methods=["HEAD"], **kwargs)
+        return cls.route(path, "POST", **kwargs)
 
     @classmethod
-    def put(cls, path=None, **kwargs):
+    def put(cls, path: str, **kwargs):
-        return cls.route(path, methods=["PUT"], **kwargs)
+        return cls.route(path, "PUT", **kwargs)
 
     @classmethod
-    def delete(cls, path=None, **kwargs):
+    def patch(cls, path: str, **kwargs):
-        return cls.route(path, methods=["DELETE"], **kwargs)
+        return cls.route(path, "PATCH", **kwargs)
+
+    @classmethod
+    def delete(cls, path: str, **kwargs):
+        return cls.route(path, "DELETE", **kwargs)
 
     @classmethod
     def override(cls):
@@ -48,13 +142,22 @@ class Router:
                 ...
         """
 
+        from cpl.api.model.api_route import ApiRoute
+        from cpl.dependency.service_provider_abc import ServiceProviderABC
+
+        routes = ServiceProviderABC.get_global_service(RouteRegistry)
+
         def inner(fn):
-            route_path = getattr(fn, "_route_path", None)
+            path = getattr(fn, "_route_path", None)
+            if path is None:
+                raise ValueError("Cannot override a route that has not been registered yet")
 
-            routes = list(filter(lambda x: x.path == route_path, cls._registered_routes))
+            route = routes.get(path)
-            for route in routes[:-1]:
+            if route is None:
-                cls._registered_routes.remove(route)
+                raise ValueError(f"Cannot override a route that does not exist: {path}")
 
+            routes.add(ApiRoute(path, fn, route.method, **route.kwargs))
+            setattr(fn, "_route_path", path)
             return fn
 
-        return inner
+        return inner

src/cpl-api/cpl/api/typing.py

@@ -1,13 +1,19 @@
-from typing import Union, Literal, Callable
+from typing import Union, Literal, Callable, Type, Awaitable
 from urllib.request import Request
 
 from starlette.middleware import Middleware
 from starlette.types import ASGIApp
 from starlette.websockets import WebSocket
 
+from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
+from cpl.auth.schema import AuthUser
+
 TRequest = Union[Request, WebSocket]
-HTTPMethods = Literal["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"]
+HTTPMethods = Literal["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"]
 PartialMiddleware = Union[
+    ASGIMiddleware,
+    Type[ASGIMiddleware],
     Middleware,
     Callable[[ASGIApp], ASGIApp],
-]
+]
+PolicyResolver = Callable[[AuthUser], bool | Awaitable[bool]]

src/cpl-api/cpl/api/web_app.py

@@ -1,153 +0,0 @@
-import os
-from typing import Mapping, Any, Callable
-
-import uvicorn
-from starlette.applications import Starlette
-from starlette.middleware import Middleware
-from starlette.middleware.cors import CORSMiddleware
-from starlette.requests import Request
-from starlette.responses import JSONResponse
-from starlette.routing import Route
-from starlette.types import ExceptionHandler
-
-from cpl.api.api_logger import APILogger
-from cpl.api.api_settings import ApiSettings
-from cpl.api.error import APIError
-from cpl.api.middleware.logging import LoggingMiddleware
-from cpl.api.middleware.request import RequestMiddleware
-from cpl.api.router import Router
-from cpl.api.typing import HTTPMethods, PartialMiddleware
-from cpl.application.abc.application_abc import ApplicationABC
-from cpl.core.configuration import Configuration
-from cpl.dependency.service_provider_abc import ServiceProviderABC
-
-_logger = APILogger("API")
-
-
-
-class WebApp(ApplicationABC):
-    def __init__(self, services: ServiceProviderABC):
-        super().__init__(services)
-        self._app: Starlette | None = None
-
-        self._api_settings = Configuration.get(ApiSettings)
-
-        self._routes: list[Route] = []
-        self._middleware: list[Middleware] = [
-            Middleware(RequestMiddleware),
-            Middleware(LoggingMiddleware),
-        ]
-        self._exception_handlers: Mapping[Any, ExceptionHandler] = {Exception: self.handle_exception}
-
-    @staticmethod
-    async def handle_exception(request: Request, exc: Exception):
-        if hasattr(request.state, "request_id"):
-            _logger.error(f"Request {request.state.request_id}", exc)
-        else:
-            _logger.error("Request unknown", exc)
-
-        if isinstance(exc, APIError):
-            return JSONResponse({"error": str(exc)}, status_code=exc.status_code)
-
-        return JSONResponse({"error": str(exc)}, status_code=500)
-
-    def _get_allowed_origins(self):
-        origins = self._api_settings.allowed_origins
-
-        if origins is None or origins == "":
-            _logger.warning("No allowed origins specified, allowing all origins")
-            return ["*"]
-
-        _logger.debug(f"Allowed origins: {origins}")
-        return origins.split(",")
-
-    def with_app(self, app: Starlette):
-        assert app is not None, "app must not be None"
-        assert isinstance(app, Starlette), "app must be an instance of Starlette"
-        self._app = app
-        return self
-
-    def _check_for_app(self):
-        if self._app is not None:
-            raise ValueError("App is already set, cannot add routes or middleware")
-
-    def with_routes_directory(self, directory: str) -> "WebApp":
-        self._check_for_app()
-        assert directory is not None, "directory must not be None"
-
-        base = directory.replace("/", ".").replace("\\", ".")
-
-        for filename in os.listdir(directory):
-            if not filename.endswith(".py") or filename == "__init__.py":
-                continue
-
-            __import__(f"{base}.{filename[:-3]}")
-
-        return self
-
-    def with_routes(self, routes: list[Route]) -> "WebApp":
-        self._check_for_app()
-        assert self._routes is not None, "routes must not be None"
-        assert all(isinstance(route, Route) for route in routes), "all routes must be of type starlette.routing.Route"
-        self._routes.extend(routes)
-        return self
-
-    def with_route(self, path: str, fn: Callable[[Request], Any], method: HTTPMethods, **kwargs) -> "WebApp":
-        self._check_for_app()
-        assert path is not None, "path must not be None"
-        assert fn is not None, "fn must not be None"
-        assert method in ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"], "method must be a valid HTTP method"
-        self._routes.append(Route(path, fn, methods=[method], **kwargs))
-        return self
-
-    def with_middleware(self, middleware: PartialMiddleware) -> "WebApp":
-        self._check_for_app()
-
-        if isinstance(middleware, Middleware):
-            self._middleware.append(middleware)
-
-        elif callable(middleware):
-            self._middleware.append(Middleware(middleware))
-        else:
-            raise ValueError("middleware must be of type starlette.middleware.Middleware or a callable")
-
-
-        return self
-
-    def main(self):
-        _logger.debug(f"Preparing API")
-        if self._app is None:
-            routes = [
-                Route(
-                    path=route.path,
-                    endpoint=self._services.inject(route.endpoint),
-                    methods=route.methods,
-                    name=route.name,
-                )
-                for route in self._routes + Router.get_routes()
-            ]
-
-            app = Starlette(
-                routes=routes,
-                middleware=[
-                    *self._middleware,
-                    Middleware(
-                        CORSMiddleware,
-                        allow_origins=self._get_allowed_origins(),
-                        allow_methods=["*"],
-                        allow_headers=["*"],
-                    ),
-                ],
-                exception_handlers=self._exception_handlers,
-            )
-        else:
-            app = self._app
-
-        _logger.info(f"Start API on {self._api_settings.host}:{self._api_settings.port}")
-        uvicorn.run(
-            app,
-            host=self._api_settings.host,
-            port=self._api_settings.port,
-            log_config=None,
-        )
-        _logger.info("Shutdown API")

src/cpl-api/requirements.txt

@@ -3,4 +3,5 @@ cpl-application
 cpl-core
 cpl-dependency
 starlette==0.48.0
-python-multipart==0.0.20
+python-multipart==0.0.20
+uvicorn==0.35.0

src/cpl-application/cpl/application/abc/application_abc.py

@@ -22,8 +22,15 @@ class ApplicationABC(ABC):
     """
 
     @abstractmethod
-    def __init__(self, services: ServiceProviderABC):
+    def __init__(self, services: ServiceProviderABC, required_modules: list[str | object] = None):
         self._services = services
+        self._required_modules = (
+            [x.__name__ if not isinstance(x, str) else x for x in required_modules] if required_modules else []
+        )
+
+    @property
+    def required_modules(self) -> list[str]:
+        return self._required_modules
 
     @classmethod
     def extend(cls, name: str | Callable, func: Callable[[Self], Self]):
@@ -80,7 +87,7 @@ class ApplicationABC(ABC):
         try:
             Host.run(self.main)
         except KeyboardInterrupt:
-            Console.close()
+            pass
 
     @abstractmethod
     def main(self): ...

src/cpl-application/cpl/application/application_builder.py

@@ -6,6 +6,7 @@ from cpl.application.abc.application_extension_abc import ApplicationExtensionAB
 from cpl.application.abc.startup_abc import StartupABC
 from cpl.application.abc.startup_extension_abc import StartupExtensionABC
 from cpl.application.host import Host
+from cpl.core.errors import dependency_error
 from cpl.dependency.service_collection import ServiceCollection
 
 TApp = TypeVar("TApp", bound=ApplicationABC)
@@ -35,6 +36,18 @@ class ApplicationBuilder(Generic[TApp]):
     def service_provider(self):
         return self._services.build()
 
+    def validate_app_required_modules(self, app: ApplicationABC):
+        for module in app.required_modules:
+            if module in self._services.loaded_modules:
+                continue
+
+            dependency_error(
+                module,
+                ImportError(
+                    f"Required module '{module}' for application '{app.__class__.__name__}' is not loaded. Load using 'add_module({module})' method."
+                ),
+            )
+
     def with_startup(self, startup: Type[StartupABC]) -> "ApplicationBuilder":
         self._startup = startup
         return self
@@ -62,4 +75,6 @@ class ApplicationBuilder(Generic[TApp]):
         for extension in self._app_extensions:
             Host.run(extension.run, self.service_provider)
 
-        return self._app(self.service_provider)
+        app = self._app(self.service_provider)
+        self.validate_app_required_modules(app)
+        return app

src/cpl-auth/cpl/auth/__init__.py

@@ -40,11 +40,10 @@ def _add_daos(collection: _ServiceCollection):
 def add_auth(collection: _ServiceCollection):
     import os
 
-    from cpl.core.console import Console
-    from cpl.database.service.migration_service import MigrationService
-    from cpl.database.model.server_type import ServerType, ServerTypes
-
     try:
+        from cpl.database.service.migration_service import MigrationService
+        from cpl.database.model.server_type import ServerType, ServerTypes
+
         collection.add_singleton(_KeycloakClient)
         collection.add_singleton(_KeycloakAdmin)
 
@@ -59,22 +58,25 @@ def add_auth(collection: _ServiceCollection):
         elif ServerType.server_type == ServerTypes.MYSQL:
             migration_service.with_directory(os.path.join(os.path.dirname(os.path.realpath(__file__)), "scripts/mysql"))
     except ImportError as e:
-        Console.error("cpl-auth is not installed", str(e))
+        from cpl.core.console import Console
+
+        Console.error("cpl-database is not installed", str(e))
 
 
 def add_permission(collection: _ServiceCollection):
-    from cpl.auth.permission_seeder import PermissionSeeder
+    from .permission_seeder import PermissionSeeder
-    from cpl.database.abc.data_seeder_abc import DataSeederABC
+    from .permission.permissions_registry import PermissionsRegistry
-    from cpl.auth.permission.permissions_registry import PermissionsRegistry
+    from .permission.permissions import Permissions
-    from cpl.auth.permission.permissions import Permissions
 
     try:
+        from cpl.database.abc.data_seeder_abc import DataSeederABC
+
         collection.add_singleton(DataSeederABC, PermissionSeeder)
         PermissionsRegistry.with_enum(Permissions)
     except ImportError as e:
         from cpl.core.console import Console
 
-        Console.error("cpl-auth is not installed", str(e))
+        Console.error("cpl-database is not installed", str(e))
 
 
 _ServiceCollection.with_module(add_auth, __name__)

src/cpl-auth/cpl/auth/keycloak/keycloak_client.py

@@ -1,4 +1,6 @@
-from keycloak import KeycloakOpenID, KeycloakAdmin, KeycloakOpenIDConnection
+from typing import Optional
+
+from keycloak import KeycloakOpenID
 
 from cpl.auth.auth_logger import AuthLogger
 from cpl.auth.keycloak_settings import KeycloakSettings
@@ -17,10 +19,7 @@ class KeycloakClient(KeycloakOpenID):
             client_secret_key=settings.client_secret,
         )
         _logger.info("Initializing Keycloak client")
-        connection = KeycloakOpenIDConnection(
+
-            server_url=settings.url,
+    def get_user_id(self, token: str) -> Optional[str]:
-            client_id=settings.client_id,
+        info = self.introspect(token)
-            realm_name=settings.realm,
+        return info.get("sub", None)
-            client_secret_key=settings.client_secret,
-        )
-        self._admin = KeycloakAdmin(connection=connection)

src/cpl-auth/cpl/auth/schema/_administration/auth_user_dao.py

@@ -16,7 +16,7 @@ class AuthUserDao(DbModelDaoABC[AuthUser]):
     def __init__(self):
         DbModelDaoABC.__init__(self, __name__, AuthUser, TableManager.get("auth_users"))
 
-        self.attribute(AuthUser.keycloak_id, str, aliases=["keycloakId"])
+        self.attribute(AuthUser.keycloak_id, str, db_name="keycloakId")
 
         async def get_users():
             return [(x.id, x.username, x.email) for x in await self.get_all()]
@@ -43,9 +43,9 @@ class AuthUserDao(DbModelDaoABC[AuthUser]):
         p = await permission_dao.get_by_name(permission if isinstance(permission, str) else permission.value)
         result = await self._db.select_map(
             f"""
-            SELECT COUNT(*)
+            SELECT COUNT(*) as count
-            FROM permission.role_users ru
+            FROM {TableManager.get("role_users")} ru
-            JOIN permission.role_permissions rp ON ru.roleId = rp.roleId
+            JOIN {TableManager.get("role_permissions")} rp ON ru.roleId = rp.roleId
             WHERE ru.userId = {user_id}
             AND rp.permissionId = {p.id}
             AND ru.deleted = FALSE
@@ -61,9 +61,9 @@ class AuthUserDao(DbModelDaoABC[AuthUser]):
         result = await self._db.select_map(
             f"""
             SELECT p.*
-            FROM permission.permissions p
+            FROM {TableManager.get("permissions")} p
-            JOIN permission.role_permissions rp ON p.id = rp.permissionId
+            JOIN {TableManager.get("role_permissions")} rp ON p.id = rp.permissionId
-            JOIN permission.role_users ru ON rp.roleId = ru.roleId
+            JOIN {TableManager.get("role_users")} ru ON rp.roleId = ru.roleId
             WHERE ru.userId = {user_id}
             AND rp.deleted = FALSE
             AND ru.deleted = FALSE;

src/cpl-auth/cpl/auth/scripts/mysql/1-users.sql

@@ -14,7 +14,7 @@ CREATE TABLE IF NOT EXISTS administration_auth_users
 
 CREATE TABLE IF NOT EXISTS administration_auth_users_history
 (
-    id         INT AUTO_INCREMENT PRIMARY KEY,
+    id INT NOT NULL,
     keycloakId CHAR(36)  NOT NULL,
     -- for history
     deleted    BOOL      NOT NULL,

src/cpl-auth/cpl/auth/scripts/mysql/2-api-key.sql

@@ -15,7 +15,7 @@ CREATE TABLE IF NOT EXISTS administration_api_keys
 
 CREATE TABLE IF NOT EXISTS administration_api_keys_history
 (
-    id         INT AUTO_INCREMENT PRIMARY KEY,
+    id INT NOT NULL,
     identifier VARCHAR(255) NOT NULL,
     keyString  VARCHAR(255) NOT NULL,
     deleted    BOOL         NOT NULL,

src/cpl-auth/cpl/auth/scripts/mysql/3-roles-permissions.sql

@@ -13,7 +13,7 @@ CREATE TABLE IF NOT EXISTS permission_permissions
 
 CREATE TABLE IF NOT EXISTS permission_permissions_history
 (
-    id          INT AUTO_INCREMENT PRIMARY KEY,
+    id INT NOT NULL,
     name        VARCHAR(255) NOT NULL,
     description TEXT         NULL,
     deleted     BOOL         NOT NULL,
@@ -57,7 +57,7 @@ CREATE TABLE IF NOT EXISTS permission_roles
 
 CREATE TABLE IF NOT EXISTS permission_roles_history
 (
-    id          INT AUTO_INCREMENT PRIMARY KEY,
+    id INT NOT NULL,
     name        VARCHAR(255) NOT NULL,
     description TEXT         NULL,
     deleted     BOOL         NOT NULL,
@@ -103,7 +103,7 @@ CREATE TABLE IF NOT EXISTS permission_role_permissions
 
 CREATE TABLE IF NOT EXISTS permission_role_permissions_history
 (
-    id           INT AUTO_INCREMENT PRIMARY KEY,
+    id INT NOT NULL,
     RoleId       INT       NOT NULL,
     permissionId INT       NOT NULL,
     deleted      BOOL      NOT NULL,
@@ -149,7 +149,7 @@ CREATE TABLE IF NOT EXISTS permission_role_auth_users
 
 CREATE TABLE IF NOT EXISTS permission_role_auth_users_history
 (
-    id       INT AUTO_INCREMENT PRIMARY KEY,
+    id INT NOT NULL,
     RoleId   INT       NOT NULL,
     UserId   INT       NOT NULL,
     deleted  BOOL      NOT NULL,

src/cpl-auth/cpl/auth/scripts/mysql/4-api-key-permissions.sql

@@ -15,7 +15,7 @@ CREATE TABLE IF NOT EXISTS permission_api_key_permissions
 
 CREATE TABLE IF NOT EXISTS permission_api_key_permissions_history
 (
-    id           INT AUTO_INCREMENT PRIMARY KEY,
+    id INT NOT NULL,
     apiKeyId     INT       NOT NULL,
     permissionId INT       NOT NULL,
     deleted      BOOL      NOT NULL,

src/cpl-auth/requirements.txt

@@ -1,4 +1,4 @@
 cpl-core
 cpl-dependency
 cpl-database
-python-keycloak-5.8.1
+python-keycloak==5.8.1

src/cpl-core/cpl/core/abc/registry_abc.py

@@ -0,0 +1,23 @@
+from abc import abstractmethod, ABC
+from typing import Generic
+
+from cpl.core.typing import T
+
+
+class RegistryABC(ABC, Generic[T]):
+
+    @abstractmethod
+    def __init__(self):
+        self._items: dict[str, T] = {}
+
+    @abstractmethod
+    def extend(self, items: list[T]) -> None: ...
+
+    @abstractmethod
+    def add(self, item: T) -> None: ...
+
+    @abstractmethod
+    def get(self, key: str) -> T | None: ...
+
+    @abstractmethod
+    def all(self) -> list[T]: ...

src/cpl-core/cpl/core/configuration/configuration.py

@@ -130,7 +130,7 @@ class Configuration:
         key_name = key.__name__ if inspect.isclass(key) else key
 
         result = cls._config.get(key_name, default)
-        if issubclass(key, ConfigurationModelABC) and result == default:
+        if isclass(key) and issubclass(key, ConfigurationModelABC) and result == default:
             result = key()
             cls.set(key, result)
 

src/cpl-core/cpl/core/configuration/configuration_model_abc.py

@@ -68,7 +68,7 @@ class ConfigurationModelABC(ABC):
             value = cast(Environment.get(env_field, str), cast_type)
 
         if value is None and required:
-            raise ValueError(f"{field} is required")
+            raise ValueError(f"{type(self).__name__}.{field} is required")
         elif value is None:
             self._options[field] = default
             return

src/cpl-core/cpl/core/errors.py

@@ -0,0 +1,15 @@
+import traceback
+
+from cpl.core.console import Console
+
+
+def dependency_error(package_name: str, e: ImportError) -> None:
+    Console.error(f"'{package_name}' is required to use this feature. Please install it and try again.")
+    tb = traceback.format_exc()
+    if not tb.startswith("NoneType: None"):
+        Console.write_line("->", tb)
+
+    elif e is not None:
+        Console.write_line("->", str(e))
+
+    exit(1)

src/cpl-core/requirements.txt

@@ -2,5 +2,4 @@ art==6.5
 colorama==0.4.6
 tabulate==0.9.0
 termcolor==3.1.0
-mysql-connector-python==9.4.0
 pynput==1.8.1

src/cpl-database/cpl/database/__init__.py

@@ -1,3 +1,4 @@
+import os
 from typing import Type
 
 from cpl.application.abc import ApplicationABC as _ApplicationABC
@@ -7,13 +8,19 @@ from . import postgres as _postgres
 from .table_manager import TableManager
 
 
-def _with_migrations(self: _ApplicationABC, *paths: list[str]) -> _ApplicationABC:
+def _with_migrations(self: _ApplicationABC, *paths: str | list[str]) -> _ApplicationABC:
     from cpl.application.host import Host
-
     from cpl.database.service.migration_service import MigrationService
 
     migration_service = self._services.get_service(MigrationService)
-    migration_service.with_directory("./scripts")
+    migration_service.with_directory(os.path.join(os.path.dirname(os.path.abspath(__file__)), "scripts"))
+
+    if isinstance(paths, str):
+        paths = [paths]
+
+    for path in paths:
+        migration_service.with_directory(path)
+
     Host.run(migration_service.migrate)
 
     return self

src/cpl-database/cpl/database/abc/data_access_object_abc.py

@@ -156,13 +156,16 @@ class DataAccessObjectABC(ABC, Generic[T_DBM]):
         :param dict result: Result from the database
         :return:
         """
-        value_map: dict[str, T] = {}
+        value_map: dict[str, Any] = {}
+        db_names = self.__db_names.items()
 
         for db_name, value in result.items():
             # Find the attribute name corresponding to the db_name
-            attr_name = next((k for k, v in self.__db_names.items() if v == db_name), None)
+            attr_name = next((k for k, v in db_names if v == db_name), None)
-            if attr_name:
+            if not attr_name:
-                value_map[attr_name] = self._get_value_from_sql(self.__attributes[attr_name], value)
+                continue
+
+            value_map[attr_name] = self._get_value_from_sql(self.__attributes[attr_name], value)
 
         return self._model_type(**value_map)
 
@@ -484,7 +487,7 @@ class DataAccessObjectABC(ABC, Generic[T_DBM]):
             builder.with_temp_table(self._external_fields[temp])
 
         if for_count:
-            builder.with_attribute("COUNT(*)", ignore_table_name=True)
+            builder.with_attribute("COUNT(*) as count", ignore_table_name=True)
         else:
             builder.with_attribute("*")
 

src/cpl-database/cpl/database/mysql/mysql_pool.py

@@ -1,7 +1,7 @@
 from typing import Optional, Any
 
 import sqlparse
-import aiomysql
+from mysql.connector.aio import MySQLConnectionPool
 
 from cpl.core.environment import Environment
 from cpl.database.db_logger import DBLogger
@@ -11,95 +11,82 @@ _logger = DBLogger(__name__)
 
 
 class MySQLPool:
-    """
-    Create a pool when connecting to MySQL, which will decrease the time spent in
-    requesting connection, creating connection, and closing connection.
-    """
 
     def __init__(self, database_settings: DatabaseSettings):
-        self._db_settings = database_settings
+        self._dbconfig = {
-        self.pool: Optional[aiomysql.Pool] = None
+            "host": database_settings.host,
+            "port": database_settings.port,
+            "user": database_settings.user,
+            "password": database_settings.password,
+            "database": database_settings.database,
+            "ssl_disabled": True,
+        }
+        self._pool: Optional[MySQLConnectionPool] = None
 
     async def _get_pool(self):
-        if self.pool is None or self.pool._closed:
+        if self._pool is None:
+            self._pool = MySQLConnectionPool(
+                pool_name="mypool", pool_size=Environment.get("DB_POOL_SIZE", int, 1), **self._dbconfig
+            )
+            await self._pool.initialize_pool()
+
+            con = await self._pool.get_connection()
             try:
-                self.pool = await aiomysql.create_pool(
+                async with await con.cursor() as cursor:
-                    host=self._db_settings.host,
+                    await cursor.execute("SELECT 1")
-                    port=self._db_settings.port,
+                    await cursor.fetchall()
-                    user=self._db_settings.user,
-                    password=self._db_settings.password,
-                    db=self._db_settings.database,
-                    minsize=1,
-                    maxsize=Environment.get("DB_POOL_SIZE", int, 1),
-                )
             except Exception as e:
-                _logger.fatal("Failed to connect to the database", e)
+                _logger.fatal(f"Error connecting to the database: {e}")
-                raise
+            finally:
-        return self.pool
+                await con.close()
+
+        return self._pool
 
     @staticmethod
     async def _exec_sql(cursor: Any, query: str, args=None, multi=True):
+        result = []
         if multi:
             queries = [str(stmt).strip() for stmt in sqlparse.parse(query) if str(stmt).strip()]
             for q in queries:
                 if q.strip() == "":
                     continue
                 await cursor.execute(q, args)
+                if cursor.description is not None:
+                    result = await cursor.fetchall()
         else:
             await cursor.execute(query, args)
+            if cursor.description is not None:
+                result = await cursor.fetchall()
+
+        return result
 
     async def execute(self, query: str, args=None, multi=True) -> list[list]:
-        """
-        Execute a SQL statement, it could be with args and without args. The usage is
-        similar to the execute() function in aiomysql.
-        :param query: SQL clause
-        :param args: args needed by the SQL clause
-        :param multi: if the query is a multi-statement
-        :return: return result
-        """
         pool = await self._get_pool()
-        async with pool.acquire() as con:
+        con = await pool.get_connection()
-            async with con.cursor() as cursor:
+        try:
-                await self._exec_sql(cursor, query, args, multi)
+            async with await con.cursor() as cursor:
+                result = await self._exec_sql(cursor, query, args, multi)
                 await con.commit()
-
+                return result
-                if cursor.description is not None:  # Query returns rows
+        finally:
-                    res = await cursor.fetchall()
+            await con.close()
-                    if res is None:
-                        return []
-
-                    return [list(row) for row in res]
-                else:
-                    return []
 
     async def select(self, query: str, args=None, multi=True) -> list[str]:
-        """
-        Execute a SQL statement, it could be with args and without args. The usage is
-        similar to the execute() function in aiomysql.
-        :param query: SQL clause
-        :param args: args needed by the SQL clause
-        :param multi: if the query is a multi-statement
-        :return: return result
-        """
         pool = await self._get_pool()
-        async with pool.acquire() as con:
+        con = await pool.get_connection()
-            async with con.cursor() as cursor:
+        try:
-                await self._exec_sql(cursor, query, args, multi)
+            async with await con.cursor() as cursor:
-                res = await cursor.fetchall()
+                res = await self._exec_sql(cursor, query, args, multi)
                 return list(res)
+        finally:
+            await con.close()
 
     async def select_map(self, query: str, args=None, multi=True) -> list[dict]:
-        """
-        Execute a SQL statement, it could be with args and without args. The usage is
-        similar to the execute() function in aiomysql.
-        :param query: SQL clause
-        :param args: args needed by the SQL clause
-        :param multi: if the query is a multi-statement
-        :return: return result
-        """
         pool = await self._get_pool()
-        async with pool.acquire() as con:
+        con = await pool.get_connection()
-            async with con.cursor(aiomysql.DictCursor) as cursor:
+        try:
-                await self._exec_sql(cursor, query, args, multi)
+            async with await con.cursor(dictionary=True) as cursor:
-                res = await cursor.fetchall()
+                res = await self._exec_sql(cursor, query, args, multi)
                 return list(res)
+        finally:
+            await con.close()

src/cpl-database/cpl/database/postgres/postgres_pool.py

@@ -25,21 +25,23 @@ class PostgresPool:
             f"password={database_settings.password} "
             f"dbname={database_settings.database}"
         )
-
+        self._pool: Optional[AsyncConnectionPool] = None
-        self.pool: Optional[AsyncConnectionPool] = None
 
     async def _get_pool(self):
-        pool = AsyncConnectionPool(
+        if self._pool is None:
-            conninfo=self._conninfo, open=False, min_size=1, max_size=Environment.get("DB_POOL_SIZE", int, 1)
+            pool = AsyncConnectionPool(
-        )
+                conninfo=self._conninfo, open=False, min_size=1, max_size=Environment.get("DB_POOL_SIZE", int, 1)
-        await pool.open()
+            )
-        try:
+            await pool.open()
-            async with pool.connection() as con:
+            try:
-                await pool.check_connection(con)
+                async with pool.connection() as con:
-        except PoolTimeout as e:
+                    await pool.check_connection(con)
-            await pool.close()
+            except PoolTimeout as e:
-            _logger.fatal(f"Failed to connect to the database", e)
+                await pool.close()
-        return pool
+                _logger.fatal(f"Failed to connect to the database", e)
+            self._pool = pool
+
+        return self._pool
 
     @staticmethod
     async def _exec_sql(cursor: Any, query: str, args=None, multi=True):

src/cpl-database/cpl/database/table_manager.py

@@ -33,7 +33,7 @@ class TableManager:
         },
         "role_users": {
             ServerTypes.POSTGRES: "permission.role_users",
-            ServerTypes.MYSQL: "permission_role_users",
+            ServerTypes.MYSQL: "permission_role_auth_users",
         },
     }
 

src/cpl-dependency/cpl/dependency/service_collection.py

@@ -1,4 +1,4 @@
-from typing import Union, Type, Callable
+from typing import Union, Type, Callable, Self
 
 from cpl.core.log.logger import Logger
 from cpl.core.log.logger_abc import LoggerABC
@@ -15,12 +15,17 @@ class ServiceCollection:
     _modules: dict[str, Callable] = {}
 
     @classmethod
-    def with_module(cls, func: Callable, name: str = None):
+    def with_module(cls, func: Callable, name: str = None) -> type[Self]:
         cls._modules[func.__name__ if name is None else name] = func
         return cls
 
     def __init__(self):
         self._service_descriptors: list[ServiceDescriptor] = []
+        self._loaded_modules: set[str] = set()
+
+    @property
+    def loaded_modules(self) -> set[str]:
+        return self._loaded_modules
 
     def _add_descriptor(self, service: Union[type, object], lifetime: ServiceLifetimeEnum, base_type: Callable = None):
         found = False
@@ -45,15 +50,15 @@ class ServiceCollection:
 
         return self
 
-    def add_singleton(self, service_type: T, service: Service = None):
+    def add_singleton(self, service_type: T, service: Service = None) -> Self:
         self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.singleton, service)
         return self
 
-    def add_scoped(self, service_type: T, service: Service = None):
+    def add_scoped(self, service_type: T, service: Service = None) -> Self:
         self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.scoped, service)
         return self
 
-    def add_transient(self, service_type: T, service: Service = None):
+    def add_transient(self, service_type: T, service: Service = None) -> Self:
         self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.transient, service)
         return self
 
@@ -62,7 +67,7 @@ class ServiceCollection:
         ServiceProviderABC.set_global_provider(sp)
         return sp
 
-    def add_module(self, module: str | object):
+    def add_module(self, module: str | object) -> Self:
         if not isinstance(module, str):
             module = module.__name__
 
@@ -70,7 +75,10 @@ class ServiceCollection:
             raise ValueError(f"Module {module} not found")
 
         self._modules[module](self)
+        if module not in self._loaded_modules:
+            self._loaded_modules.add(module)
+        return self
 
-    def add_logging(self):
+    def add_logging(self) -> Self:
         self.add_transient(LoggerABC, Logger)
         return self

src/cpl-dependency/cpl/dependency/service_provider.py

@@ -77,7 +77,7 @@ class ServiceProvider(ServiceProviderABC):
 
         return implementations
 
-    def _build_by_signature(self, sig: Signature, origin_service_type: type=None) -> list[R]:
+    def _build_by_signature(self, sig: Signature, origin_service_type: type = None) -> list[R]:
         params = []
         for param in sig.parameters.items():
             parameter = param[1]

src/cpl-dependency/cpl/dependency/service_provider_abc.py

@@ -24,19 +24,19 @@ class ServiceProviderABC(ABC):
         return cls._provider
 
     @classmethod
-    def get_global_service(cls, instance_type: T, *args, **kwargs) -> Optional[R]:
+    def get_global_service(cls, instance_type: Type[T], *args, **kwargs) -> Optional[T]:
         if cls._provider is None:
             return None
         return cls._provider.get_service(instance_type, *args, **kwargs)
 
     @classmethod
-    def get_global_services(cls, instance_type: T, *args, **kwargs) -> list[Optional[R]]:
+    def get_global_services(cls, instance_type: Type[T], *args, **kwargs) -> list[Optional[T]]:
         if cls._provider is None:
             return []
         return cls._provider.get_services(instance_type, *args, **kwargs)
 
     @abstractmethod
-    def _build_by_signature(self, sig: Signature, origin_service_type: type=None) -> list[R]: ...
+    def _build_by_signature(self, sig: Signature, origin_service_type: type = None) -> list[T]: ...
 
     @abstractmethod
     def _build_service(self, service_type: type, *args, **kwargs) -> object:
@@ -114,14 +114,24 @@ class ServiceProviderABC(ABC):
         if f is None:
             return functools.partial(cls.inject)
 
+        if iscoroutinefunction(f):
+
+            @functools.wraps(f)
+            async def async_inner(*args, **kwargs):
+                if cls._provider is None:
+                    raise Exception(f"{cls.__name__} not build!")
+
+                injection = [x for x in cls._provider._build_by_signature(signature(f)) if x is not None]
+                return await f(*args, *injection, **kwargs)
+
+            return async_inner
+
         @functools.wraps(f)
-        async def inner(*args, **kwargs):
+        def inner(*args, **kwargs):
             if cls._provider is None:
                 raise Exception(f"{cls.__name__} not build!")
 
             injection = [x for x in cls._provider._build_by_signature(signature(f)) if x is not None]
-            if iscoroutinefunction(f):
-                return await f(*args, *injection, **kwargs)
             return f(*args, *injection, **kwargs)
 
         return inner

tests/custom/api/src/appsettings.development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "Path": "logs/",
+    "Filename": "log_$start_time.log",
+    "ConsoleLevel": "TRACE",
+    "Level": "TRACE"
+  }
+}

tests/custom/api/src/appsettings.edrafts-pc.json

@@ -0,0 +1,26 @@
+{
+  "TimeFormat": {
+    "DateFormat": "%Y-%m-%d",
+    "TimeFormat": "%H:%M:%S",
+    "DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f",
+    "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S"
+  },
+
+  "Log": {
+    "Path": "logs/",
+    "Filename": "log_$start_time.log",
+    "ConsoleLevel": "TRACE",
+    "Level": "TRACE"
+  },
+
+  "Database": {
+    "Host": "localhost",
+    "User": "cpl",
+    "Port": 3306,
+    "Password": "cpl",
+    "Database": "cpl",
+    "Charset": "utf8mb4",
+    "UseUnicode": "true",
+    "Buffered": "true"
+  }
+}

tests/custom/api/src/appsettings.json

@@ -0,0 +1,15 @@
+{
+  "TimeFormat": {
+    "DateFormat": "%Y-%m-%d",
+    "TimeFormat": "%H:%M:%S",
+    "DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f",
+    "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S"
+  },
+
+  "Log": {
+    "Path": "logs/",
+    "Filename": "log_$start_time.log",
+    "ConsoleLevel": "ERROR",
+    "Level": "WARNING"
+  }
+}

tests/custom/api/src/main.py

@@ -1,20 +1,34 @@
 from starlette.responses import JSONResponse
 
-from cpl.api.web_app import WebApp
+from cpl import api
+from cpl.api.application.web_app import WebApp
 from cpl.application import ApplicationBuilder
-from custom.api.src.service import PingService
+from cpl.auth.permission.permissions import Permissions
+from cpl.core.configuration import Configuration
+from cpl.core.environment import Environment
+from service import PingService
 
 
 def main():
     builder = ApplicationBuilder[WebApp](WebApp)
 
+    Configuration.add_json_file(f"appsettings.json")
+    Configuration.add_json_file(f"appsettings.{Environment.get_environment()}.json")
+    Configuration.add_json_file(f"appsettings.{Environment.get_host_name()}.json", optional=True)
+
     builder.services.add_logging()
     builder.services.add_transient(PingService)
+    builder.services.add_module(api)
 
     app = builder.build()
-    app.with_route(path="/route1", fn=lambda r: JSONResponse("route1"), method="GET")
-    app.with_routes_directory("routes")
     app.with_logging()
+    app.with_database()
+
+    app.with_authentication()
+    app.with_authorization()
+
+    app.with_route(path="/route1", fn=lambda r: JSONResponse("route1"), method="GET", authentication=True, permissions=[Permissions.administrator])
+    app.with_routes_directory("routes")
 
     app.run()
 

tests/custom/api/src/routes/ping.py

@@ -3,10 +3,14 @@ from urllib.request import Request
 from starlette.responses import JSONResponse
 
 from cpl.api.router import Router
+from cpl.auth.permission.permissions import Permissions
 from cpl.core.log import Logger
-from custom.api.src.service import PingService
+from service import PingService
 
 
+@Router.authenticate()
+@Router.authorize(permissions=[Permissions.administrator])
+# @Router.authorize(policies=["test"])
 @Router.get(f"/ping")
 async def ping(r: Request, ping: PingService, logger: Logger):
     logger.info(f"Ping: {ping}")