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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
# Copyright (C) 2019-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/db/basic_types.idl"
enums:
KMSProvider:
description: "Enumeration of supported KMS Providers"
type: string
values:
aws: "aws"
azure: "azure"
gcp: "gcp"
local: "local"
structs:
awsKMSError:
description: "AWS KMS error"
strict: false
fields:
__type:
type: string
cpp_name: type
Message: string
# Options passed to Mongo() javascript constructor
awsKMS:
description: "AWS KMS config"
fields:
accessKeyId: string
secretAccessKey: string
sessionToken:
type: string
optional: true
url:
type: string
optional: true
azureKMSError:
description: "Azure KMS Error"
strict: false
fields:
code: string
message: string
# Options passed to Mongo() javascript constructor
azureKMS:
description: "Azure KMS config"
fields:
tenantId: string
clientId: string
clientSecret: string
identityPlatformEndpoint:
type: string
optional: true
# Documented here: https://cloud.google.com/apis/design/errors#http_mapping
gcpKMSError:
description: "GCP KMS Error"
strict: false
fields:
code: int
message: string
status: string
# Options passed to Mongo() javascript constructor
gcpKMS:
description: "GCP KMS config"
fields:
email: string
endpoint:
type: string
optional: true
privateKey: string
# Options passed to Mongo() javascript constructor
localKMS:
description: "Local KMS config"
fields:
key: bindata_generic
kmsProviders:
description: "Supported KMS Providers"
strict: true
fields:
aws:
type: awsKMS
optional: true
azure:
type: azureKMS
optional: true
gcp:
type: gcpKMS
optional: true
local:
type: localKMS
optional: true
clientSideFLEOptions:
description: "FLE Options inputted through the Mongo constructor in the shell"
fields:
keyVaultClient: #Parsed as a JSHandleValue, not through IDL
type: void
ignore: true
keyVaultNamespace:
type: string
kmsProviders: kmsProviders
schemaMap:
type: object
optional: true
bypassAutoEncryption:
type: bool
optional: true
awsEncryptResponse:
description: "Response from AWS KMS Encrypt request, i.e. TrentService.Encrypt"
strict: false
fields:
CiphertextBlob:
type: string
KeyId:
type: string
awsDecryptResponse:
description: "Response from AWS KMS Decrypt request, i.e. TrentService.Decrypt"
# Nov 13, 2019 they added EncryptionAlgorithm but it is not documented
strict: false
fields:
Plaintext:
type: string
KeyId:
type: string
awsMasterKey:
description: "AWS KMS Key Store Description"
fields:
provider:
type: string
default: '"aws"'
key:
type: string
region:
type: string
endpoint:
type: string
optional: true
awsMasterKeyAndMaterial:
description: "AWS KMS Key Material Description"
fields:
keyMaterial:
type: bindata_generic
masterKey:
type: awsMasterKey
azureEncryptResponse:
description: "Response from Azure KMS wrapKey request"
strict: false
fields:
kid: string
value: string
azureDecryptResponse:
description: "Response from Azure KMS unwrapKey request"
strict: false
fields:
kid: string
value: string
azureMasterKey:
description: "Azure KMS Key Store Description"
fields:
provider:
type: string
default: '"azure"'
keyName: string
keyVersion:
type: string
optional: true
keyVaultEndpoint: string
azureMasterKeyAndMaterial:
description: "Azure KMS Key Material Description"
fields:
keyMaterial: bindata_generic
masterKey: azureMasterKey
gcpEncryptResponse:
description: "Response from GCP KMS Encrypt request"
strict: false
fields:
name: string
ciphertext: string
gcpDecryptResponse:
description: "Response from GCP KMS Decrypt request"
strict: false
fields:
plaintext: string
gcpMasterKey:
description: "GCP KMS Key Store Description"
fields:
provider:
type: string
default: '"gcp"'
keyName:
type: string
keyRing:
type: string
keyVersion:
type: string
optional: true
location:
type: string
projectId:
type: string
endpoint:
type: string
optional: true
gcpMasterKeyAndMaterial:
description: "GCP KMS Key Material Description"
fields:
keyMaterial:
type: bindata_generic
masterKey:
type: gcpMasterKey
localMasterKey:
description: "Local KMS Key Store Description"
fields:
provider:
type: string
default: '"local"'
localMasterKeyAndMaterial:
description: "Local KMS Key Material Description"
fields:
keyMaterial:
type: bindata_generic
masterKey:
type: localMasterKey
keyStoreRecord:
description: "A V0 Key Store Record"
fields:
_id: uuid
keyMaterial: bindata_generic
creationDate: date
updateDate: date
status: int
version:
type: long
default: 0
masterKey: object
keyAltNames:
type: array<string>
ignore: true
# Defined in 4.2.2. in RFC 6749
OAuthResponse:
description: "An oauth response with a token"
strict: false
fields:
access_token: string
token_type: string
# Expires_in is in seconds
expires_in:
type: int
optional: true
scope:
type: string
optional: true
# Defined in 4.2.2.1. in RFC 6749
OAuthErrorResponse:
description: "An oauth response with a token"
strict: false
fields:
error: string
error_description:
type: string
optional: true
error_uri:
type: string
optional: true
|
