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
|
/**
* 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 <string>
#include <vector>
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/auth/privilege.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"
namespace mongo {
namespace auth {
struct CreateOrUpdateUserArgs {
UserName userName;
bool hasPassword;
std::string password;
bool hasCustomData;
BSONObj customData;
bool hasRoles;
std::vector<RoleName> roles;
boost::optional<BSONArray> authenticationRestrictions;
std::vector<std::string> mechanisms;
bool digestPassword;
CreateOrUpdateUserArgs()
: hasPassword(false), hasCustomData(false), hasRoles(false), digestPassword(true) {}
};
/**
* Takes a command object describing an invocation of the "createUser" or "updateUser" commands
* (which command it is is specified in "cmdName") on the database "dbname", and parses out all
* the arguments into the "parsedArgs" output param.
*/
Status parseCreateOrUpdateUserCommands(const BSONObj& cmdObj,
StringData cmdName,
const std::string& dbname,
CreateOrUpdateUserArgs* parsedArgs);
/**
* Takes a command object describing an invocation of one of "grantRolesToUser",
* "revokeRolesFromUser", "grantDelegateRolesToUser", "revokeDelegateRolesFromUser",
* "grantRolesToRole", and "revokeRolesFromRoles" (which command it is is specified in the
* "cmdName" argument), and parses out (into the parsedName out param) the user/role name of
* the user/roles being modified, the roles being granted or revoked, and the write concern to
* use.
*/
Status parseRolePossessionManipulationCommands(const BSONObj& cmdObj,
StringData cmdName,
const std::string& dbname,
std::string* parsedName,
std::vector<RoleName>* parsedRoleNames);
/**
* Takes a command object describing an invocation of the "dropUser" command and parses out
* the UserName of the user to be removed.
* Also validates the input and returns a non-ok Status if there is anything wrong.
*/
Status parseAndValidateDropUserCommand(const BSONObj& cmdObj,
const std::string& dbname,
UserName* parsedUserName);
/**
* Takes a command object describing an invocation of the "dropAllUsersFromDatabase" command and
* parses out the write concern.
* Also validates the input and returns a non-ok Status if there is anything wrong.
*/
Status parseAndValidateDropAllUsersFromDatabaseCommand(const BSONObj& cmdObj,
const std::string& dbname);
struct UsersInfoArgs {
enum class Target { kExplicitUsers, kDB, kGlobal };
std::vector<UserName> userNames;
Target target;
bool showPrivileges = false;
AuthenticationRestrictionsFormat authenticationRestrictionsFormat =
AuthenticationRestrictionsFormat::kOmit;
bool showCredentials = false;
boost::optional<BSONObj> filter;
};
/**
* Takes a command object describing an invocation of the "usersInfo" command and parses out
* all the arguments into the "parsedArgs" output param.
*/
Status parseUsersInfoCommand(const BSONObj& cmdObj, StringData dbname, UsersInfoArgs* parsedArgs);
struct RolesInfoArgs {
std::vector<RoleName> roleNames;
bool allForDB = false;
PrivilegeFormat privilegeFormat = PrivilegeFormat::kOmit;
AuthenticationRestrictionsFormat authenticationRestrictionsFormat =
AuthenticationRestrictionsFormat::kOmit;
bool showBuiltinRoles = false;
};
/**
* Takes a command object describing an invocation of the "rolesInfo" command and parses out
* the arguments into the "parsedArgs" output param.
*/
Status parseRolesInfoCommand(const BSONObj& cmdObj, StringData dbname, RolesInfoArgs* parsedArgs);
struct CreateOrUpdateRoleArgs {
RoleName roleName;
bool hasRoles = false;
std::vector<RoleName> roles;
bool hasPrivileges = false;
PrivilegeVector privileges;
boost::optional<BSONArray> authenticationRestrictions;
};
/**
* Takes a command object describing an invocation of the "createRole" or "updateRole" commands
* (which command it is is specified in "cmdName") on the database "dbname", and parses out all
* the arguments into the "parsedArgs" output param.
*/
Status parseCreateOrUpdateRoleCommands(const BSONObj& cmdObj,
StringData cmdName,
const std::string& dbname,
CreateOrUpdateRoleArgs* parsedArgs);
/**
* Takes a command object describing an invocation of the "grantPrivilegesToRole" or
* "revokePrivilegesFromRole" commands, and parses out the role name of the
* role being modified, the privileges being granted or revoked, and the write concern to use.
*/
Status parseAndValidateRolePrivilegeManipulationCommands(const BSONObj& cmdObj,
StringData cmdName,
const std::string& dbname,
RoleName* parsedRoleName,
PrivilegeVector* parsedPrivileges);
/**
* Takes a command object describing an invocation of the "dropRole" command and parses out
* the RoleName of the role to be removed.
*/
Status parseDropRoleCommand(const BSONObj& cmdObj,
const std::string& dbname,
RoleName* parsedRoleName);
/**
* Takes a command object describing an invocation of the "dropAllRolesFromDatabase" command and
* parses out the write concern.
*/
Status parseDropAllRolesFromDatabaseCommand(const BSONObj& cmdObj, const std::string& dbname);
/**
* Parses the privileges described in "privileges" into a vector of Privilege objects.
* Returns Status::OK() upon successfully parsing all the elements of "privileges".
*/
Status parseAndValidatePrivilegeArray(const BSONArray& privileges,
PrivilegeVector* parsedPrivileges);
/**
* Takes a BSONArray of name,db pair documents, parses that array and returns (via the
* output param parsedRoleNames) a list of the role names in the input array.
* Performs syntactic validation of "rolesArray", only.
*/
Status parseRoleNamesFromBSONArray(const BSONArray& rolesArray,
StringData dbname,
std::vector<RoleName>* parsedRoleNames);
/**
* Takes a BSONArray of name,db pair documents, parses that array and returns (via the
* output param parsedUserNames) a list of the usernames in the input array.
* Performs syntactic validation of "usersArray", only.
*/
Status parseUserNamesFromBSONArray(const BSONArray& usersArray,
StringData dbname,
std::vector<UserName>* parsedUserNames);
struct MergeAuthzCollectionsArgs {
std::string usersCollName;
std::string rolesCollName;
std::string db;
bool drop;
MergeAuthzCollectionsArgs() : drop(false) {}
};
/**
* Takes a command object describing an invocation of the "_mergeAuthzCollections" command and
* parses out the name of the temporary collections to use for user and role data, whether or
* not to drop the existing users/roles, the database if this is a for a db-specific restore.
* Returns ErrorCodes::OutdatedClient if the "db" field is missing, as that likely indicates
* the command was sent by an outdated (pre 2.6.4) version of mongorestore.
* Returns other codes indicating missing or incorrectly typed fields.
*/
Status parseMergeAuthzCollectionsCommand(const BSONObj& cmdObj,
MergeAuthzCollectionsArgs* parsedArgs);
} // namespace auth
} // namespace mongo
|
