mirror of
https://github.com/openfoodfoundation/openfoodnetwork
synced 2026-02-01 21:47:16 +00:00
5c1bdc7698
Restrict the GitHub token permissions only to the required ones; this way, even if the attackers will succeed in compromising your workflow, they won’t be able to do much. - Included permissions for the action. https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs [Keeping your GitHub Actions and workflows secure Part 1: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/) Signed-off-by: neilnaveen <42328488+neilnaveen@users.noreply.github.com>
51 lines
1.5 KiB
YAML
51 lines
1.5 KiB
YAML
# This workflow integrates Brakeman with GitHub's Code Scanning feature
|
|
# Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications
|
|
|
|
name: Brakeman Scan
|
|
|
|
# This section configures the trigger for the workflow. Feel free to customize depending on your convention
|
|
on:
|
|
push:
|
|
branches: [ "master" ]
|
|
pull_request:
|
|
branches: [ "master" ]
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
brakeman-scan:
|
|
permissions:
|
|
contents: read # for actions/checkout to fetch code
|
|
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
|
|
name: Brakeman Scan
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Checkout the repository to the GitHub Actions runner
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
|
|
# Customize the ruby version depending on your needs
|
|
- name: Setup Ruby
|
|
uses: actions/setup-ruby@v1
|
|
with:
|
|
ruby-version: '2.7'
|
|
|
|
- name: Setup Brakeman
|
|
env:
|
|
BRAKEMAN_VERSION: '4.10' # SARIF support is provided in Brakeman version 4.10+
|
|
run: |
|
|
gem install brakeman --version $BRAKEMAN_VERSION
|
|
|
|
# Execute Brakeman CLI and generate a SARIF output with the security issues identified during the analysis
|
|
- name: Scan
|
|
continue-on-error: true
|
|
run: |
|
|
brakeman -f sarif -o output.sarif.json .
|
|
|
|
# Upload the SARIF file generated in the previous step
|
|
- name: Upload SARIF
|
|
uses: github/codeql-action/upload-sarif@v1
|
|
with:
|
|
sarif_file: output.sarif.json
|