Use zizmor to scan for GHA security problems (#320)

* apply GHA security improvements suggested by zizmor * run zizmor in CI * Update GH_REF reference in check_simulator_version_updates job --------- Co-authored-by: Lola Marrero <[email protected]>
BerkeleyLearnVerify · Jan 22, 2025 · 8495cc9 · 8495cc9
1 parent dcd0213
commit 8495cc9
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 3 deletions.
diff --git a/.github/workflows/check-formatting.yml b/.github/workflows/check-formatting.yml
@@ -11,6 +11,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          persist-credentials: false
 
       - name: Run black to check formatting
         uses: psf/black@stable

diff --git a/.github/workflows/on-call-reminder.yml b/.github/workflows/on-call-reminder.yml
@@ -12,6 +12,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          persist-credentials: false
 
       - name: Set up Python
         uses: actions/setup-python@v4

diff --git a/.github/workflows/run-coverage.yml b/.github/workflows/run-coverage.yml
@@ -33,12 +33,14 @@ jobs:
       if: inputs.ref != ''
       with:
         ref: ${{ inputs.ref }}
+        persist-credentials: false
 
     - name: Checkout current branch
       uses: actions/checkout@v3
       if: inputs.ref == ''
       with:
         ref: ${{ github.ref }}
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4

diff --git a/.github/workflows/run-simulators.yml b/.github/workflows/run-simulators.yml
@@ -88,12 +88,13 @@ jobs:
             HOSTNAME: ${{ secrets.SSH_HOST }}
             USER_NAME: ${{ secrets.SSH_USERNAME }}
             GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }}
+            GH_REF: ${{ github.ref }}
           run: |
             echo "$PRIVATE_KEY" > private_key && chmod 600 private_key
-            ssh -o StrictHostKeyChecking=no -i private_key ${USER_NAME}@${HOSTNAME} '
+            ssh -o StrictHostKeyChecking=no -o SendEnv=GH_REF -i private_key ${USER_NAME}@${HOSTNAME} '
               cd /home/ubuntu/actions/ &&
               rm -rf Scenic &&
-              git clone --branch $(basename "${{ github.ref }}") --single-branch https://[email protected]/BerkeleyLearnVerify/Scenic.git &&
+              git clone --branch $(basename "$GH_REF") --single-branch https://[email protected]/BerkeleyLearnVerify/Scenic.git &&
               cd Scenic &&
               python3 -m venv venv &&
               source venv/bin/activate &&

diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -47,12 +47,14 @@ jobs:
       if: inputs.ref != ''
       with:
         ref: ${{ inputs.ref }}
+        persist-credentials: false
 
     - name: Checkout current branch
       uses: actions/checkout@v3
       if: inputs.ref == ''
       with:
         ref: ${{ github.ref }}
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
@@ -69,5 +71,8 @@ jobs:
         python -m pip install -e ".[test-full]"
 
     - name: Run pytest
+      env:
+        TEST_OPTIONS: ${{ inputs.options || (matrix.slow && '--no-graphics' || '--fast --no-graphics') }}
+      shell: sh
       run: |
-        pytest ${{ inputs.options || (matrix.slow && '--no-graphics' || '--fast --no-graphics') }}
+        pytest ${TEST_OPTIONS}
diff --git a/.github/workflows/zizmor.yml b/.github/workflows/zizmor.yml
@@ -0,0 +1,37 @@
+name: GitHub Actions Security Analysis with zizmor 🌈
+# https://woodruffw.github.io/zizmor
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  zizmor:
+    name: zizmor latest via PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      # required for workflows in private repositories
+      contents: read
+      actions: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Run zizmor 🌈
+        run: uvx zizmor --format sarif . > results.sarif 
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 
+
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif
+          category: zizmor