fix(sandbox): strict profile no longer lets a child rewrite ~/.kigi
Port of upstream grok-build 1.0.14 ("--sandbox strict now restricts
writes to ~/.grok/sessions only"), shaped for Kigi.
The strict profile granted the whole ~/.kigi read-write, so a sandboxed
command could plant a global SessionStart hook or flip
`[sandbox].profile` in config.toml for the next launch. Landlock cannot
carve a child out of a write grant, so the home is now read-only
except an explicit allowlist of state subtrees (run, sessions,
worktrees, worktree_pool, tasks, memory, logs, debug, crash, memtrace,
trace-exports); config.toml, auth.json, sandbox.toml, hooks/, bin/ and
vendor/ stay read-only. A symlinked state dir under the home is
followed only to the default ~/.kigi/sessions.
What the process itself writes there after enforcement moves or is
minted first:
- kigi-shell `apply_sandbox` mints the device id, extracts the bundled
rg and the bundled skills BEFORE enforcement for every profile that
restricts home writes (`restricts_home_writes`, custom profiles
extending strict included).
- The sandbox audit log lives at ~/.kigi/sessions/sandbox-events.jsonl.
- Leader lock/socket default to ~/.kigi/run/, the leader stderr log to
~/.kigi/logs/leader.log; discovery scans run/ and the legacy root,
and the default target prefers the current socket.
Root-level caches (version.json, agent_id, slash-mru.json, pager.toml,
claude_import_state.json) degrade best-effort under strict; documented.
Claude-Session: https://claude.ai/code/session_01RUqV8HVGXcAETyYbZ2tPQ4
This commit is contained in:
1 parent
cadc46f5dc
commit
97c934a647
13 files changed
+300
-25
No files matched your search
@@ -360,6 +360,23 @@ pub fn requires_read_deny(profile: &ProfileName, workspace: &Path) -> bool {
|
||||
pub fn requires_read_deny(_profile: &ProfileName, _workspace: &Path) -> bool {
|
||||
false
|
||||
}
|
||||
/// Whether the resolved profile leaves `~/.kigi` read-only outside its
|
||||
/// state dirs (strict and every profile extending it), so files first use
|
||||
/// would write there must be minted before enforcement.
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
pub fn restricts_home_writes(profile: &ProfileName, workspace: &Path) -> bool {
|
||||
if *profile == ProfileName::Off {
|
||||
return false;
|
||||
}
|
||||
let config = profiles::load_sandbox_config(workspace);
|
||||
profile
|
||||
.resolve_profile(workspace, &config)
|
||||
.is_ok_and(|resolved| !resolved.read_write.contains(&paths::kigi_home()))
|
||||
}
|
||||
#[cfg(not(all(feature = "enforce", unix)))]
|
||||
pub fn restricts_home_writes(_profile: &ProfileName, _workspace: &Path) -> bool {
|
||||
false
|
||||
}
|
||||
/// A profile's resolved bwrap deny plan: read-only mounts (`deny_write`),
|
||||
/// bound-over unreadable placeholders (`deny_read`), and whether the profile
|
||||
/// carries deny globs (`has_globs`, so the re-exec proceeds even with zero
|
||||
@@ -717,3 +734,31 @@ mod tests {
|
||||
let _ = std::fs::remove_dir_all(&ws_ws);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(all(test, feature = "enforce", unix))]
|
||||
mod home_write_tests {
|
||||
use super::{ProfileName, restricts_home_writes};
|
||||
|
||||
#[test]
|
||||
fn strict_restricts_home_writes_and_workspace_does_not() {
|
||||
let workspace = std::env::temp_dir();
|
||||
assert!(restricts_home_writes(&ProfileName::Strict, &workspace));
|
||||
assert!(!restricts_home_writes(&ProfileName::Workspace, &workspace));
|
||||
assert!(!restricts_home_writes(&ProfileName::ReadOnly, &workspace));
|
||||
assert!(!restricts_home_writes(&ProfileName::Off, &workspace));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn custom_profile_extending_strict_inherits_the_restriction() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let project = tmp.path().join(".kigi");
|
||||
std::fs::create_dir_all(&project).unwrap();
|
||||
std::fs::write(
|
||||
project.join("sandbox.toml"),
|
||||
"[profiles.audit-home-write-test]\nextends = \"strict\"\n",
|
||||
)
|
||||
.unwrap();
|
||||
let custom = ProfileName::Custom("audit-home-write-test".to_string());
|
||||
assert!(restricts_home_writes(&custom, tmp.path()));
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
//! Sandbox event logger.
|
||||
//!
|
||||
//! Events (profile applied, violations, bypasses) are buffered in memory and
|
||||
//! flushed as JSONL to `~/.kigi/sandbox-events.jsonl`.
|
||||
//! flushed as JSONL to `~/.kigi/sessions/sandbox-events.jsonl`.
|
||||
|
||||
use std::path::PathBuf;
|
||||
use std::sync::Mutex;
|
||||
@@ -87,8 +87,12 @@ impl SandboxLogger {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Under `sessions/`: the only home subtree a strict sandbox leaves
|
||||
/// writable, and this flush runs after enforcement.
|
||||
fn log_file_path() -> PathBuf {
|
||||
kigi_config::kigi_home().join("sandbox-events.jsonl")
|
||||
kigi_config::kigi_home()
|
||||
.join("sessions")
|
||||
.join("sandbox-events.jsonl")
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -96,6 +96,37 @@ pub(crate) fn essential_writable_paths(workspace: &Path) -> Vec<PathBuf> {
|
||||
paths
|
||||
}
|
||||
|
||||
/// Home subtrees the process keeps writing after enforcement: session and
|
||||
/// worktree state, memory, diagnostics. Landlock cannot carve a child out of
|
||||
/// a write grant, so the rest of `~/.kigi` (`config.toml`, `auth.json`,
|
||||
/// `sandbox.toml`, `hooks/`, `bin/`, `vendor/`, `plugin-data/`) stays
|
||||
/// read-only and a sandboxed child cannot arm the next launch.
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
const HOME_STATE_DIRS: &[&str] = &[
|
||||
"run",
|
||||
"sessions",
|
||||
"worktrees",
|
||||
"worktree_pool",
|
||||
"tasks",
|
||||
"memory",
|
||||
"logs",
|
||||
"debug",
|
||||
"crash",
|
||||
"memtrace",
|
||||
"trace-exports",
|
||||
];
|
||||
|
||||
/// Writable paths for the strict profile: the workspace, the home state
|
||||
/// subtrees, and temp.
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
pub(crate) fn essential_writable_paths_strict(workspace: &Path) -> Vec<PathBuf> {
|
||||
let home = kigi_home();
|
||||
let mut paths = vec![workspace.to_path_buf()];
|
||||
paths.extend(HOME_STATE_DIRS.iter().map(|dir| home.join(dir)));
|
||||
paths.extend(temp_writable_paths());
|
||||
paths
|
||||
}
|
||||
|
||||
/// Writable directory paths for the read-only profile (minimal: just ~/.kigi + temp).
|
||||
/// Device files are handled separately via `allow_file` in `to_capability_set_with_config`.
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
|
||||
@@ -18,6 +18,7 @@ use crate::paths::kigi_home;
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
use crate::paths::{
|
||||
DEVICE_DIRS, DEVICE_FILES, essential_writable_paths, essential_writable_paths_minimal,
|
||||
essential_writable_paths_strict,
|
||||
};
|
||||
|
||||
/// A resolved sandbox profile ready to be converted to a `CapabilitySet`.
|
||||
@@ -186,6 +187,32 @@ fn load_config_file(path: &Path) -> Option<SandboxConfig> {
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
impl ProfileName {
|
||||
/// Convert this profile into a nono `CapabilitySet` for the given workspace.
|
||||
/// The directory a `read_write` entry really grants. A symlink under
|
||||
/// `~/.kigi` is followed only to the default `~/.kigi/sessions` (the
|
||||
/// `KIGI_SHARE_DIR` override case); any other target would widen the
|
||||
/// grant to wherever the link points. Missing paths are created.
|
||||
fn read_write_grant_path(path: &Path, home: &Path) -> Option<PathBuf> {
|
||||
match std::fs::symlink_metadata(path) {
|
||||
Ok(meta) if meta.file_type().is_symlink() => {
|
||||
if path == home || !path.starts_with(home) {
|
||||
return Some(path.to_path_buf());
|
||||
}
|
||||
let real = dunce::canonicalize(path).ok()?;
|
||||
let default_sessions = kigi_config::default_kigi_home().join("sessions");
|
||||
(real.is_dir()
|
||||
&& path.file_name() == Some(std::ffi::OsStr::new("sessions"))
|
||||
&& real == default_sessions)
|
||||
.then_some(real)
|
||||
}
|
||||
Ok(_) => Some(path.to_path_buf()),
|
||||
Err(err) if err.kind() == std::io::ErrorKind::NotFound => {
|
||||
std::fs::create_dir_all(path).ok()?;
|
||||
Some(path.to_path_buf())
|
||||
}
|
||||
Err(_) => None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn to_capability_set(&self, workspace: &Path) -> anyhow::Result<CapabilitySet> {
|
||||
let config = load_sandbox_config(workspace);
|
||||
self.to_capability_set_with_config(workspace, &config)
|
||||
@@ -231,13 +258,14 @@ impl ProfileName {
|
||||
// apply time (it opens an O_PATH fd), but new files within it can
|
||||
// be created freely after the sandbox is applied. Pre-create
|
||||
// directories like ~/.kigi/ that may not exist on first run.
|
||||
let home = kigi_home();
|
||||
for path in &profile.read_write {
|
||||
if !path.exists() && std::fs::create_dir_all(path).is_err() {
|
||||
tracing::warn!(path = ?path, "read_write path does not exist and could not be created, skipping");
|
||||
let Some(grant) = Self::read_write_grant_path(path, &home) else {
|
||||
tracing::warn!(path = ?path, "read_write grant skipped");
|
||||
continue;
|
||||
}
|
||||
let Some(path_str) = path.to_str() else {
|
||||
tracing::warn!(path = ?path, "Skipping non-UTF8 read_write path");
|
||||
};
|
||||
let Some(path_str) = grant.to_str() else {
|
||||
tracing::warn!(path = ?grant, "Skipping non-UTF8 read_write path");
|
||||
continue;
|
||||
};
|
||||
caps = caps.allow_path(path_str, AccessMode::ReadWrite)?;
|
||||
@@ -380,12 +408,15 @@ impl ProfileName {
|
||||
.chain(std::iter::once(home.join("Library")))
|
||||
.filter(|p| p.exists())
|
||||
.chain(std::iter::once(workspace.to_path_buf()))
|
||||
// Read-only: config, auth and global hooks are read after
|
||||
// enforcement; only sessions/ below stays writable.
|
||||
.chain(std::iter::once(kigi_home()))
|
||||
.collect();
|
||||
|
||||
Ok(SandboxProfile {
|
||||
name: "strict".to_string(),
|
||||
read_only: system_read,
|
||||
read_write: essential_writable_paths(workspace),
|
||||
read_write: essential_writable_paths_strict(workspace),
|
||||
deny: vec![],
|
||||
default_read: false,
|
||||
restrict_network: true,
|
||||
@@ -544,6 +575,82 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
fn strict_read_write_is_workspace_home_state_and_temp() {
|
||||
let workspace = std::env::temp_dir();
|
||||
let profile = ProfileName::Strict
|
||||
.resolve_profile(&workspace, &SandboxConfig::default())
|
||||
.expect("strict resolves");
|
||||
let home = kigi_home();
|
||||
assert_eq!(profile.read_write[0], workspace);
|
||||
for dir in ["sessions", "worktrees", "memory", "logs", "debug"] {
|
||||
assert!(
|
||||
profile.read_write.contains(&home.join(dir)),
|
||||
"{dir} must stay writable: {:?}",
|
||||
profile.read_write
|
||||
);
|
||||
}
|
||||
for denied in [
|
||||
home.clone(),
|
||||
home.join("hooks"),
|
||||
home.join("vendor"),
|
||||
home.join("bin"),
|
||||
] {
|
||||
assert!(
|
||||
!profile.read_write.contains(&denied),
|
||||
"strict must not grant {}: {:?}",
|
||||
denied.display(),
|
||||
profile.read_write
|
||||
);
|
||||
}
|
||||
assert!(
|
||||
profile.read_only.contains(&home),
|
||||
"config/auth/hooks are read after enforcement: {:?}",
|
||||
profile.read_only
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
fn read_write_grant_follows_real_dirs_and_creates_missing_ones() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let home = tmp.path().join("home");
|
||||
std::fs::create_dir_all(home.join("sessions")).unwrap();
|
||||
assert_eq!(
|
||||
ProfileName::read_write_grant_path(&home.join("sessions"), &home),
|
||||
Some(home.join("sessions"))
|
||||
);
|
||||
let missing = home.join("fresh");
|
||||
assert_eq!(
|
||||
ProfileName::read_write_grant_path(&missing, &home),
|
||||
Some(missing.clone())
|
||||
);
|
||||
assert!(missing.is_dir());
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
fn read_write_grant_refuses_a_home_symlink_pointing_elsewhere() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let home = tmp.path().join("home");
|
||||
let outside = tmp.path().join("outside");
|
||||
std::fs::create_dir_all(&home).unwrap();
|
||||
std::fs::create_dir_all(&outside).unwrap();
|
||||
std::os::unix::fs::symlink(&outside, home.join("sessions")).unwrap();
|
||||
assert_eq!(
|
||||
ProfileName::read_write_grant_path(&home.join("sessions"), &home),
|
||||
None
|
||||
);
|
||||
// A symlinked workspace outside the home is the user's own choice.
|
||||
let ws_link = tmp.path().join("ws");
|
||||
std::os::unix::fs::symlink(&outside, &ws_link).unwrap();
|
||||
assert_eq!(
|
||||
ProfileName::read_write_grant_path(&ws_link, &home),
|
||||
Some(ws_link.clone())
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(all(feature = "enforce", unix))]
|
||||
fn base_profile_capability_set_builds() {
|
||||
|
||||
Reference in new issue
Block a user