ClientEncryption.encrypt()

Create Your Encrypted Connection

1. Start mongosh

   Run:

   mongosh --nodb

   --nodb means don't connect to a database.

2. Generate a Key String

   Generate a base 64 96-byte string:

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

3. Create an Encryption Options Object

   To create a client-side field level encryption options object, use the TEST_LOCAL_KEY string from the previous step:

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

4. Create an Encrypted Client Object

   To create an encrypted client object, use the Mongo() constructor. Replace the mongodb://myMongo.example.net URI with the connection string URI for the target cluster. For example:

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

Encrypt Your Data

Retrieve the ClientEncryption object and use the ClientEncryption.encrypt() method to encrypt a value using a specific data encryption key UUID and encryption algorithm:

clientEncryption = encryptedClient.getClientEncryption();
clientEncryption.encrypt(
  UUID("64e2d87d-f168-493c-bbdf-a394535a2cb9"),
  "123-45-6789",
  "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
)

You can also specify the algorithm using a document with an algorithm field:

clientEncryption = encryptedClient.getClientEncryption();
clientEncryption.encrypt(
  UUID("64e2d87d-f168-493c-bbdf-a394535a2cb9"),
  "123-45-6789",
  { algorithm: "AEAD_AES_256_CBC_HMAC_SHA_512-Random" }
)

Create Your Encrypted Connection

1. Start mongosh

   Start the mongosh client.

   mongosh --nodb

2. Generate Your Key

   To configure Queryable 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")

3. Create the Queryable Encryption Options

   Create the Queryable Encryption options using the generated local key string:

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

4. Create Your Encrypted Client

   Use the Mongo() constructor with the queryable 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
   )

Encrypt Your Data

Retrieve the ClientEncryption object and use the ClientEncryption.encrypt() method to encrypt a value using a specific data encryption key UUID and encryption algorithm:

const eDB = "encrypted"
const eKV = "__keyVault"
const clientEncryption = encryptedClient.getClientEncryption();
const keyVaultClient = Mongo().getDB(eDB).getCollection(eKV)
const dek = keyVaultClient.findOne({ keyAltNames: "dataKey1" })
clientEncryption.encrypt(
  dek._id,
  "123-45-6789",
  "Unindexed"
)

You can also specify the algorithm using a document containing the fields:

• algorithm

• queryType

• contentionFactor

const eDB = "encrypted"
const eKV = "__keyVault"
const clientEncryption = encryptedClient.getClientEncryption();
const keyVaultClient = Mongo().getDB(eDB).getCollection(eKV)
const dek = keyVaultClient.findOne({ keyAltNames: "dataKey1" })
clientEncryption.encrypt(
  dek._id,
  "123-45-6789",
  {
    algorithm: "Indexed",
    queryType: "equality",
    contentionFactor: 8
  }
)