terraform.azure.security.keyvault.keyvault-purge-enabled.keyvault-purge-enabled

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

Key vault should have purge protection enabled

Run Locally

Run in CI

Semgrep CI docs

Defintion

Edit RuleView Source
Open in Playground 
rules:
  - id: keyvault-purge-enabled
    message: Key vault should have purge protection enabled
    patterns:
      - pattern: resource
      - pattern-not-inside: |
          resource "azurerm_key_vault" "..." {
          ...
           purge_protection_enabled = true
          ...
          }
      - pattern-either:
          - pattern-inside: |
              resource "azurerm_key_vault" "..." {
              ...
              }
          - pattern-inside: |
              resource "azurerm_key_vault" "..." {
              ...
                purge_protection_enabled = false
              ...
              }
    metadata:
      cwe:
        - "CWE-693: Protection Mechanism Failure"
      category: security
      technology:
        - terraform
        - azure
      references:
        - https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault#purge_protection_enabled
        - https://docs.microsoft.com/en-us/azure/key-vault/general/soft-delete-overview#purge-protection
      subcategory:
        - vuln
      likelihood: MEDIUM
      impact: MEDIUM
      confidence: MEDIUM
      license: Commons Clause License Condition v1.0[LGPL-2.1-only]
      vulnerability_class:
        - Improper Authorization
    languages:
      - hcl
    severity: WARNING

Examples

keyvault-purge-enabled.tf

resource "azurerm_key_vault" "good_example" {
    name                        = "examplekeyvault"
    location                    = azurerm_resource_group.good_example.location
    enabled_for_disk_encryption = true
    soft_delete_retention_days  = 7
    purge_protection_enabled    = true
}

# ruleid: keyvault-purge-enabled
resource "azurerm_key_vault" "bad_example" {
    name                        = "examplekeyvault"
    location                    = azurerm_resource_group.bad_example.location
    enabled_for_disk_encryption = true
    purge_protection_enabled    = false
}

# ruleid: keyvault-purge-enabled
resource "azurerm_key_vault" "bad_example" {
    name                        = "examplekeyvault"
    location                    = azurerm_resource_group.bad_example.location
    enabled_for_disk_encryption = true
}