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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
# Copyright (C) 2022-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
global:
cpp_namespace: "mongo"
imports:
- "mongo/idl/basic_types.idl"
- "mongo/crypto/encryption_fields.idl"
enums:
EncryptedBinDataType:
description: "Subtypes with an BinData 6, this is the first byte of the payload"
type: int
values:
# FLE 1 Payloads
kPlaceholder : 0 # see FLEEncryptionPlaceholder
kDeterministic : 1
kRandom : 2
# FLE 2
# FLE 2 Client-side
kFLE2Placeholder : 3 # see FLE2EncryptionPlaceholder
kFLE2InsertUpdatePayload : 4 # see FLE2InsertUpdatePayload
kFLE2FindEqualityPayload : 5 # see FLE2FindEqualityPayload
# FLE 2 Server-side
kFLE2UnindexedEncryptedValue : 6 # see FLE2IndexedEqualityEncryptedValue
kFLE2EqualityIndexedValue : 7
# Transient encrypted data in query rewrites, not persisted
# same as BinDataGeneral but redacted
kFLE2TransientRaw : 8
FleVersion:
description: "The version / type of field-level encryption in use."
type: int
values:
kFle1: 1
kFle2: 2
FleAlgorithmInt:
description: "The algorithm used to encrypt fields for field level encryption represented
as an unsigned integer."
type: int
values:
kDeterministic: 1
kRandom: 2
Fle2AlgorithmInt:
description: "The algorithm used to encrypt fields for field level encryption represented
as an unsigned integer."
type: int
values:
kUnindexed: 1
kEquality: 2
kRange: 3
Fle2PlaceholderType:
description: "The type of payload to generate from a placeholder"
type: int
values:
kInsert: 1
kFind: 2
structs:
EncryptionPlaceholder:
description: "Implements Encryption BinData (subtype 6) sub-subtype 0, the intent-to-encrypt
mapping. Contains a value to encrypt and a description of how it should be encrypted."
strict: true
fields:
a:
description: "The encryption algorithm to be used."
type: FleAlgorithmInt
cpp_name: algorithm
ki:
description: "Used to query the key vault by _id. If omitted, ka must be specified."
type: uuid
cpp_name: keyId
optional: true
ka:
description: "Used to query the key vault by keyAltName. If omitted,
ki must be specified."
type: string
cpp_name: keyAltName
optional: true
v:
description: "value to encrypt"
type: IDLAnyType
cpp_name: value
FLE2EncryptionPlaceholder:
description: "Implements Encryption BinData (subtype 6) sub-subtype 0, the intent-to-encrypt
mapping. Contains a value to encrypt and a description of how it should be encrypted."
strict: true
fields:
t:
description: "The type number, determines what payload to replace the placeholder with"
type: Fle2PlaceholderType
cpp_name: type
a:
description: "The encryption algorithm to be used."
type: Fle2AlgorithmInt
cpp_name: algorithm
ki:
description: "IndexKeyId, Used to query the key vault by _id."
type: uuid
cpp_name: indexKeyId
ku:
description: "UserKeyId, Used to query the key vault by _id.,
Typically same as IndexKeyId unless explicit encryption is used."
type: uuid
cpp_name: userKeyId
v:
description: "value to encrypt"
type: IDLAnyType
cpp_name: value
cm:
description: "Queryable Encryption max contention counter"
type: long
cpp_name: maxContentionCounter
FLE2InsertUpdatePayload:
description: "Payload of an indexed field to insert or update"
strict: true
fields:
d:
description: "EDCDerivedFromDataTokenAndCounter"
type: bindata_generic
cpp_name: edcDerivedToken
s:
description: "ESCDerivedFromDataTokenAndCounter"
type: bindata_generic
cpp_name: escDerivedToken
c:
description: "ECCDerivedFromDataTokenAndCounter"
type: bindata_generic
cpp_name: eccDerivedToken
p:
description: "Encrypted tokens"
type: bindata_generic
cpp_name: encryptedTokens
u:
description: "Index KeyId"
type: uuid
cpp_name: indexKeyId
t:
description: "Encrypted type"
type: safeInt
cpp_name: type
v:
description: "Encrypted value"
type: bindata_generic
cpp_name: value
e:
description: "ServerDataEncryptionLevel1Token"
type: bindata_generic
cpp_name: serverEncryptionToken
FLE2DeletePayload:
description: "Payload of an indexed field to delete"
strict: true
fields:
o:
description: "ECOCToken"
type: bindata_generic
cpp_name: ecocToken
e:
description: "ServerDataEncryptionLevel1Token"
type: bindata_generic
cpp_name: serverEncryptionToken
FLE2FindEqualityPayload:
description: "Payload for an equality find"
strict: true
fields:
d:
description: "EDCDerivedFromDataToken"
type: bindata_generic
cpp_name: edcDerivedToken
s:
description: "ESCDerivedFromDataToken"
type: bindata_generic
cpp_name: escDerivedToken
c:
description: "ECCDerivedFromDataToken"
type: bindata_generic
cpp_name: eccDerivedToken
e:
description: "ServerDataEncryptionLevel1Token"
type: bindata_generic
cpp_name: serverEncryptionToken
optional: true # For backwards compat, make this optional
cm:
description: "Queryable Encryption max counter"
type: long
cpp_name: maxCounter
optional: true
EncryptionInformation:
description: "Implements Encryption Information which includes the schema for Queryable Encryption that is consumed by query_analysis, queries and write_ops"
strict: true
fields:
type:
description: "The version number"
type: safeInt
default: 1
unstable: true
deleteTokens:
description: "A map of field paths to FLEDeletePayload"
type: object_owned
optional: true
unstable: true
schema:
description: "A map of NamespaceString to EncryptedFieldConfig"
type: object_owned
unstable: true
crudProcessed:
description: "A boolean to indicate whether the CRUD layer has already processed this Queryable Encryption request. Used to prevent infinite recursion."
type: bool
optional: true
unstable: true
ecocDocument:
description: "foo"
strict: true
fields:
_id:
description: "Random id"
type: objectid
fieldName:
description: "Name of field"
type: string
value:
description: "Encrypted value"
type: bindata_generic
|
