加入 Cloud HSM for Google Workspace

本页面介绍了如何开始使用 Cloud HSM for Google Workspace (CHGWS),这是 Cloud Key Management Service (Cloud KMS) 提供的 Google Workspace 加密密钥服务。Cloud HSM for Google Workspace 为 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。
  • 可选:如果您允许在 Web 以外的平台应用(例如移动应用或桌面应用)上访问 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 类型进行过滤。

Cloud HSM for Google Workspace 会自动在以下多区域中选择一个最靠近您密钥位置的多区域,并提供该多区域中的端点:

  • 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 创建 Cloud HSM for Google Workspace 服务账号:

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

    请记下此命令创建的服务身份。在下一步中,您需要用到服务身份名称。

  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 Admin (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 保护级别的密钥,您必须先在同一位置预配单租户 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 资源:

  • 配置:存储您的 Google Workspace 组织和 IdP 详细信息,包括您的客户 ID、管理员邮箱、允许的网域和 JSON Web 令牌 (JWT) 身份验证参数。
  • 端点:将您的 CHGWS 配置连接到 Cloud KMS 密钥,并提供您在 Google Workspace 管理控制台中为 CSE 注册的密钥服务网址 (uri)。

以下部分介绍了如何使用 Google Cloud CLI 创建和管理 CHGWS 配置和端点。

或者,您也可以联系自己的客户代表来请求 CHGWS 端点。

创建 CHGWS 配置

CHGWS 配置会存储有关 Google Workspace 组织以及用户用于进行身份验证的身份提供方 (IdP) 的信息。您可以仅将 CHGWS 与主要 IdP 搭配使用,也可以同时配置主要 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:配置的标识符,例如 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 密钥集 (JWKS) 网址。对于 Google Identity Platform,请使用 https://www.googleapis.com/oauth2/v3/certs。
    • IDP_AUDIENCE:主 IdP 的 Web 应用 OAuth 2.0 客户端 ID。
    • ADDITIONAL_IDP_AUDIENCES:可选:非 Web 平台应用的 OAuth 2.0 客户端 ID 列表,以英文逗号分隔,不含空格。应用可以包括移动应用或桌面应用。 如果您不需要配置其他受众群体,请移除占位符,使括号为空 (additionalAudiences=[])。对于 Google Identity Platform,请使用如果您要为 CSE 使用 Google 身份中提供的客户端 ID。

    如需详细了解可用标志,请参阅 gcloud beta workspace-key-access configs create。

如需将 CHGWS 配置为同时使用主要 IdP 和访客 IdP,请执行以下操作:

  • 使用 workspace-key-access configs create 命令创建 CHGWS 配置以注册 Google Workspace,并指定 --idp-configs 标志两次:

    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:配置的标识符,例如 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 密钥集 (JWKS) 网址。对于 Google Identity Platform,请使用 https://www.googleapis.com/oauth2/v3/certs。
    • IDP_AUDIENCE:主 IdP 的 Web 应用 OAuth 2.0 客户端 ID。
    • ADDITIONAL_IDP_AUDIENCES:可选:非 Web 平台应用的 OAuth 2.0 客户端 ID 列表,以英文逗号分隔,不含空格。应用可以包括移动应用或桌面应用。 如果您不需要配置其他受众群体,请移除占位符,使括号为空 (additionalAudiences=[])。对于 Google Identity Platform,请使用如果您要为 CSE 使用 Google 身份中提供的客户端 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 的 Web 应用 OAuth 2.0 客户端 ID(Google Meet 除外)。
    • GUEST_ADDITIONAL_IDP_AUDIENCES:可选:您为访客 IdP 配置的非 Web 平台应用的 OAuth 2.0 客户端 ID 列表,以英文逗号分隔,不含空格。应用可以包括移动应用或桌面应用。如果您不需要配置其他受众群体,请移除占位符,使括号为空 (additionalAudiences=[])。对于 Google Identity Platform,请使用如果您要为 CSE 使用 Google 身份中提供的客户端 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 值。您将在在 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 的 Web 应用客户端 ID。
      • 其他 JWT 受众群体:可选:为您配置的非 Web 平台应用提供客户端 ID。对于 Google Identity Platform,请使用如果您要为 CSE 使用 Google 身份中提供的客户端 ID。
    • 访客 IdP 详细信息:可选:如果您使用的是访客 IdP,请填写此部分。

      • 访客 IdP JWKS 网址:访客 IdP 的 JWKS 网址。
      • 访客 JWT 令牌颁发者:访客 IdP 的 JWT 令牌颁发者。
      • 访客 JWT 受众:访客 IdP 的 Web 应用客户端 ID(Google Meet 除外)。
      • 访客其他 JWT 受众群体:可选:如果您配置了 Google Meet Web 客户端 ID 或其他非 Web 平台应用客户端 ID,请为每个客户端 ID 提供客户端 ID。对于 Google Identity Platform,请使用如果您要为 CSE 使用 Google 身份中提供的客户端 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 客户端加密功能中配置 CHGWS 端点

创建 CHGWS 端点后,前往 Google Workspace 管理控制台,将 Google Workspace 配置为使用该端点。管理控制台中的端点网址和 IdP 设置必须与 CHGWS 端点的详细信息一致。如果您更新了 CHGWS 端点的配置,则还必须更新 Google Workspace 管理控制台中的密钥服务配置,以匹配更新后的详细信息。如需了解详情,请参阅添加和管理密钥服务以启用客户端加密功能。

密钥服务迁移

CHGWS 可让您灵活地将密钥服务迁移到 CHGWS 或从 CHGWS 迁移。如需开始密钥服务迁移,请与您的客户代表联系,以获取提交迁移请求方面的帮助。在请求中,添加以下信息:

  • 端点 ID:CHGWS 的端点 ID。
  • 密钥服务网址:用于启用密钥服务迁移的网址列表。

    • 如果您要迁移到 Cloud HSM for Google Workspace,请提供您要从中迁移的每个密钥服务终端节点的基础网址。
    • 如果您从 Cloud HSM for Google Workspace 迁移,请提供要迁移到的密钥服务端点的基础网址。

使用自助式 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 的 Web 应用 OAuth 2.0 客户端 ID。
      • ADDITIONAL_IDP_AUDIENCES:可选:非 Web 平台应用(例如 Android、iOS 或桌面应用)的 OAuth 2.0 客户端 ID 的逗号分隔列表,以英文逗号分隔,不含空格。如果您不需要配置其他受众群体,请移除占位符,使方括号留空 (additionalAudiences=[])。对于 Google Identity Platform,请使用如果您要为 CSE 使用 Google 身份中提供的客户端 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 的 Web 应用 OAuth 2.0 客户端 ID(Google Meet 除外)。
      • GUEST_ADDITIONAL_IDP_AUDIENCES:可选:如果您为访客 IdP 配置了 Google Meet Web 客户端 ID 或其他非 Web 平台应用客户端 ID,则此处为以英文逗号分隔的 OAuth 2.0 客户端 ID 列表(以英文逗号分隔,不含空格)。如果您不需要配置其他受众群体,请移除占位符,使括号为空 (additionalAudiences=[])。对于 Google Identity Platform,请使用如果您要为 CSE 使用 Google 身份中提供的客户端 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。

如需重新启用通过停用支持端点的 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 状态,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 小时内停止。

如果您想继续使用 Cloud HSM for Google Workspace,可以为项目重新启用结算功能。重新启用结算功能后,系统会恢复收取订阅费用,并且您的 CHGWS 端点和 Cloud KMS 密钥会再次正常运行。

请求手动停用或启用

如果您通过请求 CHGWS 端点完成了初始配置,并且需要在保持其他项目资源处于活跃状态的同时停用该端点,请提交与初始配置请求类似的请求。提供 Google Workspace 详细信息、CHGWS 端点 ID 和其他相关详细信息,并说明您的要求。手动工单可能需要 48 小时才能由 CHGWS 团队完成。请求完成后,Cloud HSM for Google Workspace 订阅费用预计会在 24 小时内停止。

您可以通过创建类似请求来重新启用 CHGWS 端点及其结算功能。

删除或恢复项目

您可以删除包含适用于 Google Workspace 的 Cloud HSM 的 Cloud KMS 密钥的项目。删除项目会停止项目中的所有服务。您可以在删除项目后的 30 天内恢复已删除的项目。不过,项目中的 Cloud KMS 密钥无法恢复,因此使用已恢复项目中的密钥加密的所有文档和其他数据仍会永久加密销毁。恢复已删除的项目会恢复 Cloud HSM for Google Workspace 的订阅费用,即使 Cloud KMS 密钥仍然无法恢复。

后续步骤