MONGOC_CLIENT_ENCRYPTION_ENCRYPT_OPTS_SET_ALGORITHM(3) libmongoc MONGOC_CLIENT_ENCRYPTION_ENCRYPT_OPTS_SET_ALGORITHM(3) 

void
mongoc_client_encryption_encrypt_opts_set_algorithm (
   mongoc_client_encryption_encrypt_opts_t *opts, const char *algorithm);
#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"
// (Experimental: See below)
#define MONGOC_ENCRYPT_ALGORITHM_INDEXED "Indexed"
// (Experimental: See below)
#define MONGOC_ENCRYPT_ALGORITHM_UNINDEXED "Unindexed"
// (Experimental: See below)
#define MONGOC_ENCRYPT_ALGORITHM_RANGEPREVIEW "RangePreview"


Identifies the algorithm to use for encryption. Valid values of algorithm are:

"AEAD_AES_256_CBC_HMAC_SHA_512-Random"

for randomized encryption. Specific to the Client-Side Field Level Encryption feature.


"AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"

for deterministic (queryable) encryption. Specific to the Client-Side Field Level Encryption feature.


"Indexed"

for indexed encryption. Specific to the Queryable Encryption feature.


"Unindexed"

for unindexed encryption. Specific to the Queryable Encryption feature.


"RangePreview"

for range encryption. Specific to the Queryable Encryption feature.

NOTE:

The Range algorithm is experimental only and not intended for public use. It is subject to breaking changes. This option is part of the experimental Queryable Encryption API and may be subject to breaking changes in future releases.




  • opts: A mongoc_client_encryption_encrypt_opts_t
  • algorithm: A char * identifying the algorithm.

MongoDB, Inc

2017-present, MongoDB, Inc

March 31, 2024 1.26.0