mirror of
https://github.com/openai/codex.git
synced 2026-05-05 22:01:37 +03:00
1135 lines
35 KiB
Rust
1135 lines
35 KiB
Rust
#[cfg(unix)]
|
|
use std::os::unix::process::ExitStatusExt;
|
|
|
|
use std::collections::HashMap;
|
|
use std::io;
|
|
use std::path::Path;
|
|
use std::path::PathBuf;
|
|
use std::process::ExitStatus;
|
|
use std::time::Duration;
|
|
use std::time::Instant;
|
|
|
|
use async_channel::Sender;
|
|
use tokio::io::AsyncRead;
|
|
use tokio::io::AsyncReadExt;
|
|
use tokio::io::BufReader;
|
|
use tokio::process::Child;
|
|
use tokio_util::sync::CancellationToken;
|
|
|
|
use crate::error::CodexErr;
|
|
use crate::error::Result;
|
|
use crate::error::SandboxErr;
|
|
use crate::protocol::Event;
|
|
use crate::protocol::EventMsg;
|
|
use crate::protocol::ExecCommandOutputDeltaEvent;
|
|
use crate::protocol::ExecOutputStream;
|
|
use crate::protocol::SandboxPolicy;
|
|
use crate::sandboxing::CommandSpec;
|
|
use crate::sandboxing::ExecRequest;
|
|
use crate::sandboxing::SandboxManager;
|
|
use crate::sandboxing::SandboxPermissions;
|
|
use crate::spawn::SpawnChildRequest;
|
|
use crate::spawn::StdioPolicy;
|
|
use crate::spawn::spawn_child_async;
|
|
use crate::text_encoding::bytes_to_string_smart;
|
|
use crate::tools::sandboxing::SandboxablePreference;
|
|
use codex_exec_server::Environment as ExecutorEnvironment;
|
|
use codex_network_proxy::NetworkProxy;
|
|
#[cfg(any(target_os = "windows", test))]
|
|
use codex_protocol::permissions::FileSystemSandboxKind;
|
|
use codex_protocol::permissions::FileSystemSandboxPolicy;
|
|
use codex_protocol::permissions::NetworkSandboxPolicy;
|
|
use codex_utils_pty::DEFAULT_OUTPUT_BYTES_CAP;
|
|
use codex_utils_pty::process_group::kill_child_process_group;
|
|
|
|
#[path = "exec_remote.rs"]
|
|
mod exec_remote;
|
|
|
|
pub const DEFAULT_EXEC_COMMAND_TIMEOUT_MS: u64 = 10_000;
|
|
|
|
// Hardcode these since it does not seem worth including the libc crate just
|
|
// for these.
|
|
const SIGKILL_CODE: i32 = 9;
|
|
const TIMEOUT_CODE: i32 = 64;
|
|
const EXIT_CODE_SIGNAL_BASE: i32 = 128; // conventional shell: 128 + signal
|
|
const EXEC_TIMEOUT_EXIT_CODE: i32 = 124; // conventional timeout exit code
|
|
|
|
// I/O buffer sizing
|
|
const READ_CHUNK_SIZE: usize = 8192; // bytes per read
|
|
const AGGREGATE_BUFFER_INITIAL_CAPACITY: usize = 8 * 1024; // 8 KiB
|
|
|
|
/// Hard cap on bytes retained from exec stdout/stderr/aggregated output.
|
|
///
|
|
/// This mirrors unified exec's output cap so a single runaway command cannot
|
|
/// OOM the process by dumping huge amounts of data to stdout/stderr.
|
|
const EXEC_OUTPUT_MAX_BYTES: usize = DEFAULT_OUTPUT_BYTES_CAP;
|
|
|
|
/// Limit the number of ExecCommandOutputDelta events emitted per exec call.
|
|
/// Aggregation still collects full output; only the live event stream is capped.
|
|
pub(crate) const MAX_EXEC_OUTPUT_DELTAS_PER_CALL: usize = 10_000;
|
|
|
|
// Wait for the stdout/stderr collection tasks but guard against them
|
|
// hanging forever. In the normal case, both pipes are closed once the child
|
|
// terminates so the tasks exit quickly. However, if the child process
|
|
// spawned grandchildren that inherited its stdout/stderr file descriptors
|
|
// those pipes may stay open after we `kill` the direct child on timeout.
|
|
// That would cause the `read_capped` tasks to block on `read()`
|
|
// indefinitely, effectively hanging the whole agent.
|
|
pub const IO_DRAIN_TIMEOUT_MS: u64 = 2_000; // 2 s should be plenty for local pipes
|
|
|
|
#[derive(Debug)]
|
|
pub struct ExecParams {
|
|
pub command: Vec<String>,
|
|
pub cwd: PathBuf,
|
|
pub expiration: ExecExpiration,
|
|
pub capture_policy: ExecCapturePolicy,
|
|
pub env: HashMap<String, String>,
|
|
pub network: Option<NetworkProxy>,
|
|
pub sandbox_permissions: SandboxPermissions,
|
|
pub windows_sandbox_level: codex_protocol::config_types::WindowsSandboxLevel,
|
|
pub windows_sandbox_private_desktop: bool,
|
|
pub justification: Option<String>,
|
|
pub arg0: Option<String>,
|
|
}
|
|
|
|
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
|
|
pub enum ExecCapturePolicy {
|
|
/// Shell-like execs keep the historical output cap and timeout behavior.
|
|
#[default]
|
|
ShellTool,
|
|
/// Trusted internal helpers can buffer the full child output in memory
|
|
/// without the shell-oriented output cap or exec-expiration behavior.
|
|
FullBuffer,
|
|
}
|
|
|
|
fn select_process_exec_tool_sandbox_type(
|
|
file_system_sandbox_policy: &FileSystemSandboxPolicy,
|
|
network_sandbox_policy: NetworkSandboxPolicy,
|
|
windows_sandbox_level: codex_protocol::config_types::WindowsSandboxLevel,
|
|
enforce_managed_network: bool,
|
|
) -> SandboxType {
|
|
SandboxManager::new().select_initial(
|
|
file_system_sandbox_policy,
|
|
network_sandbox_policy,
|
|
SandboxablePreference::Auto,
|
|
windows_sandbox_level,
|
|
enforce_managed_network,
|
|
)
|
|
}
|
|
|
|
/// Mechanism to terminate an exec invocation before it finishes naturally.
|
|
#[derive(Clone, Debug)]
|
|
pub enum ExecExpiration {
|
|
Timeout(Duration),
|
|
DefaultTimeout,
|
|
Cancellation(CancellationToken),
|
|
}
|
|
|
|
impl From<Option<u64>> for ExecExpiration {
|
|
fn from(timeout_ms: Option<u64>) -> Self {
|
|
timeout_ms.map_or(ExecExpiration::DefaultTimeout, |timeout_ms| {
|
|
ExecExpiration::Timeout(Duration::from_millis(timeout_ms))
|
|
})
|
|
}
|
|
}
|
|
|
|
impl From<u64> for ExecExpiration {
|
|
fn from(timeout_ms: u64) -> Self {
|
|
ExecExpiration::Timeout(Duration::from_millis(timeout_ms))
|
|
}
|
|
}
|
|
|
|
impl ExecExpiration {
|
|
pub(crate) async fn wait(self) {
|
|
match self {
|
|
ExecExpiration::Timeout(duration) => tokio::time::sleep(duration).await,
|
|
ExecExpiration::DefaultTimeout => {
|
|
tokio::time::sleep(Duration::from_millis(DEFAULT_EXEC_COMMAND_TIMEOUT_MS)).await
|
|
}
|
|
ExecExpiration::Cancellation(cancel) => {
|
|
cancel.cancelled().await;
|
|
}
|
|
}
|
|
}
|
|
|
|
/// If ExecExpiration is a timeout, returns the timeout in milliseconds.
|
|
pub(crate) fn timeout_ms(&self) -> Option<u64> {
|
|
match self {
|
|
ExecExpiration::Timeout(duration) => Some(duration.as_millis() as u64),
|
|
ExecExpiration::DefaultTimeout => Some(DEFAULT_EXEC_COMMAND_TIMEOUT_MS),
|
|
ExecExpiration::Cancellation(_) => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ExecCapturePolicy {
|
|
fn retained_bytes_cap(self) -> Option<usize> {
|
|
match self {
|
|
Self::ShellTool => Some(EXEC_OUTPUT_MAX_BYTES),
|
|
Self::FullBuffer => None,
|
|
}
|
|
}
|
|
|
|
fn io_drain_timeout(self) -> Duration {
|
|
Duration::from_millis(IO_DRAIN_TIMEOUT_MS)
|
|
}
|
|
|
|
fn uses_expiration(self) -> bool {
|
|
match self {
|
|
Self::ShellTool => true,
|
|
Self::FullBuffer => false,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Copy, Debug, PartialEq)]
|
|
pub enum SandboxType {
|
|
None,
|
|
|
|
/// Only available on macOS.
|
|
MacosSeatbelt,
|
|
|
|
/// Only available on Linux.
|
|
LinuxSeccomp,
|
|
|
|
/// Only available on Windows.
|
|
WindowsRestrictedToken,
|
|
}
|
|
|
|
impl SandboxType {
|
|
pub(crate) fn as_metric_tag(self) -> &'static str {
|
|
match self {
|
|
SandboxType::None => "none",
|
|
SandboxType::MacosSeatbelt => "seatbelt",
|
|
SandboxType::LinuxSeccomp => "seccomp",
|
|
SandboxType::WindowsRestrictedToken => "windows_sandbox",
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
pub struct StdoutStream {
|
|
pub sub_id: String,
|
|
pub call_id: String,
|
|
pub tx_event: Sender<Event>,
|
|
}
|
|
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub async fn process_exec_tool_call(
|
|
params: ExecParams,
|
|
sandbox_policy: &SandboxPolicy,
|
|
file_system_sandbox_policy: &FileSystemSandboxPolicy,
|
|
network_sandbox_policy: NetworkSandboxPolicy,
|
|
sandbox_cwd: &Path,
|
|
codex_linux_sandbox_exe: &Option<PathBuf>,
|
|
use_legacy_landlock: bool,
|
|
stdout_stream: Option<StdoutStream>,
|
|
) -> Result<ExecToolCallOutput> {
|
|
let exec_req = build_exec_request(
|
|
params,
|
|
sandbox_policy,
|
|
file_system_sandbox_policy,
|
|
network_sandbox_policy,
|
|
sandbox_cwd,
|
|
codex_linux_sandbox_exe,
|
|
use_legacy_landlock,
|
|
)?;
|
|
|
|
// Route through the sandboxing module for a single, unified execution path.
|
|
crate::sandboxing::execute_env(exec_req, stdout_stream).await
|
|
}
|
|
|
|
/// Transform a portable exec request into the concrete argv/env that should be
|
|
/// spawned under the requested sandbox policy.
|
|
pub fn build_exec_request(
|
|
params: ExecParams,
|
|
sandbox_policy: &SandboxPolicy,
|
|
file_system_sandbox_policy: &FileSystemSandboxPolicy,
|
|
network_sandbox_policy: NetworkSandboxPolicy,
|
|
sandbox_cwd: &Path,
|
|
codex_linux_sandbox_exe: &Option<PathBuf>,
|
|
use_legacy_landlock: bool,
|
|
) -> Result<ExecRequest> {
|
|
let windows_sandbox_level = params.windows_sandbox_level;
|
|
let enforce_managed_network = params.network.is_some();
|
|
let sandbox_type = select_process_exec_tool_sandbox_type(
|
|
file_system_sandbox_policy,
|
|
network_sandbox_policy,
|
|
windows_sandbox_level,
|
|
enforce_managed_network,
|
|
);
|
|
tracing::debug!("Sandbox type: {sandbox_type:?}");
|
|
|
|
let ExecParams {
|
|
command,
|
|
cwd,
|
|
mut env,
|
|
expiration,
|
|
capture_policy,
|
|
network,
|
|
sandbox_permissions,
|
|
windows_sandbox_level,
|
|
windows_sandbox_private_desktop,
|
|
justification,
|
|
arg0: _,
|
|
} = params;
|
|
if let Some(network) = network.as_ref() {
|
|
network.apply_to_env(&mut env);
|
|
}
|
|
let (program, args) = command.split_first().ok_or_else(|| {
|
|
CodexErr::Io(io::Error::new(
|
|
io::ErrorKind::InvalidInput,
|
|
"command args are empty",
|
|
))
|
|
})?;
|
|
|
|
let spec = CommandSpec {
|
|
program: program.clone(),
|
|
args: args.to_vec(),
|
|
cwd,
|
|
env,
|
|
expiration,
|
|
capture_policy,
|
|
sandbox_permissions,
|
|
additional_permissions: None,
|
|
justification,
|
|
};
|
|
|
|
let manager = SandboxManager::new();
|
|
let exec_req = manager
|
|
.transform(crate::sandboxing::SandboxTransformRequest {
|
|
spec,
|
|
policy: sandbox_policy,
|
|
file_system_policy: file_system_sandbox_policy,
|
|
network_policy: network_sandbox_policy,
|
|
sandbox: sandbox_type,
|
|
enforce_managed_network,
|
|
network: network.as_ref(),
|
|
sandbox_policy_cwd: sandbox_cwd,
|
|
#[cfg(target_os = "macos")]
|
|
macos_seatbelt_profile_extensions: None,
|
|
codex_linux_sandbox_exe: codex_linux_sandbox_exe.as_ref(),
|
|
use_legacy_landlock,
|
|
windows_sandbox_level,
|
|
windows_sandbox_private_desktop,
|
|
})
|
|
.map_err(CodexErr::from)?;
|
|
Ok(exec_req)
|
|
}
|
|
|
|
pub(crate) async fn execute_exec_request(
|
|
exec_request: ExecRequest,
|
|
sandbox_policy: &SandboxPolicy,
|
|
stdout_stream: Option<StdoutStream>,
|
|
after_spawn: Option<Box<dyn FnOnce() + Send>>,
|
|
) -> Result<ExecToolCallOutput> {
|
|
let ExecRequest {
|
|
command,
|
|
cwd,
|
|
env,
|
|
network,
|
|
expiration,
|
|
capture_policy,
|
|
sandbox,
|
|
windows_sandbox_level,
|
|
windows_sandbox_private_desktop,
|
|
sandbox_permissions,
|
|
sandbox_policy: _sandbox_policy_from_env,
|
|
file_system_sandbox_policy,
|
|
network_sandbox_policy,
|
|
justification,
|
|
arg0,
|
|
} = exec_request;
|
|
let _ = _sandbox_policy_from_env;
|
|
|
|
let params = ExecParams {
|
|
command,
|
|
cwd,
|
|
expiration,
|
|
capture_policy,
|
|
env,
|
|
network: network.clone(),
|
|
sandbox_permissions,
|
|
windows_sandbox_level,
|
|
windows_sandbox_private_desktop,
|
|
justification,
|
|
arg0,
|
|
};
|
|
|
|
let start = Instant::now();
|
|
let raw_output_result = exec(
|
|
params,
|
|
sandbox,
|
|
sandbox_policy,
|
|
&file_system_sandbox_policy,
|
|
network_sandbox_policy,
|
|
stdout_stream,
|
|
after_spawn,
|
|
)
|
|
.await;
|
|
let duration = start.elapsed();
|
|
finalize_exec_result(raw_output_result, sandbox, duration)
|
|
}
|
|
|
|
pub(crate) async fn execute_exec_request_in_environment(
|
|
exec_request: ExecRequest,
|
|
environment: &ExecutorEnvironment,
|
|
stdout_stream: Option<StdoutStream>,
|
|
after_spawn: Option<Box<dyn FnOnce() + Send>>,
|
|
) -> Result<ExecToolCallOutput> {
|
|
if environment.experimental_exec_server_url().is_none() {
|
|
let effective_policy = exec_request.sandbox_policy.clone();
|
|
return execute_exec_request(exec_request, &effective_policy, stdout_stream, after_spawn)
|
|
.await;
|
|
}
|
|
|
|
exec_remote::execute_exec_request_via_environment(
|
|
exec_request,
|
|
environment,
|
|
stdout_stream,
|
|
after_spawn,
|
|
)
|
|
.await
|
|
}
|
|
|
|
#[cfg(target_os = "windows")]
|
|
fn extract_create_process_as_user_error_code(err: &str) -> Option<String> {
|
|
let marker = "CreateProcessAsUserW failed: ";
|
|
let start = err.find(marker)? + marker.len();
|
|
let tail = &err[start..];
|
|
let digits: String = tail.chars().take_while(char::is_ascii_digit).collect();
|
|
if digits.is_empty() {
|
|
None
|
|
} else {
|
|
Some(digits)
|
|
}
|
|
}
|
|
|
|
#[cfg(target_os = "windows")]
|
|
fn windowsapps_path_kind(path: &str) -> &'static str {
|
|
let lower = path.to_ascii_lowercase();
|
|
if lower.contains("\\program files\\windowsapps\\") {
|
|
return "windowsapps_package";
|
|
}
|
|
if lower.contains("\\appdata\\local\\microsoft\\windowsapps\\") {
|
|
return "windowsapps_alias";
|
|
}
|
|
if lower.contains("\\windowsapps\\") {
|
|
return "windowsapps_other";
|
|
}
|
|
"other"
|
|
}
|
|
|
|
#[cfg(target_os = "windows")]
|
|
fn record_windows_sandbox_spawn_failure(
|
|
command_path: Option<&str>,
|
|
windows_sandbox_level: codex_protocol::config_types::WindowsSandboxLevel,
|
|
err: &str,
|
|
) {
|
|
let Some(error_code) = extract_create_process_as_user_error_code(err) else {
|
|
return;
|
|
};
|
|
let path = command_path.unwrap_or("unknown");
|
|
let exe = Path::new(path)
|
|
.file_name()
|
|
.and_then(|name| name.to_str())
|
|
.unwrap_or("unknown")
|
|
.to_ascii_lowercase();
|
|
let path_kind = windowsapps_path_kind(path);
|
|
let level = if matches!(
|
|
windows_sandbox_level,
|
|
codex_protocol::config_types::WindowsSandboxLevel::Elevated
|
|
) {
|
|
"elevated"
|
|
} else {
|
|
"legacy"
|
|
};
|
|
if let Some(metrics) = codex_otel::metrics::global() {
|
|
let _ = metrics.counter(
|
|
"codex.windows_sandbox.createprocessasuserw_failed",
|
|
/*inc*/ 1,
|
|
&[
|
|
("error_code", error_code.as_str()),
|
|
("path_kind", path_kind),
|
|
("exe", exe.as_str()),
|
|
("level", level),
|
|
],
|
|
);
|
|
}
|
|
}
|
|
|
|
#[cfg(target_os = "windows")]
|
|
async fn exec_windows_sandbox(
|
|
params: ExecParams,
|
|
sandbox_policy: &SandboxPolicy,
|
|
) -> Result<RawExecToolCallOutput> {
|
|
use crate::config::find_codex_home;
|
|
use codex_protocol::config_types::WindowsSandboxLevel;
|
|
use codex_windows_sandbox::run_windows_sandbox_capture;
|
|
use codex_windows_sandbox::run_windows_sandbox_capture_elevated;
|
|
|
|
let ExecParams {
|
|
command,
|
|
cwd,
|
|
mut env,
|
|
network,
|
|
expiration,
|
|
capture_policy,
|
|
windows_sandbox_level,
|
|
windows_sandbox_private_desktop,
|
|
..
|
|
} = params;
|
|
if let Some(network) = network.as_ref() {
|
|
network.apply_to_env(&mut env);
|
|
}
|
|
|
|
// TODO(iceweasel-oai): run_windows_sandbox_capture should support all
|
|
// variants of ExecExpiration, not just timeout.
|
|
let timeout_ms = if capture_policy.uses_expiration() {
|
|
expiration.timeout_ms()
|
|
} else {
|
|
None
|
|
};
|
|
|
|
let policy_str = serde_json::to_string(sandbox_policy).map_err(|err| {
|
|
CodexErr::Io(io::Error::other(format!(
|
|
"failed to serialize Windows sandbox policy: {err}"
|
|
)))
|
|
})?;
|
|
let sandbox_cwd = cwd.clone();
|
|
let codex_home = find_codex_home().map_err(|err| {
|
|
CodexErr::Io(io::Error::other(format!(
|
|
"windows sandbox: failed to resolve codex_home: {err}"
|
|
)))
|
|
})?;
|
|
let command_path = command.first().cloned();
|
|
let sandbox_level = windows_sandbox_level;
|
|
let use_elevated = matches!(sandbox_level, WindowsSandboxLevel::Elevated);
|
|
let spawn_res = tokio::task::spawn_blocking(move || {
|
|
if use_elevated {
|
|
run_windows_sandbox_capture_elevated(
|
|
policy_str.as_str(),
|
|
&sandbox_cwd,
|
|
codex_home.as_ref(),
|
|
command,
|
|
&cwd,
|
|
env,
|
|
timeout_ms,
|
|
windows_sandbox_private_desktop,
|
|
)
|
|
} else {
|
|
run_windows_sandbox_capture(
|
|
policy_str.as_str(),
|
|
&sandbox_cwd,
|
|
codex_home.as_ref(),
|
|
command,
|
|
&cwd,
|
|
env,
|
|
timeout_ms,
|
|
windows_sandbox_private_desktop,
|
|
)
|
|
}
|
|
})
|
|
.await;
|
|
|
|
let capture = match spawn_res {
|
|
Ok(Ok(v)) => v,
|
|
Ok(Err(err)) => {
|
|
record_windows_sandbox_spawn_failure(
|
|
command_path.as_deref(),
|
|
sandbox_level,
|
|
&err.to_string(),
|
|
);
|
|
return Err(CodexErr::Io(io::Error::other(format!(
|
|
"windows sandbox: {err}"
|
|
))));
|
|
}
|
|
Err(join_err) => {
|
|
return Err(CodexErr::Io(io::Error::other(format!(
|
|
"windows sandbox join error: {join_err}"
|
|
))));
|
|
}
|
|
};
|
|
|
|
let exit_status = synthetic_exit_status(capture.exit_code);
|
|
let mut stdout_text = capture.stdout;
|
|
if let Some(max_bytes) = capture_policy.retained_bytes_cap()
|
|
&& stdout_text.len() > max_bytes
|
|
{
|
|
stdout_text.truncate(max_bytes);
|
|
}
|
|
let mut stderr_text = capture.stderr;
|
|
if let Some(max_bytes) = capture_policy.retained_bytes_cap()
|
|
&& stderr_text.len() > max_bytes
|
|
{
|
|
stderr_text.truncate(max_bytes);
|
|
}
|
|
let stdout = StreamOutput {
|
|
text: stdout_text,
|
|
truncated_after_lines: None,
|
|
};
|
|
let stderr = StreamOutput {
|
|
text: stderr_text,
|
|
truncated_after_lines: None,
|
|
};
|
|
let aggregated_output = aggregate_output(&stdout, &stderr, capture_policy.retained_bytes_cap());
|
|
|
|
Ok(RawExecToolCallOutput {
|
|
exit_status,
|
|
stdout,
|
|
stderr,
|
|
aggregated_output,
|
|
timed_out: capture.timed_out,
|
|
})
|
|
}
|
|
|
|
fn finalize_exec_result(
|
|
raw_output_result: std::result::Result<RawExecToolCallOutput, CodexErr>,
|
|
sandbox_type: SandboxType,
|
|
duration: Duration,
|
|
) -> Result<ExecToolCallOutput> {
|
|
match raw_output_result {
|
|
Ok(raw_output) => {
|
|
#[allow(unused_mut)]
|
|
let mut timed_out = raw_output.timed_out;
|
|
|
|
#[cfg(target_family = "unix")]
|
|
{
|
|
if let Some(signal) = raw_output.exit_status.signal() {
|
|
if signal == TIMEOUT_CODE {
|
|
timed_out = true;
|
|
} else {
|
|
return Err(CodexErr::Sandbox(SandboxErr::Signal(signal)));
|
|
}
|
|
}
|
|
}
|
|
|
|
let mut exit_code = raw_output.exit_status.code().unwrap_or(-1);
|
|
if timed_out {
|
|
exit_code = EXEC_TIMEOUT_EXIT_CODE;
|
|
}
|
|
|
|
let stdout = raw_output.stdout.from_utf8_lossy();
|
|
let stderr = raw_output.stderr.from_utf8_lossy();
|
|
let aggregated_output = raw_output.aggregated_output.from_utf8_lossy();
|
|
let exec_output = ExecToolCallOutput {
|
|
exit_code,
|
|
stdout,
|
|
stderr,
|
|
aggregated_output,
|
|
duration,
|
|
timed_out,
|
|
};
|
|
|
|
if timed_out {
|
|
return Err(CodexErr::Sandbox(SandboxErr::Timeout {
|
|
output: Box::new(exec_output),
|
|
}));
|
|
}
|
|
|
|
if is_likely_sandbox_denied(sandbox_type, &exec_output) {
|
|
return Err(CodexErr::Sandbox(SandboxErr::Denied {
|
|
output: Box::new(exec_output),
|
|
network_policy_decision: None,
|
|
}));
|
|
}
|
|
|
|
Ok(exec_output)
|
|
}
|
|
Err(err) => {
|
|
tracing::error!("exec error: {err}");
|
|
Err(err)
|
|
}
|
|
}
|
|
}
|
|
|
|
pub(crate) mod errors {
|
|
use super::CodexErr;
|
|
use crate::sandboxing::SandboxTransformError;
|
|
|
|
impl From<SandboxTransformError> for CodexErr {
|
|
fn from(err: SandboxTransformError) -> Self {
|
|
match err {
|
|
SandboxTransformError::MissingLinuxSandboxExecutable => {
|
|
CodexErr::LandlockSandboxExecutableNotProvided
|
|
}
|
|
#[cfg(not(target_os = "macos"))]
|
|
SandboxTransformError::SeatbeltUnavailable => CodexErr::UnsupportedOperation(
|
|
"seatbelt sandbox is only available on macOS".to_string(),
|
|
),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// We don't have a fully deterministic way to tell if our command failed
|
|
/// because of the sandbox - a command in the user's zshrc file might hit an
|
|
/// error, but the command itself might fail or succeed for other reasons.
|
|
/// For now, we conservatively check for well known command failure exit codes and
|
|
/// also look for common sandbox denial keywords in the command output.
|
|
pub(crate) fn is_likely_sandbox_denied(
|
|
sandbox_type: SandboxType,
|
|
exec_output: &ExecToolCallOutput,
|
|
) -> bool {
|
|
if sandbox_type == SandboxType::None || exec_output.exit_code == 0 {
|
|
return false;
|
|
}
|
|
|
|
// Quick rejects: well-known non-sandbox shell exit codes
|
|
// 2: misuse of shell builtins
|
|
// 126: permission denied
|
|
// 127: command not found
|
|
const SANDBOX_DENIED_KEYWORDS: [&str; 7] = [
|
|
"operation not permitted",
|
|
"permission denied",
|
|
"read-only file system",
|
|
"seccomp",
|
|
"sandbox",
|
|
"landlock",
|
|
"failed to write file",
|
|
];
|
|
|
|
let has_sandbox_keyword = [
|
|
&exec_output.stderr.text,
|
|
&exec_output.stdout.text,
|
|
&exec_output.aggregated_output.text,
|
|
]
|
|
.into_iter()
|
|
.any(|section| {
|
|
let lower = section.to_lowercase();
|
|
SANDBOX_DENIED_KEYWORDS
|
|
.iter()
|
|
.any(|needle| lower.contains(needle))
|
|
});
|
|
|
|
if has_sandbox_keyword {
|
|
return true;
|
|
}
|
|
|
|
const QUICK_REJECT_EXIT_CODES: [i32; 3] = [2, 126, 127];
|
|
if QUICK_REJECT_EXIT_CODES.contains(&exec_output.exit_code) {
|
|
return false;
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
{
|
|
const SIGSYS_CODE: i32 = libc::SIGSYS;
|
|
if sandbox_type == SandboxType::LinuxSeccomp
|
|
&& exec_output.exit_code == EXIT_CODE_SIGNAL_BASE + SIGSYS_CODE
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
false
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct StreamOutput<T: Clone> {
|
|
pub text: T,
|
|
pub truncated_after_lines: Option<u32>,
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
struct RawExecToolCallOutput {
|
|
pub exit_status: ExitStatus,
|
|
pub stdout: StreamOutput<Vec<u8>>,
|
|
pub stderr: StreamOutput<Vec<u8>>,
|
|
pub aggregated_output: StreamOutput<Vec<u8>>,
|
|
pub timed_out: bool,
|
|
}
|
|
|
|
impl StreamOutput<String> {
|
|
pub fn new(text: String) -> Self {
|
|
Self {
|
|
text,
|
|
truncated_after_lines: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl StreamOutput<Vec<u8>> {
|
|
pub fn from_utf8_lossy(&self) -> StreamOutput<String> {
|
|
StreamOutput {
|
|
text: bytes_to_string_smart(&self.text),
|
|
truncated_after_lines: self.truncated_after_lines,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn append_capped(dst: &mut Vec<u8>, src: &[u8], max_bytes: usize) {
|
|
if dst.len() >= max_bytes {
|
|
return;
|
|
}
|
|
let remaining = max_bytes.saturating_sub(dst.len());
|
|
let take = remaining.min(src.len());
|
|
dst.extend_from_slice(&src[..take]);
|
|
}
|
|
|
|
fn aggregate_output(
|
|
stdout: &StreamOutput<Vec<u8>>,
|
|
stderr: &StreamOutput<Vec<u8>>,
|
|
max_bytes: Option<usize>,
|
|
) -> StreamOutput<Vec<u8>> {
|
|
let Some(max_bytes) = max_bytes else {
|
|
let total_len = stdout.text.len().saturating_add(stderr.text.len());
|
|
let mut aggregated = Vec::with_capacity(total_len);
|
|
aggregated.extend_from_slice(&stdout.text);
|
|
aggregated.extend_from_slice(&stderr.text);
|
|
return StreamOutput {
|
|
text: aggregated,
|
|
truncated_after_lines: None,
|
|
};
|
|
};
|
|
|
|
let total_len = stdout.text.len().saturating_add(stderr.text.len());
|
|
let mut aggregated = Vec::with_capacity(total_len.min(max_bytes));
|
|
|
|
if total_len <= max_bytes {
|
|
aggregated.extend_from_slice(&stdout.text);
|
|
aggregated.extend_from_slice(&stderr.text);
|
|
return StreamOutput {
|
|
text: aggregated,
|
|
truncated_after_lines: None,
|
|
};
|
|
}
|
|
|
|
// Under contention, reserve 1/3 for stdout and 2/3 for stderr; rebalance unused stderr to stdout.
|
|
let want_stdout = stdout.text.len().min(max_bytes / 3);
|
|
let want_stderr = stderr.text.len();
|
|
let stderr_take = want_stderr.min(max_bytes.saturating_sub(want_stdout));
|
|
let remaining = max_bytes.saturating_sub(want_stdout + stderr_take);
|
|
let stdout_take = want_stdout + remaining.min(stdout.text.len().saturating_sub(want_stdout));
|
|
|
|
aggregated.extend_from_slice(&stdout.text[..stdout_take]);
|
|
aggregated.extend_from_slice(&stderr.text[..stderr_take]);
|
|
|
|
StreamOutput {
|
|
text: aggregated,
|
|
truncated_after_lines: None,
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct ExecToolCallOutput {
|
|
pub exit_code: i32,
|
|
pub stdout: StreamOutput<String>,
|
|
pub stderr: StreamOutput<String>,
|
|
pub aggregated_output: StreamOutput<String>,
|
|
pub duration: Duration,
|
|
pub timed_out: bool,
|
|
}
|
|
|
|
impl Default for ExecToolCallOutput {
|
|
fn default() -> Self {
|
|
Self {
|
|
exit_code: 0,
|
|
stdout: StreamOutput::new(String::new()),
|
|
stderr: StreamOutput::new(String::new()),
|
|
aggregated_output: StreamOutput::new(String::new()),
|
|
duration: Duration::ZERO,
|
|
timed_out: false,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg_attr(not(target_os = "windows"), allow(unused_variables))]
|
|
async fn exec(
|
|
params: ExecParams,
|
|
sandbox: SandboxType,
|
|
sandbox_policy: &SandboxPolicy,
|
|
file_system_sandbox_policy: &FileSystemSandboxPolicy,
|
|
network_sandbox_policy: NetworkSandboxPolicy,
|
|
stdout_stream: Option<StdoutStream>,
|
|
after_spawn: Option<Box<dyn FnOnce() + Send>>,
|
|
) -> Result<RawExecToolCallOutput> {
|
|
#[cfg(target_os = "windows")]
|
|
if sandbox == SandboxType::WindowsRestrictedToken {
|
|
let support = windows_restricted_token_sandbox_support(
|
|
sandbox,
|
|
params.windows_sandbox_level,
|
|
sandbox_policy,
|
|
file_system_sandbox_policy,
|
|
network_sandbox_policy,
|
|
);
|
|
if let Some(reason) = support.unsupported_reason {
|
|
return Err(CodexErr::Io(io::Error::other(reason)));
|
|
}
|
|
return exec_windows_sandbox(params, sandbox_policy).await;
|
|
}
|
|
let ExecParams {
|
|
command,
|
|
cwd,
|
|
mut env,
|
|
network,
|
|
arg0,
|
|
expiration,
|
|
capture_policy,
|
|
windows_sandbox_level: _,
|
|
..
|
|
} = params;
|
|
if let Some(network) = network.as_ref() {
|
|
network.apply_to_env(&mut env);
|
|
}
|
|
|
|
let (program, args) = command.split_first().ok_or_else(|| {
|
|
CodexErr::Io(io::Error::new(
|
|
io::ErrorKind::InvalidInput,
|
|
"command args are empty",
|
|
))
|
|
})?;
|
|
let arg0_ref = arg0.as_deref();
|
|
let child = spawn_child_async(SpawnChildRequest {
|
|
program: PathBuf::from(program),
|
|
args: args.into(),
|
|
arg0: arg0_ref,
|
|
cwd,
|
|
network_sandbox_policy,
|
|
// The environment already has attempt-scoped proxy settings from
|
|
// apply_to_env_for_attempt above. Passing network here would reapply
|
|
// non-attempt proxy vars and drop attempt correlation metadata.
|
|
network: None,
|
|
stdio_policy: StdioPolicy::RedirectForShellTool,
|
|
env,
|
|
})
|
|
.await?;
|
|
if let Some(after_spawn) = after_spawn {
|
|
after_spawn();
|
|
}
|
|
consume_output(child, expiration, capture_policy, stdout_stream).await
|
|
}
|
|
|
|
#[cfg_attr(not(target_os = "windows"), allow(dead_code))]
|
|
#[derive(Debug, PartialEq, Eq)]
|
|
struct WindowsRestrictedTokenSandboxSupport {
|
|
should_use: bool,
|
|
unsupported_reason: Option<String>,
|
|
}
|
|
|
|
#[cfg(any(target_os = "windows", test))]
|
|
fn windows_restricted_token_sandbox_support(
|
|
sandbox: SandboxType,
|
|
windows_sandbox_level: codex_protocol::config_types::WindowsSandboxLevel,
|
|
sandbox_policy: &SandboxPolicy,
|
|
file_system_sandbox_policy: &FileSystemSandboxPolicy,
|
|
network_sandbox_policy: NetworkSandboxPolicy,
|
|
) -> WindowsRestrictedTokenSandboxSupport {
|
|
if sandbox != SandboxType::WindowsRestrictedToken {
|
|
return WindowsRestrictedTokenSandboxSupport {
|
|
should_use: false,
|
|
unsupported_reason: None,
|
|
};
|
|
}
|
|
|
|
// Windows currently reuses SandboxType::WindowsRestrictedToken for both
|
|
// the legacy restricted-token backend and the elevated setup/runner path.
|
|
// The sandbox level decides whether restricted read-only policies are
|
|
// supported.
|
|
let should_use = file_system_sandbox_policy.kind == FileSystemSandboxKind::Restricted
|
|
&& !matches!(
|
|
sandbox_policy,
|
|
SandboxPolicy::DangerFullAccess | SandboxPolicy::ExternalSandbox { .. }
|
|
)
|
|
&& (matches!(
|
|
windows_sandbox_level,
|
|
codex_protocol::config_types::WindowsSandboxLevel::Elevated
|
|
) || sandbox_policy.has_full_disk_read_access());
|
|
|
|
let unsupported_reason = if should_use {
|
|
None
|
|
} else {
|
|
Some(format!(
|
|
"windows sandbox backend cannot enforce file_system={:?}, network={network_sandbox_policy:?}, legacy_policy={sandbox_policy:?}; refusing to run unsandboxed",
|
|
file_system_sandbox_policy.kind,
|
|
))
|
|
};
|
|
|
|
WindowsRestrictedTokenSandboxSupport {
|
|
should_use,
|
|
unsupported_reason,
|
|
}
|
|
}
|
|
|
|
/// Consumes the output of a child process according to the configured capture
|
|
/// policy.
|
|
async fn consume_output(
|
|
mut child: Child,
|
|
expiration: ExecExpiration,
|
|
capture_policy: ExecCapturePolicy,
|
|
stdout_stream: Option<StdoutStream>,
|
|
) -> Result<RawExecToolCallOutput> {
|
|
// Both stdout and stderr were configured with `Stdio::piped()`
|
|
// above, therefore `take()` should normally return `Some`. If it doesn't
|
|
// we treat it as an exceptional I/O error
|
|
|
|
let stdout_reader = child.stdout.take().ok_or_else(|| {
|
|
CodexErr::Io(io::Error::other(
|
|
"stdout pipe was unexpectedly not available",
|
|
))
|
|
})?;
|
|
let stderr_reader = child.stderr.take().ok_or_else(|| {
|
|
CodexErr::Io(io::Error::other(
|
|
"stderr pipe was unexpectedly not available",
|
|
))
|
|
})?;
|
|
|
|
let retained_bytes_cap = capture_policy.retained_bytes_cap();
|
|
let stdout_handle = tokio::spawn(read_output(
|
|
BufReader::new(stdout_reader),
|
|
stdout_stream.clone(),
|
|
/*is_stderr*/ false,
|
|
retained_bytes_cap,
|
|
));
|
|
let stderr_handle = tokio::spawn(read_output(
|
|
BufReader::new(stderr_reader),
|
|
stdout_stream.clone(),
|
|
/*is_stderr*/ true,
|
|
retained_bytes_cap,
|
|
));
|
|
|
|
let expiration_wait = async {
|
|
if capture_policy.uses_expiration() {
|
|
expiration.wait().await;
|
|
} else {
|
|
std::future::pending::<()>().await;
|
|
}
|
|
};
|
|
tokio::pin!(expiration_wait);
|
|
let (exit_status, timed_out) = tokio::select! {
|
|
status_result = child.wait() => {
|
|
let exit_status = status_result?;
|
|
(exit_status, false)
|
|
}
|
|
_ = &mut expiration_wait => {
|
|
kill_child_process_group(&mut child)?;
|
|
child.start_kill()?;
|
|
(synthetic_exit_status(EXIT_CODE_SIGNAL_BASE + TIMEOUT_CODE), true)
|
|
}
|
|
_ = tokio::signal::ctrl_c() => {
|
|
kill_child_process_group(&mut child)?;
|
|
child.start_kill()?;
|
|
(synthetic_exit_status(EXIT_CODE_SIGNAL_BASE + SIGKILL_CODE), false)
|
|
}
|
|
};
|
|
|
|
// We need mutable bindings so we can `abort()` them on timeout.
|
|
use tokio::task::JoinHandle;
|
|
|
|
async fn await_output(
|
|
handle: &mut JoinHandle<std::io::Result<StreamOutput<Vec<u8>>>>,
|
|
timeout: Duration,
|
|
) -> std::io::Result<StreamOutput<Vec<u8>>> {
|
|
match tokio::time::timeout(timeout, &mut *handle).await {
|
|
Ok(join_res) => match join_res {
|
|
Ok(io_res) => io_res,
|
|
Err(join_err) => Err(std::io::Error::other(join_err)),
|
|
},
|
|
Err(_elapsed) => {
|
|
// Timeout: abort the task to avoid hanging on open pipes.
|
|
handle.abort();
|
|
Ok(StreamOutput {
|
|
text: Vec::new(),
|
|
truncated_after_lines: None,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
let mut stdout_handle = stdout_handle;
|
|
let mut stderr_handle = stderr_handle;
|
|
|
|
let stdout = await_output(&mut stdout_handle, capture_policy.io_drain_timeout()).await?;
|
|
let stderr = await_output(&mut stderr_handle, capture_policy.io_drain_timeout()).await?;
|
|
let aggregated_output = aggregate_output(&stdout, &stderr, retained_bytes_cap);
|
|
|
|
Ok(RawExecToolCallOutput {
|
|
exit_status,
|
|
stdout,
|
|
stderr,
|
|
aggregated_output,
|
|
timed_out,
|
|
})
|
|
}
|
|
|
|
async fn read_output<R: AsyncRead + Unpin + Send + 'static>(
|
|
mut reader: R,
|
|
stream: Option<StdoutStream>,
|
|
is_stderr: bool,
|
|
max_bytes: Option<usize>,
|
|
) -> io::Result<StreamOutput<Vec<u8>>> {
|
|
let mut buf = Vec::with_capacity(
|
|
max_bytes.map_or(AGGREGATE_BUFFER_INITIAL_CAPACITY, |max_bytes| {
|
|
AGGREGATE_BUFFER_INITIAL_CAPACITY.min(max_bytes)
|
|
}),
|
|
);
|
|
let mut tmp = [0u8; READ_CHUNK_SIZE];
|
|
let mut emitted_deltas: usize = 0;
|
|
|
|
loop {
|
|
let n = reader.read(&mut tmp).await?;
|
|
if n == 0 {
|
|
break;
|
|
}
|
|
|
|
if let Some(stream) = &stream
|
|
&& emitted_deltas < MAX_EXEC_OUTPUT_DELTAS_PER_CALL
|
|
{
|
|
emit_output_delta(Some(stream), is_stderr, tmp[..n].to_vec()).await;
|
|
emitted_deltas += 1;
|
|
}
|
|
|
|
if let Some(max_bytes) = max_bytes {
|
|
append_capped(&mut buf, &tmp[..n], max_bytes);
|
|
} else {
|
|
buf.extend_from_slice(&tmp[..n]);
|
|
}
|
|
// Continue reading to EOF to avoid back-pressure
|
|
}
|
|
|
|
Ok(StreamOutput {
|
|
text: buf,
|
|
truncated_after_lines: None,
|
|
})
|
|
}
|
|
|
|
async fn emit_output_delta(stream: Option<&StdoutStream>, is_stderr: bool, chunk: Vec<u8>) {
|
|
let Some(stream) = stream else {
|
|
return;
|
|
};
|
|
|
|
let msg = EventMsg::ExecCommandOutputDelta(ExecCommandOutputDeltaEvent {
|
|
call_id: stream.call_id.clone(),
|
|
stream: if is_stderr {
|
|
ExecOutputStream::Stderr
|
|
} else {
|
|
ExecOutputStream::Stdout
|
|
},
|
|
chunk,
|
|
});
|
|
let event = Event {
|
|
id: stream.sub_id.clone(),
|
|
msg,
|
|
};
|
|
#[allow(clippy::let_unit_value)]
|
|
let _ = stream.tx_event.send(event).await;
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn synthetic_exit_status(code: i32) -> ExitStatus {
|
|
use std::os::unix::process::ExitStatusExt;
|
|
std::process::ExitStatus::from_raw(code)
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn synthetic_exit_status(code: i32) -> ExitStatus {
|
|
use std::os::windows::process::ExitStatusExt;
|
|
// On Windows the raw status is a u32. Use a direct cast to avoid
|
|
// panicking on negative i32 values produced by prior narrowing casts.
|
|
std::process::ExitStatus::from_raw(code as u32)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[path = "exec_tests.rs"]
|
|
mod tests;
|