KeyVault.deleteKey()
兼容性
此命令可用于以下环境中托管的部署:
MongoDB Atlas:用于云中 MongoDB 部署的完全托管服务
MongoDB Enterprise:基于订阅、自我管理的 MongoDB 版本
MongoDB Community:源代码可用、免费使用且可自行管理的 MongoDB 版本
语法
deleteKey()
通过以下语法实现:
keyVault = db.getMongo().getKeyVault() keyVault.deleteKey(UUID("<UUID String>"))
UUID是子类型为4
的 BSON binary data
对象。
行为
需要在数据库连接上配置客户端字段级加密
mongosh
客户端字段级加密方法需要启用客户端字段级加密的数据库连接。如果当前数据库连接在启动时未启用客户端字段级加密,则任选以下其一:
例子
以下示例用于快速评估客户端字段级加密。 有关将KeyVault.deleteKey()
与每个受支持的KMS提供程序结合使用的具体示例,请参阅删除数据加密密钥。
为本地管理的密钥配置客户端字段级加密:
生成不带换行符的 base64 编码的 96 字节字符串
使用
mongosh
加载密钥
export TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')") mongosh --nodb
使用生成的本地密钥字符串创建客户端字段级加密对象:
var autoEncryptionOpts = { "keyVaultNamespace" : "encryption.__dataKeys", "kmsProviders" : { "local" : { "key" : BinData(0, process.env["TEST_LOCAL_KEY"]) } } }
使用配置了客户端字段级加密选项的Mongo()
构造函数来创建数据库连接。 将mongodb://myMongo.example.net
URI 替换为目标集群的连接字符串 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 }