terraform.azure.best-practice.azure-keyvault-recovery-enabled.azure-keyvault-recovery-enabled

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

Ensure the key vault is recoverable https://docs.bridgecrew.io/docs/ensure-the-key-vault-is-recoverable

Run Locally

Run in CI

Semgrep CI docs

Defintion

Edit RuleView Source
Open in Playground 
rules:
  - id: azure-keyvault-recovery-enabled
    message: Ensure the key vault is recoverable
      https://docs.bridgecrew.io/docs/ensure-the-key-vault-is-recoverable
    patterns:
      - pattern: |
          resource "azurerm_key_vault" "..." {
          ...
          }
      - pattern-not-inside: |
          resource "azurerm_key_vault" "..." {
          ...
          purge_protection_enabled = true
          ...
          }
    metadata:
      category: best-practice
      technology:
        - terraform
        - azure
      references:
        - https://docs.bridgecrew.io/docs/ensure-the-key-vault-is-recoverable
      license: Commons Clause License Condition v1.0[LGPL-2.1-only]
    languages:
      - hcl
    severity: WARNING

Examples

azure-keyvault-recovery-enabled.tf

# fail
# ruleid: azure-keyvault-recovery-enabled
resource "azurerm_key_vault" "example" {
    name                        = "testvault"
    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
    sku_name = "standard"
}

# fail
# ruleid: azure-keyvault-recovery-enabled
resource "azurerm_key_vault" "example" {
    name                        = "testvault"
    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_enabled         = false
    sku_name = "standard"
}

# pass
resource "azurerm_key_vault" "example" {
    name                        = "testvault"
    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_enabled         = true
    purge_protection_enabled    = true
    sku_name = "standard"
}

# pass
resource "azurerm_key_vault" "example" {
    name                        = "testvault"
    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
    purge_protection_enabled    = true
    sku_name = "standard"
}