加入 Google Workspace 適用的 Cloud HSM

本頁面說明如何啟用 Cloud HSM for Google Workspace (CHGWS),這是 Cloud Key Management Service (Cloud KMS) 提供的 Google Workspace 加密金鑰服務。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)。
  • 您使用 Google Identity 做為識別資訊提供者 (IdP)。
  • 您使用的是多租戶 Cloud HSM 金鑰。

如果您符合上述所有條件,請前往管理控制台,完成自動化新手上路程序。

如果您符合下列任一條件,就必須手動加入:

  • 您使用第三方 IdP。
  • 您使用單一租戶 Cloud HSM。
  • 您打算從其他金鑰服務遷移金鑰。
  • 您想修改現有的 Cloud HSM for Google Workspace 設定。

如果您符合上述任一條件,請按照本文件中的設定操作說明進行。

事前準備

為 Google Workspace 啟用 Cloud HSM 前,請先完成下列必要條件:

  • 設定 Google Workspace。
  • 在 Google Workspace 中啟用 Google Workspace 用戶端加密 (CSE)。
  • 在 Google Workspace CSE 中設定識別資訊提供者 (IdP)。記下 IdP 的用戶端 ID。如果您使用 Google Identity Platform,請在 Google Cloud 專案中尋找用戶端 ID。
  • 選用:如要允許在網頁以外的平台應用程式 (例如行動裝置或電腦) 上存取 CSE 加密內容,請在 Google Workspace 管理控制台的 IdP 設定中,新增這些平台的用戶端 ID。記下這個 IdP 的所有用戶端 ID。如果您使用 Google Identity Platform,請在 Google Cloud 專案中尋找這些用戶端 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 金鑰執行加密編譯作業。設定新的 Google Cloud 專案,用於託管 Cloud KMS 金鑰。

  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
    

    記下這個指令建立的服務身分,下一個步驟會用到服務身分名稱。

  8. 將「CHGWS key Service Agent」和「瀏覽者」角色授予您建立的服務帳戶:

    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. 將 Workspace Key Access API 管理員 (roles/workspacekeyaccess.admin) 角色 (預先發布版) 授予建立及管理 CHGWS 設定和端點的管理員:

    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 的金鑰,必須先在相同位置佈建單一租戶 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 進行新手上路

您可以搭配使用 Google Cloud CLI 和 Workspace Key Access API,建立及管理下列 CHGWS 資源:

  • Config:儲存 Google Workspace 組織和 IdP 詳細資料,包括客戶 ID、管理員電子郵件地址、允許的網域,以及 JSON Web Token (JWT) 驗證參數。
  • 端點:將 CHGWS 設定連結至 Cloud KMS 金鑰,並提供金鑰服務網址 (uri),以便您在 Google Workspace 管理控制台中註冊 CSE。

下列各節說明如何使用 Google Cloud CLI 建立及管理 CHGWS 設定和端點。

或者,您也可以與帳戶代表聯絡,要求 CHGWS 端點。

建立 CHGWS 設定

CHGWS 設定會儲存 Google Workspace 組織和使用者驗證身分時所用識別資訊提供者 (IdP) 的相關資訊。您可以使用 CHGWS 搭配主要 IdP,也可以同時設定主要和訪客 IdP。

如要將 CHGWS 設為僅使用主要 IdP,請按照下列步驟操作:

  • 使用 workspace-key-access configs create 指令建立 CHGWS 設定,註冊 Google Workspace:

    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 核發者網址。如果是 Google Identity Platform,請使用 https://accounts.google.com。
    • IDP_JWKS_URI:主要 IdP 的 JSON Web Key Set (JWKS) 網址。如果是 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,請使用「如果以 Google 識別資訊做為 CSE 的 IdP」一節提供的用戶端 ID。

    如要進一步瞭解可用的旗標,請參閱 gcloud beta workspace-key-access configs create。

如要將 CHGWS 設為同時使用主要和訪客 IdP,請按照下列步驟操作:

  • 使用 workspace-key-access configs create 指令建立 CHGWS 設定,並指定 --idp-configs 旗標兩次,以註冊 Google Workspace:

    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 核發者網址。如果是 Google Identity Platform,請使用 https://accounts.google.com。
    • IDP_JWKS_URI:主要 IdP 的 JSON Web Key Set (JWKS) 網址。如果是 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,請使用「如果以 Google 識別資訊做為 CSE 的 IdP」一節提供的用戶端 ID。
    • GUEST_IDP_ISSUER:訪客 IdP 的 JWT 核發者網址。如果是 Google Identity Platform,請使用 https://accounts.google.com。
    • GUEST_IDP_JWKS_URI:訪客 IdP 的 JWKS 網址。如果是 Google Identity Platform,請使用 https://www.googleapis.com/oauth2/v3/certs。
    • GUEST_IDP_AUDIENCE:訪客 IdP 的網頁應用程式 OAuth 2.0 用戶端 ID (Google Meet 除外)。
    • GUEST_ADDITIONAL_IDP_AUDIENCES:選用:為訪客 IdP 設定的非網頁平台應用程式 OAuth 2.0 用戶端 ID 清單,以半形逗號分隔,不含空格。應用程式包括行動或電腦應用程式。如果不需要設定其他目標對象,請移除預留位置,讓括號內留空 (additionalAudiences=[])。如果是 Google Identity Platform,請使用「如果以 Google 識別資訊做為 CSE 的 IdP」一節提供的用戶端 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:金鑰服務端點的 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 值。您會在在 Google Workspace CSE 中設定 CHGWS 端點時使用這個網址。

要求 CHGWS 端點

如要申請新手上路和端點建立,請與帳戶代表聯絡,並提供下列資訊:

  • Google Workspace 詳細資料:

    • Google Workspace 客戶 ID:您的 Google Workspace 客戶 ID。如要查看客戶 ID,請參閱「查看客戶 ID」一文。

    • Google Workspace 管理員電子郵件地址:提供以逗號分隔的清單,其中包含管理員電子郵件地址。

  • IdP 詳細資料:

    • 主要 IdP 詳細資料:

      • IdP JWKS 網址:如果是 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,請使用「如果以 Google 識別資訊做為 CSE 的 IdP」一節提供的用戶端 ID。
    • 訪客 IdP 詳細資料:(選用) 如果您使用訪客 IdP,請填寫這個部分。

      • 訪客 IdP JWKS 網址:訪客 IdP 的 JWKS 網址。
      • Guest JWT token issuer:訪客 IdP 的 JWT 權杖核發者。
      • 訪客 JWT 目標對象:訪客 IdP 的網頁應用程式用戶端 ID (Google Meet 除外)。
      • 訪客額外 JWT 目標對象:選用。如果您設定 Google Meet 網頁用戶端 ID 或其他非網頁平台應用程式用戶端 ID,請提供各項 ID。如果是 Google Identity Platform,請使用「如果以 Google 識別資訊做為 CSE 的 IdP」一節提供的用戶端 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 基準網址:選用:啟用金鑰遷移的網址清單。如果是首次為這個 Google Workspace 設定 CHGWS,請將這個欄位留空。
  • 其他詳細資料:

    • Customer Name:提供客戶名稱。
    • 預期使用者人數:提供 Google Workspace 執行個體中的預期使用者人數。

管理 CHGWS 服務端點

以下各節說明如何管理 CHGWS 端點。

在 Google Workspace CSE 中設定 CHGWS 端點

建立 CHGWS 端點後,請前往 Google Workspace 管理控制台,設定 Google Workspace 使用該端點。管理控制台中的端點網址和 IdP 設定,必須與 CHGWS 端點的詳細資料相符。如果您更新 CHGWS 端點的設定,也必須在 Google Workspace 管理控制台中更新金鑰服務設定,以符合更新後的詳細資料。詳情請參閱「新增及管理金鑰服務以進行用戶端加密」。

金鑰服務遷移功能

CHGWS 可讓您彈性地將金鑰服務移至或移出 CHGWS。如要開始遷移金鑰服務,請與帳戶代表聯絡,協助您提交遷移要求。請在要求中附上下列資訊:

  • Endpoint ID:CHGWS 的端點 ID。
  • 金鑰服務網址:啟用金鑰服務遷移作業的網址清單。

    • 如果您要遷移至 Google Workspace 適用的 Cloud HSM,請提供要遷移的每個金鑰服務端點基準網址。
    • 如果您是從 Google Workspace 的 Cloud HSM 遷移,請提供要遷移至的金鑰服務端點基準網址。

使用自助式 Workspace Key Access API 更新設定

您可以使用 gcloud CLI,更新現有 CHGWS 設定的管理員電子郵件地址、允許的客戶網域或 IdP 詳細資料。更新設定時,所有使用該設定的端點都會自動更新。

  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:請移除第二個 (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 核發者網址。如果是 Google Identity Platform,請使用 https://accounts.google.com。
      • IDP_JWKS_URI:主要 IdP 的 JWKS 網址。如果是 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,請使用「如果以 Google 識別資訊做為 CSE 的 IdP」一節提供的用戶端 ID。
    • 訪客 IdP 詳細資料:選用,只有在加入第二個 (GUEST_IDP) --idp-configs 旗標時才需要:
      • GUEST_IDP_ISSUER:訪客 IdP 的 JWT 核發者網址。如果是 Google Identity Platform,請使用 https://accounts.google.com。
      • GUEST_IDP_JWKS_URI:訪客 IdP 的 JWKS 網址。如果是 Google Identity Platform,請使用 https://www.googleapis.com/oauth2/v3/certs。
      • GUEST_IDP_AUDIENCE:訪客 IdP 的網頁應用程式 OAuth 2.0 用戶端 ID (Google Meet 除外)。
      • GUEST_ADDITIONAL_IDP_AUDIENCES:選用:如果您為訪客 IdP 設定 Google Meet 網路用戶端 ID 或其他非網路平台應用程式用戶端 ID,請提供以半形逗號分隔的 OAuth 2.0 用戶端 ID 清單 (以半形逗號分隔,不含空格)。如果不需要設定其他目標對象,請移除預留位置,讓括號內留空 (additionalAudiences=[])。如果是 Google Identity Platform,請使用「如果以 Google 識別資訊做為 CSE 的 IdP」一節提供的用戶端 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,以及「要求 CHGWS 端點」中列出的更新版 Google Workspace 管理員電子郵件地址或 IdP 詳細資料。

停用及啟用端點和計費功能

您無法刪除 CHGWS 端點,但如果是自行註冊端點,則可使用 Workspace Key Access 搭配 gcloud CLI,停用或重新啟用端點。停用端點後,端點會轉換為 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。

如要重新啟用 CHGWS 端點,請先停用支援該端點的 Cloud KMS 金鑰所有版本,然後按照下列步驟操作:

  • 針對支援端點的每個 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,Cloud HSM for Google Workspace 就會持續收取定期訂閱費用。本節說明如何停止累積 Google Workspace 專用 Cloud HSM 費用,以及如何恢復。

停用及啟用端點

如果您是自行設定端點,可以使用 Workspace Key Access API 停用 CHGWS 端點,同時保留 Google Cloud 專案中的其他資源。停用端點後,端點會轉換為 DISABLED 狀態,並終止計費訂閱。您之後可以重新啟用端點,重新啟動計費訂閱,並將端點轉換回 ACTIVE 狀態。

詳情請參閱「停用及啟用端點和計費功能」。

停用或啟用專案計費功能

您可以停用專案的計費功能,該專案包含 Google Workspace 專用 Cloud HSM 的 Cloud KMS 金鑰。停用計費功能後,專案中所有收費服務都會停止運作。停用專案層級計費功能後,Cloud HSM for Google Workspace 訂閱方案費用應會在 24 小時內停止。

如要繼續使用 Google Workspace 的 Cloud HSM,請重新啟用專案的計費功能。重新啟用計費功能後,系統會恢復收取訂閱費用,CHGWS 端點和 Cloud KMS 金鑰也會恢復正常運作。

要求手動停用或啟用

如果您是透過要求 CHGWS 端點完成新手上路程序,且需要停用端點,同時保持其他專案資源有效,請提出類似新手上路要求的要求。提供 Google Workspace 詳細資料、CHGWS 端點 ID 和其他相關詳細資料,並說明您的需求。CHGWS 團隊可能需要 48 小時才能完成手動票證。要求完成後,Google Workspace 的 Cloud HSM 訂閱費用應會在 24 小時內停止。

您可以建立類似的要求,重新啟用 CHGWS 端點和相關計費功能。

刪除或還原專案

您可以刪除專案,其中包含 Google Workspace 專用 Cloud HSM 的 Cloud KMS 金鑰。刪除專案會停止專案中的所有服務。您可以在刪除專案後的 30 天內復原專案。不過,專案中的 Cloud KMS 金鑰無法復原,因此在還原的專案中,以金鑰加密的所有文件和其他資料仍會永久加密。還原已刪除的專案後,即使 Cloud KMS 金鑰仍無法復原,系統也會恢復收取 Google Workspace 的 Cloud HSM 訂閱費用。

後續步驟