Opciones de MongoClient para Queryable Encryption

El cifrado consultable con consultas de igualdad está disponible de forma general (GA) en MongoDB 7.0. Para usar el cifrado consultable, actualice MongoDB a la versión 7.0 con controladores compatibles. La versión preliminar pública del cifrado consultable, publicada con MongoDB 6.0, ya no es compatible con la función GA. Para obtener más información, consulte 7.0 Notas de compatibilidad de MongoDB.

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

Overview

Ver información sobre las opciones de configuración específicas de cifrado consultable para MongoClient instancias.

Opciones de cifrado automático

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

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 omite la opción `keyVaultClient`, la instancia de MongoDB especificada en su instancia `MongoClient` que contiene la configuración `AutoEncryptionOpts` se utiliza como host de su colección de Key Vault. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`keyVaultNamespace`	String	Sí	El espacio de nombres completo de la colección Key Vault.
`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 fragmento de código que demuestra cómo usar AutoEncryptionOpts para configurar su instancia MongoClient, seleccione la pestaña correspondiente a su controlador:

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, considere definir las credenciales proporcionadas en kmsProviders como variables de entorno y luego pasarlas a mongosh mediante la opción. Esto minimiza la posibilidad de que --eval 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 obtener más información sobre opciones adicionales para configurar la biblioteca compartida de cifrado automático, consulte Configuración.

Volver

Operaciones compatibles

Biblioteca compartida