terraform.azure.security.azure-cosmosdb-have-cmk.azure-cosmosdb-have-cmk

profile photo of semgrepsemgrep
Author
unknown
Download Count*
LGPL Commons Clause
License

Ensure that Cosmos DB accounts have customer-managed keys to encrypt data at rest

Run Locally

Run in CI

Semgrep CI docs

Defintion

Edit RuleView Source
Open in Playground 
rules:
  - id: azure-cosmosdb-have-cmk
    message: Ensure that Cosmos DB accounts have customer-managed keys to encrypt
      data at rest
    patterns:
      - pattern: resource
      - pattern-not-inside: |
          resource "azurerm_cosmosdb_account" "..." {
          ...
          key_vault_key_id = ...
          ...
          }
      - pattern-inside: |
          resource "azurerm_cosmosdb_account" "..." {
          ...
          }
    metadata:
      owasp:
        - A03:2017 - Sensitive Data Exposure
      cwe:
        - "CWE-320: CWE CATEGORY: Key Management Errors"
      category: security
      technology:
        - terraform
        - azure
      references:
        - https://owasp.org/Top10/A02_2021-Cryptographic_Failures
      subcategory:
        - audit
      likelihood: LOW
      impact: LOW
      confidence: LOW
      license: Commons Clause License Condition v1.0[LGPL-2.1-only]
      vulnerability_class:
        - Cryptographic Issues
    languages:
      - hcl
    severity: WARNING

Examples

azure-cosmosdb-have-cmk.tf

# fail
# ruleid: azure-cosmosdb-have-cmk
resource "azurerm_cosmosdb_account" "db" {
    name                = "tfex-cosmos-db-${random_integer.ri.result}"
    location            = azurerm_resource_group.rg.location
    resource_group_name = azurerm_resource_group.rg.name
    offer_type          = "Standard"
    kind                = "GlobalDocumentDB"

    enable_automatic_failover = true

    capabilities {
    name = "EnableAggregationPipeline"
    }

    capabilities {
    name = "mongoEnableDocLevelTTL"
    }

    capabilities {
    name = "MongoDBv3.4"
    }

    consistency_policy {
    consistency_level       = "BoundedStaleness"
    max_interval_in_seconds = 10
    max_staleness_prefix    = 200
    }

    geo_location {
    location          = var.failover_location
    failover_priority = 1
    }

    geo_location {
    location          = azurerm_resource_group.rg.location
    failover_priority = 0
    }
}

# pass
resource "azurerm_cosmosdb_account" "db" {
    name                = "tfex-cosmos-db-${random_integer.ri.result}"
    location            = azurerm_resource_group.rg.location
    resource_group_name = azurerm_resource_group.rg.name
    offer_type          = "Standard"
    kind                = "GlobalDocumentDB"
  
    enable_automatic_failover = true
  
    capabilities {
      name = "EnableAggregationPipeline"
    }
  
    capabilities {
      name = "mongoEnableDocLevelTTL"
    }
  
    capabilities {
      name = "MongoDBv3.4"
    }
  
    consistency_policy {
      consistency_level       = "BoundedStaleness"
      max_interval_in_seconds = 10
      max_staleness_prefix    = 200
    }
  
    geo_location {
      location          = var.failover_location
      failover_priority = 1
    }
  
    geo_location {
      location          = azurerm_resource_group.rg.location
      failover_priority = 0
    }
    
    key_vault_key_id = "A versionless Key Vault Key ID for CMK encryption"
}