mirror of
https://github.com/openai/codex.git
synced 2026-06-01 19:02:59 +00:00
fix: cancel Windows sandbox on network denial (#19880)
## Why When Guardian or the sandbox network proxy detects and denies a network attempt, core cancels the associated execution through `ExecExpiration`. The Windows sandbox capture path was only forwarding the timeout component of that expiration state. As a result, a sandboxed Windows command whose network attempt had already been denied could keep running until its timeout elapsed rather than terminating promptly in response to the denial. This change closes that cancellation-propagation gap for Windows sandbox execution. ## What changed - Added `WindowsSandboxCancellationToken` as the cancellation hook exposed to Windows capture backends. - Extracted the cancellation token from `ExecExpiration` in core and passed it to both the direct and elevated Windows sandbox capture paths alongside the existing timeout. - Updated direct capture to poll for either process exit, timeout, or cancellation and to terminate cancelled processes without reporting them as timed out. - Updated elevated capture to watch for cancellation and send the existing `Terminate` IPC frame to the elevated runner. The watcher parks for 50 ms between checks to bound response latency without a tight busy wait. - Added Windows regression coverage for a long-running PowerShell command: cancellation ends capture before its timeout and does not set `timed_out`. - Added a visible skip diagnostic when that PowerShell-dependent regression test cannot execute, and consolidated the duplicated expiration-policy branch identified in review. ## Security This improves enforcement after a denied network attempt has been attributed to a Windows sandboxed execution: the command no longer remains alive simply because Windows capture lost the cancellation signal. This PR does not claim to make Windows offline mode an airtight no-network or no-exfiltration boundary. It does not introduce AppContainer or change how network denial is detected; it makes an already-detected denial promptly stop the affected sandboxed command. ## Validation ### Commands run - `just fmt` - `cargo test -p codex-windows-sandbox` - `cargo test -p codex-core network_denial` - `cargo clippy -p codex-core -p codex-windows-sandbox --tests --no-deps -- -D warnings` - `just argument-comment-lint -p codex-windows-sandbox -p codex-core` The new capture regression is `cfg(target_os = "windows")`, so Windows CI is the execution coverage for that test path. The local macOS test runs validate the host-runnable crate and core network-denial behavior. --------- Co-authored-by: Codex <noreply@openai.com>
This commit is contained in:
@@ -225,6 +225,17 @@ impl ExecExpiration {
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg_attr(not(target_os = "windows"), allow(dead_code))]
|
||||
pub(crate) fn cancellation_token(&self) -> Option<CancellationToken> {
|
||||
match self {
|
||||
ExecExpiration::Timeout(_) | ExecExpiration::DefaultTimeout => None,
|
||||
ExecExpiration::Cancellation(cancellation)
|
||||
| ExecExpiration::TimeoutOrCancellation { cancellation, .. } => {
|
||||
Some(cancellation.clone())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn with_cancellation(self, cancellation: CancellationToken) -> Self {
|
||||
match self {
|
||||
ExecExpiration::Timeout(timeout) => ExecExpiration::TimeoutOrCancellation {
|
||||
@@ -592,12 +603,16 @@ async fn exec_windows_sandbox(
|
||||
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()
|
||||
// Windows sandbox capture still receives timeout and cancellation separately.
|
||||
let (cancellation, timeout_ms) = if capture_policy.uses_expiration() {
|
||||
let cancellation = expiration.cancellation_token().map(|token| {
|
||||
codex_windows_sandbox::WindowsSandboxCancellationToken::new(move || {
|
||||
token.is_cancelled()
|
||||
})
|
||||
});
|
||||
(cancellation, expiration.timeout_ms())
|
||||
} else {
|
||||
None
|
||||
(None, None)
|
||||
};
|
||||
|
||||
let sandbox_cwd = windows_sandbox_policy_cwd.clone();
|
||||
@@ -634,6 +649,7 @@ async fn exec_windows_sandbox(
|
||||
cwd: &cwd,
|
||||
env_map: env,
|
||||
timeout_ms,
|
||||
cancellation,
|
||||
use_private_desktop: windows_sandbox_private_desktop,
|
||||
proxy_enforced,
|
||||
read_roots_override: elevated_read_roots_override.as_deref(),
|
||||
@@ -653,6 +669,7 @@ async fn exec_windows_sandbox(
|
||||
&cwd,
|
||||
env,
|
||||
timeout_ms,
|
||||
cancellation,
|
||||
&additional_deny_read_paths,
|
||||
&additional_deny_write_paths,
|
||||
windows_sandbox_private_desktop,
|
||||
|
||||
@@ -12,6 +12,7 @@ pub struct ElevatedSandboxProfileCaptureRequest<'a> {
|
||||
pub cwd: &'a Path,
|
||||
pub env_map: HashMap<String, String>,
|
||||
pub timeout_ms: Option<u64>,
|
||||
pub cancellation: Option<crate::WindowsSandboxCancellationToken>,
|
||||
pub use_private_desktop: bool,
|
||||
pub proxy_enforced: bool,
|
||||
pub read_roots_override: Option<&'a [PathBuf]>,
|
||||
@@ -30,11 +31,14 @@ mod windows_impl {
|
||||
use crate::env::inherit_path_env;
|
||||
use crate::env::normalize_null_device_env;
|
||||
use crate::identity::require_logon_sandbox_creds;
|
||||
use crate::ipc_framed::EmptyPayload;
|
||||
use crate::ipc_framed::FramedMessage;
|
||||
use crate::ipc_framed::Message;
|
||||
use crate::ipc_framed::OutputStream;
|
||||
use crate::ipc_framed::SpawnRequest;
|
||||
use crate::ipc_framed::decode_bytes;
|
||||
use crate::ipc_framed::read_frame;
|
||||
use crate::ipc_framed::write_frame;
|
||||
use crate::logging::log_failure;
|
||||
use crate::logging::log_start;
|
||||
use crate::logging::log_success;
|
||||
@@ -46,10 +50,48 @@ mod windows_impl {
|
||||
use crate::token::LocalSid;
|
||||
use anyhow::Result;
|
||||
use codex_utils_absolute_path::AbsolutePathBuf;
|
||||
use std::fs::File;
|
||||
use std::path::Path;
|
||||
use std::sync::Arc;
|
||||
use std::sync::atomic::AtomicBool;
|
||||
use std::sync::atomic::Ordering;
|
||||
use std::time::Duration;
|
||||
|
||||
pub use crate::windows_impl::CaptureResult;
|
||||
|
||||
/// Polls for cancellation and sends the runner's terminate IPC frame when requested.
|
||||
///
|
||||
/// The 50 ms park bounds cancellation latency without busy-waiting.
|
||||
fn spawn_cancel_writer(
|
||||
pipe_write: &File,
|
||||
cancellation: Option<crate::WindowsSandboxCancellationToken>,
|
||||
) -> Result<Option<(std::thread::JoinHandle<()>, Arc<AtomicBool>)>> {
|
||||
let Some(cancellation) = cancellation else {
|
||||
return Ok(None);
|
||||
};
|
||||
let mut pipe_write = pipe_write.try_clone()?;
|
||||
let done = Arc::new(AtomicBool::new(false));
|
||||
let done_for_thread = Arc::clone(&done);
|
||||
let handle = std::thread::spawn(move || {
|
||||
while !done_for_thread.load(Ordering::SeqCst) {
|
||||
if cancellation.is_cancelled() {
|
||||
let _ = write_frame(
|
||||
&mut pipe_write,
|
||||
&FramedMessage {
|
||||
version: 1,
|
||||
message: Message::Terminate {
|
||||
payload: EmptyPayload::default(),
|
||||
},
|
||||
},
|
||||
);
|
||||
break;
|
||||
}
|
||||
std::thread::park_timeout(Duration::from_millis(50));
|
||||
}
|
||||
});
|
||||
Ok(Some((handle, done)))
|
||||
}
|
||||
|
||||
/// Launches the command runner under the sandbox user and captures its output.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub fn run_windows_sandbox_capture_for_permission_profile(
|
||||
@@ -63,6 +105,7 @@ mod windows_impl {
|
||||
cwd,
|
||||
mut env_map,
|
||||
timeout_ms,
|
||||
cancellation,
|
||||
use_private_desktop,
|
||||
proxy_enforced,
|
||||
read_roots_override,
|
||||
@@ -156,33 +199,45 @@ mod windows_impl {
|
||||
spawn_request,
|
||||
)?;
|
||||
let (pipe_write, mut pipe_read) = transport.into_files();
|
||||
drop(pipe_write);
|
||||
let cancel_writer = spawn_cancel_writer(&pipe_write, cancellation)?;
|
||||
|
||||
let mut stdout = Vec::new();
|
||||
let mut stderr = Vec::new();
|
||||
let (exit_code, timed_out) = loop {
|
||||
let msg = read_frame(&mut pipe_read)?
|
||||
.ok_or_else(|| anyhow::anyhow!("runner pipe closed before exit"))?;
|
||||
let result = loop {
|
||||
let msg = match read_frame(&mut pipe_read) {
|
||||
Ok(Some(msg)) => msg,
|
||||
Ok(None) => break Err(anyhow::anyhow!("runner pipe closed before exit")),
|
||||
Err(err) => break Err(err),
|
||||
};
|
||||
match msg.message {
|
||||
Message::SpawnReady { .. } => {}
|
||||
Message::Output { payload } => {
|
||||
let bytes = decode_bytes(&payload.data_b64)?;
|
||||
match payload.stream {
|
||||
Message::Output { payload } => match decode_bytes(&payload.data_b64) {
|
||||
Ok(bytes) => match payload.stream {
|
||||
OutputStream::Stdout => stdout.extend_from_slice(&bytes),
|
||||
OutputStream::Stderr => stderr.extend_from_slice(&bytes),
|
||||
},
|
||||
Err(err) => {
|
||||
break Err(err);
|
||||
}
|
||||
}
|
||||
Message::Exit { payload } => break (payload.exit_code, payload.timed_out),
|
||||
},
|
||||
Message::Exit { payload } => break Ok((payload.exit_code, payload.timed_out)),
|
||||
Message::Error { payload } => {
|
||||
return Err(anyhow::anyhow!("runner error: {}", payload.message));
|
||||
break Err(anyhow::anyhow!("runner error: {}", payload.message));
|
||||
}
|
||||
other => {
|
||||
return Err(anyhow::anyhow!(
|
||||
break Err(anyhow::anyhow!(
|
||||
"unexpected runner message during capture: {other:?}"
|
||||
));
|
||||
}
|
||||
}
|
||||
};
|
||||
if let Some((cancel_handle, done)) = cancel_writer {
|
||||
done.store(true, Ordering::SeqCst);
|
||||
cancel_handle.thread().unpark();
|
||||
let _ = cancel_handle.join();
|
||||
}
|
||||
drop(pipe_write);
|
||||
let (exit_code, timed_out) = result?;
|
||||
|
||||
if exit_code == 0 {
|
||||
log_success(&command, logs_base_dir);
|
||||
|
||||
@@ -5,6 +5,36 @@
|
||||
#[cfg(any(target_os = "windows", test))]
|
||||
mod ssh_config_dependencies;
|
||||
|
||||
use std::fmt;
|
||||
use std::sync::Arc;
|
||||
|
||||
/// Cancellation hook used by Windows sandbox capture backends.
|
||||
#[derive(Clone)]
|
||||
pub struct WindowsSandboxCancellationToken {
|
||||
is_cancelled: Arc<dyn Fn() -> bool + Send + Sync>,
|
||||
}
|
||||
|
||||
impl WindowsSandboxCancellationToken {
|
||||
/// Creates a token backed by a cancellation predicate.
|
||||
pub fn new(is_cancelled: impl Fn() -> bool + Send + Sync + 'static) -> Self {
|
||||
Self {
|
||||
is_cancelled: Arc::new(is_cancelled),
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns whether the caller has requested cancellation.
|
||||
pub fn is_cancelled(&self) -> bool {
|
||||
(self.is_cancelled)()
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Debug for WindowsSandboxCancellationToken {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
f.debug_struct("WindowsSandboxCancellationToken")
|
||||
.finish_non_exhaustive()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(target_os = "windows")]
|
||||
mod acl;
|
||||
#[cfg(target_os = "windows")]
|
||||
@@ -287,6 +317,7 @@ pub use stub::run_windows_sandbox_legacy_preflight;
|
||||
|
||||
#[cfg(target_os = "windows")]
|
||||
mod windows_impl {
|
||||
use super::WindowsSandboxCancellationToken;
|
||||
use super::logging::log_failure;
|
||||
use super::logging::log_success;
|
||||
use super::process::create_process_as_user;
|
||||
@@ -306,6 +337,8 @@ mod windows_impl {
|
||||
use std::io;
|
||||
use std::path::Path;
|
||||
use std::ptr;
|
||||
use std::time::Duration;
|
||||
use std::time::Instant;
|
||||
use windows_sys::Win32::Foundation::CloseHandle;
|
||||
use windows_sys::Win32::Foundation::GetLastError;
|
||||
use windows_sys::Win32::Foundation::HANDLE;
|
||||
@@ -318,6 +351,50 @@ mod windows_impl {
|
||||
|
||||
type PipeHandles = ((HANDLE, HANDLE), (HANDLE, HANDLE), (HANDLE, HANDLE));
|
||||
|
||||
enum WaitOutcome {
|
||||
Exited,
|
||||
TimedOut,
|
||||
Cancelled,
|
||||
}
|
||||
|
||||
fn wait_for_process(
|
||||
process: HANDLE,
|
||||
timeout_ms: Option<u64>,
|
||||
cancellation: Option<&WindowsSandboxCancellationToken>,
|
||||
) -> WaitOutcome {
|
||||
let Some(cancellation) = cancellation else {
|
||||
let timeout = timeout_ms.map(|ms| ms as u32).unwrap_or(INFINITE);
|
||||
let res = unsafe { WaitForSingleObject(process, timeout) };
|
||||
return if res == 0x0000_0102 {
|
||||
WaitOutcome::TimedOut
|
||||
} else {
|
||||
WaitOutcome::Exited
|
||||
};
|
||||
};
|
||||
|
||||
let deadline = timeout_ms.map(|ms| Instant::now() + Duration::from_millis(ms));
|
||||
loop {
|
||||
if cancellation.is_cancelled() {
|
||||
return WaitOutcome::Cancelled;
|
||||
}
|
||||
let wait_ms = match deadline {
|
||||
Some(deadline) => {
|
||||
let remaining = deadline.saturating_duration_since(Instant::now());
|
||||
if remaining.is_zero() {
|
||||
return WaitOutcome::TimedOut;
|
||||
}
|
||||
remaining.min(Duration::from_millis(50)).as_millis() as u32
|
||||
}
|
||||
None => 50,
|
||||
};
|
||||
let res = unsafe { WaitForSingleObject(process, wait_ms) };
|
||||
if res == 0x0000_0102 {
|
||||
continue;
|
||||
}
|
||||
return WaitOutcome::Exited;
|
||||
}
|
||||
}
|
||||
|
||||
unsafe fn setup_stdio_pipes() -> io::Result<PipeHandles> {
|
||||
let mut in_r: HANDLE = 0;
|
||||
let mut in_w: HANDLE = 0;
|
||||
@@ -362,6 +439,7 @@ mod windows_impl {
|
||||
cwd: &Path,
|
||||
env_map: HashMap<String, String>,
|
||||
timeout_ms: Option<u64>,
|
||||
cancellation: Option<WindowsSandboxCancellationToken>,
|
||||
use_private_desktop: bool,
|
||||
) -> Result<CaptureResult> {
|
||||
run_windows_sandbox_capture_with_filesystem_overrides(
|
||||
@@ -372,6 +450,7 @@ mod windows_impl {
|
||||
cwd,
|
||||
env_map,
|
||||
timeout_ms,
|
||||
cancellation,
|
||||
&[],
|
||||
&[],
|
||||
use_private_desktop,
|
||||
@@ -387,6 +466,7 @@ mod windows_impl {
|
||||
cwd: &Path,
|
||||
mut env_map: HashMap<String, String>,
|
||||
timeout_ms: Option<u64>,
|
||||
cancellation: Option<WindowsSandboxCancellationToken>,
|
||||
additional_deny_read_paths: &[AbsolutePathBuf],
|
||||
additional_deny_write_paths: &[AbsolutePathBuf],
|
||||
use_private_desktop: bool,
|
||||
@@ -531,11 +611,11 @@ mod windows_impl {
|
||||
let _ = tx_err.send(buf);
|
||||
});
|
||||
|
||||
let timeout = timeout_ms.map(|ms| ms as u32).unwrap_or(INFINITE);
|
||||
let res = unsafe { WaitForSingleObject(pi.hProcess, timeout) };
|
||||
let timed_out = res == 0x0000_0102;
|
||||
let wait_outcome = wait_for_process(pi.hProcess, timeout_ms, cancellation.as_ref());
|
||||
let timed_out = matches!(wait_outcome, WaitOutcome::TimedOut);
|
||||
let cancelled = matches!(wait_outcome, WaitOutcome::Cancelled);
|
||||
let mut exit_code_u32: u32 = 1;
|
||||
if !timed_out {
|
||||
if !timed_out && !cancelled {
|
||||
unsafe {
|
||||
GetExitCodeProcess(pi.hProcess, &mut exit_code_u32);
|
||||
}
|
||||
@@ -685,6 +765,7 @@ mod windows_impl {
|
||||
|
||||
#[cfg(not(target_os = "windows"))]
|
||||
mod stub {
|
||||
use super::WindowsSandboxCancellationToken;
|
||||
use anyhow::Result;
|
||||
use anyhow::bail;
|
||||
use codex_protocol::models::PermissionProfile;
|
||||
@@ -708,6 +789,7 @@ mod stub {
|
||||
_cwd: &Path,
|
||||
_env_map: HashMap<String, String>,
|
||||
_timeout_ms: Option<u64>,
|
||||
_cancellation: Option<WindowsSandboxCancellationToken>,
|
||||
_use_private_desktop: bool,
|
||||
) -> Result<CaptureResult> {
|
||||
bail!("Windows sandbox is only available on Windows")
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#![cfg(target_os = "windows")]
|
||||
|
||||
use super::spawn_windows_sandbox_session_legacy;
|
||||
use crate::WindowsSandboxCancellationToken;
|
||||
use crate::ipc_framed::Message;
|
||||
use crate::ipc_framed::decode_bytes;
|
||||
use crate::ipc_framed::read_frame;
|
||||
@@ -16,8 +17,10 @@ use std::io::Seek;
|
||||
use std::io::SeekFrom;
|
||||
use std::path::Path;
|
||||
use std::path::PathBuf;
|
||||
use std::sync::Arc;
|
||||
use std::sync::Mutex;
|
||||
use std::sync::MutexGuard;
|
||||
use std::sync::atomic::AtomicBool;
|
||||
use std::sync::atomic::AtomicU64;
|
||||
use std::sync::atomic::Ordering;
|
||||
use std::time::Duration;
|
||||
@@ -431,6 +434,7 @@ fn legacy_capture_powershell_emits_output() {
|
||||
cwd.as_path(),
|
||||
HashMap::new(),
|
||||
Some(10_000),
|
||||
/*cancellation*/ None,
|
||||
/*use_private_desktop*/ true,
|
||||
)
|
||||
.expect("run legacy capture powershell");
|
||||
@@ -446,6 +450,57 @@ fn legacy_capture_powershell_emits_output() {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn legacy_capture_cancellation_is_not_reported_as_timeout() {
|
||||
let Some(pwsh) = pwsh_path() else {
|
||||
eprintln!("skipping cancellation regression test: PowerShell 7 is not installed");
|
||||
return;
|
||||
};
|
||||
let _guard = legacy_process_test_guard();
|
||||
let cwd = sandbox_cwd();
|
||||
let codex_home = sandbox_home("legacy-capture-cancel");
|
||||
let permission_profile = PermissionProfile::workspace_write();
|
||||
let cancelled = Arc::new(AtomicBool::new(false));
|
||||
let cancelled_for_token = Arc::clone(&cancelled);
|
||||
let cancellation =
|
||||
WindowsSandboxCancellationToken::new(move || cancelled_for_token.load(Ordering::SeqCst));
|
||||
let cancelled_for_thread = Arc::clone(&cancelled);
|
||||
let cancel_thread = std::thread::spawn(move || {
|
||||
std::thread::sleep(Duration::from_millis(200));
|
||||
cancelled_for_thread.store(true, Ordering::SeqCst);
|
||||
});
|
||||
|
||||
let started_at = Instant::now();
|
||||
let result = run_windows_sandbox_capture(
|
||||
&permission_profile,
|
||||
cwd.as_path(),
|
||||
codex_home.path(),
|
||||
vec![
|
||||
pwsh.display().to_string(),
|
||||
"-NoProfile".to_string(),
|
||||
"-Command".to_string(),
|
||||
"Start-Sleep -Seconds 30".to_string(),
|
||||
],
|
||||
cwd.as_path(),
|
||||
HashMap::new(),
|
||||
Some(30_000),
|
||||
/*cancellation*/ Some(cancellation),
|
||||
/*use_private_desktop*/ true,
|
||||
)
|
||||
.expect("run legacy capture powershell with cancellation");
|
||||
cancel_thread.join().expect("cancel thread should finish");
|
||||
|
||||
assert!(
|
||||
started_at.elapsed() < Duration::from_secs(10),
|
||||
"cancellation should end capture before the timeout"
|
||||
);
|
||||
assert!(
|
||||
!result.timed_out,
|
||||
"cancellation should not be reported as a timeout"
|
||||
);
|
||||
assert_ne!(result.exit_code, 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn legacy_tty_powershell_emits_output_and_accepts_input() {
|
||||
let Some(pwsh) = pwsh_path() else {
|
||||
|
||||
Reference in New Issue
Block a user