Criptografia no nível de campo do cliente

Métodos de criptografia suportados

O MongoDB oferece suporte a dois métodos de criptografia de nível de campo do lado do cliente usando o MongoDB 4 oficial.2+ drivers compatíveis:

Criptografia explícita (manual) de campos

MongoDB 4 oficial .2+ drivers compatíveis, mongosh e o MongoDB 4.2 ou versões posteriores do shell mongo legado oferecem suporte à criptografia ou descriptografia explícita de campos com uma chave de criptografia de dados e um algoritmo de criptografia específicos.

Os aplicativos devem modificar qualquer código associado à construção de operações de leitura e gravação para incluir lógica de criptografia/descriptografia por meio da biblioteca de criptografia de drivers. A aplicação é responsável por selecionar o diretório de dados apropriado para criptografia/descriptografia por operação.

Para obter mais informações, consulte Criptografia explícita (manual) no nível do campo do lado do cliente.

criptografia automática de campo

Observação

Funcionalidade de empresas

O recurso automático da criptografia no nível do campo só está disponível no MongoDB Enterprise 4.2 ou posterior e no MongoDB Atlas 4.2 ou clusters posteriores.

MongoDB 4 oficial .2+ drivers compatíveis, mongosh e o MongoDB 4.2 ou posterior ao shell mongo legado é compatível com a criptografia automática de campos em operações de leitura e gravação.

Os aplicativos devem criar um objeto de conexão de banco de dados (por exemplo, MongoClient) com as definições de configuração de criptografia automática. As definições de configuração devem incluir regras de criptografia automática utilizando um subconjunto rigoroso da sintaxe padrão do Esquema JSON 4 e palavras-chave de esquema específicas de criptografia. Os aplicativos não precisam modificar o código associado à operação de leitura/gravação. Consulte Regras de criptografia automática para obter a documentação completa sobre regras de criptografia automática.

Para obter mais informações, consulte Criptografia automática no nível do campo do lado do cliente.

MongoDB 4.2+ drivers compatíveis, mongosh e o MongoDB 4.2 ou posterior mongo shell legado descriptografar automaticamente Binary 6 criados usando criptografia de nível de campo do lado do cliente. Para obter mais informações sobre descriptografia automática, consulte Descriptografia automática de campos.

Componentes de criptografia

O diagrama a seguir ilustra o relacionamento entre o driver e cada componente de criptografia:

• libmongocrypt é o código aberto licenciada pela Apache biblioteca de criptografia principal usada pelo MongoDB 4 oficial2 . + drivers compatíveis, e omongosh MongoDB 4 2. Shell ou posterior legado para alimentar a criptografia em nível de campo do lado do cliente. Alguns drivers podem exigir etapas de integração específicas para instalar ou vincular a biblioteca. Consulte a documentação do driver para obter informações mais completas.mongo

• A biblioteca compartilhada de criptografia automática oferece suporte à criptografia automática em nível de campo do lado do cliente e está disponível apenas com o MongoDB Enterprise. A biblioteca compartilhada de criptografia automática não executa funções criptográficas. A biblioteca compartilhada é uma alternativa preferencial ao mongocryptd e não requer a criação de um novo processo. mongocryptd ainda é suportado.

• O Key Vault é uma collection do MongoDB que armazena todas as chaves de criptografia usadas para criptografar valores. As diretório de dados são criptografadas usando uma chave mestra do cliente (chave mestra do cliente) antes do armazenamento na coleção. O cofre de chaves pode residir em um MongoDB cluster diferente daquele que armazena os dados criptografados.

• O KMS armazena a chave mestra do cliente usada para criptografar o diretório de dados. O MongoDB é compatível com os seguintes provedores de KMS:

  • KMS do Amazon Web Services

  • Cofre de chaves do Azure

  • KMS do Google Cloud Platform

  • Chave gerenciada localmente

• O cluster MongoDB que armazena os dados criptografados também pode impor criptografia de nível de campo no lado do cliente. Consulte Aplicar esquema de criptografia em nível de campo para obter mais informações.

Algoritmos de criptografia

A criptografia no nível do campo do MongoDB no lado do cliente usa a abordagem Encrypt-then-MAC combinada com um vetor de inicialização determinístico ou aleatório para criptografar os valores de campo. O MongoDB suporta apenas o AEAD AES-256-Algoritmo de criptografia CBC com HMAC-SHA-512 Mac.

{
 "personal_information" : {
   "ssn" : "123-45-6789",
   "credit_score" : 750,
   "credit_cards" : [ "1234-5678-9012-3456", "9876-5432-1098-7654"]
 },
 "phone_numbers" : [ "(212) 555-0153" ]
}

Descriptografia automática de campo

Os metadados blob BinData incluem a chave de encriptação de dados _id e o algoritmo de criptografia usado para criptografar os dados binários. O 4.2+ drivers compatíveis, mongosh e o MongoDB 4.2 ou shell mongo herdado posterior usa esses metadados para tentar a descriptografia automática de objetos BinData subtipo 6 . O processo de descriptografia automática funciona da seguinte forma:

1. Verifique os metadados do blob do BinData para o diretório de dados e o algoritmo de criptografia utilizado para criptografar o valor.

2. Verifique o cofre de chaves configurado no reconhecimento de data center atual para o diretório de dados especificado. Se o cofre de chaves não contiver a diretório de dados especificado, a descriptografia automática falhará e o driver retornará o blob BinData .

3. Verifique os metadados da chave de criptografia de dados da chave mestra do cliente (CMK) usada para criptografar o material da chave.

4. Para o Amazon Web Services KMS, Azure Key Vault ou Google Cloud Platform KMS, envie a chave de criptografia de dados para o provedor de KMS para descriptografia. Se a CMK não existir ou se a configuração de conexão não conceder acesso à CMK, a descriptografia falhará e o driver retornará o blob BinData .

   Para a chave managed localmente, recupere a chave local e descriptografe o diretório de dados. Se a chave local especificada na configuração do reconhecimento de data center não tiver sido usada para criptografar o diretório de dados, a descriptografia falhará e o driver retornará o blob BinData .

5. Descriptografe o valor BinData usando o diretório de dados descriptografado e o algoritmo apropriado.

Os aplicativos com acesso ao servidor MongoDB que também não têm acesso à chave mestre necessária e às chaves de criptografia de dados não podem descriptografar os valores BinData .

Para obter mais informações sobre como configurar o reconhecimento de data center para criptografia no nível do campo do lado do cliente, consulte o construtor Mongo() ou consulte a documentação do método de construção do cliente do driver de sua preferência.

Aplicar esquema de criptografia em nível de campo

Começando com MongoDB 4.2, o servidor suporta o uso da validação de esquema para impor a criptografia de campo específicos em uma collection. Use as palavras- chave da regra de criptografia automática com o objeto de validação $jsonSchema para indicar quais campo exigem criptografia. O servidor rejeita quaisquer operações de gravação para essa collection onde os campo especificados não são objeto do subtipo { Binary (BinData) 6 .

Por exemplo, o comando collMod a seguir modifica a collection hr.employees para incluir um validator. O objeto de validação $jsonSchema inclui palavras-chave de criptografia no nível do campo do lado do cliente para indicar que:

• O campo taxid deve ser criptografado. Os clientes devem usar a chave de encriptação de dados especificada e o algoritmo de criptografia aleatório ao criptografar o campo.

• O campo taxid-short deve ser criptografado. Os clientes devem usar a chave de encriptação de dados especificada e o algoritmo de criptografia determinístico ao criptografar o campo.

db.getSiblingDB("hr").runCommand(
  {
    "collMod" : "employees",
    "validator" : {
      "$jsonSchema" : {
        "bsonType" : "object",
        "properties" : {
          "taxid" : {
            "encrypt" : {
              "keyId" : [UUID("e114f7ad-ad7a-4a68-81a7-ebcb9ea0953a")],
              "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Random",
            }
          },
          "taxid-short" : {
            "encrypt" : {
              "keyId" : [UUID("33408ee9-e499-43f9-89fe-5f8533870617")],
              "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic",
              "bsonType" : "string"
            }
          }
        }
      }
    }
  }
)

Os clientes que executam a criptografia explícita (manual) de nível de campo devem encrypt , no mínimo, os campos taxid e taxid-short usando as mesmas configurações do $jsonSchema remoto antes de emitir a operação de gravação.

Os clientes que executam a criptografia automática em nível de campo do lado do cliente têm um comportamento específico, dependendo da configuração da conexão com o reconhecimento de data center:

• Se o objeto de conexão ClientSideFieldLevelEncryptionOptions schemaMap contiver uma chave para a collection especificada, o cliente utilizará esse objeto para executar a criptografia automática no nível do campo e ignorará o esquema remoto. As regras locais devem criptografar no mínimo esses campo taxid e taxid-short .

• Se o objeto ClientSideFieldLevelEncryptionOptions schemaMap da conexão não contiver uma chave para a collection especificada, o cliente baixará o esquema remoto do lado do servidor para a collection e o usará para executar a criptografia automática no nível do campo.

  Essa configuração exige que o cliente confie que o servidor tem um esquema válido em relação à criptografia automática de nível de campo. O cliente só usa o esquema remoto para executar a criptografia automática em nível de campo e não impõe nenhuma outra regra de validação especificada no esquema.

Como o MongoDB Server não pode descriptografar nem introspecção do conteúdo do field criptografado, ele não pode validar se os clientes usaram as opções de criptografia especificadas para criptografar um determinado field. Isso permite que dois clientes insiram dados criptografados usando diferentes keyIDs ou algoritmos de criptografia para um field específico. Embora alguns volumes de trabalho possam exigir implementações independentes de criptografia em nível de field, a implementação inconsistente de opções de criptografia para um field entre clientes pode resultar em comportamento incorreto ou inesperado de query no field criptografado.

Por exemplo, o cliente A criptografa o campo PII usando criptografia aleatória, enquanto o cliente B criptografa o campo PII usando criptografia determinística. O algoritmo de criptografia aleatório sempre retorna um valor único diferente, enquanto o algoritmo determinístico sempre retorna o mesmo valor. As query que esperam dados criptografados deterministicamente para esse campo retornam resultados inconsistentes, pois o servidor não pode corresponder a nenhum dos campo criptografados aleatoriamente.

Tabela de compatibilidade de drivers

MongoDB 4.2 A criptografia no nível do campo do lado do cliente só está disponível com o seguinte 4 oficial.2+ versões de driver compatíveis:

Consulte a documentação de referência do driver para obter exemplos de sintaxe e implementação.