getClientEncryption()

Syntax

getClientEncryption() has the following syntax:

db.getMongo().getClientEncryption();

Use the ClientEncryption object to access the following explicit encryption methods:

• createEncryptedCollection()

• encrypt()

• decrypt()

Behavior

Example

The getKeyVault() method automatically creates a unique index on the keyAltNames field with a partial index filter for only documents where keyAltNames exists. getKeyVault() creates this index in the key vault collection. This prevents any two data encryption keys in the same key vault from having the same key alternative name and therefore avoids ambiguity around which data encryption key is appropriate for encryption/decryption.

The following example uses a locally managed KMS for the client-side field level encryption configuration.

mongosh --nodb

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

 var autoEncryptionOpts = {
   "keyVaultNamespace" : "encryption.__dataKeys",
   "kmsProviders" : {
     "local" : {
       "key" : BinData(0, TEST_LOCAL_KEY)
     }
   }
 }

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
   autoEncryptionOpts
)

Use the getClientEncryption() method to retrieve the client encryption object:

clientEncryption = encryptedClient.getClientEncryption()

Learn More

For complete documentation on initiating MongoDB connections with client-side field level encryption enabled, see Mongo().