libmongocrypt
Loading...
Searching...
No Matches
mc-fle2-insert-update-payload-private-v2.h
1/*
2 * Copyright 2022-present MongoDB, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_V2_H
18#define MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_V2_H
19
20#include <bson/bson.h>
21
22#include "mc-array-private.h"
23#include "mc-optional-private.h"
24#include "mongocrypt-buffer-private.h"
25#include "mongocrypt-private.h"
26#include "mongocrypt.h"
27
69
70typedef struct {
71 _mongocrypt_buffer_t edcDerivedToken; // d
72 _mongocrypt_buffer_t escDerivedToken; // s
73 _mongocrypt_buffer_t encryptedTokens; // p
74 _mongocrypt_buffer_t indexKeyId; // u
75 bson_type_t valueType; // t
76 _mongocrypt_buffer_t value; // v
77 _mongocrypt_buffer_t serverEncryptionToken; // e
78 _mongocrypt_buffer_t serverDerivedFromDataToken; // l
79 int64_t contentionFactor; // k
80 mc_array_t edgeTokenSetArray; // g
81 mc_optional_int64_t sparsity; // sp
82 mc_optional_int32_t precision; // pn
83 mc_optional_int32_t trimFactor; // tf
84 bson_value_t indexMin; // mn
85 bson_value_t indexMax; // mx
86 _mongocrypt_buffer_t plaintext;
87 _mongocrypt_buffer_t userKeyId;
89
90// `mc_FLE2InsertUpdatePayloadV2_t` inherits extended alignment from libbson. To dynamically allocate, use
91// aligned allocation (e.g. BSON_ALIGNED_ALLOC)
92BSON_STATIC_ASSERT2(alignof_mc_FLE2InsertUpdatePayloadV2_t,
93 BSON_ALIGNOF(mc_FLE2InsertUpdatePayloadV2_t) >= BSON_ALIGNOF(bson_value_t));
94
106typedef struct {
107 _mongocrypt_buffer_t edcDerivedToken; // d
108 _mongocrypt_buffer_t escDerivedToken; // s
109 _mongocrypt_buffer_t serverDerivedFromDataToken; // l
110 _mongocrypt_buffer_t encryptedTokens; // p
112
113void mc_FLE2InsertUpdatePayloadV2_init(mc_FLE2InsertUpdatePayloadV2_t *payload);
114
115bool mc_FLE2InsertUpdatePayloadV2_parse(mc_FLE2InsertUpdatePayloadV2_t *out,
116 const _mongocrypt_buffer_t *in,
117 mongocrypt_status_t *status);
118
119/* mc_FLE2InsertUpdatePayloadV2_decrypt decrypts ciphertext.
120 * Returns NULL and sets @status on error. It is an error to call before
121 * mc_FLE2InsertUpdatePayloadV2_parse. */
122const _mongocrypt_buffer_t *mc_FLE2InsertUpdatePayloadV2_decrypt(_mongocrypt_crypto_t *crypto,
124 const _mongocrypt_buffer_t *user_key,
125 mongocrypt_status_t *status);
126
127bool mc_FLE2InsertUpdatePayloadV2_serialize(const mc_FLE2InsertUpdatePayloadV2_t *payload, bson_t *out);
128
129bool mc_FLE2InsertUpdatePayloadV2_serializeForRange(const mc_FLE2InsertUpdatePayloadV2_t *payload,
130 bson_t *out,
131 bool use_range_v2);
132
133void mc_FLE2InsertUpdatePayloadV2_cleanup(mc_FLE2InsertUpdatePayloadV2_t *payload);
134
135#endif /* MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_V2_H */
struct _mongocrypt_status_t mongocrypt_status_t
Definition mongocrypt.h:152
Definition mc-fle2-insert-update-payload-private-v2.h:106
Definition mc-fle2-insert-update-payload-private-v2.h:70