クライアント側のフィールドレベル暗号化メソッド

MongoDB5.0 は 10 月2024 をもってサポートを終了します。このバージョンのドキュメントはサポート対象外になりました。配置をアップグレードするには、 MongoDB を参照してください。5.0 60アップグレード手順。

注意

構文や例など、特定のメソッドの詳細については、「メソッドの参照ページ」へのリンクをクリックしてください。

mongoクライアント側のフィールドレベル暗号化メソッドでは、クライアント側のフィールドレベル暗号化が有効になっているデータベース接続が必要です。現在のデータベース接続がクライアント側のフィールドレベル暗号化を有効にして開始されなかった場合、次のいずれかが発生します。

必要なクライアント側のフィールドレベル暗号化オプションとの接続を確立するには、 Mongo()mongoshell からコンストラクターを使用します。The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
or
必要なオプションとの接続を確立するには、 mongo shellコマンドラインオプションを使用します。コマンドラインオプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。

次のメソッドはmongoshのみのです。 MongoDB ドライバーを使用してクライアント側のフィールドレベル暗号化を実装する手順については、ドライバーのドキュメントを参照してください。 See Driver Compatibility Table for a complete list of drivers with support for client-side field level encryption.

名前	説明
`getKeyVault()`	現在の MongoDB 接続のキーヴォールトオブジェクトを返します。
`KeyVault.createKey()`	クライアント側のフィールドレベル暗号化で使用するデータ暗号化キーを作成します。
`KeyVault.deleteKey()`	指定されたデータ暗号化キーをキーヴォールトから削除します。
`KeyVault.getKey()`	指定されたデータ暗号化キーをキーヴォールトから検索します。
`KeyVault.getKeys()`	キーヴォールト内のすべてのキーを検索します。
`KeyVault.addKeyAlternateName()`	指定されたデータ暗号化キーに、キーの別名を関連付けます。
`KeyVault.removeKeyAlternateName()`	指定されたデータ暗号化キーからキーの別名を削除します。
`KeyVault.getKeyByAltName()`	指定されたキーの別名を持つキーを検索します。
`getClientEncryption()`	フィールドの明示的な暗号化および復号化をサポートするためのクライアント暗号化オブジェクトを返します。
`ClientEncryption.encrypt()`	指定されたデータ暗号化キーと暗号化アルゴリズムを使ってフィールドを暗号化します。
`ClientEncryption.decrypt()`	関連付けられたデータ暗号化キーと暗号化アルゴリズムを使ってフィールドを復号化します。

戻る

mongosh のネイティブメソッド

ClientEncryption.encrypt