Nesta página, descrevemos como integrar o Cloud HSM para Google Workspace (CHGWS), o serviço de chaves de criptografia para o Google Workspace oferecido pelo Cloud Key Management Service (Cloud KMS). O Cloud HSM para Google Workspace oferece controles de privacidade aprimorados para o Google Workspace, ajudando você a atingir padrões regulatórios, como o DISA IL5, e aumentar segurança de dados. O Cloud HSM é um serviço de gerenciamento de chaves totalmente gerenciado, altamente disponível e alinhado aos padrões, operado em escala de nuvem com chaves protegidas por hardware armazenadas em HSMs (módulos de segurança de hardware) em conformidade com o FIPS 140-2 nível 3.
O CHGWS é compatível com as chaves do Cloud HSM multilocatário e de locatário único.
Para mais informações, consulte Cloud HSM para Google Workspace.
Suporte automatizado para integração
O Admin Console do Google Workspace tem um processo de integração automatizado que é consideravelmente mais rápido do que a integração manual. No entanto, a integração automatizada só será aceita se você atender a todos os critérios a seguir:
- Você está configurando a criptografia do lado do cliente Google Workspace (CSE) pela primeira vez.
- Você está usando o Google Identity como seu provedor de identidade (IdP).
- Você está usando chaves do Cloud HSM multilocatário.
Se você atender a todos esses critérios, acesse o Admin Console e conclua o processo de integração automatizado.
Você precisará fazer a integração manualmente se atender a um dos seguintes critérios:
- Você usa um IdP de terceiros.
- Você usa o Cloud HSM de locatário único.
- Você planeja migrar chaves de outro serviço de chaves.
- Você quer modificar uma configuração atual do Cloud HSM para Google Workspace.
Se você atender a qualquer um desses critérios, siga as instruções de configuração neste documento.
Antes de começar
Antes de integrar o Cloud HSM para o Google Workspace, conclua os seguintes pré-requisitos:
- Configure o Google Workspace.
- Ative a criptografia do lado do cliente Google Workspace (CSE) no Google Workspace.
- Configure seu provedor de identidade (IdP) na CSE do Google Workspace. Anote o ID do cliente do IdP. Se você usa o Google Identity Platform, encontre o ID do cliente no projeto do Google Cloud .
- Opcional: se você permitir o acesso ao conteúdo criptografado por CSE em aplicativos de plataforma que não sejam da Web (como dispositivos móveis ou computadores), adicione os IDs do cliente dessas plataformas às configurações do IdP no Admin Console do Google Workspace. Anote todos os IDs de cliente desse IdP. Se você usa o Google Identity Platform, encontre esses IDs de cliente no seu projeto do Google Cloud . Para outros provedores de identidade, crie esses IDs de cliente separadamente.
Locais compatíveis
É possível armazenar as chaves do Cloud KMS em qualquer local regional ou multirregional nas áreas geográficas dos EUA ou da Europa. O Cloud HSM para Google Workspace oferece suporte a chaves do Cloud HSM multilocatário e de locatário único. Para encontrar um local específico, acesse Locais do Cloud KMS e filtre pelo tipo de HSM.
O Cloud HSM para Google Workspace fornece automaticamente o endpoint em uma das seguintes multirregiões mais próximas do local da chave:
useur3
Configurar um projeto do Google Cloud para o Cloud KMS
Os endpoints do Cloud HSM para Google Workspace dependem de chaves do Cloud KMS para operações criptográficas. Configure um novo projeto do Google Cloud para hospedar as chaves do Cloud KMS.
Crie um projeto do Google Cloud . Este é seu projeto principal. Anote o ID e o número do projeto. Você vai precisar deles para concluir a configuração.
Ative a API Cloud KMS no seu projeto de chave do Google Cloud .
Ative a API Workspace Key Access (pré-lançamento) no seu projeto de chave doGoogle Cloud .
No console do Google Cloud , clique em terminal Ativar o Cloud Shell.
Verifique se você está no projeto correto comparando o ID do projeto com o ID do projeto no prompt do Cloud Shell.
Usando o Cloud Shell, crie a conta de serviço do Cloud HSM para o Google Workspace:
gcloud beta services identity create \ --service=cloudkmskacls-pa.googleapis.comAnote a identidade de serviço criada por esse comando. Você vai precisar do nome da identidade de serviço na próxima etapa.
Conceda os papéis Agente de serviço de chave do CHGWS e Navegador à conta de serviço que você criou:
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/browserSubstitua:
PROJECT_ID: o ID do projeto da chave.PROJECT_NUMBER: o número do projeto de chave.
Conceda o papel de administrador da API Workspace Key Access (
roles/workspacekeyaccess.admin) (pré-lançamento) ao administrador que cria e gerencia as configurações e os endpoints do CHGWS:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=user:ADMIN_USER_EMAIL \ --role=roles/workspacekeyaccess.adminSubstitua:
PROJECT_ID: o ID do projeto da chave.ADMIN_USER_EMAIL: o endereço de e-mail do administrador doGoogle Cloud que cria e gerencia as configurações e os endpoints do CHGWS.
Configurar chaves do Cloud KMS
Configure os recursos do Cloud KMS para o endpoint de serviço de chave do CHGWS.
Crie um keyring em uma das regiões com disponibilidade:
gcloud kms keyrings create KEY_RING --location LOCATIONSubstitua:
KEY_RING: o nome que você quer usar para o keyring do CHGWS, por exemplo,CHGWS_KEY_RING.LOCATION: o local em que você quer criar o keyring, por exemplo,us.
Crie uma chave do Cloud HSM.
Cloud HSM multilocatário
Para criar uma chave com o nível de proteção
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_TIMESubstitua:
KEY_NAME: o nome que você quer usar para a chave, por exemplo,CHGWS_KEY.KEY_RING: o nome do keyring, por exemplo,CHGWS_KEY_RING.LOCATION: o local em que você criou o keyring, por exemplo,us.ROTATION_PERIOD: a frequência com que você quer alternar as chaves, por exemplo,7d.NEXT_ROTATION_TIME: a data e a hora em que a próxima rotação de chaves ocorre, por exemplo,2024-03-20T01:00:00.
Cloud HSM de locatário único
Para criar uma chave com o nível de proteção
hsm_single_tenant, primeiro é necessário ter uma instância do Cloud HSM de locatário único provisionada no mesmo local.Crie e provisione uma instância de Cloud HSM de locatário único: siga as instruções no guia Criar e gerenciar uma instância de Cloud HSM de locatário único. Anote o ID da instância provisionada. Você vai usar isso na próxima etapa.
Crie uma chave:
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_TIMESubstitua:
KEY_NAME: o nome que você quer usar para a chave, por exemplo,CHGWS_KEY.KEY_RING: o nome do keyring, por exemplo,CHGWS_KEY_RING.LOCATION: o local em que você criou o keyring, por exemplo,us.PROJECT_ID: o ID do projeto da chave.INSTANCE_NAME: o nome da instância de locatário único do Cloud HSM em que você quer criar a chave.ROTATION_PERIOD: a frequência com que você quer fazer a rotação das chaves, por exemplo,7d.NEXT_ROTATION_TIME: a data e a hora em que a próxima rotação de chaves ocorre, por exemplo,2024-03-20T01:00:00.
Para mais detalhes sobre as opções de criação de chaves, consulte Como criar chaves.
Integração usando a API Workspace Key Access de autoatendimento
Use a Google Cloud CLI com a API Workspace Key Access para criar e gerenciar os seguintes recursos do CHGWS:
- Config: armazena os detalhes da organização do Google Workspace e do IdP, incluindo o ID de cliente, os endereços de e-mail do administrador, os domínios permitidos e os parâmetros de autenticação do JSON Web Token (JWT).
- Endpoint: conecta sua configuração do CHGWS à
chave do Cloud KMS e fornece o URL do serviço de chaves (
uri) que você registra no Admin Console do Google Workspace para a CSE.
As seções a seguir mostram como criar e gerenciar as configurações e os endpoints do CHGWS usando a Google Cloud CLI.
Como alternativa, você pode solicitar um endpoint do CHGWS entrando em contato com o representante da conta.
Criar configurações do CHGWS
A configuração do CHGWS armazena informações sobre sua organização do Google Workspace e os provedores de identidade (IdPs) que seus usuários usam para autenticação. É possível usar o CHGWS apenas com um IdP principal ou configurar um IdP principal e um convidado.
Para configurar o CHGWS para usar apenas um IdP principal, faça o seguinte:
Crie uma configuração do CHGWS para registrar seu Google Workspace usando o comando
workspace-key-access configs create: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] 'Substitua:
CONFIG_ID: um identificador para sua configuração, por exemplo,my-workspace-config.PROJECT_ID: o ID do projeto da chave.ENDPOINT_LOCATION: o local em que você quer criar sua configuração, por exemplo,us. Especifique um dos locais compatíveis.CUSTOMER_ID: seu ID de cliente do Google Workspace. Para encontrar seu ID de cliente, consulte Encontrar seu ID de cliente.ADMIN_EMAILS: uma lista separada por vírgulas de endereços de e-mail de administrador do Google Workspace.OWNER_DOMAINS: uma lista separada por vírgulas de domínios de clientes do Google Workspace permitidos em que você registra o serviço de chaves. Encontre seus domínios no Admin Console do Google Workspace na página Gerenciar domínios.IDP_ISSUER: o URL do emissor do JWT do IdP principal. Para o Google Identity Platform, usehttps://accounts.google.com.IDP_JWKS_URI: o URL do conjunto de chaves da Web JSON (JWKS, na sigla em inglês) do IdP principal. Para o Google Identity Platform, usehttps://www.googleapis.com/oauth2/v3/certs.IDP_AUDIENCE: o ID do cliente OAuth 2.0 do IdP principal para aplicativos da Web.ADDITIONAL_IDP_AUDIENCES: opcional: uma lista de IDs de cliente OAuth 2.0 para aplicativos de plataforma não web, separados por vírgulas sem espaços. Os aplicativos podem ser para dispositivos móveis ou computadores. Se não for necessário configurar outros públicos-alvo, remova o marcador de posição para que os colchetes fiquem vazios (additionalAudiences=[]). Para o Google Identity Platform, use os IDs do cliente fornecidos em Se você vai usar a identidade do Google para a CSE.
Para mais informações sobre as flags disponíveis, consulte
gcloud beta workspace-key-access configs create.
Para configurar o CHGWS para usar um IdP principal e um de visitante, faça o seguinte:
Crie uma configuração do CHGWS para registrar seu Google Workspace usando o comando
workspace-key-access configs createe especifique a flag--idp-configsduas vezes: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] 'Substitua:
CONFIG_ID: um identificador para sua configuração, por exemplo,my-workspace-config.PROJECT_ID: o ID do projeto da chave.ENDPOINT_LOCATION: o local em que você quer criar sua configuração, por exemplo,us. Especifique um dos locais compatíveis.CUSTOMER_ID: seu ID de cliente do Google Workspace. Para encontrar seu ID de cliente, consulte Encontrar seu ID de cliente.ADMIN_EMAILS: uma lista separada por vírgulas de endereços de e-mail de administrador do Google Workspace.OWNER_DOMAINS: uma lista separada por vírgulas de domínios de clientes do Google Workspace permitidos em que você registra o serviço de chaves. Encontre seus domínios no Admin Console do Google Workspace na página Gerenciar domínios.IDP_ISSUER: o URL do emissor do JWT do IdP principal. Para o Google Identity Platform, usehttps://accounts.google.com.IDP_JWKS_URI: o URL do conjunto de chaves da Web JSON (JWKS, na sigla em inglês) do IdP principal. Para o Google Identity Platform, usehttps://www.googleapis.com/oauth2/v3/certs.IDP_AUDIENCE: o ID do cliente OAuth 2.0 do IdP principal para aplicativos da Web.ADDITIONAL_IDP_AUDIENCES: opcional: uma lista de IDs de cliente OAuth 2.0 para aplicativos de plataforma não web, separados por vírgulas sem espaços. Os aplicativos podem ser para dispositivos móveis ou computadores. Se não for necessário configurar outros públicos-alvo, remova o marcador de posição para que os colchetes fiquem vazios (additionalAudiences=[]). Para o Google Identity Platform, use os IDs do cliente fornecidos em Se você vai usar a identidade do Google para a CSE.GUEST_IDP_ISSUER: o URL do emissor do JWT do IdP convidado. Para o Google Identity Platform, usehttps://accounts.google.com.GUEST_IDP_JWKS_URI: o URL do JWKS do IdP convidado. Para o Google Identity Platform, usehttps://www.googleapis.com/oauth2/v3/certs.GUEST_IDP_AUDIENCE: o ID do cliente OAuth 2.0 do IdP de convidado para aplicativos da Web, exceto o Google Meet.GUEST_ADDITIONAL_IDP_AUDIENCES: opcional: uma lista de IDs de cliente OAuth 2.0 para aplicativos de plataforma que não são da Web que você configura para o IdP convidado, separados por vírgulas sem espaços. Os aplicativos podem ser para dispositivos móveis ou computadores. Se você não precisar configurar outros públicos-alvo, remova o marcador de posição para que os colchetes fiquem vazios (additionalAudiences=[]). Para o Google Identity Platform, use os IDs do cliente fornecidos em Se você vai usar a identidade do Google para a CSE.
Para mais informações sobre as flags disponíveis, consulte
gcloud beta workspace-key-access configs create.
Opcional: para verificar se a configuração está correta, faça o seguinte:
Descreva a configuração para conferir os detalhes dela:
gcloud beta workspace-key-access configs describe CONFIG_ID \ --project=PROJECT_ID \ --location=ENDPOINT_LOCATION
Criar um endpoint do CHGWS
Crie um endpoint serviço de chaves do CHGWS e anexe-o à configuração do CHGWS e à chave do 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_NAMESubstitua:
ENDPOINT_ID: um identificador para o endpoint do serviço de chaves, por exemplo,my-kacls-endpoint.PROJECT_ID: o ID do projeto da chave.ENDPOINT_LOCATION: o local da configuração e do endpoint, por exemplo,us. Especifique um dos locais compatíveis.CONFIG_ID: o ID da configuração que você criou anteriormente.LOCATION: o local em que você criou o keyring do Cloud KMS. Por exemplo,us.KEY_RING: o nome do keyring do Cloud KMS.KEY_NAME: o nome da chave do Cloud KMS.
Descreva o endpoint para recuperar o
urigerado e verifique se ostateéACTIVE:gcloud beta workspace-key-access endpoints describe ENDPOINT_ID \ --project=PROJECT_ID \ --location=ENDPOINT_LOCATIONCopie o valor
urida saída. Você vai usar esse URL em Configurar o endpoint do CHGWS na CSE do Google Workspace.
Solicitar um endpoint do CHGWS
Para solicitar a integração e a criação de endpoints, entre em contato com o representante da sua conta para receber ajuda e forneça as seguintes informações:
Detalhes do Google Workspace:
ID de cliente do Google Workspace: seu ID de cliente do Google Workspace. Para encontrar seu ID de cliente, consulte Encontrar seu ID de cliente.
Endereços de e-mail do admin do Google Workspace: forneça uma lista separada por vírgulas de endereços de e-mail do administrador.
Detalhes do IdP:
Detalhes do IdP principal:
- URL do JWKS do IdP: para o Google Identity Platform,
use
https://www.googleapis.com/oauth2/v3/certs. - Emissor do token JWT: para o Google Identity Platform,
use
https://accounts.google.com. - Público-alvo do JWT: o ID do cliente do IdP para aplicativos da Web.
- Públicos-alvo adicionais do JWT: opcional. Forneça IDs do cliente para aplicativos de plataforma que não sejam da Web que você configurar. Para o Google Identity Platform, use os IDs de cliente fornecidos em Se você vai usar a identidade do Google para a CSE.
- URL do JWKS do IdP: para o Google Identity Platform,
use
Detalhes do IdP convidado: opcional: preencha esta seção se estiver usando um IdP convidado.
- URL do JWKS do IdP para convidados: o URL do JWKS do IdP para convidados.
- Emissor do token JWT de convidado: o emissor do token JWT do IdP de convidado.
- Público-alvo do JWT de convidado: o ID do cliente do IdP de convidado para aplicativos da Web, exceto o Google Meet.
- Públicos-alvo adicionais do JWT para convidados: opcional. Se você configurar um ID do cliente da Web do Google Meet ou outros IDs de cliente de aplicativos de plataforma não Web, forneça os IDs de cliente para cada um. Para o Google Identity Platform, use os IDs de cliente fornecidos em Se você vai usar a identidade do Google para a CSE.
Detalhes importantes da CSE:
- ID do projeto doGoogle Cloud :
PROJECT_ID - Número do projeto doGoogle Cloud :
PROJECT_NUMBER - Nome do keyring do Cloud KMS:
KEY_RING - Local do keyring do Cloud KMS:
LOCATION - Nome da chave do Cloud KMS:
KEY_NAME - Nível de proteção da chave do Cloud KMS:
hsmouhsm_single_tenant - URL de base do CHGWS: opcional. Uma lista de URLs para ativar a migração de chaves. Se você estiver configurando o CHGWS pela primeira vez para este Google Workspace, deixe esse campo em branco.
- ID do projeto doGoogle Cloud :
Mais detalhes:
- Nome do cliente: informe o nome do cliente.
- Número esperado de usuários: informe o número esperado de usuários na sua instância do Google Workspace.
Gerenciar endpoints de serviço do CHGWS
As seções a seguir mostram como gerenciar os endpoints do CHGWS.
Configurar o endpoint do CHGWS na CSE do Google Workspace
Depois de criar um endpoint do CHGWS, acesse o Admin Console do Google Workspace para configurar o Google Workspace para usar o endpoint. O URL do endpoint e as configurações do IdP no Admin Console precisam corresponder aos detalhes do endpoint do CHGWS. Se você atualizar a configuração do endpoint do CHGWS, também precisará atualizar a configuração do serviço de chaves no Admin Console do Google Workspace para que corresponda aos detalhes atualizados. Saiba mais em Adicionar e gerenciar serviços de chaves para criptografia do lado do cliente.
Migração do serviço de chaves
O CHGWS oferece flexibilidade para mover seu serviço de chaves para ou do CHGWS. Para iniciar uma migração de serviço de chaves, entre em contato com o representante da sua conta para receber ajuda com o envio de uma solicitação de migração. Na solicitação, inclua as seguintes informações:
- ID do endpoint: o ID do endpoint do CHGWS.
URL do serviço de chaves: uma lista de URLs para ativar a migração do serviço de chaves.
- Se você migrar para o Cloud HSM para Google Workspace, forneça o URL de base de cada endpoint de serviço de chaves de onde você está migrando.
- Se você estiver migrando do Cloud HSM para o Google Workspace, informe os URLs de base dos endpoints do serviço de chaves para onde quer migrar.
Atualizar uma configuração usando a API Workspace Key Access de autoatendimento
É possível atualizar os endereços de e-mail do administrador, os domínios de clientes permitidos ou os detalhes do IdP de uma configuração atual do CHGWS usando a CLI gcloud. A atualização de uma configuração atualiza automaticamente todos os endpoints que usam a configuração.
Atualize a configuração do CHGWS. Inclua apenas as sinalizações dos campos que você quer atualizar e remova as sinalizações dos campos que você quer manter inalterados. Cada sinalização incluída substitui os valores atuais desse campo:
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] 'Substitua:
CONFIG_ID: o ID da configuração que você quer atualizar.PROJECT_ID: o ID do projeto da chave.ENDPOINT_LOCATION: o local da configuração, por exemplo,us. Especifique um dos locais compatíveis.ADMIN_EMAILS: opcional: uma lista separada por vírgulas de endereços de e-mail de administrador do Google Workspace. Remova--admin-emailsse você não quiser atualizar os endereços de e-mail do administrador.OWNER_DOMAINS: opcional: uma lista separada por vírgulas de domínios de clientes do Google Workspace permitidos em que você registra o serviço de chaves. Encontre seus domínios no Admin Console do Google Workspace na página Gerenciar domínios. Remova--kacls-owner-domainsse não quiser atualizar os domínios de cliente permitidos.--idp-configs:- Se você configurou apenas um IdP principal: remova a segunda
flag
--idp-configs(GUEST_IDP) (e a barra invertida no final da linha anterior) e atualize os detalhes na flagPRIMARY_IDP. Seu IdP convidado continua sem definição. - Se você configurou um IdP principal e um IdP convidado: é
necessário incluir as duas flags
--idp-configs, mesmo que você esteja atualizando apenas uma delas. Se você omitir a flagGUEST_IDP, o IdP convidado será substituído como não definido. Se você omitir a flagPRIMARY_IDP, a atualização vai falhar. - Se você não quiser atualizar nenhum IdP: remova as duas flags
--idp-configspara que os detalhes do IdP atual permaneçam inalterados.
- Se você configurou apenas um IdP principal: remova a segunda
flag
- Detalhes do IdP principal: obrigatório sempre que você incluir
--idp-configs:IDP_ISSUER: o URL do emissor do JWT do seu IdP principal. Para o Google Identity Platform, usehttps://accounts.google.com.IDP_JWKS_URI: o URL do JWKS do IdP principal. Para o Google Identity Platform, usehttps://www.googleapis.com/oauth2/v3/certs.IDP_AUDIENCE: o ID do cliente OAuth 2.0 do IdP principal para aplicativos da Web.ADDITIONAL_IDP_AUDIENCES: opcional: uma lista separada por vírgulas de IDs de cliente OAuth 2.0 para aplicativos de plataforma que não são da Web (como aplicativos para Android, iOS ou computador), separados por vírgulas sem espaços. Se você não precisar configurar outros públicos-alvo, remova o marcador de posição para que os colchetes fiquem vazios (additionalAudiences=[]). Para o Google Identity Platform, use os IDs do cliente fornecidos em Se você vai usar a identidade do Google para a CSE.
- Detalhes do IdP convidado: opcional, obrigatório apenas quando você inclui a
segunda flag
--idp-configs(GUEST_IDP):GUEST_IDP_ISSUER: o URL do emissor do JWT do IdP convidado. Para o Google Identity Platform, usehttps://accounts.google.com.GUEST_IDP_JWKS_URI: o URL do JWKS do IdP convidado. Para o Google Identity Platform, usehttps://www.googleapis.com/oauth2/v3/certs.GUEST_IDP_AUDIENCE: o ID do cliente OAuth 2.0 do IdP de convidado para aplicativos da Web, exceto para o Google Meet.GUEST_ADDITIONAL_IDP_AUDIENCES: opcional: uma lista separada por vírgulas de IDs de cliente OAuth 2.0 se você configurar um ID do cliente da Web do Google Meet ou outros IDs de cliente de aplicativos de plataforma que não sejam da Web para seu IdP convidado (separados por vírgulas sem espaços). Se não for necessário configurar outros públicos-alvo, remova o marcador de posição para que os colchetes fiquem vazios (additionalAudiences=[]). Para o Google Identity Platform, use os IDs de cliente fornecidos em Se você vai usar a identidade do Google para a CSE.
Para mais informações sobre as flags disponíveis, consulte
gcloud beta workspace-key-access configs update.Opcional: revise os detalhes da configuração para confirmar se ela foi atualizada corretamente:
gcloud beta workspace-key-access configs describe CONFIG_ID \ --project=PROJECT_ID \ --location=ENDPOINT_LOCATIONOpcional: se você tiver uma configuração não utilizada que não esteja anexada a nenhum endpoint, poderá excluí-la:
gcloud beta workspace-key-access configs delete CONFIG_ID \ --project=PROJECT_ID \ --location=ENDPOINT_LOCATION
Atualizar um endpoint para usar uma configuração diferente
É possível anexar um endpoint do CHGWS a uma configuração diferente no mesmo projeto e local do Google Cloud . No entanto, não é possível alterar a chave de apoio do Cloud KMS associada a um endpoint.
Atualize a configuração anexada a um endpoint:
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
Substitua:
ENDPOINT_ID: o ID do endpoint do serviço de chaves que você quer atualizar.PROJECT_ID: o ID do projeto da chave.ENDPOINT_LOCATION: o local do endpoint e da configuração, por exemplo,us. Especifique um dos locais compatíveis.NEW_CONFIG_ID: o ID da configuração no mesmo projeto e local que você quer anexar ao endpoint.
Solicitar atualizações para um endpoint
Se você fez a integração solicitando um endpoint do CHGWS e precisa atualizar os detalhes do CHGWS, entre em contato com o representante da sua conta para enviar uma solicitação de atualização. Na solicitação, inclua seu ID de cliente do Google Workspace, o ID do projeto do Google Cloud e o ID do endpoint do CHGWS, além dos endereços de e-mail atualizados do administrador do Google Workspace ou os detalhes do IdP listados em Solicitar um endpoint do CHGWS.
Desativar e ativar endpoints e faturamento
Não é possível excluir um endpoint do CHGWS. No entanto, se você fez a integração do endpoint por conta própria, é possível desativar ou reativar um endpoint usando o Workspace Key Access com a CLI gcloud. A desativação de um endpoint
o faz passar para o estado DISABLED e encerra a assinatura de faturamento.
Para desativar um endpoint que você integrou por conta própria, faça o seguinte:
Desative o endpoint ativo e o faturamento:
gcloud beta workspace-key-access endpoints disable ENDPOINT_ID \ --project=PROJECT_ID \ --location=ENDPOINT_LOCATIONSubstitua:
ENDPOINT_ID: o ID do endpoint de serviço de chaves que você quer desativar.PROJECT_ID: o ID do projeto da chave.ENDPOINT_LOCATION: o local do endpoint. Por exemplo,us. Especifique um dos locais compatíveis.
Antes de reativar um endpoint, a chave do Cloud KMS e as versões de chave
usadas por ele precisam estar acessíveis e ativas. A ativação
de um endpoint reinicia a assinatura de faturamento e faz a transição do endpoint para
o estado ACTIVE.
Para reativar um endpoint que você desativou usando o comando workspace-key-access
endpoints disable, faça o seguinte:
Reative o endpoint e reinicie o faturamento:
gcloud beta workspace-key-access endpoints enable ENDPOINT_ID \ --project=PROJECT_ID \ --location=ENDPOINT_LOCATIONSubstitua:
ENDPOINT_ID: o ID do endpoint de serviço de chaves que você quer ativar.PROJECT_ID: o ID do projeto da chave.ENDPOINT_LOCATION: o local do endpoint. Por exemplo,us. Especifique um dos locais compatíveis.
Desativar e ativar versões de chave subjacentes
Independentemente de como você integrou o endpoint, é possível desativar as versões de chave do Cloud KMS no Cloud KMS usando o console doGoogle Cloud , a CLI gcloud ou a API Cloud KMS. Desativar as versões de chave subjacentes desativa o endpoint sem encerrar a assinatura de faturamento. Em seguida, é possível desativar o faturamento separadamente.
Para desativar as versões de chave, faça o seguinte:
Para cada versão de chave do Cloud KMS que dá suporte ao endpoint, execute o seguinte comando:
gcloud kms keys versions disable KEY_VERSION --keyring \ KEY_RING --location LOCATION --key KEY_NAMESubstitua:
KEY_VERSION: a versão da chave que você quer desativar, por exemplo,1.KEY_RING: o nome do keyring, por exemplo,CHGWS_KEY_RING.LOCATION: o local da versão da chave que você quer desativar, por exemplo,us.KEY_NAME: o nome da chave, por exemplo,CHGWS_KEY.
Para reativar um endpoint do CHGWS que você desativou ao desativar todas as versões da chave do Cloud KMS que o sustenta, faça o seguinte:
Para cada versão de chave do Cloud KMS que dá suporte ao endpoint, execute o seguinte comando:
gcloud kms keys versions enable KEY_VERSION --keyring \ KEY_RING --location LOCATION --key KEY_NAMESubstitua:
KEY_VERSION: a versão da chave que você quer ativar, por exemplo,1.KEY_RING: o nome do keyring, por exemplo,CHGWS_KEY_RING.LOCATION: o local da versão da chave que você quer ativar, por exemplo,us.KEY_NAME: o nome da chave, por exemplo,CHGWS_KEY.
Gerenciar o faturamento do CHGWS
O faturamento começa assim que o endpoint do CHGWS é criado e
ativado. A partir desse momento, as cobranças recorrentes da assinatura do Cloud HSM para Google Workspace vão continuar enquanto o endpoint permanecer ACTIVE no projeto doGoogle Cloud . Nesta seção, explicamos as diferentes maneiras de
interromper as cobranças do Cloud HSM para o Google Workspace e como retomá-las.
Desativar e ativar endpoints
Se você tiver integrado seu endpoint por conta própria, use a
API Workspace Key Access para desativar um endpoint do CHGWS
e manter ativos outros recursos no seu projeto do Google Cloud .
A desativação de um endpoint faz a transição para o estado DISABLED e encerra a
assinatura de faturamento. Depois, é possível reativar o endpoint para reiniciar a
assinatura de faturamento e fazer a transição de volta para o estado ACTIVE.
Para mais informações, consulte Desativar e ativar endpoints e faturamento.
Desativar ou ativar o faturamento do projeto
É possível desativar o faturamento do projeto que contém as chaves do Cloud KMS para o Cloud HSM para Google Workspace. Desativar o faturamento faz com que todos os serviços cobráveis do projeto parem de funcionar. Depois que o faturamento no nível do projeto for desativado, as cobranças da assinatura do Cloud HSM para Google Workspace vão parar em até 24 horas.
Quando quiser voltar a usar o Cloud HSM para o Google Workspace, reative o faturamento no projeto. Depois que o faturamento for reativado, as taxas de assinatura serão retomadas, e o endpoint do CHGWS e as chaves do Cloud KMS voltarão a funcionar normalmente.
Solicitar desativação ou ativação manual
Se você fez a integração solicitando um endpoint do CHGWS e precisa desativá-lo, mas quer manter outros recursos do projeto ativos, envie uma solicitação semelhante à solicitação de integração. Forneça os detalhes do Google Workspace, o ID do endpoint do CHGWS e outros detalhes relevantes e descreva seu requisito. Os tíquetes manuais podem levar 48 horas para serem concluídos pela equipe do CHGWS. Depois que a solicitação for concluída, as cobranças da assinatura do Cloud HSM para Google Workspace vão parar em até 24 horas.
É possível reativar o endpoint do CHGWS e o faturamento dele criando uma solicitação semelhante.
Excluir ou restaurar o projeto
É possível excluir o projeto que contém as chaves do Cloud KMS para o Cloud HSM para Google Workspace. A exclusão de um projeto interrompe todos os serviços dele. É possível recuperar um projeto excluído em até 30 dias após a exclusão. No entanto, as chaves do Cloud KMS no projeto não podem ser recuperadas. Portanto, todos os documentos e outros dados criptografados com chaves no projeto restaurado permanecem permanentemente criptografados. A restauração de um projeto excluído retoma as cobranças de assinatura do Cloud HSM para o Google Workspace, mesmo que as chaves do Cloud KMS permaneçam irrecuperáveis.
A seguir
- Saiba mais sobre o Cloud HSM para Google Workspace.
- Confira as práticas recomendadas do Cloud HSM para o Google Workspace.
- Saiba mais sobre o Cloud Key Management Service.
- Saiba como adicionar e gerenciar serviços de chaves para a criptografia do lado do cliente.
- Saiba como configurar automaticamente a criptografia do lado do cliente pela primeira vez.