From e04a77b721e258d7e1f8d378197cd98ec3662a79 Mon Sep 17 00:00:00 2001 From: Peter Holloway Date: Fri, 15 May 2026 10:40:41 +0100 Subject: [PATCH 1/2] WIP opa client Proof of concept opa client with dependency injection and example check --- src/blueapi/config.py | 8 +++ src/blueapi/service/authorization.py | 76 ++++++++++++++++++++++++++++ src/blueapi/service/main.py | 41 ++++++++++++--- tests/system_tests/compose.yaml | 2 +- 4 files changed, 119 insertions(+), 8 deletions(-) create mode 100644 src/blueapi/service/authorization.py diff --git a/src/blueapi/config.py b/src/blueapi/config.py index 83d6d7021..7ac61e711 100644 --- a/src/blueapi/config.py +++ b/src/blueapi/config.py @@ -296,6 +296,12 @@ class Tag(StrEnum): META = "Meta" +class OpaConfig(BlueapiBaseModel): + root: HttpUrl + tiled_service_account_check: str + submit_plan_check: str + + class ApplicationConfig(BlueapiBaseModel): """ Config for the worker application as a whole. Root of @@ -335,6 +341,7 @@ class ApplicationConfig(BlueapiBaseModel): oidc: OIDCConfig | None = None auth_token_path: Path | None = None numtracker: NumtrackerConfig | None = None + opa: OpaConfig | None = None def __eq__(self, other: object) -> bool: if isinstance(other, ApplicationConfig): @@ -343,6 +350,7 @@ def __eq__(self, other: object) -> bool: & (self.env == other.env) & (self.logging == other.logging) & (self.api == other.api) + & (self.opa == other.opa) ) return False diff --git a/src/blueapi/service/authorization.py b/src/blueapi/service/authorization.py new file mode 100644 index 000000000..5403b4bf6 --- /dev/null +++ b/src/blueapi/service/authorization.py @@ -0,0 +1,76 @@ +import logging +import re +from collections.abc import Mapping +from typing import Any + +import aiohttp +from aiohttp import ClientSession +from fastapi import HTTPException +from starlette.status import HTTP_401_UNAUTHORIZED + +from blueapi.config import OpaConfig +from blueapi.service.model import TaskRequest + +LOGGER = logging.getLogger(__name__) + +INSTRUMENT_SESSION_RE = re.compile(r"^[a-z]{2}(?P\d+)-(?P\d+)$") + + +class OpaClient: + client: aiohttp.ClientSession + + def __init__(self, instrument: str, config: OpaConfig): + LOGGER.info("Creating OpaClient for %s with config %s", instrument, config) + self._instrument = instrument + self._conf = config + self._url = config.root.encoded_string() + self._session = ClientSession(base_url=config.root.encoded_string()) + + def for_token(self, token: str) -> "OpaUserClient": + return OpaUserClient(self, token) + + async def check(self, endpoint: str, data: Mapping[str, Any]): + try: + resp = await self._session.post( + endpoint, + json={"input": {"beamline": self._instrument, **data}}, + ) + if not (await resp.json())["result"]: + raise HTTPException(status_code=HTTP_401_UNAUTHORIZED) + except Exception as e: + LOGGER.exception("Failed to run check", e) + raise + + async def require_tiled_service_account(self, token: str): + await self.check( + self._conf.tiled_service_account_check, {"token": token} + ) + + async def submit_plan_check(self, token: str, instrument_session: str): + if not (match := INSTRUMENT_SESSION_RE.match(instrument_session)): + raise ValueError("Invalid instrument session") + + await self.check( + self._conf.submit_plan_check, + { + "token": token, + "audience": "account", + "proposal": int(match["proposal"]), + "visit": int(match["visit"]), + }, + ) + + +class OpaUserClient: + client: OpaClient + token: str + + def __init__(self, client: OpaClient, token: str): + self.client = client + self.token = token + + async def check_submit_plan(self, task: TaskRequest): + LOGGER.info("Checking permissions to run task: %s", task) + await self.client.submit_plan_check( + token=self.token, instrument_session=task.instrument_session + ) diff --git a/src/blueapi/service/main.py b/src/blueapi/service/main.py index a53c46885..5637f0683 100644 --- a/src/blueapi/service/main.py +++ b/src/blueapi/service/main.py @@ -2,8 +2,9 @@ import urllib.parse from collections.abc import Awaitable, Callable from contextlib import asynccontextmanager -from typing import Annotated, Any +from typing import Annotated, Any, cast +from fastapi.security.utils import get_authorization_scheme_param import jwt from fastapi import ( APIRouter, @@ -32,6 +33,7 @@ from pydantic import ValidationError from pydantic.json_schema import SkipJsonSchema from starlette.responses import JSONResponse +from starlette.status import HTTP_401_UNAUTHORIZED from super_state_machine.errors import TransitionError from blueapi import __version__ @@ -56,6 +58,7 @@ TasksListResponse, WorkerTask, ) +from .authorization import OpaClient, OpaUserClient from .runner import WorkerDispatcher RUNNER: WorkerDispatcher | None = None @@ -93,6 +96,8 @@ def lifespan(config: ApplicationConfig): @asynccontextmanager async def inner(app: FastAPI): setup_runner(config) + if config.env.metadata and config.opa: + app.state.authz = OpaClient(config.env.metadata.instrument, config.opa) yield teardown_runner() @@ -140,15 +145,22 @@ def get_app(config: ApplicationConfig): return app +def bearer_token(req: Request) -> str | None: + auth = req.headers.get("Authorization") + scheme, param = get_authorization_scheme_param(auth) + if scheme.casefold() != "bearer": + raise HTTPException( + status_code=HTTP_401_UNAUTHORIZED, + detail="Not authenticated", + headers={"WWW-Authenticate": "Bearer"}, + ) + return param.strip() + + def decode_access_token(config: OIDCConfig): jwkclient = jwt.PyJWKClient(config.jwks_uri) - oauth_scheme = OAuth2AuthorizationCodeBearer( - authorizationUrl=config.authorization_endpoint, - tokenUrl=config.token_endpoint, - refreshUrl=config.token_endpoint, - ) - def inner(request: Request, access_token: str = Depends(oauth_scheme)): + def inner(request: Request, access_token: Annotated[str, Depends(bearer_token)]): signing_key = jwkclient.get_signing_key_from_jwt(access_token) decoded: dict[str, Any] = jwt.decode( access_token, @@ -166,6 +178,20 @@ def inner(request: Request, access_token: str = Depends(oauth_scheme)): TRACER = get_tracer("interface") +async def opa( + request: Request, token: Annotated[str, Depends(bearer_token)] +) -> OpaUserClient | None: + if client := cast(OpaClient | None, getattr(request.app.state, "authz", None)): + return client.for_token(token) + +async def submit_permission( + task_request: Annotated[TaskRequest, Body()], + opa: Annotated[OpaUserClient, Depends(opa)], +): + if opa: + await opa.check_submit_plan(task_request) + + async def on_key_error_404(_: Request, __: Exception): return JSONResponse( status_code=status.HTTP_404_NOT_FOUND, @@ -292,6 +318,7 @@ def submit_task( response: Response, task_request: Annotated[TaskRequest, Body(..., examples=[example_task_request])], runner: Annotated[WorkerDispatcher, Depends(_runner)], + _: Annotated[None, Depends(submit_permission)], ) -> TaskResponse: """Submit a task to the worker.""" try: diff --git a/tests/system_tests/compose.yaml b/tests/system_tests/compose.yaml index 5b34f4784..abf485bf8 100644 --- a/tests/system_tests/compose.yaml +++ b/tests/system_tests/compose.yaml @@ -8,7 +8,7 @@ services: - "8406:8000" security_opt: - label=disable - + rabbitmq: image: docker.io/rabbitmq:4.0-management ports: From db3325beb0d7308b118ed41584d13301090051a9 Mon Sep 17 00:00:00 2001 From: Peter Holloway Date: Fri, 15 May 2026 16:29:53 +0100 Subject: [PATCH 2/2] Stop the machines complaining --- src/blueapi/service/authorization.py | 4 +--- src/blueapi/service/main.py | 9 +++++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/blueapi/service/authorization.py b/src/blueapi/service/authorization.py index 5403b4bf6..9ea72c402 100644 --- a/src/blueapi/service/authorization.py +++ b/src/blueapi/service/authorization.py @@ -42,9 +42,7 @@ async def check(self, endpoint: str, data: Mapping[str, Any]): raise async def require_tiled_service_account(self, token: str): - await self.check( - self._conf.tiled_service_account_check, {"token": token} - ) + await self.check(self._conf.tiled_service_account_check, {"token": token}) async def submit_plan_check(self, token: str, instrument_session: str): if not (match := INSTRUMENT_SESSION_RE.match(instrument_session)): diff --git a/src/blueapi/service/main.py b/src/blueapi/service/main.py index 5637f0683..25b0ab47a 100644 --- a/src/blueapi/service/main.py +++ b/src/blueapi/service/main.py @@ -4,7 +4,6 @@ from contextlib import asynccontextmanager from typing import Annotated, Any, cast -from fastapi.security.utils import get_authorization_scheme_param import jwt from fastapi import ( APIRouter, @@ -20,7 +19,7 @@ from fastapi.datastructures import Address from fastapi.middleware.cors import CORSMiddleware from fastapi.responses import RedirectResponse, StreamingResponse -from fastapi.security import OAuth2AuthorizationCodeBearer +from fastapi.security.utils import get_authorization_scheme_param from observability_utils.tracing import ( add_span_attributes, get_tracer, @@ -42,6 +41,7 @@ from blueapi.worker import TrackableTask, WorkerState from blueapi.worker.event import TaskStatusEnum +from .authorization import OpaClient, OpaUserClient from .model import ( DeviceModel, DeviceResponse, @@ -58,7 +58,6 @@ TasksListResponse, WorkerTask, ) -from .authorization import OpaClient, OpaUserClient from .runner import WorkerDispatcher RUNNER: WorkerDispatcher | None = None @@ -181,8 +180,10 @@ def inner(request: Request, access_token: Annotated[str, Depends(bearer_token)]) async def opa( request: Request, token: Annotated[str, Depends(bearer_token)] ) -> OpaUserClient | None: - if client := cast(OpaClient | None, getattr(request.app.state, "authz", None)): + if client := cast(OpaClient, getattr(request.app.state, "authz", None)): return client.for_token(token) + return None + async def submit_permission( task_request: Annotated[TaskRequest, Body()],