Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions .github/dependabot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,14 @@ updates:
- "devantler-tech/*"
groups:
# One shared workflow release can update several pins and start a full CI run for each.
# The publish-app action updates like any dependency: releases are signed by this
# repository's own cd.yaml on its tag, whatever action revision runs
# (devantler-tech/monorepo ADR 0017), so no platform approval gates its updates.
shared-workflows:
applies-to: version-updates
patterns:
- "devantler-tech/.github/.github/workflows/*"
- "devantler-tech/.github/actions/*"
update-types:
- minor
- patch
ignore:
# The platform only accepts publisher revisions it has approved for this
# consumer and trusts in its image rules; move this pin by hand, in its own
# change, once both accept a newer one (an automatic bump broke regeneration
# in #489 and #498).
- dependency-name: "devantler-tech/.github/.github/workflows/publish-app.yaml"
33 changes: 22 additions & 11 deletions .github/workflows/cd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,30 @@ jobs:
# Reserved image-acceptance tags exercise AGE publication without advancing
# the controller image or manifest aliases.
if: ${{ !startsWith(github.ref_name, 'v0.0.0-age-proof.') }}
runs-on: ubuntu-latest
timeout-minutes: 60
concurrency:
group: publish-verified-${{ github.repository }}
queue: max
cancel-in-progress: false
permissions:
contents: read # Checkout the tagged source.
contents: read # Checkout the tagged source and fetch the default branch.
packages: write # Publish the image and manifest artifact to GHCR.
id-token: write # Mint the keyless Sigstore signing identity.
# Sign only with a revision the platform's image rules already trust. v19.0.5
# replaces v8.0.0, whose slot the platform needs for the next publisher
# (devantler-tech/platform#6227); the platform approves it for this consumer
# when it re-pins the controller.
uses: devantler-tech/.github/.github/workflows/publish-app.yaml@af042c540ce8db4d64add98c34b5c57691e0e812 # v19.0.5
with:
app-name: data-product-controller
enable-caller-pin: true
steps:
- name: Checkout the immutable release source
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ github.sha }}
persist-credentials: false

# Runs directly in this workflow, so the image and the manifests artifact are
# signed as this repository's cd.yaml on the release tag (devantler-tech/monorepo
# ADR 0017), whatever revision of the action runs.
- name: Publish and sign the release as this repository
uses: devantler-tech/.github/actions/publish-app@d70d50665465117f01104313e53057374a96a1a3 # v21.7.2
with:
app-name: data-product-controller

publish-age:
name: Build, exercise, sign and verify AGE image
Expand Down Expand Up @@ -209,9 +221,8 @@ jobs:
docker pull "$image"
digest=$(docker image inspect "$image" --format '{{index .RepoDigests 0}}')
[[ "$digest" =~ ^ghcr.io/devantler-tech/khoist@sha256:[a-f0-9]{64}$ ]]
publisher_identity=$(go run ./scripts/publisher-identity)
cosign verify \
--certificate-identity "$publisher_identity" \
--certificate-identity "https://github.com/devantler-tech/khoist/.github/workflows/cd.yaml@refs/tags/$RELEASE_TAG" \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-github-workflow-repository devantler-tech/khoist \
--certificate-github-workflow-ref "refs/tags/$RELEASE_TAG" \
Expand Down
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ The current chart requires Kubernetes **1.35 or newer**. Check the selected rele
`kubeVersion` field; individual source operators have their own supported versions.

The release workflows are set up to publish, for each release tag, the Helm chart plus a controller
image and manifest artifact signed by the portfolio's trusted keyless release workflow. That setup
image and manifest artifact, each signed keylessly by this repository's own workflow on that tag. That setup
does not prove that a particular version is available. Before you depend on one, confirm that the
registry serves it:

Expand Down Expand Up @@ -310,11 +310,25 @@ cosign verify \
'ghcr.io/devantler-tech/charts/khoist@sha256:<digest>'
```

Deployment policy must match this chart identity separately from the shared controller-image and
manifest publisher. Platform configuration owns signature enforcement and rollout.
Deployment policy must match this chart identity separately from the controller image and
manifest identity below. Platform configuration owns signature enforcement and rollout.

The controller image is signed by that shared publisher, not by the chart workflow above. To obtain
a verified image digest, follow the [released artifact acceptance guide](docs/release-acceptance.md):
### Verify a released image or manifest artifact

The controller image and the manifest artifact are signed by `cd.yaml`, not by the chart workflow
above, with the identity
`https://github.com/devantler-tech/khoist/.github/workflows/cd.yaml@refs/tags/<tag>`:

```bash
cosign verify \
--certificate-identity 'https://github.com/devantler-tech/khoist/.github/workflows/cd.yaml@refs/tags/<tag>' \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
'ghcr.io/devantler-tech/khoist@sha256:<digest>'
```

Use `ghcr.io/devantler-tech/khoist/manifests@sha256:<digest>` for the manifest artifact. Releases
published before `cd.yaml` signed them itself name the portfolio's shared publisher workflow
instead; for those, follow the [released artifact acceptance guide](docs/release-acceptance.md):
its script checks the image and chart signatures of one release against the release tag and source
revision you supply.

Expand Down
1 change: 1 addition & 0 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ exclude = [
# Signing identities are compared by Cosign, not fetched as documentation pages.
"^https://github\\.com/\\$GITHUB_WORKFLOW_REF$",
"^https://github\\.com/\\$SIGNING_WORKFLOW$",
"^https://github\\.com/devantler-tech/khoist/\\.github/workflows/cd\\.yaml@refs/tags/\\$RELEASE_TAG$",
"^https://github\\.com/devantler-tech/actions/\\.github/workflows/publish-app\\.yaml@[0-9a-f]{40}$",
"^https://token\\.actions\\.githubusercontent\\.com/?$",
# This fixture-only loopback route is exercised inside its container by probes.
Expand Down
60 changes: 0 additions & 60 deletions scripts/publisher-identity/main.go

This file was deleted.

45 changes: 0 additions & 45 deletions scripts/publisher-identity/main_test.go

This file was deleted.

47 changes: 32 additions & 15 deletions scripts/release.test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,39 @@ yq -e '.jobs.release.permissions | (((.issues // "none") == "none") and ((."pull
yq -e '.jobs.release.permissions | ((.contents == "write") and (."id-token" == "write"))' "$release_workflow" >/dev/null ||
fail 'release must retain contents and identity permissions for publication'

yq -e '.jobs.publish.uses | test("^devantler-tech/[.]github/[.]github/workflows/publish-app[.]yaml@[0-9a-f]{40}$")' "$workflow" >/dev/null ||
fail 'CD must call the immutable shared publish-app workflow'
grep -F 'app-name: data-product-controller' "$workflow" >/dev/null ||
fail 'CD must identify the controller container for digest pinning'
grep -F 'enable-caller-pin: true' "$workflow" >/dev/null ||
fail 'CD must require an immutable caller identity before signing'
publisher=$(yq '.jobs.publish.uses' "$workflow")
smoke=$(yq '.jobs.smoke.steps[] | select(.run != null) | .run' "$workflow")
# Releases are signed as this repository's own cd.yaml on the release tag
# (devantler-tech/monorepo ADR 0017): the publish action must run directly in
# this job, never inside a reusable workflow whose identity the signature would name.
yq -e '.jobs.publish | has("uses") | not' "$workflow" >/dev/null ||
fail 'CD must not sign through a reusable publisher workflow'
yq -e '[.jobs.publish.steps[] | select(has("uses") and (.uses | test("^devantler-tech/[.]github/actions/publish-app@")))] | length == 1' "$workflow" >/dev/null ||
fail 'CD must publish with exactly one publish-app action step'
yq -e '.jobs.publish.steps[] | select(has("uses") and (.uses | test("^devantler-tech/[.]github/actions/publish-app@"))) | .uses | test("^devantler-tech/[.]github/actions/publish-app@[0-9a-f]{40}$")' "$workflow" >/dev/null ||
fail 'CD must pin the publish-app action to a full commit SHA'
yq -e '.jobs.publish.steps[] | select(has("uses") and (.uses | test("^devantler-tech/[.]github/actions/publish-app@"))) | .with | ((.["app-name"] == "data-product-controller") and ((.mode // "deployment") == "deployment") and (has("oci-name") | not))' "$workflow" >/dev/null ||
fail 'CD must build the controller image and pin it into the data-product-controller container'
yq -e '.jobs.publish.steps[0].uses | test("^actions/checkout@[0-9a-f]{40}$")' "$workflow" >/dev/null ||
fail 'CD must check out the release source before publishing'
# shellcheck disable=SC2016 # ${{ github.sha }} is the literal workflow expression, not a shell expansion.
yq -e '.jobs.publish.steps[0].with | ((.["persist-credentials"] | ((tag == "!!bool") and (. == false))) and (.ref == "${{ github.sha }}"))' "$workflow" >/dev/null ||
fail 'CD must check out the tagged commit without a persisted credential'
yq -e '.jobs.publish.permissions | ((length == 3) and (.contents == "read") and (.packages == "write") and (."id-token" == "write"))' "$workflow" >/dev/null ||
fail 'CD publication must hold only checkout, package and signing permissions'
yq -e '.jobs.publish.concurrency["cancel-in-progress"] | ((tag == "!!bool") and (. == false))' "$workflow" >/dev/null ||
fail 'CD publications must be serialized without cancellation'
yq -e '.jobs.publish.concurrency.queue == "max"' "$workflow" >/dev/null ||
fail 'CD must retain pending release publications instead of replacing them'
# shellcheck disable=SC2016 # Literal GitHub expression: the old and new publisher share this lock.
yq -e '.jobs.publish.concurrency.group == "publish-verified-${{ github.repository }}"' "$workflow" >/dev/null ||
fail 'CD must share the previous publisher lock to protect mutable aliases during the transition'

identity=$(cd "$repo_root" && go run ./scripts/publisher-identity)
[ "$identity" = "https://github.com/$publisher" ] ||
fail 'publisher identity must resolve from the immutable workflow declaration'
printf '%s\n' "$smoke" | grep -F "publisher_identity=\$(go run ./scripts/publisher-identity)" >/dev/null ||
fail 'published-image verification must resolve its signer from the released workflow'
printf '%s\n' "$smoke" | grep -F -- "--certificate-identity \"\$publisher_identity\"" >/dev/null ||
fail 'published-image verification must trust the exact immutable publisher used by CD'
smoke=$(yq '.jobs.smoke.steps[] | select(.run != null) | .run' "$workflow")
# shellcheck disable=SC2016 # $RELEASE_TAG is the literal workflow variable, not a shell expansion.
printf '%s\n' "$smoke" | grep -F -- '--certificate-identity "https://github.com/devantler-tech/khoist/.github/workflows/cd.yaml@refs/tags/$RELEASE_TAG"' >/dev/null ||
fail 'published-image verification must trust only this repository'"'"'s cd.yaml on the release tag'
if printf '%s\n' "$smoke" | grep -F 'publish-app.yaml' >/dev/null; then
fail 'published-image verification must not trust the shared publisher'
fi

[ -f "$deployment" ] || fail 'deploy/deployment.yaml is required by publish-app'
cmp "$generated_crd" "$deploy_crd" || fail 'published and generated CRDs differ'
Expand Down
Loading