use super::agent::AgentInvocation;
use sandbox_jail::{known, Access, Backend, Policy, Sandbox};
use std::ffi::OsString;
use std::path::{Path, PathBuf};
const HOME_READ_ONLY: &[&str] = &[
".config", ".claude", ".ssh", ".gnupg", "bin", "Library", ".local",
];
const HOME_WRITABLE: &[&str] = &[
"Library/Caches",
"Library/Logs",
".local/share",
".local/state",
];
const AGENT_CONFIG: &[&str] = &[".codex/config.toml", ".codex/AGENTS.md", ".codex/rules"];
const HOME_EXEC_CONFIG: &[&str] = &[
".cargo/config",
".cargo/config.toml",
".gradle/init.d",
".gradle/init.gradle",
".gradle/gradle.properties",
".m2/settings.xml",
".oh-my-zsh",
".zprezto",
];
const SCRATCH: &[&str] = &["/tmp", "/run", "/var/tmp"];
const KEYCHAIN: &str = "com.apple.SecurityServer";
pub fn enabled(project_dir: &Path) -> bool {
crate::config::get_for_project(project_dir, "workflow.sandbox").is_ok_and(|v| v.trim() == "os")
}
pub fn enabled_globally() -> bool {
crate::config::get_global("workflow.sandbox").is_ok_and(|v| v.trim() == "os")
}
pub async fn argv(inv: &AgentInvocation) -> anyhow::Result<Vec<OsString>> {
let backend = Backend::detect()?;
let common_dir =
super::agent::resolve_git_dir_arg(&inv.main_project_dir, "--git-common-dir").await?;
let git_dir = super::agent::resolve_git_dir_arg(&inv.work_dir, "--git-dir").await?;
check_git_dirs(
&inv.work_dir,
&inv.main_project_dir,
git_dir.as_deref(),
common_dir.as_deref(),
)?;
let home = std::env::var_os("HOME")
.map(PathBuf::from)
.ok_or_else(|| anyhow::anyhow!("HOME is not set, so the sandbox cannot hide its keys"))?;
let mut projects: Vec<PathBuf> = crate::config::get_projects_with_paths()
.unwrap_or_default()
.into_iter()
.map(|(_, dir)| dir)
.collect();
projects.push(inv.main_project_dir.clone());
let path_dirs = std::env::var_os("PATH")
.map(|p| std::env::split_paths(&p).collect())
.unwrap_or_default();
let run = Run {
work_dir: inv.work_dir.clone(),
git_dir,
common_dir,
own_ref: (!inv.branch.is_empty()).then(|| format!("refs/heads/{}", inv.branch)),
home,
orch_home: crate::home::orch_home()?,
projects,
path_dirs,
temp: std::env::temp_dir(),
internal: inv.task_id.starts_with("internal:"),
seatbelt: backend == Backend::Seatbelt,
};
let sandbox = Sandbox::new(backend, policy(&run))?;
Ok(sandbox.argv().to_vec())
}
fn check_git_dirs(
work_dir: &Path,
main_project_dir: &Path,
git_dir: Option<&Path>,
common_dir: Option<&Path>,
) -> anyhow::Result<()> {
let real = |p: &Path| p.canonicalize().unwrap_or_else(|_| p.to_path_buf());
match (git_dir, common_dir) {
(Some(git), Some(common)) if git == common => anyhow::ensure!(
real(work_dir) == real(main_project_dir),
"the worktree {} uses the repository's own git dir {}",
work_dir.display(),
common.display()
),
(Some(git), Some(common)) => {
anyhow::ensure!(
git.starts_with(common.join("worktrees")),
"the worktree's git dir {} is outside its repository {}",
git.display(),
common.display()
);
let back = std::fs::read_to_string(git.join("gitdir")).unwrap_or_default();
anyhow::ensure!(
real(Path::new(back.trim())) == real(&work_dir.join(".git")),
"the git dir {} belongs to another worktree",
git.display()
);
}
(None, Some(common)) => anyhow::bail!(
"the worktree {} has no git dir in {}",
work_dir.display(),
common.display()
),
_ => {}
}
Ok(())
}
struct Run {
work_dir: PathBuf,
git_dir: Option<PathBuf>,
common_dir: Option<PathBuf>,
own_ref: Option<String>,
home: PathBuf,
orch_home: PathBuf,
projects: Vec<PathBuf>,
path_dirs: Vec<PathBuf>,
temp: PathBuf,
internal: bool,
seatbelt: bool,
}
impl Run {
fn git_dirs(&self) -> impl Iterator<Item = &PathBuf> {
self.git_dir.iter().chain(&self.common_dir)
}
}
fn policy(run: &Run) -> Policy {
let mut p = Policy::default();
p.writable.push(run.work_dir.clone());
p.writable.extend(run.git_dirs().cloned());
p.writable.extend(home_writable(&run.home));
let temp = run.temp.clone();
if run.seatbelt {
p.writable.extend([temp.clone(), "/private/tmp".into()]);
p.mach_services = Access::Only(
known::BASIC_MACH_SERVICES
.iter()
.chain(&[KEYCHAIN])
.map(|s| s.to_string())
.collect(),
);
} else {
p.scratch = SCRATCH
.iter()
.map(PathBuf::from)
.filter(|d| d.is_dir())
.collect();
if !p.scratch.iter().any(|s| temp.starts_with(s)) {
p.writable.push(temp.clone());
}
}
let mut sockets = vec![run.work_dir.clone()];
if !["/tmp", "/private/tmp"].iter().any(|t| temp.starts_with(t)) {
sockets.push(temp);
}
p.unix_sockets = Access::Only(sockets);
if let Some(common) = &run.common_dir {
git_rules(
common,
run.git_dir.as_ref(),
run.own_ref.as_deref(),
&mut p.read_only,
);
if run.git_dir.as_ref().is_some_and(|g| g != common) {
p.read_only.push(run.work_dir.join(".git"));
}
}
p.read_only.push(run.work_dir.join(".orch.yml"));
p.read_only.extend(
AGENT_CONFIG
.iter()
.chain(HOME_EXEC_CONFIG)
.map(|path| run.home.join(path)),
);
p.read_only.extend(
run.path_dirs
.iter()
.filter(|d| d.starts_with(&run.home))
.cloned(),
);
let mut keep: Vec<PathBuf> = vec![run.work_dir.clone()];
keep.extend(run.git_dirs().cloned());
if run.internal {
keep.extend(["orch.db", "orch.db-wal", "orch.db-shm"].map(|f| run.orch_home.join(f)));
}
read_only_around(&run.orch_home, &keep, &mut p.read_only);
for project in &run.projects {
read_only_around(project, &keep, &mut p.read_only);
}
p.hidden = known::credentials(&run.home)
.into_iter()
.filter(|path| {
![".cargo/config", ".cargo/config.toml"]
.map(|c| run.home.join(c))
.contains(path)
})
.collect();
p.hidden.push(run.home.join(".gnupg"));
p.own_signals = true;
if run.seatbelt {
p.apple_events = false;
p.no_exec.push(known::LAUNCHCTL.into());
p.no_exec.extend(known::setuid_binaries().iter().cloned());
}
p
}
fn home_writable(home: &Path) -> Vec<PathBuf> {
let mut dirs: Vec<PathBuf> = std::fs::read_dir(home)
.into_iter()
.flatten()
.flatten()
.filter(|e| e.file_type().is_ok_and(|t| t.is_dir()))
.filter(|e| !HOME_READ_ONLY.contains(&e.file_name().to_string_lossy().as_ref()))
.map(|e| e.path())
.collect();
dirs.extend(
HOME_WRITABLE
.iter()
.map(|d| home.join(d))
.filter(|d| d.is_dir()),
);
dirs
}
fn git_rules(
common: &Path,
git_dir: Option<&PathBuf>,
own_ref: Option<&str>,
out: &mut Vec<PathBuf>,
) {
out.extend(
[
"hooks",
"config",
"info",
"modules",
"packed-refs",
"refs/tags",
]
.map(|d| common.join(d)),
);
let own: Vec<PathBuf> = own_ref
.map(|r| vec![common.join(r), common.join("logs").join(r)])
.unwrap_or_default();
match git_dir {
Some(dir) if dir != common => {
let mut keep = vec![
common.join("objects"),
common.join("refs/remotes"),
common.join("logs/refs/remotes"),
dir.clone(),
];
keep.extend(own.iter().cloned());
read_only_around(common, &keep, out);
out.extend(["HEAD", "commondir", "gitdir", "config.worktree"].map(|f| dir.join(f)));
}
_ => read_only_around(&common.join("refs/heads"), &own, out),
}
let packed = std::fs::read_to_string(common.join("packed-refs")).unwrap_or_default();
for name in packed
.lines()
.filter_map(|l| l.split_once(' ').map(|(_, r)| r))
{
let path = common.join(name);
if name.starts_with("refs/heads/") && !own.contains(&path) && !path.exists() {
out.push(path);
}
}
}
fn read_only_around(dir: &Path, keep: &[PathBuf], out: &mut Vec<PathBuf>) {
let Ok(entries) = std::fs::read_dir(dir) else {
return;
};
for entry in entries.flatten() {
let path = entry.path();
if keep.iter().any(|k| path.starts_with(k)) {
continue;
}
let holds_kept = keep.iter().any(|k| k.starts_with(&path));
let is_dir = entry.file_type().is_ok_and(|t| t.is_dir());
if holds_kept && is_dir {
read_only_around(&path, keep, out);
} else if !holds_kept {
out.push(path);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::fs;
fn fixture(internal: bool) -> (tempfile::TempDir, Run) {
let root = tempfile::tempdir().unwrap();
let r = root.path().canonicalize().unwrap();
let (home, orch) = (r.join("home"), r.join("home/.orch"));
for dir in [
"home/.orch/worktrees/proj/mine",
"home/.orch/worktrees/proj/other",
"home/.orch/state",
"home/proj/.git/worktrees/mine",
"home/proj/.git/refs/heads/feat",
"home/proj/src",
"home/proj/.git/objects",
"home/proj/.git/worktrees/other",
"home/.config/nvim",
"home/.claude",
"home/.cargo/bin",
"home/Library/Caches",
"home/Library/LaunchAgents",
] {
fs::create_dir_all(r.join(dir)).unwrap();
}
for file in [
"home/.orch/config.yml",
"home/.orch/orch.db",
"home/proj/README.md",
"home/proj/.git/refs/heads/main",
"home/proj/.git/refs/heads/feat/mine",
"home/proj/.git/worktrees/mine/HEAD",
"home/.zshrc",
"home/.claude.json",
] {
fs::write(r.join(file), "").unwrap();
}
fs::write(
r.join("home/proj/.git/packed-refs"),
"# pack-refs with: peeled\nabc refs/heads/release\n",
)
.unwrap();
let run = Run {
work_dir: orch.join("worktrees/proj/mine"),
git_dir: Some(home.join("proj/.git/worktrees/mine")),
common_dir: Some(home.join("proj/.git")),
own_ref: Some("refs/heads/feat/mine".into()),
home: home.clone(),
orch_home: orch,
projects: vec![home.join("proj")],
path_dirs: vec![home.join(".cargo/bin"), "/usr/bin".into()],
temp: r.join("tmp"),
internal,
seatbelt: false,
};
(root, run)
}
#[test]
fn orch_home_is_read_only_around_the_task_worktree() {
let (_root, run) = fixture(false);
let p = policy(&run);
let o = &run.orch_home;
for path in [
o.join("config.yml"),
o.join("state"),
o.join("orch.db"),
o.join("worktrees/proj/other"),
] {
assert!(
p.read_only.contains(&path),
"{} not read-only",
path.display()
);
}
for path in [
o.join("worktrees"),
o.join("worktrees/proj"),
run.work_dir.clone(),
] {
assert!(!p.read_only.contains(&path), "{} read-only", path.display());
}
assert!(p.writable.contains(&run.work_dir));
}
#[test]
fn the_main_checkout_is_read_only_but_its_git_dir() {
let (_root, run) = fixture(false);
let p = policy(&run);
let proj = run.home.join("proj");
assert!(p.read_only.contains(&proj.join("src")));
assert!(p.read_only.contains(&proj.join("README.md")));
assert!(!p.read_only.contains(&proj.join(".git")));
assert!(p.read_only.contains(&proj.join(".git/hooks")));
assert!(p.read_only.contains(&proj.join(".git/config")));
}
#[test]
fn only_the_task_branch_is_writable_in_the_git_dir() {
let (_root, run) = fixture(false);
let p = policy(&run);
let git = run.home.join("proj/.git");
for path in [
"refs/heads/main",
"refs/heads/release",
"packed-refs",
"hooks",
"config",
] {
assert!(
p.read_only.contains(&git.join(path)),
"{path} not read-only"
);
}
assert!(!p.read_only.contains(&git.join("refs/heads/feat/mine")));
assert!(!p.read_only.contains(&git.join("refs/heads/feat")));
assert!(!p.read_only.contains(&git.join("objects")));
assert!(p.read_only.contains(&git.join("worktrees/other")));
assert!(p.read_only.contains(&git.join("worktrees/mine/HEAD")));
assert!(p.read_only.contains(&run.work_dir.join(".git")));
assert!(p.writable.contains(&git));
}
#[test]
fn only_the_home_s_cache_dirs_are_writable() {
let (_root, run) = fixture(false);
let p = policy(&run);
let h = &run.home;
for path in [".cargo", ".orch", "Library/Caches"] {
assert!(p.writable.contains(&h.join(path)), "{path} not writable");
}
for path in ["", ".config", ".claude", "Library"] {
assert!(!p.writable.contains(&h.join(path)), "{path:?} writable");
}
assert!(p.read_only.contains(&h.join(".cargo/bin")));
assert!(!p.read_only.contains(&PathBuf::from("/usr/bin")));
}
#[test]
fn no_socket_outside_the_worktree_and_no_launch_services() {
let (_root, mut run) = fixture(false);
run.seatbelt = true;
let p = policy(&run);
let Access::Only(sockets) = &p.unix_sockets else {
panic!("every unix socket is reachable");
};
assert!(sockets.contains(&run.work_dir));
assert!(!sockets
.iter()
.any(|s| s.starts_with("/tmp") || s.starts_with("/private/tmp")));
let Access::Only(mach) = &p.mach_services else {
panic!("every Mach service is reachable");
};
assert!(mach.iter().any(|s| s == KEYCHAIN));
assert!(!mach.iter().any(|s| s.contains("launchservices")));
}
#[test]
fn code_running_config_in_a_writable_home_dir_is_read_only() {
let (_root, run) = fixture(false);
let p = policy(&run);
assert!(p.writable.contains(&run.home.join(".cargo")));
assert!(p.read_only.contains(&run.home.join(".cargo/config.toml")));
}
#[test]
fn a_git_dir_the_agent_could_have_pointed_elsewhere_is_refused() {
let (_root, run) = fixture(false);
let (work, main) = (&run.work_dir, run.home.join("proj"));
let (git, common) = (
run.git_dir.clone().unwrap(),
run.common_dir.clone().unwrap(),
);
fs::write(
git.join("gitdir"),
format!("{}\n", work.join(".git").display()),
)
.unwrap();
assert!(check_git_dirs(work, &main, Some(&git), Some(&common)).is_ok());
assert!(check_git_dirs(work, &main, Some(&common), Some(&common)).is_err());
assert!(check_git_dirs(&main, &main, Some(&common), Some(&common)).is_ok());
let other = common.join("worktrees/other");
fs::write(other.join("gitdir"), "/elsewhere/.git\n").unwrap();
assert!(check_git_dirs(work, &main, Some(&other), Some(&common)).is_err());
assert!(check_git_dirs(work, &main, Some(&run.home), Some(&common)).is_err());
assert!(check_git_dirs(work, &main, None, Some(&common)).is_err());
}
#[test]
fn a_job_task_may_write_the_store() {
let (_root, run) = fixture(true);
assert!(!policy(&run)
.read_only
.contains(&run.orch_home.join("orch.db")));
}
#[test]
fn keys_are_hidden_and_startup_files_read_only() {
let (_root, run) = fixture(false);
let p = policy(&run);
assert!(p.hidden.contains(&run.home.join(".ssh")));
assert!(p.hidden.contains(&run.home.join(".gnupg")));
assert!(!p.hidden.iter().any(|h| h.ends_with(".cargo/config.toml")));
assert!(p.read_only.contains(&run.work_dir.join(".orch.yml")));
}
#[cfg(target_os = "macos")]
#[test]
fn the_kernel_enforces_the_policy() {
let Ok(backend) = Backend::detect() else {
eprintln!("skipped: no OS sandbox starts here");
return;
};
let (_root, mut run) = fixture(false);
run.seatbelt = backend == Backend::Seatbelt;
let other = run.orch_home.join("worktrees/proj/other");
fs::create_dir_all(run.home.join(".ssh")).unwrap();
fs::write(run.home.join(".ssh/key"), "k").unwrap();
let script = format!(
"echo ok > {w}/f && ! echo x > {o}/config.yml && ! echo x > {other}/f \
&& ! echo x > {w}/.orch.yml && ! echo x >> {h}/.zshrc && ! cat {h}/.ssh/key \
&& ! echo x > {h}/.new-dotfile && ! echo x > {h}/.claude.json \
&& echo cache > {h}/.cargo/probe",
w = run.work_dir.display(),
o = run.orch_home.display(),
other = other.display(),
h = run.home.display(),
);
let out = Sandbox::new(backend, policy(&run))
.unwrap()
.command("/bin/sh")
.args(["-c", &script])
.output()
.unwrap();
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert!(run.work_dir.join("f").exists());
assert!(!other.join("f").exists());
}
#[cfg(target_os = "macos")]
#[test]
fn the_kernel_keeps_sockets_and_other_branches_out_of_reach() {
let Ok(backend) = Backend::detect() else {
eprintln!("skipped: no OS sandbox starts here");
return;
};
let (_root, mut run) = fixture(false);
run.seatbelt = backend == Backend::Seatbelt;
for dir in [&run.work_dir, &run.home] {
let listener = std::os::unix::net::UnixListener::bind(dir.join("s")).unwrap();
std::thread::spawn(move || listener.incoming().for_each(drop));
}
let git = run.home.join("proj/.git");
let script = format!(
"/usr/bin/nc -U {w}/s </dev/null && ! /usr/bin/nc -U {h}/s </dev/null \
&& echo sha > {g}/refs/heads/feat/mine && ! echo sha > {g}/refs/heads/main",
w = run.work_dir.display(),
h = run.home.display(),
g = git.display(),
);
let out = Sandbox::new(backend, policy(&run))
.unwrap()
.command("/bin/sh")
.args(["-c", &script])
.output()
.unwrap();
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert_eq!(fs::read_to_string(git.join("refs/heads/main")).unwrap(), "");
}
#[cfg(target_os = "macos")]
#[test]
#[ignore]
fn claude_answers_inside_the_sandbox_with_the_real_home() {
let root = tempfile::tempdir().unwrap();
let work = root.path().canonicalize().unwrap();
let home = PathBuf::from(std::env::var_os("HOME").unwrap());
let run = Run {
work_dir: work.clone(),
git_dir: None,
common_dir: None,
own_ref: None,
home: home.clone(),
orch_home: home.join(".orch"),
projects: vec![],
path_dirs: std::env::split_paths(&std::env::var_os("PATH").unwrap()).collect(),
temp: std::env::temp_dir(),
internal: false,
seatbelt: true,
};
let out = Sandbox::new(Backend::Seatbelt, policy(&run))
.unwrap()
.command("/bin/sh")
.args(["-c", "claude -p --model haiku 'Reply with the word ok'"])
.current_dir(&work)
.output()
.unwrap();
let text = String::from_utf8_lossy(&out.stdout).to_lowercase();
assert!(
text.contains("ok"),
"{text}{}",
String::from_utf8_lossy(&out.stderr)
);
}
#[test]
fn a_worktree_that_is_the_main_checkout_stays_writable() {
let (_root, mut run) = fixture(false);
run.work_dir = run.home.join("proj");
let p = policy(&run);
assert!(!p.read_only.contains(&run.work_dir));
assert!(!p.read_only.contains(&run.work_dir.join("src")));
}
}