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

NAME

6       mongoc_client_encryption_encrypt_opts_set_algorithm - mongoc_client_en‐
7       cryption_encrypt_opts_set_algorithm()
8

SYNOPSIS

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

PARAMETERS

52       • opts: A mongoc_client_encryption_encrypt_opts_t
53
54       • algorithm: A char * identifying the algorithm.
55

AUTHOR

57       MongoDB, Inc
58

60       2017-present, MongoDB, Inc
61
62
63
64
651.24.3                  MONGOC_CLAIuEgNT1_7E,NC2R0Y2P3TION_ENCRYPT_OPTS_SET_ALGORITHM(3)
Impressum