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
|
/**
* Copyright (C) 2022-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.
*/
#include "mongo/util/database_name_util.h"
#include "mongo/db/database_name.h"
#include "mongo/db/multitenancy_gen.h"
#include "mongo/db/server_feature_flags_gen.h"
#include "mongo/util/str.h"
#include <ostream>
#include "mongo/logv2/log_debug.h"
namespace mongo {
std::string DatabaseNameUtil::serialize(const DatabaseName& dbName,
const SerializationContext& context) {
if (!gMultitenancySupport)
dbName.toString();
// TODO SERVER-74284: uncomment to redirect command-sepcific serialization requests
// if (context.getSource() == SerializationContext::Source::Command &&
// context.getCallerType() == SerializationContext::CallerType::Reply)
// return serializeForCommands(dbName, context);
// if we're not serializing a Command Reply, use the default serializing rules
return serializeForStorage(dbName, context);
}
std::string DatabaseNameUtil::serializeForStorage(const DatabaseName& dbName,
const SerializationContext& context) {
if (gFeatureFlagRequireTenantID.isEnabled(serverGlobalParams.featureCompatibility)) {
return dbName.toString();
}
return dbName.toStringWithTenantId();
}
std::string DatabaseNameUtil::serializeForCatalog(const DatabaseName& dbName,
const SerializationContext& context) {
return dbName.toStringWithTenantId();
}
std::string DatabaseNameUtil::serializeForCommands(const DatabaseName& dbName,
const SerializationContext& context) {
// tenantId came from either a $tenant field or security token
if (context.receivedNonPrefixedTenantId()) {
switch (context.getPrefix()) {
case SerializationContext::Prefix::ExcludePrefix:
// fallthrough
case SerializationContext::Prefix::Default:
return dbName.toString();
case SerializationContext::Prefix::IncludePrefix:
return dbName.toStringWithTenantId();
default:
MONGO_UNREACHABLE;
}
}
switch (context.getPrefix()) {
case SerializationContext::Prefix::ExcludePrefix:
return dbName.toString();
case SerializationContext::Prefix::Default:
// fallthrough
case SerializationContext::Prefix::IncludePrefix:
return dbName.toStringWithTenantId();
default:
MONGO_UNREACHABLE;
}
}
DatabaseName DatabaseNameUtil::parseDbNameFromStringExpectTenantIdInMultitenancyMode(
StringData dbName) {
if (!gMultitenancySupport) {
return DatabaseName(boost::none, dbName);
}
auto tenantDelim = dbName.find('_');
if (tenantDelim == std::string::npos) {
return DatabaseName(boost::none, dbName);
}
auto swOID = OID::parse(dbName.substr(0, tenantDelim));
if (swOID.getStatus() == ErrorCodes::BadValue) {
// If we fail to parse an OID, either the size of the substring is incorrect, or there is an
// invalid character. This indicates that the db has the "_" character, but it does not act
// as a delimeter for a tenantId prefix.
return DatabaseName(boost::none, dbName);
}
const TenantId tenantId(swOID.getValue());
return DatabaseName(tenantId, dbName.substr(tenantDelim + 1));
}
DatabaseName DatabaseNameUtil::deserialize(boost::optional<TenantId> tenantId,
StringData db,
const SerializationContext& context) {
if (db.empty()) {
return DatabaseName(tenantId, "");
}
if (!gMultitenancySupport) {
massert(7005302, "TenantId must not be set, but it is: ", tenantId == boost::none);
return DatabaseName(boost::none, db);
}
// TODO SERVER-74284: uncomment to redirect command-sepcific deserialization requests
// if (context.getSource() == SerializationContext::Source::Command &&
// context.getCallerType() == SerializationContext::CallerType::Request)
// return deserializeForCommands(std::move(tenantId), db, context);
// if we're not deserializing a Command Request, use the default deserializing rules
return deserializeForStorage(std::move(tenantId), db, context);
}
DatabaseName DatabaseNameUtil::deserializeForStorage(boost::optional<TenantId> tenantId,
StringData db,
const SerializationContext& context) {
if (gFeatureFlagRequireTenantID.isEnabled(serverGlobalParams.featureCompatibility)) {
// TODO SERVER-73113 Uncomment out this conditional to check that we always have a tenantId.
/* if (db != "admin" && db != "config" && db != "local")
massert(7005300, "TenantId must be set", tenantId != boost::none);
*/
return DatabaseName(std::move(tenantId), db);
}
auto dbName = DatabaseNameUtil::parseDbNameFromStringExpectTenantIdInMultitenancyMode(db);
// TenantId could be prefixed, or passed in separately (or both) and namespace is always
// constructed with the tenantId separately.
if (tenantId != boost::none) {
if (!dbName.tenantId()) {
return DatabaseName(std::move(tenantId), db);
}
massert(7005301, "TenantId must match that in db prefix", tenantId == dbName.tenantId());
}
return dbName;
}
DatabaseName DatabaseNameUtil::deserializeForCommands(boost::optional<TenantId> tenantId,
StringData db,
const SerializationContext& context) {
// we only get here if we are processing a Command Request. We disregard the feature flag in
// this case, essentially letting the request dictate the state of the feature.
if (tenantId != boost::none) {
switch (context.getPrefix()) {
case SerializationContext::Prefix::ExcludePrefix:
// fallthrough
case SerializationContext::Prefix::Default:
return DatabaseName(std::move(tenantId), db);
case SerializationContext::Prefix::IncludePrefix: {
auto dbName = parseDbNameFromStringExpectTenantIdInMultitenancyMode(db);
massert(8423386,
str::stream() << "TenantId from $tenant or security token present as '"
<< tenantId->toString()
<< "' with expectPrefix field set but without a prefix set",
dbName.tenantId());
massert(
8423384,
str::stream()
<< "TenantId from $tenant or security token must match prefixed tenantId: "
<< tenantId->toString() << " prefix " << dbName.tenantId()->toString(),
tenantId.value() == dbName.tenantId());
return dbName;
}
default:
MONGO_UNREACHABLE;
}
}
auto dbName = parseDbNameFromStringExpectTenantIdInMultitenancyMode(db);
if ((dbName != DatabaseName::kAdmin) && (dbName != DatabaseName::kLocal) &&
(dbName != DatabaseName::kConfig))
massert(8423388, "TenantId must be set", dbName.tenantId() != boost::none);
return dbName;
}
DatabaseName DatabaseNameUtil::deserializeForCatalog(StringData db,
const SerializationContext& context) {
// TenantId always prefix in the passed `db` for durable catalog. This method below checks for
// multitenancy and will either return a DatabaseName with (tenantId, nonPrefixedDb) or
// (none, prefixedDb).
return DatabaseNameUtil::parseDbNameFromStringExpectTenantIdInMultitenancyMode(db);
}
} // namespace mongo
|
