可查询加密的 MongoClient 选项

本页内容

概述

自动加密选项

概述

在本页，您可以了解有关 MongoClient 实例的可查询加密特定配置选项。MongoClient 实例。

自动加密选项

以下表格描述了 AutoEncryptionOptions 对象的结构

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

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

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

注意

API 文档

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

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

选项	数据类型	必需？	描述
`KeyVaultNamespace`	`字符串`	是	密钥库集合的完整命名空间。
`KmsProviders`	`map[string]map[string]interface{}`	是	可查询加密用于管理您的客户主密钥 (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`	`字符串`	是	密钥库集合的完整命名空间。
`kmsProviders`	`Map`	是	可查询加密用于管理您的客户主密钥 (CMK) 的密钥管理系统 (KMS)。有关 `kmsProviders` 对象的更多信息，请参阅 KMS 提供商。有关客户主密钥的更多信息，请参阅加密密钥和密钥库。
`bypassAutoEncryption`	`布尔值`	否	指定 `true` 以绕过自动加密规则并执行显式（手动）的字段级加密。
`bypassQueryAnalysis`	`布尔值`	否	禁用自动分析出站命令。指定 `true` 以使用显式加密而不使用自动加密共享库。
`encryptedFieldsMap`	`Map`	否	一个指定要自动加密的字段以及允许在这些字段上执行的查询类型的模式。要了解如何构建加密模式，请参阅加密字段和启用查询。
`extraOptions`	`Map`	否	加密库的配置选项。要使用自动加密共享库而不是 `mongocryptd`，请在 `cryptSharedLibPath` 属性中指定库文件的完整绝对或相对文件路径。
`keyVaultMongoClientSettings`	`MongoClientSettings`	否	为连接到托管您的密钥保管库集合的MongoDB实例的新 `MongoClient` 实例提供的设置。如果省略此选项，驱动程序将使用当前的 `MongoClient` 实例。要了解更多关于密钥库集合的信息，请参阅密钥库集合。
`kmsProviderPropertySuppliers`	`Map`	否	与 `kmsProviders()` 方法类似，但为每个属性配置一个 `Supplier`。
`kmsProviderSslContextMap`	`Map`	否	用于身份验证的SSL上下文。

注意

API 文档

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

以下表格描述了 AutoEncryptionOptions 对象的结构

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

注意

API 文档

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

以下表格描述了 AutoEncryptionOpts 类的参数

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

注意

API 文档

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

支持的操作

下一步

客户端字段级加密