用于 Queryable Encryption 的 MongoClient 选项

在此页面上

概述

自动加密选项

带有相等查询的 Queryable Encryption 在 MongoDB 7中正式可用 (GA)。 0及更高版本。 Queryable Encryption 公共预览版，在版本6中发布。 0 ，不再受支持。使用公共预览版加密的数据与功能版本不兼容。有关更多信息，请参阅 MongoDB 7中的兼容性更改。 0 。

概述

在此页面上，您可以了解适用于 MongoClient实例的 Queryable Encryption 特定配置选项。

自动加密选项

下表显示了 AutoEncryptionOptions 对象的结构：

属性	数据类型	必需？	说明
`keyVaultNamespace`	`String`	是	密钥保管库集合的完整命名空间。
`kmsProviders`	`Object`	是	Queryable Encryption 用于管理客户主密钥 (CMK) 的密钥管理系统 (KMS)。要了解有关`kmsProviders`对象的详情，请参阅KMS 提供程序。要了解有关客户主密钥的更多信息，请参阅加密密钥和密钥保管库。
`bypassAutoEncryption`	`Boolean`	无	指定`true`可绕过自动加密规则并按字段执行显式（手动）加密。
`bypassQueryAnalysis`	`Boolean`	无	禁用对传出命令的自动分析。指定`true`以使用显式加密，而不使用自动加密共享库。
`encryptedFieldsMap`	`Object`	无	一种模式，用于指定要自动加密的字段以及允许对这些字段进行的查询类型。要了解如何构建加密模式，请参阅加密字段和查询。
`extraOptions`	`Object`	无	加密库的配置选项。要使用自动加密共享库而不是`mongocryptd` ，请在此对象的`cryptSharedLibPath`属性中指定库文件的完整绝对或相对文件路径。如果驱动程序无法从此路径加载自动加密共享库，则创建`MongoClient`将失败。
`keyVaultClient`	`MongoClient`	无	指定应连接到托管密钥保管库集合的 MongoDB 实例的`MongoClient` 。如果省略此选项，驱动程序将使用当前的`MongoClient`实例。要了解有关密钥保管库集合的更多信息，请参阅密钥保管库集合。
`tlsOptions`	`Object`	无	连接到 KMS 提供商时使用的 TLS 选项。

下表描述了AutoEncryptionOptions对象中的属性：

属性	数据类型	必需？	说明
`KeyVaultNamespace`	`CollectionNamespace`	是	密钥保管库集合的完整命名空间。
`KmsProviders`	`IReadOnlyDictionary`	是	Queryable Encryption 用于管理客户主密钥 (CMK) 的密钥管理系统 (KMS)。要了解有关`KmsProviders`对象的详情，请参阅KMS 提供程序。要了解有关客户主密钥的更多信息，请参阅加密密钥和密钥保管库。
`BypassAutoEncryption`	`Boolean`	无	指定`true`可绕过自动加密规则并按字段执行显式（手动）加密。
`BypassQueryAnalysis`	`Boolean`	无	禁用对传出命令的自动分析。将此属性设置为`true`可使用显式加密，而不使用自动加密共享库。
`EncryptedFieldsMap`	`IReadOnlyDictionary`	无	一种模式，用于指定要自动加密的字段以及允许对这些字段进行的查询类型。要了解如何构建加密模式，请参阅加密字段和查询。
`ExtraOptions`	`IReadOnlyDictionary`	无	加密库的配置选项。要使用自动加密共享库而不是`mongocryptd` ，请在`cryptSharedLibPath`属性中指定库文件的完整绝对或相对文件路径。如果驱动程序无法从此路径加载自动加密共享库，则创建`MongoClient`将失败。
`KeyVaultClient`	`IMongoClient`	无	指定应连接到托管密钥保管库集合的 MongoDB 实例的`MongoClient` 。如果省略此选项，驱动程序将使用当前的`MongoClient`实例。要了解有关密钥保管库集合的更多信息，请参阅密钥保管库集合。
`TlsOptions`	`IReadOnlyDictionary`	无	连接到 KMS 提供商时使用的 TLS 选项。

注意

API 文档

有关这些自动加密选项的详情，请参阅 AutoEncryptionOptions 的 API 文档类。

下表描述了AutoEncryptionOptions对象中的选项：

选项	数据类型	必需？	说明
`KeyVaultNamespace`	`String`	是	密钥保管库集合的完整命名空间。
`KmsProviders`	`map[string]map[string]interface{}`	是	Queryable Encryption 用于管理客户主密钥 (CMK) 的密钥管理系统 (KMS)。要了解有关`KmsProviders`对象的详情，请参阅KMS 提供程序。要了解有关客户主密钥的更多信息，请参阅加密密钥和密钥保管库。
`BypassAutoEncryption`	`*bool`	无	指定`true`可绕过自动加密规则并按字段执行显式（手动）加密。
`BypassQueryAnalysis`	`*bool`	无	禁用对传出命令的自动分析。指定`true`以使用显式加密，而不使用自动加密共享库。
`EncryptedFieldsMap`	`map[string]interface{}`	无	一种模式，用于指定要自动加密的字段以及允许对这些字段进行的查询类型。要了解如何构建加密模式，请参阅加密字段和查询。
`ExtraOptions`	`map[string]interface{}`	无	加密库的配置选项。要使用自动加密共享库而不是`mongocryptd` ，请在`cryptSharedLibPath`属性中指定库文件的完整绝对或相对文件路径。如果驱动程序无法从此路径加载自动加密共享库，则创建`MongoClient`将失败。
`KeyVaultClientOptions`	`*ClientOptions`	无	用于连接到托管密钥保管库集合的 MongoDB 实例的新内部`mongo.Client`的选项。如果省略此选项，驱动程序将使用当前的`MongoClient`实例。要了解有关密钥保管库集合的更多信息，请参阅密钥保管库集合。
`TlsConfig`	`map[string]*tls.Config`	无	连接到 KMS 提供商时使用的 TLS 选项。

注意

API 文档

有关这些自动加密选项的更多信息，请参阅 AutoEncryptionOptions 的 API 文档类型。

下表描述了AutoEncryptionSettings构建器上可用的方法：

方法	数据类型	必需？	说明
`keyVaultNamespace`	`String`	是	密钥保管库集合的完整命名空间。
`kmsProviders`	`Map`	是	Queryable Encryption 用于管理客户主密钥 (CMK) 的密钥管理系统 (KMS)。要了解有关`kmsProviders`对象的详情，请参阅KMS 提供程序。要了解有关客户主密钥的更多信息，请参阅加密密钥和密钥保管库。
`bypassAutoEncryption`	`Boolean`	无	指定`true`可绕过自动加密规则并按字段执行显式（手动）加密。
`bypassQueryAnalysis`	`Boolean`	无	禁用对传出命令的自动分析。指定`true`以使用显式加密，而不使用自动加密共享库。
`encryptedFieldsMap`	`Map`	无	一种模式，用于指定要自动加密的字段以及允许对这些字段进行的查询类型。要了解如何构建加密模式，请参阅加密字段和查询。
`extraOptions`	`Map`	无	加密库的配置选项。要使用自动加密共享库而不是`mongocryptd` ，请在`cryptSharedLibPath`属性中指定库文件的完整绝对或相对文件路径。
`keyVaultMongoClientSettings`	`MongoClientSettings`	无	用于连接到托管您的密钥保管库集合的 MongoDB 实例的新`MongoClient`实例的设置。如果省略此选项，驱动程序将使用当前的`MongoClient`实例。要了解有关密钥保管库集合的更多信息，请参阅密钥保管库集合。
`kmsProviderPropertySuppliers`	`Map`	无	与`kmsProviders()`方法类似，但为每个属性配置一个`Supplier` 。
`kmsProviderSslContextMap`	`Map`	无	用于身份验证的 SSL 上下文。

注意

API 文档

下表显示了 AutoEncryptionOptions 对象的结构：

属性	数据类型	必需？	说明
`keyVaultNamespace`	`String`	是	密钥保管库集合的完整命名空间。
`kmsProviders`	`Object`	是	Queryable Encryption 用于管理客户主密钥 (CMK) 的密钥管理系统 (KMS)。要了解有关`kmsProviders`对象的详情，请参阅KMS 提供程序。要了解有关客户主密钥的更多信息，请参阅加密密钥和密钥保管库。
`bypassAutoEncryption`	`Boolean`	无	指定`true`可绕过自动加密规则并按字段执行显式（手动）加密。
`bypassQueryAnalysis`	`Boolean`	无	禁用对传出命令的自动分析。指定`true`以使用显式加密，而不使用自动加密共享库。如果未指定，则默认为`false` 。
`encryptedFieldsMap`	`Object`	无	一种模式，用于指定要自动加密的字段以及允许对这些字段进行的查询类型。要了解如何构建加密模式，请参阅加密字段和查询。
`extraOptions`	`Object`	无	加密库的配置选项。要使用自动加密共享库而不是`mongocryptd` ，请在此对象的`cryptSharedLibPath`属性中指定库文件的完整绝对或相对文件路径。如果驱动程序无法从此路径加载自动加密共享库，则创建`MongoClient`将失败。
`keyVaultClient`	`MongoClient`	无	指定应连接到托管密钥保管库集合的 MongoDB 实例的`MongoClient` 。如果省略此选项，驱动程序将使用当前的`MongoClient`实例。要了解有关密钥保管库集合的更多信息，请参阅密钥保管库集合。
`tlsOptions`	`Object`	无	连接到 KMS 提供商时使用的 TLS 选项。

注意

API 文档

有关这些自动加密选项的更多信息，请参阅 AutoEncryptionOptions 的 API 文档接口。

下表描述了AutoEncryptionOpts类的参数：

参数	数据类型	必需？	说明
`key_vault_namespace`	`String`	是	密钥保管库集合的完整命名空间。
`kms_providers`	`Mapping[string, Any]`	是	Queryable Encryption 用于管理客户主密钥 (CMK) 的密钥管理系统 (KMS)。要了解有关`kms_Providers`地图的详情，请参阅KMS 提供程序。要了解有关客户主密钥的更多信息，请参阅加密密钥和密钥保管库。
`bypass_auto_encryption`	`Boolean`	无	指定`True`可绕过自动加密规则并按字段执行显式（手动）加密。
`bypass_query_analysis`	`Boolean`	无	禁用对传出命令的自动分析。指定`True`以使用显式加密，而不使用自动加密共享库。
`encrypted_fields_map`	`Mapping`	无	一种模式，用于指定要自动加密的字段以及允许对这些字段进行的查询类型。要了解如何构建加密模式，请参阅加密字段和查询。
`crypt_shared_lib_path`	`String`	无	在此参数中指定库文件的完整绝对或相对文件路径，以使用自动加密共享库，而不是`mongocryptd` ，如果驱动程序无法从此路径加载自动加密共享库，则会引发错误。
`crypt_shared_lib_required`	`Boolean`	无	如果您指定`True` ，则当`libmongocrypt`无法加载自动加密共享库时，驱动程序会引发错误。
`key_vault_client`	`MongoClient`	无	指定应连接到托管密钥保管库集合的 MongoDB 实例的`MongoClient` 。如果省略此选项，驱动程序将使用当前的`MongoClient`实例。要了解有关密钥保管库集合的更多信息，请参阅密钥保管库集合。
`kms_tls_options`	`Mapping[string, Any]`	无	连接到 KMS 提供商时使用的 TLS 选项。
`mongocryptd_uri`	`String`	无	如果使用`mongocryptd`进行加密，则用于连接到本地`mongocryptd`进程的 MongoDB URI。
`mongocryptd_bypass_spawn`	`Boolean`	无	如果您为此参数指定`True` ，并且使用`mongocryptd`进行加密，则加密的`MongoClient`不会尝试生成`mongocryptd`进程。
`mongocryptd_spawn_path`	`String`	无	如果使用`mongocryptd`进行加密，则用于生成`mongocryptd`进程。
`mongocryptd_spawn_args`	`String`	无	如果使用`mongocryptd`进行加密，则生成`mongocryptd`进程时要使用的字符串参数列表。

注意

API 文档

有关这些自动加密选项的更多信息，请参阅 AutoEncryptionOpts 的 API 文档类。

后退

支持的操作

来年

客户端字段级加密 (Client-Side Field Level Encryption)