#[cfg(target_os = "macos")] mod pid_tracker; #[cfg(target_os = "macos")] mod seatbelt; use std::path::PathBuf; use std::process::Stdio; use codex_core::config::Config; use codex_core::config::ConfigBuilder; use codex_core::config::ConfigOverrides; use codex_core::config::NetworkProxyAuditMetadata; use codex_core::exec_env::create_env; #[cfg(target_os = "macos")] use codex_core::spawn::CODEX_SANDBOX_ENV_VAR; use codex_core::spawn::CODEX_SANDBOX_NETWORK_DISABLED_ENV_VAR; use codex_protocol::config_types::SandboxMode; use codex_protocol::permissions::NetworkSandboxPolicy; use codex_sandboxing::landlock::create_linux_sandbox_command_args_for_policies; #[cfg(target_os = "macos")] use codex_sandboxing::seatbelt::CreateSeatbeltCommandArgsParams; #[cfg(target_os = "macos")] use codex_sandboxing::seatbelt::create_seatbelt_command_args; use codex_utils_absolute_path::AbsolutePathBuf; use codex_utils_cli::CliConfigOverrides; use tokio::process::Child; use tokio::process::Command as TokioCommand; use toml::Value as TomlValue; use crate::LandlockCommand; use crate::SeatbeltCommand; use crate::WindowsCommand; use crate::exit_status::handle_exit_status; #[cfg(target_os = "macos")] use seatbelt::DenialLogger; #[cfg(target_os = "macos")] pub async fn run_command_under_seatbelt( command: SeatbeltCommand, codex_linux_sandbox_exe: Option, ) -> anyhow::Result<()> { let SeatbeltCommand { full_auto, allow_unix_sockets, log_denials, config_overrides, command, } = command; run_command_under_sandbox( full_auto, command, config_overrides, codex_linux_sandbox_exe, SandboxType::Seatbelt, log_denials, &allow_unix_sockets, ) .await } #[cfg(not(target_os = "macos"))] pub async fn run_command_under_seatbelt( _command: SeatbeltCommand, _codex_linux_sandbox_exe: Option, ) -> anyhow::Result<()> { anyhow::bail!("Seatbelt sandbox is only available on macOS"); } pub async fn run_command_under_landlock( command: LandlockCommand, codex_linux_sandbox_exe: Option, ) -> anyhow::Result<()> { let LandlockCommand { full_auto, config_overrides, command, } = command; run_command_under_sandbox( full_auto, command, config_overrides, codex_linux_sandbox_exe, SandboxType::Landlock, /*log_denials*/ false, &[], ) .await } pub async fn run_command_under_windows( command: WindowsCommand, codex_linux_sandbox_exe: Option, ) -> anyhow::Result<()> { let WindowsCommand { full_auto, config_overrides, command, } = command; run_command_under_sandbox( full_auto, command, config_overrides, codex_linux_sandbox_exe, SandboxType::Windows, /*log_denials*/ false, &[], ) .await } enum SandboxType { #[cfg(target_os = "macos")] Seatbelt, Landlock, Windows, } async fn run_command_under_sandbox( full_auto: bool, command: Vec, config_overrides: CliConfigOverrides, codex_linux_sandbox_exe: Option, sandbox_type: SandboxType, log_denials: bool, #[cfg_attr(not(target_os = "macos"), allow(unused_variables))] allow_unix_sockets: &[AbsolutePathBuf], ) -> anyhow::Result<()> { let config = load_debug_sandbox_config( config_overrides .parse_overrides() .map_err(anyhow::Error::msg)?, codex_linux_sandbox_exe, full_auto, ) .await?; // In practice, this should be `std::env::current_dir()` because this CLI // does not support `--cwd`, but let's use the config value for consistency. let cwd = config.cwd.clone(); // For now, we always use the same cwd for both the command and the // sandbox policy. In the future, we could add a CLI option to set them // separately. let sandbox_policy_cwd = cwd.clone(); let env = create_env( &config.permissions.shell_environment_policy, /*thread_id*/ None, ); // Special-case Windows sandbox: execute and exit the process to emulate inherited stdio. if let SandboxType::Windows = sandbox_type { #[cfg(target_os = "windows")] { run_command_under_windows_session(&config, command, cwd, sandbox_policy_cwd, env).await; } #[cfg(not(target_os = "windows"))] { anyhow::bail!("Windows sandbox is only available on Windows"); } } #[cfg(target_os = "macos")] let mut denial_logger = log_denials.then(DenialLogger::new).flatten(); #[cfg(not(target_os = "macos"))] let _ = log_denials; let managed_network_requirements_enabled = config.managed_network_requirements_enabled(); // This proxy should only live for the lifetime of the child process. let network_proxy = match config.permissions.network.as_ref() { Some(spec) => Some( spec.start_proxy( config.permissions.sandbox_policy.get(), /*policy_decider*/ None, /*blocked_request_observer*/ None, managed_network_requirements_enabled, NetworkProxyAuditMetadata::default(), ) .await .map_err(|err| anyhow::anyhow!("failed to start managed network proxy: {err}"))?, ), None => None, }; let network = network_proxy .as_ref() .map(codex_core::config::StartedNetworkProxy::proxy); let mut child = match sandbox_type { #[cfg(target_os = "macos")] SandboxType::Seatbelt => { let args = create_seatbelt_command_args(CreateSeatbeltCommandArgsParams { command, file_system_sandbox_policy: &config.permissions.file_system_sandbox_policy, network_sandbox_policy: config.permissions.network_sandbox_policy, sandbox_policy_cwd: sandbox_policy_cwd.as_path(), enforce_managed_network: false, network: network.as_ref(), extra_allow_unix_sockets: allow_unix_sockets, }); let network_policy = config.permissions.network_sandbox_policy; spawn_debug_sandbox_child( PathBuf::from("/usr/bin/sandbox-exec"), args, /*arg0*/ None, cwd.to_path_buf(), network_policy, env, |env_map| { env_map.insert(CODEX_SANDBOX_ENV_VAR.to_string(), "seatbelt".to_string()); if let Some(network) = network.as_ref() { network.apply_to_env(env_map); } }, ) .await? } SandboxType::Landlock => { #[expect(clippy::expect_used)] let codex_linux_sandbox_exe = config .codex_linux_sandbox_exe .expect("codex-linux-sandbox executable not found"); let use_legacy_landlock = config.features.use_legacy_landlock(); let args = create_linux_sandbox_command_args_for_policies( command, cwd.as_path(), config.permissions.sandbox_policy.get(), &config.permissions.file_system_sandbox_policy, config.permissions.network_sandbox_policy, sandbox_policy_cwd.as_path(), use_legacy_landlock, /*allow_network_for_proxy*/ false, ); let network_policy = config.permissions.network_sandbox_policy; spawn_debug_sandbox_child( codex_linux_sandbox_exe, args, Some("codex-linux-sandbox"), cwd.to_path_buf(), network_policy, env, |env_map| { if let Some(network) = network.as_ref() { network.apply_to_env(env_map); } }, ) .await? } SandboxType::Windows => { unreachable!("Windows sandbox should have been handled above"); } }; #[cfg(target_os = "macos")] if let Some(denial_logger) = &mut denial_logger { denial_logger.on_child_spawn(&child); } let status = child.wait().await?; #[cfg(target_os = "macos")] if let Some(denial_logger) = denial_logger { let denials = denial_logger.finish().await; eprintln!("\n=== Sandbox denials ==="); if denials.is_empty() { eprintln!("None found."); } else { for seatbelt::SandboxDenial { name, capability } in denials { eprintln!("({name}) {capability}"); } } } handle_exit_status(status); } #[cfg(target_os = "windows")] async fn run_command_under_windows_session( config: &Config, command: Vec, cwd: AbsolutePathBuf, sandbox_policy_cwd: AbsolutePathBuf, env: std::collections::HashMap, ) -> ! { use codex_core::windows_sandbox::WindowsSandboxLevelExt; use codex_protocol::config_types::WindowsSandboxLevel; use codex_windows_sandbox::spawn_windows_sandbox_session_elevated; use codex_windows_sandbox::spawn_windows_sandbox_session_legacy; let policy_str = match serde_json::to_string(config.permissions.sandbox_policy.get()) { Ok(policy_str) => policy_str, Err(err) => { eprintln!("windows sandbox failed to serialize policy: {err}"); std::process::exit(1); } }; let use_elevated = matches!( WindowsSandboxLevel::from_config(config), WindowsSandboxLevel::Elevated ); let spawned = if use_elevated { spawn_windows_sandbox_session_elevated( policy_str.as_str(), sandbox_policy_cwd.as_path(), config.codex_home.as_path(), command, cwd.as_path(), env, None, /*tty*/ false, /*stdin_open*/ true, config.permissions.windows_sandbox_private_desktop, ) .await } else { spawn_windows_sandbox_session_legacy( policy_str.as_str(), sandbox_policy_cwd.as_path(), config.codex_home.as_path(), command, cwd.as_path(), env, None, /*tty*/ false, /*stdin_open*/ true, config.permissions.windows_sandbox_private_desktop, ) .await }; let spawned = match spawned { Ok(spawned) => spawned, Err(err) => { eprintln!("windows sandbox failed: {err}"); std::process::exit(1); } }; let session = std::sync::Arc::new(spawned.session); let tokio_runtime = tokio::runtime::Handle::current(); // Give large or slow tail output a better chance to finish draining // without letting rare EOF issues hang the wrapper indefinitely. let output_drain_timeout = std::time::Duration::from_secs(5); // A helper thread watches our stdin. When the input source closes it, // the thread tells the main async code so we can also close stdin for // the sandboxed child process. let (stdin_eof_tx, stdin_eof_rx) = tokio::sync::oneshot::channel(); // Start background threads that copy stdin/stdout/stderr. We // intentionally do not keep their JoinHandles; dropping the handle does // not stop the thread, it just means we are not going to wait on it // later. drop(windows_stdio_bridge::spawn_input_forwarder( std::io::stdin(), session.writer_sender(), stdin_eof_tx, )); let (stdout_forwarder, stdout_forwarder_done_rx) = windows_stdio_bridge::spawn_output_forwarder( tokio_runtime.clone(), spawned.stdout_rx, std::io::stdout(), ); drop(stdout_forwarder); let (stderr_forwarder, stderr_forwarder_done_rx) = windows_stdio_bridge::spawn_output_forwarder( tokio_runtime.clone(), spawned.stderr_rx, std::io::stderr(), ); drop(stderr_forwarder); let stdin_close_task = tokio::spawn({ let session = std::sync::Arc::clone(&session); async move { let _ = stdin_eof_rx.await; session.close_stdin(); } }); let mut exit_rx = spawned.exit_rx; let exit_code = tokio::select! { res = &mut exit_rx => res.unwrap_or(-1), res = tokio::signal::ctrl_c() => { if let Ok(()) = res { session.request_terminate(); } exit_rx.await.unwrap_or(-1) } }; stdin_close_task.abort(); let _ = tokio::time::timeout(output_drain_timeout, async { let _ = stdout_forwarder_done_rx.await; let _ = stderr_forwarder_done_rx.await; }) .await; std::process::exit(exit_code); } pub fn create_sandbox_mode(full_auto: bool) -> SandboxMode { if full_auto { SandboxMode::WorkspaceWrite } else { SandboxMode::ReadOnly } } async fn spawn_debug_sandbox_child( program: PathBuf, args: Vec, arg0: Option<&str>, cwd: PathBuf, network_sandbox_policy: NetworkSandboxPolicy, mut env: std::collections::HashMap, apply_env: impl FnOnce(&mut std::collections::HashMap), ) -> std::io::Result { let mut cmd = TokioCommand::new(&program); #[cfg(unix)] cmd.arg0(arg0.map_or_else(|| program.to_string_lossy().to_string(), String::from)); #[cfg(not(unix))] let _ = arg0; cmd.args(args); cmd.current_dir(cwd); apply_env(&mut env); cmd.env_clear(); cmd.envs(env); if !network_sandbox_policy.is_enabled() { cmd.env(CODEX_SANDBOX_NETWORK_DISABLED_ENV_VAR, "1"); } cmd.stdin(Stdio::inherit()) .stdout(Stdio::inherit()) .stderr(Stdio::inherit()) .kill_on_drop(true) .spawn() } #[cfg(target_os = "windows")] mod windows_stdio_bridge { use std::io::Read; use std::io::Write; use tokio::sync::mpsc; use tokio::sync::oneshot; const STDIN_FORWARD_CHUNK_SIZE: usize = 8 * 1024; pub(super) fn spawn_input_forwarder( mut input: R, writer_tx: mpsc::Sender>, stdin_eof_tx: oneshot::Sender<()>, ) -> std::thread::JoinHandle<()> where R: Read + Send + 'static, { std::thread::spawn(move || { let mut buffer = [0_u8; STDIN_FORWARD_CHUNK_SIZE]; loop { match input.read(&mut buffer) { Ok(0) => break, Ok(n) => { if writer_tx.blocking_send(buffer[..n].to_vec()).is_err() { break; } } Err(err) if err.kind() == std::io::ErrorKind::Interrupted => continue, Err(err) => { eprintln!("windows sandbox stdin forwarder failed: {err}"); break; } } } let _ = stdin_eof_tx.send(()); }) } pub(super) fn spawn_output_forwarder( tokio_runtime: tokio::runtime::Handle, output_rx: mpsc::Receiver>, mut writer: W, ) -> (std::thread::JoinHandle<()>, oneshot::Receiver<()>) where W: Write + Send + 'static, { let (done_tx, done_rx) = oneshot::channel(); // The sandbox session emits output on Tokio channels, but writing to the // caller's stdio is simplest from a dedicated blocking thread. let handle = std::thread::spawn(move || { let mut output_rx = output_rx; while let Some(chunk) = tokio_runtime.block_on(output_rx.recv()) { if let Err(err) = writer.write_all(&chunk) { eprintln!("windows sandbox output forwarder failed to write: {err}"); break; } if let Err(err) = writer.flush() { eprintln!("windows sandbox output forwarder failed to flush: {err}"); break; } } let _ = done_tx.send(()); }); (handle, done_rx) } #[cfg(test)] mod tests { use std::sync::Mutex; use pretty_assertions::assert_eq; use super::*; #[tokio::test] async fn input_forwarder_sends_chunks_and_reports_eof() -> anyhow::Result<()> { let (writer_tx, mut writer_rx) = tokio::sync::mpsc::channel::>(4); let (stdin_closed_tx, stdin_closed_rx) = tokio::sync::oneshot::channel(); let input = std::io::Cursor::new(b"first\nsecond\n".to_vec()); let forwarder = spawn_input_forwarder(input, writer_tx, stdin_closed_tx); let mut received = Vec::new(); while let Some(chunk) = writer_rx.recv().await { received.extend_from_slice(&chunk); } stdin_closed_rx.await?; forwarder.join().expect("stdin forwarder should finish"); assert_eq!(received, b"first\nsecond\n".to_vec()); Ok(()) } #[tokio::test] async fn output_forwarder_writes_all_chunks() -> anyhow::Result<()> { #[derive(Clone, Default)] struct SharedWriter(std::sync::Arc>>); impl std::io::Write for SharedWriter { fn write(&mut self, buf: &[u8]) -> std::io::Result { let mut guard = self .0 .lock() .map_err(|_| std::io::Error::other("writer poisoned"))?; guard.extend_from_slice(buf); Ok(buf.len()) } fn flush(&mut self) -> std::io::Result<()> { Ok(()) } } let runtime = tokio::runtime::Handle::current(); let (output_tx, output_rx) = tokio::sync::mpsc::channel::>(4); let writer = SharedWriter::default(); let sink = std::sync::Arc::clone(&writer.0); let (forwarder, done_rx) = spawn_output_forwarder(runtime, output_rx, writer); output_tx.send(b"alpha".to_vec()).await?; output_tx.send(b"beta".to_vec()).await?; drop(output_tx); forwarder.join().expect("output forwarder should finish"); done_rx.await?; let output = sink .lock() .map_err(|_| anyhow::anyhow!("writer poisoned"))? .clone(); assert_eq!(output, b"alphabeta".to_vec()); Ok(()) } } } async fn load_debug_sandbox_config( cli_overrides: Vec<(String, TomlValue)>, codex_linux_sandbox_exe: Option, full_auto: bool, ) -> anyhow::Result { load_debug_sandbox_config_with_codex_home( cli_overrides, codex_linux_sandbox_exe, full_auto, /*codex_home*/ None, ) .await } async fn load_debug_sandbox_config_with_codex_home( cli_overrides: Vec<(String, TomlValue)>, codex_linux_sandbox_exe: Option, full_auto: bool, codex_home: Option, ) -> anyhow::Result { let config = build_debug_sandbox_config( cli_overrides.clone(), ConfigOverrides { codex_linux_sandbox_exe: codex_linux_sandbox_exe.clone(), ..Default::default() }, codex_home.clone(), ) .await?; if config_uses_permission_profiles(&config) { if full_auto { anyhow::bail!( "`codex sandbox --full-auto` is only supported for legacy `sandbox_mode` configs; choose a writable `[permissions]` profile instead" ); } return Ok(config); } build_debug_sandbox_config( cli_overrides, ConfigOverrides { sandbox_mode: Some(create_sandbox_mode(full_auto)), codex_linux_sandbox_exe, ..Default::default() }, codex_home, ) .await .map_err(Into::into) } async fn build_debug_sandbox_config( cli_overrides: Vec<(String, TomlValue)>, harness_overrides: ConfigOverrides, codex_home: Option, ) -> std::io::Result { let mut builder = ConfigBuilder::default() .cli_overrides(cli_overrides) .harness_overrides(harness_overrides); if let Some(codex_home) = codex_home { builder = builder .codex_home(codex_home.clone()) .fallback_cwd(Some(codex_home)); } builder.build().await } fn config_uses_permission_profiles(config: &Config) -> bool { config .config_layer_stack .effective_config() .get("default_permissions") .is_some() } #[cfg(test)] mod tests { use super::*; use tempfile::TempDir; fn escape_toml_path(path: &std::path::Path) -> String { path.display().to_string().replace('\\', "\\\\") } fn write_permissions_profile_config( codex_home: &TempDir, docs: &std::path::Path, private: &std::path::Path, ) -> std::io::Result<()> { std::fs::create_dir_all(private)?; let config = format!( "default_permissions = \"limited-read-test\"\n\ [permissions.limited-read-test.filesystem]\n\ \":minimal\" = \"read\"\n\ \"{}\" = \"read\"\n\ \"{}\" = \"none\"\n\ \n\ [permissions.limited-read-test.network]\n\ enabled = true\n", escape_toml_path(docs), escape_toml_path(private), ); std::fs::write(codex_home.path().join("config.toml"), config)?; Ok(()) } #[tokio::test] async fn debug_sandbox_honors_active_permission_profiles() -> anyhow::Result<()> { let codex_home = TempDir::new()?; let sandbox_paths = TempDir::new()?; let docs = sandbox_paths.path().join("docs"); let private = docs.join("private"); write_permissions_profile_config(&codex_home, &docs, &private)?; let codex_home_path = codex_home.path().to_path_buf(); let profile_config = build_debug_sandbox_config( Vec::new(), ConfigOverrides::default(), Some(codex_home_path.clone()), ) .await?; let legacy_config = build_debug_sandbox_config( Vec::new(), ConfigOverrides { sandbox_mode: Some(create_sandbox_mode(/*full_auto*/ false)), ..Default::default() }, Some(codex_home_path.clone()), ) .await?; let config = load_debug_sandbox_config_with_codex_home( Vec::new(), /*codex_linux_sandbox_exe*/ None, /*full_auto*/ false, Some(codex_home_path), ) .await?; assert!(config_uses_permission_profiles(&config)); assert!( profile_config.permissions.file_system_sandbox_policy != legacy_config.permissions.file_system_sandbox_policy, "test fixture should distinguish profile syntax from legacy sandbox_mode" ); assert_eq!( config.permissions.file_system_sandbox_policy, profile_config.permissions.file_system_sandbox_policy, ); assert_ne!( config.permissions.file_system_sandbox_policy, legacy_config.permissions.file_system_sandbox_policy, ); Ok(()) } #[tokio::test] async fn debug_sandbox_rejects_full_auto_for_permission_profiles() -> anyhow::Result<()> { let codex_home = TempDir::new()?; let sandbox_paths = TempDir::new()?; let docs = sandbox_paths.path().join("docs"); let private = docs.join("private"); write_permissions_profile_config(&codex_home, &docs, &private)?; let err = load_debug_sandbox_config_with_codex_home( Vec::new(), /*codex_linux_sandbox_exe*/ None, /*full_auto*/ true, Some(codex_home.path().to_path_buf()), ) .await .expect_err("full-auto should be rejected for active permission profiles"); assert!( err.to_string().contains("--full-auto"), "unexpected error: {err}" ); Ok(()) } }