[DRIVERS-2717] Enable use of native crypto in libmongocrypt bindings Created: 08/Sep/23  Updated: 15/Sep/23  Resolved: 15/Sep/23

Status: Closed
Project: Drivers
Component/s: Client Side Encryption, Performance
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Kevin Albertson Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
duplicates DRIVERS-2718 Enable use of native crypto in libmon... Implementing
Driver Changes: Needed

 Description   

Summary

Investigate options to enable use of native crypto in libmongocrypt bindings.

I expect this will require a scope document and prototyping.

Motivation

By default, libmongocrypt implements crypto primitives (including AES, HMAC, SHA) by linking to a native crypto library (OpenSSL on Linux, CommonCrypto on macOS, Cryptography API on Windows).

Alternatively: libmongocrypt can be configured without crypto using the CMake option DISABLE_NATIVE_CRYPTO. The "no crypto" version of libmongocrypt is used by driver languages that supply crypto callbacks. On last survey: Java, Python, C#, Ruby, Node, and Rust implement the crypto callbacks.

MONGOCRYPT-112 describes original motivation of the crypto callbacks:

For certain languages like Java and C# on Linux, we need to ship a binary but this binary cannot depend on the system OpenSSL.

The mongodb-crypt JAR and pymongocrypt wheel include generic Linux binaries of libmongocrypt.

Use of crypto callbacks may result in slower throughput. HELP-27047 identified a problematic workload: decrypting documents with 1500 encrypted values.

A benchmark of bulk decryption showed the most improvement when using libmongocrypt’s native system crypto, rather than the callbacks in the Java bindings:

Baseline: +264.5%
Using Java binding improvements: +173.19%
Using bulk callbacks and Java binding improvements: +146.0%
Using native crypto: +82.79%

Some bindings provide an option to use a system install of libmongocrypt (example: PYMONGOCRYPT_LIB in pymongocrypt). It may be possible to extend this to other drivers.

Who is the affected end user?

Users of In-Use Encryption.

How does this affect the end user?

Proposed changes may improve throughput of encryption and decryption.

How likely is it that this problem or use case will occur?

Certain. This was reported in HELP-27047.

If the problem does occur, what are the consequences and how severe are they?

Performance concern.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

No.

Acceptance Criteria

Expect improved throughput of encryption and decryption in impacted drivers.


Generated at Thu Feb 08 08:26:15 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.