-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add schedule and push e2e test for provenance-only workflow #24
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
a489f38
Rename default e2e test to match scheme
ianlewis ac256b1
Update e2e.generic workflows
ianlewis 801a2df
Add tests
ianlewis 283a229
Update e2e test
ianlewis 031eea2
Update push e2e test
ianlewis a683fe9
cleanup verify script
ianlewis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
109 changes: 109 additions & 0 deletions
109
.github/workflows/e2e.generic.push.main.default.slsa2.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
name: Generic push main default SLSA 2 | ||
on: | ||
schedule: | ||
- cron: "0 3 * * *" | ||
workflow_dispatch: | ||
push: | ||
branches: [main] | ||
|
||
env: | ||
GH_TOKEN: ${{ secrets.E2E_GO_TOKEN }} | ||
ISSUE_REPOSITORY: slsa-framework/slsa-github-generator | ||
THIS_FILE: e2e.generic.push.main.default.slsa2.yml | ||
|
||
jobs: | ||
push: | ||
runs-on: ubuntu-latest | ||
if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' | ||
permissions: | ||
contents: write | ||
steps: | ||
- uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0 | ||
- run: ./.github/workflows/scripts/e2e-push.sh | ||
|
||
build: | ||
if: github.event_name == 'push' && github.event.head_commit.message == github.workflow | ||
outputs: | ||
binary-name: ${{ steps.build.outputs.binary-name }} | ||
digest: ${{ steps.hash.outputs.digest }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
- name: Setup Go | ||
uses: actions/setup-go@f6164bd8c8acb4a71fb2791a8b6c4024ff038dab # v2.2.0 | ||
with: | ||
go-version: "1.18" | ||
- name: Build artifact | ||
id: build | ||
run: | | ||
go mod vendor | ||
|
||
go build -mod=vendor -o hello . | ||
|
||
echo "::set-output name=binary-name::hello" | ||
- name: Upload binary | ||
uses: actions/upload-artifact@6673cd052c4cd6fcf4b4e6e60ea986c889389535 # v2.3.1 | ||
with: | ||
name: ${{ steps.build.outputs.binary-name }} | ||
path: ${{ steps.build.outputs.binary-name }} | ||
if-no-files-found: error | ||
retention-days: 5 | ||
- name: Generate hash | ||
shell: bash | ||
id: hash | ||
env: | ||
BINARY_NAME: ${{ steps.build.outputs.binary-name }} | ||
run: | | ||
set -euo pipefail | ||
DIGEST=$(sha256sum $BINARY_NAME) | ||
DIGEST="${DIGEST//'%'/'%25'}" | ||
DIGEST="${DIGEST//$'\n'/'%0A'}" | ||
DIGEST="${DIGEST//$'\r'/'%0D'}" | ||
echo "::set-output name=digest::$DIGEST" | ||
|
||
provenance: | ||
if: github.event_name == 'push' && github.event.head_commit.message == github.workflow | ||
needs: [build] | ||
permissions: | ||
id-token: write | ||
contents: read | ||
uses: slsa-framework/slsa-github-generator/.github/workflows/slsa2_provenance.yml@main | ||
with: | ||
subjects: "${{ needs.build.outputs.digest }}" | ||
|
||
verify: | ||
runs-on: ubuntu-latest | ||
needs: [build, provenance] | ||
if: github.event_name == 'push' && github.event.head_commit.message == github.workflow | ||
steps: | ||
- uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0 | ||
- uses: actions/download-artifact@fb598a63ae348fa914e94cd0ff38f362e927b741 | ||
with: | ||
name: ${{ needs.build.outputs.binary-name }} | ||
- uses: actions/download-artifact@fb598a63ae348fa914e94cd0ff38f362e927b741 | ||
with: | ||
name: ${{ needs.provenance.outputs.attestation-name }} | ||
- uses: actions/setup-go@f6164bd8c8acb4a71fb2791a8b6c4024ff038dab # v2.2.0 | ||
with: | ||
go-version: "1.18" | ||
- env: | ||
BINARY: ${{ needs.build.outputs.go-binary-name }} | ||
PROVENANCE: ${{ needs.provenance.outputs.attestation-name }} | ||
run: ./.github/workflows/scripts/e2e.generic.default.verify.sh | ||
|
||
if-succeeded: | ||
runs-on: ubuntu-latest | ||
needs: [build, provenance, verify] | ||
if: github.event_name == 'push' && github.event.head_commit.message == github.workflow && needs.build.result == 'success' && needs.provenance.result == 'success' && needs.verify.result == 'success' | ||
steps: | ||
- uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0 | ||
- run: ./.github/workflows/scripts/e2e-report-success.sh | ||
|
||
if-failed: | ||
runs-on: ubuntu-latest | ||
needs: [build, provenance, verify] | ||
if: always() && github.event_name == 'push' && github.event.head_commit.message == github.workflow && (needs.build.result == 'failure' || needs.provenance.result == 'failure' || needs.verify.result == 'failure') | ||
steps: | ||
- uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0 | ||
- run: ./.github/workflows/scripts/e2e-report-failure.sh |
96 changes: 96 additions & 0 deletions
96
.github/workflows/e2e.generic.schedule.main.default.slsa2.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
name: Generic schedule main default SLSA 2 | ||
on: | ||
schedule: | ||
- cron: "0 3 * * *" | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build: | ||
outputs: | ||
binary-name: ${{ steps.build.outputs.binary-name }} | ||
digest: ${{ steps.hash.outputs.digest }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
- name: Setup Go | ||
uses: actions/setup-go@f6164bd8c8acb4a71fb2791a8b6c4024ff038dab # v2.2.0 | ||
with: | ||
go-version: "1.18" | ||
- name: Build artifact | ||
id: build | ||
run: | | ||
go mod vendor | ||
|
||
go build -mod=vendor -o hello . | ||
|
||
echo "::set-output name=binary-name::hello" | ||
- name: Upload binary | ||
uses: actions/upload-artifact@6673cd052c4cd6fcf4b4e6e60ea986c889389535 # v2.3.1 | ||
with: | ||
name: ${{ steps.build.outputs.binary-name }} | ||
path: ${{ steps.build.outputs.binary-name }} | ||
if-no-files-found: error | ||
retention-days: 5 | ||
- name: Generate hash | ||
shell: bash | ||
id: hash | ||
env: | ||
BINARY_NAME: ${{ steps.build.outputs.binary-name }} | ||
run: | | ||
set -euo pipefail | ||
DIGEST=$(sha256sum $BINARY_NAME) | ||
DIGEST="${DIGEST//'%'/'%25'}" | ||
DIGEST="${DIGEST//$'\n'/'%0A'}" | ||
DIGEST="${DIGEST//$'\r'/'%0D'}" | ||
echo "::set-output name=digest::$DIGEST" | ||
|
||
provenance: | ||
needs: [build] | ||
permissions: | ||
id-token: write | ||
contents: read | ||
actions: read | ||
uses: slsa-framework/slsa-github-generator/.github/workflows/slsa2_provenance.yml@main | ||
with: | ||
subjects: "${{ needs.build.outputs.digest }}" | ||
|
||
verify: | ||
runs-on: ubuntu-latest | ||
needs: [build, provenance] | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0 | ||
- name: Download binary | ||
uses: actions/download-artifact@fb598a63ae348fa914e94cd0ff38f362e927b741 | ||
with: | ||
name: ${{ needs.build.outputs.binary-name }} | ||
- name: Download provenance | ||
uses: actions/download-artifact@fb598a63ae348fa914e94cd0ff38f362e927b741 | ||
with: | ||
name: ${{ needs.provenance.outputs.attestation-name }} | ||
- name: Setup Go | ||
uses: actions/setup-go@f6164bd8c8acb4a71fb2791a8b6c4024ff038dab # v2.2.0 | ||
with: | ||
go-version: "1.17" | ||
- name: Verify provenance | ||
env: | ||
BINARY: ${{ needs.build.outputs.binary-name }} | ||
PROVENANCE: ${{ needs.provenance.outputs.attestation-name }} | ||
run: ./.github/workflows/scripts/e2e.generic.default.verify.sh | ||
|
||
if-succeeded: | ||
runs-on: ubuntu-latest | ||
needs: [build, provenance, verify] | ||
if: github.event_name == 'push' && github.event.head_commit.message == github.workflow && needs.build.result == 'success' && needs.provenance.result == 'success' && needs.verify.result == 'success' | ||
steps: | ||
- uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0 | ||
- run: ./.github/workflows/scripts/e2e-report-success.sh | ||
|
||
if-failed: | ||
runs-on: ubuntu-latest | ||
needs: [build, provenance, verify] | ||
if: always() && github.event_name == 'push' && github.event.head_commit.message == github.workflow && (needs.build.result == 'failure' || needs.provenance.result == 'failure' || needs.verify.result == 'failure') | ||
steps: | ||
- uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0 | ||
- run: ./.github/workflows/scripts/e2e-report-failure.sh |
This file was deleted.
Oops, something went wrong.
137 changes: 137 additions & 0 deletions
137
.github/workflows/scripts/e2e.generic.default.verify.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
#!/usr/bin/env bash | ||
|
||
source "./.github/workflows/scripts/e2e-utils.sh" | ||
|
||
go env -w GOFLAGS=-mod=mod | ||
|
||
# Install from HEAD | ||
go install github.com/slsa-framework/slsa-verifier@latest | ||
|
||
BRANCH=$(echo "$THIS_FILE" | cut -d '.' -f4) | ||
|
||
echo "branch is $BRANCH" | ||
echo "GITHUB_REF_NAME: $GITHUB_REF_NAME" | ||
echo "GITHUB_REF_TYPE: $GITHUB_REF_TYPE" | ||
echo "GITHUB_REF: $GITHUB_REF" | ||
|
||
# Default parameters. | ||
if [[ "$BRANCH" == "main" ]]; then | ||
slsa-verifier --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_eq "$?" "0" "main default parameters" | ||
else | ||
slsa-verifier --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "not main default parameters" | ||
fi | ||
|
||
echo "DEBUG: file is $THIS_FILE" | ||
|
||
# Correct branch | ||
slsa-verifier --branch "$BRANCH" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_eq "$?" "0" "should be branch $BRANCH" | ||
|
||
# Wrong branch | ||
slsa-verifier --branch "not-$GITHUB_REF_NAME" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "wrong branch" | ||
|
||
# Wrong tag | ||
slsa-verifier --tag v1.2.3 --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "wrong tag" | ||
|
||
if [[ "$GITHUB_REF_TYPE" == "tag" ]]; then | ||
#TODO: try several versioned-tags and tags. | ||
SEMVER="$GITHUB_REF_NAME" | ||
PATCH=$(echo "$SEMVER" | cut -d '.' -f3) | ||
MINOR=$(echo "$SEMVER" | cut -d '.' -f2) | ||
MAJOR=$(echo "$SEMVER" | cut -d '.' -f1) | ||
|
||
M="${MAJOR:1}" | ||
MAJOR_LESS_ONE="v$((M - 1))" | ||
MINOR_LESS_ONE=$((MINOR - 1)) | ||
PATCH_LESS_ONE=$((PATCH - 1)) | ||
MAJOR_PLUS_ONE="v$((M + 1))" | ||
MINOR_PLUS_ONE=$((MINOR + 1)) | ||
PATCH_PLUS_ONE=$((PATCH + 1)) | ||
|
||
# Correct vM.N.P | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR.$PATCH" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_eq "$?" "0" "$MAJOR.$MINOR.$PATCH versioned-tag vM.N.P ($MAJOR.$MINOR.$PATCH) should be correct" | ||
|
||
# Correct vM.N | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_eq "$?" "0" "$MAJOR.$MINOR versioned-tag vM.N ($MAJOR.$MINOR) should be correct" | ||
|
||
# Correct vM | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_eq "$?" "0" "$MAJOR versioned-tag vm ($MAJOR) should be correct" | ||
|
||
# Incorrect v(M-1) | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR_LESS_ONE" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR_LESS_ONE versioned-tag should be incorrect" | ||
|
||
# Incorrect v(M-1).N | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR_LESS_ONE.$MINOR" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR_LESS_ONE.$MINOR versioned-tag should be incorrect" | ||
|
||
# Incorrect v(M-1).N.P | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR_LESS_ONE.$MINOR.$PATCH" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR_LESS_ONE.$MINOR.$PATCH versioned-tag should be incorrect" | ||
|
||
# Incorrect vM.(N-1) | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR_LESS_ONE" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR.$MINOR_LESS_ONE versioned-tag should be incorrect" | ||
|
||
# Incorrect vM.(N-1).P | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR_LESS_ONE.$PATCH" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR.$MINOR_LESS_ONE.$PATCH versioned-tag should be incorrect" | ||
|
||
# Incorrect vM.N.(P-1) | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR.$PATCH_LESS_ONE" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR.$MINOR.$PATCH_LESS_ONE versioned-tag should be incorrect" | ||
|
||
# Incorrect v(M+1) | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR_PLUS_ONE" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR_PLUS_ONE versioned-tag should be incorrect" | ||
|
||
# Incorrect v(M+1).N | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR_PLUS_ONE.$MINOR" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR_PLUS_ONE.$MINOR versioned-tag should be incorrect" | ||
|
||
# Incorrect v(M+1).N.P | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR_PLUS_ONE.$MINOR.$PATCH" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR_PLUS_ONE.$MINOR.$PATCH versioned-tag should be incorrect" | ||
|
||
# Incorrect vM.(N+1) | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR_PLUS_ONE" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR.$MINOR_PLUS_ONE versioned-tag should be incorrect" | ||
|
||
# Incorrect vM.(N+1).P | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR_PLUS_ONE.$PATCH" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR.$MINOR_PLUS_ONE.$PATCH versioned-tag should be incorrect" | ||
|
||
# Incorrect vM.N.(P+1) | ||
slsa-verifier --branch "$BRANCH" --versioned-tag "$MAJOR.$MINOR.$PATCH_PLUS_ONE" --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "$MAJOR.$MINOR.$PATCH_PLUS_ONE versioned-tag should be incorrect" | ||
else | ||
# Wrong versioned-tag | ||
slsa-verifier --branch "$BRANCH" --versioned-tag v1.2.3 --artifact-path "$BINARY" --provenance "$PROVENANCE" --source "github.com/$GITHUB_REPOSITORY" | ||
e2e_assert_not_eq "$?" "0" "wrong versioned-tag" | ||
fi | ||
|
||
# Provenance content verification. | ||
ATTESTATION=$(jq -r '.payload' <"$PROVENANCE" | base64 -d) | ||
ASSETS=$(echo "$THIS_FILE" | cut -d '.' -f5 | grep -v noassets) | ||
DIR="$PWD" | ||
e2e_verify_predicate_subject_name "$ATTESTATION" "$BINARY" | ||
e2e_verify_predicate_builder_id "$ATTESTATION" "https://github.com/slsa-framework/slsa-github-generator/.github/workflows/builder_go_slsa3.yml@refs/heads/main" | ||
e2e_verify_predicate_builderType "$ATTESTATION" "https://github.com/slsa-framework/slsa-github-generator-go@v1" | ||
|
||
e2e_verify_predicate_invocation_configSource "$ATTESTATION" "{\"uri\":\"git+https://github.com/$GITHUB_REPOSITORY@$GITHUB_REF\",\"digest\":{\"sha1\":\"$GITHUB_SHA\"},\"entryPoint\":\"$GITHUB_WORKFLOW\"}" | ||
|
||
e2e_verify_predicate_invocation_environment "$ATTESTATION" "github_actor" "$GITHUB_ACTOR" | ||
e2e_verify_predicate_invocation_environment "$ATTESTATION" "github_sha1" "$GITHUB_SHA" | ||
e2e_verify_predicate_invocation_environment "$ATTESTATION" "github_event_name" "$GITHUB_EVENT_NAME" | ||
e2e_verify_predicate_invocation_environment "$ATTESTATION" "github_ref" "$GITHUB_REF" | ||
e2e_verify_predicate_invocation_environment "$ATTESTATION" "github_ref_type" "$GITHUB_REF_TYPE" | ||
|
||
e2e_verify_predicate_metadata "$ATTESTATION" "{\"buildInvocationID\":\"$GITHUB_RUN_ID-$GITHUB_RUN_ATTEMPT\",\"completeness\":{\"parameters\":true,\"environment\":false,\"materials\":false},\"reproducible\":false}" | ||
e2e_verify_predicate_materials "$ATTESTATION" "{\"uri\":\"git+https://github.com/$GITHUB_REPOSITORY@$GITHUB_REF\",\"digest\":{\"sha1\":\"$GITHUB_SHA\"}}" |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in a follow-up PR, let's create function for these, since they are the same as the SLSA3 Go. This way we can have functions that apply to all builders.