Isolate external editor buffers from sandbox-writable paths (#38830)

## Why

External editor buffers can contain the current composer text and should not be
placed in directories exposed as writable by a restricted filesystem policy.

## What changed

- Create editor buffer files under a protected `editor` directory, trying the
  configured Codex home, the default Codex home, and a workspace fallback.
- Reject candidates that overlap writable roots or resolve through symbolic
  links, while preserving external editor support for full-disk-write policies.
- Surface an editor error when no protected directory is available.

## Testing

Add coverage for writable roots, aliases, symbolic links, fallback selection,
temporary-directory grants, full-disk-write policies, and editor invocation.

GitOrigin-RevId: df1029d81b327678991ab84ffd1077f0e5855631
This commit is contained in:
viyatb-oai authored and copyberry committed 2026-08-16 03:14:17 +00:00
1 parent c7a95f84b3
commit 73abda8bfe
5 files changed
+572 -4

No files matched your search

+148 -3
View File
@@ -1,7 +1,14 @@
use std::env;
use std::fs;
use std::path::Path;
use std::path::PathBuf;
use std::process::Stdio;
#[cfg(windows)]
use codex_protocol::permissions::FileSystemPath;
use codex_protocol::permissions::FileSystemSandboxPolicy;
#[cfg(windows)]
use codex_protocol::permissions::FileSystemSpecialPath;
use color_eyre::eyre::Report;
use color_eyre::eyre::Result;
use tempfile::Builder;
@@ -50,14 +57,145 @@ pub(crate) fn resolve_editor_command() -> std::result::Result<Vec<String>, Edito
Ok(parts)
}
pub(super) fn editor_directory(
candidate_homes: &[&Path],
file_system_policy: &FileSystemSandboxPolicy,
cwd: &Path,
) -> Result<PathBuf> {
let writable_roots = file_system_policy.get_writable_roots_with_cwd(cwd);
#[cfg(windows)]
let windows_temporary_roots = if !file_system_policy.has_full_disk_write_access()
&& file_system_policy.entries.iter().any(|entry| {
matches!(
&entry.path,
FileSystemPath::Special {
value: FileSystemSpecialPath::Tmpdir
}
) && entry.access.can_write()
}) {
["TEMP", "TMP"]
.into_iter()
.filter_map(env::var_os)
.map(PathBuf::from)
.filter(|path| path.is_absolute())
.flat_map(|path| {
let canonical_path = dunce::canonicalize(&path).ok();
std::iter::once(path).chain(canonical_path)
})
.collect::<Vec<_>>()
} else {
Vec::new()
};
let mut error = Report::msg("editor directory must not be writable");
let mut rejected_writable = false;
for candidate_home in candidate_homes {
let canonical_home = match dunce::canonicalize(candidate_home) {
Ok(path) => path,
Err(canonicalize_error)
if canonicalize_error.kind() == std::io::ErrorKind::NotFound =>
{
let Some(parent) = candidate_home.parent() else {
error = Report::msg("editor directory has no parent");
continue;
};
let Some(name) = candidate_home.file_name() else {
error = Report::msg("editor directory has no parent");
continue;
};
match dunce::canonicalize(parent) {
Ok(parent) => parent.join(name),
Err(canonicalize_error) => {
error = canonicalize_error.into();
continue;
}
}
}
Err(canonicalize_error) => {
error = canonicalize_error.into();
continue;
}
};
let editor_directory = canonical_home.join("editor");
let logical_editor_directory = candidate_home.join("editor");
if !file_system_policy.has_full_disk_write_access()
&& [&logical_editor_directory, &editor_directory]
.into_iter()
.any(|directory| {
let Some(parent) = directory.parent() else {
return true;
};
let is_writable = file_system_policy.can_write_path_with_cwd(directory, cwd)
|| file_system_policy.can_write_path_with_cwd(parent, cwd)
|| writable_roots.iter().any(|root| {
root.is_path_writable(directory)
|| root.root.as_path().starts_with(directory)
});
#[cfg(windows)]
let is_writable = is_writable
|| windows_temporary_roots.iter().any(|root| {
directory.starts_with(root)
|| parent.starts_with(root)
|| root.starts_with(directory)
});
is_writable
})
{
error = Report::msg("editor directory must not be writable");
rejected_writable = true;
continue;
}
if let Err(create_error) = fs::create_dir_all(&editor_directory) {
error = create_error.into();
continue;
}
match dunce::canonicalize(&editor_directory) {
Ok(path) if path == editor_directory => return Ok(editor_directory),
Ok(_) => {
error = Report::msg("editor directory must not contain symbolic links");
}
Err(canonicalize_error) => {
error = canonicalize_error.into();
}
}
}
if rejected_writable {
Err(Report::msg("editor directory must not be writable"))
} else {
Err(error)
}
}
/// Write `seed` to a temp file, launch the editor command, and return the updated content.
pub(crate) async fn run_editor(seed: &str, editor_cmd: &[String]) -> Result<String> {
pub(crate) async fn run_editor(
seed: &str,
editor_cmd: &[String],
codex_home: &Path,
file_system_policy: &FileSystemSandboxPolicy,
cwd: &Path,
) -> Result<String> {
if editor_cmd.is_empty() {
return Err(Report::msg("editor command is empty"));
}
let default_codex_home = dirs::home_dir().map(|home| home.join(".codex"));
#[cfg(any(target_os = "macos", target_os = "linux"))]
let project_codex_home = cwd.join(".codex");
let mut candidate_homes = vec![codex_home];
if let Some(default_codex_home) = default_codex_home.as_deref() {
candidate_homes.push(default_codex_home);
}
#[cfg(any(target_os = "macos", target_os = "linux"))]
candidate_homes.push(&project_codex_home);
let editor_directory = editor_directory(&candidate_homes, file_system_policy, cwd)?;
// Convert to TempPath immediately so no file handle stays open on Windows.
let temp_path = Builder::new().suffix(".md").tempfile()?.into_temp_path();
let temp_path = Builder::new()
.suffix(".md")
.tempfile_in(editor_directory)?
.into_temp_path();
fs::write(&temp_path, seed)?;
let mut cmd = {
@@ -165,7 +303,14 @@ mod tests {
fs::set_permissions(&script_path, perms).unwrap();
let cmd = vec![script_path.to_string_lossy().to_string()];
let result = run_editor("seed", &cmd).await.unwrap();
let policy = FileSystemSandboxPolicy::read_only();
let result = run_editor("seed", &cmd, dir.path(), &policy, dir.path())
.await
.unwrap();
assert_eq!(result, "edited".to_string());
}
}
#[cfg(test)]
#[path = "external_editor_tests.rs"]
mod buffer_tests;