comindly_api/
ledger.rs

1use std::collections::BTreeMap;
2
3use anyhow::{bail, Context, Result};
4use serde::{Deserialize, Serialize};
5
6use crate::model::{Fingerprint, Symbol};
7
8#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, PartialOrd, Ord)]
9#[serde(rename_all = "snake_case")]
10pub enum Kind {
11    Intent,
12    Decision,
13    Attempt,
14    Constraint,
15    Gotcha,
16    Question,
17    /// A relation to another record (supersede, retract, confirm, dispute).
18    Relation,
19}
20
21impl Kind {
22    pub fn parse(s: &str) -> Option<Kind> {
23        Some(match s {
24            "intent" => Kind::Intent,
25            "decision" => Kind::Decision,
26            "attempt" => Kind::Attempt,
27            "constraint" => Kind::Constraint,
28            "gotcha" => Kind::Gotcha,
29            "question" => Kind::Question,
30            _ => return None,
31        })
32    }
33
34    pub fn as_str(self) -> &'static str {
35        match self {
36            Kind::Intent => "intent",
37            Kind::Decision => "decision",
38            Kind::Attempt => "attempt",
39            Kind::Constraint => "constraint",
40            Kind::Gotcha => "gotcha",
41            Kind::Question => "question",
42            Kind::Relation => "relation",
43        }
44    }
45}
46
47#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
48#[serde(rename_all = "snake_case")]
49pub enum RelationKind {
50    Supersedes,
51    Retracts,
52    Confirms,
53    Disputes,
54}
55
56impl RelationKind {
57    pub fn as_str(self) -> &'static str {
58        match self {
59            RelationKind::Supersedes => "supersede",
60            RelationKind::Retracts => "retract",
61            RelationKind::Confirms => "confirm",
62            RelationKind::Disputes => "dispute",
63        }
64    }
65
66    pub fn parse(s: &str) -> Option<RelationKind> {
67        Some(match s {
68            "confirm" | "confirms" => RelationKind::Confirms,
69            "retract" | "retracts" => RelationKind::Retracts,
70            "supersede" | "supersedes" => RelationKind::Supersedes,
71            "dispute" | "disputes" => RelationKind::Disputes,
72            _ => return None,
73        })
74    }
75}
76
77#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
78pub struct Relation {
79    pub kind: RelationKind,
80    pub target: String,
81}
82
83#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
84#[serde(rename_all = "snake_case")]
85pub enum AuthorKind {
86    Human,
87    Agent,
88    /// Legacy (removed git harvest and distiller); kept so older records still read.
89    Harvested,
90    Distilled,
91}
92
93#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
94pub struct Provenance {
95    pub author: AuthorKind,
96    /// Pseudonymous actor id (no names or emails).
97    pub actor: String,
98    pub source: String,
99    #[serde(default)]
100    pub agent: Option<String>,
101    #[serde(default)]
102    pub session: Option<String>,
103    /// The person's name, or the person an agent works for; absent with `record_names = false`.
104    #[serde(default, skip_serializing_if = "Option::is_none")]
105    pub name: Option<String>,
106    /// The writer's teams when it was written; empty for older records and outside teams.
107    #[serde(default, skip_serializing_if = "Vec::is_empty")]
108    pub teams: Vec<String>,
109}
110
111/// Who writes records: a pseudonymous actor id and, when names are kept, a name.
112#[derive(Debug, Clone, Default)]
113pub struct Identity {
114    pub actor: String,
115    pub name: Option<String>,
116}
117
118impl Provenance {
119    pub fn human(source: &str, who: &Identity) -> Provenance {
120        Provenance {
121            author: AuthorKind::Human,
122            actor: who.actor.clone(),
123            source: source.into(),
124            agent: None,
125            session: None,
126            name: who.name.clone(),
127            teams: Vec::new(),
128        }
129    }
130
131    pub fn agent(source: &str, agent: Option<String>, who: &Identity) -> Provenance {
132        Provenance {
133            author: AuthorKind::Agent,
134            agent,
135            ..Provenance::human(source, who)
136        }
137    }
138
139    /// Who, for people to read: "Ada Lovelace", "claude-code for Ada Lovelace", "an agent".
140    pub fn who(&self) -> String {
141        // Records written through a gateway before beta.9 carry the MCP library's name, not the agent's.
142        let agent = self.agent.as_deref().filter(|a| *a != "rmcp");
143        match (self.author, self.name.as_deref(), agent) {
144            (AuthorKind::Agent, Some(n), Some(a)) => format!("{a} for {n}"),
145            (AuthorKind::Agent, Some(n), None) => format!("an agent for {n}"),
146            (AuthorKind::Agent, None, Some(a)) => a.to_string(),
147            (AuthorKind::Agent, None, None) => "an agent".into(),
148            (AuthorKind::Human, Some(n), _) => n.to_string(),
149            (AuthorKind::Human, None, _) => "a person".into(),
150            (AuthorKind::Harvested, ..) => "git history".into(),
151            (AuthorKind::Distilled, ..) => "the distiller".into(),
152        }
153    }
154}
155
156/// Where a record points: a symbol as it was when the record was written.
157#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
158pub struct Anchor {
159    pub symbol: String,
160    pub repo: String,
161    pub path: String,
162    pub name: String,
163    pub line: u32,
164    #[serde(default)]
165    pub fingerprint: Option<Fingerprint>,
166    /// The indexed commit of the anchor's repository when the record was written.
167    #[serde(default, skip_serializing_if = "Option::is_none")]
168    pub commit: Option<String>,
169}
170
171impl Anchor {
172    pub fn of(s: &Symbol) -> Anchor {
173        Anchor {
174            symbol: s.id.render(),
175            repo: s.repo.0.clone(),
176            path: s.file_path.clone(),
177            name: s.name.clone(),
178            line: s.range.start.line,
179            fingerprint: s.fingerprint,
180            commit: None,
181        }
182    }
183
184    /// With the commit `commits` (by repository) records for the anchor's repository.
185    pub fn at(mut self, commits: &std::collections::HashMap<String, String>) -> Anchor {
186        self.commit = commits.get(&self.repo).cloned();
187        self
188    }
189}
190
191/// Code that shaped a record, as it was at `commit`.
192#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
193pub struct Snippet {
194    pub path: String,
195    pub code: String,
196    #[serde(default, skip_serializing_if = "Option::is_none")]
197    pub commit: Option<String>,
198}
199
200#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
201pub struct Record {
202    pub id: String,
203    pub schema: u32,
204    pub kind: Kind,
205    pub title: String,
206    #[serde(default)]
207    pub body: String,
208    /// When a future reader needs this ("relevant when adding caching to auth paths").
209    #[serde(default)]
210    pub trigger: Option<String>,
211    /// Kind-specific fields (`alternatives`, `outcome`, `rule`, `severity`, …).
212    #[serde(default)]
213    pub fields: BTreeMap<String, serde_json::Value>,
214    pub anchors: Vec<Anchor>,
215    /// `commit:<sha>`, `mr:!412`, `test:<path>::<name>`, `url:…`, or free text.
216    #[serde(default)]
217    pub evidence: Vec<String>,
218    #[serde(default, skip_serializing_if = "Vec::is_empty")]
219    pub snippets: Vec<Snippet>,
220    #[serde(default)]
221    pub relation: Option<Relation>,
222    pub provenance: Provenance,
223    /// RFC 3339, UTC.
224    pub created: String,
225    /// Optional SSH signature over the rest of the record .
226    #[serde(default, skip_serializing_if = "Option::is_none")]
227    pub signature: Option<Signature>,
228}
229
230impl Record {
231    pub fn new(kind: Kind, title: &str, anchors: Vec<Anchor>, provenance: Provenance) -> Record {
232        Record {
233            id: uuid::Uuid::now_v7().to_string(),
234            schema: SCHEMA,
235            kind,
236            title: title.trim().to_string(),
237            body: String::new(),
238            trigger: None,
239            fields: BTreeMap::new(),
240            anchors,
241            evidence: Vec::new(),
242            snippets: Vec::new(),
243            relation: None,
244            provenance,
245            created: chrono::Utc::now().to_rfc3339_opts(chrono::SecondsFormat::Secs, true),
246            signature: None,
247        }
248    }
249
250    /// The relation record for a review `action` (see [`review_action`]) on `target`.
251    pub fn review(
252        target: &Record,
253        action: &str,
254        reason: &str,
255        provenance: Provenance,
256    ) -> Result<Record> {
257        let (kind, retire) = review_action(action).with_context(|| {
258            format!("unknown action `{action}`: confirm, archive, invalidate, supersede, dispute or retract")
259        })?;
260        let mut r = Record::relation(kind, target, reason, provenance);
261        if let Some(why) = retire {
262            r.fields
263                .insert("retire".into(), serde_json::Value::String(why.into()));
264        }
265        Ok(r)
266    }
267
268    /// A relation record (`confirm`, `retract`, …) about `target`.
269    pub fn relation(
270        kind: RelationKind,
271        target: &Record,
272        reason: &str,
273        provenance: Provenance,
274    ) -> Record {
275        let title = if reason.trim().is_empty() {
276            format!("{kind:?}: {}", target.title)
277        } else {
278            reason.trim().to_string()
279        };
280        let mut r = Record::new(Kind::Relation, &title, Vec::new(), provenance);
281        r.relation = Some(Relation {
282            kind,
283            target: target.id.clone(),
284        });
285        r
286    }
287
288    /// All free text of a record, for content checks.
289    fn text(&self) -> String {
290        let fields: Vec<String> = self.fields.values().map(|v| v.to_string()).collect();
291        let code: Vec<&str> = self.snippets.iter().map(|s| s.code.as_str()).collect();
292        format!(
293            "{} {} {} {} {} {}",
294            self.title,
295            self.body,
296            self.trigger.as_deref().unwrap_or(""),
297            self.evidence.join(" "),
298            fields.join(" "),
299            code.join(" ")
300        )
301    }
302
303    /// A record that slipped past write-time checks (planted straight into the store).
304    pub fn unsafe_content(&self) -> bool {
305        let t = self.text();
306        suspicious(&t).is_some()
307            || (self.provenance.author != AuthorKind::Human && injection(&t).is_some())
308    }
309
310    /// Reject records that would mislead or carry secrets; caps keep them reviewable.
311    pub fn validate(&self) -> Result<()> {
312        if self.title.is_empty() || self.title.chars().count() > 160 {
313            bail!("title must be 1–160 characters");
314        }
315        if self.body.chars().count() > 4000 {
316            bail!("body is limited to 4000 characters");
317        }
318        if self.kind != Kind::Relation && self.anchors.is_empty() {
319            bail!("a record needs at least one anchor (a symbol it is about)");
320        }
321        if self.fields.contains_key("check") && self.kind != Kind::Constraint {
322            bail!("only constraints carry a check");
323        }
324        if self.snippets.len() > MAX_SNIPPETS {
325            bail!("at most {MAX_SNIPPETS} snippets");
326        }
327        if self.snippets.iter().any(|s| {
328            s.path.trim().is_empty()
329                || s.code.trim().is_empty()
330                || s.code.lines().count() > MAX_SNIPPET_LINES
331                || s.code.chars().count() > 4000
332        }) {
333            bail!("a snippet needs a path and 1–{MAX_SNIPPET_LINES} lines of code (4000 characters at most)");
334        }
335        if self.kind == Kind::Attempt && self.evidence.is_empty() {
336            bail!("an attempt needs evidence (a revert commit, failing test, error, MR, …)");
337        }
338        let text = self.text();
339        if let Some(why) = suspicious(&text) {
340            bail!("refusing to store record: {why}");
341        }
342        // Ledger text is injected into agents' context: machine-written records must not carry
343        // instructions aimed at an agent or shell payloads.
344        if self.provenance.author != AuthorKind::Human {
345            if let Some(why) = injection(&text) {
346                bail!("refusing to store record: {why}");
347            }
348        }
349        Ok(())
350    }
351}
352
353#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, PartialOrd, Ord)]
354#[serde(rename_all = "snake_case")]
355pub enum Status {
356    Active,
357    /// The anchored symbol moved or was renamed; its body is unchanged.
358    Moved,
359    /// The anchored symbol's body changed since the record was written: re-verify.
360    Stale,
361    /// The anchored symbol no longer exists.
362    Orphaned,
363    Superseded,
364    Retracted,
365}
366
367/// T4 constraint enforced by a passing check, T3 human or human-confirmed, T2 agent with evidence,
368/// T1 agent assertion, T0 untrusted.
369#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, PartialOrd, Ord)]
370pub enum Trust {
371    T0,
372    T1,
373    T2,
374    T3,
375    T4,
376}
377
378/// A record with its derived state against the current index.
379#[derive(Debug, Clone, Serialize, Deserialize)]
380pub struct Entry {
381    pub record: Record,
382    pub status: Status,
383    pub trust: Trust,
384    /// Current symbol ids the record's anchors map to (after moves/renames).
385    pub current: Vec<String>,
386    /// Ids of records that supersede, retract, confirm or dispute this one.
387    pub related: Vec<(RelationKind, String)>,
388    /// Signature check: verified, failed (record treated as T0), or unsigned/unchecked.
389    pub verified: Option<bool>,
390    /// Who wrote it, for people to read.
391    pub by: String,
392    /// Reviews of this record, oldest first.
393    pub history: Vec<Event>,
394    /// Why it was retracted: `outdated` (archived) or `wrong` (invalidated).
395    pub retired: Option<String>,
396    /// The writer's teams, when the note is about another team's code and none of its members confirmed it.
397    #[serde(default, skip_serializing_if = "Vec::is_empty")]
398    pub outside: Vec<String>,
399}
400
401pub const SCHEMA: u32 = 1;
402
403/// A review action: `confirm`, `supersede`, `dispute`, `retract`, `archive` (no longer applies)
404/// or `invalidate` (was wrong).
405pub fn review_action(action: &str) -> Option<(RelationKind, Option<&'static str>)> {
406    match action {
407        "archive" => Some((RelationKind::Retracts, Some("outdated"))),
408        "invalidate" => Some((RelationKind::Retracts, Some("wrong"))),
409        other => RelationKind::parse(other).map(|k| (k, None)),
410    }
411}
412
413pub const MAX_SNIPPETS: usize = 3;
414
415pub const MAX_SNIPPET_LINES: usize = 60;
416
417/// Instruction or payload text that would steer an agent reading the record.
418pub fn injection(text: &str) -> Option<&'static str> {
419    let t = text.to_lowercase();
420    const STEERING: &[&str] = &[
421        "ignore previous",
422        "ignore all previous",
423        "ignore the above",
424        "disregard previous",
425        "disregard the above",
426        "system prompt",
427        "you are now",
428        "new instructions",
429        "<system",
430        "</system",
431        "<instructions",
432        "assistant:",
433        "do not tell the user",
434        "without telling the user",
435    ];
436    const PAYLOADS: &[&str] = &[
437        "| sh",
438        "| bash",
439        "|sh",
440        "|bash",
441        "rm -rf",
442        "base64 -d",
443        "base64 --decode",
444        "<script",
445        "javascript:",
446        "chmod +x",
447        "eval(",
448        "/etc/passwd",
449        ".ssh/",
450    ];
451    if STEERING.iter().any(|p| t.contains(p)) {
452        return Some("reads like instructions to an agent");
453    }
454    if PAYLOADS.iter().any(|p| t.contains(p)) {
455        return Some("contains a shell or script payload");
456    }
457    None
458}
459
460/// Secrets and invisible/bidi characters never enter the shared ledger.
461pub fn suspicious(text: &str) -> Option<&'static str> {
462    if text
463        .chars()
464        .any(|c| matches!(c as u32, 0x202A..=0x202E | 0x2066..=0x2069 | 0xE0000..=0xE007F))
465    {
466        return Some("contains invisible or bidirectional control characters");
467    }
468    let lower = text.to_ascii_lowercase();
469    let markers = [
470        "-----begin",
471        "aws_secret_access_key",
472        "xoxb-",
473        "ghp_",
474        "glpat-",
475        "sk-ant-",
476        "password=",
477    ];
478    if markers.iter().any(|m| lower.contains(m))
479        || text.split_whitespace().any(|w| {
480            w.starts_with("AKIA") && w.len() == 20 && w.chars().all(|c| c.is_ascii_alphanumeric())
481        })
482    {
483        return Some("looks like it contains a secret");
484    }
485    None
486}
487
488#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
489pub struct Signature {
490    /// Public key, `ssh-ed25519 AAAA…`.
491    pub key: String,
492    /// Armored SSHSIG over the record without its signature.
493    pub sig: String,
494}
495
496/// One review of a record.
497#[derive(Debug, Clone, Serialize, Deserialize)]
498pub struct Event {
499    pub id: String,
500    /// `confirm`, `supersede`, `dispute`, `retract`, `archive` or `invalidate`.
501    pub action: String,
502    pub who: String,
503    pub at: String,
504    pub reason: String,
505    /// False when it could not take effect (a machine retiring a human-backed record).
506    pub counted: bool,
507}
comindly_api/ledger.rs

comindly_api/
ledger.rs
