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(NULL) {
 109             background_load(); // guarantees an exception or the policy is loaded
 110         }
 111
 112         ~XMLAccessControl() {
 113             delete m_rootAuthz;
 114         }
 115
 116         aclresult_t authorized(const SPRequest& request, const Session* session) const;
 117
 118     protected:
 119         pair<bool,DOMElement*> background_load();
 120
 121     private:
 122         AccessControl* m_rootAuthz;
 123     };
 124
 125 #if defined (_MSC_VER)
 126     #pragma warning( pop )
 127 #endif
 128
 129     AccessControl* SHIBSP_DLLLOCAL XMLAccessControlFactory(const DOMElement* const & e)
 130     {
 131         return new XMLAccessControl(e);
 132     }
 133
 134     static const XMLCh _AccessControl[] =   UNICODE_LITERAL_13(A,c,c,e,s,s,C,o,n,t,r,o,l);
 135     static const XMLCh ignoreCase[] =       UNICODE_LITERAL_10(i,g,n,o,r,e,C,a,s,e);
 136     static const XMLCh ignoreOption[] =     UNICODE_LITERAL_1(i);
 137     static const XMLCh _list[] =            UNICODE_LITERAL_4(l,i,s,t);
 138     static const XMLCh require[] =          UNICODE_LITERAL_7(r,e,q,u,i,r,e);
 139     static const XMLCh NOT[] =              UNICODE_LITERAL_3(N,O,T);
 140     static const XMLCh AND[] =              UNICODE_LITERAL_3(A,N,D);
 141     static const XMLCh OR[] =               UNICODE_LITERAL_2(O,R);
 142     static const XMLCh _Rule[] =            UNICODE_LITERAL_4(R,u,l,e);
 143     static const XMLCh _RuleRegex[] =       UNICODE_LITERAL_9(R,u,l,e,R,e,g,e,x);
 144 }
 145
 146 Rule::Rule(const DOMElement* e)
 147 {
 148     auto_ptr_char req(e->getAttributeNS(NULL,require));
 149     if (!req.get() || !*req.get())
 150         throw ConfigurationException("Access control rule missing require attribute");
 151     m_alias=req.get();
 152
 153     auto_arrayptr<char> vals(toUTF8(e->hasChildNodes() ? e->getFirstChild()->getNodeValue() : NULL));
 154     if (!vals.get())
 155         return;
 156
 157     const XMLCh* flag = e->getAttributeNS(NULL,_list);
 158     if (flag && (*flag == chLatin_f || *flag == chDigit_0)) {
 159         if (*vals.get())
 160             m_vals.push_back(vals.get());
 161         return;
 162     }
 163
 164 #ifdef HAVE_STRTOK_R
 165     char* pos=NULL;
 166     const char* token=strtok_r(const_cast<char*>(vals.get())," ",&pos);
 167 #else
 168     const char* token=strtok(const_cast<char*>(vals.get())," ");
 169 #endif
 170     while (token) {
 171         m_vals.push_back(token);
 172 #ifdef HAVE_STRTOK_R
 173         token=strtok_r(NULL," ",&pos);
 174 #else
 175         token=strtok(NULL," ");
 176 #endif
 177     }
 178 }
 179
 180 AccessControl::aclresult_t Rule::authorized(const SPRequest& request, const Session* session) const
 181 {
 182     // We can make this more complex later using pluggable comparison functions,
 183     // but for now, just a straight port to the new Attribute API.
 184
 185     // Map alias in rule to the attribute.
 186     if (!session) {
 187         request.log(SPRequest::SPWarn, "AccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
 188         return shib_acl_false;
 189     }
 190
 191     if (m_alias == "valid-user") {
 192         if (session) {
 193             request.log(SPRequest::SPDebug,"AccessControl plugin accepting valid-user based on active session");
 194             return shib_acl_true;
 195         }
 196         return shib_acl_false;
 197     }
 198     if (m_alias == "user") {
 199         for (vector<string>::const_iterator i=m_vals.begin(); i!=m_vals.end(); ++i) {
 200             if (*i == request.getRemoteUser()) {
 201                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting REMOTE_USER (") + *i + "), authz granted");
 202                 return shib_acl_true;
 203             }
 204         }
 205         return shib_acl_false;
 206     }
 207     else if (m_alias == "authnContextClassRef") {
 208         const char* ref = session->getAuthnContextClassRef();
 209         for (vector<string>::const_iterator i=m_vals.begin(); ref && i!=m_vals.end(); ++i) {
 210             if (!strcmp(i->c_str(),ref)) {
 211                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextClassRef (") + *i + "), authz granted");
 212                 return shib_acl_true;
 213             }
 214         }
 215         return shib_acl_false;
 216     }
 217     else if (m_alias == "authnContextDeclRef") {
 218         const char* ref = session->getAuthnContextDeclRef();
 219         for (vector<string>::const_iterator i=m_vals.begin(); ref && i!=m_vals.end(); ++i) {
 220             if (!strcmp(i->c_str(),ref)) {
 221                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextDeclRef (") + *i + "), authz granted");
 222                 return shib_acl_true;
 223             }
 224         }
 225         return shib_acl_false;
 226     }
 227
 228     // Find the attribute(s) matching the require rule.
 229     pair<multimap<string,const Attribute*>::const_iterator, multimap<string,const Attribute*>::const_iterator> attrs =
 230         session->getIndexedAttributes().equal_range(m_alias);
 231     if (attrs.first == attrs.second) {
 232         request.log(SPRequest::SPWarn, string("rule requires attribute (") + m_alias + "), not found in session");
 233         return shib_acl_false;
 234     }
 235
 236     for (; attrs.first != attrs.second; ++attrs.first) {
 237         bool caseSensitive = attrs.first->second->isCaseSensitive();
 238
 239         // Now we have to intersect the attribute's values against the rule's list.
 240         const vector<string>& vals = attrs.first->second->getSerializedValues();
 241         for (vector<string>::const_iterator i=m_vals.begin(); i!=m_vals.end(); ++i) {
 242             for (vector<string>::const_iterator j=vals.begin(); j!=vals.end(); ++j) {
 243                 if ((caseSensitive && *i == *j) || (!caseSensitive && !strcasecmp(i->c_str(),j->c_str()))) {
 244                     request.log(SPRequest::SPDebug, string("AccessControl plugin expecting (") + *j + "), authz granted");
 245                     return shib_acl_true;
 246                 }
 247             }
 248         }
 249     }
 250
 251     return shib_acl_false;
 252 }
 253
 254 RuleRegex::RuleRegex(const DOMElement* e) : m_exp(toUTF8(e->hasChildNodes() ? e->getFirstChild()->getNodeValue() : NULL))
 255 {
 256     auto_ptr_char req(e->getAttributeNS(NULL,require));
 257     if (!req.get() || !*req.get() || !m_exp.get() || !*m_exp.get())
 258         throw ConfigurationException("Access control rule missing require attribute or element content.");
 259     m_alias=req.get();
 260
 261     const XMLCh* flag = e->getAttributeNS(NULL,ignoreCase);
 262     bool ignore = (flag && (*flag == chLatin_t || *flag == chDigit_1));
 263     try {
 264         m_re = new RegularExpression(e->getFirstChild()->getNodeValue(), (ignore ? ignoreOption : &chNull));
 265     }
 266     catch (XMLException& ex) {
 267         auto_ptr_char tmp(ex.getMessage());
 268         throw ConfigurationException("Caught exception while parsing RuleRegex regular expression: $1", params(1,tmp.get()));
 269     }
 270 }
 271
 272 AccessControl::aclresult_t RuleRegex::authorized(const SPRequest& request, const Session* session) const
 273 {
 274     // Map alias in rule to the attribute.
 275     if (!session) {
 276         request.log(SPRequest::SPWarn, "AccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
 277         return shib_acl_false;
 278     }
 279
 280     if (m_alias == "valid-user") {
 281         if (session) {
 282             request.log(SPRequest::SPDebug,"AccessControl plugin accepting valid-user based on active session");
 283             return shib_acl_true;
 284         }
 285         return shib_acl_false;
 286     }
 287
 288     try {
 289         if (m_alias == "user") {
 290             if (m_re->matches(request.getRemoteUser().c_str())) {
 291                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting REMOTE_USER (") + m_exp.get() + "), authz granted");
 292                 return shib_acl_true;
 293             }
 294             return shib_acl_false;
 295         }
 296         else if (m_alias == "authnContextClassRef") {
 297             if (session->getAuthnContextClassRef() && m_re->matches(session->getAuthnContextClassRef())) {
 298                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextClassRef (") + m_exp.get() + "), authz granted");
 299                 return shib_acl_true;
 300             }
 301             return shib_acl_false;
 302         }
 303         else if (m_alias == "authnContextDeclRef") {
 304             if (session->getAuthnContextDeclRef() && m_re->matches(session->getAuthnContextDeclRef())) {
 305                 request.log(SPRequest::SPDebug, string("AccessControl plugin expecting authnContextDeclRef (") + m_exp.get() + "), authz granted");
 306                 return shib_acl_true;
 307             }
 308             return shib_acl_false;
 309         }
 310
 311         // Find the attribute(s) matching the require rule.
 312         pair<multimap<string,const Attribute*>::const_iterator, multimap<string,const Attribute*>::const_iterator> attrs =
 313             session->getIndexedAttributes().equal_range(m_alias);
 314         if (attrs.first == attrs.second) {
 315             request.log(SPRequest::SPWarn, string("rule requires attribute (") + m_alias + "), not found in session");
 316             return shib_acl_false;
 317         }
 318
 319         for (; attrs.first != attrs.second; ++attrs.first) {
 320             // Now we have to intersect the attribute's values against the regular expression.
 321             const vector<string>& vals = attrs.first->second->getSerializedValues();
 322             for (vector<string>::const_iterator j=vals.begin(); j!=vals.end(); ++j) {
 323                 if (m_re->matches(j->c_str())) {
 324                     request.log(SPRequest::SPDebug, string("AccessControl plugin expecting (") + m_exp.get() + "), authz granted");
 325                     return shib_acl_true;
 326                 }
 327             }
 328         }
 329     }
 330     catch (XMLException& ex) {
 331         auto_ptr_char tmp(ex.getMessage());
 332         request.log(SPRequest::SPError, string("caught exception while parsing RuleRegex regular expression: ") + tmp.get());
 333     }
 334
 335     return shib_acl_false;
 336 }
 337
 338 Operator::Operator(const DOMElement* e)
 339 {
 340     if (XMLString::equals(e->getLocalName(),NOT))
 341         m_op=OP_NOT;
 342     else if (XMLString::equals(e->getLocalName(),AND))
 343         m_op=OP_AND;
 344     else if (XMLString::equals(e->getLocalName(),OR))
 345         m_op=OP_OR;
 346     else
 347         throw ConfigurationException("Unrecognized operator in access control rule");
 348
 349     try {
 350         e=XMLHelper::getFirstChildElement(e);
 351         if (XMLString::equals(e->getLocalName(),_Rule))
 352             m_operands.push_back(new Rule(e));
 353         else if (XMLString::equals(e->getLocalName(),_RuleRegex))
 354             m_operands.push_back(new RuleRegex(e));
 355         else
 356             m_operands.push_back(new Operator(e));
 357
 358         if (m_op==OP_NOT)
 359             return;
 360
 361         e=XMLHelper::getNextSiblingElement(e);
 362         while (e) {
 363             if (XMLString::equals(e->getLocalName(),_Rule))
 364                 m_operands.push_back(new Rule(e));
 365             else if (XMLString::equals(e->getLocalName(),_RuleRegex))
 366                 m_operands.push_back(new RuleRegex(e));
 367             else
 368                 m_operands.push_back(new Operator(e));
 369             e=XMLHelper::getNextSiblingElement(e);
 370         }
 371     }
 372     catch (exception&) {
 373         for_each(m_operands.begin(),m_operands.end(),xmltooling::cleanup<AccessControl>());
 374         throw;
 375     }
 376 }
 377
 378 Operator::~Operator()
 379 {
 380     for_each(m_operands.begin(),m_operands.end(),xmltooling::cleanup<AccessControl>());
 381 }
 382
 383 AccessControl::aclresult_t Operator::authorized(const SPRequest& request, const Session* session) const
 384 {
 385     switch (m_op) {
 386         case OP_NOT:
 387             switch (m_operands.front()->authorized(request,session)) {
 388                 case shib_acl_true:
 389                     return shib_acl_false;
 390                 case shib_acl_false:
 391                     return shib_acl_true;
 392                 default:
 393                     return shib_acl_indeterminate;
 394             }
 395
 396         case OP_AND:
 397         {
 398             for (vector<AccessControl*>::const_iterator i=m_operands.begin(); i!=m_operands.end(); i++) {
 399                 if ((*i)->authorized(request,session) != shib_acl_true)
 400                     return shib_acl_false;
 401             }
 402             return shib_acl_true;
 403         }
 404
 405         case OP_OR:
 406         {
 407             for (vector<AccessControl*>::const_iterator i=m_operands.begin(); i!=m_operands.end(); i++) {
 408                 if ((*i)->authorized(request,session) == shib_acl_true)
 409                     return shib_acl_true;
 410             }
 411             return shib_acl_false;
 412         }
 413     }
 414     request.log(SPRequest::SPWarn,"unknown operation in access control policy, denying access");
 415     return shib_acl_false;
 416 }
 417
 418 pair<bool,DOMElement*> XMLAccessControl::background_load()
 419 {
 420     // Load from source using base class.
 421     pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
 422
 423     // If we own it, wrap it.
 424     XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : NULL);
 425
 426     // Check for AccessControl wrapper and drop a level.
 427     if (XMLString::equals(raw.second->getLocalName(),_AccessControl))
 428         raw.second = XMLHelper::getFirstChildElement(raw.second);
 429
 430     AccessControl* authz;
 431     if (XMLString::equals(raw.second->getLocalName(),_Rule))
 432         authz=new Rule(raw.second);
 433     else if (XMLString::equals(raw.second->getLocalName(),_RuleRegex))
 434         authz=new RuleRegex(raw.second);
 435     else
 436         authz=new Operator(raw.second);
 437
 438     // Perform the swap inside a lock.
 439     if (m_lock)
 440         m_lock->wrlock();
 441     SharedLock locker(m_lock, false);
 442     delete m_rootAuthz;
 443     m_rootAuthz = authz;
 444
 445     return make_pair(false,(DOMElement*)NULL);
 446 }
 447
 448 AccessControl::aclresult_t XMLAccessControl::authorized(const SPRequest& request, const Session* session) const
 449 {
 450     return m_rootAuthz ? m_rootAuthz->authorized(request,session) : shib_acl_false;
 451 }