3.9 KiB · text History d246627
name: audit
# Known vulnerabilities in what the site is built from: every lockfile
# in the repository (today code/Cargo.lock, the types scratch crate)
# checked against the OSV database (https://osv.dev). A finding fails
# the run, which is how it gets noticed — the CI page, the panel widget,
# `gg ci list`. Nightly, since advisories land without anyone pushing,
# and by hand from the Actions page.
#
# On a pull request it compares the lockfiles the pull request changes
# with the same files on the base branch: it fails only on a
# vulnerability the pull request brings in, and says what it fixed and
# what's still there (scripts/osv-diff). A security update PR goes green
# for what it fixes, not red for what it couldn't.
#
# The site itself isn't covered: Zola and static-web-server come in as
# pinned images (Dockerfile), and reveal.js is vendored under static/
# with no lockfile for osv-scanner to read.
on:
  schedule:
    - cron: "17 6 * * *"
  workflow_dispatch:
  pull_request:

permissions:
  contents: read

# A newer push supersedes this run: on a branch or PR the run in
# progress is cancelled; on master it finishes, and only a run still
# waiting is replaced.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}

jobs:
  osv:
    runs-on: self-hosted
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      # Pinned, and checked against the release's published checksum
      # before it runs: a scanner is a strange thing to take on trust.
      # To move it on, change both together, from
      # https://github.com/google/osv-scanner/releases (…_SHA256SUMS).
      - name: Fetch osv-scanner
        env:
          OSV_VERSION: v2.6.0
          OSV_SHA256: ca69b3d3cd08f889a49dc0a383122f71cc528b83803671df5fd874d97485b108
        run: |
          curl -sSfL -o /tmp/osv-scanner \
            "https://github.com/google/osv-scanner/releases/download/${OSV_VERSION}/osv-scanner_linux_amd64"
          echo "${OSV_SHA256}  /tmp/osv-scanner" | sha256sum -c -
          chmod +x /tmp/osv-scanner

      # Exit 1 when anything is vulnerable, so the run fails; the table
      # names each package, its version, and the version that fixes it.
      # Only the lockfiles git tracks: code/target/ is committed, and
      # nothing in a build directory is what the site is built from.
      - name: Scan the lockfiles
        if: github.event_name != 'pull_request'
        run: |
          lockfiles=$(git ls-files | grep -E '(^|/)Cargo\.lock$' || true)
          if [ -z "$lockfiles" ]; then
            echo "No lockfile to scan."
            exit 0
          fi
          /tmp/osv-scanner scan source $(printf -- '--lockfile %s ' $lockfiles)

      - name: Scan the lockfiles this pull request changes
        if: github.event_name == 'pull_request'
        env:
          BASE: ${{ github.base_ref }}
        run: |
          git fetch --quiet origin "$BASE"
          changed=$(git diff --name-only "origin/$BASE"...HEAD | grep -E '(^|/)Cargo\.lock$' || true)
          if [ -z "$changed" ]; then
            echo "No lockfile changed."
            exit 0
          fi
          mkdir -p /tmp/base
          for f in $changed; do
            mkdir -p "/tmp/base/$(dirname "$f")"
            git show "origin/$BASE:$f" > "/tmp/base/$f" 2>/dev/null || true
          done
          # 0 and 1 (found some) are both answers; with nothing to scan, none.
          scan() {
            if [ $# -eq 0 ]; then echo '{}'; return; fi
            /tmp/osv-scanner scan source --format json $(printf -- '--lockfile %s ' "$@") || [ $? -eq 1 ]
          }
          (cd /tmp/base && scan $(for f in $changed; do [ -s "$f" ] && echo "$f"; done)) > /tmp/base.json
          # A lockfile the pull request deletes has nothing on this side.
          scan $(for f in $changed; do [ -s "$f" ] && echo "$f"; done) > /tmp/head.json
          python3 scripts/osv-diff /tmp/base.json /tmp/head.json