Isolate signing step by moving to its own job

LaurentGoderre · LaurentGoderre · commit f0eb70d171fe · 2024-10-04T14:26:32.000-04:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -20,6 +20,13 @@ on:
           - '' # without this, it's technically "required" 🙃
           - 2022
           - 2019
+      pruneArtifact:
+        required: true
+        type: choice
+        options:
+          - "true"
+          - "false"
+        default: "true"
 run-name: '${{ inputs.bashbrewArch }}: ${{ inputs.firstTag }} (${{ inputs.buildId }})'
 permissions:
   contents: read
@@ -45,6 +52,9 @@ jobs:
     name: Build ${{ inputs.buildId }}
     outputs:
       shouldSign: ${{ steps.json.outputs.shouldSign }}
+      buildJson: ${{ steps.json.outputs.json }}
+      artifactId: ${{ steps.oci.outputs.artifact-id }}
+      sha256: ${{ steps.checksum.outputs.sha256 }}
     runs-on: ${{ inputs.bashbrewArch == 'windows-amd64' && format('windows-{0}', inputs.windowsVersion) || 'ubuntu-latest' }}
     steps:
 
@@ -158,136 +168,233 @@ jobs:
           fi
           eval "$shell"
 
-      # TODO signing prototype (see above where "shouldSign" is populated)
+      - name: Generate Checksum
+        id: checksum
+        run: |
+          cd build
+          tar -cvf temp.tar -C temp .
+          echo "sha256=$(sha256sum temp.tar)" >> "$GITHUB_OUTPUT"
+      - name: Stage artifact
+        id: oci
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-oci
+          path: |
+            build/temp.tar*
+          retention-days: 5
+
+  sign:
+    name: Sign
+    needs: build
+    if: ${{ needs.build.outputs.shouldSign == 'true' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      actions: write # for https://github.com/andymckay/cancel-action (see usage below)
+      id-token: write # for AWS KMS signing (see usage below)
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout-cone-mode: 'false'
+          sparse-checkout: |
+            .scripts/oci.jq
+            .scripts/provenance.jq
+      - name: Download a single artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: build-oci
+      - name: Verify artifact
+        run: |
+          echo "${{ needs.build.outputs.sha256 }}" sha256sum -c
+          mkdir -p temp
+          tar -xvf temp.tar -C temp
       - name: Configure AWS (for signing)
-        if: steps.json.outputs.shouldSign == 'true'
         # https://github.com/aws-actions/configure-aws-credentials/releases
         uses: aws-actions/configure-aws-credentials@010d0da01d0b5a38af31e9c3470dbfdabdecca3a # v4.0.1
         with:
-          # TODO drop "subset" (github.ref_name == "main" && ... || ...)
-          aws-region:     ${{ contains(fromJSON('["main","subset"]'), github.ref_name) && secrets.AWS_KMS_PROD_REGION   || secrets.AWS_KMS_STAGE_REGION }}
-          role-to-assume: ${{ contains(fromJSON('["main","subset"]'), github.ref_name) && secrets.AWS_KMS_PROD_ROLE_ARN || secrets.AWS_KMS_STAGE_ROLE_ARN }}
-          # TODO figure out if there's some way we could make our secrets ternaries here more DRY without major headaches 🙈
+          aws-region:     ${{ secrets.AWS_KMS_REGION }}
+          role-to-assume: ${{ secrets.AWS_KMS_ROLE_ARN }}
+      - name: Generate Provenance
+        env:
+          buildJson:      ${{ needs.build.outputs.buildJson }}
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: |
+          image-digest() {
+            local dir="$1/blobs"
+            img=$(
+              grep -R --include "*" '"mediaType":\s"application/vnd.oci.image.layer.' "$dir" \
+                | head -n 1 \
+                | cut -d ':' -f1
+            )
+            [ "$(cat $img | jq -r '.mediaType')" = "application/vnd.oci.image.manifest.v1+json" ] || exit 1
+            echo $img | rev | cut -d '/' -f2,1 --output-delimiter ':' | rev
+          }
+
+          digest=$(image-digest temp)
+
+          echo $buildJson | jq -L.scripts --argjson github '${{ env.GITHUB_CONTEXT }}' --argjson runner '${{ toJson(runner) }}' --arg digest ${digest} '
+            include "provenance";
+            github_actions_provenance($github; $runner; $digest)
+          ' >> provenance.json
       - name: Sign
-        if: steps.json.outputs.shouldSign == 'true'
         env:
-          AWS_KMS_REGION:  ${{ contains(fromJSON('["main","subset"]'), github.ref_name) && secrets.AWS_KMS_PROD_REGION  || secrets.AWS_KMS_STAGE_REGION }}
-          AWS_KMS_KEY_ARN: ${{ contains(fromJSON('["main","subset"]'), github.ref_name) && secrets.AWS_KMS_PROD_KEY_ARN || secrets.AWS_KMS_STAGE_KEY_ARN }}
+          AWS_KMS_REGION:  ${{ secrets.AWS_KMS_REGION }}
+          AWS_KMS_KEY_ARN: ${{ secrets.AWS_KMS_KEY_ARN }}
+
+          DOCKER_HUB_USERNAME: ${{ secrets.DOCKER_HUB_USERNAME }}
+          DOCKER_HUB_PASSWORD: ${{ secrets.DOCKER_HUB_PASSWORD }}
         run: |
-          cd build
+          validate-oci-layout() {
+            local dir="$1"
+            jq -L.scripts -s '
+              include "oci";
+              validate_oci_layout | true
+            ' "$dir/oci-layout" "$dir/index.json" || return "$?"
+            local manifest
+            manifest="$dir/blobs/$(jq -r '.manifests[0].digest | sub(":"; "/")' "$dir/index.json")" || return "$?"
+            jq -L.scripts -s '
+              include "oci";
+              if length != 1 then
+                error("unexpected image index document count: \(length)")
+              else .[0] end
+              | validate_oci_index
 
-          args=(
+              # TODO more validation?
+            ' "$manifest" || return "$?"
+          }
+
+          dockerArgs=(
             --interactive
             --rm
             --read-only
             --workdir /tmp # see "--tmpfs" below (TODO the signer currently uses PWD as TMPDIR -- something to fix in the future so we can drop this --workdir and only keep --tmpfs perhaps adding --env TMPDIR=/tmp if necessary)
           )
           if [ -t 0 ] && [ -t 1 ]; then
-            args+=( --tty )
+            dockerArgs+=( --tty )
           fi
 
           user="$(id -u)"
-          args+=( --tmpfs "/tmp:uid=$user" )
+          dockerArgs+=( --tmpfs "/tmp:uid=$user" )
           user+=":$(id -g)"
-          args+=( --user "$user" )
+          dockerArgs+=( --user "$user" )
 
           awsEnvs=( "${!AWS_@}" )
-          args+=( "${awsEnvs[@]/#/--env=}" )
-
-          # some very light assumption verification (see TODO in --mount below)
-          validate-oci-layout() {
-            local dir="$1"
-            jq -s '
-              if length != 1 then
-                error("unexpected 'oci-layout' document count: " + length)
-              else .[0] end
-              | if .imageLayoutVersion != "1.0.0" then
-                error("unsupported imageLayoutVersion: " + .imageLayoutVersion)
-              else . end
-            ' "$dir/oci-layout" || return "$?"
-            jq -s '
-              if length != 1 then
-                error("unexpected 'index.json' document count: " + length)
-              else .[0] end
+          dockerArgs+=( "${awsEnvs[@]/#/--env=}" )
 
-              | if .schemaVersion != 2 then
-                error("unsupported schemaVersion: " + .schemaVersion)
-              else . end
-              | if .mediaType != "application/vnd.oci.image.index.v1+json" and .mediaType then # TODO drop the second half of this validation: https://github.com/moby/buildkit/issues/4595
-                error("unsupported index mediaType: " + .mediaType)
-              else . end
-              | if .manifests | length != 1 then
-                error("expected only one manifests entry, not " + (.manifests | length))
-              else . end
-
-              | .manifests[0] |= (
-                if .mediaType != "application/vnd.oci.image.index.v1+json" then
-                  error("unsupported descriptor mediaType: " + .mediaType)
-                else . end
-                # TODO validate .digest somehow (`crane validate`?) - would also be good to validate all descriptors recursively
-                | if .size < 0 then
-                  error("invalid descriptor size: " + .size)
-                else . end
-              )
-            ' "$dir/index.json" || return "$?"
-            local manifest
-            manifest="$dir/blobs/$(jq -r '.manifests[0].digest | sub(":"; "/")' "$dir/index.json")" || return "$?"
-            jq -s '
-              if length != 1 then
-                error("unexpected image index document count: " + length)
-              else .[0] end
-              | if .schemaVersion != 2 then
-                error("unsupported schemaVersion: " + .schemaVersion)
-              else . end
-              | if .mediaType != "application/vnd.oci.image.index.v1+json" then
-                error("unsupported image index mediaType: " + .mediaType)
-              else . end
-
-              # TODO more validation?
-            ' "$manifest" || return "$?"
-          }
           validate-oci-layout temp
 
-          mkdir signed
+          # Login to Docker Hub
+          export DOCKER_CONFIG="$PWD/.docker"
+          mkdir "$DOCKER_CONFIG"
+          trap 'find "$DOCKER_CONFIG" -type f -exec shred -fuvz "{}" + || :; rm -rf "$DOCKER_CONFIG"' EXIT
+          docker login --username "$DOCKER_HUB_USERNAME" --password-stdin <<<"$DOCKER_HUB_PASSWORD"
+          unset DOCKER_HUB_USERNAME DOCKER_HUB_PASSWORD
 
-          args+=(
-            --mount "type=bind,src=$PWD/temp,dst=/doi-build/unsigned" # TODO this currently assumes normalized_builder == "buildkit" and !should_use_docker_buildx_driver -- we need to factor that in later (although this signs the attestations, not the image, so buildkit/buildx is the only builder whose output we *can* sign right now)
-            --mount "type=bind,src=$PWD/signed,dst=/doi-build/signed"
+          # Create signatures
+          dockerArgs+=(
+            --mount "type=bind,src=$PWD/temp,dst=/doi-build/image" # TODO this currently assumes normalized_builder == "buildkit" and !should_use_docker_buildx_driver -- we need to factor that in later (although this signs the attestations, not the image, so buildkit/buildx is the only builder whose output we *can* sign right now)
+            --mount "type=bind,src=$PWD/provenance.json,dst=/doi-build/provenance.json"
+            --mount "type=bind,src=$PWD/.docker,dst=/.docker"
 
             # https://explore.ggcr.dev/?repo=docker/image-signer-verifier
-            docker/image-signer-verifier:0.3.3@sha256:a5351e6495596429bacea85fbf8f41a77ce7237c26c74fd7c3b94c3e6d409c82
-
-            sign
+            "$IMAGE_SIGNER"
+          )
 
-            --envelope-style oci-content-descriptor
+          kmsArg=(
+             # kms key used to sign attestation artifacts
+            --kms="AWS"
+            --kms-region="$AWS_KMS_REGION"
+            --kms-key-ref="$AWS_KMS_KEY_ARN"
 
-            --aws_region "$AWS_KMS_REGION"
-            --aws_arn "awskms:///$AWS_KMS_KEY_ARN"
+            --referrers-dest="$REFERRERS_REPO"  # repo to store attestation artifacts and provenance
+          )
 
-            --input oci:///doi-build/unsigned
-            --output oci:///doi-build/signed
+          # Sign buildkit statements
+          signArgs=(
+            ${kmsArg[@]}
+            --input=oci:///doi-build/image
+            --keep=true  # keep preserves the unsigned attestations generated by buildkit
           )
 
-          docker run "${args[@]}"
+          docker run "${dockerArgs[@]}" sign "${signArgs[@]}"
 
-          validate-oci-layout signed
+          # Attach and sign provenance
+          provArgs=(
+            ${kmsArg[@]}
+            --image=oci:///doi-build/image
+            --statement="/doi-build/provenance.json"
+          )
+          docker run "${dockerArgs[@]}" attest "${provArgs[@]}"
+
+  push:
+    name: Push
+    needs:
+      - build
+      - sign
+      # - verify
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: ${{ (needs.sign.result == 'skipped' && needs.build.result == 'success') ||  needs.verify.result == 'success' || 'exit 1' }}
+      - name: Download a single artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: build-oci
+      - name: Verify artifact
+        run: |
+          echo "${{ needs.build.outputs.sha256 }}" sha256sum -c
+          mkdir -p temp
+          tar -xvf temp.tar -C temp
+      - name: Tools
+        run: |
+          mkdir .gha-bin
+          echo "$PWD/.gha-bin" >> "$GITHUB_PATH"
 
-          # TODO validate that "signed" still has all the original layer blobs from "temp" (ie, that the attestation manifest *just* has some new layers and everything else is unchanged)
+          case "${RUNNER_ARCH}" in \
+            X64) ARCH='amd64';; \
+          esac
 
-          rm -rf temp
-          mv signed temp
+          _download() {
+            local target="$1"; shift
+            local url="$1"; shift
+            wget --timeout=5 -O "$target" "$url" --progress=dot:giga
+          }
 
+          # https://doi-janky.infosiftr.net/job/wip/job/crane
+          _download ".gha-bin/crane" "https://doi-janky.infosiftr.net/job/wip/job/crane/lastSuccessfulBuild/artifact/crane-$ARCH"
+          # TODO checksum verification ("checksums.txt")
+          chmod +x ".gha-bin/crane"
+          ".gha-bin/crane" version
       - name: Push
         env:
           DOCKER_HUB_USERNAME: ${{ secrets.DOCKER_HUB_USERNAME }}
           DOCKER_HUB_PASSWORD: ${{ secrets.DOCKER_HUB_PASSWORD }}
+          buildJson:      ${{ needs.build.outputs.buildJson }}
         run: |
           export DOCKER_CONFIG="$PWD/.docker"
           mkdir "$DOCKER_CONFIG"
           trap 'find "$DOCKER_CONFIG" -type f -exec shred -fuvz "{}" + || :; rm -rf "$DOCKER_CONFIG"' EXIT
           docker login --username "$DOCKER_HUB_USERNAME" --password-stdin <<<"$DOCKER_HUB_PASSWORD"
           unset DOCKER_HUB_USERNAME DOCKER_HUB_PASSWORD
 
-          cd build
-          shell="$(jq <<<"$json" -r '.commands.push')"
+          shell="$(jq <<<"$buildJson" -r '.commands.push')"
           eval "$shell"
+
+  clean:
+    name: Cleanup
+    needs:
+      - build
+      # - verify
+      - push
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clean Up Artifact
+        if: ${{ inputs.pruneArtifact == 'true' }}
+        run: |
+          curl -L \
+            -X DELETE \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ github.token }}" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            https://api.github.com/repos/${{ github.repository }}/actions/artifacts/${{ needs.build.outputs.artifactId }}
