使用中の暗号化メソッド

注意

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

mongosh ClientEncryption メソッドでは、使用中の暗号化が有効になっているデータベース接続が必要です。現在のデータベース接続が使用中の暗号化を有効にして開始されなかった場合、次のいずれかが発生します。

Mongo()必要な使用中の暗号化オプションとの接続を確立するには、mongosh からコンストラクターを使用します。Mongo() メソッドは、CMK（Customer Master Key）管理のために次の KMS（KMS）プロバイダーをサポートしています。
or
必要なオプションとの接続を確立するには、 mongoshコマンドラインオプションを使用します。コマンドラインオプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。

次のメソッドは mongosh のみに適用されます。MongoDBドライバーを使用してクライアント側フィールドレベル暗号化 (CSFLE) またはQueryable Encryption (QE) を実装する手順については、ドライバーのドキュメントを参照してください。サポートされているドライバーについては、「クライアント側フィールドレベル暗号化の互換性」または「Queryable Encryption の互換性」を参照してください。

エイリアスを持つコマンドがグループ化されます。

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

戻る

SessionOptions

ClientEncryption.createEncryptedCollection