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
|
description: createDataKey
schemaVersion: "1.8"
runOnRequirements:
- csfle: true
createEntities:
- client:
id: &client0 client0
observeEvents:
- commandStartedEvent
- clientEncryption:
id: &clientEncryption0 clientEncryption0
clientEncryptionOpts:
keyVaultClient: *client0
keyVaultNamespace: keyvault.datakeys
kmsProviders:
aws: { accessKeyId: { $$placeholder: 1 }, secretAccessKey: { $$placeholder: 1 } }
azure: { tenantId: { $$placeholder: 1 }, clientId: { $$placeholder: 1 }, clientSecret: { $$placeholder: 1 } }
gcp: { email: { $$placeholder: 1 }, privateKey: { $$placeholder: 1 } }
kmip: { endpoint: { $$placeholder: 1 } }
local: { key: { $$placeholder: 1 } }
- database:
id: &database0 database0
client: *client0
databaseName: &database0Name keyvault
- collection:
id: &collection0 collection0
database: *database0
collectionName: &collection0Name datakeys
initialData:
- databaseName: *database0Name
collectionName: *collection0Name
documents: []
tests:
- description: create data key with AWS KMS provider
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: aws
opts:
masterKey: &new_aws_masterkey
key: arn:aws:kms:us-east-1:579766882180:key/89fcc2c4-08b0-4bd9-9f25-e30687b580d0
region: us-east-1
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$exists: true }
masterKey:
provider: aws
<<: *new_aws_masterkey
writeConcern: { w: majority }
- description: create datakey with Azure KMS provider
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: azure
opts:
masterKey: &new_azure_masterkey
keyVaultEndpoint: key-vault-csfle.vault.azure.net
keyName: key-name-csfle
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$exists: true }
masterKey:
provider: azure
<<: *new_azure_masterkey
writeConcern: { w: majority }
- description: create datakey with GCP KMS provider
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: gcp
opts:
masterKey: &new_gcp_masterkey
projectId: devprod-drivers
location: global
keyRing: key-ring-csfle
keyName: key-name-csfle
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$exists: true }
masterKey:
provider: gcp
<<: *new_gcp_masterkey
writeConcern: { w: majority }
- description: create datakey with KMIP KMS provider
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: kmip
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$exists: true }
masterKey:
provider: kmip
keyId: { $$type: string }
writeConcern: { w: majority }
- description: create datakey with local KMS provider
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: local
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$exists: true }
masterKey:
provider: local
writeConcern: { w: majority }
- description: create datakey with no keyAltName
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: local
opts:
keyAltNames: []
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
# keyAltNames field should not exist if no keyAltNames are given.
keyAltNames: { $$exists: false }
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$type: int }
masterKey: { $$type: object }
writeConcern: { w: majority }
- description: create datakey with single keyAltName
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: local
opts:
keyAltNames: ["local_key"]
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
keyAltNames: [local_key]
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$type: int }
masterKey: { $$type: object }
writeConcern: { w: majority }
- description: create datakey with multiple keyAltNames
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: local
opts:
keyAltNames: ["abc", "def"]
expectResult: { $$type: binData }
- name: aggregate
object: *collection0
arguments:
# Need to use pipeline to sort keyAltNames for deterministic matching
# because keyAltNames is not required to be sorted.
pipeline:
- $project: { _id: 0, keyAltNames: 1 }
- $unwind: $keyAltNames
- $sort: { keyAltNames: 1 }
expectResult:
- keyAltNames: abc
- keyAltNames: def
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
keyAltNames: { $$type: array }
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$type: int }
masterKey: { $$type: object }
writeConcern: { w: majority }
- commandStartedEvent: { commandName: aggregate }
- description: create datakey with custom key material
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: local
opts:
# "key_material" repeated 8 times.
keyMaterial: &custom_key_material { $binary: { base64: a2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFs, subType: "00" } }
expectResult: { $$type: binData }
expectEvents:
- client: *client0
events:
- commandStartedEvent:
databaseName: *database0Name
command:
insert: *collection0Name
documents:
- _id: { $$type: binData }
# Cannot match exact value of encrypted key material.
keyMaterial: { $$type: binData }
creationDate: { $$type: date }
updateDate: { $$type: date }
status: { $$type: int }
masterKey: { $$type: object }
writeConcern: { w: majority }
- description: create datakey with invalid custom key material (too short)
operations:
- name: createDataKey
object: *clientEncryption0
arguments:
kmsProvider: local
opts:
# "key_material" repeated only 7 times (key material length == 84).
keyMaterial: { $binary: { base64: a2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFsa2V5X21hdGVyaWFs, subType: "00" } }
expectError:
isClientError: true
expectEvents:
- client: *client0
events: []
|
