Skip to content

Commit 26074bb

Browse files
committed
Make docs less verbose regarding codeql config + enhance changlog to highlight extensibility
1 parent b144c2f commit 26074bb

File tree

2 files changed

+1
-37
lines changed

2 files changed

+1
-37
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
category: feature
33
---
4-
* Trusted Action owner list can now be expanded using data extensions for `trustedActionsOwnerDataModel` on the query `actions/unpinned-tag`
4+
* The "Unpinned tag for a non-immutable Action in workflow" query (`actions/unpinned-tag`) now supports expanding the trusted action owner list using data extensions (`extensible: trustedActionsOwnerDataModel`). If you trust an Action publisher, you can include the owner name/organization in a data extension model pack to add it to the allow list for this query. This addition will prevent security alerts when using unpinned tags for Actions published by that owner.

actions/ql/src/Security/CWE-829/UnpinnedActionsTag.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,42 +8,6 @@ Using a tag for a 3rd party Action that is not pinned to a commit can lead to ex
88

99
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.
1010

11-
12-
### Configuration
13-
14-
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.
15-
16-
#### Example
17-
18-
To allow any Action from the publisher `octodemo`, such as `octodemo/3rd-party-action`, follow these steps:
19-
20-
1. Create a data extension file `/models/trusted-owner.model.yml` with the following content:
21-
22-
```yaml
23-
extensions:
24-
- addsTo:
25-
pack: codeql/actions-all
26-
extensible: trustedActionsOwnerDataModel
27-
data:
28-
- ["octodemo"]
29-
```
30-
31-
2. Create a model pack file `/codeql-pack.yml` with the following content:
32-
33-
```yaml
34-
name: my-org/actions-extensions-model-pack
35-
version: 0.0.0
36-
library: true
37-
extensionTargets:
38-
codeql/actions-all: '*'
39-
dataExtensions:
40-
- models/**/*.yml
41-
```
42-
43-
3. Ensure that the model pack is included in your CodeQL analysis.
44-
45-
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.
46-
4711
## Examples
4812

4913
### Incorrect Usage

0 commit comments

Comments
 (0)