git-attest 1.7.0

Sign and verify attestations that a test suite already passed on a tree, so CI can skip it: the library and its command line
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

.DEFAULT_GOAL := help
SHELL := /usr/bin/env bash

help: ## show this help
	@grep -hE '^[a-z-]+:.*?## ' $(MAKEFILE_LIST) \
	  | awk 'BEGIN{FS=":.*?## "}{printf "  \033[36m%-12s\033[0m %s\n", $$1, $$2}'

lint: ## rustfmt + clippy + shellcheck
	cargo fmt --all -- --check
	cargo clippy --all-targets -- -D warnings
	@./scripts/help-lists-every-flag.sh
	@./scripts/platform-tables-match.sh
	@if command -v shellcheck > /dev/null; then \
	    shellcheck verify.sh sign/sign.sh fetch.sh tests/*.sh tests/fault/git tests/fake/* scripts/*.sh; \
	  else \
	    echo "  (shellcheck not installed — skipped)"; \
	  fi

test: ## unit tests
	cargo test

# Both implementations, against the same fixtures. This is the target that
# matters: it is the only thing keeping verify.sh and git-attest from drifting.
#
# `legacy` is a NEGATIVE control and is expected to FAIL — it is the verifier
# this project replaces, and a fixture suite it passed would be testing
# nothing. `make conformance` therefore asserts it fails.
conformance: ## run the fixtures against both implementations
	cargo build --release
	@echo "--- verify.sh ---"
	@./tests/conformance.sh "bash $(PWD)/verify.sh --quiet"
	@echo "--- git-attest ---"
	@./tests/conformance.sh "$(PWD)/target/release/git-attest covered"
	@echo "--- legacy.sh (negative control: MUST fail) ---"
	@if SKIP_JSON=1 ./tests/conformance.sh "bash $(PWD)/tests/legacy.sh" > /dev/null 2>&1; then \
	    echo "  ✗ legacy.sh PASSED the suite — the fixtures no longer prove anything"; \
	    exit 1; \
	else \
	    echo "  ok  legacy.sh still fails the defects it shipped with"; \
	fi

# A 1.1.0 verifier reads ONE block of a note. This proves what SPEC.md claims:
# on a multi-block note it reports block 1's gates or nothing, never a gate
# from a later block. The shell copy is frozen in the tree; the binary is built
# from the v1.1.0 tag, which a shallow CI checkout fetches on demand.
# The binary of a released tag, built into target/compat/<tag>/. A shallow CI
# checkout fetches the tag on demand.
define build_tag
	@git rev-parse -q --verify $(1) > /dev/null 2>&1 || git fetch -q --depth 1 origin tag $(1)
	@rm -rf target/compat/$(1)/src && mkdir -p target/compat/$(1)/src
	@git archive $(1) | tar -x -C target/compat/$(1)/src
	@cargo build -q --release --manifest-path target/compat/$(1)/src/Cargo.toml --target-dir target/compat/$(1)/target
endef

compat: ## prove released verifiers degrade safely on newer notes
	@echo "--- multi-block notes: verify.sh 1.1.0 (frozen copy) ---"
	@./tests/compat.sh "bash $(PWD)/tests/compat/verify-1.1.0.sh --quiet"
	@echo "--- multi-block notes: git-attest 1.1.0 (built from the tag) ---"
	$(call build_tag,v1.1.0)
	@./tests/compat.sh "$(PWD)/target/compat/v1.1.0/target/release/git-attest covered"
	@echo "--- input lines: verify.sh 1.1.0 (frozen copy) ---"
	@./tests/compat-fields.sh "bash $(PWD)/tests/compat/verify-1.1.0.sh --quiet" old
	@echo "--- input lines: git-attest 1.1.0 ---"
	@./tests/compat-fields.sh "$(PWD)/target/compat/v1.1.0/target/release/git-attest covered" old
	@echo "--- input lines: verify.sh 1.2.0 (frozen copy) ---"
	@./tests/compat-fields.sh "bash $(PWD)/tests/compat/verify-1.2.0.sh --quiet" old
	@echo "--- input lines: git-attest 1.2.0 (built from the tag) ---"
	$(call build_tag,v1.2.0)
	@./tests/compat-fields.sh "$(PWD)/target/compat/v1.2.0/target/release/git-attest covered" old
	@echo "--- optional paths: verify.sh 1.3.1 (frozen copy) ---"
	@./tests/compat-fields.sh "bash $(PWD)/tests/compat/verify-1.3.1.sh --quiet" fp13
	@echo "--- optional paths: git-attest 1.3.1 (built from the tag) ---"
	$(call build_tag,v1.3.1)
	@./tests/compat-fields.sh "$(PWD)/target/compat/v1.3.1/target/release/git-attest covered" fp13
	@echo "--- canonical tree: verify.sh 1.4.1 (frozen copy) ---"
	@./tests/compat-fields.sh "bash $(PWD)/tests/compat/verify-1.4.1.sh --quiet" fp14
	@echo "--- canonical tree: git-attest 1.4.1 (built from the tag) ---"
	$(call build_tag,v1.4.1)
	@./tests/compat-fields.sh "$(PWD)/target/compat/v1.4.1/target/release/git-attest covered" fp14
	@echo "--- the opt-out directive: verify.sh 1.5.1 (frozen copy) ---"
	@./tests/compat-fields.sh "bash $(PWD)/tests/compat/verify-1.5.1.sh --quiet" fp15
	@echo "--- the opt-out directive: git-attest 1.5.1 (built from the tag) ---"
	$(call build_tag,v1.5.1)
	@./tests/compat-fields.sh "$(PWD)/target/compat/v1.5.1/target/release/git-attest covered" fp15
	@echo "--- input lines: current verify.sh ---"
	@./tests/compat-fields.sh "bash $(PWD)/verify.sh --quiet" new
	@echo "--- input lines: current git-attest ---"
	@cargo build -q --release
	@./tests/compat-fields.sh "$(PWD)/target/release/git-attest covered" new

sign-test: ## the producer's fixtures (sign/sign.sh and git-attest sign against a bare origin), read back by both verifiers
	cargo build --release
	@echo "--- sign/sign.sh, read by verify.sh ---"
	@ATTEST_GIT_ATTEST="$(PWD)/target/release/git-attest" ./tests/sign.sh
	@echo "--- sign/sign.sh, read by git-attest ---"
	@ATTEST_GIT_ATTEST="$(PWD)/target/release/git-attest" ATTEST_IMPL="$(PWD)/target/release/git-attest covered" ./tests/sign.sh
	@echo "--- git-attest sign, read by verify.sh ---"
	@ATTEST_GIT_ATTEST="$(PWD)/target/release/git-attest" ATTEST_SIGN="$(PWD)/target/release/git-attest sign" ./tests/sign.sh
	@echo "--- git-attest sign, read by git-attest ---"
	@ATTEST_GIT_ATTEST="$(PWD)/target/release/git-attest" ATTEST_SIGN="$(PWD)/target/release/git-attest sign" ATTEST_IMPL="$(PWD)/target/release/git-attest covered" ./tests/sign.sh

fetch-test: ## fetch.sh against a release served from file://, RELEASE's shape, the deprecation lines
	@./tests/fetch.sh

check: lint test conformance compat sign-test fetch-test ## everything CI runs

fmt: ## format
	cargo fmt --all

msrv: ## prove the rust-version floor in Cargo.toml is real
	@v=$$(awk -F'"' '/^rust-version/ {print $$2}' Cargo.toml); \
	  echo "checking MSRV $$v"; \
	  rustup toolchain install "$$v" --profile minimal 2> /dev/null || true; \
	  cargo "+$$v" check --locked

.PHONY: help lint test conformance compat sign-test fetch-test check fmt msrv