add docs and stub API for contention factor and query type

Author: kevinAlbs

src/libmongoc/doc/mongoc_client_encryption_encrypt.rst

@@ -20,6 +20,10 @@ Performs explicit encryption.
 
 ``ciphertext`` is always initialized (even on failure). Caller must call :symbol:`bson_value_destroy()` to free.
 
+To insert or query with an "Indexed" encrypted payload, use a :symbol:`mongoc_client_t` configured with :symbol:`mongoc_auto_encryption_opts_t`.
+The :symbol:`mongoc_auto_encryption_opts_t` may be configured to bypass query analysis with :symbol:`mongoc_auto_encryption_opts_set_bypass_query_analysis`.
+The :symbol:`mongoc_auto_encryption_opts_t` must not be configured to bypass automatic encryption with :symbol:`mongoc_auto_encryption_opts_set_bypass_auto_encryption`.
+
 Parameters
 ----------
 

src/libmongoc/doc/mongoc_client_encryption_encrypt_opts_set_algorithm.rst

@@ -14,11 +14,15 @@ Synopsis
 
    #define MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
    #define MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
+   #define MONGOC_ENCRYPT_ALGORITHM_INDEXED "Indexed"
+   #define MONGOC_ENCRYPT_ALGORITHM_UNINDEXED "Unindexed"
 
 Identifies the algorithm to use for encryption. Valid values of ``algorithm`` are:
 
 * "AEAD_AES_256_CBC_HMAC_SHA_512-Random" for randomized encryption.
 * "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic" for deterministic (queryable) encryption.
+* "Indexed" for indexed encryption.
+* "Unindexed" for unindexed encryption.
 
 Parameters
 ----------

src/libmongoc/doc/mongoc_client_encryption_encrypt_opts_set_contention_factor.rst

@@ -0,0 +1,24 @@
+:man_page: mongoc_client_encryption_encrypt_opts_set_contention_factor
+
+mongoc_client_encryption_encrypt_opts_set_contention_factor()
+=============================================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+   MONGOC_EXPORT (void)
+    mongoc_client_encryption_encrypt_opts_set_contention_factor (
+        mongoc_client_encryption_encrypt_opts_t *opts, int64_t contention_factor);
+
+Sets a contention factor for explicit encryption.
+Only applies when the algorithm set by :symbol:`mongoc_client_encryption_encrypt_opts_set_algorithm()` is "Indexed".
+It is an error to set the contention factor when algorithm is not "Indexed".
+If contention factor is not supplied, it defaults to a value of 0.
+
+Parameters
+----------
+
+* ``opts``: A :symbol:`mongoc_client_encryption_encrypt_opts_t`
+* ``contention_factor``: A non-negative contention factor.

src/libmongoc/doc/mongoc_client_encryption_encrypt_opts_set_query_type.rst

@@ -0,0 +1,25 @@
+:man_page: mongoc_client_encryption_encrypt_opts_set_query_type
+
+mongoc_client_encryption_encrypt_opts_set_query_type()
+======================================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+   typedef enum { MONGOC_ENCRYPT_QUERY_TYPE_EQUALITY } mongoc_encrypt_query_type_t;
+
+   MONGOC_EXPORT (void)
+    mongoc_client_encryption_encrypt_opts_set_query_type (
+        mongoc_client_encryption_encrypt_opts_t *opts, mongoc_encrypt_query_type_t query_type);
+
+Sets a query type for explicit encryption.
+Only applies when the algorithm set by :symbol:`mongoc_client_encryption_encrypt_opts_set_algorithm()` is "Indexed".
+It is an error to set the query type when algorithm is not "Indexed".
+
+Parameters
+----------
+
+* ``opts``: A :symbol:`mongoc_client_encryption_encrypt_opts_t`
+* ``query_type``: A query type to use for explicit encryption.

src/libmongoc/doc/mongoc_client_encryption_encrypt_opts_t.rst

@@ -27,6 +27,8 @@ Used to set options for :symbol:`mongoc_client_encryption_encrypt()`.
     mongoc_client_encryption_encrypt_opts_set_keyid
     mongoc_client_encryption_encrypt_opts_set_keyaltname
     mongoc_client_encryption_encrypt_opts_set_algorithm
+    mongoc_client_encryption_encrypt_opts_set_contention_factor
+    mongoc_client_encryption_encrypt_opts_set_query_type
 
 .. seealso::
 

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

@@ -379,6 +379,14 @@ struct _mongoc_client_encryption_encrypt_opts_t {
    bson_value_t keyid;
    char *algorithm;
    char *keyaltname;
+   struct {
+      int64_t value;
+      bool set;
+   } contention_factor;
+   struct {
+      mongoc_encrypt_query_type_t value;
+      bool set;
+   } query_type;
 };
 
 mongoc_client_encryption_encrypt_opts_t *
@@ -438,6 +446,29 @@ mongoc_client_encryption_encrypt_opts_set_algorithm (
    opts->algorithm = bson_strdup (algorithm);
 }
 
+void
+mongoc_client_encryption_encrypt_opts_set_contention_factor (
+   mongoc_client_encryption_encrypt_opts_t *opts, int64_t contention_factor)
+{
+   if (!opts) {
+      return;
+   }
+   opts->contention_factor.value = contention_factor;
+   opts->contention_factor.set = true;
+}
+
+void
+mongoc_client_encryption_encrypt_opts_set_query_type (
+   mongoc_client_encryption_encrypt_opts_t *opts,
+   mongoc_encrypt_query_type_t query_type)
+{
+   if (!opts) {
+      return;
+   }
+   opts->query_type.value = query_type;
+   opts->query_type.set = true;
+}
+
 #ifndef MONGOC_ENABLE_CLIENT_SIDE_ENCRYPTION
 
 static bool

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

@@ -29,6 +29,8 @@ struct _mongoc_client_pool_t;
    "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
 #define MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC \
    "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
+#define MONGOC_ENCRYPT_ALGORITHM_INDEXED "Indexed"
+#define MONGOC_ENCRYPT_ALGORITHM_UNINDEXED "Unindexed"
 
 BSON_BEGIN_DECLS
 
@@ -158,6 +160,17 @@ MONGOC_EXPORT (void)
 mongoc_client_encryption_encrypt_opts_set_algorithm (
    mongoc_client_encryption_encrypt_opts_t *opts, const char *algorithm);
 
+MONGOC_EXPORT (void)
+mongoc_client_encryption_encrypt_opts_set_contention_factor (
+   mongoc_client_encryption_encrypt_opts_t *opts, int64_t contention_factor);
+
+typedef enum { MONGOC_ENCRYPT_QUERY_TYPE_EQUALITY } mongoc_encrypt_query_type_t;
+
+MONGOC_EXPORT (void)
+mongoc_client_encryption_encrypt_opts_set_query_type (
+   mongoc_client_encryption_encrypt_opts_t *opts,
+   mongoc_encrypt_query_type_t query_type);
+
 MONGOC_EXPORT (mongoc_client_encryption_datakey_opts_t *)
 mongoc_client_encryption_datakey_opts_new (void) BSON_GNUC_WARN_UNUSED_RESULT;