Opciones de MongoClient para Queryable Encryption

Overview

En esta página, puedes aprender sobre las opciones de configuración específicas de cifrado consultable para las instancias de MongoClient.

Opciones de cifrado automático

La siguiente tabla describe la estructura de un objeto AutoEncryptionOptions:

Propiedad	Tipo de dato	¿Requerido?	Descripción
`keyVaultNamespace`	`String`	Sí	El namespace completo de la Colección de Bóvedas de Llaves.
`kmsProviders`	`Object`	Sí	El sistema de gestión de claves (KMS) utilizado por Queryable Encryption para administrar tus claves maestras de cliente (CMK). Para obtener más información sobre los objetos `kmsProviders`, consulta Proveedores de KMS. Para obtener más información sobre las llaves maestras de cliente, consulte llaves de cifrado y bóvedas de claves.
`bypassAutoEncryption`	`Boolean`	No	Indique `true` para omitir las reglas de cifrado automáticas y realizar un cifrado explícito (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Deshabilita el análisis automático de comandos salientes. Especifique `true` para utilizar cifrado explícito sin la librería de Encriptación Automática.
`encryptedFieldsMap`	`Object`	No	Un esquema que especifica qué campos se deben encriptar 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.
`explicitEncryptionOnly`	`Boolean`	No	Si estableces `explicitEncryptionOnly` en `true`, el driver utiliza únicamente el cifrado explícito (manual) por campo y remueve la configuración de cifrado automático de la conexión. Debes cifrar y descifrar manualmente los valores de campos usando la API de `ClientEncryption`. Esta opción sólo funciona con CSFLE.
`keyVaultClient`	`MongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja tu Colección de Bóvedas de Llaves. Si omite esta opción, el controlador utilizará la instancia actual de `MongoClient`. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`tlsOptions`	`Object`	No	Las opciones de TLS que se deben utilizar al conectarse al proveedor de KMS.

La siguiente tabla describe las propiedades de un objeto AutoEncryptionOptions:

Propiedad	Tipo de dato	¿Requerido?	Descripción
`KeyVaultNamespace`	`CollectionNamespace`	Sí	El namespace completo de la Colección de Bóvedas de Llaves.
`KmsProviders`	`IReadOnlyDictionary`	Sí	El sistema de gestión de claves (KMS) utilizado por Queryable Encryption para administrar tus claves maestras de cliente (CMK). Para obtener más información sobre los objetos `KmsProviders`, consulta Proveedores de KMS. Para obtener más información sobre las llaves maestras de cliente, consulte llaves de cifrado y bóvedas de claves.
`BypassAutoEncryption`	`Boolean`	No	Indique `true` para omitir las reglas de cifrado automáticas y realizar un cifrado explícito (manual) por campo.
`BypassQueryAnalysis`	`Boolean`	No	Desactiva el análisis automático de los comandos salientes. Establece esta propiedad en `true` para usar el cifrado explícito sin la librería compartida de cifrado automático.
`EncryptedFieldsMap`	`IReadOnlyDictionary`	No	Un esquema que especifica qué campos se deben encriptar 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 librería de cifrado. Para usar la Librería Compartida de Cifrado Automático en lugar de `mongocryptd`, especifica la ruta absoluta o relativa completa del archivo de la librería en la propiedad `cryptSharedLibPath`. Si el driver no puede cargar la librería Compartida de cifrado automático desde esta ruta, la creación del `MongoClient` fallará.
`KeyVaultClient`	`IMongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja tu Colección de Bóvedas de Llaves. Si omite esta opción, el controlador utilizará la instancia actual de `MongoClient`. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`TlsOptions`	`IReadOnlyDictionary`	No	Las opciones de TLS que se deben utilizar al conectarse al proveedor de KMS.

Nota

Documentación de la API

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

La siguiente tabla describe las opciones en un objeto AutoEncryptionOptions:

Opción	Tipo de dato	¿Requerido?	Descripción
`KeyVaultNamespace`	`String`	Sí	El namespace completo de la Colección de Bóvedas de Llaves.
`KmsProviders`	`map[string]map[string]interface{}`	Sí	El sistema de gestión de claves (KMS) utilizado por Queryable Encryption para administrar tus claves maestras de cliente (CMK). Para obtener más información sobre los objetos `KmsProviders`, consulta Proveedores de KMS. Para obtener más información sobre las llaves maestras de cliente, consulte llaves de cifrado y bóvedas de claves.
`BypassAutoEncryption`	`*bool`	No	Indique `true` para omitir las reglas de cifrado automáticas y realizar un cifrado explícito (manual) por campo.
`BypassQueryAnalysis`	`*bool`	No	Deshabilita el análisis automático de comandos salientes. Especifique `true` para utilizar cifrado explícito sin la librería de Encriptación Automática.
`EncryptedFieldsMap`	`map[string]interface{}`	No	Un esquema que especifica qué campos se deben encriptar 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 librería de cifrado. Para usar la Librería Compartida de Cifrado Automático en lugar de `mongocryptd`, especifica la ruta absoluta o relativa completa del archivo de la librería en la propiedad `cryptSharedLibPath`. Si el driver no puede cargar la librería Compartida de cifrado automático desde esta ruta, la creación del `MongoClient` fallará.
`KeyVaultClientOptions`	`*ClientOptions`	No	Opciones para un nuevo `mongo.Client` interno que se conecte a la instancia de MongoDB que aloja su Colección de Bóvedas de Llaves. Si omite esta opción, el controlador utilizará la instancia actual de `MongoClient`. 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 que se deben utilizar al conectarse al proveedor de 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 generador AutoEncryptionSettings:

Método	Tipo de dato	¿Requerido?	Descripción
`keyVaultNamespace`	`String`	Sí	El namespace completo de la Colección de Bóvedas de Llaves.
`kmsProviders`	`Map`	Sí	El sistema de gestión de claves (KMS) utilizado por Queryable Encryption para administrar tus claves maestras de cliente (CMK). Para obtener más información sobre los objetos `kmsProviders`, consulta Proveedores de KMS. Para obtener más información sobre las llaves maestras de cliente, consulte llaves de cifrado y bóvedas de claves.
`bypassAutoEncryption`	`Boolean`	No	Indique `true` para omitir las reglas de cifrado automáticas y realizar un cifrado explícito (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Deshabilita el análisis automático de comandos salientes. Especifique `true` para utilizar cifrado explícito sin la librería de Encriptación Automática.
`encryptedFieldsMap`	`Map`	No	Un esquema que especifica qué campos se deben encriptar 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 librería de cifrado. Para usar la Librería Compartida de Cifrado Automático en lugar de `mongocryptd`, especifica la ruta absoluta o relativa completa del archivo de la librería en la propiedad `cryptSharedLibPath`.
`keyVaultMongoClientSettings`	`MongoClientSettings`	No	Configuraciones para una nueva instancia de `MongoClient` para conectarse a la instancia de MongoDB que aloja su Colección de Bóvedas de Llaves. Si omite esta opción, el controlador utilizará la instancia actual de `MongoClient`. 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 en su lugar.
`kmsProviderSslContextMap`	`Map`	No	El contexto SSL que se usará para la autenticación.

Nota

Documentación de la API

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

La siguiente tabla describe la estructura de un objeto AutoEncryptionOptions:

Propiedad	Tipo de dato	¿Requerido?	Descripción
`keyVaultNamespace`	`String`	Sí	El namespace completo de la Colección de Bóvedas de Llaves.
`kmsProviders`	`Object`	Sí	El sistema de gestión de claves (KMS) utilizado por Queryable Encryption para administrar tus claves maestras de cliente (CMK). Para obtener más información sobre los objetos `kmsProviders`, consulta Proveedores de KMS. Para obtener más información sobre las llaves maestras de cliente, consulte llaves de cifrado y bóvedas de claves.
`bypassAutoEncryption`	`Boolean`	No	Indique `true` para omitir las reglas de cifrado automáticas y realizar un cifrado explícito (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Deshabilita el análisis automático de comandos salientes. Especifica `true` para usar el cifrado explícito sin la Biblioteca Compartida de Cifrado Automático. Se asigna por defecto a `false` si no se especifica.
`encryptedFieldsMap`	`Object`	No	Un esquema que especifica qué campos se deben encriptar 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 librería de cifrado. Para utilizar la Biblioteca Compartida de Encriptación Automática en lugar de `mongocryptd`, especifica la ruta completa absoluta o relativa al archivo de la librería en la propiedad `cryptSharedLibPath` de este objeto. Si el driver no puede cargar la librería Compartida de cifrado automático desde esta ruta, la creación del `MongoClient` fallará.
`keyVaultClient`	`MongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja tu Colección de Bóvedas de Llaves. Si omite esta opción, el controlador utilizará la instancia actual de `MongoClient`. Para obtener más información sobre las colecciones de Key Vault, consulte Colecciones de Key Vault.
`tlsOptions`	`Object`	No	Las opciones de TLS que se deben utilizar al conectarse al proveedor de KMS.

Nota

Documentación de la API

Para obtener más información sobre estas opciones de cifrado automático, consulta 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	¿Requerido?	Descripción
`key_vault_namespace`	`String`	Sí	El namespace completo de la Colección de Bóvedas de Llaves.
`kms_providers`	`Mapping[string, Any]`	Sí	El sistema de gestión de claves (KMS) utilizado por Queryable Encryption para administrar tus claves maestras de cliente (CMK). Para obtener más información sobre los mapas `kms_Providers`, consulta Proveedores KMS. Para obtener más información sobre las llaves maestras de cliente, consulte llaves de cifrado y bóvedas de claves.
`bypass_auto_encryption`	`Boolean`	No	Indique `True` para omitir las reglas de cifrado automáticas y realizar un cifrado explícito (manual) por campo.
`bypass_query_analysis`	`Boolean`	No	Deshabilita el análisis automático de comandos salientes. Especifique `True` para utilizar cifrado explícito sin la librería de Encriptación Automática.
`encrypted_fields_map`	`Mapping`	No	Un esquema que especifica qué campos se deben encriptar 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	Especificar la ruta de archivo absoluta o relativa completa al archivo de librería en este parámetro para usar la librería Compartida de cifrado automático en lugar de `mongocryptd`. Si el driver no puede cargar la librería compartida de cifrado automático desde esta ruta, generará un error.
`crypt_shared_lib_required`	`Boolean`	No	Si se especifica `True`, el driver genera un error si `libmongocrypt` no puede cargar la librería Compartida de cifrado automático.
`key_vault_client`	`MongoClient`	No	Especifica el `MongoClient` que debe conectarse a la instancia de MongoDB que aloja tu Colección de Bóvedas de Llaves. Si omite esta opción, el controlador utilizará la instancia actual de `MongoClient`. 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 que se deben utilizar al conectarse al proveedor de KMS.
`mongocryptd_uri`	`String`	No	El URI de MongoDB que se utiliza para conectarse al proceso local `mongocryptd`, si se utiliza `mongocryptd` para el cifrado.
`mongocryptd_bypass_spawn`	`Boolean`	No	Si especificas `True` para este parámetro, el `MongoClient` cifrado no intenta generar el proceso `mongocryptd`, si se utiliza `mongocryptd` para cifrado.
`mongocryptd_spawn_path`	`String`	No	Se utiliza para invocar el proceso `mongocryptd`, si se utiliza `mongocryptd` para el cifrado.
`mongocryptd_spawn_args`	`String`	No	Una lista de argumentos de string para usar al generar el proceso `mongocryptd`, si se utiliza `mongocryptd` para cifrado.

Nota

Documentación de la API

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

Volver

Operaciones compatibles

Encriptación a nivel de campo