/usr/include/qpid/broker/AclModule.h is in libqpidbroker2-dev 0.14-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | #ifndef QPID_ACLMODULE_ACL_H
#define QPID_ACLMODULE_ACL_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/RefCounted.h"
#include <boost/shared_ptr.hpp>
#include <map>
#include <set>
#include <string>
#include <sstream>
namespace qpid {
namespace acl {
enum ObjectType {OBJ_QUEUE, OBJ_EXCHANGE, OBJ_BROKER, OBJ_LINK,
OBJ_METHOD, OBJECTSIZE}; // OBJECTSIZE must be last in list
enum Action {ACT_CONSUME, ACT_PUBLISH, ACT_CREATE, ACT_ACCESS, ACT_BIND,
ACT_UNBIND, ACT_DELETE, ACT_PURGE, ACT_UPDATE,
ACTIONSIZE}; // ACTIONSIZE must be last in list
enum Property {PROP_NAME, PROP_DURABLE, PROP_OWNER, PROP_ROUTINGKEY,
PROP_PASSIVE, PROP_AUTODELETE, PROP_EXCLUSIVE, PROP_TYPE,
PROP_ALTERNATE, PROP_QUEUENAME, PROP_SCHEMAPACKAGE,
PROP_SCHEMACLASS, PROP_POLICYTYPE, PROP_MAXQUEUESIZE,
PROP_MAXQUEUECOUNT};
enum AclResult {ALLOW, ALLOWLOG, DENY, DENYLOG};
} // namespace acl
namespace broker {
class AclModule
{
public:
// effienty turn off ACL on message transfer.
virtual bool doTransferAcl()=0;
virtual bool authorise(const std::string& id, const acl::Action& action, const acl::ObjectType& objType, const std::string& name,
std::map<acl::Property, std::string>* params=0)=0;
virtual bool authorise(const std::string& id, const acl::Action& action, const acl::ObjectType& objType, const std::string& ExchangeName,
const std::string& RoutingKey)=0;
// create specilied authorise methods for cases that need faster matching as needed.
virtual ~AclModule() {};
};
} // namespace broker
namespace acl {
class AclHelper {
private:
AclHelper(){}
public:
static inline ObjectType getObjectType(const std::string& str) {
if (str.compare("queue") == 0) return OBJ_QUEUE;
if (str.compare("exchange") == 0) return OBJ_EXCHANGE;
if (str.compare("broker") == 0) return OBJ_BROKER;
if (str.compare("link") == 0) return OBJ_LINK;
if (str.compare("method") == 0) return OBJ_METHOD;
throw str;
}
static inline std::string getObjectTypeStr(const ObjectType o) {
switch (o) {
case OBJ_QUEUE: return "queue";
case OBJ_EXCHANGE: return "exchange";
case OBJ_BROKER: return "broker";
case OBJ_LINK: return "link";
case OBJ_METHOD: return "method";
default: assert(false); // should never get here
}
return "";
}
static inline Action getAction(const std::string& str) {
if (str.compare("consume") == 0) return ACT_CONSUME;
if (str.compare("publish") == 0) return ACT_PUBLISH;
if (str.compare("create") == 0) return ACT_CREATE;
if (str.compare("access") == 0) return ACT_ACCESS;
if (str.compare("bind") == 0) return ACT_BIND;
if (str.compare("unbind") == 0) return ACT_UNBIND;
if (str.compare("delete") == 0) return ACT_DELETE;
if (str.compare("purge") == 0) return ACT_PURGE;
if (str.compare("update") == 0) return ACT_UPDATE;
throw str;
}
static inline std::string getActionStr(const Action a) {
switch (a) {
case ACT_CONSUME: return "consume";
case ACT_PUBLISH: return "publish";
case ACT_CREATE: return "create";
case ACT_ACCESS: return "access";
case ACT_BIND: return "bind";
case ACT_UNBIND: return "unbind";
case ACT_DELETE: return "delete";
case ACT_PURGE: return "purge";
case ACT_UPDATE: return "update";
default: assert(false); // should never get here
}
return "";
}
static inline Property getProperty(const std::string& str) {
if (str.compare("name") == 0) return PROP_NAME;
if (str.compare("durable") == 0) return PROP_DURABLE;
if (str.compare("owner") == 0) return PROP_OWNER;
if (str.compare("routingkey") == 0) return PROP_ROUTINGKEY;
if (str.compare("passive") == 0) return PROP_PASSIVE;
if (str.compare("autodelete") == 0) return PROP_AUTODELETE;
if (str.compare("exclusive") == 0) return PROP_EXCLUSIVE;
if (str.compare("type") == 0) return PROP_TYPE;
if (str.compare("alternate") == 0) return PROP_ALTERNATE;
if (str.compare("queuename") == 0) return PROP_QUEUENAME;
if (str.compare("schemapackage") == 0) return PROP_SCHEMAPACKAGE;
if (str.compare("schemaclass") == 0) return PROP_SCHEMACLASS;
if (str.compare("policytype") == 0) return PROP_POLICYTYPE;
if (str.compare("maxqueuesize") == 0) return PROP_MAXQUEUESIZE;
if (str.compare("maxqueuecount") == 0) return PROP_MAXQUEUECOUNT;
throw str;
}
static inline std::string getPropertyStr(const Property p) {
switch (p) {
case PROP_NAME: return "name";
case PROP_DURABLE: return "durable";
case PROP_OWNER: return "owner";
case PROP_ROUTINGKEY: return "routingkey";
case PROP_PASSIVE: return "passive";
case PROP_AUTODELETE: return "autodelete";
case PROP_EXCLUSIVE: return "exclusive";
case PROP_TYPE: return "type";
case PROP_ALTERNATE: return "alternate";
case PROP_QUEUENAME: return "queuename";
case PROP_SCHEMAPACKAGE: return "schemapackage";
case PROP_SCHEMACLASS: return "schemaclass";
case PROP_POLICYTYPE: return "policytype";
case PROP_MAXQUEUESIZE: return "maxqueuesize";
case PROP_MAXQUEUECOUNT: return "maxqueuecount";
default: assert(false); // should never get here
}
return "";
}
static inline AclResult getAclResult(const std::string& str) {
if (str.compare("allow") == 0) return ALLOW;
if (str.compare("allow-log") == 0) return ALLOWLOG;
if (str.compare("deny") == 0) return DENY;
if (str.compare("deny-log") == 0) return DENYLOG;
throw str;
}
static inline std::string getAclResultStr(const AclResult r) {
switch (r) {
case ALLOW: return "allow";
case ALLOWLOG: return "allow-log";
case DENY: return "deny";
case DENYLOG: return "deny-log";
default: assert(false); // should never get here
}
return "";
}
typedef std::set<Property> propSet;
typedef boost::shared_ptr<propSet> propSetPtr;
typedef std::pair<Action, propSetPtr> actionPair;
typedef std::map<Action, propSetPtr> actionMap;
typedef boost::shared_ptr<actionMap> actionMapPtr;
typedef std::pair<ObjectType, actionMapPtr> objectPair;
typedef std::map<ObjectType, actionMapPtr> objectMap;
typedef objectMap::const_iterator omCitr;
typedef boost::shared_ptr<objectMap> objectMapPtr;
typedef std::map<Property, std::string> propMap;
typedef propMap::const_iterator propMapItr;
// This map contains the legal combinations of object/action/properties found in an ACL file
static void loadValidationMap(objectMapPtr& map) {
if (!map.get()) return;
map->clear();
propSetPtr p0; // empty ptr, used for no properties
// == Exchanges ==
propSetPtr p1(new propSet);
p1->insert(PROP_TYPE);
p1->insert(PROP_ALTERNATE);
p1->insert(PROP_PASSIVE);
p1->insert(PROP_DURABLE);
propSetPtr p2(new propSet);
p2->insert(PROP_ROUTINGKEY);
propSetPtr p3(new propSet);
p3->insert(PROP_QUEUENAME);
p3->insert(PROP_ROUTINGKEY);
actionMapPtr a0(new actionMap);
a0->insert(actionPair(ACT_CREATE, p1));
a0->insert(actionPair(ACT_DELETE, p0));
a0->insert(actionPair(ACT_ACCESS, p0));
a0->insert(actionPair(ACT_BIND, p2));
a0->insert(actionPair(ACT_UNBIND, p2));
a0->insert(actionPair(ACT_ACCESS, p3));
a0->insert(actionPair(ACT_PUBLISH, p0));
map->insert(objectPair(OBJ_EXCHANGE, a0));
// == Queues ==
propSetPtr p4(new propSet);
p4->insert(PROP_ALTERNATE);
p4->insert(PROP_PASSIVE);
p4->insert(PROP_DURABLE);
p4->insert(PROP_EXCLUSIVE);
p4->insert(PROP_AUTODELETE);
p4->insert(PROP_POLICYTYPE);
p4->insert(PROP_MAXQUEUESIZE);
p4->insert(PROP_MAXQUEUECOUNT);
actionMapPtr a1(new actionMap);
a1->insert(actionPair(ACT_ACCESS, p0));
a1->insert(actionPair(ACT_CREATE, p4));
a1->insert(actionPair(ACT_PURGE, p0));
a1->insert(actionPair(ACT_DELETE, p0));
a1->insert(actionPair(ACT_CONSUME, p0));
map->insert(objectPair(OBJ_QUEUE, a1));
// == Links ==
actionMapPtr a2(new actionMap);
a2->insert(actionPair(ACT_CREATE, p0));
map->insert(objectPair(OBJ_LINK, a2));
// == Method ==
propSetPtr p5(new propSet);
p5->insert(PROP_SCHEMAPACKAGE);
p5->insert(PROP_SCHEMACLASS);
actionMapPtr a4(new actionMap);
a4->insert(actionPair(ACT_ACCESS, p5));
map->insert(objectPair(OBJ_METHOD, a4));
}
static std::string propertyMapToString(const std::map<Property, std::string>* params) {
std::ostringstream ss;
ss << "{";
if (params)
{
for (propMapItr pMItr = params->begin(); pMItr != params->end(); pMItr++) {
ss << " " << getPropertyStr((Property) pMItr-> first) << "=" << pMItr->second;
}
}
ss << " }";
return ss.str();
}
};
}} // namespace qpid::acl
#endif // QPID_ACLMODULE_ACL_H
|