Docs Menu
Docs Home
/
MongoDBマニュアル
/ / /

KeyVault.deleteKey()

項目一覧

  • 動作
KeyVault.deleteKey(UUID)

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

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

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

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

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

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

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

1

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

mongosh --nodb
2

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

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

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

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

データベース接続を作成するには、クライアント側のフィールドレベル暗号化オプションが構成された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

以下も参照してください。

戻る

KeyVault.createKey

項目一覧