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
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/auth/authz_manager_external_state_local.h"
#include "mongo/base/status.h"
#include "mongo/bson/util/bson_extract.h"
#include "mongo/db/auth/address_restriction.h"
#include "mongo/db/auth/auth_options_gen.h"
#include "mongo/db/auth/auth_types_gen.h"
#include "mongo/db/auth/privilege_parser.h"
#include "mongo/db/auth/user_document_parser.h"
#include "mongo/db/multitenancy.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/server_options.h"
#include "mongo/db/storage/snapshot_manager.h"
#include "mongo/db/tenant_id.h"
#include "mongo/logv2/log.h"
#include "mongo/util/duration.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/net/ssl_types.h"
#include "mongo/util/str.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kAccessControl
namespace mongo {
using std::vector;
using ResolveRoleOption = AuthzManagerExternalStateLocal::ResolveRoleOption;
Status AuthzManagerExternalStateLocal::getStoredAuthorizationVersion(OperationContext* opCtx,
int* outVersion) {
BSONObj versionDoc;
Status status = findOne(opCtx,
AuthorizationManager::versionCollectionNamespace,
AuthorizationManager::versionDocumentQuery,
&versionDoc);
if (status.isOK()) {
BSONElement versionElement = versionDoc[AuthorizationManager::schemaVersionFieldName];
if (versionElement.isNumber()) {
*outVersion = versionElement.numberInt();
return Status::OK();
} else if (versionElement.eoo()) {
return Status(ErrorCodes::NoSuchKey,
str::stream() << "No " << AuthorizationManager::schemaVersionFieldName
<< " field in version document.");
} else {
return Status(ErrorCodes::TypeMismatch,
str::stream()
<< "Could not determine schema version of authorization data. "
"Bad (non-numeric) type "
<< typeName(versionElement.type()) << " (" << versionElement.type()
<< ") for " << AuthorizationManager::schemaVersionFieldName
<< " field in version document");
}
} else if (status == ErrorCodes::NoMatchingDocument) {
*outVersion = AuthorizationManager::schemaVersion28SCRAM;
return Status::OK();
} else {
return status;
}
}
namespace {
NamespaceString getUsersCollection(const boost::optional<TenantId>& tenant) {
return NamespaceString(tenant, NamespaceString::kAdminDb, NamespaceString::kSystemUsers);
}
NamespaceString getRolesCollection(const boost::optional<TenantId>& tenant) {
return NamespaceString(tenant, NamespaceString::kAdminDb, NamespaceString::kSystemRoles);
}
void serializeResolvedRoles(BSONObjBuilder* user,
const AuthzManagerExternalState::ResolvedRoleData& data,
boost::optional<const BSONObj&> roleDoc = boost::none) {
BSONArrayBuilder rolesBuilder(user->subarrayStart("inheritedRoles"));
for (const auto& roleName : data.roles.get()) {
roleName.serializeToBSON(&rolesBuilder);
}
rolesBuilder.doneFast();
if (data.privileges) {
BSONArrayBuilder privsBuilder(user->subarrayStart("inheritedPrivileges"));
if (roleDoc) {
auto privs = roleDoc.get()["privileges"];
if (privs) {
for (const auto& privilege : privs.Obj()) {
privsBuilder.append(privilege);
}
}
}
for (const auto& privilege : data.privileges.get()) {
privsBuilder.append(privilege.toBSON());
}
privsBuilder.doneFast();
}
if (data.restrictions) {
BSONArrayBuilder arBuilder(user->subarrayStart("inheritedAuthenticationRestrictions"));
if (roleDoc) {
auto ar = roleDoc.get()["authenticationRestrictions"];
if ((ar.type() == Array) && (ar.Obj().nFields() > 0)) {
arBuilder.append(ar);
}
}
if (auto ar = data.restrictions->toBSON(); ar.nFields() > 0) {
// TODO: SERVER-50283 Refactor UnnamedRestriction BSON serialization APIs.
for (const auto& elem : ar) {
arBuilder.append(elem);
}
}
arBuilder.doneFast();
}
}
/**
* Make sure the roleDoc as retreived from storage matches expectations for options.
*/
constexpr auto kRolesFieldName = "roles"_sd;
constexpr auto kPrivilegesFieldName = "privileges"_sd;
constexpr auto kAuthenticationRestrictionFieldName = "authenticationRestrictions"_sd;
std::vector<RoleName> filterAndMapRole(BSONObjBuilder* builder,
BSONObj role,
ResolveRoleOption option,
bool liftAuthenticationRestrictions,
const boost::optional<TenantId>& tenant) {
std::vector<RoleName> subRoles;
bool sawRestrictions = false;
for (const auto& elem : role) {
if (elem.fieldNameStringData() == kRolesFieldName) {
uassert(
ErrorCodes::BadValue, "Invalid roles field, expected array", elem.type() == Array);
for (const auto& roleName : elem.Obj()) {
subRoles.push_back(RoleName::parseFromBSON(roleName, tenant));
}
if ((option & ResolveRoleOption::kRoles) == 0) {
continue;
}
}
if ((elem.fieldNameStringData() == kPrivilegesFieldName) &&
((option & ResolveRoleOption::kPrivileges) == 0)) {
continue;
}
if (elem.fieldNameStringData() == kAuthenticationRestrictionFieldName) {
sawRestrictions = true;
if (option & ResolveRoleOption::kRestrictions) {
if (liftAuthenticationRestrictions) {
// For a rolesInfo invocation, we need to lift ARs up into a container.
BSONArrayBuilder arBuilder(
builder->subarrayStart(kAuthenticationRestrictionFieldName));
arBuilder.append(elem);
arBuilder.doneFast();
} else {
// For a usersInfo invocation, we leave it as is.
builder->append(elem);
}
}
continue;
}
builder->append(elem);
}
if (!sawRestrictions && (option & ResolveRoleOption::kRestrictions)) {
builder->append(kAuthenticationRestrictionFieldName, BSONArray());
}
return subRoles;
}
ResolveRoleOption makeResolveRoleOption(PrivilegeFormat showPrivileges,
AuthenticationRestrictionsFormat showRestrictions) {
auto option = ResolveRoleOption::kRoles;
if (showPrivileges != PrivilegeFormat::kOmit) {
option = static_cast<ResolveRoleOption>(option | ResolveRoleOption::kPrivileges);
}
if (showRestrictions != AuthenticationRestrictionsFormat::kOmit) {
option = static_cast<ResolveRoleOption>(option | ResolveRoleOption::kRestrictions);
}
return option;
}
MONGO_FAIL_POINT_DEFINE(authLocalGetUser);
void handleAuthLocalGetUserFailPoint(const std::vector<RoleName>& directRoles) {
auto sfp = authLocalGetUser.scoped();
if (!sfp.isActive()) {
return;
}
IDLParserErrorContext ctx("authLocalGetUser");
auto delay = AuthLocalGetUserFailPoint::parse(ctx, sfp.getData()).getResolveRolesDelayMS();
if (delay <= 0) {
return;
}
LOGV2_DEBUG(4859400,
3,
"Sleeping prior to merging direct roles, after user acquisition",
"duration"_attr = Milliseconds(delay),
"directRoles"_attr = directRoles);
sleepmillis(delay);
}
} // namespace
// We ignore tenant-specific collections here, since hasAnyPrivilegeDocuments
// only impacts localhost auth bypass which by definition will be a local user.
bool AuthzManagerExternalStateLocal::hasAnyPrivilegeDocuments(OperationContext* opCtx) {
if (_hasAnyPrivilegeDocuments.load()) {
return true;
}
BSONObj userBSONObj;
Status statusFindUsers =
findOne(opCtx, AuthorizationManager::usersCollectionNamespace, BSONObj(), &userBSONObj);
// If we were unable to complete the query,
// it's best to assume that there _are_ privilege documents.
if (statusFindUsers != ErrorCodes::NoMatchingDocument) {
_hasAnyPrivilegeDocuments.store(true);
return true;
}
Status statusFindRoles =
findOne(opCtx, AuthorizationManager::rolesCollectionNamespace, BSONObj(), &userBSONObj);
if (statusFindRoles != ErrorCodes::NoMatchingDocument) {
_hasAnyPrivilegeDocuments.store(true);
return true;
}
return false;
}
AuthzManagerExternalStateLocal::RolesLocks::RolesLocks(OperationContext* opCtx,
const boost::optional<TenantId>& tenant) {
if (!storageGlobalParams.disableLockFreeReads) {
_readLockFree = std::make_unique<AutoReadLockFree>(opCtx);
} else {
_adminLock = std::make_unique<Lock::DBLock>(
opCtx, DatabaseName(boost::none, NamespaceString::kAdminDb), LockMode::MODE_IS);
_rolesLock = std::make_unique<Lock::CollectionLock>(
opCtx, getRolesCollection(tenant), LockMode::MODE_S);
}
}
AuthzManagerExternalStateLocal::RolesLocks::~RolesLocks() {
_readLockFree.reset(nullptr);
_rolesLock.reset(nullptr);
_adminLock.reset(nullptr);
}
AuthzManagerExternalStateLocal::RolesLocks AuthzManagerExternalStateLocal::_lockRoles(
OperationContext* opCtx, const boost::optional<TenantId>& tenant) {
return AuthzManagerExternalStateLocal::RolesLocks(opCtx, tenant);
}
StatusWith<User> AuthzManagerExternalStateLocal::getUserObject(OperationContext* opCtx,
const UserRequest& userReq) try {
const UserName& userName = userReq.name;
std::vector<RoleName> directRoles;
User user(userReq.name);
auto rolesLock = _lockRoles(opCtx, userName.getTenant());
if (!userReq.roles) {
// Normal path: Acquire a user from the local store by UserName.
BSONObj userDoc;
auto status =
findOne(opCtx, getUsersCollection(userName.getTenant()), userName.toBSON(), &userDoc);
if (!status.isOK()) {
if (status == ErrorCodes::NoMatchingDocument) {
return {ErrorCodes::UserNotFound,
str::stream() << "Could not find user \"" << userName.getUser()
<< "\" for db \"" << userName.getDB() << "\""};
}
return status;
}
V2UserDocumentParser userDocParser;
userDocParser.setTenantId(userReq.name.getTenant());
uassertStatusOK(userDocParser.initializeUserFromUserDocument(userDoc, &user));
for (auto iter = user.getRoles(); iter.more();) {
directRoles.push_back(iter.next());
}
} else {
// Proxy path. Some other external mechanism (e.g. X509 or LDAP) has acquired
// a base user definition with a set of immediate roles.
// We're being asked to use the local roles collection to derive privileges,
// subordinate roles, and authentication restrictions.
directRoles = std::vector<RoleName>(userReq.roles->cbegin(), userReq.roles->cend());
User::CredentialData credentials;
credentials.isExternal = true;
user.setCredentials(credentials);
user.setRoles(makeRoleNameIteratorForContainer(directRoles));
}
if (auto tenant = userName.getTenant()) {
// Apply TenantID for user to all roles (which are assumed to be part of the same tenant).
for (auto& role : directRoles) {
role = RoleName(role.getRole(), role.getDB(), tenant);
}
}
handleAuthLocalGetUserFailPoint(directRoles);
auto data = uassertStatusOK(resolveRoles(opCtx, directRoles, ResolveRoleOption::kAll));
data.roles->insert(directRoles.cbegin(), directRoles.cend());
user.setIndirectRoles(makeRoleNameIteratorForContainer(data.roles.get()));
user.addPrivileges(data.privileges.get());
user.setIndirectRestrictions(data.restrictions.get());
LOGV2_DEBUG(5517200,
3,
"Acquired new user object",
"userName"_attr = userName,
"directRoles"_attr = directRoles);
return std::move(user);
} catch (const AssertionException& ex) {
return ex.toStatus();
}
Status AuthzManagerExternalStateLocal::getUserDescription(OperationContext* opCtx,
const UserRequest& userReq,
BSONObj* result) try {
const UserName& userName = userReq.name;
std::vector<RoleName> directRoles;
BSONObjBuilder resultBuilder;
auto rolesLock = _lockRoles(opCtx, userName.getTenant());
if (!userReq.roles) {
BSONObj userDoc;
auto status =
findOne(opCtx, getUsersCollection(userName.getTenant()), userName.toBSON(), &userDoc);
if (!status.isOK()) {
if (status == ErrorCodes::NoMatchingDocument) {
return {ErrorCodes::UserNotFound,
str::stream() << "Could not find user \"" << userName.getUser()
<< "\" for db \"" << userName.getDB() << "\""};
}
return status;
}
directRoles = filterAndMapRole(
&resultBuilder, userDoc, ResolveRoleOption::kAll, false, userName.getTenant());
} else {
uassert(ErrorCodes::BadValue,
"Illegal combination of pre-defined roles with tenant identifier",
userName.getTenant() == boost::none);
// We are able to artifically construct the external user from the request
resultBuilder.append("_id", str::stream() << userName.getDB() << '.' << userName.getUser());
resultBuilder.append("user", userName.getUser());
resultBuilder.append("db", userName.getDB());
resultBuilder.append("credentials", BSON("external" << true));
directRoles = std::vector<RoleName>(userReq.roles->cbegin(), userReq.roles->cend());
BSONArrayBuilder rolesBuilder(resultBuilder.subarrayStart("roles"));
for (const RoleName& role : directRoles) {
rolesBuilder.append(role.toBSON());
}
rolesBuilder.doneFast();
}
if (auto tenant = userName.getTenant()) {
// Apply TenantID for user to all roles (which are assumed to be part of the same tenant).
for (auto& role : directRoles) {
role = RoleName(role.getRole(), role.getDB(), tenant);
}
}
handleAuthLocalGetUserFailPoint(directRoles);
auto data = uassertStatusOK(resolveRoles(opCtx, directRoles, ResolveRoleOption::kAll));
data.roles->insert(directRoles.cbegin(), directRoles.cend());
serializeResolvedRoles(&resultBuilder, data);
*result = resultBuilder.obj();
return Status::OK();
} catch (const AssertionException& ex) {
return ex.toStatus();
}
Status AuthzManagerExternalStateLocal::rolesExist(OperationContext* opCtx,
const std::vector<RoleName>& roleNames) {
// Perform DB queries for user-defined roles (skipping builtin roles).
stdx::unordered_set<RoleName> unknownRoles;
for (const auto& roleName : roleNames) {
if (!auth::isBuiltinRole(roleName) &&
!hasOne(opCtx, getRolesCollection(roleName.getTenant()), roleName.toBSON())) {
unknownRoles.insert(roleName);
}
}
// If anything remains, raise it as an unknown role error.
if (!unknownRoles.empty()) {
return makeRoleNotFoundStatus(unknownRoles);
}
return Status::OK();
}
using ResolvedRoleData = AuthzManagerExternalState::ResolvedRoleData;
StatusWith<ResolvedRoleData> AuthzManagerExternalStateLocal::resolveRoles(
OperationContext* opCtx, const std::vector<RoleName>& roleNames, ResolveRoleOption option) try {
using RoleNameSet = typename decltype(ResolvedRoleData::roles)::value_type;
const bool processRoles = option & ResolveRoleOption::kRoles;
const bool processPrivs = option & ResolveRoleOption::kPrivileges;
const bool processRests = option & ResolveRoleOption::kRestrictions;
const bool walkIndirect = (option & ResolveRoleOption::kDirectOnly) == 0;
RoleNameSet inheritedRoles;
PrivilegeVector inheritedPrivileges;
RestrictionDocuments::sequence_type inheritedRestrictions;
RoleNameSet frontier(roleNames.cbegin(), roleNames.cend());
RoleNameSet visited;
while (!frontier.empty()) {
RoleNameSet nextFrontier;
for (const auto& role : frontier) {
visited.insert(role);
if (auth::isBuiltinRole(role)) {
if (processPrivs) {
invariant(auth::addPrivilegesForBuiltinRole(role, &inheritedPrivileges));
}
continue;
}
BSONObj roleDoc;
auto status =
findOne(opCtx, getRolesCollection(role.getTenant()), role.toBSON(), &roleDoc);
if (!status.isOK()) {
if (status.code() == ErrorCodes::NoMatchingDocument) {
LOGV2(5029200, "Role does not exist", "role"_attr = role);
continue;
}
return status;
}
BSONElement elem;
if ((processRoles || walkIndirect) && (elem = roleDoc["roles"])) {
if (elem.type() != Array) {
return {ErrorCodes::BadValue,
str::stream()
<< "Invalid 'roles' field in role document '" << role
<< "', expected an array but found " << typeName(elem.type())};
}
for (const auto& subroleElem : elem.Obj()) {
auto subrole = RoleName::parseFromBSON(subroleElem, role.getTenant());
if (visited.count(subrole) || nextFrontier.count(subrole)) {
continue;
}
if (walkIndirect) {
nextFrontier.insert(subrole);
}
if (processRoles) {
inheritedRoles.insert(std::move(subrole));
}
}
}
if (processPrivs && (elem = roleDoc["privileges"])) {
if (elem.type() != Array) {
return {ErrorCodes::UnsupportedFormat,
str::stream()
<< "Invalid 'privileges' field in role document '" << role << "'"};
}
for (const auto& privElem : elem.Obj()) {
auto priv = Privilege::fromBSON(privElem);
Privilege::addPrivilegeToPrivilegeVector(&inheritedPrivileges, priv);
}
}
if (processRests && (elem = roleDoc["authenticationRestrictions"])) {
if (elem.type() != Array) {
return {ErrorCodes::UnsupportedFormat,
str::stream()
<< "Invalid 'authenticationRestrictions' field in role document '"
<< role << "'"};
}
inheritedRestrictions.push_back(
uassertStatusOK(parseAuthenticationRestriction(BSONArray(elem.Obj()))));
}
}
frontier = std::move(nextFrontier);
}
ResolvedRoleData ret;
if (processRoles) {
ret.roles = std::move(inheritedRoles);
}
if (processPrivs) {
ret.privileges = std::move(inheritedPrivileges);
}
if (processRests) {
ret.restrictions = RestrictionDocuments(std::move(inheritedRestrictions));
}
return ret;
} catch (const AssertionException& ex) {
return ex.toStatus();
}
Status AuthzManagerExternalStateLocal::getRolesAsUserFragment(
OperationContext* opCtx,
const std::vector<RoleName>& roleNames,
AuthenticationRestrictionsFormat showRestrictions,
BSONObj* result) {
auto option = makeResolveRoleOption(PrivilegeFormat::kShowAsUserFragment, showRestrictions);
BSONObjBuilder fragment;
BSONArrayBuilder rolesBuilder(fragment.subarrayStart("roles"));
for (const auto& roleName : roleNames) {
roleName.serializeToBSON(&rolesBuilder);
}
rolesBuilder.doneFast();
auto swData = resolveRoles(opCtx, roleNames, option);
if (!swData.isOK()) {
return swData.getStatus();
}
auto data = std::move(swData.getValue());
data.roles->insert(roleNames.cbegin(), roleNames.cend());
serializeResolvedRoles(&fragment, data);
*result = fragment.obj();
return Status::OK();
}
Status AuthzManagerExternalStateLocal::getRolesDescription(
OperationContext* opCtx,
const std::vector<RoleName>& roleNames,
PrivilegeFormat showPrivileges,
AuthenticationRestrictionsFormat showRestrictions,
std::vector<BSONObj>* result) {
if (showPrivileges == PrivilegeFormat::kShowAsUserFragment) {
// Shouldn't be called this way, but cope if we are.
BSONObj fragment;
auto status = getRolesAsUserFragment(opCtx, roleNames, showRestrictions, &fragment);
if (status.isOK()) {
result->push_back(fragment);
}
return status;
}
auto option = makeResolveRoleOption(showPrivileges, showRestrictions);
for (const auto& role : roleNames) {
try {
BSONObj roleDoc;
if (auth::isBuiltinRole(role)) {
// Synthesize builtin role from definition.
PrivilegeVector privs;
uassert(ErrorCodes::OperationFailed,
"Failed generating builtin role privileges",
auth::addPrivilegesForBuiltinRole(role, &privs));
BSONObjBuilder builtinBuilder;
builtinBuilder.append("db", role.getDB());
builtinBuilder.append("role", role.getRole());
builtinBuilder.append("roles", BSONArray());
if (showPrivileges == PrivilegeFormat::kShowSeparate) {
BSONArrayBuilder builtinPrivs(builtinBuilder.subarrayStart("privileges"));
for (const auto& priv : privs) {
builtinPrivs.append(priv.toBSON());
}
builtinPrivs.doneFast();
}
roleDoc = builtinBuilder.obj();
} else {
auto status =
findOne(opCtx, getRolesCollection(role.getTenant()), role.toBSON(), &roleDoc);
if (status.code() == ErrorCodes::NoMatchingDocument) {
continue;
}
uassertStatusOK(status); // throws
}
BSONObjBuilder roleBuilder;
auto subRoles = filterAndMapRole(&roleBuilder, roleDoc, option, true, role.getTenant());
auto data = uassertStatusOK(resolveRoles(opCtx, subRoles, option));
data.roles->insert(subRoles.cbegin(), subRoles.cend());
serializeResolvedRoles(&roleBuilder, data, roleDoc);
roleBuilder.append("isBuiltin", auth::isBuiltinRole(role));
result->push_back(roleBuilder.obj());
} catch (const AssertionException& ex) {
return {ex.code(),
str::stream() << "Failed fetching role '" << role << "': " << ex.reason()};
}
}
return Status::OK();
}
Status AuthzManagerExternalStateLocal::getRoleDescriptionsForDB(
OperationContext* opCtx,
const DatabaseName& dbname,
PrivilegeFormat showPrivileges,
AuthenticationRestrictionsFormat showRestrictions,
bool showBuiltinRoles,
std::vector<BSONObj>* result) {
auto option = makeResolveRoleOption(showPrivileges, showRestrictions);
if (showPrivileges == PrivilegeFormat::kShowAsUserFragment) {
return {ErrorCodes::IllegalOperation,
"Cannot get user fragment for all roles in a database"};
}
if (showBuiltinRoles) {
for (const auto& roleName : auth::getBuiltinRoleNamesForDB(dbname)) {
BSONObjBuilder roleBuilder;
roleBuilder.append(AuthorizationManager::ROLE_NAME_FIELD_NAME, roleName.getRole());
roleBuilder.append(AuthorizationManager::ROLE_DB_FIELD_NAME, roleName.getDB());
roleBuilder.append("isBuiltin", true);
roleBuilder.append("roles", BSONArray());
roleBuilder.append("inheritedRoles", BSONArray());
if (showPrivileges == PrivilegeFormat::kShowSeparate) {
BSONArrayBuilder privsBuilder(roleBuilder.subarrayStart("privileges"));
PrivilegeVector privs;
invariant(auth::addPrivilegesForBuiltinRole(roleName, &privs));
for (const auto& privilege : privs) {
privsBuilder.append(privilege.toBSON());
}
privsBuilder.doneFast();
// Builtin roles have identival privs/inheritedPrivs
BSONArrayBuilder ipBuilder(roleBuilder.subarrayStart("inheritedPrivileges"));
for (const auto& privilege : privs) {
ipBuilder.append(privilege.toBSON());
}
ipBuilder.doneFast();
}
if (showRestrictions == AuthenticationRestrictionsFormat::kShow) {
roleBuilder.append("authenticationRestrictions", BSONArray());
roleBuilder.append("inheritedAuthenticationRestrictions", BSONArray());
}
result->push_back(roleBuilder.obj());
}
}
return query(opCtx,
getRolesCollection(dbname.tenantId()),
BSON(AuthorizationManager::ROLE_DB_FIELD_NAME << dbname.db()),
BSONObj(),
[&](const BSONObj& roleDoc) {
try {
BSONObjBuilder roleBuilder;
auto subRoles = filterAndMapRole(
&roleBuilder, roleDoc, option, true, dbname.tenantId());
roleBuilder.append("isBuiltin", false);
auto data = uassertStatusOK(resolveRoles(opCtx, subRoles, option));
data.roles->insert(subRoles.cbegin(), subRoles.cend());
serializeResolvedRoles(&roleBuilder, data, roleDoc);
result->push_back(roleBuilder.obj());
return Status::OK();
} catch (const AssertionException& ex) {
return ex.toStatus();
}
});
}
/**
* Below this point is the implementation of our OpObserver handler.
*
* Ops which mutate user documents will invalidate those specific users
* from the UserCache.
*
* Any other privilege related op (mutation to roles or version collection,
* or command issued on the admin namespace) will invalidate the entire
* user cache.
*/
namespace {
class AuthzCollection {
public:
enum class AuthzCollectionType {
kNone,
kUsers,
kRoles,
kVersion,
kAdmin,
};
AuthzCollection() = default;
explicit AuthzCollection(const NamespaceString& nss) : _tenant(nss.tenantId()) {
// Capture events regardless of what Tenant they occured in,
// invalidators will purge cache on a per-tenant basis as needed.
auto db = nss.dbName().db();
auto coll = nss.coll();
if (db != NamespaceString::kAdminDb) {
return;
}
// System-only collections.
if (coll == AuthorizationManager::versionCollectionNamespace.coll()) {
_type = AuthzCollectionType::kVersion;
return;
}
if (coll == AuthorizationManager::adminCommandNamespace.coll()) {
_type = AuthzCollectionType::kAdmin;
return;
}
if (coll == NamespaceString::kSystemUsers) {
// admin.system.users or {tenantID}_admin.system.users
_type = AuthzCollectionType::kUsers;
return;
}
if (coll == NamespaceString::kSystemRoles) {
// admin.system.roles or {tenantID}_admin.system.roles
_type = AuthzCollectionType::kRoles;
return;
}
}
operator bool() const {
return _type != AuthzCollectionType::kNone;
}
bool isPrivilegeCollection() const {
return (_type == AuthzCollectionType::kUsers) || (_type == AuthzCollectionType::kRoles);
}
AuthzCollectionType getType() const {
return _type;
}
const boost::optional<TenantId>& getTenant() const {
return _tenant;
}
private:
AuthzCollectionType _type = AuthzCollectionType::kNone;
boost::optional<TenantId> _tenant;
};
constexpr auto kOpInsert = "i"_sd;
constexpr auto kOpUpdate = "u"_sd;
constexpr auto kOpDelete = "d"_sd;
void _invalidateUserCache(OperationContext* opCtx,
AuthorizationManagerImpl* authzManager,
StringData op,
AuthzCollection coll,
const BSONObj& o,
const BSONObj* o2) {
if ((coll.getType() == AuthzCollection::AuthzCollectionType::kUsers) &&
((op == kOpInsert) || (op == kOpUpdate) || (op == kOpDelete))) {
const BSONObj* src = (op == kOpUpdate) ? o2 : &o;
auto id = (*src)["_id"].str();
auto splitPoint = id.find('.');
if (splitPoint == std::string::npos) {
LOGV2_WARNING(23749,
"Invalidating user cache based on user being updated failed, will "
"invalidate the entire cache instead",
"error"_attr =
Status(ErrorCodes::FailedToParse,
str::stream() << "_id entries for user documents must be of "
"the form <dbname>.<username>. Found: "
<< id));
authzManager->invalidateUserCache(opCtx);
return;
}
UserName userName(id.substr(splitPoint + 1), id.substr(0, splitPoint), coll.getTenant());
authzManager->invalidateUserByName(opCtx, userName);
} else if (const auto& tenant = coll.getTenant()) {
authzManager->invalidateUsersByTenant(opCtx, tenant.get());
} else {
authzManager->invalidateUserCache(opCtx);
}
}
} // namespace
void AuthzManagerExternalStateLocal::logOp(OperationContext* opCtx,
AuthorizationManagerImpl* authzManager,
StringData op,
const NamespaceString& nss,
const BSONObj& o,
const BSONObj* o2) {
AuthzCollection coll(nss);
if (!coll) {
return;
}
_invalidateUserCache(opCtx, authzManager, op, coll, o, o2);
if (coll.isPrivilegeCollection() && (op == kOpInsert)) {
_hasAnyPrivilegeDocuments.store(true);
}
}
} // namespace mongo
|