|
| 1 | +import { readFile } from 'node:fs/promises'; |
| 2 | +import { join } from 'node:path'; |
| 3 | + |
| 4 | +import { type Binary, type Document, EJSON } from 'bson'; |
| 5 | +import { expect } from 'chai'; |
| 6 | + |
| 7 | +import { getCSFLEKMSProviders } from '../../csfle-kms-providers'; |
| 8 | +import { |
| 9 | + ClientEncryption, |
| 10 | + type ClientEncryptionEncryptOptions, |
| 11 | + type MongoClient |
| 12 | +} from '../../mongodb'; |
| 13 | + |
| 14 | +const metadata: MongoDBMetadataUI = { |
| 15 | + requires: { |
| 16 | + clientSideEncryption: '>=6.4.0', |
| 17 | + mongodb: '>=8.2.0', |
| 18 | + topology: '!single' |
| 19 | + } |
| 20 | +}; |
| 21 | + |
| 22 | +const loadFLEDataFile = (filename: string) => |
| 23 | + readFile(join(__dirname, '../../spec/client-side-encryption/etc/data', filename), { |
| 24 | + encoding: 'utf-8' |
| 25 | + }); |
| 26 | + |
| 27 | +describe.only('27. Text Explicit Encryption', function () { |
| 28 | + let encryptedFields: Document; |
| 29 | + let keyDocument1: Document; |
| 30 | + let keyId1: Binary; |
| 31 | + let client: MongoClient; |
| 32 | + let keyVaultClient: MongoClient; |
| 33 | + let clientEncryption: ClientEncryption; |
| 34 | + let encryptedClient: MongoClient; |
| 35 | + let encryptOpts: ClientEncryptionEncryptOptions; |
| 36 | + |
| 37 | + beforeEach(async function () { |
| 38 | + encryptedFields = EJSON.parse(await loadFLEDataFile('encryptedFields-prefix-suffix.json'), { |
| 39 | + relaxed: false |
| 40 | + }); |
| 41 | + keyDocument1 = EJSON.parse(await loadFLEDataFile('keys/key1-document.json'), { |
| 42 | + relaxed: false |
| 43 | + }); |
| 44 | + |
| 45 | + keyId1 = keyDocument1._id; |
| 46 | + client = this.configuration.newClient(); |
| 47 | + |
| 48 | + await client |
| 49 | + .db('db') |
| 50 | + .dropCollection('explicit_encryption', { writeConcern: { w: 'majority' }, encryptedFields }); |
| 51 | + await client.db('db').createCollection('explicit_encryption', { |
| 52 | + writeConcern: { w: 'majority' }, |
| 53 | + encryptedFields |
| 54 | + }); |
| 55 | + |
| 56 | + // Drop and create the collection `keyvault.datakeys`. |
| 57 | + // Insert `key1Document` in `keyvault.datakeys` with majority write concern. |
| 58 | + await client.db('keyvault').dropCollection('datakeys', { writeConcern: { w: 'majority' } }); |
| 59 | + await client.db('keyvault').createCollection('datakeys', { writeConcern: { w: 'majority' } }); |
| 60 | + await client |
| 61 | + .db('keyvault') |
| 62 | + .collection('datakeys') |
| 63 | + .insertOne(keyDocument1, { writeConcern: { w: 'majority' } }); |
| 64 | + |
| 65 | + // Create a MongoClient named `keyVaultClient`. |
| 66 | + keyVaultClient = this.configuration.newClient(); |
| 67 | + |
| 68 | + // Create a ClientEncryption object named `clientEncryption` with these options: |
| 69 | + // class ClientEncryptionOpts { |
| 70 | + // keyVaultClient: <keyVaultClient>, |
| 71 | + // keyVaultNamespace: "keyvault.datakeys", |
| 72 | + // kmsProviders: { "local": { "key": <base64 decoding of LOCAL_MASTERKEY> } }, |
| 73 | + // } |
| 74 | + clientEncryption = new ClientEncryption(keyVaultClient, { |
| 75 | + keyVaultNamespace: 'keyvault.datakeys', |
| 76 | + kmsProviders: { |
| 77 | + local: getCSFLEKMSProviders().local |
| 78 | + } |
| 79 | + }); |
| 80 | + |
| 81 | + // Create a MongoClient named `encryptedClient` with these `AutoEncryptionOpts`: |
| 82 | + // class AutoEncryptionOpts { |
| 83 | + // keyVaultNamespace: "keyvault.datakeys", |
| 84 | + // kmsProviders: { "local": { "key": <base64 decoding of LOCAL_MASTERKEY> } }, |
| 85 | + // bypassQueryAnalysis: true, |
| 86 | + // } |
| 87 | + encryptedClient = this.configuration.newClient( |
| 88 | + {}, |
| 89 | + { |
| 90 | + autoEncryption: { |
| 91 | + keyVaultNamespace: 'keyvault.datakeys', |
| 92 | + kmsProviders: { |
| 93 | + local: getCSFLEKMSProviders().local |
| 94 | + }, |
| 95 | + bypassQueryAnalysis: true |
| 96 | + } |
| 97 | + } |
| 98 | + ); |
| 99 | + |
| 100 | + encryptOpts = { |
| 101 | + keyId: keyId1, |
| 102 | + contentionFactor: 0, |
| 103 | + algorithm: 'TextPreview', |
| 104 | + textOptions: { |
| 105 | + caseSensitive: true, |
| 106 | + diacriticSensitive: true, |
| 107 | + prefix: { |
| 108 | + strMaxQueryLength: 10, |
| 109 | + strMinQueryLength: 2 |
| 110 | + }, |
| 111 | + suffix: { |
| 112 | + strMaxQueryLength: 10, |
| 113 | + strMinQueryLength: 2 |
| 114 | + }, |
| 115 | + substring: { |
| 116 | + strMaxLength: 10, |
| 117 | + strMaxQueryLength: 10, |
| 118 | + strMinQueryLength: 2 |
| 119 | + } |
| 120 | + } |
| 121 | + }; |
| 122 | + |
| 123 | + const encryptedText = await clientEncryption.encrypt('foobarbaz', { |
| 124 | + keyId: keyId1, |
| 125 | + algorithm: 'TextPreview', |
| 126 | + contentionFactor: 0, |
| 127 | + textOptions: { |
| 128 | + caseSensitive: true, |
| 129 | + diacriticSensitive: true, |
| 130 | + prefix: { |
| 131 | + strMaxQueryLength: 10, |
| 132 | + strMinQueryLength: 2 |
| 133 | + }, |
| 134 | + suffix: { |
| 135 | + strMaxQueryLength: 10, |
| 136 | + strMinQueryLength: 2 |
| 137 | + } |
| 138 | + } |
| 139 | + }); |
| 140 | + |
| 141 | + await encryptedClient |
| 142 | + .db('db') |
| 143 | + .collection<{ _id: number; encryptedText: Binary }>('explicit_encryption') |
| 144 | + .insertOne({ |
| 145 | + _id: 0, |
| 146 | + encryptedText |
| 147 | + }); |
| 148 | + }); |
| 149 | + |
| 150 | + afterEach(async function () { |
| 151 | + await Promise.allSettled([client.close(), encryptedClient.close(), keyVaultClient.close()]); |
| 152 | + }); |
| 153 | + |
| 154 | + it('works', async function () { |
| 155 | + const encryptedFoo = await clientEncryption.encrypt('foo', { |
| 156 | + keyId: keyId1, |
| 157 | + algorithm: 'TextPreview', |
| 158 | + contentionFactor: 0, |
| 159 | + textOptions: { |
| 160 | + caseSensitive: true, |
| 161 | + diacriticSensitive: true, |
| 162 | + prefix: { |
| 163 | + strMaxQueryLength: 10, |
| 164 | + strMinQueryLength: 2 |
| 165 | + } |
| 166 | + } |
| 167 | + }); |
| 168 | + |
| 169 | + const filter = { |
| 170 | + $expr: { $encStrStartsWith: { input: 'encryptedText', prefix: encryptedFoo } } |
| 171 | + }; |
| 172 | + |
| 173 | + expect( |
| 174 | + await encryptedClient |
| 175 | + .db('db') |
| 176 | + .collection<{ _id: number; encryptedText: Binary }>('explicit_encryption') |
| 177 | + .findOne(filter) |
| 178 | + ).to.deep.equal({ _id: 0, encryptedText: 'foobarbaz' }); |
| 179 | + }); |
| 180 | +}); |
0 commit comments