README.md

sarif-to-comment-action

This GitHub action converts a SARIF file with security vulnerability findings into a GitHub pull request comment using the @security-alert/sarif-to-comment NPM package.

This is useful if you have do not have access GitHub Advanced Security, in a private repository or GitHub Enterprise. You could, for example, post CodeQL results to a GitHub Issue or PR as a comment.

These are the inputs to action image.

Inputs

sarif-file

Path to SARIF file to add to PR comment. Required.

token

Your GitHub Access Token. For example, ${{ secrets.GITHUB_TOKEN }}. Required.

repository

GitHub repository where this action will run, in owner/repo format. For example, ${{ github.repository }}. Required.

branch

Branch the PR is on. For example, ${{ github.head_ref }}. Required.

pr-number

Number of the pull request. For example, ${{ github.event.number }}. Required.

title

Title for the issue. Default: SARIF vulnerabilities report.

show-rule-details

Flag to show or hide rule details. Default: true

dry-run

If true, do not post the results to a PR. If false, do post the results to the PR. Required. Default: false

odc-sarif

If true, the SARIF input is formatted in the OWASP Dependency Check dialect and the input file will be modified so that the action can correctly parse the SARIF. If false, as for CodeQL SARIF, do nothing extra. Default: false

Example usage

Add this action to your own GitHub action yaml file, replacing the value in sarif-file with the path to the file you want to convert and add to your pull request in this final step, likely the output of a security scanning tool. There are additional helper steps to determine the expected values of url, repo, and owner in the comment-test.yaml workflow.

- name: Post SARIF findings in the pull request
  if: github.event_name == 'pull_request'
  uses: sett-and-hive/sarif-to-comment-action@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    repository: ${{ github.repository }}
    branch: ${{ github.head_ref }}
    pr-number: ${{ github.event.number }}
    sarif-file: scan/results/xss.sarif
    title: My security issue
    dry-run: false

You will need to give you job write permissions for issues for this action to succeed.

If you want to test locally with nektos/act, you will need to add choose a VM runner with docker so the tests work locally with act. Make sure you use an action VM runner that contains the Docker client, like ubuntu-latest=catthehacker.

act -P ubuntu-latest=catthehacker/ubuntu:act-20.04 -j test pull_request

With a section in your test job similar to this:

- name: Post SARIF findings in the pull request
  if: github.event_name == 'pull_request'
  uses: sett-and-hive/sarif-to-comment-action@v1
  with:
    token: fake-secret
    # token: ${{ secrets.GITHUB_TOKEN }}
    branch: 'your-branch'
    pr-number: '1'
    repository: ${{ github.repository }}
    sarif-file: "./test/fixtures/codeql.sarif"
    title: My security issue
    dry-run: 'true' # will not post to PR
    odc-sarif: true

Sample action file

# A workflow that posts SARIF results to an issue

name: Your security scan workflow

on:
  pull_request:
    branches: [main]
  schedule:
    - cron: "0 3 * * *"
  workflow_dispatch:

permissions:
  issues: write

jobs:
  issue:
    runs-on: ubuntu-latest
    name: Run the scan that generates a SARIF file

    steps:

      - name: Checkout
        uses: actions/checkout@v3

      # Your actual scanning step here
      - name: Your security scanner that generates SARIF output
        uses: your-favorite/security-scanner@main
        with:
            format: SARIF
            report-path: ./report/scan-findings.sarif

      - name: Post SARIF findings in the issue
        uses: sett-and-hive/sarif-to-issue-action@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          repository: ${{ github.repository }}
          branch: ${{ github.head_ref }}
          pr-number: ${{ github.event.number }}
          sarif-file: ./report/scan-findings.sarif
          title: "Security scanning results"
          odc-sarif: false

Running as a composite action

Running this action as a composite action allows to run it on dockerized self-hosted runners and various operating systems as it does not require Docker. To run it as a composite action, add /composite to the action name:

- name: Post SARIF findings in the pull request
  uses: sett-and-hive/sarif-to-comment-action/composite@v1
  with:
    ...

Note that this will require node environment to be installed on your machine. You can install it with Setup node action.

Testing

There is a simple test that builds and runs the Dockerfile and does a dry run of @security-alert/sarif-to-comment with a test fixture file with known vulnerabilities.

test/test.sh

All new functionality must be covered by tests.

Security testing

There is a security test that builds and runs the trivy scanner to test for vulnerabilities in the Dockerfile image.

test/trivy.sh

CI

There are two files that perform different tests on the repository.

comment-test.yaml workflow uses the sett-and-hive/sarif-to-comment-action action as one would in their own action workflow.

cit-test.yaml workflow runs the same test script used to develop the action in this repository, ``test/test.sh`.

There is a security scanning workflow as well, trivy workflow, that scans each day and also scans each PR. There is a gitleaks workflow that detects secrets, to keep them out of the repository.

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue. All new functionality must be covered by tests. Please follow this bash style guide when updating or creating scripts.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request ⭐