你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

启用客户管理的密钥

本文是由四部分构成的教程系列的第二部分。 第一部分 概述了客户管理的密钥、其功能和注意事项,然后再在注册表上启用一个密钥。 本文将引导你完成使用 Azure CLI、Azure 门户或 Azure 资源管理器模板来启用客户管理的密钥的步骤。

先决条件

使用 Azure CLI 启用客户管理的密钥

创建资源组

运行 az group create 命令以创建保存密钥存储、容器注册表和其他所需资源的资源组:

az group create --name <resource-group-name> --location <location>

创建用户分配的托管标识

为注册表配置用户分配的 托管标识 ,以便它可以访问加密密钥:

  1. 运行 az identity create 命令创建托管标识:

    az identity create \
      --resource-group <resource-group-name> \
      --name <managed-identity-name>
    
  2. 在命令输出中,记下 id 和 principalId 的值,以配置对该注册表项的访问权限:

    {
      "clientId": "00001111-aaaa-2222-bbbb-3333cccc4444",
      "clientSecretUrl": "https://control-eastus.identity.azure.net/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentityname/credentials?tid=aaaabbbb-0000-cccc-1111-dddd2222eeee&oid=aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb&aid=00001111-aaaa-2222-bbbb-3333cccc4444",
      "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myresourcegroup",
      "location": "eastus",
      "name": "myidentityname",
      "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "resourceGroup": "myresourcegroup",
      "tags": {},
      "tenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "Microsoft.ManagedIdentity/userAssignedIdentities"
    }
    
  3. 为方便起见,请将 id 和 principalId 值存储在环境变量中:

    identityID=$(az identity show --resource-group <resource-group-name> --name <managed-identity-name> --query 'id' --output tsv)
    
    identityPrincipalID=$(az identity show --resource-group <resource-group-name> --name <managed-identity-name> --query 'principalId' --output tsv)
    

创建和配置密钥保管库

  1. 运行 az keyvault create 命令创建一个密钥保管库,可以在其中存储客户管理的用于加密容器注册表的密钥。

  2. 默认情况下,新的密钥保管库会自动启用软删除设置。 为防止意外删除密钥或密钥保管库导致的数据丢失,建议启用“清除保护”设置:

    az keyvault create --name <key-vault-name> \
      --resource-group <resource-group-name> \
      --enable-purge-protection
    
  3. 为方便起见,请记下密钥保管库资源 ID 并将值存储在环境变量中:

    keyvaultID=$(az keyvault show --resource-group <resource-group-name> --name <key-vault-name> --query 'id' --output tsv)
    

启用受信任的服务以访问密钥保管库

如果使用防火墙或虚拟网络(专用终结点)来保护密钥保管库,则必须启用网络设置,以允许受信任的 Azure 服务进行访问。 有关详细信息,请参阅配置 Azure 密钥保管库 网络设置。

启用托管标识以访问密钥保管库

可通过两种方式启用托管身份以访问密钥保管库。

第一种是为密钥保管库配置访问策略并设置密钥权限以使用用户分配的托管标识进行访问:

  1. 运行 az keyvault set policy 命令。 传递先前创建并存储的环境变量值 principalID。

  2. 将密钥权限设置为 get、unwrapKey 和 wrapKey:

    az keyvault set-policy \
      --resource-group <resource-group-name> \
      --name <key-vault-name> \
      --object-id $identityPrincipalID \
      --key-permissions get unwrapKey wrapKey
    
    

第二种是使用 Azure 基于角色的访问控制 (RBAC) 将权限分配给用户分配的托管标识并访问密钥保管库。 运行 az role assignment create 命令并将 密钥保管库 Crypto Service Encryption User 角色分配给用户分配的托管标识:

az role assignment create --assignee $identityPrincipalID \
  --role "Key Vault Crypto Service Encryption User" \
  --scope $keyvaultID

在密钥保管库中创建密钥并获取密钥 ID

  1. 运行 az keyvault key create 命令以在密钥保管库中创建密钥:

    az keyvault key create \
      --name <key-name> \
      --vault-name <key-vault-name>
    
  2. 记下命令输出中的密钥 ID (kid):

    [...]
      "key": {
        "crv": null,
        "d": null,
        "dp": null,
        "dq": null,
        "e": "AQAB",
        "k": null,
        "keyOps": [
          "encrypt",
          "decrypt",
          "sign",
          "verify",
          "wrapKey",
          "unwrapKey"
        ],
        "kid": "https://mykeyvault.vault.azure.net/keys/mykey/<version>",
        "kty": "RSA",
    [...]
    
  3. 为方便起见,请将为密钥 ID 选择的格式存储在 $keyID 环境变量中。 可以使用带版本或不带版本的密钥 ID。

密钥轮换

可以选择手动或自动密钥轮换。

使用带有密钥版本的客户管理密钥加密注册表,将只允许在 Azure 容器注册表中手动轮换密钥。 此示例存储密钥的 kid 属性:

keyID=$(az keyvault key show \
  --name <keyname> \
  --vault-name <key-vault-name> \
  --query 'key.kid' --output tsv)

如果通过省略密钥版本来使用客户管理的密钥加密注册表,将启用自动密钥轮换来检测 Azure 密钥保管库中的新密钥版本。 此示例从键的 kid 属性中删除版本:

keyID=$(az keyvault key show \
  --name <keyname> \
  --vault-name <key-vault-name> \
  --query 'key.kid' --output tsv)

keyID=$(echo $keyID | sed -e "s/\/[^/]*$//")

创建和配置托管 HSM

必须先预配和激活托管 HSM,然后才能创建密钥或分配数据平面角色。 按照快速入门操作:使用 Azure CLI预配和激活托管 HSM,然后返回到本文。

Azure 容器注册表 需要对托管 HSM 启用清除保护。 始终为托管 HSM 启用软删除,但还必须启用清除保护:

az keyvault update-hsm \
  --hsm-name <managed-hsm-name> \
  --enable-purge-protection true

Important

你在启用后就无法关闭清除保护。 已删除的托管 HSM 在保留期结束后被彻底删除之前,将继续产生费用。 有关详细信息,请参阅 托管 HSM 软删除和清除保护。

如果启用了托管 HSM 防火墙,请在创建注册表之前配置受信任的服务或其他网络访问。 有关详细信息,请参阅 托管 HSM 的网络安全性。

创建加密密钥的用户需要允许创建密钥的托管 HSM 角色,例如 托管 HSM 加密用户。 有关详细信息,请参阅 托管 HSM 数据平面角色管理。

创建支持密钥包装的 RSA-HSM 密钥:

az keyvault key create \
  --hsm-name <managed-hsm-name> \
  --name <key-name> \
  --kty RSA-HSM \
  --ops wrapKey unwrapKey

托管 HSM 使用本地 RBAC 而不是密钥保管库访问策略。 将托管 HSM 加密服务加密用户角色分配给用户分配的标识。 以下示例将分配限制为注册表使用的键:

az keyvault role assignment create \
  --hsm-name <managed-hsm-name> \
  --role "Managed HSM Crypto Service Encryption User" \
  --assignee-object-id $identityPrincipalID \
  --assignee-principal-type MSI \
  --scope /keys/<key-name>

将密钥 ID 及其版本存储起来,以便手动轮换:

keyID=$(az keyvault key show \
  --hsm-name <managed-hsm-name> \
  --name <key-name> \
  --query 'key.kid' --output tsv)

若要启用自动密钥轮换,请从密钥 ID 中删除版本:

keyID=$(echo $keyID | sed -e "s/\/[^/]*$//")

注释

托管 HSM 密钥 URI 使用格式 https://<managed-hsm-name>.managedhsm.azure.net/keys/<key-name>/<version>。 DNS 后缀可能因Azure云而异。

使用客户管理的密钥创建注册表

  1. 运行 az acr create 命令,以在“高级”服务层级创建注册表并启用客户管理的密钥。

  2. 传递在前面的步骤中存储在环境变量中的托管标识 ID (id) 和密钥 ID (kid) 值:

    az acr create \
      --resource-group <resource-group-name> \
      --name <container-registry-name> \
      --identity $identityID \
      --key-encryption-key $keyID \
      --sku Premium
    

显示加密状态

运行 az acr encryption show 命令以显示使用客户管理的密钥执行的注册表加密的状态:

az acr encryption show --name <container-registry-name>

输出类似于以下内容,具体取决于用于加密注册表的密钥:

{
  "keyVaultProperties": {
    "identity": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "keyIdentifier": "https://myvault.vault.azure.net/keys/myresourcegroup/abcdefg123456789...",
    "keyRotationEnabled": true,
    "lastKeyRotationTimestamp": xxxxxxxx
    "versionedKeyIdentifier": "https://myvault.vault.azure.net/keys/myresourcegroup/abcdefg123456789...",
  },
  "status": "enabled"
}

使用 Azure 门户启用客户管理的密钥

创建用户分配的托管标识

要在 Azure 门户中为 Azure 资源创建用户分配的托管标识:

  1. 按照步骤创建用户分配的托管标识。

  2. 保存身份名称以在之后的步骤中使用。

用于在Azure门户中创建用户分配标识的选项的屏幕截图。

创建 key vault

  1. 按照快速入门:使用 Azure 门户创建密钥保管库中的步骤操作。

  2. 为客户管理的密钥创建密钥保管库时,请在“基本”选项卡中启用“清除保护”设置。 此设置有助于防止因意外删除密钥或密钥保管库导致的数据丢失。

    用于在 Azure 门户中创建密钥保管库的选项的屏幕截图。

启用受信任的服务以访问密钥保管库

如果使用防火墙或虚拟网络(专用终结点)来保护密钥保管库,请启用网络设置,以允许受信任的 Azure 服务进行访问。 有关详细信息,请参阅配置 Azure 密钥保管库 网络设置。

启用托管标识以访问密钥保管库

可通过两种方式启用托管身份以访问密钥保管库。

第一种是为密钥保管库配置访问策略并设置密钥权限以使用用户分配的托管标识进行访问:

  1. 转到密钥保管库。
  2. 选择“设置”>“访问策略” +添加访问策略。
  3. 选择“密钥权限”,然后选择“获取”、“解包密钥”和“包装密钥”。
  4. 在“选择主体”中,选择你的用户分配的托管身份的资源名称。
  5. 依次选择“添加”、“保存”。

用于创建 Key Vault 访问策略的选项的屏幕截图。

另一个选项是将 密钥保管库 Crypto Service Encryption User RBAC 角色分配给密钥保管库范围内用户分配的托管标识。 有关详细步骤,请参阅使用 Azure 门户分配 Azure 角色。

创建和配置托管 HSM

  1. 按照快速入门操作:使用 Azure 门户预配和激活托管 HSM。
  2. 确保在托管 HSM 上启用清除保护。 除了始终启用的软删除功能之外,Azure 容器注册表还需要清除保护。 启用保护后,无法禁用清除保护,已删除的托管 HSM 在其保留期内仍会产生费用。 有关详细信息,请参阅 托管 HSM 软删除和清除保护。
  3. 确保创建加密密钥的用户具有允许创建密钥的托管 HSM 角色,例如 托管 HSM 加密用户。
  4. 在“设置”下,选择“密钥”,然后创建或导入支持 wrapKey 和 unwrapKey 操作的 RSA-HSM 密钥。
  5. 在 “设置”下,选择 “本地 RBAC”。
  6. 为用户分配的托管标识添加 Managed HSM Crypto Service Encryption User 角色分配。 为了获得最小特权,请在加密密钥的范围内分配角色。 有关详细信息,请参阅 托管 HSM 数据平面角色管理。
  7. 如果启用了托管 HSM 防火墙,请配置受信任的服务或其他网络访问。 有关详细信息,请参阅 托管 HSM 的网络安全性。

Important

Azure 容器注册表不会创建或更新托管 HSM 角色分配。 在创建注册表或更改其加密密钥之前配置角色分配。

在密钥保管库中创建密钥

在密钥保管库中创建一个密钥并使用它来加密注册表。 如果要选择特定的密钥版本作为客户管理的密钥,请执行以下步骤。 如果密钥保管库访问仅限于专用终结点或选定网络,则创建注册表之前可能还需要创建密钥。

  1. 转到密钥保管库。
  2. 选择设置>密钥。
  3. 选择“+生成/导入”并输入密钥的唯一名称。
  4. 接受剩余的默认值,然后选择 创建。
  5. 创建后,选择该密钥,然后选择当前版本。 复制密钥版本的密钥标识符。

创建容器注册表

  1. 选择 创建资源> > 容器 > 容器注册表。

  2. 在“基本信息”选项卡中选择或创建一个资源组,然后输入注册表名称。 在 定价计划中,选择“ 高级”。

  3. 在“加密”选项卡上的“客户管理的密钥”中,选择“已启用”。

  4. 选择包含你的托管标识的订阅。 对于 标识,选择创建的托管标识。

  5. 对于 加密,请选择以下选项之一:

    • 选择从 密钥保管库 中选择,然后打开加密密钥下的密钥选取器。 选择订阅,将 密钥存储类型 设置为 Key Vault 或 托管 HSM,然后选择密钥存储和密钥。 选择 “选择 ”以确认。 你选择的密钥不带版本,并支持自动密钥轮换。
    • 选择 Enter key URI,并提供现有 密钥保管库 或托管 HSM 密钥的标识符。 可以提供带版本的密钥 URI(必须手动轮换的密钥)或不带版本的密钥 URI(启用自动密钥轮换)。

    如果托管 HSM 防火墙阻止门户列出密钥,请允许你的客户端 IP 地址通过防火墙,或选择 输入密钥 URI。 允许受信任的服务使Azure 容器注册表能够访问托管 HSM,但它不允许在配置的网络边界之外的客户端使用密钥选取器。

    选择托管 HSM 作为密钥存储类型的密钥选取器以及所选 HSM 和密钥的屏幕截图。

  6. 选择“查看 + 创建”。

  7. 选择“创建”以部署注册表实例。

“加密”选项卡的屏幕截图,其中启用了客户管理的密钥、选定的托管标识和配置的托管 HSM 密钥。

显示加密状态

要在门户中查看注册表的加密状态,请转到注册表。 在“设置”下,选择“加密”。

使用资源管理器模板启用客户管理的密钥

可以使用资源管理器模板创建容器注册表,并使用存储在 密钥保管库 或托管 HSM 中的客户管理的密钥启用加密。

在部署模板之前,请创建用户分配的标识并配置其对密钥的访问权限:

  • 对于 密钥保管库,请使用访问策略或 unwrapKey Azure RBAC 角色向标识授予 、get 和 wrapKey 权限。
  • 对于托管 HSM,在密钥范围内为标识分配托管 HSM 加密服务加密用户本地 RBAC 角色。

该模板声明现有标识,以便注册表可以依赖它。 将模板部署到与标识相同的资源组。

密钥存储必须启用清除保护。 有关托管 HSM 设置,请参阅 创建和配置托管 HSM。

  1. 将资源管理器模板的以下内容复制到新文件中并将其另存为 CMKtemplate.json:

    {
      "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "parameters": {
        "registry_name": {
          "type": "String"
        },
        "identity_name": {
          "type": "String"
        },
        "kek_id": {
          "type": "String"
        }
      },
      "resources": [
        {
          "type": "Microsoft.ContainerRegistry/registries",
          "apiVersion": "2019-12-01-preview",
          "name": "[parameters('registry_name')]",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "Premium",
            "tier": "Premium"
          },
          "identity": {
            "type": "UserAssigned",
            "userAssignedIdentities": {
              "[resourceID('Microsoft.ManagedIdentity/userAssignedIdentities', parameters('identity_name'))]": {}
            }
          },
          "dependsOn": [
            "[resourceId('Microsoft.ManagedIdentity/userAssignedIdentities', parameters('identity_name'))]"
          ],
          "properties": {
            "adminUserEnabled": false,
            "encryption": {
              "status": "enabled",
              "keyVaultProperties": {
                "identity": "[reference(resourceId('Microsoft.ManagedIdentity/userAssignedIdentities', parameters('identity_name')), '2018-11-30').clientId]",
                "keyIdentifier": "[parameters('kek_id')]"
              }
            },
            "networkRuleSet": {
              "defaultAction": "Allow",
              "virtualNetworkRules": [],
              "ipRules": []
            },
            "policies": {
              "quarantinePolicy": {
                "status": "disabled"
              },
              "trustPolicy": {
                "type": "Notary",
                "status": "disabled"
              },
              "retentionPolicy": {
                "days": 7,
                "status": "disabled"
              }
            }
          }
        },
        {
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "apiVersion": "2018-11-30",
          "name": "[parameters('identity_name')]",
          "location": "[resourceGroup().location]"
        }
      ]
    }
    
  2. 按照前面部分中的步骤创建以下资源:

    • 用户分配的托管标识,按名称标识
    • 密钥保管库或托管 HSM 密钥,由密钥 ID 标识
    • 所需的密钥保管库权限或托管 HSM 本地 RBAC 角色分配
  3. 运行 az deployment group create 命令,以使用前面的模板文件创建注册表。 提供新的注册表名称、现有的用户分配的托管标识名称和你创建的密钥 ID。

    az deployment group create \
      --resource-group <resource-group-name> \
      --template-file CMKtemplate.json \
      --parameters \
        registry_name=<registry-name> \
        identity_name=<managed-identity> \
        kek_id=<key-id>
    
  4. 运行 az acr encryption show 命令显示注册表加密的状态:

    az acr encryption show --name <registry-name>
    

后续步骤

继续阅读下一篇文章,了解如何轮换客户管理的密钥、更新密钥版本和撤销客户管理的密钥。