OctoscanはGitHubアクションワークフロー向けの静的脆弱性スキャナーです。
各ルールの脆弱なワークフローはtestdataにあります。ルールを試すには: ./octoscan scan testdata。
$ go mod tidy
$ go build
または docker を使用する場合:
$ docker pull ghcr.io/synacktiv/octoscan:latest
Octoscan はローカルの git リポジトリに対して実行することも、dl アクションで全てのワークフローをダウンロードすることもできます:
$ octoscan dl -h
Octoscan.
Usage:
octoscan dl [options] --org <org> [--repo <repo> --token <pat> --default-branch --max-branches <num> --path <path> --output-dir <dir> --include-archives]
Options:
-h, --help Show help
-d, --debug Debug output
--verbose Verbose output
--org <org> Organizations to target
--repo <repo> Repository to target
--token <pat> GHP to authenticate to GitHub
--default-branch Only download workflows from the default branch
--max-branches <num> Limit the number of branches to download
--path <path> GitHub file path to download [default: .github/workflows]
--output-dir <dir> Output dir where to download files [default: octoscan-output]
--include-archives Also download archived repositories
./octoscan dl --token ghp_<token> --org apache --repo incubator-answer
何を実行すればよいかわからない場合は、これを実行するだけです:
./octoscan scan path/to/repos/ --disable-rules shellcheck,local-action --filter-triggers external
誤検知を減らし、最も興味深い結果を得ることができます。
dl コマンドでワークフローをダウンロードした場合、octoscan はデフォルトですべてのブランチのすべてのワークフローをダウンロードするため、ワークフローが重複している可能性があります。重複したワークフローを削除して分析を高速化するには、分析を実行する前に fdupes コマンドを使用できます:
fdupes -n -r -N -d path/to/repo
$ octoscan scan -h
octoscan
Usage:
octoscan scan [options] --list-rules
octoscan scan [options] <target>
octoscan scan [options] <target> [--debug-rules --filter-triggers=<triggers> --filter-run --ignore=<pattern> ((--disable-rules | --enable-rules ) <rules>) --config-file <config>]
Options:
-h, --help
-v, --version
-d, --debug
--verbose
--format <format> Output format, json, sarif or custom template to format error messages in Go template syntax. See https://github.com/rhysd/actionlint/tree/main/docs/usage.md#format
--oneline Use one line per one error. Useful for reading error messages from programs
Args:
<target> Target File or directory to scan
--filter-triggers <triggers> Scan workflows with specific triggers (comma separated list: "push,pull_request_target" or pre-configured: external/allnopr)
--filter-run Search for expression injection only in run shell scripts.
--ignore <pattern> Regular expression matching to error messages you want to ignore.
--disable-rules <rules> Disable specific rules. Split on ","
--enable-rules <rules> Enable specific rules, this will disable all other rules. Split on ","
--debug-rules Enable debug rules.
--config-file <config> Config file.
Examples:
$ octoscan scan ci.yml --disable-rules shellcheck,local-action --filter-triggers external
このツールは、push/pull_request イベント時にリポジトリをスキャンする GitHub action として直接使用することもできます。詳細については、このリポジトリを確認してください。
ルールの完全なリストは、次のコマンドで確認できます:
$ octoscan scan --list-rules
2024/08/07 16:50:48 [INFO] Available rules
- shellcheck
Checks for shell script sources in "run:" using shellcheck
- credentials
Checks for credentials in "services:" configuration
- dangerous-action
Check for dangerous actions.
- dangerous-checkout
Check for dangerous checkout.
- expression-injection
Check for expression injection.
- dangerous-write
Check for dangerous write operation on $GITHUB_OUTPUT or $GITHUB_ENV.
- local-action
Check for local actions.
- runner-label
Checks for GitHub-hosted and preset self-hosted runner labels in "runs-on:"
- unsecure-commands
Check 'ACTIONS_ALLOW_UNSECURE_COMMANDS' env variable.
- known-vulnerability
Check for known vulnerabilities.
- bot-check
Check for if statements that are based on a bot identity.
- dangerous-artefact
Check for workflow that upload artefacts containing sensitive files.
- overprovisioned-secrets
Check for dumps (toJSON(secrets)) and dynamic accesses (secrets[...]) of the secrets context.
- toctou
Check for checkouts of a mutable PR reference in workflows triggered after an approval (comment, dispatch, label).
- prompt-injection
Check for AI agents that process untrusted input, that anyone can trigger or that have dangerous tools.
- unsound-condition
Check for "if:" conditions that can be bypassed or that are always true.
- debug-external-trigger
Check for workflow that can be externally triggered.
- debug-artefacts
Check for workflow that upload artefacts.
- debug-js-exec
Check for workflow that execute system commands in JS scripts.
- debug-oidc-action
Check for OIDC actions.
- repo-jacking
Verify that external actions are pointing to a valid GitHub user or organization.
workflow_run や pull_request_target のようなトリガーは、シークレットへの読み取りアクセスを持ち、対象リポジトリへの書き込みアクセスを持つ可能性があるため、特権的なコンテキストで実行されます。信頼できないコードに対して明示的なチェックアウトを実行すると、そのようなコンテキストで攻撃者のコードがダウンロードされる結果になります。

actions/checkout v7 以降、このアクションは pull_request_target および workflow_run ワークフローにおいてフォーク PR のコードの取得を拒否します(この保護は浮動メジャータグ v2 以降にバックポートされており、SHA、マイナー、パッチのピン留めには適用されません)。このルールは以下を報告します:
ref または PR のヘッドリポジトリである repository を指定したチェックアウト。また、特権イベントの場合、ピン留めされたバージョンにこの保護があるかどうかを通知します;allow-unsafe-pr-checkout、保護を無効にする入力:これは意図的なオプトアウトであり、注意深く確認してください。スクリプト(git、gh pr checkout)やその他のイベント(issue_comment など)によるチェックは、この保護の対象外です。
このルールは、危険なアクションが使用された場合にユーザーに警告します。主に信頼できないアーティファクトに焦点を当てています。