Queryable Encryption の MongoClient オプション

項目一覧

Overview

AutoEncryptionOpts
例

等価クエリを使用した Queryable Encryption は、MongoDB 7.0で通常使用可能（GA）です。 Queryable Encryption を使用するには、互換性のあるドライバーを使用して MongoDB をバージョン7.0にアップグレードします。 MongoDB 6.0でリリースされた Queryable Encryption Public Preview はサポートされなくなり、GA 機能と互換性がありません。詳しくは、 MongoDB 7を参照してください。 0互換性ノート。

Overview

MongoClientインスタンスの Queryable Encryption 固有の構成オプションに関する情報を表示します。

AutoEncryptionOpts

Queryable Encryption の固有オプションを指定するには、 AutoEncryptionOptsオブジェクトをMongoClientインスタンスに渡します。

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

Parameter	タイプ	必須	説明
`keyVaultClient`	`MongoClient`	No	キーヴォールトコレクションをホストしている MongoDB インスタンスに接続するように構成された`MongoClient`インスタンス。 `keyVaultClient`オプションを省略すると、 `AutoEncryptionOpts`構成を含む`MongoClient`インスタンスに指定された MongoDB インスタンスが、キーヴォールトコレクションのホストとして使用されます。キー Vault コレクションの詳細については、「キー Vault コレクション」を参照してください。
`keyVaultNamespace`	文字列	はい	キーヴォールトコレクションの完全な名前空間。
`kmsProviders`	オブジェクト	はい	CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System）。 `kmsProviders`オブジェクトの詳細については、 KMS プロバイダーを参照してください。 CMK の詳細については、「キーとキーヴォールト」を参照してください。
`encryptedFieldsMap`	オブジェクト	No	暗号化スキーマ。暗号化スキーマの構築方法については、「フィールドの暗号化とクエリ可能性」を参照してください。
`bypassQueryAnalysis`	ブール値	No	送信コマンドの自動分析を無効にします。 `crypt_shared`ライブラリなしでインデックス付きフィールドで明示的な暗号化を使用するには、 `bypassQueryAnalysis`を`true`に設定します。指定しない場合、デフォルトは`false`になります。

例

AutoEncryptionOptsを使用してMongoClientインスタンスを構成する方法を示すコードスニペットを表示するには、ドライバーに対応するタブを選択します。

var AutoEncryptionOpts =
{
   "keyVaultClient" : keyVaultClient,
   "keyVaultNamespace" : "<database>.<collection>",
   "kmsProviders" : { ... },
   "bypassQueryAnalysis": "<boolean value>", // optional - defaults to false
   "encryptedFieldsMap" : { ... }
}
cluster = Mongo(
  "mongodb://myhostexample.net:27017/?replicaSet=myReplicaSet",
  AutoEncryptionOpts
);

Tip

環境変数

可能であれば、で提供される認証情報を環境変数として定義し、オプションを使用してkmsProviders mongosh--evalに渡すことを検討してください。これにより、認証情報がログに漏洩する可能性を最小限に抑えられます。

const secureClient = new MongoClient(connectionString, {
  useNewUrlParser: true,
  useUnifiedTopology: true,
  monitorCommands: true,
  autoEncryption: {
    keyVaultNamespace,
    kmsProviders,
    bypassQueryAnalysis, // optional - defaults to false
    encryptedFieldsMap: patientSchema,
    extraOptions: extraOptions,
  },
});

自動暗号化共有ライブラリを構成するための追加オプションの詳細については、「構成」を参照してください。

戻る

サポートされている操作

共有ライブラリ