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
|
/**
* Copyright (C) 2019-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#include "mongo/platform/basic.h"
#include "mongo/shell/encrypted_dbclient_base.h"
#include "mongo/base/data_cursor.h"
#include "mongo/base/data_type_validated.h"
#include "mongo/bson/bson_depth.h"
#include "mongo/client/dbclient_base.h"
#include "mongo/crypto/aead_encryption.h"
#include "mongo/crypto/fle_data_frames.h"
#include "mongo/crypto/symmetric_crypto.h"
#include "mongo/db/client.h"
#include "mongo/db/commands.h"
#include "mongo/db/matcher/schema/encrypt_schema_gen.h"
#include "mongo/db/namespace_string.h"
#include "mongo/rpc/object_check.h"
#include "mongo/rpc/op_msg_rpc_impls.h"
#include "mongo/scripting/mozjs/bindata.h"
#include "mongo/scripting/mozjs/implscope.h"
#include "mongo/scripting/mozjs/maxkey.h"
#include "mongo/scripting/mozjs/minkey.h"
#include "mongo/scripting/mozjs/mongo.h"
#include "mongo/scripting/mozjs/objectwrapper.h"
#include "mongo/scripting/mozjs/valuereader.h"
#include "mongo/scripting/mozjs/valuewriter.h"
#include "mongo/shell/encrypted_shell_options.h"
#include "mongo/shell/kms.h"
#include "mongo/shell/kms_gen.h"
#include "mongo/shell/shell_options.h"
#include "mongo/util/lru_cache.h"
namespace mongo {
EncryptedShellGlobalParams encryptedShellGlobalParams;
namespace {
constexpr Duration kCacheInvalidationTime = Minutes(1);
ImplicitEncryptedDBClientCallback* implicitEncryptedDBClientCallback{nullptr};
} // namespace
void setImplicitEncryptedDBClientCallback(ImplicitEncryptedDBClientCallback* callback) {
implicitEncryptedDBClientCallback = callback;
}
static void validateCollection(JSContext* cx, JS::HandleValue value) {
uassert(ErrorCodes::BadValue,
"Collection object must be provided to ClientSideFLEOptions",
!(value.isNull() || value.isUndefined()));
JS::RootedValue coll(cx, value);
uassert(31043,
"The collection object in ClientSideFLEOptions is invalid",
mozjs::getScope(cx)->getProto<mozjs::DBCollectionInfo>().instanceOf(coll));
}
EncryptedDBClientBase::EncryptedDBClientBase(std::unique_ptr<DBClientBase> conn,
ClientSideFLEOptions encryptionOptions,
JS::HandleValue collection,
JSContext* cx)
: _conn(std::move(conn)), _encryptionOptions(std::move(encryptionOptions)), _cx(cx) {
validateCollection(cx, collection);
_collection = JS::Heap<JS::Value>(collection);
uassert(31078,
"Cannot use WriteMode Legacy with Field Level Encryption",
shellGlobalParams.writeMode != "legacy");
};
std::string EncryptedDBClientBase::getServerAddress() const {
return _conn->getServerAddress();
}
bool EncryptedDBClientBase::call(Message& toSend,
Message& response,
bool assertOk,
std::string* actualServer) {
return _conn->call(toSend, response, assertOk, actualServer);
}
void EncryptedDBClientBase::say(Message& toSend, bool isRetry, std::string* actualServer) {
MONGO_UNREACHABLE;
}
bool EncryptedDBClientBase::lazySupported() const {
return _conn->lazySupported();
}
BSONObj EncryptedDBClientBase::encryptDecryptCommand(const BSONObj& object,
bool encrypt,
const StringData databaseName) {
std::stack<std::pair<BSONObjIterator, BSONObjBuilder>> frameStack;
// The encryptDecryptCommand frameStack requires a guard because if encryptMarking or
// decrypt payload throw an exception, the stack's destructor will fire. Because a stack's
// variables are not guaranteed to be destroyed in any order, we need to add a guard
// to ensure the stack is destroyed in order.
const auto frameStackGuard = makeGuard([&] {
while (!frameStack.empty()) {
frameStack.pop();
}
});
frameStack.emplace(BSONObjIterator(object), BSONObjBuilder());
while (frameStack.size() > 1 || frameStack.top().first.more()) {
uassert(31096,
"Object too deep to be encrypted. Exceeded stack depth.",
frameStack.size() < BSONDepth::kDefaultMaxAllowableDepth);
auto& [iterator, builder] = frameStack.top();
if (iterator.more()) {
BSONElement elem = iterator.next();
if (elem.type() == BSONType::Object) {
frameStack.emplace(BSONObjIterator(elem.Obj()),
BSONObjBuilder(builder.subobjStart(elem.fieldNameStringData())));
} else if (elem.type() == BSONType::Array) {
frameStack.emplace(
BSONObjIterator(elem.Obj()),
BSONObjBuilder(builder.subarrayStart(elem.fieldNameStringData())));
} else if (elem.isBinData(BinDataType::Encrypt)) {
int len;
const char* data(elem.binData(len));
uassert(31178, "Invalid intentToEncrypt object from Query Analyzer", len >= 1);
if ((*data == kRandomEncryptionBit || *data == kDeterministicEncryptionBit) &&
!encrypt) {
ConstDataRange dataCursor(data, len);
decryptPayload(dataCursor, &builder, elem.fieldNameStringData());
} else if (*data == kIntentToEncryptBit && encrypt) {
BSONObj obj = BSONObj(data + 1);
encryptMarking(obj, &builder, elem.fieldNameStringData());
} else {
builder.append(elem);
}
} else {
builder.append(elem);
}
} else {
frameStack.pop();
}
}
invariant(frameStack.size() == 1);
frameStack.top().second.append("$db", databaseName);
return frameStack.top().second.obj();
}
void EncryptedDBClientBase::encryptMarking(const BSONObj& elem,
BSONObjBuilder* builder,
StringData elemName) {
MONGO_UNREACHABLE;
}
void EncryptedDBClientBase::decryptPayload(ConstDataRange data,
BSONObjBuilder* builder,
StringData elemName) {
invariant(builder);
uassert(ErrorCodes::BadValue, "Invalid decryption blob", data.length() > kAssociatedDataLength);
FLEDecryptionFrame dataFrame = createDecryptionFrame(data);
auto plaintext = dataFrame.getPlaintext();
// extract type byte
const uint8_t bsonType = dataFrame.getBSONType();
BSONObj decryptedObj = validateBSONElement(plaintext, bsonType);
if (bsonType == BSONType::Object) {
builder->append(elemName, decryptedObj);
} else {
builder->appendAs(decryptedObj.firstElement(), elemName);
}
}
std::pair<rpc::UniqueReply, DBClientBase*> EncryptedDBClientBase::processResponse(
rpc::UniqueReply result, const StringData databaseName) {
auto rawReply = result->getCommandReply();
BSONObj decryptedDoc = encryptDecryptCommand(rawReply, false, databaseName);
rpc::OpMsgReplyBuilder replyBuilder;
replyBuilder.setCommandReply(StatusWith<BSONObj>(decryptedDoc));
auto msg = replyBuilder.done();
auto host = _conn->getServerAddress();
auto reply = _conn->parseCommandReplyMessage(host, msg);
return {std::move(reply), this};
}
std::pair<rpc::UniqueReply, DBClientBase*> EncryptedDBClientBase::runCommandWithTarget(
OpMsgRequest request) {
std::string commandName = request.getCommandName().toString();
std::string databaseName = request.getDatabase().toString();
if (std::find(kEncryptedCommands.begin(), kEncryptedCommands.end(), StringData(commandName)) ==
std::end(kEncryptedCommands)) {
return _conn->runCommandWithTarget(std::move(request));
}
auto result = _conn->runCommandWithTarget(std::move(request)).first;
return processResponse(std::move(result), databaseName);
}
/**
*
* This function reads the data from the CDR and returns a copy
* constructed and owned BSONObject.
*
*/
BSONObj EncryptedDBClientBase::validateBSONElement(ConstDataRange out, uint8_t bsonType) {
if (bsonType == BSONType::Object) {
ConstDataRangeCursor cdc = ConstDataRangeCursor(out);
BSONObj valueObj;
valueObj = cdc.readAndAdvance<Validated<BSONObj>>();
return valueObj.getOwned();
} else {
auto valueString = "value"_sd;
// The size here is to construct a new BSON document and validate the
// total size of the object. The first four bytes is for the size of an
// int32_t, then a space for the type of the first element, then the space
// for the value string and the the 0x00 terminated field name, then the
// size of the actual data, then the last byte for the end document character,
// also 0x00.
size_t docLength = sizeof(int32_t) + 1 + valueString.size() + 1 + out.length() + 1;
BufBuilder builder;
builder.reserveBytes(docLength);
uassert(ErrorCodes::BadValue,
"invalid decryption value",
docLength < std::numeric_limits<int32_t>::max());
builder.appendNum(static_cast<uint32_t>(docLength));
builder.appendChar(static_cast<uint8_t>(bsonType));
builder.appendStr(valueString, true);
builder.appendBuf(out.data(), out.length());
builder.appendChar('\0');
ConstDataRangeCursor cdc =
ConstDataRangeCursor(ConstDataRange(builder.buf(), builder.len()));
BSONObj elemWrapped = cdc.readAndAdvance<Validated<BSONObj>>();
return elemWrapped.getOwned();
}
}
std::string EncryptedDBClientBase::toString() const {
return _conn->toString();
}
int EncryptedDBClientBase::getMinWireVersion() {
return _conn->getMinWireVersion();
}
int EncryptedDBClientBase::getMaxWireVersion() {
return _conn->getMaxWireVersion();
}
void EncryptedDBClientBase::generateDataKey(JSContext* cx, JS::CallArgs args) {
if (args.length() != 2) {
uasserted(ErrorCodes::BadValue, "generateDataKey requires 2 arg");
}
if (!args.get(0).isString()) {
uasserted(ErrorCodes::BadValue, "1st param to generateDataKey has to be a string");
}
if (!args.get(1).isString()) {
uasserted(ErrorCodes::BadValue, "2nd param to generateDataKey has to be a string");
}
std::string kmsProvider = mozjs::ValueWriter(cx, args.get(0)).toString();
std::string clientMasterKey = mozjs::ValueWriter(cx, args.get(1)).toString();
std::unique_ptr<KMSService> kmsService = KMSServiceController::createFromClient(
kmsProvider, _encryptionOptions.getKmsProviders().toBSON());
SecureVector<uint8_t> dataKey(crypto::kFieldLevelEncryptionKeySize);
auto res = crypto::engineRandBytes(dataKey->data(), dataKey->size());
uassert(31042, "Error generating data key: " + res.codeString(), res.isOK());
BSONObj obj = kmsService->encryptDataKey(ConstDataRange(dataKey->data(), dataKey->size()),
clientMasterKey);
mozjs::ValueReader(cx, args.rval()).fromBSON(obj, nullptr, false);
}
void EncryptedDBClientBase::getDataKeyCollection(JSContext* cx, JS::CallArgs args) {
if (args.length() != 0) {
uasserted(ErrorCodes::BadValue, "getDataKeyCollection does not take any params");
}
args.rval().set(_collection.get());
}
void EncryptedDBClientBase::encrypt(mozjs::MozJSImplScope* scope,
JSContext* cx,
JS::CallArgs args) {
// Input Validation
uassert(ErrorCodes::BadValue, "encrypt requires 3 args", args.length() == 3);
if (!(args.get(1).isObject() || args.get(1).isString() || args.get(1).isNumber() ||
args.get(1).isBoolean())) {
uasserted(ErrorCodes::BadValue,
"Second parameter must be an object, string, number, or bool");
}
uassert(ErrorCodes::BadValue, "Third parameter must be a string", args.get(2).isString());
auto algorithmStr = mozjs::ValueWriter(cx, args.get(2)).toString();
FleAlgorithmInt algorithm;
if (StringData(algorithmStr) == FleAlgorithm_serializer(FleAlgorithmEnum::kRandom)) {
algorithm = FleAlgorithmInt::kRandom;
} else if (StringData(algorithmStr) ==
FleAlgorithm_serializer(FleAlgorithmEnum::kDeterministic)) {
algorithm = FleAlgorithmInt::kDeterministic;
} else {
uasserted(ErrorCodes::BadValue, "Third parameter must be the FLE Algorithm type");
}
// Extract the UUID from the callArgs
auto binData = getBinDataArg(scope, cx, args, 0, BinDataType::newUUID);
UUID uuid = UUID::fromCDR(ConstDataRange(binData.data(), binData.size()));
BSONType bsonType = BSONType::EOO;
BufBuilder plaintextBuilder;
if (args.get(1).isObject()) {
JS::RootedObject rootedObj(cx, &args.get(1).toObject());
auto jsclass = JS_GetClass(rootedObj);
if (strcmp(jsclass->name, "Object") == 0 || strcmp(jsclass->name, "Array") == 0) {
uassert(ErrorCodes::BadValue,
"Cannot deterministically encrypt object or array types.",
algorithm != FleAlgorithmInt::kDeterministic);
// If it is a JS Object, then we can extract all the information by simply calling
// ValueWriter.toBSON and setting the type bit, which is what is happening below.
BSONObj valueObj = mozjs::ValueWriter(cx, args.get(1)).toBSON();
plaintextBuilder.appendBuf(valueObj.objdata(), valueObj.objsize());
if (strcmp(jsclass->name, "Array") == 0) {
bsonType = BSONType::Array;
} else {
bsonType = BSONType::Object;
}
} else if (scope->getProto<mozjs::MinKeyInfo>().getJSClass() == jsclass ||
scope->getProto<mozjs::MaxKeyInfo>().getJSClass() == jsclass ||
scope->getProto<mozjs::DBRefInfo>().getJSClass() == jsclass) {
uasserted(ErrorCodes::BadValue, "Second parameter cannot be MinKey, MaxKey, or DBRef");
} else {
if (scope->getProto<mozjs::BinDataInfo>().getJSClass() == jsclass) {
mozjs::ObjectWrapper o(cx, args.get(1));
auto binType = BinDataType(o.getNumberInt(mozjs::InternedString::type));
uassert(ErrorCodes::BadValue,
"Cannot encrypt BinData subtype 2.",
binType != BinDataType::ByteArrayDeprecated);
}
if (scope->getProto<mozjs::NumberDecimalInfo>().getJSClass() == jsclass) {
uassert(ErrorCodes::BadValue,
"Cannot deterministically encrypt NumberDecimal type objects.",
algorithm != FleAlgorithmInt::kDeterministic);
}
if (scope->getProto<mozjs::CodeInfo>().getJSClass() == jsclass) {
uassert(ErrorCodes::BadValue,
"Cannot deterministically encrypt Code type objects.",
algorithm != FleAlgorithmInt::kDeterministic);
}
// If it is one of our Mongo defined types, then we have to use the ValueWriter
// writeThis function, which takes in a set of WriteFieldRecursionFrames (setting
// a limit on how many times we can recursively dig into an object's nested
// structure) and writes the value out to a BSONObjBuilder. We can then extract
// that information from the object by building it and pulling out the first
// element, which is the object we are trying to get.
mozjs::ObjectWrapper::WriteFieldRecursionFrames frames;
frames.emplace(cx, rootedObj.get(), nullptr, StringData{});
BSONObjBuilder builder;
mozjs::ValueWriter(cx, args.get(1)).writeThis(&builder, "value"_sd, &frames);
BSONObj object = builder.obj();
auto elem = object.getField("value"_sd);
plaintextBuilder.appendBuf(elem.value(), elem.valuesize());
bsonType = elem.type();
}
} else if (args.get(1).isString()) {
std::string valueStr = mozjs::ValueWriter(cx, args.get(1)).toString();
if (valueStr.size() + 1 > std::numeric_limits<uint32_t>::max()) {
uasserted(ErrorCodes::BadValue, "Plaintext string to encrypt too long.");
}
plaintextBuilder.appendNum(static_cast<uint32_t>(valueStr.size() + 1));
plaintextBuilder.appendStr(valueStr, true);
bsonType = BSONType::String;
} else if (args.get(1).isNumber()) {
uassert(ErrorCodes::BadValue,
"Cannot deterministically encrypt Floating Point numbers.",
algorithm != FleAlgorithmInt::kDeterministic);
double valueNum = mozjs::ValueWriter(cx, args.get(1)).toNumber();
plaintextBuilder.appendNum(valueNum);
bsonType = BSONType::NumberDouble;
} else if (args.get(1).isBoolean()) {
uassert(ErrorCodes::BadValue,
"Cannot deterministically encrypt booleans.",
algorithm != FleAlgorithmInt::kDeterministic);
bool boolean = mozjs::ValueWriter(cx, args.get(1)).toBoolean();
if (boolean) {
plaintextBuilder.appendChar(0x01);
} else {
plaintextBuilder.appendChar(0x00);
}
bsonType = BSONType::Bool;
} else {
uasserted(ErrorCodes::BadValue, "Cannot encrypt valuetype provided.");
}
ConstDataRange plaintext(plaintextBuilder.buf(), plaintextBuilder.len());
FLEEncryptionFrame encryptionFrame =
createEncryptionFrame(getDataKey(uuid), algorithm, uuid, bsonType, plaintext);
// Prepare the return value
ConstDataRange ciphertextBlob(encryptionFrame.get());
std::string blobStr = base64::encode(ciphertextBlob.data(), ciphertextBlob.length());
JS::AutoValueArray<2> arr(cx);
arr[0].setInt32(BinDataType::Encrypt);
mozjs::ValueReader(cx, arr[1]).fromStringData(blobStr);
scope->getProto<mozjs::BinDataInfo>().newInstance(arr, args.rval());
}
void EncryptedDBClientBase::decrypt(mozjs::MozJSImplScope* scope,
JSContext* cx,
JS::CallArgs args) {
uassert(ErrorCodes::BadValue, "decrypt requires one argument", args.length() == 1);
uassert(ErrorCodes::BadValue,
"decrypt argument must be a BinData subtype Encrypt object",
args.get(0).isObject());
uassert(ErrorCodes::BadValue,
"decrypt argument must be a BinData subtype Encrypt object",
scope->getProto<mozjs::BinDataInfo>().instanceOf(args.get(0)));
JS::RootedObject obj(cx, &args.get(0).get().toObject());
std::vector<uint8_t> data = getBinDataArg(scope, cx, args, 0, BinDataType::Encrypt);
ConstDataRange ciphertextBlob(data);
FLEDecryptionFrame dataFrame = createDecryptionFrame(ciphertextBlob);
const uint8_t bsonType = dataFrame.getBSONType();
BSONObj parent;
BSONObj decryptedObj = validateBSONElement(dataFrame.getPlaintext(), bsonType);
if (bsonType == BSONType::Object) {
mozjs::ValueReader(cx, args.rval()).fromBSON(decryptedObj, &parent, true);
} else {
mozjs::ValueReader(cx, args.rval())
.fromBSONElement(decryptedObj.firstElement(), parent, true);
}
}
void EncryptedDBClientBase::trace(JSTracer* trc) {
JS::TraceEdge(trc, &_collection, "collection object");
}
JS::Value EncryptedDBClientBase::getCollection() const {
return _collection.get();
}
std::unique_ptr<DBClientCursor> EncryptedDBClientBase::query(const NamespaceStringOrUUID& nsOrUuid,
Query query,
int nToReturn,
int nToSkip,
const BSONObj* fieldsToReturn,
int queryOptions,
int batchSize) {
return _conn->query(
nsOrUuid, query, nToReturn, nToSkip, fieldsToReturn, queryOptions, batchSize);
}
bool EncryptedDBClientBase::isFailed() const {
return _conn->isFailed();
}
bool EncryptedDBClientBase::isStillConnected() {
return _conn->isStillConnected();
}
ConnectionString::ConnectionType EncryptedDBClientBase::type() const {
return _conn->type();
}
double EncryptedDBClientBase::getSoTimeout() const {
return _conn->getSoTimeout();
}
bool EncryptedDBClientBase::isReplicaSetMember() const {
return _conn->isReplicaSetMember();
}
bool EncryptedDBClientBase::isMongos() const {
return _conn->isMongos();
}
FLEEncryptionFrame EncryptedDBClientBase::createEncryptionFrame(std::shared_ptr<SymmetricKey> key,
FleAlgorithmInt algorithm,
UUID uuid,
BSONType type,
ConstDataRange plaintext) {
auto cipherLength = crypto::aeadCipherOutputLength(plaintext.length());
FLEEncryptionFrame dataframe(key, algorithm, uuid, type, plaintext, cipherLength);
uassertStatusOK(crypto::aeadEncryptDataFrame(dataframe));
return dataframe;
}
FLEDecryptionFrame EncryptedDBClientBase::createDecryptionFrame(ConstDataRange data) {
auto frame = FLEDecryptionFrame(data);
auto key = getDataKey(frame.getUUID());
frame.setKey(key);
uassertStatusOK(crypto::aeadDecryptDataFrame(frame));
return frame;
}
NamespaceString EncryptedDBClientBase::getCollectionNS() {
JS::RootedValue fullNameRooted(_cx);
JS::RootedObject collectionRooted(_cx, &_collection.get().toObject());
JS_GetProperty(_cx, collectionRooted, "_fullName", &fullNameRooted);
if (!fullNameRooted.isString()) {
uasserted(ErrorCodes::BadValue, "Collection object is incomplete.");
}
std::string fullName = mozjs::ValueWriter(_cx, fullNameRooted).toString();
NamespaceString fullNameNS = NamespaceString(fullName);
uassert(ErrorCodes::BadValue,
str::stream() << "Invalid namespace: " << fullName,
fullNameNS.isValid());
return fullNameNS;
}
std::vector<uint8_t> EncryptedDBClientBase::getBinDataArg(
mozjs::MozJSImplScope* scope, JSContext* cx, JS::CallArgs args, int index, BinDataType type) {
if (!args.get(index).isObject() ||
!scope->getProto<mozjs::BinDataInfo>().instanceOf(args.get(index))) {
uasserted(ErrorCodes::BadValue, "First parameter must be a BinData object");
}
mozjs::ObjectWrapper o(cx, args.get(index));
auto binType = BinDataType(static_cast<int>(o.getNumber(mozjs::InternedString::type)));
uassert(ErrorCodes::BadValue,
str::stream() << "Incorrect bindata type, expected" << typeName(type) << " but got "
<< typeName(binType),
binType == type);
auto str = static_cast<std::string*>(JS_GetPrivate(args.get(index).toObjectOrNull()));
uassert(ErrorCodes::BadValue, "Cannot call getter on BinData prototype", str);
std::string string = base64::decode(*str);
return std::vector<uint8_t>(string.data(), string.data() + string.length());
}
std::shared_ptr<SymmetricKey> EncryptedDBClientBase::getDataKey(const UUID& uuid) {
auto ts_new = Date_t::now();
if (_datakeyCache.hasKey(uuid)) {
auto [key, ts] = _datakeyCache.find(uuid)->second;
if (ts_new - ts < kCacheInvalidationTime) {
return key;
} else {
_datakeyCache.erase(uuid);
}
}
auto key = getDataKeyFromDisk(uuid);
_datakeyCache.add(uuid, std::make_pair(key, ts_new));
return key;
}
std::shared_ptr<SymmetricKey> EncryptedDBClientBase::getDataKeyFromDisk(const UUID& uuid) {
NamespaceString fullNameNS = getCollectionNS();
BSONObj dataKeyObj = _conn->findOne(fullNameNS.ns(), QUERY("_id" << uuid));
if (dataKeyObj.isEmpty()) {
uasserted(ErrorCodes::BadValue, "Invalid keyID.");
}
auto keyStoreRecord = KeyStoreRecord::parse(IDLParserErrorContext("root"), dataKeyObj);
if (dataKeyObj.hasField("version"_sd)) {
uassert(ErrorCodes::BadValue,
"Invalid version, must be either 0 or undefined",
dataKeyObj.getIntField("version"_sd) == 0);
}
BSONElement elem = dataKeyObj.getField("keyMaterial"_sd);
uassert(ErrorCodes::BadValue, "Invalid key.", elem.isBinData(BinDataType::BinDataGeneral));
uassert(ErrorCodes::BadValue,
"Invalid version, must be either 0 or undefined",
keyStoreRecord.getVersion() == 0);
auto dataKey = keyStoreRecord.getKeyMaterial();
uassert(ErrorCodes::BadValue, "Invalid data key.", dataKey.length() != 0);
std::unique_ptr<KMSService> kmsService = KMSServiceController::createFromDisk(
_encryptionOptions.getKmsProviders().toBSON(), keyStoreRecord.getMasterKey());
SecureVector<uint8_t> decryptedKey =
kmsService->decrypt(dataKey, keyStoreRecord.getMasterKey());
return std::make_shared<SymmetricKey>(
std::move(decryptedKey), crypto::aesAlgorithm, "kms_encryption");
}
namespace {
/**
* Constructs a collection object from a namespace, passed in to the nsString parameter.
* The client is the connection to a database in which you want to create the collection.
* The collection parameter gets set to a javascript collection object.
*/
void createCollectionObject(JSContext* cx,
JS::HandleValue client,
StringData nsString,
JS::MutableHandleValue collection) {
invariant(!client.isNull() && !client.isUndefined());
auto ns = NamespaceString(nsString);
uassert(ErrorCodes::BadValue,
"Invalid keystore namespace.",
ns.isValid() && NamespaceString::validCollectionName(ns.coll()));
auto scope = mozjs::getScope(cx);
// The collection object requires a database object to be constructed as well.
JS::RootedValue databaseRV(cx);
JS::AutoValueArray<2> databaseArgs(cx);
databaseArgs[0].setObject(client.toObject());
mozjs::ValueReader(cx, databaseArgs[1]).fromStringData(ns.db());
scope->getProto<mozjs::DBInfo>().newInstance(databaseArgs, &databaseRV);
invariant(databaseRV.isObject());
auto databaseObj = databaseRV.toObjectOrNull();
JS::AutoValueArray<4> collectionArgs(cx);
collectionArgs[0].setObject(client.toObject());
collectionArgs[1].setObject(*databaseObj);
mozjs::ValueReader(cx, collectionArgs[2]).fromStringData(ns.coll());
mozjs::ValueReader(cx, collectionArgs[3]).fromStringData(ns.ns());
scope->getProto<mozjs::DBCollectionInfo>().newInstance(collectionArgs, collection);
}
// The parameters required to start FLE on the shell. The current connection is passed in as a
// parameter to create the keyvault collection object if one is not provided.
std::unique_ptr<DBClientBase> createEncryptedDBClientBase(std::unique_ptr<DBClientBase> conn,
JS::HandleValue arg,
JS::HandleObject mongoConnection,
JSContext* cx) {
uassert(
31038, "Invalid Client Side Encryption parameters.", arg.isObject() || arg.isUndefined());
static constexpr auto keyVaultClientFieldId = "keyVaultClient";
if (!arg.isObject() && encryptedShellGlobalParams.awsAccessKeyId.empty()) {
return conn;
}
ClientSideFLEOptions encryptionOptions;
JS::RootedValue client(cx);
JS::RootedValue collection(cx);
if (!arg.isObject()) {
// If arg is not an object, but one of the required encryptedShellGlobalParams
// is defined, the user is trying to start an encrypted client with command line
// parameters.
AwsKMS awsKms = AwsKMS(encryptedShellGlobalParams.awsAccessKeyId,
encryptedShellGlobalParams.awsSecretAccessKey);
awsKms.setUrl(StringData(encryptedShellGlobalParams.awsKmsURL));
awsKms.setSessionToken(StringData(encryptedShellGlobalParams.awsSessionToken));
KmsProviders kmsProviders;
kmsProviders.setAws(awsKms);
// The mongoConnection object will never be null.
// If the encrypted shell is started through command line parameters, then the user must
// default to the implicit connection for the keyvault collection.
client.setObjectOrNull(mongoConnection.get());
// Because we cannot add a schemaMap object through the command line, we set the
// schemaMap object in ClientSideFLEOptions to be null so we know to always use
// remote schemas.
encryptionOptions = ClientSideFLEOptions(encryptedShellGlobalParams.keyVaultNamespace,
std::move(kmsProviders));
} else {
uassert(ErrorCodes::BadValue,
"Collection object must be passed to Field Level Encryption Options",
arg.isObject());
const BSONObj obj = mozjs::ValueWriter(cx, arg).toBSON();
encryptionOptions = encryptionOptions.parse(IDLParserErrorContext("root"), obj);
// IDL does not perform a deep copy of BSONObjs when parsing, so we must get an
// owned copy of the schemaMap.
if (encryptionOptions.getSchemaMap()) {
encryptionOptions.setSchemaMap(encryptionOptions.getSchemaMap().get().getOwned());
}
// This logic tries to extract the client from the args. If the connection object is defined
// in the ClientSideFLEOptions struct, then the client will extract it and set itself to be
// that. Else, the client will default to the implicit connection.
JS::RootedObject handleObject(cx, &arg.toObject());
JS_GetProperty(cx, handleObject, keyVaultClientFieldId, &client);
if (client.isNull() || client.isUndefined()) {
client.setObjectOrNull(mongoConnection.get());
}
}
createCollectionObject(cx, client, encryptionOptions.getKeyVaultNamespace(), &collection);
if (implicitEncryptedDBClientCallback != nullptr) {
return implicitEncryptedDBClientCallback(
std::move(conn), encryptionOptions, collection, cx);
}
std::unique_ptr<EncryptedDBClientBase> base =
std::make_unique<EncryptedDBClientBase>(std::move(conn), encryptionOptions, collection, cx);
return std::move(base);
}
MONGO_INITIALIZER(setCallbacksForEncryptedDBClientBase)(InitializerContext*) {
mongo::mozjs::setEncryptedDBClientCallback(createEncryptedDBClientBase);
return Status::OK();
}
} // namespace
} // namespace mongo
|