mongodb-client-encryption

MongoDB Client Encryption

The Node.js wrapper for libmongocrypt

Note This library provides encryption functionality for the MongoDB Node.js driver but is not intended to be consumed in isolation. The public API that uses the functionality in this library is available in the mongodb package.

MongoDB Node.js Driver Version Compatibility

Only the following version combinations with the MongoDB Node.js Driver are considered stable.

	mongodb-client-encryption@1.x	mongodb-client-encryption@2.x	mongodb-client-encryption@6.x
mongodb@6.x	N/A	N/A	✓
mongodb@5.x	N/A	✓	N/A
mongodb@4.x	✓	✓	N/A
mongodb@3.x	✓	N/A	N/A

Installation

You can install mongodb-client-encryption with the following:

npm install mongodb-client-encryption

Development

Setup

Run the following command to build libmongocrypt and setup the node bindings for development:

bash ./etc/build-static.sh

Prebuild Platforms

Below are the platforms that are available as prebuilds on each github release. prebuild-install downloads these automatically depending on the platform you are running npm install on.

• Linux GLIBC 2.23 or later
  • s390x
  • arm64
  • x64
• MacOS universal binary
  • x64
  • arm64
• Windows
  • x64

Linting

We lint both the c++ bindings and the Typescript.

To lint the Typescript, you can run npm run check:eslint -- --fix. To lint the c++, run npm run clang-format.

Testing

The unit tests require the binding to be built. Run npm run rebuild to build the addon from the c++ source. Then the tests can be run with npm test.

Note: changes to c++ source are not automatically re-compiled. One needs to rebuild the bindings after each change.

Changelog

6.1.0-alpha (2024-06-17)

Features

• NODE-5908: support range v2 protocol (#13) (4650f7c)
• NODE-6226: build macos universal binary (#21) (a044ccd)