[DRIVERS-2302] Add FLE 2 API to ClientEncryptionOpts - MongoDB Jira

XML

Word

Printable

JSON

Details

Type: Spec Change
Status: Closed
Priority: Unknown
Resolution: Done
Fix Version/s: None
Component/s: Client Side Encryption
Labels:
- size-medium
- spec-change

Epic Link:
FLE 2.0 Support
Driver Changes:
Needed
Server Compat:
- 6.0
Quarter:
- FY23Q2
Downstream Changes Summary:
Hide

Please see these specifications PRs for the detailed changes and new prose tests:

https://github.com/mongodb/specifications/pull/1200

https://github.com/mongodb/specifications/pull/1218

Please see the Go driver implementation for reference.

Bindings changes

Upgrade libmongocrypt dependency to 1.5.0. Drivers can use 1.5.0-alpha1 to test. Binaries are available from this upload-all task.

Update the bindings to libmongocrypt to add the new functions: mongocrypt_ctx_setopt_index_type, mongocrypt_ctx_setopt_query_type, and mongocrypt_ctx_setopt_contention_factor.

Driver changes

Add the new driver API options: EncryptOpts.queryType and EncryptOpts.contentionFactor.

Pass EncryptOpts.queryType to libmongocrypt with mongocrypt_ctx_setopt_query_type.

Pass EncryptOpts.contentionFactor to libmongocrypt with mongocrypt_ctx_setopt_contention_factor.

If EncryptOpts.algorithm is "Indexed", call mongocrypt_ctx_setopt_index_type(ctx, MONGOCRYPT_INDEX_TYPE_EQUALITY).

If EncryptOpts.algorithm is "Unindexed", call mongocrypt_ctx_setopt_index_type(ctx, MONGOCRYPT_INDEX_TYPE_NONE).

Test changes

Add new prose tests for FLE 2.0 explicit encryption.
Show
Please see these specifications PRs for the detailed changes and new prose tests: https://github.com/mongodb/specifications/pull/1200 https://github.com/mongodb/specifications/pull/1218 Please see the Go driver implementation for reference. Bindings changes Upgrade libmongocrypt dependency to 1.5.0. Drivers can use 1.5.0-alpha1 to test. Binaries are available from this upload-all task . Update the bindings to libmongocrypt to add the new functions: mongocrypt_ctx_setopt_index_type , mongocrypt_ctx_setopt_query_type , and mongocrypt_ctx_setopt_contention_factor . Driver changes Add the new driver API options: EncryptOpts.queryType and EncryptOpts.contentionFactor . Pass EncryptOpts.queryType to libmongocrypt with mongocrypt_ctx_setopt_query_type . Pass EncryptOpts.contentionFactor to libmongocrypt with mongocrypt_ctx_setopt_contention_factor . If EncryptOpts.algorithm is "Indexed", call mongocrypt_ctx_setopt_index_type(ctx, MONGOCRYPT_INDEX_TYPE_EQUALITY) . If EncryptOpts.algorithm is "Unindexed", call mongocrypt_ctx_setopt_index_type(ctx, MONGOCRYPT_INDEX_TYPE_NONE) . Test changes Add new prose tests for FLE 2.0 explicit encryption.

Description

Summary

Add new options to EncryptOpts:

queryType
contentionFactor

Add values to EncryptOpts.algorithm:

"Indexed"
"Unindexed"

Add tests for the new explicit encryption and decryption behavior.

Motivation

Is this issue urgent?

Yes. This is a 6.0 requirement.

Is this ticket required by a downstream team?

Shell.

Is this ticket only for tests?

No.

Attachments

Issue Links

has to be finished together with

DRIVERS-2371 Require contentionFactor for "Indexed" explicit encryption

Implementing

split to

JAVA-4597 Support queryable encryption in ClientEncryption

Closed

PHPC-2092 ClientEncryption options for queryable encryption

Closed

CDRIVER-4372 Add Queryable Encryption API to ClientEncryptionOpts

Closed

CSHARP-4157 Add FLE 2 API to ClientEncryptionOpts

Closed

CXX-2502 Add FLE 2 API to ClientEncryptionOpts

Closed

GODRIVER-2400 Add Queryable Encryption API to ClientEncryptionOpts

Closed

MOTOR-953 Add FLE 2 API to ClientEncryptionOpts

Closed

NODE-4220 Add FLE 2 API to ClientEncryptionOpts

Closed

PYTHON-3245 Add FLE 2 API to ClientEncryptionOpts

Closed

RUBY-2980 Add FLE 2 API to ClientEncryptionOpts

Closed

RUST-1301 Add FLE 2 API to ClientEncryptionOpts

Closed

SWIFT-1558 Add FLE 2 API to ClientEncryptionOpts

Closed

(8 split to)

Activity

People

Assignee:: Kevin Albertson

Reporter:: Kevin Albertson

Votes:: 0 Vote for this issue

Watchers:: 2 Start watching this issue

Dates

Created:: Apr 28 2022 09:49:54 PM UTC

Updated:: Jan 20 2023 08:15:38 PM UTC

Resolved:: Jan 20 2023 08:15:38 PM UTC