Por padrão, o Workflows criptografa o conteúdo do cliente em repouso. O Workflows executa a criptografia, e você não precisa 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 Workflows. 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 ver registros de auditoria e controlar ciclos de vida de chaves. Em vez de o Google ser proprietário e responsável pelo gerenciamento das 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 Workflows é semelhante à criptografia padrão do Google. Para saber mais sobre suas opções de criptografia, consulte Chaves de criptografia gerenciadas pelo cliente (CMEK).
É possível proteger o fluxo de trabalho e os dados associados em repouso usando uma chave de criptografia que só você pode acessar e que pode ser controlada e gerenciada usando o Cloud KMS.
O que é protegido com a CMEK
Ao implantar um fluxo de trabalho, é possível especificar uma chave do Cloud KMS. Essa chave é usada para criptografar o fluxo de trabalho e as execuções dele:
Um fluxo de trabalho requer um arquivo de origem que contenha uma definição de fluxo de trabalho válida. Esse arquivo de origem é criptografado usando a chave.
Uma execução de fluxo de trabalho executa a definição atual do fluxo de trabalho (uma revisão de fluxo de trabalho específica). Usando a chave associada à revisão do fluxo de trabalho no momento da implantação, o fluxo de trabalho compilado e todos os dados de entrada, saída e ambiente de execução armazenados são criptografados. Isso inclui argumentos de execução, resultados, erros e exceções, eventos do Eventarc entregues, além de solicitações e respostas de callback e HTTP.
Antes de começar
Antes de usar CMEK no Workflows, siga estas etapas:
Ative as APIs.
Console
-
Ative as APIs Cloud KMS e Workflows, se ainda não estiverem ativadas.
Funções necessárias para ativar APIs
Para ativar APIs, você precisa da permissão
serviceusage.services.enable. Se você criou o projeto, provavelmente já tem essa permissão pelo papel de proprietário (roles/owner). Caso contrário, é possível conseguir essa permissão pelo papel de administrador do Service Usage (roles/serviceusage.serviceUsageAdmin). Saiba como conceder papéis.
gcloud
-
No console do Google Cloud , ative o Cloud Shell.
Na parte inferior do console do Google Cloud , uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.
- Atualize os componentes
gcloud.gcloud components update
- Ative as APIs Cloud KMS e Workflows no
projeto que armazenará as chaves de criptografia.
gcloud services enable cloudkms.googleapis.com workflows.googleapis.com
-
O Cloud KMS produz registros de auditoria do Cloud quando as chaves são ativadas, desativadas ou usadas por recursos do Workflows 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 Informações sobre registros de auditoria do Cloud KMS.
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.
Recuperar o ID do recurso de uma chave do Cloud KMS
O ID do recurso de uma chave do Cloud KMS é obrigatório quando você ativa a CMEK para um fluxo de trabalho. Neste documento, consulte Ativar CMEK para um fluxo de trabalho.
Console
No console do Google Cloud , acesse a página Gerenciamento de chaves.
Clique no keyring que contém a chave.
Na chave referente ao ID de recurso que está sendo recuperado, clique em more_vert Mais.
Clique em Copiar nome do recurso.
O ID do recurso da chave é copiado para a área de transferência. O formato é semelhante ao seguinte:
projects/PROJECT_NAME/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME
Uma chave contém zero ou mais versões de chave. O ID do recurso de uma versão de chave é o ID da chave, mais uma barra (
/) e o ID da versão. Para listar todas as versões de uma chave:- Clique no nome da chave.
- Para uma versão específica, clique em Mais.
- Clique em Copiar nome do recurso.
gcloud
Liste todas as chaves em um determinado keyring:
gcloud kms keys list --keyring RING_NAME --location LOCATION
Substitua:
RING_NAME: o nome do keyring;LOCATION: a região do keyring.
A saída inclui o ID de recurso de cada chave. Exemplo:
NAME: projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME
A chave tem zero ou mais versões. O ID do recurso de uma versão de chave é o ID da chave, mais uma barra (
/) e o ID da versão. Liste todas as versões de uma chave:gcloud kms keys versions list --location LOCATION --keyring RING_NAME --key KEY_NAME
A saída inclui o ID do recurso de cada versão de chave. Exemplo:
NAME: projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME/2
Conceder ao agente de serviço do Workflows acesso à chave
Conceda ao agente de serviço do Workflows o papel do Identity and Access Management (IAM) de Criptografador/descriptografador de CryptoKey do Cloud KMS para que ele possa acessar a chave do Cloud KMS:
Console
Ao ativar a CMEK para um fluxo de trabalho por meio do console, você precisa conceder o papel Criptografador/Descriptografador de CryptoKey do Cloud KMS à conta de serviço. Para mais informações, neste documento, consulte Ativar CMEK para um fluxo de trabalho.
gcloud
gcloud kms keys add-iam-policy-binding KEY_NAME \ --keyring RING_NAME \ --location LOCATION \ --member serviceAccount:service-PROJECT_NUMBER@gcp-sa-workflows. \ --role roles/cloudkms.cryptoKeyEncrypterDecrypter
Substitua:
KEY_NAME: o nome da chave; Por exemplo,my-key.RING_NAME: o nome do keyring; Por exemplo,my-keyring.LOCATION: a localização da chave; Por exemplo,us-central1.PROJECT_NUMBER: o número do projeto do 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)"
Enquanto o agente de serviço tiver o papel roles/cloudkms.cryptoKeyEncrypterDecrypter, um fluxo de trabalho no seu projeto poderá criptografar e descriptografar os dados usando a chave CMEK. Se você revogar esse papel ou desativar ou destruir a chave CMEK, esses dados não poderão ser acessados. Neste documento, consulte
Desativar o Cloud KMS.
Ativar CMEK para um fluxo de trabalho
Ao criar um fluxo de trabalho ou atualizá-lo posteriormente, é possível especificar a chave do Cloud KMS que o fluxo de trabalho precisa usar para criptografia de dados.
Console
No console Google Cloud , acesse a página Fluxos de trabalho.
Clique no nome do fluxo de trabalho que você quer atualizar.
A página Detalhes dos fluxos de trabalho é exibida.
Clique em Editar.
Selecione Chave do Cloud KMS.
Na lista Tipo de gerenciamento de chaves, selecione Cloud KMS.
Na lista Selecionar uma chave do Cloud KMS, selecione ou filtre uma chave do Cloud KMS.
Opcional: para inserir manualmente o nome do recurso da chave, na lista Selecionar uma chave do Cloud KMS, clique em Inserir chave manualmente e insira o nome do recurso da chave no formato especificado.
Se solicitado, conceda o papel
cloudkms.cryptoKeyEncrypterDecrypterà conta de serviço do Workflows com o papelworkflows.serviceAgent.Clique em Próxima.
Para salvar as alterações e implantar o fluxo de trabalho atualizado, clique em Implantar.
gcloud
gcloud workflows deploy WORKFLOW_NAME \ --source=SOURCE_FILE \ --kms-key=KEY \ --location LOCATION \ --service-account=SERVICE_ACCOUNT
Substitua:
WORKFLOW_NAME: o nome do fluxo de trabalhoSOURCE_FILE: o arquivo de origem do fluxo de trabalho com uma extensão de arquivoyamlpara um arquivo YAML ou com uma extensão de arquivojsonpara um arquivo JSON. Por exemplo,myWorkflow.yaml.KEY: o ID do recurso da chave no formatoprojects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. É possível recuperar o ID da chave.LOCATION: o local do fluxo de trabalhoSERVICE_ACCOUNT: a conta de serviço que o fluxo de trabalho usará para acessar outros serviços do Google Cloud . Por exemplo,SERVICE_ACCOUNT_NAME@PROJECT_NAME.. Recomendamos o uso de uma conta de serviço com os privilégios mínimos necessários para acessar os recursos necessários. Se deixado em branco, a conta de serviço padrão será usada. Para mais informações, consulte Conceder permissão a um fluxo de trabalho para acessar recursos do Google Cloud .
Observe o seguinte:
- As revisões e execuções de fluxo de trabalho são criptografadas com a chave especificada no momento da implantação. Os recursos criptografados anteriormente com uma chave anterior permanecem criptografados com essa chave anterior. Se um fluxo de trabalho for editado posteriormente e uma nova chave for especificada, essa revisão do fluxo de trabalho será criptografada com a nova chave, e todas as execuções subsequentes usarão a nova chave.
- As revisões e execuções de fluxo de trabalho não criptografadas por CMEK anteriormente permanecem não criptografadas.
- Se você desativar as CMEKs em uma revisão de fluxo de trabalho, as execuções subsequentes serão criadas sem a criptografia de CMEK. Neste documento, consulte Desativar CMEK para um fluxo de trabalho. As revisões e execuções de fluxo de trabalho atuais permanecem criptografadas com as chaves da criptografia anterior.
Verificar a integração do Cloud KMS
Para verificar a integração da CMEK, exiba os metadados de um fluxo de trabalho.
Console
No console Google Cloud , acesse a página Fluxos de trabalho.
Clique no nome do fluxo de trabalho que você quer verificar.
A página Detalhes dos fluxos de trabalho é exibida.
Clique na guia Detalhes.
O valor Criptografia exibe o ID do recurso da chave do Cloud KMS usada para proteger o fluxo de trabalho e a execução dele.
gcloud
gcloud workflows describe WORKFLOW_NAME \ --location=LOCATION
A saída será semelhante a esta:
createTime: '2022-08-10T19:57:58.233177709Z' cryptoKeyName: projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME name: projects/PROJECT_NAME/locations/LOCATION/workflows/WORKFLOW_NAME revisionCreateTime: '2022-11-18T19:44:04.933633237Z' revisionId: 000009-8be serviceAccount: projects/PROJECT_NAME/serviceAccounts/SA_NAME@PROJECT_NAME. sourceContents: [...] state: ACTIVE updateTime: '2022-11-18T19:44:05.171793128Z'
O valor cryptokeyName é o ID do recurso da chave do Cloud KMS
usada para proteger o fluxo de trabalho e a execução dele.
Desativar CMEK para um fluxo de trabalho
É possível desativar a CMEK de um fluxo de trabalho para que ele não use mais a chave associada do Cloud KMS.
Console
No console Google Cloud , acesse a página Fluxos de trabalho.
Clique no nome do fluxo de trabalho que você quer atualizar.
A página Detalhes dos fluxos de trabalho é exibida.
Clique em Editar.
Para limpar o botão de opção Chave do Cloud KMS, selecione Google-managed encryption key.
Clique em Próxima.
Para salvar as alterações e implantar o fluxo de trabalho atualizado, clique em Implantar.
gcloud
gcloud workflows deploy WORKFLOW_NAME \ --source=SOURCE_FILE \ --clear-kms-key \ --service-account=SERVICE_ACCOUNT
Isso desativa a CMEK para a revisão atual do fluxo de trabalho, e todas as execuções subsequentes são criadas sem criptografia CMEK. As revisões e execuções de fluxo de trabalho atuais permanecem criptografadas com as chaves da criptografia anterior.
Desativar o Cloud KMS
Se você quiser revogar o acesso aos dados do seu fluxo de trabalho ou das execuções dele, desative o Cloud KMS de uma das seguintes maneiras:
Desative ou destrua a versão da chave primária da sua chave de criptografia gerenciada pelo cliente. A desativação de uma versão de chave CMEK suspende o acesso a todos os dados protegidos por ela. A destruição de uma versão de chave é a contraparte permanente dessa ação. Ambas afetam apenas os fluxos de trabalho e as execuções de fluxo de trabalho associados à chave específica. Não é possível criar novas execuções ou visualizar os recursos associados à chave desativada ou destruída. As execuções ativas vão falhar com uma mensagem de erro correspondente.
Revogue o papel do IAM
cloudkms.cryptoKeyEncrypterDecrypterdo agente de serviço do Workflows. Isso afeta todos os fluxos de trabalho no projetoGoogle Cloud que são compatíveis com a criptografia usando CMEK. Não é possível criar novos fluxos de trabalho e execuções integrados à CMEK nem visualizar recursos criptografados por CMEK. Todas as execuções ativas vão falhar com uma mensagem de erro correspondente.
Embora nenhuma das operações garanta a revogação do acesso instantâneo, as alterações do IAM geralmente são propagadas mais rapidamente. Para mais informações, consulte Consistência de recursos do Cloud KMS e Propagação de alterações no acesso.
Solução de problemas
Talvez você encontre erros ao usar o Cloud KMS com o Workflows. 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 KMS fornecida é diferente da região do
fluxo de trabalho.
Solução: use um keyring do Cloud KMS e um fluxo de trabalho protegido da mesma região. Eles podem estar em projetos diferentes. Para mais informações, consulte Locais do Cloud KMS e Locais do Workflows. |
| O limite de cota do Cloud KMS foi excedido | Seu limite de cota para solicitações do Cloud KMS foi atingido.
Solução: limite o número de chamadas do Cloud KMS ou aumente o limite da cota. Para mais informações, consulte Cotas do Cloud KMS. |
Como um status de chave indisponível é tratado
Se, por algum motivo, o Cloud KMS estiver indisponível, talvez o Workflows não consiga recuperar o status da chave do Cloud KMS.
Se o status da chave estiver indisponível, o fluxo de trabalho ou a execução dele vai retornar
um valor state: UNAVAILABLE e os detalhes relacionados no campo stateError.
Se o status da chave ficar indisponível durante a execução de um fluxo de trabalho (por exemplo, uma permissão é revogada durante um callback), ocorre um erro de tempo de execução, retornando um valor state: FAILED e detalhes relacionados no campo error.
Preços
Essa integração não gera custos adicionais além das operações com chaves, que são faturadas no seu projeto do Google Cloud . Para informações sobre os preços atuais, consulte Preços do Cloud KMS.