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
|
/*
* 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/user_name.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/namespace_string.h"
namespace mongo {
/**
* 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 {
MONGO_DISALLOW_COPYING(AuthzManagerExternalState);
public:
virtual ~AuthzManagerExternalState();
// Gets the privilege information document for "userName". authzVersion indicates what
// version of the privilege document format is being used, which is needed to know how to
// query for the user's privilege document.
//
// On success, returns Status::OK() and stores a shared-ownership copy of the document into
// "result".
Status getPrivilegeDocument(const UserName& userName,
int authzVersion,
BSONObj* result);
// Returns true if there exists at least one privilege document in the system.
bool hasAnyPrivilegeDocuments();
// Creates the given user object in the given database.
// TODO(spencer): remove dbname argument once users are only written into the admin db
virtual Status insertPrivilegeDocument(const std::string& dbname,
const BSONObj& userObj) = 0;
// Updates the given user object with the given update modifier.
virtual Status updatePrivilegeDocument(const UserName& user,
const BSONObj& updateObj) = 0;
// Removes users for the given database matching the given query.
// Writes into *numRemoved the number of user documents that were modified.
virtual Status removePrivilegeDocuments(const BSONObj& query, int* numRemoved) = 0;
/**
* Puts into the *dbnames vector the name of every database in the cluster.
*/
virtual Status getAllDatabaseNames(std::vector<std::string>* dbnames) = 0;
/**
* Puts into the *privDocs vector every privilege document from the given database's
* system.users collection.
*/
virtual Status getAllV1PrivilegeDocsForDB(const std::string& dbname,
std::vector<BSONObj>* privDocs) = 0;
/**
* Finds a document matching "query" in "collectionName", and store a shared-ownership
* copy into "result".
*
* Returns Status::OK() on success. If no match is found, returns
* ErrorCodes::NoMatchingDocument. Other errors returned as appropriate.
*/
virtual Status findOne(const NamespaceString& collectionName,
const BSONObj& query,
BSONObj* result) = 0;
/**
* Inserts "document" into "collectionName".
*/
virtual Status insert(const NamespaceString& collectionName,
const BSONObj& document) = 0;
/**
* Update one document matching "query" according to "updatePattern" in "collectionName".
*
* If "upsert" is true and no document matches "query", inserts one using "query" as a
* template.
*/
virtual Status updateOne(const NamespaceString& collectionName,
const BSONObj& query,
const BSONObj& updatePattern,
bool upsert) = 0;
/**
* Removes all documents matching "query" from "collectionName".
*/
virtual Status remove(const NamespaceString& collectionName,
const BSONObj& query) = 0;
/**
* Creates an index with the given pattern on "collectionName".
*/
virtual Status createIndex(const NamespaceString& collectionName,
const BSONObj& pattern,
bool unique) = 0;
/**
* Drops the named collection.
*/
virtual Status dropCollection(const NamespaceString& collectionName) = 0;
/**
* Renames collection "oldName" to "newName", possibly dropping the previous
* collection named "newName".
*/
virtual Status renameCollection(const NamespaceString& oldName,
const NamespaceString& newName) = 0;
/**
* Copies the contents of collection "fromName" into "toName". Fails
* if "toName" is already a collection.
*/
virtual Status copyCollection(const NamespaceString& fromName,
const NamespaceString& toName) = 0;
/**
* Tries to acquire the global lock guarding modifications to all persistent data related
* to authorization, namely the admin.system.users, admin.system.roles, and
* admin.system.version collections. This serializes all writers to the authorization
* documents, but does not impact readers.
* This can only be called when already in the AuthorizationManager's _lock.
*/
virtual bool tryAcquireAuthzUpdateLock(const StringData& why) = 0;
/**
* Releases the lock guarding modifications to persistent authorization data, which must
* already be held.
* This can only be called when already in the AuthorizationManager's _lock.
*/
virtual void releaseAuthzUpdateLock() = 0;
protected:
AuthzManagerExternalState(); // This class should never be instantiated directly.
// Queries the userNamespace with the given query and returns the privilegeDocument found
// in *result. Returns Status::OK if it finds a document matching the query. If it doesn't
// find a document matching the query, returns a Status with code UserNotFound. Other
// errors may return other Status codes.
virtual Status _findUser(const std::string& usersNamespace,
const BSONObj& query,
BSONObj* result) = 0;
};
} // namespace mongo
|
