KeyVault.removeKeyAlternateName()
KeyVault.removeKeyAlternateName(UUID, keyAltName)
Removes the specified
keyAltName
from the data encryption key with the specifiedUUID
. The data encryption key must exist in the key vault associated to the database connection.removeKeyAlternateName()
has the following syntax:keyVault = db.getMongo().getKeyVault() keyVault.removeKeyAlternateName( UUID("<UUID string>"), "keyAltName" ) Returns: The data encryption key prior to updating the keyAltName
.Returns
null
if no data encryption key has the specifiedUUID()
.
Behavior
Requires Configuring Client-Side Field Level Encryption on Database Connection
The mongo
client-side field level encryption methods
require a database connection with client-side field level encryption
enabled. If the current database connection was not initiated with
client-side field level encryption enabled, either:
Use the
Mongo()
constructor from themongo
shell to establish a connection with the required client-side field level encryption options. TheMongo()
method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:or
Use the
mongo
shell command line options to establish a connection with the required options. The command line options only support the Amazon Web Services KMS provider for CMK management.
Example
The following example is intended for rapid evaluation of
client-side field level encryption. For specific examples of using
KeyVault.removeKeyAlternateName()
with each supported
KMS provider, see
Manage a Data Encryption Key's Alternate Name.
Configuring client-side field level encryption for a locally
managed key requires specifying a base64-encoded 96-byte
string with no line breaks. The following operation generates
a key that meets the stated requirements and loads it into
the mongo
shell:
TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')") mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"
Create the client-side field level encryption object using the generated local key string:
var ClientSideFieldLevelEncryptionOptions = { "keyVaultNamespace" : "encryption.__dataKeys", "kmsProviders" : { "local" : { "key" : BinData(0, TEST_LOCAL_KEY) } } }
Use the Mongo()
constructor to create a database connection
with the client-side field level encryption options. Replace the
mongodb://myMongo.example.net
URI with the connection string
URI of the target cluster.
encryptedClient = Mongo( "mongodb://myMongo.example.net:27017/?replSetName=myMongo", ClientSideFieldLevelEncryptionOptions )
Retrieve the keyVault
object and use the
KeyVault.removeKeyAlternateName()
method to remove the
specified key alternate name from the data encryption key with matching
UUID
:
keyVault = encryptedClient.getKeyVault() keyVault.removeKeyAlternateName(UUID("b4b41b33-5c97-412e-a02b-743498346079"),"Other-Data-Encryption-Key")
If successful, removeKeyAlternateName()
returns the
data encryption key prior to updating the keyAltName
.
{ "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"), "keyMaterial" : BinData(0,"PXRsLOAYxhzTS/mFQAI8486da7BwZgqA91UI7NKz/T/AjB0uJZxTvhvmQQsKbCJYsWVS/cp5Rqy/FUX2zZwxJOJmI3rosPhzV0OI5y1cuXhAlLWlj03CnTcOSRzE/YIrsCjMB0/NyiZ7MRWUYzLAEQnE30d947XCiiHIb8a0kt2SD0so8vZvSuP2n0Vtz4NYqnzF0CkhZSWFa2e2yA=="), "creationDate" : ISODate("2019-08-12T21:21:30.569Z"), "updateDate" : ISODate("2019-08-12T21:21:30.569Z"), "status" : 0, "version" : NumberLong(0), "masterKey" : { "provider" : "local" }, "keyAltNames" : [ "ssn-encryption-key" ] }