summaryrefslogtreecommitdiff
path: root/src/mongo/db/auth/builtin_roles.tpl.cpp
blob: b698f34fce7725b33c34851fe99262fbb6021d99 (plain)
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) 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/platform/basic.h"

#include "mongo/db/auth/builtin_roles.h"

#include <map>

#include "mongo/base/string_data.h"
#include "mongo/base/string_data_comparator_interface.h"
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/privilege.h"
#include "mongo/db/auth/resource_pattern.h"

namespace mongo {
namespace {
constexpr auto kAdminDB = "admin"_sd;

/* Forward declarations so that inheritance calls don't have to worry about order.
 * Warning: Potential for infinite recursion here, so inherit your roles wisely.
 */

//#for $role in $roles
void addPrivileges_${role.name}(PrivilegeVector* privileges, StringData dbName);
//#end for

/* Implemenations */

//## Use current name if `db` wasn't specified,
//## or override it with an explicit value if it was.
//#def dbName($db)
//#if $db is None
//#echo 'dbName'
//#else
//#echo '"' + $db + '"_sd'
//#end if
//#end def

//#for $role in $roles
void addPrivileges_${role.name}(PrivilegeVector* privileges, StringData dbName) {
    //#if $role.adminOnly
    /* Admin only builtin role */
    fassert(6837401, dbName == kAdminDB);
    //#end if

    //#for $subrole in $role.roles
    addPrivileges_${subrole.role}(privileges, $dbName($subrole.db));
    //#end for

    //#for $priv in $role.privileges
    Privilege::addPrivilegeToPrivilegeVector(
        privileges,
        Privilege(
            //#if $priv.matchType == 'any'
            ResourcePattern::forAnyResource(),
            //#elif $priv.matchType == 'any_normal'
            ResourcePattern::forAnyNormalResource(),
            //#elif $priv.matchType == 'cluster'
            ResourcePattern::forClusterResource(),
            //#elif $priv.matchType == 'database'
            ResourcePattern::forDatabaseName($dbName($priv.db)),
            //#elif $priv.matchType == 'collection'
            ResourcePattern::forCollectionName("$priv.collection"_sd),
            //#elif $priv.matchType == 'exact_namespace'
            ResourcePattern::forExactNamespace(
                NamespaceString($dbName($priv.db), "$priv.collection"_sd)),
            //#elif $priv.matchType == 'any_system_buckets'
            ResourcePattern::forAnySystemBuckets(),
            //#elif $priv.matchType == 'system_buckets_in_any_db'
            ResourcePattern::forAnySystemBucketsInAnyDatabase("$priv.system_buckets"_sd),
            //#elif $priv.matchType == 'system_buckets'
            ResourcePattern::forExactSystemBucketsCollection($dbName($priv.db),
                                                             "$priv.system_buckets"_sd),
            //#elif $priv.matchType == 'any_system_buckets_in_db'
            ResourcePattern::forAnySystemBucketsInDatabase($dbName($priv.db)),
            //#else
            //#assert False
            //#end if
            ActionSet({
                //#for action in $priv.actions
                ActionType::$action,
                //#end for
            })));
    //#end for

    //## Special case for __system.admin
    //#if $role.name == "__system"
    //#assert $role.adminOnly
    ActionSet allActions;
    allActions.addAllActions();
    Privilege::addPrivilegeToPrivilegeVector(
        privileges, Privilege(ResourcePattern::forAnyResource(), allActions));
    //#end if
}

//#end for

using addPrivilegesFn = void (*)(PrivilegeVector*, StringData);
struct BuiltinRoleAttributes {
    bool adminOnly;
    addPrivilegesFn addPrivileges;
};

//#def boolval($val)
//#if $val
//#echo 'true'
//#else
//#echo 'false'
//#end if
//#end def

const std::map<StringData, BuiltinRoleAttributes> kBuiltinRoleMap = {
    //#for $role in $roles
    {"$role.name"_sd, {$boolval($role.adminOnly), addPrivileges_${role.name}}},
    //#end for
};

const stdx::unordered_set<RoleName> kAdminBuiltinRoles = {
    //#for $role in $roles
    RoleName("$role.name"_sd, kAdminDB),
    //#end for
};

// \$external is a virtual database used for X509, LDAP,
// and other authentication mechanisms and not used for storage.
// Therefore, granting privileges on this database does not make sense.
bool isValidDB(const DatabaseName& dbname) {
    return NamespaceString::validDBName(dbname, NamespaceString::DollarInDbNameBehavior::Allow) &&
        (dbname.db() != NamespaceString::kExternalDb);
}

}  // namespace

//#set $global_roles = [role for role in $roles if role.adminOnly == False]
//#set $admin_only_roles = [role for role in $roles if role.adminOnly == True]
//##
stdx::unordered_set<RoleName> auth::getBuiltinRoleNamesForDB(const DatabaseName& dbName) {
    if (!isValidDB(dbName)) {
        return {};
    }

    if (dbName.db() == kAdminDB) {
        return kAdminBuiltinRoles;
    }

    return stdx::unordered_set<RoleName>({
        //#for $role in $global_roles
        RoleName("$role.name"_sd, dbName),
        //#end for
    });
}

void auth::generateUniversalPrivileges(PrivilegeVector* privileges) {
    addPrivileges___system(privileges, kAdminDB);
}

bool auth::addPrivilegesForBuiltinRole(const RoleName& role, PrivilegeVector* privileges) {
    if (!isValidDB(role.getDatabaseName())) {
        return false;
    }

    auto it = kBuiltinRoleMap.find(role.getRole());
    if (it == kBuiltinRoleMap.end()) {
        return false;
    }

    const auto& def = it->second;
    if (def.adminOnly && (role.getDB() != kAdminDB)) {
        return false;
    }

    def.addPrivileges(privileges, role.getDB());
    return true;
}

bool auth::isBuiltinRole(const RoleName& role) {
    if (!isValidDB(role.getDatabaseName())) {
        return false;
    }

    auto it = kBuiltinRoleMap.find(role.getRole());
    if (it == kBuiltinRoleMap.end()) {
        return false;
    }

    return !it->second.adminOnly || (role.getDB() == kAdminDB);
}

}  // namespace mongo