Skip to content

Commit

Permalink
Add configuration instructions for trusted Action publishers using da…
Browse files Browse the repository at this point in the history
…ta extensions
  • Loading branch information
felickz committed Jan 8, 2025
1 parent bccec0a commit 6b3098d
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions actions/ql/src/Security/CWE-829/UnpinnedActionsTag.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,42 @@ Using a tag for a 3rd party Action that is not pinned to a commit can lead to ex

Pinning an action to a full length commit SHA is currently the only way to use a non-immutable action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. When selecting a SHA, you should verify it is from the action's repository and not a repository fork.


### Configuration

If there is an Action publisher that you trust, you can include the owner name/organization in a data extension model pack to add it to the allow list for this query. Adding owners to this list will prevent security alerts when using unpinned tags for Actions published by that owner.

#### Example

To allow any Action from the publisher `octodemo`, such as `octodemo/3rd-party-action`, follow these steps:

1. Create a data extension file `/models/trusted-owner.model.yml` with the following content:

```yaml
extensions:
- addsTo:
pack: codeql/actions-all
extensible: trustedActionsOwnerDataModel
data:
- ["octodemo"]
```
2. Create a model pack file `/codeql-pack.yml` with the following content:

```yaml
name: my-org/actions-extensions-model-pack
version: 0.0.0
library: true
extensionTargets:
codeql/actions-all: '*'
dataExtensions:
- models/**/*.yml
```

3. Ensure that the model pack is included in your CodeQL analysis.

By following these steps, you will add `octodemo` to the list of trusted Action publishers, and the query will no longer generate security alerts for unpinned tags from this publisher.

## Examples

### Incorrect Usage
Expand All @@ -25,3 +61,6 @@ Pinning an action to a full length commit SHA is currently the only way to use a
## References

- [Using third-party actions](https://docs.github.com/en/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)
- [Extending CodeQL coverage with CodeQL model packs in default setup](https://docs.github.com/en/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup#extending-codeql-coverage-with-codeql-model-packs-in-default-setup)
- [Creating and working with CodeQL packs](https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs#creating-a-codeql-model-pack)

0 comments on commit 6b3098d

Please sign in to comment.