KeyVault.deleteKey()
New in version 4.2.
beta
Client-Side Field Level Encryption is available as a beta. The contentsof this page may change during the beta period.
KeyVault.
deleteKey
(UUID)- Deletes a data key with the specified UUID from the key vaultassociated to the database connection.
deleteKey()
has the following syntax:
- keyVault = db.getMongo().getKeyVault()
- keyVault.deleteKey(UUID("<UUID String>"))
The UUID is a BSONbinary data
object with subtype 4
.
returns: | A document indicating the number of deleted keys. |
---|
Behavior
Requires Configuring Client-Side Field Level Encryption on Database Connection
The mongo
client-side field level encrytion methodsrequire a database connection with client-side field level encryptionenabled. If the current database connection was not initiated withclient-side field level encryption enabled, either:
- Use the
Mongo()
constructor from themongo
shell to establish a connection with the required client-side fieldlevel encryption options. TheMongo()
method supports bothAmazon Web Services and Local Key Management Service (KMS) providersfor Customer Master Key (CMK) management.
or
- Use the
mongo
shell command line options to establish aconnection with the required options. The command line options onlysupport the AWS KMS provider for CMK management.
Example
The following example is intended for rapid evaluation ofclient-side field level encryption. For more complete examplesappropriate for development and production environments, seeRemove a data encryption key.
Configuring client-side field level encryption for a locallymanaged key requires specifying a base64-encoded 96-bytestring with no line breaks. The following operation generatesa key that meets the stated requirements and loads it intothe mongo
shell:
- TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")
- mongo --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"
Create the client-side field level encryption object using thegenerated local key string:
- var ClientSideFieldLevelEncryptionOptions = {
- "keyVaultNamespace" : "encryption.__dataKeys",
- "kmsProviders" : {
- "local" : {
- "key" : BinData(0, TEST_LOCAL_KEY)
- }
- }
- }
Use the Mongo()
constructor to create a database connectionwith the client-side field level encryption options. Replace themongodb://myMongo.example.net
URI with the connection stringURI of the target cluster.
- encryptedClient = Mongo(
- "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
- ClientSideFieldLevelEncryptionOptions
- )
Retrieve the KeyVault
object anduse the KeyVault.deleteKey()
method todelete the data key with matching UUID
:
- keyVault = encryptedClient.getKeyVault()
- keyVault.deleteKey(UUID("b4b41b33-5c97-412e-a02b-743498346079"))
If successful, deleteKey()
returns output similar tothe following:
- { "acknowledged" : true, "deletedCount" : 1 }
See also