身份验证入门

本主题介绍了如何快速向 Google Cloud API 进行身份验证，以便进行测试。本主题不涉及如何向非 Google Cloud API（例如 Google Maps Platform API）进行身份验证。如需了解 Google Maps Platform API 和 SDK 的 API 密钥，请参阅 Google 地图文档。

在继续操作之前，我们建议所有 Google Cloud 开发者首先阅读身份验证概览主题，以便了解身份验证在 Google Cloud 中的工作原理，包括常见的场景和策略。此外，在将应用部署到生产环境之前，请确保您已阅读以服务帐号身份进行身份验证。

注意：如果您的应用在本地或其他云服务商上运行，您可以使用工作负载身份联合向外部身份授予访问权限，而无需使用服务帐号密钥。某些客户端库可以使用应用默认凭据 (ADC) 自动为外部身份生成凭据。

如需了解详情，请参阅您的身份提供商的文档：

• 自动生成 Amazon Web Services (AWS) 凭据
• 自动生成 Microsoft Azure 凭据
• 为支持 OpenID Connect (OIDC) 的身份提供商自动生成凭据

创建服务帐号

Cloud Console

创建服务帐号：

1. 在 Cloud Console 中，转到创建服务帐号页面。

   转到“创建服务帐号”
2. 选择一个项目。

3. 在服务帐号名称字段中，输入一个名称。 Cloud Console 会根据此名称填充服务帐号 ID 字段。

   在服务帐号说明字段中，输入说明。例如，Service account for quickstart。

4. 点击创建并继续。

5. 点击选择角色字段。

   在快速访问下，点击基本，然后点击所有者。

   注意：角色字段会影响您的服务帐号可以访问项目中的哪些资源。您可以撤消这些角色或稍后授予其他角色。在生产环境中，请勿授予 Owner、Editor 或 Viewer 角色。如需了解详情，请参阅授予、更改和撤消对资源的访问权限。
6. 点击继续。

7. 点击完成以完成服务帐号的创建过程。

   不要关闭浏览器窗口。您将在下一步骤中用到它。

创建服务帐号密钥：

1. 在 Cloud Console 中，点击您创建的服务帐号的电子邮件地址。
2. 点击密钥。
3. 依次点击添加密钥和创建新密钥。
4. 点击创建。JSON 密钥文件将下载到您的计算机上。
5. 点击关闭。

命令行

您可以使用本地机器上的 Cloud SDK 或在 Cloud Shell 中运行以下命令。

1. 创建服务帐号。将 NAME 替换为服务帐号的名称。

   gcloud iam service-accounts create NAME

2. 向服务帐号授予权限。将 PROJECT_ID 替换为您的项目 ID。

   gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/owner"

   注意：--role 标志会影响您的服务帐号可以访问项目中的哪些资源。您可以撤消这些角色或稍后授予其他角色。在生产环境中，请勿授予 Owner、Editor 或 Viewer 角色。如需了解详情，请参阅授予、更改和撤消对资源的访问权限。

3. 生成密钥文件。将 FILE_NAME 替换为密钥文件的名称。

   gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com

设置环境变量

如需将服务帐号与 Cloud SDK 结合使用，您需要设置代码运行的环境变量。

通过设置环境变量 GOOGLE_APPLICATION_CREDENTIALS 向应用代码提供身份验证凭据。 此变量仅适用于当前的 Shell 会话，因此，如果您打开新的会话，请重新设置该变量。

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 文件的路径。

通过设置环境变量，您可以独立于应用单独提供凭据，而无需在部署时更改应用代码。或者，您可以在代码中明确指定指向服务帐号密钥文件的路径。如需了解详情，请参阅以服务帐号身份进行身份验证。

核实身份验证

设置环境变量后，使用 Google Cloud 客户端库时，您无需在代码中明确指定您的凭据。客户端库可隐式确定您的凭据。因此，您可以先设置环境变量，然后运行客户端库代码（如下例所示），从而核实身份验证是否有效。如果请求成功，则身份验证有效。

注意：必须安装 Cloud Storage 客户端库才能运行以下示例。

C#

在 GitHub 上查看

public object AuthImplicit(string projectId)
{
    // If you don't specify credentials when constructing the client, the
    // client library will look for credentials in the environment.
    var credential = GoogleCredential.GetApplicationDefault();
    var storage = StorageClient.Create(credential);
    // Make an authenticated API request.
    var buckets = storage.ListBuckets(projectId);
    foreach (var bucket in buckets)
    {
        Console.WriteLine(bucket.Name);
    }
    return null;
}

Go

在 GitHub 上查看

// implicit uses Application Default Credentials to authenticate.
func implicit() {
	ctx := context.Background()

	// For API packages whose import path is starting with "cloud.google.com/go",
	// such as cloud.google.com/go/storage in this case, if there are no credentials
	// provided, the client library will look for credentials in the environment.
	storageClient, err := storage.NewClient(ctx)
	if err != nil {
		log.Fatal(err)
	}
	defer storageClient.Close()

	it := storageClient.Buckets(ctx, "project-id")
	for {
		bucketAttrs, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			log.Fatal(err)
		}
		fmt.Println(bucketAttrs.Name)
	}

	// For packages whose import path is starting with "google.golang.org/api",
	// such as google.golang.org/api/cloudkms/v1, use NewService to create the client.
	kmsService, err := cloudkms.NewService(ctx)
	if err != nil {
		log.Fatal(err)
	}

	_ = kmsService
}

Java

在 GitHub 上查看

static void authImplicit() {
  // If you don't specify credentials when constructing the client, the client library will
  // look for credentials via the environment variable GOOGLE_APPLICATION_CREDENTIALS.
  Storage storage = StorageOptions.getDefaultInstance().getService();

  System.out.println("Buckets:");
  Page<Bucket> buckets = storage.list();
  for (Bucket bucket : buckets.iterateAll()) {
    System.out.println(bucket.toString());
  }
}

Node.js

在 GitHub 上查看

// Imports the Google Cloud client library.
const {Storage} = require('@google-cloud/storage');

// Instantiates a client. If you don't specify credentials when constructing
// the client, the client library will look for credentials in the
// environment.
const storage = new Storage();
// Makes an authenticated API request.
async function listBuckets() {
  try {
    const results = await storage.getBuckets();

    const [buckets] = results;

    console.log('Buckets:');
    buckets.forEach(bucket => {
      console.log(bucket.name);
    });
  } catch (err) {
    console.error('ERROR:', err);
  }
}
listBuckets();

PHP

在 GitHub 上查看

// Imports the Cloud Storage client library.
use Google\Cloud\Storage\StorageClient;

/**
 * Authenticate to a cloud client library using a service account implicitly.
 *
 * @param string $projectId The Google project ID.
 */
function auth_cloud_implicit($projectId)
{
    $config = [
        'projectId' => $projectId,
    ];

    # If you don't specify credentials when constructing the client, the
    # client library will look for credentials in the environment.
    $storage = new StorageClient($config);

    # Make an authenticated API request (listing storage buckets)
    foreach ($storage->buckets() as $bucket) {
        printf('Bucket: %s' . PHP_EOL, $bucket->name());
    }
}

Python

在 GitHub 上查看

def implicit():
    from google.cloud import storage

    # If you don't specify credentials when constructing the client, the
    # client library will look for credentials in the environment.
    storage_client = storage.Client()

    # Make an authenticated API request
    buckets = list(storage_client.list_buckets())
    print(buckets)

Ruby

在 GitHub 上查看

# project_id = "Your Google Cloud project ID"

require "google/cloud/storage"

# If you don't specify credentials when constructing the client, the client
# library will look for credentials in the environment.
storage = Google::Cloud::Storage.new project: project_id

# Make an authenticated API request
storage.buckets.each do |bucket|
  puts bucket.name
end

后续步骤

• 了解如何向 Google Cloud API 验证身份
• 了解如何以最终用户身份进行身份验证
• 了解如何以服务帐号身份进行身份验证
• 了解如何使用 API 密钥

亲自尝试

如果您是 Google Cloud 新手，请创建一个帐号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金，用于运行、测试和部署工作负载。

免费开始使用