summaryrefslogtreecommitdiff
path: root/src/mongo/db/auth/principal.h
blob: 0ebb502b16a68bb7cb97b347a775f259690bf1f7 (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
/*    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 <boost/date_time/posix_time/posix_time.hpp>
#include <string>

#include "mongo/base/disallow_copying.h"
#include "mongo/base/string_data.h"
#include "mongo/db/auth/user_name.h"
#include "mongo/util/string_map.h"

namespace mongo {

    /**
     * Represents an authenticated user.  Every principal has a name, a time that the user's
     * authentication expires, and a flag that describes whether or not privileges should be
     * acquired implicitly.
     *
     * The implicit privilege acquisition flag defaults to disabled, and the expiration time
     * defaults to never.
     *
     * This class does not do any locking/synchronization, the consumer will be responsible for
     * synchronizing access.
     */
    class Principal {
        MONGO_DISALLOW_COPYING(Principal);

    public:
        Principal(const UserName& name,
                  const boost::posix_time::ptime& expirationTime);
        explicit Principal(const UserName& name);
        ~Principal();

        const UserName& getName() const { return _name; }

        // Returns the expiration time of this principal information.
        // No expiration is represented as boost::posix_time::pos_infin
        const boost::posix_time::ptime& getExpirationTime() const { return _expirationTime; }

        void setExpirationTime(boost::posix_time::ptime& expiration);

        bool isDatabaseProbed(const StringData& dbname) const;
        void markDatabaseAsProbed(const StringData& dbname);

    private:
        UserName _name;
        boost::posix_time::ptime _expirationTime;
        StringMap<bool> _probedDatabases;
    };

} // namespace mongo