File: auto_encryption_spec.rb

package info (click to toggle)
ruby-mongo 2.23.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 15,020 kB
  • sloc: ruby: 110,810; makefile: 5
file content (754 lines) | stat: -rw-r--r-- 23,825 bytes parent folder | download
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
# frozen_string_literal: true
# rubocop:todo all

require 'spec_helper'
require 'bson'
require 'json'

describe 'Auto Encryption' do
  require_libmongocrypt
  min_server_fcv '4.2'
  require_enterprise

  # Diagnostics of leaked background threads only, these tests do not
  # actually require a clean slate. https://jira.mongodb.org/browse/RUBY-2138
  clean_slate

  include_context 'define shared FLE helpers'

  let(:encryption_client) do
    new_local_client(
      SpecConfig.instance.addresses,
      SpecConfig.instance.test_options.merge(
        auto_encryption_options: {
          kms_providers: kms_providers,
          kms_tls_options: kms_tls_options,
          key_vault_namespace: key_vault_namespace,
          schema_map: local_schema,
          bypass_auto_encryption: bypass_auto_encryption,
          # Spawn mongocryptd on non-default port for sharded cluster tests
          extra_options: extra_options,
        },
        database: 'auto_encryption',
        max_pool_size: max_pool_size,
        timeout_ms: timeout_ms
      ),
    )
  end

  let(:client) { authorized_client.use('auto_encryption') }

  let(:bypass_auto_encryption) { false }

  let(:max_pool_size) do
    Mongo::Server::ConnectionPool::DEFAULT_MAX_SIZE
  end

  let(:encrypted_ssn_binary) do
    BSON::Binary.new(Base64.decode64(encrypted_ssn), :ciphertext)
  end

  shared_context 'bypass auto encryption' do
    let(:bypass_auto_encryption) { true }
  end

  shared_context 'jsonSchema validator on collection' do
    let(:local_schema) { nil }

    before do
      client['users',
        {
          'validator' => { '$jsonSchema' => schema_map }
        }
      ].create
    end
  end

  shared_context 'schema map in client options' do
    let(:local_schema) { { "auto_encryption.users" => schema_map } }

    before do
      client['users'].create
    end
  end

  shared_context 'encrypted document in collection' do
    before do
      client['users'].insert_one(ssn: encrypted_ssn_binary)
    end
  end

  shared_context 'multiple encrypted documents in collection' do
    before do
      client['users'].insert_one(ssn: encrypted_ssn_binary)
      client['users'].insert_one(ssn: encrypted_ssn_binary)
    end
  end

  shared_context 'limited connection pool' do
    let(:max_pool_size) do
      1
    end
  end

  before(:each) do
    client['users'].drop
    key_vault_collection.drop
    key_vault_collection.insert_one(data_key)
  end

  shared_examples 'an encrypted command' do
    # context 'with AWS KMS provider' do
    #   include_context 'with AWS kms_providers'

    #   context 'with validator' do
    #     include_context 'jsonSchema validator on collection'
    #     it_behaves_like 'it performs an encrypted command'
    #   end

    #   context 'with schema map' do
    #     include_context 'schema map in client options'
    #     it_behaves_like 'it performs an encrypted command'

    #     context 'with limited connection pool' do
    #       include_context 'limited connection pool'
    #       it_behaves_like 'it performs an encrypted command'
    #     end
    #   end
    # end

    # context 'with Azure KMS provider' do
    #   include_context 'with Azure kms_providers'

    #   context 'with validator' do
    #     include_context 'jsonSchema validator on collection'
    #     it_behaves_like 'it performs an encrypted command'
    #   end

    #   context 'with schema map' do
    #     include_context 'schema map in client options'
    #     it_behaves_like 'it performs an encrypted command'

    #     context 'with limited connection pool' do
    #       include_context 'limited connection pool'
    #       it_behaves_like 'it performs an encrypted command'
    #     end
    #   end
    # end

    # context 'with GCP KMS provider' do
    #   include_context 'with GCP kms_providers'

    #   context 'with validator' do
    #     include_context 'jsonSchema validator on collection'
    #     it_behaves_like 'it performs an encrypted command'
    #   end

    #   context 'with schema map' do
    #     include_context 'schema map in client options'
    #     it_behaves_like 'it performs an encrypted command'

    #     context 'with limited connection pool' do
    #       include_context 'limited connection pool'
    #       it_behaves_like 'it performs an encrypted command'
    #     end
    #   end
    # end

    # context 'with KMIP KMS provider' do
    #   include_context 'with KMIP kms_providers'

    #   context 'with validator' do
    #     include_context 'jsonSchema validator on collection'
    #     it_behaves_like 'it performs an encrypted command'
    #   end

    #   context 'with schema map' do
    #     include_context 'schema map in client options'
    #     it_behaves_like 'it performs an encrypted command'

    #     context 'with limited connection pool' do
    #       include_context 'limited connection pool'
    #       it_behaves_like 'it performs an encrypted command'
    #     end
    #   end
    # end

    context 'with local KMS provider' do
      include_context 'with local kms_providers'

      context 'with validator' do
        include_context 'jsonSchema validator on collection'
        it_behaves_like 'it performs an encrypted command'
      end

      context 'with schema map' do
        include_context 'schema map in client options'
        it_behaves_like 'it performs an encrypted command'

        context 'with limited connection pool' do
          include_context 'limited connection pool'
          it_behaves_like 'it performs an encrypted command'
        end
      end
    end
  end

  [nil, 0].each do |timeout_ms|
    context "with timeout_ms #{timeout_ms}" do
      let(:timeout_ms) { timeout_ms }

      describe '#aggregate' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:result) do
            encryption_client['users'].aggregate([
              { '$match' => { 'ssn' => ssn } }
            ]).first
          end

          it 'encrypts the command and decrypts the response' do
            result.should_not be_nil
            result['ssn'].should == ssn
          end

          context 'when bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              result.should be_nil
            end

            it 'does auto decrypt the response' do
              result = encryption_client['users'].aggregate([
                { '$match' => { 'ssn' => encrypted_ssn_binary } }
              ]).first

              result.should_not be_nil
              result['ssn'].should == ssn
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#count' do
        shared_examples 'it performs an encrypted command' do
          include_context 'multiple encrypted documents in collection'

          let(:result) { encryption_client['users'].count(ssn: ssn) }

          it 'encrypts the command and finds the documents' do
            expect(result).to eq(2)
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              expect(result).to eq(0)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#distinct' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:result) { encryption_client['users'].distinct(:ssn) }

          it 'decrypts the SSN field' do
            expect(result.length).to eq(1)
            expect(result).to include(ssn)
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'still decrypts the SSN field' do
              expect(result.length).to eq(1)
              expect(result).to include(ssn)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#delete_one' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:result) { encryption_client['users'].delete_one(ssn: ssn) }

          it 'encrypts the SSN field' do
            expect(result.deleted_count).to eq(1)
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the SSN field' do
              expect(result.deleted_count).to eq(0)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#delete_many' do
        shared_examples 'it performs an encrypted command' do
          include_context 'multiple encrypted documents in collection'

          let(:result) { encryption_client['users'].delete_many(ssn: ssn) }

          it 'decrypts the SSN field' do
            expect(result.deleted_count).to eq(2)
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the SSN field' do
              expect(result.deleted_count).to eq(0)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#find' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:result) { encryption_client['users'].find(ssn: ssn).first }

          it 'encrypts the command and decrypts the response' do
            result.should_not be_nil
            expect(result['ssn']).to eq(ssn)
          end

          context 'when bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              expect(result).to be_nil
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#find_one_and_delete' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:result) { encryption_client['users'].find_one_and_delete(ssn: ssn) }

          it 'encrypts the command and decrypts the response' do
            expect(result['ssn']).to eq(ssn)
          end

          context 'when bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              expect(result).to be_nil
            end

            it 'still decrypts the command' do
              result = encryption_client['users'].find_one_and_delete(ssn: encrypted_ssn_binary)
              expect(result['ssn']).to eq(ssn)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#find_one_and_replace' do
        shared_examples 'it performs an encrypted command' do
          let(:name) { 'Alan Turing' }

          context 'with :return_document => :before' do
            include_context 'encrypted document in collection'

            let(:result) do
              encryption_client['users'].find_one_and_replace(
                { ssn: ssn },
                { name: name },
                return_document: :before
              )
            end

            it 'encrypts the command and decrypts the response, returning original document' do
              expect(result['ssn']).to eq(ssn)

              documents = client['users'].find
              expect(documents.count).to eq(1)
              expect(documents.first['ssn']).to be_nil
            end
          end

          context 'with :return_document => :after' do
            before do
              client['users'].insert_one(name: name)
            end

            let(:result) do
              encryption_client['users'].find_one_and_replace(
                { name: name },
                { ssn: ssn },
                return_document: :after
              )
            end

            it 'encrypts the command and decrypts the response, returning new document' do
              expect(result['ssn']).to eq(ssn)

              documents = client['users'].find
              expect(documents.count).to eq(1)
              expect(documents.first['ssn']).to eq(encrypted_ssn_binary)
            end
          end

          context 'when bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'
            include_context 'encrypted document in collection'

            let(:result) do
              encryption_client['users'].find_one_and_replace(
                { ssn: encrypted_ssn_binary },
                { name: name },
                :return_document => :before
              )
            end

            it 'does not encrypt the command but still decrypts the response, returning original document' do
              expect(result['ssn']).to eq(ssn)

              documents = client['users'].find
              expect(documents.count).to eq(1)
              expect(documents.first['ssn']).to be_nil
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#find_one_and_update' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:name) { 'Alan Turing' }

          let(:result) do
            encryption_client['users'].find_one_and_update(
              { ssn: ssn },
              { name: name }
            )
          end

          it 'encrypts the command and decrypts the response' do
            expect(result['ssn']).to eq(ssn)

            documents = client['users'].find
            expect(documents.count).to eq(1)
            expect(documents.first['ssn']).to be_nil
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              expect(result).to be_nil
            end

            it 'still decrypts the response' do
              # Query using the encrypted ssn value so the find will succeed
              result = encryption_client['users'].find_one_and_update(
                { ssn: encrypted_ssn_binary },
                { name: name }
              )

              expect(result['ssn']).to eq(ssn)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#insert_one' do
        let(:query) { { ssn: ssn } }
        let(:result) { encryption_client['users'].insert_one(query) }

        shared_examples 'it performs an encrypted command' do
          it 'encrypts the ssn field' do
            expect(result).to be_ok
            expect(result.inserted_ids.length).to eq(1)

            id = result.inserted_ids.first

            document = client['users'].find(_id: id).first
            document.should_not be_nil
            expect(document['ssn']).to eq(encrypted_ssn_binary)
          end
        end

        shared_examples 'it obeys bypass_auto_encryption option' do
          include_context 'bypass auto encryption'

          it 'does not encrypt the command' do
            result = encryption_client['users'].insert_one(ssn: ssn)
            expect(result).to be_ok
            expect(result.inserted_ids.length).to eq(1)

            id = result.inserted_ids.first

            document = client['users'].find(_id: id).first
            expect(document['ssn']).to eq(ssn)
          end
        end

        it_behaves_like 'an encrypted command'

        context 'with jsonSchema in schema_map option' do
          include_context 'schema map in client options'

          context 'with AWS KMS provider' do
            include_context 'with AWS kms_providers'
            it_behaves_like 'it obeys bypass_auto_encryption option'
          end

          context 'with Azure KMS provider' do
            include_context 'with Azure kms_providers'
            it_behaves_like 'it obeys bypass_auto_encryption option'
          end

          context 'with GCP KMS provider' do
            include_context 'with GCP kms_providers'
            it_behaves_like 'it obeys bypass_auto_encryption option'
          end

          context 'with KMIP KMS provider' do
            include_context 'with KMIP kms_providers'
            it_behaves_like 'it obeys bypass_auto_encryption option'
          end


          context 'with local KMS provider and ' do
            include_context 'with local kms_providers'
            it_behaves_like 'it obeys bypass_auto_encryption option'
          end
        end

        context 'with schema_map client option pointing to wrong collection' do
          let(:local_schema) { { 'wrong_db.wrong_coll' => schema_map } }

          include_context 'with local kms_providers'

          it 'does not raise an exception but doesn\'t encrypt either' do
            expect do
              result
            end.not_to raise_error

            expect(result).to be_ok
            id = result.inserted_ids.first

            document = client['users'].find(_id: id).first
            document.should_not be_nil
            # Document was not encrypted
            expect(document['ssn']).to eq(ssn)
          end
        end

        context 'encrypting using key alt name' do
          include_context 'schema map in client options'

          let(:query) { { ssn: ssn, altname: key_alt_name } }

          context 'with AWS KMS provider' do
            include_context 'with AWS kms_providers and key alt names'
            it 'encrypts the ssn field' do
              expect(result).to be_ok
              expect(result.inserted_ids.length).to eq(1)

              id = result.inserted_ids.first

              document = client['users'].find(_id: id).first
              document.should_not be_nil
              # Auto-encryption with key alt names only works with random encryption,
              # so it will not generate the same result on every test run.
              expect(document['ssn']).to be_ciphertext
            end
          end

          context 'with Azure KMS provider' do
            include_context 'with Azure kms_providers and key alt names'
            it 'encrypts the ssn field' do
              expect(result).to be_ok
              expect(result.inserted_ids.length).to eq(1)

              id = result.inserted_ids.first

              document = client['users'].find(_id: id).first
              document.should_not be_nil
              # Auto-encryption with key alt names only works with random encryption,
              # so it will not generate the same result on every test run.
              expect(document['ssn']).to be_ciphertext
            end

            context 'with GCP KMS provider' do
              include_context 'with GCP kms_providers and key alt names'
              it 'encrypts the ssn field' do
                expect(result).to be_ok
                expect(result.inserted_ids.length).to eq(1)

                id = result.inserted_ids.first

                document = client['users'].find(_id: id).first
                document.should_not be_nil
                # Auto-encryption with key alt names only works with random encryption,
                # so it will not generate the same result on every test run.
                expect(document['ssn']).to be_ciphertext
              end
            end

            context 'with KMIP KMS provider' do
              include_context 'with KMIP kms_providers and key alt names'
              it 'encrypts the ssn field' do
                expect(result).to be_ok
                expect(result.inserted_ids.length).to eq(1)

                id = result.inserted_ids.first

                document = client['users'].find(_id: id).first
                document.should_not be_nil
                # Auto-encryption with key alt names only works with random encryption,
                # so it will not generate the same result on every test run.
                expect(document['ssn']).to be_ciphertext
              end
            end
          end

          context 'with local KMS provider' do
            include_context 'with local kms_providers and key alt names'
            it 'encrypts the ssn field' do
              expect(result).to be_ok
              expect(result.inserted_ids.length).to eq(1)

              id = result.inserted_ids.first

              document = client['users'].find(_id: id).first
              document.should_not be_nil
              # Auto-encryption with key alt names only works with random encryption,
              # so it will not generate the same result on every test run.
              expect(document['ssn']).to be_a_kind_of(BSON::Binary)
            end
          end
        end
      end

      describe '#replace_one' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:replacement_ssn) { '098-765-4321' }

          let(:result) do
            encryption_client['users'].replace_one(
              { ssn: ssn },
              { ssn: replacement_ssn }
            )
          end

          it 'encrypts the ssn field' do
            expect(result.modified_count).to eq(1)

            find_result = encryption_client['users'].find(ssn: '098-765-4321')
            expect(find_result.count).to eq(1)
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              expect(result.modified_count).to eq(0)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#update_one' do
        shared_examples 'it performs an encrypted command' do
          include_context 'encrypted document in collection'

          let(:result) do
            encryption_client['users'].replace_one({ ssn: ssn }, { ssn: '098-765-4321' })
          end

          it 'encrypts the ssn field' do
            expect(result.n).to eq(1)

            find_result = encryption_client['users'].find(ssn: '098-765-4321')
            expect(find_result.count).to eq(1)
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              expect(result.n).to eq(0)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end

      describe '#update_many' do
        shared_examples 'it performs an encrypted command' do
          before do
            client['users'].insert_one(ssn: encrypted_ssn_binary, age: 25)
            client['users'].insert_one(ssn: encrypted_ssn_binary, age: 43)
          end

          let(:result) do
            encryption_client['users'].update_many({ ssn: ssn }, { "$inc" => { :age =>  1 } })
          end

          it 'encrypts the ssn field' do
            expect(result.n).to eq(2)

            updated_documents = encryption_client['users'].find(ssn: ssn)
            ages = updated_documents.map { |doc| doc['age'] }
            expect(ages).to include(26)
            expect(ages).to include(44)
          end

          context 'with bypass_auto_encryption=true' do
            include_context 'bypass auto encryption'

            it 'does not encrypt the command' do
              expect(result.n).to eq(0)
            end
          end
        end

        it_behaves_like 'an encrypted command'
      end
    end
  end
end