/ /

/ /

Opciones de MongoClient para Queryable Encryption

Las consultas de igualdad y rango de cifrado consultable son totalmente compatibles en producción. Las consultas de prefijo, sufijo y subcadena solo están disponibles en la vista previa pública de MongoDB 8.2. No habilite estos tipos de consulta en producción. La funcionalidad de GA de los tipos de consulta de prefijo, sufijo y subcadena será incompatible con la función de vista previa. Para obtener más información, consulte Tipos de consulta admitidos.

Overview

En esta página, puede obtener información sobre las opciones de configuración específicas del cifrado consultable para MongoClient instancias.

Opciones de cifrado automático

La siguiente tabla describe la estructura de un objeto AutoEncryptionOptions:

Propiedad	Tipo de dato	¿Obligatorio?	Descripción
`keyVaultNamespace`	`String`	Sí	El completo espacio de nombres de la colección Key Vault.
`kmsProviders`	`Object`	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 obtener más información sobre las claves maestras del cliente, consulte Claves de cifrado y bóvedas de claves.
`bypassAutoEncryption`	`Boolean`	No	Especifique `true` para omitir las reglas de cifrado automático y realizar un cifrado explícito (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Desactiva el análisis automático de los comandos salientes. Especifique `true` para usar cifrado explícito sin la biblioteca compartida de cifrado automático.
`encryptedFieldsMap`	`Object`	No	Un esquema que especifica qué campos se cifrarán automáticamente y los tipos de consultas permitidas en esos campos. Para aprender cómo construir un esquema de cifrado, consulta Campos cifrados y queries habilitadas.
`extraOptions`	`Object`	No	Opciones de configuración para la biblioteca de cifrado. Para utilizar la biblioteca compartida de cifrado automático en lugar de `mongocryptd`, especifique la ruta de archivo absoluta o relativa completa al archivo de biblioteca en la propiedad `cryptSharedLibPath` de este objeto. Si el controlador no puede cargar la biblioteca compartida de cifrado automático desde esta ruta, la creación de `MongoClient` fallará.
`keyVaultClient`	`MongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja su colección de Key Vault. Si omite esta opción, el controlador utiliza la instancia `MongoClient` actual. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`tlsOptions`	`Object`	No	Las opciones de TLS a utilizar al conectarse al proveedor KMS.

La siguiente tabla describe las propiedades de un objeto AutoEncryptionOptions:

Propiedad	Tipo de dato	¿Obligatorio?	Descripción
`KeyVaultNamespace`	`CollectionNamespace`	Sí	El espacio de nombres completo de la colección Key Vault.
`KmsProviders`	`IReadOnlyDictionary`	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 obtener más información sobre las claves maestras del cliente, consulte Claves de cifrado y bóvedas de claves.
`BypassAutoEncryption`	`Boolean`	No	Especifique `true` para omitir las reglas de cifrado automático y realizar un cifrado explícito (manual) por campo.
`BypassQueryAnalysis`	`Boolean`	No	Desactiva el análisis automático de los comandos salientes. Establezca esta propiedad en `true` para usar cifrado explícito sin la biblioteca compartida de cifrado automático.
`EncryptedFieldsMap`	`IReadOnlyDictionary`	No	Un esquema que especifica qué campos se cifrarán automáticamente y los tipos de consultas permitidas en esos campos. Para aprender cómo construir un esquema de cifrado, consulta Campos cifrados y queries habilitadas.
`ExtraOptions`	`IReadOnlyDictionary`	No	Opciones de configuración para la biblioteca de cifrado. Para utilizar la biblioteca compartida de cifrado automático en lugar de `mongocryptd`, especifique la ruta de archivo absoluta o relativa completa al archivo de la biblioteca en la propiedad `cryptSharedLibPath`. Si el controlador no puede cargar la biblioteca compartida de cifrado automático desde esta ruta, la creación de `MongoClient` fallará.
`KeyVaultClient`	`IMongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja su colección de Key Vault. Si omite esta opción, el controlador utiliza la instancia `MongoClient` actual. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`TlsOptions`	`IReadOnlyDictionary`	No	Las opciones de TLS a utilizar al conectarse al proveedor KMS.

Nota

Documentación de la API

Para obtener más información sobre estas opciones de cifrado automático, consulte la documentación de la API para AutoEncryptionOptions clase.

La siguiente tabla describe las opciones en un objeto AutoEncryptionOptions:

Opción	Tipo de dato	¿Obligatorio?	Descripción
`KeyVaultNamespace`	`String`	Sí	El espacio de nombres completo de la colección Key Vault.
`KmsProviders`	`map[string]map[string]interface{}`	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 obtener más información sobre las claves maestras del cliente, consulte Claves de cifrado y bóvedas de claves.
`BypassAutoEncryption`	`*bool`	No	Especifique `true` para omitir las reglas de cifrado automático y realizar un cifrado explícito (manual) por campo.
`BypassQueryAnalysis`	`*bool`	No	Desactiva el análisis automático de los comandos salientes. Especifique `true` para usar cifrado explícito sin la biblioteca compartida de cifrado automático.
`EncryptedFieldsMap`	`map[string]interface{}`	No	Un esquema que especifica qué campos se cifrarán automáticamente y los tipos de consultas permitidas en esos campos. Para aprender cómo construir un esquema de cifrado, consulta Campos cifrados y queries habilitadas.
`ExtraOptions`	`map[string]interface{}`	No	Opciones de configuración para la biblioteca de cifrado. Para utilizar la biblioteca compartida de cifrado automático en lugar de `mongocryptd`, especifique la ruta de archivo absoluta o relativa completa al archivo de la biblioteca en la propiedad `cryptSharedLibPath`. Si el controlador no puede cargar la biblioteca compartida de cifrado automático desde esta ruta, la creación de `MongoClient` fallará.
`KeyVaultClientOptions`	`*ClientOptions`	No	Opciones para que un nuevo `mongo.Client` interno se conecte a la instancia de MongoDB que aloja su colección de Key Vault. Si omite esta opción, el controlador utiliza la instancia `MongoClient` actual. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`TlsConfig`	`map[string]*tls.Config`	No	Las opciones de TLS a utilizar al conectarse al proveedor KMS.

Nota

Documentación de la API

Para obtener más información sobre estas opciones de cifrado automático, consulte la documentación de la API para el tipo AutoEncryptionOptions.

La siguiente tabla describe los métodos disponibles en el constructor AutoEncryptionSettings:

Método	Tipo de dato	¿Obligatorio?	Descripción
`keyVaultNamespace`	`String`	Sí	El espacio de nombres completo de la colección Key Vault.
`kmsProviders`	`Map`	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 obtener más información sobre las claves maestras del cliente, consulte Claves de cifrado y bóvedas de claves.
`bypassAutoEncryption`	`Boolean`	No	Especifique `true` para omitir las reglas de cifrado automático y realizar un cifrado explícito (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Desactiva el análisis automático de los comandos salientes. Especifique `true` para usar cifrado explícito sin la biblioteca compartida de cifrado automático.
`encryptedFieldsMap`	`Map`	No	Un esquema que especifica qué campos se cifrarán automáticamente y los tipos de consultas permitidas en esos campos. Para aprender cómo construir un esquema de cifrado, consulta Campos cifrados y queries habilitadas.
`extraOptions`	`Map`	No	Opciones de configuración para la biblioteca de cifrado. Para utilizar la biblioteca compartida de cifrado automático en lugar de `mongocryptd`, especifique la ruta de archivo absoluta o relativa completa al archivo de la biblioteca en la propiedad `cryptSharedLibPath`.
`keyVaultMongoClientSettings`	`MongoClientSettings`	No	Configuración para una nueva instancia `MongoClient` para conectarse a la instancia de MongoDB que aloja su colección de Key Vault. Si omite esta opción, el controlador utiliza la instancia `MongoClient` actual. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`kmsProviderPropertySuppliers`	`Map`	No	Similar al método `kmsProviders()`, pero configura un `Supplier` para cada propiedad.
`kmsProviderSslContextMap`	`Map`	No	El contexto SSL que se utilizará para la autenticación.

Nota

Documentación de la API

Para obtener más información sobre estas opciones de cifrado automático, consulte la documentación de la API de la clase AutoEncryptionSettings.Builder.

La siguiente tabla describe la estructura de un objeto AutoEncryptionOptions:

Propiedad	Tipo de dato	¿Obligatorio?	Descripción
`keyVaultNamespace`	`String`	Sí	El espacio de nombres completo de la colección Key Vault.
`kmsProviders`	`Object`	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 obtener más información sobre las claves maestras del cliente, consulte Claves de cifrado y bóvedas de claves.
`bypassAutoEncryption`	`Boolean`	No	Especifique `true` para omitir las reglas de cifrado automático y realizar un cifrado explícito (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Desactiva el análisis automático de los comandos salientes. Especifique `true` para usar cifrado explícito sin la biblioteca compartida de cifrado automático. El valor predeterminado es `false` si no se especifica.
`encryptedFieldsMap`	`Object`	No	Un esquema que especifica qué campos se cifrarán automáticamente y los tipos de consultas permitidas en esos campos. Para aprender cómo construir un esquema de cifrado, consulta Campos cifrados y queries habilitadas.
`extraOptions`	`Object`	No	Opciones de configuración para la biblioteca de cifrado. Para utilizar la biblioteca compartida de cifrado automático en lugar de `mongocryptd`, especifique la ruta de archivo absoluta o relativa completa al archivo de biblioteca en la propiedad `cryptSharedLibPath` de este objeto. Si el controlador no puede cargar la biblioteca compartida de cifrado automático desde esta ruta, la creación de `MongoClient` fallará.
`keyVaultClient`	`MongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja su colección de Key Vault. Si omite esta opción, el controlador utiliza la instancia `MongoClient` actual. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`tlsOptions`	`Object`	No	Las opciones de TLS a utilizar al conectarse al proveedor KMS.

Nota

Documentación de la API

Para obtener más información sobre estas opciones de cifrado automático, consulte la documentación de la API para la interfaz AutoEncryptionOptions.

La siguiente tabla describe los parámetros de la clase AutoEncryptionOpts:

Parameter	Tipo de dato	¿Obligatorio?	Descripción
`key_vault_namespace`	`String`	Sí	El espacio de nombres completo de la colección Key Vault.
`kms_providers`	`Mapping[string, Any]`	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 `kms_Providers` los mapas, consulte Proveedores de KMS. Para obtener más información sobre las claves maestras del cliente, consulte Claves de cifrado y bóvedas de claves.
`bypass_auto_encryption`	`Boolean`	No	Especifique `True` para omitir las reglas de cifrado automático y realizar un cifrado explícito (manual) por campo.
`bypass_query_analysis`	`Boolean`	No	Desactiva el análisis automático de los comandos salientes. Especifique `True` para usar cifrado explícito sin la biblioteca compartida de cifrado automático.
`encrypted_fields_map`	`Mapping`	No	Un esquema que especifica qué campos se cifrarán automáticamente y los tipos de consultas permitidas en esos campos. Para aprender cómo construir un esquema de cifrado, consulta Campos cifrados y queries habilitadas.
`crypt_shared_lib_path`	`String`	No	Especifique la ruta de archivo absoluta o relativa completa al archivo de la biblioteca en este parámetro para utilizar la biblioteca compartida de cifrado automático en lugar de `mongocryptd`. Si el controlador no puede cargar la biblioteca compartida de cifrado automático desde esta ruta, genera un error.
`crypt_shared_lib_required`	`Boolean`	No	Si especifica `True`, el controlador genera un error si `libmongocrypt` no puede cargar la biblioteca compartida de cifrado automático.
`key_vault_client`	`MongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja su colección de Key Vault. Si omite esta opción, el controlador utiliza la instancia `MongoClient` actual. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`kms_tls_options`	`Mapping[string, Any]`	No	Las opciones de TLS a utilizar al conectarse al proveedor KMS.
`mongocryptd_uri`	`String`	No	La URI de MongoDB utilizada para conectarse al proceso local `mongocryptd`, si se utiliza `mongocryptd` para el cifrado.
`mongocryptd_bypass_spawn`	`Boolean`	No	Si especifica `True` para este parámetro, el `MongoClient` cifrado no intenta generar el proceso `mongocryptd` si se utiliza `mongocryptd` para el cifrado.
`mongocryptd_spawn_path`	`String`	No	Se utiliza para generar el proceso `mongocryptd`, si se utiliza `mongocryptd` para el cifrado.
`mongocryptd_spawn_args`	`String`	No	Una lista de argumentos de cadena para usar al generar el proceso `mongocryptd`, si se usa `mongocryptd` para el cifrado.

Nota

Documentación de la API

Para obtener más información sobre estas opciones de cifrado automático, consulte la documentación de la API para la clase AutoEncryptionOpts.

Volver

Operaciones compatibles

Encriptación a nivel de campo