summaryrefslogtreecommitdiff
path: root/cpp/src/qpid/acl/AclData.h
blob: 43cb5193f5a5abf8a82b3392ab312ce5d5466594 (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
#ifndef QPID_ACL_ACLDATA_H
#define QPID_ACL_ACLDATA_H


/*
 *
 * Copyright (c) 2006 The Apache Software Foundation
 *
 * 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.
 *
 */

#include "qpid/broker/AclModule.h"
#include "AclTopicMatch.h"
#include "qpid/log/Statement.h"
#include "boost/shared_ptr.hpp"
#include <vector>
#include <sstream>

namespace qpid {
namespace acl {

class AclData {


public:

    typedef std::map<qpid::acl::Property, std::string> propertyMap;
    typedef propertyMap::const_iterator                propertyMapItr;

    typedef std::map<qpid::acl::SpecProperty, std::string> specPropertyMap;
    typedef specPropertyMap::const_iterator                specPropertyMapItr;

    //
    // rule
    //
    // Created by AclReader and stored in a ruleSet vector for subsequent
    //  run-time lookup matching and allow/deny decisions.
    // RuleSet vectors are indexed by Action-Object-actorId so these
    //  attributes are not part of a rule.
    // A single ACL file entry may create many rule entries in
    //  many ruleset vectors.
    //
    struct Rule {
        typedef broker::TopicExchange::TopicExchangeTester topicTester;

        int                   rawRuleNum;   // rule number in ACL file
        qpid::acl::AclResult  ruleMode;     // combined allow/deny log/nolog
        specPropertyMap       props;        //
        bool                  pubRoutingKeyInRule;
        std::string           pubRoutingKey;
        boost::shared_ptr<topicTester> pTTest;
        bool                  pubExchNameInRule;
        std::string           pubExchName;
        std::vector<bool>     ruleHasUserSub;

        Rule (int ruleNum, qpid::acl::AclResult res, specPropertyMap& p) :
            rawRuleNum(ruleNum),
            ruleMode(res),
            props(p),
            pubRoutingKeyInRule(false),
            pubRoutingKey(),
            pTTest(boost::shared_ptr<topicTester>(new topicTester())),
            pubExchNameInRule(false),
            pubExchName(),
            ruleHasUserSub(PROPERTYSIZE, false)
            {}


        std::string toString () const {
            std::ostringstream ruleStr;
            ruleStr << "[rule " << rawRuleNum
                    << " ruleMode = " << AclHelper::getAclResultStr(ruleMode)
                    << " props{";
            for (specPropertyMapItr pMItr  = props.begin();
                                    pMItr != props.end();
                                    pMItr++) {
                ruleStr << " "
                        << AclHelper::getPropertyStr((SpecProperty) pMItr-> first)
                        << "=" << pMItr->second;
            }
            ruleStr << " }]";
            return ruleStr.str();
        }

        void addTopicTest(const std::string& pattern) {
            pTTest->addBindingKey(broker::TopicExchange::normalize(pattern));
        }

        // Topic Exchange tester
        // return true if any bindings match 'pattern'
        bool matchRoutingKey(const std::string& pattern) const
        {
            topicTester::BindingVec bv;
            return pTTest->findMatches(pattern, bv);
        }
    };

    typedef  std::vector<Rule>               ruleSet;
    typedef  ruleSet::const_iterator         ruleSetItr;
    typedef  std::map<std::string, ruleSet > actionObject; // user
    typedef  actionObject::iterator          actObjItr;
    typedef  actionObject*                   aclAction;
    typedef  std::map<std::string, uint16_t> quotaRuleSet; // <username, N>
    typedef  quotaRuleSet::const_iterator    quotaRuleSetItr;

    // Action*[] -> Object*[] -> map<user -> set<Rule> >
    aclAction*           actionList[qpid::acl::ACTIONSIZE];
    qpid::acl::AclResult decisionMode;  // allow/deny[-log] if no matching rule found
    bool                 transferAcl;
    std::string          aclSource;

    AclResult lookup(
        const std::string&               id,        // actor id
        const Action&                    action,
        const ObjectType&                objType,
        const std::string&               name,      // object name
        std::map<Property, std::string>* params=0);

    AclResult lookup(
        const std::string&               id,        // actor id
        const Action&                    action,
        const ObjectType&                objType,
        const std::string&               ExchangeName,
        const std::string&               RoutingKey);

    bool matchProp(const std::string & src, const std::string& src1);
    void clear ();
    static const std::string ACL_KEYWORD_USER_SUBST;
    static const std::string ACL_KEYWORD_DOMAIN_SUBST;
    static const std::string ACL_KEYWORD_USERDOMAIN_SUBST;
    static const std::string ACL_KEYWORD_ALL;
    static const std::string ACL_KEYWORD_ACL;
    static const std::string ACL_KEYWORD_GROUP;
    static const std::string ACL_KEYWORD_QUOTA;
    static const std::string ACL_KEYWORD_QUOTA_CONNECTIONS;
    static const char        ACL_SYMBOL_WILDCARD;
    static const std::string ACL_KEYWORD_WILDCARD;
    static const char        ACL_SYMBOL_LINE_CONTINUATION;

    void substituteString(std::string& targetString,
                          const std::string& placeholder,
                          const std::string& replacement);
    std::string normalizeUserId(const std::string& userId);
    void substituteUserId(std::string& ruleString,
                          const std::string& userId);
    void substituteKeywords(std::string& ruleString,
                            const std::string& userId);

    // Per user connection quotas extracted from acl rule file
    //   Set by reader
    void setConnQuotaRuleSettings (bool, boost::shared_ptr<quotaRuleSet>);
    //   Get by connection approvers
    bool enforcingConnectionQuotas() { return connQuotaRulesExist; }
    bool getConnQuotaForUser(const std::string&, uint16_t*) const;

    /** getConnectMaxSpec
     * Connection quotas are held in uint16_t variables.
     * This function specifies the largest value that a user is allowed
     * to declare for a connection quota. The upper limit serves two
     * purposes: 1. It leaves room for magic numbers that may be declared
     * by keyword names in Acl files and not have those numbers conflict
     * with innocent user declared values, and 2. It makes the unsigned
     * math very close to _MAX work reliably with no risk of accidental
     * wrapping back to zero.
     */
    static uint16_t getConnectMaxSpec() {
        return 65530;
    }
    static std::string getMaxConnectSpecStr() {
        return "65530";
    }


    AclData();
    virtual ~AclData();

private:
    bool compareIntMax(const qpid::acl::SpecProperty theProperty,
                       const std::string             theAclValue,
                       const std::string             theLookupValue);

    bool compareIntMin(const qpid::acl::SpecProperty theProperty,
                       const std::string             theAclValue,
                       const std::string             theLookupValue);

    // Per-user connection quota
    bool connQuotaRulesExist;
    boost::shared_ptr<quotaRuleSet> connQuotaRuleSettings; // Map of user-to-N values from rule file
};

}} // namespace qpid::acl

#endif // QPID_ACL_ACLDATA_H