Usar chaves de criptografia gerenciadas pelo cliente

Por padrão, o Cloud Scheduler criptografa o conteúdo do cliente em repouso. O Cloud Scheduler processa a criptografia para você sem que você precise fazer nada. Essa opção é chamada de criptografia padrão do Google.

Se você quiser controlar suas chaves de criptografia, use chaves de criptografia gerenciadas pelo cliente (CMEKs) no Cloud KMS com serviços integrados a CMEKs, incluindo o Cloud Scheduler. Ao usar chaves do Cloud KMS, é possível controlar o nível de proteção, o local, a programação de rotação, as permissões de uso e acesso e os limites criptográficos. Com o Cloud KMS, também é possível visualizar registros de auditoria e controlar ciclos de vida de chaves. Em vez de o Google ser proprietário e gerente de chaves de criptografia de chaves (KEKs) simétricas que protegem seus dados, você controla e gerencia essas chaves no Cloud KMS.

Depois de configurar os recursos com CMEKs, a experiência de acesso aos recursos do Cloud Scheduler é semelhante à criptografia padrão do Google. Para saber mais sobre suas opções de criptografia, consulte Chaves de criptografia gerenciadas pelo cliente (CMEK).

O que é protegido com a CMEK

É possível especificar uma chave do Cloud KMS por projeto do Google Cloud e por região do Cloud Scheduler compatível. Essa chave é usada para proteger os seguintes dados nesse projeto e região:

  • Jobs com um destino de endpoint HTTP ou HTTPS: o corpo da solicitação HTTP e os cabeçalhos do cliente.
  • Jobs com um destino de tópico do Pub/Sub: o payload e os atributos da mensagem do Pub/Sub.

Antes de começar

Antes de usar CMEK no Cloud Scheduler, conclua as seguintes etapas de pré-requisito.

  1. Configure o ambiente.

  2. Atualize os componentes gcloud.

    gcloud components update

  3. Faça login usando sua conta.

    gcloud auth login

  4. Ative a API Cloud KMS para o projeto que armazena as chaves de criptografia:

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

    Substitua KMS_PROJECT_ID pelo ID do projeto que armazena as chaves do Cloud KMS. Pode ser o mesmo projeto dos jobs do Cloud Scheduler ou um projeto separado.

  5. O Cloud KMS produz registros de auditoria do Cloud quando as chaves são ativadas, desativadas ou usadas por recursos do Cloud Scheduler para criptografar e descriptografar dados.

    Verifique se a geração de registros está ativada para a API Cloud KMS no seu projeto e se você decidiu quais permissões e papéis específicos de geração de registros se aplicam ao seu caso de uso. Para mais informações, consulte Registros de auditoria do Cloud KMS.

Funções exigidas

Para receber as permissões necessárias para configurar CMEK para o Cloud Scheduler, peça ao administrador para conceder a você os seguintes papéis do IAM:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para configurar CMEK para o Cloud Scheduler. Para acessar as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para configurar CMEK para o Cloud Scheduler:

  • Conceda ao agente de serviço acesso à chave: cloudkms.cryptoKeys.setIamPolicy na chave, no keyring ou no projeto que contém a chave do Cloud KMS.
  • Ative ou desative a CMEK: cloudscheduler.cmekConfig.update no projeto do Cloud Scheduler
  • Confira o status da configuração ou status de funcionamento da CMEK:
    • cloudscheduler.cmekConfig.get no projeto do Cloud Scheduler
    • cloudscheduler.operations.get no projeto do Cloud Scheduler

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Criar um keyring e uma chave do Cloud KMS

Você pode criar um novo keyring ou usar um atual. No keyring, é possível adicionar uma nova chave ou usar uma atual. Recomendamos o uso de chaves diferentes para aplicativos, serviços ou ambientes distintos.

  1. Crie um keyring.

  2. Criar uma chave. A chave precisa usar o algoritmo de criptografia simétrica.

Conceder ao agente de serviço do Cloud Scheduler acesso à chave

Conceda ao agente de serviço do Cloud Scheduler o papel de criptografador/descriptografador de CryptoKey do Cloud KMS do Identity and Access Management (IAM) para que ele possa acessar a chave do Cloud KMS. Se você ativou recentemente a API Cloud Scheduler em um projeto e ainda não criou jobs, talvez seja necessário criar o agente de serviço executando gcloud beta services identity create --service=cloudscheduler.googleapis.com --project=PROJECT_ID.

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

Substitua:

  • KEY_NAME: o nome da chave, por exemplo, my-key.
  • KEY_RING: o nome do keyring, por exemplo, my-keyring.
  • LOCATION: o local da chave, por exemplo, us-central1.
  • KMS_PROJECT_ID: o ID do projeto em que a chave do Cloud KMS está localizada.
  • PROJECT_NUMBER: o número do projeto do Cloud Scheduler Google Cloud . Encontre o número do projeto na página Boas-vindas do console do Google Cloud ou executando o seguinte comando:

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

Desde que o agente de serviço tenha o papel roles/cloudkms.cryptoKeyEncrypterDecrypter, um job no seu projeto pode criptografar e descriptografar os dados usando a chave CMEK. Se você revogar esse papel ou se desativar ou destruir a chave CMEK, esses dados não poderão ser acessados. Neste documento, consulte Remover o Cloud KMS.

Ativar CMEK para uma região do Cloud Scheduler

Especifique a chave do Cloud KMS a ser usada para criptografia de dados em uma região do Cloud Scheduler usando o comando gcloud scheduler cmek-config update:

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

Substitua:

  • LOCATION: uma região compatível com o Cloud Scheduler.
  • KEY_NAME: o nome da chave, por exemplo, my-key.
  • KEY_RING: o nome do keyring, por exemplo, my-keyring.
  • KMS_PROJECT_ID: o ID do projeto em que a chave do Cloud KMS que você quer usar está localizada.

Observe o seguinte:

  • Ativar, alterar ou desativar uma chave CMEK no Cloud Scheduler é executado de forma assíncrona e retorna uma operação de longa duração (projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID). É possível verificar se a atualização foi concluída executando o comando gcloud scheduler operations describe.
  • O Cloud Scheduler criptografa jobs novos e atualizados no projeto e na região protegidos com a chave ativada. Os jobs atuais criptografados anteriormente com uma chave anterior são criptografados novamente com a nova chave.
  • Os jobs desprotegidos são criptografados.
  • A rotação de uma chave no Cloud KMS não criptografa novamente os jobs atuais nem muda os novos jobs na região para a nova versão da chave primária. Para mais informações, consulte Rotação de chaves CMEK.
  • Se você desativar a CMEK em uma região, os jobs atuais serão criptografados usando a criptografia padrão do Google, e os jobs subsequentes serão criados sem a criptografia de CMEK. Neste documento, consulte Desativar a CMEK para uma região do Cloud Scheduler.

Verificar a configuração do Cloud KMS

Verifique se a CMEK está ativada recuperando a configuração dela para uma região do Cloud Scheduler usando o comando gcloud scheduler cmek-config describe:

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

O resultado será o seguinte:

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

O valor kmsKeyName é o ID do recurso da chave do Cloud KMS usada para proteger os jobs na região.

Desativar a CMEK para uma região do Cloud Scheduler

É possível desativar a CMEK em uma região do Cloud Scheduler para que todos os jobs criados nessa região sejam criados sem a criptografia da CMEK.

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

Isso desativa a CMEK para a região específica, e todos os jobs subsequentes são criados sem criptografia CMEK. Os jobs atuais são criptografados usando a criptografia padrão do Google.

Remover o Cloud KMS

Se você quiser revogar o acesso aos dados dos seus jobs, remova o Cloud KMS de uma das seguintes maneiras:

  • Desative ou destrua a versão apropriada da sua chave de criptografia gerenciada pelo cliente. É possível verificar se uma versão de chave está em uso. A desativação de uma versão de chave CMEK suspende o acesso a todos os dados protegidos por essa versão até que a chave seja reativada. A destruição de uma versão de chave bloqueia permanentemente o acesso e pode causar perda de dados irrecuperável. Ambos afetam apenas os jobs associados à versão de chave específica.

    Não é possível visualizar os recursos protegidos pela versão de chave desativada ou destruída. Todas as execuções de jobs ativos falham com uma mensagem de erro correspondente.

  • Revogue o papel do IAM roles/cloudkms.cryptoKeyEncrypterDecrypter do agente de serviço do Cloud Scheduler. Isso afeta todos os jobs no projeto e na região específicos doGoogle Cloud que são compatíveis com a criptografia usando CMEK. Não é possível criar novos jobs integrados a CMEK nem visualizar ou listar jobs criptografados por CMEK, mas ainda é possível excluí-los. Todas as execuções de jobs ativos falham com uma mensagem de erro correspondente.

Embora nenhuma dessas operações garanta a revogação instantânea do acesso, as alterações do IAM geralmente entram em vigor mais rapidamente. Para mais informações, consulte Consistência de recursos do Cloud KMS e Propagação de alterações no acesso.

Sobre as restrições da política da organização de CMEK

O Cloud Scheduler é compatível com as seguintes restrições de política da organização, que podem ajudar a aplicar o uso de CMEK em uma organização:

  • constraints/gcp.restrictNonCmekServices: use essa restrição para exigir que as CMEKs sejam usadas para proteger todos os novos recursos do Cloud Scheduler em uma organização, pasta ou projeto.

    Se ativa, essa política da organização impede a criação ou atualização de recursos, a menos que você ative primeiro uma chave do Cloud KMS. Também não é possível desativar a CMEK em uma região do Cloud Scheduler.

  • constraints/gcp.restrictCmekCryptoKeyProjects: use essa restrição para garantir que os recursos do Cloud Scheduler protegidos por CMEK usem uma chave de um projeto aprovado.

    Por exemplo, é possível especificar uma regra semelhante a esta: "Para todos os recursos do Cloud Scheduler em projects/my-company-data-project, a chave do Cloud KMS usada neste projeto precisa vir de projects/my-company-central-keys OU projects/team-specific-keys".

Observe o seguinte:

  • Depois de aplicar uma política da organização de CMEK, ainda será possível acessar jobs que usam a criptografia padrão do Google. No entanto, não será possível atualizá-los, a menos que você configure primeiro uma chave do Cloud KMS aceitável para a região do Cloud Scheduler.

  • Os jobs que têm como destino um aplicativo do App Engine não estão sujeitos às políticas da organização de CMEK. Por exemplo, se você definir a restrição constraints/gcp.restrictNonCmekServices, ainda será possível criar ou atualizar um job que tenha como destino um aplicativo do App Engine.

Para saber mais sobre como configurar políticas da organização, consulte Políticas da organização de CMEK.

Solução de problemas

Talvez você encontre erros ao usar o Cloud KMS com o Cloud Scheduler. A tabela a seguir descreve diferentes problemas e como resolvê-los.

Problema Descrição
A permissão cloudkms.cryptoKeyVersions.useToEncrypt foi negada

A chave do Cloud KMS fornecida não existe ou a permissão não está configurada corretamente.

Solução:

A versão da chave não está ativada

A versão da chave do Cloud KMS fornecida foi desativada.

Solução: reative a versão da chave do Cloud KMS.

A região do keyring não corresponde ao recurso a ser protegido

A região do keyring do Cloud KMS fornecida é diferente da região protegida do Cloud Scheduler.

Solução: use um keyring do Cloud KMS da mesma região do Cloud Scheduler. O keyring pode estar em um projeto diferente. Para mais informações, consulte Locais do Cloud KMS e locais do Cloud Scheduler.

O projeto não é compatível com CMEK no Cloud Scheduler

A ativação da CMEK falha com um erro FAILED_PRECONDITION com a mensagem: Your project is currently not compatible with CMEK in Cloud Scheduler. Esse erro ocorre quando os jobs atuais do Cloud Scheduler no seu projeto não foram migrados para oferecer suporte a CMEK. Por exemplo, a falta de permissões de agente de serviço ou jobs legados com nomes de tópicos do Pub/Sub inválidos podem impedir a migração.

Solução:

  1. Revise e corrija os problemas de permissão ou configuração de job no seu projeto:
  2. Depois de resolver qualquer problema de permissão ou configuração de job, abra uma solicitação de suporte no console do Google Cloud para concluir a migração e ativar a CMEK no projeto. Corrigir as permissões ou as configurações do job não elimina o erro até que a migração seja concluída.

Registro de auditoria

O Cloud KMS produz registros de auditoria quando as chaves são ativadas, desativadas ou usadas por recursos do Cloud Scheduler para criptografar e descriptografar mensagens. Para mais informações, consulte Registros de auditoria do Cloud KMS.

Erros do Cloud EKM

Para resolver problemas que podem ser encontrados ao usar chaves gerenciadas externamente por meio do Cloud External Key Manager (Cloud EKM), consulte a Referência de erros do Cloud EKM.

Status de chave indisponível

Se, por algum motivo, o Cloud KMS estiver indisponível, o Cloud Scheduler talvez não consiga recuperar o status da chave do Cloud KMS.

Se o Cloud KMS estiver indisponível quando um job estiver programado para ser executado, o Cloud Scheduler não poderá descriptografar os dados do job nem invocar o destino dele. Para erros temporários do Cloud KMS (como UNAVAILABLE, RESOURCE_EXHAUSTED ou uma chave do Cloud EKM inacessível), o Cloud Scheduler tenta novamente a descriptografia internamente com espera exponencial e registra entradas de registro CmekRetryFailure no Cloud Logging em cloudscheduler.googleapis.com/cmek. Para erros que não podem ser repetidos, como um erro de permissão ou uma chave desativada ou destruída, a descriptografia falha imediatamente sem invocar o destino.

Cotas do Cloud KMS

Quando você usa CMEK no Cloud Scheduler, seus projetos podem consumir cotas de solicitações criptográficas do Cloud KMS. Por exemplo, o Cloud Scheduler pode consumir essas cotas ao executar jobs, processar solicitações de gerenciamento de jobs ou atualizar a configuração da CMEK. O Cloud Scheduler reutiliza uma chave intermediária armazenada em cache por até cinco minutos por projeto e região. Assim, as execuções frequentes de jobs não consomem cota. As operações de criptografia e descriptografia que usam chaves CMEK só afetam as cotas do Cloud KMS se você usar chaves externas (Cloud EKM). Para mais informações, consulte Cotas do Cloud KMS.

Preços

Essa integração não gera custos adicionais além das operações com chaves do Cloud KMS, que são faturadas no seu projeto do Google Cloud .

Os recursos de entrega subjacentes que usam sua chave por meio de concessões de chave podem realizar outras operações do Cloud KMS. Para ajudar a estimar o uso do Cloud KMS para operações diretas do Cloud Scheduler, espere as seguintes taxas de operação criptográfica por projeto e região:

  • Execuções de jobs: o Cloud Scheduler reutiliza uma chave intermediária em cache por até cinco minutos por projeto e região. Os projetos com menos de uma execução de job a cada cinco minutos realizam aproximadamente uma operação de descriptografia do Cloud KMS por execução. Os projetos com execuções mais frequentes realizam aproximadamente uma operação de descriptografia a cada cinco minutos em toda a região.
  • Operações de gerenciamento de jobs: as solicitações para criar, atualizar, receber, listar, pausar ou retomar jobs com dados protegidos usam uma chave intermediária em cache separada por até cinco minutos por projeto e região.
  • Atualizações de configuração de CMEK: ativar ou alterar uma chave CMEK com cmek-config executa outras operações de chave do Cloud KMS para validar a chave e criptografar novamente os jobs protegidos na região. A desativação da CMEK descriptografa os jobs protegidos atuais de volta para a criptografia padrão do Google.

Para informações sobre preços, consulte Preços do Cloud KMS.