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
|
/**
* 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.
*/
#pragma once
#include <memory>
#include <string>
#include <vector>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/shim.h"
#include "mongo/base/status.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/auth/privilege_format.h"
#include "mongo/db/auth/role_name.h"
#include "mongo/db/auth/user.h"
#include "mongo/db/auth/user_name.h"
#include "mongo/db/jsobj.h"
#include "mongo/stdx/functional.h"
namespace mongo {
class AuthzSessionExternalState;
class OperationContext;
/**
* Public interface for a class that encapsulates all the information related to system
* state not stored in AuthorizationManager. This is primarily to make AuthorizationManager
* easier to test as well as to allow different implementations for mongos and mongod.
*/
class AuthzManagerExternalState {
AuthzManagerExternalState(const AuthzManagerExternalState&) = delete;
AuthzManagerExternalState& operator=(const AuthzManagerExternalState&) = delete;
public:
static MONGO_DECLARE_SHIM(()->std::unique_ptr<AuthzManagerExternalState>) create;
virtual ~AuthzManagerExternalState();
/**
* Initializes the external state object. Must be called after construction and before
* calling other methods. Object may not be used after this method returns something other
* than Status::OK().
*/
virtual Status initialize(OperationContext* opCtx) = 0;
/**
* Creates an external state manipulator for an AuthorizationSession whose
* AuthorizationManager uses this object as its own external state manipulator.
*/
virtual std::unique_ptr<AuthzSessionExternalState> makeAuthzSessionExternalState(
AuthorizationManager* authzManager) = 0;
/**
* Retrieves the schema version of the persistent data describing users and roles.
* Will leave *outVersion unmodified on non-OK status return values.
*/
virtual Status getStoredAuthorizationVersion(OperationContext* opCtx, int* outVersion) = 0;
/**
* Writes into "result" a document describing the named user and returns Status::OK(). The
* description includes the user credentials and customData, if present, the user's role
* membership and delegation information, a full list of the user's privileges, and a full
* list of the user's roles, including those roles held implicitly through other roles
* (indirect roles). In the event that some of this information is inconsistent, the
* document will contain a "warnings" array, with std::string messages describing
* inconsistencies.
*
* If the user does not exist, returns ErrorCodes::UserNotFound.
*/
virtual Status getUserDescription(OperationContext* opCtx,
const UserName& userName,
BSONObj* result) = 0;
/**
* Writes into "result" a document describing the named role and returns Status::OK(). If
* showPrivileges is kOmit or kShowPrivileges, the description includes the roles which the
* named role is a member of, including those memberships held implicitly through other roles
* (indirect roles). If "showPrivileges" is kShowPrivileges, then the description documents
* will also include a full list of the role's privileges. If "showPrivileges" is
* kShowAsUserFragment, then the description returned will take the form of a partial user
* document, describing a hypothetical user which possesses the provided and implicit roles,
* and all inherited privileges. In the event that some of this information is inconsistent,
* the document will contain a "warnings" array, with std::string messages describing
* inconsistencies.
*
* If the role does not exist, returns ErrorCodes::RoleNotFound.
*/
virtual Status getRoleDescription(OperationContext* opCtx,
const RoleName& roleName,
PrivilegeFormat showPrivileges,
AuthenticationRestrictionsFormat,
BSONObj* result) = 0;
/**
* Writes into "result" a document describing the named role is and returns Status::OK(). If
* showPrivileges is kOmit or kShowPrivileges, the description includes the roles which the
* named roles are a member of, including those memberships held implicitly through other roles
* (indirect roles). If "showPrivileges" is kShowPrivileges, then the description documents
* will also include a full list of the roles' privileges. If "showPrivileges" is
* kShowAsUserFragment, then the description returned will take the form of a partial user
* document, describing a hypothetical user which possesses the provided and implicit roles,
* and all inherited privileges. In the event that some of this information is inconsistent,
* the document will contain a "warnings" array, with std::string messages describing
* inconsistencies.
*/
virtual Status getRolesDescription(OperationContext* opCtx,
const std::vector<RoleName>& roles,
PrivilegeFormat showPrivileges,
AuthenticationRestrictionsFormat,
BSONObj* result) = 0;
/**
* Writes into "result" documents describing the roles that are defined on the given
* database. If showPrivileges is kOmit or kShowPrivileges, then a vector of BSON documents are
* returned, where each document includes the other roles a particular role is a
* member of, including those role memberships held implicitly through other roles
* (indirect roles). If showPrivileges is kShowPrivileges, then the description documents
* will also include a full list of the roles' privileges. If showBuiltinRoles is true, then
* the result array will contain description documents for all the builtin roles for the given
* database, if it is false the result will just include user defined roles. In the event that
* some of the information in a given role description is inconsistent, the document will
* contain a "warnings" array, with std::string messages describing inconsistencies.
*/
virtual Status getRoleDescriptionsForDB(OperationContext* opCtx,
StringData dbname,
PrivilegeFormat showPrivileges,
AuthenticationRestrictionsFormat,
bool showBuiltinRoles,
std::vector<BSONObj>* result) = 0;
/**
* Returns true if there exists at least one privilege document in the system.
*/
virtual bool hasAnyPrivilegeDocuments(OperationContext* opCtx) = 0;
virtual void logOp(OperationContext* opCtx,
const char* op,
const NamespaceString& ns,
const BSONObj& o,
const BSONObj* o2) {}
/**
* Represents a lock_guard on the storage for this implementation of the external state.
*/
class StateLock {
StateLock(StateLock&) = delete;
StateLock& operator=(StateLock&) = delete;
public:
StateLock() = default;
virtual ~StateLock() = default;
};
/**
* Returns a Lock on the external state for the given operation context.
*
* By default this returns an empty/noop StateLock.
*/
virtual std::unique_ptr<StateLock> lock(OperationContext* opCtx) {
return std::make_unique<StateLock>();
};
/**
* Returns true if you must acquire a StateLock before fetching a user description.
*
* By default this returns false since only mongod actually needs to do locking at this level.
*/
virtual bool needsLockForUserName(OperationContext* opCtx, const UserName& user) {
return false;
}
protected:
AuthzManagerExternalState(); // This class should never be instantiated directly.
/**
* Returns true if roles for this user were provided by the client, and can be obtained from
* the connection.
*/
bool shouldUseRolesFromConnection(OperationContext* opCtx, const UserName& username);
};
} // namespace mongo
|
