Skip to content
Open
Show file tree
Hide file tree
Changes from 9 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"id": "ecbbe763-95dc-47e6-8660-84ff751e5acf",
"queryName": "Beta - SQL DB Instance With Unrecommended Logging Threshold",
"severity": "LOW",
"category": "Observability",
"descriptionText": "All 'google_sql_database_instance' resources based on POSTGRES should have the 'log_min_messages' flag set to 'WARNING' or a higher severity to prevent excessively logging",
"descriptionUrl": "https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/sql_database_instance.html#settings-1",
"platform": "Terraform",
"descriptionID": "ecbbe763",
"cloudProvider": "gcp",
"cwe": "779",
"riskScore": "1.0",
"experimental": "true"
}
Original file line number Diff line number Diff line change
@@ -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, "POSTGRES")
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 'log_min_messages' to 'WARNING' or a higher severity", [name]),
"keyActualValue" : sprintf("'google_sql_database_instance[%s].settings.database_flags' sets 'log_min_messages' to '%s'", [name, results.value]),
"searchLine": results.searchLine
}
}

get_results(resource, name) = results { # array
resource.settings.database_flags[x].name == "log_min_messages"
not common_lib.inArray(["WARNING", "ERROR", "LOG", "FATAL", "PANIC"], resource.settings.database_flags[x].value)

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 == "log_min_messages"
not common_lib.inArray(["WARNING", "ERROR", "LOG", "FATAL", "PANIC"], resource.settings.database_flags.value)

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
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
resource "google_sql_database_instance" "negative_1" {
name = "main-instance"
database_version = "MYSQL_8_0" # Is not a POSTGRES instance
region = "us-central1"

settings {
tier = "db-f1-micro"

database_flags = [
{ name = "log_min_messages", value = "DEBUG3" }
]
}
}

resource "google_sql_database_instance" "negative_2" {
name = "mysql-instance-without-flag"
database_version = "POSTGRES_17"
region = "us-central1"

# Defaults to "ERROR"
}

resource "google_sql_database_instance" "negative_3" {
name = "postgres-instance-without-flag"
database_version = "POSTGRES_16"
region = "us-central1"

settings {} # Defaults to "ERROR"
}

resource "google_sql_database_instance" "negative_4" {
name = "postgres-instance-without-flag"
database_version = "POSTGRES_15"
region = "us-central1"

settings {
database_flags = [
# Defaults to "ERROR"
]
}
}

resource "google_sql_database_instance" "negative_5" {
name = "mysql-instance-with-flag"
database_version = "POSTGRES_15"
region = "us-central1"

settings {
tier = "db-f1-micro"

database_flags = [
{ name = "log_min_messages", value = "WARNING" }, # Has flag set to "WARNING" (minimum)
{ name = "log_min_messages", value = "ERROR" }, # Has flag set to "ERROR"
{ name = "log_min_messages", value = "LOG" }, # Has flag set to "LOG"
{ name = "log_min_messages", value = "FATAL" }, # Has flag set to "FATAL"
{ name = "log_min_messages", value = "PANIC" }, # Has flag set to "PANIC"
]
}
}

resource "google_sql_database_instance" "negative_6" { # Single object support test 1
name = "mysql-instance-with-flag"
database_version = "POSTGRES_15"
region = "us-central1"

settings {
tier = "db-f1-micro"

database_flags {
name = "log_min_messages"
value = "WARNING"
} # Has flag set to "WARNING" (minimum)
}
}

resource "google_sql_database_instance" "negative_7" { # Single object support test 2
name = "mysql-instance-with-flag"
database_version = "POSTGRES_15"
region = "us-central1"

settings {
tier = "db-f1-micro"

database_flags {
name = "log_min_messages"
value = "PANIC"
} # Has flag set to "PANIC"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
resource "google_sql_database_instance" "positive_1" {
name = "postgres-instance-with-flag"
database_version = "POSTGRES_14"
region = "us-central1"

settings {
database_flags = [
{ name = "sample_flag1", value = "off" },
{ name = "log_min_messages", value = "NOTICE" }, # Flag is set to "NOTICE"
{ name = "sample_flag2", value = "off" }
]
}
}

resource "google_sql_database_instance" "positive_2" {
name = "postgres-instance-with-flag"
database_version = "POSTGRES_13"
region = "us-central1"

settings {
database_flags = [
{ name = "log_min_messages", value = "DEBUG5" }, # Flag is set to "DEBUG5"
]
}
}

resource "google_sql_database_instance" "positive_3" { # Single object support test
name = "postgres-instance-with-flag"
database_version = "POSTGRES_13"
region = "us-central1"

settings {
database_flags {
name = "log_min_messages"
value = "INFO"
} # Flag is set to "INFO"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[
{
"queryName": "Beta - SQL DB Instance With Unrecommended Logging Threshold",
"severity": "LOW",
"line": 9
},
{
"queryName": "Beta - SQL DB Instance With Unrecommended Logging Threshold",
"severity": "LOW",
"line": 22
},
{
"queryName": "Beta - SQL DB Instance With Unrecommended Logging Threshold",
"severity": "LOW",
"line": 34
}
]
Loading