CDRIVER-6358 add QE "substring"

.evergreen/scripts/compile-libmongocrypt.sh

@@ -12,7 +12,7 @@ compile_libmongocrypt() {
   # `src/kms-message`.
   #
   # Run `.evergreen/scripts/kms-divergence-check.sh` to ensure that there is no divergence in the copied files.
-  declare -r version="1.19.1"
+  declare -r version="1.20.0"
 
   git clone --depth=1 -q https://github.com/mongodb/libmongocrypt --branch "${version:?}" || return
 

NEWS

@@ -3,16 +3,18 @@ libmongoc 2.4.0 [UNRELEASED]
 
 ## Notes
 
-* Raise required version of libmongocrypt from 1.15.1 to 1.18.0 to support In-Use Encryption (corresponds to the CMake option: `ENABLE_CLIENT_SIDE_ENCRYPTION`).
+* Raise required version of libmongocrypt from 1.15.1 to 1.20.0 to support In-Use Encryption (corresponds to the CMake option: `ENABLE_CLIENT_SIDE_ENCRYPTION`).
 * In a future minor release the minimum supported MongoDB Server version will be raised from 4.2 to 4.4. This is in accordance with [MongoDB Software Lifecycle Schedules](https://www.mongodb.com/legal/support-policy/lifecycles).
 
 ## Deprecations
 
-* The previously experimental Queryable Encryption text search API (`mongoc_client_encryption_encrypt_text_*`) has been renamed to `mongoc_client_encryption_encrypt_string_*` to match the generally available "String" algorithm. The old `_text_` names are deprecated and will be removed in a future release.
+* The Queryable Encryption "Text" APIs are deprecated for "String" APIs
+  * `mongoc_client_encryption_encrypt_text_*` is deprecated for `mongoc_client_encryption_encrypt_string_*` to match the generally available "String" algorithm.
+  * The `TextPreview` algorithm is deprecated. Use `String` instead.
 
 ## New Features
 
-* The Queryable Encryption "String" algorithm (`MONGOC_ENCRYPT_ALGORITHM_STRING`) is now generally available, supporting `prefix` and `suffix` query types.
+* The Queryable Encryption "String" algorithm (`MONGOC_ENCRYPT_ALGORITHM_STRING`) is now generally available, supporting `prefix`, `suffix`, and `substring` query types.
   * The `prefixPreview`, `suffixPreview`, and `substringPreview` query types remains experimental.
 
 

src/libmongoc/CMakeLists.txt

@@ -489,10 +489,10 @@ elseif (NOT ENABLE_CLIENT_SIDE_ENCRYPTION STREQUAL OFF)
       find_package (mongocrypt QUIET)
    endif ()
 
-   if (mongocrypt_FOUND AND "${mongocrypt_VERSION}" VERSION_LESS 1.18.0)
+   if (mongocrypt_FOUND AND "${mongocrypt_VERSION}" VERSION_LESS 1.20.0)
       message (STATUS "  libmongocrypt found at ${mongocrypt_DIR}")
       message (STATUS "  libmongocrypt version ${mongocrypt_VERSION} found")
-      message (STATUS "  libmongocrypt version 1.18.0 is required to enable In-Use Encryption Support.")
+      message (STATUS "  libmongocrypt version 1.20.0 is required to enable In-Use Encryption Support.")
       set (REQUIRED_MONGOCRYPT_VERSION_FOUND OFF)
    elseif (mongocrypt_FOUND)
       set (REQUIRED_MONGOCRYPT_VERSION_FOUND ON)

src/libmongoc/doc/mongoc_client_encryption_encrypt_opts_set_query_type.rst

@@ -11,7 +11,8 @@ Synopsis
    #define MONGOC_ENCRYPT_QUERY_TYPE_EQUALITY "equality"
    #define MONGOC_ENCRYPT_QUERY_TYPE_RANGE "range"
    #define MONGOC_ENCRYPT_QUERY_TYPE_RANGEPREVIEW "rangePreview" // Deprecated.
-   #define MONGOC_ENCRYPT_QUERY_TYPE_SUBSTRINGPREVIEW "substringPreview"
+   #define MONGOC_ENCRYPT_QUERY_TYPE_SUBSTRINGPREVIEW "substringPreview" // Deprecated.
+   #define MONGOC_ENCRYPT_QUERY_TYPE_SUBSTRINGPREVIEW "substring"
    #define MONGOC_ENCRYPT_QUERY_TYPE_PREFIXPREVIEW "prefixPreview" // Deprecated.
    #define MONGOC_ENCRYPT_QUERY_TYPE_PREFIX "prefix"
    #define MONGOC_ENCRYPT_QUERY_TYPE_SUFFIXPREVIEW "suffixPreview" // Deprecated.
@@ -24,9 +25,6 @@ Synopsis
 
 Sets the query type for explicit encryption.
 
-.. warning::
-   The "substringPreview" query type is in preview and should be used for experimental workloads only. This feature is unstable and its security is not guaranteed until released as Generally Available (GA). The GA version of this feature may not be backwards compatible with the preview version.
-
 Parameters
 ----------
 

src/libmongoc/src/mongoc/mongoc-client-side-encryption.h

@@ -42,8 +42,9 @@ struct _mongoc_database_t;
 
 #define MONGOC_ENCRYPT_QUERY_TYPE_EQUALITY "equality"
 #define MONGOC_ENCRYPT_QUERY_TYPE_RANGE "range"
-#define MONGOC_ENCRYPT_QUERY_TYPE_RANGEPREVIEW "rangePreview" // Deprecated.
-#define MONGOC_ENCRYPT_QUERY_TYPE_SUBSTRINGPREVIEW "substringPreview"
+#define MONGOC_ENCRYPT_QUERY_TYPE_RANGEPREVIEW "rangePreview"         // Deprecated.
+#define MONGOC_ENCRYPT_QUERY_TYPE_SUBSTRINGPREVIEW "substringPreview" // Deprecated.
+#define MONGOC_ENCRYPT_QUERY_TYPE_SUBSTRING "substring"
 #define MONGOC_ENCRYPT_QUERY_TYPE_PREFIXPREVIEW "prefixPreview" // Deprecated.
 #define MONGOC_ENCRYPT_QUERY_TYPE_PREFIX "prefix"
 #define MONGOC_ENCRYPT_QUERY_TYPE_SUFFIXPREVIEW "suffixPreview" // Deprecated.

src/libmongoc/tests/client_side_encryption_prose/explicit_encryption/encryptedFields-substring-ci-di.json

@@ -1,31 +1,31 @@
 {
   "fields": [
     {
-            "keyId": {
-                "$binary": {
-                    "base64": "EjRWeBI0mHYSNBI0VniQEg==",
-                    "subType": "04"
-                }
-            },
-            "path": "encryptedText",
-            "bsonType": "string",
-            "queries": [
-                {
-                    "queryType": "substringPreview",
-                    "strMaxLength": {
-                        "$numberInt": "10"
-                    },
-                    "strMinQueryLength": {
-                        "$numberInt": "2"
-                    },
-                    "strMaxQueryLength": {
-                        "$numberInt": "10"
-                    },
-                    "contention": 0,
-                    "caseSensitive": false,
-                    "diacriticSensitive": false
-                }
-            ]
+      "keyId": {
+        "$binary": {
+          "base64": "EjRWeBI0mHYSNBI0VniQEg==",
+          "subType": "04"
         }
+      },
+      "path": "encryptedText",
+      "bsonType": "string",
+      "queries": [
+        {
+          "queryType": "substring",
+          "strMaxLength": {
+            "$numberInt": "10"
+          },
+          "strMinQueryLength": {
+            "$numberInt": "2"
+          },
+          "strMaxQueryLength": {
+            "$numberInt": "6"
+          },
+          "contention": 0,
+          "caseSensitive": false,
+          "diacriticSensitive": false
+        }
+      ]
+    }
   ]
 }

src/libmongoc/tests/client_side_encryption_prose/explicit_encryption/encryptedFields-substring-preview.json

@@ -0,0 +1,33 @@
+{
+  "fields": [
+    {
+            "keyId": {
+                "$binary": {
+                    "base64": "EjRWeBI0mHYSNBI0VniQEg==",
+                    "subType": "04"
+                }
+            },
+            "path": "encryptedText",
+            "bsonType": "string",
+            "queries": [
+                {
+                    "queryType": "substringPreview",
+                    "strMaxLength": {
+                        "$numberInt": "10"
+                    },
+                    "strMinQueryLength": {
+                        "$numberInt": "2"
+                    },
+                    "strMaxQueryLength": {
+                        "$numberInt": "6"
+                    },
+                    "contention": {
+                        "$numberLong": "0"
+                    },
+                    "caseSensitive": true,
+                    "diacriticSensitive": true
+                }
+            ]
+        }
+  ]
+}

src/libmongoc/tests/client_side_encryption_prose/explicit_encryption/encryptedFields-substring.json

@@ -1,6 +1,6 @@
 {
-  "fields": [
-    {
+    "fields": [
+        {
             "keyId": {
                 "$binary": {
                     "base64": "EjRWeBI0mHYSNBI0VniQEg==",
@@ -11,15 +11,15 @@
             "bsonType": "string",
             "queries": [
                 {
-                    "queryType": "substringPreview",
+                    "queryType": "substring",
                     "strMaxLength": {
                         "$numberInt": "10"
                     },
                     "strMinQueryLength": {
                         "$numberInt": "2"
                     },
                     "strMaxQueryLength": {
-                        "$numberInt": "10"
+                        "$numberInt": "6"
                     },
                     "contention": {
                         "$numberLong": "0"
@@ -29,5 +29,5 @@
                 }
             ]
         }
-  ]
+    ]
 }