Google Workspace 向け Cloud HSM にオンボーディングする

このページでは、Cloud Key Management Service(Cloud KMS)が提供する Google Workspace の暗号鍵サービスである Cloud HSM for Google Workspace(CHGWS)をオンボーディングする方法について説明します。Google Workspace 向け Cloud HSM は、Google Workspace のプライバシー管理を強化し、DISA IL5 などの規制基準を達成してデータ セキュリティを向上させるのに役立ちます。Cloud HSM は、標準に準拠した高可用性のフルマネージド鍵管理サービスです。クラウド規模で運用され、FIPS 140-2 レベル 3 に準拠した HSM(ハードウェア セキュリティ モジュール)にハードウェア格納型キーが保存されます。

CHGWS は、マルチテナント Cloud HSM 鍵とシングルテナント Cloud HSM 鍵の両方に対応しています。

詳しくは、Google Workspace 向け Cloud HSM をご覧ください。

自動オンボーディング サポート

Google Workspace 管理コンソールには、手動でのオンボーディングよりも大幅に高速な自動オンボーディング プロセスがあります。ただし、自動オンボーディングは、次の条件をすべて満たす場合にのみサポートされます。

  • Google Workspace クライアントサイド暗号化(CSE)を初めて設定する場合。
  • ID プロバイダ(IdP)として Google Identity を使用している。
  • マルチテナント Cloud HSM 鍵を使用している。

これらの条件をすべて満たしている場合は、管理コンソールに移動して自動オンボーディング プロセスを完了します。

次のいずれかの条件を満たす場合は、手動でオンボーディングする必要があります。

  • サードパーティの IdP を使用している。
  • Single-tenant Cloud HSM を使用している。
  • 別の鍵サービスから鍵を移行する予定がある。
  • Google Workspace 向け Cloud HSM の既存の構成を変更する。

これらの条件のいずれかを満たしている場合は、このドキュメントの設定手順に沿って操作してください。

始める前に

Google Workspace 向け Cloud HSM をオンボーディングする前に、次の前提条件を満たしてください。

  • Google Workspace を設定する。
  • Google Workspace で Google Workspace クライアントサイド暗号化(CSE)を有効にします。
  • Google Workspace CSE で ID プロバイダ(IdP)を構成します。IdP のクライアント ID をメモします。Google Identity Platform を使用している場合は、 Google Cloud プロジェクトでクライアント ID を確認します。
  • 省略可: ウェブ以外のプラットフォーム アプリケーション(モバイルやデスクトップなど)で CSE 暗号化コンテンツへのアクセスを許可する場合は、Google Workspace 管理コンソールの IdP 設定に、それらのプラットフォームのクライアント ID を追加します。この IdP のすべてのクライアント ID をメモします。Google Identity Platform を使用している場合は、 Google Cloud プロジェクトでこれらのクライアント ID を確認します。他の ID プロバイダの場合は、これらのクライアント ID を個別に作成します。

対応している地域

Cloud KMS 鍵は、米国またはヨーロッパの地理的エリア内の任意のリージョンまたはマルチリージョン ロケーションに保存できます。Google Workspace 向け Cloud HSM は、マルチテナント Cloud HSM 鍵とシングルテナント Cloud HSM 鍵の両方をサポートしています。特定のロケーションを確認するには、Cloud KMS のロケーションにアクセスして、HSM タイプでフィルタします。

Google Workspace 向け Cloud HSM は、鍵のロケーションに最も近い次のマルチリージョンのいずれかでエンドポイントを自動的に提供します。

  • us
  • eur3

Cloud KMS 用の Google Cloud プロジェクトを設定する

Google Workspace 向け Cloud HSM エンドポイントは、暗号オペレーションに Cloud KMS 鍵を使用します。Cloud KMS 鍵をホストする新しい Google Cloud プロジェクトを設定します。

  1. Google Cloud プロジェクトを作成します。これが鍵のプロジェクトになります。プロジェクト ID とプロジェクト番号をメモしておきます。これらは、設定を完了するために必要です。

  2. 作成したプロジェクトの課金を有効にします。

  3. Google Cloud 鍵プロジェクトで Cloud KMS API を有効にします。

    API の有効化

  4. Google Cloud 鍵プロジェクトで Workspace Key Access API(プレビュー)を有効にします。

    API の有効化

  5. Google Cloud コンソールで、ターミナル Cloud Shell をアクティブにするをクリックします。

  6. プロジェクト ID と Cloud Shell プロンプトのプロジェクト ID を比較して、正しいプロジェクトにいることを確認します。

  7. Cloud Shell を使用して、Google Workspace サービス アカウント用の Cloud HSM を作成します。

    gcloud beta services identity create \
        --service=cloudkmskacls-pa.googleapis.com
    

    このコマンドによって作成されたサービス ID をメモします。次のステップでサービス ID 名が必要になります。

  8. 作成したサービス アカウントに CHGWS 鍵サービス エージェントとブラウザのロールを付与します。

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudkmskacls.iam.gserviceaccount.com \
        --role=roles/cloudkmskacls.serviceAgent
    
    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudkmskacls.iam.gserviceaccount.com \
        --role=roles/browser
    

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

    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • PROJECT_NUMBER: 鍵プロジェクトのプロジェクト番号。
  9. CHGWS 構成とエンドポイントを作成して管理する管理者に、Workspace Key Access API 管理者(roles/workspacekeyaccess.admin)ロール(プレビュー)を付与します。

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=user:ADMIN_USER_EMAIL \
        --role=roles/workspacekeyaccess.admin
    

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

    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • ADMIN_USER_EMAIL: CHGWS 構成とエンドポイントを作成して管理するGoogle Cloud 管理者のメールアドレス。

Cloud KMS 鍵を設定する

CHGWS 鍵サービス エンドポイントの Cloud KMS リソースを設定します。

  1. サポート対象の地域のいずれかにキーリングを作成します。

    gcloud kms keyrings create KEY_RING --location LOCATION
    

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

    • KEY_RING: CHGWS キーリングに使用する名前(例: CHGWS_KEY_RING)。
    • LOCATION: キーリングを作成するロケーション(例: us)。
  2. Cloud HSM 鍵を作成します。

    マルチテナント Cloud HSM

    hsm 保護レベルの鍵を作成するには:

    gcloud kms keys create KEY_NAME \
        --protection-level "hsm" \
        --keyring KEY_RING \
        --location LOCATION \
        --purpose "encryption" \
        --rotation-period ROTATION_PERIOD \
        --next-rotation-time NEXT_ROTATION_TIME
    

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

    • KEY_NAME: 鍵に使用する名前(例: CHGWS_KEY)。
    • KEY_RING: キーリングの名前(例: CHGWS_KEY_RING)。
    • LOCATION: キーリングを作成したロケーション(例: us)。
    • ROTATION_PERIOD: 鍵をローテーションする頻度(例: 7d)。
    • NEXT_ROTATION_TIME: 次の鍵のローテーションが行われる日時(例: 2024-03-20T01:00:00)。

    単一テナント Cloud HSM

    hsm_single_tenant 保護レベルの鍵を作成するには、まず同じロケーションに Single-tenant Cloud HSM インスタンスをプロビジョニングする必要があります。

    1. 単一テナント Cloud HSM インスタンスを作成してプロビジョニングする: 単一テナント Cloud HSM インスタンスを作成して管理するガイドの手順に沿って操作します。プロビジョニングされたインスタンス ID をメモします。次の手順でこれを使用します。

    2. 鍵を作成する:

      gcloud kms keys create KEY_NAME \
          --protection-level "hsm_single_tenant" \
          --keyring KEY_RING \
          --location LOCATION \
          --purpose "encryption" \
          --crypto-key-backend "projects/PROJECT_ID/locations/LOCATION/singleTenantHsmInstances/INSTANCE_NAME" \
          --rotation-period ROTATION_PERIOD \
          --next-rotation-time NEXT_ROTATION_TIME
      

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

      • KEY_NAME: 鍵に使用する名前(例: CHGWS_KEY)。
      • KEY_RING: キーリングの名前(例: CHGWS_KEY_RING)。
      • LOCATION: キーリングを作成したロケーション(例: us)。
      • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
      • INSTANCE_NAME: 鍵を作成する単一テナント Cloud HSM インスタンスの名前。
      • ROTATION_PERIOD: 鍵をローテーションする頻度(例: 7d)。
      • NEXT_ROTATION_TIME: 次の鍵のローテーションが行われる日時(例: 2024-03-20T01:00:00)。

    鍵の作成オプションの詳細については、鍵の作成をご覧ください。

セルフサービスの Workspace Key Access API を使用してオンボーディングする

Workspace Key Access API で Google Cloud CLI を使用して、次の CHGWS リソースを作成、管理できます。

  • Config: Google Workspace 組織と IdP の詳細(お客様 ID、管理者メールアドレス、許可されたドメイン、JSON Web Token(JWT)認証パラメータなど)を保存します。
  • エンドポイント: CHGWS 構成を Cloud KMS 鍵に接続し、CSE 用に Google Workspace 管理コンソールに登録する鍵サービス URL(uri)を提供します。

以降のセクションでは、Google Cloud CLI を使用して CHGWS 構成とエンドポイントを作成して管理する方法について説明します。

または、アカウント担当者に連絡して CHGWS エンドポイントをリクエストすることもできます。

CHGWS 構成を作成する

CHGWS 構成には、Google Workspace 組織と、ユーザーが認証に使用する ID プロバイダ(IdP)に関する情報が保存されます。CHGWS はプライマリ IdP のみで使用できます。また、プライマリ IdP とゲスト IdP の両方を構成することもできます。

プライマリ IdP のみを使用するように CHGWS を構成する手順は次のとおりです。

  • workspace-key-access configs create コマンドを使用して、Google Workspace を登録するための CHGWS 構成を作成します。

    gcloud beta workspace-key-access configs create CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --customer-id=CUSTOMER_ID \
        --admin-emails=ADMIN_EMAILS \
        --kacls-owner-domains=OWNER_DOMAINS \
        --idp-configs='
            idpType=PRIMARY_IDP,
            issuer=IDP_ISSUER,
            jwksUri=IDP_JWKS_URI,
            audience=IDP_AUDIENCE,
            additionalAudiences=[ADDITIONAL_IDP_AUDIENCES]
        '
    

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

    • CONFIG_ID: 構成の ID(例: my-workspace-config)。
    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • ENDPOINT_LOCATION: 構成を作成するロケーション(例: us)。互換性のあるロケーションのいずれかを指定します。
    • CUSTOMER_ID: Google Workspace のお客様 ID。お客様 ID を確認するには、お客様 ID を確認するをご覧ください。
    • ADMIN_EMAILS: Google Workspace 管理者のメールアドレスのカンマ区切りのリスト。
    • OWNER_DOMAINS: 鍵サービスを登録する、許可された Google Workspace 顧客ドメインのカンマ区切りリスト。Google Workspace 管理コンソールの [ドメインの管理] ページでドメインを確認します。
    • IDP_ISSUER: プライマリ IdP の JWT 発行元 URL。Google Identity Platform の場合は、https://accounts.google.com を使用します。
    • IDP_JWKS_URI: プライマリ IdP の JSON Web Key Set(JWKS)URL。Google Identity Platform の場合は、https://www.googleapis.com/oauth2/v3/certs を使用します。
    • IDP_AUDIENCE: ウェブ アプリケーション用のプライマリ IdP の OAuth 2.0 クライアント ID。
    • ADDITIONAL_IDP_AUDIENCES: 省略可。ウェブ プラットフォーム以外のアプリケーションの OAuth 2.0 クライアント ID のリスト。カンマ区切りで、スペースは含めません。アプリケーションには、モバイル アプリケーションやデスクトップ アプリケーションが含まれます。追加のオーディエンスを構成する必要がない場合は、プレースホルダを削除して、角かっこを空(additionalAudiences=[])にします。Google Identity Platform の場合は、CSE で Google ID を使用する場合に記載されているクライアント ID を使用します。

    使用可能なフラグの詳細については、gcloud beta workspace-key-access configs create をご覧ください。

プライマリ IdP とゲスト IdP の両方を使用するように CHGWS を構成するには、次の操作を行います。

  • workspace-key-access configs create コマンドを使用して Google Workspace を登録する CHGWS 構成を作成し、--idp-configs フラグを 2 回指定します。

    gcloud beta workspace-key-access configs create CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --customer-id=CUSTOMER_ID \
        --admin-emails=ADMIN_EMAILS \
        --kacls-owner-domains=OWNER_DOMAINS \
        --idp-configs='
            idpType=PRIMARY_IDP,
            issuer=IDP_ISSUER,
            jwksUri=IDP_JWKS_URI,
            audience=IDP_AUDIENCE,
            additionalAudiences=[ADDITIONAL_IDP_AUDIENCES]
        ' \
        --idp-configs='
            idpType=GUEST_IDP,
            issuer=GUEST_IDP_ISSUER,
            jwksUri=GUEST_IDP_JWKS_URI,
            audience=GUEST_IDP_AUDIENCE,
            additionalAudiences=[GUEST_ADDITIONAL_IDP_AUDIENCES]
        '
    

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

    • CONFIG_ID: 構成の ID(例: my-workspace-config)。
    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • ENDPOINT_LOCATION: 構成を作成するロケーション(例: us)。互換性のあるロケーションのいずれかを指定します。
    • CUSTOMER_ID: Google Workspace のお客様 ID。お客様 ID を確認するには、お客様 ID を確認するをご覧ください。
    • ADMIN_EMAILS: Google Workspace 管理者のメールアドレスのカンマ区切りのリスト。
    • OWNER_DOMAINS: 鍵サービスを登録する、許可された Google Workspace 顧客ドメインのカンマ区切りリスト。Google Workspace 管理コンソールの [ドメインの管理] ページでドメインを確認します。
    • IDP_ISSUER: プライマリ IdP の JWT 発行元 URL。Google Identity Platform の場合は、https://accounts.google.com を使用します。
    • IDP_JWKS_URI: プライマリ IdP の JSON Web Key Set(JWKS)URL。Google Identity Platform の場合は、https://www.googleapis.com/oauth2/v3/certs を使用します。
    • IDP_AUDIENCE: ウェブ アプリケーション用のプライマリ IdP の OAuth 2.0 クライアント ID。
    • ADDITIONAL_IDP_AUDIENCES: 省略可。ウェブ プラットフォーム以外のアプリケーションの OAuth 2.0 クライアント ID のリスト。カンマ区切りで、スペースは含めません。アプリケーションには、モバイル アプリケーションやデスクトップ アプリケーションが含まれます。追加のオーディエンスを構成する必要がない場合は、プレースホルダを削除して、角かっこを空(additionalAudiences=[])にします。Google Identity Platform の場合は、CSE で Google ID を使用する場合に記載されているクライアント ID を使用します。
    • GUEST_IDP_ISSUER: ゲスト IdP の JWT 発行者 URL。Google Identity Platform の場合は、https://accounts.google.com を使用します。
    • GUEST_IDP_JWKS_URI: ゲスト IdP の JWKS URL。Google Identity Platform の場合は、https://www.googleapis.com/oauth2/v3/certs を使用します。
    • GUEST_IDP_AUDIENCE: Google Meet を除くウェブ アプリケーション用のゲスト IdP の OAuth 2.0 クライアント ID。
    • GUEST_ADDITIONAL_IDP_AUDIENCES: 省略可。ゲスト IdP 用に構成するウェブ プラットフォーム以外のアプリケーションの OAuth 2.0 クライアント ID のリスト。スペースなしでカンマで区切ります。アプリケーションには、モバイル アプリケーションやデスクトップ アプリケーションが含まれます。追加のオーディエンスを構成する必要がない場合は、プレースホルダを削除して、角かっこを空にします(additionalAudiences=[])。Google Identity Platform の場合は、CSE で Google ID を使用する場合に記載されているクライアント ID を使用します。

    使用可能なフラグの詳細については、gcloud beta workspace-key-access configs create をご覧ください。

省略可: 構成が正しく設定されていることを確認するには、次の操作を行います。

  • 構成を記述して詳細を表示します。

    gcloud beta workspace-key-access configs describe CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

CHGWS エンドポイントを作成する

  1. CHGWS 鍵サービス エンドポイントを作成し、CHGWS 構成と Cloud KMS 鍵にアタッチします。

    gcloud beta workspace-key-access endpoints create ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --config=projects/PROJECT_ID/locations/ENDPOINT_LOCATION/configs/CONFIG_ID \
        --kms-key=projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME
    

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

    • ENDPOINT_ID: 鍵サービス エンドポイントの識別子(例: my-kacls-endpoint)。
    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • ENDPOINT_LOCATION: 構成とエンドポイントのロケーション(例: us)。互換性のあるロケーションのいずれかを指定します。
    • CONFIG_ID: 以前に作成した構成の ID。
    • LOCATION: Cloud KMS キーリングを作成したロケーション(例: us)。
    • KEY_RING: Cloud KMS キーリングの名前。
    • KEY_NAME: Cloud KMS 鍵の名前。
  2. エンドポイントを記述して、生成された uri を取得し、state が ACTIVE であることを確認します。

    gcloud beta workspace-key-access endpoints describe ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

    出力から uri の値をコピーします。この URL は、Google Workspace CSE で CHGWS エンドポイントを構成するで使用します。

CHGWS エンドポイントをリクエストする

オンボーディングとエンドポイントの作成をリクエストするには、アカウント担当者に連絡して、次の情報を提供してください。

  • Google Workspace の詳細:

    • Google Workspace お客様 ID: Google Workspace のお客様 ID。お客様 ID を確認するには、お客様 ID を確認するをご覧ください。

    • Google Workspace 管理者のメールアドレス: 管理者のメールアドレスをカンマ区切りのリストで指定します。

  • IdP の詳細:

    • メインの IdP の詳細:

      • IdP JWKS URL: Google Identity Platform の場合は、https://www.googleapis.com/oauth2/v3/certs を使用します。
      • JWT トークン発行元: Google Identity Platform の場合は、https://accounts.google.com を使用します。
      • JWT オーディエンス: ウェブ アプリケーション用の IdP のクライアント ID。
      • 追加の JWT オーディエンス: 省略可。構成するウェブ プラットフォーム以外のアプリケーションのクライアント ID を指定します。Google Identity Platform の場合は、CSE で Google ID を使用する場合に記載されているクライアント ID を使用します。
    • ゲスト IdP の詳細: 省略可。ゲスト IdP を使用している場合は、このセクションを完了します。

      • ゲスト IdP の JWKS URL: ゲスト IdP の JWKS URL。
      • ゲスト JWT トークン発行者: ゲスト IdP の JWT トークン発行者。
      • ゲスト JWT オーディエンス: Google Meet を除くウェブ アプリケーションのゲスト IdP のクライアント ID。
      • ゲストの追加の JWT オーディエンス: 省略可。Google Meet ウェブ クライアント ID またはその他のウェブ プラットフォーム以外のアプリケーション クライアント ID を構成する場合は、それぞれにクライアント ID を指定します。Google Identity Platform の場合は、CSE で Google ID を使用する場合に記載されているクライアント ID を使用します。
  • CSE 鍵の詳細:

    • Google Cloud プロジェクト ID: PROJECT_ID
    • Google Cloud プロジェクト番号: PROJECT_NUMBER
    • Cloud KMS キーリング名: KEY_RING
    • Cloud KMS キーリングのロケーション: LOCATION
    • Cloud KMS 鍵名: KEY_NAME
    • Cloud KMS 鍵の保護レベル: hsm または hsm_single_tenant
    • CHGWS ベース URL: 省略可。鍵の移行を有効にする URL のリスト。この Google Workspace で CHGWS を初めて設定する場合は、このフィールドを空白のままにします。
  • その他の詳細:

    • Customer Name(お客様の名前): お客様の名前を入力します。
    • 予想されるユーザー数: Google Workspace インスタンスで予想されるユーザー数を入力します。

CHGWS サービス エンドポイントを管理する

以降のセクションでは、CHGWS エンドポイントを管理する方法について説明します。

Google Workspace CSE で CHGWS エンドポイントを構成する

CHGWS エンドポイントを作成したら、Google Workspace 管理コンソールに移動して、エンドポイントを使用するように Google Workspace を構成します。管理コンソールのエンドポイント URL と IdP の設定は、CHGWS エンドポイントの詳細と一致している必要があります。CHGWS エンドポイントの構成を更新する場合は、更新された詳細に合わせて、Google Workspace 管理コンソールで鍵サービスの構成も更新する必要があります。詳しくは、クライアントサイド暗号化で使用する鍵サービスを追加、管理するをご覧ください。

鍵サービスの移行

CHGWS を使用すると、鍵サービスを CHGWS との間で柔軟に移動できます。鍵サービスの移行を開始するには、アカウント担当者に連絡して、移行リクエストの送信を依頼してください。リクエストには、次の情報を含めます。

  • エンドポイント ID: CHGWS のエンドポイント ID。
  • 鍵サービスの URL: 鍵サービスの移行を有効にする URL のリスト。

    • Google Workspace 向け Cloud HSM に移行する場合は、移行元の各鍵サービス エンドポイントのベース URL を指定します。
    • Google Workspace 向け Cloud HSM から移行する場合は、移行先の鍵サービス エンドポイントのベース URL を指定します。

セルフサービスの Workspace Key Access API を使用して構成を更新する

既存の CHGWS 構成の管理者メールアドレス、許可されたお客様のドメイン、IdP の詳細を更新するには、gcloud CLI を使用します。構成を更新すると、その構成を使用するすべてのエンドポイントが自動的に更新されます。

  1. CHGWS 構成を更新します。更新するフィールドのフラグのみを含め、変更しないフィールドのフラグは削除します。含めた各フラグは、そのフィールドの既存の値を置き換えます。

    gcloud beta workspace-key-access configs update CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION \
        --admin-emails=ADMIN_EMAILS \
        --kacls-owner-domains=OWNER_DOMAINS \
        --idp-configs='
            idpType=PRIMARY_IDP,
            issuer=IDP_ISSUER,
            jwksUri=IDP_JWKS_URI,
            audience=IDP_AUDIENCE,
            additionalAudiences=[ADDITIONAL_IDP_AUDIENCES]
        ' \
        --idp-configs='
            idpType=GUEST_IDP,
            issuer=GUEST_IDP_ISSUER,
            jwksUri=GUEST_IDP_JWKS_URI,
            audience=GUEST_IDP_AUDIENCE,
            additionalAudiences=[GUEST_ADDITIONAL_IDP_AUDIENCES]
        '
    

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

    • CONFIG_ID: 更新する構成の ID。
    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • ENDPOINT_LOCATION: 構成のロケーション(例: us)。互換性のあるロケーションのいずれかを指定します。
    • ADMIN_EMAILS: 省略可。Google Workspace 管理者のメールアドレスのカンマ区切りのリスト。管理者のメールアドレスを更新しない場合は、--admin-emails を削除します。
    • OWNER_DOMAINS: 省略可。鍵サービスを登録する、許可された Google Workspace 顧客ドメインのカンマ区切りリスト。Google Workspace 管理コンソールの [ドメインの管理] ページでドメインを確認します。許可されたお客様のドメインを更新しない場合は、--kacls-owner-domains を削除します。
    • --idp-configs:
      • プライマリ IdP のみを構成した場合: 2 番目の(GUEST_IDP)--idp-configs フラグ(および前の行の末尾のバックスラッシュ)を削除し、PRIMARY_IDP フラグの詳細を更新します。ゲスト IdP は未設定のままです。
      • プライマリ IdP とゲスト IdP の両方を構成した場合: どちらか一方のみを更新する場合でも、両方の --idp-configs フラグを含める必要があります。GUEST_IDP フラグを省略すると、ゲスト IdP は未設定として上書きされます。PRIMARY_IDP フラグを省略すると、更新は失敗します。
      • IdP を更新しない場合: 両方の --idp-configs フラグを削除して、既存の IdP の詳細が変更されないようにします。
    • プライマリ IdP の詳細: --idp-configs を含める場合は常に必要です。
      • IDP_ISSUER: プライマリ IdP の JWT 発行元 URL。Google Identity Platform の場合は、https://accounts.google.com を使用します。
      • IDP_JWKS_URI: プライマリ IdP の JWKS URL。Google Identity Platform の場合は、https://www.googleapis.com/oauth2/v3/certs を使用します。
      • IDP_AUDIENCE: ウェブ アプリケーション用のプライマリ IdP の OAuth 2.0 クライアント ID。
      • ADDITIONAL_IDP_AUDIENCES: 省略可。ウェブ以外のプラットフォーム アプリケーション(Android、iOS、デスクトップ アプリケーションなど)の OAuth 2.0 クライアント ID のカンマ区切りのリスト。カンマで区切り、スペースは入れません。追加のオーディエンスを構成する必要がない場合は、プレースホルダを削除して、角かっこを空にします(additionalAudiences=[])。Google Identity Platform の場合は、CSE で Google ID を使用する場合に記載されているクライアント ID を使用します。
    • ゲスト IdP の詳細: 省略可。2 番目の(GUEST_IDP)--idp-configs フラグを含める場合にのみ必要です。
      • GUEST_IDP_ISSUER: ゲスト IdP の JWT 発行者 URL。Google Identity Platform の場合は、https://accounts.google.com を使用します。
      • GUEST_IDP_JWKS_URI: ゲスト IdP の JWKS URL。Google Identity Platform の場合は、https://www.googleapis.com/oauth2/v3/certs を使用します。
      • GUEST_IDP_AUDIENCE: Google Meet を除くウェブ アプリケーション用のゲスト IdP の OAuth 2.0 クライアント ID。
      • GUEST_ADDITIONAL_IDP_AUDIENCES: 省略可。Google Meet ウェブ クライアント ID またはゲスト IdP の他のウェブ プラットフォーム以外のアプリケーション クライアント ID を構成する場合は、OAuth 2.0 クライアント ID のカンマ区切りリスト(スペースなしのカンマ区切り)。追加のオーディエンスを構成する必要がない場合は、プレースホルダを削除して、角かっこを空にします(additionalAudiences=[])。Google Identity Platform の場合は、CSE で Google ID を使用する場合に記載されているクライアント ID を使用します。

    使用可能なフラグの詳細については、gcloud beta workspace-key-access configs update をご覧ください。

  2. 省略可: 構成の詳細を確認して、正しく更新されていることを確認します。

    gcloud beta workspace-key-access configs describe CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    
  3. 省略可: エンドポイントに接続されていない未使用の構成がある場合は、削除できます。

    gcloud beta workspace-key-access configs delete CONFIG_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

別の構成を使用するようにエンドポイントを更新する

CHGWS エンドポイントは、同じ Google Cloud プロジェクトとロケーションの別の構成に接続できます。ただし、エンドポイントに関連付けられているバッキング Cloud KMS 鍵は変更できません。

エンドポイントに接続されている構成を更新します。

gcloud beta workspace-key-access endpoints update ENDPOINT_ID \
    --project=PROJECT_ID \
    --location=ENDPOINT_LOCATION \
    --config=projects/PROJECT_ID/locations/ENDPOINT_LOCATION/configs/NEW_CONFIG_ID

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

  • ENDPOINT_ID: 更新する鍵サービス エンドポイントの ID。
  • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
  • ENDPOINT_LOCATION: エンドポイントと構成のロケーション(例: us)。互換性のあるロケーションのいずれかを指定します。
  • NEW_CONFIG_ID: エンドポイントに接続する、同じプロジェクトとロケーションにある構成の ID。

エンドポイントへの更新をリクエストする

CHGWS エンドポイントをリクエストしてオンボーディングし、既存の CHGWS の詳細を更新する必要がある場合は、アカウント担当者に連絡して更新リクエストを送信してください。リクエストには、Google Workspace のお客様 ID、 Google Cloud プロジェクト ID、CHGWS エンドポイント ID、更新された Google Workspace 管理者のメールアドレス、または CHGWS エンドポイントをリクエストするに記載されている IdP の詳細を含めます。

エンドポイントと課金を無効または有効にする

CHGWS エンドポイントを削除することはできません。ただし、エンドポイントをセルフオンボーディングした場合は、gcloud CLI で Workspace Key Access を使用してエンドポイントを無効または再度有効にできます。エンドポイントを無効にすると、エンドポイントは DISABLED 状態に移行し、課金サブスクリプションが終了します。

セルフ オンボーディングしたエンドポイントを無効にするには、次の操作を行います。

  • アクティブなエンドポイントを無効にし、課金を無効にします。

    gcloud beta workspace-key-access endpoints disable ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

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

    • ENDPOINT_ID: 無効にする鍵サービス エンドポイントの ID。
    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • ENDPOINT_LOCATION: エンドポイントのロケーション(例: us)。互換性のあるロケーションのいずれかを指定します。

エンドポイントを再度有効にする前に、エンドポイントで使用されている Cloud KMS 鍵と鍵バージョンがアクセス可能で、アクティブである必要があります。エンドポイントを有効にすると、課金サブスクリプションが再開され、エンドポイントが ACTIVE 状態に移行します。

workspace-key-access endpoints disable コマンドを使用して無効にしたエンドポイントを再度有効にするには、次の操作を行います。

  • エンドポイントを再度有効にして、課金を再開します。

    gcloud beta workspace-key-access endpoints enable ENDPOINT_ID \
        --project=PROJECT_ID \
        --location=ENDPOINT_LOCATION
    

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

    • ENDPOINT_ID: 有効にする鍵サービス エンドポイントの ID。
    • PROJECT_ID: 鍵プロジェクトのプロジェクト ID。
    • ENDPOINT_LOCATION: エンドポイントのロケーション(例: us)。互換性のあるロケーションのいずれかを指定します。

基盤となる鍵バージョンを無効にして有効にする

エンドポイントのオンボーディング方法に関係なく、Google Cloud コンソール、gcloud CLI、または Cloud KMS API を使用して、Cloud KMS で基盤となる Cloud KMS 鍵バージョンを無効にできます。基盤となる鍵バージョンを無効にすると、課金サブスクリプションを終了せずにエンドポイントが無効になります。その後、課金を個別に無効にすることができます。

基盤となる鍵バージョンを無効にするには、次の操作を行います。

  • エンドポイントをバックアップする Cloud KMS 鍵バージョンごとに、次のコマンドを実行します。

    gcloud kms keys versions disable KEY_VERSION --keyring \
        KEY_RING --location LOCATION --key KEY_NAME
    

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

    • KEY_VERSION: 無効にする鍵のバージョン(例: 1)。
    • KEY_RING: キーリングの名前(例: CHGWS_KEY_RING)。
    • LOCATION: 無効にする鍵バージョンのロケーション(例: us)。
    • KEY_NAME: 鍵の名前(例: CHGWS_KEY)。

エンドポイントをサポートする Cloud KMS 鍵のすべての鍵バージョンを無効にして、無効にした CHGWS エンドポイントを再度有効にするには、次の操作を行います。

  • エンドポイントをバックアップする Cloud KMS 鍵バージョンごとに、次のコマンドを実行します。

    gcloud kms keys versions enable KEY_VERSION --keyring \
        KEY_RING --location LOCATION --key KEY_NAME
    

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

    • KEY_VERSION: 有効にする鍵のバージョン(例: 1)。
    • KEY_RING: キーリングの名前(例: CHGWS_KEY_RING)。
    • LOCATION: 有効にする鍵バージョンのロケーション(例: us)。
    • KEY_NAME: 鍵の名前(例: CHGWS_KEY)。

CHGWS の請求を管理する

CHGWS エンドポイントが作成されてアクティブになると、すぐに課金が開始されます。それ以降、エンドポイントがGoogle Cloud プロジェクトで ACTIVE のままである限り、Google Workspace 向け Cloud HSM の定期的なサブスクリプション料金が継続されます。このセクションでは、Google Workspace 向け Cloud HSM の課金を停止する方法と、課金を再開する方法について説明します。

エンドポイントを無効化し、その後有効化する

エンドポイントをセルフ オンボーディングした場合は、Workspace Key Access API を使用して CHGWS エンドポイントを無効にしながら、 Google Cloud プロジェクトの他のリソースをアクティブに保つことができます。エンドポイントを無効にすると、DISABLED 状態に移行し、課金サブスクリプションが終了します。後でエンドポイントを再度有効にして、課金サブスクリプションを再開し、ACTIVE 状態に戻すことができます。

詳細については、エンドポイントと課金を無効または有効にするをご覧ください。

プロジェクトの課金を無効または有効にする

Google Workspace 向け Cloud HSM の Cloud KMS 鍵を含むプロジェクトの課金を無効にすることができます。課金を無効にすると、プロジェクト内のすべての課金対象サービスが停止します。プロジェクト レベルの課金が無効になると、24 時間以内に Cloud HSM for Google Workspace サブスクリプションの課金が停止します。

Google Workspace で Cloud HSM の使用を再開する場合は、プロジェクトで課金を再度有効にします。課金が再度有効になると、利用料金が再開され、CHGWS エンドポイントと Cloud KMS 鍵が再び正常に機能します。

手動での無効化または有効化をリクエストする

CHGWS エンドポイントをリクエストしてオンボーディングし、他のプロジェクト リソースをアクティブな状態に保ちながらエンドポイントを無効にする必要がある場合は、オンボーディング リクエストと同様のリクエストを送信します。Google Workspace の詳細、CHGWS エンドポイント ID、その他の関連する詳細を提供し、要件を説明します。手動チケットの場合、CHGWS チームが完了するまでに 48 時間かかることがあります。リクエストが完了すると、24 時間以内に Google Workspace 向け Cloud HSM のサブスクリプション料金の請求が停止します。

同様のリクエストを作成することで、CHGWS エンドポイントとその課金を再度有効にできます。

プロジェクトを削除または復元する

Google Workspace 向け Cloud HSM の Cloud KMS 鍵を含むプロジェクトを削除できます。プロジェクトを削除すると、プロジェクト内のすべてのサービスが停止します。削除したプロジェクトは、削除後 30 日以内であれば復元できます。ただし、プロジェクト内の Cloud KMS 鍵は復元できないため、復元されたプロジェクト内の鍵で暗号化されたすべてのドキュメントやその他のデータは、完全に暗号化されたままになります。削除されたプロジェクトを復元すると、Cloud KMS 鍵が復元不能なままであっても、Google Workspace 向け Cloud HSM のサブスクリプション料金が再開されます。

次のステップ