Actions: Extractor for external actions and workflows does not take into account the ref
- 主要語言
- CodeQL
- 星號
- 10.1k
- 分支
- 2.1k
- 平均合併
- 2 天 15 小時
- 30 天內合併 PR
- 141
描述
I'm trying to add external workflows to the repo before calling CodeQL. This would allow me to recurse into composite actions and callable workflows not defined in the same repo.
This would help detect cache poisoning attacks and unsafe checkouts from composite actions and callable workflows defined in different repos that the one being scanned. As well as other unsafe constructs inside these workflows and actions our organization might rely on.
The attack on tanstack, is an example of how the actual actions/cache call was "hidden" in a composite action:
https://tanstack.com/blog/npm-supply-chain-compromise-postmortem
```yaml
on:
pull_request_target:
paths: ['packages/**', 'benchmarks/**']
jobs:
benchmark-pr:
steps:
- uses: actions/checkout@v6.0.2
with:
ref: refs/pull/${{ github.event.pull_request.number }}/merge # fork's merged code
- uses: TanStack/config/.github/setup@main # transitively calls actions/cache@v5
```
Currently, when storing external composite actions and callable workflows in `.github/actions/external/` the actions are ingested and scanned along with the repos own workflows and thus more issues can be detected.
**But** the folder structure doesn't take into account the ref of the action, so I can only put a single implementation in, before scanning.
# Why this is inherent to the CodeQL extractor's design
Looking at the CodeQL QL library conventions:
`CompositeActionImpl.getResolvedPath()` strips `.github/actions/external/` → result is `actions/checkout`
The uses: string is `actions/checkout@v5` — the QL library matches by path prefix, not by exact `uses:` string
So the CodeQL extractor itself doesn't support multiple versions of the same action at different refs. The directory convention has no slot for the version/ref.
# Impact
When multiple workflows in the same repo use different versions of the same action, such as: `actions/checkout@v5` and `actions/checkout@v6`, it's only possible to place one of these versions in the expected `external` folder.
This results in:
* Incorrect analysis results: CodeQL may analyze v6's `action.yml` when the workflow actually uses v5, or vice versa. If the actions differ in their internal `uses:` or `run:` steps between versions, this could produce false positives or false negatives.
* Non-deterministic: The result depends on the order dependencies are processed.
Possible mitigations
# Proposed solution:
Ensure the `ref` is somehow part of (or supported in) the directory structure:
```
.github/actions/external/actions/checkout/{ref}/path/action.yaml
```
Given that refs themselves can contain `/` and other unsupported characters, and that they may actually point to a different sha between runs, it might be even better to resolve the ref to a sha and when stored under that path:
```
.github/actions/external/actions/checkout/{sha}/path/action.yaml
```
That would result in the most predictable scans.
This may require a sha->ref lookup in order to resolve to the right composite action.
貢獻指南
研究方向
從 `.github/actions/external/` 慣例以及針對 `CompositeActionImpl.getResolvedPath()` 所描述的 CodeQL QL 程式庫行為開始。追蹤如何比對 `actions/checkout@v5` 和 `@v6` 等 `uses:` 值,然後定義應如何表示 refs 或已解析的 SHAs。完成的標準是,同一個外部 action 或 workflow 的不同 refs 能夠以確定性的方式被擷取並分析。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- github-actions
- 領域
- devtools, security
- Issue 類型
- 功能
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 冷清
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100