Skip to content

docs(operator-guide): verify release image and chart signatures - #657

Merged
MaxRink merged 1 commit into
mainfrom
docs/verify-release-signatures
Nov 15, 2026
Merged

MaxRink merged 1 commit into
mainfrom
docs/verify-release-signatures

Conversation

@MaxRink

@MaxRink MaxRink commented Nov 15, 2026

Copy link
Copy Markdown
Collaborator

Closes #652

Description

Adds "Verify Release Signatures" to the Installation part of docs/operator-guide.md and links it from the README. The commands follow what release.yml actually publishes:

Artifact Published by release.yml Verified with
Image signature cosign sign (keyless) on the manifest digest cosign verify
Chart signature cosign sign on ghcr.io/telekom/charts/auth-operator:<version> cosign verify
Image SBOM cosign attest --type spdxjson cosign verify-attestation
Image provenance actions/attest-build-provenance gh attestation verify oci://…
install.yaml, crds.yaml provenance actions/attest-build-provenance gh attestation verify <file>

All of these use the same anchored identity:
^https://github\.com/telekom/auth-operator/\.github/workflows/release\.yml@refs/tags/v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$
together with the issuer https://token.actions.githubusercontent.com. The tag part mirrors the SemVer guard in release.yml.

The release notes already contain exact-identity commands for each tag. This section adds the regexp form for policies, the provenance of the manifests, and a Kyverno example.

Cosign v3 stores the signatures as Sigstore bundles in OCI referrers, so the Kyverno ClusterPolicy needs type: SigstoreBundle (Kyverno 1.13+). Without it, Kyverno reports "no signatures found" even for a valid release.

Type of Change

  • 📚 Documentation update

Testing

The Bash blocks were extracted from the Markdown and run verbatim with cosign v3.1.4, gh, and VERSION=0.5.0-rc.26. All commands succeed. The image and chart of 0.4.0-rc.17 and 0.5.0-rc.20 also verify.

Negative checks:

  • cosign verify of the unsigned main build sha-f343a38 fails with "no signatures found".
  • cosign verify and gh attestation verify of 0.5.0-rc.26 fail with an identity anchored to refs/heads/main.
  • gh attestation verify of a modified crds.yaml fails.

Kyverno CLI 1.19.2 apply with the policy from the doc:

  • the release image passes, by tag and by digest.
  • the branch build fails.
  • ghcr.io/telekom/auth-operator-foo is not matched.
  • the same policy anchored to refs/heads/main fails for the release.

PSA PSM-12.17

🤖 Generated with Claude Code

Document cosign verification of the release image and OCI chart with an
anchored certificate identity for release.yml tag builds, the SBOM and
provenance attestations, and a Kyverno policy using the same identity.

Closes #652

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: MaxRink <maximilian.rink@telekom.de>
@MaxRink
MaxRink requested a review from a team as a code owner November 15, 2026 11:13
Copilot AI balanced review requested due to automatic review settings November 15, 2026 11:13
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Output Delta

No output differences were detected for this PR.
No output-delta input files changed.
There is no diff to inspect for this run.

  • Trusted baseline job: skipped
  • Candidate PR job: skipped
  • Differences detected: false
  • RBAC differences detected: false
  • CRD status differences detected: false
  • Candidate log errors detected: false
  • Latest tag diff generated: false
  • Workflow conclusion: skipped
  • Workflow run: not_applicable

The compare job downloads artifacts only; it does not checkout or execute pull-request code.

@github-actions

Copy link
Copy Markdown
Contributor

📊 Output Delta Report

No output differences were detected for this PR.
No output-delta input files changed, so the Output Delta comparison workflow was not run.

No full diff content was generated for this run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the release-signature verification documentation update.

No open issues 🎉

What changed in this PR

Adds release-signature verification guidance to Auth Operator’s installation documentation, addressing #652 so consumers can verify published artifacts before deployment.

Changes:

  • Documents image and OCI Helm chart verification using cosign with an anchored release-workflow identity and issuer.
  • Adds SBOM and provenance verification commands for images and release manifests.
  • Provides a Kyverno admission-policy example and guidance on deploying verified image digests.
File Description
README.md Links installation instructions to the new verification guide.
docs/​operator-guide.md Adds verification commands, identity constraints, and a Kyverno policy example.

Review effort: Balanced

@github-actions

github-actions Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Security scan report

Commit: 68d8576c1e20f4b4b7b16774d1d493dbe49c814c

Security findings are advisory, not merge blockers. Build, test and licensing checks remain blocking.

A successful job is not proof of a clean scan; findings and scanner errors are called out below.

Check Result Details
Helm Chart Security Scan success Logs
Go Security Checker success Logs
Go Vulnerability Check success Logs
Dependency Review success Logs
Trivy Image Scan success Logs
Trivy Filesystem Scan success Logs
Dependency License Audit success Logs
Helm Lint success Logs
Lint success Logs
Verify Release Image Signature skipped Logs
Test success Logs
Verify Generated Files success Logs
Security Scan success Logs
Build success Logs

See the linked logs for complete findings and any scanner setup failures.

@MaxRink
MaxRink merged commit f20ca81 into main Nov 15, 2026
50 checks passed
@MaxRink
MaxRink deleted the docs/verify-release-signatures branch November 15, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: verify release image and chart signatures

2 participants