独自のプログラムを使用した V4 署名プロセス

このページでは、好みのプログラミング言語を使用して、独自のワークフローで Cloud Storage RSA 鍵署名付き URL を作成するための、V4 署名プロセスを実装するアルゴリズムについて説明します。署名付き URL は、Cloud Storage の特定のリソースに対する期限付きの読み取りまたは書き込みアクセスを提供します。署名付き URL は、その URL を所有する全員が、Google アカウントを持っているかどうかにかかわらず、URL がアクティブである限り使用できます。

Cloud Storage のツールを使用して、Cloud Storage RSA 鍵署名付き URL をより簡単に作成する方法については、Cloud Storage ツールを使用した V4 署名プロセスをご覧ください。署名付き URL について詳しくは、署名付き URL の概要をご覧ください。

前提条件

V4 署名プロセスを実装するプログラムを作成する前に、次の手順を行ってください。

  1. 新しい秘密鍵を生成するか、サービス アカウント用の既存の秘密鍵を準備します。鍵は、JSON 形式か PKCS12 形式のものを使用できます。

    秘密鍵とサービス アカウントについて詳しくは、サービス アカウントをご覧ください。

  2. 署名付き URL によるリクエストを実行できるように、サービス アカウントに十分な権限を付与してください。

    たとえば、署名付き URL を使用してユーザーがオブジェクトをダウンロードできるようにする場合、サービス アカウントにはオブジェクトに対する storage.objects.get 権限が必要です。

URL に署名するアルゴリズム

プログラムには次の手順が含まれている必要があります。

  1. 正規リクエストを文字列として作成します。正規リクエストにより、署名付き URL を使用するときにユーザーがリクエストに含める必要がある要素を定義します。

    必要な構成要素と形式について詳しくは、正規リクエストをご覧ください。

  2. 署名対象文字列を作成します。署名対象文字列は、署名を作成するための基礎であり、正規リクエストの 16 進エンコードされたハッシュ値が含まれます。

    署名対象文字列の形式の詳細については、署名をご覧ください。

  3. SHA-256 の RSA 署名を使用して署名対象文字列に署名します。この署名の結果がリクエストの署名になります。

    使用するプログラミング言語には、RSA 署名を実行するためのライブラリが提供されていなければなりません。または、有効期限が 12 時間以下の場合は、Google Cloud から提供される IAM signBlob メソッドを使用します。

  4. 次の文字列結合を使用して署名付き URL を作成します。

    HOSTNAME + PATH_TO_RESOURCE + "?" + CANONICAL_QUERY_STRING + "&X-Goog-Signature=" + REQUEST_SIGNATURE

    署名付き URL には次のコンポーネントが含まれます。

    • HOSTNAME: https://storage.googleapis.com です。

    • PATH_TO_RESOURCE: 正規リクエストの作成に使用した値と一致している必要があります。

    • CANONICAL_QUERY_STRING: 正規リクエストの作成に使用した値と一致している必要があります。

    • REQUEST_SIGNATURE: 前のステップで RSA 署名を使用して得られた出力です。

    完成した URL の例は次のとおりです。

    https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm=GOOG4-
    RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount.com
    %2F20181026%2Fus%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T211942Z&X-Goog
    -expires=3600&X-Goog-Signedheaders=host&X-Goog-Signature=2d2a6f5055eb004b8690b
    9479883292ae7450cdc15f17d7f99bc49b916f9e7429106ed7e5858ae6b4ab0bbbdb1a8ccc364d
    ad3a0da2caebd30887a70c5b2569d089ceb8afbde3eed4dff5086f0db5483998c175980991fe89
    9fbd2cd8cb813b00165e8d56e0a8aa7b3d7a12ee1baa8400611040f05b50a1a8eab5ba223fe137
    5747748de950ec7a4dc50f8382a6ffd4994ac42498d7daa703d9a414d4475154d0e7edaa92d4f2
    507d92c1f7e8efa7cab64df68b5df48575b9259d8d0bdb5dc752bdf07bd162d98ff2924f2e4a26
    fa6b3cede73ad5333c47d146a21c2ab2d97115986a12c68ff37346d6c2ca83e56b8ec8ad956327
    10b489b75c35697d781c38e

Python のサンプル プログラム

Cloud Storage クライアント ライブラリを使用して、多くの一般的なプログラミング言語の署名付き URL を作成できます。Cloud Storage ツールを使用した V4 署名プロセスでサンプルをご覧ください。

次の例では、Cloud Storage クライアント ライブラリを使用せずに、URL に署名するアルゴリズムを実装しています。この例では Python プログラミング言語を使用していますが、任意の言語に適用できます。

import binascii
import collections
import datetime
import hashlib
import sys

# pip install google-auth
from google.oauth2 import service_account
# pip install six
import six
from six.moves.urllib.parse import quote

def generate_signed_url(service_account_file, bucket_name, object_name,
                        subresource=None, expiration=604800, http_method='GET',
                        query_parameters=None, headers=None):

    if expiration > 604800:
        print('Expiration Time can\'t be longer than 604800 seconds (7 days).')
        sys.exit(1)

    escaped_object_name = quote(six.ensure_binary(object_name), safe=b'/~')
    canonical_uri = '/{}'.format(escaped_object_name)

    datetime_now = datetime.datetime.utcnow()
    request_timestamp = datetime_now.strftime('%Y%m%dT%H%M%SZ')
    datestamp = datetime_now.strftime('%Y%m%d')

    google_credentials = service_account.Credentials.from_service_account_file(
        service_account_file)
    client_email = google_credentials.service_account_email
    credential_scope = '{}/auto/storage/goog4_request'.format(datestamp)
    credential = '{}/{}'.format(client_email, credential_scope)

    if headers is None:
        headers = dict()
    host = '{}.storage.googleapis.com'.format(bucket_name)
    headers['host'] = host

    canonical_headers = ''
    ordered_headers = collections.OrderedDict(sorted(headers.items()))
    for k, v in ordered_headers.items():
        lower_k = str(k).lower()
        strip_v = str(v).lower()
        canonical_headers += '{}:{}\n'.format(lower_k, strip_v)

    signed_headers = ''
    for k, _ in ordered_headers.items():
        lower_k = str(k).lower()
        signed_headers += '{};'.format(lower_k)
    signed_headers = signed_headers[:-1]  # remove trailing ';'

    if query_parameters is None:
        query_parameters = dict()
    query_parameters['X-Goog-Algorithm'] = 'GOOG4-RSA-SHA256'
    query_parameters['X-Goog-Credential'] = credential
    query_parameters['X-Goog-Date'] = request_timestamp
    query_parameters['X-Goog-Expires'] = expiration
    query_parameters['X-Goog-SignedHeaders'] = signed_headers
    if subresource:
        query_parameters[subresource] = ''

    canonical_query_string = ''
    ordered_query_parameters = collections.OrderedDict(
        sorted(query_parameters.items()))
    for k, v in ordered_query_parameters.items():
        encoded_k = quote(str(k), safe='')
        encoded_v = quote(str(v), safe='')
        canonical_query_string += '{}={}&'.format(encoded_k, encoded_v)
    canonical_query_string = canonical_query_string[:-1]  # remove trailing '&'

    canonical_request = '\n'.join([http_method,
                                   canonical_uri,
                                   canonical_query_string,
                                   canonical_headers,
                                   signed_headers,
                                   'UNSIGNED-PAYLOAD'])

    canonical_request_hash = hashlib.sha256(
        canonical_request.encode()).hexdigest()

    string_to_sign = '\n'.join(['GOOG4-RSA-SHA256',
                                request_timestamp,
                                credential_scope,
                                canonical_request_hash])

    # signer.sign() signs using RSA-SHA256 with PKCS1v15 padding
    signature = binascii.hexlify(
        google_credentials.signer.sign(string_to_sign)
    ).decode()

    scheme_and_host = '{}://{}'.format('https', host)
    signed_url = '{}{}?{}&x-goog-signature={}'.format(
        scheme_and_host, canonical_uri, canonical_query_string, signature)

    return signed_url

次のステップ