ci: Add SARIF upload to GitHub Security Dashboard

[jkan2]

Description

Since the findings are located in the semgrep UI, this will allow it to be uploaded to the security dashboard (under code scanning in the security tab). The python script is from semgrep themselves and it transforms the original sarif from semgrep to a more useable readable format in GHAS.

Also changed the image pull to be in ghcr instead of docker hub to prevent pull rate limiting and potential docker hub outages

How Has This Been Tested?

• Tested CCTX in localnet
• Tested in development environment
• Go unit tests
• Go integration tests
• Tested via GitHub Actions

Summary by CodeRabbit

• New Features

  • Enhanced GitHub Actions workflow for improved security scanning.
  • Added JSON output for Semgrep findings.
  • Introduced conversion of findings to SARIF format for better integration with GitHub Advanced Security Dashboard.

• Chores

  • Updated workflow steps for better organization and clarity.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in the pull request enhance the GitHub Actions workflow for Semgrep by adding a checkout step for the semgrep-utilities repository. This allows the workflow to utilize a Python script for converting Semgrep's JSON output into SARIF format. The SARIF file is subsequently uploaded to the GitHub Advanced Security Dashboard. The job's conditional execution remains unchanged, still excluding runs triggered by the dependabot[bot].

Changes

File Path	Change Summary
.github/workflows/semgrep.yml	Added a checkout step for semgrep-utilities, updated semgrep ci command for JSON output, added a step to convert JSON to SARIF, and included a step to upload the SARIF file to GitHub Advanced Security.

Possibly related PRs

• ci: Add Semgrep to CI #2912: The changes in both PRs involve modifications to the .github/workflows/semgrep.yml file, specifically related to the integration and execution of Semgrep within GitHub Actions workflows.

Suggested reviewers

• CharlieMc0
• lumtis
• gartnera

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

.github/workflows/semgrep.yml (1)

33-36: Correct implementation of SARIF upload to GitHub Security Dashboard.

The addition of the SARIF file upload step is correctly implemented using the official GitHub action. This will effectively integrate the Semgrep findings into the GitHub Advanced Security Dashboard.

For improved clarity and maintainability, consider extracting the SARIF filename into an environment variable. This can be achieved by modifying the workflow as follows:

name: Semgrep
on:
  workflow_dispatch: {}
  pull_request: {}
  push:
    branches:
      - develop
  schedule:
    - cron: '56 22 * * *'
jobs:
  semgrep:
    name: semgrep/ci
    runs-on: ubuntu-20.04
    env:
      SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}
+     SARIF_FILE: semgrep-github.sarif
    container:
      image: semgrep/semgrep
    
    if: (github.actor != 'dependabot[bot]')
    steps:
      - uses: actions/checkout@v4    
      - name: Checkout semgrep-utilities repo
        uses: actions/checkout@v4
        with:
          repository: zeta-chain/semgrep-utilities
          path: semgrep-utilities
          
      - run: semgrep ci --json --output semgrep-findings.json 
      
-     - run: python semgrep-utilities/utilities/github-sarif-helper/src/semgrep-json-to-sarif.py --json semgrep-findings.json --sarif semgrep-github.sarif
+     - run: python semgrep-utilities/utilities/github-sarif-helper/src/semgrep-json-to-sarif.py --json semgrep-findings.json --sarif ${{ env.SARIF_FILE }}

      - name: Upload SARIF file for GitHub Advanced Security Dashboard
        uses: github/codeql-action/upload-sarif@v3
        with:
-         sarif_file: semgrep-github.sarif
+         sarif_file: ${{ env.SARIF_FILE }}

This modification enhances readability and reduces the risk of inconsistencies if the filename needs to be changed in the future.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2892114 and 5fb560c.

📒 Files selected for processing (1)

• .github/workflows/semgrep.yml (1 hunks)

🔇 Additional comments (2)

.github/workflows/semgrep.yml (2)

19-27: Appropriate implementation of semgrep-utilities checkout.

The addition of the semgrep-utilities repository checkout is correctly implemented. The use of a specific path for the checkout ensures proper isolation of the utilities.

---

29-29: Correct modification of semgrep ci command for JSON output.

The semgrep ci command has been appropriately updated to generate JSON output, which is essential for the subsequent SARIF conversion process.