summaryrefslogtreecommitdiff
path: root/src/mongo/db/auth/user_document_parser_test.cpp
blob: 0fba05a5168d2101ff2cc8ab03ff98c3de10cb58 (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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/*    Copyright 2012 10gen Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

/**
 * Unit tests of the UserDocumentParser type.
 */

#include "mongo/base/status.h"
#include "mongo/db/auth/action_set.h"
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/auth/user_document_parser.h"
#include "mongo/db/jsobj.h"
#include "mongo/unittest/unittest.h"

#define ASSERT_NULL(EXPR) ASSERT_FALSE(EXPR)
#define ASSERT_NON_NULL(EXPR) ASSERT_TRUE(EXPR)

namespace mongo {
namespace {

    class V1UserDocumentParsing : public ::mongo::unittest::Test {
    public:
        V1UserDocumentParsing() {}

        scoped_ptr<User> user;
        scoped_ptr<User> adminUser;
        V1UserDocumentParser v1parser;

        void setUp() {
            resetUsers();
        }

        void resetUsers() {
            user.reset(new User(UserName("spencer", "test")));
            adminUser.reset(new User(UserName("admin", "admin")));
        }
    };

    TEST_F(V1UserDocumentParsing, testParsingV0UserDocuments) {
        BSONObj readWrite = BSON("user" << "spencer" << "pwd" << "passwordHash");
        BSONObj readOnly = BSON("user" << "spencer" << "pwd" << "passwordHash" <<
                                "readOnly" << true);
        BSONObj readWriteAdmin = BSON("user" << "admin" << "pwd" << "passwordHash");
        BSONObj readOnlyAdmin = BSON("user" << "admin" << "pwd" << "passwordHash" <<
                                     "readOnly" << true);

        ASSERT_OK(v1parser.initializeUserRolesFromUserDocument(
                          user.get(), readOnly, "test"));
        RoleNameIterator roles = user->getRoles();
        ASSERT_EQUALS(RoleName("read", "test"), roles.next());
        ASSERT_FALSE(roles.more());

        resetUsers();
        ASSERT_OK(v1parser.initializeUserRolesFromUserDocument(
                          user.get(), readWrite, "test"));
        roles = user->getRoles();
        ASSERT_EQUALS(RoleName("dbOwner", "test"), roles.next());
        ASSERT_FALSE(roles.more());

        resetUsers();
        ASSERT_OK(v1parser.initializeUserRolesFromUserDocument(
                          adminUser.get(), readOnlyAdmin, "admin"));
        roles = adminUser->getRoles();
        ASSERT_EQUALS(RoleName("readAnyDatabase", "admin"), roles.next());
        ASSERT_FALSE(roles.more());

        resetUsers();
        ASSERT_OK(v1parser.initializeUserRolesFromUserDocument(
                          adminUser.get(), readWriteAdmin, "admin"));
        roles = adminUser->getRoles();
        ASSERT_EQUALS(RoleName("root", "admin"), roles.next());
        ASSERT_FALSE(roles.more());
    }

    TEST_F(V1UserDocumentParsing, VerifyRolesFieldMustBeAnArray) {
        ASSERT_NOT_OK(v1parser.initializeUserRolesFromUserDocument(
                user.get(),
                BSON("user" << "spencer" << "pwd" << "" << "roles" << "read"),
                "test"));
        ASSERT_FALSE(user->getRoles().more());
    }

    TEST_F(V1UserDocumentParsing, VerifySemanticallyInvalidRolesStillParse) {
        ASSERT_OK(v1parser.initializeUserRolesFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "pwd" << "" <<
                     "roles" << BSON_ARRAY("read" << "frim")),
                "test"));
        RoleNameIterator roles = user->getRoles();
        RoleName role = roles.next();
        if (role == RoleName("read", "test")) {
            ASSERT_EQUALS(RoleName("frim", "test"), roles.next());
        } else {
            ASSERT_EQUALS(RoleName("frim", "test"), role);
            ASSERT_EQUALS(RoleName("read", "test"), roles.next());
        }
        ASSERT_FALSE(roles.more());
    }

    TEST_F(V1UserDocumentParsing, VerifyOtherDBRolesMustBeAnObjectOfArraysOfStrings) {
        ASSERT_NOT_OK(v1parser.initializeUserRolesFromUserDocument(
                adminUser.get(),
                BSON("user" << "admin" <<
                     "pwd" << "" <<
                     "roles" << BSON_ARRAY("read") <<
                     "otherDBRoles" << BSON_ARRAY("read")),
                "admin"));

        ASSERT_NOT_OK(v1parser.initializeUserRolesFromUserDocument(
                adminUser.get(),
                BSON("user" << "admin" <<
                     "pwd" << "" <<
                     "roles" << BSON_ARRAY("read") <<
                     "otherDBRoles" << BSON("test2" << "read")),
                "admin"));
    }

    TEST_F(V1UserDocumentParsing, VerifyCannotGrantPrivilegesOnOtherDatabasesNormally) {
        // Cannot grant roles on other databases, except from admin database.
        ASSERT_NOT_OK(v1parser.initializeUserRolesFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "pwd" << "" <<
                     "roles" << BSONArrayBuilder().arr() <<
                     "otherDBRoles" << BSON("test2" << BSON_ARRAY("read"))),
                "test"));
        ASSERT_FALSE(user->getRoles().more());
    }

    TEST_F(V1UserDocumentParsing, GrantUserAdminOnTestViaAdmin) {
        // Grant userAdmin on test via admin.
        ASSERT_OK(v1parser.initializeUserRolesFromUserDocument(
                adminUser.get(),
                BSON("user" << "admin" <<
                     "pwd" << "" <<
                     "roles" << BSONArrayBuilder().arr() <<
                     "otherDBRoles" << BSON("test" << BSON_ARRAY("userAdmin"))),
                "admin"));
        RoleNameIterator roles = adminUser->getRoles();
        ASSERT_EQUALS(RoleName("userAdmin", "test"), roles.next());
        ASSERT_FALSE(roles.more());
    }

    TEST_F(V1UserDocumentParsing, MixedV0V1UserDocumentsAreInvalid) {
        // Try to mix fields from V0 and V1 user documents and make sure it fails.
        ASSERT_NOT_OK(v1parser.initializeUserRolesFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "pwd" << "passwordHash" <<
                     "readOnly" << false <<
                     "roles" << BSON_ARRAY("read")),
                "test"));
        ASSERT_FALSE(user->getRoles().more());
    }

    class V2UserDocumentParsing : public ::mongo::unittest::Test {
    public:
        V2UserDocumentParsing() {}

        scoped_ptr<User> user;
        scoped_ptr<User> adminUser;
        V2UserDocumentParser v2parser;

        void setUp() {
            user.reset(new User(UserName("spencer", "test")));
            adminUser.reset(new User(UserName("admin", "admin")));
        }
    };


    TEST_F(V2UserDocumentParsing, V2DocumentValidation) {
        BSONArray emptyArray = BSONArrayBuilder().arr();

        // V1 documents don't work
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" << "pwd" << "a" <<
                     "roles" << BSON_ARRAY("read"))));

        // Need name field
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << emptyArray)));

        // Need source field
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << emptyArray)));

        // Need credentials field
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "roles" << emptyArray)));

        // Need roles field
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a"))));

        // Don't need credentials field if userSource is $external
        ASSERT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "$external" <<
                     "roles" << emptyArray)));

        // Empty roles arrays are OK
        ASSERT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << emptyArray)));

        // Roles must be objects
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << BSON_ARRAY("read"))));

        // Role needs name
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << BSON_ARRAY(BSON("db" << "dbA")))));

        // Role needs source
        ASSERT_NOT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << BSON_ARRAY(BSON("role" << "roleA")))));


        // Basic valid user document
        ASSERT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << BSON_ARRAY(BSON("role" << "roleA" <<
                                                "db" << "dbA")))));

        // Multiple roles OK
        ASSERT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "roles" << BSON_ARRAY(BSON("role" << "roleA" <<
                                                "db" << "dbA") <<
                                           BSON("role" << "roleB" <<
                                                "db" << "dbB")))));

        // Optional extraData field OK
        ASSERT_OK(v2parser.checkValidUserDocument(
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a") <<
                     "extraData" << BSON("foo" << "bar") <<
                     "roles" << BSON_ARRAY(BSON("role" << "roleA" <<
                                                "db" << "dbA")))));
    }

    TEST_F(V2UserDocumentParsing, V2CredentialExtraction) {
        // Old "pwd" field not valid
        ASSERT_NOT_OK(v2parser.initializeUserCredentialsFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "pwd" << "")));

        // Credentials must be provided (so long as userSource is not $external)
        ASSERT_NOT_OK(v2parser.initializeUserCredentialsFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "db" << "test")));

        // Credentials must be object
        ASSERT_NOT_OK(v2parser.initializeUserCredentialsFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << "a")));

        // Must specify credentials for MONGODB-CR
        ASSERT_NOT_OK(v2parser.initializeUserCredentialsFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("foo" << "bar"))));

        // Make sure extracting valid credentials works
        ASSERT_OK(v2parser.initializeUserCredentialsFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "db" << "test" <<
                     "credentials" << BSON("MONGODB-CR" << "a"))));
        ASSERT(user->getCredentials().password == "a");
        ASSERT(!user->getCredentials().isExternal);

        // Leaving out 'credentials' field is OK so long as userSource is $external
        ASSERT_OK(v2parser.initializeUserCredentialsFromUserDocument(
                user.get(),
                BSON("user" << "spencer" <<
                     "db" << "$external")));
        ASSERT(user->getCredentials().password.empty());
        ASSERT(user->getCredentials().isExternal);

    }

    TEST_F(V2UserDocumentParsing, V2RoleExtraction) {
        // "roles" field must be provided
        ASSERT_NOT_OK(v2parser.initializeUserRolesFromUserDocument(
                BSON("user" << "spencer"),
                user.get()));

        // V1-style roles arrays no longer work
        ASSERT_NOT_OK(v2parser.initializeUserRolesFromUserDocument(
                BSON("user" << "spencer" <<
                     "roles" << BSON_ARRAY("read")),
                user.get()));

        // Roles must have "db" field
        ASSERT_NOT_OK(v2parser.initializeUserRolesFromUserDocument(
                BSON("user" << "spencer" <<
                     "roles" << BSON_ARRAY(BSONObj())),
                user.get()));

        ASSERT_NOT_OK(v2parser.initializeUserRolesFromUserDocument(
                BSON("user" << "spencer" <<
                     "roles" << BSON_ARRAY(BSON("role" << "roleA"))),
                user.get()));

        ASSERT_NOT_OK(v2parser.initializeUserRolesFromUserDocument(
                BSON("user" << "spencer" <<
                     "roles" << BSON_ARRAY(BSON("user" << "roleA" <<
                                                "db" << "dbA"))),
                user.get()));

        // Valid role names are extracted successfully
        ASSERT_OK(v2parser.initializeUserRolesFromUserDocument(
                BSON("user" << "spencer" <<
                     "roles" << BSON_ARRAY(BSON("role" << "roleA" <<
                                                "db" << "dbA"))),
                user.get()));
        RoleNameIterator roles = user->getRoles();
        ASSERT_EQUALS(RoleName("roleA", "dbA"), roles.next());
        ASSERT_FALSE(roles.more());

        // Multiple roles OK
        ASSERT_OK(v2parser.initializeUserRolesFromUserDocument(
                BSON("user" << "spencer" <<
                     "roles" << BSON_ARRAY(BSON("role" << "roleA" <<
                                                "db" << "dbA") <<
                                           BSON("role" << "roleB" <<
                                                "db" << "dbB"))),
                user.get()));
        roles = user->getRoles();
        RoleName role = roles.next();
        if (role == RoleName("roleA", "dbA")) {
            ASSERT_EQUALS(RoleName("roleB", "dbB"), roles.next());
        } else {
            ASSERT_EQUALS(RoleName("roleB", "dbB"), role);
            ASSERT_EQUALS(RoleName("roleA", "dbA"), roles.next());
        }
        ASSERT_FALSE(roles.more());
    }

}  // namespace
}  // namespace mongo