Adding queryable encryption range support by rozza · Pull Request #4885 · spring-projects/spring-data-mongodb

rozza · 2025-01-24T15:28:32Z

Supports range style queries for encrypted fields.

Note: This feature requires MongoDB 8.0 and a Mongo Client 5.x

You have read the Spring Data contribution guidelines.
You use the code formatters provided here and have them applied to your changes. Don’t submit any formatting related changes.
You submit test cases (unit or integration tests) that back your changes.
You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).

Closes: #4185

Supports range style queries for encrypted fields

rozza · 2025-01-24T15:28:52Z

+	 *
+	 * @param encryptedFields can be null
+	 * @return new instance of {@link CollectionOptions}.
+	 * @since 4.5.0


Not sure if this is the correct version?

rozza · 2025-01-24T15:29:22Z

+	 * @param options
+	 * @return
+	 */
+	public static RangeOptionsAdapter rangeOptionsAdapter(RangeOptions options) {


Only available in the 5.x driver

rozza · 2025-01-24T15:30:41Z

+					database.getCollection("test").drop();
+
+					ClientEncryption clientEncryption = mongoClientEncryption.getClientEncryption();
+					BsonDocument encryptedFields = new BsonDocument().append("fields",


Added multiple fields as:

a) its non trivial / not obvious how to do so.
b) needed to ensure testing worked as expected

rozza · 2025-01-24T15:31:28Z

+
+		private static final String LOCAL_KMS_PROVIDER = "local";
+
+		private static final Lazy<Map<String, Map<String, Object>>> LAZY_KMS_PROVIDERS = Lazy.of(() -> {


Lazily constructed the master key - so does this only once.

rozza · 2025-01-24T15:32:16Z

+				builder.autoEncryptionSettings(AutoEncryptionSettings.builder() //
+						.kmsProviders(clientEncryptionSettings.getKmsProviders()) //
+						.keyVaultNamespace(clientEncryptionSettings.getKeyVaultNamespace()) //
+						.bypassQueryAnalysis(true).build());


bypassQueryAnalysis is required to be true.

rozza · 2025-01-24T15:34:05Z

@christophstrobl apologies I closed #4879 while I was still working through it and couldn't reopen it - so created a new PR.

rozza · 2025-01-24T15:43:08Z

+				Assert.isInstanceOf(Integer.class, trimFactor, () -> String
+						.format("Expected to find a %s but it turned out to be %s.", Integer.class, trimFactor.getClass()));
+
+				rangeOptionsAdapter(encryptionRangeOptions).trimFactor((Integer) trimFactor);


Not sure what the best approach is for handling Mongo driver 4 user. This adapter is needed to compile - but should there be another check to prevent them using range options at all?

we're going to remove the 4.x driver backwards compatibility for the next release, so don't worry about that one.

No problems - have removed.

rozza · 2025-01-28T11:05:49Z

Note: The @Encrypted annotation for range encryption doesn't need the rangeOptions metadata as that is only needed when explicitly encrypting range values.

Also I haven't added MongoJsonSchema support - I'm not sure its required here?

Supports range style queries for encrypted fields Closes: #4181 Original Pull Request: #4885

This commit decouples queryable encryption from explicit encryption and introduces the Queryable annotation to represent different query types like range and equality. Additionally it removes value conversion from range encryption and fixes update mapping of range encrypted fields. Original Pull Request: #4885

Original Pull Request: #4885

christophstrobl · 2025-04-14T10:49:47Z

Thank you @rozza - merged to 4.5 development line.

Guard tests for encryption functionality. Original Pull Request: #4885

Supports range style queries for encrypted fields Closes: #4185 Original Pull Request: #4885

This commit decouples queryable encryption from explicit encryption and introduces the Queryable annotation to represent different query types like range and equality. Additionally it removes value conversion from range encryption and fixes update mapping of range encrypted fields. Original Pull Request: #4885

Original Pull Request: #4885

Guard tests for encryption functionality. Original Pull Request: #4885

Supports range style queries for encrypted fields Closes: #4185 Original Pull Request: #4885

This commit decouples queryable encryption from explicit encryption and introduces the Queryable annotation to represent different query types like range and equality. Additionally it removes value conversion from range encryption and fixes update mapping of range encrypted fields. Original Pull Request: #4885

Original Pull Request: #4885

Guard tests for encryption functionality. Original Pull Request: #4885

Adding queryable encryption range support

94d2f6f

Supports range style queries for encrypted fields

rozza commented Jan 24, 2025

View reviewed changes

rozza marked this pull request as ready for review January 24, 2025 15:32

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 24, 2025

rozza commented Jan 24, 2025

View reviewed changes

mp911de assigned christophstrobl Jan 27, 2025

mp911de added type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Jan 27, 2025

rozza added 2 commits January 27, 2025 14:48

Remove MongoClient 4.x check / support

681cc2d

Javadoc fix

ba26fa6

christophstrobl pushed a commit that referenced this pull request Apr 14, 2025

Adding queryable encryption range support

156274e

Supports range style queries for encrypted fields Closes: #4181 Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 14, 2025

Polishing.

c722788

Original Pull Request: #4885

christophstrobl added a commit that referenced this pull request Apr 14, 2025

Update Javadoc.

fc5e092

Original Pull Request: #4885

christophstrobl closed this Apr 14, 2025

mp911de added a commit that referenced this pull request Apr 14, 2025

Polishing.

7663686

Guard tests for encryption functionality. Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 14, 2025

Polishing.

cd36089

Guard tests for encryption functionality. Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 22, 2025

Adding queryable encryption range support

9b7a4e5

Supports range style queries for encrypted fields Closes: #4185 Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 22, 2025

Polishing.

e89548a

Original Pull Request: #4885

christophstrobl added a commit that referenced this pull request Apr 22, 2025

Update Javadoc.

272a062

Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 22, 2025

Polishing.

5eaeb92

Guard tests for encryption functionality. Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 22, 2025

Adding queryable encryption range support

78998ff

Supports range style queries for encrypted fields Closes: #4185 Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 22, 2025

Polishing.

efbea03

Original Pull Request: #4885

christophstrobl added a commit that referenced this pull request Apr 22, 2025

Update Javadoc.

486e2f4

Original Pull Request: #4885

christophstrobl pushed a commit that referenced this pull request Apr 22, 2025

Polishing.

4244a88

Guard tests for encryption functionality. Original Pull Request: #4885

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding queryable encryption range support#4885

Adding queryable encryption range support#4885
rozza wants to merge 3 commits intospring-projects:mainfrom
rozza:QERange

rozza commented Jan 24, 2025 •

edited by christophstrobl

Loading

Uh oh!

rozza Jan 24, 2025

Uh oh!

rozza Jan 24, 2025

Uh oh!

rozza Jan 24, 2025

Uh oh!

rozza Jan 24, 2025

Uh oh!

rozza Jan 24, 2025

Uh oh!

rozza commented Jan 24, 2025

Uh oh!

rozza Jan 24, 2025

Uh oh!

christophstrobl Jan 24, 2025

Uh oh!

rozza Jan 28, 2025

Uh oh!

rozza commented Jan 28, 2025

Uh oh!

christophstrobl commented Apr 14, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		private static final String LOCAL_KMS_PROVIDER = "local";

		private static final Lazy<Map<String, Map<String, Object>>> LAZY_KMS_PROVIDERS = Lazy.of(() -> {

Conversation

rozza commented Jan 24, 2025 • edited by christophstrobl Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rozza commented Jan 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rozza commented Jan 28, 2025

Uh oh!

christophstrobl commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rozza commented Jan 24, 2025 •

edited by christophstrobl

Loading

christophstrobl commented Apr 14, 2025 •

edited

Loading