Harden GitHub Actions Workflow - codeql.yml

[int-stepsecurity-advanced]

GitHub Token Permissions Are Not Set to Minimum in Workflow

Summary

The GitHub token permissions in your workflow file (.github/workflows/codeql.yml) exceed the minimum required. Reducing permissions to the minimum necessary enhances security by limiting the access scope of the token, thereby lowering the risk of accidental or malicious misuse.

Why This is Important

Using excessive permissions in GitHub workflows can expose your repository to potential security risks. The GitHub token grants access to repository resources, and any unnecessary permissions increase the likelihood of sensitive actions being performed without justification. By applying the principle of least privilege, you protect your repository from unintended data exposure and ensure that each job only has access to what it absolutely needs.

Evidence of Excessive Permissions

For more context, please refer to the build log from your recent workflow run, which highlights the permissions granted to the GitHub token that exceed the recommended minimum.

Suggested Fix

Below is the updated permissions configuration, which minimizes access for the GitHub token. Update your workflow file with this suggested configuration to resolve this issue:

```diff
  # For most projects, this workflow file will not need changing; you simply need
  # to commit it to your repository.
  #
  # You may wish to alter this file to override the set of languages analyzed,
  # or to provide custom queries or build logic.
  #
  # ******** NOTE ********
  # We have attempted to detect the languages in your repository. Please check
  # the `language` matrix defined below to confirm you have the correct set of
  # supported CodeQL languages.
  #
  name: "CodeQL"
  on:
    push:
      branches: ["main"]
    pull_request:
      # The branches below must be a subset of the branches above
      branches: ["main"]
    schedule:
      - cron: "0 0 * * 1"
  permissions:
    contents: read
  jobs:
    analyze:
      name: Analyze
      runs-on: ubuntu-latest
      permissions:
        actions: read
        contents: read
        security-events: write
      strategy:
        fail-fast: false
        matrix:
          language: ["javascript", "typescript"]
          # CodeQL supports [ $supported-codeql-languages ]
          # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
      steps:
        - name: Harden Runner
          uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
          with:
            egress-policy: audit
        - name: Checkout repository
          uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
        # Initializes the CodeQL tools for scanning.
        - name: Initialize CodeQL
          uses: github/codeql-action/init@379614612a29c9e28f31f39a59013eb8012a51f0 # v3.24.3
          with:
            languages: ${{ matrix.language }}
            # If you wish to specify custom queries, you can do so here or in a config file.
            # By default, queries listed here will override any specified in a config file.
            # Prefix the list here with "+" to use these queries and those in the config file.
        # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
        # If this step fails, then you should remove it and run the build manually (see below)
        - name: Autobuild
          uses: github/codeql-action/autobuild@379614612a29c9e28f31f39a59013eb8012a51f0 # v3.24.3
        # ℹ️ Command-line programs to run using the OS shell.
        # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
        #   If the Autobuild fails above, remove it and uncomment the following three lines.
        #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
        # - run: |
        #   echo "Run, Build Application using script"
        #   ./location_of_script_within_repo/buildscript.sh
        - name: Perform CodeQL Analysis
          uses: github/codeql-action/analyze@379614612a29c9e28f31f39a59013eb8012a51f0 # v3.24.3
          with:
            category: "/language:${{matrix.language}}"

Next Steps

Please review and update the workflow file with these minimum permissions. If additional permissions are necessary for certain steps, specify only those permissions explicitly.

For further guidance, refer to the GitHub documentation on fine-grained permissions.

Severity: High