JavaScript 用 Azure Key Vault 証明書クライアントライブラリ - バージョン 4.9.0

[アーティクル]
10/17/2024

Azure Key Vault は、クラウドアプリケーション全体で使用される証明書の安全なストレージと自動管理を提供するクラウドサービスです。 Azure Key Vault には、複数の証明書と同じ証明書の複数のバージョンを保持できます。コンテナー内の各証明書には、証明書の発行と有効期間を制御するポリシーと、有効期限が近い証明書として実行されるアクションが関連付けられています。

Azure Key Vault の詳細については、「Azure Key Vault とは」を参照してください。

Node.js アプリケーションで Azure Key Vault 証明書のクライアントライブラリを使用して、次の目的で使用します。

証明書を取得、設定、および削除します。
証明書、その属性、発行者、ポリシー、操作、連絡先を更新します。
証明書をバックアップして復元します。
削除された証明書を取得、消去、または回復します。
証明書のすべてのバージョンを取得します。
すべての証明書を取得します。
削除されたすべての証明書を取得します。

注: このパッケージは、Azure Key Vault サービスの制限によりブラウザーで使用できません。ガイダンスについては、このドキュメント参照してください。

主要なリンク:

はじめ

現在サポートされている環境

Node.js の LTS バージョンをする

前提条件

Azure サブスクリプション
既存の Azure Key Vault。キーコンテナーを作成する必要がある場合は、このドキュメントのの手順に従って、Azure Portal 行うことができます。または、次の手順従って Azure CLI を使用します。

パッケージをインストールする

npm を使用して Azure Key Vault 証明書クライアントライブラリをインストールする

npm install @azure/keyvault-certificates

ID ライブラリをインストールする

Key Vault クライアントは、Azure ID ライブラリを使用して認証します。 npm を使用してインストールする

npm install @azure/identity

TypeScript の構成

TypeScript ユーザーには、Node 型の定義がインストールされている必要があります。

npm install @types/node

また、tsconfig.jsonで compilerOptions.allowSyntheticDefaultImports を有効にする必要があります。 compilerOptions.esModuleInteropを有効にした場合、allowSyntheticDefaultImports は既定で有効になっています。詳細については、TypeScript のコンパイラオプションハンドブックのを参照してください。

Azure Active Directory での認証

Key Vault サービスは、Azure Active Directory を使用して API への要求を認証します。 @azure/identity パッケージには、アプリケーションでこれを行うために使用できるさまざまな資格情報の種類が用意されています。用の README には、作業を開始するための詳細とサンプルが用意されています。

Azure Key Vault サービスと対話するには、CertificateClient クラスのインスタンス、コンテナーの URL、資格情報オブジェクトを作成する必要があります。このドキュメントに示す例では、DefaultAzureCredentialという名前の資格情報オブジェクトを使用します。これは、ローカルの開発環境や運用環境など、ほとんどのシナリオに適しています。さらに、運用環境での認証には、マネージド ID を使用することをお勧めします。

認証のさまざまな方法とそれに対応する資格情報の種類の詳細については、Azure ID のドキュメントを参照してください。

簡単な例を次に示します。まず、DefaultAzureCredential と CertificateClientをインポートします。

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

これらをインポートしたら、次に Key Vault サービスに接続できます。

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

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

// Lastly, create our certificates client and connect to the service
const client = new CertificateClient(url, credential);

主な概念

証明書クライアント は、JavaScript アプリケーションから Azure Key Vault API の証明書に関連する API メソッドと対話するための主要なインターフェイスです。初期化されると、証明書の作成、読み取り、更新、削除に使用できる基本的な一連のメソッドが提供されます。
証明書のバージョン は、Key Vault 内の証明書のバージョンです。ユーザーが一意の証明書名に値を割り当てるたびに、その証明書の新しい バージョン が作成されます。名前で証明書を取得すると、クエリに特定のバージョンが指定されていない限り、常に割り当てられた最新の値が返されます。
論理的な削除、Key Vault では削除と削除を 2 つの個別の手順としてサポートできるため、削除された証明書はすぐに失われるわけではありません。これは、Key Vault で論理的な削除が有効場合にのみ発生します。
証明書バックアップ は、作成された任意の証明書から生成できます。これらのバックアップはバイナリデータとして提供され、以前に削除された証明書の再生成にのみ使用できます。

Azure Key Vault サービス API バージョンの指定

既定では、このパッケージでは、7.1されている最新の Azure Key Vault サービスバージョンが使用されます。サポートされている他のバージョンは 7.0だけです。次に示すように、クライアントコンストラクターで serviceVersion オプションを設定することで、使用されているサービスのバージョンを変更できます。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

// Change the Azure Key Vault service API version being used via the `serviceVersion` option
const client = new CertificateClient(url, credential, {
  serviceVersion: "7.0",
});

例

次のセクションでは、Azure Key Vault 証明書を使用する一般的なタスクの一部を説明するコードスニペットを示します。ここで説明するシナリオは、次のもので構成されます。

証明書の作成と設定を行います。
Key Vault 証明書を取得します。
証明書の完全な情報を取得します。
PEM 形式で証明書を。
すべての証明書を一覧表示します。
証明書を更新します。
証明書を削除します。
証明書の一覧を反復処理します。

証明書の作成と設定

beginCreateCertificate は、Azure Key Vault に格納する証明書を作成します。同じ名前の証明書が既に存在する場合は、新しいバージョンの証明書が作成されます。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

async function main() {
  // Note: Sending `Self` as the `issuerName` of the certificate's policy will create a self-signed certificate.
  await client.beginCreateCertificate(certificateName, {
    issuerName: "Self",
    subject: "cn=MyCert",
  });
}

main();

証明書の名前とポリシーに加えて、省略可能な値を持つ 3 番目の引数に次のプロパティを渡すこともできます。

enabled: 証明書を使用できるかどうかを決定するブール値。
tags: 証明書の検索とフィルター処理に使用できるキー値のセット。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

// Note: Sending `Self` as the `issuerName` of the certificate's policy will create a self-signed certificate.
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert",
};
const enabled = true;
const tags = {
  myCustomTag: "myCustomTagsValue",
};

async function main() {
  await client.beginCreateCertificate(certificateName, certificatePolicy, {
    enabled,
    tags,
  });
}

main();

同じ名前の beginCreateCertificate を呼び出すと、同じ証明書の新しいバージョンが作成され、最新の属性が提供されます。

証明書が完全に作成されるまでに時間がかかるため、beginCreateCertificate は、次のガイドラインに従って基になる実行時間の長い操作を追跡するポーリングオブジェクトを返 https://azure.github.io/azure-sdk/typescript_design.html#ts-lro

受信したポーラーを使用すると、poller.getResult()を呼び出して作成された証明書を取得できます。また、証明書が作成されるまで個々のサービス呼び出しを実行するか、プロセスが完了するまで待機することで、削除が完了するまで待機することもできます。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert",
};

async function main() {
  const poller = await client.beginCreateCertificate(certificateName, certificatePolicy);

  // You can use the pending certificate immediately:
  const pendingCertificate = poller.getResult();

  // Or you can wait until the certificate finishes being signed:
  const keyVaultCertificate = await poller.pollUntilDone();
  console.log(keyVaultCertificate);
}

main();

証明書が署名されるまで待機するもう 1 つの方法は、次のように個々の呼び出しを行うことです。

const { DefaultAzureCredential } = require("@azure/identity");
const { CertificateClient } = require("@azure/keyvault-certificates");
const { delay } = require("@azure/core-util");

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert",
};

async function main() {
  const poller = await client.beginCreateCertificate(certificateName, certificatePolicy);

  while (!poller.isDone()) {
    await poller.poll();
    await delay(5000);
  }

  console.log(`The certificate ${certificateName} is fully created`);
}

main();

Key Vault 証明書の取得

コンテナーから証明書を読み取り返す最も簡単な方法は、名前で証明書を取得することです。 getCertificate は、証明書のポリシーと共に、証明書の最新バージョンを取得します。必要に応じて、バージョンを指定した場合に getCertificateVersion を呼び出すことによって、別のバージョンの証明書を取得できます。 getCertificateVersion は証明書のポリシーを返しません。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

async function main() {
  const latestCertificate = await client.getCertificate(certificateName);
  console.log(`Latest version of the certificate ${certificateName}: `, latestCertificate);
  const specificCertificate = await client.getCertificateVersion(
    certificateName,
    latestCertificate.properties.version
  );
  console.log(
    `The certificate ${certificateName} at the version ${latestCertificate.properties.version}: `,
    specificCertificate
  );
}

main();

証明書の完全な情報の取得

Azure Key Vault の設計では、キー、シークレット、証明書が区別されます。 Key Vault サービスの証明書機能は、キーとシークレットの機能を使用して設計されています。 Key Vault 証明書の構成を評価してみましょう。

Key Vault 証明書が作成されると、アドレス指定可能なキーとシークレットも同じ名前で作成されます。 Key Vault キーを使用すると、キー操作が可能になり、Key Vault シークレットを使用して証明書の値をシークレットとして取得できます。 Key Vault 証明書には、公開 x509 証明書メタデータも含まれています。ソース: 証明書の構成。

秘密キーが Key Vault シークレットに格納されており、公開証明書が含まれていることを知っている場合は、Key Vault シークレットクライアントを使用して取得できます。

// Using the same credential object we used before,
// and the same keyVaultUrl,
// let's create a SecretClient
import { SecretClient } from "@azure/keyvault-secrets";

const secretClient = new SecretClient(keyVaultUrl, credential);

// Assuming you've already created a Key Vault certificate,
// and that certificateName contains the name of your certificate
const certificateSecret = await secretClient.getSecret(certificateName);

// Here we can find both the private key and the public certificate, in PKCS 12 format:
const PKCS12Certificate = certificateSecret.value!;

// You can write this into a file:
fs.writeFileSync("myCertificate.p12", PKCS12Certificate);

既定では、証明書のコンテンツタイプは PKCS 12 であることに注意してください。証明書のコンテンツタイプを指定することで、PEM 形式で取得できます。 PEM 証明書を作成する方法を示す前に、まず PKCS 12 証明書から PEM 秘密鍵を取得する方法を見てみましょう。

opensslを使用すると、次のコマンドを使用して PEM 形式でパブリック証明書を取得できます。

openssl pkcs12 -in myCertificate.p12 -out myCertificate.crt.pem -clcerts -nokeys

次のように、openssl を使用して秘密キーを取得することもできます。

openssl pkcs12 -in myCertificate.p12 -out myCertificate.key.pem -nocerts -nodes

どちらの場合も、openssl によって証明書の作成に使用されるパスワードの入力が求められる点に注意してください。これまでに使用したサンプルコードではパスワードが指定されていないため、各コマンドの末尾に -passin 'pass:' を追加できます。

PEM 形式の証明書

PEM 形式の証明書を操作する場合は、証明書を作成する時点で contentType プロパティを指定して、PEM 形式で証明書を作成および管理するように Azure の Key Vault サービスに指示できます。

次の例は、証明書とシークレットの Key Vault クライアントを使用して、PEM 形式の証明書のパブリック部分とプライベート部分を作成および取得する方法を示しています。

// Creating the certificate
const certificateName = "MyCertificate";
const createPoller = await client.beginCreateCertificate(certificateName, {
  issuerName: "Self",
  subject: "cn=MyCert",
  contentType: "application/x-pem-file", // Here you specify you want to work with PEM certificates.
});
const keyVaultCertificate = await createPoller.pollUntilDone();

// Getting the PEM formatted private key and public certificate:
const certificateSecret = await secretClient.getSecret(certificateName);
const PEMPair = certificateSecret.value!;

console.log(PEMPair);

公開証明書は、秘密キーと同じコンテンツ BLOB に含まれる点に注意してください。 PEM ヘッダーを使用して、それに応じて抽出できます。

すべての証明書を一覧表示する

listPropertiesOfCertificates キーコンテナー内のすべての証明書が一覧表示されます。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

async function main() {
  for await (let certificateProperties of client.listPropertiesOfCertificates()) {
    console.log("Certificate properties: ", certificateProperties);
  }
}

main();

証明書の更新

証明書属性は、次のように、updateCertificateを使用して既存の証明書バージョンに更新できます。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

async function main() {
  const result = await client.getCertificate(certificateName);
  await client.updateCertificateProperties(certificateName, result.properties.version, {
    enabled: false,
    tags: {
      myCustomTag: "myCustomTagsValue",
    },
  });
}

main();

証明書のポリシーは、次のように updateCertificatePolicyで個別に更新することもできます。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

async function main() {
  const result = client.getCertificate(certificateName);
  // Note: Sending `Self` as the `issuerName` of the certificate's policy will create a self-signed certificate.
  await client.updateCertificatePolicy(certificateName, {
    issuerName: "Self",
    subject: "cn=MyCert",
  });
}

main();

証明書の削除

beginDeleteCertificate メソッドは、削除する証明書を設定します。このプロセスは、必要なリソースが利用可能になるとすぐにバックグラウンドで発生します。

Key Vault 論理的な削除が有効になっている場合、この操作では、証明書に 削除された 証明書としてのみラベル付けされます。削除された証明書は更新できません。読み取り、回復、または消去のみが可能です。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

async function main() {
  const poller = await client.beginDeleteCertificate(certificateName);

  // You can use the deleted certificate immediately:
  const deletedCertificate = poller.getResult();

  // The certificate is being deleted. Only wait for it if you want to restore it or purge it.
  await poller.pollUntilDone();

  // You can also get the deleted certificate this way:
  await client.getDeletedCertificate(certificateName);

  // Deleted certificates can also be recovered or purged.

  // recoverDeletedCertificate returns a poller, just like beginDeleteCertificate.
  // const recoverPoller = await client.beginRecoverDeletedCertificate(certificateName);
  // await recoverPoller.pollUntilDone();

  // If a certificate is done and the Key Vault has soft-delete enabled, the certificate can be purged with:
  await client.purgeDeletedCertificate(certificateName);
}

main();

証明書の削除はすぐには行われないため、削除された証明書を読み取り、回復、または消去できるようになる前に、beginDeleteCertificate メソッドが呼び出されてからしばらく時間が必要になります。

証明書の一覧の反復処理

CertificateClient を使用すると、証明書コンテナー内のすべての証明書、および削除されたすべての証明書と特定の証明書のバージョンを取得して反復処理できます。次の API メソッドを使用できます。

listPropertiesOfCertificates は、削除されていないすべての証明書を最新バージョンの名前で一覧表示します。
listDeletedCertificates は、削除されたすべての証明書を最新バージョンの名前で一覧表示します。
listPropertiesOfCertificateVersions は、証明書名に基づいて証明書のすべてのバージョンを一覧表示します。

次のように使用できます。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

async function main() {
  for await (let certificateProperties of client.listPropertiesOfCertificates()) {
    console.log("Certificate properties: ", certificateProperties);
  }
  for await (let deletedCertificate of client.listDeletedCertificates()) {
    console.log("Deleted certificate: ", deletedCertificate);
  }
  for await (let certificateProperties of client.listPropertiesOfCertificateVersions(
    certificateName
  )) {
    console.log("Certificate properties: ", certificateProperties);
  }
}

main();

これらのメソッドはすべて、使用可能なすべての結果 一度に 返されます。ページごとに取得するには、次のように、使用する API メソッドを呼び出した直後に .byPage() を追加します。

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

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

async function main() {
  for await (let page of client.listPropertiesOfCertificates().byPage()) {
    for (let certificateProperties of page) {
      console.log("Certificate properties: ", certificateProperties);
    }
  }
  for await (let page of client.listDeletedCertificates().byPage()) {
    for (let deletedCertificate of page) {
      console.log("Deleted certificate: ", deletedCertificate);
    }
  }
  for await (let page of client.listPropertiesOfCertificateVersions(certificateName).byPage()) {
    for (let certificateProperties of page) {
      console.log("Properties of certificate: ", certificateProperties);
    }
  }
}

main();

トラブルシューティング

ログ記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、AZURE_LOG_LEVEL 環境変数を infoに設定します。または、@azure/loggerで setLogLevel を呼び出すことによって、実行時にログを有効にすることもできます。

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

さまざまな障害シナリオを診断する方法の詳細については、トラブルシューティングガイドのを参照してください。

次の手順

その他のコードサンプルについては、次のリンクを参照してください。

貢献

このライブラリに投稿する場合は、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。

インプレッション

次の方法で共有

JavaScript 用 Azure Key Vault 証明書クライアントライブラリ - バージョン 4.9.0

はじめ

現在サポートされている環境

前提条件

パッケージをインストールする

ID ライブラリをインストールする

TypeScript の構成

Azure Active Directory での認証

主な概念

Azure Key Vault サービス API バージョンの指定

例

証明書の作成と設定

Key Vault 証明書の取得

証明書の完全な情報の取得

PEM 形式の証明書

すべての証明書を一覧表示する

証明書の更新

証明書の削除

証明書の一覧の反復処理

トラブルシューティング

次の手順

貢献

その他のリソース

次の方法で共有

JavaScript 用 Azure Key Vault 証明書クライアント ライブラリ - バージョン 4.9.0

はじめ

現在サポートされている環境

前提 条件

パッケージをインストールする

ID ライブラリをインストールする

TypeScript の構成

Azure Active Directory での認証

主な概念

Azure Key Vault サービス API バージョンの指定

例

証明書の作成と設定

Key Vault 証明書の取得

証明書の完全な情報の取得

PEM 形式の証明書

すべての証明書を一覧表示する

証明書の更新

証明書の削除

証明書の一覧の反復処理

トラブルシューティング

次の手順

貢献

その他のリソース

JavaScript 用 Azure Key Vault 証明書クライアントライブラリ - バージョン 4.9.0

前提条件