KeyVault.removeKeyAlternateName() (original) (raw)

KeyVault.removeKeyAlternateName(UUID, keyAltName)

Removes the specified keyAltName from the data encryption key with the specified UUID. The data encryption key must exist in the key vault associated to the database connection.

This command is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

removeKeyAlternateName() has the following syntax:

keyVault = db.getMongo().getKeyVault()

keyVault.removeKeyAlternateName(

   UUID("<UUID string>"),

   "keyAltName"

)

The mongosh 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 the mongoshto establish a connection with the required client-side field level encryption options. The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
  • Amazon Web Services KMS
  • Azure Key Vault
  • Google Cloud Platform KMS
  • Locally Managed Key
    or
• Use the mongosh 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.

The following example is intended for rapid evaluation of client-side field level encryption. For specific examples of usingKeyVault.removeKeyAlternateName() with each supportedKMS provider, seeEncryption Key Management.

Start the mongosh client.

To configure client-side field level encryption for a locally managed key, generate a base64-encoded 96-byte string with no line breaks.

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

Create the client-side field level encryption options using the generated local key string:

 var autoEncryptionOpts = {

   "keyVaultNamespace" : "encryption.__dataKeys",

   "kmsProviders" : {

     "local" : {

       "key" : BinData(0, TEST_LOCAL_KEY)

     }

   }

 }

Use the Mongo() constructor with the client-side field level encryption options configured to create a database connection. 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",

   autoEncryptionOpts

)

Retrieve the keyVault object and use theKeyVault.removeKeyAlternateName() method to remove the specified key alternate name from the data encryption key with matchingUUID:

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"

    ]

}