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
|
/**
* 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 <iosfwd>
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/db/auth/action_type_gen.h"
#include "mongo/db/namespace_string.h"
namespace mongo {
/**
* Representation of names of various kinds of resources targetable by the access control
* system.
*
* Three of the types of name, "forDatabaseName", "forExactNamespace" and "forClusterResource",
* can represent concrete resources targeted for manipulation by database operations. All of
* the types also act as patterns, useful for matching against groups of concrete resources as
* part of the access control system. See buildResourceSearchList() in
* authorization_session.cpp for details.
*/
class ResourcePattern {
friend class AuthorizationContract;
public:
/**
* Returns a pattern that matches absolutely any resource.
*/
static ResourcePattern forAnyResource() {
return ResourcePattern(MatchTypeEnum::kMatchAnyResource);
}
/**
* Returns a pattern that matches any database or collection resource except collections for
* which ns.isSystem().
*/
static ResourcePattern forAnyNormalResource() {
return ResourcePattern(MatchTypeEnum::kMatchAnyNormalResource);
}
/**
* Returns a pattern that matches the "cluster" resource.
*/
static ResourcePattern forClusterResource() {
return ResourcePattern(MatchTypeEnum::kMatchClusterResource);
}
/**
* Returns a pattern that matches the named database, and NamespaceStrings
* "ns" for which ns.isSystem() is false and ns.db() == dbname.
*/
static ResourcePattern forDatabaseName(StringData dbName) {
return ResourcePattern(MatchTypeEnum::kMatchDatabaseName, NamespaceString(dbName, ""));
}
/**
* Returns a pattern that matches NamespaceStrings "ns" for which ns.coll() ==
* collectionName.
*/
static ResourcePattern forCollectionName(StringData collectionName) {
return ResourcePattern(MatchTypeEnum::kMatchCollectionName,
NamespaceString("", collectionName));
}
/**
* Returns a pattern that matches the given exact namespace string.
*/
static ResourcePattern forExactNamespace(const NamespaceString& ns) {
return ResourcePattern(MatchTypeEnum::kMatchExactNamespace, ns);
}
/**
* Constructs a pattern that never matches.
*/
ResourcePattern() : _matchType(MatchTypeEnum::kMatchNever) {}
/**
* Returns true if this pattern matches only exact namespaces.
*/
bool isExactNamespacePattern() const {
return _matchType == MatchTypeEnum::kMatchExactNamespace;
}
/**
* Returns true if this pattern matches on the database name only.
*/
bool isDatabasePattern() const {
return _matchType == MatchTypeEnum::kMatchDatabaseName;
}
/**
* Returns true if this pattern matches on the collection name only.
*/
bool isCollectionPattern() const {
return _matchType == MatchTypeEnum::kMatchCollectionName;
}
/**
* Returns true if this pattern matches the cluster resource only.
*/
bool isClusterResourcePattern() const {
return _matchType == MatchTypeEnum::kMatchClusterResource;
}
/**
* Returns true if this pattern matches only any normal resource.
*/
bool isAnyNormalResourcePattern() const {
return _matchType == MatchTypeEnum::kMatchAnyNormalResource;
}
/**
* Returns true if this pattern matches any resource.
*/
bool isAnyResourcePattern() const {
return _matchType == MatchTypeEnum::kMatchAnyResource;
}
/**
* Returns the namespace that this pattern matches.
*
* Behavior is undefined unless isExactNamespacePattern() is true.
*/
const NamespaceString& ns() const {
return _ns;
}
/**
* Returns the database that this pattern matches.
*
* Behavior is undefined unless the pattern is of type matchDatabaseName or
* matchExactNamespace
*/
StringData databaseToMatch() const {
return _ns.db();
}
/**
* Returns the collection that this pattern matches.
*
* Behavior is undefined unless the pattern is of type matchCollectionName or
* matchExactNamespace
*/
StringData collectionToMatch() const {
return _ns.coll();
}
std::string toString() const;
bool operator==(const ResourcePattern& other) const {
if (_matchType != other._matchType)
return false;
if (_ns != other._ns)
return false;
return true;
}
template <typename H>
friend H AbslHashValue(H h, const ResourcePattern& rp) {
return H::combine(std::move(h), rp._ns, rp._matchType);
}
/**
* Returns a pattern for IDL generated code to use.
*/
static ResourcePattern forAuthorizationContract(MatchTypeEnum e) {
return ResourcePattern(e);
}
private:
// AuthorizationContract works directly with MatchTypeEnum. Users should not be concerned with
// how a ResourcePattern was constructed.
MatchTypeEnum matchType() const {
return _matchType;
}
private:
explicit ResourcePattern(MatchTypeEnum type) : _matchType(type) {}
ResourcePattern(MatchTypeEnum type, const NamespaceString& ns) : _matchType(type), _ns(ns) {}
MatchTypeEnum _matchType;
NamespaceString _ns;
};
std::ostream& operator<<(std::ostream& os, const ResourcePattern& pattern);
} // namespace mongo
|
