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(bom): add gcp bill of materials for dataflow job in terraform #6037

Merged
merged 1 commit into from
Dec 7, 2022
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
12 changes: 12 additions & 0 deletions assets/queries/terraform/gcp_bom/dataflow/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"id": "895ed0d9-6fec-4567-8614-d7a74b599a53",
"queryName": "BOM - GCP Dataflow",
"severity": "TRACE",
"category": "Bill Of Materials",
"descriptionText": "A list of Dataflow resources found. Unified stream and batch data processing that's serverless, fast, and cost-effective.",
"descriptionUrl": "https://kics.io",
"platform": "Terraform",
"descriptionID": "5d614ad5",
"cloudProvider": "gcp"
}

41 changes: 41 additions & 0 deletions assets/queries/terraform/gcp_bom/dataflow/query.rego
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package Cx

import data.generic.common as common_lib
import data.generic.terraform as tf_lib

CxPolicy[result] {
dataflow_job := input.document[i].resource.google_dataflow_job[name]

bom_output = {
"resource_type": "google_dataflow_job",
"resource_name": tf_lib.get_resource_name(dataflow_job, name),
"resource_accessibility": check_accessability(dataflow_job),
"resource_encryption": check_encrytion(dataflow_job),
"resource_vendor": "GCP",
"resource_category": "Streaming",
}

result := {
"documentId": input.document[i].id,
"searchKey": sprintf("google_dataflow_job[%s]", [name]),
"issueType": "BillOfMaterials",
"keyExpectedValue": "",
"keyActualValue": "",
"searchLine": common_lib.build_search_line(["resource", "google_dataflow_job", name], []),
"value": json.marshal(bom_output),
}
}

check_encrytion(resource) = enc_status {
common_lib.valid_key(resource, "kms_key_name")
enc_status := "encrypted"
} else = enc_status {
enc_status := "unencrypted"
}

check_accessability(resource) = acc_status {
resource.ip_configuration == "WORKER_IP_PUBLIC"
acc_status := "public"
} else = acc_status {
acc_status := "unknown"
}
22 changes: 22 additions & 0 deletions assets/queries/terraform/gcp_bom/dataflow/test/negative.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# negative sample
resource "google_bigquery_dataset" "negative1" {
dataset_id = "example_dataset"
friendly_name = "test"
description = "This is a test description"
location = "EU"
default_table_expiration_ms = 3600000

labels = {
env = "default"
}

access {
role = "OWNER"
user_by_email = google_service_account.bqowner.email
}

access {
role = "READER"
domain = "hashicorp.com"
}
}
33 changes: 33 additions & 0 deletions assets/queries/terraform/gcp_bom/dataflow/test/positive.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
resource "google_dataflow_job" "pubsub_stream" {
name = "tf-test-dataflow-job1"
template_gcs_path = "gs://my-bucket/templates/template_file"
temp_gcs_location = "gs://my-bucket/tmp_dir"
enable_streaming_engine = true
parameters = {
inputFilePattern = "${google_storage_bucket.bucket1.url}/*.json"
outputTopic = google_pubsub_topic.topic.id
}
transform_name_mapping = {
name = "test_job"
env = "test"
}
on_delete = "cancel"
}

resource "google_dataflow_job" "pubsub_stream2" {
name = "tf-test-dataflow-job1"
template_gcs_path = "gs://my-bucket/templates/template_file"
temp_gcs_location = "gs://my-bucket/tmp_dir"
enable_streaming_engine = true
parameters = {
inputFilePattern = "${google_storage_bucket.bucket1.url}/*.json"
outputTopic = google_pubsub_topic.topic.id
}
transform_name_mapping = {
name = "test_job"
env = "test"
}
on_delete = "cancel"
kms_key_name = "somekey"
ip_configuration = "WORKER_IP_PUBLIC"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[
{
"queryName": "BOM - GCP Dataflow",
"severity": "TRACE",
"line": 1,
"fileName": "positive.tf"
},
{
"queryName": "BOM - GCP Dataflow",
"severity": "TRACE",
"line": 17,
"fileName": "positive.tf"
}
]