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
|
/* 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.
*/
#pragma once
#include <string>
#include <vector>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/string_data.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/auth/user.h"
#include "mongo/db/auth/user_name.h"
namespace mongo {
/**
* A collection of authenticated users.
* This class does not do any locking/synchronization, the consumer will be responsible for
* synchronizing access.
*/
class UserSet {
MONGO_DISALLOW_COPYING(UserSet);
public:
typedef std::vector<User*>::const_iterator iterator;
UserSet();
~UserSet();
/**
* Adds a User to the UserSet.
*
* The UserSet does not take ownership of the User.
*
* As there can only be one user per database in the UserSet, if a User already exists for
* the new User's database, the old user will be removed from the set and returned. It is
* the caller's responsibility to then release that user. If no user already exists for the
* new user's database, returns NULL.
*
* Invalidates any outstanding iterators or NameIterators.
*/
User* add(User* user);
/**
* Replaces the user at "it" with "replacement." Does not take ownership of the User.
* Returns a pointer to the old user referenced by "it". Does _not_ invalidate "iterator"
* instances.
*/
User* replaceAt(iterator it, User* replacement);
/**
* Removes the user at "it", and returns a pointer to it. After this call, "it" remains
* valid. It will either equal "end()", or refer to some user between the values of "it"
* and "end()" before this call was made.
*/
User* removeAt(iterator it);
/**
* Removes the User whose authentication credentials came from dbname, and returns that
* user. It is the caller's responsibility to then release that user back to the
* authorizationManger. If no user exists for the given database, returns NULL;
*/
User* removeByDBName(const StringData& dbname);
// Returns the User with the given name, or NULL if not found.
// Ownership of the returned User remains with the UserSet. The pointer
// returned is only guaranteed to remain valid until the next non-const method is called
// on the UserSet.
User* lookup(const UserName& name) const;
// Gets the user whose authentication credentials came from dbname, or NULL if none
// exist. There should be at most one such user.
User* lookupByDBName(const StringData& dbname) const;
// Gets an iterator over the names of the users stored in the set. The iterator is
// valid until the next non-const method is called on the UserSet.
UserNameIterator getNames() const;
iterator begin() const { return _users.begin(); }
iterator end() const { return _usersEnd; }
private:
typedef std::vector<User*>::iterator mutable_iterator;
mutable_iterator mbegin() { return _users.begin(); }
mutable_iterator mend() { return _usersEnd; }
// The UserSet maintains ownership of the Users in it, and is responsible for
// returning them to the AuthorizationManager when done with them.
std::vector<User*> _users;
std::vector<User*>::iterator _usersEnd;
};
} // namespace mongo
|
