Compartilhar via

Extensão da máquina virtual do Azure Key Vault para Windows

  • Artigo

A extensão da VM (máquina virtual) do Azure Key Vault fornece atualização automática de certificados armazenados em um cofre de chaves do Azure. A extensão monitora uma lista de certificados observados armazenados em cofres de chaves. Ao detectar uma alteração, a extensão recupera e instala os certificados correspondentes. Este artigo descreve as plataformas, configurações e opções de implantação com suporte para a extensão da VM do Key Vault para Windows.

Sistemas operacionais

A extensão da VM do Key Vault é compatível com as seguintes versões do Windows:

  • Windows Server 2022
  • Windows Server 2019
  • Windows Server 2016
  • Windows Server 2012

A extensão da VM do Key Vault também tem suporte em uma VM local personalizada. A VM deve ser carregada e convertida em uma imagem especializada para ser usada no Azure com a instalação principal do Windows Server 2019.

Certificados com suporte

A extensão da VM do Key Vault é compatível com os seguintes tipos de conteúdo de certificado:

  • PKCS #12
  • PEM

Observação

A extensão da VM do Key Vault baixa todos os certificados para o repositório de certificados do Windows ou para o local especificado na propriedade certificateStoreLocation nas configurações de extensão da VM.

Atualizações na versão 3.0+

A versão 3.0 de extensão da VM do Key Vault para Windows adiciona suporte para os seguintes recursos:

  • Adicionar permissões da ACL aos certificados baixados
  • Habilitar configuração do Repositório de Certificados por certificado
  • Exportar chaves privadas
  • Suporte à reassociação de certificado do IIS

Pré-requisitos

Examine os seguintes pré-requisitos para usar a extensão da VM do Key Vault para Windows:

  • Uma instância do Azure Key Vault com um certificado. Para obter mais informações, confira Criar um cofre de chaves usando o portal do Azure.

  • Uma VM com uma identidade gerenciada atribuída.

  • A função de Usuário de Segredos do Key Vault deve ser atribuída no nível de escopo do Key Vault para VMs e identidade gerenciada dos Conjuntos de Dimensionamento de Máquinas Virtuais do Azure. Essa função recupera a parte do segredo de um certificado. Para obter mais informações, consulte os seguintes artigos:

  • Os Conjuntos de Dimensionamento de Máquinas Virtuais devem ter a seguinte configuração identity:

    "identity": {
   "type": "UserAssigned",
   "userAssignedIdentities": {
      "[parameters('userAssignedIdentityResourceId')]": {}
   }
}

  • A extensão da VM do Key Vault deve ter a seguinte configuração authenticationSettings:

    "authenticationSettings": {
    "msiEndpoint": "[parameters('userAssignedIdentityEndpoint')]",
    "msiClientId": "[reference(parameters('userAssignedIdentityResourceId'), variables('msiApiVersion')).clientId]"
}

Observação

O antigo modelo de permissão de política de acesso também pode ser usado para fornecer acesso a VMs e Conjuntos de Dimensionamento de Máquinas Virtuais. Esse método requer a política com permissões get e list nos segredos. Para obter mais informações, confira Atribuir uma política de acesso do Key Vault.

Esquema de extensão

O JSON a seguir mostra o esquema para a extensão da VM de Key Vault. Antes de considerar as opções de implementação do esquema, examine as observações importantes a seguir.

  • A extensão não requer configurações protegidas. Todas as configurações são consideradas informações públicas.

  • Os URLs de certificados observados devem estar no formato https://myVaultName.vault.azure.net/secrets/myCertName.

    Esse formato é preferido porque o caminho retorna o certificado completo do /secrets, incluindo a chave privada, mas o caminho /certificates não. Para obter mais informações sobre certificados, confira a visão geral de chaves, segredos e certificados do Azure Key Vault.

  • A propriedade authenticationSettings é necessária para VMs com quaisquer identidades atribuídas pelo usuário.

    Essa propriedade especifica a identidade a ser usada para autenticação no Key Vault. Defina essa propriedade com uma identidade atribuída pelo sistema para evitar problemas com uma extensão da VM com várias identidades.

{
   "type": "Microsoft.Compute/virtualMachines/extensions",
   "name": "KVVMExtensionForWindows",
   "apiVersion": "2022-08-01",
   "location": "<location>",
   "dependsOn": [
      "[concat('Microsoft.Compute/virtualMachines/', <vmName>)]"
   ],
   "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForWindows",
      "typeHandlerVersion": "3.0",
      "autoUpgradeMinorVersion": true,
      "settings": {
         "secretsManagementSettings": {
             "pollingIntervalInS": <A string that specifies the polling interval in seconds. Example: "3600">,
             "linkOnRenewal": <Windows only. Ensures s-channel binding when the certificate renews without necessitating redeployment. Example: true>,
             "requireInitialSync": <Initial synchronization of certificates. Example: true>,
             "observedCertificates": <An array of KeyVault URIs that represent monitored certificates, including certificate store location and ACL permission to certificate private key. Example: 
             [
                {
                    "url": <A Key Vault URI to the secret portion of the certificate. Example: "https://myvault.vault.azure.net/secrets/mycertificate1">,
                    "certificateStoreName": <The certificate store name. Example: "MY">,
                    "certificateStoreLocation": <The certificate store location, which currently works locally only. Example: "LocalMachine">,
                    "accounts": <Optional. An array of preferred accounts with read access to certificate private keys. Administrators and SYSTEM get Full Control by default. Example: ["Network Service", "Local Service"]>
                },
                {
                    "url": <Example: "https://myvault.vault.azure.net/secrets/mycertificate2">,
                    "certificateStoreName": <Example: "MY">,
                    "certificateStoreLocation": <Example: "CurrentUser">,
                    "keyExportable": <Optional. Lets the private key be exportable. Example: "false">,
                    "accounts": <Example: ["Local Service"]>
                }
             ]>
         },
         "authenticationSettings": {
             "msiEndpoint":  <Required when the msiClientId property is used. Specifies the MSI endpoint. Example for most Azure VMs: "http://169.254.169.254/metadata/identity/oauth2/token">,
             "msiClientId":  <Required when the VM has any user assigned identities. Specifies the MSI identity. Example:  "c7373ae5-91c2-4165-8ab6-7381d6e75619">
         }
      }
   }
}

Valores de propriedade

O esquema JSON inclui as propriedades a seguir.

Nome Valor/exemplo Tipo de dados
apiVersion 2022-08-01 date
publisher Microsoft.Azure.KeyVault string
type KeyVaultForWindows string
typeHandlerVersion "3.0" string
pollingIntervalInS "3600" string
linkOnRenewal (opcional) true booleano
requireInitialSync (opcional) false booleano
observedCertificates [{...}, {...}] Matriz de cadeia de caracteres
observedCertificates/url "https://myvault.vault.azure.net/secrets/mycertificate" string
observedCertificates/certificateStoreName MY string
observedCertificates/certificateStoreLocation LocalMachine ou CurrentUser (diferencia maiúsculas de minúsculas) string
observedCertificates/keyExportable (opcional) false booleano
observedCertificates/accounts (opcional) ["Serviço de Rede", "Serviço Local"] Matriz de cadeia de caracteres
msiEndpoint "http://169.254.169.254/metadata/identity/oauth2/token" string
msiClientId c7373ae5-91c2-4165-8ab6-7381d6e75619 string

Implantação de modelo

As extensões da VM do Azure podem ser implantadas com modelos do Azure Resource Manager (ARM). Modelos são ideais ao implantar uma ou mais máquinas virtuais que exigem renovação de certificados pós-implantação. A extensão pode ser implantada em VMs individuais ou instâncias de Conjuntos de Dimensionamento de Máquinas Virtuais. O esquema e a configuração são comuns a ambos os tipos de modelo.

A configuração JSON de uma extensão de cofre de chaves está aninhada dentro da VM ou do modelo de Conjuntos de Dimensionamento de Máquinas Virtuais. Para uma extensão de recurso da VM, a configuração "resources": [] é aninhada no objeto da máquina virtual. Para uma extensão de instância de Conjuntos de Dimensionamento de Máquinas Virtuais, a configuração é aninhada no objeto "virtualMachineProfile":"extensionProfile":{"extensions" :[].

Os trechos JSON a seguir fornecem configurações de exemplo para uma implantação de modelo do ARM da extensão da VM do Key Vault.

{
   "type": "Microsoft.Compute/virtualMachines/extensions",
   "name": "KeyVaultForWindows",
   "apiVersion": "2022-08-01",
   "location": "<location>",
   "dependsOn": [
      "[concat('Microsoft.Compute/virtualMachines/', <vmName>)]"
   ],
   "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForWindows",
      "typeHandlerVersion": "3.0",
      "autoUpgradeMinorVersion": true,
      "settings": {
         "secretsManagementSettings": {
             "pollingIntervalInS": <A string that specifies the polling interval in seconds. Example: "3600">,
             "linkOnRenewal": <Windows only. Ensures s-channel binding when the certificate renews without necessitating redeployment. Example: true>,
             "observedCertificates": <An array of KeyVault URIs that represent monitored certificates, including certificate store location and ACL permission to certificate private key. Example:
             [
                {
                    "url": <A Key Vault URI to the secret portion of the certificate. Example: "https://myvault.vault.azure.net/secrets/mycertificate1">,
                    "certificateStoreName": <The certificate store name. Example: "MY">,
                    "certificateStoreLocation": <The certificate store location, which currently works locally only. Example: "LocalMachine">,
                    "accounts": <Optional. An array of preferred accounts with read access to certificate private keys. Administrators and SYSTEM get Full Control by default. Example: ["Network Service", "Local Service"]>
                },
                {
                    "url": <Example: "https://myvault.vault.azure.net/secrets/mycertificate2">,
                    "certificateStoreName": <Example: "MY">,
                    "certificateStoreLocation": <Example: "CurrentUser">,
                    "keyExportable": <Optional. Lets the private key be exportable. Example: "false">,
                    "accounts": <Example: ["Local Service"]>
                },
                {
                    "url": <Example: "https://myvault.vault.azure.net/secrets/mycertificate3">,
                    "certificateStoreName": <Example: "TrustedPeople">,
                    "certificateStoreLocation": <Example: "LocalMachine">
                }
             ]>           
         },
         "authenticationSettings": {
            "msiEndpoint":  <Required when the msiClientId property is used. Specifies the MSI endpoint. Example for most Azure VMs: "http://169.254.169.254/metadata/identity/oauth2/token">,
            "msiClientId":  <Required when the VM has any user assigned identities. Specifies the MSI identity. Example: "c7373ae5-91c2-4165-8ab6-7381d6e75619">
         }
      }
   }
}

Ordenação de dependência da extensão

Você pode habilitar a extensão da VM do Key Vault para dar suporte à ordenação de dependência da extensão. Por padrão, a extensão da VM do Key Vault relata um início bem-sucedido assim que a pesquisa começa. No entanto, você pode configurar a extensão para relatar um início bem-sucedido somente depois que a extensão baixar e instalar todos os certificados.

Se você usar outras extensões que exijam a instalação de todos os certificados antes de serem iniciados, poderá habilitar a ordenação de dependência de extensão na extensão da VM do Key Vault. Esse recurso permite que outras extensões declarem uma dependência na extensão da VM do Key Vault.

Você pode usar esse recurso para impedir que outras extensões sejam iniciadas até que todos os certificados dependentes sejam instalados. Quando o recurso está habilitado, a extensão da VM do Key Vault tenta novamente baixar e instalar certificados indefinidamente e permanece em um estado de Transição, até que todos os certificados sejam instalados com sucesso. Depois que todos os certificados estiverem presentes, a extensão da VM do Key Vault relatará um início bem-sucedido.

Para habilitar o recurso de ordenação de dependência da extensão na extensão da VM do Key Vault, defina a propriedade secretsManagementSettings:

"secretsManagementSettings": {
   "requireInitialSync": true,
   ...
}

Para obter mais informações sobre como configurar dependências entre extensões, confira Provisionamento de extensão de sequência em Conjuntos de Dimensionamento de Máquinas Virtuais.

Importante

O recurso de ordenação de dependência da extensão não é compatível com um modelo do ARM que cria uma identidade atribuída pelo sistema e atualiza uma política de acesso do Key Vault com essa identidade. Se você tentar usar o recurso nesse cenário, ocorrerá um impasse porque a política de acesso do Key Vault não poderá ser atualizada até que todas as extensões sejam iniciadas. Em vez disso, use uma identidade do MSI atribuída a um único usuário e a pré-ACL de seus cofres de chaves com essa identidade antes de implantar.

Implantação do Azure PowerShell

A extensão da VM do Azure Key Vault pode ser implantada com o Azure PowerShell. Salve as configurações de extensão da VM do Key Vault em um arquivo JSON (settings.json).

Os trechos JSON a seguir fornecem configurações de exemplo para implantar a extensão da VM do Key Vault com o PowerShell.

{   
   "secretsManagementSettings": {
   "pollingIntervalInS": "3600",
   "linkOnRenewal": true,
   "observedCertificates":
   [
      {
          "url": "https://<examplekv>.vault.azure.net/secrets/certificate1",
          "certificateStoreName": "MY",
          "certificateStoreLocation": "LocalMachine",
          "accounts": [
             "Network Service"
          ]
      },
      {
          "url": "https://<examplekv>.vault.azure.net/secrets/certificate2",
          "certificateStoreName": "MY",
          "certificateStoreLocation": "LocalMachine",
          "keyExportable": true,
          "accounts": [
             "Network Service",
             "Local Service"
          ]
      }
   ]},
   "authenticationSettings": {
      "msiEndpoint":  "http://169.254.169.254/metadata/identity/oauth2/token",
      "msiClientId":  "c7373ae5-91c2-4165-8ab6-7381d6e75619"
   }      
}

Implantar em uma VM

# Build settings
$settings = (get-content -raw ".\settings.json")
$extName =  "KeyVaultForWindows"
$extPublisher = "Microsoft.Azure.KeyVault"
$extType = "KeyVaultForWindows"
 
# Start the deployment
Set-AzVmExtension -TypeHandlerVersion "3.0" -ResourceGroupName <ResourceGroupName> -Location <Location> -VMName <VMName> -Name $extName -Publisher $extPublisher -Type $extType -SettingString $settings

Implantar em uma instância de Conjuntos de Dimensionamento de Máquinas Virtuais

# Build settings
$settings = ".\settings.json"
$extName = "KeyVaultForWindows"
$extPublisher = "Microsoft.Azure.KeyVault"
$extType = "KeyVaultForWindows"
  
# Add extension to Virtual Machine Scale Sets
$vmss = Get-AzVmss -ResourceGroupName <ResourceGroupName> -VMScaleSetName <VmssName>
Add-AzVmssExtension -VirtualMachineScaleSet $vmss  -Name $extName -Publisher $extPublisher -Type $extType -TypeHandlerVersion "3.0" -Setting $settings

# Start the deployment
Update-AzVmss -ResourceGroupName <ResourceGroupName> -VMScaleSetName <VmssName> -VirtualMachineScaleSet $vmss

Implantação da CLI do Azure

A extensão da VM do Azure Key Vault pode ser implantada usando a CLI do Azure. Salve as configurações de extensão da VM do Key Vault em um arquivo JSON (settings.json).

Os trechos JSON a seguir fornecem configurações de exemplo para implantar a extensão da VM do Key Vault com a CLI do Azure.

   {   
        "secretsManagementSettings": {
          "pollingIntervalInS": "3600",
          "linkOnRenewal": true,
          "observedCertificates": [
            {
                "url": "https://<examplekv>.vault.azure.net/secrets/certificate1",
                "certificateStoreName": "MY",
                "certificateStoreLocation": "LocalMachine",
                "accounts": [
                    "Network Service"
                ]
            },
            {
                "url": "https://<examplekv>.vault.azure.net/secrets/certificate2",
                "certificateStoreName": "MY",
                "certificateStoreLocation": "LocalMachine",                
                "keyExportable": true,
                "accounts": [
                    "Network Service",
                    "Local Service"
                ]
            }
        ]
        },
          "authenticationSettings": {
          "msiEndpoint":  "http://169.254.169.254/metadata/identity/oauth2/token",
          "msiClientId":  "c7373ae5-91c2-4165-8ab6-7381d6e75619"
        }      
     }

Implantar em uma VM

# Start the deployment
az vm extension set --name "KeyVaultForWindows" `
 --publisher Microsoft.Azure.KeyVault `
 --resource-group "<resourcegroup>" `
 --vm-name "<vmName>" `
 --settings "@settings.json"

Implantar em uma instância de Conjuntos de Dimensionamento de Máquinas Virtuais

# Start the deployment
az vmss extension set --name "KeyVaultForWindows" `
 --publisher Microsoft.Azure.KeyVault `
 --resource-group "<resourcegroup>" `
 --vmss-name "<vmssName>" `
 --settings "@settings.json"

Solucionar problemas

Aqui estão algumas sugestões de como solucionar problemas de implantação.

Confira as perguntas frequentes

Há um limite para o número de certificados observados?

Não. A extensão da VM do Key Vault não limita o número de certificados observados (observedCertificates).

Qual é a permissão padrão quando nenhuma conta é especificada?

Por padrão, os Administradores e SISTEMA recebem Controle Total.

Como você determina se uma chave de certificado é CAPI1 ou CNG?

A extensão depende do comportamento padrão da API PFXImportCertStore. Por padrão, se um certificado tiver um atributo Nome do Provedor que corresponda a CAPI1, o certificado será importado usando APIs CAPI1. Caso contrário, o certificado será importado usando APIs CNG.

A extensão dá suporte à reassociação automática de certificado?

Sim, a extensão de VM do Azure Key Vault dá suporte à reassociação automática de certificado. A extensão de VM Key Vault dá suporte à associação de canal S na renovação do certificado quando a propriedade linkOnRenewal é definida como true.

Para o IIS, você pode configurar a reassociação automática habilitando a reassociação automática de renovações de certificado no IIS. A extensão de VM do Azure Key Vault gera notificações de ciclo de vida do certificado quando um certificado com uma SAN correspondente é instalado. O IIS usa esse evento para reassociar automaticamente o certificado. Para obter mais informações, consulte Reassociação de certificado no IIS

Exibir o status da extensão

Verifique o status de sua implantação de extensão no portal do Azure ou usando o PowerShell ou a CLI do Azure.

Para exibir o estado de implantação de extensões para uma determinada VM, execute os seguintes comandos.

  • Azure PowerShell:

    Get-AzVMExtension -ResourceGroupName <myResourceGroup> -VMName <myVM> -Name <myExtensionName>

  • CLI do Azure:

    az vm get-instance-view --resource-group <myResourceGroup> --name <myVM> --query "instanceView.extensions"

Examinar logs e configuração

Os logs de extensão da VM do Key Vault existem apenas localmente na VM. Examine os detalhes do log para ajudar na solução de problemas.

Arquivo de log Descrição
C:\WindowsAzure\Logs\WaAppAgent.log` Mostra quando ocorrem atualizações na extensão.
C:\WindowsAzure\Logs\Plugins\Microsoft.Azure.KeyVault.KeyVaultForWindows<versão mais recente>\ Mostra o status do download do certificado. O local de download é sempre um armazenamento MY do computador Windows (certlm.msc).
C:\Packages\Plugins\Microsoft.Azure.KeyVault.KeyVaultForWindows<versão mais recente>\RuntimeSettings\ Os logs de serviço da Extensão de VM do Key Vault mostram o status do serviço akvvm_service.
C:\Packages\Plugins\Microsoft.Azure.KeyVault.KeyVaultForWindows<versão mais recente>\Status\ A configuração e os binários do serviço de Extensão da VM do Key Vault.

Obter suporte

Aqui estão algumas outras opções para ajudá-lo a resolver problemas de implantação: