candor_classify/policy.rs
1//! The canonical CANDOR_POLICY DSL parser (candor-spec SPEC §6.2).
2//!
3//! This is the **single** Rust implementation of the policy grammar — shared by the nightly dylint
4//! gate (`src/lib.rs`, AS-EFF-006/008/009) and the stable `candor-query` (`whatif`, and the
5//! `parsepolicy` dump the cross-impl conformance suite diffs against the JVM engine). Keeping one
6//! parser here is what makes "the gate means the same thing in every language" a fact rather than a
7//! hope: the Rust gate, the Rust pre-edit tool, and the cross-impl differential all read THIS code.
8//!
9//! Pure, stable Rust (string parsing only — no rustc types), so it lives beside the classifier.
10
11use crate::cap_from_name;
12use std::collections::{BTreeMap, BTreeSet};
13
14/// The honesty marker (SPEC §4). Denyable so `deny Unknown <scope>` forbids the *unverifiable* case.
15pub const UNKNOWN: &str = "Unknown";
16
17/// SPEC §4 ⟨0.7⟩'s CLOSED FIVE-KIND `unknownWhy` VOCABULARY, as a TABLE — and the single place this
18/// engine SPELLS a reason, not merely the single place it reads one.
19///
20/// SOUNDNESS R490. `ReasonClass::classify` below has carried the note "THIS IS THE ONLY PLACE THIS
21/// ENGINE HOLDS SPEC §4's KIND VOCABULARY" since ⟨0.24⟩, and it was true of the READER and false of the
22/// WRITERS: the nightly dylint lint at the repo root is a SECOND PRODUCER publishing into
23/// `.candor/baseline.candor.Cdylib.json`, and it had drifted in three kinds (`generic-iter:`,
24/// `iter-combinator:`, `deref:`) and two details. That is the hazard `classify`'s own comment describes,
25/// one repo over and in the direction it was not looking.
26///
27/// SO THIS TABLE IS WHAT BOTH HALVES READ. `classify` matches on `Kind::token()` rather than on its own
28/// copy of the five strings, so adding, renaming or removing a kind moves the classifier and the
29/// producers in the same edit — the JVM engine's failure (a correct `classify` beside a typed `Kind`
30/// enum missing `ambiguous`, one token with two answers inside one engine) is not reachable from here.
31///
32/// It is NOT a closed set for PARSING. §2 forward-compatibility lets a producer emit a kind this
33/// version has never heard of, and `classify`'s catch-all is what keeps such a kind inside
34/// `Unknown[*]` / `Unknown[dynamic]`. This type constrains what THIS ENGINE WRITES.
35#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
36pub enum Kind {
37 /// invocation chosen at runtime by name/metadata — reflection, `Method.invoke`, `eval`
38 Reflect,
39 /// a boundary to code the engine cannot analyse — native methods, FFI/`extern`, intrinsics
40 Native,
41 /// an unresolved virtual / interface / protocol dispatch with a resolvable owner type + member
42 Dispatch,
43 /// an unresolved higher-order / owner-less invocation over a function/closure VALUE — §4 names the
44 /// shapes: param, field, bound, computed, opaque-iterable
45 Callback,
46 /// ⟨0.24⟩ the analyser's OWN name resolution was ambiguous — two or more separately-written
47 /// definitions competing for one name, so no owner could be formed at all
48 Ambiguous,
49}
50
51impl Kind {
52 /// The §4 `kind` token — the part before the first `:`, and the part every gate reads.
53 pub fn token(self) -> &'static str {
54 match self {
55 Kind::Reflect => "reflect",
56 Kind::Native => "native",
57 Kind::Dispatch => "dispatch",
58 Kind::Callback => "callback",
59 Kind::Ambiguous => "ambiguous",
60 }
61 }
62
63 /// The five, in a form a census can iterate. `classify` and the source-hygiene census both read
64 /// THIS, so neither can hold its own list.
65 pub const ALL: [Kind; 5] = [Kind::Reflect, Kind::Native, Kind::Dispatch, Kind::Callback, Kind::Ambiguous];
66
67 /// SPEC §6.2's projection of this kind onto a policy CLASS. `ambiguous` projects to `dispatch`:
68 /// §6.2's table has named `ambiguous*` since ⟨0.19⟩, and reclassifying it to `indirect` was measured
69 /// to take `deny E Unknown[dispatch]` from 58 of 200 crates to 0 of 200.
70 pub fn class(self) -> ReasonClass {
71 match self {
72 Kind::Reflect => ReasonClass::Reflect,
73 Kind::Native => ReasonClass::Native,
74 Kind::Dispatch | Kind::Ambiguous => ReasonClass::Dispatch,
75 Kind::Callback => ReasonClass::Indirect,
76 }
77 }
78
79 /// Spell a §4 reason: `kind:detail`. The detail is best-effort for every kind EXCEPT `dispatch:`
80 /// with an owner — use [`Kind::dispatch_on`] there, which is the normative shape.
81 ///
82 /// ⟨0.24⟩ A DOT-FREE `dispatch:` detail is not a defect: it is the RESERVED form for "no owner could
83 /// be formed at all", free text, explicitly not conformance-compared. That is why this constructor
84 /// accepts one rather than forcing every caller through `dispatch_on`.
85 pub fn reason(self, detail: &str) -> String {
86 format!("{}:{}", self.token(), detail)
87 }
88
89 /// `dispatch:<owner-type>.<member>` — §4's ONE normative detail, and the shape §3.1's dispatch
90 /// frontier parses (`possibleViaUnknownDispatch` keys on the dot). The owner is passed as the type's
91 /// own name, never as a language path: `Store.put`, not `p::Store::put`.
92 pub fn dispatch_on(owner: &str, member: &str) -> String {
93 format!("{}:{owner}.{member}", Kind::Dispatch.token())
94 }
95}
96
97/// The NORMATIVE projection of a raw `unknown_why` reason onto a fixed, cross-engine reason CLASS
98/// (candor-spec REASON-SCOPED-UNKNOWN-DESIGN.md §1). Reason-scoped policies (`deny E Unknown[class]`)
99/// quantify over these classes, so the mapping MUST be identical in every engine — this mirrors the
100/// java reference `ReasonClass` (its `classify(String)` path, since rust emits raw string reasons). The
101/// class set is CLOSED (six members); a raw reason matching no pinned prefix maps to `Unresolved` —
102/// conservative: it stays in scope of any `Unknown[*]` / `Unknown[dynamic]` policy, never silently
103/// tolerated.
104#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
105pub enum ReasonClass {
106 /// reflection / metaprogramming
107 Reflect,
108 /// unresolved virtual/dynamic dispatch, same-name ambiguity, invokedynamic
109 Dispatch,
110 /// callback / closure / function-value / async-continuation indirection
111 Indirect,
112 /// FFI / native boundary
113 Native,
114 /// generic unresolvable call/import, AND the catch-all for any unrecognized raw reason
115 Unresolved,
116 /// analysis not wired up (fixable, not a real dynamic hole): missing-config / no-tsconfig
117 Setup,
118}
119
120impl ReasonClass {
121 /// The lowercase policy-facing token (`deny E Unknown[<token>]`).
122 pub fn token(self) -> &'static str {
123 match self {
124 ReasonClass::Reflect => "reflect",
125 ReasonClass::Dispatch => "dispatch",
126 ReasonClass::Indirect => "indirect",
127 ReasonClass::Native => "native",
128 ReasonClass::Unresolved => "unresolved",
129 ReasonClass::Setup => "setup",
130 }
131 }
132
133 /// Parse a policy-facing token back to a class; `None` if it names no class.
134 pub fn from_token(t: &str) -> Option<ReasonClass> {
135 Some(match t {
136 "reflect" => ReasonClass::Reflect,
137 "dispatch" => ReasonClass::Dispatch,
138 "indirect" => ReasonClass::Indirect,
139 "native" => ReasonClass::Native,
140 "unresolved" => ReasonClass::Unresolved,
141 "setup" => ReasonClass::Setup,
142 _ => return None,
143 })
144 }
145
146 /// Map a raw `unknown_why` reason to its normative class — prefix-based (raw reasons carry a
147 /// `kind:detail` shape, e.g. `dispatch:foo::Bar`), unrecognized → `Unresolved`. Byte-identical
148 /// intent to the java `ReasonClass.classify(String)`.
149 ///
150 /// ⟨0.24⟩ THIS IS THE ONLY PLACE THIS ENGINE HOLDS SPEC §4's KIND VOCABULARY. Every other reference
151 /// to a kind is either a raw string being emitted or the `dispatch:` prefix test in candor-query's
152 /// dispatch frontier; there is no typed kind enum here. §4's "AN ENGINE HOLDS THIS VOCABULARY TWICE,
153 /// AND THE HALVES DRIFT" paragraph records the JVM engine classifying `ambiguous` correctly HERE
154 /// while its typed `Kind` enum lacked the kind entirely — one token, two answers, inside one engine,
155 /// concealed precisely because this half was right. Holding it once is why that is not reachable in
156 /// this engine; a future typed representation must be added at the same commit as its control
157 /// (`off_vocabulary_kinds_round_trip_and_classify_through_the_catch_all`).
158 ///
159 /// The five §4 kinds are `reflect`/`native`/`dispatch`/`callback`/`ambiguous`. `ambiguous` maps to
160 /// `dispatch` and rust is its only PRODUCER; `indy`/`task-handoff` are candor-java's migration kinds
161 /// and `dep:`/`dep-stale:` are swift's registered per-dependency-ENTRY kinds, reaching `Unresolved`
162 /// through the catch-all, which is the class §6.2 prescribes for them.
163 ///
164 /// ⟨0.35⟩ **AND THIS ENGINE PRODUCES A SIXTH SPELLING OF ITS OWN, `macro:`, WHICH THE PARAGRAPH
165 /// ABOVE DID NOT NAME UNTIL SOUNDNESS R270.** It is off-vocabulary as a §4 kind — legal under §2
166 /// forward-compatibility, round-tripped verbatim, and reaching `Unresolved` through the catch-all
167 /// below, deliberately: it marks the ZERO-READABLE-DEFS case (a macro this engine declined to
168 /// expand), which is "a limit of its own resolution rather than an ambiguity in the program" in
169 /// §4 ⟨0.25⟩'s words, and `dispatch` is the wrong class for that. Four sites emit it, and they are
170 /// listed here rather than left to a grep because the whole hazard this doc comment exists for is a
171 /// vocabulary held in one place going stale while the code moves:
172 ///
173 /// * `collector.rs` `macro:unexpanded multi-arm macro_rules! <name>` (R257)
174 /// * `collector.rs` `macro:unreadable macro_rules! template <name>` (R257)
175 /// * `collector.rs` `macro:re-export key a macro-hidden module could also own` (R270)
176 /// * `scan.rs` `macro:module items hidden by an unexpanded macro` (R270, R128's site)
177 ///
178 /// R257 minted the spelling at exactly the two lines it was reported for and this comment kept
179 /// asserting the file held the vocabulary once; R270 is the sweep, and the census that justified it
180 /// enumerates every `ambiguous:`-emitting site rather than the ones in hand. The six that REMAIN
181 /// `ambiguous:` are each genuinely two-separately-written-definitions — including
182 /// `ambiguous:same-name macro_rules! definitions`, which a sweep keyed on the WORD "macro" would
183 /// have re-kinded wrongly and cost 15 crates their `deny Unknown[dispatch]` gate. The kind is
184 /// decided by the CONDITION (two readable defs vs none), never by the name.
185 ///
186 /// A dedicated §4 kind for this state is a SPEC clause plus a conformance PART before any engine
187 /// emits it, and candor-rust does not own that file — filed, not invented here (SOUNDNESS R489).
188 /// And the choice is not free: NONE of the five canonical kinds projects to `unresolved`, so mapping
189 /// `macro:` onto any of them MOVES its class. R270 priced that in both directions and it is the
190 /// measurement that keeps the kind where it is.
191 ///
192 /// ⟨R490⟩ **AND THE PARAGRAPH ABOVE WAS STILL COUNTING ONLY THE SPELLINGS IN THIS CRATE.** The
193 /// nightly dylint lint at the repo root is a SECOND PRODUCER, and it held three more kinds outside
194 /// §4's five (`generic-iter:`, `iter-combinator:`, `deref:`) plus two `dispatch:` details spelled as
195 /// rust PATHS. It now builds every reason through `Kind` above, and
196 /// `candor-scan/tests/source_hygiene.rs` asserts it spells none of its own.
197 pub fn classify(why: &str) -> ReasonClass {
198 let w = why.trim().to_ascii_lowercase();
199 // THE FIVE §4 KINDS COME FROM `Kind::ALL`, NOT FROM A SECOND COPY OF THE FIVE STRINGS
200 // (SOUNDNESS R490). Every other arm below is an ALIAS this engine accepts from a sibling
201 // producer — swift's `closure`/`dynamicmemberlookup`, java's `indy`/`task-handoff` migration
202 // kinds, ts's `missing-config`/`no-tsconfig`/`no-node_modules` setup kinds — and each is
203 // deliberately spelled here and nowhere else, because they are things this engine READS and
204 // never WRITES. The canonical five are checked FIRST so an alias can never shadow one.
205 if let Some(k) = Kind::ALL.into_iter().find(|k| w.starts_with(k.token())) {
206 return k.class();
207 }
208 // SOUNDNESS R1218 — A PREFIX, LIKE EVERY OTHER ARM. This was `w == "dynamicmemberlookup"`, an
209 // EQUALITY test, and swift does not emit the bare word: it emits `dynamicMemberLookup:<Root>.<prop>`.
210 // §6.2's table lists "raw `unknownWhy` PREFIXES", so the real token fell through to the catch-all
211 // and a reflect hole was gated as `unresolved`. MEASURED with this engine's `gate --report` over
212 // candor-swift's own report of a `@dynamicMemberLookup` read: `deny Unknown[reflect]` exit 0
213 // (swift's own gate: 1) and `deny Unknown[unresolved]` exit 1 (swift: 0).
214 if w.starts_with("dynamicmemberlookup") {
215 ReasonClass::Reflect
216 } else if w.starts_with("closure") || w.starts_with("task-handoff") {
217 ReasonClass::Indirect
218 } else if w.starts_with("indy") {
219 ReasonClass::Dispatch
220 } else if w.starts_with("missing-config") || w.starts_with("no-tsconfig") || w.starts_with("no-node_modules") {
221 ReasonClass::Setup
222 } else {
223 ReasonClass::Unresolved
224 }
225 }
226
227 /// The `dynamic` alias — every GENUINE blind-spot class (excludes `setup`), incl. `unresolved` (the
228 /// catch-all) so `Unknown[dynamic]` never under-gates. The design's recommended usable strict gate.
229 pub fn dynamic_set() -> BTreeSet<ReasonClass> {
230 [
231 ReasonClass::Reflect,
232 ReasonClass::Dispatch,
233 ReasonClass::Indirect,
234 ReasonClass::Native,
235 ReasonClass::Unresolved,
236 ]
237 .into_iter()
238 .collect()
239 }
240}
241
242/// SPEC §6.2 ⟨0.24⟩ — does a function's TRANSITIVE reason-class set intersect `want` (class tokens)?
243///
244/// THE `None`/EMPTY ARM IS THE FAIL-CLOSED NET, and it is why this lives here rather than being
245/// open-coded twice. §6.2: "a function whose `Unknown` carries no recorded reason CONTRIBUTES
246/// `unresolved` to its class set — so a narrowed filter never *silently* tolerates a hole it failed to
247/// classify." Read the other way round, `!contains ⇒ exclude` over an empty set drops the entry from
248/// EVERY filter including one naming its own class: a silent under-report wearing a filter.
249///
250/// `classes` is the ACCUMULATED (post-`propagate_str`) set, never the direct `unknownWhy`: a reason
251/// names a site in the function's OWN body (§4), so a function whose `Unknown` is purely inherited
252/// carries none, and matching against the direct field answers a different question. SHARED by the
253/// `deny E Unknown[class]` gate (candor-scan) and `unverified --class` (candor-query) so a gate and the
254/// disclosure explaining it cannot disagree about which holes a class names.
255///
256/// The empty arm is a NET, not a route: it keys on the ABSENCE of a class set, so any other reason on
257/// the same function hides whatever it was covering. The reasonless case that CAN co-occur with a
258/// reason — a direct `Unknown` the unit did not name — must therefore contribute `unresolved` into the
259/// DIRECT map before propagation (candor-scan's `unknown_via_dep`, candor-query's report-side signature),
260/// not arrive here by absence.
261pub fn reason_class_matches(classes: Option<&BTreeSet<String>>, want: &BTreeSet<&str>) -> bool {
262 match classes {
263 None => want.contains(ReasonClass::Unresolved.token()),
264 Some(cs) if cs.is_empty() => want.contains(ReasonClass::Unresolved.token()),
265 Some(cs) => cs.iter().any(|t| want.contains(t.as_str())),
266 }
267}
268
269/// Parse `unknown-alias <name> = <class,…>` lines from `.candor/config` text (⟨0.19⟩, SPEC §6.2) into a
270/// name→classes map. A name that shadows a built-in (`*`/`dynamic`/a class token) is warned-and-skipped (a
271/// config alias may not redefine a built-in), as is a definition naming no valid class. Byte-shape with the
272/// java reference `Config.addAlias`.
273pub fn parse_unknown_aliases(config_text: &str) -> std::collections::BTreeMap<String, BTreeSet<ReasonClass>> {
274 let mut out = std::collections::BTreeMap::new();
275 for raw in config_text.lines() {
276 let line = raw.split('#').next().unwrap_or("").trim();
277 if line.is_empty() {
278 continue;
279 }
280 let mut it = line.splitn(2, char::is_whitespace);
281 // Case-INSENSITIVE key match, like the config loaders in java/ts/swift (which lowercase the key) —
282 // a case-sensitive match here made `Unknown-Alias …` define an alias everywhere BUT rust (a four-way
283 // parse divergence; caught in review). The rest of the line (name + classes) stays case-sensitive.
284 if !it.next().is_some_and(|k| k.eq_ignore_ascii_case("unknown-alias")) {
285 continue;
286 }
287 let val = it.next().unwrap_or("").trim();
288 let Some((name, classes)) = val.split_once('=') else {
289 eprintln!("candor: ignoring `unknown-alias` (want `unknown-alias <name> = <class,…>`): {val}");
290 continue;
291 };
292 let name = name.trim();
293 if name.is_empty() || name == "*" || name == "dynamic" || ReasonClass::from_token(name).is_some() {
294 eprintln!("candor: ignoring `unknown-alias` with reserved/empty name `{name}` (may not shadow `*`/`dynamic`/a class token)");
295 continue;
296 }
297 let mut set = BTreeSet::new();
298 let mut bad: Vec<&str> = Vec::new();
299 for cn in classes.split(',') {
300 let cn = cn.trim();
301 if cn.is_empty() {
302 continue;
303 }
304 if cn == "dynamic" {
305 set.extend(ReasonClass::dynamic_set());
306 } else if let Some(rc) = ReasonClass::from_token(cn) {
307 set.insert(rc);
308 } else {
309 bad.push(cn);
310 }
311 }
312 // ⟨0.24⟩ **AN UNRECOGNISED TOKEN REFUSES THE WHOLE DEFINITION** — SPEC §6.2 `be0b9a9`: the rule
313 // binds every policy value list, and *"the second is the sharper one: the typo is in the
314 // vocabulary the policy is written against rather than in the policy itself, and it fails open
315 // identically."*
316 //
317 // MEASURED: `unknown-alias corp = dispatch,nativ` → the DEFINITION silently became `{dispatch}`,
318 // so `deny Unknown[corp]` exited 0 over a native-caused hole that `= dispatch,native` catches.
319 // The alias resolved, `used_aliases` recorded it, the verdict named the config — every disclosure
320 // fired correctly ABOUT A DEFINITION THAT WAS NOT THE ONE ON DISK.
321 //
322 // REFUSING THE DEFINITION rather than minting a new error channel is what makes this fit: an
323 // alias that does not exist is one the policy's own `Unknown[<name>]` cannot resolve, so it lands
324 // on the `errors` path already there and the gate routes refuse with exit 2 — naming the token
325 // AND the accepted set, as §6.2 requires. It also keeps the blast radius honest: a config
326 // defining ten aliases, one of them typo'd and NONE of them mentioned by this policy, changed
327 // nothing, and turning that into a red gate would be the mirror over-reach. The refusal is
328 // triggered by USE, exactly like `used_aliases` (recorded at the point of use, for the same
329 // reason).
330 if !bad.is_empty() {
331 eprintln!(
332 "candor: REFUSING `unknown-alias {name}` — it names unrecognised reason-class(es) `{}` \
333 (accepted: reflect, dispatch, indirect, native, unresolved, setup, plus `dynamic`). The \
334 definition is refused WHOLE rather than narrowed to the tokens that parsed: keeping the \
335 rest would silently redefine `{name}` as something narrower than the config says, and a \
336 policy using it would gate less than it reads. `{name}` is now undefined, so a policy \
337 naming it is a policy error (exit 2).",
338 bad.join("`, `")
339 );
340 } else if set.is_empty() {
341 eprintln!("candor: ignoring `unknown-alias {name}` — no valid reason-class");
342 } else {
343 out.insert(name.to_string(), set);
344 }
345 }
346 out
347}
348
349/// ⟨0.20⟩ Parse `net-partner <host>` lines from `.candor/config` (NET-DESTINATION-CLASS-DESIGN.md): the
350/// per-project set of business-partner hosts the `Net` destination-class classifier treats as
351/// `known-partner`. Multi-value (repeatable key); the value is host-normalized (`:port` stripped,
352/// lowercased) like `MODEL_HOSTS`. Case-insensitive key match, mirroring `parse_unknown_aliases` + the
353/// java/ts/swift config loaders. A partner is per-project — never a universal list.
354pub fn parse_net_partners(config_text: &str) -> BTreeSet<String> {
355 let mut out = BTreeSet::new();
356 for raw in config_text.lines() {
357 let line = raw.split('#').next().unwrap_or("").trim();
358 if line.is_empty() {
359 continue;
360 }
361 let mut it = line.splitn(2, char::is_whitespace);
362 if !it.next().is_some_and(|k| k.eq_ignore_ascii_case("net-partner")) {
363 continue;
364 }
365 let val = it.next().unwrap_or("").trim();
366 if val.is_empty() {
367 continue;
368 }
369 // ⟨0.29⟩ A MALFORMED VALUE IS DISCLOSED, NOT SILENTLY KEPT AS JUNK. The grammar is
370 // `net-partner <host>`; the `=` spelling an operator reaches for by habit
371 // (`net-partner = partner.example`) parsed as the HOST `"= partner.example"`, which entered the
372 // set and matched nothing for the rest of the run. The direction is SAFE — the gate stays armed,
373 // so nothing is certified that should not be — which is precisely why it sat unnoticed: the
374 // operator believes a partner is declared, the verdict disagrees, and no line connects the two.
375 // ⟨0.28⟩ gave POLICY files an `ignored` block for exactly this; config files had none.
376 if val.contains(char::is_whitespace) || val.starts_with('=') {
377 eprintln!(
378 "candor: net-partner takes a bare host — `net-partner <host>`, one per line; \
379 '{val}' is not one and was IGNORED (an '=' or extra words is the usual cause) — {}",
380 raw.trim()
381 );
382 continue;
383 }
384 out.insert(host_part(val).to_ascii_lowercase());
385 }
386 out
387}
388
389/// Discover `.candor/config` text for a policy/scan anchored at `start`: `$CANDOR_CONFIG` if set + readable,
390/// else the nearest `.candor/config` walking UP from `start`, else `None`. Read-only + lenient (no
391/// process-exit — the caller decides fail-closed); used to resolve `unknown-alias` for the §6.2 gate +
392/// `parsepolicy` so both reflect the same checked-in config.
393pub fn discover_config_text(start: &std::path::Path) -> Option<String> {
394 discover_config(start).map(|(_, t)| t)
395}
396
397/// THE RUNNING BINARY'S REFUSAL WRITER, registered by whichever entry armed a sink.
398///
399/// (These paragraphs once sat ABOVE this static while documenting `discover_config`, which is below it —
400/// so rustdoc rendered that function's path/canonicalization rationale as a description of this hook.
401/// They now live on the item they describe: a doc block belongs to the next item, and separating it with
402/// a blank line is not a fix — clippy's `empty_line_after_doc_comments` rejects that, and CI said so.)
403///
404/// [`discover_config`] is SHARED and sits BELOW every gate sink, so its `exit(2)` for an unreadable
405/// config could not write the refusal document `--gate-json` was promised. Measured: on the `gate`
406/// verb route an unreadable `CANDOR_CONFIG` exited 2 with an EMPTY stream in candor-scan and
407/// candor-ts while candor-java and candor-swift wrote the refusal. The FILE sink was covered — the
408/// armed placeholder survives an exit that writes nothing — so only the stream, which cannot be
409/// pre-armed, was exposed.
410///
411/// NOT registered at startup: `set_refusal_sink` is called by the gate entries that arm a sink, so a
412/// process that never arms one still exits 2 plainly. The comment inside `discover_config` already
413/// records this cause being fixed once, for the EXIT
414/// CODE: the scan route refused and the query route did not. That fix stopped at the exit code and
415/// left the machine channel, which is exactly the split conformance PART 35 and PART 36 exist to
416/// keep apart. A hook rather than a Result because every caller of this function wants the same
417/// answer — refuse through whatever sink this process armed — and threading a new error type through
418/// all of them would create the second copy of a rule that this project keeps getting bitten by.
419static REFUSAL_SINK: std::sync::OnceLock<fn(&str) -> !> = std::sync::OnceLock::new();
420
421/// Register the process's refusal writer. Idempotent; the first registration wins.
422pub fn set_refusal_sink(f: fn(&str) -> !) {
423 let _ = REFUSAL_SINK.set(f);
424}
425
426/// Exit 2 through the registered sink when there is one, and plainly when there is not — a library
427/// consumer that never armed a sink must still get the documented exit code.
428fn refuse_unevaluable(reason: &str) -> ! {
429 if let Some(f) = REFUSAL_SINK.get() {
430 f(reason)
431 }
432 std::process::exit(2)
433}
434
435/// ⟨0.24⟩ As [`discover_config_text`], but ALSO the PATH the text came from, canonicalized.
436///
437/// **WHY THE PATH IS NOW LOAD-BEARING** (SPEC §3.1): a `.candor/config` supplying `unknown-alias`
438/// vocabulary can move a verdict 0→1, and discovery walks PARENT DIRECTORIES, so a file anywhere above
439/// the policy participates — ambient, and until now invisible in the output. *"A verdict changed by a
440/// file the operator cannot see named in the output is the ambient-input failure this whole format
441/// exists to refuse; the remedy is the same one used everywhere else here — not to forbid the input, but
442/// to make it impossible for it to act unnamed."* So the gate document NAMES it, and the path has to
443/// travel out of discovery for that to be possible.
444///
445/// CANONICALIZED because the two routes reach the same file from different working directories, and
446/// §3.1's byte-equality MUST is about the DOCUMENT: a relative path would differ between them for no
447/// reason other than where each was invoked.
448pub fn discover_config(start: &std::path::Path) -> Option<(std::path::PathBuf, String)> {
449 let canon = |p: &std::path::Path| std::fs::canonicalize(p).unwrap_or_else(|_| p.to_path_buf());
450 // CONFIGURED-BUT-UNUSABLE FAILS LOUD, ON THIS ROUTE TOO. `.ok()` turned an unreadable config into
451 // "no config", so the run continued WITHOUT whatever it declared — a policy, a baseline, an engine
452 // pin, an `unknown-alias` vocabulary. The SCAN route already refuses; this QUERY route did not, so
453 // `gate --report R --policy P` with a broken CANDOR_CONFIG exited 1 here and 2 in java and ts on the
454 // same input. §3.4's posture does not vary by verb.
455 if let Ok(p) = std::env::var("CANDOR_CONFIG") {
456 let p = std::path::PathBuf::from(p);
457 match std::fs::read_to_string(&p) {
458 Ok(t) => return Some((canon(&p), t)),
459 Err(e) => {
460 eprintln!("candor: CANDOR_CONFIG set but {} could not be read ({e}) — failing (exit 2,", p.display());
461 eprintln!(" unevaluable). A config that cannot be read is a guard the operator believes is on.");
462 refuse_unevaluable(&format!("CANDOR_CONFIG set but {} could not be read ({e})", p.display()));
463 }
464 }
465 }
466 let start = canon(start);
467 let mut cur = if start.is_dir() { Some(start.as_path()) } else { start.parent() };
468 while let Some(d) = cur {
469 let cand = d.join(".candor/config");
470 if cand.is_file() {
471 match std::fs::read_to_string(&cand) {
472 Ok(t) => return Some((canon(&cand), t)),
473 Err(e) => {
474 eprintln!("candor: {} exists but could not be read ({e}) — failing (exit 2,", cand.display());
475 eprintln!(" unevaluable). Treating it as absent would run without what it declares.");
476 refuse_unevaluable(&format!("{} exists but could not be read ({e})", cand.display()));
477 }
478 }
479 }
480 cur = d.parent();
481 }
482 None
483}
484
485/// One `deny <Effect…> [scope]` / `pure <scope>` rule (AS-EFF-006). `effects` empty ⇒ a `pure` rule
486/// (ANY effect forbidden). `scope` is a path segment-scope the rule applies to (None = whole unit).
487#[derive(Debug, Clone)]
488pub struct PolicyRule {
489 pub effects: BTreeSet<&'static str>,
490 pub scope: Option<String>,
491 /// Reason-class filter on an `Unknown` membership (REASON-SCOPED-UNKNOWN-DESIGN.md): empty ⇒
492 /// `Unknown[*]` (any reason — the bare form); non-empty ⇒ the Unknown hit fires ONLY for a fn whose
493 /// (transitive) reason classes include one of these. Ignored when `effects` doesn't contain `Unknown`.
494 pub unknown_classes: BTreeSet<ReasonClass>,
495 /// Destination-class filter on a `Net` membership (NET-DESTINATION-CLASS-DESIGN.md): empty ⇒ `Net[*]`
496 /// (any destination — the bare form); non-empty ⇒ the Net hit fires ONLY for a fn whose (transitive)
497 /// destination classes include one of these. Ignored when `effects` doesn't contain `Net`.
498 pub net_classes: BTreeSet<String>,
499 pub raw: String,
500}
501
502/// ⟨0.33⟩ ONE `deny`/`pure` RULE IN ITS CANONICAL EXPANDED FORM — the §6.2 spelling of the rule as THE
503/// MATCHER USED it, after alias resolution (`unknown_classes` is already the resolved token set, not the
504/// raw `Unknown[<alias>]` text).
505///
506/// This is what SPEC §2 ⟨0.33⟩'s `scannedUnder.deny` records: the deny set a policy-scanned peek was
507/// BOUNDED BY, so a consumer gating with a different deny set can tell whether the producer was even
508/// asked its question (candor-java's `Policy.canonicalDenyRule` is the reference sibling — this is the
509/// same rendering, ported).
510///
511/// **NOT effect NAMES.** `pure` is a rule with an EMPTY effect set ("every effect except `Unknown`"), so
512/// flattening the rule to a set of names loses it entirely and a flattened STRICTEST policy compares
513/// equal to the EMPTY set — the four-way false all-clear ⟨0.30⟩ closed on the peek itself, one layer in.
514///
515/// **NOT the raw line.** §3.1 already records that alias expansion breaks byte-equality: two configs
516/// defining `unknown-alias corp` DIFFERENTLY give the raw line `deny Unknown[corp]` two meanings, so
517/// comparing raw text would read a producer that asked the WEAKER question as having answered the
518/// stronger one. Recording the EXPANDED, resolved form is the only rendering that is one meaning per
519/// string.
520pub fn canonical_deny_rule(r: &PolicyRule) -> String {
521 let suffix = r.scope.as_deref().map(|s| format!(" {s}")).unwrap_or_default();
522 if r.effects.is_empty() {
523 return format!("pure{suffix}");
524 }
525 // `effects` is a `BTreeSet<&'static str>`, so this iterates in one fixed (alphabetical) order for
526 // any given set — deterministic across calls and across which order the policy TEXT listed them in,
527 // which is what lets `canonical_deny_set` below produce ONE string per rule regardless of how the
528 // operator wrote it.
529 let parts: Vec<String> = r
530 .effects
531 .iter()
532 .map(|&e| {
533 if e == "Unknown" && !r.unknown_classes.is_empty() {
534 let mut toks: Vec<&str> = r.unknown_classes.iter().map(|c| c.token()).collect();
535 toks.sort_unstable();
536 format!("Unknown[{}]", toks.join(","))
537 } else if e == "Net" && !r.net_classes.is_empty() {
538 // `net_classes` is a `BTreeSet<String>`, already code-point sorted.
539 format!("Net[{}]", r.net_classes.iter().cloned().collect::<Vec<_>>().join(","))
540 } else {
541 e.to_string()
542 }
543 })
544 .collect();
545 format!("deny {}{suffix}", parts.join(" "))
546}
547
548/// ⟨0.33⟩ A rule LIST as a canonical SET — [`canonical_deny_rule`] over every entry, deduplicated and
549/// code-point sorted (`BTreeSet<String>`'s own order, the same collation the verdict's `zeroMatch` list
550/// uses), so one policy produces ONE document however its lines were ordered and a consumer's SUBSET
551/// test (SPEC §2 ⟨0.33⟩) is a plain membership test rather than an order-sensitive comparison.
552pub fn canonical_deny_set(rules: &[PolicyRule]) -> Vec<String> {
553 rules.iter().map(canonical_deny_rule).collect::<BTreeSet<String>>().into_iter().collect()
554}
555
556/// One `allow <Effect> [in <scope>] <literal>…` rule (AS-EFF-008). The effect is one of the four
557/// that carry a literal surface (`Net` hosts / `Exec` commands / `Fs` paths / `Db` tables); a
558/// function in `scope` performing it may reach ONLY the listed literals. Matching is
559/// effect-specific (`literal_allowed`).
560#[derive(Debug, Clone)]
561pub struct AllowRule {
562 pub effect: &'static str,
563 pub scope: Option<String>,
564 pub literals: BTreeSet<String>,
565 pub raw: String,
566}
567
568/// One `forbid <A> -> <B>` module-layering rule (AS-EFF-009): a function in scope `A` must not
569/// transitively call into scope `B`.
570#[derive(Debug, Clone)]
571pub struct LayerRule {
572 pub from: String,
573 pub to: String,
574 pub raw: String,
575}
576
577/// ⟨0.29⟩ One `only <A> -> <B> [<C> …]` PERMISSION rule (AS-EFF-011): a function in scope `A` may reach
578/// `A` itself and the listed scopes, and NOTHING else.
579///
580/// **`forbid` FAILS OPEN; `only` FAILS SAFE, and that is the whole reason the form exists.** A dependency
581/// you forgot to prohibit is silently permitted, so "this package is a leaf" can only be spelled by
582/// enumerating what it must not reach — a list that does not cover a package added later, and nothing says
583/// so. That is the allowlist hazard this project refuses everywhere in the analysis, living in the POLICY
584/// LANGUAGE instead. Under `only`, a dependency you forgot to permit is a loud violation.
585///
586/// Found by pointing candor's own architecture gate at candor: the natural
587/// `forbid io.poly.candor.model -> io.poly.candor` SELF-FIRES at 58 violations, because a scope matches a
588/// contiguous run of segments and `model` sits under the very prefix it is trying to protect itself from.
589///
590/// THE WALK STOPS AT A PERMITTED SCOPE, and that is a semantic decision rather than an optimisation: a
591/// permitted callee's own dependencies are governed by the rules about IT, not by this one. Descending
592/// past it would make `only` require the transitive closure of everything you permit — which is the
593/// enumeration-that-rots this form exists to replace, one level down.
594#[derive(Debug, Clone)]
595pub struct OnlyRule {
596 /// The scope being constrained. It may always reach ITSELF: an explicit `A -> A` would be noise, and
597 /// without the implicit permission the form is unusable for exactly the case it exists for.
598 pub from: String,
599 /// The scopes `from` may reach. At least one — `only A ->` with nothing after the arrow is DROPPED as
600 /// malformed rather than read as "A may reach nothing at all", which is a different rule (and one a
601 /// reader is far more likely to have typed by accident than to have meant).
602 pub to: Vec<String>,
603 pub raw: String,
604}
605
606/// ⟨0.24⟩ ONE POLICY LINE THE PARSER DID NOT HONOUR AS WRITTEN (SPEC §3.1 `901f14d` / `195d45a`).
607///
608/// **THE DEFECT.** `parsepolicy` emitted **no `errors` key at all** (measured 2026-07-28 on the
609/// conformance battery: java 10, ts 4, rust 0, swift 0). Every one of these facts existed — they were
610/// printed to stderr as "ignoring policy rule …" — so the verb whose entire purpose is to let a consumer
611/// diff what an engine made of a policy answered the question with the not-honoured half deleted. Worse,
612/// it was INCONSISTENT with this engine's own gate: the gate refuses an unrecognised class token while
613/// the parse narrowed it silently, which is two answers to one question.
614///
615/// **`kind` IS A CLOSED SET, AND IT IS THE SPEC'S, NOT THE REFERENCE ENGINE'S.** `901f14d` pins four
616/// values: `reason-class/alias`, `Net destination-class`, `effect-name`, `rule-kind`. Measured, candor-java
617/// emits `forbid form`, `allow values` and `rule kind` (space, not hyphen) — three values outside the set
618/// and one spelling divergence — and candor-ts renames `kind`→`vocabulary` and `rule`→`where` and emits
619/// `accepted` as a PROSE STRING. This engine follows the clause: a line that names a rule keyword but does
620/// not form that keyword's rule formed no rule kind, so it is `rule-kind`.
621///
622/// `accepted` is an ARRAY OF TOKENS — the tokens that WOULD have been honoured in the position the bad one
623/// occupies. Empty where the position is open-ended (a host, a path), which is a fact about the grammar
624/// rather than a gap in the report.
625#[derive(Debug, Clone)]
626pub struct PolicyError {
627 /// One of [`PolicyError::KIND_REASON_CLASS`], [`PolicyError::KIND_NET_CLASS`],
628 /// [`PolicyError::KIND_EFFECT_NAME`], [`PolicyError::KIND_RULE_KIND`].
629 pub kind: &'static str,
630 /// The offending token, verbatim. Empty when the position was EMPTY (a missing arrow, an `allow` with
631 /// no values) — which is itself the finding.
632 pub token: String,
633 /// The tokens accepted in that position. Empty ⇒ the position takes an open-ended literal.
634 pub accepted: Vec<String>,
635 /// The raw policy line, verbatim.
636 pub rule: String,
637 /// The human sentence — the same text the stderr channel carries, so the two cannot disagree.
638 pub message: String,
639 /// ⟨0.28⟩ The 1-based SOURCE LINE the error sits on — SPEC §6.2 pins the verdict's `ignored`
640 /// disclosure as `[{ line, text, reason }]`, and a consumer's next action is to go to that line.
641 /// Counted over the normalized text (bare `\r` line breaks count like `\n`, matching the split).
642 pub line: usize,
643 /// ⟨0.28⟩ The source line VERBATIM — before comment-stripping and trimming, unlike `rule`, because
644 /// §6.2's `text` is "the source line, verbatim" and the operator matches it against their file.
645 pub text: String,
646 /// ⟨0.24⟩ Does this error make the policy UNHONOURABLE, so every gate route must refuse (exit 2)?
647 ///
648 /// FATAL and REPORTED are different questions and this field is the only place they are told apart.
649 /// A dropped `nonsense line` is reported and survivable — the rest of the policy means what it says.
650 /// A rewritten `deny Unknown[dispatch,nativ]` is not: the rule that RAN is not the rule that was
651 /// written, and the direction that matters NARROWS it.
652 pub fatal: bool,
653}
654
655impl PolicyError {
656 pub const KIND_REASON_CLASS: &'static str = "reason-class/alias";
657 pub const KIND_NET_CLASS: &'static str = "Net destination-class";
658 pub const KIND_EFFECT_NAME: &'static str = "effect-name";
659 pub const KIND_RULE_KIND: &'static str = "rule-kind";
660}
661
662/// The rule kinds parsed from a CANDOR_POLICY file.
663#[derive(Default, Debug)]
664pub struct ParsedPolicy {
665 pub rules: Vec<PolicyRule>,
666 pub allow_rules: Vec<AllowRule>,
667 pub layer_rules: Vec<LayerRule>,
668 /// ⟨0.29⟩ the `only <A> -> <B> …` permission rules — see [`OnlyRule`]. Kept in their own list rather
669 /// than folded into `layer_rules` because the two read OPPOSITE ways: a `forbid` names what must not
670 /// happen, an `only` names the complete set of what may, so a route that handled one as the other
671 /// would inverse the verdict rather than approximate it.
672 pub only_rules: Vec<OnlyRule>,
673 /// ⟨0.24⟩ POLICY ERRORS — a policy that cannot be honoured AS WRITTEN (SPEC §6.2). Non-empty ⇒ every
674 /// gate route MUST refuse: exit 2, the unreadable-policy posture. Not a warning list: the rules in
675 /// `rules` are what the text would mean if the error were tolerated, and tolerating it is the defect.
676 ///
677 /// Today the only member is an unrecognised reason-class/alias token in an `Unknown[…]` filter. The
678 /// asymmetry that used to justify a warning — "a dropped policy token leaves a WIDER rule standing,
679 /// so the failure is loud" — is false in the case that matters, and the false half is FAIL-OPEN:
680 ///
681 /// - `deny Unknown[corp]` (sole unrecognised token) — the filter empties and the rule WIDENS to a
682 /// bare `deny Unknown`, while the engine prints "ignoring policy rule" and then KEEPS and
683 /// re-scopes it. Merely surprising, but a FALSE DISCLOSURE.
684 /// - `deny Unknown[dispatch,nativ]` (a typo BESIDE valid tokens) — the token is dropped, the rule
685 /// NARROWS to `[dispatch]`, and it stops gating native-caused holes entirely while the operator
686 /// reads a gate that looks armed. **That is the fail-open, and it is the common case: a typo
687 /// lands beside correct tokens far more often than alone.**
688 ///
689 /// A policy that cannot be honoured as written is not silently rewritten into a different policy.
690 ///
691 /// ⟨0.24⟩ THIS LIST NOW HOLDS EVERY LINE THE PARSER DID NOT HONOUR, fatal or not (SPEC §3.1
692 /// `195d45a`) — `parsepolicy` reports them all, and the gate routes refuse on
693 /// [`ParsedPolicy::fatal_messages`] alone. Widening the LIST without widening what REFUSES is the
694 /// whole of the change: a dropped `nonsense line` was always survivable and stays so.
695 pub errors: Vec<PolicyError>,
696 /// ⟨0.24⟩ The `.candor/config` `unknown-alias` definitions this policy actually resolved a token
697 /// through (SPEC §3.1) — **name → the reason-class TOKENS it expanded to**, not a bare name list.
698 /// Non-empty ⇒ a config file supplied vocabulary that PARTICIPATED in the verdict, and the
699 /// `--gate-json` document MUST name that file. Recorded at the point of USE, not from the alias map:
700 /// a config defining ten aliases none of which the policy mentions changed nothing, and naming it
701 /// would train the reader to ignore the field.
702 ///
703 /// ⟨0.24⟩ **THE VALUE TRAVELS WITH THE NAME, AND THAT IS A SPEC MUST** (§3.1, candor-spec `7f5b5ba`).
704 /// This engine shipped the bare name — as did java and swift — and candor-ts kept the map and won the
705 /// argument from the clause's OWN sentence: `configSources: [path]` is rejected there because *a
706 /// disclosure that names the source but not the content leaves the reader knowing they were affected
707 /// and not how*, and `["corp"]` fails that same test one level down. **`corp = reflect` and
708 /// `corp = reflect,native` gate DIFFERENTLY under one unchanged policy line**, so a reader given only
709 /// the name cannot tell which gate ran. The map is a strict superset — the keys recover the old array.
710 ///
711 /// Class TOKENS rather than `ReasonClass`, so the wire order is the token's alphabetical one (which
712 /// is what candor-ts's `[...set].sort()` produces) and not `ReasonClass`'s declaration order.
713 pub used_aliases: BTreeMap<String, BTreeSet<String>>,
714}
715
716impl ParsedPolicy {
717 /// ⟨0.24⟩ The messages of the errors that make the policy UNHONOURABLE — what every gate route
718 /// refuses on. Non-empty ⇒ exit 2, the unreadable-policy posture.
719 ///
720 /// Separate from `errors` because REPORTED and FATAL are different questions, and conflating them in
721 /// either direction is a defect: refusing on every dropped line would make `nonsense line` fail a
722 /// build, and reporting only the fatal ones is the silent narrowing this rung exists to close.
723 pub fn fatal_messages(&self) -> Vec<&str> {
724 self.errors.iter().filter(|e| e.fatal).map(|e| e.message.as_str()).collect()
725 }
726}
727
728/// The hostname part of a `host[:port]` literal, port stripped — so `api.stripe.com` in a rule accepts
729/// a reached `api.stripe.com:443`. IPv6-aware: a bracketed `[host]:port` yields the bracketed host, and
730/// a BARE IPv6 literal (>1 colon, no brackets) has no port to strip and is returned whole — a naive
731/// first-colon split collapsed every `2001:db8::*` to `2001`, so one allowed IPv6 accepted any address
732/// in that block (/code-review). A hostname/IPv4 `host` or `host:port` (≤1 colon) splits at the colon.
733pub fn host_part(h: &str) -> &str {
734 if let Some(rest) = h.strip_prefix('[') {
735 // `[ipv6]` or `[ipv6]:port` — the host is between the brackets.
736 return rest.split(']').next().unwrap_or(rest);
737 }
738 if h.matches(':').count() > 1 {
739 return h; // bare IPv6 literal — no port suffix to strip
740 }
741 h.split(':').next().unwrap_or(h)
742}
743
744/// The basename of a command (`/usr/bin/git` → `git`), so `allow Exec … git` accepts an absolute path.
745pub fn cmd_base(c: &str) -> &str {
746 c.rsplit(['/', '\\']).next().unwrap_or(c)
747}
748
749/// Whether an allowed path `a` covers a reached path `r` (SPEC §6.2: path-boundary-respecting prefix).
750/// A directory covers itself and everything beneath it, but NOT a sibling sharing a textual prefix
751/// (`/etc/app` ⊉ `/etc/apppwned`); a `..` that climbs out is never covered; absolute/relative are
752/// never conflated.
753pub fn fs_path_covered(a: &str, r: &str) -> bool {
754 if r.split(['/', '\\']).any(|c| c == "..") {
755 return false;
756 }
757 let absolute = |s: &str| s.starts_with('/') || s.starts_with('\\');
758 if absolute(a) != absolute(r) {
759 return false;
760 }
761 let norm = |s: &str| -> Vec<String> {
762 s.split(['/', '\\'])
763 .filter(|c| !c.is_empty() && *c != ".")
764 .map(|c| c.to_string())
765 .collect()
766 };
767 let (ac, rc) = (norm(a), norm(r));
768 ac.len() <= rc.len() && ac.iter().zip(&rc).all(|(x, y)| x == y)
769}
770
771/// Whether an allowed table entry `a` covers a reached table `r` (SPEC §6.2): case-insensitive
772/// exact match on the (possibly schema-qualified) name, or a `schema.*` entry covering every table
773/// in that schema. Strict on qualification — an allowed `entries` does NOT cover a reached
774/// `ledger.entries` (write both forms if your queries mix them); silent widening is the failure
775/// mode an allowlist exists to prevent.
776pub fn db_table_covered(a: &str, r: &str) -> bool {
777 let (a, r) = (a.to_lowercase(), r.to_lowercase());
778 if let Some(schema) = a.strip_suffix(".*") {
779 return r.strip_prefix(schema).is_some_and(|rest| rest.starts_with('.'));
780 }
781 a == r
782}
783
784/// Whether a reached literal is allowed under an effect-specific match (SPEC §6.2): `Net` host by
785/// name (port ignored), `Exec` command by basename, `Fs` path by boundary-respecting prefix,
786/// `Db` table by qualified name or `schema.*`.
787pub fn literal_allowed(effect: &str, reached: &str, allow: &BTreeSet<String>) -> bool {
788 match effect {
789 // `Llm` ⟨0.13⟩ rides the Net host literal (SPEC §1) — matched by hostname like `Net`.
790 "Net" | "Llm" => allow.iter().any(|a| host_part(a) == host_part(reached)),
791 "Exec" => allow.iter().any(|a| cmd_base(a) == cmd_base(reached)),
792 "Fs" => allow.iter().any(|a| fs_path_covered(a, reached)),
793 "Db" => allow.iter().any(|a| db_table_covered(a, reached)),
794 _ => allow.contains(reached),
795 }
796}
797
798/// Split a function name (or scope) into PATH SEGMENTS on either separator. Reports reach the Rust gate
799/// AND `candor-query` from BOTH the Rust engines (`::`-separated names) and the JVM/Swift/TS engines
800/// (`.`-separated names — `candor-query` is explicitly built to read them). Segmenting on `::` ALONE
801/// left a scoped `deny`/`pure` rule silently INERT on a dotted name: the scope matched nothing, so
802/// `whatif` returned a false green on the security boundary (gate-evasion). The JVM engine's own
803/// `scopeMatches` already splits on `.`; this aligns the Rust side. A `:`/`.` never appears WITHIN a
804/// real segment, so splitting on both never over-segments a Rust name (no spurious match).
805fn name_segments(s: &str) -> Vec<&str> {
806 s.split(['.', ':']).filter(|p| !p.is_empty()).collect()
807}
808
809/// A policy scope matches a function name by **path segment** (SPEC §6.2), not substring: split both
810/// into segments (on `::` or `.`); the scope matches a contiguous run of name-segments where every
811/// segment except the last matches exactly and the last is a prefix. So `domain` matches
812/// `app::domain::h`, `com.acme.domain.h`, and `domain_logic` but not `subdomain`.
813/// ⟨0.29⟩ SCOPE MATCHING FOR A **PERMISSION**, where the prefix rule is FAIL-OPEN.
814///
815/// [`scope_matches`]'s last segment is a PREFIX of its name-segment, so `util` matches `utilities`. For
816/// `deny`/`pure`/`forbid` that widening is FAIL-CLOSED — a scope that matches more forbids more — and it
817/// is why the rule exists. For the `to` list of an `only` rule it is the exact inverse: a permitted scope
818/// that matches more PERMITS more, so the matcher that keeps every other rule kind safe silently widens
819/// the one form whose entire purpose is to fail safe.
820///
821/// MEASURED on the shipped ⟨0.29⟩ implementation, before this function existed:
822///
823/// ```text
824/// only model -> util `model::go` reaching `utilities_untrusted::exfil` → policy ✓
825/// forbid model -> util the identical reach → AS-EFF-009
826/// ```
827///
828/// The operator wrote a complete permission list and the matcher quietly extended it to anything sharing
829/// a prefix with an entry. So a `to` scope matches by EXACT segment run, with no prefix on the last —
830/// `only a -> util` permits `util::x` and `crate::util::x`, and does NOT permit `utilities_untrusted::x`.
831///
832/// THE `from` SIDE KEEPS THE PREFIX RULE, deliberately: `from` selects which functions the rule BINDS, so
833/// matching more constrains more, which is the safe direction. The asymmetry is the point — each side
834/// takes the matcher whose over-approximation errs toward the gate firing.
835pub fn scope_matches_permitted(name: &str, scope: &str) -> bool {
836 let segs = name_segments(name);
837 let parts = name_segments(scope);
838 if parts.is_empty() || parts.len() > segs.len() {
839 return false;
840 }
841 segs.windows(parts.len()).any(|w| w == parts.as_slice())
842}
843
844/// A TRAILING SEPARATOR MEANS EXACT SEGMENT — `app::` matches the segment `app` and nothing else,
845/// where bare `app` keeps the documented prefix behaviour and still matches `application_name`.
846///
847/// REPORTED FROM THE FIELD (ebman CI adoption, 2026-08-23) and reproduced: `forbid aws -> app` fired
848/// 14 times on honest AWS SDK calls because `app` prefix-matched `application_name`, and writing
849/// `app::` did not help — `name_segments` drops empty parts, so `app::` segmented to exactly `["app"]`
850/// and the separator never survived to mean anything. The reporter deleted the rule, which is the real
851/// cost: **the genuine `aws -> app` violation it existed to catch will now never fire, and nothing in
852/// the policy file records that a boundary stopped being checked.** The two available responses to the
853/// false positives — delete the rule, or widen the scope until it stops firing — end in the same place.
854///
855/// ADDITIVE ON PURPOSE. Bare `app` is unchanged, so no existing verdict moves; only `app::`, which
856/// today silently behaves as `app`, starts meaning what everyone who writes it intends. Silence was
857/// the worst of the three options available (match exactly / error as unsupported / quietly do
858/// nothing), because ⟨0.24⟩ §3.1 already rules that an unanswerable condition must be DISCLOSED rather
859/// than scored as satisfied — and a scope token that segments away is exactly that.
860fn scope_is_exact(scope: &str) -> bool {
861 let t = scope.trim_end();
862 t.ends_with("::") || t.ends_with('.')
863}
864
865pub fn scope_matches(name: &str, scope: &str) -> bool {
866 let segs = name_segments(name);
867 let parts = name_segments(scope);
868 if parts.is_empty() || parts.len() > segs.len() {
869 return false;
870 }
871 let exact = scope_is_exact(scope);
872 let (last, init) = parts.split_last().unwrap();
873 segs.windows(parts.len()).any(|w| {
874 let (w_last, w_init) = w.split_last().unwrap();
875 w_init == init && if exact { w_last == last } else { w_last.starts_with(last) }
876 })
877}
878
879/// Reconstruct a rule's source form and the `Unknown`-forbidding upgrade for it: `pure <scope>` →
880/// (`"pure <scope>"`, `"deny Unknown <scope>"`); `deny <E…> <scope>` → (`"deny <E…> <scope>"`,
881/// `"deny <E…> Unknown <scope>"`). Shared so the gate note and `candor unverified` name the identical
882/// rule and upgrade — one source of truth for the disclosure's advice.
883///
884/// ⟨0.24⟩ **THE NARROWING FILTERS ARE RENDERED, and they had to start being rendered in the same commit
885/// that made them REACHABLE here.** Making `unverified_hole_rule` filter-aware is what first lets a
886/// `deny Unknown[reflect]` / `deny Net[unknown-host]` rule be the rule a hole is disclosed under — and
887/// this reconstruction dropped the bracket, so the fix would have printed the operator's narrowed rule
888/// back to them as the WIDE one (`deny Unknown`) and advised the nonsense upgrade `deny Unknown
889/// Unknown`. That is the same mis-attribution `whatif` carries, arriving through the fix for a different
890/// defect: the hazard on this rung is that each correction manufactures its own mirror, so the rendering
891/// moves with the predicate rather than after it.
892///
893/// A rule carrying NO filter renders byte-identically to before, which is what keeps conformance PARTs
894/// 12c/12d (`deny Db Net Unknown domain`, four-way) unmoved.
895///
896/// THE UPGRADE SPLITS on whether the rule already denies `Unknown`. If it does, it can only be here
897/// NARROWED — a bare `deny … Unknown` fires on every `Unknown`, so the function would be a violation and
898/// not a hole — and the upgrade is that term WIDENED to bare `Unknown`, not a second `Unknown` appended.
899pub fn rule_and_upgrade(r: &PolicyRule) -> (String, String) {
900 let scope = r.scope.clone().unwrap_or_default();
901 let suffix = if scope.is_empty() { String::new() } else { format!(" {scope}") };
902 if r.effects.is_empty() {
903 // `pure` forbids real effects but not Unknown; to REQUIRE provable purity, add a deny-Unknown.
904 return (format!("pure{suffix}"), format!("deny Unknown{suffix}"));
905 }
906 // One effect term, with its narrowing filter if it has one. Class tokens sorted by TOKEN string, as
907 // `parsepolicy` sorts them and as the java reference's `.sorted()` does — the dump and the
908 // disclosure must spell one rule one way.
909 let term = |e: &str| -> String {
910 if e == UNKNOWN && !r.unknown_classes.is_empty() {
911 let mut t: Vec<&str> = r.unknown_classes.iter().map(|c| c.token()).collect();
912 t.sort_unstable();
913 format!("{UNKNOWN}[{}]", t.join(","))
914 } else if e == "Net" && !r.net_classes.is_empty() {
915 format!("Net[{}]", r.net_classes.iter().map(String::as_str).collect::<Vec<_>>().join(","))
916 } else {
917 e.to_string()
918 }
919 };
920 let effs = r.effects.iter().map(|e| term(e)).collect::<Vec<_>>().join(" ");
921 if r.effects.contains(UNKNOWN) {
922 let widened =
923 r.effects.iter().map(|e| if *e == UNKNOWN { UNKNOWN.to_string() } else { term(e) }).collect::<Vec<_>>();
924 (format!("deny {effs}{suffix}"), format!("deny {}{suffix}", widened.join(" ")))
925 } else {
926 (format!("deny {effs}{suffix}"), format!("deny {effs} {UNKNOWN}{suffix}"))
927 }
928}
929
930/// The single predicate for a provable-purity hole (eval/fixloop/DISPATCH-NOTE.md): a function that is
931/// `Unknown`, sits in a `pure`/`deny <E>` scope, and PASSES that rule (carries none of its forbidden real
932/// effects) — so its compliance is asserted but not verified (the Unknown could hide the very effect the
933/// rule forbids; the classic case is a fn/closure-injected port). A *real* violation is the gate's job, not
934/// this. Returns the first governing rule under which the function is such a hole, or `None` if it is not
935/// one. Shared by candor-scan's gate note and candor-query's `unverified` so "what a hole is" has ONE
936/// definition — the two paths can never drift (conformance PART 12d pins their agreement).
937///
938/// ⟨0.24⟩ **"PASSES" IS NOW ASKED OF THE GATE, NOT OF A SECOND COPY OF IT.** This predicate computed the
939/// passing test from `r.effects` alone — "does the rule NAME an effect this function has?" — which is
940/// the pre-⟨0.19⟩ question, still being asked after two rungs gave rules a NARROWING FILTER. So on
941/// `deny Unknown[reflect]` over an `indirect` hole the gate TOLERATED (exit 0, the class does not match)
942/// while this read the same rule as violated; and a hole is *by definition* a function that PASSES its
943/// rule while `Unknown`, so the real hole was reclassified as a violation-that-isn't and **deleted from
944/// the disclosure** — `unverified` answering "every function in a pure/deny layer is PROVABLY clean ✓"
945/// over a function the gate had just declined to clear. MEASURED 2026-07-28, and reachable with no alias
946/// in play at all: one layer below the widening `ea0df4f` closed, in the same four verbs.
947///
948/// It now calls [`crate::gate::rule_hits`] — the gate's own firing decision — so the two cannot disagree
949/// again. That needs the function's TRANSITIVE reason classes and its ⟨0.20⟩ destination classes, the
950/// same two accumulators the gate reads, which is why they are parameters now rather than derivable.
951///
952/// **THE DIRECTION IS THE MIRROR ARGUMENT.** A filter can only ever SHRINK what a rule charges, so a
953/// filter-aware pass test can only ever find MORE holes — this cannot silently suppress a disclosure
954/// that used to appear. Pinned in both directions by
955/// `a_narrowed_rule_the_gate_tolerates_is_a_hole_and_the_one_it_fires_on_is_not`, in one run, because
956/// the fixture proving the fabrication is closed cannot show the reach closed with it. A WITHHELD filter
957/// — nothing to read — likewise counts as PASSING here: the gate did not clear the function, and an
958/// advisory note's fail-safe direction is to disclose.
959pub fn unverified_hole_rule<'a, S: AsRef<str>>(
960 name: &str,
961 effects: &[S],
962 reason_classes: Option<&BTreeSet<String>>,
963 net_classes: &[String],
964 rules: &'a [PolicyRule],
965) -> Option<&'a PolicyRule> {
966 if !effects.iter().any(|e| e.as_ref() == UNKNOWN) {
967 return None;
968 }
969 let effs: Vec<&str> = effects.iter().map(AsRef::as_ref).collect();
970 rules.iter().find(|r| {
971 // in the rule's scope (a scopeless rule governs the whole unit) …
972 if let Some(s) = &r.scope {
973 if !scope_matches(name, s) {
974 return false;
975 }
976 }
977 // … and PASSES it — the gate's own answer, narrowing filters and all. Empty `hits` IS passing.
978 crate::gate::rule_hits(r, &effs, reason_classes, net_classes).hits.is_empty()
979 })
980}
981
982/// R443 — THE PROVABLE-PURITY ADVISORY'S LINES, ONE RENDERER FOR BOTH GATE ROUTES.
983///
984/// `candor-scan --policy` printed this note and `candor-query gate --report` printed NOTHING over the
985/// identical tree, the identical rule and the identical verdict (MEASURED 2026-09-15 on
986/// `pub fn via_callback(f: impl Fn()) { f(); }` under `pure via_callback`: route B three lines naming
987/// `deny Unknown via_callback`, route A `policy ✓` and silence). **The silent route is the DEPLOYED
988/// one** — gating a precomputed report is what the query layer is for, so it is what CI runs.
989///
990/// The SET is already single-sourced ([`unverified_hole_rule`], which both routes have always called);
991/// this is the other half — the rendering, which would otherwise be the same three sentences written
992/// twice in two crates, i.e. the R288/R347 shape arriving through the fix for it. Only the `prefix`
993/// differs, because the two routes must name themselves (an operator has to know which command to
994/// re-run). `holes` is `(fn, upgrade)` in the caller's own order — already the shape candor-scan's
995/// `unverified_holes` returns.
996///
997/// ADVISORY: the caller prints these and does NOT touch its verdict or exit code. Whether `pure`/`deny`
998/// should FAIL CLOSED on `Unknown` is a SPEC question (R443's expensive half) and is deliberately not
999/// decided here.
1000pub fn unverified_note_lines(prefix: &str, holes: &[(String, String)]) -> Vec<String> {
1001 if holes.is_empty() {
1002 return Vec::new();
1003 }
1004 let mut out = vec![format!(
1005 "{prefix}: note — {} function(s) PASS the policy but are Unknown (purity NOT verified — the Unknown could hide a forbidden effect):",
1006 holes.len()
1007 )];
1008 for (fq, up) in holes {
1009 out.push(format!(" `{fq}` → add `{up}`"));
1010 }
1011 out.push(
1012 " (advisory; add the upgrade(s) to REQUIRE provable purity, or run `candor-query unverified` for detail — the gate verdict is unchanged)"
1013 .to_string(),
1014 );
1015 out
1016}
1017
1018/// Parse a CANDOR_POLICY file (SPEC §6.2). One rule per line; `#` comments and blanks ignored:
1019///
1020/// ```text
1021/// deny Net Db domain # functions whose path contains segment "domain" must not perform Net or Db
1022/// deny Exec # no function anywhere may perform Exec
1023/// deny Unknown api # functions in "api" must be fully resolvable (forbid the unverifiable)
1024/// pure parse # functions whose path contains segment "parse" must be effect-free
1025/// allow Net in billing api.stripe.com
1026/// forbid domain -> infra
1027/// ```
1028///
1029/// In a `deny` rule, leading tokens that name a known effect (or `Unknown`) are forbidden; the FIRST
1030/// non-effect token is the scope and ends the rule. A `deny` naming no known effect is dropped (it is
1031/// NOT a `pure` rule). Malformed/unknown lines are ignored with a warning — never silently widened.
1032/// The §6.2 token separator: ASCII whitespace ONLY (space/tab/CR/LF/VT/FF). `split_whitespace`/`trim`
1033/// use Unicode `White_Space`, which would split a NBSP/ideographic space that Java drops — a gateless-
1034/// green cross-engine divergence (adversarial DSL review). A non-ASCII space stays part of its token, so
1035/// the rule is malformed and ignored, uniformly.
1036fn is_ascii_ws(c: char) -> bool {
1037 matches!(c, ' ' | '\t' | '\n' | '\x0b' | '\x0c' | '\r')
1038}
1039
1040pub fn parse_policy(text: &str) -> ParsedPolicy {
1041 parse_policy_impl(text, true, &std::collections::BTreeMap::new())
1042}
1043/// As [`parse_policy`] but with `.candor/config` `unknown-alias` definitions (⟨0.19⟩, SPEC §6.2): an
1044/// `Unknown[<name>]` filter resolves a user-defined `<name>` to its reason classes. The gate + `parsepolicy`
1045/// pass the discovered aliases (via [`parse_unknown_aliases`]); a config alias never changes what bare
1046/// `deny E Unknown` means (always `Unknown[*]`), so the rule stays legible from the policy alone.
1047pub fn parse_policy_with_aliases(text: &str, aliases: &std::collections::BTreeMap<String, std::collections::BTreeSet<ReasonClass>>) -> ParsedPolicy {
1048 parse_policy_impl(text, true, aliases)
1049}
1050/// ⟨0.24⟩ [`parse_policy_with_aliases`] but SILENT — for a caller that must inspect
1051/// [`ParsedPolicy::errors`] / [`ParsedPolicy::used_aliases`] BEFORE it parses for real (candor-scan
1052/// refuses before touching the classifier's accumulators). Silent so the ordinary parse warnings are not
1053/// printed twice on the same text.
1054pub fn parse_policy_silent(
1055 text: &str,
1056 aliases: &std::collections::BTreeMap<String, BTreeSet<ReasonClass>>,
1057) -> ParsedPolicy {
1058 parse_policy_impl(text, false, aliases)
1059}
1060/// Same as [`parse_policy`] but SILENT about malformed rules — for a SECOND, advisory re-parse within the
1061/// same run (candor-scan parses once for the gate check and again for the `unverified` disclosure), so the
1062/// CI log doesn't print every "ignoring policy rule …" warning twice (#21). The first parse already warned.
1063pub fn parse_policy_quiet(text: &str) -> ParsedPolicy {
1064 parse_policy_impl(text, false, &std::collections::BTreeMap::new())
1065}
1066fn parse_policy_impl(text: &str, warn: bool, aliases: &std::collections::BTreeMap<String, std::collections::BTreeSet<ReasonClass>>) -> ParsedPolicy {
1067 macro_rules! warn_ignore { ($($a:tt)*) => { if warn { eprintln!($($a)*); } } }
1068 let mut out = ParsedPolicy::default();
1069 // ⟨0.28⟩ The source position of the line under the cursor, for `PolicyError::{line, text}` — bound
1070 // BEFORE the macro below so its body (whose free identifiers resolve at definition scope) can read
1071 // them; the loop updates both per iteration. §6.2's `ignored` disclosure is `[{line, text, reason}]`.
1072 let mut cur_line: usize;
1073 let mut cur_text: &str;
1074 // ⟨0.24⟩ Record a line the parser did not honour (SPEC §3.1 `195d45a`), on the ONE list `parsepolicy`
1075 // reports and the gate routes filter for `fatal`. The stderr sentence and `message` are the SAME
1076 // string by construction — a disclosure that can drift from the one beside it is how this family
1077 // produced a FALSE disclosure once already (conformance PART 13b).
1078 macro_rules! not_honoured {
1079 ($fatal:expr, $kind:expr, $token:expr, $accepted:expr, $rule:expr, $msg:expr) => {{
1080 let message: String = $msg;
1081 out.errors.push(PolicyError {
1082 kind: $kind,
1083 token: ($token).to_string(),
1084 accepted: ($accepted).iter().map(|s: &&str| s.to_string()).collect(),
1085 rule: ($rule).to_string(),
1086 message,
1087 line: cur_line,
1088 text: cur_text.to_string(),
1089 fatal: $fatal,
1090 });
1091 }};
1092 }
1093 // `str::lines()` splits on \n and \r\n but NOT bare \r — a classic-Mac file then collapses to ONE
1094 // line, and since \r is also an in-line ASCII-ws token separator (is_ascii_ws), every rule after the
1095 // first was glued into the first rule's tokens and dropped (sweep [16], a gateless-green divergence).
1096 // Java's Files.readAllLines (the reference) breaks on bare \r too — normalize to match it. Allocation
1097 // only when a bare \r is actually present (the overwhelmingly-common \n / \r\n files are untouched).
1098 // ⟨0.40⟩ SOUNDNESS R1224 (SPEC §6.2, the owner's ruling 2026-10-20) — a U+FEFF at BYTE OFFSET 0 is an ENCODING
1099 // MARK, removed before the file is split into lines; it is not a character of the first token. An editor
1100 // that writes a UTF-8 byte-order mark (PowerShell 5.1 `Out-File -Encoding utf8`) otherwise costs the policy
1101 // its FIRST rule: `\u{feff}deny` is no keyword, so a one-rule file refused (exit 2, zero rules) and a
1102 // multi-rule one ran without it. ONE mark, at offset 0 only: a second U+FEFF, or one at the start of a later
1103 // line or inside a token, stays an ordinary token character and its line is ignored-with-a-warning as before.
1104 // Every policy reader in this repo — candor-query's gate/whatif/fix/parsepolicy/gate-verdict, candor-scan's
1105 // `--policy` routes and the nightly lint — parses through this function, so this is the one place.
1106 let text = text.strip_prefix('\u{feff}').unwrap_or(text);
1107 let normalized;
1108 let text = if text.contains('\r') {
1109 normalized = text.replace("\r\n", "\n").replace('\r', "\n");
1110 normalized.as_str()
1111 } else {
1112 text
1113 };
1114 for (line_idx, raw_line) in text.lines().enumerate() {
1115 cur_line = line_idx + 1;
1116 cur_text = raw_line;
1117 let line = raw_line.split('#').next().unwrap_or("").trim_matches(is_ascii_ws);
1118 if line.is_empty() {
1119 continue;
1120 }
1121 let mut toks = line.split(is_ascii_ws).filter(|s| !s.is_empty());
1122 match toks.next().unwrap_or("") {
1123 "allow" => {
1124 let effect = match toks.next().unwrap_or("") {
1125 "Net" => "Net",
1126 // `Llm` ⟨0.13⟩ rides the Net host literal (SPEC §1) — `allow Llm <host…>` restricts which
1127 // MODEL hosts a scope may reach, matched by hostname like Net (its reached surface IS the
1128 // Net host surface). Match candor-java's Policy.parsePolicy.
1129 "Llm" => "Llm",
1130 "Exec" => "Exec",
1131 "Fs" => "Fs",
1132 "Db" => "Db",
1133 other => {
1134 let msg = format!(
1135 "unknown effect-name `{other}` in `allow` (accepted: Db, Exec, Fs, Llm, Net \
1136 \u{2014} `allow` covers only the effects carrying a literal surface: Net/Llm \
1137 hosts, Exec commands, Fs paths, Db tables): {line}"
1138 );
1139 warn_ignore!("candor: policy error — {msg}");
1140 // ⟨0.24⟩ FATAL (SPEC §6.2 `1e1748a`). MEASURED four-way before this:
1141 // `allow Nett host.example` -> exit 0 on rust, ts, java AND swift. The rule is
1142 // DELETED and the certification silently vanishes, so the operator reads an
1143 // armed allowlist that does not exist.
1144 //
1145 // The grammar defence that kept the token rule inside the bracket does NOT
1146 // reach here: `allow`'s effect position is a fixed, closed set with **no scope
1147 // reading available**, so an unrecognised token there is unambiguously a typo
1148 // and there is no legitimate policy it could be. This document already calls a
1149 // dropped rule "the limit case of silently rewritten into a different policy…
1150 // a bigger rewrite than a narrowed filter" — and the bigger rewrite was
1151 // warning-only while the smaller one was already exit 2.
1152 not_honoured!(
1153 true,
1154 PolicyError::KIND_EFFECT_NAME,
1155 other,
1156 ["Db", "Exec", "Fs", "Llm", "Net"],
1157 line,
1158 msg
1159 );
1160 continue;
1161 }
1162 };
1163 let mut rest: Vec<&str> = toks.collect();
1164 let scope = if rest.first() == Some(&"in") {
1165 let s = rest.get(1).map(|s| s.to_string());
1166 rest.drain(..2.min(rest.len()));
1167 s
1168 } else {
1169 None
1170 };
1171 let literals: BTreeSet<String> = rest.iter().map(|h| h.to_string()).collect();
1172 if literals.is_empty() {
1173 let msg = format!("`allow {effect}` names no values: {line}");
1174 warn_ignore!("candor: ignoring policy rule ({msg})");
1175 // `accepted` is EMPTY on purpose: the position takes an open-ended literal (a host, a
1176 // path, a command, a table), so there is no token list to offer. A fact about the
1177 // grammar, not a gap in the report.
1178 not_honoured!(false, PolicyError::KIND_RULE_KIND, "", [], line, msg);
1179 continue;
1180 }
1181 out.allow_rules.push(AllowRule { effect, scope, literals, raw: line.to_string() });
1182 }
1183 "deny" => {
1184 let mut effects = BTreeSet::new();
1185 let mut scope = None;
1186 // Reason-class filter on `Unknown` (REASON-SCOPED-UNKNOWN-DESIGN.md): empty ⇒ `Unknown[*]`
1187 // (any reason — the bare form); non-empty ⇒ only those classes. `*` = all.
1188 let mut unknown_classes: BTreeSet<ReasonClass> = BTreeSet::new();
1189 let mut unknown_star = false;
1190 // Destination-class filter on `Net` (NET-DESTINATION-CLASS-DESIGN.md): empty ⇒ `Net[*]`
1191 // (any destination — the bare form); non-empty ⇒ only those classes. `*` = all.
1192 let mut net_classes: BTreeSet<String> = BTreeSet::new();
1193 let mut net_star = false;
1194 for t in toks {
1195 // `Net[unknown-host]` / `Net[*]` / `Net[known-telemetry,unknown-host]`: the destination-scoped form.
1196 if let Some(inner) = t.strip_prefix("Net[").and_then(|s| s.strip_suffix(']')) {
1197 effects.insert("Net");
1198 for cn in inner.split(',') {
1199 let cn = cn.trim();
1200 if cn.is_empty() {
1201 continue;
1202 }
1203 if cn == "*" {
1204 net_star = true;
1205 } else if crate::NET_DEST_CLASSES.contains(&cn) {
1206 net_classes.insert(cn.to_string());
1207 } else {
1208 // ⟨0.24⟩ A POLICY ERROR, not a warning — SPEC §6.2 `be0b9a9`. Byte-identical
1209 // in shape to the reason-class arm below, and byte-identical in harm:
1210 // MEASURED `deny Net[known-telemetry,unknown-hosst]` → exit 0 where the
1211 // correctly-spelled rule exits 1. The typo is dropped, the filter NARROWS
1212 // to `[known-telemetry]`, and the gate stops covering unidentifiable
1213 // destinations while the operator reads a gate that looks armed.
1214 not_honoured!(
1215 true,
1216 PolicyError::KIND_NET_CLASS,
1217 cn,
1218 ["known-telemetry", "known-partner", "unknown-host", "*"],
1219 line,
1220 format!(
1221 "unrecognised Net destination-class `{cn}` in `{line}` — \
1222 accepted: known-telemetry, known-partner, unknown-host, plus `*`"
1223 )
1224 );
1225 }
1226 }
1227 continue;
1228 }
1229 // `Unknown[dispatch,reflect]` / `Unknown[*]` / `Unknown[dynamic]`: the reason-scoped form.
1230 if let Some(inner) = t.strip_prefix("Unknown[").and_then(|s| s.strip_suffix(']')) {
1231 effects.insert(UNKNOWN);
1232 for cn in inner.split(',') {
1233 let cn = cn.trim();
1234 if cn.is_empty() {
1235 continue;
1236 }
1237 if cn == "*" {
1238 unknown_star = true;
1239 } else if cn == "dynamic" {
1240 unknown_classes.extend(ReasonClass::dynamic_set());
1241 } else if let Some(rc) = ReasonClass::from_token(cn) {
1242 unknown_classes.insert(rc);
1243 } else if let Some(a) = aliases.get(cn) {
1244 unknown_classes.extend(a.iter().copied()); // ⟨0.19⟩ config `unknown-alias`
1245 // ⟨0.24⟩ → the verdict names it AND what it expanded to (SPEC §3.1
1246 // `7f5b5ba`): the NAME alone cannot tell a reader which gate ran.
1247 out.used_aliases
1248 .insert(cn.to_string(), a.iter().map(|c| c.token().to_string()).collect());
1249 } else {
1250 // ⟨0.24⟩ A POLICY ERROR, not a warning — see `ParsedPolicy::errors`. The
1251 // token is still dropped below so `rules` stays well-formed for the
1252 // advisory readers (`unverified`, `parsepolicy`); the gate routes refuse
1253 // on `errors` before any of it is used as a verdict.
1254 not_honoured!(
1255 true,
1256 PolicyError::KIND_REASON_CLASS,
1257 cn,
1258 [
1259 "reflect",
1260 "dispatch",
1261 "indirect",
1262 "native",
1263 "unresolved",
1264 "setup",
1265 "dynamic",
1266 "*"
1267 ],
1268 line,
1269 format!(
1270 "unrecognised reason-class/alias `{cn}` in `{line}` — accepted: \
1271 reflect, dispatch, indirect, native, unresolved, setup, plus the \
1272 aliases `dynamic` and `*`, plus any `unknown-alias` defined in \
1273 the `.candor/config` beside the policy. (⟨0.24⟩ an \
1274 `unknown-alias` whose OWN definition names an unrecognised class \
1275 is refused WHOLE, so a typo in the config surfaces as an \
1276 undefined alias here — check the `unknown-alias` lines too, and \
1277 the line above this one.)"
1278 )
1279 );
1280 }
1281 }
1282 continue;
1283 }
1284 let e = if t == UNKNOWN { Some(UNKNOWN) } else { cap_from_name(t) };
1285 match e {
1286 Some(e) => {
1287 effects.insert(e);
1288 if e == UNKNOWN {
1289 unknown_star = true; // bare Unknown ⇒ all classes
1290 }
1291 if e == "Net" {
1292 net_star = true; // bare Net ⇒ all destinations
1293 }
1294 }
1295 None => {
1296 scope = Some(t.to_string());
1297 break;
1298 }
1299 }
1300 }
1301 if effects.is_empty() {
1302 // The accepted set is the §1 effect vocabulary plus `Unknown` — SORTED, so the
1303 // document is deterministic and diffable across engines.
1304 let mut acc: Vec<&str> = candor_report::EFFECTS.to_vec();
1305 acc.push(UNKNOWN);
1306 acc.sort_unstable();
1307 let msg = format!(
1308 "`deny` names no known effect (accepted: {}): {line}",
1309 acc.join(", ")
1310 );
1311 warn_ignore!("candor: policy error — {msg}");
1312 // ⟨0.24⟩ FATAL (SPEC §6.2 `1e1748a`). MEASURED four-way: `deny Nett app` -> exit 0
1313 // on all four; the rule is DELETED and the gate is green. `Nett` is read as the
1314 // SCOPE (the first unrecognised token ends the effect list), so the line parses to
1315 // a deny of NOTHING.
1316 //
1317 // **A `deny` whose effect list ends up EMPTY is malformed under EITHER reading** —
1318 // typo-in-the-effect or scope-with-no-effect are both nonsense — so there is no
1319 // legitimate policy it could be and refusing it loses nothing. What stays open is
1320 // only the genuinely ambiguous middle (`deny Net Exex app`: at least one valid
1321 // effect plus an unrecognised trailing token that MIGHT be a scope), which the
1322 // parser cannot tell from a legitimate scope and which `parsepolicy` shows either
1323 // way by dumping the `scope` it read.
1324 not_honoured!(
1325 true,
1326 PolicyError::KIND_EFFECT_NAME,
1327 scope.as_deref().unwrap_or(""),
1328 acc,
1329 line,
1330 msg
1331 );
1332 continue;
1333 }
1334 // `*` (or bare `Unknown`) means all classes ⇒ empty filter (matches any Unknown).
1335 if unknown_star {
1336 unknown_classes.clear();
1337 } else if !unknown_classes.is_empty() && !unknown_classes.contains(&ReasonClass::Unresolved) {
1338 // A2 under-gating lint: a narrowed scope that omits `unresolved` (the catch-all for holes
1339 // an engine couldn't classify) may silently tolerate exactly those — flag it (advisory).
1340 warn_ignore!("candor: policy rule narrows `Unknown[…]` but omits `unresolved` — may UNDER-gate on holes the engine couldn't classify; add `unresolved` (or use `dynamic`) to stay conservative: {line}");
1341 }
1342 // `*` (or bare `Net`) means all destinations ⇒ empty filter (matches any Net).
1343 if net_star {
1344 net_classes.clear();
1345 }
1346 out.rules.push(PolicyRule { effects, scope, unknown_classes, net_classes, raw: line.to_string() });
1347 }
1348 "pure" => out.rules.push(PolicyRule {
1349 effects: BTreeSet::new(),
1350 scope: toks.next().map(str::to_string),
1351 unknown_classes: BTreeSet::new(),
1352 net_classes: BTreeSet::new(),
1353 raw: line.to_string(),
1354 }),
1355 "forbid" => {
1356 let a = toks.next().unwrap_or("");
1357 let arrow = toks.next().unwrap_or("");
1358 let b = toks.next().unwrap_or("");
1359 if a.is_empty() || arrow != "->" || b.is_empty() {
1360 let msg = format!("`forbid` is malformed (want `forbid <scope> -> <scope>`): {line}");
1361 warn_ignore!("candor: ignoring layering rule ({msg})");
1362 // The token reported is whatever sat in the ARROW position — `->` must be its own
1363 // token, so `forbid glued->arrow` finds nothing there and that absence is the finding.
1364 not_honoured!(false, PolicyError::KIND_RULE_KIND, arrow, ["->"], line, msg);
1365 continue;
1366 }
1367 out.layer_rules.push(LayerRule {
1368 from: a.to_string(),
1369 to: b.to_string(),
1370 raw: line.to_string(),
1371 });
1372 }
1373 // ⟨0.29⟩ `only <A> -> <B> [<C> …]` — the PERMISSION form. Everything after the arrow is a
1374 // scope, so the rule takes a LIST where `forbid` takes one destination; that is the whole
1375 // ergonomic difference, and it is why the tail is not read left-to-right for anything else.
1376 "only" => {
1377 let a = toks.next().unwrap_or("");
1378 let arrow = toks.next().unwrap_or("");
1379 let to: Vec<String> = toks.map(str::to_string).collect();
1380 if a.is_empty() || arrow != "->" || to.is_empty() {
1381 let msg = format!(
1382 "`only` is malformed (want `only <scope> -> <scope> [<scope> …]`): {line}"
1383 );
1384 warn_ignore!("candor: ignoring permission rule ({msg})");
1385 // Same witness as `forbid`: whatever sat in the ARROW position, since `->` must be
1386 // its own token and `only glued->arrow` finds nothing there.
1387 not_honoured!(false, PolicyError::KIND_RULE_KIND, arrow, ["->"], line, msg);
1388 continue;
1389 }
1390 out.only_rules.push(OnlyRule {
1391 from: a.to_string(),
1392 to,
1393 raw: line.to_string(),
1394 });
1395 }
1396 other => {
1397 let msg = format!(
1398 "unknown rule kind `{other}` (accepted: allow, deny, forbid, only, pure): {line}"
1399 );
1400 warn_ignore!("candor: ignoring policy rule ({msg})");
1401 not_honoured!(
1402 false,
1403 PolicyError::KIND_RULE_KIND,
1404 other,
1405 ["allow", "deny", "forbid", "only", "pure"],
1406 line,
1407 msg
1408 );
1409 }
1410 }
1411 }
1412 out
1413}
1414
1415#[cfg(test)]
1416mod tests {
1417 /// R443 — the note's bytes, pinned. Both gate routes render through this one function now, so the
1418 /// only thing a route may vary is the PREFIX; anything else drifting is this assertion failing.
1419 /// The strings are the ones candor-scan has printed since ⟨0.19⟩, character for character, because
1420 /// the point of the change was to give the SILENT route the EXISTING disclosure — not a new one.
1421 #[test]
1422 fn unverified_note_lines_render_one_note_for_both_routes() {
1423 let holes = vec![
1424 ("via_callback".to_string(), "deny Unknown via_callback".to_string()),
1425 ("domain::price".to_string(), "deny Net Unknown domain".to_string()),
1426 ];
1427 let scan = super::unverified_note_lines("candor-scan", &holes);
1428 let query = super::unverified_note_lines("candor-query gate", &holes);
1429 assert_eq!(scan.len(), 4, "header + one line per hole + the advisory footer");
1430 assert_eq!(
1431 scan[0],
1432 "candor-scan: note — 2 function(s) PASS the policy but are Unknown (purity NOT verified — the Unknown could hide a forbidden effect):"
1433 );
1434 assert_eq!(scan[1], " `via_callback` → add `deny Unknown via_callback`");
1435 assert_eq!(scan[2], " `domain::price` → add `deny Net Unknown domain`");
1436 assert_eq!(
1437 scan[3],
1438 " (advisory; add the upgrade(s) to REQUIRE provable purity, or run `candor-query unverified` for detail — the gate verdict is unchanged)"
1439 );
1440 // The prefix, and NOTHING else, is what the two routes differ in.
1441 assert_eq!(scan[1..], query[1..]);
1442 assert_eq!(query[0], scan[0].replacen("candor-scan", "candor-query gate", 1));
1443 // A clean pass renders NO lines at all — the over-charge control, at the renderer.
1444 assert!(super::unverified_note_lines("candor-scan", &[]).is_empty());
1445 }
1446
1447 #[test]
1448 fn db_table_covering_is_strict() {
1449 use super::db_table_covered as c;
1450 assert!(c("ledger.entries", "Ledger.Entries")); // case-insensitive exact
1451 assert!(c("ledger.*", "ledger.entries")); // schema wildcard
1452 assert!(!c("ledger.*", "ledgerx.entries")); // boundary-respecting
1453 assert!(!c("entries", "ledger.entries")); // no silent qualification widening
1454 assert!(c("entries", "entries"));
1455 }
1456
1457 #[test]
1458 fn allow_db_parses_and_gates() {
1459 let p = super::parse_policy("allow Db in billing ledger.* customers\n");
1460 assert_eq!(p.allow_rules.len(), 1);
1461 assert_eq!(p.allow_rules[0].effect, "Db");
1462 assert!(super::literal_allowed("Db", "ledger.entries", &p.allow_rules[0].literals));
1463 assert!(super::literal_allowed("Db", "customers", &p.allow_rules[0].literals));
1464 assert!(!super::literal_allowed("Db", "audit.log", &p.allow_rules[0].literals));
1465 }
1466
1467 use super::*;
1468
1469 #[test]
1470 fn policy_parses() {
1471 let p = parse_policy(
1472 "# the domain layer must stay pure of I/O\n\
1473 deny Net Db domain\n\
1474 deny Exec\n\
1475 pure parse\n\
1476 nonsense line\n\
1477 deny notaneffect\n",
1478 );
1479 let rules = &p.rules;
1480 assert_eq!(rules.len(), 3);
1481 assert_eq!(rules[0].effects, ["Db", "Net"].into_iter().collect::<BTreeSet<_>>());
1482 assert_eq!(rules[0].scope.as_deref(), Some("domain"));
1483 assert!(rules[1].effects.contains("Exec") && rules[1].scope.is_none());
1484 assert!(rules[2].effects.is_empty() && rules[2].scope.as_deref() == Some("parse"));
1485 // sweep [16]: a classic-Mac (bare \r) multi-rule policy must NOT collapse to the first rule.
1486 let cr = parse_policy("deny Net a\rdeny Exec b\rdeny Db c\r");
1487 assert_eq!(cr.rules.len(), 3, "bare-CR lines must each parse");
1488 assert!(cr.rules.iter().any(|r| r.effects.contains("Exec") && r.scope.as_deref() == Some("b")));
1489 // mixed \r\n and bare \r normalize identically.
1490 assert_eq!(parse_policy("deny Net a\r\ndeny Exec b\r").rules.len(), 2);
1491 // SOUNDNESS R1224 — a U+FEFF at byte offset 0 is stripped, so the first rule is EVALUATED…
1492 let bom = parse_policy("\u{feff}deny Fs core\ndeny Net web\n");
1493 assert_eq!(bom.rules.len(), 2, "a byte-0 BOM must not cost the first rule: {:?}", bom.rules);
1494 assert!(bom.rules[0].effects.contains("Fs") && bom.rules[0].scope.as_deref() == Some("core"));
1495 assert!(bom.errors.is_empty(), "a byte-0 BOM is not a malformed line: {:?}", bom.errors.iter().map(|e| &e.message).collect::<Vec<_>>());
1496 assert_eq!(parse_policy("\u{feff}deny Fs core").rules.len(), 1, "a one-rule BOM'd policy is not zero-rule");
1497 // …with CRLF too (the mark is removed before line-splitting and CR normalisation).
1498 assert_eq!(parse_policy("\u{feff}deny Fs core\r\ndeny Net web\r\n").rules.len(), 2);
1499 // …and ANYWHERE ELSE it stays a token character: the line is still ignored (and reported).
1500 let mid = parse_policy("deny Net web\n\u{feff}deny Fs core\n");
1501 assert_eq!(mid.rules.len(), 1, "a BOM at the start of a LATER line is not an encoding mark");
1502 assert!(!mid.errors.is_empty(), "the BOM'd later line is reported, not silently dropped");
1503 assert_eq!(parse_policy("\u{feff}\u{feff}deny Fs core").rules.len(), 0, "only ONE mark is removed");
1504 assert_eq!(parse_policy("deny Fs\u{feff} core").rules.len(), 0, "a mid-token BOM stays a token character");
1505 // `Unknown` is a denyable token; a bare `deny` with no effect is ignored.
1506 assert_eq!(parse_policy("deny Unknown core").rules[0].effects, ["Unknown"].into_iter().collect());
1507 assert!(parse_policy("deny\ndeny \n").rules.is_empty());
1508 // a `deny` whose first token is a non-effect names no effect -> dropped, NOT a pure rule.
1509 assert!(parse_policy("deny notaneffect scope").rules.is_empty());
1510 // the first non-effect token ENDS the rule: a later effect token is not collected.
1511 let p2 = parse_policy("deny Net foo Db");
1512 assert_eq!(p2.rules[0].effects, ["Net"].into_iter().collect::<BTreeSet<_>>());
1513 assert_eq!(p2.rules[0].scope.as_deref(), Some("foo"));
1514 // NBSP is NOT a token separator (only ASCII White_Space is) — pinned to MATCH Java, which
1515 // drops it: a `deny\u{a0}Net` is one token `deny\u{a0}Net`, NOT `deny` + `Net`, so it names no
1516 // known effect and is dropped. Splitting on Unicode whitespace here would let candor see a deny
1517 // the JVM engine doesn't — a gateless-divergence between impls. (See is_ascii_ws.)
1518 assert!(parse_policy("deny\u{a0}Net core").rules.is_empty(),
1519 "an NBSP between deny and the effect must NOT split into separate tokens");
1520 // The NBSP rides INTO the scope token rather than separating it: `deny Net\u{a0}domain` is
1521 // `deny` + `Net` + `\u{a0}domain` — Net is the effect, the scope keeps the NBSP verbatim.
1522 let nb = parse_policy("deny Net \u{a0}domain");
1523 assert_eq!(nb.rules.len(), 1);
1524 assert_eq!(nb.rules[0].effects, ["Net"].into_iter().collect::<BTreeSet<_>>());
1525 assert_eq!(nb.rules[0].scope.as_deref(), Some("\u{a0}domain"));
1526 }
1527
1528 #[test]
1529 fn reason_scoped_unknown_parses() {
1530 use super::ReasonClass::*;
1531 // `Unknown[dispatch,indirect]` narrows the Unknown membership to those classes.
1532 let p = parse_policy("deny Net Unknown[dispatch,indirect] dom\n");
1533 let r = &p.rules[0];
1534 assert!(r.effects.contains("Unknown") && r.effects.contains("Net"));
1535 assert_eq!(r.scope.as_deref(), Some("dom"));
1536 assert_eq!(r.unknown_classes, [Dispatch, Indirect].into_iter().collect());
1537 // bare `Unknown` and `Unknown[*]` ⇒ empty filter (all classes).
1538 assert!(parse_policy("deny Net Unknown dom\n").rules[0].unknown_classes.is_empty(), "bare Unknown ⇒ all");
1539 assert!(parse_policy("deny Net Unknown[*] dom\n").rules[0].unknown_classes.is_empty(), "Unknown[*] ⇒ all");
1540 // `dynamic` alias = every genuine class incl. unresolved, excl. setup.
1541 assert_eq!(
1542 parse_policy("deny Net Unknown[dynamic] dom\n").rules[0].unknown_classes,
1543 [Reflect, Dispatch, Indirect, Native, Unresolved].into_iter().collect()
1544 );
1545 // config `unknown-alias` (⟨0.19⟩): a user-defined name resolves; a reserved name is rejected.
1546 let aliases = super::parse_unknown_aliases(
1547 "unknown-alias risky = reflect,native\nunknown-alias telemetry = indirect\nunknown-alias reflect = native\n");
1548 assert_eq!(aliases.get("risky"), Some(&[Reflect, Native].into_iter().collect()));
1549 assert_eq!(aliases.get("telemetry"), Some(&[Indirect].into_iter().collect()));
1550 assert!(!aliases.contains_key("reflect"), "a config alias may not shadow a class token");
1551 // the `unknown-alias` KEY matches case-insensitively (parity with java/ts/swift, which lowercase it)
1552 assert_eq!(super::parse_unknown_aliases("Unknown-Alias hot = native\n").get("hot"),
1553 Some(&[Native].into_iter().collect()), "the unknown-alias key must match case-insensitively");
1554 let pr = super::parse_policy_with_aliases("deny Net Unknown[risky] api\n", &aliases);
1555 assert_eq!(pr.rules[0].unknown_classes, [Reflect, Native].into_iter().collect());
1556 // an UNDEFINED alias name is dropped-with-warning → empty filter (behaves like bare Unknown[*])
1557 assert!(super::parse_policy_with_aliases("deny Net Unknown[nope] api\n", &aliases).rules[0].unknown_classes.is_empty());
1558 // classify: raw reason tokens → normative classes (mirrors java ReasonClass.classify).
1559 assert_eq!(ReasonClass::classify("reflect:Class.forName"), Reflect);
1560 assert_eq!(ReasonClass::classify("native:extern fn"), Native);
1561 assert_eq!(ReasonClass::classify("callback:unresolved call"), Indirect);
1562 assert_eq!(ReasonClass::classify("ambiguous:same-name local defs"), Dispatch);
1563 assert_eq!(ReasonClass::classify("unresolved"), Unresolved);
1564 assert_eq!(ReasonClass::classify("whatever-new"), Unresolved); // conservative catch-all
1565 }
1566
1567 /// THE CONTROL SPEC §4 ⟨0.24⟩ MAKES A SHOULD: a FABRICATED, off-vocabulary kind must still behave as
1568 /// §2 forward-compatibility requires. Without it, "added a fifth kind" and "stopped checking the kind
1569 /// set" are the same diff — the classifier is one `_ =>` arm away from either.
1570 ///
1571 /// SOUNDNESS R490 — THE TYPED HALF NOW EXISTS (`Kind`), AND THIS IS THE CONTROL ITS OWN DOC COMMENT
1572 /// SAID TO ADD AT THE SAME COMMIT. The JVM engine's failure was a string classifier correct on
1573 /// `ambiguous` since July beside a typed `Kind` enum that lacked the kind entirely — one token
1574 /// classified two ways inside one engine, concealed precisely because the string half was right. That
1575 /// is unreachable here only while the two halves are the SAME table, so the round-trip below asserts
1576 /// it for every kind rather than for the ones someone remembered: `Kind::ALL` is what `classify`
1577 /// matches on, and what this loop iterates.
1578 #[test]
1579 fn off_vocabulary_kinds_round_trip_and_classify_through_the_catch_all() {
1580 use ReasonClass::*;
1581 // A kind no engine emits and no section names. §2: tolerated, and classified CONSERVATIVELY —
1582 // `unresolved`, the catch-all, so a narrowed `Unknown[unresolved]`/`[dynamic]`/`[*]` still bites it.
1583 assert_eq!(ReasonClass::classify("banana:whatever"), Unresolved);
1584 assert_eq!(ReasonClass::classify("banana:dispatch of a banana"), Unresolved,
1585 "a canonical kind appearing in the DETAIL must not leak into the classification");
1586 // …and it must not be swallowed into a narrower class. These are the four wrong answers.
1587 for wrong in [Reflect, Dispatch, Indirect, Native] {
1588 assert_ne!(ReasonClass::classify("banana:whatever"), wrong);
1589 }
1590 // The five §4 ⟨0.24⟩ kinds all classify, and `ambiguous` is the fifth — pinned beside the
1591 // fabricated one deliberately: one arm chain answers both, so a change that stops distinguishing
1592 // them fails here rather than in the field.
1593 assert_eq!(ReasonClass::classify("reflect:x"), Reflect);
1594 assert_eq!(ReasonClass::classify("native:x"), Native);
1595 assert_eq!(ReasonClass::classify("dispatch:Owner.member"), Dispatch);
1596 assert_eq!(ReasonClass::classify("callback:x"), Indirect);
1597 assert_eq!(ReasonClass::classify("ambiguous:x"), Dispatch);
1598 // ⟨0.24⟩ `dep:<hash>` / `dep-stale:<pkg>` are REGISTERED §4 kinds, not migration ones — swift
1599 // emits them per dependency ENTRY, and this engine CONSUMES swift/ts reports through
1600 // candor-query. §6.2 pins their class as `unresolved`, which is where the catch-all lands them;
1601 // pinned so a future prefix arm cannot move them without saying so.
1602 assert_eq!(ReasonClass::classify("dep:9f2c1a"), Unresolved);
1603 assert_eq!(ReasonClass::classify("dep-stale:somepkg"), Unresolved);
1604
1605 // SOUNDNESS R1218 — every SIBLING-PRODUCER alias is a PREFIX (§6.2's table header), so each must
1606 // project identically bare and with the `:detail` its producer actually writes. The alias arm that
1607 // was an equality test failed exactly here: swift writes `dynamicMemberLookup:Bag.anything`.
1608 for (bare, class) in [
1609 ("dynamicMemberLookup", Reflect),
1610 ("closure", Indirect),
1611 ("task-handoff", Indirect),
1612 ("indy", Dispatch),
1613 ("missing-config", Setup),
1614 ("no-tsconfig", Setup),
1615 ("no-node_modules", Setup),
1616 ] {
1617 assert_eq!(ReasonClass::classify(bare), class, "bare `{bare}`");
1618 let detailed = format!("{bare}:Owner.member");
1619 assert_eq!(ReasonClass::classify(&detailed), class, "`{detailed}` must project like `{bare}`");
1620 }
1621
1622 // ── SOUNDNESS R490: THE TYPED HALF AND THE STRING HALF ARE ONE TABLE ────────────────────────
1623 // Every kind this engine can WRITE must classify to the class it declares, through the same
1624 // `classify` a consumer runs — asserted over `Kind::ALL`, so a kind added without a class, or a
1625 // class arm changed without the producer, fails here. A hand-listed version of this loop is the
1626 // bug it is guarding against.
1627 assert_eq!(Kind::ALL.len(), 5, "SPEC §4 ⟨0.7⟩'s kind set is CLOSED at five");
1628 for k in Kind::ALL {
1629 assert_eq!(ReasonClass::classify(&k.reason("some detail")), k.class(),
1630 "kind {:?} spells a reason its own classifier does not agree with", k);
1631 assert!(!k.token().contains(':'), "a kind token cannot contain the `kind:detail` separator");
1632 }
1633 // The one NORMATIVE detail shape (§4): `dispatch:<owner-type>.<member>`, dotted, which is what
1634 // §3.1's dispatch frontier parses. Pinned as a STRING because that is what reaches the report.
1635 assert_eq!(Kind::dispatch_on("Store", "put"), "dispatch:Store.put");
1636 assert_eq!(ReasonClass::classify(&Kind::dispatch_on("Store", "put")), Dispatch);
1637 // …and the reserved DOT-FREE form stays a `dispatch:` (⟨0.24⟩): it is the "no owner could be
1638 // formed at all" spelling, free text, not conformance-compared — but still class `dispatch`, so
1639 // re-kinding it to `callback:` would silently narrow every `deny E Unknown[dispatch]` in the field.
1640 assert_eq!(ReasonClass::classify(&Kind::Dispatch.reason("untyped cross-package receiver")), Dispatch);
1641 }
1642
1643 #[test]
1644 fn net_destination_class_parses_and_classifies() {
1645 // `Net[unknown-host,known-telemetry]` narrows the Net membership to those destination classes.
1646 let p = parse_policy("deny Net[unknown-host,known-telemetry] dom\n");
1647 let r = &p.rules[0];
1648 assert!(r.effects.contains("Net"));
1649 assert_eq!(r.scope.as_deref(), Some("dom"));
1650 assert_eq!(
1651 r.net_classes,
1652 ["unknown-host", "known-telemetry"].iter().map(|s| s.to_string()).collect()
1653 );
1654 // bare `Net` and `Net[*]` ⇒ empty filter (all destinations).
1655 assert!(parse_policy("deny Net dom\n").rules[0].net_classes.is_empty(), "bare Net ⇒ all");
1656 assert!(parse_policy("deny Net[*] dom\n").rules[0].net_classes.is_empty(), "Net[*] ⇒ all");
1657 // an unknown destination-class is dropped-with-warning → empty filter (behaves like bare Net[*]).
1658 assert!(parse_policy("deny Net[nope] dom\n").rules[0].net_classes.is_empty());
1659 // the classifier: telemetry (subdomain-aware), model host, unresolved, and the config-partner path.
1660 let no_partners = BTreeSet::new();
1661 assert_eq!(crate::net_dest_class("sentry.io", &no_partners), "known-telemetry");
1662 assert_eq!(crate::net_dest_class("us.i.posthog.com", &no_partners), "known-telemetry"); // 0.20.1 corpus-grown
1663 assert_eq!(crate::net_dest_class("o1.ingest.sentry.io", &no_partners), "known-telemetry");
1664 assert_eq!(crate::net_dest_class("api.openai.com", &no_partners), "known-partner", "a model host is known-partner");
1665 assert_eq!(crate::net_dest_class("evil.example.com", &no_partners), "unknown-host");
1666 let partners: BTreeSet<String> = ["api.stripe.com".to_string()].into_iter().collect();
1667 assert_eq!(crate::net_dest_class("api.stripe.com", &partners), "known-partner", "config-declared partner");
1668 assert_eq!(crate::net_dest_class("api.stripe.com", &no_partners), "unknown-host", "partner is config-only");
1669 // `net-partner` config parsing: host-normalized, case-insensitive key, multi-value.
1670 let pset = super::parse_net_partners("net-partner Api.Stripe.com:443\nNET-PARTNER hooks.stripe.com\n");
1671 assert!(pset.contains("api.stripe.com") && pset.contains("hooks.stripe.com"));
1672 }
1673
1674 #[test]
1675 fn allowlist_parses() {
1676 let p = parse_policy(
1677 "allow Net in billing api.stripe.com hooks.stripe.com\n\
1678 allow Exec in ci git\n\
1679 allow Fs in config /etc/app\n\
1680 allow Net github.com\n\
1681 allow Clock whatever\n\
1682 allow Net in nohosts\n\
1683 allow\n",
1684 );
1685 assert_eq!(p.allow_rules.len(), 4); // Clock carries no literal surface — rejected; Db now does
1686 assert_eq!((p.allow_rules[0].effect, p.allow_rules[0].scope.as_deref()), ("Net", Some("billing")));
1687 assert_eq!(
1688 p.allow_rules[0].literals,
1689 ["api.stripe.com", "hooks.stripe.com"].iter().map(|s| s.to_string()).collect()
1690 );
1691 assert_eq!((p.allow_rules[1].effect, p.allow_rules[1].scope.as_deref()), ("Exec", Some("ci")));
1692 assert!(p.allow_rules[1].literals.contains("git"));
1693 assert_eq!((p.allow_rules[2].effect, p.allow_rules[2].scope.as_deref()), ("Fs", Some("config")));
1694 assert_eq!((p.allow_rules[3].effect, p.allow_rules[3].scope.is_none()), ("Net", true));
1695
1696 let set = |xs: &[&str]| xs.iter().map(|s| s.to_string()).collect::<BTreeSet<_>>();
1697 assert!(literal_allowed("Net", "api.stripe.com:443", &set(&["api.stripe.com"])));
1698 // IPv6: a bare literal is matched WHOLE (no first-colon collapse), so a different address in the
1699 // same block is NOT accepted; a bracketed `[host]:port` matches the bare host. (/code-review.)
1700 assert!(literal_allowed("Net", "2001:db8::aa", &set(&["2001:db8::aa"])));
1701 assert!(!literal_allowed("Net", "2001:db8::ff", &set(&["2001:db8::aa"])));
1702 assert!(!literal_allowed("Net", "2001:dead::1", &set(&["2001:db8::aa"])));
1703 assert!(literal_allowed("Net", "[2001:db8::aa]:443", &set(&["2001:db8::aa"])));
1704 assert_eq!(host_part("2001:db8::aa"), "2001:db8::aa");
1705 assert_eq!(host_part("[2001:db8::aa]:443"), "2001:db8::aa");
1706 assert_eq!(host_part("api.stripe.com:443"), "api.stripe.com");
1707 assert!(literal_allowed("Exec", "/usr/bin/git", &set(&["git"])));
1708 assert!(!literal_allowed("Exec", "/usr/bin/curl", &set(&["git"])));
1709 assert!(literal_allowed("Fs", "/etc/app/conf.toml", &set(&["/etc/app"])));
1710 assert!(!literal_allowed("Fs", "/etc/shadow", &set(&["/etc/app"])));
1711 assert_eq!(cmd_base("/usr/bin/git"), "git");
1712 }
1713
1714 #[test]
1715 fn layering_rule_parses() {
1716 let p = parse_policy(
1717 "forbid domain -> infra\n\
1718 forbid app::web -> app::db \n\
1719 forbid domain infra\n\
1720 forbid domain ->\n\
1721 forbid\n",
1722 );
1723 assert_eq!(p.layer_rules.len(), 2);
1724 assert_eq!((p.layer_rules[0].from.as_str(), p.layer_rules[0].to.as_str()), ("domain", "infra"));
1725 assert_eq!((p.layer_rules[1].from.as_str(), p.layer_rules[1].to.as_str()), ("app::web", "app::db"));
1726 }
1727
1728 /// ⟨0.29⟩ `only <A> -> <B> [<C> …]` — the PERMISSION form. The tail is a LIST, which is the whole
1729 /// ergonomic difference from `forbid`; a missing arrow or an EMPTY tail is dropped rather than read
1730 /// as "A may reach nothing", a rule far likelier to be a typo than an intention.
1731 #[test]
1732 fn parses_the_only_permission_form_and_drops_the_malformed() {
1733 let p = parse_policy(
1734 "only model -> util\n\
1735 only app::web -> app::db app::dto \n\
1736 only model util\n\
1737 only model ->\n\
1738 only\n",
1739 );
1740 assert_eq!(p.only_rules.len(), 2, "the two well-formed lines, and only those");
1741 assert_eq!(p.only_rules[0].from.as_str(), "model");
1742 assert_eq!(p.only_rules[0].to, vec!["util".to_string()]);
1743 assert_eq!(p.only_rules[1].from.as_str(), "app::web");
1744 assert_eq!(p.only_rules[1].to, vec!["app::db".to_string(), "app::dto".to_string()],
1745 "every token after the arrow is a permitted scope");
1746 // …and an `only` line is a RULE for the zero-rule refusal: a policy holding one is ARMED, so a
1747 // route that counted only deny/allow/forbid would call this file empty and refuse a live gate.
1748 assert!(!p.rules.is_empty() || !p.only_rules.is_empty(),
1749 "an only-only policy must not read as a zero-rule file");
1750 }
1751
1752 #[test]
1753 fn scope_matches_by_segment_not_substring() {
1754 assert!(scope_matches("app::domain::handle", "domain"));
1755 assert!(scope_matches("domain::handle", "domain"));
1756 assert!(scope_matches("app::domain", "domain"));
1757 assert!(scope_matches("crate::domain_logic", "domain"));
1758 assert!(!scope_matches("app::subdomain::handle", "domain"));
1759 assert!(!scope_matches("app::not_my_domain::f", "domain"));
1760 // multi-segment: intermediates exact, last is a prefix, contiguous.
1761 assert!(scope_matches("crate::net::client::send", "net::client"));
1762 assert!(scope_matches("crate::net::client_pool::get", "net::client"));
1763 assert!(!scope_matches("crate::net::server::send", "net::client"));
1764 assert!(!scope_matches("crate::network::client::send", "net::client"));
1765 assert!(!scope_matches("crate::net::x::client", "net::client"));
1766 assert!(!scope_matches("net", "net::client"));
1767 // DOTTED names (JVM/Swift/TS reports `candor-query` consumes): a scope must match across `.` too,
1768 // else a scoped deny/pure rule is silently inert → whatif false-green (gate-evasion). Both a
1769 // `.`-written and a `::`-written scope must match a dotted name.
1770 assert!(scope_matches("com.acme.domain.Pricing.quote", "domain"));
1771 assert!(scope_matches("com.acme.domain.Pricing.quote", "acme.domain"));
1772 assert!(scope_matches("com.acme.domain.Pricing.quote", "acme::domain"));
1773 assert!(scope_matches("com.acme.infra.Net.fetch", "infra.Net"));
1774 assert!(!scope_matches("com.acme.subdomain.h", "domain"));
1775 assert!(!scope_matches("com.acme.domain.h", "infra"));
1776 }
1777
1778 #[test]
1779 fn fs_path_covered_respects_boundaries() {
1780 assert!(fs_path_covered("/etc/app", "/etc/app"));
1781 assert!(fs_path_covered("/etc/app", "/etc/app/cfg.toml"));
1782 assert!(fs_path_covered("/etc/app/", "/etc/app/cfg"));
1783 assert!(!fs_path_covered("/etc/app", "/etc/apppwned"));
1784 assert!(!fs_path_covered("/etc/app", "/etc/application/x"));
1785 assert!(!fs_path_covered("/etc/app/cfg", "/etc/app"));
1786 assert!(!fs_path_covered("/etc/app", "/etc/app/../passwd"));
1787 assert!(fs_path_covered("/", "/etc/app/x"));
1788 assert!(!fs_path_covered("etc/app", "/etc/app/cfg"));
1789 assert!(!fs_path_covered("/etc/app", "etc/app/cfg"));
1790 assert!(fs_path_covered("etc/app", "etc/app/cfg"));
1791 }
1792
1793 /// ⟨0.24⟩ THE PROVABLE-PURITY DISCLOSURE MUST ASK THE GATE WHAT "PASSES" MEANS — SPEC §6.2, and both
1794 /// directions in ONE test, because killing an over-charge is exactly where a silent under-report gets
1795 /// introduced and the fixture proving the fabrication is closed cannot show the reach closed with it.
1796 ///
1797 /// A hole is a function that PASSES its rule while `Unknown`. `unverified_hole_rule` used to compute
1798 /// PASSES from `r.effects` alone — the pre-⟨0.19⟩ question, asked after two rungs gave rules a
1799 /// NARROWING FILTER — so a rule the gate TOLERATES was read here as violated and the hole was DELETED
1800 /// from the disclosure. MEASURED 2026-07-28: `deny Unknown[reflect]` over an `indirect` hole → gate
1801 /// exit 0, `unverified` "every function in a pure/deny layer is PROVABLY clean ✓".
1802 ///
1803 /// ROW 1 (the fix) — the filter does NOT match, so the gate tolerates and this IS a hole.
1804 /// ROW 2 (the mirror) — the SAME rule, SAME function, filter spelled to MATCH: the gate fires, so it
1805 /// is a violation and NOT a hole. Without row 2 the fix is satisfied by a predicate that calls
1806 /// everything a hole, which is the mirror over-report of the thing being fixed.
1807 /// ROW 3 — the ⟨0.20⟩ `Net[dest…]` filter, the same shape on the other narrowing axis.
1808 /// ROW 4 — no filter at all: byte-identical to pre-⟨0.24⟩, which is what keeps conformance PARTs
1809 /// 12c/12d (four-way) from moving.
1810 #[test]
1811 fn a_narrowed_rule_the_gate_tolerates_is_a_hole_and_the_one_it_fires_on_is_not() {
1812 let effs = ["Unknown"];
1813 let indirect: BTreeSet<String> = ["indirect".to_string()].into_iter().collect();
1814 let hole = |src: &str, classes: Option<&BTreeSet<String>>, nets: &[String]| -> Option<String> {
1815 let p = parse_policy(src);
1816 unverified_hole_rule("app::go", &effs, classes, nets, &p.rules).map(|r| rule_and_upgrade(r).1)
1817 };
1818
1819 // ROW 1 — tolerated by the gate (indirect ∉ {reflect}) ⇒ a hole, and the upgrade WIDENS the
1820 // filter rather than appending a second `Unknown`.
1821 assert_eq!(
1822 hole("deny Unknown[reflect]\n", Some(&indirect), &[]).as_deref(),
1823 Some("deny Unknown"),
1824 "a rule the gate TOLERATES leaves the function unproven — that is the disclosure's whole subject"
1825 );
1826
1827 // ROW 2 — THE MIRROR. Same rule, same signature, filter spelled to match: the gate FIRES, so this
1828 // is a violation and the disclosure must stay silent about it.
1829 assert_eq!(
1830 hole("deny Unknown[indirect]\n", Some(&indirect), &[]),
1831 None,
1832 "a rule the gate FIRES on is a violation, not a hole — filter-awareness must not start \
1833 disclosing the gate's own findings back as unproven passes"
1834 );
1835 assert_eq!(hole("deny Unknown[dynamic]\n", Some(&indirect), &[]), None, "`dynamic` covers indirect");
1836
1837 // ROW 3 — the ⟨0.20⟩ destination filter, both ways, on a fn carrying Net BESIDE its Unknown.
1838 let netfn = ["Net".to_string(), "Unknown".to_string()];
1839 let telemetry = vec!["known-telemetry".to_string()];
1840 let p = parse_policy("deny Net[unknown-host]\n");
1841 assert_eq!(
1842 unverified_hole_rule("app::go", &netfn, Some(&indirect), &telemetry, &p.rules)
1843 .map(|r| rule_and_upgrade(r).1)
1844 .as_deref(),
1845 Some("deny Net[unknown-host] Unknown"),
1846 "a `Net[dest…]` the fn's destinations do not match is tolerated, so the Unknown beside it is a hole"
1847 );
1848 let p = parse_policy("deny Net[known-telemetry]\n");
1849 assert_eq!(
1850 unverified_hole_rule("app::go", &netfn, Some(&indirect), &telemetry, &p.rules).map(|r| r.raw.clone()),
1851 None,
1852 "MIRROR: the matching destination filter FIRES, so it is a violation and not a hole"
1853 );
1854
1855 // ROW 4 — UNFILTERED, unchanged. `deny Unknown` fires on every Unknown (never a hole); `pure` and
1856 // `deny Fs` pass a fn with no real effect (always a hole) — the forms PARTs 12c/12d pin four-way.
1857 assert_eq!(hole("deny Unknown\n", Some(&indirect), &[]), None);
1858 assert_eq!(hole("pure\n", Some(&indirect), &[]).as_deref(), Some("deny Unknown"));
1859 assert_eq!(hole("deny Net Db domain\ndeny Fs\n", Some(&indirect), &[]).as_deref(), Some("deny Fs Unknown"));
1860 assert_eq!(
1861 hole("deny Net Db go\n", Some(&indirect), &[]).as_deref(),
1862 Some("deny Db Net Unknown go"),
1863 "the sorted multi-effect upgrade PART 12c-deny pins in all four engines"
1864 );
1865
1866 // A WITHHELD filter — no class set to read — counts as PASSING, so the hole is disclosed rather
1867 // than dropped. The gate withholds there too; between an advisory note that speaks and one that
1868 // goes quiet over a rule that never ran, only the first stays true.
1869 assert_eq!(hole("deny Unknown[reflect]\n", None, &[]).as_deref(), Some("deny Unknown"));
1870 }
1871}
1872
1873// ── ⟨0.27⟩ SPEC §3.4 `engine` — the engine↔baseline coupling ─────────────────────────────────────
1874/// What an `engine` pin says about the build that is running. Data, not a print-and-exit, so every
1875/// branch is testable — including the two that MUST NOT change the exit code.
1876#[derive(Debug, PartialEq, Eq)]
1877pub enum PinVerdict {
1878 /// No pin, or a pin qualified for another implementation. Today's behaviour, exactly.
1879 Absent,
1880 Match,
1881 /// A different version — the engine↔baseline coupling is broken. Exit 2 (UNEVALUABLE, never 1).
1882 Mismatch,
1883 /// Present but unreadable (`engine latest`, a bare `engine`, trailing junk). Exit 2: a pin that
1884 /// cannot be read is a guard the operator believes is on. This is the one place §6.2's
1885 /// warn-and-skip posture INVERTS — skipping a key that ADDS something costs that key; skipping a
1886 /// PIN costs the guard.
1887 Malformed,
1888 /// Well-formed, and this build cannot state its own release. UNANSWERABLE — §3.1's rule applies:
1889 /// disclosed, never scored, INCLUDING as satisfied.
1890 Undetermined,
1891}
1892
1893/// The pin that applies to `impl_name` — the qualified form wins over the unqualified one, and the
1894/// LAST occurrence wins (matching candor-java's map semantics). Two lines that DISAGREE about the same
1895/// key return a value that cannot parse, so they surface as [`PinVerdict::Malformed`] rather than one
1896/// silently discarding the other: two lines disagreeing about which engine to run is not a preference
1897/// to resolve, it is a question the config leaves unanswered.
1898pub fn engine_pin_for(text: &str, impl_name: &str) -> Option<String> {
1899 const IMPLS: [&str; 5] = ["java", "rust", "ts", "swift", "agents"];
1900 let (mut wild, mut qual): (Option<String>, Option<String>) = (None, None);
1901 let mut bad = false;
1902 for raw in text.lines() {
1903 let line = raw.split('#').next().unwrap_or("").trim();
1904 if line.is_empty() {
1905 continue;
1906 }
1907 let mut it = line.split_whitespace();
1908 if !it.next().is_some_and(|k| k.eq_ignore_ascii_case("engine")) {
1909 continue;
1910 }
1911 let rest: Vec<&str> = it.collect();
1912 let slot = |cur: &mut Option<String>, v: String| {
1913 if cur.as_ref().is_some_and(|p| *p != v) {
1914 *cur = Some(format!("{} / {v}", cur.as_ref().unwrap()));
1915 } else {
1916 *cur = Some(v);
1917 }
1918 };
1919 // A KNOWN QUALIFIER DECIDES OWNERSHIP BEFORE ARITY. Checking the one-token case first made `engine swift` a WILDCARD pin whose version is the literal "swift" -> MALFORMED -> exit 2 in every engine, so one operator forgetting a version on a qualified line killed the whole family. SPEC 3.4 says the skip is whole-line 'whatever follows it' -- and nothing following it is a case of that too.
1920 if let Some(head) = rest.first() {
1921 if IMPLS.contains(&head.to_ascii_lowercase().as_str()) {
1922 if head.eq_ignore_ascii_case(impl_name) {
1923 if rest.len() == 2 { slot(&mut qual, rest[1].to_string()); } else { bad = true; }
1924 }
1925 continue; // another impl's line, whatever follows it
1926 }
1927 }
1928 match rest.len() {
1929 0 => bad = true, // a bare `engine` line
1930 1 => slot(&mut wild, rest[0].to_string()), // engine <version>
1931 _ => bad = true, // trailing junk / unknown qualifier
1932 }
1933 }
1934 if bad {
1935 return Some("<unreadable>".to_string());
1936 }
1937 // AN UNREADABLE UNQUALIFIED LINE IS NOT HIDDEN BY A QUALIFIED PIN. `qual ?? wild` returned the qua
1938 // lified value, so `engine garbage` beside a good qualified line passed SILENTLY here while candor-java ex
1939 // ited 2 — the exact mirror of the bug just fixed in java, four engines the other way. Unreadability is a property of the LINE; precedence only decides which VERSION applies.
1940 if let Some(w) = &wild {
1941 if normalize_version(w).is_none() { return Some(w.clone()); }
1942 }
1943 qual.or(wild)
1944}
1945
1946/// [`PinVerdict`] for `pin` against `running`. Pure: no printing, no exit.
1947pub fn pin_verdict(pin: Option<&str>, running: &str) -> PinVerdict {
1948 let Some(pin) = pin else { return PinVerdict::Absent };
1949 let Some(want) = normalize_version(pin) else { return PinVerdict::Malformed };
1950 if running.trim().is_empty() || running == "unknown" {
1951 return PinVerdict::Undetermined;
1952 }
1953 if want == normalize_version(running).unwrap_or_else(|| running.trim().to_string()) {
1954 PinVerdict::Match
1955 } else {
1956 PinVerdict::Mismatch
1957 }
1958}
1959
1960/// A pin token → its comparable form, or None when it is not a version at all. A leading `v` is
1961/// optional (the GitHub-tag `v0.27.0` and the crate `0.27.0` are the same pin) and a two-part `0.27`
1962/// means `0.27.0`. Anything else — `latest`, a branch name — is MALFORMED rather than a version that
1963/// can never match: the difference decides whether the operator reads "wrong version" or "that is not
1964/// a version".
1965fn normalize_version(raw: &str) -> Option<String> {
1966 let s = raw.trim().strip_prefix(['v', 'V']).unwrap_or_else(|| raw.trim());
1967 let parts: Vec<&str> = s.split('.').collect();
1968 if !(parts.len() == 2 || parts.len() == 3) || !parts.iter().all(|p| !p.is_empty() && p.bytes().all(|b| b.is_ascii_digit())) {
1969 return None;
1970 }
1971 Some(if parts.len() == 2 { format!("{s}.0") } else { s.to_string() })
1972}