Docs Menu
Docs Home
/
MongoDB Manual
/
Security
/
Encryption
/
In-Use Encryption
/
Client-Side Field Level Encryption

Installation Requirements

On this page

  • Overview
  • What You Need
  • Learn More

Overview

Learn about the applications and libraries you must install to use Client-Side Field Level Encryption (CSFLE).

What You Need

Before you can use CSFLE, you must set up the following items in your development environment:

  • (Optional) Download the Automatic Encryption Shared Library. The Automatic Encryption Shared Library is a preferred alternative to mongocryptd and does not require spawning a new process. mongocryptd is still supported.

  • Install MongoDB Enterprise Edition.

  • Install a MongoDB Driver Compatible with CSFLE.

  • Start a MongoDB instance or Atlas Cluster.

  • Install specific driver dependencies. To see the list of dependencies for your driver, select the tab corresponding to the language you would like to use to complete this guide:

Dependency Name
Description

x64 Support

CSFLE requires x64 support.

Dependency Name
Description

Install libmongocrypt for CSFLE

The libmongocrypt library contains bindings to communicate with the native library that manages the encryption.

Dependency Name
Description

mongodb-crypt

The mongodb-crypt library contains bindings to communicate with the native library that manages the encryption.

Dependency Name
Description

mongodb-client-encryption

NodeJS wrapper for the libmongocrypt encryption library. The libmongocrypt library contains bindings to communicate with the native library that manages the encryption.

When using Node.js driver version 6.0.0 or later, mongodb-client-encryption must have the same major version number as the driver.

For example, Node.js driver v6.x.x requires mongodb-client-encryption v6.x.x.

Dependency Name
Description

pymongocrypt

Python wrapper for the libmongocrypt encryption library. The libmongocrypt library contains bindings to communicate with the native library that manages the encryption.

Learn More

To start using CSFLE, see Quick Start.

To learn how to use CSFLE with a remote Key Management System provider, see Tutorials.

Back

Features

Next

Quick Start