Navigation

On this page

Overview

The is a dynamic library that enables your client application to perform automatic . A dynamic library is a set of functionality accessed by an application at runtime rather than compile time. The performs the following tasks:

  • Uses your to mark fields in read and write operations for encryption
  • Prevents your application from executing unsupported operations on encrypted fields

The does not perform any of the following tasks:

  • The does not perform encryption or decryption itself
  • The does not access any encryption key material
  • The does not listen over the network

Important

Supported MongoDB Server Products

Automatic is only available in the following MongoDB server products:

  • MongoDB Atlas 6.0 or later clusters
  • MongoDB Enterprise 6.0 or later

Automatic is not available in any version of MongoDB Community Server.

The provides the same functionality as mongocryptd, but does not require you to spawn another process to perform automatic encryption.

To learn more about automatic encryption, see <qe-features>.

To learn more about mongocryptd, see <qe-reference-mongocryptd>.

Note

libmongocrypt Performs Encryption

Drivers compatible with MongoDB 6.0 and later use the Apache-licensed libmongocrypt library for performing encryption and decryption.

Download the

Download the from the MongoDB Download Center using the following link:

MongoDB Download Center

  • In the Version dropdown, select 6.0.0-rc9 (release candidate).
  • In the Platform dropdown, select your platform.
  • In the Package dropdown, select crypt_shared.
  • Click Download.

Configuration

You can configure how your driver searches for the through the following parameters:

Name Description
cryptSharedLibPath
Specifies the absolute path to the package,
.
Default: undefined
cryptSharedRequired
Specifies if the driver must use the . If true,
the driver raises an error if the is unavailable.
If false, the driver performs the following sequence of actions:
  1. Attempts to use the .
  2. If the is unavailable, the driver attempts to spawn and connect to mongocryptd.
Default: false

To view an example demonstrating how to configure these parameters, see the Quick Start.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.