빠른 시작: JavaScript용 Azure Key Vault 키 클라이언트 라이브러리

• Azure 구독 - 체험 구독 만들기
• 현재 Node.js LTS.
• Azure CLI
• 기존 Key Vault - 다음을 사용하여 만들 수 있습니다.
  • Azure CLI
  • Azure Portal
  • Azure PowerShell

• Azure 구독 - 체험 구독 만들기
• 현재 Node.js LTS.
• TypeScript 5 이상
• Azure CLI
• 기존 Key Vault - 다음을 사용하여 만들 수 있습니다.
  • Azure CLI
  • Azure Portal
  • Azure PowerShell

• 새 텍스트 파일을 만들고 index.js 파일에 다음 코드를 붙여넣습니다.

  const { KeyClient } = require("@azure/keyvault-keys");
  const { DefaultAzureCredential } = require("@azure/identity");
  
  async function main() {
  
      // 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 KeyClient(keyVaultUrl, credential);
  
      const uniqueString = Date.now();
      const keyName = `sample-key-${uniqueString}`;
      const ecKeyName = `sample-ec-key-${uniqueString}`;
      const rsaKeyName = `sample-rsa-key-${uniqueString}`;
  
      // Create key using the general method
      const result = await client.createKey(keyName, "EC");
      console.log("key: ", result);
  
      // Create key using specialized key creation methods
      const ecResult = await client.createEcKey(ecKeyName, { curve: "P-256" });
      const rsaResult = await client.createRsaKey(rsaKeyName, { keySize: 2048 });
      console.log("Elliptic curve key: ", ecResult);
      console.log("RSA Key: ", rsaResult);
  
      // Get a specific key
      const key = await client.getKey(keyName);
      console.log("key: ", key);
  
      // Or list the keys we have
      for await (const keyProperties of client.listPropertiesOfKeys()) {
      const key = await client.getKey(keyProperties.name);
      console.log("key: ", key);
      }
  
      // Update the key
      const updatedKey = await client.updateKeyProperties(keyName, result.properties.version, {
      enabled: false
      });
      console.log("updated key: ", updatedKey);
  
      // Delete the key - the key is soft-deleted but not yet purged
      const deletePoller = await client.beginDeleteKey(keyName);
      await deletePoller.pollUntilDone();
  
      const deletedKey = await client.getDeletedKey(keyName);
      console.log("deleted key: ", deletedKey);
  
      // Purge the key - the key is permanently deleted
      // This operation could take some time to complete
      console.time("purge a single key");
      await client.purgeDeletedKey(keyName);
      console.timeEnd("purge a single key");
  }
  
  main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
  });
  

샘플 애플리케이션 실행

1. 앱을 실행합니다.

   node index.js
   

2. create 및 get 메서드는 키에 대한 전체 JSON 개체를 반환합니다.

   "key":  {
     "key": {
       "kid": "https://YOUR-KEY-VAULT-ENDPOINT/keys/YOUR-KEY-NAME/YOUR-KEY-VERSION",
       "kty": "YOUR-KEY-TYPE",
       "keyOps": [ ARRAY-OF-VALID-OPERATIONS ],
       ... other properties based on key type
     },
     "id": "https://YOUR-KEY-VAULT-ENDPOINT/keys/YOUR-KEY-NAME/YOUR-KEY-VERSION",
     "name": "YOUR-KEY-NAME",
     "keyOperations": [ ARRAY-OF-VALID-OPERATIONS ],
     "keyType": "YOUR-KEY-TYPE",
     "properties": {
       "tags": undefined,
       "enabled": true,
       "notBefore": undefined,
       "expiresOn": undefined,
       "createdOn": 2021-11-29T18:29:11.000Z,
       "updatedOn": 2021-11-29T18:29:11.000Z,
       "recoverableDays": 90,
       "recoveryLevel": "Recoverable+Purgeable",
       "exportable": undefined,
       "releasePolicy": undefined,
       "vaultUrl": "https://YOUR-KEY-VAULT-ENDPOINT",
       "version": "YOUR-KEY-VERSION",
       "name": "YOUR-KEY-VAULT-NAME",
       "managed": undefined,
       "id": "https://YOUR-KEY-VAULT-ENDPOINT/keys/YOUR-KEY-NAME/YOUR-KEY-VERSION"
     }
   }
   

• 새 텍스트 파일을 만들고 다음 코드를 index.ts 파일에 붙여넣습니다.

  import {
    KeyClient,
    KeyVaultKey,
    KeyProperties,
    DeletedKey,
  } from "@azure/keyvault-keys";
  import { DefaultAzureCredential } from "@azure/identity";
  import "dotenv/config";
  
  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 printKey(keyVaultKey: KeyVaultKey): void {
    const { name, key, id, keyType, keyOperations, properties } = keyVaultKey;
    console.log("Key: ", { name, key, id, keyType });
  
    const { vaultUrl, version, enabled, expiresOn }: KeyProperties = properties;
    console.log("Key Properties: ", { vaultUrl, version, enabled, expiresOn });
  
    console.log("Key Operations: ", keyOperations.join(", "));
  }
  
  async function main(): Promise<void> {
    // Create a new KeyClient
    const client = new KeyClient(keyVaultUrl, credential);
  
    // Create unique key names
    const uniqueString = Date.now().toString();
    const keyName = `sample-key-${uniqueString}`;
    const ecKeyName = `sample-ec-key-${uniqueString}`;
    const rsaKeyName = `sample-rsa-key-${uniqueString}`;
  
    // Create a EC key
    const ecKey = await client.createKey(keyName, "EC");
    printKey(ecKey);
  
    // Elliptic curve key
    const ec256Key = await client.createEcKey(ecKeyName, {
      curve: "P-256",
    });
    printKey(ec256Key);
  
    // RSA key
    const rsa2048Key = await client.createRsaKey(rsaKeyName, {
      keySize: 2048,
    });
    printKey(rsa2048Key);
  
    // Get a key
    const key = await client.getKey(keyName);
    printKey(key);
  
    // Get properties of all keys
    for await (const keyProperties of client.listPropertiesOfKeys()) {
      const iteratedKey = await client.getKey(keyProperties.name);
      printKey(iteratedKey);
    }
  
    // Update key properties - disable key
    const updatedKey = await client.updateKeyProperties(
      keyName,
      ecKey.properties.version,
      {
        enabled: false,
      }
    );
    printKey(updatedKey);
  
    // Delete key (without immediate purge)
    const deletePoller = await client.beginDeleteKey(keyName);
    await deletePoller.pollUntilDone();
  
    // Get a deleted key
    const deletedKey = await client.getDeletedKey(keyName);
    console.log("deleted key: ", deletedKey.name);
  
    // Purge a deleted key
    console.time("purge a single key");
    await client.purgeDeletedKey(keyName);
    console.timeEnd("purge a single key");
  }
  
  main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
  });
  

샘플 애플리케이션 실행

1. TypeScript 앱 빌드:

   tsc
   

2. 앱을 실행합니다.

   node index.js
   

3. create 및 get 메서드는 키에 대한 전체 JSON 개체를 반환합니다.

   "key":  {
     "key": {
       "kid": "https://YOUR-KEY-VAULT-ENDPOINT/keys/YOUR-KEY-NAME/YOUR-KEY-VERSION",
       "kty": "YOUR-KEY-TYPE",
       "keyOps": [ ARRAY-OF-VALID-OPERATIONS ],
       ... other properties based on key type
     },
     "id": "https://YOUR-KEY-VAULT-ENDPOINT/keys/YOUR-KEY-NAME/YOUR-KEY-VERSION",
     "name": "YOUR-KEY-NAME",
     "keyOperations": [ ARRAY-OF-VALID-OPERATIONS ],
     "keyType": "YOUR-KEY-TYPE",
     "properties": {
       "tags": undefined,
       "enabled": true,
       "notBefore": undefined,
       "expiresOn": undefined,
       "createdOn": 2021-11-29T18:29:11.000Z,
       "updatedOn": 2021-11-29T18:29:11.000Z,
       "recoverableDays": 90,
       "recoveryLevel": "Recoverable+Purgeable",
       "exportable": undefined,
       "releasePolicy": undefined,
       "vaultUrl": "https://YOUR-KEY-VAULT-ENDPOINT",
       "version": "YOUR-KEY-VERSION",
       "name": "YOUR-KEY-VAULT-NAME",
       "managed": undefined,
       "id": "https://YOUR-KEY-VAULT-ENDPOINT/keys/YOUR-KEY-NAME/YOUR-KEY-VERSION"
     }
   }