本页面介绍如何开始使用 Cloud Key Management Service API 的 Cloud 客户端库。请在客户端库说明中详细了解 Cloud API 的客户端库。
安装客户端库
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"
设置身份验证
要运行客户端库,您必须先设置身份验证。完成此操作的一种方法是创建服务帐号并设置环境变量,如以下步骤所示。如需了解其他身份验证的方法,请参阅以服务帐号身份进行身份验证。
控制台
创建服务帐号:
-
在 Cloud Console 中,转到创建服务帐号页面。
转到“创建服务帐号” - 选择您的项目。
-
在服务帐号名称字段中,输入一个名称。Cloud Console 会根据此名称填充服务帐号 ID 字段。
在服务帐号说明字段中,输入说明。例如,
Service account for quickstart
。 - 点击创建并继续。
-
如需提供对项目的访问权限,请向服务帐号授予以下角色:Project > Owner。
在选择角色列表中,选择一个角色。
如需添加其他角色,请点击
添加其他角色,然后添加其他各个角色。 - 点击继续。
-
点击完成以完成服务帐号的创建过程。
不要关闭浏览器窗口。您将在下一步骤中用到它。
创建服务帐号密钥:
- 在 Cloud Console 中,点击您创建的服务帐号的电子邮件地址。
- 点击密钥。
- 点击添加密钥,然后点击创建新密钥。
- 点击创建。JSON 密钥文件将下载到您的计算机上。
- 点击关闭。
gcloud
设置身份验证:
-
创建服务帐号。将 NAME 替换为服务帐号的名称:
gcloud iam service-accounts create NAME
-
向服务帐号授予角色。对以下每个 IAM 角色运行以下命令一次:
roles/owner
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
替换以下内容:
- NAME:服务帐号的名称
- PROJECT_ID:您在其中创建服务帐号的项目的 ID
- ROLE:要授予的角色
-
生成密钥文件:
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com
替换以下内容:
- FILE_NAME:密钥文件的名称
- NAME:服务帐号的名称
- PROJECT_ID:您在其中创建服务帐号的项目的 ID
通过设置环境变量 GOOGLE_APPLICATION_CREDENTIALS
向应用代码提供身份验证凭据。此变量仅适用于当前的 Shell 会话。如果您希望变量应用于未来的 Shell 会话,请在 shell 启动文件中设置变量,例如在 ~/.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 参考文档。
后续步骤
了解如何以编程方式加密和解密数据。