Mulai cepat: Pustaka klien rahasia Azure Key Vault untuk JavaScript

Artikel
11/02/2024

Mulai menggunakan pustaka klien rahasia Azure Key Vault untuk JavaScript. Azure Key Vault adalah layanan awan yang menyediakan penyimpanan aman untuk rahasia. Anda dapat menyimpan kunci, kata sandi, sertifikat, dan rahasia lainnya dengan aman. Brankas kunci Azure dapat dibuat dan dikelola melalui portal Microsoft Azure. Dalam mulai cepat ini, Anda mempelajari cara membuat, mengambil, dan menghapus rahasia dari brankas kunci Azure menggunakan pustaka klien JavaScript.

Sumber daya pustaka klien Key Vault:

Dokumentasi referensi API | Kode sumber pustaka | Paket (npm)

Untuk informasi selengkapnya tentang Key Vault dan rahasia, lihat:

Prasyarat

Langganan Azure - membuat secara gratis.
Node.js LTS saat ini.
Azure CLI

Prasyarat

Langganan Azure - membuat secara gratis.
Node.js LTS saat ini.
TypeScript 5+
Azure CLI.

Mulai cepat ini mengasumsikan Anda menjalankan Azure CLI.

Jalankan perintah login.
```
az login
```
Jika CLI dapat membuka browser default Anda, CLI akan melakukannya dan memuat halaman masuk Azure.

Jika tidak, buka halaman browser di https://aka.ms/devicelogin dan masukkan kode otorisasi yang ditampilkan di terminal Anda.
Masuk menggunakan kredensial akun Anda di browser.

Gunakan perintah az group create untuk membuat grup sumber daya:
```
az group create --name myResourceGroup --location eastus
```
Anda dapat mengubah "eastus" ke lokasi yang lebih dekat dengan Anda, jika Anda mau.
Gunakan az keyvault create untuk membuat brankas kunci:
```
az keyvault create --name <your-unique-keyvault-name> --resource-group myResourceGroup
```
Ganti <your-unique-keyvault-name> dengan nama yang unik di seluruh Azure. Anda biasanya menggunakan nama pribadi atau perusahaan bersama dengan nomor dan pengidentifikasi lain.

Gunakan perintah New-AzResourceGroup untuk membuat grup sumber daya:
```
New-AzResourceGroup -Name myResourceGroup -Location eastus
```
Anda dapat mengubah "eastus" ke lokasi yang lebih dekat dengan Anda, jika Anda mau.
Gunakan New-AzKeyVault untuk membuat brankas kunci:
```
New-AzKeyVault -Name <your-unique-keyvault-name> -ResourceGroupName myResourceGroup -Location eastus
```
Ganti <your-unique-keyvault-name> dengan nama yang unik di seluruh Azure. Anda biasanya menggunakan nama pribadi atau perusahaan bersama dengan nomor dan pengidentifikasi lain.

Memberikan akses ke brankas kunci Anda

Untuk mendapatkan izin ke brankas kunci Anda melalui Kontrol Akses Berbasis Peran (RBAC), tetapkan peran ke "Nama Prinsipal Pengguna" (UPN) Anda menggunakan perintah Azure CLI az role assignment create.

az role assignment create --role "Key Vault Secrets Officer" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"

Ganti <upn>, <subscription-id>, <resource-group-name> , dan <your-unique-keyvault-name> dengan nilai aktual Anda. UPN Anda biasanya akan dalam format alamat email (misalnya, username@domain.com).

Membuat aplikasi Node.js baru

Buat aplikasi Node.js yang menggunakan brankas kunci Anda.

Di terminal, buat folder bernama key-vault-node-app dan ubah ke folder itu:
```
mkdir key-vault-node-app && cd key-vault-node-app
```
Buat proyek Node.js baru:
```
npm init -y
```

Instal paket Key Vault

Menggunakan terminal, instal pustaka klien rahasia Azure Key Vault, @azure/keyvault-secrets untuk Node.js.
```
npm install @azure/keyvault-secrets
```
Instal pustaka klien Azure Identity, @azure/paket identitas untuk mengautentikasi ke Key Vault.
```
npm install @azure/identity
```

Memberikan akses ke brankas kunci Anda

az role assignment create --role "Key Vault Secrets Officer" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"

Ganti <upn>, <subscription-id>, <resource-group-name> , dan <your-unique-keyvault-name> dengan nilai aktual Anda. UPN Anda biasanya akan dalam format alamat email (misalnya, username@domain.com).

Atur variabel lingkungan

Aplikasi ini menggunakan titik akhir brankas kunci sebagai variabel lingkungan yang disebut KEY_VAULT_URL.

set KEY_VAULT_URL=<your-key-vault-endpoint>

Windows PowerShell

$Env:KEY_VAULT_URL="<your-key-vault-endpoint>"

export KEY_VAULT_URL=<your-key-vault-endpoint>

Mengautentikasi dan membuat klien

Permintaan aplikasi ke sebagian besar layanan Azure harus diotorisasi. Menggunakan metode DefaultAzureCredential yang disediakan oleh pustaka klien Azure Identity adalah pendekatan yang direkomendasikan untuk menerapkan koneksi tanpa kata sandi ke layanan Azure dalam kode Anda. DefaultAzureCredential mendukung beberapa metode autentikasi dan menentukan metode autentikasi yang harus digunakan saat runtime bahasa umum. Pendekatan ini memungkinkan aplikasi Anda menggunakan metode autentikasi yang berbeda di lingkungan yang berbeda (lokal vs. produksi) tanpa menerapkan kode spesifik per lingkungan.

Dalam mulai cepat ini, DefaultAzureCredential autentikasi ke brankas kunci menggunakan kredensial pengguna pengembangan lokal yang masuk ke Azure CLI. Saat aplikasi disebarkan ke Azure, kode yang sama DefaultAzureCredential dapat secara otomatis menemukan dan menggunakan identitas terkelola yang ditetapkan ke App Service, Komputer Virtual, atau layanan lainnya. Untuk informasi selengkapnya, lihat Gambaran Umum Identitas Terkelola.

Dalam kode ini, titik akhir brankas kunci Anda digunakan untuk membuat klien brankas kunci. Format titik akhir terlihat seperti https://<your-key-vault-name>.vault.azure.net tetapi dapat berubah untuk sovereign cloud. Untuk informasi selengkapnya tentang mengautentikasi ke brankas kunci, lihat Panduan Pengembang.

Contoh kode

Sampel kode di bawah ini akan memperlihatkan cara membuat klien, mengatur rahasia, menampilkan rahasia, dan menghapus rahasia.

Kode ini menggunakan kelas dan metode Rahasia Key Vault berikut:

Menyiapkan kerangka kerja aplikasi

Buat file teks baru dan tempel kode berikut ke file index.js.

const { SecretClient } = require("@azure/keyvault-secrets");
const { DefaultAzureCredential } = require("@azure/identity");

async function main() {
  // If you're using MSI, DefaultAzureCredential should "just work".
  // Otherwise, DefaultAzureCredential expects the following three environment variables:
  // - AZURE_TENANT_ID: The tenant ID in Azure Active Directory
  // - AZURE_CLIENT_ID: The application (client) ID registered in the AAD tenant
  // - AZURE_CLIENT_SECRET: The client secret for the registered application
  const credential = new DefaultAzureCredential();

  const keyVaultUrl = process.env["KEY_VAULT_URL"];
  if(!keyVaultUrl) throw new Error("KEY_VAULT_URL is empty");

  const client = new SecretClient(keyVaultUrl, credential);

  // Create a secret
  // The secret can be a string of any kind. For example,
  // a multiline text block such as an RSA private key with newline characters,
  // or a stringified JSON object, like `JSON.stringify({ mySecret: 'MySecretValue'})`.
  const uniqueString = new Date().getTime();
  const secretName = `secret${uniqueString}`;
  const result = await client.setSecret(secretName, "MySecretValue");
  console.log("result: ", result);

  // Read the secret we created
  const secret = await client.getSecret(secretName);
  console.log("secret: ", secret);

  // Update the secret with different attributes
  const updatedSecret = await client.updateSecretProperties(secretName, result.properties.version, {
    enabled: false
  });
  console.log("updated secret: ", updatedSecret);

  // Delete the secret immediately without ability to restore or purge.
  await client.beginDeleteSecret(secretName);
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Jalankan aplikasi sampel

Jalankan aplikasi:
```
node index.js
```

Metode buat dan dapatkan menghasilkan objek JSON lengkap untuk rahasia:

{
    "value": "MySecretValue",
    "name": "secret1637692472606",
    "properties": {
        "createdOn": "2021-11-23T18:34:33.000Z",
        "updatedOn": "2021-11-23T18:34:33.000Z",
        "enabled": true,
        "recoverableDays": 90,
        "recoveryLevel": "Recoverable+Purgeable",
        "id": "https: //YOUR-KEYVAULT-ENDPOINT.vault.azure.net/secrets/secret1637692472606/YOUR-VERSION",
        "vaultUrl": "https: //YOUR-KEYVAULT-ENDPOINT.vault.azure.net",
        "version": "YOUR-VERSION",
        "name": "secret1637692472606"
    }
}

Metode pembaruan menghasilkan pasangan nama/nilai properti:

"createdOn": "2021-11-23T18:34:33.000Z",
"updatedOn": "2021-11-23T18:34:33.000Z",
"enabled": true,
"recoverableDays": 90,
"recoveryLevel": "Recoverable+Purgeable",
"id": "https: //YOUR-KEYVAULT-ENDPOINT/secrets/secret1637692472606/YOUR-VERSION",
"vaultUrl": "https: //YOUR-KEYVAULT-ENDPOINT",
"version": "YOUR-VERSION",
"name": "secret1637692472606"

Buat file teks baru dan tempelkan kode berikut ke dalam file index.ts .

import {
  SecretClient,
  KeyVaultSecret,
  SecretProperties,
} from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";
import "dotenv/config";

// Passwordless credential
const credential = new DefaultAzureCredential();

// Get Key Vault name from environment variables
// such as `https://${keyVaultName}.vault.azure.net`
const keyVaultUrl = process.env.KEY_VAULT_URL;
if (!keyVaultUrl) throw new Error("KEY_VAULT_URL is empty");

function printSecret(secret: KeyVaultSecret): void {
  const { name, value, properties } = secret;
  const { enabled, expiresOn, createdOn } = properties;
  console.log("Secret: ", { name, value, enabled, expiresOn, createdOn });
}
function printSecretProperties(secret: SecretProperties): void {
  const { name, enabled, expiresOn, createdOn } = secret;
  console.log("Secret: ", { name, enabled, expiresOn, createdOn });
}

async function main(): Promise<void> {
  // Create a new SecretClient
  const client = new SecretClient(keyVaultUrl, credential);

  // Create a unique secret name
  const uniqueString = new Date().getTime().toString();
  const secretName = `secret${uniqueString}`;

  // Create a secret
  const createSecretResult = await client.setSecret(
    secretName,
    "MySecretValue"
  );
  printSecret(createSecretResult);

  // Get the secret by name
  const getSecretResult = await client.getSecret(secretName);
  printSecret(getSecretResult);

  // Update properties
  const updatedSecret = await client.updateSecretProperties(
    secretName,
    getSecretResult.properties.version,
    {
      enabled: false,
    }
  );
  printSecretProperties(updatedSecret);

  // Delete secret (without immediate purge)
  const deletePoller = await client.beginDeleteSecret(secretName);
  await deletePoller.pollUntilDone();
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Jalankan aplikasi sampel

Buat aplikasi TypeScript:
```
tsc
```
Jalankan aplikasi:
```
node index.js
```

Metode buat dan dapatkan menghasilkan objek JSON lengkap untuk rahasia:

{
    "value": "MySecretValue",
    "name": "secret1637692472606",
    "properties": {
        "createdOn": "2021-11-23T18:34:33.000Z",
        "updatedOn": "2021-11-23T18:34:33.000Z",
        "enabled": true,
        "recoverableDays": 90,
        "recoveryLevel": "Recoverable+Purgeable",
        "id": "https: //YOUR-KEYVAULT-ENDPOINT.vault.azure.net/secrets/secret1637692472606/YOUR-VERSION",
        "vaultUrl": "https: //YOUR-KEYVAULT-ENDPOINT.vault.azure.net",
        "version": "YOUR-VERSION",
        "name": "secret1637692472606"
    }
}

Metode pembaruan menghasilkan pasangan nama/nilai properti:

"createdOn": "2021-11-23T18:34:33.000Z",
"updatedOn": "2021-11-23T18:34:33.000Z",
"enabled": true,
"recoverableDays": 90,
"recoveryLevel": "Recoverable+Purgeable",
"id": "https: //YOUR-KEYVAULT-ENDPOINT/secrets/secret1637692472606/YOUR-VERSION",
"vaultUrl": "https: //YOUR-KEYVAULT-ENDPOINT",
"version": "YOUR-VERSION",
"name": "secret1637692472606"

Mengintegrasikan dengan App Configuration

SDK Azure menyediakan metode pembantu, parseKeyVaultSecretIdentifier, untuk mengurai ID Rahasia Key Vault yang diberikan. Ini diperlukan jika Anda menggunakan referensi App Configuration ke Key Vault. App Configuration menyimpan ID Rahasia Key Vault. Anda memerlukan metode parseKeyVaultSecretIdentifier untuk menguraikan ID tersebut agar mendapatkan nama rahasia. Setelah mendapatkan nama rahasia, Anda dapat memperoleh nilai rahasia saat ini menggunakan kode dari mulai cepat ini.

Langkah berikutnya

Dalam mulai cepat ini, Anda akan membuat brankas kunci, menyimpan rahasia, dan menampilkan rahasia tersebut. Untuk mempelajari selengkapnya tentang Key Vault dan cara mengintegrasikannya dengan aplikasi Anda, lihat artikel di bawah ini.

Baca Gambaran Umum Azure Key Vault
Baca Gambaran Umum Rahasia Azure Key Vault
Cara Mengamankan akses ke brankas kunci
Lihat Panduan pengembang Azure Key Vault
Tinjau Ringkasan keamanan Azure Key Vault

Bagikan melalui

Mulai cepat: Pustaka klien rahasia Azure Key Vault untuk JavaScript

Prasyarat

Prasyarat

Buat grup sumber daya dan brankas kunci

Memberikan akses ke brankas kunci Anda

Membuat aplikasi Node.js baru

Instal paket Key Vault

Memberikan akses ke brankas kunci Anda

Atur variabel lingkungan

Mengautentikasi dan membuat klien

Contoh kode

Menyiapkan kerangka kerja aplikasi

Jalankan aplikasi sampel

Jalankan aplikasi sampel

Mengintegrasikan dengan App Configuration

Langkah berikutnya

Saran dan Komentar

Sumber Daya Tambahan:

Bagikan melalui

Mulai cepat: Pustaka klien rahasia Azure Key Vault untuk JavaScript

Prasyarat

Prasyarat

Masuk ke Azure

Buat grup sumber daya dan brankas kunci

Memberikan akses ke brankas kunci Anda

Membuat aplikasi Node.js baru

Instal paket Key Vault

Memberikan akses ke brankas kunci Anda

Atur variabel lingkungan

Mengautentikasi dan membuat klien

Contoh kode

Menyiapkan kerangka kerja aplikasi

Jalankan aplikasi sampel

Jalankan aplikasi sampel

Mengintegrasikan dengan App Configuration

Langkah berikutnya

Saran dan Komentar

Sumber Daya Tambahan: