Skip to content
Merged
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
13 changes: 5 additions & 8 deletions checkov/terraform/plan_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ def _get_providers(template: dict[str, dict[str, Any]]) -> list[dict[str, dict[s
# }
# },
# {
# "aws.west": {
# "aws": {
# "region": ["us-west-1"],
# "alias": ["west"],
# . . .
Expand All @@ -360,10 +360,11 @@ def _get_providers(template: dict[str, dict[str, Any]]) -> list[dict[str, dict[s
if _is_provider_key(key=provider_key):
# Not a provider, skip
continue
provider_name = provider_data.get("name")
provider_alias = provider_data.get("alias", "default")
provider_map: dict[str, dict[str, Any]] = {}
provider_map[provider_key] = {}
provider_map_entry = provider_map[provider_key]
provider_map[provider_name] = {}
provider_map_entry = provider_map[provider_name]
for field, value in provider_data.get('expressions', {}).items():
if field in LINE_FIELD_NAMES or not isinstance(value, dict):
continue # don't care about line #s or non dicts
Expand All @@ -377,11 +378,7 @@ def _get_providers(template: dict[str, dict[str, Any]]) -> list[dict[str, dict[s
provider_map_entry[start_line] = [provider_data.get(START_LINE, 1) - 1]
provider_map_entry[end_line] = [provider_data.get(END_LINE, 1)]
provider_map_entry['alias'] = [provider_alias]
# provider_key already contains the alias (ie "aws.east") for non-default providers
if provider_alias == "default":
provider_map_entry[TF_PLAN_RESOURCE_ADDRESS] = f"{provider_key}.{provider_alias}"
else:
provider_map_entry[TF_PLAN_RESOURCE_ADDRESS] = provider_key
provider_map_entry[TF_PLAN_RESOURCE_ADDRESS] = f"{provider_name}.{provider_alias}"
providers.append(provider_map)

return providers
Expand Down
6 changes: 3 additions & 3 deletions tests/terraform/parser/test_plan_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ def test_plan_multiple_providers(self):
tf_definition, _ = parse_tf_plan(valid_plan_path, {})
providers = tf_definition['provider']
self.assertEqual( len(providers), 3)
provider_keys = []
provider_names = []
provider_aliases = []
provider_addresses = []
for provider in providers:
key = next(iter(provider))
provider_keys.append(key)
provider_names.append(key)
provider_aliases.append( provider[key]['alias'][0] )
provider_addresses.append( provider[key]['__address__'] )

self.assertEqual(provider_keys, ["aws", "aws.ohio", "aws.oregon"])
self.assertEqual(provider_names, ["aws", "aws", "aws"])
self.assertEqual(provider_aliases, ["default", "ohio", "oregon"])
self.assertEqual(provider_addresses, ["aws.default", "aws.ohio", "aws.oregon"])

Expand Down
13 changes: 13 additions & 0 deletions tests/terraform/runner/resources/plan_with_providers/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
provider "aws" {
region = "us-east-1"
}

provider "aws" {
region = "us-east-2"
alias = "ohio"
access_key = "AKIAIOSFODNN7EXAMPLE"
}
provider "aws" {
region = "us-west-2"
alias = "oregon"
}
48 changes: 48 additions & 0 deletions tests/terraform/runner/resources/plan_with_providers/tfplan.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"format_version": "1.2",
"terraform_version": "1.11.4",
"planned_values": {
"root_module": {}
},
"configuration": {
"provider_config": {
"aws": {
"name": "aws",
"full_name": "registry.terraform.io/hashicorp/aws",
"expressions": {
"region": {
"constant_value": "us-east-1"
}
}
},
"aws.ohio": {
"name": "aws",
"full_name": "registry.terraform.io/hashicorp/aws",
"alias": "ohio",
"expressions": {
"access_key": {
"constant_value": "AKIAIOSFODNN7EXAMPLE"
},
"region": {
"constant_value": "us-east-2"
}
}
},
"aws.oregon": {
"name": "aws",
"full_name": "registry.terraform.io/hashicorp/aws",
"alias": "oregon",
"expressions": {
"region": {
"constant_value": "us-west-2"
}
}
}
},
"root_module": {}
},
"timestamp": "2025-05-05T16:11:28Z",
"applyable": false,
"complete": true,
"errored": false
}
24 changes: 24 additions & 0 deletions tests/terraform/runner/test_plan_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -933,6 +933,30 @@ def test_plan_change_keys(self):
self.assertEqual(passing_resources, passed_check_resources)
self.assertEqual(failing_resources, failed_check_resources)

def test_plan_with_providers(self):
"""
Ensure AWS providers are parsed correctly and the credentials check runs against
providers with aliases, too.
"""
current_dir = os.path.dirname(os.path.realpath(__file__))
valid_plan_path = current_dir + "/resources/plan_with_providers/tfplan.json"
runner = Runner(db_connector=self.db_connector())
checks_allowlist = ["CKV_AWS_41"]
report = runner.run(
root_folder=None,
files=[valid_plan_path],
external_checks_dir=None,
runner_filter=RunnerFilter(framework=["terraform_plan"], checks=checks_allowlist),
)
report_json = report.get_json()
self.assertIsInstance(report_json, str)
self.assertIsNotNone(report_json)

for record in report.failed_checks:
self.assertIn(record.check_id, checks_allowlist)
self.assertEqual(report.get_summary()["failed"], 1)
self.assertEqual(report.get_summary()["passed"], 2)

def tearDown(self) -> None:
resource_registry.checks = deepcopy(self.orig_checks)
BaseCheckRegistry._BaseCheckRegistry__all_registered_checks = deepcopy(self.orig_all_registered_checks)
Expand Down
Loading