Garantia de integridade dos dados

Esta página descreve como usar somas de verificação para manter e verificar a integridade dos dados do secret ao adicionar e acessar versões dele.

Pense em uma soma de verificação como uma impressão digital exclusiva dos seus dados. É um código curto gerado a partir dos dados do secret usando o algoritmo CRC32C. Se até mesmo um único bit nos dados do secret mudar, a soma de verificação também mudará. Isso permite que o Secret Manager detecte modificações ou corrupções acidentais.

O Secret Manager usa somas de verificação das seguintes maneiras:

  1. Ao adicionar uma versão do secret:

    • O Secret Manager calcula a soma de verificação CRC32C dos dados do secret.

    • Essa soma de verificação é armazenada com os dados do secret.

  2. Ao acessar uma versão do secret:

    • O Secret Manager retorna os dados do secret com a soma de verificação.

    • Você pode usar essa soma de verificação para verificar se os dados recebidos são exatamente iguais aos armazenados no Secret Manager.

Para garantir que a soma de verificação seja compatível com a estrutura SecretPayload, ela precisa ser calculada usando o algoritmo CRC32C e codificada como um número inteiro decimal. A resposta SecretVersion inclui um campo que indica se o servidor recebeu e validou essa soma de verificação.

O exemplo a seguir mostra como as somas de verificação funcionam no Secret Manager:

API

Esses exemplos usam curl para demonstrar o uso da API. É possível gerar tokens de acesso com o gcloud auth print-access-token. No Compute Engine ou no GKE, você precisa fazer a autenticação com o escopo do cloud-platform.

Com os dados do secret armazenados em um arquivo de dados, calcule a soma de verificação, usando gcloud storage hash. A soma de verificação precisa ser convertida para o formato decimal. Ela é codificada como int64 no proto SecretPayload. 

$ gcloud storage hash "/path/to/file.txt" --hex

Codifique os dados do secret em Base64 e salve-os como uma variável do shell.

$ SECRET_DATA=$(echo "seCr3t" | base64)

Com os dados do secret transmitidos na linha de comando, calcule a soma de verificação da seguinte maneira: 

$ gcloud storage hash --hex cat <(echo ${SECRET_DATA})

Invoque a API usando curl.

$ curl "https://secretmanager.googleapis.com/v1/projects/project-id/secrets/secret-id:addVersion" \
    --request "POST" \
    --header "authorization: Bearer $(gcloud auth print-access-token)" \
    --header "content-type: application/json" \
    --data "{\"payload\": {\"data\": \"${SECRET_DATA}\", \"data_crc32c\": $CHECKSUM}}"

Quando a versão do secret é acessada, o SecretPayload retornado contém os dados com a soma de verificação. Confira um exemplo de resposta:

{
  "name": "projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID",
  "payload": {
    "data": "YQo=",
    "dataCrc32c": "163439259"
  }
}

No console, ao adicionar uma versão do secret, a soma de verificação é calculada automaticamente quando você insere um valor para o secret.

As versões do secret criptografadas com chaves de criptografia gerenciadas pelo cliente (CMEK) e criadas antes de 16 de julho de 2021 não têm somas de verificação armazenadas.

A seguir