Skip to content

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions checkov/github_actions/checks/job/RevisionHash.py
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[]')

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 the uses that can appear under runs. https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#runsstepsuses

Copy link
Author

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.

)

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 tests/github_actions/gha/.github/workflows/revision_hash.yaml
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
17 changes: 17 additions & 0 deletions tests/github_actions/test_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,23 @@ def test_runner_on_workflows_dispatch(self):
assert len(report.skipped_checks) == 0
assert len(report.parsing_errors) == 0

def test_runner_revision_hash(self):
# given
file_path = Path(__file__).parent / "gha/.github/workflows/revision_hash.yaml"
file_dir = [str(file_path)]
checks = ["CKV_GHA_8"]

# when
report = Runner().run(
files=file_dir, runner_filter=RunnerFilter(framework=["github_actions"], checks=checks)
)

# then
assert len(report.failed_checks) == 2
assert len(report.passed_checks) == 2
assert len(report.skipped_checks) == 2
assert len(report.parsing_errors) == 0


if __name__ == "__main__":
unittest.main()