chore: Add Security Scan

[AmberJBlue]

Summary by Sourcery

Add a GitHub Actions workflow to perform automated Trivy and Bandit security scans on code pushes and pull requests to the main branch, including SARIF reporting and artifact uploads.

CI:

• Create security-scan.yaml workflow triggered on pushes, pull requests, and manual dispatch
• Add Trivy job to scan the filesystem for vulnerabilities, output SARIF results, enforce failure on critical/high issues, and upload findings to the Security tab
• Add Bandit job to run a Python-focused security scan, generate SARIF output, and upload results as artifacts

[sourcery-ai]

Reviewer's Guide

Introduce a GitHub Actions workflow that runs Trivy FS scans (with enforced exit codes on critical/high vulnerabilities) and Bandit security analysis (uploading SARIF artifacts) on push, pull requests, and manual triggers.

File-Level Changes

Change	Details	Files
Add Trivy-based vulnerability scanning with severity enforcement	Configure workflow triggers for push, pull_request, and workflow_dispatch Checkout code and set up Python 3.11 environment Install project dependencies if pyproject.toml is present Run Trivy FS scan outputting SARIF and enforce exit on critical/high findings Upload Trivy SARIF results to the Security tab	.github/workflows/security-scan.yaml
Add Bandit security scanning and SARIF artifact upload	Set up Python 3.11 virtual environment with pip caching Install project dev dependencies and Bandit with SARIF support Run PyCQA/bandit-action on the repository, excluding tests Upload Bandit SARIF results as a GitHub artifact with retention	.github/workflows/security-scan.yaml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[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.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

Blocking issues:

• An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
• An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
• An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)

General comments:

• Consider caching Trivy’s vulnerability database between runs (e.g. via actions/cache) to speed up subsequent scans.
• Instead of uploading Bandit results as a generic artifact, use upload-sarif so the SARIF report shows up in GitHub’s Security tab.
• You might consolidate the repeated Python setup and dependency-installation steps into a reusable workflow or composite action.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Consider caching Trivy’s vulnerability database between runs (e.g. via actions/cache) to speed up subsequent scans.
- Instead of uploading Bandit results as a generic artifact, use upload-sarif so the SARIF report shows up in GitHub’s Security tab.
- You might consolidate the repeated Python setup and dependency-installation steps into a reusable workflow or composite action.

## Individual Comments

### Comment 1
<location> `.github/workflows/security-scan.yaml:77` </location>
<code_context>
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+
+      - name: Create virtual environment
</code_context>

<issue_to_address>
Pip cache is enabled for Python setup, but not used in Trivy job.

Enable pip cache in the Trivy job to improve installation speed and maintain consistency with the Bandit job.

Suggested implementation:

```
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache: "pip"

```

If the Trivy job is defined separately from the Bandit job, make sure to apply this change to the Trivy job's `actions/setup-python` step. If you do not see a `cache: "pip"` line in the Trivy job, add it as shown above.
</issue_to_address>

## Security Issues

### Issue 1
<location> `.github/workflows/security-scan.yaml:36` </location>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

### Issue 2
<location> `.github/workflows/security-scan.yaml:46` </location>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

### Issue 3
<location> `.github/workflows/security-scan.yaml:95` </location>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}