
📦 :octocat: A GitHub Action that performs a security scan of your GitHub Actions.
A GitHub Action that performs a security scan of your GitHub actions.
This action is based on octoscan
Here is a basic example of how to use this action. This will work for both push and pull_request events.
---
name: Octoscan
on:
workflow_dispatch:
pull_request:
paths:
- '.github/workflows/*'
push:
paths:
- '.github/workflows/*'
permissions:
security-events: write
actions: read
contents: read
jobs:
octoscan:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- id: octoscan
name: Run octoscan
uses: synacktiv/action-octoscan@v1
- name: Upload SARIF file to GitHub
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: "${{steps.octoscan.outputs.sarif_output}}"
category: octoscan
The action downloads octoscan from its releases when it runs, so synacktiv/action-octoscan@v1 always runs the latest release of octoscan, with nothing to update.
To reproduce a run, pin octoscan with the version input and the action with a commit SHA:
- uses: synacktiv/action-octoscan@<commit sha>
with:
version: v0.1.7
The binary is verified with the SHA256SUMS of the release (releases published before they existed are not).
Security results can the be reviewed in the code security tab if you have write access on the target repository:

Or directly in the pull request:

Inputs are based on the options of octoscan, you can find them here.
The following are optional as step.with keys: