45f3cefbc5
Hoist control-plane auth provisioning out of the per-backend launchers into one shared contract, parameterized per trust domain (#476). Every blocking finding in PR #471 was the same integration-bug class: each launcher re-derived, by hand, how to generate the signing key, scope it to the orchestrator, mint the gateway JWT, and keep the host key canonical. Introduces `trust_domain.py`: * `TrustDomain` — one credential boundary (host-canonical key file + role set + env vars). `mint`/`verify` are scoped to the domain's roles, so a future host-controller domain (#468) uses its own key/verifier/roles rather than a `host` role on the control plane's frozenset (which the orchestrator key could then forge). * `ControlPlaneProvisioning` — the single seam answering the four invariants: host-canonical key, split key-vs-token credential, CLI token valid across co-running backends, and fail-closed (no open mode) for any co-located topology. * `Topology` — the backend declares what it is; the default is co-located + fail-closed, so a backend need not redeclare it. The `Orchestrator` ABC gets `control_plane_key()` (fail-closed) and routes `mint_gateway_token()` through the contract; docker/macOS/firecracker orchestrators, the server (verify), and the host CLI client (mint cli) all go through the domain instead of reading the host key directly. `orchestrator_auth` gains an optional `roles=` arg (default unchanged) so a domain scopes its own role set; `paths.host_signing_key(filename)` generalizes host_orchestrator_token. Adds unit coverage for the domain boundary + provisioning invariants and a PRD capturing the durable rationale. No change to the auth primitive's HMAC, the plane split, or the server's documented open-mode fallback. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Closes #476
108 lines
4.4 KiB
Python
108 lines
4.4 KiB
Python
"""Unit: role-scoped control-plane tokens (issue #469 review)."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import base64
|
|
import json
|
|
import unittest
|
|
|
|
from bot_bottle.orchestrator_auth import ROLE_CLI, ROLE_GATEWAY, ROLES, mint, verify
|
|
|
|
_KEY = "test-key"
|
|
|
|
|
|
def _b64(obj: object) -> str:
|
|
return base64.urlsafe_b64encode(
|
|
json.dumps(obj).encode()).rstrip(b"=").decode("ascii")
|
|
|
|
|
|
class TestMintVerify(unittest.TestCase):
|
|
def test_round_trip_each_role(self) -> None:
|
|
for role in ROLES:
|
|
self.assertEqual(role, verify(mint(role, _KEY), _KEY))
|
|
|
|
def test_gateway_and_cli_are_distinct(self) -> None:
|
|
self.assertEqual(ROLE_GATEWAY, verify(mint(ROLE_GATEWAY, _KEY), _KEY))
|
|
self.assertEqual(ROLE_CLI, verify(mint(ROLE_CLI, _KEY), _KEY))
|
|
|
|
def test_wrong_key_rejected(self) -> None:
|
|
self.assertIsNone(verify(mint(ROLE_GATEWAY, _KEY), "other-key"))
|
|
|
|
def test_tampered_signature_rejected(self) -> None:
|
|
tok = mint(ROLE_CLI, _KEY)
|
|
self.assertIsNone(verify(tok[:-1] + ("A" if tok[-1] != "A" else "B"), _KEY))
|
|
|
|
def test_tampered_payload_rejected(self) -> None:
|
|
header, _payload, sig = mint(ROLE_GATEWAY, _KEY).split(".")
|
|
forged = f"{header}.{_b64({'role': 'cli'})}.{sig}"
|
|
self.assertIsNone(verify(forged, _KEY))
|
|
|
|
def test_alg_none_rejected(self) -> None:
|
|
# An unsigned "alg: none" token must never verify.
|
|
tok = f"{_b64({'alg': 'none', 'typ': 'JWT'})}.{_b64({'role': 'cli'})}."
|
|
self.assertIsNone(verify(tok, _KEY))
|
|
|
|
def test_validly_signed_but_wrong_alg_rejected(self) -> None:
|
|
# Alg-confusion: even a *correctly signed* token whose header claims a
|
|
# non-HS256 alg must be rejected.
|
|
from bot_bottle.orchestrator_auth import _sign # noqa: PLC0415
|
|
signing_input = f"{_b64({'alg': 'none', 'typ': 'JWT'})}.{_b64({'role': 'cli'})}"
|
|
self.assertIsNone(verify(f"{signing_input}.{_sign(_KEY, signing_input)}", _KEY))
|
|
|
|
def test_validly_signed_but_undecodable_rejected(self) -> None:
|
|
# A correct signature over a header that isn't valid base64/JSON still
|
|
# fails closed rather than raising.
|
|
from bot_bottle.orchestrator_auth import _sign # noqa: PLC0415
|
|
signing_input = f"!!!not-base64!!!.{_b64({'role': 'cli'})}"
|
|
self.assertIsNone(verify(f"{signing_input}.{_sign(_KEY, signing_input)}", _KEY))
|
|
|
|
def test_malformed_tokens_rejected(self) -> None:
|
|
for bad in ("", "a", "a.b", "a.b.c.d", "not-base64.$$.$$"):
|
|
self.assertIsNone(verify(bad, _KEY))
|
|
|
|
def test_empty_key_never_verifies(self) -> None:
|
|
self.assertIsNone(verify(mint(ROLE_CLI, _KEY), ""))
|
|
|
|
def test_unknown_role_in_payload_rejected(self) -> None:
|
|
header, _p, _s = mint(ROLE_CLI, _KEY).split(".")
|
|
# Re-sign a token carrying an unknown role — a valid signature but a
|
|
# role the control plane doesn't recognise must still be rejected.
|
|
from bot_bottle.orchestrator_auth import _sign # noqa: PLC0415
|
|
payload = _b64({"role": "root"})
|
|
signing_input = f"{header}.{payload}"
|
|
forged = f"{signing_input}.{_sign(_KEY, signing_input)}"
|
|
self.assertIsNone(verify(forged, _KEY))
|
|
|
|
def test_mint_rejects_unknown_role(self) -> None:
|
|
with self.assertRaises(ValueError):
|
|
mint("root", _KEY)
|
|
|
|
def test_mint_rejects_empty_key(self) -> None:
|
|
with self.assertRaises(ValueError):
|
|
mint(ROLE_GATEWAY, "")
|
|
|
|
|
|
class TestCustomRoleSet(unittest.TestCase):
|
|
"""The `roles=` seam a trust domain other than the control plane uses (#476):
|
|
mint/verify are scoped to the passed role set, not the module default."""
|
|
|
|
_ROLES = frozenset({"host"})
|
|
|
|
def test_round_trips_a_role_in_the_custom_set(self) -> None:
|
|
tok = mint("host", _KEY, roles=self._ROLES)
|
|
self.assertEqual("host", verify(tok, _KEY, roles=self._ROLES))
|
|
|
|
def test_mint_rejects_a_role_outside_the_custom_set(self) -> None:
|
|
with self.assertRaises(ValueError):
|
|
mint(ROLE_CLI, _KEY, roles=self._ROLES)
|
|
|
|
def test_verify_rejects_a_role_outside_the_verifiers_set(self) -> None:
|
|
# A validly signed token whose role isn't in the verifier's set fails —
|
|
# this is what keeps one domain's key from asserting another's role.
|
|
tok = mint(ROLE_CLI, _KEY) # a control-plane `cli` token
|
|
self.assertIsNone(verify(tok, _KEY, roles=self._ROLES))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|