啟用客戶自控金鑰

本文是四部分教學課程系列的第二部分。 第一部分 概述客戶管理的金鑰、其功能及在您啟用登錄表前的注意事項。 本文將逐步引導您完成使用 Azure CLI、Azure 入口網站或 Azure Resource Manager 範本啟用客戶自控金鑰的步驟。

必要條件

使用 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. 為了方便起見,請記下金鑰保存庫資源識別碼,並將值儲存在環境變數中:

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

啟用受信任的服務以存取金鑰保存庫

如果金鑰保存庫受到防火牆或虛擬網路 (私人端點) 保護,您必須啟用網路設定以允許受信任的 Azure 服務存取。 如需詳細資訊,請參閱設定 Azure Key Vault 網路設定。

啟用受控識別以存取 Key Vault

有兩種方式可讓受控識別存取您的金鑰保存庫。

第一個選項是設定金鑰保存庫的存取原則,並設定使用使用者指派的受控識別來存取的金鑰權限:

  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 命令來建立 Key Vault 中的金鑰:

    az keyvault key create \
      --name <key-name> \
      --vault-name <key-vault-name>
    
  2. 在命令輸出中,記下金鑰識別元 (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. 為了方便起見,請將您選擇的金鑰識別碼格式儲存在 $keyID 環境變數中。 您可以使用包含或不含版本的金鑰識別元。

金鑰輪替

您可以選擇手動或自動金鑰輪替。

使用具有金鑰版本的客戶自控金鑰加密 Azure Container Registry,將只允許手動金鑰輪替。 此範例會儲存金鑰的 kid 屬性:

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

使用客戶自控金鑰為登錄加密時,若省略金鑰版本,將會啟用自動金鑰輪替,以偵測 Azure Key Vault 中的新金鑰版本。 此範例會從金鑰的 kid 屬性中移除版本:

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

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

建立並設定 Managed HSM

您必須先配置並啟用受管理型 HSM,才能建立金鑰或指派資料平面角色。 請遵循快速入門:使用 Azure CLI 配置並啟用受管理型 HSM,然後返回本文。

Azure Container Registry 需要受管式 HSM 啟用清除保護功能。 軟刪除對受管式 HSM 始終啟用,但您也必須啟用清除保護:

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

Important

你啟用清除保護後就無法關閉它。 刪除的託管 HSM 會持續產生費用,直到保留期結束後被清除為止。 欲了解更多資訊,請參閱 管理型 HSM 軟刪除及清除保護。

如果已啟用受控 HSM 防火牆,請先設定信任的服務或其他網路存取權,再建立登錄。 欲了解更多資訊,請參閱 受管型 HSM 網路安全。

建立加密金鑰的使用者需要一個允許建立金鑰的受管理 HSM 角色,例如 Managed HSM Crypto User。 欲了解更多資訊,請參閱 受管理型 HSM 資料平面角色管理。

建立一個支援金鑰包裝的 RSA-HSM 金鑰:

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

託管 HSM 使用本地 RBAC 取代 金鑰保存庫 存取政策。 將 Managed HSM Crypto Service Encryption User 角色指派給使用者指派的身分識別。 以下範例將指派限制為登錄檔所使用的金鑰:

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/\/[^/]*$//")

Note

受管型 HSM 金鑰 URI 採用格式 https://<managed-hsm-name>.managedhsm.azure.net/keys/<key-name>/<version>。 DNS 後綴會因 Azure 雲端而異。

使用客戶自控金鑰建立登錄

  1. 執行 az acr create 命令,以便在進階服務層中建立登錄,並啟用客戶自控金鑰。

  2. 傳遞先前步驟中儲存在環境變數中的受控識別識別碼 (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 入口網站中建立使用者指派身份的選項截圖。

建立金鑰保存庫

  1. 請遵循快速入門:使用 Azure 入口網站建立 Key Vault中的步驟。

  2. 當您為客戶自控金鑰建立金鑰保存庫時,請在基本索引標籤上,啟用清除保護設定。 此設定有助於防止意外刪除金鑰或金鑰保存庫所導致的資料遺失。

    在 Azure 入口網站建立金鑰保險庫的選項截圖。

啟用受信任的服務以存取金鑰保存庫

如果金鑰保存庫受到防火牆或虛擬網路 (私人端點) 保護,請啟用網路設定以允許受信任的 Azure 服務存取。 如需詳細資訊,請參閱設定 Azure Key Vault 網路設定。

啟用受控識別以存取 Key Vault

有兩種方式可讓受控識別存取您的金鑰保存庫。

第一個選項是設定金鑰保存庫的存取原則,並設定使用使用者指派的受控識別來存取的金鑰權限:

  1. 移至您的金鑰保存庫。
  2. 選取設定>存取原則> + 新增存取原則。
  3. 選取 金鑰權限,然後選取 取得、解除包裝金鑰 和 包裝金鑰。
  4. 在選取主體中,選取使用者指派受控身分識別的資源名稱。
  5. 選擇新增,然後選擇儲存。

建立金鑰保險庫存取原則的選項截圖。

另一個選項是在金鑰保存庫範圍,將金鑰保存庫 Crypto Service Encryption User RBAC 角色指派給使用者指派受控身分識別。 如需詳細步驟,請參閱使用 Azure 入口網站指派 Azure 角色。

建立並設定 Managed HSM

  1. 請遵循快速啟動:透過 Azure 入口網站配置並啟用受管型 HSM。
  2. 確保在受管理的 HSM 上啟用清除保護。 Azure Container Registry 除了始終啟用的軟刪除功能外,還需要清除保護。 啟用清除保護後無法停用,且已刪除的託管 HSM 在其保留期間仍會產生費用。 欲了解更多資訊,請參閱 管理型 HSM 軟刪除及清除保護。
  3. 確保建立加密金鑰的使用者擁有允許金鑰建立的受管理 HSM 角色,例如 Managed HSM 加密用戶。
  4. 在 設定中選擇 鍵,然後建立或匯入支援 wrapKey 和 unwrapKey 操作的 RSA-HSM 鍵。
  5. 在設定中,選擇本地 RBAC。
  6. 為使用者指派的識別身分新增 Managed HSM Crypto Service Encryption User 角色指派。 為達到最低權限,請在金鑰範圍指派角色。 欲了解更多資訊,請參閱 受管理型 HSM 資料平面角色管理。
  7. 若啟用受管型 HSM 防火牆,請設定可信服務或其他網路存取。 欲了解更多資訊,請參閱 受管型 HSM 網路安全。

Important

Azure Container Registry 不會建立或更新受管理的 HSM 角色指派。 請在建立登錄或變更其加密金鑰之前,先設定角色指派。

在金鑰保存庫中建立一把金鑰

在金鑰保存庫中建立金鑰,並使用它來加密登錄。 如果您想要選取特定金鑰版本作為客戶自控金鑰,請遵循下列步驟。 如果金鑰保存庫的存取權受限於私人端點或選取的網路,您可能也需要在建立登錄之前建立金鑰。

  1. 移至您的金鑰保存庫。
  2. 選取設定>按鍵。
  3. 選取 +產生/匯入,然後輸入唯一的金鑰名稱。
  4. 接受剩餘預設值,然後選取 建立。
  5. 建立之後,請選取金鑰,然後選取目前的版本。 複製金鑰版本的金鑰識別碼。

建立容器登錄庫

  1. 選取 建立資源>容器>容器登錄。

  2. 在基本索引標籤上,選取或建立資源群組,然後輸入登錄名稱。 在 「定價方案」中,選擇 「高級方案」。

  3. 在 加密 索引標籤頁的 客戶管理金鑰 中,選取 已啟用。

  4. 選取包含受控識別的訂用帳戶。 針對身分識別,選取您建立的受控身分識別。

  5. 請為 加密 選擇以下選項之一:

    • 選擇「從 金鑰保存庫 選取」,然後在「加密金鑰」下開啟金鑰選擇器。 選擇訂閱,將金鑰儲存類型設為Key Vault或受管 HSM,然後選擇金鑰儲存區與金鑰。 選擇 選擇 以確認。 您選取的金鑰未設版本,因此可啟用自動金鑰輪替。
    • 選取輸入金鑰 URI,並提供現有 金鑰保存庫 或受控 HSM 金鑰的識別碼。 你可以提供有版本的金鑰 URI(對於需要手動旋轉的金鑰),或是無版本化金鑰 URI(能自動旋轉金鑰)。

    如果管理式 HSM 防火牆阻止入口網站列出金鑰,請允許您的用戶端 IP 位址通過,或選擇 輸入金鑰 URI。 允許可信服務會讓 Azure Container Registry 能夠存取受管理的 HSM,但不允許位於已設定網路界限之外的用戶端使用金鑰選擇器。

    金鑰選擇器的截圖,其中「管理 HSM」為金鑰儲存類型,並選取了 HSM 和金鑰。

  6. 選取 [檢閱 + 建立]。

  7. 選取建立,以部署登錄執行個體。

加密標籤的螢幕截圖,啟用客戶管理金鑰、已選取管理身份,並設定了受管式 HSM 金鑰。

顯示加密狀態

若要在入口網站中查看登錄的加密狀態,請前往您的登錄。 在設定下,選取加密。

使用 Resource Manager 範本啟用客戶自控金鑰

您可以使用 Resource Manager 範本建立容器登錄檔,並啟用存放在 金鑰保存庫 或 Managed HSM 中的客戶管理金鑰加密。

在部署範本前,先建立使用者指派的身份並設定其對金鑰的存取權限:

  • 對於 金鑰保存庫,請透過存取原則或 unwrapKey Azure RBAC 角色,授予該身分識別 、get 及 wrapKey 權限。
  • 若使用受控 HSM,請在金鑰範圍將受控 HSM 加密服務加密使用者 本機 RBAC 角色指派給該身分識別。

範本宣告現有識別,讓登錄能依賴該識別。 將範本部署到與身分識別相同的資源群組。

金鑰儲存區必須啟用清除保護。 關於受管理 HSM 設定,請參閱 建立與設定受管理 HSM。

  1. 將下列 Resource Manager 範本的內容複製到新檔案,並將其儲存為 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. 依照之前章節中的步驟來建立下列資源:

    • 使用者指派受控身分識別 (依名稱識別)
    • 金鑰保存庫 或 Managed HSM 金鑰,以金鑰 ID 識別
    • 必要的 金鑰保存庫 權限或受管理的 HSM 本地 RBAC 角色指派
  3. 執行 az deployment group create 命令,以使用前述範本檔案建立登錄。 提供新的登錄名稱、現有的使用者指派受控身分識別名稱,以及您建立的金鑰識別碼。

    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>
    

下一步

前往下一篇文章以逐步瞭解如何輪替客戶自控金鑰、更新金鑰版本,以及撤銷客戶自控金鑰。