/
commands.cpp
1068 lines (929 loc) · 43.3 KB
/
commands.cpp
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 (C) 2018-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.
*/
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kCommand
#include "mongo/platform/basic.h"
#include "mongo/db/commands.h"
#include <string>
#include <vector>
#include "mongo/bson/mutable/algorithm.h"
#include "mongo/bson/mutable/document.h"
#include "mongo/bson/timestamp.h"
#include "mongo/bson/util/bson_extract.h"
#include "mongo/db/audit.h"
#include "mongo/db/auth/action_set.h"
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/auth/privilege.h"
#include "mongo/db/client.h"
#include "mongo/db/commands/test_commands_enabled.h"
#include "mongo/db/curop.h"
#include "mongo/db/error_labels.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/read_write_concern_defaults.h"
#include "mongo/idl/basic_types_gen.h"
#include "mongo/idl/command_generic_argument.h"
#include "mongo/idl/idl_parser.h"
#include "mongo/logv2/log.h"
#include "mongo/rpc/factory.h"
#include "mongo/rpc/metadata/client_metadata.h"
#include "mongo/rpc/op_msg_rpc_impls.h"
#include "mongo/rpc/rewrite_state_change_errors.h"
#include "mongo/rpc/write_concern_error_detail.h"
#include "mongo/s/stale_exception.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/str.h"
using namespace fmt::literals;
namespace mongo {
using logv2::LogComponent;
const std::set<std::string> kNoApiVersions = {};
const std::set<std::string> kApiVersions1 = {"1"};
namespace {
const char kWriteConcernField[] = "writeConcern";
const WriteConcernOptions kMajorityWriteConcern(
WriteConcernOptions::kMajority,
// Note: Even though we're setting UNSET here, kMajority implies JOURNAL if journaling is
// supported by the mongod.
WriteConcernOptions::SyncMode::UNSET,
WriteConcernOptions::kWriteConcernTimeoutUserCommand);
// Returns true if found to be authorized, false if undecided. Throws if unauthorized.
bool checkAuthorizationImplPreParse(OperationContext* opCtx,
const Command* command,
const OpMsgRequest& request) {
auto client = opCtx->getClient();
if (client->isInDirectClient())
return true;
uassert(ErrorCodes::Unauthorized,
str::stream() << command->getName() << " may only be run against the admin database.",
!command->adminOnly() || request.getDatabase() == NamespaceString::kAdminDb);
auto authzSession = AuthorizationSession::get(client);
if (!authzSession->getAuthorizationManager().isAuthEnabled()) {
// Running without auth, so everything should be allowed except remotely invoked
// commands that have the 'localHostOnlyIfNoAuth' restriction.
uassert(ErrorCodes::Unauthorized,
str::stream() << command->getName()
<< " must run from localhost when running db without auth",
!command->adminOnly() || !command->localHostOnlyIfNoAuth() ||
client->getIsLocalHostConnection());
return true; // Blanket authorization: don't need to check anything else.
}
if (authzSession->isUsingLocalhostBypass())
return false; // Still can't decide on auth because of the localhost bypass.
uassert(ErrorCodes::Unauthorized,
str::stream() << "command " << command->getName() << " requires authentication",
!command->requiresAuth() || authzSession->isAuthenticated() ||
request.securityToken.nFields());
return false;
}
// The command names that are allowed in a multi-document transaction.
const StringMap<int> txnCmdAllowlist = {{"abortTransaction", 1},
{"aggregate", 1},
{"commitTransaction", 1},
{"coordinateCommitTransaction", 1},
{"create", 1},
{"createIndexes", 1},
{"delete", 1},
{"distinct", 1},
{"find", 1},
{"findandmodify", 1},
{"findAndModify", 1},
{"getMore", 1},
{"insert", 1},
{"killCursors", 1},
{"prepareTransaction", 1},
{"update", 1}};
auto getCommandInvocationHooks =
ServiceContext::declareDecoration<std::unique_ptr<CommandInvocationHooks>>();
} // namespace
void CommandInvocationHooks::set(ServiceContext* serviceContext,
std::unique_ptr<CommandInvocationHooks> hooks) {
getCommandInvocationHooks(serviceContext) = std::move(hooks);
}
//////////////////////////////////////////////////////////////
// CommandHelpers
BSONObj CommandHelpers::runCommandDirectly(OperationContext* opCtx, const OpMsgRequest& request) {
auto command = globalCommandRegistry()->findCommand(request.getCommandName());
invariant(command);
rpc::OpMsgReplyBuilder replyBuilder;
std::unique_ptr<CommandInvocation> invocation;
try {
invocation = command->parse(opCtx, request);
invocation->run(opCtx, &replyBuilder);
auto body = replyBuilder.getBodyBuilder();
CommandHelpers::extractOrAppendOk(body);
} catch (const StaleConfigException&) {
// These exceptions are intended to be handled at a higher level.
throw;
} catch (const DBException& ex) {
if (ex.code() == ErrorCodes::Unauthorized) {
CommandHelpers::auditLogAuthEvent(opCtx, invocation.get(), request, ex.code());
}
auto body = replyBuilder.getBodyBuilder();
body.resetToEmpty();
appendCommandStatusNoThrow(body, ex.toStatus());
}
return replyBuilder.releaseBody();
}
Future<void> CommandHelpers::runCommandInvocation(
std::shared_ptr<RequestExecutionContext> rec,
std::shared_ptr<CommandInvocation> invocation,
transport::ServiceExecutor::ThreadingModel threadingModel) {
switch (threadingModel) {
case transport::ServiceExecutor::ThreadingModel::kBorrowed:
return runCommandInvocationAsync(std::move(rec), std::move(invocation));
case transport::ServiceExecutor::ThreadingModel::kDedicated:
return makeReadyFutureWith([opCtx = rec->getOpCtx(),
request = rec->getRequest(),
invocation = invocation.get(),
replyBuilder = rec->getReplyBuilder()] {
runCommandInvocation(opCtx, request, invocation, replyBuilder);
});
}
MONGO_UNREACHABLE;
}
void CommandHelpers::runCommandInvocation(OperationContext* opCtx,
const OpMsgRequest& request,
CommandInvocation* invocation,
rpc::ReplyBuilderInterface* response) {
auto&& hooks = getCommandInvocationHooks(opCtx->getServiceContext());
if (hooks) {
hooks->onBeforeRun(opCtx, request, invocation);
}
invocation->run(opCtx, response);
if (hooks) {
hooks->onAfterRun(opCtx, request, invocation);
}
}
Future<void> CommandHelpers::runCommandInvocationAsync(
std::shared_ptr<RequestExecutionContext> rec,
std::shared_ptr<CommandInvocation> invocation) try {
auto&& hooks = getCommandInvocationHooks(rec->getOpCtx()->getServiceContext());
if (hooks)
hooks->onBeforeAsyncRun(rec, invocation.get());
return invocation->runAsync(rec).then([rec, hooks = hooks.get(), invocation] {
if (hooks)
hooks->onAfterAsyncRun(rec, invocation.get());
});
} catch (const DBException& e) {
return e.toStatus();
}
void CommandHelpers::auditLogAuthEvent(OperationContext* opCtx,
const CommandInvocation* invocation,
const OpMsgRequest& request,
ErrorCodes::Error err) {
class Hook final : public audit::CommandInterface {
public:
Hook(const CommandInvocation* invocation, const OpMsgRequest& request)
: _invocation(invocation) {
if (_invocation) {
_nss = _invocation->ns();
_name = _invocation->definition()->getName();
} else {
_nss = NamespaceString(request.getDatabase());
_name = request.getCommandName().toString();
}
}
void snipForLogging(mutablebson::Document* cmdObj) const override {
if (_invocation) {
_invocation->definition()->snipForLogging(cmdObj);
}
}
std::set<StringData> sensitiveFieldNames() const override {
if (_invocation) {
return _invocation->definition()->sensitiveFieldNames();
}
return {};
}
StringData getName() const override {
return _name;
}
NamespaceString ns() const override {
return _nss;
}
bool redactArgs() const override {
return !_invocation;
}
private:
const CommandInvocation* _invocation;
NamespaceString _nss;
std::string _name;
};
// Always audit errors other than Unauthorized.
//
// When we get Unauthorized (usually),
// then only audit if our Command definition wants it (default),
// or if we don't know our Command definition.
if ((err != ErrorCodes::Unauthorized) || !invocation ||
invocation->definition()->auditAuthorizationFailure()) {
audit::logCommandAuthzCheck(opCtx->getClient(), request, Hook(invocation, request), err);
}
}
void CommandHelpers::uassertNoDocumentSequences(StringData commandName,
const OpMsgRequest& request) {
uassert(40472,
str::stream() << "The " << commandName
<< " command does not support document sequences.",
request.sequences.empty());
}
std::string CommandHelpers::parseNsFullyQualified(const BSONObj& cmdObj) {
BSONElement first = cmdObj.firstElement();
uassert(ErrorCodes::BadValue,
str::stream() << "collection name has invalid type " << typeName(first.type()),
first.canonicalType() == canonicalizeBSONType(mongo::String));
const NamespaceString nss(first.valueStringData());
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Invalid namespace specified '" << nss.ns() << "'",
nss.isValid());
return nss.ns();
}
NamespaceString CommandHelpers::parseNsCollectionRequired(StringData dbname,
const BSONObj& cmdObj) {
// Accepts both BSON String and Symbol for collection name per SERVER-16260
// TODO(kangas) remove Symbol support in MongoDB 3.0 after Ruby driver audit
BSONElement first = cmdObj.firstElement();
const bool isUUID = (first.canonicalType() == canonicalizeBSONType(mongo::BinData) &&
first.binDataType() == BinDataType::newUUID);
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Collection name must be provided. UUID is not valid in this "
<< "context",
!isUUID);
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "collection name has invalid type " << typeName(first.type()),
first.canonicalType() == canonicalizeBSONType(mongo::String));
const NamespaceString nss(dbname, first.valueStringData());
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Invalid namespace specified '" << nss.ns() << "'",
nss.isValid());
return nss;
}
NamespaceStringOrUUID CommandHelpers::parseNsOrUUID(StringData dbname, const BSONObj& cmdObj) {
BSONElement first = cmdObj.firstElement();
if (first.type() == BinData && first.binDataType() == BinDataType::newUUID) {
return {dbname.toString(), uassertStatusOK(UUID::parse(first))};
} else {
// Ensure collection identifier is not a Command
const NamespaceString nss(parseNsCollectionRequired(dbname, cmdObj));
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Invalid collection name specified '" << nss.ns(),
!(nss.ns().find('$') != std::string::npos && nss.ns() != "local.oplog.$main"));
return nss;
}
}
std::string CommandHelpers::parseNsFromCommand(StringData dbname, const BSONObj& cmdObj) {
BSONElement first = cmdObj.firstElement();
if (first.type() != mongo::String)
return dbname.toString();
return str::stream() << dbname << '.' << cmdObj.firstElement().valueStringData();
}
ResourcePattern CommandHelpers::resourcePatternForNamespace(const std::string& ns) {
if (!NamespaceString::validCollectionComponent(ns)) {
return ResourcePattern::forDatabaseName(ns);
}
return ResourcePattern::forExactNamespace(NamespaceString(ns));
}
Command* CommandHelpers::findCommand(StringData name) {
return globalCommandRegistry()->findCommand(name);
}
bool CommandHelpers::appendCommandStatusNoThrow(BSONObjBuilder& result, const Status& status) {
appendSimpleCommandStatus(result, status.isOK(), status.reason());
BSONObj tmp = result.asTempObj();
if (!status.isOK() && !tmp.hasField("code")) {
result.append("code", status.code());
result.append("codeName", ErrorCodes::errorString(status.code()));
}
if (auto extraInfo = status.extraInfo()) {
extraInfo->serialize(&result);
}
// If the command has errored, assert that it satisfies the IDL-defined requirements on a
// command error reply.
// Only validate error reply in test mode so that we don't expose users to errors if we
// construct an invalid error reply.
if (!status.isOK() && getTestCommandsEnabled()) {
try {
ErrorReply::parse(IDLParserErrorContext("appendCommandStatusNoThrow"),
result.asTempObj());
} catch (const DBException&) {
invariant(false,
"invalid error-response to a command constructed in "
"CommandHelpers::appendComandStatusNoThrow. All erroring command responses "
"must comply with the format specified by the IDL-defined struct ErrorReply, "
"defined in idl/basic_types.idl");
}
}
return status.isOK();
}
void CommandHelpers::appendSimpleCommandStatus(BSONObjBuilder& result,
bool ok,
const std::string& errmsg) {
BSONObj tmp = result.asTempObj();
bool have_ok = tmp.hasField("ok");
bool need_errmsg = !ok && !tmp.hasField("errmsg");
if (!have_ok)
result.append("ok", ok ? 1.0 : 0.0);
if (need_errmsg) {
result.append("errmsg", errmsg);
}
}
bool CommandHelpers::extractOrAppendOk(BSONObjBuilder& reply) {
if (auto okField = reply.asTempObj()["ok"]) {
// If ok is present, use its truthiness.
return okField.trueValue();
}
// Missing "ok" field is an implied success.
reply.append("ok", 1.0);
return true;
}
void CommandHelpers::appendCommandWCStatus(BSONObjBuilder& result,
const Status& awaitReplicationStatus,
const WriteConcernResult& wcResult) {
if (!awaitReplicationStatus.isOK() && !result.hasField("writeConcernError")) {
WriteConcernErrorDetail wcError;
wcError.setStatus(awaitReplicationStatus);
BSONObjBuilder errInfoBuilder;
if (wcResult.wTimedOut) {
errInfoBuilder.append("wtimeout", true);
}
errInfoBuilder.append(kWriteConcernField, wcResult.wcUsed.toBSON());
wcError.setErrInfo(errInfoBuilder.obj());
result.append("writeConcernError", wcError.toBSON());
}
}
BSONObj CommandHelpers::appendGenericCommandArgs(const BSONObj& cmdObjWithGenericArgs,
const BSONObj& request) {
BSONObjBuilder b;
b.appendElements(request);
for (const auto& elem : filterCommandRequestForPassthrough(cmdObjWithGenericArgs)) {
const auto name = elem.fieldNameStringData();
if (isGenericArgument(name) && !request.hasField(name)) {
b.append(elem);
}
}
return b.obj();
}
void CommandHelpers::appendGenericReplyFields(const BSONObj& replyObjWithGenericReplyFields,
const BSONObj& reply,
BSONObjBuilder* replyBuilder) {
replyBuilder->appendElements(reply);
for (const auto& elem : filterCommandReplyForPassthrough(replyObjWithGenericReplyFields)) {
const auto name = elem.fieldNameStringData();
if (isGenericArgument(name) && !reply.hasField(name)) {
replyBuilder->append(elem);
}
}
}
BSONObj CommandHelpers::appendGenericReplyFields(const BSONObj& replyObjWithGenericReplyFields,
const BSONObj& reply) {
BSONObjBuilder b;
appendGenericReplyFields(replyObjWithGenericReplyFields, reply, &b);
return b.obj();
}
BSONObj CommandHelpers::appendMajorityWriteConcern(const BSONObj& cmdObj,
WriteConcernOptions defaultWC) {
WriteConcernOptions newWC = kMajorityWriteConcern;
if (cmdObj.hasField(kWriteConcernField)) {
auto wc = uassertStatusOK(WriteConcernOptions::extractWCFromCommand(cmdObj));
// The command has a writeConcern field and it's majority, so we can return it as-is.
if (wc.isMajority()) {
return cmdObj;
}
newWC = WriteConcernOptions{
WriteConcernOptions::kMajority, WriteConcernOptions::SyncMode::UNSET, wc.wTimeout};
} else if (!defaultWC.usedDefaultConstructedWC) {
auto minimumAcceptableWTimeout = newWC.wTimeout;
newWC = defaultWC;
newWC.w = "majority";
if (defaultWC.wTimeout < minimumAcceptableWTimeout) {
newWC.wTimeout = minimumAcceptableWTimeout;
}
}
// Append all original fields except the writeConcern field to the new command.
BSONObjBuilder cmdObjWithWriteConcern;
for (const auto& elem : cmdObj) {
const auto name = elem.fieldNameStringData();
if (name != "writeConcern" && !cmdObjWithWriteConcern.hasField(name)) {
cmdObjWithWriteConcern.append(elem);
}
}
// Finally, add the new write concern.
cmdObjWithWriteConcern.append(kWriteConcernField, newWC.toBSON());
return cmdObjWithWriteConcern.obj();
}
BSONObj CommandHelpers::filterCommandRequestForPassthrough(const BSONObj& cmdObj) {
BSONObjIterator cmdIter(cmdObj);
BSONObjBuilder bob;
filterCommandRequestForPassthrough(&cmdIter, &bob);
return bob.obj();
}
void CommandHelpers::filterCommandRequestForPassthrough(BSONObjIterator* cmdIter,
BSONObjBuilder* requestBuilder) {
while (cmdIter->more()) {
auto elem = cmdIter->next();
const auto name = elem.fieldNameStringData();
if (name == "$readPreference") {
BSONObjBuilder(requestBuilder->subobjStart("$queryOptions")).append(elem);
continue;
}
if (!shouldForwardToShards(name))
continue;
requestBuilder->append(elem);
}
}
void CommandHelpers::filterCommandReplyForPassthrough(const BSONObj& cmdObj,
BSONObjBuilder* output) {
for (auto elem : cmdObj) {
const auto name = elem.fieldNameStringData();
if (!shouldForwardFromShards(name))
continue;
output->append(elem);
}
}
BSONObj CommandHelpers::filterCommandReplyForPassthrough(const BSONObj& cmdObj) {
BSONObjBuilder bob;
filterCommandReplyForPassthrough(cmdObj, &bob);
return bob.obj();
}
bool CommandHelpers::isHelpRequest(const BSONElement& helpElem) {
return !helpElem.eoo() && helpElem.trueValue();
}
bool CommandHelpers::uassertShouldAttemptParse(OperationContext* opCtx,
const Command* command,
const OpMsgRequest& request) {
try {
return checkAuthorizationImplPreParse(opCtx, command, request);
} catch (const ExceptionFor<ErrorCodes::Unauthorized>& e) {
if (command->auditAuthorizationFailure()) {
CommandHelpers::auditLogAuthEvent(opCtx, nullptr, request, e.code());
}
throw;
}
}
void CommandHelpers::uassertCommandRunWithMajority(StringData commandName,
const WriteConcernOptions& writeConcern) {
uassert(ErrorCodes::InvalidOptions,
"\"{}\" must be called with majority writeConcern, got: {} "_format(
commandName, writeConcern.toBSON().toString()),
writeConcern.isMajority());
}
void CommandHelpers::canUseTransactions(const NamespaceString& nss,
StringData cmdName,
bool allowTransactionsOnConfigDatabase) {
uassert(ErrorCodes::OperationNotSupportedInTransaction,
"Cannot run 'count' in a multi-document transaction. Please see "
"http://dochub.mongodb.org/core/transaction-count for a recommended alternative.",
cmdName != "count"_sd);
auto inTxnAllowlist = txnCmdAllowlist.find(cmdName) != txnCmdAllowlist.cend();
uassert(ErrorCodes::OperationNotSupportedInTransaction,
str::stream() << "Cannot run '" << cmdName << "' in a multi-document transaction.",
inTxnAllowlist);
const auto dbName = nss.db();
uassert(ErrorCodes::OperationNotSupportedInTransaction,
str::stream() << "Cannot run command against the '" << dbName
<< "' database in a transaction.",
dbName != NamespaceString::kLocalDb);
uassert(ErrorCodes::OperationNotSupportedInTransaction,
str::stream() << "Cannot run command against the '" << nss
<< "' collection in a transaction.",
!nss.isSystemDotProfile());
if (allowTransactionsOnConfigDatabase) {
uassert(ErrorCodes::OperationNotSupportedInTransaction,
"Cannot run command against the config.transactions namespace in a transaction"
"on a sharded cluster.",
nss != NamespaceString::kSessionTransactionsTableNamespace);
} else {
uassert(ErrorCodes::OperationNotSupportedInTransaction,
"Cannot run command against the config database in a transaction.",
dbName != "config"_sd);
}
}
constexpr StringData CommandHelpers::kHelpFieldName;
MONGO_FAIL_POINT_DEFINE(failCommand);
MONGO_FAIL_POINT_DEFINE(waitInCommandMarkKillOnClientDisconnect);
// A decoration representing error labels specified in a failCommand failpoint that has affected a
// command in this OperationContext.
const OperationContext::Decoration<boost::optional<BSONArray>> errorLabelsOverride =
OperationContext::declareDecoration<boost::optional<BSONArray>>();
bool CommandHelpers::shouldActivateFailCommandFailPoint(const BSONObj& data,
const CommandInvocation* invocation,
Client* client) {
const Command* cmd = invocation->definition();
NamespaceString nss;
try {
nss = invocation->ns();
} catch (const ExceptionFor<ErrorCodes::InvalidNamespace>&) {
return false;
}
return shouldActivateFailCommandFailPoint(data, nss, cmd, client);
}
bool CommandHelpers::shouldActivateFailCommandFailPoint(const BSONObj& data,
const NamespaceString& nss,
const Command* cmd,
Client* client) {
if (cmd->getName() == "configureFailPoint"_sd) // Banned even if in failCommands.
return false;
if (!(data.hasField("failLocalClients") && data.getBoolField("failLocalClients")) &&
!client->session()) {
return false;
}
auto threadName = client->desc();
auto appName = StringData();
if (auto clientMetadata = ClientMetadata::get(client)) {
appName = clientMetadata->getApplicationName();
}
auto isInternalClient =
!client->session() || (client->session()->getTags() & transport::Session::kInternalClient);
if (data.hasField("threadName") && (threadName != data.getStringField("threadName"))) {
return false; // only activate failpoint on thread from certain client
}
if (data.hasField("appName") && (appName != data.getStringField("appName"))) {
return false; // only activate failpoint on connection with a certain appName
}
if (data.hasField("namespace") && (nss != NamespaceString(data.getStringField("namespace")))) {
return false;
}
if (!(data.hasField("failInternalCommands") && data.getBoolField("failInternalCommands")) &&
isInternalClient) {
return false;
}
for (auto&& failCommand : data.getObjectField("failCommands")) {
if (failCommand.type() == String && cmd->hasAlias(failCommand.valueStringData())) {
LOGV2(4898500,
"Activating 'failCommand' failpoint",
"data"_attr = data,
"threadName"_attr = threadName,
"appName"_attr = appName,
"namespace"_attr = nss,
"isInternalClient"_attr = isInternalClient,
"command"_attr = cmd->getName());
return true;
}
}
return false;
}
void CommandHelpers::evaluateFailCommandFailPoint(OperationContext* opCtx,
const CommandInvocation* invocation) {
bool closeConnection;
bool blockConnection;
bool hasErrorCode;
/**
* Default value is used to suppress the uassert for `errorExtraInfo` if `errorCode` is not set.
*/
long long errorCode = ErrorCodes::OK;
/**
* errorExtraInfo only holds a reference to the BSONElement of the parent object (data).
* The copy constructor of BSONObj handles cloning to keep references valid outside the scope.
*/
BSONElement errorExtraInfo;
const Command* cmd = invocation->definition();
failCommand.executeIf(
[&](const BSONObj& data) {
rpc::RewriteStateChangeErrors::onActiveFailCommand(opCtx, data);
if (data.hasField(kErrorLabelsFieldName) &&
data[kErrorLabelsFieldName].type() == Array) {
// Propagate error labels specified in the failCommand failpoint to the
// OperationContext decoration to override getErrorLabels() behaviors.
invariant(!errorLabelsOverride(opCtx));
errorLabelsOverride(opCtx).emplace(
data.getObjectField(kErrorLabelsFieldName).getOwned());
}
if (blockConnection) {
long long blockTimeMS = 0;
uassert(ErrorCodes::InvalidOptions,
"must specify 'blockTimeMS' when 'blockConnection' is true",
data.hasField("blockTimeMS") &&
bsonExtractIntegerField(data, "blockTimeMS", &blockTimeMS).isOK());
uassert(ErrorCodes::InvalidOptions,
"'blockTimeMS' must be non-negative",
blockTimeMS >= 0);
LOGV2(20432,
"Blocking {command} via 'failCommand' failpoint for {blockTime}",
"Blocking command via 'failCommand' failpoint",
"command"_attr = cmd->getName(),
"blockTime"_attr = Milliseconds{blockTimeMS});
opCtx->sleepFor(Milliseconds{blockTimeMS});
LOGV2(20433,
"Unblocking {command} via 'failCommand' failpoint",
"Unblocking command via 'failCommand' failpoint",
"command"_attr = cmd->getName());
}
auto tassert = [&] {
bool b;
Status st = bsonExtractBooleanField(data, "tassert", &b);
if (st == ErrorCodes::NoSuchKey) {
return false;
}
uassertStatusOK(st);
return b;
}();
auto raise = [&](const Status& status) {
if (tassert) {
tassert(status);
} else {
uassertStatusOK(status);
}
};
static constexpr auto failpointMsg = "Failing command via 'failCommand' failpoint"_sd;
if (closeConnection) {
opCtx->getClient()->session()->end();
LOGV2(20431,
"Failing {command} via 'failCommand' failpoint: closing connection",
"command"_attr = cmd->getName());
raise(Status(tassert ? ErrorCodes::Error(5704000) : ErrorCodes::Error(50985),
failpointMsg));
}
auto errorExtraInfo = [&]() -> boost::optional<BSONObj> {
BSONElement e;
Status st = bsonExtractTypedField(data, "errorExtraInfo", BSONType::Object, &e);
if (st == ErrorCodes::NoSuchKey)
return {}; // It's optional. Missing is allowed. Other errors aren't.
uassertStatusOK(st);
return {e.Obj()};
}();
if (errorExtraInfo) {
LOGV2(20434,
"Failing {command} via 'failCommand' failpoint: returning {errorCode} and "
"{errorExtraInfo}",
"command"_attr = cmd->getName(),
"errorCode"_attr = errorCode,
"errorExtraInfo"_attr = errorExtraInfo);
raise(Status(ErrorCodes::Error(errorCode), failpointMsg, *errorExtraInfo));
} else if (hasErrorCode) {
LOGV2(
20435,
"Failing command {command} via 'failCommand' failpoint: returning {errorCode}",
"command"_attr = cmd->getName(),
"errorCode"_attr = errorCode);
raise(Status(ErrorCodes::Error(errorCode), failpointMsg));
}
},
[&](const BSONObj& data) {
closeConnection = data.hasField("closeConnection") &&
bsonExtractBooleanField(data, "closeConnection", &closeConnection).isOK() &&
closeConnection;
hasErrorCode = data.hasField("errorCode") &&
bsonExtractIntegerField(data, "errorCode", &errorCode).isOK();
blockConnection = data.hasField("blockConnection") &&
bsonExtractBooleanField(data, "blockConnection", &blockConnection).isOK() &&
blockConnection;
return shouldActivateFailCommandFailPoint(data, invocation, opCtx->getClient()) &&
(closeConnection || blockConnection || hasErrorCode);
});
}
void CommandHelpers::handleMarkKillOnClientDisconnect(OperationContext* opCtx,
bool shouldMarkKill) {
if (opCtx->getClient()->isInDirectClient()) {
return;
}
if (shouldMarkKill) {
opCtx->markKillOnClientDisconnect();
}
waitInCommandMarkKillOnClientDisconnect.executeIf(
[&](const BSONObj&) { waitInCommandMarkKillOnClientDisconnect.pauseWhileSet(opCtx); },
[&](const BSONObj& obj) {
auto md = ClientMetadata::get(opCtx->getClient());
return md && (md->getApplicationName() == obj["appName"].str());
});
}
namespace {
// We store the CommandInvocation as a shared_ptr on the OperationContext in case we need to persist
// the invocation past the lifetime of the op. If so, this shared_ptr can be copied off to another
// thread. If not, there is only one shared_ptr and the invocation goes out of scope when the op
// ends.
auto invocationForOpCtx = OperationContext::declareDecoration<std::shared_ptr<CommandInvocation>>();
} // namespace
//////////////////////////////////////////////////////////////
// CommandInvocation
void CommandInvocation::set(OperationContext* opCtx,
std::shared_ptr<CommandInvocation> invocation) {
invocationForOpCtx(opCtx) = std::move(invocation);
}
std::shared_ptr<CommandInvocation> CommandInvocation::get(OperationContext* opCtx) {
return invocationForOpCtx(opCtx);
}
CommandInvocation::~CommandInvocation() = default;
void CommandInvocation::checkAuthorization(OperationContext* opCtx,
const OpMsgRequest& request) const {
// Always send an authorization event to audit log, even if OK.
// Not using a scope guard because auditLogAuthEvent could conceivably throw.
try {
const Command* c = definition();
if (checkAuthorizationImplPreParse(opCtx, c, request)) {
// Blanket authorization: don't need to check anything else.
} else {
try {
doCheckAuthorization(opCtx);
} catch (const ExceptionFor<ErrorCodes::Unauthorized>&) {
namespace mmb = mutablebson;
mmb::Document cmdToLog(request.body, mmb::Document::kInPlaceDisabled);
c->snipForLogging(&cmdToLog);
auto dbname = request.getDatabase();
uasserted(ErrorCodes::Unauthorized,
str::stream() << "not authorized on " << dbname << " to execute command "
<< redact(cmdToLog.getObject()));
}
}
} catch (const DBException& e) {
LOGV2_OPTIONS(20436,
{LogComponent::kAccessControl},
"Checking authorization failed: {error}",
"Checking authorization failed",
"error"_attr = e.toStatus());
CommandHelpers::auditLogAuthEvent(opCtx, this, request, e.code());
throw;
}
CommandHelpers::auditLogAuthEvent(opCtx, this, request, ErrorCodes::OK);
}
//////////////////////////////////////////////////////////////
// Command
class BasicCommandWithReplyBuilderInterface::Invocation final : public CommandInvocation {
public:
Invocation(OperationContext*,
const OpMsgRequest& request,
BasicCommandWithReplyBuilderInterface* command)
: CommandInvocation(command),
_command(command),
_request(request),
_dbName(_request.getDatabase().toString()) {}
private:
void run(OperationContext* opCtx, rpc::ReplyBuilderInterface* result) override {
opCtx->lockState()->setDebugInfo(redact(_request.body).toString());
bool ok = _command->runWithReplyBuilder(opCtx, _dbName, _request.body, result);
if (!ok) {
BSONObjBuilder bob = result->getBodyBuilder();
CommandHelpers::appendSimpleCommandStatus(bob, ok);
}
}
Future<void> runAsync(std::shared_ptr<RequestExecutionContext> rec) override {
return _command->runAsync(rec, _dbName).onError([rec](Status status) {
if (status.code() != ErrorCodes::FailedToRunWithReplyBuilder)
return status;
BSONObjBuilder bob = rec->getReplyBuilder()->getBodyBuilder();
CommandHelpers::appendSimpleCommandStatus(bob, false);
return Status::OK();
});
}
void explain(OperationContext* opCtx,
ExplainOptions::Verbosity verbosity,
rpc::ReplyBuilderInterface* result) override {
uassertStatusOK(_command->explain(opCtx, _request, verbosity, result));
}
NamespaceString ns() const override {
return NamespaceString(_command->parseNs(_dbName, cmdObj()));
}
bool supportsWriteConcern() const override {
return _command->supportsWriteConcern(cmdObj());
}
ReadConcernSupportResult supportsReadConcern(repl::ReadConcernLevel level,
bool isImplicitDefault) const override {
return _command->supportsReadConcern(cmdObj(), level, isImplicitDefault);
}
bool supportsReadMirroring() const override {
return _command->supportsReadMirroring(cmdObj());
}
void appendMirrorableRequest(BSONObjBuilder* bob) const override {
invariant(cmdObj().isOwned());
_command->appendMirrorableRequest(bob, cmdObj());
}
bool allowsAfterClusterTime() const override {
return _command->allowsAfterClusterTime(cmdObj());
}
bool canIgnorePrepareConflicts() const override {
return _command->canIgnorePrepareConflicts();
}
void doCheckAuthorization(OperationContext* opCtx) const override {
uassertStatusOK(_command->checkAuthForOperation(
opCtx, _request.getDatabase().toString(), _request.body));
}
const BSONObj& cmdObj() const {
return _request.body;
}
BasicCommandWithReplyBuilderInterface* const _command;
const OpMsgRequest _request;
const std::string _dbName;
};
Command::~Command() = default;
void Command::snipForLogging(mutablebson::Document* cmdObj) const {
auto sensitiveFields = sensitiveFieldNames();
if (!sensitiveFields.empty()) {
for (auto& sensitiveField : sensitiveFields) {
for (mutablebson::Element element =
mutablebson::findFirstChildNamed(cmdObj->root(), sensitiveField);
element.ok();
element = mutablebson::findElementNamed(element.rightSibling(), sensitiveField)) {
uassertStatusOK(element.setValueString("xxx"));
}
}
}
}
std::unique_ptr<CommandInvocation> BasicCommandWithReplyBuilderInterface::parse(
OperationContext* opCtx, const OpMsgRequest& request) {
CommandHelpers::uassertNoDocumentSequences(getName(), request);
return std::make_unique<Invocation>(opCtx, request, this);
}
Command::Command(StringData name, std::vector<StringData> aliases)
: _name(name.toString()),
_aliases(std::move(aliases)),
_commandsExecutedMetric("commands." + _name + ".total", &_commandsExecuted),
_commandsFailedMetric("commands." + _name + ".failed", &_commandsFailed) {
globalCommandRegistry()->registerCommand(this, _name, _aliases);
}
const std::set<std::string>& Command::apiVersions() const {
return kNoApiVersions;
}
const std::set<std::string>& Command::deprecatedApiVersions() const {
return kNoApiVersions;
}
bool Command::hasAlias(const StringData& alias) const {
return globalCommandRegistry()->findCommand(alias) == this;
}
Status BasicCommandWithReplyBuilderInterface::explain(OperationContext* opCtx,
const OpMsgRequest& request,
ExplainOptions::Verbosity verbosity,
rpc::ReplyBuilderInterface* result) const {
return {ErrorCodes::IllegalOperation, str::stream() << "Cannot explain cmd: " << getName()};
}