1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/*
* Copyright 2022-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_H
#define MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_H
#include <bson/bson.h>
#include "mc-array-private.h"
#include "mongocrypt-buffer-private.h"
#include "mongocrypt-private.h"
#include "mongocrypt.h"
/**
* FLE2InsertUpdatePayload represents an FLE2 payload of an indexed field to
* insert or update. It is created client side.
*
* FLE2InsertUpdatePayload has the following data layout:
*
* struct {
* uint8_t fle_blob_subtype = 4;
* uint8_t bson[];
* } FLE2InsertUpdatePayload;
*
* bson is a BSON document of this form:
* d: <binary> // EDCDerivedFromDataTokenAndContentionFactor
* s: <binary> // ESCDerivedFromDataTokenAndContentionFactor
* c: <binary> // ECCDerivedFromDataTokenAndContentionFactor
* p: <binary> // Encrypted Tokens
* u: <UUID> // Index KeyId
* t: <int32> // Encrypted type
* v: <binary> // Encrypted value
* e: <binary> // ServerDataEncryptionLevel1Token
* g: array<EdgeTokenSet> // Array of Edges
*
* p is the result of:
* Encrypt(
* key=ECOCToken,
* plaintext=(
* ESCDerivedFromDataTokenAndContentionFactor ||
* ECCDerivedFromDataTokenAndContentionFactor)
* )
*
* v is the result of:
* UserKeyId || EncryptAEAD(
* key=UserKey,
* plaintext=value
* associated_data=UserKeyId)
*/
typedef struct {
_mongocrypt_buffer_t edcDerivedToken; // d
_mongocrypt_buffer_t escDerivedToken; // s
_mongocrypt_buffer_t eccDerivedToken; // c
_mongocrypt_buffer_t encryptedTokens; // p
_mongocrypt_buffer_t indexKeyId; // u
bson_type_t valueType; // t
_mongocrypt_buffer_t value; // v
_mongocrypt_buffer_t serverEncryptionToken; // e
mc_array_t edgeTokenSetArray; // g
_mongocrypt_buffer_t plaintext;
_mongocrypt_buffer_t userKeyId;
} mc_FLE2InsertUpdatePayload_t;
/**
* EdgeTokenSet is the following BSON document:
* d: <binary> // EDCDerivedFromDataTokenAndContentionFactor
* s: <binary> // ESCDerivedFromDataTokenAndContentionFactor
* c: <binary> // ECCDerivedFromDataTokenAndContentionFactor
* p: <binary> // Encrypted Tokens
*
* Instances of mc_EdgeTokenSet_t are expected to be owned by
* mc_FLE2InsertUpdatePayload_t and are freed in
* mc_FLE2InsertUpdatePayload_cleanup.
*/
typedef struct {
_mongocrypt_buffer_t edcDerivedToken; // d
_mongocrypt_buffer_t escDerivedToken; // s
_mongocrypt_buffer_t eccDerivedToken; // c
_mongocrypt_buffer_t encryptedTokens; // p
} mc_EdgeTokenSet_t;
void mc_FLE2InsertUpdatePayload_init(mc_FLE2InsertUpdatePayload_t *payload);
bool mc_FLE2InsertUpdatePayload_parse(mc_FLE2InsertUpdatePayload_t *out,
const _mongocrypt_buffer_t *in,
mongocrypt_status_t *status);
/* mc_FLE2InsertUpdatePayload_decrypt decrypts ciphertext.
* Returns NULL and sets @status on error. It is an error to call before
* mc_FLE2InsertUpdatePayload_parse. */
const _mongocrypt_buffer_t *mc_FLE2InsertUpdatePayload_decrypt(_mongocrypt_crypto_t *crypto,
mc_FLE2InsertUpdatePayload_t *iup,
const _mongocrypt_buffer_t *user_key,
mongocrypt_status_t *status);
bool mc_FLE2InsertUpdatePayload_serialize(const mc_FLE2InsertUpdatePayload_t *payload, bson_t *out);
bool mc_FLE2InsertUpdatePayload_serializeForRange(const mc_FLE2InsertUpdatePayload_t *payload, bson_t *out);
void mc_FLE2InsertUpdatePayload_cleanup(mc_FLE2InsertUpdatePayload_t *payload);
#endif /* MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_H */
|
