Queryable Encryption の MongoClient オプション

項目一覧

Overview

自動暗号化オプション

Overview

このページでは、 MongoClientインスタンスの Queryable Encryption 固有の構成オプションについて説明します。

自動暗号化オプション

次の表は、 AutoEncryptionOptionsオブジェクトの構造を説明するものです。

プロパティ	データ型	必須	説明
`keyVaultNamespace`	`String`	はい	キーヴォールトコレクションの完全な名前空間。
`kmsProviders`	`Object`	はい	CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System）。 `kmsProviders`オブジェクトの詳細については、 KMS プロバイダーを参照してください。 CMK の詳細については、「暗号化キーとキーヴォールト」を参照してください。
`bypassAutoEncryption`	`Boolean`	No	自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 `true`を指定します。
`bypassQueryAnalysis`	`Boolean`	No	送信コマンドの自動分析を無効にします。自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 `true`を指定します。
`encryptedFieldsMap`	`Object`	No	自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。暗号化スキーマの構築方法については、「暗号化されたフィールド」と「有効なクエリ」を参照してください。
`extraOptions`	`Object`	No	暗号化ライブラリの構成オプション。 `mongocryptd`の代わりに自動暗号化共有ライブラリを使用するには、このオブジェクトの`cryptSharedLibPath`プロパティでライブラリファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合、 `MongoClient`の作成は失敗します。
`keyVaultClient`	`MongoClient`	No	キーヴォールトコレクションをホストしている MongoDB インスタンスに接続する`MongoClient`を指定します。このオプションを省略すると、ドライバーは現在の`MongoClient`インスタンスを使用します。キー Vault コレクションの詳細については、「キー Vault コレクション」を参照してください。
`tlsOptions`	`Object`	No	KMS プロバイダーに接続するときに使用する TLS オプションです。

次の表では、 AutoEncryptionOptionsオブジェクトのプロパティを説明しています。

プロパティ	データ型	必須	説明
`KeyVaultNamespace`	`CollectionNamespace`	はい	キーヴォールトコレクションの完全な名前空間。
`KmsProviders`	`IReadOnlyDictionary`	はい	CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System）。 `KmsProviders`オブジェクトの詳細については、 KMS プロバイダーを参照してください。 CMK の詳細については、「暗号化キーとキーヴォールト」を参照してください。
`BypassAutoEncryption`	`Boolean`	No	自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 `true`を指定します。
`BypassQueryAnalysis`	`Boolean`	No	送信コマンドの自動分析を無効にします。自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、このプロパティを`true`に設定します。
`EncryptedFieldsMap`	`IReadOnlyDictionary`	No	自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。暗号化スキーマの構築方法については、「暗号化されたフィールド」と「有効なクエリ」を参照してください。
`ExtraOptions`	`IReadOnlyDictionary`	No	暗号化ライブラリの構成オプション。 `mongocryptd`の代わりに自動暗号化共有ライブラリを使用するには、 `cryptSharedLibPath`プロパティでライブラリファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合、 `MongoClient`の作成は失敗します。
`KeyVaultClient`	`IMongoClient`	No	キーヴォールトコレクションをホストしている MongoDB インスタンスに接続する`MongoClient`を指定します。このオプションを省略すると、ドライバーは現在の`MongoClient`インスタンスを使用します。キー Vault コレクションの詳細については、「キー Vault コレクション」を参照してください。
`TlsOptions`	`IReadOnlyDictionary`	No	KMS プロバイダーに接続するときに使用する TLS オプションです。

注意

API ドキュメント

これらの自動暗号化オプションの詳細については、 AutoEncryptionOptions の API ドキュメントを参照してくださいクラス。

次の表では、 AutoEncryptionOptionsオブジェクトのオプションを説明しています。

オプション	データ型	必須	説明
`KeyVaultNamespace`	`String`	はい	キーヴォールトコレクションの完全な名前空間。
`KmsProviders`	`map[string]map[string]interface{}`	はい	CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System）。 `KmsProviders`オブジェクトの詳細については、 KMS プロバイダーを参照してください。 CMK の詳細については、「暗号化キーとキーヴォールト」を参照してください。
`BypassAutoEncryption`	`*bool`	No	自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 `true`を指定します。
`BypassQueryAnalysis`	`*bool`	No	送信コマンドの自動分析を無効にします。自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 `true`を指定します。
`EncryptedFieldsMap`	`map[string]interface{}`	No	自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。暗号化スキーマの構築方法については、「暗号化されたフィールド」と「有効なクエリ」を参照してください。
`ExtraOptions`	`map[string]interface{}`	No	暗号化ライブラリの構成オプション。 `mongocryptd`の代わりに自動暗号化共有ライブラリを使用するには、 `cryptSharedLibPath`プロパティでライブラリファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合、 `MongoClient`の作成は失敗します。
`KeyVaultClientOptions`	`*ClientOptions`	No	キーヴォールトコレクションをホストしている MongoDB インスタンスに接続するための新しい内部`mongo.Client`のオプション。このオプションを省略すると、ドライバーは現在の`MongoClient`インスタンスを使用します。キー Vault コレクションの詳細については、「キー Vault コレクション」を参照してください。
`TlsConfig`	`map[string]*tls.Config`	No	KMS プロバイダーに接続するときに使用する TLS オプションです。

注意

API ドキュメント

これらの自動暗号化オプションの詳細については、 AutoEncryptionOptions の API ドキュメントを参照してください型。

次の表では、 AutoEncryptionSettingsビルダで利用できるメソッドを説明しています。

方式	データ型	必須	説明
`keyVaultNamespace`	`String`	はい	キーヴォールトコレクションの完全な名前空間。
`kmsProviders`	`Map`	はい	CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System）。 `kmsProviders`オブジェクトの詳細については、 KMS プロバイダーを参照してください。 CMK の詳細については、「暗号化キーとキーヴォールト」を参照してください。
`bypassAutoEncryption`	`Boolean`	No	自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 `true`を指定します。
`bypassQueryAnalysis`	`Boolean`	No	送信コマンドの自動分析を無効にします。自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 `true`を指定します。
`encryptedFieldsMap`	`Map`	No	自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。暗号化スキーマの構築方法については、「暗号化されたフィールド」と「有効なクエリ」を参照してください。
`extraOptions`	`Map`	No	暗号化ライブラリの構成オプション。 `mongocryptd`の代わりに自動暗号化共有ライブラリを使用するには、 `cryptSharedLibPath`プロパティでライブラリファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。
`keyVaultMongoClientSettings`	`MongoClientSettings`	No	新しい`MongoClient`インスタンスが、キーヴォールトコレクションをホストしている MongoDB インスタンスに接続するための設定。このオプションを省略すると、ドライバーは現在の`MongoClient`インスタンスを使用します。キー Vault コレクションの詳細については、「キー Vault コレクション」を参照してください。
`kmsProviderPropertySuppliers`	`Map`	No	`kmsProviders()`メソッドと同様ですが、代わりに各プロパティに対して`Supplier`を構成します。
`kmsProviderSslContextMap`	`Map`	No	認証に使用する SSL コンテキスト。

注意

API ドキュメント

これらの自動暗号化オプションの詳細については、 AutoEncryptionSettings.Builder の API ドキュメントを参照してくださいクラス。

次の表は、 AutoEncryptionOptionsオブジェクトの構造を説明するものです。

プロパティ	データ型	必須	説明
`keyVaultNamespace`	`String`	はい	キーヴォールトコレクションの完全な名前空間。
`kmsProviders`	`Object`	はい	CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System）。 `kmsProviders`オブジェクトの詳細については、 KMS プロバイダーを参照してください。 CMK の詳細については、「暗号化キーとキーヴォールト」を参照してください。
`bypassAutoEncryption`	`Boolean`	No	自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 `true`を指定します。
`bypassQueryAnalysis`	`Boolean`	No	送信コマンドの自動分析を無効にします。自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 `true`を指定します。指定しない場合、デフォルトは`false`です。
`encryptedFieldsMap`	`Object`	No	自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。暗号化スキーマの構築方法については、「暗号化されたフィールド」と「有効なクエリ」を参照してください。
`extraOptions`	`Object`	No	暗号化ライブラリの構成オプション。 `mongocryptd`の代わりに自動暗号化共有ライブラリを使用するには、このオブジェクトの`cryptSharedLibPath`プロパティでライブラリファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合、 `MongoClient`の作成は失敗します。
`keyVaultClient`	`MongoClient`	No	キーヴォールトコレクションをホストしている MongoDB インスタンスに接続する`MongoClient`を指定します。このオプションを省略すると、ドライバーは現在の`MongoClient`インスタンスを使用します。キー Vault コレクションの詳細については、「キー Vault コレクション」を参照してください。
`tlsOptions`	`Object`	No	KMS プロバイダーに接続するときに使用する TLS オプションです。

注意

API ドキュメント

これらの自動暗号化オプションの詳細については、 AutoEncryptionOptions の API ドキュメントを参照してくださいインターフェースを使用します。

次の表では、 AutoEncryptionOptsクラスのパラメータを説明しています。

Parameter	データ型	必須	説明
`key_vault_namespace`	`String`	はい	キーヴォールトコレクションの完全な名前空間。
`kms_providers`	`Mapping[string, Any]`	はい	CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System）。 `kms_Providers`マップの詳細については、 KMS プロバイダーを参照してください。 CMK の詳細については、「暗号化キーとキーヴォールト」を参照してください。
`bypass_auto_encryption`	`Boolean`	No	自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 `True`を指定します。
`bypass_query_analysis`	`Boolean`	No	送信コマンドの自動分析を無効にします。自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 `True`を指定します。
`encrypted_fields_map`	`Mapping`	No	自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。暗号化スキーマの構築方法については、「暗号化されたフィールド」と「有効なクエリ」を参照してください。
`crypt_shared_lib_path`	`String`	No	このパラメータでライブラリファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定して、 `mongocryptd`の代わりに自動暗号化共有ライブラリを使用します。ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合は、エラーが発生します。
`crypt_shared_lib_required`	`Boolean`	No	`True`を指定した場合、 `libmongocrypt`が自動暗号化共有ライブラリを読み込まない場合、ドライバーはエラーを発生させます。
`key_vault_client`	`MongoClient`	No	キーヴォールトコレクションをホストしている MongoDB インスタンスに接続する`MongoClient`を指定します。このオプションを省略すると、ドライバーは現在の`MongoClient`インスタンスを使用します。キー Vault コレクションの詳細については、「キー Vault コレクション」を参照してください。
`kms_tls_options`	`Mapping[string, Any]`	No	KMS プロバイダーに接続するときに使用する TLS オプションです。
`mongocryptd_uri`	`String`	No	暗号化に`mongocryptd`を使用する場合に、ローカル`mongocryptd`プロセスへの接続に使用される MongoDB URI 。
`mongocryptd_bypass_spawn`	`Boolean`	No	このパラメータに`True`を指定すると、暗号化された`MongoClient`は、暗号化に`mongocryptd`を使用している場合、 `mongocryptd`プロセスの生成を試行しません。
`mongocryptd_spawn_path`	`String`	No	暗号化に`mongocryptd`を使用する場合に、 `mongocryptd`プロセスを生成するために使用されます。
`mongocryptd_spawn_args`	`String`	No	暗号化に`mongocryptd`を使用する場合に、 `mongocryptd`プロセスを生成するときに使用する string 引数のリスト。

注意

API ドキュメント

これらの自動暗号化オプションの詳細については、 AutoEncryptionOpts の API ドキュメントを参照してくださいクラス。

戻る

サポートされている操作

クライアントサイドのフィールドレベル暗号化