Opções do MongoClient para Queryable Encryption

Nesta página

Visão geral

AutoEncryptionOpts
Exemplo

Queryable Encryption com queries de igualdade está geralmente disponível (GA) no MongoDB 7.0. Para usar a Queryable Encryption, atualize o MongoDB para a versão 7.0 com drivers compatíveis. A pré-visualização pública do Queryable Encryption lançada com o MongoDB 6.0 não é mais suportada e é incompatível com a funcionalidade GA. Para obter mais informações, consulte o MongoDB 7.0 notas de compatibilidade.

Visão geral

Visualize informações sobre as opções de configuração específicas do Queryable Encryption para instâncias do MongoClient .

AutoEncryptionOpts

Passe um objeto AutoEncryptionOpts para sua instância MongoClient para especificar as opções específicas da Queryable Encryption.

A tabela a seguir descreve a estrutura de um objeto AutoEncryptionOpts:

Parâmetro	Tipo	Obrigatório	Descrição
`keyVaultClient`	`MongoClient`	No	Uma instância `MongoClient` configurada para se conectar à instância do MongoDB que hospeda sua Key Vault collection. Se você omitir a opção `keyVaultClient`, a MongoDB especificada para sua instância do `MongoClient` contendo a configuração do `AutoEncryptionOpts` será usada como o host da sua collection de cofre de chaves. Para saber mais sobre as collections do Key Vault, consulte Coleções do Key Vault.
`keyVaultNamespace`	String	Sim	O namespace completo da coleção Key Vault.
`kmsProviders`	Objeto	Sim	O sistema de gerenciamento de chaves (KMS) usado pela Queryable Encryption para gerenciar suas chaves mestras do cliente (CMKs). Para saber mais sobre objetos do `kmsProviders` , consulte Fornecedores de KMS. Para saber mais sobre as chaves mestres do cliente, consulte Chaves e cofres de chaves.
`encryptedFieldsMap`	Objeto	No	Um esquema de criptografia. Para saber como construir um esquema de criptografia, consulte Criptografia de campo e consultabilidade.
`bypassQueryAnalysis`	Boolean	No	Desabilita a análise automática dos comandos de saída. Configure `bypassQueryAnalysis` para `true` para utilizar criptografia explícita em campos indexados sem a biblioteca do `crypt_shared` . O padrão é `false` se não for especificado.

Exemplo

Para visualizar um trecho de código que demonstra como usar o AutoEncryptionOpts para configurar sua instância do MongoClient , selecione a guia correspondente ao seu driver:

var AutoEncryptionOpts =
{
   "keyVaultClient" : keyVaultClient,
   "keyVaultNamespace" : "<database>.<collection>",
   "kmsProviders" : { ... },
   "bypassQueryAnalysis": "<boolean value>", // optional - defaults to false
   "encryptedFieldsMap" : { ... }
}
cluster = Mongo(
  "mongodb://myhostexample.net:27017/?replicaSet=myReplicaSet",
  AutoEncryptionOpts
);

Dica

Variáveis de ambiente

Se possível, considere a possibilidade de definir as credenciais disponibilizadas no kmsProviders como variáveis de ambiente e, em seguida, passá-las para mongosh utilizando a opção --eval. Isso minimiza as chances de vazamento de credenciais em logs.

const secureClient = new MongoClient(connectionString, {
  useNewUrlParser: true,
  useUnifiedTopology: true,
  monitorCommands: true,
  autoEncryption: {
    keyVaultNamespace,
    kmsProviders,
    bypassQueryAnalysis, // optional - defaults to false
    encryptedFieldsMap: patientSchema,
    extraOptions: extraOptions,
  },
});

Para saber mais sobre opções adicionais para configurar a Biblioteca Compartilhada de criptografia automática, consulte Configuração.

Voltar

Operações suportadas

Biblioteca compartilhada