Skip to content
Python

security: keep OpenWorker's own sidecar token out of the shell environment

Mr-Neutr0n4451efc8621a
diff --git a/coworker/tools/shell.py b/coworker/tools/shell.py
index 0404511d..a84e4257 100644
--- a/coworker/tools/shell.py
+++ b/coworker/tools/shell.py
@@ -52,6 +52,20 @@ _NONINTERACTIVE_ENV = {
}
+# OpenWorker's own sidecar credential. It authenticates every request to the local API
+# (server/app.py `require_sidecar_token`), which is the only thing standing between a
+# process on this machine and the agent's shell/file tools. `run_shell` used to inherit it
+# straight from `os.environ`, so `echo $COWORKER_API_TOKEN` — or any build script, test
+# suite or npm postinstall the agent runs — read it back out. Nothing a user asks the shell
+# to do needs OpenWorker's own token, so it never enters the shell environment.
+_SIDECAR_ENV_VARS = ("COWORKER_API_TOKEN",)
+
+
+def _shell_base_env() -> dict[str, str]:
+ """The parent environment minus OpenWorker's own sidecar credential."""
+ return {k: v for k, v in os.environ.items() if k not in _SIDECAR_ENV_VARS}
+
+
class Executor(ABC):
@abstractmethod
def run(self, command: str, timeout: Optional[float] = None) -> dict[str, Any]: ...
@@ -161,7 +175,11 @@ class LocalExecutor(Executor):
if shell_path is None:
shell_path = "powershell.exe" if self._is_windows else "/bin/bash"
self._shell_path = shell_path
- self._env = {**os.environ, **_NONINTERACTIVE_ENV, **(env or {})}
+ self._env = {
+ **_shell_base_env(),
+ **_NONINTERACTIVE_ENV,
+ **(env or {}),
+ }
# Managed pinned tools (toolchain.install) land under one stable bin dir; putting
# it on PATH up front — even before anything is installed there — means a tool the
# user approves mid-session works in THIS shell immediately, by name, no respawn.
diff --git a/tests/test_shell_env_isolation.py b/tests/test_shell_env_isolation.py
new file mode 100644
index 00000000..7a14f41e
--- /dev/null
+++ b/tests/test_shell_env_isolation.py
@@ -0,0 +1,69 @@
+"""`run_shell` must not hand OpenWorker's own sidecar token to the commands it runs.
+
+`COWORKER_API_TOKEN` authenticates every request to the local API
+(`server/app.py::require_sidecar_token`). That token is the only thing standing between a
+process on this machine and the agent's shell and file tools, so anything the shell runs
+learning it is a privilege escalation — and the shell exists to run project code: build
+scripts, test suites, npm lifecycle hooks.
+"""
+
+import os
+
+from coworker.tools.shell import LocalExecutor, _shell_base_env
+
+
+def _stdout(result) -> str:
+ return str(result.get("output") or result.get("stdout") or "")
+
+
+def test_sidecar_token_is_not_in_the_shell_environment(monkeypatch, tmp_path):
+ monkeypatch.setenv("COWORKER_API_TOKEN", "SIDECAR-SECRET")
+ ex = LocalExecutor(cwd=str(tmp_path))
+ try:
+ out = _stdout(ex.run('echo "[$COWORKER_API_TOKEN]"', timeout=20))
+ finally:
+ ex.close()
+ assert "SIDECAR-SECRET" not in out
+ assert "[]" in out, f"expected an empty expansion, got {out!r}"
+
+
+def test_env_listing_does_not_reveal_the_token(monkeypatch, tmp_path):
+ """`echo $VAR` is not the only way to read it — `env` must not carry it either."""
+ monkeypatch.setenv("COWORKER_API_TOKEN", "SIDECAR-SECRET")
+ ex = LocalExecutor(cwd=str(tmp_path))
+ try:
+ out = _stdout(ex.run("env", timeout=20))
+ finally:
+ ex.close()
+ assert "SIDECAR-SECRET" not in out
+ assert "COWORKER_API_TOKEN" not in out
+
+
+def test_the_users_own_keys_are_still_available(monkeypatch, tmp_path):
+ """Scoped deliberately: the user's provider keys stay, so builds and CLIs keep working.
+ Only OpenWorker's own credential is withheld."""
+ monkeypatch.setenv("OPENAI_API_KEY", "sk-user-key")
+ ex = LocalExecutor(cwd=str(tmp_path))
+ try:
+ out = _stdout(ex.run('echo "[$OPENAI_API_KEY]"', timeout=20))
+ finally:
+ ex.close()
+ assert "sk-user-key" in out
+
+
+def test_base_env_drops_only_the_sidecar_vars(monkeypatch):
+ monkeypatch.setenv("COWORKER_API_TOKEN", "SIDECAR-SECRET")
+ monkeypatch.setenv("PATH", os.environ.get("PATH", "/usr/bin"))
+ env = _shell_base_env()
+ assert "COWORKER_API_TOKEN" not in env
+ assert "PATH" in env, "the shell still needs a usable PATH"
+
+
+def test_explicit_env_overrides_still_apply(tmp_path):
+ """The `env=` constructor argument is unchanged."""
+ ex = LocalExecutor(cwd=str(tmp_path), env={"OW_TEST_MARKER": "present"})
+ try:
+ out = _stdout(ex.run('echo "[$OW_TEST_MARKER]"', timeout=20))
+ finally:
+ ex.close()
+ assert "present" in out