このページでは、Cloud Key Management Service API の Cloud クライアント ライブラリの使い方について説明します。Cloud APIs 用のクライアント ライブラリの詳細については、クライアント ライブラリの説明をご覧ください。
クライアント ライブラリのインストール
C#
詳細については、C# 開発環境の設定をご覧ください。
PowerShell または Visual Studio Package Manager Console を使用する場合:
Install-Package "Google.Cloud.Kms.V1" -Version "2.0.0-beta03"
dotnet CLI を使用する場合:
dotnet add package "Google.Cloud.Kms.V1" -Version "2.0.0-beta03"
Go
詳細については、Go 開発環境の設定をご覧ください。
go get "cloud.google.com/go/kms/apiv1"
Java
詳細については、Java 開発環境の設定をご覧ください。
Maven を使用している場合は、次のものを pom.xml
ファイルに追加します。BOM の詳細については、Google Cloud Platform ライブラリ BOM をご覧ください。
Gradle を使用している場合は、次のものを依存関係に追加します。
sbt を使用している場合は、次のものを依存関係に追加します。
Visual Studio Code、IntelliJ または Eclipse を使用している場合は、次の IDE プラグインでプロジェクトにクライアント ライブラリを追加できます。
プラグインでは、サービス アカウントのキー管理などの追加機能も提供されます。詳細は各プラグインのドキュメントをご覧ください。
Node.js
詳細については、Node.js 開発環境の設定をご覧ください。
npm install --save "@google-cloud/kms"
PHP
詳細については、Google Cloud での PHP の使用をご覧ください。
composer require "google/cloud-kms"
Python
詳細については、Python 開発環境の設定をご覧ください。
pip install --upgrade "google-cloud-kms"
Ruby
詳細については、Ruby 開発環境の設定をご覧ください。
gem install "google-cloud-kms"
認証の設定
クライアント ライブラリを実行するには、まず認証を設定する必要があります。これを行う 1 つの方法は、次のようにサービス アカウントを作成して環境変数を設定することです。その他の認証方法については、サービス アカウントとして認証するをご覧ください。
Console
サービス アカウントを作成します。
-
コンソールで [サービス アカウントの作成] ページに移動します。
[サービス アカウントの作成] に移動 - プロジェクトを選択します。
-
[サービス アカウント名] フィールドに名前を入力します。この名前に基づいて [サービス アカウント ID] フィールドに値が入力されます。
[サービス アカウントの説明] フィールドに説明を入力します。例:
Service account for quickstart
- [作成して続行] をクリックします。
-
プロジェクトへのアクセス権限を付与するには、サービス アカウントに次のロールを付与します。[プロジェクト] > [オーナー]
[ロールを選択] リストでロールを選択します。
ロールを追加するには、[
別のロールを追加] をクリックして各ロールを追加します。 - [続行] をクリックします。
-
[完了] をクリックして、サービス アカウントの作成を完了します。
ブラウザ ウィンドウは閉じないでください。次のステップでこれを使用します。
サービス アカウント キーを作成します。
- コンソールで、作成したサービス アカウントのメールアドレスをクリックします。
- [キー] をクリックします。
- [鍵を追加]、[新しい鍵を作成] の順にクリックします。
- [作成] をクリックします。JSON キーファイルがパソコンにダウンロードされます。
- [閉じる] をクリックします。
gcloud
認証を設定します。
-
サービス アカウントを作成します。
gcloud iam service-accounts create NAME
NAME
をサービス アカウントの名前に置き換えます。 -
サービス アカウントにロールを付与します。次の IAM ロールごとに次のコマンドを 1 回実行します。
roles/owner
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
次のように置き換えます。
SERVICE_ACCOUNT_NAME
: サービス アカウントの名前PROJECT_ID
: サービス アカウントを作成したプロジェクト IDROLE
: 付与するロール
-
鍵ファイルを生成します。
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
次のように置き換えます。
FILE_NAME
: 鍵ファイルの名前SERVICE_ACCOUNT_NAME
: サービス アカウントの名前PROJECT_ID
: サービス アカウントを作成したプロジェクト ID
環境変数 GOOGLE_APPLICATION_CREDENTIALS
を設定して、アプリケーション コードに認証情報を指定します。この変数は、現在のシェル セッションにのみ適用されます。この変数を新しいシェル セッションに適用する場合は、シェル起動ファイル(~/.bashrc
ファイルや ~/.profile
ファイルなど)で変数を設定します。
Linux または macOS
export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
KEY_PATH
をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。
例:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
Windows
PowerShell の場合:
$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
KEY_PATH
をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。
例:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
コマンド プロンプトの場合:
set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH
KEY_PATH
をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。
クライアント ライブラリの使用
次の例は、クライアント ライブラリの使用方法を示しています。
C#
Cloud KMS 用のクライアント ライブラリをインストールして使用する方法については、Cloud KMS クライアント ライブラリをご覧ください。 詳細については、Cloud KMS C# API のリファレンス ドキュメントをご覧ください。
Go
Cloud KMS 用のクライアント ライブラリをインストールして使用する方法については、Cloud KMS クライアント ライブラリをご覧ください。 詳細については、Cloud KMS Go API のリファレンス ドキュメントをご覧ください。
Java
Cloud KMS 用のクライアント ライブラリをインストールして使用する方法については、Cloud KMS クライアント ライブラリをご覧ください。 詳細については、Cloud KMS Java API のリファレンス ドキュメントをご覧ください。
Node.js
Cloud KMS 用のクライアント ライブラリをインストールして使用する方法については、Cloud KMS クライアント ライブラリをご覧ください。 詳細については、Cloud KMS Node.js API のリファレンス ドキュメントをご覧ください。
PHP
Cloud KMS 用のクライアント ライブラリをインストールして使用する方法については、Cloud KMS クライアント ライブラリをご覧ください。 詳細については、Cloud KMS PHP API のリファレンス ドキュメントをご覧ください。
Python
Cloud KMS 用のクライアント ライブラリをインストールして使用する方法については、Cloud KMS クライアント ライブラリをご覧ください。 詳細については、Cloud KMS Python API のリファレンス ドキュメントをご覧ください。
Ruby
Cloud KMS 用のクライアント ライブラリをインストールして使用する方法については、Cloud KMS クライアント ライブラリをご覧ください。 詳細については、Cloud KMS Ruby API のリファレンス ドキュメントをご覧ください。
次のステップ
プログラムによるデータの暗号化と復号の方法を学習します。