mirror of
https://github.com/openai/codex.git
synced 2026-04-26 15:45:02 +00:00
e89e5136bd
## Why `shell-tool-mcp` and the Bash fork are no longer needed, but the patched zsh fork is still relevant for shell escalation and for the DotSlash-backed zsh-fork integration tests. Deleting the old `shell-tool-mcp` workflow also deleted the only pipeline that rebuilt those patched zsh binaries. This keeps the package removal, while preserving a small release path that can be reused whenever `codex-rs/shell-escalation/patches/zsh-exec-wrapper.patch` changes. ## What changed - removed the `shell-tool-mcp` workspace package, its npm packaging/release jobs, the Bash test fixture, and the remaining Bash-specific compatibility wiring - deleted the old `.github/workflows/shell-tool-mcp.yml` and `.github/workflows/shell-tool-mcp-ci.yml` workflows now that their responsibilities have been replaced or removed - kept the zsh patch under `codex-rs/shell-escalation/patches/zsh-exec-wrapper.patch` and updated the `codex-rs/shell-escalation` docs/code to describe the zsh-based flow directly - added `.github/workflows/rust-release-zsh.yml` to build only the three zsh binaries that `codex-rs/app-server/tests/suite/zsh` needs today: - `aarch64-apple-darwin` on `macos-15` - `x86_64-unknown-linux-musl` on `ubuntu-24.04` - `aarch64-unknown-linux-musl` on `ubuntu-24.04` - extracted the shared zsh build/smoke-test/stage logic into `.github/scripts/build-zsh-release-artifact.sh`, made that helper directly executable, and now invoke it directly from the workflow so the Linux and macOS jobs only keep the OS-specific setup in YAML - wired those standalone `codex-zsh-*.tar.gz` assets into `rust-release.yml` and added `.github/dotslash-zsh-config.json` so releases also publish a `codex-zsh` DotSlash file - updated the checked-in `codex-rs/app-server/tests/suite/zsh` fixture comments to explain that new releases come from the standalone zsh assets, while the checked-in fixture remains pinned to the latest historical release until a newer zsh artifact is published - tightened a couple of follow-on cleanups in `codex-rs/shell-escalation`: the `ExecParams::command` comment now describes the shell `-c`/`-lc` string more clearly, and the README now points at the same `git.code.sf.net` zsh source URL that the workflow uses ## Testing - `cargo test -p codex-shell-escalation` - `just argument-comment-lint` - `bash -n .github/scripts/build-zsh-release-artifact.sh` - attempted `cargo test -p codex-core`; unrelated existing failures remain, but the touched `tools::runtimes::shell::unix_escalation::*` coverage passed during that run
30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
# codex-shell-escalation
|
|
|
|
This crate contains the Unix shell-escalation protocol implementation and the
|
|
`codex-execve-wrapper` executable.
|
|
|
|
`codex-execve-wrapper` receives the arguments to an intercepted `execve(2)` call and delegates the
|
|
decision to the shell-escalation protocol over a shared file descriptor (specified by the
|
|
`CODEX_ESCALATE_SOCKET` environment variable). The server on the other side replies with one of:
|
|
|
|
- `Run`: `codex-execve-wrapper` should invoke `execve(2)` on itself to run the original command
|
|
within the sandboxed shell.
|
|
- `Escalate`: forward the file descriptors of the current process so the command can be run
|
|
faithfully outside the sandbox. When the process completes, the server forwards the exit code
|
|
back to `codex-execve-wrapper`.
|
|
- `Deny`: the server has declared the proposed command to be forbidden, so
|
|
`codex-execve-wrapper` prints an error to `stderr` and exits with `1`.
|
|
|
|
## Patched zsh
|
|
|
|
We carry a small patch to `Src/exec.c` (see `patches/zsh-exec-wrapper.patch`) that adds support for `EXEC_WRAPPER`. The patch applies to `77045ef899e53b9598bebc5a41db93a548a40ca6` from https://git.code.sf.net/p/zsh/code. To rebuild manually:
|
|
|
|
```bash
|
|
git clone https://git.code.sf.net/p/zsh/code
|
|
git checkout 77045ef899e53b9598bebc5a41db93a548a40ca6
|
|
git apply /path/to/patches/zsh-exec-wrapper.patch
|
|
./Util/preconfig
|
|
./configure
|
|
make -j"$(nproc)"
|
|
```
|