Document and expand test coverage of config file feature

This commit is contained in:
2026-04-04 07:46:28 +02:00
parent db60fb9ddb
commit 8958f79ece
3 changed files with 30 additions and 5 deletions

View File

@@ -16,6 +16,25 @@ The threat model is prompt injection and accidental damage, not a determined att
**Not protected in blacklist mode:** arbitrary readable files outside the sensitive paths list, and D-Bus method calls (access control is daemon-side). **Not protected in blacklist mode:** arbitrary readable files outside the sensitive paths list, and D-Bus method calls (access control is daemon-side).
## Configuration file
Settings can be stored in a TOML config file at `$XDG_CONFIG_HOME/agent-sandbox/config.toml` (or pass `--config <path>`). Use `--no-config` to skip loading it. The config file accepts the same options as the corresponding CLI flags.
Top-level keys set defaults; `[profile.<name>]` sections define named presets selectable with `--profile <name>`. CLI flags always take highest precedence, followed by the active profile, then top-level defaults.
```toml
# Global defaults
whitelist = true
no-net = true
ro = ["~/.aws"]
# Named profile
[profile.docker]
blacklist = true
rw = ["/var/run/docker.sock"]
command = ["claude", "--dangerously-skip-permissions"]
```
## Escape hatches ## Escape hatches
When the agent needs access to something the sandbox blocks, use `--rw` or `--ro`: When the agent needs access to something the sandbox blocks, use `--rw` or `--ro`:

View File

@@ -47,7 +47,7 @@ pub struct Args {
pub profile: Option<String>, pub profile: Option<String>,
/// Path to config file (default: $XDG_CONFIG_HOME/agent-sandbox/config.toml) /// Path to config file (default: $XDG_CONFIG_HOME/agent-sandbox/config.toml)
#[arg(long = "config", value_name = "PATH")] #[arg(long = "config", value_name = "PATH", conflicts_with = "no_config")]
pub config_path: Option<PathBuf>, pub config_path: Option<PathBuf>,
/// Skip loading the config file entirely /// Skip loading the config file entirely

View File

@@ -3,12 +3,18 @@ use std::process::Command;
use tempfile::TempDir; use tempfile::TempDir;
fn sandbox(extra_args: &[&str]) -> Command { fn sandbox_withconfig(extra_args: &[&str]) -> Command {
let mut cmd = Command::new(env!("CARGO_BIN_EXE_agent-sandbox")); let mut cmd = Command::new(env!("CARGO_BIN_EXE_agent-sandbox"));
cmd.args(extra_args); cmd.args(extra_args);
cmd cmd
} }
fn sandbox(extra_args: &[&str]) -> Command {
let mut cmd = sandbox_withconfig(&["--no-config"]);
cmd.args(extra_args);
cmd
}
fn write_config(dir: &TempDir, content: &str) -> String { fn write_config(dir: &TempDir, content: &str) -> String {
let path = dir.path().join("config.toml"); let path = dir.path().join("config.toml");
fs::write(&path, content).expect("failed to write config"); fs::write(&path, content).expect("failed to write config");
@@ -547,7 +553,7 @@ fn rw_missing_path_errors() {
#[test] #[test]
fn config_missing_file_errors() { fn config_missing_file_errors() {
let output = sandbox(&["--config", "/nonexistent/config.toml"]) let output = sandbox_withconfig(&["--config", "/nonexistent/config.toml"])
.args(["--", "true"]) .args(["--", "true"])
.output() .output()
.expect("failed to execute"); .expect("failed to execute");
@@ -565,7 +571,7 @@ fn config_invalid_toml_errors() {
let dir = TempDir::new().unwrap(); let dir = TempDir::new().unwrap();
let cfg = write_config(&dir, "not valid {{{{ toml"); let cfg = write_config(&dir, "not valid {{{{ toml");
let output = sandbox(&["--config", &cfg]) let output = sandbox_withconfig(&["--config", &cfg])
.args(["--", "true"]) .args(["--", "true"])
.output() .output()
.expect("failed to execute"); .expect("failed to execute");
@@ -583,7 +589,7 @@ fn config_unknown_key_errors() {
let dir = TempDir::new().unwrap(); let dir = TempDir::new().unwrap();
let cfg = write_config(&dir, "hardened = true\nbogus = \"nope\"\n"); let cfg = write_config(&dir, "hardened = true\nbogus = \"nope\"\n");
let output = sandbox(&["--config", &cfg]) let output = sandbox_withconfig(&["--config", &cfg])
.args(["--", "true"]) .args(["--", "true"])
.output() .output()
.expect("failed to execute"); .expect("failed to execute");