Docs Menu

Docs HomeMongoDB Manual

Explicit Encryption

On this page

  • Overview
  • Use Explicit Encryption
  • Create a ClientEncryption Instance
  • Encrypt Fields in Read and Write Operations
  • Automatic Decryption
  • Server-Side Field Level Encryption Enforcement
  • Learn More

Learn how to use the explicit encryption mechanism of Queryable Encryption.

Explicit encryption is a mechanism in which you specify how you would like to encrypt and decrypt fields in your document in each operation you perform on your database.

Explicit encryption is available in the following MongoDB products using version 6.0 or later:

  • MongoDB Community Server

  • MongoDB Enterprise Advanced

  • MongoDB Atlas

The following sections provide an overview of using explicit encryption in your Queryable Encryption-enabled application:

ClientEncryption is an abstraction used across drivers and mongosh that encapsulates the Key Vault collection and KMS operations involved in explicit encryption.

To create a ClientEncryption instance, specify:

  • A kmsProviders object configured with access to the KMS hosting your Customer Master Key

  • The namespace of your Key Vault collection

  • If you use MongoDB Community Server, set the bypassQueryAnalysis option to True

  • A MongoClient instance with access to your Key Vault collection

For more ClientEncryption options, see MongoClient Options for Queryable Encryption.

Note

Code examples are not currently available but are coming soon.

You must update read and write operations throughout your application such that your application encrypts fields before performing read and write operations.

To encrypt fields, use the encrypt method of your ClientEncryption instance. Specify the following:

  • The value to be encrypted

  • The algorithm used, either Indexed or Unindexed

  • The ID of the Data Encryption Key

  • The contention factor (if you are using the Indexed algorithm)

  • If performing a read operation, set the query type defined for your field (if you are using the Indexed algorithm)

Note

Query Types

The query type only applies to read operations.

To learn more about query types, see Query Types.

Use the Indexed algorithm if you specify a queryType on the field.

Indexed supports equality queries. Indexed fields require an index on the server. The index is created by specifying the encryptedFields option in db.createCollection().

To decrypt your fields automatically, you must configure your MongoClient instance as follows:

  • Specify a kmsProviders object

  • Specify your Key Vault collection

  • If you use MongoDB Community Server, set the bypassQueryAnalysis option to True

Note

Automatic Decryption is Available in MongoDB Community Server

Although automatic encryption requires MongoDB Enterprise or MongoDB Atlas, automatic decryption is available in the following MongoDB products using version 6.0 or later:

  • MongoDB Community Server

  • MongoDB Enterprise Advanced

  • MongoDB Atlas

Specify Fields for Encryption to enforce encryption of specific fields in a collection.

Indexed fields require an index on the server. The index is created by specifying the encryptedFields option in db.createCollection().

A client performing Queryable Encryption with the explicit encryption mechanism on a MongoDB instance configured to enforce encryption of certain fields must encrypt those fields as specified on the MongoDB instance.

To learn how to set up server-side Queryable Encryption enforcement, see Field Encryption and Queryability.

To learn more about Key Vault collections, Data Encryption Keys, and Customer Master Keys, see Keys and Key Vaults.

To learn more about KMS providers and kmsProviders objects, see KMS Providers.

←  Encrypted Collection ManagementKeys and Key Vaults →
Share Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.