1MONGOC_CLIENT_ENCRYPTION_MEONNCGROYCP_TC_LOIPETlNSiT_b_SmEEoNTnC_gRAoYLcPGTOIROINT_HEMN(C3R)YPT_OPTS_SET_ALGORITHM(3)
2
3
4

SYNOPSIS

6          void
7          mongoc_client_encryption_encrypt_opts_set_algorithm (
8             mongoc_client_encryption_encrypt_opts_t *opts, const char *algorithm);
9
10          #define MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
11          #define MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
12          // (Experimental: See below)
13          #define MONGOC_ENCRYPT_ALGORITHM_INDEXED "Indexed"
14          // (Experimental: See below)
15          #define MONGOC_ENCRYPT_ALGORITHM_UNINDEXED "Unindexed"
16          // (Experimental: See below)
17          #define MONGOC_ENCRYPT_ALGORITHM_RANGEPREVIEW "RangePreview"
18
19       Identifies  the  algorithm to use for encryption. Valid values of algo‐
20       rithm are:
21
22       "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
23          for randomized encryption. Specific to the Client-Side  Field  Level
24          Encryption feature.
25
26       "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
27          for   deterministic   (queryable)   encryption.   Specific   to  the
28          Client-Side Field Level Encryption feature.
29
30       "Indexed"
31          for indexed encryption. Specific to the  Queryable  Encryption  fea‐
32          ture.
33
34       "Unindexed"
35          for  unindexed encryption. Specific to the Queryable Encryption fea‐
36          ture.
37
38       "RangePreview"
39          for range encryption. Specific to the Queryable Encryption feature.
40
41          NOTE:
42              The Range algorithm is experimental only and  not  intended  for
43              public  use.  It  is subject to breaking changes. This option is
44              part of the experimental Queryable Encryption  API  and  may  be
45              subject to breaking changes in future releases.
46

PARAMETERS

48       • opts: A mongoc_client_encryption_encrypt_opts_t
49
50       • algorithm: A char * identifying the algorithm.
51

AUTHOR

53       MongoDB, Inc
54

56       2017-present, MongoDB, Inc
57
58
59
60
611.25.1                  MONGOC_CLNIoEvNT0_8E,NC2R0Y2P3TION_ENCRYPT_OPTS_SET_ALGORITHM(3)
Impressum