gitlab-compliance 2.1.1__tar.gz → 2.3.0__tar.gz

{gitlab_compliance-2.1.1 → gitlab_compliance-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlab-compliance
-Version: 2.1.1
+Version: 2.3.0
 Summary: BDD compliance testing for GitLab CI/CD pipelines and project settings — by MaturityBuilder
 License-Expression: Apache-2.0
 License-File: LICENSE

{gitlab_compliance-2.1.1 → gitlab_compliance-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitlab-compliance"
-version = "2.1.1"
+version = "2.3.0"
 dynamic = [ "readme" ]
 license = "Apache-2.0"
 requires-python = ">=3.12"
@@ -62,7 +62,7 @@ gitlab-compliance = 'src.gitlab_compliance:gitlab_compliance'
 [tool.poetry.group.dev.dependencies]
 setuptools = "83.0.0"
 pytest = "^9.0.3"
-pre-commit = "^4.2.0"
+pre-commit = "^4.6.1"
 pyyaml = "^6.0.3"
 coverage = "^7.9.2"
 

{gitlab_compliance-2.1.1 → gitlab_compliance-2.3.0}/src/compliance/behave_support/environment.py

@@ -6,6 +6,15 @@ from src.compliance.model import load_pipeline_entities
 from src.compliance.release_cache import ReleaseMetadataCache
 
 
+def _resolve_external_flag(value: str | None) -> bool | None:
+    normalized = str(value or "auto").strip().lower()
+    if normalized in {"true", "yes", "on", "1"}:
+        return True
+    if normalized in {"false", "no", "off", "0"}:
+        return False
+    return None
+
+
 def before_all(context):
     context.compliance_entities = {}
     context.stash = []
@@ -42,6 +51,9 @@ def before_scenario(context, scenario):
             == "true",
             load_api_entities=context.config.userdata.get("load_api_entities", "true")
             == "true",
+            resolve_external_includes=_resolve_external_flag(
+                context.config.userdata.get("resolve_external_includes", "auto")
+            ),
             cache=getattr(context, "release_cache", None),
         )
 

gitlab_compliance-2.3.0/src/compliance/behave_support/steps/script_steps.py

@@ -0,0 +1,494 @@
+"""Behave steps for GitLab CI embedded shell script policies."""
+
+from __future__ import annotations
+
+from behave import given, then, when
+
+from src.compliance.behave_support.environment import _skip_remaining_steps
+from src.compliance.script_analysis import (
+    format_script_violation,
+    job_has_effective_script,
+    job_has_script_field,
+    script_bashisms_without_bash_shebang,
+    script_curl_missing_fail,
+    script_defines_functions,
+    script_downloads_without_checksum,
+    script_enables_strict_mode,
+    script_functions_mask_failures,
+    script_has_bashism_in_posix_test,
+    script_has_chmod_777,
+    script_has_dangerous_rm,
+    script_has_hardcoded_secrets,
+    script_has_nested_backticks,
+    script_has_pipefail,
+    script_has_pipeline,
+    script_has_remote_pipe_to_shell,
+    script_has_shebang,
+    script_has_unpinned_apk,
+    script_has_unpinned_apt,
+    script_has_unpinned_docker_image,
+    script_has_unpinned_go_install,
+    script_has_unpinned_npm,
+    script_has_unpinned_pip,
+    script_has_unpinned_yum,
+    script_has_unquoted_command_substitution,
+    script_has_unquoted_path_variables,
+    script_has_unquoted_test_variables,
+    script_has_unquoted_variables,
+    script_has_unresolved_references,
+    script_has_unsafe_array_expansion,
+    script_has_unverified_git_clone,
+    script_is_multiline,
+    script_masks_failures,
+    script_posix_shebang_with_bashisms,
+    script_shebang_is_valid,
+    script_uses_backticks,
+    script_uses_eval,
+    script_uses_insecure_temp_files,
+)
+from src.compliance.stash import filter_entities, name_starts_with
+
+
+def _set_stash(context, entities: list[dict]):
+    context.stash = list(entities)
+    context.step_mode = "given"
+    context.scenario_skipped = False
+
+
+def _set_stash_or_skip(context, entities: list[dict], *, skip_reason: str):
+    if not entities:
+        _skip_remaining_steps(context, skip_reason)
+        return
+    _set_stash(context, entities)
+
+
+def _apply_filter(context, entities: list[dict], reason: str):
+    if context.scenario_skipped:
+        return
+    context.step_mode = "when"
+    if not entities:
+        _skip_remaining_steps(context, reason)
+        return
+    context.stash = entities
+
+
+def _assert_none(context, predicate, message: str):
+    if context.scenario_skipped:
+        return
+    context.step_mode = "then"
+    if not context.stash:
+        raise AssertionError("No entities in stash to assert against.")
+    failures = [
+        format_script_violation(entity, message)
+        for entity in context.stash
+        if predicate(entity)
+    ]
+    if failures:
+        raise AssertionError("; ".join(failures))
+
+
+def _assert_all_true(context, predicate, message: str):
+    if context.scenario_skipped:
+        return
+    context.step_mode = "then"
+    if not context.stash:
+        raise AssertionError("No entities in stash to assert against.")
+    failures = [
+        format_script_violation(entity, message)
+        for entity in context.stash
+        if not predicate(entity)
+    ]
+    if failures:
+        raise AssertionError("; ".join(failures))
+
+
+@given("I have any job with effective script defined")
+def given_any_job_with_effective_script(context):
+    jobs = filter_entities(
+        context.compliance_entities.get("jobs", []),
+        job_has_effective_script,
+    )
+    _set_stash_or_skip(
+        context, jobs, skip_reason="No jobs with effective script found in pipeline"
+    )
+
+
+@given("I have any job with before_script defined")
+def given_any_job_with_before_script(context):
+    jobs = filter_entities(
+        context.compliance_entities.get("jobs", []),
+        lambda entity: job_has_script_field(entity, "before_script"),
+    )
+    _set_stash_or_skip(
+        context, jobs, skip_reason="No jobs with before_script found in pipeline"
+    )
+
+
+@given("I have any job with script defined")
+def given_any_job_with_script(context):
+    jobs = filter_entities(
+        context.compliance_entities.get("jobs", []),
+        lambda entity: job_has_script_field(entity, "script"),
+    )
+    _set_stash_or_skip(
+        context, jobs, skip_reason="No jobs with script found in pipeline"
+    )
+
+
+@when("a variable is expanded within a command")
+def when_variable_expanded(context):
+    filtered = filter_entities(context.stash, script_has_unquoted_variables)
+    # Keep jobs that have expansions to validate; if none, keep stash for positive pass.
+    if filtered:
+        _apply_filter(context, filtered, "No jobs with variable expansions")
+    else:
+        context.step_mode = "when"
+
+
+@when("variables are used as part of a path")
+def when_variables_in_path(context):
+    filtered = filter_entities(context.stash, script_has_unquoted_path_variables)
+    if filtered:
+        _apply_filter(context, filtered, "No jobs with path variable usage")
+    else:
+        context.step_mode = "when"
+
+
+@when("command substitution is used")
+def when_command_substitution(context):
+    filtered = filter_entities(
+        context.stash,
+        lambda e: script_has_unquoted_command_substitution(e)
+        or "$(" in str(e.get("values", {}).get("effective_script", "")),
+    )
+    if not filtered:
+        filtered = filter_entities(
+            context.stash,
+            lambda e: "$("
+            in "\n".join(
+                map(str, e.get("values", {}).get("effective_script", []) or [])
+            )
+            or "`"
+            in "\n".join(
+                map(str, e.get("values", {}).get("effective_script", []) or [])
+            ),
+        )
+    if filtered:
+        _apply_filter(context, filtered, "No jobs with command substitution")
+    else:
+        context.step_mode = "when"
+
+
+@when("an array is expanded")
+def when_array_expanded(context):
+    filtered = filter_entities(context.stash, script_has_unsafe_array_expansion)
+    if filtered:
+        _apply_filter(context, filtered, "No jobs with array expansions")
+    else:
+        context.step_mode = "when"
+
+
+@when("the effective script has more than 1 line")
+def when_multiline_script(context):
+    filtered = filter_entities(context.stash, script_is_multiline)
+    _apply_filter(context, filtered, "No multi-line effective scripts")
+
+
+@when("rm is used recursively")
+def when_rm_recursive(context):
+    filtered = filter_entities(context.stash, script_has_dangerous_rm)
+    if filtered:
+        _apply_filter(context, filtered, "No recursive rm usage")
+    else:
+        context.step_mode = "when"
+
+
+@when("a pipeline is used")
+def when_pipeline_used(context):
+    filtered = filter_entities(context.stash, script_has_pipeline)
+    _apply_filter(context, filtered, "No pipelines found in scripts")
+
+
+@when("temporary files are required")
+def when_temp_files_required(context):
+    filtered = filter_entities(context.stash, script_uses_insecure_temp_files)
+    if filtered:
+        _apply_filter(context, filtered, "No temporary file usage detected")
+    else:
+        context.step_mode = "when"
+
+
+@when('its name starts with "{prefix}"')
+def when_name_starts_with_prefix(context, prefix):
+    filtered = filter_entities(context.stash, lambda e: name_starts_with(e, prefix))
+    _apply_filter(context, filtered, f"No entity names start with '{prefix}'")
+
+
+@then("the variable must be wrapped in double quotes")
+def then_variables_quoted(context):
+    _assert_none(
+        context,
+        script_has_unquoted_variables,
+        "Unquoted variable expansions found",
+    )
+
+
+@then("all variables must be safely quoted")
+def then_path_variables_quoted(context):
+    _assert_none(
+        context,
+        script_has_unquoted_path_variables,
+        "Unquoted variables used in file paths",
+    )
+
+
+@then("the result must be quoted unless word splitting is intended")
+def then_cmd_sub_quoted(context):
+    _assert_none(
+        context,
+        script_has_unquoted_command_substitution,
+        "Unquoted command substitution found",
+    )
+
+
+@then('array "@" syntax must be used where appropriate')
+def then_array_at_syntax(context):
+    _assert_none(
+        context,
+        script_has_unsafe_array_expansion,
+        "Unsafe array expansion found",
+    )
+
+
+@then("the script must enable strict mode options")
+def then_strict_mode_table(context):
+    _assert_all_true(
+        context,
+        script_enables_strict_mode,
+        "Multi-line script missing set -e/-u/pipefail",
+    )
+
+
+@then("failure must be handled explicitly")
+def then_failure_handled(context):
+    # With strict mode, failures are handled; otherwise flag || true masking.
+    def ok(entity):
+        if script_enables_strict_mode(entity):
+            return True
+        return not script_masks_failures(entity)
+
+    _assert_all_true(context, ok, "Command failures are not handled explicitly")
+
+
+@then("functions must propagate failures")
+def then_functions_propagate(context):
+    filtered = filter_entities(context.stash, script_defines_functions)
+    if not filtered:
+        context.step_mode = "then"
+        return
+    context.stash = filtered
+    _assert_none(
+        context,
+        script_functions_mask_failures,
+        "Functions mask failures with || true",
+    )
+
+
+@then("file paths must be quoted")
+def then_file_paths_quoted(context):
+    _assert_none(
+        context,
+        script_has_unquoted_path_variables,
+        "Unquoted file paths found",
+    )
+
+
+@then("mktemp must be used for temporary files")
+def then_mktemp_used(context):
+    _assert_none(
+        context,
+        script_uses_insecure_temp_files,
+        "Insecure temporary file creation without mktemp",
+    )
+
+
+@then("path validation must be performed for recursive rm")
+def then_rm_protected(context):
+    _assert_none(
+        context,
+        script_has_dangerous_rm,
+        "Dangerous recursive rm without path validation",
+    )
+
+
+@then("command substitution must use dollar parentheses")
+def then_no_backticks(context):
+    _assert_none(context, script_uses_backticks, "Legacy backtick substitution found")
+
+
+@then("nested command substitution must use dollar parentheses")
+def then_nested_dollar(context):
+    _assert_none(
+        context,
+        script_has_nested_backticks,
+        "Nested backtick substitution found",
+    )
+
+
+@then("POSIX compliant operators must be used")
+def then_posix_operators(context):
+    _assert_none(
+        context,
+        script_has_bashism_in_posix_test,
+        "Non-portable operators in [ tests",
+    )
+
+
+@then("variables in test expressions must be quoted")
+def then_test_vars_quoted(context):
+    _assert_none(
+        context,
+        script_has_unquoted_test_variables,
+        "Unquoted variables in test expressions",
+    )
+
+
+@then("pipefail must be enabled")
+def then_pipefail(context):
+    _assert_all_true(
+        context,
+        lambda e: (not script_has_pipeline(e)) or script_has_pipefail(e),
+        "Pipeline used without pipefail",
+    )
+
+
+@then("eval must not be used")
+def then_no_eval(context):
+    _assert_none(context, script_uses_eval, "eval is used in script")
+
+
+@then("untrusted remote scripts must not be executed")
+def then_no_remote_pipe(context):
+    _assert_none(
+        context,
+        script_has_remote_pipe_to_shell,
+        "Remote pipe to shell (curl|sh) detected",
+    )
+
+
+@then("user supplied variables must be quoted or validated")
+def then_user_input_safe(context):
+    _assert_none(
+        context,
+        script_has_unquoted_variables,
+        "User/CI variables used without quoting",
+    )
+
+
+@then("hardcoded secrets must not be present")
+def then_no_secrets(context):
+    _assert_none(
+        context,
+        script_has_hardcoded_secrets,
+        "Hardcoded secret pattern detected",
+    )
+
+
+@then("script downloads must verify checksums")
+def then_downloads_checksum(context):
+    _assert_none(
+        context,
+        script_downloads_without_checksum,
+        "Download without nearby checksum verification",
+    )
+
+
+@then('package installs of type "{manager}" must use pinned versions')
+def then_packages_pinned(context, manager):
+    predicates = {
+        "apk": script_has_unpinned_apk,
+        "pip": script_has_unpinned_pip,
+        "apt": script_has_unpinned_apt,
+        "yum": script_has_unpinned_yum,
+        "npm": script_has_unpinned_npm,
+        "go": script_has_unpinned_go_install,
+    }
+    predicate = predicates.get(manager)
+    if predicate is None:
+        raise AssertionError(f"Unknown package manager '{manager}'")
+    _assert_none(context, predicate, f"Unpinned {manager} package install")
+
+
+@then("docker commands must pin container images to a tag or sha256 digest")
+def then_docker_images_pinned(context):
+    _assert_none(
+        context,
+        script_has_unpinned_docker_image,
+        "Docker command references an unpinned container image",
+    )
+
+
+@then("git clone must verify commit or tag")
+def then_git_clone_verified(context):
+    _assert_none(
+        context,
+        script_has_unverified_git_clone,
+        "git clone without commit/tag verification",
+    )
+
+
+@then("curl must use fail flag")
+def then_curl_fail(context):
+    _assert_none(context, script_curl_missing_fail, "curl without --fail/-f")
+
+
+@then("deprecated CI_BUILD variables must not be used")
+def then_no_ci_build(context):
+    from src.compliance.script_analysis import script_uses_deprecated_ci_build_vars
+
+    _assert_none(
+        context,
+        script_uses_deprecated_ci_build_vars,
+        "Deprecated $CI_BUILD_* variable used",
+    )
+
+
+@then("unresolved script references must not be present")
+def then_no_unresolved_refs(context):
+    _assert_none(
+        context,
+        script_has_unresolved_references,
+        "Unresolved !reference in script blocks",
+    )
+
+
+@then("shebang must be valid when present")
+def then_shebang_valid(context):
+    _assert_all_true(
+        context,
+        lambda e: (not script_has_shebang(e)) or script_shebang_is_valid(e),
+        "Invalid shebang in script block",
+    )
+
+
+@then("bash specific features must declare bash")
+def then_bash_declared(context):
+    _assert_none(
+        context,
+        script_bashisms_without_bash_shebang,
+        "Bash-specific syntax without bash shebang",
+    )
+
+
+@then("POSIX shebang scripts must not use bashisms")
+def then_posix_no_bashisms(context):
+    _assert_none(
+        context,
+        script_posix_shebang_with_bashisms,
+        "Bashisms used with sh shebang",
+    )
+
+
+@then("chmod 777 must not be used")
+def then_no_chmod_777(context):
+    _assert_none(context, script_has_chmod_777, "chmod 777 is used")

gitlab_compliance-2.3.0/src/compliance/builtin_policies/__init__.py

@@ -0,0 +1,15 @@
+"""Bundled compliance policies shipped with gitlab-compliance."""
+
+from __future__ import annotations
+
+import os
+
+BUILTIN_POLICIES_DIR = os.path.join(os.path.dirname(__file__))
+BUILTIN_SHELL_POLICIES_DIR = os.path.join(BUILTIN_POLICIES_DIR, "shell")
+BUILTIN_SUPPLY_CHAIN_POLICIES_DIR = os.path.join(BUILTIN_POLICIES_DIR, "supply-chain")
+
+__all__ = [
+    "BUILTIN_POLICIES_DIR",
+    "BUILTIN_SHELL_POLICIES_DIR",
+    "BUILTIN_SUPPLY_CHAIN_POLICIES_DIR",
+]

gitlab_compliance-2.3.0/src/compliance/builtin_policies/shell/shell-ci-conventions.feature

@@ -0,0 +1,34 @@
+# METADATA
+# title: GitLab CI script conventions
+# description: CI-specific hygiene for curl and deprecated variables.
+# custom:
+#   id: GLCI-SHELL-CI
+#   severity: MEDIUM
+Feature: GitLab CI script conventions
+
+# METADATA
+# title: curl uses fail flag
+# custom:
+#   id: GLCI-SHELL-CI-001
+#   severity: MEDIUM
+  Scenario: curl must use fail flag
+    Given I have any job with effective script defined
+    Then curl must use fail flag
+
+# METADATA
+# title: Deprecated CI_BUILD variables are not used
+# custom:
+#   id: GLCI-SHELL-CI-002
+#   severity: MEDIUM
+  Scenario: Deprecated CI_BUILD variables must not be used
+    Given I have any job with effective script defined
+    Then deprecated CI_BUILD variables must not be used
+
+# METADATA
+# title: CI variables should be quoted
+# custom:
+#   id: GLCI-SHELL-CI-003
+#   severity: MEDIUM
+  Scenario: CI variables should be quoted
+    Given I have any job with effective script defined
+    Then user supplied variables must be quoted or validated

gitlab_compliance-2.3.0/src/compliance/builtin_policies/shell/shell-command-substitution.feature

@@ -0,0 +1,25 @@
+# METADATA
+# title: Command substitution standards
+# description: Prefer modern dollar-parentheses substitution over backticks.
+# custom:
+#   id: GLCI-SHELL-SUB
+#   severity: MEDIUM
+Feature: Command substitution
+
+# METADATA
+# title: Legacy backticks are not used
+# custom:
+#   id: GLCI-SHELL-SUB-001
+#   severity: MEDIUM
+  Scenario: Legacy backticks are not used
+    Given I have any job with effective script defined
+    Then command substitution must use dollar parentheses
+
+# METADATA
+# title: Nested command substitution is readable
+# custom:
+#   id: GLCI-SHELL-SUB-002
+#   severity: MEDIUM
+  Scenario: Nested command substitution is readable
+    Given I have any job with effective script defined
+    Then nested command substitution must use dollar parentheses

gitlab_compliance-2.3.0/src/compliance/builtin_policies/shell/shell-conditionals.feature

@@ -0,0 +1,25 @@
+# METADATA
+# title: Conditional expression standards
+# description: Portable and safely quoted test expressions.
+# custom:
+#   id: GLCI-SHELL-TEST
+#   severity: MEDIUM
+Feature: Conditional expressions
+
+# METADATA
+# title: Test operators are portable
+# custom:
+#   id: GLCI-SHELL-TEST-001
+#   severity: MEDIUM
+  Scenario: Test operators are portable
+    Given I have any job with effective script defined
+    Then POSIX compliant operators must be used
+
+# METADATA
+# title: Variables are quoted in test statements
+# custom:
+#   id: GLCI-SHELL-TEST-002
+#   severity: HIGH
+  Scenario: Variables are quoted in test statements
+    Given I have any job with effective script defined
+    Then variables in test expressions must be quoted

gitlab_compliance-2.3.0/src/compliance/builtin_policies/shell/shell-error-handling.feature

@@ -0,0 +1,35 @@
+# METADATA
+# title: Error handling
+# description: Strict mode and exit-code handling for GitLab CI job scripts.
+# custom:
+#   id: GLCI-SHELL-ERR
+#   severity: HIGH
+Feature: Error handling
+
+# METADATA
+# title: Scripts use strict mode
+# custom:
+#   id: GLCI-SHELL-ERR-001
+#   severity: MEDIUM
+  Scenario: Multi-line scripts use strict mode
+    Given I have any job with effective script defined
+    When the effective script has more than 1 line
+    Then the script must enable strict mode options
+
+# METADATA
+# title: Commands return meaningful exit codes
+# custom:
+#   id: GLCI-SHELL-ERR-002
+#   severity: MEDIUM
+  Scenario: Commands return meaningful exit codes
+    Given I have any job with effective script defined
+    Then failure must be handled explicitly
+
+# METADATA
+# title: Functions propagate failures
+# custom:
+#   id: GLCI-SHELL-ERR-003
+#   severity: MEDIUM
+  Scenario: Functions propagate failures
+    Given I have any job with effective script defined
+    Then functions must propagate failures