サービスアカウントとして認証する

このトピックでは、アプリケーションをサービスアカウントとして認証する方法について説明します。一般的な認証シナリオや方法など、Google Cloud APIs への認証に関する一般的な情報については、認証の概要をご覧ください。サービスアカウントの詳細については、Identity and Access Management のドキュメントでサービスアカウントをご覧ください。

認証情報の自動検出

アプリケーションがデフォルトのサービスアカウントのある Google Cloud 環境内で実行されている場合、アプリケーションは Google Cloud APIs を呼び出すためにサービスアカウントの認証情報を取得できます。このような環境には、Compute Engine、Google Kubernetes Engine、App Engine、Cloud Run、Cloud Functions があります。これは、認証情報を手動で提供するよりも便利で安全なため、この方法をおすすめします。

また、アプリケーションには Google Cloud クライアントライブラリを使用することをおすすめします。Google Cloud クライアントライブラリでは、アプリケーションのデフォルト認証情報（ADC）というライブラリを使用して、サービスアカウントの認証情報を自動的に検索します。サービスアカウントの認証情報は次の順序で検索されます。

環境変数 GOOGLE_APPLICATION_CREDENTIALS が設定されている場合、ADC はその変数が参照しているサービスアカウントファイルを使用します。
環境変数 GOOGLE_APPLICATION_CREDENTIALS が設定されていない場合、ADC は Compute Engine、Google Kubernetes Engine、App Engine、Cloud Run、Cloud Functions によって提供されるデフォルトのサービスアカウントを使用します。
ADC が上記のどの認証情報も使用できない場合、エラーが発生します。

次のサンプルコードは、アプリケーションコードで ADC ライブラリを使用する方法を示しています。

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)
	}

	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;

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 環境以外でアプリケーションを実行する場合は、サービスアカウントを手動で作成する必要があります。その後、1 つ以上のサービスアカウントキーを作成します。これは、サービスアカウントに関連付けられた認証情報です。作成したサービスアカウントキーをアプリケーションに手動で渡します。

サービスアカウントの作成

サービスアカウントがない場合は、次の手順で作成します。

Cloud Console

Cloud Console で、[サービスアカウントキーの作成] ページに移動します。
[サービスアカウントキーの作成] ページに移動
[サービスアカウント] リストから [新しいサービスアカウント] を選択します。
[サービスアカウント名] フィールドに名前を入力します。
[ロール] リストで、[プロジェクト] > [オーナー] を選択します。

注: [ロール] フィールドの設定により、リソースにアクセスするサービスアカウントが承認されます。このフィールドは、Cloud Console を使用して後から表示および変更できます。本番環境アプリケーションを開発している場合は、[プロジェクト > オーナー] よりも詳細な権限を指定します。詳しくは、サービスアカウントへのロールの付与をご覧ください。
[作成] をクリックします。キーが含まれている JSON ファイルがパソコンにダウンロードされます。

コマンドライン

ローカルマシン上の Cloud SDK を使用するか、または Cloud Shell 内で以下のコマンドを実行できます。

サービスアカウントを作成します。[NAME] をサービスアカウントの名前に置き換えます。
```
gcloud iam service-accounts create [NAME]
```
サービスアカウントに権限を付与します。[PROJECT_ID] を実際のプロジェクト ID に置き換えます。
```
gcloud projects add-iam-policy-binding [PROJECT_ID] --member "serviceAccount:[NAME]@[PROJECT_ID].iam.gserviceaccount.com" --role "roles/owner"
```
注: [ロール] フィールドの設定により、リソースにアクセスするサービスアカウントが承認されます。このフィールドは、後で Cloud Console を使用して表示および変更できます。本番環境アプリケーションを開発している場合は、[プロジェクト] > [オーナー] よりも詳細な権限を指定します。詳しくはサービスアカウントへのロールの付与をご覧ください。

キーファイルを生成します。[FILE_NAME] はキーファイルの名前に置き換えてください。

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

環境変数を使用して認証情報を提供する

環境変数 GOOGLE_APPLICATION_CREDENTIALS を設定して、アプリケーションコードに認証情報を指定します。[PATH] は、サービスアカウントキーが含まれる JSON ファイルのファイルパスに置き換えます。この変数は現在のシェルセッションにのみ適用されるため、新しいセッションを開く場合は、変数を再度設定します。

Linux または macOS

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

例:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"

Windows

PowerShell を使用する場合:

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

例:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"

コマンドプロンプトを使用する場合:

set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

この手順を完了すると、上記のセクションで説明したように、認証情報が自動的に検出されます。必要なコードが少なく、さまざまな環境にコードを移植できるため、ADC の使用をおすすめします。

コードを使用して認証情報を提供する

次の例に示すように、サービスアカウントファイルを明示的に参照するコードを使用することもできます。以下のサンプルを実行するには、Cloud Storage クライアントライブラリをインストールする必要があります。

C#

GitHub で表示

        // Some APIs, like Storage, accept a credential in their Create()
        // method.
        public object AuthExplicit(string projectId, string jsonPath)
        {
            // Explicitly use service account credentials by specifying
            // the private key file.
            var credential = GoogleCredential.FromFile(jsonPath);
            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;
        }
        // Other APIs, like Language, accept a channel in their Create()
        // method.
        public object AuthExplicit(string projectId, string jsonPath)
        {
            LanguageServiceClientBuilder builder = new LanguageServiceClientBuilder
            {
                CredentialsPath = jsonPath
            };

            LanguageServiceClient client = builder.Build();
            AnalyzeSentiment(client);
            return 0;
        }

Go

GitHub で表示


// explicit reads credentials from the specified path.
func explicit(jsonPath, projectID string) {
	ctx := context.Background()
	client, err := storage.NewClient(ctx, option.WithCredentialsFile(jsonPath))
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Buckets:")
	it := client.Buckets(ctx, projectID)
	for {
		battrs, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			log.Fatal(err)
		}
		fmt.Println(battrs.Name)
	}
}

Java

GitHub で表示

static void authExplicit(String jsonPath) throws IOException {
  // You can specify a credential file by providing a path to GoogleCredentials.
  // Otherwise credentials are read from the GOOGLE_APPLICATION_CREDENTIALS environment variable.
  GoogleCredentials credentials = GoogleCredentials.fromStream(new FileInputStream(jsonPath))
        .createScoped(Lists.newArrayList("https://www.googleapis.com/auth/cloud-platform"));
  Storage storage = StorageOptions.newBuilder().setCredentials(credentials).build().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. Explicitly use service account credentials by
// specifying the private key file. All clients in google-cloud-node have this
// helper, see https://github.com/GoogleCloudPlatform/google-cloud-node/blob/master/docs/authentication.md
// const projectId = 'project-id'
// const keyFilename = '/path/to/keyfile.json'
const storage = new Storage({projectId, keyFilename});

// Makes an authenticated API request.
async function listBuckets() {
  try {
    const [buckets] = await storage.getBuckets();

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

PHP

GitHub で表示

namespace Google\Cloud\Samples\Auth;

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

function auth_cloud_explicit($projectId, $serviceAccountPath)
{
    # Explicitly use service account credentials by specifying the private key
    # file.
    $config = [
        'keyFilePath' => $serviceAccountPath,
        'projectId' => $projectId,
    ];
    $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 explicit():
    from google.cloud import storage

    # Explicitly use service account credentials by specifying the private key
    # file.
    storage_client = storage.Client.from_service_account_json(
        'service_account.json')

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

Ruby

GitHub で表示

# project_id = "Your Google Cloud project ID"
# key_file   = "path/to/service-account.json"
require "google/cloud/storage"

# Explicitly use service account credentials by specifying the private key
# file.
storage = Google::Cloud::Storage.new project: project_id, keyfile: key_file

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

認証情報を管理する際のベストプラクティス

機密データにアクセスするには、認証情報が必要です。次の方法で認証情報へのアクセスを保護します。

API キー、OAuth トークン、サービスアカウントキーなど、認証に関する重要な情報をソースコード内に組み込まないでください。代わりに、アプリケーションのソースコードの外部にある認証情報を指す環境変数を使用できます（Cloud Key Management Service など）。
テスト環境と本番環境のように、異なるコンテキストには異なる認証情報を使用してください。
認証情報が第三者に盗まれないように、認証情報の転送には必ず HTTPS などのセキュアチャネルを使用してください。クリアテキストや URL の一部として転送しないようご注意ください。
有効期間が長い認証情報をクライアント側アプリケーションに組み込まないでください。たとえば、モバイルアプリには、サービスアカウントキーを組み込まないでください。クライアント側アプリケーションを調べることは可能なため、認証情報が第三者によって簡単に見つけられて、使用されてしまう可能性があります。
不要になったトークンは無効にしてください。

API エラーのトラブルシューティング

API リクエストが失敗した場合のトラブルシューティング方法について詳しくは、Cloud APIs のエラーをご覧ください。

次のステップ

Google Cloud API に対する認証について学習する
エンドユーザーとして認証する方法を学習する
API キーの使用方法について学習する

サービス アカウントとして認証する

認証情報の自動検出

C#

Go

Java

Node.js

PHP

Python

Ruby

認証情報を手動で提供する

サービス アカウントの作成

Cloud Console

コマンドライン

環境変数を使用して認証情報を提供する

Linux または macOS

Windows

コードを使用して認証情報を提供する

C#

Go

Java

Node.js

PHP

Python

Ruby

認証情報を管理する際のベスト プラクティス

API エラーのトラブルシューティング

次のステップ

サービスアカウントとして認証する

サービスアカウントの作成

認証情報を管理する際のベストプラクティス