Skip to content
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

feat(terraform): drop and deletion checks for spanner #5625

Merged
merged 3 commits into from
Nov 2, 2023
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
from checkov.terraform.checks.resource.base_resource_value_check import BaseResourceValueCheck
from checkov.common.models.enums import CheckCategories, CheckResult


class SpannerDatabaseDeletionProtection(BaseResourceValueCheck):
def __init__(self) -> None:
name = "Ensure Spanner Database has deletion protection enabled"
id = "CKV_GCP_119"
supported_resources = ['google_spanner_database']
categories = [CheckCategories.GENERAL_SECURITY]
super().__init__(name=name, id=id, categories=categories, supported_resources=supported_resources,
missing_block_result=CheckResult.PASSED)

def get_inspected_key(self) -> str:
return 'deletion_protection'

def get_expected_value(self) -> bool:
return True


check = SpannerDatabaseDeletionProtection()
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
from checkov.terraform.checks.resource.base_resource_value_check import BaseResourceValueCheck
from checkov.common.models.enums import CheckCategories, CheckResult


class SpannerDatabaseDropProtection(BaseResourceValueCheck):
def __init__(self) -> None:
name = "Ensure Spanner Database has drop protection enabled"
id = "CKV_GCP_120"
supported_resources = ["google_spanner_database"]
categories = [CheckCategories.GENERAL_SECURITY]
super().__init__(name=name, id=id, categories=categories, supported_resources=supported_resources,
missing_block_result=CheckResult.FAILED)

def get_inspected_key(self) -> str:
return "enable_drop_protection"

def get_expected_value(self) -> bool:
return True


check = SpannerDatabaseDropProtection()
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
resource "google_spanner_database" "fail" {
instance = google_spanner_instance.example.name
name = "my-database"
ddl = [
"CREATE TABLE t1 (t1 INT64 NOT NULL,) PRIMARY KEY(t1)",
"CREATE TABLE t2 (t2 INT64 NOT NULL,) PRIMARY KEY(t2)",
]
deletion_protection = false
# encryption_config {
# kms_key_name=
# }
}

resource "google_spanner_database" "pass" {
instance = google_spanner_instance.example.name
name = "my-database"
ddl = [
"CREATE TABLE t1 (t1 INT64 NOT NULL,) PRIMARY KEY(t1)",
"CREATE TABLE t2 (t2 INT64 NOT NULL,) PRIMARY KEY(t2)",
]
deletion_protection = true
encryption_config {
kms_key_name= google_kms_crypto_key.example.name
}
}

resource "google_spanner_database" "pass2" {
instance = google_spanner_instance.example.name
name = "my-database"
ddl = [
"CREATE TABLE t1 (t1 INT64 NOT NULL,) PRIMARY KEY(t1)",
"CREATE TABLE t2 (t2 INT64 NOT NULL,) PRIMARY KEY(t2)",
]

encryption_config {
kms_key_name= google_kms_crypto_key.example.name
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
resource "google_spanner_database" "fail" {
instance = google_spanner_instance.example.name
name = "my-database"
ddl = [
"CREATE TABLE t1 (t1 INT64 NOT NULL,) PRIMARY KEY(t1)",
"CREATE TABLE t2 (t2 INT64 NOT NULL,) PRIMARY KEY(t2)",
]
deletion_protection = false
enable_drop_protection=false
# encryption_config {
# kms_key_name=
# }
}

resource "google_spanner_database" "fail2" {
instance = google_spanner_instance.example.name
name = "my-database"
ddl = [
"CREATE TABLE t1 (t1 INT64 NOT NULL,) PRIMARY KEY(t1)",
"CREATE TABLE t2 (t2 INT64 NOT NULL,) PRIMARY KEY(t2)",
]
deletion_protection = false
# encryption_config {
# kms_key_name=
# }
}

resource "google_spanner_database" "pass" {
instance = google_spanner_instance.example.name
name = "my-database"
ddl = [
"CREATE TABLE t1 (t1 INT64 NOT NULL,) PRIMARY KEY(t1)",
"CREATE TABLE t2 (t2 INT64 NOT NULL,) PRIMARY KEY(t2)",
]
deletion_protection = false
enable_drop_protection=true
encryption_config {
kms_key_name= google_kms_crypto_key.example.name
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import unittest
import os

from checkov.terraform.checks.resource.gcp.SpannerDatabaseDeletionProtection import check
from checkov.runner_filter import RunnerFilter
from checkov.terraform.runner import Runner


class TestSpannerDatabaseDeletionProtection(unittest.TestCase):

def test(self):
runner = Runner()
current_dir = os.path.dirname(os.path.realpath(__file__))

test_files_dir = current_dir + "/example_SpannerDatabaseDeletionProtection"
report = runner.run(root_folder=test_files_dir, runner_filter=RunnerFilter(checks=[check.id]))
summary = report.get_summary()

passing_resources = {
'google_spanner_database.pass',
'google_spanner_database.pass2',
}
failing_resources = {
'google_spanner_database.fail',
}

passed_check_resources = set([c.resource for c in report.passed_checks])
failed_check_resources = set([c.resource for c in report.failed_checks])

self.assertEqual(summary['passed'], len(passing_resources))
self.assertEqual(summary['failed'], len(failing_resources))
self.assertEqual(summary['skipped'], 0)
self.assertEqual(summary['parsing_errors'], 0)

self.assertEqual(passing_resources, passed_check_resources)
self.assertEqual(failing_resources, failed_check_resources)


if __name__ == '__main__':
unittest.main()
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import unittest
import os

from checkov.terraform.checks.resource.gcp.SpannerDatabaseDropProtection import check
from checkov.runner_filter import RunnerFilter
from checkov.terraform.runner import Runner


class TestSpannerDatabaseDropProtection(unittest.TestCase):

def test(self):
runner = Runner()
current_dir = os.path.dirname(os.path.realpath(__file__))

test_files_dir = current_dir + "/example_SpannerDatabaseDropProtection"
report = runner.run(root_folder=test_files_dir, runner_filter=RunnerFilter(checks=[check.id]))
summary = report.get_summary()

passing_resources = {
'google_spanner_database.pass',
}
failing_resources = {
'google_spanner_database.fail',
'google_spanner_database.fail2',
}

passed_check_resources = set([c.resource for c in report.passed_checks])
failed_check_resources = set([c.resource for c in report.failed_checks])

self.assertEqual(summary['passed'], len(passing_resources))
self.assertEqual(summary['failed'], len(failing_resources))
self.assertEqual(summary['skipped'], 0)
self.assertEqual(summary['parsing_errors'], 0)

self.assertEqual(passing_resources, passed_check_resources)
self.assertEqual(failing_resources, failed_check_resources)


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