terraform.azure.best-practice.azure-keyvault-enables-soft-delete.azure-keyvault-enables-soft-delete

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

Ensure that key vault enables soft delete

Run Locally

Run in CI

Semgrep CI docs

Defintion

Edit RuleView Source
Open in Playground 
rules:
  - id: azure-keyvault-enables-soft-delete
    message: Ensure that key vault enables soft delete
    patterns:
      - pattern: resource
      - pattern-inside: |
          resource "azurerm_key_vault" "..." {
          ...
          soft_delete_enabled = false
          ...
          }
    metadata:
      category: best-practice
      technology:
        - terraform
        - azure
      license: Commons Clause License Condition v1.0[LGPL-2.1-only]
    languages:
      - hcl
    severity: WARNING

Examples

azure-keyvault-enables-soft-delete.tf

# fail
# ruleid: azure-keyvault-enables-soft-delete
resource "azurerm_key_vault" "example" {
    name                        = "examplekeyvault"
    location                    = azurerm_resource_group.example.location
    resource_group_name         = azurerm_resource_group.example.name
    enabled_for_disk_encryption = true
    tenant_id                   = data.azurerm_client_config.current.tenant_id
    soft_delete_retention_days  = 7
    purge_protection_enabled    = false
    soft_delete_enabled = false
    sku_name = "standard"

    access_policy {
    tenant_id = data.azurerm_client_config.current.tenant_id
    object_id = data.azurerm_client_config.current.object_id

    key_permissions = [
        "Get",
    ]

    secret_permissions = [
        "Get",
    ]

    storage_permissions = [
        "Get",
    ]
    }
}

# pass
resource "azurerm_key_vault" "example" {
    name                        = "examplekeyvault"
    location                    = azurerm_resource_group.example.location
    resource_group_name         = azurerm_resource_group.example.name
    enabled_for_disk_encryption = true
    tenant_id                   = data.azurerm_client_config.current.tenant_id
    soft_delete_retention_days  = 7
    purge_protection_enabled    = false
  
    sku_name = "standard"
  
    access_policy {
      tenant_id = data.azurerm_client_config.current.tenant_id
      object_id = data.azurerm_client_config.current.object_id
  
      key_permissions = [
        "Get",
      ]
  
      secret_permissions = [
        "Get",
      ]
  
      storage_permissions = [
        "Get",
      ]
    }
}

# pass
resource "azurerm_key_vault" "example" {
    name                        = "examplekeyvault"
    location                    = azurerm_resource_group.example.location
    resource_group_name         = azurerm_resource_group.example.name
    enabled_for_disk_encryption = true
    tenant_id                   = data.azurerm_client_config.current.tenant_id
    soft_delete_retention_days  = 7
    purge_protection_enabled    = false
    soft_delete_enabled = true
    sku_name = "standard"
  
    access_policy {
      tenant_id = data.azurerm_client_config.current.tenant_id
      object_id = data.azurerm_client_config.current.object_id
  
      key_permissions = [
        "Get",
      ]
  
      secret_permissions = [
        "Get",
      ]
  
      storage_permissions = [
        "Get",
      ]
    }
}