From c8fe23bdf0594e70025ae6b5eb8a076dc6cabbdb Mon Sep 17 00:00:00 2001 From: Dave Thaler Date: Wed, 26 Jun 2024 12:14:37 -0700 Subject: [PATCH 1/2] Enable OSSF scorecard workflow (#488) * Enable OSSF scorecard workflow Start using the [OpenSSF scorecard](https://github.com/ossf/scorecard) to track overall health and security of this repository. This PR also adds a badge to the main page to see the results, which can be clicked on to see details (which will only show results once the PR is merged causing the workflow to run for the first time). Signed-off-by: Dave Thaler * Harden scorecard runner Signed-off-by: Dave Thaler --------- Signed-off-by: Dave Thaler --- .github/workflows/scorecard.yml | 77 +++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 78 insertions(+) create mode 100644 .github/workflows/scorecard.yml diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml new file mode 100644 index 00000000..2032dbb5 --- /dev/null +++ b/.github/workflows/scorecard.yml @@ -0,0 +1,77 @@ +# This workflow uses actions that are not certified by GitHub. They are provided +# by a third-party and are governed by separate terms of service, privacy +# policy, and support documentation. + +name: Scorecard supply-chain security +on: + # For Branch-Protection check. Only the default branch is supported. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection + branch_protection_rule: + # To guarantee Maintained check is occasionally updated. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained + schedule: + - cron: '22 16 * * 1' + push: + branches: [ "main" ] + +# Declare default permissions as read only. +permissions: read-all + +jobs: + analysis: + name: Scorecard analysis + runs-on: ubuntu-latest + permissions: + # Needed to upload the results to code-scanning dashboard. + security-events: write + # Needed to publish results and get a badge (see publish_results below). + id-token: write + # Uncomment the permissions below if installing in a private repository. + # contents: read + # actions: read + + steps: + - uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0 + with: + egress-policy: audit + + - name: "Checkout code" + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + persist-credentials: false + + - name: "Run analysis" + uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1 + with: + results_file: results.sarif + results_format: sarif + # (Optional) "write" PAT token. Uncomment the `repo_token` line below if: + # - you want to enable the Branch-Protection check on a *public* repository, or + # - you are installing Scorecard on a *private* repository + # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional. + # repo_token: ${{ secrets.SCORECARD_TOKEN }} + + # Public repositories: + # - Publish results to OpenSSF REST API for easy access by consumers + # - Allows the repository to include the Scorecard badge. + # - See https://github.com/ossf/scorecard-action#publishing-results. + # For private repositories: + # - `publish_results` will always be set to `false`, regardless + # of the value entered here. + publish_results: true + + # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF + # format to the repository Actions tab. + - name: "Upload artifact" + uses: actions/upload-artifact@97a0fba1372883ab732affbe8f94b823f91727db # v3.pre.node20 + with: + name: SARIF file + path: results.sarif + retention-days: 5 + + # Upload the results to GitHub's code scanning dashboard (optional). + # Commenting out will disable upload of results to your repo's Code Scanning dashboard + - name: "Upload to code-scanning" + uses: github/codeql-action/upload-sarif@1b1aada464948af03b950897e5eb522f92603cc2 # v3.24.9 + with: + sarif_file: results.sarif diff --git a/README.md b/README.md index 99a059ea..aef06084 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Slack](https://img.shields.io/badge/slack-join%20chat-blue.svg?logo=slack)](https://join.slack.com/t/orcasound/shared_invite/zt-293mdpy47-El~xXZA6YmHOWoCzB~8WpQ) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/orcasound/orcasite/blob/master/CONTRIBUTING.md) +[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/orcasound/orcasite/badge)](https://scorecard.dev/viewer/?uri=github.com/orcasound/orcasite) This repo specifies the web backend and frontend for the [Orcasound app](http://live.orcasound.net) that plays a live audio stream through the user's browser of choice. The backend is an [Elixir](https://elixir-lang.org/) app using the [Phoenix framework](https://phoenixframework.org/). The frontend is built in [Next.js](https://nextjs.org/). From 5f09dd3566a7012e595e05faea363db0bf936ec3 Mon Sep 17 00:00:00 2001 From: Dave Thaler Date: Wed, 26 Jun 2024 12:16:39 -0700 Subject: [PATCH 2/2] Use step-security/harden-runner in github workflows (#486) Turning on harden-runner in "audit" mode is the first step in hardening github workflow jobs. The second step will be to enable "block" mode, which can be seen as the results of the first run: https://app.stepsecurity.io/github/orcasound/orcasite/actions/runs/9293630393?jobid=25577205636&tab=recommendations For more details see https://github.com/step-security/harden-runner Signed-off-by: Dave Thaler --- .github/workflows/ci.yaml | 4 ++++ .github/workflows/fast-forward.yaml | 4 ++++ .github/workflows/heroku.yaml | 8 ++++++++ 3 files changed, 16 insertions(+) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 36a9e91c..6ff518bf 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -10,6 +10,10 @@ jobs: test: runs-on: ubuntu-latest steps: + - uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0 + with: + egress-policy: audit + - name: Checkout code uses: actions/checkout@v4 diff --git a/.github/workflows/fast-forward.yaml b/.github/workflows/fast-forward.yaml index 74431437..98817299 100644 --- a/.github/workflows/fast-forward.yaml +++ b/.github/workflows/fast-forward.yaml @@ -17,6 +17,10 @@ jobs: issues: write steps: + - uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0 + with: + egress-policy: audit + - name: Fast forwarding uses: sequoia-pgp/fast-forward@v1 with: diff --git a/.github/workflows/heroku.yaml b/.github/workflows/heroku.yaml index 54a8b5df..2c404c51 100644 --- a/.github/workflows/heroku.yaml +++ b/.github/workflows/heroku.yaml @@ -17,6 +17,10 @@ jobs: || (contains(github.event.comment.body, '/refresh-heroku-status') && github.event.issue.pull_request) }} steps: + - uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0 + with: + egress-policy: audit + # Forward deployment's status to the deployed commit. - uses: octokit/request-action@v2.x env: @@ -41,6 +45,10 @@ jobs: # Check that the deployed app returns successful HTTP response. steps: + - uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0 + with: + egress-policy: audit + - id: health_check uses: jtalk/url-health-check-action@v4 with: