1use std::path::PathBuf;
48use std::process::{Command, Stdio};
49
50use crate::pushrefs::PushRef;
51
52pub const FORMAT: &str = "amont-attest-v2";
61
62pub const NOTES_REF: &str = "amont-attest";
64
65pub const NOTES_FULL_REF: &str = "refs/notes/amont-attest";
68
69pub const NAMESPACE: &str = "amont-attest";
74
75pub const PUSH_GUARD: &str = "AMONT_ATTEST_PUSH";
78
79const TOGGLE: &str = "amont.attest";
83
84const KEY_CONFIG: &str = "amont.attestKey";
86const KEY_DEFAULT: &str = ".ssh/amont-attest";
87
88pub fn push_guard_active() -> bool {
90 std::env::var_os(PUSH_GUARD).is_some()
91}
92
93pub fn enabled() -> bool {
95 crate::config::boolean_or(TOGGLE, false)
96}
97
98fn key_path() -> Option<PathBuf> {
104 if let Some(k) = crate::git::stdout(&["config", "--get", KEY_CONFIG]) {
105 if !k.is_empty() {
106 return Some(PathBuf::from(k));
107 }
108 }
109 let home = std::env::var_os("HOME").or_else(|| std::env::var_os("USERPROFILE"))?;
110 Some(PathBuf::from(home).join(KEY_DEFAULT))
111}
112
113pub fn platform() -> String {
120 format!("{}-{}", std::env::consts::ARCH, std::env::consts::OS)
121}
122
123pub fn payload(tree: &str, gates: &[String]) -> String {
132 format!(
133 "{FORMAT}\ntree {tree}\ngates {}\nplatform {}\namont {}\n",
134 gates.join(" "),
135 platform(),
136 env!("CARGO_PKG_VERSION")
137 )
138}
139
140fn sign(payload: &str, key: &std::path::Path) -> Option<String> {
144 use std::io::Write;
145 let mut child = Command::new("ssh-keygen")
146 .args(["-Y", "sign", "-n", NAMESPACE, "-f"])
147 .arg(key)
148 .stdin(Stdio::piped())
149 .stdout(Stdio::piped())
150 .stderr(Stdio::null())
151 .spawn()
152 .ok()?;
153 child.stdin.take()?.write_all(payload.as_bytes()).ok()?;
154 let out = child.wait_with_output().ok()?;
155 if !out.status.success() {
156 return None;
157 }
158 let sig = String::from_utf8_lossy(&out.stdout).trim().to_string();
159 sig.starts_with("-----BEGIN SSH SIGNATURE-----")
160 .then_some(sig)
161}
162
163pub fn verify(
170 payload: &str,
171 sig: &str,
172 allowed_signers: &std::path::Path,
173 principal: &str,
174) -> bool {
175 use std::io::Write;
176 let sig_file = std::env::temp_dir().join(format!(
178 "amont-attest-verify-{}-{:p}.sig",
179 std::process::id(),
180 &sig
181 ));
182 if std::fs::write(&sig_file, format!("{sig}\n")).is_err() {
183 return false;
184 }
185 let ok = (|| {
186 let mut child = Command::new("ssh-keygen")
187 .args(["-Y", "verify", "-n", NAMESPACE, "-I", principal, "-f"])
188 .arg(allowed_signers)
189 .arg("-s")
190 .arg(&sig_file)
191 .stdin(Stdio::piped())
192 .stdout(Stdio::null())
193 .stderr(Stdio::null())
194 .spawn()
195 .ok()?;
196 child.stdin.take()?.write_all(payload.as_bytes()).ok()?;
197 child.wait().ok().map(|s| s.success())
198 })()
199 .unwrap_or(false);
200 let _ = std::fs::remove_file(&sig_file);
201 ok
202}
203
204pub fn attest_push(remote: &str, refs: &[PushRef], gates: &[String]) {
216 if gates.is_empty() || remote.is_empty() || !enabled() {
217 return;
218 }
219 let Some(key) = key_path() else { return };
220 if !key.exists() {
221 crate::config::complain(
222 TOGGLE,
223 &format!("signing key {} does not exist", key.display()),
224 "no attestation (CI will run the tests)",
225 );
226 return;
227 }
228 let mut noted = false;
229 for r in refs {
230 if is_zero(&r.local_oid) {
231 continue; }
233 let spec = format!("{}^{{tree}}", r.local_oid);
234 let Some(tree) = crate::git::stdout(&["rev-parse", &spec]) else {
235 continue;
236 };
237 let body = match sign(&payload(&tree, gates), &key) {
238 Some(sig) => format!("{}\n{sig}", payload(&tree, gates)),
239 None => continue,
240 };
241 if crate::git::succeeds(&[
242 "notes",
243 "--ref",
244 NOTES_REF,
245 "add",
246 "-f",
247 "-m",
248 &body,
249 &r.local_oid,
250 ]) {
251 noted = true;
252 }
253 }
254 if noted && push_notes(remote) {
255 crate::say!(
256 "{} attested {} for CI ({})",
257 crate::ui::valid_sign(),
258 crate::ui::highlight(&gates.join(" ")),
259 NOTES_REF,
260 );
261 }
262}
263
264pub fn covered(
287 signers: &std::path::Path,
288 principal: &str,
289 require_platform: Option<&str>,
290) -> Option<String> {
291 let refspec = format!("+{NOTES_FULL_REF}:{NOTES_FULL_REF}");
292 let _ = crate::git::succeeds(&["fetch", "origin", &refspec]);
293 let head_tree = crate::git::stdout(&["rev-parse", "HEAD^{tree}"])?;
294 for candidate in ["HEAD", "HEAD^2"] {
300 let Some(commit) = crate::git::stdout(&["rev-parse", "--verify", candidate]) else {
301 continue;
302 };
303 let Some(body) = crate::git::stdout(&["notes", "--ref", NOTES_REF, "show", &commit]) else {
304 continue;
305 };
306 let Some((payload, sig)) = split_note(&body) else {
307 continue;
308 };
309 let mut lines = payload.lines();
313 if lines.next() != Some(FORMAT) {
314 continue;
315 }
316 let field = |name: &str| {
317 payload
318 .lines()
319 .find_map(|l| l.strip_prefix(name).and_then(|r| r.strip_prefix(' ')))
320 .map(str::trim)
321 };
322 let (Some(tree), Some(gates), Some(ran_on)) =
323 (field("tree"), field("gates"), field("platform"))
324 else {
325 continue;
326 };
327 if tree != head_tree || gates.is_empty() {
328 continue; }
330 if require_platform.is_some_and(|want| want != ran_on) {
334 continue;
335 }
336 if verify(&payload, &sig, signers, principal) {
337 return Some(gates.to_string());
338 }
339 }
340 None
341}
342
343pub fn default_signers() -> Option<PathBuf> {
354 let root = crate::git::stdout(&["rev-parse", "--show-toplevel"]).map(PathBuf::from);
355 [".forgejo/allowed_signers", ".github/allowed_signers"]
356 .into_iter()
357 .map(|rel| match &root {
358 Some(root) => root.join(rel),
359 None => PathBuf::from(rel),
360 })
361 .find(|p| p.exists())
362}
363
364pub fn first_principal(signers: &std::path::Path) -> Option<String> {
369 let body = std::fs::read_to_string(signers).ok()?;
370 body.lines()
371 .map(str::trim)
372 .find(|l| !l.is_empty() && !l.starts_with('#'))
373 .and_then(|l| l.split_whitespace().next())
374 .map(str::to_string)
375}
376
377fn split_note(body: &str) -> Option<(String, String)> {
381 let (payload, sig) = body.split_once("\n\n")?;
382 if !sig.starts_with("-----BEGIN SSH SIGNATURE-----") {
383 return None;
384 }
385 Some((format!("{payload}\n"), sig.to_string()))
386}
387
388fn push_notes(remote: &str) -> bool {
393 let refspec = format!("{NOTES_FULL_REF}:{NOTES_FULL_REF}");
394 Command::new("git")
395 .args(["push", remote, &refspec])
396 .env(PUSH_GUARD, "1")
397 .stdin(Stdio::null())
398 .stdout(Stdio::null())
399 .stderr(Stdio::null())
400 .status()
401 .map(|s| s.success())
402 .unwrap_or(false)
403}
404
405fn is_zero(oid: &str) -> bool {
408 !oid.is_empty() && oid.bytes().all(|b| b == b'0')
409}
410
411pub fn forget() -> bool {
415 crate::git::succeeds(&["update-ref", "-d", NOTES_FULL_REF])
416}
417
418pub fn forget_in(repo: &std::path::Path) -> bool {
420 crate::git::succeeds_in(repo, &["update-ref", "-d", NOTES_FULL_REF])
421}
422
423#[cfg(test)]
424mod tests {
425 use super::*;
426 use std::path::Path;
427
428 fn dir(name: &str) -> PathBuf {
432 let d = std::env::temp_dir().join(format!("attest-{name}-{}", std::process::id()));
433 let _ = std::fs::remove_dir_all(&d);
434 std::fs::create_dir_all(&d).unwrap();
435 d
436 }
437
438 fn git(dir: &Path, args: &[&str]) -> String {
439 let out = std::process::Command::new("git")
440 .arg("-C")
441 .arg(dir)
442 .args(args)
443 .output()
444 .expect("git");
445 String::from_utf8_lossy(&out.stdout).trim().to_string()
446 }
447
448 fn repo(name: &str) -> PathBuf {
449 let d = dir(name);
450 git(&d, &["init", "-q", "--template=", "."]);
451 git(&d, &["config", "user.email", "t@t.test"]);
452 git(&d, &["config", "user.name", "t"]);
453 d
454 }
455
456 fn keypair(d: &Path) -> (PathBuf, PathBuf) {
459 let key = d.join("attest_key");
460 let ok = std::process::Command::new("ssh-keygen")
461 .args(["-q", "-t", "ed25519", "-N", "", "-C", "test", "-f"])
462 .arg(&key)
463 .status()
464 .expect("ssh-keygen must exist for these tests")
465 .success();
466 assert!(ok, "keygen failed");
467 let pubkey = std::fs::read_to_string(key.with_extension("pub")).unwrap();
468 let signers = d.join("allowed_signers");
469 std::fs::write(
470 &signers,
471 format!("t@t.test namespaces=\"{NAMESPACE}\" {pubkey}"),
472 )
473 .unwrap();
474 (key, signers)
475 }
476
477 fn in_repo<T>(dir: &Path, f: impl FnOnce() -> T) -> T {
480 let _guard = crate::TEST_CWD.lock().unwrap_or_else(|p| p.into_inner());
481 let prev = std::env::current_dir().unwrap();
482 std::env::set_current_dir(dir).unwrap();
483 let r = f();
484 std::env::set_current_dir(prev).unwrap();
485 r
486 }
487
488 #[test]
489 fn the_payload_is_the_documented_contract() {
490 let p = payload(
491 "abc123",
492 &["pre-push-pytest".into(), "pre-push-cargo-test".into()],
493 );
494 let lines: Vec<&str> = p.lines().collect();
495 assert_eq!(lines[0], FORMAT);
496 assert_eq!(lines[1], "tree abc123");
497 assert_eq!(lines[2], "gates pre-push-pytest pre-push-cargo-test");
498 assert_eq!(lines[3], format!("platform {}", platform()));
499 assert_eq!(lines[4], format!("amont {}", env!("CARGO_PKG_VERSION")));
500 assert!(
501 p.ends_with('\n'),
502 "CI reconstructs these bytes; the trailing newline is part of them"
503 );
504 }
505
506 #[test]
507 fn sign_verify_roundtrip_and_tamper_rejection() {
508 let d = dir("roundtrip");
509 let (key, signers) = keypair(&d);
510 let p = payload("deadbeef", &["pre-push-pytest".into()]);
511 let sig = sign(&p, &key).expect("signing with a real key succeeds");
512 assert!(verify(&p, &sig, &signers, "t@t.test"));
513 let tampered = payload("deadbeee", &["pre-push-pytest".into()]);
516 assert!(!verify(&tampered, &sig, &signers, "t@t.test"));
517 assert!(!verify(&p, &sig, &signers, "someone@else.test"));
519 let _ = std::fs::remove_dir_all(&d);
520 }
521
522 #[test]
523 fn a_missing_key_signs_nothing() {
524 assert!(sign("anything", Path::new("/nonexistent/key")).is_none());
525 }
526
527 #[test]
531 fn an_enabled_push_leaves_a_verifiable_note_on_the_remote() {
532 let d = dir("e2e");
533 let (key, signers) = keypair(&d);
534 let remote = d.join("remote.git");
535 std::fs::create_dir_all(&remote).unwrap();
536 git(&remote, &["init", "-q", "--bare", "--template=", "."]);
537 let work = repo("e2e-work");
538 git(
539 &work,
540 &["remote", "add", "origin", remote.to_str().unwrap()],
541 );
542 git(&work, &["config", "amont.attest", "true"]);
543 git(&work, &["config", "amont.attestKey", key.to_str().unwrap()]);
544 std::fs::write(work.join("a.ts"), "x").unwrap();
545 git(&work, &["add", "a.ts"]);
546 git(&work, &["commit", "-qm", "chore: a"]);
547 let head = git(&work, &["rev-parse", "HEAD"]);
548 let tree = git(&work, &["rev-parse", "HEAD^{tree}"]);
549 let push_ref = PushRef {
550 local_ref: "refs/heads/main".into(),
551 local_oid: head.clone(),
552 remote_ref: "refs/heads/main".into(),
553 remote_oid: "0".repeat(40),
554 };
555 in_repo(&work, || {
556 attest_push("origin", &[push_ref], &["pre-push-run-tests-js".into()]);
557 });
558 let body = git(&remote, &["notes", "--ref", NOTES_REF, "show", &head]);
560 assert!(!body.is_empty(), "no note reached the remote");
561 let (p, sig) = body
562 .split_once("\n\n")
563 .expect("payload, blank line, signature");
564 let p = format!("{p}\n"); assert!(p.starts_with(FORMAT));
566 assert!(
567 p.contains(&format!("tree {tree}")),
568 "attests the pushed tree"
569 );
570 assert!(
571 verify(&p, sig, &signers, "t@t.test"),
572 "the remote copy verifies"
573 );
574 let _ = std::fs::remove_dir_all(&d);
575 let _ = std::fs::remove_dir_all(&work);
576 }
577
578 #[test]
581 fn no_opt_in_means_no_note() {
582 let d = dir("optout");
583 let (key, _) = keypair(&d);
584 let remote = d.join("remote.git");
585 std::fs::create_dir_all(&remote).unwrap();
586 git(&remote, &["init", "-q", "--bare", "--template=", "."]);
587 let work = repo("optout-work");
588 git(
589 &work,
590 &["remote", "add", "origin", remote.to_str().unwrap()],
591 );
592 git(&work, &["config", "amont.attestKey", key.to_str().unwrap()]);
593 std::fs::write(work.join("a.ts"), "x").unwrap();
594 git(&work, &["add", "a.ts"]);
595 git(&work, &["commit", "-qm", "chore: a"]);
596 let head = git(&work, &["rev-parse", "HEAD"]);
597 let push_ref = PushRef {
598 local_ref: "refs/heads/main".into(),
599 local_oid: head.clone(),
600 remote_ref: "refs/heads/main".into(),
601 remote_oid: "0".repeat(40),
602 };
603 in_repo(&work, || {
604 attest_push("origin", &[push_ref], &["pre-push-run-tests-js".into()]);
605 });
606 assert!(
607 git(&remote, &["notes", "--ref", NOTES_REF, "list"]).is_empty(),
608 "an un-opted-in repo attested something"
609 );
610 let _ = std::fs::remove_dir_all(&d);
611 let _ = std::fs::remove_dir_all(&work);
612 }
613
614 #[test]
617 fn deletions_and_empty_gates_attest_nothing() {
618 let d = dir("nothing");
619 let (key, _) = keypair(&d);
620 let remote = d.join("remote.git");
621 std::fs::create_dir_all(&remote).unwrap();
622 git(&remote, &["init", "-q", "--bare", "--template=", "."]);
623 let work = repo("nothing-work");
624 git(
625 &work,
626 &["remote", "add", "origin", remote.to_str().unwrap()],
627 );
628 git(&work, &["config", "amont.attest", "true"]);
629 git(&work, &["config", "amont.attestKey", key.to_str().unwrap()]);
630 std::fs::write(work.join("a.ts"), "x").unwrap();
631 git(&work, &["add", "a.ts"]);
632 git(&work, &["commit", "-qm", "chore: a"]);
633 let head = git(&work, &["rev-parse", "HEAD"]);
634 let deletion = PushRef {
635 local_ref: "(delete)".into(),
636 local_oid: "0".repeat(40),
637 remote_ref: "refs/heads/gone".into(),
638 remote_oid: head.clone(),
639 };
640 let real = PushRef {
641 local_ref: "refs/heads/main".into(),
642 local_oid: head,
643 remote_ref: "refs/heads/main".into(),
644 remote_oid: "0".repeat(40),
645 };
646 in_repo(&work, || {
647 attest_push("origin", &[deletion], &["pre-push-pytest".into()]);
648 attest_push("origin", &[real], &[]);
649 });
650 assert!(git(&remote, &["notes", "--ref", NOTES_REF, "list"]).is_empty());
651 let _ = std::fs::remove_dir_all(&d);
652 let _ = std::fs::remove_dir_all(&work);
653 }
654
655 #[test]
660 fn covered_answers_in_a_fresh_clone_and_rejects_drift_and_forgery() {
661 let d = dir("covered");
662 let (key, signers) = keypair(&d);
663 let remote = d.join("remote.git");
664 std::fs::create_dir_all(&remote).unwrap();
665 git(&remote, &["init", "-q", "--bare", "--template=", "."]);
666 git(&remote, &["symbolic-ref", "HEAD", "refs/heads/main"]);
672 let work = repo("covered-work");
673 git(
674 &work,
675 &["remote", "add", "origin", remote.to_str().unwrap()],
676 );
677 git(&work, &["config", "amont.attest", "true"]);
678 git(&work, &["config", "amont.attestKey", key.to_str().unwrap()]);
679 std::fs::write(work.join("a.ts"), "x").unwrap();
680 git(&work, &["add", "a.ts"]);
681 git(&work, &["commit", "-qm", "chore: a"]);
682 git(&work, &["push", "-q", "origin", "HEAD:main"]);
683 let head = git(&work, &["rev-parse", "HEAD"]);
684 let push_ref = PushRef {
685 local_ref: "refs/heads/main".into(),
686 local_oid: head.clone(),
687 remote_ref: "refs/heads/main".into(),
688 remote_oid: "0".repeat(40),
689 };
690 in_repo(&work, || {
691 attest_push("origin", &[push_ref], &["pre-push-pytest".into()]);
692 });
693 let clone = d.join("ci-checkout");
694 git(
695 &d,
696 &[
697 "clone",
698 "-q",
699 "--template=",
700 remote.to_str().unwrap(),
701 clone.to_str().unwrap(),
702 ],
703 );
704 in_repo(&clone, || {
705 assert_eq!(
706 covered(&signers, "t@t.test", Some(&platform())).as_deref(),
707 Some("pre-push-pytest"),
708 "a fresh clone verifies the attestation and reads the gates"
709 );
710 assert_eq!(
711 covered(&signers, "t@t.test", None).as_deref(),
712 Some("pre-push-pytest"),
713 "`any` covers a platform-independent suite"
714 );
715 assert_eq!(
718 covered(&signers, "t@t.test", Some("s390x-aix")),
719 None,
720 "a pass on one platform is not evidence about another"
721 );
722 assert_eq!(
723 covered(&signers, "someone@else.test", None),
724 None,
725 "an unlisted principal covers nothing"
726 );
727 });
728 std::fs::write(clone.join("b.ts"), "y").unwrap();
730 git(&clone, &["config", "user.email", "t@t.test"]);
731 git(&clone, &["config", "user.name", "t"]);
732 git(&clone, &["add", "b.ts"]);
733 git(&clone, &["commit", "-qm", "chore: b"]);
734 in_repo(&clone, || {
735 assert_eq!(covered(&signers, "t@t.test", None), None, "drifted tree");
736 });
737 git(
740 &work,
741 &[
742 "notes", "--ref", NOTES_REF, "add", "-f", "-m", "garbage", &head,
743 ],
744 );
745 git(
746 &work,
747 &[
748 "push",
749 "-q",
750 "origin",
751 &format!("+{NOTES_FULL_REF}:{NOTES_FULL_REF}"),
752 ],
753 );
754 git(&clone, &["reset", "-q", "--hard", &head]);
755 in_repo(&clone, || {
756 assert_eq!(
757 covered(&signers, "t@t.test", None),
758 None,
759 "a foreign note is not a stamp"
760 );
761 });
762 let _ = std::fs::remove_dir_all(&d);
763 let _ = std::fs::remove_dir_all(&work);
764 }
765
766 #[test]
772 fn default_signers_is_found_from_a_subdirectory() {
773 let work = repo("signers-subdir");
774 std::fs::create_dir_all(work.join(".forgejo")).unwrap();
775 std::fs::write(work.join(".forgejo/allowed_signers"), "t@t.test x\n").unwrap();
776 let sub = work.join("packages").join("thing");
777 std::fs::create_dir_all(&sub).unwrap();
778 in_repo(&sub, || {
779 let found = default_signers().expect("resolved from the repo root, not the cwd");
780 assert!(found.ends_with(".forgejo/allowed_signers"));
781 assert!(found.exists(), "the path it returns must be usable as-is");
782 assert_eq!(
783 first_principal(&found).as_deref(),
784 Some("t@t.test"),
785 "and readable from there"
786 );
787 });
788 let _ = std::fs::remove_dir_all(&work);
789 }
790
791 #[test]
792 fn zero_oids_of_any_width_are_zero() {
793 assert!(is_zero(&"0".repeat(40)));
794 assert!(is_zero(&"0".repeat(64)));
795 assert!(!is_zero("0a0000"));
796 assert!(!is_zero(""));
797 }
798
799 #[test]
800 fn forget_removes_the_local_ref() {
801 let work = repo("forget");
802 std::fs::write(work.join("a.ts"), "x").unwrap();
803 git(&work, &["add", "a.ts"]);
804 git(&work, &["commit", "-qm", "chore: a"]);
805 git(
806 &work,
807 &["notes", "--ref", NOTES_REF, "add", "-m", "x", "HEAD"],
808 );
809 in_repo(&work, forget);
810 assert!(git(&work, &["notes", "--ref", NOTES_REF, "list"]).is_empty());
811 let _ = std::fs::remove_dir_all(&work);
812 }
813}