Opciones de MongoClient para Queryable Encryption

La Queryable Encryption con consultas de igualdad está disponible de manera general (GA) en MongoDB 7.0. Para usar Queryable Encryption, actualice MongoDB a la versión 7.0 con controladores compatibles. La versión preliminar pública de Queryable Encryption lanzada con MongoDB 6.0 ya no está soportada y no es compatible con la funcionalidad GA. Para obtener más información, consulta Notas de compatibilidad de MongoDB 7.0 .

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación de 6.0, consulte los procedimientos de actualización de MongoDB 7.0 .

Overview

Ver información sobre las opciones de configuración específicas de Queryable Encryption para MongoClient instancia.

AutoEncryptionOpts

Pase un objeto AutoEncryptionOpts a su instancia MongoClient para especificar opciones específicas de Queryable Encryption.

La siguiente tabla describe la estructura de un objeto AutoEncryptionOpts:

Parameter	Tipo	Requerido	Descripción
`keyVaultClient`	`MongoClient`	No	Una instancia `MongoClient` configurada para conectarse a la instancia de MongoDB que aloja su colección Key Vault. Si omites la opción `keyVaultClient`, la instancia de MongoDB especificada a tu instancia `MongoClient` que contiene la configuración `AutoEncryptionOpts` se usará como el host de tu Colección de Bóvedas de Llaves. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`keyVaultNamespace`	String	Sí	El namespace completo de la Colección de Bóvedas de Llaves.
`kmsProviders`	Objeto	Sí	El sistema de administración de claves (KMS) utilizado por Queryable Encryption para administrar sus claves maestras de cliente (CMK). Para obtener más información sobre `kmsProviders` los objetos, consulte Proveedores de KMS. Para aprender más sobre las llaves maestras de cliente, consulta Claves y almacenes de claves.
`encryptedFieldsMap`	Objeto	No	Un esquema de cifrado. Para aprender a construir un esquema de cifrado, consulta Cifrado de campos y consultabilidad.
`bypassQueryAnalysis`	Booleano	No	Desactiva el análisis automático de los comandos salientes. Establece `bypassQueryAnalysis` en `true` para utilizar cifrado explícito en campos indexados sin la librería `crypt_shared`. Por defecto, se establece en `false` si no se especifica.

Ejemplo

Para ver un code-snippet demostrando cómo utilizar AutoEncryptionOpts para configurar tu instancia MongoClient, selecciona la pestaña correspondiente a tu 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
);

Tip

Variables de entorno

Si es posible, considera definir las credenciales proporcionadas en kmsProviders como variables de entorno y luego pasarlas a mongosh mediante la opción --eval. Esto minimiza las posibilidades de que las credenciales se filtren en los registros.

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

Para conocer otras opciones de configuración de la Biblioteca compartida de cifrado automático, consulta Configuración.

Volver

Operaciones compatibles

Librería compartida