utf-8-sig exists to tolerate BOMs that Windows tooling adds to files users edit. /proc and /sys files are generated by the Linux kernel, never BOM'd and absent on Windows, so -sig there only muddies the read/write policy. Switch every literal /proc/ and /sys/ read to utf-8 and teach the footgun read rule that string literals starting with /proc/ or /sys/ are exempt (user-edited files keep utf-8-sig).
968 lines
48 KiB
Python
968 lines
48 KiB
Python
"""iron-proxy (``ironsh/iron-proxy``) integration for credential-injecting egress control.
|
|
|
|
Sandboxes (Docker/Modal/SSH) hold only opaque proxy tokens; iron-proxy — a TLS-intercepting,
|
|
default-deny egress firewall — swaps them for real credentials on the way out, so a leaked
|
|
token is useless outside the trusted proxy boundary. The pinned binary is auto-installed
|
|
into the PM tool store; CA, ``proxy.yaml``, ``mappings.json``, pidfile and logs live in
|
|
``<hermes_home>/proxy``. Failures warn and never block agent startup.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import hashlib
|
|
import ipaddress
|
|
import json
|
|
import logging
|
|
import os
|
|
import platform
|
|
import shutil
|
|
import signal
|
|
import subprocess
|
|
import tempfile
|
|
import threading
|
|
import time
|
|
import urllib.error
|
|
import urllib.request
|
|
from contextlib import contextmanager, suppress
|
|
from dataclasses import dataclass, field, replace
|
|
from pathlib import Path
|
|
from typing import Dict, List, Optional, Tuple
|
|
|
|
from utils import atomic_json_write, atomic_write_text
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
_RUN_TIMEOUT = 30
|
|
_STARTUP_GRACE_SECONDS = 5
|
|
|
|
# Management API (v0.39): loopback POST /v1/reload hot-swaps the ruleset. Bearer key minted at
|
|
# setup (0600 at <proxy>/management.token), injected under this env name; empty => daemon refuses to start.
|
|
_MGMT_API_KEY_ENV = "HERMES_IRON_PROXY_MGMT_KEY"
|
|
_MGMT_PORT_OFFSET = 2 # tunnel_port is CONNECT/MITM, +1 is plain-HTTP forward, +2 is management
|
|
_MGMT_RELOAD_TIMEOUT = 15
|
|
|
|
# HTTPS_PROXY semantics use a single CONNECT tunnel, so only the tunnel listener is exposed.
|
|
_DEFAULT_TUNNEL_PORT = 9090
|
|
|
|
# Hosts allowed by default for AI inference traffic. Anything else is 403'd.
|
|
_DEFAULT_ALLOWED_HOSTS: Tuple[str, ...] = (
|
|
"openrouter.ai", "*.openrouter.ai", "api.openai.com", "api.anthropic.com", "generativelanguage.googleapis.com",
|
|
"api.x.ai", "api.mistral.ai", "api.groq.com", "api.together.xyz", "api.deepseek.com", "inference.nousresearch.com",
|
|
)
|
|
|
|
# Provider env-var name -> upstream hosts on which the Authorization Bearer token is swapped.
|
|
_BEARER_PROVIDERS: Dict[str, Tuple[str, ...]] = {
|
|
"OPENROUTER_API_KEY": ("openrouter.ai", "*.openrouter.ai"), "OPENAI_API_KEY": ("api.openai.com",),
|
|
"GROQ_API_KEY": ("api.groq.com",), "TOGETHER_API_KEY": ("api.together.xyz",),
|
|
"DEEPSEEK_API_KEY": ("api.deepseek.com",), "MISTRAL_API_KEY": ("api.mistral.ai",),
|
|
"XAI_API_KEY": ("api.x.ai",), "NOUS_API_KEY": ("inference.nousresearch.com",),
|
|
}
|
|
|
|
# Non-Authorization-header providers (v0.39 ``match_headers`` is case-insensitive). ``aliases``
|
|
# name the SAME credential and MUST collapse into one mapping: every rule is ``require: true`` and
|
|
# two require-rules on one host would reject each other's requests; the sandbox gets the token
|
|
# under every name. Authorization is also matched for Anthropic/Azure (SDKs may send Bearer);
|
|
# Gemini's ``?key=<token>`` style is covered by match_query.
|
|
# Providers whose API authenticates with a NON-Authorization header. iron-proxy v0.39's
|
|
# ``secrets.replace.match_headers`` targets arbitrary header names (case-insensitive; confirmed by the
|
|
# iron-proxy author on PR #30179 and verified in the pinned v0.39.0 source — ``swapHeaders`` +
|
|
# ``parseHeaderMatchers``), so these are first-class swapped providers, not "uncovered". ``aliases`` are
|
|
# interchangeable env-var names for the SAME upstream credential (Hermes' auth.py keys Google on both
|
|
# GEMINI_API_KEY and GOOGLE_API_KEY). The sandbox receives the minted token under the canonical name AND
|
|
# every alias so SDKs reading either work.
|
|
_HEADER_AUTH_PROVIDERS: Dict[str, Dict[str, Tuple[str, ...]]] = {
|
|
"ANTHROPIC_API_KEY": {"hosts": ("api.anthropic.com",), "match_headers": ("x-api-key", "Authorization"), "aliases": ()},
|
|
"AZURE_OPENAI_API_KEY": {"hosts": ("*.openai.azure.com", "*.cognitiveservices.azure.com", "*.services.ai.azure.com"),
|
|
"match_headers": ("api-key", "Authorization"), "aliases": ()},
|
|
"GEMINI_API_KEY": {"hosts": ("generativelanguage.googleapis.com",), "match_headers": ("x-goog-api-key",), "aliases": ("GOOGLE_API_KEY",)},
|
|
}
|
|
|
|
# Creds that static header replacement can't swap (SigV4, SDK-minted OAuth): warning only.
|
|
_NON_BEARER_PROVIDERS: Tuple[str, ...] = ("AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "GOOGLE_APPLICATION_CREDENTIALS")
|
|
|
|
# Default SSRF deny list (docs promise: cloud metadata IPs refused regardless of allowlist);
|
|
# callers pass [] to disable (hermetic tests only).
|
|
_DEFAULT_UPSTREAM_DENY_CIDRS: Tuple[str, ...] = (
|
|
"127.0.0.0/8", "::1/128", # loopback v4 / v6
|
|
"169.254.0.0/16", "fe80::/10", # link-local incl. AWS/GCP/Azure IMDS
|
|
"10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16", "fc00::/7", # RFC1918 + IPv6 ULA
|
|
"::ffff:0:0/96", # IPv4-mapped IPv6 — else ::ffff:169.254.169.254 bypasses IMDS deny
|
|
"100.64.0.0/10", # RFC6598 CGNAT (AWS VPC shared services, k8s pod nets)
|
|
"198.18.0.0/15", # RFC2544 benchmark range
|
|
)
|
|
|
|
# Minimal daemon env (SYSTEMROOT/USERPROFILE are Windows); everything else is stripped so
|
|
# /proc/<pid>/environ never exposes operator secrets.
|
|
_PROXY_SUBPROCESS_ENV_ALLOWLIST: Tuple[str, ...] = (
|
|
"PATH", "HOME", "TMPDIR", "TZ", "LANG", "LC_ALL", "LC_CTYPE", "NO_COLOR", "SSL_CERT_DIR", "SSL_CERT_FILE", "SYSTEMROOT", "USERPROFILE",
|
|
)
|
|
|
|
# Always stripped — these would recurse the proxy through itself or a corporate proxy.
|
|
_PROXY_SUBPROCESS_ENV_STRIP: Tuple[str, ...] = ("HTTPS_PROXY", "https_proxy", "HTTP_PROXY", "http_proxy", "ALL_PROXY", "all_proxy", "NO_PROXY", "no_proxy")
|
|
|
|
# SIGKILL doesn't exist on Windows; SIGTERM there is TerminateProcess() — same semantics.
|
|
_KILL_SIGNAL = getattr(signal, "SIGKILL", signal.SIGTERM)
|
|
# O_NOFOLLOW is POSIX-only; 0 is a no-op flag elsewhere.
|
|
_O_NOFOLLOW = getattr(os, "O_NOFOLLOW", 0)
|
|
|
|
# ``--version`` output keyed by binary path (get_status runs per container create).
|
|
_VERSION_CACHE: Dict[str, str] = {}
|
|
|
|
# Nonce planted in the daemon env so ``_pid_alive`` can prove a PID is still *our* binary across
|
|
# PID recycling (a fresh process can't inherit our arbitrary env value).
|
|
_HERMES_IRON_PROXY_NONCE_ENV = "HERMES_IRON_PROXY_NONCE"
|
|
_proxy_nonce: Optional[str] = None
|
|
|
|
|
|
@dataclass
|
|
class ProxyStatus:
|
|
enabled: bool = False
|
|
binary_path: Optional[Path] = None
|
|
binary_version: Optional[str] = None
|
|
config_path: Optional[Path] = None
|
|
ca_cert_path: Optional[Path] = None
|
|
pid: Optional[int] = None
|
|
listening: bool = False
|
|
tunnel_port: int = _DEFAULT_TUNNEL_PORT
|
|
warnings: List[str] = field(default_factory=list)
|
|
|
|
@property
|
|
def installed(self) -> bool:
|
|
return self.binary_path is not None and self.binary_path.exists()
|
|
|
|
@property
|
|
def configured(self) -> bool:
|
|
return bool(self.config_path and self.config_path.exists() and self.ca_cert_path and self.ca_cert_path.exists())
|
|
|
|
|
|
@dataclass
|
|
class TokenMapping:
|
|
"""Sandbox-visible proxy token -> upstream credential lookup. ``real_env_name`` is read from iron-proxy's
|
|
OWN env at egress; ``alias_env_names`` are extra SANDBOX names for the same token."""
|
|
proxy_token: str
|
|
real_env_name: str
|
|
upstream_hosts: Tuple[str, ...]
|
|
match_headers: Tuple[str, ...] = ("Authorization",)
|
|
alias_env_names: Tuple[str, ...] = ()
|
|
|
|
|
|
def _proxy_state_dir_ro() -> Path: # without creating it (status probes, pidfile reads)
|
|
from hermes_constants import get_hermes_home
|
|
return get_hermes_home() / "proxy"
|
|
|
|
|
|
def _proxy_state_dir() -> Path:
|
|
"""Proxy state dir (CA key, pidfile, logs), created 0o700; unconditional chmod tightens a pre-existing slack-umask dir."""
|
|
(d := _proxy_state_dir_ro()).mkdir(parents=True, exist_ok=True)
|
|
with suppress(OSError): # Windows no-op / shared fs we don't own; files still get explicit perms
|
|
d.chmod(0o700)
|
|
return d
|
|
|
|
|
|
def find_iron_proxy(*, install_if_missing: bool = False) -> Optional[Path]:
|
|
"""External tools do not require PM platform support; acquire only on a miss."""
|
|
if system := shutil.which("iron-proxy"):
|
|
return Path(system)
|
|
import pm
|
|
|
|
selected = pm.installed_package("iron-proxy")
|
|
if selected is not None:
|
|
return selected.binary
|
|
if install_if_missing:
|
|
try:
|
|
pm.ensure("iron-proxy")
|
|
return pm.installed_package("iron-proxy").binary
|
|
except Exception as exc: # noqa: BLE001 — never block startup
|
|
logger.warning("iron-proxy auto-install failed: %s", exc)
|
|
return None
|
|
|
|
|
|
def install_iron_proxy(*, force: bool = False) -> Path:
|
|
"""Explicit setup/repair; PM verifies and repairs existing entries too."""
|
|
import pm
|
|
|
|
pm.ensure("iron-proxy", explicit=True)
|
|
target = pm.installed_package("iron-proxy").binary
|
|
_VERSION_CACHE.pop(str(target), None)
|
|
return target
|
|
|
|
|
|
def _verify_checksums_signature(tmp: Path, checksum_path: Path) -> bool:
|
|
"""Best-effort GPG check of checksums.txt in an ephemeral keyring. False (with a warning) when gpg or the signature
|
|
assets are unavailable — SHA-256 stays enforced, gpg is never a hard dependency. Raises ONLY on a present-but-bad signature."""
|
|
if not (gpg := shutil.which("gpg")):
|
|
logger.warning("gpg not found on PATH — skipping iron-proxy release-signature verification (SHA-256 checksum check still enforced).")
|
|
return False
|
|
sig_path, pubkey_path = tmp / "checksums.txt.asc", tmp / "public-key.asc"
|
|
if not sig_path.is_file() or not pubkey_path.is_file():
|
|
logger.warning("iron-proxy release signature assets unavailable — skipping GPG verification (SHA-256 checksum check still enforced).")
|
|
return False
|
|
with tempfile.TemporaryDirectory(prefix="hermes-iron-signature-") as gnupg_home:
|
|
gpg_base = [gpg, "--homedir", gnupg_home, "--batch", "--no-tty"]
|
|
if (imp := _run([*gpg_base, "--import", str(pubkey_path)], timeout=60)).returncode != 0:
|
|
logger.warning("Could not import iron-proxy signing key — skipping GPG verification (SHA-256 still enforced): %s", imp.stderr.decode("utf-8", "replace")[:200])
|
|
return False
|
|
if (verify := _run([*gpg_base, "--verify", str(sig_path), str(checksum_path)], timeout=60)).returncode != 0:
|
|
raise RuntimeError(
|
|
f"iron-proxy checksums.txt failed GPG signature verification — refusing to install (possible release-channel tampering). gpg: {verify.stderr.decode('utf-8', 'replace')[:300]}"
|
|
)
|
|
logger.info("Verified iron-proxy checksums.txt GPG signature.")
|
|
return True
|
|
|
|
|
|
def allowlisted_env() -> Dict[str, str]:
|
|
"""Infrastructure-only env (PATH, HOME, locale) — never the operator's secrets."""
|
|
return {n: os.environ[n] for n in _PROXY_SUBPROCESS_ENV_ALLOWLIST if n in os.environ}
|
|
|
|
|
|
def _run(argv: List[str], *, timeout: int, text: bool = False, **kwargs) -> "subprocess.CompletedProcess":
|
|
if text:
|
|
kwargs.update(text=True, encoding="utf-8", errors="replace")
|
|
return subprocess.run(argv, capture_output=True, timeout=timeout, stdin=subprocess.DEVNULL, **kwargs) # noqa: S603
|
|
|
|
|
|
def iron_proxy_version(binary: Path) -> str:
|
|
"""``iron-proxy --version`` output, stripped and cached by path. Empty on failure."""
|
|
if (key := str(binary)) in _VERSION_CACHE:
|
|
return _VERSION_CACHE[key]
|
|
try:
|
|
# Scrubbed env: a PATH-resolved binary must not see the host's API keys.
|
|
res = _run([str(binary), "--version"], timeout=_RUN_TIMEOUT, text=True, env=allowlisted_env())
|
|
except (OSError, subprocess.TimeoutExpired):
|
|
return ""
|
|
if out := (res.stdout or res.stderr or "").strip(): # never cache empty output — it would poison status for the process lifetime
|
|
_VERSION_CACHE[key] = out
|
|
return out
|
|
|
|
|
|
def _write_private_file(path: Path, data: bytes) -> None:
|
|
"""Create/truncate ``path`` 0o600 from the first byte (no chmod-after TOCTOU), O_NOFOLLOW against a planted
|
|
symlink, fchmod to tighten a pre-existing file."""
|
|
fd = os.open(str(path), os.O_WRONLY | os.O_CREAT | os.O_TRUNC | _O_NOFOLLOW, 0o600)
|
|
try:
|
|
with suppress(OSError, AttributeError):
|
|
os.fchmod(fd, 0o600)
|
|
os.write(fd, data)
|
|
finally:
|
|
os.close(fd)
|
|
|
|
|
|
def _fd_owned_by_us(fd: int) -> bool:
|
|
"""False iff the open file is owned by another uid (same threat model as the pidfile)."""
|
|
try:
|
|
st = os.fstat(fd)
|
|
return not (hasattr(os, "getuid") and st.st_uid != os.getuid())
|
|
except AttributeError:
|
|
return True # Windows
|
|
|
|
|
|
def ensure_ca_cert(*, force: bool = False) -> Tuple[Path, Path]:
|
|
"""Generate (or return existing) 10-year CA cert + key via the host ``openssl``."""
|
|
state = _proxy_state_dir()
|
|
ca_crt, ca_key = state / "ca.crt", state / "ca.key"
|
|
if ca_crt.exists() and ca_key.exists() and not force:
|
|
return ca_crt, ca_key
|
|
if shutil.which("openssl") is None:
|
|
raise RuntimeError("openssl not found on PATH. Install OpenSSL (apt: `openssl`, brew: `openssl`) to generate the iron-proxy CA cert.")
|
|
with tempfile.TemporaryDirectory(prefix="hermes-proxy-ca-") as tmpdir:
|
|
tmp_key, tmp_crt = Path(tmpdir) / "ca.key", Path(tmpdir) / "ca.crt"
|
|
_run(["openssl", "genrsa", "-out", str(tmp_key), "4096"], timeout=60, check=True)
|
|
_run(["openssl", "req", "-x509", "-new", "-nodes", "-key", str(tmp_key), "-sha256", "-days", "3650", "-subj", "/CN=hermes iron-proxy CA",
|
|
"-addext", "basicConstraints=critical,CA:TRUE", "-addext", "keyUsage=critical,keyCertSign", "-out", str(tmp_crt)], timeout=60, check=True)
|
|
# Key: stage 0o600 against a fresh inode, then atomically rename into place.
|
|
key_staged = ca_key.with_suffix(ca_key.suffix + ".staged")
|
|
key_staged.unlink(missing_ok=True)
|
|
_write_private_file(key_staged, tmp_key.read_bytes())
|
|
os.replace(key_staged, ca_key)
|
|
# Cert is public — 0o644 matches typical PEM layout.
|
|
ca_crt.write_bytes(tmp_crt.read_bytes())
|
|
os.chmod(ca_crt, 0o644)
|
|
logger.info("Generated iron-proxy CA at %s", ca_crt)
|
|
return ca_crt, ca_key
|
|
|
|
|
|
def mint_proxy_token(prefix: str = "hermes-proxy") -> str:
|
|
"""Opaque token: recognizable prefix + 128-bit random hex suffix (iron-proxy matches exactly)."""
|
|
return f"{prefix}-{hashlib.sha256(os.urandom(32)).hexdigest()[:32]}"
|
|
|
|
|
|
def _read_text_or_none(p: Path) -> Optional[str]:
|
|
"""Stripped file contents, or None when missing/unreadable/empty."""
|
|
try:
|
|
return p.read_text(encoding="utf-8-sig").strip() or None
|
|
except OSError:
|
|
return None
|
|
|
|
|
|
def _management_token_path() -> Path:
|
|
"""Management-token location; resolving it never creates or changes state."""
|
|
return _proxy_state_dir_ro() / "management.token"
|
|
|
|
|
|
def ensure_management_token(*, force: bool = False) -> str:
|
|
"""Return the management-API bearer key, minting it on first call.
|
|
|
|
Stored at the path from :func:`_management_token_path` with 0600 perms.
|
|
The daemon receives it via the ``HERMES_IRON_PROXY_MGMT_KEY`` env var
|
|
(named in the generated config's ``management.api_key_env``);
|
|
``hermes egress reload`` reads the same file to authenticate.
|
|
"""
|
|
|
|
_proxy_state_dir()
|
|
p = _management_token_path()
|
|
if not force and (existing := _read_text_or_none(p)):
|
|
return existing
|
|
token = mint_proxy_token(prefix="hermes-mgmt")
|
|
_write_private_file(p, token.encode("utf-8"))
|
|
return token
|
|
|
|
|
|
def _yaml():
|
|
"""Shared YAML helpers or None (not a hard requirement for proxy discovery)."""
|
|
|
|
try:
|
|
import hermes_yaml as yaml
|
|
return yaml
|
|
except ImportError:
|
|
return None
|
|
|
|
|
|
def _parse_listen(listen) -> Optional[Tuple[str, int]]:
|
|
"""``"host:port"`` -> ``(host, port)``; empty host means loopback."""
|
|
|
|
if not isinstance(listen, str) or ":" not in listen:
|
|
return None
|
|
host, _, port_s = listen.rpartition(":")
|
|
try:
|
|
port = int(port_s)
|
|
except ValueError:
|
|
return None
|
|
return (host or "127.0.0.1", port)
|
|
|
|
|
|
def _config_listen(section: str, *keys: str, config_path: Optional[Path] = None) -> Optional[Tuple[str, int]]:
|
|
"""``(host, port)`` from the first truthy ``proxy.yaml[section][key]``, or None (also when file/ruamel.yaml is missing)."""
|
|
yaml, data = _yaml(), {}
|
|
if yaml is not None:
|
|
with suppress(OSError, yaml.YAMLError):
|
|
data = yaml.safe_load((config_path or (_proxy_state_dir_ro() / "proxy.yaml")).read_text(encoding="utf-8-sig")) or {}
|
|
block = data.get(section) or {}
|
|
return _parse_listen(next((block[k] for k in keys if block.get(k)), ""))
|
|
|
|
|
|
def _read_management_listen_from_config(config_path: Optional[Path] = None) -> Optional[Tuple[str, int]]:
|
|
return _config_listen("management", "listen", config_path=config_path)
|
|
|
|
|
|
def _probe_target() -> Tuple[str, int]:
|
|
"""Configured bind host/port to probe — on Linux the docker bridge, where a loopback connect would report a healthy
|
|
daemon as down. ``tunnel_listen`` (CONNECT/MITM) falls back to ``http_listen`` for pre-listener-role-split configs."""
|
|
return _config_listen("proxy", "tunnel_listen", "http_listen") or ("127.0.0.1", _DEFAULT_TUNNEL_PORT)
|
|
|
|
|
|
# Management-API error status -> operator message (422 = validation rejected, ruleset unchanged; 401 = daemon started with another management.token).
|
|
_RELOAD_HTTP_ERRORS = {
|
|
422: "iron-proxy rejected the new config (validation failed; the running ruleset is unchanged): {body}",
|
|
401: "management API rejected our key (401). The running daemon was started with a different management.token — run `hermes egress restart`.",
|
|
}
|
|
|
|
|
|
def reload_proxy() -> bool:
|
|
"""``POST /v1/reload`` (validation failures leave the running config untouched); actionable RuntimeError on any failure."""
|
|
if not (pid := _read_pid()) or not _pid_alive(pid):
|
|
raise RuntimeError("iron-proxy is not running — nothing to reload. Run `hermes egress start`.")
|
|
if (mgmt := _read_management_listen_from_config()) is None:
|
|
raise RuntimeError(
|
|
"The generated proxy.yaml has no management listener (written before reload support). Re-run `hermes egress setup` and use `hermes egress restart` this one time."
|
|
)
|
|
if not (token := _read_text_or_none(_management_token_path())):
|
|
raise RuntimeError("management.token is missing — re-run `hermes egress setup`, then `hermes egress restart`.")
|
|
host, port = mgmt
|
|
req = urllib.request.Request(f"http://{host}:{port}/v1/reload", method="POST", headers={"Authorization": f"Bearer {token}"}, data=b"")
|
|
try:
|
|
with urllib.request.urlopen(req, timeout=_MGMT_RELOAD_TIMEOUT) as resp:
|
|
if resp.status == 200:
|
|
return True
|
|
raise RuntimeError(f"management API returned unexpected status {resp.status}")
|
|
except urllib.error.HTTPError as exc:
|
|
body = ""
|
|
with suppress(OSError):
|
|
body = exc.read().decode("utf-8", errors="replace")[:500]
|
|
message = _RELOAD_HTTP_ERRORS.get(exc.code, "management reload failed (HTTP {code}): {body}")
|
|
raise RuntimeError(message.format(code=exc.code, body=body)) from exc
|
|
except (urllib.error.URLError, OSError) as exc:
|
|
# A daemon started from a pre-management config is alive but has no listener.
|
|
raise RuntimeError(
|
|
f"could not reach the management API at {host}:{port} ({exc}). If the daemon was started before reload support, run `hermes egress restart` once."
|
|
) from exc
|
|
|
|
|
|
def _default_http_listen(tunnel_port: int) -> List[str]:
|
|
"""Single bind (v0.39 allows one): docker bridge on Linux (what ``host.docker.internal`` resolves to; loopback is
|
|
unreachable from containers), loopback on Docker Desktop (VPNkit). NEVER 0.0.0.0: a LAN peer with a leaked
|
|
sandbox token could spend the operator's API quota."""
|
|
if platform.system() == "Linux":
|
|
if (bridge_ip := _detect_docker_bridge_ip()) and bridge_ip != "127.0.0.1":
|
|
return [f"{bridge_ip}:{tunnel_port}"]
|
|
logger.warning(
|
|
"No docker bridge (docker0) detected — binding iron-proxy to loopback only. Docker sandboxes will NOT be able to reach the proxy until it is restarted with docker running."
|
|
)
|
|
return [f"127.0.0.1:{tunnel_port}"]
|
|
|
|
|
|
def _detect_docker_bridge_ip() -> Optional[str]:
|
|
"""docker0 IPv4 via ``ip -4 addr show docker0``, or None. SECURITY: validated through
|
|
:mod:`ipaddress` so a hostile ``ip`` shim can't inject 0.0.0.0/loopback/multicast/link-local/public."""
|
|
try:
|
|
res = _run(["ip", "-4", "-o", "addr", "show", "docker0"], timeout=2, text=True)
|
|
except (OSError, subprocess.TimeoutExpired):
|
|
return None
|
|
# Expected: "<n>: docker0 inet 172.17.0.1/16 ..." — first inet token (per line) wins.
|
|
lines = (line.split() for line in res.stdout.splitlines()) if res.returncode == 0 else ()
|
|
candidate = next((parts[parts.index("inet") + 1].split("/")[0] for parts in lines if "inet" in parts[:-1]), None)
|
|
try:
|
|
addr = ipaddress.IPv4Address(candidate) # None/"" raise too
|
|
except (ipaddress.AddressValueError, ValueError):
|
|
return None
|
|
if addr.is_unspecified or addr.is_loopback or addr.is_multicast or addr.is_reserved or addr.is_link_local or addr.is_global:
|
|
logger.warning("Refusing suspicious docker bridge IP %s reported by `ip`; skipping bridge bind.", candidate)
|
|
return None
|
|
return str(addr)
|
|
|
|
|
|
def build_proxy_config(
|
|
*, mappings: List[TokenMapping], ca_cert: Path, ca_key: Path, tunnel_port: int = _DEFAULT_TUNNEL_PORT, audit_log: Optional[Path] = None,
|
|
allowed_hosts: Optional[List[str]] = None, upstream_deny_cidrs: Optional[List[str]] = None, http_listen: Optional[List[str]] = None,
|
|
) -> Dict:
|
|
"""iron-proxy YAML config dict (v0.39.0 schema). Real secrets come from iron-proxy's OWN env (``source: {type: env}``);
|
|
the sandbox never sees them. ``upstream_deny_cidrs=None`` = default SSRF deny list, ``[]`` opts out.
|
|
``audit_log`` is forward-compat only (v0.39 rejects ``audit_path``)."""
|
|
hosts: List[str] = list(allowed_hosts or _DEFAULT_ALLOWED_HOSTS)
|
|
for h in (h for m in mappings for h in m.upstream_hosts):
|
|
if h not in hosts:
|
|
hosts.append(h)
|
|
deny_cidrs = list(_DEFAULT_UPSTREAM_DENY_CIDRS if upstream_deny_cidrs is None else upstream_deny_cidrs)
|
|
# Query scan covers ``?key=<token>`` SDKs; body inspection deliberately off. ``require`` fails
|
|
# closed: an allowlisted-host request WITHOUT the proxy token is rejected, so a real key sent
|
|
# directly can't cross the boundary.
|
|
secrets_rules = [{
|
|
"source": {"type": "env", "var": m.real_env_name},
|
|
"replace": {
|
|
"proxy_value": m.proxy_token, "match_headers": list(m.match_headers or ("Authorization",)),
|
|
"match_query": True, "match_body": False, "require": True,
|
|
},
|
|
"rules": [{"host": h} for h in m.upstream_hosts],
|
|
} for m in mappings]
|
|
# ONE string per listener field. tunnel_listen is the CONNECT+MITM listener sandboxes reach via
|
|
# HTTPS_PROXY (a CONNECT to http_listen is forwarded upstream and 400s); http_listen is plain-HTTP
|
|
# forward on tunnel_port+1.
|
|
primary_listen = (list(http_listen) if http_listen else _default_http_listen(tunnel_port) or [f"127.0.0.1:{tunnel_port}"])[0]
|
|
bind_host = primary_listen.rsplit(":", 1)[0] or "127.0.0.1"
|
|
return {
|
|
# Required by the parser; tunnel-only mode never binds an exposed DNS port.
|
|
"dns": {"listen": "127.0.0.1:0", "proxy_ip": "127.0.0.1"},
|
|
"proxy": {
|
|
# Both bind the docker bridge on Linux / loopback on Docker Desktop — NEVER 0.0.0.0.
|
|
"tunnel_listen": primary_listen, "http_listen": f"{bind_host}:{tunnel_port + 1}",
|
|
"https_listen": "127.0.0.1:0", # direct-TLS listener is not exposed
|
|
"max_request_body_bytes": 16 * 1024 * 1024, "max_response_body_bytes": 0,
|
|
"upstream_response_header_timeout": "120s", "upstream_deny_cidrs": deny_cidrs,
|
|
},
|
|
# v0.39 defaults metrics to :9090 (our default tunnel_port) — pin to an ephemeral loopback port.
|
|
"metrics": {"listen": "127.0.0.1:0"},
|
|
# Loopback only: sandboxes must never reach the management surface.
|
|
"management": {"listen": f"127.0.0.1:{tunnel_port + _MGMT_PORT_OFFSET}", "api_key_env": _MGMT_API_KEY_ENV},
|
|
"tls": {"ca_cert": str(ca_cert), "ca_key": str(ca_key), "cert_cache_size": 1000, "leaf_cert_expiry_hours": 168},
|
|
"transforms": [{"name": "allowlist", "config": {"domains": hosts}}, {"name": "secrets", "config": {"secrets": secrets_rules}}],
|
|
"log": {"level": "info"},
|
|
}
|
|
|
|
|
|
def _open_private_append(path: Path, *, strict_chmod: bool) -> int:
|
|
"""O_APPEND|O_CREAT 0o600 + O_NOFOLLOW (planted symlinks refused); fchmod tightens a pre-existing
|
|
file (failure fatal iff ``strict_chmod``). Raises OSError; caller owns the fd."""
|
|
fd = os.open(str(path), os.O_WRONLY | os.O_CREAT | os.O_APPEND | _O_NOFOLLOW, 0o600)
|
|
try:
|
|
os.fchmod(fd, 0o600)
|
|
except OSError:
|
|
if strict_chmod:
|
|
os.close(fd)
|
|
raise
|
|
return fd
|
|
|
|
|
|
def ensure_audit_log(audit_path: Path) -> None:
|
|
"""Pre-create the audit log 0o600 (forward-compat: v0.39 never writes it); RuntimeError on any OSError."""
|
|
try:
|
|
os.close(_open_private_append(audit_path, strict_chmod=True))
|
|
except OSError as exc:
|
|
raise RuntimeError(
|
|
f"Refusing to start: could not pre-create audit log {audit_path} with restrictive permissions ({exc}). Move or chmod any existing file at that path and retry."
|
|
) from exc
|
|
|
|
|
|
def write_proxy_config(config: Dict) -> Path:
|
|
"""Serialize the config dict to ``<hermes_home>/proxy/proxy.yaml`` (safe_dump, no Python tags).
|
|
|
|
The file holds proxy tokens: written 0600 from creation, never at process umask."""
|
|
if (yaml := _yaml()) is None:
|
|
raise RuntimeError("ruamel.yaml is required to write the iron-proxy config but is not installed.")
|
|
path = _proxy_state_dir() / "proxy.yaml"
|
|
atomic_write_text(path, yaml.safe_dump(config, default_flow_style=False, sort_keys=False), mode=0o600)
|
|
return path
|
|
|
|
|
|
def write_mappings(mappings: List[TokenMapping]) -> Path:
|
|
"""Persist sandbox-visible tokens to ``mappings.json`` (read by the Docker backend, not iron-proxy)."""
|
|
payload = {"version": 1, "tokens": [{
|
|
"proxy_token": m.proxy_token, "env_name": m.real_env_name, "upstream_hosts": list(m.upstream_hosts),
|
|
"match_headers": list(m.match_headers), "alias_env_names": list(m.alias_env_names),
|
|
} for m in mappings]}
|
|
path = _proxy_state_dir() / "mappings.json"
|
|
atomic_json_write(path, payload, mode=0o600)
|
|
return path
|
|
|
|
|
|
def load_mappings() -> List[TokenMapping]:
|
|
"""Read mappings.json, if it exists. Empty list on any error."""
|
|
if not (f := _proxy_state_dir() / "mappings.json").exists():
|
|
return []
|
|
try:
|
|
payload = json.loads(f.read_text(encoding="utf-8-sig"))
|
|
except (OSError, json.JSONDecodeError) as exc:
|
|
logger.warning("Failed to read iron-proxy mappings.json: %s", exc)
|
|
return []
|
|
out: List[TokenMapping] = []
|
|
for item in payload.get("tokens", []):
|
|
with suppress(KeyError, TypeError): # pre-header-auth files load with the bearer defaults they were written under
|
|
out.append(TokenMapping(item["proxy_token"], item["env_name"], tuple(item.get("upstream_hosts") or ()),
|
|
tuple(item.get("match_headers") or ("Authorization",)), tuple(item.get("alias_env_names") or ())))
|
|
return out
|
|
|
|
|
|
def discover_provider_mappings(*, available_env_names: Optional[List[str]] = None) -> List[TokenMapping]:
|
|
"""One TokenMapping per known provider whose env var is set (bearer providers first). Canonical OR any alias
|
|
present -> ONE mapping on the canonical name (the subprocess-env builder mirrors aliases).
|
|
``available_env_names`` (Bitwarden adapter) overrides the non-empty names in the host env."""
|
|
names = set(available_env_names) if available_env_names is not None else {k for k, v in os.environ.items() if v}
|
|
specs = [(n, h, ("Authorization",), ()) for n, h in _BEARER_PROVIDERS.items()] + [
|
|
(n, tuple(s["hosts"]), tuple(s["match_headers"]), tuple(s.get("aliases") or ())) for n, s in _HEADER_AUTH_PROVIDERS.items()
|
|
]
|
|
return [
|
|
TokenMapping(mint_proxy_token(prefix=env_name.lower().replace("_api_key", "")), env_name, hosts, headers, aliases)
|
|
for env_name, hosts, headers, aliases in specs
|
|
if env_name in names or any(a in names for a in aliases)
|
|
]
|
|
|
|
|
|
def discover_uncovered_providers(*, available_env_names: Optional[List[str]] = None) -> List[str]:
|
|
"""Env names of recognized providers the proxy can't swap (SigV4 / SDK-minted OAuth)."""
|
|
names = set(available_env_names) if available_env_names is not None else {k for k, v in os.environ.items() if v}
|
|
return [n for n in _NON_BEARER_PROVIDERS if n in names]
|
|
|
|
|
|
def merge_mappings(*, existing: List[TokenMapping], discovered: List[TokenMapping], rotate: bool = False) -> List[TokenMapping]:
|
|
"""Existing tokens are preserved (containers baked with them keep working), hosts/headers/aliases refresh
|
|
from ``discovered``; ``rotate=True`` re-mints; undiscovered providers drop."""
|
|
by_name = {} if rotate else {m.real_env_name: m for m in existing}
|
|
return [replace(d, proxy_token=by_name[d.real_env_name].proxy_token) if d.real_env_name in by_name else d for d in discovered]
|
|
|
|
|
|
def _pidfile() -> Path:
|
|
return _proxy_state_dir() / "iron-proxy.pid"
|
|
|
|
|
|
def _read_pid() -> Optional[int]:
|
|
try:
|
|
pid = int((_proxy_state_dir_ro() / "iron-proxy.pid").read_text(encoding="utf-8-sig", errors="replace").strip())
|
|
except (OSError, ValueError):
|
|
|
|
return None
|
|
return pid if pid > 0 else None
|
|
|
|
|
|
def _pid_proc_starttime(pid: int) -> Optional[str]:
|
|
"""/proc/<pid>/stat starttime (field 22) on Linux, else None — cheap PID-recycling detector."""
|
|
try:
|
|
text = Path(f"/proc/{pid}/stat").read_text(encoding="utf-8")
|
|
except OSError:
|
|
return None
|
|
# comm may contain spaces/parens, so split after the LAST ")"; field 22 -> tail index 19.
|
|
fields = text[rparen + 1:].split() if (rparen := text.rfind(")")) >= 0 else []
|
|
return fields[19] if len(fields) > 19 else None
|
|
|
|
|
|
def _persisted_nonce_path() -> Path:
|
|
"""On-disk nonce sibling of the pidfile, so stop/status in a later CLI process can still defeat PID recycling."""
|
|
return _proxy_state_dir_ro() / "iron-proxy.nonce"
|
|
|
|
|
|
def _read_persisted_nonce() -> Optional[str]:
|
|
"""Nonce from disk, or None if missing/unreadable/empty/not owned by us (callers fall back to argv0
|
|
matching). O_NOFOLLOW: this read decides whether stop_proxy SIGKILLs a PID."""
|
|
try:
|
|
fd = os.open(str(_persisted_nonce_path()), os.O_RDONLY | _O_NOFOLLOW)
|
|
except OSError:
|
|
return None
|
|
try:
|
|
if not _fd_owned_by_us(fd):
|
|
return None
|
|
return os.read(fd, 256).decode("utf-8", errors="ignore").strip() or None
|
|
finally:
|
|
os.close(fd)
|
|
|
|
|
|
def _pid_alive(pid: int) -> bool:
|
|
"""True iff ``pid`` is alive AND an iron-proxy process. PID-reuse defense, in priority order: nonce in
|
|
/proc/<pid>/environ, argv[0] basename in /proc/<pid>/cmdline, ``ps -o comm=`` basename (a loose
|
|
``"iron-proxy" in cmdline`` would hit ``tail iron-proxy.log``)."""
|
|
if pid <= 0:
|
|
return False
|
|
try:
|
|
# psutil when available: os.kill(pid, 0) on Windows is a HARD kill (bpo-14484).
|
|
import psutil # type: ignore
|
|
if not psutil.pid_exists(pid):
|
|
return False
|
|
except ImportError:
|
|
if platform.system() != "Windows":
|
|
try:
|
|
os.kill(pid, 0) # windows-footgun: ok — POSIX-only branch
|
|
except (ProcessLookupError, PermissionError, OSError):
|
|
return False
|
|
# Strong proof: nonce from this process's start_proxy and/or the on-disk sibling file.
|
|
nonce_candidates = [n for n in dict.fromkeys((_proxy_nonce, _read_persisted_nonce())) if n]
|
|
if nonce_candidates:
|
|
with suppress(OSError):
|
|
env_bytes = Path(f"/proc/{pid}/environ").read_bytes()
|
|
if any(f"{_HERMES_IRON_PROXY_NONCE_ENV}={n}".encode() in env_bytes for n in nonce_candidates):
|
|
return True
|
|
with suppress(OSError):
|
|
if (cmdline_path := Path(f"/proc/{pid}/cmdline")).exists():
|
|
return os.path.basename(cmdline_path.read_bytes().split(b"\x00")[0].decode("utf-8", errors="ignore")).startswith("iron-proxy")
|
|
with suppress(OSError, subprocess.TimeoutExpired): # macOS / non-Linux fallback
|
|
res = _run(["ps", "-p", str(pid), "-o", "comm="], timeout=2, text=True)
|
|
if res.returncode == 0:
|
|
return os.path.basename((res.stdout or "").strip()).startswith("iron-proxy")
|
|
# Exotic platforms: if the OS says alive, believe it.
|
|
return True
|
|
|
|
|
|
def start_proxy(
|
|
*, binary: Optional[Path] = None, config_path: Optional[Path] = None, extra_env: Optional[Dict[str, str]] = None,
|
|
install_if_missing: bool = True, refresh_secrets_from_bitwarden: bool = False, bitwarden_config: Optional[Dict] = None,
|
|
) -> ProxyStatus:
|
|
"""Spawn iron-proxy as a managed background subprocess (idempotent if already running). ``refresh_secrets_from_bitwarden``
|
|
re-fetches secrets from BWS — the ``credential_source: bitwarden`` rotation promise."""
|
|
global _proxy_nonce
|
|
if (existing := _read_pid()) and _pid_alive(existing):
|
|
return get_status()
|
|
if (bin_path := binary or find_iron_proxy(install_if_missing=install_if_missing)) is None:
|
|
raise RuntimeError("iron-proxy binary not available — run `hermes egress install`.")
|
|
if not (cfg := config_path or (_proxy_state_dir() / "proxy.yaml")).exists():
|
|
raise RuntimeError(f"iron-proxy config not found at {cfg}. Run `hermes egress setup` first.")
|
|
# Minimal env: os.environ.copy() would expose every operator secret via /proc/<pid>/environ.
|
|
env = _build_proxy_subprocess_env(extra_env=extra_env, refresh_from_bitwarden=refresh_secrets_from_bitwarden, bitwarden_config=bitwarden_config)
|
|
# v0.39 validates api_key_env is non-empty when management.listen is set.
|
|
if _read_management_listen_from_config(cfg) is not None:
|
|
env[_MGMT_API_KEY_ENV] = ensure_management_token()
|
|
# Per-start nonce for PID-recycling defense; module-global is fine (one proxy per process).
|
|
_proxy_nonce = hashlib.sha256(os.urandom(16)).hexdigest()
|
|
env[_HERMES_IRON_PROXY_NONCE_ENV] = _proxy_nonce
|
|
log_path = _proxy_state_dir() / "iron-proxy.log"
|
|
proc = _spawn_daemon(bin_path, cfg, env, log_path)
|
|
# Pidfile BEFORE the listening poll so `hermes egress stop` can clean an orphan if the parent dies mid-poll.
|
|
pidfile = _pidfile()
|
|
try:
|
|
_write_pidfile_safely(pidfile, proc.pid)
|
|
except RuntimeError:
|
|
_kill_and_wait(proc, grace_seconds=2)
|
|
raise
|
|
|
|
def _abort(msg: str, *, kill: bool) -> RuntimeError:
|
|
tail = _tail_log(log_path, lines=20)
|
|
if kill:
|
|
_kill_and_wait(proc, grace_seconds=2)
|
|
pidfile.unlink(missing_ok=True)
|
|
return RuntimeError(f"{msg}Last log lines:\n{tail}")
|
|
|
|
def _interrupt_handler(_signum, _frame): # pragma: no cover - signal path
|
|
_kill_and_wait(proc, grace_seconds=2) # Ctrl-C while waiting must not leak an orphan holding the port
|
|
pidfile.unlink(missing_ok=True)
|
|
raise KeyboardInterrupt()
|
|
|
|
_exited_error = lambda: _abort(f"iron-proxy exited immediately (code {proc.returncode}). ", kill=False) # noqa: E731
|
|
# Probe the CONFIGURED bind host (on Linux the docker bridge, where loopback never connects).
|
|
probe_host, tunnel_port = _probe_target()
|
|
with _interrupt_guard(_interrupt_handler):
|
|
listening = _await_listening(proc, probe_host, tunnel_port, on_exit=_exited_error)
|
|
# Process may have died right at deadline.
|
|
if proc.poll() is not None:
|
|
raise _exited_error()
|
|
# Alive-but-not-listening is a failure: an orphan holding the port breaks every restart.
|
|
if not listening:
|
|
raise _abort(f"iron-proxy did not bind {probe_host}:{tunnel_port} within {_STARTUP_GRACE_SECONDS}s. Process was killed. ", kill=True)
|
|
logger.info("Started iron-proxy pid=%s config=%s", proc.pid, cfg)
|
|
return get_status()
|
|
|
|
|
|
@contextmanager
|
|
def _interrupt_guard(handler):
|
|
"""Route SIGINT/SIGTERM to ``handler`` for the block (POSIX main thread only); previous handlers restored after."""
|
|
if platform.system() == "Windows" or threading.current_thread() is not threading.main_thread():
|
|
yield
|
|
return
|
|
prev = [(sig, signal.signal(sig, handler)) for sig in (signal.SIGINT, signal.SIGTERM)]
|
|
try:
|
|
yield
|
|
finally:
|
|
for sig, old in prev:
|
|
signal.signal(sig, old)
|
|
|
|
|
|
def _spawn_daemon(bin_path: Path, cfg: Path, env: Dict[str, str], log_path: Path) -> "subprocess.Popen":
|
|
"""Popen with stdout/stderr appended to ``log_path`` (0o600 from the first byte, O_NOFOLLOW so a planted
|
|
symlink e.g. to authorized_keys can't receive output, owner-checked). Our log fd closes after Popen — the child has its dup."""
|
|
try:
|
|
log_fd = _open_private_append(log_path, strict_chmod=False)
|
|
except OSError as exc:
|
|
raise RuntimeError(f"Refusing to write iron-proxy log {log_path}: {exc}. Remove that path manually and retry.") from exc
|
|
if not _fd_owned_by_us(log_fd):
|
|
uid = os.fstat(log_fd).st_uid
|
|
os.close(log_fd)
|
|
raise RuntimeError(f"iron-proxy log {log_path} has unexpected owner uid={uid}; refusing to write.")
|
|
try:
|
|
# start_new_session is POSIX-only (Windows isn't supported anyway — no upstream binary).
|
|
return subprocess.Popen( # noqa: S603
|
|
[str(bin_path), "-config", str(cfg)], env=env, stdin=subprocess.DEVNULL, stdout=log_fd, stderr=subprocess.STDOUT,
|
|
**({} if platform.system() == "Windows" else {"start_new_session": True}),
|
|
)
|
|
except OSError as exc:
|
|
raise RuntimeError(f"failed to spawn iron-proxy: {exc}") from exc
|
|
finally:
|
|
with suppress(OSError):
|
|
os.close(log_fd)
|
|
|
|
|
|
def _await_listening(proc: "subprocess.Popen", host: str, port: int, *, on_exit) -> bool:
|
|
"""Poll until ``host:port`` accepts or the grace window lapses (do-while: >=1 check even at 0s); raises ``on_exit()`` if the child dies."""
|
|
deadline = time.time() + _STARTUP_GRACE_SECONDS
|
|
while True:
|
|
if proc.poll() is not None:
|
|
raise on_exit()
|
|
if _port_listening(host, port):
|
|
return True
|
|
if time.time() >= deadline:
|
|
return False
|
|
time.sleep(0.1)
|
|
|
|
|
|
def _write_pidfile_safely(pidfile: Path, pid: int) -> None:
|
|
"""O_EXCL + O_NOFOLLOW + ownership check, then persist the nonce. An existing pidfile is either a concurrent
|
|
start (fail cleanly) or a stale crash leftover (unlink and retry once)."""
|
|
open_flags = os.O_WRONLY | os.O_CREAT | os.O_EXCL | _O_NOFOLLOW
|
|
try:
|
|
fd = os.open(str(pidfile), open_flags, 0o600)
|
|
except FileExistsError:
|
|
if (existing_pid := _read_pid()) and _pid_alive(existing_pid):
|
|
raise RuntimeError(
|
|
f"Another iron-proxy start appears to be in progress (pidfile {pidfile} -> pid {existing_pid}). Run `hermes egress stop` if that proxy is stuck."
|
|
)
|
|
pidfile.unlink(missing_ok=True)
|
|
fd = os.open(str(pidfile), open_flags, 0o600)
|
|
except OSError as exc:
|
|
# ELOOP from a planted symlink at the pidfile path.
|
|
raise RuntimeError(f"Refusing to write pidfile {pidfile}: {exc}. Remove that path manually and retry.") from exc
|
|
try:
|
|
if not _fd_owned_by_us(fd):
|
|
raise RuntimeError(f"pidfile {pidfile} has unexpected owner uid={os.fstat(fd).st_uid}")
|
|
os.write(fd, str(pid).encode("utf-8"))
|
|
finally:
|
|
os.close(fd)
|
|
# Best-effort nonce sibling (0o600); without it stop falls back to argv0 matching.
|
|
if _proxy_nonce:
|
|
with suppress(OSError):
|
|
_write_private_file(pidfile.with_suffix(".nonce"), _proxy_nonce.encode("utf-8"))
|
|
|
|
|
|
def _kill_and_wait(proc: "subprocess.Popen", *, grace_seconds: int = 2) -> None:
|
|
try:
|
|
proc.terminate()
|
|
except OSError:
|
|
return
|
|
try:
|
|
proc.wait(timeout=grace_seconds)
|
|
except subprocess.TimeoutExpired:
|
|
with suppress(OSError):
|
|
proc.kill()
|
|
with suppress(subprocess.TimeoutExpired):
|
|
proc.wait(timeout=grace_seconds)
|
|
|
|
|
|
def _build_proxy_subprocess_env(
|
|
*, extra_env: Optional[Dict[str, str]] = None, refresh_from_bitwarden: bool = False, bitwarden_config: Optional[Dict] = None,
|
|
) -> Dict[str, str]:
|
|
"""Allowlisted infra vars + the secrets named in mappings. With ``refresh_from_bitwarden`` and a populated
|
|
``bitwarden_config`` secrets come from BWS (the rotation guarantee); without ``allow_env_fallback`` any BWS
|
|
shortfall fails closed instead of keeping stale host-env values."""
|
|
env, parent = allowlisted_env(), os.environ
|
|
# Forward ONLY mapped secrets; the rule is keyed on the canonical name, so mirror an alias value into it.
|
|
mappings = load_mappings()
|
|
needed = {m.real_env_name for m in mappings}
|
|
alias_sources = {m.real_env_name: m.alias_env_names for m in mappings if m.alias_env_names}
|
|
for name in needed:
|
|
if (source := name if name in parent else next((a for a in alias_sources.get(name, ()) if parent.get(a)), None)) is not None:
|
|
env[name] = parent[source]
|
|
if refresh_from_bitwarden and bitwarden_config:
|
|
_refresh_secrets_from_bitwarden(env, needed, bitwarden_config, bool(bitwarden_config.get("allow_env_fallback")))
|
|
# Caller overrides win (wizard test secrets), then strip proxy-recursion vars regardless.
|
|
if extra_env:
|
|
env.update(extra_env)
|
|
for name in _PROXY_SUBPROCESS_ENV_STRIP:
|
|
env.pop(name, None)
|
|
env.setdefault("NO_COLOR", "1")
|
|
return env
|
|
|
|
|
|
def _bitwarden_shortfall(allow_env_fallback: bool, error: str, warning: str, *args, cause: Optional[BaseException] = None) -> None:
|
|
"""Raise ``error`` (chained to ``cause`` when given) unless the operator opted into the legacy host-env fallback (then log ``warning``)."""
|
|
if not allow_env_fallback:
|
|
if cause is not None:
|
|
raise RuntimeError(error) from cause
|
|
raise RuntimeError(error)
|
|
logger.warning(warning, *args)
|
|
|
|
|
|
def _refresh_secrets_from_bitwarden(env: Dict[str, str], needed: set, bitwarden_config: Dict, allow_env_fallback: bool) -> None:
|
|
"""Overwrite ``env[needed]`` with fresh (uncached) BWS values; only mapped names are injected so unrelated BWS secrets never leak."""
|
|
try:
|
|
# Lazy: the bitwarden module isn't importable in every install.
|
|
from agent.secret_sources import bitwarden as bw
|
|
access_token = os.environ.get(bitwarden_config.get("access_token_env", "BWS_ACCESS_TOKEN"), "").strip()
|
|
project_id = bitwarden_config.get("project_id", "")
|
|
if not (access_token and project_id):
|
|
# Don't interpolate access_token_name — CodeQL treats config values as tainted.
|
|
_bitwarden_shortfall(
|
|
allow_env_fallback,
|
|
"credential_source=bitwarden but the access-token env or project_id is empty. Either set both, switch to "
|
|
"credential_source: env, or set `proxy.allow_env_fallback: true` to opt into the legacy fallback behaviour.",
|
|
"credential_source=bitwarden but access-token env or project_id is empty — proxy will fall back to parent env (allow_env_fallback=true).",
|
|
)
|
|
return
|
|
secrets, warnings = bw.fetch_bitwarden_secrets(access_token=access_token, project_id=project_id, cache_ttl_seconds=0, use_cache=False)
|
|
except ImportError as exc:
|
|
# A dependency vanishing between setup and restart must not silently degrade.
|
|
_bitwarden_shortfall(
|
|
allow_env_fallback,
|
|
"Bitwarden refresh module unavailable at proxy start (credential_source=bitwarden with "
|
|
"proxy.allow_env_fallback: false). Either fix the import, switch to credential_source: env, or set "
|
|
"`proxy.allow_env_fallback: true` to opt into the legacy fallback behaviour.",
|
|
"Bitwarden refresh module unavailable at proxy start, falling back to parent env (allow_env_fallback=true): %s", exc, cause=exc,
|
|
)
|
|
return
|
|
missing = sorted(needed - set(secrets))
|
|
env.update((n, secrets[n]) for n in needed if n in secrets)
|
|
if missing:
|
|
_bitwarden_shortfall(
|
|
allow_env_fallback,
|
|
f"Bitwarden refresh did not return secrets for {missing}. Either add the secrets to your BWS project, switch to "
|
|
f"credential_source: env via `hermes egress setup --no-bitwarden`, or set `proxy.allow_env_fallback: true` in "
|
|
f"config.yaml to opt into the legacy host-env fallback.",
|
|
"Bitwarden refresh did not return secrets for %s — falling back to host env for those names (allow_env_fallback=true).", missing,
|
|
)
|
|
if warnings: # log only the count: the taint analyzer can't tell bws status text is non-secret
|
|
logger.warning("Bitwarden refresh produced %d warning(s); run `hermes secrets bitwarden status` for detail.", len(warnings))
|
|
|
|
|
|
def _forget_daemon() -> None:
|
|
global _proxy_nonce
|
|
_pidfile().unlink(missing_ok=True)
|
|
with suppress(OSError):
|
|
_persisted_nonce_path().unlink()
|
|
_proxy_nonce = None
|
|
|
|
|
|
def stop_proxy() -> bool:
|
|
"""Returns True if it was running."""
|
|
pid = _read_pid()
|
|
if not pid or not _pid_alive(pid):
|
|
_forget_daemon()
|
|
return False
|
|
# Capture starttime BEFORE signalling: if the pid is recycled mid-wait, abort the SIGKILL.
|
|
starttime_before = _pid_proc_starttime(pid)
|
|
try:
|
|
os.kill(pid, signal.SIGTERM)
|
|
except ProcessLookupError:
|
|
_forget_daemon()
|
|
return False
|
|
# Up to 5s for graceful exit, then SIGKILL — unless the pid was recycled meanwhile.
|
|
deadline = time.time() + 5.0
|
|
while time.time() < deadline:
|
|
if not _pid_alive(pid):
|
|
break
|
|
time.sleep(0.1)
|
|
else:
|
|
starttime_after = _pid_proc_starttime(pid)
|
|
if (starttime_before is not None and starttime_after is not None and starttime_before != starttime_after) or not _pid_alive(pid):
|
|
logger.warning("iron-proxy pid=%s appears recycled before SIGKILL; not killing.", pid)
|
|
else:
|
|
with suppress(ProcessLookupError):
|
|
os.kill(pid, _KILL_SIGNAL)
|
|
_forget_daemon()
|
|
logger.info("Stopped iron-proxy pid=%s", pid)
|
|
return True
|
|
|
|
|
|
def get_status() -> ProxyStatus:
|
|
"""Snapshot the proxy state without side effects (called per Docker container create)."""
|
|
status = ProxyStatus()
|
|
probe_host, status.tunnel_port = _probe_target()
|
|
if binary := find_iron_proxy(install_if_missing=False):
|
|
status.binary_path, status.binary_version = binary, iron_proxy_version(binary)
|
|
state = _proxy_state_dir_ro()
|
|
cfg, ca = state / "proxy.yaml", state / "ca.crt"
|
|
status.config_path, status.ca_cert_path = (cfg if cfg.exists() else None), (ca if ca.exists() else None)
|
|
if (pid := _read_pid()) and _pid_alive(pid):
|
|
status.pid, status.listening = pid, _port_listening(probe_host, status.tunnel_port)
|
|
return status
|
|
|
|
|
|
def _port_listening(host: str, port: int) -> bool:
|
|
import socket
|
|
try:
|
|
with socket.create_connection((host, port), timeout=0.5):
|
|
return True
|
|
except OSError:
|
|
return False
|
|
|
|
|
|
def _tail_log(path: Path, *, lines: int = 20) -> str:
|
|
if not path.exists():
|
|
return "(no log file)"
|
|
try:
|
|
return "\n".join(path.read_bytes()[-8192:].decode("utf-8", errors="replace").splitlines()[-lines:])
|
|
except OSError as exc:
|
|
return f"(could not read log: {exc})"
|
|
|
|
|
|
def _reset_for_tests() -> None:
|
|
global _proxy_nonce
|
|
_VERSION_CACHE.clear()
|
|
_proxy_nonce = None
|
|
|
|
|
|
__all__ = [
|
|
"ProxyStatus", "TokenMapping", "allowlisted_env", "build_proxy_config", "discover_provider_mappings",
|
|
"discover_uncovered_providers", "ensure_audit_log", "ensure_ca_cert", "ensure_management_token",
|
|
"find_iron_proxy", "get_status", "install_iron_proxy", "iron_proxy_version", "load_mappings",
|
|
"merge_mappings", "mint_proxy_token", "reload_proxy", "start_proxy", "stop_proxy",
|
|
"write_mappings", "write_proxy_config",
|
|
]
|
|
|
|
|
|
# ---- BEGIN PLUGIN-COMPAT (revert-scheduled; see COMPAT_MANIFEST.md) ----
|
|
# Names external plugins imported from this module before the Sep 2026 decomposition.
|
|
# Internal code MUST NOT use these (scripts/check_compat_pointers.py fails CI if it does).
|
|
# The whole block is removed by reverting the commit that added it.
|
|
import stat # noqa: F401,E402
|
|
# ---- END PLUGIN-COMPAT ----
|