Introdução aos segredos do Azure Key Vault em JavaScript

  • Artigo

Este artigo mostra como se conectar ao Azure Key Vault usando a biblioteca de cliente de segredos do Azure Key Vault para JavaScript. Uma vez conectado, seu código pode operar em segredos e propriedades secretas no cofre.

Pacote de referência | da API (npm) | Exemplos de | código-fonte | da biblioteca Dar feedback

Pré-requisitos

Configure o seu projeto

  1. Abra um prompt de comando e mude para a pasta do projeto. Altere YOUR-DIRECTORY para o nome da pasta:

    cd YOUR-DIRECTORY

  2. Se você ainda não tiver um package.json arquivo em seu diretório, inicialize o projeto para criar o arquivo:

    npm init -y

  3. Instale a biblioteca de cliente de segredos do Azure Key Vault para JavaScript:

    npm install @azure/keyvault-secrets

  4. Se você quiser usar conexões sem senha usando a ID do Microsoft Entra, instale a biblioteca de cliente do Azure Identity para JavaScript:

    npm install @azure/identity

Autorize o acesso e conecte-se ao Cofre da Chave

O Microsoft Entra ID fornece a conexão mais segura gerenciando a identidade da conexão (identidade gerenciada). Esta funcionalidade sem palavra-passe permite-lhe desenvolver uma aplicação que não requer quaisquer segredos (chaves ou cadeias de ligação) armazenados no código.

Antes de autenticar programaticamente no Azure para usar os segredos do Cofre da Chave do Azure, certifique-se de configurar seu ambiente.

Diagram of Azure SDK for JavaScript credential flow.

Um desenvolvedor deve instalar a CLI do Azure e entrar interativamente com o comando az login para fazer logon no Azure antes de usar o código DefaultAzureCredential.

az login

Compilar a aplicação

À medida que você cria seu aplicativo, seu código interage com dois tipos de recursos:

  • KeyVaultSecret, que inclui:
    • Nome secreto, um valor de cadeia de caracteres.
    • Valor secreto, que é uma cadeia do segredo. Você fornece a serialização e a desserialização do valor secreto para dentro e para fora de uma cadeia de caracteres, conforme necessário.
    • Propriedades secretas.
  • SecretProperties, que incluem os metadados do segredo, como nome, versão, tags, dados de expiração e se ele está habilitado.

Se você precisar do valor de KeyVaultSecret, use métodos que retornem o KeyVaultSecret:

O restante dos métodos retorna o objeto SecretProperties ou outra forma das propriedades, como:

Criar um objeto SecretClient

O objeto SecretClient é o objeto superior no SDK. Este cliente permite-lhe manipular os segredos.

Depois que as funções de acesso do Azure Key Vault e seu ambiente local estiverem configurados, crie um arquivo JavaScript, que inclui o pacote @azure/identity . Crie uma credencial, como DefaultAzureCredential, para implementar conexões sem senha ao seu cofre. Use essa credencial para autenticar com um objeto SecretClient .

// Include required dependencies
import { DefaultAzureCredential } from '@azure/identity';  
import { SecretClient } from '@azure/keyvault-secrets';  

// Authenticate to Azure
const credential = new DefaultAzureCredential(); 

// Create SecretClient
const vaultName = '<your-vault-name>';  
const url = `https://${vaultName}.vault.azure.net`;  
const client = new SecretClient(url, credential);  

// Get secret
const secret = await client.getSecret("MySecretName");

Consulte também

Próximos passos