receipt.rs 94.4%

169 of 179 lines run, 37 of 45 functions · run #299 on main · run missed

//! Execution receipts (spec §14.6): what a runner ran, in what, on which
//! inputs and with what result. A receipt names no state, so the same
//! receipt serves every state whose scope is unchanged; an attestation of
//! kind `receipt`, signed by the runner, binds it to the state it ran on.

use crate::attest::{Attest, AttestBody};
use crate::cbor::{self, Value};
use crate::hash::{hash_object, ObjectRef, ObjectType};
use crate::identity::{verify, Domain, Identity, SecretKey, Signature};
use crate::objects::{array, bytes, check_version, field, map, oref, text, uint, Hlc, ObjectError};

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Receipt {
    pub job_name: String,
    /// The pipeline definition the job came from.
    pub pipeline_hash: ObjectRef,
    /// BLAKE3 over the sorted (path, content) of the files the job's scope
    /// matches; the whole tree when it has no scope.
    pub scope_tree_hash: ObjectRef,
    /// Artifacts and other inputs consumed beyond the tree.
    pub inputs: Vec<ObjectRef>,
    /// What the job ran in: isolation tier, rootfs, argv and environment.
    pub environment: ObjectRef,
    /// Blobs the job produced.
    pub outputs: Vec<ObjectRef>,
    pub exit_code: u32,
    pub duration_ms: u64,
}

fn refs(v: &[ObjectRef]) -> Value {
    Value::Array(v.iter().map(|h| Value::Bytes(h.0.to_vec())).collect())
}

fn refs_from(v: &Value, what: &str) -> Result<Vec<ObjectRef>, ObjectError> {
    array(v, what)?.iter().map(|h| oref(h, what)).collect()
}

impl Receipt {
    pub fn passed(&self) -> bool {
        self.exit_code == 0
    }

    pub fn to_value(&self) -> Value {
        Value::map([
            (0, Value::Uint(1)),
            (1, Value::Text(self.job_name.clone())),
            (2, Value::Bytes(self.pipeline_hash.0.to_vec())),
            (3, Value::Bytes(self.scope_tree_hash.0.to_vec())),
            (4, refs(&self.inputs)),
            (5, Value::Bytes(self.environment.0.to_vec())),
            (6, refs(&self.outputs)),
            (7, Value::Uint(self.exit_code as u64)),
            (8, Value::Uint(self.duration_ms)),
        ])
    }

    pub fn encode(&self) -> Vec<u8> {
        cbor::encode(&self.to_value())
    }

    pub fn hash(&self) -> ObjectRef {
        hash_object(ObjectType::Receipt, &self.encode())
    }

    pub fn decode(b: &[u8]) -> Result<Receipt, ObjectError> {
        let v = cbor::decode(b)?;
        let m = map(&v, "receipt")?;
        check_version(m)?;
        let exit_code = uint(field(m, 7, "exit_code")?, "exit_code")?;
        Ok(Receipt {
            job_name: text(field(m, 1, "job_name")?, "job_name")?.to_owned(),
            pipeline_hash: oref(field(m, 2, "pipeline_hash")?, "pipeline_hash")?,
            scope_tree_hash: oref(field(m, 3, "scope_tree_hash")?, "scope_tree_hash")?,
            inputs: refs_from(field(m, 4, "inputs")?, "inputs")?,
            environment: oref(field(m, 5, "environment")?, "environment")?,
            outputs: refs_from(field(m, 6, "outputs")?, "outputs")?,
            exit_code: u32::try_from(exit_code)
                .map_err(|_| ObjectError::Schema("exit_code: expected u32".into()))?,
            duration_ms: uint(field(m, 8, "duration_ms")?, "duration_ms")?,
        })
    }
}

#[derive(Clone, Debug, PartialEq, Eq, thiserror::Error)]
pub enum ReceiptError {
    #[error("the attestation is not of kind receipt")]
    NotReceipt,
    #[error("the attestation names a different receipt")]
    WrongReceipt,
    #[error("no signature by the runner {0}")]
    Unsigned(String),
    #[error("the runner's signature does not verify: {0}")]
    BadSignature(String),
    #[error("{0}")]
    Schema(String),
}

impl From<ObjectError> for ReceiptError {
    fn from(e: ObjectError) -> Self {
        ReceiptError::Schema(e.to_string())
    }
}

/// A receipt as a runner hands it over: the receipt, the attestation
/// binding it to a state, the runner's signature over that attestation, and
/// the runner's identity, so it verifies with nothing else.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct SignedReceipt {
    pub receipt: Receipt,
    pub attest: Attest,
    pub sigs: Vec<Signature>,
    pub runner: Identity,
}

impl SignedReceipt {
    /// Bind `receipt` to `state` of repository `repo` for run `run` (a URL
    /// or other name of the run), signed by `runner` with `sk`.
    pub fn sign(
        receipt: Receipt,
        repo: [u8; 16],
        state: ObjectRef,
        run: &str,
        runner: &Identity,
        sk: &SecretKey,
    ) -> SignedReceipt {
        let attest = Attest {
            repo,
            hlc: Hlc::now(),
            body: AttestBody::Receipt {
                receipt: receipt.hash(),
                state,
                run: run.into(),
            },
        };
        let sig = sk.sign(Domain::Attest, &runner.hash(), &attest.hash());
        SignedReceipt {
            receipt,
            attest,
            sigs: vec![sig],
            runner: runner.clone(),
        }
    }

    /// The state the receipt was made on.
    pub fn state(&self) -> ObjectRef {
        match &self.attest.body {
            AttestBody::Receipt { state, .. } => *state,
            _ => ObjectRef([0; 32]),
        }
    }

    pub fn run(&self) -> &str {
        match &self.attest.body {
            AttestBody::Receipt { run, .. } => run,
            _ => "",
        }
    }

    /// The attestation is a receipt attestation for this receipt, and the
    /// runner signed it. Whether to trust the runner is the reader's call.
    pub fn verify(&self) -> Result<(), ReceiptError> {
        let AttestBody::Receipt { receipt, .. } = &self.attest.body else {
            return Err(ReceiptError::NotReceipt);
        };
        if *receipt != self.receipt.hash() {
            return Err(ReceiptError::WrongReceipt);
        }
        let key = self.runner.hash();
        let target = self.attest.hash();
        let sig = self
            .sigs
            .iter()
            .find(|s| s.key == key)
            .ok_or_else(|| ReceiptError::Unsigned(key.short(12)))?;
        verify(&self.runner, sig, Domain::Attest, &target)
            .map_err(|e| ReceiptError::BadSignature(e.to_string()))
    }

    /// `[receipt, attest, [Signature], identity]`, each object as its bytes.
    pub fn encode(&self) -> Vec<u8> {
        cbor::encode(&Value::Array(vec![
            Value::Bytes(self.receipt.encode()),
            Value::Bytes(self.attest.encode()),
            Value::Array(self.sigs.iter().map(|s| s.to_value()).collect()),
            Value::Bytes(self.runner.encode()),
        ]))
    }

    pub fn decode(b: &[u8]) -> Result<SignedReceipt, ReceiptError> {
        let v = cbor::decode(b).map_err(ObjectError::from)?;
        let a = array(&v, "signed receipt")?;
        if a.len() != 4 {
            return Err(ReceiptError::Schema(
                "signed receipt: expected [receipt, attest, sigs, identity]".into(),
            ));
        }
        Ok(SignedReceipt {
            receipt: Receipt::decode(bytes(&a[0], "receipt")?)?,
            attest: Attest::decode(bytes(&a[1], "attest")?)?,
            sigs: array(&a[2], "sigs")?
                .iter()
                .map(Signature::from_value)
                .collect::<Result<_, _>>()?,
            runner: Identity::decode(bytes(&a[3], "identity")?)?,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    pub(crate) fn sample() -> Receipt {
        Receipt {
            job_name: "test".into(),
            pipeline_hash: ObjectRef([1; 32]),
            scope_tree_hash: ObjectRef([2; 32]),
            inputs: vec![],
            environment: ObjectRef([3; 32]),
            outputs: vec![ObjectRef([4; 32])],
            exit_code: 0,
            duration_ms: 1500,
        }
    }

    #[test]
    fn receipts_round_trip_and_hash_as_receipt_objects() {
        let r = sample();
        assert_eq!(Receipt::decode(&r.encode()).unwrap(), r);
        let mut h = blake3::Hasher::new();
        h.update(format!("oxy1 receipt {}\0", r.encode().len()).as_bytes());
        h.update(&r.encode());
        assert_eq!(
            r.hash().0,
            *h.finalize().as_bytes(),
            "OxygenFlow's receipt hash"
        );
        assert!(r.passed());
    }

    #[test]
    fn a_signed_receipt_verifies_and_tampering_does_not() {
        let sk = SecretKey::generate();
        let runner = sk.identity("earth-1", "runner@earth", 1);
        let sr = SignedReceipt::sign(
            sample(),
            [7; 16],
            ObjectRef([9; 32]),
            "andy/demo#3",
            &runner,
            &sk,
        );
        sr.verify().unwrap();
        let back = SignedReceipt::decode(&sr.encode()).unwrap();
        assert_eq!(back, sr);
        assert_eq!(back.state(), ObjectRef([9; 32]));
        assert_eq!(back.run(), "andy/demo#3");

        let mut forged = sr.clone();
        forged.receipt.exit_code = 0;
        forged.receipt.duration_ms = 1;
        assert_eq!(forged.verify(), Err(ReceiptError::WrongReceipt));

        let mut moved = sr.clone();
        if let AttestBody::Receipt { state, .. } = &mut moved.attest.body {
            *state = ObjectRef([8; 32]);
        }
        assert!(matches!(moved.verify(), Err(ReceiptError::BadSignature(_))));

        let other = SecretKey::generate().identity("mallory", "m@x", 1);
        let mut swapped = sr.clone();
        swapped.runner = other;
        assert!(matches!(swapped.verify(), Err(ReceiptError::Unsigned(_))));
    }
}

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

1		//! Execution receipts (spec §14.6): what a runner ran, in what, on which
2		//! inputs and with what result. A receipt names no state, so the same
3		//! receipt serves every state whose scope is unchanged; an attestation of
4		//! kind `receipt`, signed by the runner, binds it to the state it ran on.
5
6		use crate::attest::{Attest, AttestBody};
7		use crate::cbor::{self, Value};
8		use crate::hash::{hash_object, ObjectRef, ObjectType};
9		use crate::identity::{verify, Domain, Identity, SecretKey, Signature};
10		use crate::objects::{array, bytes, check_version, field, map, oref, text, uint, Hlc, ObjectError};
11
12		#[derive(Clone, Debug, PartialEq, Eq)]
13		pub struct Receipt {
14		pub job_name: String,
15		/// The pipeline definition the job came from.
16		pub pipeline_hash: ObjectRef,
17		/// BLAKE3 over the sorted (path, content) of the files the job's scope
18		/// matches; the whole tree when it has no scope.
19		pub scope_tree_hash: ObjectRef,
20		/// Artifacts and other inputs consumed beyond the tree.
21		pub inputs: Vec<ObjectRef>,
22		/// What the job ran in: isolation tier, rootfs, argv and environment.
23		pub environment: ObjectRef,
24		/// Blobs the job produced.
25		pub outputs: Vec<ObjectRef>,
26		pub exit_code: u32,
27		pub duration_ms: u64,
28		}
29
30	78×	fn refs(v: &[ObjectRef]) -> Value {
31	78×	Value::Array(v.iter().map(\|h\| Value::Bytes(h.0.to_vec())).collect())
32	78×	}
33
34	30×	fn refs_from(v: &Value, what: &str) -> Result<Vec<ObjectRef>, ObjectError> {
35	30×	array(v, what)?.iter().map(\|h\| oref(h, what)).collect()
36	30×	}
37
38		impl Receipt {
39	2×	pub fn passed(&self) -> bool {
40	2×	self.exit_code == 0
41	2×	}
42
43	39×	pub fn to_value(&self) -> Value {
44	39×	Value::map([
45	39×	(0, Value::Uint(1)),
46	39×	(1, Value::Text(self.job_name.clone())),
47	39×	(2, Value::Bytes(self.pipeline_hash.0.to_vec())),
48	39×	(3, Value::Bytes(self.scope_tree_hash.0.to_vec())),
49	39×	(4, refs(&self.inputs)),
50	39×	(5, Value::Bytes(self.environment.0.to_vec())),
51	39×	(6, refs(&self.outputs)),
52	39×	(7, Value::Uint(self.exit_code as u64)),
53	39×	(8, Value::Uint(self.duration_ms)),
54	39×	])
55	39×	}
56
57	39×	pub fn encode(&self) -> Vec<u8> {
58	39×	cbor::encode(&self.to_value())
59	39×	}
60
61	27×	pub fn hash(&self) -> ObjectRef {
62	27×	hash_object(ObjectType::Receipt, &self.encode())
63	27×	}
64
65	15×	pub fn decode(b: &[u8]) -> Result<Receipt, ObjectError> {
66	15×	let v = cbor::decode(b)?;
67	15×	let m = map(&v, "receipt")?;
68	15×	check_version(m)?;
69	15×	let exit_code = uint(field(m, 7, "exit_code")?, "exit_code")?;
70		Ok(Receipt {
71	15×	job_name: text(field(m, 1, "job_name")?, "job_name")?.to_owned(),
72	15×	pipeline_hash: oref(field(m, 2, "pipeline_hash")?, "pipeline_hash")?,
73	15×	scope_tree_hash: oref(field(m, 3, "scope_tree_hash")?, "scope_tree_hash")?,
74	15×	inputs: refs_from(field(m, 4, "inputs")?, "inputs")?,
75	15×	environment: oref(field(m, 5, "environment")?, "environment")?,
76	15×	outputs: refs_from(field(m, 6, "outputs")?, "outputs")?,
77	15×	exit_code: u32::try_from(exit_code)
78	15×	.map_err(\|_\| ObjectError::Schema("exit_code: expected u32".into()))?,
79	15×	duration_ms: uint(field(m, 8, "duration_ms")?, "duration_ms")?,
80		})
81	15×	}
82		}
83
84		#[derive(Clone, Debug, PartialEq, Eq, thiserror::Error)]
85		pub enum ReceiptError {
86		#[error("the attestation is not of kind receipt")]
87		NotReceipt,
88		#[error("the attestation names a different receipt")]
89		WrongReceipt,
90		#[error("no signature by the runner {0}")]
91		Unsigned(String),
92		#[error("the runner's signature does not verify: {0}")]
93		BadSignature(String),
94		#[error("{0}")]
95		Schema(String),
96		}
97
98		impl From<ObjectError> for ReceiptError {
99	0×	fn from(e: ObjectError) -> Self {
100	0×	ReceiptError::Schema(e.to_string())
101	0×	}
102		}
103
104		/// A receipt as a runner hands it over: the receipt, the attestation
105		/// binding it to a state, the runner's signature over that attestation, and
106		/// the runner's identity, so it verifies with nothing else.
107		#[derive(Clone, Debug, PartialEq, Eq)]
108		pub struct SignedReceipt {
109		pub receipt: Receipt,
110		pub attest: Attest,
111		pub sigs: Vec<Signature>,
112		pub runner: Identity,
113		}
114
115		impl SignedReceipt {
116		/// Bind `receipt` to `state` of repository `repo` for run `run` (a URL
117		/// or other name of the run), signed by `runner` with `sk`.
118	4×	pub fn sign(
119	4×	receipt: Receipt,
120	4×	repo: [u8; 16],
121	4×	state: ObjectRef,
122	4×	run: &str,
123	4×	runner: &Identity,
124	4×	sk: &SecretKey,
125	4×	) -> SignedReceipt {
126	4×	let attest = Attest {
127	4×	repo,
128	4×	hlc: Hlc::now(),
129	4×	body: AttestBody::Receipt {
130	4×	receipt: receipt.hash(),
131	4×	state,
132	4×	run: run.into(),
133	4×	},
134	4×	};
135	4×	let sig = sk.sign(Domain::Attest, &runner.hash(), &attest.hash());
136	4×	SignedReceipt {
137	4×	receipt,
138	4×	attest,
139	4×	sigs: vec![sig],
140	4×	runner: runner.clone(),
141	4×	}
142	4×	}
143
144		/// The state the receipt was made on.
145	9×	pub fn state(&self) -> ObjectRef {
146	9×	match &self.attest.body {
147	9×	AttestBody::Receipt { state, .. } => *state,
148	0×	_ => ObjectRef([0; 32]),
149		}
150	9×	}
151
152	7×	pub fn run(&self) -> &str {
153	7×	match &self.attest.body {
154	7×	AttestBody::Receipt { run, .. } => run,
155	0×	_ => "",
156		}
157	7×	}
158
159		/// The attestation is a receipt attestation for this receipt, and the
160		/// runner signed it. Whether to trust the runner is the reader's call.
161	18×	pub fn verify(&self) -> Result<(), ReceiptError> {
162	18×	let AttestBody::Receipt { receipt, .. } = &self.attest.body else {
163	0×	return Err(ReceiptError::NotReceipt);
164		};
165	18×	if *receipt != self.receipt.hash() {
166	4×	return Err(ReceiptError::WrongReceipt);
167	14×	}
168	14×	let key = self.runner.hash();
169	14×	let target = self.attest.hash();
170	14×	let sig = self
171	14×	.sigs
172	14×	.iter()
173	14×	.find(\|s\| s.key == key)
174	14×	.ok_or_else(\|\| ReceiptError::Unsigned(key.short(12)))?;
175	13×	verify(&self.runner, sig, Domain::Attest, &target)
176	13×	.map_err(\|e\| ReceiptError::BadSignature(e.to_string()))
177	18×	}
178
179		/// `[receipt, attest, [Signature], identity]`, each object as its bytes.
180	7×	pub fn encode(&self) -> Vec<u8> {
181	7×	cbor::encode(&Value::Array(vec![
182	7×	Value::Bytes(self.receipt.encode()),
183	7×	Value::Bytes(self.attest.encode()),
184	7×	Value::Array(self.sigs.iter().map(\|s\| s.to_value()).collect()),
185	7×	Value::Bytes(self.runner.encode()),
186		]))
187	7×	}
188
189	5×	pub fn decode(b: &[u8]) -> Result<SignedReceipt, ReceiptError> {
190	5×	let v = cbor::decode(b).map_err(ObjectError::from)?;
191	5×	let a = array(&v, "signed receipt")?;
192	5×	if a.len() != 4 {
193	0×	return Err(ReceiptError::Schema(
194	0×	"signed receipt: expected [receipt, attest, sigs, identity]".into(),
195	0×	));
196	5×	}
197		Ok(SignedReceipt {
198	5×	receipt: Receipt::decode(bytes(&a[0], "receipt")?)?,
199	5×	attest: Attest::decode(bytes(&a[1], "attest")?)?,
200	5×	sigs: array(&a[2], "sigs")?
201	5×	.iter()
202	5×	.map(Signature::from_value)
203	5×	.collect::<Result<_, _>>()?,
204	5×	runner: Identity::decode(bytes(&a[3], "identity")?)?,
205		})
206	5×	}
207		}
208
209		#[cfg(test)]
210		mod tests {
211		use super::*;
212
213	2×	pub(crate) fn sample() -> Receipt {
214	2×	Receipt {
215	2×	job_name: "test".into(),
216	2×	pipeline_hash: ObjectRef([1; 32]),
217	2×	scope_tree_hash: ObjectRef([2; 32]),
218	2×	inputs: vec![],
219	2×	environment: ObjectRef([3; 32]),
220	2×	outputs: vec![ObjectRef([4; 32])],
221	2×	exit_code: 0,
222	2×	duration_ms: 1500,
223	2×	}
224	2×	}
225
226		#[test]
227	1×	fn receipts_round_trip_and_hash_as_receipt_objects() {
228	1×	let r = sample();
229	1×	assert_eq!(Receipt::decode(&r.encode()).unwrap(), r);
230	1×	let mut h = blake3::Hasher::new();
231	1×	h.update(format!("oxy1 receipt {}\0", r.encode().len()).as_bytes());
232	1×	h.update(&r.encode());
233	1×	assert_eq!(
234	1×	r.hash().0,
235	1×	*h.finalize().as_bytes(),
236		"OxygenFlow's receipt hash"
237		);
238	1×	assert!(r.passed());
239	1×	}
240
241		#[test]
242	1×	fn a_signed_receipt_verifies_and_tampering_does_not() {
243	1×	let sk = SecretKey::generate();
244	1×	let runner = sk.identity("earth-1", "runner@earth", 1);
245	1×	let sr = SignedReceipt::sign(
246	1×	sample(),
247	1×	[7; 16],
248	1×	ObjectRef([9; 32]),
249	1×	"andy/demo#3",
250	1×	&runner,
251	1×	&sk,
252		);
253	1×	sr.verify().unwrap();
254	1×	let back = SignedReceipt::decode(&sr.encode()).unwrap();
255	1×	assert_eq!(back, sr);
256	1×	assert_eq!(back.state(), ObjectRef([9; 32]));
257	1×	assert_eq!(back.run(), "andy/demo#3");
258
259	1×	let mut forged = sr.clone();
260	1×	forged.receipt.exit_code = 0;
261	1×	forged.receipt.duration_ms = 1;
262	1×	assert_eq!(forged.verify(), Err(ReceiptError::WrongReceipt));
263
264	1×	let mut moved = sr.clone();
265	1×	if let AttestBody::Receipt { state, .. } = &mut moved.attest.body {
266	1×	*state = ObjectRef([8; 32]);
267	1×	}
268	1×	assert!(matches!(moved.verify(), Err(ReceiptError::BadSignature(_))));
269
270	1×	let other = SecretKey::generate().identity("mallory", "m@x", 1);
271	1×	let mut swapped = sr.clone();
272	1×	swapped.runner = other;
273	1×	assert!(matches!(swapped.verify(), Err(ReceiptError::Unsigned(_))));
274	1×	}
275		}

Coverage / crates/oxy-core/src/receipt.rs 94.4%

Keyboard