From 2bac906d40fcc4231fe147855d52e1e396ea6a63 Mon Sep 17 00:00:00 2001 From: Alessandro Fael Garcia Date: Wed, 31 Jan 2024 05:54:24 -0900 Subject: [PATCH] Implement OSSF Scorecard --- .github/workflows/rename_project.sh | 3 +- .github/workflows/scorecard.yml | 74 +++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/scorecard.yml diff --git a/.github/workflows/rename_project.sh b/.github/workflows/rename_project.sh index 4170157..1562df6 100755 --- a/.github/workflows/rename_project.sh +++ b/.github/workflows/rename_project.sh @@ -26,4 +26,5 @@ do done # This command runs only once on GHA! -rm -rf .github/workflows +rm -f .github/workflows/rename_template.yml +rm -f .github/workflows/rename_project.sh diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml new file mode 100644 index 0000000..b1dc821 --- /dev/null +++ b/.github/workflows/scorecard.yml @@ -0,0 +1,74 @@ +# 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: '30 9 * * 1' + push: + branches: [main, master] + +# Declare default permissions as read only. +permissions: read-all + +jobs: + analysis: + name: Scorecard analysis + runs-on: ubuntu-22.04 + 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 + issues: read # To allow GraphQL ListCommits to work + pull-requests: read # To allow GraphQL ListCommits to work + checks: read # To detect SAST tools + steps: + - name: Check out the codebase + uses: actions/checkout@v4 + with: + persist-credentials: false + + - name: Run analysis + uses: ossf/scorecard-action@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#authentication-with-pat. + # 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@v4 + with: + name: SARIF file + path: results.sarif + retention-days: 5 + + # Upload the results to GitHub's code scanning dashboard. + - name: Upload SARIF results to code scanning + uses: github/codeql-action/upload-sarif@v3 + with: + sarif_file: results.sarif