MONGOCRYPT-828 improve checks for text required options (#1045)

Check text options and contention are set for text algorithm

Author: kevinAlbs

src/mongocrypt-ctx-encrypt.c

@@ -1403,11 +1403,20 @@ static bool _fle2_finalize_explicit(mongocrypt_ctx_t *ctx, mongocrypt_binary_t *
         _mongocrypt_buffer_copy_to(&ctx->opts.key_id, &marking.u.fle2.index_key_id);
     }
 
-    if (ctx->opts.contention_factor.set) {
+    // Handle contention factor:
+    switch (ctx->opts.index_type.value) {
+    case MONGOCRYPT_INDEX_TYPE_NONE:
+    default:
+        BSON_ASSERT(!ctx->opts.contention_factor.set); // Checked earlier in explicit_encrypt_init.
+        break;
+
+    case MONGOCRYPT_INDEX_TYPE_EQUALITY:
+    case MONGOCRYPT_INDEX_TYPE_RANGEPREVIEW_DEPRECATED:
+    case MONGOCRYPT_INDEX_TYPE_RANGE:
+    case MONGOCRYPT_INDEX_TYPE_TEXTPREVIEW:
+        // All QE indexed algorithms require contention factor.
+        BSON_ASSERT(ctx->opts.contention_factor.set); // Checked earlier in explicit_encrypt_init.
         marking.u.fle2.maxContentionFactor = ctx->opts.contention_factor.value;
-    } else if (ctx->opts.index_type.value == MONGOCRYPT_INDEX_TYPE_EQUALITY) {
-        _mongocrypt_ctx_fail_w_msg(ctx, "contention factor required for indexed algorithm");
-        goto fail;
     }
 
     /* Convert marking to ciphertext. */
@@ -1906,6 +1915,7 @@ static bool explicit_encrypt_init(mongocrypt_ctx_t *ctx, mongocrypt_binary_t *ms
         return _mongocrypt_ctx_fail_w_msg(ctx, "contention factor is required for indexed algorithm");
     }
 
+    // Check required options for range algorithm are set:
     if (ctx->opts.index_type.set
         && (ctx->opts.index_type.value == MONGOCRYPT_INDEX_TYPE_RANGE
             || ctx->opts.index_type.value == MONGOCRYPT_INDEX_TYPE_RANGEPREVIEW_DEPRECATED)) {
@@ -1918,6 +1928,17 @@ static bool explicit_encrypt_init(mongocrypt_ctx_t *ctx, mongocrypt_binary_t *ms
         }
     }
 
+    // Check required options for text algorithm are set:
+    if (ctx->opts.index_type.set && (ctx->opts.index_type.value == MONGOCRYPT_INDEX_TYPE_TEXTPREVIEW)) {
+        if (!ctx->opts.contention_factor.set) {
+            return _mongocrypt_ctx_fail_w_msg(ctx, "contention factor is required for textPreview algorithm");
+        }
+
+        if (!ctx->opts.textopts.set) {
+            return _mongocrypt_ctx_fail_w_msg(ctx, "text opts are required for textPreview algorithm");
+        }
+    }
+
     if (ctx->opts.rangeopts.set && !mc_validate_sparsity(ctx->opts.rangeopts.value.sparsity, ctx->status)) {
         return _mongocrypt_ctx_fail(ctx);
     }

test/test-mongocrypt-ctx-setopt.c

@@ -1028,6 +1028,26 @@ static void _test_setopt_for_explicit_encrypt(_mongocrypt_tester_t *tester) {
         ASSERT_EX_ENCRYPT_INIT_FAILS(bson, "suffixPreview query type requires textPreview index type");
     }
 
+    /* It is an error to set a text algorithm without setting text options */
+    {
+        REFRESH;
+        /* Set key ID to get past the 'either key id or key alt name required' error */
+        ASSERT_KEY_ID_OK(uuid);
+        ASSERT_OK(mongocrypt_ctx_setopt_algorithm(ctx, MONGOCRYPT_ALGORITHM_TEXTPREVIEW_STR, -1), ctx);
+        ASSERT_OK(mongocrypt_ctx_setopt_contention_factor(ctx, 0), ctx);
+        ASSERT_EX_ENCRYPT_INIT_FAILS(bson, "text opts are required for textPreview algorithm");
+    }
+
+    /* It is an error to set a text algorithm without setting contention */
+    {
+        REFRESH;
+        /* Set key ID to get past the 'either key id or key alt name required' error */
+        ASSERT_KEY_ID_OK(uuid);
+        ASSERT_OK(mongocrypt_ctx_setopt_algorithm(ctx, MONGOCRYPT_ALGORITHM_TEXTPREVIEW_STR, -1), ctx);
+        ASSERT_OK(mongocrypt_ctx_setopt_algorithm_text(ctx, textopts), ctx);
+        ASSERT_EX_ENCRYPT_INIT_FAILS(bson, "contention factor is required for textPreview algorithm");
+    }
+
     mongocrypt_ctx_destroy(ctx);
     mongocrypt_destroy(crypt);
 }