-
Notifications
You must be signed in to change notification settings - Fork 454
/
Copy pathtest-mongoc-client-side-encryption.c
6825 lines (5847 loc) · 286 KB
/
test-mongoc-client-side-encryption.c
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2009-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.
*/
#include "json-test.h"
#include "test-libmongoc.h"
#include "bson-dsl.h"
#include "common-b64-private.h"
/* _mongoc_host_list_from_string_with_err */
#include "mongoc/mongoc-host-list-private.h"
#include "mongoc/mongoc-cluster-aws-private.h"
/* MONGOC_SERVER_ERR_NS_NOT_FOUND */
#include "mongoc/mongoc-error-private.h"
#include "mongoc/mongoc-client-side-encryption-private.h"
#include "mongoc/mongoc-uri.h"
#include "mongoc/mongoc-http-private.h"
static void
_before_test (json_test_ctx_t *ctx, const bson_t *test)
{
mongoc_client_t *client;
mongoc_collection_t *keyvault_coll;
bson_iter_t iter;
bson_error_t error;
bool ret;
mongoc_write_concern_t *wc;
bson_t insert_opts;
BSON_UNUSED (test);
/* Insert data into the key vault. */
client = test_framework_new_default_client ();
wc = mongoc_write_concern_new ();
mongoc_write_concern_set_wmajority (wc, 1000);
bson_init (&insert_opts);
mongoc_write_concern_append (wc, &insert_opts);
if (bson_iter_init_find (&iter, ctx->config->scenario, "key_vault_data")) {
keyvault_coll = mongoc_client_get_collection (client, "keyvault", "datakeys");
/* Drop and recreate, inserting data. */
ret = mongoc_collection_drop (keyvault_coll, &error);
if (!ret) {
/* Ignore "namespace does not exist" error. */
ASSERT_OR_PRINT (error.code == 26, error);
}
bson_iter_recurse (&iter, &iter);
while (bson_iter_next (&iter)) {
bson_t doc;
bson_iter_bson (&iter, &doc);
ret = mongoc_collection_insert_one (keyvault_coll, &doc, &insert_opts, NULL /* reply */, &error);
ASSERT_OR_PRINT (ret, error);
}
mongoc_collection_destroy (keyvault_coll);
}
bson_destroy (&insert_opts);
mongoc_write_concern_destroy (wc);
mongoc_client_destroy (client);
}
static bool
_run_operation (json_test_ctx_t *ctx, const bson_t *test, const bson_t *operation)
{
bson_t reply;
bool res;
res = json_test_operation (ctx, test, operation, ctx->collection, NULL, &reply);
bson_destroy (&reply);
return res;
}
static void
test_client_side_encryption_cb (void *scenario)
{
json_test_config_t config = JSON_TEST_CONFIG_INIT;
config.before_test_cb = _before_test;
config.run_operation_cb = _run_operation;
config.scenario = scenario;
config.command_started_events_only = true;
config.command_monitoring_allow_subset = false;
run_json_general_test (&config);
}
/* This is the hex form of the base64 encoded value:
* Mng0NCt4ZHVUYUJCa1kxNkVyNUR1QURhZ2h2UzR2d2RrZzh0cFBwM3R6NmdWMDFBMUN3YkQ5aXRRMkhGRGdQV09wOGVNYUMxT2k3NjZKelhaQmRCZGJkTXVyZG9uSjFk
* From the client side encryption spec.
*/
#define LOCAL_MASTERKEY \
"\x32\x78\x34\x34\x2b\x78\x64\x75\x54\x61\x42\x42\x6b\x59\x31\x36\x45\x72" \
"\x35\x44\x75\x41\x44\x61\x67\x68\x76\x53\x34\x76\x77\x64\x6b\x67\x38\x74" \
"\x70\x50\x70\x33\x74\x7a\x36\x67\x56\x30\x31\x41\x31\x43\x77\x62\x44\x39" \
"\x69\x74\x51\x32\x48\x46\x44\x67\x50\x57\x4f\x70\x38\x65\x4d\x61\x43\x31" \
"\x4f\x69\x37\x36\x36\x4a\x7a\x58\x5a\x42\x64\x42\x64\x62\x64\x4d\x75\x72" \
"\x64\x6f\x6e\x4a\x31\x64"
static void
_set_extra_bypass (bson_t *extra)
{
if (test_framework_getenv_bool ("MONGOC_TEST_MONGOCRYPTD_BYPASS_SPAWN")) {
BSON_APPEND_BOOL (extra, "mongocryptdBypassSpawn", true);
}
}
static void
_set_extra_crypt_shared (bson_t *extra)
{
char *const path = test_framework_getenv ("MONGOC_TEST_CRYPT_SHARED_LIB_PATH");
if (path) {
BSON_APPEND_UTF8 (extra, "cryptSharedLibPath", path);
bson_free (path);
}
}
/* Convenience helper to check if spawning mongocryptd should be bypassed */
static void
_check_bypass (mongoc_auto_encryption_opts_t *opts)
{
bson_t extra = BSON_INITIALIZER;
_set_extra_bypass (&extra);
mongoc_auto_encryption_opts_set_extra (opts, &extra);
bson_destroy (&extra);
}
static bson_t *
_make_aws_kms_provider (bson_t *kms_providers)
{
char *aws_secret_access_key;
char *aws_access_key_id;
aws_secret_access_key = test_framework_getenv_required ("MONGOC_TEST_AWS_SECRET_ACCESS_KEY");
aws_access_key_id = test_framework_getenv_required ("MONGOC_TEST_AWS_ACCESS_KEY_ID");
if (!kms_providers) {
kms_providers = bson_new ();
}
bson_concat (kms_providers,
tmp_bson ("{ 'aws': { 'secretAccessKey': '%s', 'accessKeyId': '%s' }}",
aws_secret_access_key,
aws_access_key_id));
bson_free (aws_secret_access_key);
bson_free (aws_access_key_id);
return kms_providers;
}
static bson_t *
_make_azure_kms_provider (bson_t *kms_providers)
{
char *azure_tenant_id;
char *azure_client_id;
char *azure_client_secret;
azure_tenant_id = test_framework_getenv_required ("MONGOC_TEST_AZURE_TENANT_ID");
azure_client_id = test_framework_getenv_required ("MONGOC_TEST_AZURE_CLIENT_ID");
azure_client_secret = test_framework_getenv_required ("MONGOC_TEST_AZURE_CLIENT_SECRET");
if (!kms_providers) {
kms_providers = bson_new ();
}
bson_concat (kms_providers,
tmp_bson ("{ 'azure': { 'tenantId': '%s', 'clientId': '%s', "
"'clientSecret': '%s' }}",
azure_tenant_id,
azure_client_id,
azure_client_secret));
bson_free (azure_tenant_id);
bson_free (azure_client_id);
bson_free (azure_client_secret);
return kms_providers;
}
static bson_t *
_make_gcp_kms_provider (bson_t *kms_providers)
{
char *gcp_email;
char *gcp_privatekey;
gcp_email = test_framework_getenv_required ("MONGOC_TEST_GCP_EMAIL");
gcp_privatekey = test_framework_getenv_required ("MONGOC_TEST_GCP_PRIVATEKEY");
if (!gcp_email || !gcp_privatekey) {
test_error ("Set MONGOC_TEST_GCP_EMAIL and MONGOC_TEST_GCP_PRIVATEKEY to "
"enable CSFLE tests.");
}
if (!kms_providers) {
kms_providers = bson_new ();
}
bson_concat (kms_providers, tmp_bson ("{ 'gcp': { 'email': '%s', 'privateKey': '%s' }}", gcp_email, gcp_privatekey));
bson_free (gcp_email);
bson_free (gcp_privatekey);
return kms_providers;
}
static bson_t *
_make_local_kms_provider (bson_t *kms_providers)
{
bson_t *local = BCON_NEW ("local", "{", "key", BCON_BIN (0, (uint8_t *) LOCAL_MASTERKEY, 96), "}");
if (!kms_providers) {
kms_providers = bson_new ();
}
bson_concat (kms_providers, local);
bson_destroy (local);
return kms_providers;
}
static bson_t *
_make_kmip_kms_provider (bson_t *kms_providers)
{
if (!kms_providers) {
kms_providers = bson_new ();
}
bson_concat (kms_providers, tmp_bson ("{ 'kmip': { 'endpoint': 'localhost:5698' } }"));
return kms_providers;
}
/* Convenience helper for creating KMS providers doc */
static bson_t *
_make_kms_providers (bool with_aws, bool with_local)
{
bson_t *kms_providers = bson_new ();
if (with_aws) {
_make_aws_kms_provider (kms_providers);
_make_azure_kms_provider (kms_providers);
_make_gcp_kms_provider (kms_providers);
_make_kmip_kms_provider (kms_providers);
}
if (with_local) {
_make_local_kms_provider (kms_providers);
}
return kms_providers;
}
static bson_t *
_make_tls_opts (void)
{
bson_t *tls_opts = bson_new ();
char *kmip_tls_ca_file;
char *kmip_tls_certificate_key_file;
kmip_tls_ca_file = test_framework_getenv_required ("MONGOC_TEST_CSFLE_TLS_CA_FILE");
kmip_tls_certificate_key_file = test_framework_getenv_required ("MONGOC_TEST_CSFLE_TLS_CERTIFICATE_KEY_FILE");
bson_concat (tls_opts,
tmp_bson ("{ 'kmip': { 'tlsCAFile': '%s', 'tlsCertificateKeyFile': '%s' } }",
kmip_tls_ca_file,
kmip_tls_certificate_key_file));
bson_free (kmip_tls_ca_file);
bson_free (kmip_tls_certificate_key_file);
return tls_opts;
}
static bson_t *
_make_kms_masterkey (char const *provider)
{
if (strcmp (provider, "aws") == 0) {
return BCON_NEW ("region",
"us-east-1",
"key",
"arn:aws:kms:us-east-1:579766882180:key/"
"89fcc2c4-08b0-4bd9-9f25-e30687b580d0");
}
if (strcmp (provider, "azure") == 0) {
return BCON_NEW ("keyVaultEndpoint", "key-vault-csfle.vault.azure.net", "keyName", "key-name-csfle");
}
if (strcmp (provider, "gcp") == 0) {
return BCON_NEW ("projectId",
"devprod-drivers",
"location",
"global",
"keyRing",
"key-ring-csfle",
"keyName",
"key-name-csfle");
}
if (strcmp (provider, "kmip") == 0) {
return bson_new ();
}
if (strcmp (provider, "local") == 0) {
return bson_new ();
}
return NULL;
}
typedef struct {
int num_inserts;
} limits_apm_ctx_t;
static void
_command_started (const mongoc_apm_command_started_t *event)
{
limits_apm_ctx_t *ctx;
ctx = (limits_apm_ctx_t *) mongoc_apm_command_started_get_context (event);
if (0 == strcmp ("insert", mongoc_apm_command_started_get_command_name (event))) {
ctx->num_inserts++;
}
}
/* Prose Test 4: BSON Size Limits and Batch Splitting */
static void
test_bson_size_limits_and_batch_splitting (void *unused)
{
/* Expect an insert of two documents over 2MiB to split into two inserts but
* still succeed. */
mongoc_client_t *client;
mongoc_auto_encryption_opts_t *opts;
mongoc_uri_t *uri;
mongoc_collection_t *coll;
bson_error_t error;
bson_t *corpus_schema;
bson_t *datakey;
bson_t *cmd;
bson_t *kms_providers;
bson_t *docs[2];
char *as;
limits_apm_ctx_t ctx = {0};
mongoc_apm_callbacks_t *callbacks;
/* Values from the spec to test boundaries. */
const int size_16mib = 16777216;
const int size_2mib = 2097152;
const int exceeds_2mib_after_encryption = size_2mib - 2000;
const int exceeds_16mib_after_encryption = size_16mib - 2000;
BSON_UNUSED (unused);
/* Do the test setup. */
/* Drop and create db.coll configured with limits-schema.json */
uri = test_framework_get_uri ();
client = test_framework_client_new_from_uri (uri, NULL);
test_framework_set_ssl_opts (client);
mongoc_client_set_error_api (client, MONGOC_ERROR_API_VERSION_2);
coll = mongoc_client_get_collection (client, "db", "coll");
(void) mongoc_collection_drop (coll, NULL);
corpus_schema = get_bson_from_json_file ("./src/libmongoc/tests/client_side_encryption_prose/limits-schema.json");
cmd = BCON_NEW ("create", "coll", "validator", "{", "$jsonSchema", BCON_DOCUMENT (corpus_schema), "}");
ASSERT_OR_PRINT (mongoc_client_command_simple (client, "db", cmd, NULL /* read prefs */, NULL /* reply */, &error),
error);
mongoc_collection_destroy (coll);
/* Drop and create the key vault collection, keyvault.datakeys. */
{
mongoc_write_concern_t *wc;
coll = mongoc_client_get_collection (client, "keyvault", "datakeys");
(void) mongoc_collection_drop (coll, NULL);
datakey = get_bson_from_json_file ("./src/libmongoc/tests/client_side_encryption_prose/limits-key.json");
wc = mongoc_write_concern_new ();
mongoc_write_concern_set_wmajority (wc, 1000);
mongoc_collection_set_write_concern (coll, wc);
ASSERT_OR_PRINT (mongoc_collection_insert_one (coll, datakey, NULL /* opts */, NULL /* reply */, &error), error);
mongoc_write_concern_destroy (wc);
mongoc_collection_destroy (coll);
}
mongoc_client_destroy (client);
client = test_framework_client_new_from_uri (uri, NULL);
test_framework_set_ssl_opts (client);
mongoc_client_set_error_api (client, MONGOC_ERROR_API_VERSION_2);
kms_providers = _make_kms_providers (false /* aws */, true /* local */);
opts = mongoc_auto_encryption_opts_new ();
_check_bypass (opts);
mongoc_auto_encryption_opts_set_keyvault_namespace (opts, "keyvault", "datakeys");
mongoc_auto_encryption_opts_set_kms_providers (opts, kms_providers);
ASSERT_OR_PRINT (mongoc_client_enable_auto_encryption (client, opts, &error), error);
callbacks = mongoc_apm_callbacks_new ();
mongoc_apm_set_command_started_cb (callbacks, _command_started);
mongoc_client_set_apm_callbacks (client, callbacks, &ctx);
coll = mongoc_client_get_collection (client, "db", "coll");
/* End of setup */
/* Insert { "_id": "over_2mib_under_16mib", "unencrypted": <the string "a"
* repeated 2097152 times> } */
docs[0] = BCON_NEW ("_id", "over_2mib_under_16mib");
as = bson_malloc (size_16mib);
memset (as, 'a', size_16mib);
bson_append_utf8 (docs[0], "unencrypted", -1, as, 2097152);
ASSERT_OR_PRINT (mongoc_collection_insert_one (coll, docs[0], NULL /* opts */, NULL /* reply */, &error), error);
bson_destroy (docs[0]);
/* Insert the document `limits/limits-doc.json <../limits/limits-doc.json>`_
* concatenated with ``{ "_id": "encryption_exceeds_2mib", "unencrypted": <
* the string "a" repeated (2097152 - 2000) times > }`` */
docs[0] = get_bson_from_json_file ("./src/libmongoc/tests/client_side_encryption_prose/limits-doc.json");
bson_append_utf8 (docs[0], "_id", -1, "encryption_exceeds_2mib", -1);
bson_append_utf8 (docs[0], "unencrypted", -1, as, exceeds_2mib_after_encryption);
ASSERT_OR_PRINT (mongoc_collection_insert_one (coll, docs[0], NULL /* opts */, NULL /* reply */, &error), error);
bson_destroy (docs[0]);
/* Insert two documents that each exceed 2MiB but no encryption occurs.
* Expect the bulk write to succeed and run as two separate inserts.
*/
docs[0] = BCON_NEW ("_id", "over_2mib_1");
bson_append_utf8 (docs[0], "unencrypted", -1, as, size_2mib);
docs[1] = BCON_NEW ("_id", "over_2mib_2");
bson_append_utf8 (docs[1], "unencrypted", -1, as, size_2mib);
ctx.num_inserts = 0;
ASSERT_OR_PRINT (
mongoc_collection_insert_many (coll, (const bson_t **) docs, 2, NULL /* opts */, NULL /* reply */, &error),
error);
ASSERT_CMPINT (ctx.num_inserts, ==, 2);
bson_destroy (docs[0]);
bson_destroy (docs[1]);
/* Insert two documents that each exceed 2MiB after encryption occurs. Expect
* the bulk write to succeed and run as two separate inserts.
*/
docs[0] = get_bson_from_json_file ("./src/libmongoc/tests/client_side_encryption_prose/limits-doc.json");
bson_append_utf8 (docs[0], "_id", -1, "encryption_exceeds_2mib_1", -1);
bson_append_utf8 (docs[0], "unencrypted", -1, as, exceeds_2mib_after_encryption);
docs[1] = get_bson_from_json_file ("./src/libmongoc/tests/client_side_encryption_prose/limits-doc.json");
bson_append_utf8 (docs[1], "_id", -1, "encryption_exceeds_2mib_2", -1);
bson_append_utf8 (docs[1], "unencrypted", -1, as, exceeds_2mib_after_encryption);
ctx.num_inserts = 0;
ASSERT_OR_PRINT (
mongoc_collection_insert_many (coll, (const bson_t **) docs, 2, NULL /* opts */, NULL /* reply */, &error),
error);
ASSERT_CMPINT (ctx.num_inserts, ==, 2);
bson_destroy (docs[0]);
bson_destroy (docs[1]);
/* Check that inserting close to, but not exceeding, 16MiB, passes */
docs[0] = bson_new ();
bson_append_utf8 (docs[0], "_id", -1, "under_16mib", -1);
bson_append_utf8 (docs[0], "unencrypted", -1, as, exceeds_16mib_after_encryption);
ASSERT_OR_PRINT (mongoc_collection_insert_one (coll, docs[0], NULL /* opts */, NULL /* reply */, &error), error);
bson_destroy (docs[0]);
/* but.. exceeding 16 MiB fails */
docs[0] = get_bson_from_json_file ("./src/libmongoc/tests/client_side_encryption_prose/limits-doc.json");
bson_append_utf8 (docs[0], "_id", -1, "under_16mib", -1);
bson_append_utf8 (docs[0], "unencrypted", -1, as, exceeds_16mib_after_encryption);
BSON_ASSERT (!mongoc_collection_insert_one (coll, docs[0], NULL /* opts */, NULL /* reply */, &error));
ASSERT_ERROR_CONTAINS (error, MONGOC_ERROR_SERVER, 2, "too large");
bson_destroy (docs[0]);
bson_free (as);
bson_destroy (kms_providers);
bson_destroy (corpus_schema);
bson_destroy (cmd);
bson_destroy (datakey);
mongoc_collection_destroy (coll);
mongoc_client_destroy (client);
mongoc_uri_destroy (uri);
mongoc_apm_callbacks_destroy (callbacks);
mongoc_auto_encryption_opts_destroy (opts);
}
typedef struct {
bson_t *last_cmd;
} _datakey_and_double_encryption_ctx_t;
static void
_datakey_and_double_encryption_command_started (const mongoc_apm_command_started_t *event)
{
_datakey_and_double_encryption_ctx_t *ctx;
ctx = (_datakey_and_double_encryption_ctx_t *) mongoc_apm_command_started_get_context (event);
bson_destroy (ctx->last_cmd);
ctx->last_cmd = bson_copy (mongoc_apm_command_started_get_command (event));
}
static void
test_datakey_and_double_encryption_creating_and_using (mongoc_client_encryption_t *client_encryption,
mongoc_client_t *client,
mongoc_client_t *client_encrypted,
const char *kms_provider,
_datakey_and_double_encryption_ctx_t *test_ctx)
{
bson_value_t keyid;
bson_error_t error;
bool ret;
mongoc_client_encryption_datakey_opts_t *opts;
mongoc_client_encryption_encrypt_opts_t *encrypt_opts;
char *altname;
mongoc_collection_t *coll;
mongoc_cursor_t *cursor;
bson_t filter;
const bson_t *doc;
bson_value_t to_encrypt;
bson_value_t encrypted;
bson_value_t encrypted_via_altname;
bson_t to_insert = BSON_INITIALIZER;
char *hello;
opts = mongoc_client_encryption_datakey_opts_new ();
if (0 == strcmp (kms_provider, "aws")) {
mongoc_client_encryption_datakey_opts_set_masterkey (opts,
tmp_bson ("{ 'region': 'us-east-1', 'key': "
"'arn:aws:kms:us-east-1:579766882180:key/"
"89fcc2c4-08b0-4bd9-9f25-e30687b580d0' }"));
} else if (0 == strcmp (kms_provider, "azure")) {
mongoc_client_encryption_datakey_opts_set_masterkey (
opts,
tmp_bson ("{'keyVaultEndpoint': 'key-vault-csfle.vault.azure.net', "
"'keyName': 'key-name-csfle'}"));
} else if (0 == strcmp (kms_provider, "gcp")) {
mongoc_client_encryption_datakey_opts_set_masterkey (opts,
tmp_bson ("{'projectId': 'devprod-drivers','location': "
"'global','keyRing': 'key-ring-csfle','keyName': "
"'key-name-csfle'}"));
} else if (0 == strcmp (kms_provider, "kmip")) {
mongoc_client_encryption_datakey_opts_set_masterkey (opts, tmp_bson ("{}"));
}
altname = bson_strdup_printf ("%s_altname", kms_provider);
mongoc_client_encryption_datakey_opts_set_keyaltnames (opts, &altname, 1);
ret = mongoc_client_encryption_create_datakey (client_encryption, kms_provider, opts, &keyid, &error);
ASSERT_OR_PRINT (ret, error);
/* Expect a BSON binary with subtype 4 to be returned */
BSON_ASSERT (keyid.value_type == BSON_TYPE_BINARY);
BSON_ASSERT (keyid.value.v_binary.subtype == BSON_SUBTYPE_UUID);
/* Check that client captured a command_started event for the insert command
* containing a majority writeConcern. */
assert_match_bson (
test_ctx->last_cmd, tmp_bson ("{'insert': 'datakeys', 'writeConcern': { 'w': 'majority' } }"), false);
/* Use client to run a find on keyvault.datakeys */
coll = mongoc_client_get_collection (client, "keyvault", "datakeys");
bson_init (&filter);
BSON_APPEND_VALUE (&filter, "_id", &keyid);
cursor = mongoc_collection_find_with_opts (coll, &filter, NULL /* opts */, NULL /* read prefs */);
mongoc_collection_destroy (coll);
/* Expect that exactly one document is returned with the "masterKey.provider"
* equal to <kms_provider> */
BSON_ASSERT (mongoc_cursor_next (cursor, &doc));
BSON_ASSERT (0 == strcmp (kms_provider, bson_lookup_utf8 (doc, "masterKey.provider")));
BSON_ASSERT (!mongoc_cursor_next (cursor, &doc));
ASSERT_OR_PRINT (!mongoc_cursor_error (cursor, &error), error);
mongoc_cursor_destroy (cursor);
/* Call client_encryption.encrypt() with the value "hello <kms provider>" */
encrypt_opts = mongoc_client_encryption_encrypt_opts_new ();
mongoc_client_encryption_encrypt_opts_set_algorithm (encrypt_opts,
MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC);
mongoc_client_encryption_encrypt_opts_set_keyid (encrypt_opts, &keyid);
hello = bson_strdup_printf ("hello %s", kms_provider);
{
to_encrypt.value_type = BSON_TYPE_UTF8;
to_encrypt.value.v_utf8.str = bson_strdup (hello);
const size_t len = strlen (to_encrypt.value.v_utf8.str);
ASSERT (bson_in_range_unsigned (uint32_t, len));
to_encrypt.value.v_utf8.len = (uint32_t) len;
}
ret = mongoc_client_encryption_encrypt (client_encryption, &to_encrypt, encrypt_opts, &encrypted, &error);
ASSERT_OR_PRINT (ret, error);
mongoc_client_encryption_encrypt_opts_destroy (encrypt_opts);
/* Expect the return value to be a BSON binary subtype 6 */
BSON_ASSERT (encrypted.value_type == BSON_TYPE_BINARY);
BSON_ASSERT (encrypted.value.v_binary.subtype == BSON_SUBTYPE_ENCRYPTED);
/* Use client_encrypted to insert { _id: "<kms provider>", "value":
* <encrypted> } into db.coll */
coll = mongoc_client_get_collection (client_encrypted, "db", "coll");
BSON_APPEND_UTF8 (&to_insert, "_id", kms_provider);
BSON_APPEND_VALUE (&to_insert, "value", &encrypted);
ret = mongoc_collection_insert_one (coll, &to_insert, NULL /* opts */, NULL /* reply */, &error);
ASSERT_OR_PRINT (ret, error);
/* Use client_encrypted to run a find querying with _id of <kms_provider> and
* expect value to be "hello <kms_provider>". */
cursor = mongoc_collection_find_with_opts (
coll, tmp_bson ("{ '_id': '%s' }", kms_provider), NULL /* opts */, NULL /* read prefs */);
BSON_ASSERT (mongoc_cursor_next (cursor, &doc));
BSON_ASSERT (0 == strcmp (hello, bson_lookup_utf8 (doc, "value")));
BSON_ASSERT (!mongoc_cursor_next (cursor, &doc));
ASSERT_OR_PRINT (!mongoc_cursor_error (cursor, &error), error);
mongoc_cursor_destroy (cursor);
mongoc_collection_destroy (coll);
/* Call client_encryption.encrypt() with the value "hello <kms provider>",
* the algorithm AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic, and the
* key_alt_name of <kms provider>_altname. */
encrypt_opts = mongoc_client_encryption_encrypt_opts_new ();
mongoc_client_encryption_encrypt_opts_set_algorithm (encrypt_opts,
MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC);
mongoc_client_encryption_encrypt_opts_set_keyaltname (encrypt_opts, altname);
ret =
mongoc_client_encryption_encrypt (client_encryption, &to_encrypt, encrypt_opts, &encrypted_via_altname, &error);
ASSERT_OR_PRINT (ret, error);
mongoc_client_encryption_encrypt_opts_destroy (encrypt_opts);
/* Expect the return value to be a BSON binary subtype 6. Expect the value to
* exactly match the value of encrypted. */
BSON_ASSERT (encrypted_via_altname.value_type == BSON_TYPE_BINARY);
BSON_ASSERT (encrypted_via_altname.value.v_binary.subtype == BSON_SUBTYPE_ENCRYPTED);
BSON_ASSERT (encrypted_via_altname.value.v_binary.data_len == encrypted.value.v_binary.data_len);
BSON_ASSERT (0 == memcmp (encrypted_via_altname.value.v_binary.data,
encrypted.value.v_binary.data,
encrypted.value.v_binary.data_len));
bson_value_destroy (&encrypted);
bson_value_destroy (&encrypted_via_altname);
bson_free (hello);
bson_destroy (&to_insert);
bson_value_destroy (&to_encrypt);
bson_value_destroy (&keyid);
bson_free (altname);
bson_destroy (&filter);
mongoc_client_encryption_datakey_opts_destroy (opts);
}
/* Prose Test 1: Custom Key Material Test */
static void
test_create_datakey_with_custom_key_material (void *unused)
{
mongoc_client_t *client = NULL;
mongoc_client_encryption_t *client_encryption = NULL;
bson_error_t error;
bson_t datakey = BSON_INITIALIZER;
BSON_UNUSED (unused);
/* Create a MongoClient object (referred to as client). */
client = test_framework_new_default_client ();
/* Using client, drop the collection keyvault.datakeys. */
{
mongoc_collection_t *const datakeys = mongoc_client_get_collection (client, "keyvault", "datakeys");
(void) mongoc_collection_drop (datakeys, NULL);
mongoc_collection_destroy (datakeys);
}
/* Create a ClientEncryption object (referred to as client_encryption) with
* client set as the keyVaultClient. */
{
mongoc_client_encryption_opts_t *const client_encryption_opts = mongoc_client_encryption_opts_new ();
bson_t *const kms_providers = _make_kms_providers (true /* aws */, true /* local */);
bson_t *const tls_opts = _make_tls_opts ();
mongoc_client_encryption_opts_set_kms_providers (client_encryption_opts, kms_providers);
mongoc_client_encryption_opts_set_tls_opts (client_encryption_opts, tls_opts);
mongoc_client_encryption_opts_set_keyvault_namespace (client_encryption_opts, "keyvault", "datakeys");
mongoc_client_encryption_opts_set_keyvault_client (client_encryption_opts, client);
client_encryption = mongoc_client_encryption_new (client_encryption_opts, &error);
ASSERT_OR_PRINT (client_encryption, error);
mongoc_client_encryption_opts_destroy (client_encryption_opts);
bson_destroy (kms_providers);
bson_destroy (tls_opts);
}
/* Using client_encryption, create a data key with a local KMS provider and
* the following custom key material: */
{
const char key_material[] = "xPTAjBRG5JiPm+d3fj6XLi2q5DMXUS/"
"f1f+SMAlhhwkhDRL0kr8r9GDLIGTAGlvC+HVjSIgdL+"
"RKwZCvpXSyxTICWSXTUYsWYPyu3IoHbuBZdmw2faM3WhcRIgbMReU5";
uint8_t data[96];
mongoc_client_encryption_datakey_opts_t *datakey_opts = mongoc_client_encryption_datakey_opts_new ();
bson_value_t keyid;
BSON_ASSERT (mcommon_b64_pton (key_material, data, sizeof (key_material)) == 96);
mongoc_client_encryption_datakey_opts_set_keymaterial (datakey_opts, data, sizeof (data));
ASSERT_OR_PRINT (
mongoc_client_encryption_create_datakey (client_encryption, "local", datakey_opts, &keyid, &error), error);
ASSERT (keyid.value_type == BSON_TYPE_BINARY);
ASSERT (keyid.value.v_binary.subtype == BSON_SUBTYPE_UUID);
ASSERT (keyid.value.v_binary.data_len != 0);
mongoc_client_encryption_datakey_opts_destroy (datakey_opts);
bson_value_destroy (&keyid);
}
/* Find the resulting key document in keyvault.datakeys, save a copy of the
* key document, then remove the key document from the collection. */
{
mongoc_collection_t *const datakeys = mongoc_client_get_collection (client, "keyvault", "datakeys");
mongoc_cursor_t *cursor =
mongoc_collection_find_with_opts (datakeys, tmp_bson ("{}"), NULL /* opts */, NULL /* read prefs */);
const bson_t *bson;
ASSERT (mongoc_cursor_next (cursor, &bson));
bson_copy_to (bson, &datakey);
mongoc_cursor_destroy (cursor);
(void) mongoc_collection_drop (datakeys, &error);
mongoc_collection_destroy (datakeys);
}
/* Replace the _id field in the copied key document with a UUID with base64
* value AAAAAAAAAAAAAAAAAAAAAA== (16 bytes all equal to 0x00) and insert the
* modified key document into keyvault.datakeys with majority write concern.
*/
{
mongoc_collection_t *const datakeys = mongoc_client_get_collection (client, "keyvault", "datakeys");
bson_t modified_datakey = BSON_INITIALIZER;
uint8_t bytes[16] = {0};
mongoc_write_concern_t *const wc = mongoc_write_concern_new ();
bson_t opts = BSON_INITIALIZER;
bson_copy_to_excluding_noinit (&datakey, &modified_datakey, "_id", NULL);
BSON_ASSERT (BSON_APPEND_BINARY (&modified_datakey, "_id", BSON_SUBTYPE_UUID, bytes, sizeof (bytes)));
mongoc_write_concern_set_w (wc, MONGOC_WRITE_CONCERN_W_MAJORITY);
mongoc_write_concern_append (wc, &opts);
ASSERT_OR_PRINT (mongoc_collection_insert_one (datakeys, &modified_datakey, &opts, NULL, &error), error);
mongoc_collection_destroy (datakeys);
bson_destroy (&modified_datakey);
mongoc_write_concern_destroy (wc);
bson_destroy (&opts);
}
/* Using client_encryption, encrypt the string "test" with the modified data
* key using the AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic algorithm and
* assert the resulting value is equal to the following (given as base64): */
{
const char expected[] = "AQAAAAAAAAAAAAAAAAAAAAACz0ZOLuuhEYi807ZXTdhbqhLaS2/"
"t9wLifJnnNYwiw79d75QYIZ6M/aYC1h9nCzCjZ7pGUpAuNnkUhnIXM3PjrA==";
mongoc_client_encryption_encrypt_opts_t *const encrypt_opts = mongoc_client_encryption_encrypt_opts_new ();
bson_value_t keyid = {0};
bson_value_t to_encrypt = {0};
bson_value_t ciphertext = {0};
keyid.value_type = BSON_TYPE_BINARY;
keyid.value.v_binary.subtype = BSON_SUBTYPE_UUID;
keyid.value.v_binary.data = bson_malloc0 (16);
keyid.value.v_binary.data_len = 16u;
to_encrypt.value_type = BSON_TYPE_UTF8;
to_encrypt.value.v_utf8.str = bson_strdup ("test");
to_encrypt.value.v_utf8.len = 4u;
mongoc_client_encryption_encrypt_opts_set_keyid (encrypt_opts, &keyid);
mongoc_client_encryption_encrypt_opts_set_algorithm (encrypt_opts,
MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC);
ASSERT_OR_PRINT (
mongoc_client_encryption_encrypt (client_encryption, &to_encrypt, encrypt_opts, &ciphertext, &error), error);
{
char actual[256];
/* Need room for null terminator. */
ASSERT (mcommon_b64_ntop (
ciphertext.value.v_binary.data, ciphertext.value.v_binary.data_len, actual, sizeof (actual)) < 255);
ASSERT_CMPSTR (expected, actual);
}
bson_value_destroy (&keyid);
bson_value_destroy (&ciphertext);
bson_value_destroy (&to_encrypt);
mongoc_client_encryption_encrypt_opts_destroy (encrypt_opts);
}
mongoc_client_destroy (client);
mongoc_client_encryption_destroy (client_encryption);
bson_destroy (&datakey);
}
/* Prose Test 2: Data Key and Double Encryption */
static void
test_datakey_and_double_encryption (void *unused)
{
mongoc_client_t *client;
mongoc_client_t *client_encrypted;
mongoc_client_encryption_t *client_encryption;
mongoc_apm_callbacks_t *callbacks;
mongoc_collection_t *coll;
bson_error_t error;
bson_t *kms_providers;
bson_t *tls_opts;
mongoc_auto_encryption_opts_t *auto_encryption_opts;
mongoc_client_encryption_opts_t *client_encryption_opts;
bson_t *schema_map;
bool ret;
_datakey_and_double_encryption_ctx_t test_ctx = {0};
BSON_UNUSED (unused);
/* Test setup */
/* Create a MongoClient without encryption enabled (referred to as client).
* Enable command monitoring to listen for command_started events. */
client = test_framework_new_default_client ();
callbacks = mongoc_apm_callbacks_new ();
mongoc_apm_set_command_started_cb (callbacks, _datakey_and_double_encryption_command_started);
mongoc_client_set_apm_callbacks (client, callbacks, &test_ctx);
/* Using client, drop the collections keyvault.datakeys and db.coll. */
coll = mongoc_client_get_collection (client, "keyvault", "datakeys");
(void) mongoc_collection_drop (coll, NULL);
mongoc_collection_destroy (coll);
coll = mongoc_client_get_collection (client, "db", "coll");
(void) mongoc_collection_drop (coll, NULL);
mongoc_collection_destroy (coll);
/* Create a MongoClient configured with auto encryption (referred to as
* client_encrypted) */
auto_encryption_opts = mongoc_auto_encryption_opts_new ();
kms_providers = _make_kms_providers (true /* aws */, true /* local */);
tls_opts = _make_tls_opts ();
_check_bypass (auto_encryption_opts);
mongoc_auto_encryption_opts_set_kms_providers (auto_encryption_opts, kms_providers);
mongoc_auto_encryption_opts_set_tls_opts (auto_encryption_opts, tls_opts);
mongoc_auto_encryption_opts_set_keyvault_namespace (auto_encryption_opts, "keyvault", "datakeys");
schema_map = get_bson_from_json_file ("./src/libmongoc/tests/client_side_encryption_prose/"
"datakey-and-double-encryption-schemamap.json");
mongoc_auto_encryption_opts_set_schema_map (auto_encryption_opts, schema_map);
client_encrypted = test_framework_new_default_client ();
ret = mongoc_client_enable_auto_encryption (client_encrypted, auto_encryption_opts, &error);
ASSERT_OR_PRINT (ret, error);
/* Create a ClientEncryption object (referred to as client_encryption) */
client_encryption_opts = mongoc_client_encryption_opts_new ();
mongoc_client_encryption_opts_set_kms_providers (client_encryption_opts, kms_providers);
mongoc_client_encryption_opts_set_tls_opts (client_encryption_opts, tls_opts);
mongoc_client_encryption_opts_set_keyvault_namespace (client_encryption_opts, "keyvault", "datakeys");
mongoc_client_encryption_opts_set_keyvault_client (client_encryption_opts, client);
client_encryption = mongoc_client_encryption_new (client_encryption_opts, &error);
ASSERT_OR_PRINT (client_encryption, error);
test_datakey_and_double_encryption_creating_and_using (
client_encryption, client, client_encrypted, "local", &test_ctx);
test_datakey_and_double_encryption_creating_and_using (
client_encryption, client, client_encrypted, "aws", &test_ctx);
test_datakey_and_double_encryption_creating_and_using (
client_encryption, client, client_encrypted, "azure", &test_ctx);
test_datakey_and_double_encryption_creating_and_using (
client_encryption, client, client_encrypted, "gcp", &test_ctx);
test_datakey_and_double_encryption_creating_and_using (
client_encryption, client, client_encrypted, "kmip", &test_ctx);
bson_destroy (kms_providers);
bson_destroy (tls_opts);
bson_destroy (schema_map);
mongoc_client_encryption_opts_destroy (client_encryption_opts);
mongoc_auto_encryption_opts_destroy (auto_encryption_opts);
mongoc_apm_callbacks_destroy (callbacks);
mongoc_client_destroy (client);
mongoc_client_destroy (client_encrypted);
mongoc_client_encryption_destroy (client_encryption);
bson_destroy (test_ctx.last_cmd);
}
static void
_test_key_vault (bool with_external_key_vault)
{
mongoc_client_t *client;
mongoc_client_t *client_encrypted;
mongoc_client_t *client_external;
mongoc_client_encryption_t *client_encryption;
mongoc_uri_t *external_uri;
mongoc_collection_t *coll;
bson_t *datakey;
bson_t *kms_providers;
bson_error_t error;
mongoc_write_concern_t *wc;
bson_t *schema;
bson_t *schema_map;
mongoc_auto_encryption_opts_t *auto_encryption_opts;
mongoc_client_encryption_opts_t *client_encryption_opts;
mongoc_client_encryption_encrypt_opts_t *encrypt_opts;
bool res;
const bson_value_t *keyid;
bson_value_t value;
bson_value_t ciphertext;
bson_iter_t iter;
external_uri = test_framework_get_uri ();
mongoc_uri_set_username (external_uri, "fake-user");
mongoc_uri_set_password (external_uri, "fake-pwd");
client_external = test_framework_client_new_from_uri (external_uri, NULL);
test_framework_set_ssl_opts (client_external);
/* Using client, drop the collections keyvault.datakeys and db.coll. */
client = test_framework_new_default_client ();
coll = mongoc_client_get_collection (client, "db", "coll");
(void) mongoc_collection_drop (coll, NULL);
mongoc_collection_destroy (coll);
coll = mongoc_client_get_collection (client, "keyvault", "datakeys");
(void) mongoc_collection_drop (coll, NULL);
/* Insert the document external-key.json into ``keyvault.datakeys``. */
wc = mongoc_write_concern_new ();
mongoc_write_concern_set_wmajority (wc, 1000);
mongoc_collection_set_write_concern (coll, wc);
datakey = get_bson_from_json_file ("./src/libmongoc/tests/"
"client_side_encryption_prose/external/"
"external-key.json");
ASSERT_OR_PRINT (mongoc_collection_insert_one (coll, datakey, NULL, NULL, &error), error);
mongoc_collection_destroy (coll);
/* Create a MongoClient configured with auto encryption. */
client_encrypted = test_framework_new_default_client ();
mongoc_client_set_error_api (client_encrypted, MONGOC_ERROR_API_VERSION_2);
auto_encryption_opts = mongoc_auto_encryption_opts_new ();
_check_bypass (auto_encryption_opts);
schema = get_bson_from_json_file ("./src/libmongoc/tests/"
"client_side_encryption_prose/external/"
"external-schema.json");
schema_map = BCON_NEW ("db.coll", BCON_DOCUMENT (schema));
kms_providers = _make_kms_providers (false /* aws */, true /* local */);
mongoc_auto_encryption_opts_set_kms_providers (auto_encryption_opts, kms_providers);
mongoc_auto_encryption_opts_set_keyvault_namespace (auto_encryption_opts, "keyvault", "datakeys");
mongoc_auto_encryption_opts_set_schema_map (auto_encryption_opts, schema_map);
if (with_external_key_vault) {
mongoc_auto_encryption_opts_set_keyvault_client (auto_encryption_opts, client_external);
}
ASSERT_OR_PRINT (mongoc_client_enable_auto_encryption (client_encrypted, auto_encryption_opts, &error), error);
/* Create a ClientEncryption object. */
client_encryption_opts = mongoc_client_encryption_opts_new ();
mongoc_client_encryption_opts_set_kms_providers (client_encryption_opts, kms_providers);
mongoc_client_encryption_opts_set_keyvault_namespace (client_encryption_opts, "keyvault", "datakeys");
if (with_external_key_vault) {
mongoc_client_encryption_opts_set_keyvault_client (client_encryption_opts, client_external);
} else {
mongoc_client_encryption_opts_set_keyvault_client (client_encryption_opts, client);
}
client_encryption = mongoc_client_encryption_new (client_encryption_opts, &error);
ASSERT_OR_PRINT (client_encryption, error);
/* Use client_encrypted to insert the document {"encrypted": "test"} into
* db.coll. */
coll = mongoc_client_get_collection (client_encrypted, "db", "coll");
res = mongoc_collection_insert_one (coll, tmp_bson ("{'encrypted': 'test'}"), NULL, NULL, &error);
if (with_external_key_vault) {
BSON_ASSERT (!res);
ASSERT_ERROR_CONTAINS (error, MONGOC_ERROR_CLIENT, MONGOC_ERROR_CLIENT_AUTHENTICATE, "Authentication failed");
} else {
ASSERT_OR_PRINT (res, error);
}
/* Use client_encryption to explicitly encrypt the string "test" with key ID
* ``LOCALAAAAAAAAAAAAAAAAA==`` and deterministic algorithm. */
encrypt_opts = mongoc_client_encryption_encrypt_opts_new ();
mongoc_client_encryption_encrypt_opts_set_algorithm (encrypt_opts,
MONGOC_AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC);
BSON_ASSERT (bson_iter_init_find (&iter, datakey, "_id"));