shibsp/impl/XMLAccessControl.cpp

   1 /*
   2  *  Copyright 2001-2010 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * XMLAccessControl.cpp
  19  *
  20  * XML-based access control syntax.
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "AccessControl.h"
  26 #include "SessionCache.h"
  27 #include "SPRequest.h"
  28 #include "attribute/Attribute.h"
  29
  30 #include <algorithm>
  31 #include <xmltooling/unicode.h>
  32 #include <xmltooling/util/ReloadableXMLFile.h>
  33 #include <xmltooling/util/Threads.h>
  34 #include <xmltooling/util/XMLHelper.h>
  35 #include <xercesc/util/XMLUniDefs.hpp>
  36 #include <xercesc/util/regx/RegularExpression.hpp>
  37
  38 #ifndef HAVE_STRCASECMP
  39 # define strcasecmp _stricmp
  40 #endif
  41
  42 using namespace shibsp;
  43 using namespace xmltooling;
  44 using namespace std;
  45
  46 namespace shibsp {
  47
  48     class Rule : public AccessControl
  49     {
  50     public:
  51         Rule(const DOMElement* e);
  52         ~Rule() {}
  53
  54         Lockable* lock() {return this;}
  55         void unlock() {}
  56
  57         aclresult_t authorized(const SPRequest& request, const Session* session) const;
  58
  59     private:
  60         string m_alias;
  61         vector <string> m_vals;
  62     };
  63
  64     class RuleRegex : public AccessControl
  65     {
  66     public:
  67         RuleRegex(const DOMElement* e);
  68         ~RuleRegex() {
  69             delete m_re;
  70         }
  71
  72         Lockable* lock() {return this;}
  73         void unlock() {}
  74
  75         aclresult_t authorized(const SPRequest& request, const Session* session) const;
  76
  77     private:
  78         string m_alias;
  79         auto_arrayptr<char> m_exp;
  80         RegularExpression* m_re;
  81     };
  82
  83     class Operator : public AccessControl
  84     {
  85     public:
  86         Operator(const DOMElement* e);
  87         ~Operator();
  88
  89         Lockable* lock() {return this;}
  90         void unlock() {}
  91
  92         aclresult_t authorized(const SPRequest& request, const Session* session) const;
  93
  94     private:
  95         enum operator_t { OP_NOT, OP_AND, OP_OR } m_op;
  96         vector<AccessControl*> m_operands;
  97     };
  98
  99 #if defined (_MSC_VER)
 100     #pragma warning( push )
 101     #pragma warning( disable : 4250 )
 102 #endif
 103
 104     class XMLAccessControl : public AccessControl, public ReloadableXMLFile
 105     {
 106     public:
 107         XMLAccessControl(const DOMElement* e)
 108                 : ReloadableXMLFile(e, Category::getInstance(SHIBSP_LOGCAT".AccessControl.XML")), m_rootAuthz(nullptr) {
 109             background_load(); // guarantees an exception or the policy is loaded
 110         }
 111
 112         ~XMLAccessControl() {
 113             shutdown();
 114             delete m_rootAuthz;
 115         }
 116
 117         aclresult_t authorized(const SPRequest& request, const Session* session) const;
 118
 119     protected:
 120         pair<bool,DOMElement*> background_load();
 121
 122     private:
 123         AccessControl* m_rootAuthz;
 124     };
 125
 126 #if defined (_MSC_VER)
 127     #pragma warning( pop )
 128 #endif
 129
 130     AccessControl* SHIBSP_DLLLOCAL XMLAccessControlFactory(const DOMElement* const & e)
 131     {
 132         return new XMLAccessControl(e);
 133     }
 134
 135     static const XMLCh _AccessControl[] =   UNICODE_LITERAL_13(A,c,c,e,s,s,C,o,n,t,r,o,l);
 136     static const XMLCh ignoreCase[] =       UNICODE_LITERAL_10(i,g,n,o,r,e,C,a,s,e);
 137     static const XMLCh ignoreOption[] =     UNICODE_LITERAL_1(i);
 138     static const XMLCh _list[] =            UNICODE_LITERAL_4(l,i,s,t);
 139     static const XMLCh require[] =          UNICODE_LITERAL_7(r,e,q,u,i,r,e);
 140     static const XMLCh NOT[] =              UNICODE_LITERAL_3(N,O,T);
 141     static const XMLCh AND[] =              UNICODE_LITERAL_3(A,N,D);
 142     static const XMLCh OR[] =               UNICODE_LITERAL_2(O,R);
 143     static const XMLCh _Rule[] =            UNICODE_LITERAL_4(R,u,l,e);
 144     static const XMLCh _RuleRegex[] =       UNICODE_LITERAL_9(R,u,l,e,R,e,g,e,x);
 145 }
 146
 147 Rule::Rule(const DOMElement* e) : m_alias(XMLHelper::getAttrString(e, nullptr, require))
 148 {
 149     if (m_alias.empty())
 150         throw ConfigurationException("Access control rule missing require attribute");
 151
 152     auto_arrayptr<char> vals(toUTF8(e->hasChildNodes() ? e->getFirstChild()->getNodeValue() : nullptr));
 153     if (!vals.get())
 154         return;
 155
 156     bool listflag = XMLHelper::getAttrBool(e, true, _list);
 157     if (!listflag) {
 158         if (*vals.get())
 159             m_vals.push_back(vals.get());
 160         return;
 161     }
 162
 163 #ifdef HAVE_STRTOK_R
 164     char* pos=nullptr;
 165     const char* token=strtok_r(const_cast<char*>(vals.get())," ",&pos);
 166 #else
 167     const char* token=strtok(const_cast<char*>(vals.get())," ");
 168 #endif
 169     while (token) {
 170         m_vals.push_back(token);
 171 #ifdef HAVE_STRTOK_R
 172         token=strtok_r(nullptr," ",&pos);
 173 #else
 174         token=strtok(nullptr," ");
 175 #endif
 176     }
 177 }
 178
 179 AccessControl::aclresult_t Rule::authorized(const SPRequest& request, const Session* session) const
 180 {
 181     // We can make this more complex later using pluggable comparison functions,
 182     // but for now, just a straight port to the new Attribute API.
 183
 184     // Map alias in rule to the attribute.
 185     if (!session) {
 186         request.log(SPRequest::SPWarn, "AccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
 187         return shib_acl_false;
 188     }
 189
 190     if (m_alias == "valid-user") {
 191         if (session) {
 192             request.log(SPRequest::SPDebug,"AccessControl plugin accepting valid-user based on active session");
 193             return shib_acl_true;
 194         }
 195         return shib_acl_false;
 196     }
 197     if (m_alias == "user") {
 198         for (vector<string>::const_iterator i=m_vals.begin(); i!=m_vals.end(); ++i) {
 199             if (*i == request.getRemoteUser()) {
 200                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting REMOTE_USER (") + *i + "), authz granted");
 201                 return shib_acl_true;
 202             }
 203         }
 204         return shib_acl_false;
 205     }
 206     else if (m_alias == "authnContextClassRef") {
 207         const char* ref = session->getAuthnContextClassRef();
 208         for (vector<string>::const_iterator i=m_vals.begin(); ref && i!=m_vals.end(); ++i) {
 209             if (!strcmp(i->c_str(),ref)) {
 210                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextClassRef (") + *i + "), authz granted");
 211                 return shib_acl_true;
 212             }
 213         }
 214         return shib_acl_false;
 215     }
 216     else if (m_alias == "authnContextDeclRef") {
 217         const char* ref = session->getAuthnContextDeclRef();
 218         for (vector<string>::const_iterator i=m_vals.begin(); ref && i!=m_vals.end(); ++i) {
 219             if (!strcmp(i->c_str(),ref)) {
 220                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextDeclRef (") + *i + "), authz granted");
 221                 return shib_acl_true;
 222             }
 223         }
 224         return shib_acl_false;
 225     }
 226
 227     // Find the attribute(s) matching the require rule.
 228     pair<multimap<string,const Attribute*>::const_iterator, multimap<string,const Attribute*>::const_iterator> attrs =
 229         session->getIndexedAttributes().equal_range(m_alias);
 230     if (attrs.first == attrs.second) {
 231         request.log(SPRequest::SPWarn, string("rule requires attribute (") + m_alias + "), not found in session");
 232         return shib_acl_false;
 233     }
 234
 235     for (; attrs.first != attrs.second; ++attrs.first) {
 236         bool caseSensitive = attrs.first->second->isCaseSensitive();
 237
 238         // Now we have to intersect the attribute's values against the rule's list.
 239         const vector<string>& vals = attrs.first->second->getSerializedValues();
 240         for (vector<string>::const_iterator i=m_vals.begin(); i!=m_vals.end(); ++i) {
 241             for (vector<string>::const_iterator j=vals.begin(); j!=vals.end(); ++j) {
 242                 if ((caseSensitive && *i == *j) || (!caseSensitive && !strcasecmp(i->c_str(),j->c_str()))) {
 243                     request.log(SPRequest::SPDebug, string("AccessControl plugin expecting (") + *j + "), authz granted");
 244                     return shib_acl_true;
 245                 }
 246             }
 247         }
 248     }
 249
 250     return shib_acl_false;
 251 }
 252
 253 RuleRegex::RuleRegex(const DOMElement* e)
 254     : m_alias(XMLHelper::getAttrString(e, nullptr, require)),
 255         m_exp(toUTF8(e->hasChildNodes() ? e->getFirstChild()->getNodeValue() : nullptr))
 256 {
 257     if (m_alias.empty() || !m_exp.get() || !*m_exp.get())
 258         throw ConfigurationException("Access control rule missing require attribute or element content.");
 259
 260     bool ignore = XMLHelper::getAttrBool(e, false, ignoreCase);
 261     try {
 262         m_re = new RegularExpression(e->getFirstChild()->getNodeValue(), (ignore ? ignoreOption : &chNull));
 263     }
 264     catch (XMLException& ex) {
 265         auto_ptr_char tmp(ex.getMessage());
 266         throw ConfigurationException("Caught exception while parsing RuleRegex regular expression: $1", params(1,tmp.get()));
 267     }
 268 }
 269
 270 AccessControl::aclresult_t RuleRegex::authorized(const SPRequest& request, const Session* session) const
 271 {
 272     // Map alias in rule to the attribute.
 273     if (!session) {
 274         request.log(SPRequest::SPWarn, "AccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
 275         return shib_acl_false;
 276     }
 277
 278     if (m_alias == "valid-user") {
 279         if (session) {
 280             request.log(SPRequest::SPDebug,"AccessControl plugin accepting valid-user based on active session");
 281             return shib_acl_true;
 282         }
 283         return shib_acl_false;
 284     }
 285
 286     try {
 287         if (m_alias == "user") {
 288             if (m_re->matches(request.getRemoteUser().c_str())) {
 289                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting REMOTE_USER (") + m_exp.get() + "), authz granted");
 290                 return shib_acl_true;
 291             }
 292             return shib_acl_false;
 293         }
 294         else if (m_alias == "authnContextClassRef") {
 295             if (session->getAuthnContextClassRef() && m_re->matches(session->getAuthnContextClassRef())) {
 296                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextClassRef (") + m_exp.get() + "), authz granted");
 297                 return shib_acl_true;
 298             }
 299             return shib_acl_false;
 300         }
 301         else if (m_alias == "authnContextDeclRef") {
 302             if (session->getAuthnContextDeclRef() && m_re->matches(session->getAuthnContextDeclRef())) {
 303                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextDeclRef (") + m_exp.get() + "), authz granted");
 304                 return shib_acl_true;
 305             }
 306             return shib_acl_false;
 307         }
 308
 309         // Find the attribute(s) matching the require rule.
 310         pair<multimap<string,const Attribute*>::const_iterator, multimap<string,const Attribute*>::const_iterator> attrs =
 311             session->getIndexedAttributes().equal_range(m_alias);
 312         if (attrs.first == attrs.second) {
 313             request.log(SPRequest::SPWarn, string("rule requires attribute (") + m_alias + "), not found in session");
 314             return shib_acl_false;
 315         }
 316
 317         for (; attrs.first != attrs.second; ++attrs.first) {
 318             // Now we have to intersect the attribute's values against the regular expression.
 319             const vector<string>& vals = attrs.first->second->getSerializedValues();
 320             for (vector<string>::const_iterator j=vals.begin(); j!=vals.end(); ++j) {
 321                 if (m_re->matches(j->c_str())) {
 322                     request.log(SPRequest::SPDebug, string("AccessControl plugin expecting (") + m_exp.get() + "), authz granted");
 323                     return shib_acl_true;
 324                 }
 325             }
 326         }
 327     }
 328     catch (XMLException& ex) {
 329         auto_ptr_char tmp(ex.getMessage());
 330         request.log(SPRequest::SPError, string("caught exception while parsing RuleRegex regular expression: ") + tmp.get());
 331     }
 332
 333     return shib_acl_false;
 334 }
 335
 336 Operator::Operator(const DOMElement* e)
 337 {
 338     if (XMLString::equals(e->getLocalName(),NOT))
 339         m_op=OP_NOT;
 340     else if (XMLString::equals(e->getLocalName(),AND))
 341         m_op=OP_AND;
 342     else if (XMLString::equals(e->getLocalName(),OR))
 343         m_op=OP_OR;
 344     else
 345         throw ConfigurationException("Unrecognized operator in access control rule");
 346
 347     try {
 348         e=XMLHelper::getFirstChildElement(e);
 349         if (XMLString::equals(e->getLocalName(),_Rule))
 350             m_operands.push_back(new Rule(e));
 351         else if (XMLString::equals(e->getLocalName(),_RuleRegex))
 352             m_operands.push_back(new RuleRegex(e));
 353         else
 354             m_operands.push_back(new Operator(e));
 355
 356         if (m_op==OP_NOT)
 357             return;
 358
 359         e=XMLHelper::getNextSiblingElement(e);
 360         while (e) {
 361             if (XMLString::equals(e->getLocalName(),_Rule))
 362                 m_operands.push_back(new Rule(e));
 363             else if (XMLString::equals(e->getLocalName(),_RuleRegex))
 364                 m_operands.push_back(new RuleRegex(e));
 365             else
 366                 m_operands.push_back(new Operator(e));
 367             e=XMLHelper::getNextSiblingElement(e);
 368         }
 369     }
 370     catch (exception&) {
 371         for_each(m_operands.begin(),m_operands.end(),xmltooling::cleanup<AccessControl>());
 372         throw;
 373     }
 374 }
 375
 376 Operator::~Operator()
 377 {
 378     for_each(m_operands.begin(),m_operands.end(),xmltooling::cleanup<AccessControl>());
 379 }
 380
 381 AccessControl::aclresult_t Operator::authorized(const SPRequest& request, const Session* session) const
 382 {
 383     switch (m_op) {
 384         case OP_NOT:
 385             switch (m_operands.front()->authorized(request,session)) {
 386                 case shib_acl_true:
 387                     return shib_acl_false;
 388                 case shib_acl_false:
 389                     return shib_acl_true;
 390                 default:
 391                     return shib_acl_indeterminate;
 392             }
 393
 394         case OP_AND:
 395         {
 396             for (vector<AccessControl*>::const_iterator i=m_operands.begin(); i!=m_operands.end(); i++) {
 397                 if ((*i)->authorized(request,session) != shib_acl_true)
 398                     return shib_acl_false;
 399             }
 400             return shib_acl_true;
 401         }
 402
 403         case OP_OR:
 404         {
 405             for (vector<AccessControl*>::const_iterator i=m_operands.begin(); i!=m_operands.end(); i++) {
 406                 if ((*i)->authorized(request,session) == shib_acl_true)
 407                     return shib_acl_true;
 408             }
 409             return shib_acl_false;
 410         }
 411     }
 412     request.log(SPRequest::SPWarn,"unknown operation in access control policy, denying access");
 413     return shib_acl_false;
 414 }
 415
 416 pair<bool,DOMElement*> XMLAccessControl::background_load()
 417 {
 418     // Load from source using base class.
 419     pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
 420
 421     // If we own it, wrap it.
 422     XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : nullptr);
 423
 424     // Check for AccessControl wrapper and drop a level.
 425     if (XMLString::equals(raw.second->getLocalName(),_AccessControl))
 426         raw.second = XMLHelper::getFirstChildElement(raw.second);
 427
 428     AccessControl* authz;
 429     if (XMLString::equals(raw.second->getLocalName(),_Rule))
 430         authz=new Rule(raw.second);
 431     else if (XMLString::equals(raw.second->getLocalName(),_RuleRegex))
 432         authz=new RuleRegex(raw.second);
 433     else
 434         authz=new Operator(raw.second);
 435
 436     // Perform the swap inside a lock.
 437     if (m_lock)
 438         m_lock->wrlock();
 439     SharedLock locker(m_lock, false);
 440     delete m_rootAuthz;
 441     m_rootAuthz = authz;
 442
 443     return make_pair(false,(DOMElement*)nullptr);
 444 }
 445
 446 AccessControl::aclresult_t XMLAccessControl::authorized(const SPRequest& request, const Session* session) const
 447 {
 448     return m_rootAuthz ? m_rootAuthz->authorized(request,session) : shib_acl_false;
 449 }