didericis-claude
07c8593999
EgressRoute now extends egress_addon_core.Route, which holds the four wire-visible fields (host, path_allowlist, auth_scheme, token_env). EgressRoute adds only the three host-side fields (token_ref, roles, tls_passthrough) that are never serialised to the sidecar. _route_to_yaml_fields is typed as Route -> dict, making the host→wire boundary explicit: only fields declared on the base class cross into the YAML the addon reads.
335 lines
12 KiB
Python
335 lines
12 KiB
Python
"""Per-bottle egress proxy (PRD 0017).
|
|
|
|
Replaces the cred-proxy sidecar (PRD 0010) with a mitmproxy-based
|
|
sidecar that becomes the agent's `HTTP_PROXY` / `HTTPS_PROXY`. It
|
|
owns three jobs:
|
|
|
|
1. MITM the agent's HTTPS with the per-bottle CA (moved from
|
|
pipelock).
|
|
2. Enforce manifest-declared `path_allowlist` per route.
|
|
3. Inject `Authorization` headers for routes that declare an
|
|
`auth` block, the same way cred-proxy does today.
|
|
|
|
This module defines the abstract proxy (`Egress`), its plan
|
|
dataclass (`EgressPlan`), and the resolved per-route shape
|
|
(`EgressRoute`). The sidecar's start/stop lifecycle is backend-
|
|
specific and lives on concrete subclasses (see
|
|
`bot_bottle/backend/docker/egress.py`).
|
|
|
|
Chunks 1+2 of the PRD: this module + the mitmproxy addon + the Docker
|
|
lifecycle are wired into the agent's `HTTP_PROXY` path; cred-proxy
|
|
has been removed. Chunk 3 retargets the cred-proxy-block remediation
|
|
flow (PRD 0014) at egress and renames the MCP tool.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import dataclasses
|
|
from abc import ABC, abstractmethod
|
|
from dataclasses import dataclass
|
|
from pathlib import Path
|
|
from typing import TYPE_CHECKING
|
|
|
|
from .egress_addon_core import Route
|
|
from .log import die
|
|
|
|
if TYPE_CHECKING:
|
|
from .manifest import Bottle
|
|
|
|
CODEX_HOST_CREDENTIAL_TOKEN_REF = "BOT_BOTTLE_CODEX_HOST_ACCESS_TOKEN"
|
|
|
|
|
|
# DNS name agents will dial for the per-bottle egress sidecar.
|
|
# Backend-agnostic by contract: every concrete backend (Docker today,
|
|
# others later) attaches this name to its sidecar on the bottle's
|
|
# internal network. The agent's `HTTP_PROXY` env var resolves to
|
|
# `http://egress:<port>` once chunk 2 cuts over.
|
|
EGRESS_HOSTNAME = "egress"
|
|
|
|
# In-container path the addon reads. Pre-created in
|
|
# `Dockerfile.sidecars` so the host bind-mount can drop the file
|
|
# directly. Content is YAML (hand-rolled by `egress_render_routes`
|
|
# in the style of `pipelock_render_yaml`, parsed by `yaml_subset`
|
|
# inside the addon).
|
|
EGRESS_ROUTES_IN_CONTAINER = "/etc/egress/routes.yaml"
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class EgressRoute(Route):
|
|
"""Host-side extension of the addon's `Route`.
|
|
|
|
Inherits `host`, `path_allowlist`, `auth_scheme`, and `token_env`
|
|
from `egress_addon_core.Route` — those are the fields that cross the
|
|
YAML wire into the sidecar. The three fields below are host-only and
|
|
are never serialised to the addon.
|
|
|
|
`token_ref` is the host env var the CLI reads at launch and forwards
|
|
into the container's environ under `token_env`. Routes that share a
|
|
`token_ref` coalesce to one `token_env` slot.
|
|
|
|
`roles` carries the manifest route's role tuple (reserved for
|
|
future use; always empty today).
|
|
|
|
`tls_passthrough` signals that pipelock must not TLS-MITM this
|
|
host — either because the manifest declared `pipelock.tls_passthrough:
|
|
true` (lifted in `egress_manifest_routes`) or because a provider
|
|
route set it (e.g. egress injects its own Bearer on that host
|
|
after the agent boundary and pipelock's header DLP would block it)."""
|
|
|
|
token_ref: str = ""
|
|
roles: tuple[str, ...] = ()
|
|
tls_passthrough: bool = False
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class EgressPlan:
|
|
"""Output of Egress.prepare; consumed by .start.
|
|
|
|
The slug + routes_path + routes + token_env_map fields are
|
|
filled at prepare time (host-side, side-effect-free on docker).
|
|
The network + CA + pipelock fields are populated by the backend's
|
|
launch step via `dataclasses.replace` once those resources
|
|
exist. Empty defaults are sentinels meaning "not yet set";
|
|
`.start` validates that they are populated.
|
|
|
|
`token_env_map` is `{<token_env in container>: <token_ref on host>}`.
|
|
The backend's start step reads `os.environ[token_ref]` and
|
|
forwards the value into the egress container's environ
|
|
under `token_env`. The plan itself never holds token values —
|
|
secrets never land in a dataclass that might be logged.
|
|
|
|
`mitmproxy_ca_host_path` is the host path of the per-bottle
|
|
egress CA (single PEM with cert+key concatenated) minted
|
|
by `egress_tls_init`. `.start` docker-cps it into the
|
|
sidecar at `~/.mitmproxy/mitmproxy-ca.pem` — mitmproxy reads
|
|
that file at boot to mint per-host leaf certs.
|
|
|
|
`mitmproxy_ca_cert_only_host_path` is the cert-only PEM (no
|
|
key) for installing into the agent's trust store via
|
|
`provision_ca`. Separate file rather than re-parsing the
|
|
concat so secrets and trust artefacts stay on distinct paths.
|
|
|
|
`pipelock_ca_host_path` is the host path of the pipelock CA
|
|
(cert only). `.start` docker-cps it into the sidecar so the
|
|
proxy's outbound HTTPS client trusts pipelock's MITM on the
|
|
egress → upstream leg.
|
|
|
|
`pipelock_proxy_url` is the URL egress sets as `HTTPS_PROXY`
|
|
in its environ so outbound HTTPS traverses pipelock — keeping
|
|
pipelock's hostname allowlist + DLP body scanner on the
|
|
egress → upstream leg.
|
|
"""
|
|
|
|
slug: str
|
|
routes_path: Path
|
|
routes: tuple[EgressRoute, ...]
|
|
token_env_map: dict[str, str]
|
|
internal_network: str = ""
|
|
egress_network: str = ""
|
|
mitmproxy_ca_host_path: Path = Path()
|
|
mitmproxy_ca_cert_only_host_path: Path = Path()
|
|
pipelock_ca_host_path: Path = Path()
|
|
pipelock_proxy_url: str = ""
|
|
|
|
|
|
def egress_manifest_routes(
|
|
bottle: Bottle,
|
|
) -> tuple[EgressRoute, ...]:
|
|
"""Lift each `bottle.egress.routes[]` manifest entry into an EgressRoute.
|
|
Order is preserved. Token slots are not assigned here — slot assignment
|
|
is a final step in `egress_routes_for_bottle` after provider and manifest
|
|
routes are merged."""
|
|
out: list[EgressRoute] = []
|
|
for r in bottle.egress.routes:
|
|
out.append(EgressRoute(
|
|
host=r.Host,
|
|
path_allowlist=r.PathAllowlist,
|
|
auth_scheme=r.AuthScheme,
|
|
token_ref=r.TokenRef,
|
|
roles=r.Role,
|
|
tls_passthrough=r.Pipelock.TlsPassthrough,
|
|
))
|
|
return tuple(out)
|
|
|
|
|
|
def egress_routes_for_bottle(
|
|
bottle: Bottle,
|
|
provider_routes: tuple[EgressRoute, ...] = (),
|
|
) -> tuple[EgressRoute, ...]:
|
|
"""Effective egress routes for the agent.
|
|
|
|
Provider routes own their hosts outright; manifest routes for hosts
|
|
not claimed by any provider are appended. Token slots are assigned
|
|
in a final pass over the merged list in order, so provisioned routes
|
|
get the lower slot numbers."""
|
|
manifest = egress_manifest_routes(bottle)
|
|
provisioned_hosts = {pr.host.lower() for pr in provider_routes}
|
|
merged = list(provider_routes) + [
|
|
r for r in manifest if r.host.lower() not in provisioned_hosts
|
|
]
|
|
return _assign_token_slots(merged)
|
|
|
|
|
|
def _assign_token_slots(
|
|
routes: list[EgressRoute],
|
|
) -> tuple[EgressRoute, ...]:
|
|
"""Assign EGRESS_TOKEN_N slots to authenticated routes in order.
|
|
|
|
Routes sharing a token_ref share a slot. Unauthenticated routes
|
|
(no auth_scheme / token_ref) keep token_env empty."""
|
|
slot_for_ref: dict[str, str] = {}
|
|
out: list[EgressRoute] = []
|
|
for r in routes:
|
|
if r.auth_scheme and r.token_ref:
|
|
slot = slot_for_ref.get(r.token_ref)
|
|
if slot is None:
|
|
slot = f"EGRESS_TOKEN_{len(slot_for_ref)}"
|
|
slot_for_ref[r.token_ref] = slot
|
|
out.append(dataclasses.replace(r, token_env=slot))
|
|
else:
|
|
out.append(r)
|
|
return tuple(out)
|
|
|
|
|
|
def egress_token_env_map(
|
|
routes: tuple[EgressRoute, ...],
|
|
) -> dict[str, str]:
|
|
"""Collapse the route list into `{token_env: token_ref}` for the
|
|
authenticated routes. Routes without `auth` contribute no entry.
|
|
|
|
Conflict detection: two routes that share a `token_env` slot but
|
|
name different `token_ref` host vars is a programming error in
|
|
`egress_routes_for_bottle`; surface it as a die rather than
|
|
silently picking one."""
|
|
out: dict[str, str] = {}
|
|
for r in routes:
|
|
if not (r.auth_scheme and r.token_ref and r.token_env):
|
|
continue
|
|
existing = out.get(r.token_env)
|
|
if existing is not None and existing != r.token_ref:
|
|
die(
|
|
f"egress plan conflict: {r.token_env} maps to both "
|
|
f"{existing!r} and {r.token_ref!r}. Two routes sharing a "
|
|
f"token slot must reference the same host env var."
|
|
)
|
|
out[r.token_env] = r.token_ref
|
|
return out
|
|
|
|
|
|
def _route_to_yaml_fields(r: Route) -> dict:
|
|
"""Return the addon-visible fields for one route.
|
|
|
|
Single authoritative mapping between EgressRoute (host-side) and
|
|
egress_addon_core.Route (sidecar-side). When a field is added to
|
|
the addon's Route that must appear in the YAML, add it here and
|
|
in egress_addon_core._parse_one together."""
|
|
fields: dict = {"host": r.host}
|
|
if r.auth_scheme and r.token_env:
|
|
fields["auth_scheme"] = r.auth_scheme
|
|
fields["token_env"] = r.token_env
|
|
if r.path_allowlist:
|
|
fields["path_allowlist"] = list(r.path_allowlist)
|
|
return fields
|
|
|
|
|
|
def egress_render_routes(
|
|
routes: tuple[EgressRoute, ...],
|
|
) -> str:
|
|
"""Serialize the route table for the addon to read.
|
|
|
|
YAML content — no token values, no host env-var names. Fields are
|
|
determined by `_route_to_yaml_fields`, which is the single point of
|
|
truth for the EgressRoute → egress_addon_core.Route mapping."""
|
|
lines: list[str] = ["routes:"]
|
|
if not routes:
|
|
lines[0] = "routes: []"
|
|
return "\n".join(lines) + "\n"
|
|
for r in routes:
|
|
f = _route_to_yaml_fields(r)
|
|
lines.append(f' - host: "{f["host"]}"')
|
|
if "auth_scheme" in f:
|
|
lines.append(f' auth_scheme: "{f["auth_scheme"]}"')
|
|
lines.append(f' token_env: "{f["token_env"]}"')
|
|
if "path_allowlist" in f:
|
|
lines.append(" path_allowlist:")
|
|
for p in f["path_allowlist"]:
|
|
lines.append(f' - "{p}"')
|
|
return "\n".join(lines) + "\n"
|
|
|
|
|
|
def egress_resolve_token_values(
|
|
token_env_map: dict[str, str],
|
|
host_env: dict[str, str],
|
|
) -> dict[str, str]:
|
|
"""Read `host_env[TokenRef]` for each entry in `token_env_map` and
|
|
return `{token_env: <value>}`. Dies (with a pointer at the missing
|
|
var name) if any TokenRef is unset.
|
|
|
|
Pure function: takes the host env as an argument so tests can pass
|
|
a sealed mapping without touching `os.environ`."""
|
|
out: dict[str, str] = {}
|
|
for token_env, token_ref in token_env_map.items():
|
|
value = host_env.get(token_ref)
|
|
if value is None:
|
|
die(
|
|
f"egress: host env var '{token_ref}' is unset. Set it "
|
|
f"before launching, or remove the corresponding auth block "
|
|
f"from bottle.egress.routes."
|
|
)
|
|
if not value:
|
|
die(
|
|
f"egress: host env var '{token_ref}' is empty. The "
|
|
f"egress will not inject an empty token; set it to "
|
|
f"the real value or remove the route's auth block."
|
|
)
|
|
out[token_env] = value
|
|
return out
|
|
|
|
|
|
class Egress(ABC):
|
|
"""The per-bottle egress proxy. Encapsulates the host-side prepare
|
|
(route lift + routes.yaml render + token-env-map derivation); the
|
|
sidecar's start/stop lifecycle is backend-specific and lives on
|
|
concrete subclasses."""
|
|
|
|
def prepare(
|
|
self,
|
|
bottle: Bottle,
|
|
slug: str,
|
|
stage_dir: Path,
|
|
provider_routes: tuple[EgressRoute, ...] = (),
|
|
) -> EgressPlan:
|
|
"""Lift `bottle.egress.routes` + `provider_routes` into resolved
|
|
routes, render the routes file (mode 600) under `stage_dir`, and
|
|
return the plan. Pure host-side, no docker subprocess. The
|
|
token-env map records the mapping the launch step uses to
|
|
forward values from the host's environ into the sidecar's environ.
|
|
|
|
Returned plan is incomplete: the launch step must fill
|
|
`internal_network` / `egress_network` / `pipelock_proxy_url`
|
|
via `dataclasses.replace` before passing it to `.start`."""
|
|
routes = egress_routes_for_bottle(bottle, provider_routes)
|
|
routes_path = stage_dir / "egress_routes.yaml"
|
|
routes_path.write_text(egress_render_routes(routes))
|
|
routes_path.chmod(0o600)
|
|
return EgressPlan(
|
|
slug=slug,
|
|
routes_path=routes_path,
|
|
routes=routes,
|
|
token_env_map=egress_token_env_map(routes),
|
|
)
|
|
|
|
__all__ = [
|
|
"CODEX_HOST_CREDENTIAL_TOKEN_REF",
|
|
"EGRESS_HOSTNAME",
|
|
"EGRESS_ROUTES_IN_CONTAINER",
|
|
"Egress",
|
|
"EgressPlan",
|
|
"EgressRoute",
|
|
"egress_manifest_routes",
|
|
"egress_render_routes",
|
|
"egress_resolve_token_values",
|
|
"egress_routes_for_bottle",
|
|
"egress_token_env_map",
|
|
]
|