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
|
/**
* Copyright (C) 2012 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 <string>
#include <vector>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.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/authz_session_external_state.h"
#include "mongo/db/auth/privilege.h"
#include "mongo/db/auth/user_name.h"
#include "mongo/db/auth/user_set.h"
#include "mongo/db/namespace_string.h"
namespace mongo {
/**
* Contains all the authorization logic for a single client connection. It contains a set of
* the users which have been authenticated, as well as a set of privileges that have been
* granted to those users to perform various actions.
*
* An AuthorizationSession object is present within every mongo::ClientBasic object.
*
* Users in the _authenticatedUsers cache may get marked as invalid by the AuthorizationManager,
* for instance if their privileges are changed by a user or role modification command. At the
* beginning of every user-initiated operation startRequest() gets called which updates
* the cached information about any users who have been marked as invalid. This guarantees that
* every operation looks at one consistent view of each user for every auth check required over
* the lifetime of the operation.
*/
class AuthorizationSession {
MONGO_DISALLOW_COPYING(AuthorizationSession);
public:
// Takes ownership of the externalState.
explicit AuthorizationSession(AuthzSessionExternalState* externalState);
~AuthorizationSession();
AuthorizationManager& getAuthorizationManager();
// Should be called at the beginning of every new request. This performs the checks
// necessary to determine if localhost connections should be given full access.
// TODO: try to eliminate the need for this call.
void startRequest();
/**
* Adds the User identified by "UserName" to the authorization session, acquiring privileges
* for it in the process.
*/
Status addAndAuthorizeUser(const UserName& userName);
// Returns the authenticated user with the given name. Returns NULL
// if no such user is found.
// The user remains in the _authenticatedUsers set for this AuthorizationSession,
// and ownership of the user stays with the AuthorizationManager
User* lookupUser(const UserName& name);
// Gets an iterator over the names of all authenticated users stored in this manager.
UserNameIterator getAuthenticatedUserNames();
// Returns a std::string representing all logged-in users on the current session.
// WARNING: this std::string will contain NUL bytes so don't call c_str()!
std::string getAuthenticatedUserNamesToken();
// Removes any authenticated principals whose authorization credentials came from the given
// database, and revokes any privileges that were granted via that principal.
void logoutDatabase(const std::string& dbname);
// Adds the internalSecurity user to the set of authenticated users.
// Used to grant internal threads full access.
void grantInternalAuthorization();
// Generates a vector of default privileges that are granted to any user,
// regardless of which roles that user does or does not possess.
// If localhost exception is active, the permissions include the ability to create
// the first user and the ability to run the commands needed to bootstrap the system
// into a state where the first user can be created.
PrivilegeVector getDefaultPrivileges();
// Checks if this connection has the privileges necessary to perform the given query on the
// given namespace.
Status checkAuthForQuery(const NamespaceString& ns, const BSONObj& query);
// Checks if this connection has the privileges necessary to perform a getMore on the given
// cursor in the given namespace.
Status checkAuthForGetMore(const NamespaceString& ns, long long cursorID);
// Checks if this connection has the privileges necessary to perform the given update on the
// given namespace.
Status checkAuthForUpdate(const NamespaceString& ns,
const BSONObj& query,
const BSONObj& update,
bool upsert);
// Checks if this connection has the privileges necessary to insert the given document
// to the given namespace. Correctly interprets inserts to system.indexes and performs
// the proper auth checks for index building.
Status checkAuthForInsert(const NamespaceString& ns, const BSONObj& document);
// Checks if this connection has the privileges necessary to perform a delete on the given
// namespace.
Status checkAuthForDelete(const NamespaceString& ns, const BSONObj& query);
// Checks if this connection has the privileges necessary to grant the given privilege
// to a role.
Status checkAuthorizedToGrantPrivilege(const Privilege& privilege);
// Checks if this connection has the privileges necessary to revoke the given privilege
// from a role.
Status checkAuthorizedToRevokePrivilege(const Privilege& privilege);
// Utility function for isAuthorizedForActionsOnResource(
// ResourcePattern::forDatabaseName(role.getDB()), ActionType::grantAnyRole)
bool isAuthorizedToGrantRole(const RoleName& role);
// Utility function for isAuthorizedForActionsOnResource(
// ResourcePattern::forDatabaseName(role.getDB()), ActionType::grantAnyRole)
bool isAuthorizedToRevokeRole(const RoleName& role);
// Returns true if the current session is authenticated as the given user and that user
// is allowed to change his/her own password
bool isAuthorizedToChangeOwnPasswordAsUser(const UserName& userName);
// Returns true if the current session is authenticated as the given user and that user
// is allowed to change his/her own customData.
bool isAuthorizedToChangeOwnCustomDataAsUser(const UserName& userName);
// Returns true if any of the authenticated users on this session have the given role.
// NOTE: this does not refresh any of the users even if they are marked as invalid.
bool isAuthenticatedAsUserWithRole(const RoleName& roleName);
// Returns true if this session is authorized for the given Privilege.
//
// Contains all the authorization logic including handling things like the localhost
// exception.
bool isAuthorizedForPrivilege(const Privilege& privilege);
// Like isAuthorizedForPrivilege, above, except returns true if the session is authorized
// for all of the listed privileges.
bool isAuthorizedForPrivileges(const std::vector<Privilege>& privileges);
// Utility function for isAuthorizedForPrivilege(Privilege(resource, action)).
bool isAuthorizedForActionsOnResource(const ResourcePattern& resource, ActionType action);
// Utility function for isAuthorizedForPrivilege(Privilege(resource, actions)).
bool isAuthorizedForActionsOnResource(const ResourcePattern& resource,
const ActionSet& actions);
// Utility function for
// isAuthorizedForActionsOnResource(ResourcePattern::forExactNamespace(ns), action).
bool isAuthorizedForActionsOnNamespace(const NamespaceString& ns, ActionType action);
// Utility function for
// isAuthorizedForActionsOnResource(ResourcePattern::forExactNamespace(ns), actions).
bool isAuthorizedForActionsOnNamespace(const NamespaceString& ns, const ActionSet& actions);
// Replaces the vector of UserNames that a system user is impersonating with a new vector.
// The auditing system adds these to each audit record in the log.
void setImpersonatedUserNames(const std::vector<UserName>& names);
// Returns an iterator to a vector of impersonated usernames.
UserNameIterator getImpersonatedUserNames() const;
// Clears the vector of impersonated UserNames.
void clearImpersonatedUserNames();
// Tells whether impersonation is active or not. This state is set when
// setImpersonatedUserNames is called and cleared when clearImpersonatedUserNames is
// called.
bool isImpersonating() const;
private:
// If any users authenticated on this session are marked as invalid this updates them with
// up-to-date information. May require a read lock on the "admin" db to read the user data.
void _refreshUserInfoAsNeeded();
// Checks if this connection is authorized for the given Privilege, ignoring whether or not
// we should even be doing authorization checks in general. Note: this may acquire a read
// lock on the admin database (to update out-of-date user privilege information).
bool _isAuthorizedForPrivilege(const Privilege& privilege);
scoped_ptr<AuthzSessionExternalState> _externalState;
// All Users who have been authenticated on this connection
UserSet _authenticatedUsers;
// A vector of impersonated UserNames. These are used in the auditing system.
// They are not used for authz checks.
std::vector<UserName> _impersonatedUserNames;
bool _impersonationFlag;
};
} // namespace mongo
|
