Scroll to navigation

MONGOC_CLIENT_ENCRYPTION_ENCRYPT_OPTS_SET_ALGORITHM(3) libmongoc MONGOC_CLIENT_ENCRYPTION_ENCRYPT_OPTS_SET_ALGORITHM(3)

NAME

mongoc_client_encryption_encrypt_opts_set_algorithm - mongoc_client_encryption_encrypt_opts_set_algorithm()

SYNOPSIS

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"


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.

NOTE:

This option is part of the experimental Queryable Encryption API and may be subject to breaking changes in future releases.




"Unindexed"

for unindexed encryption.

NOTE:

This option is part of the experimental Queryable Encryption API and may be subject to breaking changes in future releases.




PARAMETERS

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

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

October 20, 2022 1.23.1