Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ca91fc4d91 | |||
| 4a607ad098 | |||
| e24b62b6b9 | |||
| a5910696a5 | |||
| c69642e568 |
@@ -89,6 +89,14 @@ class MacosContainerBottleBackend(
|
|||||||
with _launch.launch(plan, provision=self.provision) as bottle:
|
with _launch.launch(plan, provision=self.provision) as bottle:
|
||||||
yield bottle
|
yield bottle
|
||||||
|
|
||||||
|
def ensure_orchestrator(self) -> str:
|
||||||
|
"""Bring up the per-host infra container (control plane + gateway) and
|
||||||
|
return its control-plane URL — the on-demand entry point operator tools
|
||||||
|
(`supervise`) call when no control plane is running yet. Mirrors
|
||||||
|
firecracker's infra-VM bring-up."""
|
||||||
|
from .infra import MacosInfraService
|
||||||
|
return MacosInfraService().ensure_running().control_plane_url
|
||||||
|
|
||||||
def prepare_cleanup(self) -> MacosContainerBottleCleanupPlan:
|
def prepare_cleanup(self) -> MacosContainerBottleCleanupPlan:
|
||||||
return _cleanup.prepare_cleanup()
|
return _cleanup.prepare_cleanup()
|
||||||
|
|
||||||
|
|||||||
@@ -52,6 +52,7 @@ class MacosContainerBottle(Bottle):
|
|||||||
terminal_title: str = "",
|
terminal_title: str = "",
|
||||||
terminal_color: str = "",
|
terminal_color: str = "",
|
||||||
agent_workdir: str = "/home/node",
|
agent_workdir: str = "/home/node",
|
||||||
|
exec_env: dict[str, str] | None = None,
|
||||||
):
|
):
|
||||||
self.name = container
|
self.name = container
|
||||||
self._teardown = teardown
|
self._teardown = teardown
|
||||||
@@ -62,6 +63,15 @@ class MacosContainerBottle(Bottle):
|
|||||||
self.terminal_color = terminal_color
|
self.terminal_color = terminal_color
|
||||||
self.agent_provider_template = agent_provider_template
|
self.agent_provider_template = agent_provider_template
|
||||||
self.agent_workdir = agent_workdir
|
self.agent_workdir = agent_workdir
|
||||||
|
# Env applied to the agent process at `container exec` time, on top of
|
||||||
|
# what the container was run with. This is how the identity token
|
||||||
|
# reaches the agent (PRD 0070): registration mints it *after* the
|
||||||
|
# container exists — its source IP is the registration key and Apple
|
||||||
|
# Container assigns that by DHCP — so it cannot be in the run-time env
|
||||||
|
# the way docker's compose spec does it. `container exec --env` wins
|
||||||
|
# over the run-time value, so the token-bearing proxy URL set here
|
||||||
|
# supersedes the token-less one baked in at launch.
|
||||||
|
self._exec_env = dict(exec_env or {})
|
||||||
self._closed = False
|
self._closed = False
|
||||||
|
|
||||||
def agent_argv(self, argv: list[str], *, tty: bool = True) -> list[str]:
|
def agent_argv(self, argv: list[str], *, tty: bool = True) -> list[str]:
|
||||||
@@ -74,6 +84,12 @@ class MacosContainerBottle(Bottle):
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
container_exec = ["container", "exec"]
|
container_exec = ["container", "exec"]
|
||||||
|
# Bare env names, same rule as the terminal hints below: the value
|
||||||
|
# stays in the child env `exec_agent` builds and never reaches argv —
|
||||||
|
# the proxy URL here carries the identity token, which `ps` would
|
||||||
|
# otherwise expose to every process on the host.
|
||||||
|
for name in sorted(self._exec_env):
|
||||||
|
container_exec.extend(["--env", name])
|
||||||
if tty:
|
if tty:
|
||||||
container_exec.extend(["--interactive", "--tty"])
|
container_exec.extend(["--interactive", "--tty"])
|
||||||
# Forward terminal capability hints so TUIs can enable modified-key
|
# Forward terminal capability hints so TUIs can enable modified-key
|
||||||
@@ -94,21 +110,33 @@ class MacosContainerBottle(Bottle):
|
|||||||
|
|
||||||
def exec_agent(self, argv: list[str], *, tty: bool = True) -> int:
|
def exec_agent(self, argv: list[str], *, tty: bool = True) -> int:
|
||||||
agent_argv = self.agent_argv(argv, tty=tty)
|
agent_argv = self.agent_argv(argv, tty=tty)
|
||||||
|
# The values behind the bare `--env` names in `agent_argv`. `sh -lc`
|
||||||
|
# below is in this process tree, so the child env reaches `container
|
||||||
|
# exec` either way.
|
||||||
|
env = {**os.environ, **self._exec_env} if self._exec_env else None
|
||||||
script = (
|
script = (
|
||||||
exec_shell_script(agent_argv, self.terminal_title, self.terminal_color)
|
exec_shell_script(agent_argv, self.terminal_title, self.terminal_color)
|
||||||
if tty else None
|
if tty else None
|
||||||
)
|
)
|
||||||
if script is None:
|
if script is None:
|
||||||
return subprocess.run(agent_argv, check=False).returncode
|
return subprocess.run(agent_argv, env=env, check=False).returncode
|
||||||
return subprocess.run(["sh", "-lc", script], check=False).returncode
|
return subprocess.run(["sh", "-lc", script], env=env, check=False).returncode
|
||||||
|
|
||||||
def exec(self, script: str, *, user: str = "node") -> ExecResult:
|
def exec(self, script: str, *, user: str = "node") -> ExecResult:
|
||||||
|
# Carry the same exec env the agent gets: provisioning steps run
|
||||||
|
# through here, and a provider whose provision step fetches anything
|
||||||
|
# would egress without the identity token and be denied by /resolve.
|
||||||
|
# Bare `--env NAME` again, so the token stays off argv.
|
||||||
|
argv = ["container", "exec", "--user", user, "--interactive"]
|
||||||
|
for name in sorted(self._exec_env):
|
||||||
|
argv.extend(["--env", name])
|
||||||
|
argv.extend([self.name, "sh", "-s"])
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["container", "exec", "--user", user, "--interactive",
|
argv,
|
||||||
self.name, "sh", "-s"],
|
|
||||||
input=script,
|
input=script,
|
||||||
capture_output=True,
|
capture_output=True,
|
||||||
text=True,
|
text=True,
|
||||||
|
env={**os.environ, **self._exec_env} if self._exec_env else None,
|
||||||
check=False,
|
check=False,
|
||||||
)
|
)
|
||||||
return ExecResult(
|
return ExecResult(
|
||||||
|
|||||||
@@ -13,9 +13,13 @@ from .. import BottlePlan
|
|||||||
class MacosContainerBottlePlan(BottlePlan):
|
class MacosContainerBottlePlan(BottlePlan):
|
||||||
slug: str
|
slug: str
|
||||||
forwarded_env: dict[str, str] = field(repr=False)
|
forwarded_env: dict[str, str] = field(repr=False)
|
||||||
agent_proxy_url: str = ""
|
|
||||||
agent_git_gate_url: str = ""
|
agent_git_gate_url: str = ""
|
||||||
agent_supervise_url: str = ""
|
agent_supervise_url: str = ""
|
||||||
|
# Read by provision-time consumers (git extraHeader, supervise MCP header)
|
||||||
|
# via getattr(plan, "identity_token", ""); stamped in launch after the
|
||||||
|
# bottle is registered. See launch.py's stamp for why it lives here and not
|
||||||
|
# only in the exec-time proxy env.
|
||||||
|
identity_token: str = ""
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def container_name(self) -> str:
|
def container_name(self) -> str:
|
||||||
|
|||||||
@@ -0,0 +1,144 @@
|
|||||||
|
"""Consolidated bottle launch sequence for the macOS backend (PRD 0070).
|
||||||
|
|
||||||
|
The docker backend allocates a free address, pins the agent to it with
|
||||||
|
`--ip`, registers it, *then* starts the agent — registration precedes launch
|
||||||
|
because the pinned address is known up front.
|
||||||
|
|
||||||
|
**Apple Container 1.0.0 has no `--ip`.** The `--network` flag takes only
|
||||||
|
`<name>[,mac=…][,mtu=…]`; the address is assigned by vmnet's DHCP and is
|
||||||
|
knowable only once the container is running. So the macOS order inverts:
|
||||||
|
|
||||||
|
ensure_gateway() -> caller starts the agent -> register_agent(source_ip)
|
||||||
|
|
||||||
|
That is why this module exposes two functions where docker has one — the
|
||||||
|
caller has to start the agent in between. `ensure_gateway` runs first because
|
||||||
|
the agent's proxy env needs the gateway's address at `container run` time; the
|
||||||
|
agent's *own* address (the attribution key) only exists afterwards.
|
||||||
|
|
||||||
|
The control plane and the gateway are one **infra container** here (see
|
||||||
|
`infra`), so `gateway_ip` and the control-plane host are the same address.
|
||||||
|
|
||||||
|
The consequence for the identity token: it is minted by registration, i.e.
|
||||||
|
*after* the agent container exists, so it cannot be baked into the run-time
|
||||||
|
env the way docker's compose spec does. It is delivered at `container exec`
|
||||||
|
time instead — see `bottle.MacosContainerBottle`.
|
||||||
|
|
||||||
|
That delivery is load-bearing, not a nicety: `/resolve` requires a matching
|
||||||
|
`(source_ip, identity_token)` pair and fail-closes with no source-IP-only
|
||||||
|
fallback (#366). So egress that does not carry the token is denied — which is
|
||||||
|
the safe direction, and is why the agent's init process is a bare `sleep` and
|
||||||
|
every real command arrives through `container exec`.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
from ...egress import EgressPlan
|
||||||
|
from ...git_gate import GitGatePlan
|
||||||
|
from ...orchestrator.client import OrchestratorClient
|
||||||
|
from ...orchestrator.registration import registration_inputs
|
||||||
|
from ..docker.gateway_provision import deprovision_git_gate, provision_git_gate
|
||||||
|
from .gateway import GATEWAY_NETWORK
|
||||||
|
from .gateway_provision import AppleGatewayTransport
|
||||||
|
from .infra import MacosInfraService, OrchestratorStartError
|
||||||
|
|
||||||
|
|
||||||
|
class ConsolidatedLaunchError(RuntimeError):
|
||||||
|
"""The consolidated register/provision sequence could not complete."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class GatewayEndpoint:
|
||||||
|
"""What the agent `container run` needs to reach the shared gateway (the
|
||||||
|
infra container). `gateway_ip` is that container's host-only address, the
|
||||||
|
same host the control-plane URL points at."""
|
||||||
|
|
||||||
|
orchestrator_url: str
|
||||||
|
gateway_ip: str # the gateway's address — the agent's proxy target
|
||||||
|
gateway_ca_pem: str # the shared CA the provisioner installs
|
||||||
|
network: str # the shared host-only network to attach to
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class LaunchContext:
|
||||||
|
"""What the running agent needs once it has been registered."""
|
||||||
|
|
||||||
|
bottle_id: str
|
||||||
|
identity_token: str
|
||||||
|
source_ip: str # the agent's DHCP-assigned address (attribution key)
|
||||||
|
gateway_ip: str
|
||||||
|
network: str
|
||||||
|
orchestrator_url: str
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_gateway(
|
||||||
|
*, service: MacosInfraService | None = None,
|
||||||
|
) -> GatewayEndpoint:
|
||||||
|
"""Ensure the per-host infra container (control plane + gateway) is up and
|
||||||
|
report how to reach it. Idempotent — one singleton, so N bottle launches
|
||||||
|
share it. Call before starting the agent container: the agent's proxy env
|
||||||
|
needs `gateway_ip` at run time."""
|
||||||
|
service = service or MacosInfraService()
|
||||||
|
infra = service.ensure_running()
|
||||||
|
return GatewayEndpoint(
|
||||||
|
orchestrator_url=infra.control_plane_url,
|
||||||
|
gateway_ip=infra.gateway_ip,
|
||||||
|
gateway_ca_pem=service.ca_cert_pem(),
|
||||||
|
network=service.network,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def register_agent(
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
*,
|
||||||
|
source_ip: str,
|
||||||
|
endpoint: GatewayEndpoint,
|
||||||
|
image_ref: str = "",
|
||||||
|
tokens: dict[str, str] | None = None,
|
||||||
|
) -> LaunchContext:
|
||||||
|
"""Register the (already running) agent by its address and provision its
|
||||||
|
git-gate state into the gateway. `source_ip` must be read from the live
|
||||||
|
container — it is the attribution key the gateway resolves policy by.
|
||||||
|
Raises on failure; the caller tears down."""
|
||||||
|
client = OrchestratorClient(endpoint.orchestrator_url)
|
||||||
|
inputs = registration_inputs(egress_plan)
|
||||||
|
reg = client.register_bottle(
|
||||||
|
source_ip, image_ref=image_ref, policy=inputs.policy,
|
||||||
|
metadata=inputs.metadata, tokens=tokens,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
provision_git_gate(AppleGatewayTransport(), reg.bottle_id, git_gate_plan)
|
||||||
|
except Exception:
|
||||||
|
# Roll the registration back so a provisioning failure leaves no orphan.
|
||||||
|
client.teardown_bottle(reg.bottle_id)
|
||||||
|
raise
|
||||||
|
return LaunchContext(
|
||||||
|
bottle_id=reg.bottle_id,
|
||||||
|
identity_token=reg.identity_token,
|
||||||
|
source_ip=source_ip,
|
||||||
|
gateway_ip=endpoint.gateway_ip,
|
||||||
|
network=endpoint.network,
|
||||||
|
orchestrator_url=endpoint.orchestrator_url,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def teardown_consolidated(bottle_id: str, *, orchestrator_url: str) -> None:
|
||||||
|
"""Deregister the bottle and remove its git-gate state from the gateway.
|
||||||
|
Both steps are idempotent so this is safe from a cleanup trap. Does NOT
|
||||||
|
stop the gateway — it's a persistent per-host singleton."""
|
||||||
|
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
||||||
|
deprovision_git_gate(AppleGatewayTransport(), bottle_id)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"GatewayEndpoint",
|
||||||
|
"LaunchContext",
|
||||||
|
"ensure_gateway",
|
||||||
|
"register_agent",
|
||||||
|
"teardown_consolidated",
|
||||||
|
"ConsolidatedLaunchError",
|
||||||
|
"OrchestratorStartError",
|
||||||
|
"GATEWAY_NETWORK",
|
||||||
|
]
|
||||||
@@ -1,9 +1,11 @@
|
|||||||
"""Host-side egress route-apply for the macos-container backend.
|
"""Host-side egress route-apply for the macos-container backend.
|
||||||
|
|
||||||
The per-bottle companion container this used to signal (`container kill
|
The per-bottle companion container this used to signal (`container kill
|
||||||
--signal HUP <container>`) was removed in the companion-container removal (#385),
|
--signal HUP <container>`) was removed in the companion-container removal
|
||||||
along with the disabled macOS launch path. Fails closed until the macOS
|
(#385). In the consolidated model the shared gateway resolves egress policy
|
||||||
backend grows the consolidated gateway.
|
per-request against the orchestrator rather than reloading a per-bottle routes
|
||||||
|
file, so the live per-bottle reload is not supported here and fails closed
|
||||||
|
until the gateway-side apply lands — same posture as the docker backend.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -16,8 +18,8 @@ class MacOSContainerEgressApplicator(EgressApplicator):
|
|||||||
del slug
|
del slug
|
||||||
raise EgressApplyError(
|
raise EgressApplyError(
|
||||||
"live egress route-apply was removed with the per-bottle "
|
"live egress route-apply was removed with the per-bottle "
|
||||||
"companion container (#385); the macos-container backend is "
|
"companion container (#385); route changes will flow through "
|
||||||
"disabled until it uses the consolidated gateway."
|
"the consolidated gateway in a follow-up."
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +1,42 @@
|
|||||||
"""Active-agent enumeration for the macOS Apple Container backend.
|
"""Active-agent enumeration for the macOS Apple Container backend."""
|
||||||
|
|
||||||
The backend is disabled during the companion-container removal (#385) — it can't
|
|
||||||
launch bottles, so there are none to enumerate. Enumeration returns when
|
|
||||||
the backend grows the consolidated gateway.
|
|
||||||
"""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from ...bottle_state import read_metadata
|
||||||
from .. import ActiveAgent
|
from .. import ActiveAgent
|
||||||
|
from .infra import INFRA_NAME
|
||||||
|
|
||||||
|
_PREFIX = "bot-bottle-"
|
||||||
|
# The shared per-host infra container carries the same prefix as agent
|
||||||
|
# containers but is infrastructure, not a bottle — one control plane + gateway
|
||||||
|
# serves every agent, so listing it as an agent would invent one per host.
|
||||||
|
_INFRA_NAMES = frozenset({INFRA_NAME})
|
||||||
|
|
||||||
|
|
||||||
def enumerate_active() -> list[ActiveAgent]:
|
def enumerate_active() -> list[ActiveAgent]:
|
||||||
return []
|
result = subprocess.run(
|
||||||
|
["container", "list", "--quiet"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return []
|
||||||
|
out: list[ActiveAgent] = []
|
||||||
|
for name in sorted(line.strip() for line in result.stdout.splitlines()):
|
||||||
|
if not name.startswith(_PREFIX) or name in _INFRA_NAMES:
|
||||||
|
continue
|
||||||
|
slug = name[len(_PREFIX):]
|
||||||
|
metadata = read_metadata(slug)
|
||||||
|
out.append(ActiveAgent(
|
||||||
|
backend_name="macos-container",
|
||||||
|
slug=slug,
|
||||||
|
agent_name=metadata.agent_name if metadata else "?",
|
||||||
|
started_at=metadata.started_at if metadata else "",
|
||||||
|
services=(),
|
||||||
|
label=metadata.label if metadata else "",
|
||||||
|
color=metadata.color if metadata else "",
|
||||||
|
))
|
||||||
|
return out
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
"""Shared network/image constants for the macOS consolidated infra container.
|
||||||
|
|
||||||
|
The gateway data plane no longer runs as its own Apple container — it shares a
|
||||||
|
single per-host **infra container** with the control plane (see `infra`),
|
||||||
|
because two Apple-Container guests writing one `bot-bottle.db` over virtiofs
|
||||||
|
would race incoherent `fcntl` locks. This module holds the pieces both the
|
||||||
|
infra service and the launch/provision glue need: the network names, the
|
||||||
|
gateway image, and the network-creation helper.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
|
from ...orchestrator.gateway import GatewayError
|
||||||
|
from . import util as container_mod
|
||||||
|
|
||||||
|
# The shared host-only network the infra container and every agent bottle sit
|
||||||
|
# on. The agent's address here is the attribution key. Distinct from the docker
|
||||||
|
# names so both backends can coexist on one host.
|
||||||
|
GATEWAY_NETWORK = "bot-bottle-mac-gateway"
|
||||||
|
# The NAT network that gives the infra container (and only it) a route out.
|
||||||
|
GATEWAY_EGRESS_NETWORK = "bot-bottle-mac-egress"
|
||||||
|
|
||||||
|
GATEWAY_IMAGE = os.environ.get("BOT_BOTTLE_GATEWAY_IMAGE", "bot-bottle-gateway:latest")
|
||||||
|
|
||||||
|
DEFAULT_CA_TIMEOUT_SECONDS = 30.0
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_networks(
|
||||||
|
network: str = GATEWAY_NETWORK, egress_network: str = GATEWAY_EGRESS_NETWORK,
|
||||||
|
) -> None:
|
||||||
|
"""Create the shared host-only network + the NAT egress network. Idempotent
|
||||||
|
— `create_network` tolerates 'already exists'."""
|
||||||
|
container_mod.create_network(egress_network)
|
||||||
|
container_mod.create_network(network, internal=True)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"GATEWAY_NETWORK",
|
||||||
|
"GATEWAY_EGRESS_NETWORK",
|
||||||
|
"GATEWAY_IMAGE",
|
||||||
|
"GatewayError",
|
||||||
|
"DEFAULT_CA_TIMEOUT_SECONDS",
|
||||||
|
"ensure_networks",
|
||||||
|
]
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
"""`GatewayTransport` for the Apple infra container (PRD 0070).
|
||||||
|
|
||||||
|
The provisioning *logic* (per-bottle creds dirs, namespaced repo init) is
|
||||||
|
backend-neutral and lives in `backend.docker.gateway_provision`; this is only
|
||||||
|
the transport — how files and commands reach the running gateway. Docker uses
|
||||||
|
`docker exec`/`docker cp` and Firecracker uses SSH; Apple uses the `container`
|
||||||
|
CLI's equivalents against the infra container that hosts the gateway daemons.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from ..docker.gateway_provision import GatewayProvisionError
|
||||||
|
from . import util as container_mod
|
||||||
|
from .infra import INFRA_NAME
|
||||||
|
|
||||||
|
|
||||||
|
class AppleGatewayTransport:
|
||||||
|
"""`GatewayTransport` for the gateway daemons in the Apple infra container."""
|
||||||
|
|
||||||
|
def __init__(self, gateway: str = INFRA_NAME) -> None:
|
||||||
|
self.gateway = gateway
|
||||||
|
|
||||||
|
def exec(self, argv: list[str]) -> None:
|
||||||
|
result = container_mod.run_container_argv(
|
||||||
|
["container", "exec", self.gateway, *argv]
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
raise GatewayProvisionError(
|
||||||
|
f"gateway exec {argv!r} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
def cp_into(self, src: str, dest: str) -> None:
|
||||||
|
result = container_mod.run_container_argv(
|
||||||
|
["container", "cp", src, f"{self.gateway}:{dest}"]
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
raise GatewayProvisionError(
|
||||||
|
f"gateway cp {src} -> {dest} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["AppleGatewayTransport", "GatewayProvisionError"]
|
||||||
@@ -0,0 +1,305 @@
|
|||||||
|
"""The per-host infra container for the macOS backend (PRD 0070).
|
||||||
|
|
||||||
|
A single persistent Apple container that runs BOTH the orchestrator control
|
||||||
|
plane and the gateway data plane — the macOS analogue of the Firecracker infra
|
||||||
|
VM (`backend/firecracker/infra_vm.py`), not the docker backend's two separate
|
||||||
|
containers.
|
||||||
|
|
||||||
|
Why one container, not two: Apple Containers are lightweight VMs, each with its
|
||||||
|
own kernel. The docker backend runs the orchestrator and gateway as two
|
||||||
|
containers safely because they share the host kernel, so their concurrent
|
||||||
|
writes to the one `bot-bottle.db` (the orchestrator's registry + the gateway
|
||||||
|
supervise daemon's queue) are serialized by coherent `fcntl` locks. Across two
|
||||||
|
*guest* kernels sharing a virtiofs-mounted DB those locks are not coherent, and
|
||||||
|
concurrent writers can corrupt the file. Firecracker solved this by putting
|
||||||
|
both services in one guest with the DB on a device only that guest mounts; this
|
||||||
|
does the same with Apple primitives.
|
||||||
|
|
||||||
|
Two consequences fall out of the single container, both simplifications:
|
||||||
|
|
||||||
|
- **No DNS dance.** The control plane and the gateway daemons reach each other
|
||||||
|
over `127.0.0.1`, so nothing depends on Apple's (absent) container DNS and
|
||||||
|
there is no orchestrator-before-gateway ordering to get right.
|
||||||
|
- **The DB is never host-shared.** It lives on a container-only volume, so no
|
||||||
|
host process opens the live file. The host CLI reaches registry + supervise
|
||||||
|
state through the control-plane HTTP surface (`cli/supervise.py` already uses
|
||||||
|
`OrchestratorClient`), exactly as it does for firecracker.
|
||||||
|
|
||||||
|
The control-plane source is bind-mounted (like the docker orchestrator), so a
|
||||||
|
code change takes effect on the next launch without an image rebuild; the
|
||||||
|
gateway daemons are baked in the gateway image and rebuild through its own
|
||||||
|
digest check.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import time
|
||||||
|
import urllib.error
|
||||||
|
import urllib.request
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ... import log
|
||||||
|
from ...orchestrator.gateway import GATEWAY_CA_CERT
|
||||||
|
from ...orchestrator.lifecycle import (
|
||||||
|
DEFAULT_PORT,
|
||||||
|
DEFAULT_STARTUP_TIMEOUT_SECONDS,
|
||||||
|
OrchestratorStartError,
|
||||||
|
source_hash,
|
||||||
|
)
|
||||||
|
from ...paths import (
|
||||||
|
CONTROL_PLANE_TOKEN_ENV,
|
||||||
|
HOST_DB_FILENAME,
|
||||||
|
host_control_plane_token,
|
||||||
|
)
|
||||||
|
from . import util as container_mod
|
||||||
|
from .gateway import (
|
||||||
|
DEFAULT_CA_TIMEOUT_SECONDS,
|
||||||
|
GATEWAY_EGRESS_NETWORK,
|
||||||
|
GATEWAY_IMAGE,
|
||||||
|
GATEWAY_NETWORK,
|
||||||
|
GatewayError,
|
||||||
|
ensure_networks,
|
||||||
|
)
|
||||||
|
|
||||||
|
# The one per-host infra container: control plane + gateway data plane.
|
||||||
|
INFRA_NAME = "bot-bottle-mac-infra"
|
||||||
|
INFRA_LABEL = "bot-bottle-mac-infra=1"
|
||||||
|
# Container-only volume holding bot-bottle.db. No host bind-mount, so the DB is
|
||||||
|
# written by exactly one kernel (this container's). Survives recreation.
|
||||||
|
INFRA_DB_VOLUME = "bot-bottle-mac-db"
|
||||||
|
|
||||||
|
# BOT_BOTTLE_ROOT inside the container; host_db_path() resolves the DB to
|
||||||
|
# <root>/db/<filename> and the supervise daemon writes the same file.
|
||||||
|
_DB_ROOT_IN_CONTAINER = "/var/lib/bot-bottle"
|
||||||
|
_DB_PATH_IN_CONTAINER = f"{_DB_ROOT_IN_CONTAINER}/db/{HOST_DB_FILENAME}"
|
||||||
|
_SRC_IN_CONTAINER = "/bot-bottle-src"
|
||||||
|
|
||||||
|
_REPO_ROOT = Path(__file__).resolve().parents[3]
|
||||||
|
|
||||||
|
_HEALTH_POLL_SECONDS = 0.25
|
||||||
|
_HEALTH_REQUEST_TIMEOUT_SECONDS = 1.0
|
||||||
|
_CA_POLL_SECONDS = 0.5
|
||||||
|
|
||||||
|
# The gateway subset the consolidated model runs (no per-bottle git:// daemon).
|
||||||
|
_GATEWAY_DAEMONS = "egress,git-http,supervise"
|
||||||
|
|
||||||
|
|
||||||
|
def _init_script(port: int) -> str:
|
||||||
|
"""PID-1 init: start the control plane and the gateway daemons, both in
|
||||||
|
this container, reaching each other over loopback. Backgrounded so `wait`
|
||||||
|
reaps as PID 1. No `set -e` — a transient daemon failure must not kill the
|
||||||
|
whole container (gateway_init applies the same 'stay up' policy)."""
|
||||||
|
return (
|
||||||
|
"export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\n"
|
||||||
|
f"mkdir -p $(dirname {_DB_PATH_IN_CONTAINER})\n"
|
||||||
|
# Control plane, from the bind-mounted source (stdlib-only package).
|
||||||
|
f"( cd {_SRC_IN_CONTAINER} && BOT_BOTTLE_ROOT={_DB_ROOT_IN_CONTAINER} "
|
||||||
|
f"python3 -m bot_bottle.orchestrator --host 0.0.0.0 --port {port} "
|
||||||
|
"--broker stub ) &\n"
|
||||||
|
# Gateway data plane, multi-tenant against the local control plane.
|
||||||
|
f"( cd /app && BOT_BOTTLE_GATEWAY_DAEMONS={_GATEWAY_DAEMONS} "
|
||||||
|
f"BOT_BOTTLE_ORCHESTRATOR_URL=http://127.0.0.1:{port} "
|
||||||
|
f"SUPERVISE_DB_PATH={_DB_PATH_IN_CONTAINER} python3 /app/gateway_init.py ) &\n"
|
||||||
|
"while : ; do wait ; done\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class InfraEndpoint:
|
||||||
|
"""How to reach the running infra container. The control plane and the
|
||||||
|
gateway are the same container, so one address serves both."""
|
||||||
|
|
||||||
|
control_plane_url: str # http://<infra ip>:8099 — host CLI + registration
|
||||||
|
gateway_ip: str # same container; agents' proxy / git-http / MCP target
|
||||||
|
|
||||||
|
|
||||||
|
class MacosInfraService:
|
||||||
|
"""Manages the single per-host infra container. Callers use
|
||||||
|
`ensure_running()` (returns the endpoint) and `ca_cert_pem()`."""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
port: int = DEFAULT_PORT,
|
||||||
|
network: str = GATEWAY_NETWORK,
|
||||||
|
egress_network: str = GATEWAY_EGRESS_NETWORK,
|
||||||
|
image: str = GATEWAY_IMAGE,
|
||||||
|
repo_root: Path = _REPO_ROOT,
|
||||||
|
name: str = INFRA_NAME,
|
||||||
|
db_volume: str = INFRA_DB_VOLUME,
|
||||||
|
) -> None:
|
||||||
|
self.port = port
|
||||||
|
self.network = network
|
||||||
|
self.egress_network = egress_network
|
||||||
|
self.image = image
|
||||||
|
self._repo_root = repo_root
|
||||||
|
self._name = name
|
||||||
|
self._db_volume = db_volume
|
||||||
|
|
||||||
|
def _resolve_url(self) -> str:
|
||||||
|
"""The control-plane URL, or "" while the container has no address."""
|
||||||
|
ip = container_mod.try_container_ipv4_on_network(self._name, self.network)
|
||||||
|
return f"http://{ip}:{self.port}" if ip else ""
|
||||||
|
|
||||||
|
def is_healthy(
|
||||||
|
self, url: str, *, timeout: float = _HEALTH_REQUEST_TIMEOUT_SECONDS,
|
||||||
|
) -> bool:
|
||||||
|
if not url:
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(f"{url}/health", timeout=timeout) as resp:
|
||||||
|
return resp.status == 200
|
||||||
|
except (urllib.error.URLError, TimeoutError, OSError):
|
||||||
|
return False
|
||||||
|
|
||||||
|
def _source_current(self, current_hash: str) -> bool:
|
||||||
|
"""True iff the running infra container was created from the current
|
||||||
|
bind-mounted control-plane source. The control-plane process loads that
|
||||||
|
code at startup and won't reload it, so a stale container keeps serving
|
||||||
|
OLD code."""
|
||||||
|
if not container_mod.container_is_running(self._name):
|
||||||
|
return False
|
||||||
|
env = container_mod.container_env(self._name)
|
||||||
|
if not env:
|
||||||
|
return True # can't compare → don't churn a working container
|
||||||
|
return env.get("BOT_BOTTLE_SOURCE_HASH") == current_hash
|
||||||
|
|
||||||
|
def _running_healthy_endpoint(self, current_hash: str) -> InfraEndpoint | None:
|
||||||
|
"""The endpoint if the running container is BOTH source-current and
|
||||||
|
answering /health, else None (→ recreate). Health, not just the source
|
||||||
|
label, is what lets a wedged-but-current container self-heal instead of
|
||||||
|
being polled to death forever."""
|
||||||
|
if not self._source_current(current_hash):
|
||||||
|
return None
|
||||||
|
url = self._resolve_url()
|
||||||
|
if url and self.is_healthy(url):
|
||||||
|
return InfraEndpoint(control_plane_url=url, gateway_ip=_ip_of(url))
|
||||||
|
return None
|
||||||
|
|
||||||
|
def ensure_built(self) -> None:
|
||||||
|
"""Ensure the gateway data-plane image exists. The control-plane source
|
||||||
|
is bind-mounted, not baked, so only the gateway image needs building."""
|
||||||
|
container_mod.build_image(
|
||||||
|
self.image, str(self._repo_root), dockerfile="Dockerfile.gateway",
|
||||||
|
)
|
||||||
|
|
||||||
|
def ensure_running(
|
||||||
|
self, *, startup_timeout: float = DEFAULT_STARTUP_TIMEOUT_SECONDS,
|
||||||
|
) -> InfraEndpoint:
|
||||||
|
"""Ensure the single infra container is up; return how to reach it.
|
||||||
|
Idempotent per-host singleton — a healthy container on current source
|
||||||
|
is left untouched, so N launches share the one control plane + gateway.
|
||||||
|
Raises `OrchestratorStartError` on startup timeout."""
|
||||||
|
current_hash = source_hash(self._repo_root)
|
||||||
|
endpoint = self._running_healthy_endpoint(current_hash)
|
||||||
|
if endpoint is not None:
|
||||||
|
return endpoint
|
||||||
|
self.ensure_built()
|
||||||
|
log.info("starting infra container", context={"name": self._name})
|
||||||
|
self._run_container(current_hash)
|
||||||
|
return self._wait_healthy(startup_timeout)
|
||||||
|
|
||||||
|
def _run_container(self, current_hash: str) -> None:
|
||||||
|
ensure_networks(self.network, self.egress_network)
|
||||||
|
container_mod.force_remove_container(self._name)
|
||||||
|
argv = [
|
||||||
|
"container", "run", "--detach",
|
||||||
|
"--name", self._name,
|
||||||
|
"--label", "bot-bottle.backend=macos-container",
|
||||||
|
"--label", INFRA_LABEL,
|
||||||
|
# NAT network FIRST so the gateway's egress has a default route;
|
||||||
|
# the host-only network is where agents (and the host CLI) reach it.
|
||||||
|
"--network", self.egress_network,
|
||||||
|
"--network", self.network,
|
||||||
|
"--dns", container_mod.dns_server(),
|
||||||
|
# Container-only DB volume: one kernel writes bot-bottle.db, never
|
||||||
|
# shared with the host or another guest.
|
||||||
|
"--volume", f"{self._db_volume}:{_DB_ROOT_IN_CONTAINER}",
|
||||||
|
# Bind-mount the control-plane source (read-only); a code change
|
||||||
|
# takes effect on relaunch with no image rebuild.
|
||||||
|
"--mount",
|
||||||
|
container_mod.bind_mount_spec(
|
||||||
|
str(self._repo_root), _SRC_IN_CONTAINER, readonly=True),
|
||||||
|
# Baked onto the container so `_source_current` can detect a real
|
||||||
|
# control-plane code change and recreate.
|
||||||
|
"--env", f"BOT_BOTTLE_SOURCE_HASH={current_hash}",
|
||||||
|
# The control-plane secret, for BOTH the control plane (to require
|
||||||
|
# it) and the gateway's PolicyResolver (to present it) — they share
|
||||||
|
# this one container. Bare `--env NAME` inherits the value from the
|
||||||
|
# run process below, so the secret never lands on argv or in
|
||||||
|
# `container inspect`'s command line. The agent runs in a SEPARATE
|
||||||
|
# container that is never given this var, which is the whole point.
|
||||||
|
"--env", CONTROL_PLANE_TOKEN_ENV,
|
||||||
|
"--entrypoint", "sh",
|
||||||
|
self.image,
|
||||||
|
"-c", _init_script(self.port),
|
||||||
|
]
|
||||||
|
run_env = {**os.environ, CONTROL_PLANE_TOKEN_ENV: host_control_plane_token()}
|
||||||
|
result = container_mod.run_container_argv(argv, env=run_env)
|
||||||
|
if result.returncode != 0:
|
||||||
|
raise OrchestratorStartError(
|
||||||
|
f"infra container failed to start: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
def _wait_healthy(self, startup_timeout: float) -> InfraEndpoint:
|
||||||
|
deadline = time.monotonic() + startup_timeout
|
||||||
|
while True:
|
||||||
|
url = self._resolve_url()
|
||||||
|
if url and self.is_healthy(url):
|
||||||
|
log.info("infra container healthy", context={"url": url})
|
||||||
|
return InfraEndpoint(control_plane_url=url, gateway_ip=_ip_of(url))
|
||||||
|
if time.monotonic() >= deadline:
|
||||||
|
raise OrchestratorStartError(
|
||||||
|
f"infra container did not become healthy within "
|
||||||
|
f"{startup_timeout:g}s"
|
||||||
|
)
|
||||||
|
time.sleep(_HEALTH_POLL_SECONDS)
|
||||||
|
|
||||||
|
def ca_cert_pem(self, *, timeout: float = DEFAULT_CA_TIMEOUT_SECONDS) -> str:
|
||||||
|
"""The gateway's mitmproxy CA (PEM) agents install to trust its TLS
|
||||||
|
interception. Read out of the container (the CA lives on a
|
||||||
|
container-internal path, not a host mount); polls because mitmproxy
|
||||||
|
writes it a beat after start."""
|
||||||
|
deadline = time.monotonic() + timeout
|
||||||
|
while True:
|
||||||
|
result = container_mod.run_container_argv(
|
||||||
|
["container", "exec", self._name, "cat", GATEWAY_CA_CERT])
|
||||||
|
if result.returncode == 0 and result.stdout.strip():
|
||||||
|
return result.stdout
|
||||||
|
if time.monotonic() >= deadline:
|
||||||
|
raise GatewayError(
|
||||||
|
f"gateway CA not available in {self._name} after {timeout:g}s: "
|
||||||
|
f"{(result.stderr or '').strip() or 'empty'}"
|
||||||
|
)
|
||||||
|
time.sleep(_CA_POLL_SECONDS)
|
||||||
|
|
||||||
|
def stop(self) -> None:
|
||||||
|
"""Remove the infra container (idempotent). The DB volume persists."""
|
||||||
|
container_mod.force_remove_container(self._name)
|
||||||
|
|
||||||
|
|
||||||
|
def _ip_of(url: str) -> str:
|
||||||
|
"""The host from an http://host:port URL."""
|
||||||
|
return url.split("://", 1)[-1].rsplit(":", 1)[0]
|
||||||
|
|
||||||
|
|
||||||
|
def probe_control_plane_url(port: int = DEFAULT_PORT) -> str:
|
||||||
|
"""The running infra container's control-plane URL, or "" if it isn't up.
|
||||||
|
Used by host-side control-plane discovery (`discover_orchestrator_url`);
|
||||||
|
safe to call on any host — returns "" when the container or the `container`
|
||||||
|
CLI isn't present."""
|
||||||
|
ip = container_mod.try_container_ipv4_on_network(INFRA_NAME, GATEWAY_NETWORK)
|
||||||
|
return f"http://{ip}:{port}" if ip else ""
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"MacosInfraService",
|
||||||
|
"InfraEndpoint",
|
||||||
|
"OrchestratorStartError",
|
||||||
|
"GatewayError",
|
||||||
|
"INFRA_NAME",
|
||||||
|
"INFRA_DB_VOLUME",
|
||||||
|
]
|
||||||
@@ -1,24 +1,74 @@
|
|||||||
"""Launch flow for the macOS Apple Container backend — disabled (#385).
|
"""Launch flow for the macOS Apple Container backend (PRD 0070).
|
||||||
|
|
||||||
This backend launched a per-bottle companion container (the egress /
|
The agent container attaches to the **shared host-only gateway network** and
|
||||||
git-gate / supervise data plane) alongside the agent container, with the
|
proxies egress through the one per-host gateway, replacing the per-bottle
|
||||||
agent's proxy env pointed at the companion's host-only IP. That
|
companion container removed in #385.
|
||||||
per-bottle-companion architecture was removed in the companion-container removal;
|
|
||||||
the macOS backend will be re-enabled once it grows the consolidated
|
|
||||||
per-host gateway the docker backend already uses.
|
|
||||||
|
|
||||||
Until then, launching a macOS bottle fails closed. `prepare` / `status`
|
The order differs from docker's, forced by Apple Container 1.0.0 having no
|
||||||
/ cleanup still work.
|
`--ip` (see `consolidated_launch`): the agent is started *before* it is
|
||||||
|
registered, because its DHCP-assigned address — the attribution key — does not
|
||||||
|
exist until then.
|
||||||
|
|
||||||
|
gateway up -> run agent -> read its IP -> register it -> provision
|
||||||
|
|
||||||
|
Two things follow from that inversion:
|
||||||
|
|
||||||
|
- The **identity token** is minted by registration and so cannot be in the
|
||||||
|
agent's run-time env; it rides the proxy URL applied at `container exec`
|
||||||
|
time (`bottle.MacosContainerBottle`). `/resolve` requires it (#366), so
|
||||||
|
egress without it is denied — hence the bare `sleep` init: every real agent
|
||||||
|
command goes through exec and therefore carries the token.
|
||||||
|
- The agent is run with `--cap-drop CAP_NET_RAW`. Apple Container grants
|
||||||
|
NET_RAW by default, which would let an agent open a raw socket and forge a
|
||||||
|
neighbour's source address on the shared segment. NET_ADMIN is already
|
||||||
|
absent (the agent cannot change its own address or route), so dropping
|
||||||
|
NET_RAW is what closes the source-address half of PRD 0070's invariant:
|
||||||
|
"a packet's source address, as seen by the orchestrator, provably identifies
|
||||||
|
the originating bottle." The identity token is the other half — an attacker
|
||||||
|
would need to forge the address *and* steal the token — but the invariant is
|
||||||
|
a stated precondition of consolidation, so it is enforced on its own terms
|
||||||
|
rather than left to the token.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from contextlib import contextmanager
|
import dataclasses
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
from contextlib import ExitStack, contextmanager
|
||||||
|
from pathlib import Path
|
||||||
from typing import Callable, Generator
|
from typing import Callable, Generator
|
||||||
|
|
||||||
from ...log import die
|
from ...bottle_state import (
|
||||||
|
egress_state_dir,
|
||||||
|
git_gate_state_dir,
|
||||||
|
read_committed_image,
|
||||||
|
)
|
||||||
|
from ...egress import (
|
||||||
|
egress_agent_env_entries,
|
||||||
|
egress_resolve_token_values,
|
||||||
|
)
|
||||||
|
from ...git_gate import (
|
||||||
|
provision_git_gate_dynamic_keys,
|
||||||
|
revoke_git_gate_provisioned_keys,
|
||||||
|
)
|
||||||
|
from ...git_http_backend import DEFAULT_PORT as _GIT_HTTP_PORT
|
||||||
|
from ...log import die, info, warn
|
||||||
|
from ...supervise import SUPERVISE_PORT
|
||||||
|
from ..docker.egress import EGRESS_PORT
|
||||||
|
from ..util import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
||||||
|
from . import util as container_mod
|
||||||
from .bottle import MacosContainerBottle
|
from .bottle import MacosContainerBottle
|
||||||
from .bottle_plan import MacosContainerBottlePlan
|
from .bottle_plan import MacosContainerBottlePlan
|
||||||
|
from .consolidated_launch import (
|
||||||
|
GatewayEndpoint,
|
||||||
|
ensure_gateway,
|
||||||
|
register_agent,
|
||||||
|
teardown_consolidated,
|
||||||
|
)
|
||||||
|
|
||||||
|
_REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
||||||
|
_AGENT_SLEEP_SECONDS = "2147483647"
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
@@ -27,13 +77,274 @@ def launch(
|
|||||||
*,
|
*,
|
||||||
provision: Callable[[MacosContainerBottlePlan, "MacosContainerBottle"], str | None],
|
provision: Callable[[MacosContainerBottlePlan, "MacosContainerBottle"], str | None],
|
||||||
) -> Generator[MacosContainerBottle, None, None]:
|
) -> Generator[MacosContainerBottle, None, None]:
|
||||||
"""Fail closed: the macOS backend is disabled until it grows the
|
"""Build, run, register, provision, and yield an Apple Container bottle on
|
||||||
consolidated per-host gateway (the companion-container path it used
|
the shared per-host gateway."""
|
||||||
was removed in #385)."""
|
stack = ExitStack()
|
||||||
del plan, provision
|
bottle_for_revoke = plan.manifest.bottle
|
||||||
die(
|
git_gate_dir_for_revoke = git_gate_state_dir(plan.slug)
|
||||||
"the macos-container backend is temporarily disabled during the "
|
|
||||||
"companion-container removal (#385); it will return once it uses "
|
def teardown() -> None:
|
||||||
"the consolidated gateway. Use --backend=docker for now."
|
teardown_exc: BaseException | None = None
|
||||||
|
try:
|
||||||
|
stack.close()
|
||||||
|
except BaseException as exc: # noqa: W0718 - teardown must continue
|
||||||
|
teardown_exc = exc
|
||||||
|
warn(f"macos-container teardown failed: {exc!r}")
|
||||||
|
revoke_git_gate_provisioned_keys(bottle_for_revoke, git_gate_dir_for_revoke)
|
||||||
|
if teardown_exc is not None:
|
||||||
|
raise teardown_exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
plan = _build_images(plan)
|
||||||
|
|
||||||
|
# Step 1: the per-host singletons. Must precede the agent run — its
|
||||||
|
# proxy env needs the gateway's address at `container run` time.
|
||||||
|
endpoint = ensure_gateway()
|
||||||
|
|
||||||
|
# Step 2: mint this bottle's deploy keys, then point it at the SHARED
|
||||||
|
# gateway's CA + git-http/supervise ports.
|
||||||
|
plan = _provision_git_gate_keys(plan)
|
||||||
|
plan = _install_gateway_ca(plan, endpoint)
|
||||||
|
plan = _stamp_agent_urls(plan, endpoint)
|
||||||
|
|
||||||
|
# Step 3: run the agent. It has no identity token yet — registration
|
||||||
|
# needs the address this run assigns.
|
||||||
|
container_mod.force_remove_container(plan.container_name)
|
||||||
|
_start_agent(plan, endpoint)
|
||||||
|
stack.callback(container_mod.force_remove_container, plan.container_name)
|
||||||
|
|
||||||
|
# Step 4: read the assigned address and register by it. This is the
|
||||||
|
# attribution key; `--cap-drop CAP_NET_RAW` at run is what makes it
|
||||||
|
# unforgeable. Poll: `container run --detach` can return before vmnet's
|
||||||
|
# DHCP has assigned the address.
|
||||||
|
source_ip = container_mod.wait_container_ipv4_on_network(
|
||||||
|
plan.container_name, endpoint.network,
|
||||||
|
)
|
||||||
|
if not source_ip:
|
||||||
|
die(
|
||||||
|
f"agent {plan.container_name} never got an address on "
|
||||||
|
f"{endpoint.network}"
|
||||||
|
)
|
||||||
|
effective_env = {**os.environ, **plan.agent_provision.provisioned_env}
|
||||||
|
token_values = egress_resolve_token_values(
|
||||||
|
plan.egress_plan.token_env_map, effective_env,
|
||||||
|
)
|
||||||
|
ctx = register_agent(
|
||||||
|
plan.egress_plan,
|
||||||
|
plan.git_gate_plan,
|
||||||
|
source_ip=source_ip,
|
||||||
|
endpoint=endpoint,
|
||||||
|
image_ref=plan.image,
|
||||||
|
tokens=token_values,
|
||||||
|
)
|
||||||
|
stack.callback(
|
||||||
|
teardown_consolidated, ctx.bottle_id,
|
||||||
|
orchestrator_url=ctx.orchestrator_url,
|
||||||
|
)
|
||||||
|
info(
|
||||||
|
f"agent {plan.container_name} registered "
|
||||||
|
f"(gateway {endpoint.gateway_ip}, ip {source_ip})"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Stamp the token onto the plan so provision-time consumers can read it,
|
||||||
|
# not only the exec-time egress proxy. git-gate's gitconfig extraHeader
|
||||||
|
# and the supervise MCP --header both reach the gateway on NO_PROXY (they
|
||||||
|
# bypass the egress proxy that carries the token), so without this the
|
||||||
|
# gateway's /resolve fail-closes and every git fetch/push and supervise
|
||||||
|
# call from the bottle is denied. Registration already produced the
|
||||||
|
# token above, so — unlike the run-time env — the plan CAN carry it.
|
||||||
|
plan = dataclasses.replace(plan, identity_token=ctx.identity_token)
|
||||||
|
|
||||||
|
bottle = MacosContainerBottle(
|
||||||
|
plan.container_name,
|
||||||
|
teardown,
|
||||||
|
None,
|
||||||
|
agent_command=plan.agent_command,
|
||||||
|
agent_prompt_mode=plan.agent_prompt_mode,
|
||||||
|
agent_provider_template=plan.agent_provider_template,
|
||||||
|
terminal_title=(
|
||||||
|
f"{plan.spec.label} ({plan.spec.agent_name})"
|
||||||
|
if plan.spec.label else plan.spec.agent_name
|
||||||
|
),
|
||||||
|
terminal_color=plan.spec.color,
|
||||||
|
agent_workdir=plan.workspace_plan.workdir,
|
||||||
|
exec_env=_identity_proxy_env(endpoint, ctx.identity_token),
|
||||||
|
)
|
||||||
|
bottle.prompt_path = provision(plan, bottle)
|
||||||
|
|
||||||
|
yield bottle
|
||||||
|
finally:
|
||||||
|
teardown()
|
||||||
|
|
||||||
|
|
||||||
|
def _build_images(plan: MacosContainerBottlePlan) -> MacosContainerBottlePlan:
|
||||||
|
"""Build the agent image. The gateway's own image is built by
|
||||||
|
`ensure_gateway` — it belongs to the shared singleton, not to a bottle."""
|
||||||
|
committed = read_committed_image(plan.slug)
|
||||||
|
if committed and container_mod.image_exists(committed):
|
||||||
|
info(f"using committed image {committed!r}")
|
||||||
|
return dataclasses.replace(
|
||||||
|
plan,
|
||||||
|
agent_provision=dataclasses.replace(
|
||||||
|
plan.agent_provision, image=committed,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
container_mod.build_image(
|
||||||
|
plan.image, _REPO_DIR, dockerfile=plan.dockerfile_path,
|
||||||
)
|
)
|
||||||
yield # unreachable — `die` raises; keeps this a generator/contextmanager
|
return plan
|
||||||
|
|
||||||
|
|
||||||
|
def _provision_git_gate_keys(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
) -> MacosContainerBottlePlan:
|
||||||
|
if not plan.git_gate_plan.upstreams:
|
||||||
|
return plan
|
||||||
|
git_gate_plan = provision_git_gate_dynamic_keys(
|
||||||
|
plan.manifest.bottle,
|
||||||
|
plan.git_gate_plan,
|
||||||
|
git_gate_state_dir(plan.slug),
|
||||||
|
)
|
||||||
|
return dataclasses.replace(plan, git_gate_plan=git_gate_plan)
|
||||||
|
|
||||||
|
|
||||||
|
def _install_gateway_ca(
|
||||||
|
plan: MacosContainerBottlePlan, endpoint: GatewayEndpoint,
|
||||||
|
) -> MacosContainerBottlePlan:
|
||||||
|
"""Stage the SHARED gateway's CA for the provisioner to install, replacing
|
||||||
|
the per-bottle CA the companion container used to mint. Every bottle on
|
||||||
|
this host trusts this one CA."""
|
||||||
|
ca_dir = egress_state_dir(plan.slug) / "gateway-ca"
|
||||||
|
ca_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
ca_file = ca_dir / "gateway-ca.pem"
|
||||||
|
ca_file.write_text(endpoint.gateway_ca_pem)
|
||||||
|
egress_plan = dataclasses.replace(
|
||||||
|
plan.egress_plan,
|
||||||
|
mitmproxy_ca_host_path=ca_file,
|
||||||
|
mitmproxy_ca_cert_only_host_path=ca_file,
|
||||||
|
)
|
||||||
|
return dataclasses.replace(plan, egress_plan=egress_plan)
|
||||||
|
|
||||||
|
|
||||||
|
def _stamp_agent_urls(
|
||||||
|
plan: MacosContainerBottlePlan, endpoint: GatewayEndpoint,
|
||||||
|
) -> MacosContainerBottlePlan:
|
||||||
|
"""Point the agent's git-gate insteadOf rewrites + supervise MCP at the
|
||||||
|
shared gateway's ports. Both bypass the egress proxy (NO_PROXY covers the
|
||||||
|
gateway address)."""
|
||||||
|
git_gate_url = (
|
||||||
|
f"http://{endpoint.gateway_ip}:{_GIT_HTTP_PORT}"
|
||||||
|
if plan.git_gate_plan.upstreams else ""
|
||||||
|
)
|
||||||
|
supervise_url = (
|
||||||
|
f"http://{endpoint.gateway_ip}:{SUPERVISE_PORT}/"
|
||||||
|
if plan.supervise_plan is not None else ""
|
||||||
|
)
|
||||||
|
return dataclasses.replace(
|
||||||
|
plan,
|
||||||
|
agent_git_gate_url=git_gate_url,
|
||||||
|
agent_supervise_url=supervise_url,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _proxy_url(gateway_ip: str, identity_token: str = "") -> str:
|
||||||
|
"""The agent's egress proxy URL. The identity token rides as proxy
|
||||||
|
credentials — the gateway reads Proxy-Authorization, resolves the
|
||||||
|
(source_ip, token) pair against the control plane, and strips it before
|
||||||
|
upstream. Without a valid pair `/resolve` denies the request (#366)."""
|
||||||
|
cred = f"bottle:{identity_token}@" if identity_token else ""
|
||||||
|
return f"http://{cred}{gateway_ip}:{EGRESS_PORT}"
|
||||||
|
|
||||||
|
|
||||||
|
def _no_proxy(gateway_ip: str) -> str:
|
||||||
|
# git-http + supervise live on the gateway and must NOT go through the
|
||||||
|
# egress proxy — the agent reaches them directly by its address.
|
||||||
|
return f"localhost,127.0.0.1,{gateway_ip}"
|
||||||
|
|
||||||
|
|
||||||
|
def _identity_proxy_env(
|
||||||
|
endpoint: GatewayEndpoint, identity_token: str,
|
||||||
|
) -> dict[str, str]:
|
||||||
|
"""The token-bearing proxy env applied at `container exec`. It supersedes
|
||||||
|
the token-less run-time value (exec `--env` wins), which is the only way to
|
||||||
|
get the token in: it does not exist until after the container runs."""
|
||||||
|
if not identity_token:
|
||||||
|
return {}
|
||||||
|
url = _proxy_url(endpoint.gateway_ip, identity_token)
|
||||||
|
return {
|
||||||
|
"HTTPS_PROXY": url, "HTTP_PROXY": url,
|
||||||
|
"https_proxy": url, "http_proxy": url,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _start_agent(plan: MacosContainerBottlePlan, endpoint: GatewayEndpoint) -> None:
|
||||||
|
argv = _agent_run_argv(plan, endpoint)
|
||||||
|
env = {**os.environ, **plan.forwarded_env}
|
||||||
|
info(f"container run agent {plan.container_name}")
|
||||||
|
result = subprocess.run(
|
||||||
|
argv, capture_output=True, text=True, env=env, check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container run for agent {plan.container_name} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _agent_run_argv(
|
||||||
|
plan: MacosContainerBottlePlan, endpoint: GatewayEndpoint,
|
||||||
|
) -> list[str]:
|
||||||
|
argv = [
|
||||||
|
"container", "run",
|
||||||
|
"--name", plan.container_name,
|
||||||
|
"--detach",
|
||||||
|
"--label", "bot-bottle.backend=macos-container",
|
||||||
|
"--network", endpoint.network,
|
||||||
|
# The attribution invariant: without NET_RAW the agent cannot open a
|
||||||
|
# raw socket, so it cannot source-IP-spoof its neighbours on the shared
|
||||||
|
# segment. NET_ADMIN is not granted by default, so its address and
|
||||||
|
# route are already fixed. See the module docstring.
|
||||||
|
"--cap-drop", "CAP_NET_RAW",
|
||||||
|
]
|
||||||
|
for entry in _agent_env_entries(plan, endpoint):
|
||||||
|
argv += ["--env", entry]
|
||||||
|
# The init process is a no-op: every agent command arrives via
|
||||||
|
# `container exec`, which is also how the identity token gets in.
|
||||||
|
argv += [plan.image, "sleep", _AGENT_SLEEP_SECONDS]
|
||||||
|
return argv
|
||||||
|
|
||||||
|
|
||||||
|
def _agent_env_entries(
|
||||||
|
plan: MacosContainerBottlePlan, endpoint: GatewayEndpoint,
|
||||||
|
) -> tuple[str, ...]:
|
||||||
|
# Token-less at run time — the token does not exist yet (see
|
||||||
|
# `_identity_proxy_env`). Anything egressing before the exec-time override
|
||||||
|
# is denied by `/resolve`, which is the safe direction.
|
||||||
|
proxy_url = _proxy_url(endpoint.gateway_ip)
|
||||||
|
no_proxy = _no_proxy(endpoint.gateway_ip)
|
||||||
|
env = [
|
||||||
|
f"HTTPS_PROXY={proxy_url}",
|
||||||
|
f"HTTP_PROXY={proxy_url}",
|
||||||
|
f"https_proxy={proxy_url}",
|
||||||
|
f"http_proxy={proxy_url}",
|
||||||
|
f"NO_PROXY={no_proxy}",
|
||||||
|
f"no_proxy={no_proxy}",
|
||||||
|
f"NODE_EXTRA_CA_CERTS={AGENT_CA_PATH}",
|
||||||
|
f"SSL_CERT_FILE={AGENT_CA_BUNDLE}",
|
||||||
|
f"REQUESTS_CA_BUNDLE={AGENT_CA_BUNDLE}",
|
||||||
|
]
|
||||||
|
if plan.agent_git_gate_url:
|
||||||
|
env.append(f"GIT_GATE_URL={plan.agent_git_gate_url}")
|
||||||
|
if plan.agent_supervise_url:
|
||||||
|
env.append(f"MCP_SUPERVISE_URL={plan.agent_supervise_url}")
|
||||||
|
for name, value in sorted(plan.agent_provision.guest_env.items()):
|
||||||
|
env.append(f"{name}={value}")
|
||||||
|
# Forwarded vars: bare name → inherits from the `container run` process env
|
||||||
|
# so the secret value never lands on argv.
|
||||||
|
for name in sorted(plan.forwarded_env.keys()):
|
||||||
|
env.append(name)
|
||||||
|
env.extend(egress_agent_env_entries(plan.egress_plan))
|
||||||
|
return tuple(env)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["launch"]
|
||||||
|
|||||||
@@ -437,22 +437,145 @@ def inspect_container(name: str) -> dict[str, object]:
|
|||||||
|
|
||||||
|
|
||||||
def container_ipv4_on_network(name: str, network: str) -> str:
|
def container_ipv4_on_network(name: str, network: str) -> str:
|
||||||
data = inspect_container(name)
|
"""The container's IPv4 address on `network`. Fatal if absent — callers
|
||||||
status = data.get("status")
|
that can tolerate "not yet" want `try_container_ipv4_on_network`."""
|
||||||
|
ip = try_container_ipv4_on_network(name, network)
|
||||||
|
if not ip:
|
||||||
|
die(f"container {name} has no IPv4 address on {network}")
|
||||||
|
return ip
|
||||||
|
|
||||||
|
|
||||||
|
def run_container_argv(
|
||||||
|
argv: list[str], *, env: dict[str, str] | None = None,
|
||||||
|
) -> subprocess.CompletedProcess[str]:
|
||||||
|
"""Run a `container` command, returning the result for the caller to
|
||||||
|
interpret. Unlike the `die`-on-failure helpers above, this lets callers
|
||||||
|
that raise their own typed errors (the gateway / orchestrator lifecycle)
|
||||||
|
keep control of the failure path.
|
||||||
|
|
||||||
|
`env` sets the child process environment — used to hand a secret to a bare
|
||||||
|
`--env NAME` flag (Apple's "just key → inherit from host" form) so the
|
||||||
|
value is inherited from this process, never written onto argv or into
|
||||||
|
`container inspect`'s recorded command line."""
|
||||||
|
return subprocess.run(
|
||||||
|
argv, capture_output=True, text=True, check=False, env=env)
|
||||||
|
|
||||||
|
|
||||||
|
def bind_mount_spec(source: str, target: str, *, readonly: bool = False) -> str:
|
||||||
|
"""A `container run --mount` bind spec. One definition so the gateway and
|
||||||
|
orchestrator emit an identical string — a divergence here would silently
|
||||||
|
break one backend's mounts while the other kept working."""
|
||||||
|
spec = f"type=bind,source={source},target={target}"
|
||||||
|
if readonly:
|
||||||
|
spec += ",readonly"
|
||||||
|
return spec
|
||||||
|
|
||||||
|
|
||||||
|
def _normalize_digest(value: str) -> str:
|
||||||
|
return value.split(":", 1)[1] if ":" in value else value
|
||||||
|
|
||||||
|
|
||||||
|
def _inspect_first(argv: list[str]) -> dict[str, object]:
|
||||||
|
"""Run an inspect command and return its first JSON object, or {} on any
|
||||||
|
failure (non-zero exit, malformed JSON, unexpected shape). {} is the shared
|
||||||
|
'don't know' signal all the non-fatal inspect readers below build on — a
|
||||||
|
caller comparing against it treats it as 'leave the working container
|
||||||
|
alone', never as a mismatch."""
|
||||||
|
result = run_container_argv(argv)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return {}
|
||||||
|
try:
|
||||||
|
data = json.loads(result.stdout or "[]")
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
return {}
|
||||||
|
if isinstance(data, list):
|
||||||
|
data = data[0] if data else {}
|
||||||
|
return data if isinstance(data, dict) else {}
|
||||||
|
|
||||||
|
|
||||||
|
def _descriptor_digest(node: object) -> str:
|
||||||
|
"""The normalized digest under a `{... "descriptor": {"digest": ...}}`
|
||||||
|
node, or "". Both the image and container inspect shapes nest the image's
|
||||||
|
identity this way, so the digest readers stay symmetric — a difference
|
||||||
|
between them is what would spuriously recreate a container."""
|
||||||
|
if not isinstance(node, dict):
|
||||||
|
return ""
|
||||||
|
descriptor = node.get("descriptor")
|
||||||
|
if isinstance(descriptor, dict) and descriptor.get("digest"):
|
||||||
|
return _normalize_digest(str(descriptor["digest"]))
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def image_digest(ref: str) -> str:
|
||||||
|
"""The digest of image `ref`, or "" if it can't be read. Reads exactly the
|
||||||
|
field `container_image_digest` reads (`configuration.descriptor.digest`) so
|
||||||
|
the two are comparable; "" means 'don't know' → callers don't churn."""
|
||||||
|
data = _inspect_first([_CONTAINER, "image", "inspect", ref])
|
||||||
|
return _descriptor_digest(data.get("configuration"))
|
||||||
|
|
||||||
|
|
||||||
|
def container_image_digest(name: str) -> str:
|
||||||
|
"""The digest of the image container `name` was created from, or "" if it
|
||||||
|
can't be read. Compare with `image_digest(ref)` to tell whether a running
|
||||||
|
container predates an image rebuild."""
|
||||||
|
config = _inspect_first([_CONTAINER, "inspect", name]).get("configuration")
|
||||||
|
image = config.get("image") if isinstance(config, dict) else None
|
||||||
|
return _descriptor_digest(image)
|
||||||
|
|
||||||
|
|
||||||
|
def container_env(name: str) -> dict[str, str]:
|
||||||
|
"""The env container `name` was started with, or {} if unreadable. Lets a
|
||||||
|
caller tell whether a running container's baked-in configuration still
|
||||||
|
matches what it would pass today."""
|
||||||
|
config = _inspect_first([_CONTAINER, "inspect", name]).get("configuration")
|
||||||
|
init = config.get("initProcess") if isinstance(config, dict) else None
|
||||||
|
entries = init.get("environment") if isinstance(init, dict) else None
|
||||||
|
if not isinstance(entries, list):
|
||||||
|
return {}
|
||||||
|
env: dict[str, str] = {}
|
||||||
|
for entry in entries:
|
||||||
|
if isinstance(entry, str) and "=" in entry:
|
||||||
|
key, value = entry.split("=", 1)
|
||||||
|
env[key] = value
|
||||||
|
return env
|
||||||
|
|
||||||
|
|
||||||
|
def try_container_ipv4_on_network(name: str, network: str) -> str:
|
||||||
|
"""`container_ipv4_on_network` without the fatal exit: "" when the address
|
||||||
|
isn't readable yet. For pollers — a container is created before it has an
|
||||||
|
address, so "not yet" is an expected state there, not an error."""
|
||||||
|
status = _inspect_first([_CONTAINER, "inspect", name]).get("status")
|
||||||
networks = status.get("networks") if isinstance(status, dict) else None
|
networks = status.get("networks") if isinstance(status, dict) else None
|
||||||
if not isinstance(networks, list):
|
if not isinstance(networks, list):
|
||||||
die(f"container inspect {name} did not include status.networks")
|
return ""
|
||||||
for entry in networks:
|
for entry in networks:
|
||||||
if not isinstance(entry, dict):
|
if not isinstance(entry, dict) or entry.get("network") != network:
|
||||||
continue
|
|
||||||
if entry.get("network") != network:
|
|
||||||
continue
|
continue
|
||||||
raw = entry.get("ipv4Address")
|
raw = entry.get("ipv4Address")
|
||||||
if not isinstance(raw, str) or not raw:
|
if isinstance(raw, str) and raw:
|
||||||
die(f"container {name} has no IPv4 address on {network}")
|
return raw.split("/", 1)[0]
|
||||||
return raw.split("/", 1)[0]
|
return ""
|
||||||
die(f"container {name} is not attached to network {network}")
|
|
||||||
raise AssertionError("unreachable")
|
|
||||||
|
def wait_container_ipv4_on_network(
|
||||||
|
name: str, network: str, *, timeout: float = 15.0, poll: float = 0.25,
|
||||||
|
) -> str:
|
||||||
|
"""Poll for the container's DHCP-assigned address on `network`, returning
|
||||||
|
it once available or "" on timeout.
|
||||||
|
|
||||||
|
Apple Container has no `--ip`: `container run --detach` can return before
|
||||||
|
vmnet's DHCP has populated `status.networks[].ipv4Address`, so a bare read
|
||||||
|
right after start races the assignment. Callers that need the address (the
|
||||||
|
attribution key, the gateway's proxy target) poll through here instead of
|
||||||
|
the fatal `container_ipv4_on_network`."""
|
||||||
|
deadline = time.monotonic() + timeout
|
||||||
|
while True:
|
||||||
|
ip = try_container_ipv4_on_network(name, network)
|
||||||
|
if ip:
|
||||||
|
return ip
|
||||||
|
if time.monotonic() >= deadline:
|
||||||
|
return ""
|
||||||
|
time.sleep(poll)
|
||||||
|
|
||||||
|
|
||||||
def image_id(ref: str) -> str:
|
def image_id(ref: str) -> str:
|
||||||
|
|||||||
@@ -14,13 +14,20 @@ from __future__ import annotations
|
|||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
|
|
||||||
def run_docker(argv: list[str]) -> subprocess.CompletedProcess[str]:
|
def run_docker(
|
||||||
|
argv: list[str], *, env: dict[str, str] | None = None,
|
||||||
|
) -> subprocess.CompletedProcess[str]:
|
||||||
"""Run a `docker` command, capturing stdout/stderr as text. Never raises
|
"""Run a `docker` command, capturing stdout/stderr as text. Never raises
|
||||||
on a non-zero exit — callers inspect `returncode` / `stderr` so they can
|
on a non-zero exit — callers inspect `returncode` / `stderr` so they can
|
||||||
stay fail-closed or tolerate idempotent no-ops (e.g. removing an
|
stay fail-closed or tolerate idempotent no-ops (e.g. removing an
|
||||||
already-absent container)."""
|
already-absent container).
|
||||||
|
|
||||||
|
`env` sets the child process environment — used to hand a secret to a bare
|
||||||
|
`--env NAME` flag (docker inherits its value from this process) so the
|
||||||
|
value never lands on argv or in `docker inspect`'s recorded command line."""
|
||||||
return subprocess.run(
|
return subprocess.run(
|
||||||
argv, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True, check=False,
|
argv, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True,
|
||||||
|
check=False, env=env,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -17,9 +17,22 @@ import urllib.error
|
|||||||
import urllib.request
|
import urllib.request
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
from ..paths import host_control_plane_token
|
||||||
|
from .control_plane import CONTROL_AUTH_HEADER
|
||||||
|
|
||||||
DEFAULT_TIMEOUT_SECONDS = 5.0
|
DEFAULT_TIMEOUT_SECONDS = 5.0
|
||||||
|
|
||||||
|
|
||||||
|
def _host_auth_token() -> str:
|
||||||
|
"""The per-host control-plane secret, or "" if it can't be read. "" means
|
||||||
|
'send no auth header' — correct against an open (unconfigured) control
|
||||||
|
plane, and harmlessly rejected by a secured one."""
|
||||||
|
try:
|
||||||
|
return host_control_plane_token()
|
||||||
|
except OSError:
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
class OrchestratorClientError(RuntimeError):
|
class OrchestratorClientError(RuntimeError):
|
||||||
"""A control-plane call failed (unreachable, or an unexpected status)."""
|
"""A control-plane call failed (unreachable, or an unexpected status)."""
|
||||||
|
|
||||||
@@ -34,11 +47,24 @@ class RegisteredBottle:
|
|||||||
|
|
||||||
|
|
||||||
class OrchestratorClient:
|
class OrchestratorClient:
|
||||||
"""Trusted host-side client for the orchestrator control plane."""
|
"""Trusted host-side client for the orchestrator control plane.
|
||||||
|
|
||||||
def __init__(self, base_url: str, *, timeout: float = DEFAULT_TIMEOUT_SECONDS) -> None:
|
Presents the per-host control-plane secret on every call (the header the
|
||||||
|
control plane requires on all routes but `/health`). The secret is read
|
||||||
|
from the host file — this client only ever runs host-side (CLI, launcher,
|
||||||
|
discovery), so it can read what an agent can't. `auth_token` is overridable
|
||||||
|
for tests; the default reads the host file, minting it on first use."""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
base_url: str,
|
||||||
|
*,
|
||||||
|
timeout: float = DEFAULT_TIMEOUT_SECONDS,
|
||||||
|
auth_token: str | None = None,
|
||||||
|
) -> None:
|
||||||
self._base = base_url.rstrip("/")
|
self._base = base_url.rstrip("/")
|
||||||
self._timeout = timeout
|
self._timeout = timeout
|
||||||
|
self._auth_token = auth_token if auth_token is not None else _host_auth_token()
|
||||||
|
|
||||||
def _request(
|
def _request(
|
||||||
self, method: str, path: str, body: dict[str, object] | None = None,
|
self, method: str, path: str, body: dict[str, object] | None = None,
|
||||||
@@ -49,6 +75,8 @@ class OrchestratorClient:
|
|||||||
callers can treat 404 as a meaningful "no such bottle"."""
|
callers can treat 404 as a meaningful "no such bottle"."""
|
||||||
data = json.dumps(body).encode() if body is not None else None
|
data = json.dumps(body).encode() if body is not None else None
|
||||||
headers = {"Content-Type": "application/json"} if data is not None else {}
|
headers = {"Content-Type": "application/json"} if data is not None else {}
|
||||||
|
if self._auth_token:
|
||||||
|
headers[CONTROL_AUTH_HEADER] = self._auth_token
|
||||||
req = urllib.request.Request(
|
req = urllib.request.Request(
|
||||||
f"{self._base}{path}", data=data, method=method, headers=headers,
|
f"{self._base}{path}", data=data, method=method, headers=headers,
|
||||||
)
|
)
|
||||||
@@ -186,6 +214,13 @@ def discover_orchestrator_url(*, timeout: float = 2.0) -> str:
|
|||||||
f"http://{netpool.orch_slot().guest_ip}:{CONTROL_PLANE_PORT}")
|
f"http://{netpool.orch_slot().guest_ip}:{CONTROL_PLANE_PORT}")
|
||||||
except Exception: # noqa: BLE001 — backend optional / not firecracker
|
except Exception: # noqa: BLE001 — backend optional / not firecracker
|
||||||
pass
|
pass
|
||||||
|
try: # macOS: infra container control plane on its host-only address
|
||||||
|
from ..backend.macos_container.infra import probe_control_plane_url
|
||||||
|
url = probe_control_plane_url()
|
||||||
|
if url:
|
||||||
|
candidates.append(url)
|
||||||
|
except Exception: # noqa: BLE001 — backend optional / not macOS
|
||||||
|
pass
|
||||||
for url in candidates:
|
for url in candidates:
|
||||||
if OrchestratorClient(url, timeout=timeout).health():
|
if OrchestratorClient(url, timeout=timeout).health():
|
||||||
return url
|
return url
|
||||||
|
|||||||
@@ -34,6 +34,7 @@ returned only once, to the caller that launches the bottle.
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import hmac
|
||||||
import http.server
|
import http.server
|
||||||
import json
|
import json
|
||||||
import os
|
import os
|
||||||
@@ -42,11 +43,20 @@ import sys
|
|||||||
import typing
|
import typing
|
||||||
from urllib.parse import urlsplit
|
from urllib.parse import urlsplit
|
||||||
|
|
||||||
|
from ..paths import CONTROL_PLANE_TOKEN_ENV
|
||||||
from .service import Orchestrator
|
from .service import Orchestrator
|
||||||
|
|
||||||
# JSON body payload type (parsed request / rendered response).
|
# JSON body payload type (parsed request / rendered response).
|
||||||
Json = dict[str, object]
|
Json = dict[str, object]
|
||||||
|
|
||||||
|
# The request header carrying the per-host control-plane secret. Every route
|
||||||
|
# except `GET /health` requires it (see `dispatch`). The trusted callers hold
|
||||||
|
# the secret (the gateway's PolicyResolver, the host CLI's OrchestratorClient);
|
||||||
|
# an agent that can merely *reach* the port cannot present it, so it can't
|
||||||
|
# enumerate bottles, rewrite policy, read injected upstream tokens, or approve
|
||||||
|
# its own supervise proposals.
|
||||||
|
CONTROL_AUTH_HEADER = "x-bot-bottle-control-auth"
|
||||||
|
|
||||||
|
|
||||||
def _parse_json_object(body: bytes) -> Json:
|
def _parse_json_object(body: bytes) -> Json:
|
||||||
"""Parse a JSON object body. Raises ValueError for non-objects / bad JSON."""
|
"""Parse a JSON object body. Raises ValueError for non-objects / bad JSON."""
|
||||||
@@ -59,15 +69,29 @@ def _parse_json_object(body: bytes) -> Json:
|
|||||||
|
|
||||||
|
|
||||||
def dispatch( # pylint: disable=too-many-return-statements,too-many-branches
|
def dispatch( # pylint: disable=too-many-return-statements,too-many-branches
|
||||||
orch: Orchestrator, method: str, path: str, body: bytes
|
orch: Orchestrator, method: str, path: str, body: bytes, *, authorized: bool = True,
|
||||||
) -> tuple[int, Json]:
|
) -> tuple[int, Json]:
|
||||||
"""Route one control-plane request to a (status, payload) pair. Pure —
|
"""Route one control-plane request to a (status, payload) pair. Pure —
|
||||||
no I/O beyond the orchestrator — so it is fully testable without a socket."""
|
no I/O beyond the orchestrator — so it is fully testable without a socket.
|
||||||
|
|
||||||
|
`authorized` is whether the request presented the control-plane secret (or
|
||||||
|
no secret is configured — see `ControlPlaneServer`). Every route except
|
||||||
|
`GET /health` requires it: the source-IP + identity-token checks inside
|
||||||
|
`/resolve` and `/attribute` authenticate the *bottle* a request is about,
|
||||||
|
not the *caller*, so without this gate any agent that can reach the port
|
||||||
|
could rewrite another bottle's policy, read the injected upstream tokens,
|
||||||
|
or approve its own supervise proposals. Defaults True so unit tests of the
|
||||||
|
routing logic don't have to thread it through."""
|
||||||
route = urlsplit(path).path.rstrip("/") or "/"
|
route = urlsplit(path).path.rstrip("/") or "/"
|
||||||
|
|
||||||
if method == "GET" and route == "/health":
|
if method == "GET" and route == "/health":
|
||||||
return 200, {"status": "ok"}
|
return 200, {"status": "ok"}
|
||||||
|
|
||||||
|
if not authorized:
|
||||||
|
# Everything below is a trusted-caller operation. Deny before touching
|
||||||
|
# the registry / broker / supervise store.
|
||||||
|
return 401, {"error": "control-plane authentication required"}
|
||||||
|
|
||||||
if method == "GET" and route == "/gateway":
|
if method == "GET" and route == "/gateway":
|
||||||
return 200, orch.gateway_status()
|
return 200, orch.gateway_status()
|
||||||
|
|
||||||
@@ -209,8 +233,10 @@ class Handler(http.server.BaseHTTPRequestHandler):
|
|||||||
assert isinstance(server, ControlPlaneServer)
|
assert isinstance(server, ControlPlaneServer)
|
||||||
length = int(self.headers.get("Content-Length") or 0)
|
length = int(self.headers.get("Content-Length") or 0)
|
||||||
body = self.rfile.read(length) if length > 0 else b""
|
body = self.rfile.read(length) if length > 0 else b""
|
||||||
|
authorized = server.is_authorized(self.headers.get(CONTROL_AUTH_HEADER, ""))
|
||||||
try:
|
try:
|
||||||
status, payload = dispatch(server.orchestrator, method, self.path, body)
|
status, payload = dispatch(
|
||||||
|
server.orchestrator, method, self.path, body, authorized=authorized)
|
||||||
except Exception as e: # noqa: BLE001 — the control plane must stay up
|
except Exception as e: # noqa: BLE001 — the control plane must stay up
|
||||||
sys.stderr.write(f"orchestrator: {method} {self.path} failed: {e!r}\n")
|
sys.stderr.write(f"orchestrator: {method} {self.path} failed: {e!r}\n")
|
||||||
sys.stderr.flush()
|
sys.stderr.flush()
|
||||||
@@ -236,15 +262,40 @@ class Handler(http.server.BaseHTTPRequestHandler):
|
|||||||
|
|
||||||
|
|
||||||
class ControlPlaneServer(socketserver.ThreadingMixIn, http.server.HTTPServer):
|
class ControlPlaneServer(socketserver.ThreadingMixIn, http.server.HTTPServer):
|
||||||
"""Threading HTTP server that carries the orchestrator for its handlers."""
|
"""Threading HTTP server that carries the orchestrator for its handlers.
|
||||||
|
|
||||||
|
Holds the per-host control-plane secret (from `$BOT_BOTTLE_CONTROL_PLANE_TOKEN`,
|
||||||
|
injected by the launcher into this container only). When a secret is set,
|
||||||
|
every route but `/health` requires it; when it is unset the server runs
|
||||||
|
**open** and says so loudly at startup — a fail-visible fallback for tests
|
||||||
|
and any backend that hasn't wired the secret yet (e.g. Firecracker, whose
|
||||||
|
nft boundary already blocks agents from the control-plane port)."""
|
||||||
|
|
||||||
daemon_threads = True
|
daemon_threads = True
|
||||||
allow_reuse_address = True
|
allow_reuse_address = True
|
||||||
|
|
||||||
def __init__(self, address: tuple[str, int], orchestrator: Orchestrator) -> None:
|
def __init__(self, address: tuple[str, int], orchestrator: Orchestrator) -> None:
|
||||||
self.orchestrator = orchestrator
|
self.orchestrator = orchestrator
|
||||||
|
self._auth_token = os.environ.get(CONTROL_PLANE_TOKEN_ENV, "").strip()
|
||||||
|
if not self._auth_token:
|
||||||
|
sys.stderr.write(
|
||||||
|
"orchestrator: WARNING — no control-plane secret "
|
||||||
|
f"(${CONTROL_PLANE_TOKEN_ENV}); running WITHOUT caller "
|
||||||
|
"authentication. Any client that can reach this port can drive "
|
||||||
|
"it. Backends that put the control plane on an agent-reachable "
|
||||||
|
"network MUST set this.\n"
|
||||||
|
)
|
||||||
|
sys.stderr.flush()
|
||||||
super().__init__(address, Handler)
|
super().__init__(address, Handler)
|
||||||
|
|
||||||
|
def is_authorized(self, presented: str) -> bool:
|
||||||
|
"""True iff the request may proceed past `/health`: either no secret is
|
||||||
|
configured (open mode) or the presented header matches it. Constant-time
|
||||||
|
compare so a wrong token leaks nothing timing-wise."""
|
||||||
|
if not self._auth_token:
|
||||||
|
return True
|
||||||
|
return hmac.compare_digest(presented, self._auth_token)
|
||||||
|
|
||||||
|
|
||||||
def make_server(
|
def make_server(
|
||||||
orchestrator: Orchestrator, host: str = "127.0.0.1", port: int = 0
|
orchestrator: Orchestrator, host: str = "127.0.0.1", port: int = 0
|
||||||
@@ -254,4 +305,7 @@ def make_server(
|
|||||||
return ControlPlaneServer((host, port), orchestrator)
|
return ControlPlaneServer((host, port), orchestrator)
|
||||||
|
|
||||||
|
|
||||||
__all__ = ["dispatch", "Handler", "ControlPlaneServer", "make_server", "Json"]
|
__all__ = [
|
||||||
|
"dispatch", "Handler", "ControlPlaneServer", "make_server", "Json",
|
||||||
|
"CONTROL_AUTH_HEADER",
|
||||||
|
]
|
||||||
|
|||||||
@@ -23,7 +23,11 @@ import time
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from ..docker_cmd import run_docker
|
from ..docker_cmd import run_docker
|
||||||
from ..paths import host_db_path
|
from ..paths import (
|
||||||
|
CONTROL_PLANE_TOKEN_ENV,
|
||||||
|
host_control_plane_token,
|
||||||
|
host_db_path,
|
||||||
|
)
|
||||||
from ..supervise import DB_PATH_IN_CONTAINER
|
from ..supervise import DB_PATH_IN_CONTAINER
|
||||||
|
|
||||||
# The host DB dir is bind-mounted here so the gateway's supervise daemon
|
# The host DB dir is bind-mounted here so the gateway's supervise daemon
|
||||||
@@ -215,12 +219,19 @@ class DockerGateway(Gateway):
|
|||||||
]
|
]
|
||||||
for port in self._host_port_bindings:
|
for port in self._host_port_bindings:
|
||||||
argv += ["--publish", f"0.0.0.0:{port}:{port}"]
|
argv += ["--publish", f"0.0.0.0:{port}:{port}"]
|
||||||
|
run_env = dict(os.environ)
|
||||||
if self._orchestrator_url:
|
if self._orchestrator_url:
|
||||||
# Makes the gateway's egress / git / supervise daemons multi-tenant:
|
# Makes the gateway's egress / git / supervise daemons multi-tenant:
|
||||||
# each request resolves source-IP -> policy against the control plane.
|
# each request resolves source-IP -> policy against the control plane.
|
||||||
argv += ["--env", f"BOT_BOTTLE_ORCHESTRATOR_URL={self._orchestrator_url}"]
|
argv += ["--env", f"BOT_BOTTLE_ORCHESTRATOR_URL={self._orchestrator_url}"]
|
||||||
|
# ...and presents the control-plane secret on those /resolve calls
|
||||||
|
# (the control plane requires it). Bare `--env NAME` keeps the value
|
||||||
|
# off argv / `docker inspect`; only the gateway (not the agent) is
|
||||||
|
# given it. Only needed in multi-tenant mode, where /resolve is used.
|
||||||
|
argv += ["--env", CONTROL_PLANE_TOKEN_ENV]
|
||||||
|
run_env[CONTROL_PLANE_TOKEN_ENV] = host_control_plane_token()
|
||||||
argv.append(self.image_ref)
|
argv.append(self.image_ref)
|
||||||
proc = run_docker(argv)
|
proc = run_docker(argv, env=run_env)
|
||||||
if proc.returncode != 0:
|
if proc.returncode != 0:
|
||||||
raise GatewayError(f"gateway failed to start: {proc.stderr.strip()}")
|
raise GatewayError(f"gateway failed to start: {proc.stderr.strip()}")
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ from pathlib import Path
|
|||||||
|
|
||||||
from .. import log
|
from .. import log
|
||||||
from ..docker_cmd import run_docker
|
from ..docker_cmd import run_docker
|
||||||
from ..paths import bot_bottle_root
|
from ..paths import CONTROL_PLANE_TOKEN_ENV, bot_bottle_root, host_control_plane_token
|
||||||
from .gateway import GATEWAY_IMAGE, GATEWAY_NETWORK, DockerGateway, GatewayError
|
from .gateway import GATEWAY_IMAGE, GATEWAY_NETWORK, DockerGateway, GatewayError
|
||||||
|
|
||||||
DEFAULT_PORT = 8099
|
DEFAULT_PORT = 8099
|
||||||
@@ -41,7 +41,7 @@ ORCHESTRATOR_IMAGE = os.environ.get(
|
|||||||
ORCHESTRATOR_DOCKERFILE = "Dockerfile.orchestrator"
|
ORCHESTRATOR_DOCKERFILE = "Dockerfile.orchestrator"
|
||||||
# Baked onto the container as a label so `ensure_running` can tell whether the
|
# Baked onto the container as a label so `ensure_running` can tell whether the
|
||||||
# running process is executing the *current* bind-mounted source — see
|
# running process is executing the *current* bind-mounted source — see
|
||||||
# `_source_hash`.
|
# `source_hash`.
|
||||||
ORCHESTRATOR_SOURCE_HASH_LABEL = "bot-bottle-orchestrator-source-hash"
|
ORCHESTRATOR_SOURCE_HASH_LABEL = "bot-bottle-orchestrator-source-hash"
|
||||||
|
|
||||||
# The repo root is bind-mounted into the control-plane container so
|
# The repo root is bind-mounted into the control-plane container so
|
||||||
@@ -60,7 +60,7 @@ class OrchestratorStartError(RuntimeError):
|
|||||||
"""The orchestrator container did not become healthy within the timeout."""
|
"""The orchestrator container did not become healthy within the timeout."""
|
||||||
|
|
||||||
|
|
||||||
def _source_hash(repo_root: Path) -> str:
|
def source_hash(repo_root: Path) -> str:
|
||||||
"""Content hash of the orchestrator's bind-mounted Python source (the
|
"""Content hash of the orchestrator's bind-mounted Python source (the
|
||||||
`bot_bottle` package the control-plane process imports). This only
|
`bot_bottle` package the control-plane process imports). This only
|
||||||
changes when the code that would actually run inside the container
|
changes when the code that would actually run inside the container
|
||||||
@@ -134,20 +134,24 @@ class OrchestratorService:
|
|||||||
proc = run_docker(["docker", "ps", "--filter", f"name=^/{name}$", "--format", "{{.Names}}"])
|
proc = run_docker(["docker", "ps", "--filter", f"name=^/{name}$", "--format", "{{.Names}}"])
|
||||||
return name in proc.stdout.split()
|
return name in proc.stdout.split()
|
||||||
|
|
||||||
def _run_orchestrator_container(self, source_hash: str) -> None:
|
def _run_orchestrator_container(self, current_hash: str) -> None:
|
||||||
"""Start the control-plane container (idempotent: clears a stale
|
"""Start the control-plane container (idempotent: clears a stale
|
||||||
fixed-name container first). Register-only broker → no docker socket.
|
fixed-name container first). Register-only broker → no docker socket.
|
||||||
Labels the container with `source_hash` so a later `ensure_running`
|
Labels the container with `current_hash` so a later `ensure_running`
|
||||||
can detect a real code change (see `_source_hash`)."""
|
can detect a real code change (see `source_hash`)."""
|
||||||
run_docker(["docker", "rm", "--force", self._orchestrator_name])
|
run_docker(["docker", "rm", "--force", self._orchestrator_name])
|
||||||
proc = run_docker([
|
proc = run_docker([
|
||||||
"docker", "run", "--detach",
|
"docker", "run", "--detach",
|
||||||
"--name", self._orchestrator_name,
|
"--name", self._orchestrator_name,
|
||||||
"--label", self._orchestrator_label,
|
"--label", self._orchestrator_label,
|
||||||
"--label", f"{ORCHESTRATOR_SOURCE_HASH_LABEL}={source_hash}",
|
"--label", f"{ORCHESTRATOR_SOURCE_HASH_LABEL}={current_hash}",
|
||||||
"--network", self.network,
|
"--network", self.network,
|
||||||
# Host CLI reaches the control plane here; bound to loopback so it
|
# Host CLI reaches the control plane here; bound to loopback so it
|
||||||
# is not exposed on the host's external interfaces.
|
# is not exposed on the host's external interfaces. NOTE: the
|
||||||
|
# container is still on `self.network` (the shared gateway network),
|
||||||
|
# so agents can reach it by container IP — which is exactly why the
|
||||||
|
# control plane requires the secret below rather than trusting the
|
||||||
|
# network boundary.
|
||||||
"--publish", f"127.0.0.1:{self.port}:{self.port}",
|
"--publish", f"127.0.0.1:{self.port}:{self.port}",
|
||||||
"--volume", f"{self._repo_root}:{_APP_DIR}:ro",
|
"--volume", f"{self._repo_root}:{_APP_DIR}:ro",
|
||||||
"--workdir", _APP_DIR,
|
"--workdir", _APP_DIR,
|
||||||
@@ -155,11 +159,15 @@ class OrchestratorService:
|
|||||||
# orchestrator opens bot-bottle.db).
|
# orchestrator opens bot-bottle.db).
|
||||||
"--volume", f"{self._host_root}:{_ROOT_IN_CONTAINER}",
|
"--volume", f"{self._host_root}:{_ROOT_IN_CONTAINER}",
|
||||||
"--env", f"BOT_BOTTLE_ROOT={_ROOT_IN_CONTAINER}",
|
"--env", f"BOT_BOTTLE_ROOT={_ROOT_IN_CONTAINER}",
|
||||||
|
# The control-plane secret it requires on every route but /health.
|
||||||
|
# Bare `--env NAME` → docker inherits the value from the run env
|
||||||
|
# below, so the secret never lands on argv / `docker inspect`.
|
||||||
|
"--env", CONTROL_PLANE_TOKEN_ENV,
|
||||||
"--entrypoint", "python3",
|
"--entrypoint", "python3",
|
||||||
self.image,
|
self.image,
|
||||||
"-m", "bot_bottle.orchestrator",
|
"-m", "bot_bottle.orchestrator",
|
||||||
"--host", "0.0.0.0", "--port", str(self.port), "--broker", "stub",
|
"--host", "0.0.0.0", "--port", str(self.port), "--broker", "stub",
|
||||||
])
|
], env={**os.environ, CONTROL_PLANE_TOKEN_ENV: host_control_plane_token()})
|
||||||
if proc.returncode != 0:
|
if proc.returncode != 0:
|
||||||
raise OrchestratorStartError(
|
raise OrchestratorStartError(
|
||||||
f"orchestrator container failed to start: {proc.stderr.strip()}"
|
f"orchestrator container failed to start: {proc.stderr.strip()}"
|
||||||
@@ -224,7 +232,7 @@ class OrchestratorService:
|
|||||||
# launch (the prior behaviour) would drop every other active
|
# launch (the prior behaviour) would drop every other active
|
||||||
# bottle's in-memory egress tokens each time a new bottle starts,
|
# bottle's in-memory egress tokens each time a new bottle starts,
|
||||||
# since the orchestrator process holds them only in memory (#381).
|
# since the orchestrator process holds them only in memory (#381).
|
||||||
current_hash = _source_hash(self._repo_root)
|
current_hash = source_hash(self._repo_root)
|
||||||
if self.is_healthy() and self._orchestrator_source_current(current_hash):
|
if self.is_healthy() and self._orchestrator_source_current(current_hash):
|
||||||
return self.url
|
return self.url
|
||||||
|
|
||||||
|
|||||||
+59
-1
@@ -16,6 +16,8 @@ layer (and to COPY flat into the gateway).
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import secrets
|
||||||
|
import stat
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
# The single shared host state DB. All bot-bottle SQLite stores (supervise
|
# The single shared host state DB. All bot-bottle SQLite stores (supervise
|
||||||
@@ -23,6 +25,14 @@ from pathlib import Path
|
|||||||
# TableMigrations schema_key namespaces each store's tables.
|
# TableMigrations schema_key namespaces each store's tables.
|
||||||
HOST_DB_FILENAME = "bot-bottle.db"
|
HOST_DB_FILENAME = "bot-bottle.db"
|
||||||
|
|
||||||
|
# The per-host control-plane secret file, and the env var the launchers inject
|
||||||
|
# its value into. The control plane requires this secret on every mutating /
|
||||||
|
# reading route (see orchestrator/control_plane.py); it is held only by the
|
||||||
|
# trusted callers (control plane, gateway, host CLI) and never handed to an
|
||||||
|
# agent, so an agent that can reach the control-plane port still can't drive it.
|
||||||
|
CONTROL_PLANE_TOKEN_FILENAME = "control-plane-token"
|
||||||
|
CONTROL_PLANE_TOKEN_ENV = "BOT_BOTTLE_CONTROL_PLANE_TOKEN"
|
||||||
|
|
||||||
|
|
||||||
def bot_bottle_root() -> Path:
|
def bot_bottle_root() -> Path:
|
||||||
"""The app data root — `$BOT_BOTTLE_ROOT` if set, else `~/.bot-bottle`."""
|
"""The app data root — `$BOT_BOTTLE_ROOT` if set, else `~/.bot-bottle`."""
|
||||||
@@ -40,4 +50,52 @@ def host_db_path() -> Path:
|
|||||||
return bot_bottle_root() / "db" / HOST_DB_FILENAME
|
return bot_bottle_root() / "db" / HOST_DB_FILENAME
|
||||||
|
|
||||||
|
|
||||||
__all__ = ["HOST_DB_FILENAME", "bot_bottle_root", "host_db_path"]
|
def host_db_dir() -> Path:
|
||||||
|
"""The directory holding the shared host state DB, created if missing.
|
||||||
|
Backends bind-mount this into their gateway so the supervise daemon writes
|
||||||
|
to the one DB the orchestrator (and the operator over HTTP) reads."""
|
||||||
|
db_dir = host_db_path().parent
|
||||||
|
db_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
return db_dir
|
||||||
|
|
||||||
|
|
||||||
|
def host_control_plane_token() -> str:
|
||||||
|
"""The per-host control-plane secret, minted (256-bit, url-safe) and
|
||||||
|
persisted 0600 on first use, then reused.
|
||||||
|
|
||||||
|
This is the shared secret the launchers inject into the control-plane and
|
||||||
|
gateway containers and that the host CLI presents on every call. It is a
|
||||||
|
*host* artifact — the file lives under the root the agent never mounts, and
|
||||||
|
the env var is set only on the trusted containers — so reading it here is
|
||||||
|
safe on the host launch path but the value never reaches a bottle."""
|
||||||
|
path = bot_bottle_root() / CONTROL_PLANE_TOKEN_FILENAME
|
||||||
|
try:
|
||||||
|
existing = path.read_text().strip()
|
||||||
|
if existing:
|
||||||
|
return existing
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
token = secrets.token_urlsafe(32)
|
||||||
|
# Create 0600 up front (O_EXCL loses a concurrent race harmlessly — we
|
||||||
|
# re-read the winner's token below) so the secret is never briefly world-
|
||||||
|
# readable between write and chmod.
|
||||||
|
try:
|
||||||
|
fd = os.open(path, os.O_WRONLY | os.O_CREAT | os.O_EXCL, 0o600)
|
||||||
|
except FileExistsError:
|
||||||
|
return path.read_text().strip()
|
||||||
|
with os.fdopen(fd, "w") as f:
|
||||||
|
f.write(token)
|
||||||
|
os.chmod(path, stat.S_IRUSR | stat.S_IWUSR)
|
||||||
|
return token
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"HOST_DB_FILENAME",
|
||||||
|
"CONTROL_PLANE_TOKEN_FILENAME",
|
||||||
|
"CONTROL_PLANE_TOKEN_ENV",
|
||||||
|
"bot_bottle_root",
|
||||||
|
"host_db_path",
|
||||||
|
"host_db_dir",
|
||||||
|
"host_control_plane_token",
|
||||||
|
]
|
||||||
|
|||||||
@@ -29,11 +29,29 @@ the gateway.
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import json
|
import json
|
||||||
|
import os
|
||||||
import urllib.error
|
import urllib.error
|
||||||
import urllib.request
|
import urllib.request
|
||||||
|
|
||||||
DEFAULT_TIMEOUT_SECONDS = 2.0
|
DEFAULT_TIMEOUT_SECONDS = 2.0
|
||||||
|
|
||||||
|
# The control-plane secret this gateway presents on every /resolve call, read
|
||||||
|
# from the env the launcher injects into the gateway container. The control
|
||||||
|
# plane requires it (orchestrator/control_plane.py). Constant + env-var name are
|
||||||
|
# duplicated here rather than imported because this module is COPYed flat into
|
||||||
|
# the gateway image, free of bot-bottle imports — same rationale as
|
||||||
|
# IDENTITY_HEADER in egress_addon / git_http_backend.
|
||||||
|
CONTROL_AUTH_HEADER = "x-bot-bottle-control-auth"
|
||||||
|
CONTROL_PLANE_TOKEN_ENV = "BOT_BOTTLE_CONTROL_PLANE_TOKEN"
|
||||||
|
|
||||||
|
|
||||||
|
def _control_auth_headers() -> dict[str, str]:
|
||||||
|
"""The auth header to send, or {} when no secret is configured (an open
|
||||||
|
control plane, e.g. Firecracker behind its nft boundary — sending nothing
|
||||||
|
is correct there and harmlessly ignored)."""
|
||||||
|
token = os.environ.get(CONTROL_PLANE_TOKEN_ENV, "").strip()
|
||||||
|
return {CONTROL_AUTH_HEADER: token} if token else {}
|
||||||
|
|
||||||
|
|
||||||
class PolicyResolveError(RuntimeError):
|
class PolicyResolveError(RuntimeError):
|
||||||
"""The orchestrator was unreachable or returned an unexpected status —
|
"""The orchestrator was unreachable or returned an unexpected status —
|
||||||
@@ -57,7 +75,7 @@ class PolicyResolver:
|
|||||||
).encode()
|
).encode()
|
||||||
req = urllib.request.Request(
|
req = urllib.request.Request(
|
||||||
f"{self._base}/resolve", data=body, method="POST",
|
f"{self._base}/resolve", data=body, method="POST",
|
||||||
headers={"Content-Type": "application/json"},
|
headers={"Content-Type": "application/json", **_control_auth_headers()},
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
with urllib.request.urlopen(req, timeout=self._timeout) as resp:
|
with urllib.request.urlopen(req, timeout=self._timeout) as resp:
|
||||||
|
|||||||
@@ -358,3 +358,111 @@ the Apple Container-specific constraints directly:
|
|||||||
|
|
||||||
Do not implement the backend as a direct clone of Docker Compose
|
Do not implement the backend as a direct clone of Docker Compose
|
||||||
service aliases. That assumption failed in this run.
|
service aliases. That assumption failed in this run.
|
||||||
|
|
||||||
|
## Addendum: consolidated-gateway findings (2026-07-17, PRD 0070)
|
||||||
|
|
||||||
|
Re-tested on Apple Container 1.0.0 while porting the backend to the
|
||||||
|
per-host consolidated gateway (#351). The two-network shape above still
|
||||||
|
holds; these are the additional constraints that shaped the port, each
|
||||||
|
verified against the live CLI on this host.
|
||||||
|
|
||||||
|
### No static IP for a container
|
||||||
|
|
||||||
|
`container run --network` accepts only
|
||||||
|
`<name>[,mac=XX:XX:XX:XX:XX:XX][,mtu=VALUE]`. There is no `--ip`. The
|
||||||
|
address comes from vmnet's DHCP and is knowable only after the container
|
||||||
|
is running:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ container run --name a --network bb-net --detach alpine sleep 900
|
||||||
|
$ container inspect a | jq -r '.[0].status.networks[0].ipv4Address'
|
||||||
|
192.168.128.3/24
|
||||||
|
```
|
||||||
|
|
||||||
|
Consequence: the docker backend's "allocate a free IP -> pin it with
|
||||||
|
`--ip` -> register -> launch" order cannot be reproduced. macOS inverts
|
||||||
|
it to "launch -> read the assigned address -> register". The identity
|
||||||
|
token therefore cannot be in the agent's run-time env (registration mints
|
||||||
|
it after the container exists) and is delivered at `container exec` time.
|
||||||
|
|
||||||
|
### Networks are fixed at run time
|
||||||
|
|
||||||
|
There is no `container network connect`; `container network` exposes only
|
||||||
|
`create`, `delete`, `list`, `inspect`, `prune`. A network cannot be
|
||||||
|
attached to a running container, so a *persistent* shared gateway rules
|
||||||
|
out per-bottle networks — they would force a gateway restart per launch.
|
||||||
|
One shared host-only network, created up front, is the only shape that
|
||||||
|
keeps the gateway a singleton.
|
||||||
|
|
||||||
|
### No container DNS
|
||||||
|
|
||||||
|
Containers cannot resolve each other by name; the host-only network's
|
||||||
|
resolver refuses the query:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ container exec agent nslookup gw
|
||||||
|
;; connection timed out; no servers could be reached
|
||||||
|
$ container exec agent cat /etc/resolv.conf
|
||||||
|
nameserver 192.168.128.1
|
||||||
|
```
|
||||||
|
|
||||||
|
Consequence: the gateway is handed the control plane's **IP**, not a
|
||||||
|
container name as on docker. That forces the startup order
|
||||||
|
orchestrator -> read its address -> gateway.
|
||||||
|
|
||||||
|
### The host can reach the host-only network directly
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ container inspect c | jq -r '.[0].status.networks[0].ipv4Address'
|
||||||
|
192.168.128.2/24
|
||||||
|
$ curl -s http://192.168.128.2:8099/i
|
||||||
|
ok
|
||||||
|
```
|
||||||
|
|
||||||
|
So no `--publish` hop is needed: the host CLI and the gateway use the
|
||||||
|
same control-plane URL. Docker needs `--publish 127.0.0.1:...` plus a
|
||||||
|
separate internal URL for the same job.
|
||||||
|
|
||||||
|
### CAP_NET_RAW is granted by default — and matters for attribution
|
||||||
|
|
||||||
|
Apple grants NET_RAW but not NET_ADMIN. The agent therefore cannot change
|
||||||
|
its own address or route:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ container exec agent ip addr add 192.168.128.99/24 dev eth0
|
||||||
|
ip: RTNETLINK answers: Operation not permitted
|
||||||
|
$ container exec agent ip route replace default via 192.168.128.2 dev eth0
|
||||||
|
ip: RTNETLINK answers: Operation not permitted
|
||||||
|
$ container exec agent grep CapEff /proc/self/status
|
||||||
|
CapEff: 00000000a80425fb # bit 13 (NET_RAW) set, bit 12 (NET_ADMIN) clear
|
||||||
|
```
|
||||||
|
|
||||||
|
But NET_RAW permits raw sockets, i.e. source-address forgery against
|
||||||
|
neighbours on the shared segment — directly against PRD 0070's invariant
|
||||||
|
("a packet's source address, as seen by the orchestrator, provably
|
||||||
|
identifies the originating bottle"). `--cap-drop CAP_NET_RAW` closes it:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ container run --cap-drop CAP_NET_RAW ... alpine
|
||||||
|
$ container exec nr grep CapEff /proc/self/status
|
||||||
|
CapEff: 00000000a80405fb # bit 13 cleared
|
||||||
|
$ container exec nr ping -c1 192.168.128.2
|
||||||
|
ping: permission denied (are you root?)
|
||||||
|
```
|
||||||
|
|
||||||
|
The agent is run with `--cap-drop CAP_NET_RAW` for this reason.
|
||||||
|
|
||||||
|
### `container exec` inherits run-time env, and `--env` overrides it
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ container run --name e --env FOO=from_run --detach alpine sleep 120
|
||||||
|
$ container exec e sh -c 'echo $FOO'
|
||||||
|
from_run
|
||||||
|
$ container exec --env FOO=from_exec e sh -c 'echo $FOO'
|
||||||
|
from_exec
|
||||||
|
```
|
||||||
|
|
||||||
|
This is what makes exec-time identity-token delivery work: the token-less
|
||||||
|
proxy URL baked in at launch is superseded by the token-bearing one at
|
||||||
|
exec. Bare `--env NAME` (inherit from the parent process) keeps the token
|
||||||
|
value off argv.
|
||||||
|
|||||||
@@ -247,7 +247,7 @@ class TestHasBackend(unittest.TestCase):
|
|||||||
class TestEnsureOrchestrator(unittest.TestCase):
|
class TestEnsureOrchestrator(unittest.TestCase):
|
||||||
"""The backend-agnostic orchestrator bring-up entry point. Docker starts
|
"""The backend-agnostic orchestrator bring-up entry point. Docker starts
|
||||||
the orchestrator + gateway containers; firecracker boots the infra VM;
|
the orchestrator + gateway containers; firecracker boots the infra VM;
|
||||||
backends without one (macos-container) die with a pointer."""
|
macos-container starts the infra container."""
|
||||||
|
|
||||||
def test_docker_delegates_to_orchestrator_service(self):
|
def test_docker_delegates_to_orchestrator_service(self):
|
||||||
b = get_bottle_backend("docker")
|
b = get_bottle_backend("docker")
|
||||||
@@ -272,11 +272,16 @@ class TestEnsureOrchestrator(unittest.TestCase):
|
|||||||
url = b.ensure_orchestrator()
|
url = b.ensure_orchestrator()
|
||||||
self.assertEqual(url, "http://10.243.255.1:8099")
|
self.assertEqual(url, "http://10.243.255.1:8099")
|
||||||
|
|
||||||
def test_macos_default_dies(self):
|
def test_macos_delegates_to_infra_container(self):
|
||||||
from bot_bottle.log import Die
|
|
||||||
b = get_bottle_backend("macos-container")
|
b = get_bottle_backend("macos-container")
|
||||||
with self.assertRaises(Die):
|
with patch(
|
||||||
b.ensure_orchestrator()
|
"bot_bottle.backend.macos_container.infra.MacosInfraService"
|
||||||
|
) as service_cls:
|
||||||
|
service_cls.return_value.ensure_running.return_value.control_plane_url = (
|
||||||
|
"http://192.168.128.2:8099"
|
||||||
|
)
|
||||||
|
url = b.ensure_orchestrator()
|
||||||
|
self.assertEqual(url, "http://192.168.128.2:8099")
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -0,0 +1,136 @@
|
|||||||
|
"""Unit: macOS consolidated launch — register-after-start (PRD 0070)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import MagicMock, Mock, patch
|
||||||
|
|
||||||
|
from bot_bottle.backend.macos_container.consolidated_launch import (
|
||||||
|
GatewayEndpoint,
|
||||||
|
ensure_gateway,
|
||||||
|
register_agent,
|
||||||
|
teardown_consolidated,
|
||||||
|
)
|
||||||
|
from bot_bottle.egress import EgressPlan, EgressRoute
|
||||||
|
from bot_bottle.git_gate import GitGatePlan
|
||||||
|
from bot_bottle.orchestrator.client import RegisteredBottle
|
||||||
|
|
||||||
|
_MOD = "bot_bottle.backend.macos_container.consolidated_launch"
|
||||||
|
|
||||||
|
|
||||||
|
def _egress_plan() -> EgressPlan:
|
||||||
|
return EgressPlan(
|
||||||
|
slug="demo", routes_path=Path("/x"),
|
||||||
|
routes=(EgressRoute(host="api.example.com"),), token_env_map={},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _git_plan() -> GitGatePlan:
|
||||||
|
return GitGatePlan(
|
||||||
|
slug="demo", entrypoint_script=Path(), hook_script=Path(),
|
||||||
|
access_hook_script=Path(), upstreams=(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _endpoint() -> GatewayEndpoint:
|
||||||
|
return GatewayEndpoint(
|
||||||
|
orchestrator_url="http://192.168.128.2:8099",
|
||||||
|
gateway_ip="192.168.128.3",
|
||||||
|
gateway_ca_pem="-----BEGIN CERTIFICATE-----\n",
|
||||||
|
network="bot-bottle-mac-gateway",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _client() -> Mock:
|
||||||
|
c = Mock()
|
||||||
|
c.register_bottle.return_value = RegisteredBottle("b1", "tok")
|
||||||
|
return c
|
||||||
|
|
||||||
|
|
||||||
|
class TestEnsureGateway(unittest.TestCase):
|
||||||
|
def _run(self, service: MagicMock) -> GatewayEndpoint:
|
||||||
|
with patch(f"{_MOD}.MacosInfraService", return_value=service):
|
||||||
|
return ensure_gateway()
|
||||||
|
|
||||||
|
def _service(self) -> MagicMock:
|
||||||
|
from bot_bottle.backend.macos_container.infra import InfraEndpoint
|
||||||
|
service = MagicMock()
|
||||||
|
service.ensure_running.return_value = InfraEndpoint(
|
||||||
|
control_plane_url="http://192.168.128.2:8099",
|
||||||
|
gateway_ip="192.168.128.2",
|
||||||
|
)
|
||||||
|
service.network = "bot-bottle-mac-gateway"
|
||||||
|
service.ca_cert_pem.return_value = "PEM"
|
||||||
|
return service
|
||||||
|
|
||||||
|
def test_reports_gateway_endpoint(self) -> None:
|
||||||
|
endpoint = self._run(self._service())
|
||||||
|
self.assertEqual("http://192.168.128.2:8099", endpoint.orchestrator_url)
|
||||||
|
self.assertEqual("192.168.128.2", endpoint.gateway_ip)
|
||||||
|
self.assertEqual("PEM", endpoint.gateway_ca_pem)
|
||||||
|
self.assertEqual("bot-bottle-mac-gateway", endpoint.network)
|
||||||
|
|
||||||
|
def test_control_plane_and_gateway_share_one_address(self) -> None:
|
||||||
|
"""One infra container hosts both, so the gateway IP and the
|
||||||
|
control-plane host are the same."""
|
||||||
|
endpoint = self._run(self._service())
|
||||||
|
self.assertEqual(
|
||||||
|
endpoint.gateway_ip,
|
||||||
|
endpoint.orchestrator_url.split("://")[1].split(":")[0],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestRegisterAgent(unittest.TestCase):
|
||||||
|
def _run(
|
||||||
|
self, client: Mock, provision: Mock | None = None,
|
||||||
|
*, source_ip: str = "192.168.128.9",
|
||||||
|
):
|
||||||
|
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
|
patch(f"{_MOD}.provision_git_gate", provision or Mock()):
|
||||||
|
return register_agent(
|
||||||
|
_egress_plan(), _git_plan(),
|
||||||
|
source_ip=source_ip, endpoint=_endpoint(), image_ref="img:1",
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_registers_by_the_address_read_from_the_live_container(self) -> None:
|
||||||
|
"""The attribution key is the DHCP-assigned address the caller read
|
||||||
|
back — there is no --ip to pin it up front."""
|
||||||
|
client = _client()
|
||||||
|
ctx = self._run(client, source_ip="192.168.128.9")
|
||||||
|
self.assertEqual("192.168.128.9", ctx.source_ip)
|
||||||
|
self.assertEqual("192.168.128.9", client.register_bottle.call_args.args[0])
|
||||||
|
|
||||||
|
def test_returns_identity_token_and_bottle_id(self) -> None:
|
||||||
|
ctx = self._run(_client())
|
||||||
|
self.assertEqual("b1", ctx.bottle_id)
|
||||||
|
self.assertEqual("tok", ctx.identity_token)
|
||||||
|
|
||||||
|
def test_provisions_git_gate_for_the_registered_bottle(self) -> None:
|
||||||
|
provision = Mock()
|
||||||
|
self._run(_client(), provision)
|
||||||
|
self.assertEqual("b1", provision.call_args.args[1])
|
||||||
|
|
||||||
|
def test_rolls_registration_back_when_provisioning_fails(self) -> None:
|
||||||
|
"""A provisioning failure must not leave an orphan registration
|
||||||
|
holding the source IP."""
|
||||||
|
client = _client()
|
||||||
|
provision = Mock(side_effect=RuntimeError("boom"))
|
||||||
|
with self.assertRaises(RuntimeError):
|
||||||
|
self._run(client, provision)
|
||||||
|
client.teardown_bottle.assert_called_once_with("b1")
|
||||||
|
|
||||||
|
|
||||||
|
class TestTeardown(unittest.TestCase):
|
||||||
|
def test_deregisters_and_deprovisions(self) -> None:
|
||||||
|
client = Mock()
|
||||||
|
deprovision = Mock()
|
||||||
|
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
|
patch(f"{_MOD}.deprovision_git_gate", deprovision):
|
||||||
|
teardown_consolidated("b1", orchestrator_url="http://o:8099")
|
||||||
|
client.teardown_bottle.assert_called_once_with("b1")
|
||||||
|
self.assertEqual("b1", deprovision.call_args.args[1])
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -43,10 +43,31 @@ class TestMacosContainerCleanup(unittest.TestCase):
|
|||||||
|
|
||||||
|
|
||||||
class TestMacosContainerEnumerate(unittest.TestCase):
|
class TestMacosContainerEnumerate(unittest.TestCase):
|
||||||
def test_enumerate_active_is_empty_while_disabled(self):
|
"""The backend launches bottles again (PRD 0070), so enumeration is real
|
||||||
# The macOS backend is disabled during the companion-container removal cleanup
|
rather than the disabled-era stub. These must not shell out: `container`
|
||||||
# (#385); it launches nothing, so there is nothing to enumerate.
|
does not exist on the Linux CI host."""
|
||||||
self.assertEqual([], enum_mod.enumerate_active())
|
|
||||||
|
def _enumerate(self, stdout: str, returncode: int = 0):
|
||||||
|
completed = enum_mod.subprocess.CompletedProcess(
|
||||||
|
args=[], returncode=returncode, stdout=stdout, stderr="",
|
||||||
|
)
|
||||||
|
with patch.object(enum_mod.subprocess, "run", return_value=completed), \
|
||||||
|
patch.object(enum_mod, "read_metadata", return_value=None):
|
||||||
|
return enum_mod.enumerate_active()
|
||||||
|
|
||||||
|
def test_lists_agent_containers_by_slug(self):
|
||||||
|
agents = self._enumerate("bot-bottle-dev-abc\nunrelated\n")
|
||||||
|
self.assertEqual(["dev-abc"], [a.slug for a in agents])
|
||||||
|
self.assertEqual(["macos-container"], [a.backend_name for a in agents])
|
||||||
|
|
||||||
|
def test_excludes_the_infra_singleton(self):
|
||||||
|
"""The infra container shares the bot-bottle- prefix but is
|
||||||
|
infrastructure — listing it would invent an agent per host."""
|
||||||
|
agents = self._enumerate("bot-bottle-mac-infra\nbot-bottle-dev-abc\n")
|
||||||
|
self.assertEqual(["dev-abc"], [a.slug for a in agents])
|
||||||
|
|
||||||
|
def test_empty_when_the_cli_fails(self):
|
||||||
|
self.assertEqual([], self._enumerate("", returncode=1))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -0,0 +1,210 @@
|
|||||||
|
"""Unit: macOS agent run wiring — the attribution invariant + token delivery
|
||||||
|
(PRD 0070).
|
||||||
|
|
||||||
|
Replaces the argv coverage from the per-bottle companion-container era
|
||||||
|
(`test_macos_container_launch.py`, removed with that architecture in #385).
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from typing import cast
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from bot_bottle.backend.macos_container.bottle import MacosContainerBottle
|
||||||
|
from bot_bottle.backend.macos_container.bottle_plan import MacosContainerBottlePlan
|
||||||
|
from bot_bottle.backend.macos_container.consolidated_launch import GatewayEndpoint
|
||||||
|
from bot_bottle.backend.macos_container.launch import (
|
||||||
|
_agent_run_argv,
|
||||||
|
_identity_proxy_env,
|
||||||
|
_proxy_url,
|
||||||
|
)
|
||||||
|
from bot_bottle.manifest import ManifestIndex
|
||||||
|
|
||||||
|
_BOTTLE = "bot_bottle.backend.macos_container.bottle"
|
||||||
|
|
||||||
|
_MANIFEST = ManifestIndex.from_json_obj({
|
||||||
|
"bottles": {"dev": {}},
|
||||||
|
"agents": {"demo": {"skills": [], "prompt": "", "bottle": "dev"}},
|
||||||
|
}).load_for_agent("demo")
|
||||||
|
|
||||||
|
|
||||||
|
def _endpoint() -> GatewayEndpoint:
|
||||||
|
return GatewayEndpoint(
|
||||||
|
orchestrator_url="http://192.168.128.2:8099",
|
||||||
|
gateway_ip="192.168.128.3",
|
||||||
|
gateway_ca_pem="PEM",
|
||||||
|
network="bot-bottle-mac-gateway",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _plan(
|
||||||
|
stage_dir: Path,
|
||||||
|
*,
|
||||||
|
agent_git_gate_url: str = "",
|
||||||
|
agent_supervise_url: str = "",
|
||||||
|
) -> MacosContainerBottlePlan:
|
||||||
|
routes_path = stage_dir / "routes.yaml"
|
||||||
|
routes_path.write_text("routes: []\n", encoding="utf-8")
|
||||||
|
ca_path = stage_dir / "gateway-ca.pem"
|
||||||
|
ca_path.write_text("ca\n", encoding="utf-8")
|
||||||
|
egress_plan = SimpleNamespace(
|
||||||
|
mitmproxy_ca_host_path=ca_path,
|
||||||
|
routes_path=routes_path,
|
||||||
|
routes=("route",),
|
||||||
|
token_env_map={"EGRESS_TOKEN_0": "HOST_TOKEN"},
|
||||||
|
canary="",
|
||||||
|
canary_env="",
|
||||||
|
)
|
||||||
|
return cast(MacosContainerBottlePlan, SimpleNamespace(
|
||||||
|
spec=SimpleNamespace(),
|
||||||
|
manifest=_MANIFEST,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
slug="dev-abc",
|
||||||
|
container_name="bot-bottle-dev-abc",
|
||||||
|
image="bot-bottle-agent:latest",
|
||||||
|
forwarded_env={"OAUTH_TOKEN": "host-value"},
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
git_gate_plan=SimpleNamespace(upstreams=()),
|
||||||
|
supervise_plan=None,
|
||||||
|
agent_provision=SimpleNamespace(
|
||||||
|
guest_env={"LITERAL": "value"},
|
||||||
|
provisioned_env={},
|
||||||
|
),
|
||||||
|
agent_git_gate_url=agent_git_gate_url,
|
||||||
|
agent_supervise_url=agent_supervise_url,
|
||||||
|
))
|
||||||
|
|
||||||
|
|
||||||
|
class TestAgentRunArgv(unittest.TestCase):
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self._tmp = tempfile.TemporaryDirectory()
|
||||||
|
self.argv = _agent_run_argv(_plan(Path(self._tmp.name)), _endpoint())
|
||||||
|
|
||||||
|
def tearDown(self) -> None:
|
||||||
|
self._tmp.cleanup()
|
||||||
|
|
||||||
|
def test_drops_net_raw(self) -> None:
|
||||||
|
"""The attribution invariant: Apple grants CAP_NET_RAW by default,
|
||||||
|
which would let an agent forge a neighbour's source address with a raw
|
||||||
|
socket and be attributed as that bottle."""
|
||||||
|
self.assertIn("--cap-drop", self.argv)
|
||||||
|
self.assertEqual("CAP_NET_RAW", self.argv[self.argv.index("--cap-drop") + 1])
|
||||||
|
|
||||||
|
def test_attaches_to_the_shared_gateway_network(self) -> None:
|
||||||
|
self.assertEqual(
|
||||||
|
"bot-bottle-mac-gateway", self.argv[self.argv.index("--network") + 1],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_never_pins_an_ip(self) -> None:
|
||||||
|
"""Apple Container 1.0.0 has no --ip: the address is DHCP-assigned and
|
||||||
|
read back after start."""
|
||||||
|
self.assertNotIn("--ip", self.argv)
|
||||||
|
|
||||||
|
def test_run_time_proxy_carries_no_identity_token(self) -> None:
|
||||||
|
"""The token is minted by registration, which happens after this run —
|
||||||
|
so it cannot be here. `/resolve` denies the token-less pair (#366),
|
||||||
|
which is the safe direction; the real value arrives at exec time."""
|
||||||
|
joined = " ".join(self.argv)
|
||||||
|
self.assertIn(f"HTTP_PROXY={_proxy_url('192.168.128.3')}", joined)
|
||||||
|
self.assertNotIn("bottle:", joined)
|
||||||
|
|
||||||
|
def test_gateway_bypasses_the_proxy(self) -> None:
|
||||||
|
"""git-http + supervise live on the gateway and must be reached
|
||||||
|
directly, not through its own egress proxy."""
|
||||||
|
entry = next(a for a in self.argv if a.startswith("NO_PROXY="))
|
||||||
|
self.assertIn("192.168.128.3", entry)
|
||||||
|
|
||||||
|
def test_forwarded_secrets_stay_off_argv(self) -> None:
|
||||||
|
"""Bare name → inherited from the run process env, so the value never
|
||||||
|
lands on the command line."""
|
||||||
|
self.assertIn("OAUTH_TOKEN", self.argv)
|
||||||
|
self.assertNotIn("host-value", " ".join(self.argv))
|
||||||
|
|
||||||
|
def test_agent_init_is_a_no_op(self) -> None:
|
||||||
|
"""Every agent command arrives via `container exec`; the init process
|
||||||
|
just holds the container open."""
|
||||||
|
self.assertEqual("sleep", self.argv[-2])
|
||||||
|
|
||||||
|
|
||||||
|
class TestIdentityTokenDelivery(unittest.TestCase):
|
||||||
|
def test_exec_env_carries_the_token_as_proxy_credentials(self) -> None:
|
||||||
|
env = _identity_proxy_env(_endpoint(), "s3cret")
|
||||||
|
self.assertEqual(
|
||||||
|
"http://bottle:s3cret@192.168.128.3:9099", env["HTTP_PROXY"],
|
||||||
|
)
|
||||||
|
self.assertEqual(env["HTTP_PROXY"], env["https_proxy"])
|
||||||
|
|
||||||
|
def test_no_token_means_no_override(self) -> None:
|
||||||
|
self.assertEqual({}, _identity_proxy_env(_endpoint(), ""))
|
||||||
|
|
||||||
|
def test_token_value_never_reaches_argv(self) -> None:
|
||||||
|
"""`ps` is world-readable: the token rides the child env behind a bare
|
||||||
|
`--env` name, never the command line."""
|
||||||
|
bottle = MacosContainerBottle(
|
||||||
|
"bot-bottle-demo", lambda: None, None,
|
||||||
|
exec_env=_identity_proxy_env(_endpoint(), "s3cret"),
|
||||||
|
)
|
||||||
|
argv = bottle.agent_argv(["--help"], tty=False)
|
||||||
|
self.assertNotIn("s3cret", " ".join(argv))
|
||||||
|
self.assertIn("HTTP_PROXY", argv)
|
||||||
|
self.assertEqual("--env", argv[argv.index("HTTP_PROXY") - 1])
|
||||||
|
|
||||||
|
def test_bottle_without_exec_env_is_unchanged(self) -> None:
|
||||||
|
bottle = MacosContainerBottle("bot-bottle-demo", lambda: None, None)
|
||||||
|
argv = bottle.agent_argv(["--help"], tty=False)
|
||||||
|
self.assertNotIn("--env", argv)
|
||||||
|
|
||||||
|
|
||||||
|
class TestPlanIdentityToken(unittest.TestCase):
|
||||||
|
"""git-gate's gitconfig extraHeader and the supervise MCP --header read
|
||||||
|
`getattr(plan, "identity_token", "")` at provision time and both bypass the
|
||||||
|
egress proxy (NO_PROXY), so the exec-time proxy token never reaches them —
|
||||||
|
the plan must carry the token or /resolve fail-closes and git + supervise
|
||||||
|
are denied on macOS."""
|
||||||
|
|
||||||
|
def test_macos_plan_has_the_identity_token_field(self) -> None:
|
||||||
|
from dataclasses import fields
|
||||||
|
|
||||||
|
from bot_bottle.backend.macos_container.bottle_plan import (
|
||||||
|
MacosContainerBottlePlan,
|
||||||
|
)
|
||||||
|
names = {f.name for f in fields(MacosContainerBottlePlan)}
|
||||||
|
self.assertIn("identity_token", names)
|
||||||
|
|
||||||
|
def test_matches_the_docker_plan(self) -> None:
|
||||||
|
"""Both consolidated backends must expose identity_token so a shared
|
||||||
|
provision-time consumer degrades to neither backend silently."""
|
||||||
|
from dataclasses import fields
|
||||||
|
|
||||||
|
from bot_bottle.backend.docker.bottle_plan import DockerBottlePlan
|
||||||
|
from bot_bottle.backend.macos_container.bottle_plan import (
|
||||||
|
MacosContainerBottlePlan,
|
||||||
|
)
|
||||||
|
docker = {f.name for f in fields(DockerBottlePlan)}
|
||||||
|
macos = {f.name for f in fields(MacosContainerBottlePlan)}
|
||||||
|
self.assertIn("identity_token", docker & macos)
|
||||||
|
|
||||||
|
def test_provisioning_exec_also_carries_the_token(self) -> None:
|
||||||
|
"""`provision` runs through `exec`; a provider whose provision step
|
||||||
|
fetches anything would otherwise egress token-less and be denied."""
|
||||||
|
bottle = MacosContainerBottle(
|
||||||
|
"bot-bottle-demo", lambda: None, None,
|
||||||
|
exec_env=_identity_proxy_env(_endpoint(), "s3cret"),
|
||||||
|
)
|
||||||
|
with patch(f"{_BOTTLE}.subprocess.run") as run:
|
||||||
|
run.return_value = SimpleNamespace(returncode=0, stdout="", stderr="")
|
||||||
|
bottle.exec("echo hi")
|
||||||
|
argv, kwargs = run.call_args.args[0], run.call_args.kwargs
|
||||||
|
self.assertIn("HTTP_PROXY", argv)
|
||||||
|
self.assertNotIn("s3cret", " ".join(argv))
|
||||||
|
self.assertEqual(
|
||||||
|
"http://bottle:s3cret@192.168.128.3:9099", kwargs["env"]["HTTP_PROXY"],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -273,5 +273,55 @@ resolver #2
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _completed(stdout: str, returncode: int = 0):
|
||||||
|
return util.subprocess.CompletedProcess(args=[], returncode=returncode, stdout=stdout, stderr="")
|
||||||
|
|
||||||
|
|
||||||
|
class TestInspectDigests(unittest.TestCase):
|
||||||
|
"""image_digest and container_image_digest must read the SAME field shape
|
||||||
|
(a `descriptor.digest`) so a running container and its image are
|
||||||
|
comparable. An asymmetry recreates the gateway on every launch."""
|
||||||
|
|
||||||
|
_IMAGE = '{"configuration": {"descriptor": {"digest": "sha256:abc123"}}, "id": "abc123"}'
|
||||||
|
_CONTAINER = '[{"configuration": {"image": {"descriptor": {"digest": "sha256:abc123"}}}}]'
|
||||||
|
|
||||||
|
def test_image_and_container_digests_agree_for_the_same_image(self):
|
||||||
|
with patch.object(util, "run_container_argv") as run:
|
||||||
|
run.return_value = _completed(self._IMAGE)
|
||||||
|
img = util.image_digest("bot-bottle-gateway:latest")
|
||||||
|
run.return_value = _completed(self._CONTAINER)
|
||||||
|
ctr = util.container_image_digest("bot-bottle-mac-gateway")
|
||||||
|
self.assertEqual("abc123", img)
|
||||||
|
self.assertEqual(img, ctr)
|
||||||
|
|
||||||
|
def test_image_digest_never_falls_back_to_a_tag_or_id(self):
|
||||||
|
"""The old `id` fallback could yield a value container_image_digest
|
||||||
|
can't produce, permanently mismatching. Missing descriptor → '' (don't
|
||||||
|
churn), never a stray id/tag."""
|
||||||
|
with patch.object(util, "run_container_argv") as run:
|
||||||
|
run.return_value = _completed('{"id": "bot-bottle-gateway:latest"}')
|
||||||
|
self.assertEqual("", util.image_digest("bot-bottle-gateway:latest"))
|
||||||
|
|
||||||
|
def test_unreadable_inspect_returns_empty(self):
|
||||||
|
with patch.object(util, "run_container_argv") as run:
|
||||||
|
run.return_value = _completed("", returncode=1)
|
||||||
|
self.assertEqual("", util.image_digest("x"))
|
||||||
|
self.assertEqual("", util.container_image_digest("x"))
|
||||||
|
self.assertEqual({}, util.container_env("x"))
|
||||||
|
|
||||||
|
|
||||||
|
class TestWaitContainerIpv4(unittest.TestCase):
|
||||||
|
def test_returns_address_once_dhcp_assigns_it(self):
|
||||||
|
with patch.object(util, "try_container_ipv4_on_network", side_effect=["", "", "192.168.128.4"]), \
|
||||||
|
patch.object(util.time, "sleep"):
|
||||||
|
ip = util.wait_container_ipv4_on_network("c", "net", timeout=5, poll=0)
|
||||||
|
self.assertEqual("192.168.128.4", ip)
|
||||||
|
|
||||||
|
def test_returns_empty_on_timeout(self):
|
||||||
|
with patch.object(util, "try_container_ipv4_on_network", return_value=""), \
|
||||||
|
patch.object(util.time, "sleep"):
|
||||||
|
self.assertEqual("", util.wait_container_ipv4_on_network("c", "net", timeout=-1))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|||||||
@@ -0,0 +1,168 @@
|
|||||||
|
"""Unit: the single macOS infra container (control plane + gateway, PRD 0070)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import Mock, patch
|
||||||
|
|
||||||
|
from bot_bottle.backend.macos_container.infra import (
|
||||||
|
INFRA_DB_VOLUME,
|
||||||
|
MacosInfraService,
|
||||||
|
OrchestratorStartError,
|
||||||
|
probe_control_plane_url,
|
||||||
|
)
|
||||||
|
|
||||||
|
_INFRA = "bot_bottle.backend.macos_container.infra"
|
||||||
|
|
||||||
|
|
||||||
|
def _ok(stdout: str = "") -> Mock:
|
||||||
|
return Mock(returncode=0, stdout=stdout, stderr="")
|
||||||
|
|
||||||
|
|
||||||
|
def _fail(stderr: str = "boom") -> Mock:
|
||||||
|
return Mock(returncode=1, stdout="", stderr=stderr)
|
||||||
|
|
||||||
|
|
||||||
|
class TestInfraRun(unittest.TestCase):
|
||||||
|
def _run_container(self, svc: MacosInfraService) -> list[str]:
|
||||||
|
run = Mock(return_value=_ok())
|
||||||
|
|
||||||
|
def _spec(src: str, tgt: str, readonly: bool = False) -> str:
|
||||||
|
return f"type=bind,source={src},target={tgt}" + (
|
||||||
|
",readonly" if readonly else "")
|
||||||
|
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod, \
|
||||||
|
patch(f"{_INFRA}.ensure_networks"):
|
||||||
|
mod.dns_server.return_value = "1.1.1.1"
|
||||||
|
mod.bind_mount_spec.side_effect = _spec
|
||||||
|
mod.run_container_argv = run
|
||||||
|
svc._run_container("h1")
|
||||||
|
return run.call_args.args[0]
|
||||||
|
|
||||||
|
def test_single_container_runs_both_processes(self) -> None:
|
||||||
|
"""The whole point: one container starts the control plane AND the
|
||||||
|
gateway daemons, so one kernel owns the DB."""
|
||||||
|
argv = self._run_container(MacosInfraService(repo_root=Path("/r")))
|
||||||
|
script = argv[-1]
|
||||||
|
self.assertIn("bot_bottle.orchestrator", script)
|
||||||
|
self.assertIn("gateway_init.py", script)
|
||||||
|
self.assertIn("127.0.0.1", script) # they reach each other on loopback
|
||||||
|
|
||||||
|
def test_db_is_a_container_only_volume(self) -> None:
|
||||||
|
"""No host bind-mount of the DB — a named volume only this container
|
||||||
|
mounts, so the DB is never written by two kernels."""
|
||||||
|
argv = self._run_container(MacosInfraService(repo_root=Path("/r")))
|
||||||
|
vols = [argv[i + 1] for i, a in enumerate(argv) if a == "--volume"]
|
||||||
|
self.assertTrue(any(v.startswith(f"{INFRA_DB_VOLUME}:") for v in vols))
|
||||||
|
# The repo source is bind-mounted read-only; the DB is not a bind mount.
|
||||||
|
mounts = [argv[i + 1] for i, a in enumerate(argv) if a == "--mount"]
|
||||||
|
self.assertTrue(all("bot-bottle.db" not in m for m in mounts))
|
||||||
|
|
||||||
|
def test_nat_network_precedes_the_host_only_network(self) -> None:
|
||||||
|
argv = self._run_container(MacosInfraService(repo_root=Path("/r")))
|
||||||
|
nets = [argv[i + 1] for i, a in enumerate(argv) if a == "--network"]
|
||||||
|
self.assertEqual(["bot-bottle-mac-egress", "bot-bottle-mac-gateway"], nets)
|
||||||
|
|
||||||
|
def test_source_hash_is_labelled_for_recreate(self) -> None:
|
||||||
|
argv = self._run_container(MacosInfraService(repo_root=Path("/r")))
|
||||||
|
self.assertIn("BOT_BOTTLE_SOURCE_HASH=h1", argv)
|
||||||
|
|
||||||
|
def test_start_failure_raises(self) -> None:
|
||||||
|
svc = MacosInfraService(repo_root=Path("/r"))
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod, \
|
||||||
|
patch(f"{_INFRA}.ensure_networks"):
|
||||||
|
mod.dns_server.return_value = "1.1.1.1"
|
||||||
|
mod.bind_mount_spec.return_value = "m"
|
||||||
|
mod.run_container_argv = Mock(return_value=_fail())
|
||||||
|
with self.assertRaises(OrchestratorStartError):
|
||||||
|
svc._run_container("h1")
|
||||||
|
|
||||||
|
|
||||||
|
class TestInfraEnsureRunning(unittest.TestCase):
|
||||||
|
def test_current_healthy_container_is_left_alone(self) -> None:
|
||||||
|
"""Idempotent singleton: N launches must not churn the infra container
|
||||||
|
and drop every live bottle's control plane."""
|
||||||
|
svc = MacosInfraService(repo_root=Path("/r"))
|
||||||
|
run = Mock()
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod, \
|
||||||
|
patch(f"{_INFRA}.source_hash", return_value="h1"), \
|
||||||
|
patch.object(svc, "_run_container", run), \
|
||||||
|
patch.object(svc, "is_healthy", return_value=True):
|
||||||
|
mod.container_is_running.return_value = True
|
||||||
|
mod.container_env.return_value = {"BOT_BOTTLE_SOURCE_HASH": "h1"}
|
||||||
|
mod.try_container_ipv4_on_network.return_value = "192.168.128.2"
|
||||||
|
endpoint = svc.ensure_running()
|
||||||
|
run.assert_not_called()
|
||||||
|
self.assertEqual("http://192.168.128.2:8099", endpoint.control_plane_url)
|
||||||
|
self.assertEqual("192.168.128.2", endpoint.gateway_ip)
|
||||||
|
|
||||||
|
def test_changed_source_recreates(self) -> None:
|
||||||
|
svc = MacosInfraService(repo_root=Path("/r"))
|
||||||
|
run = Mock()
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod, \
|
||||||
|
patch(f"{_INFRA}.source_hash", return_value="h2"), \
|
||||||
|
patch.object(svc, "ensure_built"), \
|
||||||
|
patch.object(svc, "_run_container", run), \
|
||||||
|
patch.object(svc, "is_healthy", return_value=True):
|
||||||
|
mod.container_is_running.return_value = True
|
||||||
|
mod.container_env.return_value = {"BOT_BOTTLE_SOURCE_HASH": "h1"}
|
||||||
|
mod.try_container_ipv4_on_network.return_value = "192.168.128.2"
|
||||||
|
svc.ensure_running()
|
||||||
|
run.assert_called_once()
|
||||||
|
|
||||||
|
def test_wedged_but_current_container_is_recreated(self) -> None:
|
||||||
|
"""Current source but a dead HTTP server must be recreated, not polled
|
||||||
|
to death forever — health, not just the source label, gates reuse."""
|
||||||
|
svc = MacosInfraService(repo_root=Path("/r"))
|
||||||
|
run = Mock()
|
||||||
|
health = Mock(side_effect=[False, True])
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod, \
|
||||||
|
patch(f"{_INFRA}.source_hash", return_value="h1"), \
|
||||||
|
patch.object(svc, "ensure_built"), \
|
||||||
|
patch.object(svc, "_run_container", run), \
|
||||||
|
patch.object(svc, "is_healthy", health):
|
||||||
|
mod.container_is_running.return_value = True
|
||||||
|
mod.container_env.return_value = {"BOT_BOTTLE_SOURCE_HASH": "h1"}
|
||||||
|
mod.try_container_ipv4_on_network.return_value = "192.168.128.2"
|
||||||
|
svc.ensure_running()
|
||||||
|
run.assert_called_once()
|
||||||
|
|
||||||
|
def test_never_healthy_raises(self) -> None:
|
||||||
|
svc = MacosInfraService(repo_root=Path("/r"))
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod, \
|
||||||
|
patch(f"{_INFRA}.source_hash", return_value="h1"), \
|
||||||
|
patch.object(svc, "ensure_built"), \
|
||||||
|
patch.object(svc, "_run_container"), \
|
||||||
|
patch.object(svc, "is_healthy", return_value=False):
|
||||||
|
mod.container_is_running.return_value = False
|
||||||
|
mod.try_container_ipv4_on_network.return_value = "192.168.128.2"
|
||||||
|
with self.assertRaises(OrchestratorStartError):
|
||||||
|
svc.ensure_running(startup_timeout=0.01)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCaCertPem(unittest.TestCase):
|
||||||
|
def test_reads_ca_out_of_the_container(self) -> None:
|
||||||
|
svc = MacosInfraService(repo_root=Path("/r"))
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod:
|
||||||
|
mod.run_container_argv.return_value = _ok("-----BEGIN CERTIFICATE-----\n")
|
||||||
|
pem = svc.ca_cert_pem()
|
||||||
|
self.assertTrue(pem.startswith("-----BEGIN CERTIFICATE-----"))
|
||||||
|
argv = mod.run_container_argv.call_args.args[0]
|
||||||
|
self.assertEqual(["container", "exec", "bot-bottle-mac-infra", "cat"], argv[:4])
|
||||||
|
|
||||||
|
|
||||||
|
class TestProbeControlPlane(unittest.TestCase):
|
||||||
|
def test_returns_url_when_running(self) -> None:
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod:
|
||||||
|
mod.try_container_ipv4_on_network.return_value = "192.168.128.2"
|
||||||
|
self.assertEqual("http://192.168.128.2:8099", probe_control_plane_url())
|
||||||
|
|
||||||
|
def test_empty_when_absent(self) -> None:
|
||||||
|
with patch(f"{_INFRA}.container_mod") as mod:
|
||||||
|
mod.try_container_ipv4_on_network.return_value = ""
|
||||||
|
self.assertEqual("", probe_control_plane_url())
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -11,6 +11,7 @@ import secrets
|
|||||||
import tempfile
|
import tempfile
|
||||||
import threading
|
import threading
|
||||||
import unittest
|
import unittest
|
||||||
|
import urllib.error
|
||||||
import urllib.request
|
import urllib.request
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
@@ -243,6 +244,82 @@ class TestServerRoundTrip(unittest.TestCase):
|
|||||||
self.assertEqual(reg["bottle_id"], attr["bottle_id"])
|
self.assertEqual(reg["bottle_id"], attr["bottle_id"])
|
||||||
|
|
||||||
|
|
||||||
|
class TestControlPlaneAuth(unittest.TestCase):
|
||||||
|
"""The per-host control-plane secret (issue #400): every route but /health
|
||||||
|
is a trusted-caller op an agent must not be able to drive just because it
|
||||||
|
can reach the port."""
|
||||||
|
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self._tmp = tempfile.TemporaryDirectory()
|
||||||
|
self.addCleanup(self._tmp.cleanup)
|
||||||
|
self.orch = _orchestrator(Path(self._tmp.name) / "r.db")
|
||||||
|
|
||||||
|
def test_health_is_public_even_unauthorized(self) -> None:
|
||||||
|
status, _ = dispatch(self.orch, "GET", "/health", b"", authorized=False)
|
||||||
|
self.assertEqual(200, status)
|
||||||
|
|
||||||
|
def test_unauthorized_denies_every_other_route(self) -> None:
|
||||||
|
for method, path, body in [
|
||||||
|
("GET", "/bottles", b""),
|
||||||
|
("POST", "/bottles", _body({"source_ip": "10.0.0.1"})),
|
||||||
|
("PUT", "/bottles/x/policy", _body({"policy": "routes: []"})),
|
||||||
|
("DELETE", "/bottles/x", b""),
|
||||||
|
("POST", "/resolve", _body({"source_ip": "10.0.0.1", "identity_token": "t"})),
|
||||||
|
("POST", "/attribute", _body({"source_ip": "10.0.0.1", "identity_token": "t"})),
|
||||||
|
("GET", "/supervise/proposals", b""),
|
||||||
|
("POST", "/supervise/respond", _body({"proposal_id": "p", "bottle_slug": "s", "decision": "approve"})),
|
||||||
|
]:
|
||||||
|
status, _ = dispatch(self.orch, method, path, body, authorized=False)
|
||||||
|
self.assertEqual(401, status, f"{method} {path} should be 401 unauthorized")
|
||||||
|
|
||||||
|
def test_deny_happens_before_the_registry_is_touched(self) -> None:
|
||||||
|
"""An unauthorized DELETE must not tear a bottle down. 401, and the
|
||||||
|
bottle is still there."""
|
||||||
|
rec = self.orch.registry.register("10.0.0.9", policy="", metadata="")
|
||||||
|
status, _ = dispatch(
|
||||||
|
self.orch, "DELETE", f"/bottles/{rec.bottle_id}", b"", authorized=False)
|
||||||
|
self.assertEqual(401, status)
|
||||||
|
self.assertIsNotNone(self.orch.registry.get(rec.bottle_id))
|
||||||
|
|
||||||
|
def _server_with_secret(self, secret: str):
|
||||||
|
with patch.dict("os.environ", {"BOT_BOTTLE_CONTROL_PLANE_TOKEN": secret}):
|
||||||
|
server = make_server(self.orch, "127.0.0.1", 0)
|
||||||
|
self.addCleanup(server.server_close)
|
||||||
|
threading.Thread(target=server.serve_forever, daemon=True).start()
|
||||||
|
self.addCleanup(server.shutdown)
|
||||||
|
host, port = server.server_address[0], server.server_address[1]
|
||||||
|
return f"http://{host}:{port}"
|
||||||
|
|
||||||
|
def _status(self, url: str, *, header: str | None = None) -> int:
|
||||||
|
req = urllib.request.Request(url)
|
||||||
|
if header is not None:
|
||||||
|
req.add_header("x-bot-bottle-control-auth", header)
|
||||||
|
try:
|
||||||
|
return urllib.request.urlopen(req, timeout=5).status
|
||||||
|
except urllib.error.HTTPError as e:
|
||||||
|
return e.code
|
||||||
|
|
||||||
|
def test_configured_server_enforces_the_header_over_http(self) -> None:
|
||||||
|
base = self._server_with_secret("s3cret-admin")
|
||||||
|
# /health is public — no header needed.
|
||||||
|
self.assertEqual(200, self._status(f"{base}/health"))
|
||||||
|
# /bottles requires the secret.
|
||||||
|
self.assertEqual(401, self._status(f"{base}/bottles"))
|
||||||
|
self.assertEqual(401, self._status(f"{base}/bottles", header="wrong"))
|
||||||
|
self.assertEqual(200, self._status(f"{base}/bottles", header="s3cret-admin"))
|
||||||
|
|
||||||
|
def test_unconfigured_server_runs_open(self) -> None:
|
||||||
|
"""No secret set (tests / nft-protected Firecracker): open mode, so the
|
||||||
|
existing round-trip and unit behavior are unchanged."""
|
||||||
|
with patch.dict("os.environ", {}, clear=False):
|
||||||
|
import os
|
||||||
|
os.environ.pop("BOT_BOTTLE_CONTROL_PLANE_TOKEN", None)
|
||||||
|
server = make_server(self.orch, "127.0.0.1", 0)
|
||||||
|
self.addCleanup(server.server_close)
|
||||||
|
self.assertTrue(server.is_authorized(""))
|
||||||
|
self.assertTrue(server.is_authorized("anything"))
|
||||||
|
|
||||||
|
|
||||||
class TestDispatchSupervise(unittest.TestCase):
|
class TestDispatchSupervise(unittest.TestCase):
|
||||||
"""The /supervise/* routes over the pure dispatch()."""
|
"""The /supervise/* routes over the pure dispatch()."""
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ class TestDockerGateway(unittest.TestCase):
|
|||||||
def test_ensure_running_noop_when_up_and_image_current(self) -> None:
|
def test_ensure_running_noop_when_up_and_image_current(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout=self.sc.name) # running
|
return _proc(stdout=self.sc.name) # running
|
||||||
@@ -58,7 +58,7 @@ class TestDockerGateway(unittest.TestCase):
|
|||||||
# a rebuild's new flat daemons take effect.
|
# a rebuild's new flat daemons take effect.
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout=self.sc.name)
|
return _proc(stdout=self.sc.name)
|
||||||
@@ -76,7 +76,7 @@ class TestDockerGateway(unittest.TestCase):
|
|||||||
def test_ensure_running_starts_the_singleton_when_absent(self) -> None:
|
def test_ensure_running_starts_the_singleton_when_absent(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
return _proc(stdout="") if argv[:2] == ["docker", "ps"] else _proc()
|
return _proc(stdout="") if argv[:2] == ["docker", "ps"] else _proc()
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ class TestDockerGateway(unittest.TestCase):
|
|||||||
def test_ensure_running_creates_network_when_missing(self) -> None:
|
def test_ensure_running_creates_network_when_missing(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:3] == ["docker", "network", "inspect"]:
|
if argv[:3] == ["docker", "network", "inspect"]:
|
||||||
return _proc(returncode=1, stderr="No such network")
|
return _proc(returncode=1, stderr="No such network")
|
||||||
@@ -135,7 +135,7 @@ class TestDockerGateway(unittest.TestCase):
|
|||||||
def test_ensure_running_reuses_existing_network(self) -> None:
|
def test_ensure_running_reuses_existing_network(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
return _proc(stdout="") if argv[:2] == ["docker", "ps"] else _proc()
|
return _proc(stdout="") if argv[:2] == ["docker", "ps"] else _proc()
|
||||||
|
|
||||||
@@ -144,7 +144,7 @@ class TestDockerGateway(unittest.TestCase):
|
|||||||
self.assertEqual([], [c for c in calls if c[:3] == ["docker", "network", "create"]])
|
self.assertEqual([], [c for c in calls if c[:3] == ["docker", "network", "create"]])
|
||||||
|
|
||||||
def test_ensure_running_raises_on_docker_failure(self) -> None:
|
def test_ensure_running_raises_on_docker_failure(self) -> None:
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout="")
|
return _proc(stdout="")
|
||||||
if argv[:2] == ["docker", "run"]:
|
if argv[:2] == ["docker", "run"]:
|
||||||
@@ -181,7 +181,7 @@ class TestDockerGatewayBuild(unittest.TestCase):
|
|||||||
# build-if-missing silently ran a stale single-tenant image.
|
# build-if-missing silently ran a stale single-tenant image.
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def rec(argv: list[str]) -> Mock:
|
def rec(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
return _proc() # image present, build succeeds
|
return _proc() # image present, build succeeds
|
||||||
|
|
||||||
@@ -196,7 +196,7 @@ class TestDockerGatewayBuild(unittest.TestCase):
|
|||||||
def test_ensure_built_no_cache_env_forces_full_rebuild(self) -> None:
|
def test_ensure_built_no_cache_env_forces_full_rebuild(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def rec(argv: list[str]) -> Mock:
|
def rec(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
return _proc()
|
return _proc()
|
||||||
|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ from bot_bottle.orchestrator.lifecycle import (
|
|||||||
ORCHESTRATOR_SOURCE_HASH_LABEL,
|
ORCHESTRATOR_SOURCE_HASH_LABEL,
|
||||||
OrchestratorService,
|
OrchestratorService,
|
||||||
OrchestratorStartError,
|
OrchestratorStartError,
|
||||||
_source_hash,
|
source_hash,
|
||||||
)
|
)
|
||||||
from tests.unit import use_bottle_root
|
from tests.unit import use_bottle_root
|
||||||
|
|
||||||
@@ -57,10 +57,10 @@ class TestOrchestratorService(unittest.TestCase):
|
|||||||
# A healthy control plane already running the *current* bind-mounted
|
# A healthy control plane already running the *current* bind-mounted
|
||||||
# source is left alone — recreating it on every launch would drop
|
# source is left alone — recreating it on every launch would drop
|
||||||
# every other active bottle's in-memory egress tokens (#381).
|
# every other active bottle's in-memory egress tokens (#381).
|
||||||
current = _source_hash(self.svc._repo_root)
|
current = source_hash(self.svc._repo_root)
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout=ORCHESTRATOR_NAME)
|
return _proc(stdout=ORCHESTRATOR_NAME)
|
||||||
@@ -83,7 +83,7 @@ class TestOrchestratorService(unittest.TestCase):
|
|||||||
# effect, same as the gateway's image-staleness check.
|
# effect, same as the gateway's image-staleness check.
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout=ORCHESTRATOR_NAME)
|
return _proc(stdout=ORCHESTRATOR_NAME)
|
||||||
@@ -98,13 +98,13 @@ class TestOrchestratorService(unittest.TestCase):
|
|||||||
self.assertEqual(1, len(runs))
|
self.assertEqual(1, len(runs))
|
||||||
self.assertIn(ORCHESTRATOR_NAME, runs[0])
|
self.assertIn(ORCHESTRATOR_NAME, runs[0])
|
||||||
# the fresh container is labeled with the current hash, not the stale one
|
# the fresh container is labeled with the current hash, not the stale one
|
||||||
current = _source_hash(self.svc._repo_root)
|
current = source_hash(self.svc._repo_root)
|
||||||
self.assertIn(f"{ORCHESTRATOR_SOURCE_HASH_LABEL}={current}", runs[0])
|
self.assertIn(f"{ORCHESTRATOR_SOURCE_HASH_LABEL}={current}", runs[0])
|
||||||
|
|
||||||
def test_ensure_running_starts_orchestrator_container_when_absent(self) -> None:
|
def test_ensure_running_starts_orchestrator_container_when_absent(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout="") # not running
|
return _proc(stdout="") # not running
|
||||||
@@ -127,7 +127,7 @@ class TestOrchestratorService(unittest.TestCase):
|
|||||||
# gateway data plane — built from Dockerfile.orchestrator when absent.
|
# gateway data plane — built from Dockerfile.orchestrator when absent.
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout="") # orchestrator not running
|
return _proc(stdout="") # orchestrator not running
|
||||||
@@ -148,7 +148,7 @@ class TestOrchestratorService(unittest.TestCase):
|
|||||||
def test_ensure_running_skips_orchestrator_image_build_when_present(self) -> None:
|
def test_ensure_running_skips_orchestrator_image_build_when_present(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str]) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout="")
|
return _proc(stdout="")
|
||||||
|
|||||||
Reference in New Issue
Block a user