receipts.rs 82.5%

99 of 120 lines run, 15 of 26 functions · run #309 on main · run missed

//! Execution receipts in a repository (spec §14.6): kept beside the state
//! they were made on, with the runner's identity and signature.

use super::*;
use crate::receipt::SignedReceipt;

/// A stored receipt and what verifying it found.
#[derive(Clone, Debug)]
pub struct ReceiptInfo {
    /// The receipt attestation's ObjectRef, which names it.
    pub attest: ObjectRef,
    pub signed: SignedReceipt,
    /// Why it does not verify, if it does not.
    pub problem: Option<String>,
    /// The runner's key was revoked (spec §14.2).
    pub revoked: bool,
}

impl Repo {
    /// Verify `sr` and keep it: the receipt, the attestation with its
    /// signatures, and the runner's identity. Returns the attestation's
    /// ObjectRef. Receipts for another repository are refused.
    pub fn add_receipt(&self, sr: &SignedReceipt) -> Result<ObjectRef> {
        sr.verify()
            .map_err(|e| RepoError::Msg(format!("receipt does not verify: {e}")))?;
        if sr.attest.repo != self.id()? {
            return fail("that receipt is for another repository");
        }
        self.store.put_identity(&sr.runner)?;
        self.store.put_receipt(&sr.receipt)?;
        let r = self.store.put_attest(&sr.attest)?;
        for sig in &sr.sigs {
            self.store.put_signature(&r, sig)?;
        }
        self.store.index_receipt(&sr.state(), &r)?;
        Ok(r)
    }

    /// The receipt named by attestation `r`, verified again from the store.
    pub fn receipt(&self, r: &ObjectRef) -> Result<ReceiptInfo> {
        let attest = self.store.get_attest(r)?;
        let AttestBody::Receipt { receipt, .. } = &attest.body else {
            return fail(format!("#{} is not a receipt", r.short(12)));
        };
        let receipt = self.store.get_receipt(receipt)?;
        let sigs = self.store.signatures(r)?;
        let Some(key) = sigs.first().map(|s| s.key) else {
            return fail(format!("receipt #{} has no signature", r.short(12)));
        };
        let runner = self.store.get_identity(&key)?;
        let signed = SignedReceipt {
            receipt,
            attest,
            sigs,
            runner,
        };
        let problem = signed.verify().err().map(|e| e.to_string());
        Ok(ReceiptInfo {
            attest: *r,
            revoked: self.is_revoked(&key)?,
            signed,
            problem,
        })
    }

    /// Every receipt kept for the state of `heads`, oldest first.
    pub fn receipts(&self, heads: &[ChangeHash]) -> Result<Vec<ReceiptInfo>> {
        let state = hash_object(
            ObjectType::State,
            &StateObject::new(heads.to_vec()).encode(),
        );
        let mut out = self
            .store
            .receipts_for(&state)?
            .iter()
            .map(|r| self.receipt(r))
            .collect::<Result<Vec<_>>>()?;
        out.sort_by_key(|i| i.signed.attest.hlc);
        Ok(out)
    }

    /// Receipts to keep through garbage collection: those whose state's
    /// heads `keep` holds, with their receipts, runners and outputs.
    /// Keep a signed approval (oxygenhub#235): verified, for this repository,
    /// with the signer's identity and indexed by the state it approves, so
    /// garbage collection keeps it while that state lives. Who may approve is
    /// the caller's rule.
    pub fn add_approval(&self, sa: &crate::approval::SignedApproval) -> Result<ObjectRef> {
        sa.verify()
            .map_err(|e| RepoError::Msg(format!("approval does not verify: {e}")))?;
        if sa.attest.repo != self.id()? {
            return fail("that approval is for another repository");
        }
        let state = sa
            .statement()
            .map_err(|e| RepoError::Msg(e.to_string()))?
            .state;
        self.store.put_identity(&sa.signer)?;
        let r = self.store.put_attest(&sa.attest)?;
        for sig in &sa.sigs {
            self.store.put_signature(&r, sig)?;
        }
        self.store.index_approval(&state, &r)?;
        Ok(r)
    }

    /// Approvals of states garbage collection keeps are kept, with their
    /// signatures and signers.
    pub(crate) fn reachable_approvals(&self, keep: &mut HashSet<ObjectRef>) -> Result<()> {
        for state in self.store.approval_states()? {
            if !keep.contains(&state) {
                let heads = match self.store.get_state(&state) {
                    Ok(s) => s.heads,
                    Err(StoreError::NotFound(_)) => vec![],
                    Err(e) => return Err(e.into()),
                };
                if !heads.iter().all(|h| keep.contains(h)) {
                    continue;
                }
                keep.insert(state);
            }
            for a in self.store.approvals_for(&state)? {
                keep.insert(a);
                for sig in self.store.signatures(&a)? {
                    keep.insert(sig.key);
                }
            }
        }
        Ok(())
    }

    pub(crate) fn reachable_receipts(&self, keep: &mut HashSet<ObjectRef>) -> Result<()> {
        for state in self.store.receipt_states()? {
            let heads = match self.store.get_state(&state) {
                Ok(s) => s.heads,
                // A receipt may arrive before its state object; its heads
                // are unknown, so keep it.
                Err(StoreError::NotFound(_)) => vec![],
                Err(e) => return Err(e.into()),
            };
            if !heads.iter().all(|h| keep.contains(h)) {
                continue;
            }
            keep.insert(state);
            for a in self.store.receipts_for(&state)? {
                keep.insert(a);
                for sig in self.store.signatures(&a)? {
                    keep.insert(sig.key);
                }
                let Ok(attest) = self.store.get_attest(&a) else {
                    continue;
                };
                let AttestBody::Receipt { receipt, .. } = attest.body else {
                    continue;
                };
                keep.insert(receipt);
                let Ok(r) = self.store.get_receipt(&receipt) else {
                    continue;
                };
                for b in r.outputs.iter().chain(&r.inputs) {
                    if keep.insert(*b) {
                        if let Ok(bytes) = self.store.get_typed(b, ObjectType::Blob) {
                            keep.extend(Blob::decode(&bytes)?.chunks);
                        }
                    }
                }
            }
        }
        Ok(())
    }
}

1		//! Execution receipts in a repository (spec §14.6): kept beside the state
2		//! they were made on, with the runner's identity and signature.
3
4		use super::*;
5		use crate::receipt::SignedReceipt;
6
7		/// A stored receipt and what verifying it found.
8		#[derive(Clone, Debug)]
9		pub struct ReceiptInfo {
10		/// The receipt attestation's ObjectRef, which names it.
11		pub attest: ObjectRef,
12		pub signed: SignedReceipt,
13		/// Why it does not verify, if it does not.
14		pub problem: Option<String>,
15		/// The runner's key was revoked (spec §14.2).
16		pub revoked: bool,
17		}
18
19		impl Repo {
20		/// Verify `sr` and keep it: the receipt, the attestation with its
21		/// signatures, and the runner's identity. Returns the attestation's
22		/// ObjectRef. Receipts for another repository are refused.
23	5×	pub fn add_receipt(&self, sr: &SignedReceipt) -> Result<ObjectRef> {
24	5×	sr.verify()
25	5×	.map_err(\|e\| RepoError::Msg(format!("receipt does not verify: {e}")))?;
26	3×	if sr.attest.repo != self.id()? {
27	1×	return fail("that receipt is for another repository");
28	2×	}
29	2×	self.store.put_identity(&sr.runner)?;
30	2×	self.store.put_receipt(&sr.receipt)?;
31	2×	let r = self.store.put_attest(&sr.attest)?;
32	2×	for sig in &sr.sigs {
33	2×	self.store.put_signature(&r, sig)?;
34		}
35	2×	self.store.index_receipt(&sr.state(), &r)?;
36	2×	Ok(r)
37	5×	}
38
39		/// The receipt named by attestation `r`, verified again from the store.
40	7×	pub fn receipt(&self, r: &ObjectRef) -> Result<ReceiptInfo> {
41	7×	let attest = self.store.get_attest(r)?;
42	7×	let AttestBody::Receipt { receipt, .. } = &attest.body else {
43	0×	return fail(format!("#{} is not a receipt", r.short(12)));
44		};
45	7×	let receipt = self.store.get_receipt(receipt)?;
46	7×	let sigs = self.store.signatures(r)?;
47	7×	let Some(key) = sigs.first().map(\|s\| s.key) else {
48	0×	return fail(format!("receipt #{} has no signature", r.short(12)));
49		};
50	7×	let runner = self.store.get_identity(&key)?;
51	7×	let signed = SignedReceipt {
52	7×	receipt,
53	7×	attest,
54	7×	sigs,
55	7×	runner,
56	7×	};
57	7×	let problem = signed.verify().err().map(\|e\| e.to_string());
58		Ok(ReceiptInfo {
59	7×	attest: *r,
60	7×	revoked: self.is_revoked(&key)?,
61	7×	signed,
62	7×	problem,
63		})
64	7×	}
65
66		/// Every receipt kept for the state of `heads`, oldest first.
67	9×	pub fn receipts(&self, heads: &[ChangeHash]) -> Result<Vec<ReceiptInfo>> {
68	9×	let state = hash_object(
69	9×	ObjectType::State,
70	9×	&StateObject::new(heads.to_vec()).encode(),
71		);
72	9×	let mut out = self
73	9×	.store
74	9×	.receipts_for(&state)?
75	9×	.iter()
76	9×	.map(\|r\| self.receipt(r))
77	9×	.collect::<Result<Vec<_>>>()?;
78	9×	out.sort_by_key(\|i\| i.signed.attest.hlc);
79	9×	Ok(out)
80	9×	}
81
82		/// Receipts to keep through garbage collection: those whose state's
83		/// heads `keep` holds, with their receipts, runners and outputs.
84		/// Keep a signed approval (oxygenhub#235): verified, for this repository,
85		/// with the signer's identity and indexed by the state it approves, so
86		/// garbage collection keeps it while that state lives. Who may approve is
87		/// the caller's rule.
88	3×	pub fn add_approval(&self, sa: &crate::approval::SignedApproval) -> Result<ObjectRef> {
89	3×	sa.verify()
90	3×	.map_err(\|e\| RepoError::Msg(format!("approval does not verify: {e}")))?;
91	2×	if sa.attest.repo != self.id()? {
92	1×	return fail("that approval is for another repository");
93	1×	}
94	1×	let state = sa
95	1×	.statement()
96	1×	.map_err(\|e\| RepoError::Msg(e.to_string()))?
97		.state;
98	1×	self.store.put_identity(&sa.signer)?;
99	1×	let r = self.store.put_attest(&sa.attest)?;
100	1×	for sig in &sa.sigs {
101	1×	self.store.put_signature(&r, sig)?;
102		}
103	1×	self.store.index_approval(&state, &r)?;
104	1×	Ok(r)
105	3×	}
106
107		/// Approvals of states garbage collection keeps are kept, with their
108		/// signatures and signers.
109	17×	pub(crate) fn reachable_approvals(&self, keep: &mut HashSet<ObjectRef>) -> Result<()> {
110	17×	for state in self.store.approval_states()? {
111	1×	if !keep.contains(&state) {
112	0×	let heads = match self.store.get_state(&state) {
113	0×	Ok(s) => s.heads,
114	0×	Err(StoreError::NotFound(_)) => vec![],
115	0×	Err(e) => return Err(e.into()),
116		};
117	0×	if !heads.iter().all(\|h\| keep.contains(h)) {
118	0×	continue;
119	0×	}
120	0×	keep.insert(state);
121	1×	}
122	1×	for a in self.store.approvals_for(&state)? {
123	1×	keep.insert(a);
124	1×	for sig in self.store.signatures(&a)? {
125	1×	keep.insert(sig.key);
126	1×	}
127		}
128		}
129	17×	Ok(())
130	17×	}
131
132	17×	pub(crate) fn reachable_receipts(&self, keep: &mut HashSet<ObjectRef>) -> Result<()> {
133	17×	for state in self.store.receipt_states()? {
134	1×	let heads = match self.store.get_state(&state) {
135	1×	Ok(s) => s.heads,
136		// A receipt may arrive before its state object; its heads
137		// are unknown, so keep it.
138	0×	Err(StoreError::NotFound(_)) => vec![],
139	0×	Err(e) => return Err(e.into()),
140		};
141	1×	if !heads.iter().all(\|h\| keep.contains(h)) {
142	0×	continue;
143	1×	}
144	1×	keep.insert(state);
145	1×	for a in self.store.receipts_for(&state)? {
146	1×	keep.insert(a);
147	1×	for sig in self.store.signatures(&a)? {
148	1×	keep.insert(sig.key);
149	1×	}
150	1×	let Ok(attest) = self.store.get_attest(&a) else {
151	0×	continue;
152		};
153	1×	let AttestBody::Receipt { receipt, .. } = attest.body else {
154	0×	continue;
155		};
156	1×	keep.insert(receipt);
157	1×	let Ok(r) = self.store.get_receipt(&receipt) else {
158	0×	continue;
159		};
160	1×	for b in r.outputs.iter().chain(&r.inputs) {
161	1×	if keep.insert(*b) {
162	1×	if let Ok(bytes) = self.store.get_typed(b, ObjectType::Blob) {
163	1×	keep.extend(Blob::decode(&bytes)?.chunks);
164	0×	}
165	0×	}
166		}
167		}
168		}
169	17×	Ok(())
170	17×	}
171		}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

Coverage / crates/oxy-core/src/repo/receipts.rs 82.5%

Keyboard