terraform.azure.security.azure-key-backedby-hsm.azure-key-backedby-hsm

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

Ensure that key vault key is backed by HSM

Run Locally

Run in CI

Semgrep CI docs

Defintion

Edit RuleView Source
Open in Playground 
rules:
  - id: azure-key-backedby-hsm
    message: Ensure that key vault key is backed by HSM
    patterns:
      - pattern: resource
      - pattern-not-inside: |
          resource "azurerm_key_vault_key" "..." {
          ...
          key_type = "EC-HSM"
          ...
          }
      - pattern-not-inside: |
          resource "azurerm_key_vault_key" "..." {
          ...
          key_type = "RSA-HSM"
          ...
          }
      - pattern-inside: |
          resource "azurerm_key_vault_key" "..." {
          ...
          }
    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-key-backedby-hsm.tf

# fail
# ruleid: azure-key-backedby-hsm
resource "azurerm_key_vault_key" "generated" {
    name         = "generated-certificate"
    key_vault_id = azurerm_key_vault.example.id
    key_type     = "RSA"
    key_size     = 2048

    key_opts = [
    "decrypt",
    "encrypt",
    "sign",
    "unwrapKey",
    "verify",
    "wrapKey",
    ]
}

# pass
resource "azurerm_key_vault_key" "generated" {
    name         = "generated-certificate"
    key_vault_id = azurerm_key_vault.example.id
    key_type     = "EC-HSM"
    key_size     = 2048

    key_opts = [
    "decrypt",
    "encrypt",
    "sign",
    "unwrapKey",
    "verify",
    "wrapKey",
    ]
    expiration_date = "2020-12-30T20:00:00Z"
}

# pass
resource "azurerm_key_vault_key" "generated" {
    name         = "generated-certificate"
    key_vault_id = azurerm_key_vault.example.id
    key_type     = "RSA-HSM"
    key_size     = 2048

    key_opts = [
      "decrypt",
      "encrypt",
      "sign",
      "unwrapKey",
      "verify",
      "wrapKey",
    ]
    expiration_date = "2020-12-30T20:00:00Z"
}