Skip to main content

safe_chains/
lib.rs

1// The generated test names spell the command and its flags verbatim, and FLAG CASE IS MEANINGFUL:
2// find takes both `-D` and `-d`, `-P` and `-p`, `-L` and `-l`, and commands like `asn1Decoding` and
3// `checkLocalKDC` are camel-case upstream. Lowercasing to satisfy `non_snake_case` would erase the
4// distinction the test exists to pin, so the generated items opt out instead.
5#[cfg(test)]
6macro_rules! safe {
7    ($($name:ident: $cmd:expr),* $(,)?) => {
8        $(#[test] #[allow(non_snake_case)] fn $name() { assert!(check($cmd), "expected safe: {}", $cmd); })*
9    };
10}
11
12#[cfg(test)]
13macro_rules! denied {
14    ($($name:ident: $cmd:expr),* $(,)?) => {
15        $(#[test] #[allow(non_snake_case)] fn $name() { assert!(!check($cmd), "expected denied: {}", $cmd); })*
16    };
17}
18
19#[cfg(test)]
20macro_rules! inert {
21    ($($name:ident: $cmd:expr),* $(,)?) => {
22        $(#[test] #[allow(non_snake_case)] fn $name() {
23            assert_eq!(
24                crate::command_verdict($cmd),
25                crate::verdict::Verdict::Allowed(crate::verdict::SafetyLevel::Inert),
26                "expected Inert: {}", $cmd,
27            );
28        })*
29    };
30}
31
32#[cfg(test)]
33macro_rules! safe_read {
34    ($($name:ident: $cmd:expr),* $(,)?) => {
35        $(#[test] #[allow(non_snake_case)] fn $name() {
36            assert_eq!(
37                crate::command_verdict($cmd),
38                crate::verdict::Verdict::Allowed(crate::verdict::SafetyLevel::SafeRead),
39                "expected SafeRead: {}", $cmd,
40            );
41        })*
42    };
43}
44
45#[cfg(test)]
46macro_rules! safe_write {
47    ($($name:ident: $cmd:expr),* $(,)?) => {
48        $(#[test] #[allow(non_snake_case)] fn $name() {
49            assert_eq!(
50                crate::command_verdict($cmd),
51                crate::verdict::Verdict::Allowed(crate::verdict::SafetyLevel::SafeWrite),
52                "expected SafeWrite: {}", $cmd,
53            );
54        })*
55    };
56}
57
58pub mod allowlist;
59pub mod cli;
60#[cfg(test)]
61mod composition;
62pub mod cst;
63pub mod decisionlog;
64pub mod docs;
65pub mod engine;
66mod envvars;
67#[cfg(test)]
68mod handler_property_tests;
69mod handlers;
70pub mod netloc;
71#[cfg(test)]
72mod overreach_property_tests;
73pub mod parse;
74#[cfg(test)]
75mod path_placement_tests;
76pub mod pathctx;
77pub mod pathgate;
78pub mod policy;
79pub mod refusal;
80pub mod registry;
81pub mod suggest;
82pub mod targets;
83pub mod verdict;
84
85pub use verdict::{SafetyLevel, Verdict};
86
87/// The facet profile behind a verdict, rendered for `--explain`.
88///
89/// Answers the question the boolean cannot: not "is this allowed" but "on which axis was it
90/// refused". Empty when no resolver claims the command — that is the answer too, since it means the
91/// legacy classifier decided and there are no facets to show.
92pub fn facet_breakdown(command: &str) -> String {
93    // One simple command only. `shell_words` has no idea what `&&` means, so on a chain it hands
94    // back one flat token list and the resolver reads the SECOND command's arguments as flags of
95    // the first — `aws dynamodb scan --table-name t && rm -rf /` produced a single worst-case
96    // profile belonging to neither segment. A diagnostic that invents a capability set no resolver
97    // emitted is worse than silence, and `render()` above already breaks the chain down per segment.
98    if cst::explain(command).segments.len() != 1 {
99        return "\n  (facet breakdown covers one command at a time; run --explain on a single segment)\n".to_string();
100    }
101    // A COMPOUND is one segment, so it reaches here — but the flat split cannot see into it.
102    // `(cat ~/.ssh/id_rsa)` tokenises to `["(cat", "~/.ssh/id_rsa)"]`, no resolver recognises
103    // `(cat`, and the refusal rendered with no reason at all. The command the caller has to change
104    // is INSIDE the construct, so describe that one and say so.
105    let inner = cst::denied_inner_words(command);
106    let words = match inner {
107        Some(ref w) => w.clone(),
108        None => match shell_words::split(command) {
109            Ok(w) => w,
110            Err(_) => return String::new(),
111        },
112    };
113    if words.is_empty() {
114        return String::new();
115    }
116    let tokens: Vec<parse::Token> = words.into_iter().map(parse::Token::from_raw).collect();
117    let Some(ex) = engine::bridge::explain_profile(&tokens) else {
118        return String::new();
119    };
120    let mut out = String::from("\n  resolved profile:\n");
121    if let Some(w) = &inner {
122        out.push_str(&format!("    (the refused command inside it: `{}`)\n", w.join(" ")));
123    }
124    for (because, facets) in &ex.capabilities {
125        out.push_str(&format!("    · {because}\n"));
126        for (name, term) in facets {
127            out.push_str(&format!("        {name:<28} {term}\n"));
128        }
129    }
130    match &ex.blocked_by {
131        Some((level, mismatch)) => {
132            out.push_str(&format!("\n  refused by `{level}` (the most permissive auto-approving level):\n    {mismatch}\n",));
133        }
134        None => out.push_str("\n  admitted by the auto-approve band.\n"),
135    }
136    out
137}
138
139pub fn is_safe_command(command: &str) -> bool {
140    command_verdict(command).is_allowed()
141}
142
143pub fn command_verdict(command: &str) -> Verdict {
144    cst::command_verdict(command)
145}
146
147/// Classify `command` against a named level. Every engine-resolved leaf is decided by
148/// `Level::admits` against `level` rather than by walking the band; a `Denied` on any segment
149/// dominates. Legacy (unresolved) leaves keep their local-safe `SafeWrite`-or-below verdict.
150///
151/// A pass returns the band the PROFILE earns (`to_legacy`), so the caller's `<= ceiling` gate
152/// still tightens — that is what lets `reader` (SafeRead) and `paranoid` (Inert) use this path at
153/// all. Upper-band levels have no legacy equivalent and keep the shared `SafeWrite`.
154pub fn command_verdict_at_level(command: &str, level: &'static engine::level::Level) -> Verdict {
155    let _guard = engine::bridge::enter_eval_level(level);
156    cst::command_verdict(command)
157}
158
159/// The `&'static Level` for an UPPER-band level name, or `None` for the lower band (which the
160/// 3-value ceiling already handles) or an unknown name. The caller passes the CANONICAL name
161/// (legacy aliases already resolved).
162pub fn upper_level_by_name(name: &str) -> Option<&'static engine::level::Level> {
163    if !matches!(name, "local-admin" | "network-admin" | "yolo") {
164        return None;
165    }
166    engine::authoring::default_levels().iter().find(|l| l.name == name)
167}
168
169/// Resolve a level NAME to its `(3-band ceiling, engine level for admits)`, or `None` for an unknown
170/// name. The ceiling gates the projected verdict; the engine level (when present) classifies per-level
171/// via `admits`, exposing distinctions the 3-band projection flattens — `editor` (no destroy, no
172/// sibling write) vs `developer`, and the upper band (git push, bulk-object-read, sudo). `paranoid`/
173/// `reader` are pure ceilings (their read/inert bands need no `admits`), and `developer` IS the default
174/// band, so those carry no engine level. Legacy aliases (`safe-write`) canonicalize first.
175pub fn level_ceiling(name: &str) -> Option<(SafetyLevel, Option<&'static engine::level::Level>)> {
176    let (ceiling, legacy_of) = verdict::SafetyLevel::resolve_threshold(name)?;
177    let canonical = legacy_of.unwrap_or(name);
178    // EVERY named level classifies through `admits`. The levels are `extends`-chained
179    // (paranoid ⊂ reader ⊂ editor ⊂ developer ⊂ admin ⊂ yolo), so one mechanism across the whole
180    // ladder makes it monotone BY CONSTRUCTION: whatever a level admits, every looser level
181    // inherits.
182    //
183    // Only `editor` and the upper band used to, for a reason that turned out to be a bug rather
184    // than a design: `project` stamped every pass `SafeWrite`, which the `<= threshold` gate then
185    // refused at any lower ceiling, so handing `reader` an engine level denied its entire band
186    // (measured: 157 commands, `cat ./notes.txt` among them). With `project` returning the band
187    // the profile actually earns, that is gone.
188    //
189    // The mixture was itself the `level_monotonic` fuzz failure — `editor` decided by `admits`
190    // while `reader` and `developer` decided by projection, and nothing made two mechanisms
191    // adjacent in one ordered ladder agree.
192    let engine_level = match canonical {
193        "paranoid" | "reader" | "editor" | "developer" | "local-admin" | "network-admin" | "yolo" => {
194            engine::authoring::default_levels().iter().find(|l| l.name == canonical)
195        }
196        _ => None,
197    };
198    Some((ceiling, engine_level))
199}
200
201/// The ceilinged verdict: classify `command` at `(threshold, engine_level)`, gating the projected
202/// level `<= threshold`. The single seam both the CLI (`--level`) and the hook (configured `level`)
203/// funnel through. `engine_level = Some` classifies via `Level::admits` (the fine per-level model);
204/// `None` uses the 3-band projection. Either way the result is gated to `threshold`, so a legacy leaf
205/// that bypasses the engine (a redirect write → `SafeWrite`) is still held under a lower ceiling.
206pub fn command_verdict_ceilinged(command: &str, threshold: SafetyLevel, engine_level: Option<&'static engine::level::Level>) -> Verdict {
207    let verdict = match engine_level {
208        Some(level) => command_verdict_at_level(command, level),
209        None => command_verdict(command),
210    };
211    match verdict {
212        Verdict::Allowed(level) if level <= threshold => Verdict::Allowed(level),
213        _ => Verdict::Denied,
214    }
215}
216
217/// The coverage-fallback explanation (built-in classifier + the user's `permissions.allow` patterns),
218/// computed UNDER the configured engine level so a covered command honors that level's rule — a
219/// worktree destroy an `editor` plan forbids classifies as denied here too, not re-admitted. `None`
220/// engine level → the plain 3-band coverage (paranoid/reader/default). The caller still gates the
221/// result's `overall <= threshold`; running under the level closes the last path a lower plan's
222/// tighter rule could leak through.
223/// Whether Claude Code's OWN permission files may contribute trust to this run.
224///
225/// safe-chains reads two things out of `~/.claude/settings.json`: `permissions.allow` command
226/// patterns (the coverage bridge, `allowlist.rs`) and `Read(...)` path approvals (the grant bridge,
227/// `regions.rs`). Both were loaded unconditionally, on every harness — so a file that exists purely
228/// to configure Claude Code was silently granting permissions under Codex, Cursor, Grok and agy.
229///
230/// On Codex that is not academic. Codex has no interactive approval, which is why safe-chains
231/// DENIES a gated command there; with a `Bash(curl:*)` rule sitting in the Claude file,
232/// `curl … | sh` went from denied to abstain, and abstain on Codex means it simply runs.
233///
234/// Defaults to FALSE, so a harness safe-chains does not recognize never inherits another tool's
235/// grants. Only the Claude target turns it on.
236static CLAUDE_CONFIG_TRUSTED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
237
238/// Honor `~/.claude/settings.json` as a source of trust for the rest of this process.
239pub fn trust_claude_config() {
240    CLAUDE_CONFIG_TRUSTED.store(true, std::sync::atomic::Ordering::Relaxed);
241}
242
243pub(crate) fn claude_config_trusted() -> bool {
244    CLAUDE_CONFIG_TRUSTED.load(std::sync::atomic::Ordering::Relaxed)
245}
246
247pub fn explain_with_coverage_at_level(command: &str, engine_level: Option<&'static engine::level::Level>) -> cst::Explanation {
248    let patterns = allowlist::Matcher::load();
249    let _guard = engine_level.map(engine::bridge::enter_eval_level);
250    cst::explain_with_coverage(command, &patterns)
251}
252
253/// The auto-approve ceiling the HOOK evaluates at, from the write-protected user config
254/// (`~/.config/safe-chains.toml`, `level = "…"`). No config, or an unknown name → the default
255/// `developer` band (`SafeWrite`, no engine level) — fail-safe. Honored ONLY from the user config,
256/// never a repo `.safe-chains.toml`; the file is write-denied, so an agent cannot set its own ceiling.
257pub fn configured_hook_ceiling() -> (SafetyLevel, Option<&'static engine::level::Level>) {
258    registry::user_config_level()
259        .and_then(|name| level_ceiling(&name))
260        .unwrap_or((SafetyLevel::SafeWrite, None))
261}
262
263/// Classify `command` with the harness-supplied directory context installed (HP-19), so
264/// relative paths resolve against the real `cwd`/`root`. `command_verdict(cmd)` is the
265/// no-context form (`PathCtx::default()`), preserving every existing caller.
266pub fn command_verdict_in(command: &str, ctx: pathctx::PathCtx) -> Verdict {
267    let _guard = pathctx::enter(ctx);
268    cst::command_verdict(command)
269}
270
271/// Why a not-auto-approved command's path reach was flagged — so the nudge can explain the actual
272/// reason instead of a one-size-fits-all "outside the working directory". A peer's hidden file and a
273/// path genuinely above cwd both deny, but the remedy differs, and conflating them is what reads as
274/// "directory parsing is broken".
275#[derive(Debug, Clone, Copy, PartialEq, Eq)]
276pub enum ReachReason {
277    /// A known credential store (`.ssh`, `.aws`, keychain…).
278    Credential,
279    /// A file safe-chains reads its OWN permissions from (`~/.config/safe-chains.toml`,
280    /// `~/.claude/settings.json`). Distinct from `OutsideWorkspace` because the generic remedy
281    /// there — grant the path — is not merely unhelpful but FALSE: the write face is frozen, so
282    /// following the advice changes nothing. For safe-chains' own config it is also circular,
283    /// telling the user to edit the file they are being stopped from editing.
284    FrozenTrustFile,
285    /// The DIRECTORY a trust file lives in. Distinct from `FrozenTrustFile` because only HALF of
286    /// it is refused: writing a file into `~/.config` is ordinary and stays allowed, and only
287    /// removing or replacing the directory is not. Copy that said "this is refused" flatly would
288    /// misdescribe a directory the user explicitly granted.
289    FrozenTrustRoot,
290    /// One of the files that decide who may log in (`/etc/passwd`, `/etc/sudoers`, `/etc/pam.d`,
291    /// the loader and boot). Same false-remedy problem as `FrozenTrustFile`.
292    FrozenSystemIntegrity,
293    /// A raw block or character device (`/dev/mem`, `/dev/rdisk0`, `/dev/sda`). Distinct from
294    /// `FrozenSystemIntegrity` because the `device` rung outranks `system-integrity`, so without
295    /// its own arm every device was explained as a file that "decides who may log in" — which is
296    /// both false and unhelpful about the thing that actually makes a device dangerous.
297    RawDevice,
298    /// Genuinely above/outside the working directory.
299    OutsideWorkspace,
300    /// A path built by an interpolation that nothing confines (`./out/$i`, `> $(cmd)`). It is not
301    /// outside anything — it names WHATEVER the value turns out to be, which is why it cannot be
302    /// admitted — so the remedy is to constrain the spelling, not to grant a directory.
303    Unconfined,
304    /// A temp path that is NOT this session's scratchpad. Reading and writing it is fine; RUNNING
305    /// code from it is not, because anonymous `/tmp` is where downloaded/foreign code lands. This
306    /// is the one reach whose remedy is usually "that IS my working directory" — so the nudge says
307    /// how to bless it rather than implying the agent did something wrong.
308    ForeignTemp,
309}
310
311/// Render command-derived text safely INSIDE one of our messages.
312///
313/// The explanation is read by a human deciding whether to approve, and on the Claude and Qwen
314/// targets it is injected into the model's context as `additionalContext`. Command text is not
315/// trustworthy input for either job: a command routinely carries data the agent picked up from a
316/// file, an issue title, a downloaded manifest. Echoed raw, a newline in it forged a whole extra
317/// line of our OWN output —
318///
319/// ```text
320///   ✗  cat "/etc/x
321///   ✓  ls   safe-chains: auto-approves.
322/// ```
323///
324/// — so the reader saw an approval that never happened, in our voice. Escaping the control
325/// characters keeps any echoed text to a single line of literal content, which is the property
326/// that makes forging a second line impossible. Bidi controls go too: they reorder what is
327/// DISPLAYED without changing the bytes, which is the same forgery by other means.
328///
329/// This neutralizes our own OUTPUT. It is not a check on the command and decides nothing.
330/// Render our INTERNAL substitution markers back as `$(…)` before any of them reach a human.
331///
332/// A path carrying a substitution is classified through a sentinel, and the operand the nudge
333/// reports is the expanded form — so the reader of `cat ~/p/out/$(seq 1 1)` was being shown
334/// `~/p/out/__SAFE_CHAINS_CMDSUB_ATOM__`, a path they never wrote. On the Claude and Qwen targets
335/// this text is injected into the MODEL's context, where an internal marker is worse than noise:
336/// it is a magic string the model can learn and start emitting, and a nudge that describes a path
337/// the user cannot find in their own command is one they have no reason to trust.
338///
339/// Covers every sentinel spelling at once — opaque, atom, and the locus-tagged forms — by keying
340/// on the shared prefix and consuming through the terminating `__`, so a sentinel added later is
341/// rendered without touching this. Text that merely LOOKS like a sentinel keeps its tail — only
342/// the marker itself is replaced — because what follows a bare prefix is the user's path, not our
343/// internals, and dropping it handed a crafted filename control over how much of the path the
344/// reader saw.
345fn render_sentinels(s: &str) -> std::borrow::Cow<'_, str> {
346    let prefix = cst::eval::TAGGED_PREFIX;
347    if !s.contains(prefix) {
348        return std::borrow::Cow::Borrowed(s);
349    }
350    let mut out = String::with_capacity(s.len());
351    let mut rest = s;
352    while let Some(at) = rest.find(prefix) {
353        out.push_str(&rest[..at]);
354        out.push_str("$(…)");
355        let after = &rest[at + prefix.len()..];
356        rest = if let Some(tail) = after.strip_prefix('_') {
357            // The opaque marker is the prefix plus a single `_`.
358            tail
359        } else if let Some(i) = after.find("__") {
360            // Atom and locus-tagged markers are the prefix, a term, then `__`.
361            &after[i + 2..]
362        } else {
363            // Not one of ours. Keep the text: dropping it let a CRAFTED filename decide how much
364            // of the path a human was shown — `cat ~/__SAFE_CHAINS_CMDSUB_.ssh/id_rsa` reported
365            // reaching `~/$(…)`, hiding `.ssh/id_rsa` from the one message used to decide.
366            after
367        };
368    }
369    out.push_str(rest);
370    std::borrow::Cow::Owned(out)
371}
372
373pub fn sanitize_display(s: &str) -> String {
374    let s = &render_sentinels(s);
375    let mut out = String::with_capacity(s.len());
376    for c in s.chars() {
377        match c {
378            '\n' => out.push_str("\\n"),
379            '\r' => out.push_str("\\r"),
380            '\t' => out.push_str("\\t"),
381            // C0/C1 controls, and the bidi overrides/isolates/marks.
382            c if c.is_control() || matches!(c, '\u{202A}'..='\u{202E}' | '\u{2066}'..='\u{2069}' | '\u{200E}' | '\u{200F}') => {
383                out.push_str(&format!("\\u{{{:04x}}}", c as u32));
384            }
385            c => out.push(c),
386        }
387    }
388    out
389}
390
391impl ReachReason {
392    /// The self-contained nudge body ("it reaches `X`, …") including the reason-appropriate remedy.
393    /// Callers add their own framing (block / please-confirm) and the docs link.
394    /// Whether naming this path in `~/.config/safe-chains.toml` actually changes the verdict.
395    ///
396    /// The refusal copy offers a grant, or explains that granting will not help, and the two must
397    /// not diverge: advice that does nothing costs more than silence, because the reader follows
398    /// it, sees no change, and stops believing the rest. `a_refusal_offers_a_grant_only_when_one_
399    /// would_work` runs the verdict twice — once with the grant applied — and holds this to it.
400    ///
401    /// `Credential` is `true` as of 2026-09-01 and was `false` before it. A grant naming a store
402    /// used to move the locus and leave `reads_secret` set, so the message's "name that path"
403    /// advice was FALSE while reading exactly right. That is the failure this pairing exists to
404    /// catch, and it went unnoticed because nothing compared the sentence to the behaviour.
405    pub fn grant_helps(self) -> bool {
406        match self {
407            // A grant that NAMES the store clears the shield for reading it.
408            ReachReason::Credential | ReachReason::RawDevice => true,
409            // "That IS my working directory" is the usual answer here.
410            ReachReason::ForeignTemp | ReachReason::OutsideWorkspace => true,
411            // Frozen faces stay frozen however specifically they are named: an agent that can edit
412            // the trust file decides what is approved next, and one that can write `/etc/sudoers`
413            // owns the machine's authorization substrate.
414            ReachReason::FrozenTrustFile | ReachReason::FrozenTrustRoot | ReachReason::FrozenSystemIntegrity => false,
415            // There is no path to grant. The remedy is to constrain the spelling.
416            ReachReason::Unconfined => false,
417        }
418    }
419
420    pub fn message(self, path: &str) -> String {
421        let path = &sanitize_display(path);
422        match self {
423            ReachReason::Credential => format!(
424                "it reaches `{path}`, a credential store. The agent has no ordinary reason to touch \
425                 one. If that was not intended, stop it. If you do want to allow it, name that path \
426                 in ~/.config/safe-chains.toml. A grant on a parent directory does not reach a \
427                 credential store"
428            ),
429            ReachReason::RawDevice => format!(
430                "it reaches `{path}`, a raw device. Reading one is not reading a file — a disk \
431                 device hands over every file on it and memory hands over every secret in it — and \
432                 writing one goes underneath the filesystem entirely. If you do want the read, \
433                 name that path in ~/.config/safe-chains.toml; the write stays refused"
434            ),
435            ReachReason::FrozenTrustFile => format!(
436                "it reaches `{path}`. safe-chains reads its own permissions from that file, so a \
437                 write there is never auto-approved. Granting the path does not change that, \
438                 because an agent that can edit this file can decide what gets approved next. Edit \
439                 it yourself if you meant to change it"
440            ),
441            ReachReason::FrozenTrustRoot => format!(
442                "it reaches `{path}`. safe-chains reads its own permissions from a file in that \
443                 directory, so removing or replacing the directory itself is never auto-approved: \
444                 doing that would point the trust root somewhere else. Writing files into it is \
445                 fine, and granting the path does not change either half. Move or delete it \
446                 yourself if you meant to"
447            ),
448            ReachReason::FrozenSystemIntegrity => format!(
449                "it reaches `{path}`. That file decides who may log in and what they may do, so a \
450                 write there is never auto-approved. Granting the path does not change that. Edit \
451                 it yourself if you meant to change it"
452            ),
453            ReachReason::ForeignTemp => format!(
454                "it runs code from `{path}`, a temporary directory that is not this session's \
455                 scratchpad. Reading and writing temp files is fine. Running code from there is \
456                 not, because a downloaded script lands in the same place. If this is a working \
457                 directory you trust, grant it in ~/.config/safe-chains.toml. A scratchpad the \
458                 harness reports for this session is recognized on its own and needs no grant"
459            ),
460            ReachReason::Unconfined => format!(
461                "the path `{path}` is built by an interpolation, so what it names depends on a \
462                 value the command does not show. It could be anywhere, which is why it cannot be \
463                 auto-approved. If the interpolated part cannot contain a `/`, put literal text \
464                 beside it in the same path component. `out/dx_$i.txt` is approved where `out/$i` \
465                 is not: the first is a filename whatever `$i` holds, and the second could be `..`"
466            ),
467            ReachReason::OutsideWorkspace => match pathctx::cwd().map(|c| sanitize_display(&c)) {
468                Some(cwd) => format!(
469                    "it reaches `{path}`, outside the working directory `{cwd}`. If the agent is \
470                     running from the wrong directory, relaunch it where you meant to be. To allow \
471                     it from here, grant that path in ~/.config/safe-chains.toml"
472                ),
473                None => format!(
474                    "it reaches `{path}`, outside the working directory. To allow it, grant that \
475                     path in ~/.config/safe-chains.toml"
476                ),
477            },
478        }
479    }
480}
481
482/// If a NOT-auto-approved command reaches a path OUTSIDE the workspace, return that path (its
483/// original spelling) and WHY, so the hook can nudge instead of silently prompting. Resolves against
484/// the ambient `cwd`/`root`: relative worktree paths, `/tmp`, and `/dev` streams are admitted and
485/// skipped; an absolute or home path that isn't admitted for read *or* write is the reach. A
486/// credential store outranks the hidden-peer wording; a hidden peer path outranks the generic
487/// outside-workspace reason.
488pub fn workspace_overreach(command: &str) -> Option<(String, ReachReason)> {
489    let tokens = operand_words(command)?;
490    tokens.into_iter().find_map(|t| {
491        if !policy::looks_like_path(&t) {
492            return None;
493        }
494        let resolved = pathctx::resolve(&t).into_owned();
495        // A temp path is READ/WRITE admitted, so the outside-test below never fires on it — but it
496        // is not EXECUTABLE unless it is this session's scratchpad. When the command was denied,
497        // that is the likely reason, and it is the one case where the fix is a grant rather than a
498        // correction, so surface it with those instructions.
499        if pathctx::under_temp_root(&resolved) && !pathctx::in_session_scratchpad(&resolved) {
500            return Some((t, ReachReason::ForeignTemp));
501        }
502        // The REBIND face is consulted too, or a granted trust-root directory denies in silence:
503        // the grant opens read and write, so `rm -rf ~/.config` looked ordinary here while the
504        // engine refused it. Only the trust-root directories can make this term true, since every
505        // other role's rebind face equals its write face.
506        let outside = (resolved.starts_with('/') || resolved.starts_with('~'))
507            && (!engine::resolve::read_content_verdict(&resolved).is_allowed()
508                || !engine::resolve::write_target_verdict(&resolved).is_allowed()
509                || engine::resolve::rebind_is_stricter_than_write(&resolved));
510        if !outside {
511            return None;
512        }
513        // Asked on the LITERAL structure, so an interpolated component cannot strip the credential
514        // warning off a path that plainly names one. `cat ~/.ssh/$(id)` was reported as merely
515        // "built by an interpolation" — offering to flank it, which can never help, while dropping
516        // the one sentence that matters — and the CONFINED spelling fell through to
517        // "outside the working directory", whose remedy is to GRANT the path.
518        //
519        // Granting a credential store IS possible now (a grant covers what it names), so the
520        // objection is no longer "that remedy cannot work". It is that the generic wording says
521        // "grant that path" while meaning the ordinary parent-directory grant, which is exactly
522        // the form a credential store does not accept. The Credential arm spells out the
523        // difference instead.
524        let reason = if engine::resolve::names_credential_store(&resolved) {
525            ReachReason::Credential
526        } else if let Some(kind) = engine::resolve::frozen_write_kind(&resolved) {
527            // Ahead of Unconfined and OutsideWorkspace for the same reason Credential is: both of
528            // those end in "grant that path", which for a frozen write face is FALSE rather than
529            // merely vague, and for safe-chains' own config it is circular as well.
530            match kind {
531                engine::resolve::FrozenWrite::TrustFile => ReachReason::FrozenTrustFile,
532                engine::resolve::FrozenWrite::TrustRootDir => ReachReason::FrozenTrustRoot,
533                engine::resolve::FrozenWrite::SystemIntegrity => ReachReason::FrozenSystemIntegrity,
534                engine::resolve::FrozenWrite::RawDevice => ReachReason::RawDevice,
535            }
536        } else if engine::resolve::anchoring_of(&resolved) == crate::engine::facet::Anchoring::Opaque {
537            // Ahead of OutsideWorkspace because it is the more specific diagnosis of the SAME
538            // refusal, and the generic wording actively misleads here: it names a working-directory
539            // problem the user does not have and a remedy (grant the path) that cannot work,
540            // since the path is not a fixed path at all.
541            ReachReason::Unconfined
542        } else {
543            ReachReason::OutsideWorkspace
544        };
545        Some((t, reason))
546    })
547}
548
549/// The words a command actually RUNS with, for explaining a denial.
550///
551/// This must agree with the parse the verdict came from, so it walks the CST. Splitting the raw
552/// string instead (`shell_words::split`) tokenizes text the shell never treats as an argument —
553/// above all a heredoc BODY, which is data. `git commit -m "$(cat <<'EOF' … EOF)"` whose message
554/// merely MENTIONS `/etc/hosts` was reported as "reaches /etc/hosts", naming a false reason for the
555/// denial and advising the reader to grant that path — a config widening the command never needed.
556///
557/// Falls back to the raw split only when the command does not parse, where a best-effort nudge on
558/// approximate tokens still beats none.
559fn operand_words(command: &str) -> Option<Vec<String>> {
560    let Some(script) = cst::parse(command) else {
561        return shell_words::split(command).ok();
562    };
563    let mut out = Vec::new();
564    collect_script_words(&script, &mut out);
565    Some(out)
566}
567
568/// A word contributes its own expansions AND the words of any command substitution inside it: the
569/// inner command runs, so `notacommand $(cat /etc/shadow)` really does read the file, even though
570/// `expand()` renders the substitution as an opaque stand-in and hides the path.
571fn collect_word(word: &cst::Word, out: &mut Vec<String>) {
572    out.extend(word.expand());
573    for part in &word.0 {
574        collect_part_subs(part, out);
575    }
576}
577
578/// The words of any command SUBSTITUTION inside a word part, and nothing else — the part's own
579/// literal text is the caller's business, because whether it counts as an operand depends on where
580/// the word came from (a heredoc body's literal text never does).
581fn collect_part_subs(part: &cst::WordPart, out: &mut Vec<String>) {
582    use cst::WordPart;
583    match part {
584        WordPart::CmdSub(script) | WordPart::ProcSub(script) => collect_script_words(script, out),
585        WordPart::DQuote(inner) => collect_word(inner, out),
586        // Arithmetic contributes no operand of its own — its value is a number — but a `$( )`
587        // inside it runs, and that command's words are operands the verdict layer classifies.
588        WordPart::Arith(inner) => collect_word(inner, out),
589        WordPart::Lit(_) | WordPart::Escape(_) | WordPart::SQuote(_) | WordPart::Backtick(_) => {}
590    }
591}
592
593fn collect_script_words(script: &cst::Script, out: &mut Vec<String>) {
594    for stmt in &script.0 {
595        for cmd in &stmt.pipeline.commands {
596            collect_cmd_words(cmd, out);
597        }
598    }
599}
600
601/// A redirect TARGET is a path the command opens, so it is a reach and must be reported —
602/// `notacommand > /etc/passwd` names `/etc/passwd`. A heredoc DELIMITER is not a path at all, and
603/// its body never appears in the CST, which is the whole point.
604fn collect_redir_words(redirs: &[cst::Redir], out: &mut Vec<String>) {
605    use cst::Redir;
606    for redir in redirs {
607        match redir {
608            Redir::Write { target, .. } | Redir::Read { target, .. } | Redir::ReadWrite { target, .. } | Redir::HereStr(target) => {
609                collect_word(target, out)
610            }
611            // Only the body's SUBSTITUTIONS, never its literal text. Behind a bare delimiter a
612            // `$(cat /etc/shadow)` in the body really runs, so it is a reach worth naming; the
613            // prose around it is data and naming it would state a false reason for the denial.
614            Redir::HereDoc { body, .. } => {
615                for part in &body.0 {
616                    collect_part_subs(part, out);
617                }
618            }
619            Redir::DupFd { .. } => {}
620        }
621    }
622}
623
624fn collect_cmd_words(cmd: &cst::Cmd, out: &mut Vec<String>) {
625    use cst::Cmd;
626    let words = |ws: &[cst::Word], out: &mut Vec<String>| {
627        for w in ws {
628            collect_word(w, out);
629        }
630    };
631    match cmd {
632        Cmd::Simple(s) => {
633            words(&s.words, out);
634            collect_redir_words(&s.redirs, out);
635        }
636        Cmd::Subshell { body, redirs } | Cmd::BraceGroup { body, redirs } => {
637            collect_script_words(body, out);
638            collect_redir_words(redirs, out);
639        }
640        Cmd::For { items, body, redirs, .. } => {
641            words(items, out);
642            collect_script_words(body, out);
643            collect_redir_words(redirs, out);
644        }
645        Cmd::While { cond, body, redirs } | Cmd::Until { cond, body, redirs } => {
646            collect_script_words(cond, out);
647            collect_script_words(body, out);
648            collect_redir_words(redirs, out);
649        }
650        Cmd::If { branches, else_body, redirs } => {
651            collect_redir_words(redirs, out);
652            for branch in branches {
653                collect_script_words(&branch.cond, out);
654                collect_script_words(&branch.body, out);
655            }
656            if let Some(body) = else_body {
657                collect_script_words(body, out);
658            }
659        }
660        Cmd::DoubleBracket { words: ws, redirs } => {
661            words(ws, out);
662            collect_redir_words(redirs, out);
663        }
664        Cmd::Case { subject, arms, redirs } => {
665            collect_word(subject, out);
666            for arm in arms {
667                collect_script_words(&arm.body, out);
668            }
669            collect_redir_words(redirs, out);
670        }
671        Cmd::FunctionDef { body, .. } => collect_script_words(body, out),
672    }
673}
674
675#[cfg(test)]
676mod tests;