Navigation

KeyVault.addKeyAlternateName()

On this page

New in version 4.2.

beta

Client-Side Field Level Encryption is available as a beta. The contents of this page may change during the beta period.

KeyVault.addKeyAlternateName(UUID, keyAltName)

Adds the keyAltName to the keyAltNames array of the data key with UUID.

keyAltName must be unique among all keys in the key vault. getKeyVault creates a unique index on keyAltNames to enforce uniqueness of keyAltName.

addKeyAlternateName() has the following syntax:

keyVault = db.getMongo().getKeyVault()

keyVault.addKeyAlternateName(
  UUID("<UUID string>"),
  "keyAltName"
)
returns:

Returns the previous version of the data key document.

Returns null if no data key has the specified UUID().

Behavior

Requires Configuring Client-Side Field Level Encryption on Database Connection

The mongo client-side field level encrytion 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 mongo shell to establish a connection with the required client-side field level encryption options. The Mongo() method supports both Amazon Web Services and Local 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 AWS KMS provider for CMK management.

Example

The following example uses a locally managed KMS for the client-side field level encryption configuration. See Manage a Data Key’s Alternate Name for more complete examples of data key management with Amazon Web Services KMS and locally managed KMS.

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:

echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')"

Create a mongo shell session using the --nodb option and issue the following operation from that shell:

mongo --nodb

From the mongo shell session, issue the following operation to create the client-side field level encryption configuration object. Replace the key string with a valid base64-encoded 96-byte string, such as the one genereated using the code provided at the beginning of this example:

var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultNamespace" : "encryption.__dataKeys",
  "kmsProviders" : {
    "local" : {
      "key" : BinData(0, "96-BYTE_LOCAL_KEY_STRING")
    }
  }
}

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",
  clientSideFLEOptions
)

Retrieve the KeyVault object and use the KeyVault.addKeyAlternateName() method to add a new key alternate name to the data key with matching UUID. The specified key alternate name must be unique:

keyVault = encryptedClient.getKeyVault()
keyVault.addKeyAlternateName(UUID("b4b41b33-5c97-412e-a02b-743498346079"),"Other-Data-Encryption-Key")

If successful, addKeyAlternateName() returns the previous version of data key document:

{
    "_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" : [
    ]
}

To view the current version of the data key document, use KeyVault.getKey() specifying the _id of the returned document or KeyVault.getKeyByAltName() specifying one of the keyAltNames.