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
|
/**
* Copyright (C) 2013 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 <algorithm>
#include <set>
#include "mongo/base/status.h"
#include "mongo/db/auth/privilege.h"
#include "mongo/db/auth/role_name.h"
#include "mongo/platform/unordered_map.h"
#include "mongo/platform/unordered_set.h"
namespace mongo {
/**
* A graph of role and privilege relationships.
*
* This structure is used to store an in-memory representation of the admin.system.roledata
* collection, specifically the graph of which roles are members of other roles and what
* privileges each role has, both directly and transitively through membership in other roles.
* There are some restrictions on calls to getAllPrivileges(), specifically, one must call
* recomputePrivilegeData() before calling getAllPrivileges() if any of the mutation methods
* have been called on the instance since the later of its construction or the last call to
* recomputePrivilegeData() on the object.
*/
class RoleGraph {
public:
RoleGraph();
RoleGraph(const RoleGraph& other);
~RoleGraph();
// Swaps the contents of this RoleGraph with those of "other"
void swap(RoleGraph& other);
/**
* Returns an iterator that can be used to get a list of the members of the given role.
* Members of a role are roles that have been granted this role directly (roles that are
* members transitively through another role are not included). These are the "parents" of
* this node in the graph. The iterator is valid until the next call to addRole or
* removeRole.
*/
RoleNameIterator getDirectMembers(const RoleName& role) const;
/**
* Returns an iterator that can be used to get a list of "subordinate" roles of the given
* role. Subordinate roles are the roles that this role has been granted directly (roles
* that have been granted transitively through another role are not included). These are
* the "children" of this node in the graph. The iterator is valid until the next call to
* addRole or removeRole.
*/
RoleNameIterator getDirectSubordinates(const RoleName& role) const;
/**
* Returns a vector of the privileges that the given role has been directly granted.
* Privileges that have been granted transitively through this role's subordinate roles are
* not included.
*/
const PrivilegeVector& getDirectPrivileges(const RoleName& role) const;
/**
* Returns a vector of all privileges that the given role contains. This includes both the
* privileges that have been granted to this role directly, as well as any privileges
* inherited from the role's subordinate roles.
*/
const PrivilegeVector& getAllPrivileges(const RoleName& role) const;
/**
* Returns whether or not the given role exists in the role graph.
*/
bool roleExists(const RoleName& role) const;
// Mutation functions
/**
* Puts an entry into the RoleGraph for the given RoleName.
* Returns DuplicateKey if the role already exists.
*/
Status createRole(const RoleName& role);
/**
* Deletes the given role by first removing it from the members/subordinates arrays for
* all other roles, and then by removing its own entries in the 4 member maps.
* Returns RoleNotFound if the role doesn't exist.
*/
Status deleteRole(const RoleName& role);
/**
* Grants "role" to "recipient". This leaves "recipient" as a member of "role" and "role"
* as a subordinate of "recipient".
* Returns RoleNotFound if either of "role" or "recipient" doesn't exist in
* the RoleGraph.
*/
Status addRoleToRole(const RoleName& recipient, const RoleName& role);
/**
* Revokes "role" from "recipient".
* Returns RoleNotFound if either of "role" or "recipient" doesn't exist in
* the RoleGraph. Returns RolesNotRelated if "recipient" is not currently a
* member of "role".
*/
Status removeRoleFromRole(const RoleName& recipient, const RoleName& role);
/**
* Grants "privilegeToAdd" to "role".
* Returns RoleNotFound if "role" doesn't exist in the role graph.
*/
Status addPrivilegeToRole(const RoleName& role, const Privilege& privilegeToAdd);
/**
* Grants Privileges from "privilegesToAdd" to "role".
* Returns RoleNotFound if "role" doesn't exist in the role graph.
*/
Status addPrivilegesToRole(const RoleName& role, const PrivilegeVector& privilegesToAdd);
/**
* Removes "privilegeToRemove" from "role".
* Returns RoleNotFound if "role" doesn't exist in the role graph.
* Returns PrivilegeNotFound if "role" doesn't contain the full privilege being removed.
*/
Status removePrivilegeFromRole(const RoleName& role,
const Privilege& privilegeToRemove);
/**
* Removes all privileges in the "privilegesToRemove" vector from "role".
* Returns RoleNotFound if "role" doesn't exist in the role graph.
* Returns PrivilegeNotFound if "role" is missing any of the privileges being removed. If
* PrivilegeNotFound is returned then the graph may be in an inconsistent state and needs to
* be abandoned.
*/
Status removePrivilegesFromRole(const RoleName& role,
const PrivilegeVector& privilegesToRemove);
/**
* Removes all privileges from "role".
* Returns RoleNotFound if "role" doesn't exist in the role graph.
*/
Status removeAllPrivilegesFromRole(const RoleName& role);
/**
* Recomputes the indirect (getAllPrivileges) data for this graph.
*
* Must be called between calls to any of the mutation functions and calls
* to getAllPrivileges().
*
* Returns Status::OK() on success. If a cycle is detected, returns
* ErrorCodes::GraphContainsCycle, and the status message reveals the cycle.
*/
Status recomputePrivilegeData();
private:
// Helper method for recursively doing a topological DFS to compute the indirect privilege
// data and look for cycles
Status _recomputePrivilegeDataHelper(const RoleName& currentRole,
std::vector<RoleName>& inProgressRoles,
unordered_set<RoleName>& visitedRoles);
// Represents all the outgoing edges to other roles from any given role.
typedef unordered_map<RoleName, unordered_set<RoleName> > EdgeSet;
// Maps a role name to a list of privileges associated with that role.
typedef unordered_map<RoleName, PrivilegeVector> RolePrivilegeMap;
EdgeSet _roleToSubordinates;
EdgeSet _roleToMembers;
RolePrivilegeMap _directPrivilegesForRole;
RolePrivilegeMap _allPrivilegesForRole;
};
void swap(RoleGraph& lhs, RoleGraph& rhs);
} // namespace mongo
|
