File: automatic_data_encryption_keys_prose_spec.rb

package info (click to toggle)
ruby-mongo 2.21.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 14,764 kB
  • sloc: ruby: 108,806; makefile: 5; sh: 2
file content (153 lines) | stat: -rw-r--r-- 4,098 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
# frozen_string_literal: true

require 'spec_helper'

describe 'Client-Side Encryption' do
  describe 'Automatic Data Encryption Keys' do
    require_libmongocrypt
    require_enterprise
    require_topology :replica_set, :sharded, :load_balanced
    min_server_version '7.0.0-rc0'

    include_context 'define shared FLE helpers'

    let(:test_database_name) do
      'automatic_data_encryption_keys'
    end

    let(:key_vault_client) do
      ClientRegistry.instance.new_local_client(SpecConfig.instance.addresses)
    end

    let(:client_encryption) do
      Mongo::ClientEncryption.new(
        key_vault_client,
        kms_tls_options: kms_tls_options,
        key_vault_namespace: key_vault_namespace,
        kms_providers: {
          local: {
            key: local_master_key
          },
          aws: {
            access_key_id: SpecConfig.instance.fle_aws_key,
            secret_access_key: SpecConfig.instance.fle_aws_secret,
          }
        }
      )
    end

    let(:database) do
      authorized_client.use(test_database_name).database
    end

    before do
      authorized_client.use(key_vault_db)[key_vault_coll].drop
      authorized_client.use(test_database_name).database.drop
    end

    shared_examples 'creates data keys automatically' do
      let(:opts) do
        { encrypted_fields: { fields: [ field ] } }
      end

      context 'when insert unencrypted value' do
        let(:field) do
          {
            path: 'ssn',
            bsonType: 'string',
            keyId: nil
          }
        end

        it 'fails document validation' do
          client_encryption.create_encrypted_collection(
            database, 'testing1', opts, kms_provider, master_key
          )
          expect { database['testing1'].insert_one(ssn: '123-45-6789') }
            .to raise_error(Mongo::Error::OperationFailure, /Document failed validation/)
        end
      end

      it 'fails when missing encrypted field' do
        expect do
          client_encryption.create_encrypted_collection(
            database, 'testing1', {}, kms_provider, master_key
          )
        end.to raise_error(ArgumentError, /coll_opts must contain :encrypted_fields/)
      end

      context 'when invalid keyId provided' do
        let(:field) do
          {
            path: 'ssn',
            bsonType: 'string',
            keyId: false
          }
        end

        it 'fails' do
          expect do
            client_encryption.create_encrypted_collection(
              database, 'testing1', opts, kms_provider, master_key
            )
          end.to raise_error(Mongo::Error::CryptError, /keyId' is the wrong type/)
        end
      end

      context 'when configured correctly' do
        let(:field) do
          {
            path: 'ssn',
            bsonType: 'string',
            keyId: nil
          }
        end

        let(:new_encrypted_fields) do
          _, new_encrypted_fields = client_encryption.create_encrypted_collection(
            database, 'testing1', opts, kms_provider, master_key
          )

          new_encrypted_fields
        end

        let(:key_id) do
          new_encrypted_fields[:fields].first[:keyId]
        end

        let(:encrypted_payload) do
          client_encryption.encrypt(
            '123-45-6789',
            key_id: key_id,
            algorithm: 'Unindexed'
          )
        end

        it 'successfully inserts encrypted value' do
          expect do
            database['testing1'].insert_one(ssn: encrypted_payload)
          end.not_to raise_error
        end
      end
    end

    context 'with aws' do
      let(:kms_provider) { 'aws' }
      let(:master_key) do
        {
          region: 'us-east-1',
          key: 'arn:aws:kms:us-east-1:579766882180:key/89fcc2c4-08b0-4bd9-9f25-e30687b580d0'
        }
      end

      it_behaves_like 'creates data keys automatically'
    end

    context 'with local' do
      let(:kms_provider) { 'local' }
      let(:master_key) { { key: local_master_key } }

      it_behaves_like 'creates data keys automatically'
    end
  end
end