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