summaryrefslogtreecommitdiff
path: root/src/mongo/db/auth/privilege_parser.h
blob: aec390e39738da0461a8b029022e2210dca22f49 (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
/**
 *    Copyright (C) 2013 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    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
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    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 GNU Affero General 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.
 */

#pragma once

#include <string>
#include <vector>

#include "mongo/base/string_data.h"
#include "mongo/db/jsobj.h"
#include "mongo/s/bson_serializable.h"

namespace mongo {

    class Privilege;

    /**
     * This class is used to parse documents describing resources as they are represented as part
     * of privileges granted to roles in the role management commands.
     */
    class ParsedResource : BSONSerializable {
        MONGO_DISALLOW_COPYING(ParsedResource);
    public:

        //
        // schema declarations
        //

        static const BSONField<bool> anyResource;
        static const BSONField<bool> cluster;
        static const BSONField<std::string> db;
        static const BSONField<std::string> collection;

        //
        // construction / destruction
        //

        ParsedResource();
        ~ParsedResource();

        /** Copies all the fields present in 'this' to 'other'. */
        void cloneTo(ParsedResource* other) const;

        //
        // bson serializable interface implementation
        //

        bool isValid(std::string* errMsg) const;
        BSONObj toBSON() const;
        bool parseBSON(const BSONObj& source, std::string* errMsg);
        void clear();
        virtual std::string toString() const;

        //
        // individual field accessors
        //

        void setAnyResource(bool anyResource);
        void unsetAnyResource();
        bool isAnyResourceSet() const;
        bool getAnyResource() const;

        void setCluster(bool cluster);
        void unsetCluster();
        bool isClusterSet() const;
        bool getCluster() const;

        void setDb(StringData db);
        void unsetDb();
        bool isDbSet() const;
        const std::string& getDb() const;

        void setCollection(StringData collection);
        void unsetCollection();
        bool isCollectionSet() const;
        const std::string& getCollection() const;

    private:
        // Convention: (M)andatory, (O)ptional

        // (O) Only present if the resource matches anything.
        bool _anyResource;
        bool _isAnyResourceSet;

        // (O) Only present if the resource is the cluster
        bool _cluster;
        bool _isClusterSet;

        // (O) database portion of the resource
        std::string _db;
        bool _isDbSet;

        // (O) collection portion of the resource
        std::string _collection;
        bool _isCollectionSet;
    };

    /**
     * This class is used to parse documents describing privileges in the role managment commands.
     */
    class ParsedPrivilege : BSONSerializable {
        MONGO_DISALLOW_COPYING(ParsedPrivilege);
    public:

        //
        // schema declarations
        //

        static const BSONField<std::vector<std::string> > actions;
        static const BSONField<ParsedResource> resource;

        //
        // construction / destruction
        //

        ParsedPrivilege();
        ~ParsedPrivilege();

        /**
         * Takes a parsedPrivilege and turns it into a true Privilege object.
         */
        static bool parsedPrivilegeToPrivilege(const ParsedPrivilege& parsedPrivilege,
                                               Privilege* result,
                                               std::string* errmsg);
        /**
         * Takes a Privilege object and turns it into a ParsedPrivilege.
         */
        static bool privilegeToParsedPrivilege(const Privilege& privilege,
                                               ParsedPrivilege* result,
                                               std::string* errmsg);

        //
        // bson serializable interface implementation
        //

        bool isValid(std::string* errMsg) const;
        BSONObj toBSON() const;
        bool parseBSON(const BSONObj& source, std::string* errMsg);
        void clear();
        std::string toString() const;

        //
        // individual field accessors
        //

        void setActions(const std::vector<std::string>& actions);
        void addToActions(const std::string& actions);
        void unsetActions();
        bool isActionsSet() const;
        size_t sizeActions() const;
        const std::vector<std::string>& getActions() const;
        const std::string& getActionsAt(size_t pos) const;

        void setResource(const ParsedResource& resource);
        void unsetResource();
        bool isResourceSet() const;
        const ParsedResource& getResource() const;

    private:
        // Convention: (M)andatory, (O)ptional

        // (M) Array of action types
        std::vector<std::string> _actions;
        bool _isActionsSet;

        // (M) Object describing the resource pattern of this privilege
        ParsedResource _resource;
        bool _isResourceSet;
    };

} // namespace mongo