2025-09-26 10:13:37 -07:00
|
|
|
[package]
|
|
|
|
|
name = "codex-rmcp-client"
|
2025-11-24 12:22:18 -08:00
|
|
|
version.workspace = true
|
|
|
|
|
edition.workspace = true
|
|
|
|
|
license.workspace = true
|
2025-09-26 10:13:37 -07:00
|
|
|
|
|
|
|
|
[lints]
|
|
|
|
|
workspace = true
|
|
|
|
|
|
|
|
|
|
[dependencies]
|
|
|
|
|
anyhow = "1"
|
2025-10-03 10:43:12 -07:00
|
|
|
axum = { workspace = true, default-features = false, features = [
|
|
|
|
|
"http1",
|
|
|
|
|
"tokio",
|
|
|
|
|
] }
|
client: extend custom CA handling across HTTPS and websocket clients (#14239)
## Stacked PRs
This work is now effectively split across two steps:
- #14178: add custom CA support for browser and device-code login flows,
docs, and hermetic subprocess tests
- #14239: extend that shared custom CA handling across Codex HTTPS
clients and secure websocket TLS
Note: #14240 was merged into this branch while it was stacked on top of
this PR. This PR now subsumes that websocket follow-up and should be
treated as the combined change.
Builds on top of #14178.
## Problem
Custom CA support landed first in the login path, but the real
requirement is broader. Codex constructs outbound TLS clients in
multiple places, and both HTTPS and secure websocket paths can fail
behind enterprise TLS interception if they do not honor
`CODEX_CA_CERTIFICATE` or `SSL_CERT_FILE` consistently.
This PR broadens the shared custom-CA logic beyond login and applies the
same policy to websocket TLS, so the enterprise-proxy story is no longer
split between “HTTPS works” and “websockets still fail”.
## What This Delivers
Custom CA support is no longer limited to login. Codex outbound HTTPS
clients and secure websocket connections can now honor the same
`CODEX_CA_CERTIFICATE` / `SSL_CERT_FILE` configuration, so enterprise
proxy/intercept setups work more consistently end-to-end.
For users and operators, nothing new needs to be configured beyond the
same CA env vars introduced in #14178. The change is that more of Codex
now respects them, including websocket-backed flows that were previously
still using default trust roots.
I also manually validated the proxy path locally with mitmproxy using:
`CODEX_CA_CERTIFICATE=~/.mitmproxy/mitmproxy-ca-cert.pem
HTTPS_PROXY=http://127.0.0.1:8080 just codex`
with mitmproxy installed via `brew install mitmproxy` and configured as
the macOS system proxy.
## Mental model
`codex-client` is now the owner of shared custom-CA policy for outbound
TLS client construction. Reqwest callers start from the builder
configuration they already need, then pass that builder through
`build_reqwest_client_with_custom_ca(...)`. Websocket callers ask the
same module for a rustls client config when a custom CA bundle is
configured.
The env precedence is the same everywhere:
- `CODEX_CA_CERTIFICATE` wins
- otherwise fall back to `SSL_CERT_FILE`
- otherwise use system roots
The helper is intentionally narrow. It loads every usable certificate
from the configured PEM bundle into the appropriate root store and
returns either a configured transport or a typed error that explains
what went wrong.
## Non-goals
This does not add handshake-level integration tests against a live TLS
endpoint. It does not validate that the configured bundle forms a
meaningful certificate chain. It also does not try to force every
transport in the repo through one abstraction; it extends the shared CA
policy across the reqwest and websocket paths that actually needed it.
## Tradeoffs
The main tradeoff is centralizing CA behavior in `codex-client` while
still leaving adoption up to call sites. That keeps the implementation
additive and reviewable, but it means the rule "outbound Codex TLS that
should honor enterprise roots must use the shared helper" is still
partly enforced socially rather than by types.
For websockets, the shared helper only builds an explicit rustls config
when a custom CA bundle is configured. When no override env var is set,
websocket callers still use their ordinary default connector path.
## Architecture
`codex-client::custom_ca` now owns CA bundle selection, PEM
normalization, mixed-section parsing, certificate extraction, typed
CA-loading errors, and optional rustls client-config construction for
websocket TLS.
The affected consumers now call into that shared helper directly rather
than carrying login-local CA behavior:
- backend-client
- cloud-tasks
- RMCP client paths that use `reqwest`
- TUI voice HTTP paths
- `codex-core` default reqwest client construction
- `codex-api` websocket clients for both responses and realtime
websocket connections
The subprocess CA probe, env-sensitive integration tests, and shared PEM
fixtures also live in `codex-client`, which is now the actual owner of
the behavior they exercise.
## Observability
The shared CA path logs:
- which environment variable selected the bundle
- which path was loaded
- how many certificates were accepted
- when `TRUSTED CERTIFICATE` labels were normalized
- when CRLs were ignored
- where client construction failed
Returned errors remain user-facing and include the relevant env var,
path, and remediation hint. That same error model now applies whether
the failure surfaced while building a reqwest client or websocket TLS
configuration.
## Tests
Pure unit tests in `codex-client` cover env precedence and PEM
normalization behavior. Real client construction remains in subprocess
tests so the suite can control process env and avoid the macOS seatbelt
panic path that motivated the hermetic test split.
The subprocess coverage verifies:
- `CODEX_CA_CERTIFICATE` precedence over `SSL_CERT_FILE`
- fallback to `SSL_CERT_FILE`
- single-cert and multi-cert bundles
- malformed and empty-file errors
- OpenSSL `TRUSTED CERTIFICATE` handling
- CRL tolerance for well-formed CRL sections
The websocket side is covered by the existing `codex-api` / `codex-core`
websocket test suites plus the manual mitmproxy validation above.
---------
Co-authored-by: Ivan Zakharchanka <3axap4eHko@gmail.com>
Co-authored-by: Codex <noreply@openai.com>
2026-03-12 17:59:26 -07:00
|
|
|
codex-client = { workspace = true }
|
2025-10-27 12:10:11 -07:00
|
|
|
codex-keyring-store = { workspace = true }
|
2025-10-08 14:37:57 -07:00
|
|
|
codex-protocol = { workspace = true }
|
2026-02-06 21:26:36 -08:00
|
|
|
codex-utils-pty = { workspace = true }
|
2026-01-30 15:46:33 -08:00
|
|
|
codex-utils-home-dir = { workspace = true }
|
2025-10-27 12:10:11 -07:00
|
|
|
futures = { workspace = true, default-features = false, features = ["std"] }
|
2025-11-16 23:07:34 -06:00
|
|
|
keyring = { workspace = true, features = ["crypto-rust"] }
|
2025-10-27 12:10:11 -07:00
|
|
|
oauth2 = "5"
|
|
|
|
|
reqwest = { version = "0.12", default-features = false, features = [
|
|
|
|
|
"json",
|
|
|
|
|
"stream",
|
2026-01-22 07:57:18 -08:00
|
|
|
"rustls-tls",
|
2025-10-27 12:10:11 -07:00
|
|
|
] }
|
2025-10-03 10:43:12 -07:00
|
|
|
rmcp = { workspace = true, default-features = false, features = [
|
|
|
|
|
"auth",
|
2025-09-26 10:13:37 -07:00
|
|
|
"base64",
|
|
|
|
|
"client",
|
|
|
|
|
"macros",
|
|
|
|
|
"schemars",
|
|
|
|
|
"server",
|
|
|
|
|
"transport-child-process",
|
2025-09-26 18:24:01 -07:00
|
|
|
"transport-streamable-http-client-reqwest",
|
|
|
|
|
"transport-streamable-http-server",
|
|
|
|
|
] }
|
2026-01-13 10:22:51 -08:00
|
|
|
schemars = { workspace = true }
|
2025-10-03 10:43:12 -07:00
|
|
|
serde = { workspace = true, features = ["derive"] }
|
|
|
|
|
serde_json = { workspace = true }
|
|
|
|
|
sha2 = { workspace = true }
|
2026-03-06 10:02:42 -05:00
|
|
|
sse-stream = "0.2.1"
|
|
|
|
|
thiserror = { workspace = true }
|
2025-10-03 10:43:12 -07:00
|
|
|
tiny_http = { workspace = true }
|
|
|
|
|
tokio = { workspace = true, features = [
|
2025-09-26 10:13:37 -07:00
|
|
|
"io-util",
|
|
|
|
|
"macros",
|
|
|
|
|
"process",
|
|
|
|
|
"rt-multi-thread",
|
|
|
|
|
"sync",
|
|
|
|
|
"io-std",
|
|
|
|
|
"time",
|
|
|
|
|
] }
|
2025-10-03 10:43:12 -07:00
|
|
|
tracing = { workspace = true, features = ["log"] }
|
|
|
|
|
urlencoding = { workspace = true }
|
|
|
|
|
webbrowser = { workspace = true }
|
fix: resolve Windows MCP server execution for script-based tools (#3828)
## What?
Fixes MCP server initialization failures on Windows when using
script-based tools like `npx`, `pnpm`, and `yarn` that rely on
`.cmd`/`.bat` files rather than `.exe` binaries.
Fixes #2945
## Why?
Windows users encounter "program not found" errors when configuring MCP
servers with commands like `npx` in their `~/.codex/config.toml`. This
happens because:
- Tools like `npx` are batch scripts (`npx.cmd`) on Windows, not
executable binaries
- Rust's `std::process::Command` bypasses the shell and cannot execute
these scripts directly
- The Windows shell normally handles this by checking `PATHEXT` for
executable extensions
Without this fix, Windows users must specify full paths or add `.cmd`
extensions manually, which breaks cross-platform compatibility.
## How?
Added platform-specific program resolution using the `which` crate to
find the correct executable path:
- **Windows**: Resolves programs through PATH/PATHEXT to find
`.cmd`/`.bat` scripts
- **Unix**: Returns the program unchanged (no-op, as Unix handles
scripts natively)
### Changes
- Added `which = "6"` dependency to `mcp-client/Cargo.toml`
- Implemented `program_resolver` module in `mcp_client.rs` with
platform-specific resolution
- Added comprehensive tests for both Windows and Unix behavior
### Testing
Added platform-specific tests to verify:
- Unix systems execute scripts without extensions
- Windows fails without proper extensions
- Windows succeeds with explicit extensions
- Cross-platform resolution enables successful execution
**Tested on:**
- Windows 11 (NT 10.0.26100.0 x64)
- PowerShell 5.1 & 7+, CMD, Git Bash
- MCP servers: playwright, context7, supabase
- WSL (verified no regression)
**Local checks passed:**
```bash
cargo test && cargo clippy --tests && cargo fmt -- --config imports_granularity=Item
```
### Results
**Before:**
```
🖐 MCP client for `playwright` failed to start: program not found
```
**After:**
```
🖐 MCP client for `playwright` failed to start: request timed out
```
Windows users can now use simple commands like `npx` in their config
without specifying full paths or extensions. The timeout issue is a
separate concern that will be addressed in a follow-up PR.
---------
Co-authored-by: Eric Traut <etraut@openai.com>
2025-11-17 06:41:10 +09:00
|
|
|
which = { workspace = true }
|
2025-09-26 10:13:37 -07:00
|
|
|
|
|
|
|
|
[dev-dependencies]
|
2025-12-23 19:29:32 -08:00
|
|
|
codex-utils-cargo-bin = { workspace = true }
|
2025-10-03 10:43:12 -07:00
|
|
|
pretty_assertions = { workspace = true }
|
2025-10-16 21:24:43 -07:00
|
|
|
serial_test = { workspace = true }
|
2025-10-03 10:43:12 -07:00
|
|
|
tempfile = { workspace = true }
|
2025-11-16 23:07:34 -06:00
|
|
|
[target.'cfg(target_os = "linux")'.dependencies]
|
|
|
|
|
keyring = { workspace = true, features = ["linux-native-async-persistent"] }
|
|
|
|
|
|
|
|
|
|
[target.'cfg(target_os = "macos")'.dependencies]
|
|
|
|
|
keyring = { workspace = true, features = ["apple-native"] }
|
|
|
|
|
|
|
|
|
|
[target.'cfg(target_os = "windows")'.dependencies]
|
|
|
|
|
keyring = { workspace = true, features = ["windows-native"] }
|
|
|
|
|
|
|
|
|
|
[target.'cfg(any(target_os = "freebsd", target_os = "openbsd"))'.dependencies]
|
|
|
|
|
keyring = { workspace = true, features = ["sync-secret-service"] }
|