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