-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(gha): ensure action sources use commit hash #7058
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bt-macole
wants to merge
1
commit into
bridgecrewio:main
Choose a base branch
from
bt-macole:featgha_rev_check
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
from __future__ import annotations | ||
|
||
import re | ||
from typing import Any | ||
|
||
from checkov.common.models.enums import CheckResult | ||
from checkov.github_actions.checks.base_github_action_check import BaseGithubActionsCheck | ||
from checkov.yaml_doc.enums import BlockType | ||
|
||
# Matches @ followed by a 40-character SHA-1 commit hash with optional trailing comment | ||
COMMIT_ID_PATTERN = re.compile(r"@[0-9a-f]{40}\s*(#.*)?$") | ||
|
||
|
||
class RevisionHash(BaseGithubActionsCheck): | ||
def __init__(self) -> None: | ||
name = "Ensure GitHub Action sources use a commit hash" | ||
id = "CKV_GHA_8" | ||
super().__init__( | ||
name=name, | ||
id=id, | ||
block_type=BlockType.ARRAY, | ||
supported_entities=('jobs', 'jobs.*.steps[]') | ||
) | ||
|
||
def scan_conf(self, conf: dict[str, Any]) -> tuple[CheckResult, dict[str, Any] | None]: | ||
if not isinstance(conf, dict): | ||
return CheckResult.UNKNOWN, conf | ||
uses = conf.get("uses", None) | ||
|
||
if uses is None or re.search(COMMIT_ID_PATTERN, uses): | ||
return CheckResult.PASSED, conf | ||
|
||
return CheckResult.FAILED, conf | ||
|
||
|
||
check = RevisionHash() |
32 changes: 32 additions & 0 deletions
32
tests/github_actions/gha/.github/workflows/revision_hash.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Checkov | ||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
permissions: {} | ||
|
||
jobs: | ||
checkov-job: | ||
runs-on: ubuntu-latest | ||
name: checkov-action | ||
steps: | ||
- name: Checkout with master version of action | ||
uses: actions/checkout@master | ||
|
||
- name: Checkout with tagged version | ||
uses: actions/checkout@v3 | ||
|
||
- name: Checkout with hash | ||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 | ||
|
||
- name: Checkout with hash and comment on the same line | ||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
||
- name: Run Checkov action | ||
id: checkov | ||
# checkov:skip=CKV_GHA_8:Trust our own stuff? | ||
uses: bridgecrewio/checkov-action@master | ||
with: | ||
directory: terraform/ | ||
framework: terraform |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You may also want to add
'runs.steps[]'
to your supported_entities to capture theuses
that can appear underruns
. https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#runsstepsusesThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thats a good find. however, runs.steps[] is not a currently supported resource type for github actions. seems like it should definitely be added though.