Skip to content

v1.3.0

Choose a tag to compare

@github-actions github-actions released this 08 Oct 04:32
· 209 commits to main since this release
v1.3.0
4341f5e

verify-attestation.sh changes in this release. The new sha256 is 0e7d4a27f2834a69a7173731a7589bca6566355cedce11dfc9a4b71c25745552; v1.2.1's was 16dcf769…. If you pin the script by hash, update the pin.

Output changes. The verifier prints claims about the organisation only for a document that verifies, and the full posture JSON only with --raw. Exit codes keep their meaning. If you read the band or the posture JSON from the output, see "Changed" below.

Security

  • Document fields were printed with their terminal control characters (GHSA-2mgq-37v5-x454, low; v1.0.0 to v1.2.1).

    • An edited document could make stdout show a forged "Attested content" block and a VERIFIED line.
    • The exit code and the verdict on stderr were always correct.
    • Every value taken from a document, key set or status list is now printed with control characters and non-ASCII bytes as visible \xHH escapes.
  • Retired signing keys are enforced (#56). A key marked with hs_retired_at (RFC 3339 UTC, seconds):

    • a document whose signed generatedAt is at or after its retirement, or that has no generatedAt to compare, fails with retired_key (exit 1);
    • a status list issued at or after the retirement of its key is unknown (exit 3);
    • a malformed marker makes the key set invalid.

    Earlier versions ignore the marker.

  • Key sets that cannot be read one way are refused: a repeated kid, or keys that is not an array of objects. --jwks exits 2; --status-keys exits 3.

Changed

  • Attested content only when verified (#14).
    • The overall band, frameworks, subject, visibility and dates appear in an "Attested content" block before the verdict, only when the document verifies.
    • Any other outcome prints attested content withheld: this document did not verify.
    • The full posture JSON, printed every time before, now needs --raw and follows the same rule.
  • Short --help (#15): the options, the exit codes and where to read more.
  • No references to a non-public document (#34). The messages cite §7.1 of docs/security/attest-verification.md, which has a new paragraph, "Unknown is not good".
  • --pub-b64url together with --jwks is a usage error (exit 2). Before, the key set was silently ignored.

Added

  • --expect-kid KID (#13).

    • It requires the signing key's kid, recomputed from the key bytes.
    • Repeat it to pin two keys through a rotation overlap.
    • A mismatch exits 1; a malformed value exits 2.
    • It is not --check-kid, and it does not apply to the status-list key.
  • docs/security/keys.md:

    • the current signing keys, their roles and dates;
    • how to check them yourself;
    • the rotation policy (12 months, 90-day overlap; retired keys stay published and marked);
    • how the file changes.

    The active attestation key is roeFReafBOA_WF3cqfilHA.

  • Compatibility policy (#20):

    • CHANGELOG.md and a README "Compatibility" section;
    • incompatible format changes are announced at least 90 days in advance;
    • only the latest release is supported.
  • Documentation:

    • issue templates;
    • links to the guides on docs.hodeishield.com;
    • the key fingerprint defined as the kid;
    • CONTRIBUTING "Issues" and "Design".

Tests and CI

  • Vectors: 14 appended to tests/vectors/v1/ for retired keys and ambiguous key sets. 115 in total; the first 101 are unchanged.
  • tests/run.sh: new cases cover every change above, including injected escape sequences.
  • Mutant check: VERIFIER_SKIP_MUTANTS=1 bash tests/run.sh skips it locally. CI always runs it and fails if the variable is set there.

Verify this release

sha256sum -c SHA256SUMS
cosign verify-blob --bundle verify-attestation.sh.sigstore.json \
  --certificate-identity "https://github.com/Hodeitek/hodeishield-attest-verifier/.github/workflows/release.yml@refs/tags/v1.3.0" \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com \
  verify-attestation.sh

verify-attestation.sh sha256: 0e7d4a27f2834a69a7173731a7589bca6566355cedce11dfc9a4b71c25745552

Full changelog: v1.2.1...v1.3.0