KeyVault.deleteKey()（mongoshメソッド）

KeyVault.deleteKey(UUID)

指定された UUID を持つデータ暗号化キーを、データベース接続に関連付けられたキーヴォールトから削除します。

deleteKey() の構文は次のとおりです。

keyVault = db.getMongo().getKeyVault()
keyVault.deleteKey(UUID("<UUID String>"))

UUID は、サブタイプ 4 を持つBSON binary dataオブジェクトです。

次の値を返します。	削除されたキーの数を示すドキュメント。

互換性

このコマンドは、次の環境でホストされている配置で使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のための完全管理サービスです

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

動作

データベース接続にクライアント側のフィールドレベル暗号化を構成する必要があります

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

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

例

次の例は、クライアント側のフィールドレベル暗号化の迅速な評価を目的としています。サポートされている各 KMS プロバイダーで KeyVault.deleteKey() を使用する具体的な例については、「データ暗号化キーの削除」を参照してください。

mongosh を起動する

mongoshクライアントを起動します。

mongosh --nodb

キーの生成

ローカルで管理されているキーのクライアント側フィールドレベル暗号化を構成するには、改行を含まない base64 でエンコードされた 96 バイトのstringを生成します。

const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")

クライアント側のフィールドレベル暗号化オプションの作成

生成されたローカルキーstringを使用して、クライアント側のフィールドレベル暗号化オプションを作成します。

 let autoEncryptionOpts = {
   "keyVaultNamespace" : "encryption.__dataKeys",
   "kmsProviders" : {
     "local" : {
       "key" : BinData(0, TEST_LOCAL_KEY)
     }
   }
 }

暗号化されたクライアントの作成

データベース接続を作成するには、クライアント側のフィールドレベル暗号化オプションが構成されたMongo()コンストラクターを使用します。 mongodb://myMongo.example.net URI を、ターゲットクラスターの接続string URIに置き換えます。

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
   autoEncryptionOpts
)

KeyVaultオブジェクトを取得し、メソッドを使用してKeyVault.deleteKey() と一致するデータ暗号化のキーを削除します。UUID

keyVault = encryptedClient.getKeyVault()
keyVault.deleteKey(UUID("b4b41b33-5c97-412e-a02b-743498346079"))

成功した場合、deleteKey() は次のような出力を返します。

{ "acknowledged" : true, "deletedCount" : 1 }

Tip