diff --git a/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/metadata.json b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/metadata.json new file mode 100644 index 00000000000..c589353b683 --- /dev/null +++ b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/metadata.json @@ -0,0 +1,14 @@ +{ + "id": "c3655703-569b-42ec-8027-ef8835d989c0", + "queryName": "Beta - SQL DB Instance With Contained Database Authentication", + "severity": "HIGH", + "category": "Insecure Configurations", + "descriptionText": "In a 'google_sql_database_instance' resource based on SQLSERVER, the 'contained database authentication' flag should be set to 'off'", + "descriptionUrl": "https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/sql_database_instance.html#settings-1", + "platform": "Terraform", + "descriptionID": "c3655703", + "cloudProvider": "gcp", + "cwe": "286", + "riskScore": "6.0", + "experimental": "true" +} diff --git a/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/query.rego b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/query.rego new file mode 100644 index 00000000000..aeda4ab00db --- /dev/null +++ b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/query.rego @@ -0,0 +1,42 @@ +package Cx + +import data.generic.common as common_lib +import data.generic.terraform as tf_lib + +CxPolicy[result] { + resource := input.document[i].resource.google_sql_database_instance[name] + + contains(resource.database_version, "SQLSERVER") + results := get_results(resource, name) + + result := { + "documentId": input.document[i].id, + "resourceType": "google_sql_database_instance", + "resourceName": tf_lib.get_resource_name(resource, name), + "searchKey": results.searchKey, + "issueType": "IncorrectValue", + "keyExpectedValue": sprintf("'google_sql_database_instance[%s].settings.database_flags' should set 'contained database authentication' to 'off'", [name]), + "keyActualValue": sprintf("'google_sql_database_instance[%s].settings.database_flags' sets 'contained database authentication' to '%s'", [name, results.value]), + "searchLine": results.searchLine + } +} + +get_results(resource, name) = results { # array + resource.settings.database_flags[x].name == "contained database authentication" + resource.settings.database_flags[x].value != "off" + + results := { + "searchKey": sprintf("google_sql_database_instance[%s].settings.database_flags[%d].name", [name, x]), + "searchLine": common_lib.build_search_line(["resource", "google_sql_database_instance", name, "settings", "database_flags", x, "name"], []), + "value": resource.settings.database_flags[x].value + } +} else = results { # single object + resource.settings.database_flags.name == "contained database authentication" + resource.settings.database_flags.value != "off" + + results := { + "searchKey": sprintf("google_sql_database_instance[%s].settings.database_flags.name", [name]), + "searchLine": common_lib.build_search_line(["resource", "google_sql_database_instance", name, "settings", "database_flags", "name"], []), + "value": resource.settings.database_flags.value + } +} diff --git a/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/negative.tf b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/negative.tf new file mode 100644 index 00000000000..e9dc1b4ae84 --- /dev/null +++ b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/negative.tf @@ -0,0 +1,84 @@ +resource "google_sql_database_instance" "negative_1" { + name = "main-instance" + database_version = "MYSQL_8_0" # Is not a SQLSERVER instance + region = "us-central1" + + settings { + tier = "db-f1-micro" + + database_flags { + name = "contained database authentication" + value = "on" + } + } +} + +resource "google_sql_database_instance" "negative_2" { + name = "sqlserver-instance-without-flag" + database_version = "SQLSERVER_2017_STANDARD" + region = "us-central1" + + # Defaults to "off" +} + +resource "google_sql_database_instance" "negative_3" { + name = "sqlserver-instance-without-flag" + database_version = "SQLSERVER_2017_STANDARD" + region = "us-central1" + + settings {} # Defaults to "off" +} + +resource "google_sql_database_instance" "negative_4" { + name = "sqlserver-instance-without-flag" + database_version = "SQLSERVER_2017_STANDARD" + region = "us-central1" + + settings { + database_flags { + name = "sample_flag" + value = "off" + } + # Defaults to "off" + } +} + +resource "google_sql_database_instance" "negative_5" { + name = "sqlserver-instance-with-flag" + database_version = "SQLSERVER_2019_STANDARD" + region = "us-central1" + + settings { + tier = "db-f1-micro" + + database_flags { + name = "sample_flag1" + value = "off" + } + + database_flags { # Has flag set to "off" - array + name = "contained database authentication" + value = "off" + } + + database_flags { + name = "sample_flag2" + value = "off" + } + } +} + +resource "google_sql_database_instance" "negative_6" { # Single object support test + name = "sqlserver-instance-with-flag" + database_version = "SQLSERVER_2019_STANDARD" + region = "us-central1" + + settings { + tier = "db-f1-micro" + + database_flags { + name = "contained database authentication" + value = "off" + } + } +} diff --git a/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/positive.tf b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/positive.tf new file mode 100644 index 00000000000..60aa9a36257 --- /dev/null +++ b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/positive.tf @@ -0,0 +1,35 @@ +resource "google_sql_database_instance" "positive_1" { + name = "sqlserver-instance-with-flag" + database_version = "SQLSERVER_2017_EXPRESS" + region = "us-central1" + + settings { + database_flags { + name = "sample_flag1" + value = "off" + } + + database_flags { # Flag is not set to "off" + name = "contained database authentication" + value = "on" + } + + database_flags { + name = "sample_flag2" + value = "off" + } + } +} + +resource "google_sql_database_instance" "positive_2" { # Single object support test + name = "sqlserver-instance-with-flag" + database_version = "SQLSERVER_2017_EXPRESS" + region = "us-central1" + + settings { + database_flags { + name = "contained database authentication" + value = "on" + } # Flag is not set to "off" + } +} diff --git a/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/positive_expected_result.json b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/positive_expected_result.json new file mode 100644 index 00000000000..420abab1a70 --- /dev/null +++ b/assets/queries/terraform/gcp/sql_db_instance_with_contained_database_authentication/test/positive_expected_result.json @@ -0,0 +1,12 @@ +[ + { + "queryName": "Beta - SQL DB Instance With Contained Database Authentication", + "severity": "HIGH", + "line": 13 + }, + { + "queryName": "Beta - SQL DB Instance With Contained Database Authentication", + "severity": "HIGH", + "line": 31 + } +] diff --git a/assets/similarityID_transition/terraform_gcp.yaml b/assets/similarityID_transition/terraform_gcp.yaml index 31723432d4b..c339ad9a2e2 100644 --- a/assets/similarityID_transition/terraform_gcp.yaml +++ b/assets/similarityID_transition/terraform_gcp.yaml @@ -3,6 +3,10 @@ similarityIDChangeList: queryName: Beta - Google DNS Policy Logging Disabled observations: "" change: 2 + - queryId: c3655703-569b-42ec-8027-ef8835d989c0 + queryName: Beta - SQL DB Instance With Contained Database Authentication + observations: "" + change: 2 - queryId: f5aff735-fd1c-4751-a5e9-98bfe4893fa2 queryName: Beta - SQL DB Instance With Exposed Trace Logs observations: ""