attest.rs 93.8%

196 of 209 lines run, 23 of 28 functions · run #307 on main · run missed

//! Attestations (spec §14.4): signed statements about references and batches
//! of changes, and runs (receipts, §14.6).

use crate::cbor::{self, Value};
use crate::hash::{hash_object, ChangeHash, KeyId, ObjectRef, ObjectType};
use crate::objects::{
    array, bytes, check_version, field, map, oref, text, uint, Hlc, ObjectError, FORMAT_VERSION,
};

pub const MAX_SEAL_HASHES: usize = 4096;

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum AttestBody {
    /// A bookmark moved from `old_state` to `new_state` (spec §10.2).
    Ref {
        name: String,
        old_state: ObjectRef,
        new_state: ObjectRef,
        serial: u64,
    },
    /// One signature covering a batch of changes (spec §14.4).
    Seal { hashes: Vec<ChangeHash> },
    /// An immutable named state (spec §10.1).
    Tag {
        name: String,
        state: ObjectRef,
        message: String,
    },
    /// The signing key's identity was replaced by `new` (spec §14.2).
    Rotate { new: KeyId },
    /// `key` must no longer be trusted (spec §14.2).
    Revoke { key: KeyId, reason: String },
    /// A runner ran the job of `receipt` on `state` (spec §14.6); `run`
    /// names the run, usually by URL.
    Receipt {
        receipt: ObjectRef,
        state: ObjectRef,
        run: String,
    },
    /// A person approved (or rejected) one job of one run (OxygenFlow
    /// approval gates; oxygenhub#235): the job as hashed with its sandbox,
    /// on that state, taking exactly those input blobs (a reviewed plan),
    /// for that environment. It approves nothing else.
    Approval {
        run: String,
        job: String,
        job_hash: ObjectRef,
        state: ObjectRef,
        inputs: Vec<ObjectRef>,
        environment: String,
        approve: bool,
    },
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Attest {
    /// Repository ID chosen at init.
    pub repo: [u8; 16],
    pub hlc: Hlc,
    pub body: AttestBody,
}

impl Attest {
    pub fn kind(&self) -> &'static str {
        match self.body {
            AttestBody::Ref { .. } => "ref",
            AttestBody::Seal { .. } => "seal",
            AttestBody::Tag { .. } => "tag",
            AttestBody::Rotate { .. } => "rotate",
            AttestBody::Revoke { .. } => "revoke",
            AttestBody::Receipt { .. } => "receipt",
            AttestBody::Approval { .. } => "approval",
        }
    }

    pub fn seal(repo: [u8; 16], mut hashes: Vec<ChangeHash>) -> Attest {
        hashes.sort();
        hashes.dedup();
        Attest {
            repo,
            hlc: Hlc::now(),
            body: AttestBody::Seal { hashes },
        }
    }

    pub fn to_value(&self) -> Value {
        let body = match &self.body {
            AttestBody::Ref {
                name,
                old_state,
                new_state,
                serial,
            } => Value::map([
                (0, Value::Text(name.clone())),
                (1, Value::Bytes(old_state.0.to_vec())),
                (2, Value::Bytes(new_state.0.to_vec())),
                (3, Value::Uint(*serial)),
            ]),
            AttestBody::Seal { hashes } => Value::map([(
                0,
                Value::Array(hashes.iter().map(|h| Value::Bytes(h.0.to_vec())).collect()),
            )]),
            AttestBody::Tag {
                name,
                state,
                message,
            } => Value::map([
                (0, Value::Text(name.clone())),
                (1, Value::Bytes(state.0.to_vec())),
                (2, Value::Text(message.clone())),
            ]),
            AttestBody::Rotate { new } => Value::map([(0, Value::Bytes(new.0.to_vec()))]),
            AttestBody::Revoke { key, reason } => Value::map([
                (0, Value::Bytes(key.0.to_vec())),
                (1, Value::Text(reason.clone())),
            ]),
            AttestBody::Receipt {
                receipt,
                state,
                run,
            } => Value::map([
                (0, Value::Bytes(receipt.0.to_vec())),
                (1, Value::Bytes(state.0.to_vec())),
                (2, Value::Text(run.clone())),
            ]),
            AttestBody::Approval {
                run,
                job,
                job_hash,
                state,
                inputs,
                environment,
                approve,
            } => Value::map([
                (0, Value::Text(run.clone())),
                (1, Value::Text(job.clone())),
                (2, Value::Bytes(job_hash.0.to_vec())),
                (3, Value::Bytes(state.0.to_vec())),
                (
                    4,
                    Value::Array(inputs.iter().map(|i| Value::Bytes(i.0.to_vec())).collect()),
                ),
                (5, Value::Text(environment.clone())),
                (6, Value::Uint(u64::from(*approve))),
            ]),
        };
        Value::map([
            (0, Value::Uint(FORMAT_VERSION)),
            (1, Value::Text(self.kind().into())),
            (2, Value::Bytes(self.repo.to_vec())),
            (3, self.hlc.to_value()),
            (4, body),
        ])
    }

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

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

    pub fn decode(b: &[u8]) -> Result<Attest, ObjectError> {
        let v = cbor::decode(b)?;
        let m = map(&v, "attest")?;
        check_version(m)?;
        let kind = text(field(m, 1, "kind")?, "kind")?;
        let repo: [u8; 16] = bytes(field(m, 2, "repo")?, "repo")?
            .try_into()
            .map_err(|_| ObjectError::Schema("repo: expected 16 bytes".into()))?;
        let hlc = Hlc::from_value(field(m, 3, "hlc")?)?;
        let b = map(field(m, 4, "body")?, "body")?;
        let body = match kind {
            "ref" => AttestBody::Ref {
                name: text(field(b, 0, "name")?, "name")?.to_owned(),
                old_state: oref(field(b, 1, "old_state")?, "old_state")?,
                new_state: oref(field(b, 2, "new_state")?, "new_state")?,
                serial: uint(field(b, 3, "serial")?, "serial")?,
            },
            "seal" => {
                let hashes = array(field(b, 0, "hashes")?, "hashes")?
                    .iter()
                    .map(|h| oref(h, "hash"))
                    .collect::<Result<Vec<_>, _>>()?;
                if hashes.is_empty()
                    || hashes.len() > MAX_SEAL_HASHES
                    || !hashes.windows(2).all(|w| w[0] < w[1])
                {
                    return Err(ObjectError::Schema(
                        "seal: hashes must be 1..4096, sorted and unique".into(),
                    ));
                }
                AttestBody::Seal { hashes }
            }
            "tag" => AttestBody::Tag {
                name: text(field(b, 0, "name")?, "name")?.to_owned(),
                state: oref(field(b, 1, "state")?, "state")?,
                message: text(field(b, 2, "message")?, "message")?.to_owned(),
            },
            "rotate" => AttestBody::Rotate {
                new: oref(field(b, 0, "new")?, "new")?,
            },
            "revoke" => AttestBody::Revoke {
                key: oref(field(b, 0, "key")?, "key")?,
                reason: text(field(b, 1, "reason")?, "reason")?.to_owned(),
            },
            "receipt" => AttestBody::Receipt {
                receipt: oref(field(b, 0, "receipt")?, "receipt")?,
                state: oref(field(b, 1, "state")?, "state")?,
                run: text(field(b, 2, "run")?, "run")?.to_owned(),
            },
            "approval" => {
                let inputs = array(field(b, 4, "inputs")?, "inputs")?
                    .iter()
                    .map(|h| oref(h, "input"))
                    .collect::<Result<Vec<_>, _>>()?;
                if !inputs.windows(2).all(|w| w[0] < w[1]) {
                    return Err(ObjectError::Schema(
                        "approval: inputs must be sorted and unique".into(),
                    ));
                }
                AttestBody::Approval {
                    run: text(field(b, 0, "run")?, "run")?.to_owned(),
                    job: text(field(b, 1, "job")?, "job")?.to_owned(),
                    job_hash: oref(field(b, 2, "job_hash")?, "job_hash")?,
                    state: oref(field(b, 3, "state")?, "state")?,
                    inputs,
                    environment: text(field(b, 5, "environment")?, "environment")?.to_owned(),
                    approve: match uint(field(b, 6, "approve")?, "approve")? {
                        0 => false,
                        1 => true,
                        _ => return Err(ObjectError::Schema("approval: approve is 0 or 1".into())),
                    },
                }
            }
            other => {
                return Err(ObjectError::Schema(format!(
                    "unknown attestation kind {other:?}"
                )))
            }
        };
        Ok(Attest { repo, hlc, body })
    }
}

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

    #[test]
    fn round_trips() {
        let r = Attest {
            repo: [1; 16],
            hlc: Hlc {
                wall_ms: 3,
                logical: 0,
            },
            body: AttestBody::Ref {
                name: "main".into(),
                old_state: ObjectRef([1; 32]),
                new_state: ObjectRef([2; 32]),
                serial: 7,
            },
        };
        assert_eq!(Attest::decode(&r.encode()).unwrap(), r);
        assert_eq!(r.kind(), "ref");
        let s = Attest::seal(
            [1; 16],
            vec![ObjectRef([9; 32]), ObjectRef([3; 32]), ObjectRef([9; 32])],
        );
        let d = Attest::decode(&s.encode()).unwrap();
        assert!(
            matches!(&d.body, AttestBody::Seal { hashes } if hashes == &vec![ObjectRef([3; 32]), ObjectRef([9; 32])])
        );
        assert_ne!(s.hash(), r.hash());
        let t = Attest {
            repo: [1; 16],
            hlc: Hlc::default(),
            body: AttestBody::Tag {
                name: "v1".into(),
                state: ObjectRef([5; 32]),
                message: "release".into(),
            },
        };
        assert_eq!(Attest::decode(&t.encode()).unwrap(), t);
        assert_eq!(t.kind(), "tag");
    }

    #[test]
    fn rejects_bad_seals() {
        let empty = Attest {
            repo: [0; 16],
            hlc: Hlc::default(),
            body: AttestBody::Seal { hashes: vec![] },
        };
        assert!(Attest::decode(&empty.encode()).is_err());
        let unsorted = Attest {
            repo: [0; 16],
            hlc: Hlc::default(),
            body: AttestBody::Seal {
                hashes: vec![ObjectRef([2; 32]), ObjectRef([1; 32])],
            },
        };
        assert!(Attest::decode(&unsorted.encode()).is_err());
    }
}

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

1		//! Attestations (spec §14.4): signed statements about references and batches
2		//! of changes, and runs (receipts, §14.6).
3
4		use crate::cbor::{self, Value};
5		use crate::hash::{hash_object, ChangeHash, KeyId, ObjectRef, ObjectType};
6		use crate::objects::{
7		array, bytes, check_version, field, map, oref, text, uint, Hlc, ObjectError, FORMAT_VERSION,
8		};
9
10		pub const MAX_SEAL_HASHES: usize = 4096;
11
12		#[derive(Clone, Debug, PartialEq, Eq)]
13		pub enum AttestBody {
14		/// A bookmark moved from `old_state` to `new_state` (spec §10.2).
15		Ref {
16		name: String,
17		old_state: ObjectRef,
18		new_state: ObjectRef,
19		serial: u64,
20		},
21		/// One signature covering a batch of changes (spec §14.4).
22		Seal { hashes: Vec<ChangeHash> },
23		/// An immutable named state (spec §10.1).
24		Tag {
25		name: String,
26		state: ObjectRef,
27		message: String,
28		},
29		/// The signing key's identity was replaced by `new` (spec §14.2).
30		Rotate { new: KeyId },
31		/// `key` must no longer be trusted (spec §14.2).
32		Revoke { key: KeyId, reason: String },
33		/// A runner ran the job of `receipt` on `state` (spec §14.6); `run`
34		/// names the run, usually by URL.
35		Receipt {
36		receipt: ObjectRef,
37		state: ObjectRef,
38		run: String,
39		},
40		/// A person approved (or rejected) one job of one run (OxygenFlow
41		/// approval gates; oxygenhub#235): the job as hashed with its sandbox,
42		/// on that state, taking exactly those input blobs (a reviewed plan),
43		/// for that environment. It approves nothing else.
44		Approval {
45		run: String,
46		job: String,
47		job_hash: ObjectRef,
48		state: ObjectRef,
49		inputs: Vec<ObjectRef>,
50		environment: String,
51		approve: bool,
52		},
53		}
54
55		#[derive(Clone, Debug, PartialEq, Eq)]
56		pub struct Attest {
57		/// Repository ID chosen at init.
58		pub repo: [u8; 16],
59		pub hlc: Hlc,
60		pub body: AttestBody,
61		}
62
63		impl Attest {
64	521×	pub fn kind(&self) -> &'static str {
65	521×	match self.body {
66	296×	AttestBody::Ref { .. } => "ref",
67	116×	AttestBody::Seal { .. } => "seal",
68	50×	AttestBody::Tag { .. } => "tag",
69	16×	AttestBody::Rotate { .. } => "rotate",
70	4×	AttestBody::Revoke { .. } => "revoke",
71	27×	AttestBody::Receipt { .. } => "receipt",
72	12×	AttestBody::Approval { .. } => "approval",
73		}
74	521×	}
75
76	39×	pub fn seal(repo: [u8; 16], mut hashes: Vec<ChangeHash>) -> Attest {
77	39×	hashes.sort();
78	39×	hashes.dedup();
79	39×	Attest {
80	39×	repo,
81	39×	hlc: Hlc::now(),
82	39×	body: AttestBody::Seal { hashes },
83	39×	}
84	39×	}
85
86	519×	pub fn to_value(&self) -> Value {
87	519×	let body = match &self.body {
88		AttestBody::Ref {
89	295×	name,
90	295×	old_state,
91	295×	new_state,
92	295×	serial,
93	295×	} => Value::map([
94	295×	(0, Value::Text(name.clone())),
95	295×	(1, Value::Bytes(old_state.0.to_vec())),
96	295×	(2, Value::Bytes(new_state.0.to_vec())),
97	295×	(3, Value::Uint(*serial)),
98	295×	]),
99	116×	AttestBody::Seal { hashes } => Value::map([(
100		0,
101	127×	Value::Array(hashes.iter().map(\|h\| Value::Bytes(h.0.to_vec())).collect()),
102		)]),
103		AttestBody::Tag {
104	49×	name,
105	49×	state,
106	49×	message,
107	49×	} => Value::map([
108	49×	(0, Value::Text(name.clone())),
109	49×	(1, Value::Bytes(state.0.to_vec())),
110	49×	(2, Value::Text(message.clone())),
111	49×	]),
112	16×	AttestBody::Rotate { new } => Value::map([(0, Value::Bytes(new.0.to_vec()))]),
113	4×	AttestBody::Revoke { key, reason } => Value::map([
114	4×	(0, Value::Bytes(key.0.to_vec())),
115	4×	(1, Value::Text(reason.clone())),
116	4×	]),
117		AttestBody::Receipt {
118	27×	receipt,
119	27×	state,
120	27×	run,
121	27×	} => Value::map([
122	27×	(0, Value::Bytes(receipt.0.to_vec())),
123	27×	(1, Value::Bytes(state.0.to_vec())),
124	27×	(2, Value::Text(run.clone())),
125	27×	]),
126		AttestBody::Approval {
127	12×	run,
128	12×	job,
129	12×	job_hash,
130	12×	state,
131	12×	inputs,
132	12×	environment,
133	12×	approve,
134	12×	} => Value::map([
135	12×	(0, Value::Text(run.clone())),
136	12×	(1, Value::Text(job.clone())),
137	12×	(2, Value::Bytes(job_hash.0.to_vec())),
138	12×	(3, Value::Bytes(state.0.to_vec())),
139		(
140		4,
141	18×	Value::Array(inputs.iter().map(\|i\| Value::Bytes(i.0.to_vec())).collect()),
142		),
143	12×	(5, Value::Text(environment.clone())),
144	12×	(6, Value::Uint(u64::from(*approve))),
145		]),
146		};
147	519×	Value::map([
148	519×	(0, Value::Uint(FORMAT_VERSION)),
149	519×	(1, Value::Text(self.kind().into())),
150	519×	(2, Value::Bytes(self.repo.to_vec())),
151	519×	(3, self.hlc.to_value()),
152	519×	(4, body),
153	519×	])
154	519×	}
155
156	519×	pub fn encode(&self) -> Vec<u8> {
157	519×	cbor::encode(&self.to_value())
158	519×	}
159
160	157×	pub fn hash(&self) -> ObjectRef {
161	157×	hash_object(ObjectType::Attest, &self.encode())
162	157×	}
163
164	810×	pub fn decode(b: &[u8]) -> Result<Attest, ObjectError> {
165	810×	let v = cbor::decode(b)?;
166	810×	let m = map(&v, "attest")?;
167	810×	check_version(m)?;
168	810×	let kind = text(field(m, 1, "kind")?, "kind")?;
169	810×	let repo: [u8; 16] = bytes(field(m, 2, "repo")?, "repo")?
170	810×	.try_into()
171	810×	.map_err(\|_\| ObjectError::Schema("repo: expected 16 bytes".into()))?;
172	810×	let hlc = Hlc::from_value(field(m, 3, "hlc")?)?;
173	810×	let b = map(field(m, 4, "body")?, "body")?;
174	810×	let body = match kind {
175	810×	"ref" => AttestBody::Ref {
176	331×	name: text(field(b, 0, "name")?, "name")?.to_owned(),
177	331×	old_state: oref(field(b, 1, "old_state")?, "old_state")?,
178	331×	new_state: oref(field(b, 2, "new_state")?, "new_state")?,
179	331×	serial: uint(field(b, 3, "serial")?, "serial")?,
180		},
181	479×	"seal" => {
182	319×	let hashes = array(field(b, 0, "hashes")?, "hashes")?
183	319×	.iter()
184	355×	.map(\|h\| oref(h, "hash"))
185	319×	.collect::<Result<Vec<_>, _>>()?;
186	319×	if hashes.is_empty()
187	318×	\|\| hashes.len() > MAX_SEAL_HASHES
188	318×	\|\| !hashes.windows(2).all(\|w\| w[0] < w[1])
189		{
190	2×	return Err(ObjectError::Schema(
191	2×	"seal: hashes must be 1..4096, sorted and unique".into(),
192	2×	));
193	317×	}
194	317×	AttestBody::Seal { hashes }
195		}
196	160×	"tag" => AttestBody::Tag {
197	143×	name: text(field(b, 0, "name")?, "name")?.to_owned(),
198	143×	state: oref(field(b, 1, "state")?, "state")?,
199	143×	message: text(field(b, 2, "message")?, "message")?.to_owned(),
200		},
201	17×	"rotate" => AttestBody::Rotate {
202	0×	new: oref(field(b, 0, "new")?, "new")?,
203		},
204	17×	"revoke" => AttestBody::Revoke {
205	0×	key: oref(field(b, 0, "key")?, "key")?,
206	0×	reason: text(field(b, 1, "reason")?, "reason")?.to_owned(),
207		},
208	17×	"receipt" => AttestBody::Receipt {
209	14×	receipt: oref(field(b, 0, "receipt")?, "receipt")?,
210	14×	state: oref(field(b, 1, "state")?, "state")?,
211	14×	run: text(field(b, 2, "run")?, "run")?.to_owned(),
212		},
213	3×	"approval" => {
214	3×	let inputs = array(field(b, 4, "inputs")?, "inputs")?
215	3×	.iter()
216	4×	.map(\|h\| oref(h, "input"))
217	3×	.collect::<Result<Vec<_>, _>>()?;
218	3×	if !inputs.windows(2).all(\|w\| w[0] < w[1]) {
219	0×	return Err(ObjectError::Schema(
220	0×	"approval: inputs must be sorted and unique".into(),
221	0×	));
222	3×	}
223		AttestBody::Approval {
224	3×	run: text(field(b, 0, "run")?, "run")?.to_owned(),
225	3×	job: text(field(b, 1, "job")?, "job")?.to_owned(),
226	3×	job_hash: oref(field(b, 2, "job_hash")?, "job_hash")?,
227	3×	state: oref(field(b, 3, "state")?, "state")?,
228	3×	inputs,
229	3×	environment: text(field(b, 5, "environment")?, "environment")?.to_owned(),
230	3×	approve: match uint(field(b, 6, "approve")?, "approve")? {
231	0×	0 => false,
232	3×	1 => true,
233	0×	_ => return Err(ObjectError::Schema("approval: approve is 0 or 1".into())),
234		},
235		}
236		}
237	0×	other => {
238	0×	return Err(ObjectError::Schema(format!(
239	0×	"unknown attestation kind {other:?}"
240	0×	)))
241		}
242		};
243	808×	Ok(Attest { repo, hlc, body })
244	810×	}
245		}
246
247		#[cfg(test)]
248		mod tests {
249		use super::*;
250
251		#[test]
252	1×	fn round_trips() {
253	1×	let r = Attest {
254	1×	repo: [1; 16],
255	1×	hlc: Hlc {
256	1×	wall_ms: 3,
257	1×	logical: 0,
258	1×	},
259	1×	body: AttestBody::Ref {
260	1×	name: "main".into(),
261	1×	old_state: ObjectRef([1; 32]),
262	1×	new_state: ObjectRef([2; 32]),
263	1×	serial: 7,
264	1×	},
265	1×	};
266	1×	assert_eq!(Attest::decode(&r.encode()).unwrap(), r);
267	1×	assert_eq!(r.kind(), "ref");
268	1×	let s = Attest::seal(
269	1×	[1; 16],
270	1×	vec![ObjectRef([9; 32]), ObjectRef([3; 32]), ObjectRef([9; 32])],
271		);
272	1×	let d = Attest::decode(&s.encode()).unwrap();
273	1×	assert!(
274	1×	matches!(&d.body, AttestBody::Seal { hashes } if hashes == &vec![ObjectRef([3; 32]), ObjectRef([9; 32])])
275		);
276	1×	assert_ne!(s.hash(), r.hash());
277	1×	let t = Attest {
278	1×	repo: [1; 16],
279	1×	hlc: Hlc::default(),
280	1×	body: AttestBody::Tag {
281	1×	name: "v1".into(),
282	1×	state: ObjectRef([5; 32]),
283	1×	message: "release".into(),
284	1×	},
285	1×	};
286	1×	assert_eq!(Attest::decode(&t.encode()).unwrap(), t);
287	1×	assert_eq!(t.kind(), "tag");
288	1×	}
289
290		#[test]
291	1×	fn rejects_bad_seals() {
292	1×	let empty = Attest {
293	1×	repo: [0; 16],
294	1×	hlc: Hlc::default(),
295	1×	body: AttestBody::Seal { hashes: vec![] },
296	1×	};
297	1×	assert!(Attest::decode(&empty.encode()).is_err());
298	1×	let unsorted = Attest {
299	1×	repo: [0; 16],
300	1×	hlc: Hlc::default(),
301	1×	body: AttestBody::Seal {
302	1×	hashes: vec![ObjectRef([2; 32]), ObjectRef([1; 32])],
303	1×	},
304	1×	};
305	1×	assert!(Attest::decode(&unsorted.encode()).is_err());
306	1×	}
307		}

Coverage / crates/oxy-core/src/attest.rs 93.8%

Keyboard