クイックスタート: Java 用 Azure Key Vault 証明書クライアントライブラリ (証明書)

[アーティクル]
08/08/2024

Java 用 Azure Key Vault 証明書クライアントライブラリを使ってみます。以下の手順に従ってパッケージをインストールし、基本タスクのコード例を試してみましょう。

ヒント

Spring アプリケーションで Azure Key Vault の証明書リソースを操作している場合は、Spring Cloud Azure を代替手段として検討することをお勧めします。 Spring Cloud Azure は、Spring と Azure サービスのシームレスな統合を実現するオープンソースプロジェクトです。 Spring Cloud Azure の詳細と、Key Vault 証明書の使用例については、「Azure Key Vault 証明書を使用して Spring Boot で HTTPS を有効にする」を参照してください。

その他のリソース:

前提条件

Azure サブスクリプション - 無料アカウントを作成します。
Java Development Kit (JDK) バージョン 8 以降
Apache Maven
Azure CLI

このクイックスタートは、Linux ターミナルウィンドウで Azure CLI と Apache Maven を実行していることを前提としています。

設定

このクイックスタートでは、Azure CLI と Azure Identity ライブラリを使用して、Azure サービスに対するユーザーの認証を行います。開発者は、Visual Studio または Visual Studio Code を使用してその呼び出しを認証することもできます。詳細については、Azure Identity クライアントライブラリを使用してクライアントを認証する方法に関するページを参照してください。

login コマンドを実行します。
```
az login
```
CLI で既定のブラウザーを開くことができる場合、開いたブラウザに Azure サインインページが読み込まれます。

それ以外の場合は、 https://aka.ms/devicelogin でブラウザーページを開き、ターミナルに表示されている認証コードを入力します。
ブラウザーでアカウントの資格情報を使用してサインインします。

新しい Java コンソールアプリを作成する

コンソールウィンドウで、mvn コマンドを使用し、akv-certificates-java という名前で新しい Java コンソールアプリを作成します。

mvn archetype:generate -DgroupId=com.keyvault.certificates.quickstart
                       -DartifactId=akv-certificates-java
                       -DarchetypeArtifactId=maven-archetype-quickstart
                       -DarchetypeVersion=1.4
                       -DinteractiveMode=false

プロジェクトの生成からの出力は、次のようになります。

[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Archetype: maven-archetype-quickstart:1.4
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: com.keyvault.certificates.quickstart
[INFO] Parameter: artifactId, Value: akv-certificates-java
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.keyvault.certificates.quickstart
[INFO] Parameter: packageInPathFormat, Value: com/keyvault/quickstart
[INFO] Parameter: package, Value: com.keyvault.certificates.quickstart
[INFO] Parameter: groupId, Value: com.keyvault.certificates.quickstart
[INFO] Parameter: artifactId, Value: akv-certificates-java
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Project created from Archetype in dir: /home/user/quickstarts/akv-certificates-java
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  38.124 s
[INFO] Finished at: 2019-11-15T13:19:06-08:00
[INFO] ------------------------------------------------------------------------

新しく作成された akv-certificates-java/ フォルダーにディレクトリを変更します。

cd akv-certificates-java

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

テキストエディターで pom.xml ファイルを開きます。依存関係のグループに、次の dependency 要素を追加します。

    <dependency>
      <groupId>com.azure</groupId>
      <artifactId>azure-security-keyvault-certificates</artifactId>
      <version>4.1.3</version>
    </dependency>

    <dependency>
      <groupId>com.azure</groupId>
      <artifactId>azure-identity</artifactId>
      <version>1.2.0</version>
    </dependency>

リソースグループとキーコンテナーを作成する

このクイックスタートでは、事前作成済みの Azure Key Vault を使用します。キーコンテナーは、Azure CLI のクイックスタート、Azure PowerShell のクイックスタート、または Azure portal のクイックスタートの手順に従って作成できます。

別の方法として、これらの Azure CLI または Azure PowerShell コマンドを実行することもできます。

重要

各キーコンテナーには一意の名前が必要です。次の例では、<your-unique-keyvault-name> をお使いのキーコンテナーの名前に置き換えてください。

Azure CLI
Azure PowerShell

az group create --name "myResourceGroup" -l "EastUS"

az keyvault create --name "<your-unique-keyvault-name>" -g "myResourceGroup" --enable-rbac-authorization

New-AzResourceGroup -Name myResourceGroup -Location eastus

New-AzKeyVault -Name <your-unique-keyvault-name> -ResourceGroupName myResourceGroup -Location eastus

キーコンテナーへのアクセス許可を付与する

ロールベースのアクセス制御 (RBAC) を使用してキーコンテナーに対するアクセス許可を取得するには、Azure CLI コマンドの az role assignment create を使用して、"ユーザープリンシパル名" (UPN) にロールを割り当てます。

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

<upn>、<subscription-id>、<resource-group-name>、<your-unique-keyvault-name> は実際の値に置き換えます。 UPN は一般的に、メールアドレスの形式を取ります (例: username@domain.com)。

環境変数の設定

このアプリケーションでは、キーコンテナーの名前を、KEY_VAULT_NAME という環境変数として使用しています。

Windows

set KEY_VAULT_NAME=<your-key-vault-name>

Windows PowerShell

$Env:KEY_VAULT_NAME="<your-key-vault-name>"

macOS または Linux

export KEY_VAULT_NAME=<your-key-vault-name>

オブジェクトモデル

Java 用 Azure Key Vault 証明書クライアントライブラリを使用すると、証明書を管理できます。「コード例」セクションでは、クライアントの作成、証明書の作成、証明書の取得、および証明書の削除の方法を示しています。

コンソールアプリ全体は以下にあります。

コード例

ディレクティブの追加

コードの先頭に次のディレクティブを追加します。

import com.azure.core.util.polling.SyncPoller;
import com.azure.identity.DefaultAzureCredentialBuilder;

import com.azure.security.keyvault.certificates.CertificateClient;
import com.azure.security.keyvault.certificates.CertificateClientBuilder;
import com.azure.security.keyvault.certificates.models.CertificateOperation;
import com.azure.security.keyvault.certificates.models.CertificatePolicy;
import com.azure.security.keyvault.certificates.models.DeletedCertificate;
import com.azure.security.keyvault.certificates.models.KeyVaultCertificate;
import com.azure.security.keyvault.certificates.models.KeyVaultCertificateWithPolicy;

クライアントの認証と作成

ほとんどの Azure サービスに対するアプリケーション要求は、認可される必要があります。 DefaultAzureCredential を使うことは、コード内の Azure サービスへのパスワードレス接続を実装するための推奨される方法です。 DefaultAzureCredential は複数の認証方法をサポートしており、実行時に使用する方法が決定されます。このアプローチを採用すると、環境固有のコードを実装することなく、異なる環境 (ローカルと運用環境) で異なる認証方法をアプリに使用できます。

このクイックスタートでは、DefaultAzureCredential は Azure CLI にログインしたローカル開発ユーザーの資格情報を使って、キーコンテナーに対して認証されます。アプリケーションが Azure にデプロイされると、同じDefaultAzureCredential コードで、App Service、仮想マシン、またはその他のサービスに割り当てられているマネージド ID を自動的に検出して使用できます。詳細については、マネージド ID の概要に関するページを参照してください。

この例では、キーコンテナーの名前は、https://<your-key-vault-name>.vault.azure.net という形式で、キーコンテナーの URI に展開されます。キーコンテナーに対する認証の詳細については、開発者ガイドを参照してください。

String keyVaultName = System.getenv("KEY_VAULT_NAME");
String keyVaultUri = "https://" + keyVaultName + ".vault.azure.net";

CertificateClient certificateClient = new CertificateClientBuilder()
    .vaultUrl(keyVaultUri)
    .credential(new DefaultAzureCredentialBuilder().build())
    .buildClient();

シークレットを保存する

アプリケーションが認証されたら、certificateClient.beginCreateCertificate メソッドを使用して、キーコンテナーに証明書を作成できます。これには証明書の名前と証明書ポリシーが必要です。このサンプルでは、値 "myCertificate" を certificateName 変数に割り当てて、既定のポリシーを使用しています。

証明書の作成は実行時間の長い操作です。進行状況をポーリングすることも、操作が完了するまで待つこともできます。

SyncPoller<CertificateOperation, KeyVaultCertificateWithPolicy> certificatePoller =
    certificateClient.beginCreateCertificate(certificateName, CertificatePolicy.getDefault());
certificatePoller.waitForCompletion();

作成が完了したら、次の呼び出しを使用して証明書を取得できます。

KeyVaultCertificate createdCertificate = certificatePoller.getFinalResult();

証明書の取得

certificateClient.getCertificate メソッドを使用して、以前に作成した証明書を取得できるようになりました。

KeyVaultCertificate retrievedCertificate = certificateClient.getCertificate(certificateName);

これで、retrievedCertificate.getName、retrievedCertificate.getProperties などの操作を使用して、取得した証明書の詳細にアクセスできるようになりました。内容を取得するには、retrievedCertificate.getCer を使用します。

証明書の削除

最後に、certificateClient.beginDeleteCertificate メソッドを使用して、キーコンテナーから証明書を削除しましょう。これも実行時間の長い操作です。

SyncPoller<DeletedCertificate, Void> deletionPoller = certificateClient.beginDeleteCertificate(certificateName);
deletionPoller.waitForCompletion();

リソースをクリーンアップする

不要になったら、Azure CLI または Azure PowerShell を使用して、キーコンテナーとそれに対応するリソースグループを削除できます。

az group delete -g "myResourceGroup"

Remove-AzResourceGroup -Name "myResourceGroup"

サンプルコード

package com.keyvault.certificates.quickstart;

import com.azure.core.util.polling.SyncPoller;
import com.azure.identity.DefaultAzureCredentialBuilder;

import com.azure.security.keyvault.certificates.CertificateClient;
import com.azure.security.keyvault.certificates.CertificateClientBuilder;
import com.azure.security.keyvault.certificates.models.CertificateOperation;
import com.azure.security.keyvault.certificates.models.CertificatePolicy;
import com.azure.security.keyvault.certificates.models.DeletedCertificate;
import com.azure.security.keyvault.certificates.models.KeyVaultCertificate;
import com.azure.security.keyvault.certificates.models.KeyVaultCertificateWithPolicy;

public class App {
    public static void main(String[] args) throws InterruptedException, IllegalArgumentException {
        String keyVaultName = System.getenv("KEY_VAULT_NAME");
        String keyVaultUri = "https://" + keyVaultName + ".vault.azure.net";

        System.out.printf("key vault name = %s and kv uri = %s \n", keyVaultName, keyVaultUri);

        CertificateClient certificateClient = new CertificateClientBuilder()
            .vaultUrl(keyVaultUri)
            .credential(new DefaultAzureCredentialBuilder().build())
            .buildClient();

        String certificateName = "myCertificate";

        System.out.print("Creating a certificate in " + keyVaultName + " called '" + certificateName + " ... ");

        SyncPoller<CertificateOperation, KeyVaultCertificateWithPolicy> certificatePoller =
            certificateClient.beginCreateCertificate(certificateName, CertificatePolicy.getDefault());
        certificatePoller.waitForCompletion();

        System.out.print("done.");
        System.out.println("Retrieving certificate from " + keyVaultName + ".");

        KeyVaultCertificate retrievedCertificate = certificateClient.getCertificate(certificateName);

        System.out.println("Your certificate's ID is '" + retrievedCertificate.getId() + "'.");
        System.out.println("Deleting your certificate from " + keyVaultName + " ... ");

        SyncPoller<DeletedCertificate, Void> deletionPoller = certificateClient.beginDeleteCertificate(certificateName);
        deletionPoller.waitForCompletion();

        System.out.print("done.");
    }
}

次のステップ

このクイックスタートでは、キーコンテナーを作成し、証明書を作成しました。さらに証明書を取得した後、これを削除しました。 Key Vault およびアプリケーションとの統合方法の詳細については、引き続き以下の記事を参照してください。

次の方法で共有

クイックスタート: Java 用 Azure Key Vault 証明書クライアントライブラリ (証明書)

前提条件

設定

新しい Java コンソールアプリを作成する

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

リソースグループとキーコンテナーを作成する

キーコンテナーへのアクセス許可を付与する

環境変数の設定

オブジェクトモデル

コード例

ディレクティブの追加

クライアントの認証と作成

シークレットを保存する

証明書の取得

証明書の削除

リソースをクリーンアップする

サンプルコード

次のステップ

フィードバック

その他のリソース

次の方法で共有

クイックスタート: Java 用 Azure Key Vault 証明書クライアント ライブラリ (証明書)

前提条件

設定

Azure へのサインイン

新しい Java コンソール アプリを作成する

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

リソース グループとキー コンテナーを作成する

キー コンテナーへのアクセス許可を付与する

環境変数の設定

オブジェクト モデル

コード例

ディレクティブの追加

クライアントの認証と作成

シークレットを保存する

証明書の取得

証明書の削除

リソースをクリーンアップする

サンプル コード

次のステップ

フィードバック

その他のリソース

クイックスタート: Java 用 Azure Key Vault 証明書クライアントライブラリ (証明書)

新しい Java コンソールアプリを作成する

リソースグループとキーコンテナーを作成する

キーコンテナーへのアクセス許可を付与する

オブジェクトモデル

サンプルコード