顧客管理の暗号鍵を使用する

デフォルトでは、Cloud Scheduler はお客様のコンテンツを保存時に暗号化します。暗号化は、Cloud Scheduler が行うため、お客様側での操作は必要ありません。このオプションは、Google のデフォルトの暗号化と呼ばれます。

暗号鍵を管理する場合は、Cloud KMS の顧客管理の暗号鍵(CMEK)を、Cloud Scheduler などの CMEK 統合サービスで使用できます。Cloud KMS 鍵を使用すると、保護レベル、ロケーション、ローテーション スケジュール、使用とアクセスの権限、暗号境界を制御できます。Cloud KMS を使用すると、監査ログを表示し、鍵のライフサイクルを管理することもできます。データを保護する対称鍵暗号鍵(KEK)は Google が所有して管理するのではなく、ユーザーが Cloud KMS でこれらの鍵の制御と管理を行います。

CMEK を使用してリソースを設定した後は、Cloud Scheduler リソースへのアクセスは、Google のデフォルトの暗号化を使用する場合と同様です。暗号化オプションの詳細については、顧客管理の暗号鍵(CMEK)をご覧ください。

CMEK による保護対象

Cloud KMS 鍵は、 Google Cloud プロジェクトごと、およびサポートされている Cloud Scheduler リージョンごとに指定できます。この鍵は、そのプロジェクトとリージョンで次のデータを保護するために使用されます。

  • HTTP または HTTPS エンドポイント ターゲットを持つジョブ: HTTP リクエスト本文と顧客ヘッダー。
  • Pub/Sub トピック ターゲットを持つジョブ: Pub/Sub メッセージのペイロードと属性。

始める前に

Cloud Scheduler で CMEK を使用する前に、次の前提条件の手順を完了します。

  1. 環境を設定する。

  2. gcloud コンポーネントを更新します。

    gcloud components update

  3. アカウントを使用してログインします。

    gcloud auth login

  4. 暗号鍵を格納するプロジェクトで Cloud KMS API を有効にします。

    gcloud services enable cloudkms.googleapis.com \
        --project=KMS_PROJECT_ID

    KMS_PROJECT_ID は、Cloud KMS 鍵を保存するプロジェクトの ID に置き換えます。これは、Cloud Scheduler ジョブと同じプロジェクトにすることも、別のプロジェクトにすることもできます。

  5. 鍵の有効化または無効化を行うと、Cloud KMS により Cloud Audit Logs が生成されます。このログは、データの暗号化または復号で Cloud Scheduler リソースが鍵を使用したときにも生成されます。

    プロジェクト内の Cloud KMS API でロギングが有効になっていることと、ユースケースに適用されるロギング固有の権限とロールを決定していることを確認します。詳細については、Cloud KMS 監査ロギングをご覧ください。

必要なロール

Cloud Scheduler の CMEK を構成するために必要な権限を取得するには、次の IAM ロールを付与するよう管理者に依頼してください。

  • サービス エージェントに鍵へのアクセス権を付与する: Cloud KMS 鍵を含む鍵、キーリング、またはプロジェクトに対する Cloud KMS 管理者(roles/cloudkms.admin)
  • CMEK の有効化または無効化: Cloud Scheduler プロジェクトに対する Cloud Scheduler 管理者(roles/cloudscheduler.admin)
  • CMEK の構成またはオペレーションのステータスを表示します。

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

これらの事前定義ロールには、Cloud Scheduler の CMEK を構成するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

Cloud Scheduler に CMEK を構成するには、次の権限が必要です。

  • サービス エージェントに鍵へのアクセス権を付与します。 cloudkms.cryptoKeys.setIamPolicy Cloud KMS 鍵を含む鍵、キーリング、またはプロジェクト
  • Cloud Scheduler プロジェクトで CMEK(cloudscheduler.cmekConfig.update)を有効または無効にする
  • CMEK の構成またはオペレーションのステータスを表示します。
    • Cloud Scheduler プロジェクトに対する cloudscheduler.cmekConfig.get
    • Cloud Scheduler プロジェクトに対する cloudscheduler.operations.get

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

Cloud KMS キーリングと鍵を作成する

キーリングは新しく作成するか、既存のものを使用できます。キーリング内では、新しい鍵を追加することも、既存の鍵を使用することも可能です。異なるアプリケーション、サービス、環境には、異なる鍵を使用することをおすすめします。

  1. キーリングを作成します。

  2. 鍵を作成する。鍵には対称暗号化アルゴリズムを使用する必要があります。

Cloud Scheduler サービス エージェントに鍵へのアクセス権を付与する

Cloud Scheduler サービス エージェントに Cloud KMS CryptoKey Encrypter/Decrypterの Identity and Access Management(IAM)ロールを付与して、Cloud KMS 鍵にアクセスできるようにする必要があります。プロジェクトで Cloud Scheduler API を最近有効にし、まだジョブを作成していない場合は、まず gcloud beta services identity create --service=cloudscheduler.googleapis.com --project=PROJECT_ID を実行してサービス エージェントを作成する必要があります。

gcloud kms keys add-iam-policy-binding KEY_NAME \
    --keyring=KEY_RING \
    --location=LOCATION \
    --project=KMS_PROJECT_ID \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com \
    --role=roles/cloudkms.cryptoKeyEncrypterDecrypter

次のように置き換えます。

  • KEY_NAME: 鍵の名前(例: my-key)。
  • KEY_RING: キーリングの名前(例: my-keyring)。
  • LOCATION: 鍵のロケーション(例: us-central1)。
  • KMS_PROJECT_ID: Cloud KMS 鍵が配置されているプロジェクトの ID。
  • PROJECT_NUMBER: Cloud Scheduler Google Cloud プロジェクトのプロジェクト番号。プロジェクト番号は、 Google Cloud コンソールの [ようこそ] ページで確認できます。また、次のコマンドでも確認できます。

    export PROJECT=$(gcloud info --format='value(config.project)')
    gcloud projects describe ${PROJECT} --format="value(projectNumber)"

サービス エージェントに roles/cloudkms.cryptoKeyEncrypterDecrypter ロールがあれば、プロジェクト内のジョブで CMEK 鍵を使用してデータを暗号化および復号できます。ロールの取り消しや、CMEK 鍵の無効化や破棄をすると、そのデータにアクセスできなくなります。このドキュメントの Cloud KMS を削除するをご覧ください。

Cloud Scheduler リージョンで CMEK を有効にする

gcloud scheduler cmek-config update コマンドを使用して、Cloud Scheduler リージョンでデータ暗号化に使用する Cloud KMS 鍵を指定します。

gcloud scheduler cmek-config update \
    --location=LOCATION \
    --kms-key-name=KEY_NAME \
    --kms-keyring=KEY_RING \
    --kms-project=KMS_PROJECT_ID

次のように置き換えます。

次の点にご注意ください。

  • Cloud Scheduler で CMEK 鍵を有効化、変更、無効化すると、非同期で実行され、長時間実行オペレーション(projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID)が返されます。更新が完了したかどうかを確認するには、gcloud scheduler operations describe コマンドを実行します。
  • Cloud Scheduler は、保護されたプロジェクトとリージョンの新しいジョブと更新されたジョブを、有効な鍵で暗号化します。以前の鍵で暗号化された既存のジョブは、新しい鍵で再暗号化されます。
  • 既存の保護されていないジョブが暗号化されます。
  • Cloud KMS で鍵をローテーションしても、既存のジョブが自動的に再暗号化されたり、リージョン内の新しいジョブが新しい主キーのバージョンに切り替えられたりすることはありません。詳細については、CMEK 鍵のローテーションをご覧ください。
  • リージョンで CMEK を無効にすると、既存のジョブは Google のデフォルトの暗号化を使用して暗号化され、後続のジョブは CMEK 暗号化なしで作成されます。このドキュメントの Cloud Scheduler リージョンの CMEK を無効にするをご覧ください。

Cloud KMS の構成を確認する

gcloud scheduler cmek-config describe コマンドを使用して Cloud Scheduler リージョンの CMEK 構成を取得し、CMEK が有効になっていることを確認します。

gcloud scheduler cmek-config describe \
    --location=LOCATION

出力は次のようになります。

kmsKeyName: projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME
name: projects/PROJECT_ID/locations/LOCATION/cmekConfig

kmsKeyName 値は、リージョン内のジョブを保護するために使用される Cloud KMS 鍵のリソース ID です。

Cloud Scheduler リージョンの CMEK を無効にする

Cloud Scheduler リージョンで CMEK を無効にすると、そのリージョンで作成されたジョブは CMEK 暗号化なしで作成されます。

gcloud scheduler cmek-config update \
    --location=LOCATION \
    --clear-kms-key

これにより、特定のリージョンの CMEK が無効になり、後続のジョブは CMEK 暗号化なしで作成されます。既存のジョブは、Google のデフォルトの暗号化を使用して暗号化されます。

Cloud KMS を削除する

ジョブへのデータアクセスを取り消す場合は、次のいずれかの方法で Cloud KMS を削除できます。

  • 顧客管理の暗号鍵の適切な鍵バージョンを無効化または破棄します。鍵バージョンが使用中かどうかを確認できます。CMEK 鍵バージョンを無効にすると、鍵が再度有効になるまで、その鍵バージョンで保護されているすべてのデータにアクセスできなくなります。鍵バージョンを破棄すると、アクセスが完全にブロックされ、復元できないデータ損失が発生する可能性があります。どちらも、特定の鍵バージョンに関連付けられたジョブにのみ影響します。

    無効化または破棄された鍵バージョンで保護されているリソースを表示することはできません。アクティブなジョブの実行は、対応するエラー メッセージを出して失敗します。

  • Cloud Scheduler サービス エージェントから roles/cloudkms.cryptoKeyEncrypterDecrypter IAM ロールを取り消します。これは、CMEK を使用した暗号化をサポートする特定のGoogle Cloud プロジェクトとリージョンのすべてのジョブに影響します。CMEK 統合ジョブを新規作成したり、CMEK で暗号化されたジョブを表示または一覧表示することはできません(ただし、削除は可能です)。アクティブなジョブの実行は、対応するエラー メッセージを出して失敗します。

いずれのオペレーションでも即時のアクセス取り消しは保証されませんが、通常は IAM の変更のほうがより速く反映されます。詳細については、Cloud KMS リソースの整合性とアクセス権の変更の伝播をご覧ください。

CMEK の組織のポリシーの制約について

Cloud Scheduler は、次の組織のポリシーの制約をサポートしています。これにより、組織全体で CMEK の使用を適用できます。

  • constraints/gcp.restrictNonCmekServices: この制約を使用して、組織、フォルダ、プロジェクト内のすべての新しい Cloud Scheduler リソースを保護するために CMEK を使用することを要求します。

    この組織のポリシーが有効になっている場合、最初に Cloud KMS 鍵を有効にしない限り、リソースの作成や更新はできません。Cloud Scheduler リージョンで CMEK を無効にすることもできません。

  • constraints/gcp.restrictCmekCryptoKeyProjects: この制約を使用して、CMEK で保護された Cloud Scheduler リソースが承認済みのプロジェクトの鍵を使用するようにします。

    たとえば、「projects/my-company-data-project のすべての Cloud Scheduler リソースに対して、このプロジェクトで使用される Cloud KMS 鍵は projects/my-company-central-keys または projects/team-specific-keys からのものでなければならない」というルールを指定できます。

次の点にご注意ください。

  • CMEK 組織ポリシーを適用した後も、Google のデフォルトの暗号化を使用する既存のジョブにアクセスできます。ただし、Cloud Scheduler リージョンに適切な Cloud KMS 鍵を構成しない限り、ジョブを更新することはできません。

  • App Engine アプリケーションをターゲットとするジョブは、CMEK の組織のポリシーの対象外です。たとえば、constraints/gcp.restrictNonCmekServices 制約を設定しても、App Engine アプリケーションをターゲットとするジョブを作成または更新できます。

組織のポリシーの構成について詳しくは、CMEK の組織のポリシーをご覧ください。

トラブルシューティング

Cloud Scheduler で Cloud KMS を使用すると、エラーが発生する可能性があります。次の表にさまざまな問題とその解決方法を示します。

問題 説明
権限 cloudkms.cryptoKeyVersions.useToEncrypt が拒否されました

指定された Cloud KMS 鍵が存在しないか、権限が適切に構成されていません。

解決方法:

鍵バージョンが有効になっていない

指定された Cloud KMS 鍵バージョンが無効になっています。

解決方法: Cloud KMS 鍵バージョンを再度有効にします。

キーリングのリージョンが、保護対象のリソースと一致しません

指定された Cloud KMS キーリング リージョンが、保護された Cloud Scheduler リージョンと異なります。

解決方法: Cloud Scheduler リージョンと同じリージョンの Cloud KMS キーリングを使用します。キーリングは別のプロジェクトに配置できます。詳細については、Cloud KMS のロケーションと Cloud Scheduler のロケーションをご覧ください。

プロジェクトが Cloud Scheduler の CMEK と互換性がない

CMEK を有効にすると、FAILED_PRECONDITION エラーが発生し、Your project is currently not compatible with CMEK in Cloud Scheduler というメッセージが表示されます。このエラーは、プロジェクト内の既存の Cloud Scheduler ジョブが CMEK をサポートするように移行されていない場合に発生します。たとえば、サービス エージェントの権限がない場合や、無効な Pub/Sub トピック名を持つレガシージョブがある場合、移行が妨げられる可能性があります。

解決方法:

  1. プロジェクトの権限またはジョブ構成の問題を確認して修正します。
  2. 権限またはジョブ構成の問題を解決したら、 Google Cloud コンソールでサポート リクエストを開き、移行を完了して、プロジェクトで CMEK を有効にできるようにします。権限またはジョブ構成を修正するだけでは、移行が完了するまでエラーは解消されません。

監査ロギング

鍵を有効または無効にすると、Cloud KMS により監査ログが生成されます。このログは、メッセージの暗号化または復号で Cloud Scheduler リソースが鍵を使用したときにも生成されます。詳細については、Cloud KMS 監査ロギングをご覧ください。

Cloud EKM のエラー

Cloud External Key Manager(Cloud EKM)を介して外部管理鍵を使用する場合に発生する可能性のある問題を解決するには、Cloud EKM エラー リファレンスをご覧ください。

使用できない鍵のステータス

なんらかの理由で Cloud KMS が使用できない場合、Cloud Scheduler が Cloud KMS から鍵のステータスを取得できないことがあります。

ジョブの実行がスケジュールされているときに Cloud KMS が使用できない場合、Cloud Scheduler はジョブデータを復号したり、ジョブのターゲットを呼び出したりできません。一時的な Cloud KMS エラー(UNAVAILABLE、RESOURCE_EXHAUSTED、到達不能な Cloud EKM 鍵など)の場合、Cloud Scheduler は指数バックオフを使用して内部で復号を再試行し、Cloud Logging の cloudscheduler.googleapis.com/cmek に CmekRetryFailure ログエントリをロギングします。権限エラーや、無効化または破棄された鍵など、再試行できないエラーの場合、復号はターゲットを呼び出すことなく直ちに失敗します。

Cloud KMS の割り当て

Cloud Scheduler で CMEK を使用すると、プロジェクトで Cloud KMS 暗号リクエストの割り当てが消費されることがあります。たとえば、Cloud Scheduler は、ジョブの実行、ジョブ管理リクエストの処理、CMEK 構成の更新時に、これらの割り当てを消費します。Cloud Scheduler は、プロジェクトとリージョンごとに最大 5 分間、キャッシュに保存された中間鍵を再利用します。そのため、ジョブを頻繁に実行しても割り当てが消費されることはありません。 CMEK 鍵を使用する暗号化と復号の処理は、ハードウェア(Cloud HSM)鍵または外部(Cloud EKM)鍵を使用する場合にのみ、Cloud KMS の割り当てに影響します。 詳細については、Cloud KMS の割り当てをご覧ください。

料金

この統合により、Cloud KMS 鍵オペレーション以外の追加の費用は発生しません。Cloud KMS 鍵オペレーションの費用は Google Cloud プロジェクトに課金されます。

鍵の付与を通じて鍵を使用する基盤となる配信リソースは、追加の Cloud KMS オペレーションを実行できます。Cloud Scheduler の直接オペレーションでの Cloud KMS の使用量を見積もるには、プロジェクトとリージョンごとに次の暗号オペレーション率を想定してください。

  • ジョブの実行: Cloud Scheduler は、プロジェクトとリージョンごとに最大 5 分間、キャッシュに保存された中間鍵を再利用します。5 分間に 1 回未満のジョブ実行を行うプロジェクトでは、実行ごとに約 1 回の Cloud KMS 復号オペレーションが実行されます。実行頻度が高いプロジェクトでは、リージョン全体で約 5 分に 1 回の復号オペレーションが実行されます。
  • ジョブ管理オペレーション: 保護されたデータを含むジョブの作成、更新、取得、一覧表示、一時停止、再開のリクエストでは、プロジェクトとリージョンごとに最大 5 分間、個別のキャッシュに保存された中間鍵が使用されます。
  • CMEK 構成の更新: cmek-config で CMEK 鍵を有効にするか変更すると、追加の Cloud KMS 鍵オペレーションが実行され、鍵が検証され、リージョン内の既存の保護されたジョブが再暗号化されます。CMEK を無効にすると、既存の保護されたジョブが復号され、Google のデフォルトの暗号化に戻ります。

料金情報については、Cloud KMS の料金をご覧ください。