feat(query): new query "Beta - Databricks Workspace Using Default Virtual Network" - Terraform/azure

[cx-andre-pereira]

Reason for Proposed Changes

• Currently there is no query checking that a azurerm_databricks_workspace is associated with a azurerm_virtual_network through the "virtual_network_id" field.
• Associating a custom virtual network to the Databricks Workspace allows users to:
  • "Connect Azure Databricks to other Azure services (such as Azure Storage) more securely using service endpoints or Azure private endpoints."
  • "Connect to on-premises data sources using user-defined routes."
  • "Connect Azure Databricks to a network virtual appliance to inspect all outbound traffic and take actions according to allow and deny rules. "
  • "Configure Azure Databricks to use custom DNS."
  • "Configure network security group (NSG) rules to specify egress traffic restrictions."

(Explicitly stated within the official documentation)

All this to say that by not associating a custom VN, you default to Databricks-managed networking — losing visibility and control.

Extra documentation: "OOTB" rules, "customize networking from users to Azure Databricks"(Azure docs)

Proposed Changes

• Implemented the "Beta - Databricks Workspace Using Default Virtual Network" query with id "05d6b52e-11ca-453d-bb3a-21c7c853ee92".

• Given the context of the query implementation and the available list of "category" values i chose "Networking and Firewall", additionally the severity is set to "MEDIUM"; this was based on other queries of the same "category" and the, specifically, the "2e48d91c-50e4-45c8-9312-27b625868a72" query which i believe presents risks with similar "danger" levels.

• For the implementation itself, first it is checked that the "custom_parameters" block is set for the "azurerm_databricks_workspace" resource being evaluated. If not the query will flag.

• Inside the block it is then checked that the main field "virtual_network_id" is set. If it is not present the query will flag.

I submit this contribution under the Apache-2.0 license.

[github-actions]

KICS version: v2.1.13

Category Results CRITICAL 0 HIGH 0 MEDIUM 0 LOW 0 INFO 0 TRACE 0 TOTAL 0	Metric Values Files scanned 1 Files parsed 1 Files failed to scan 0 Total executed queries 47 Queries failed to execute 0 Execution time 0

[gitguardian]

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
21271469	Triggered	Generic Password	e8b1d27	assets/queries/terraform/azure/unrestricted_sql_server_access/test/negative4.tf	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secret safely. Learn here the best practices.
3. Revoke and rotate this secret.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}