2 * Copyright 2001-2007 Internet2
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
17 /** XMLRequestMapper.cpp
\r
19 * XML-based RequestMapper implementation
\r
22 #include "internal.h"
\r
23 #include "exceptions.h"
\r
24 #include "AccessControl.h"
\r
25 #include "RequestMapper.h"
\r
26 #include "SPRequest.h"
\r
27 #include "util/DOMPropertySet.h"
\r
28 #include "util/SPConstants.h"
\r
30 #include <xmltooling/util/NDC.h>
\r
31 #include <xmltooling/util/ReloadableXMLFile.h>
\r
32 #include <xmltooling/util/XMLHelper.h>
\r
33 #include <xercesc/util/XMLUniDefs.hpp>
\r
34 #include <xercesc/util/regx/RegularExpression.hpp>
\r
36 using namespace shibsp;
\r
37 using namespace xmltooling;
\r
38 using namespace log4cpp;
\r
39 using namespace std;
\r
43 // Blocks access when an ACL plugin fails to load.
\r
44 class AccessControlDummy : public AccessControl
\r
53 bool authorized(const SPRequest& request, const Session* session) const {
\r
58 class Override : public DOMPropertySet, public DOMNodeFilter
\r
61 Override() : m_base(NULL), m_acl(NULL) {}
\r
62 Override(const DOMElement* e, Category& log, const Override* base=NULL);
\r
66 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
\r
67 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
\r
68 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
\r
69 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
\r
70 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
\r
71 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
\r
73 // Provides filter to exclude special config elements.
\r
74 short acceptNode(const DOMNode* node) const;
\r
76 const Override* locate(const char* path) const;
\r
77 AccessControl* getAC() const { return (m_acl ? m_acl : (m_base ? m_base->getAC() : NULL)); }
\r
80 void loadACL(const DOMElement* e, Category& log);
\r
82 map<string,Override*> m_map;
\r
83 vector< pair<RegularExpression*,Override*> > m_regexps;
\r
86 const Override* m_base;
\r
87 AccessControl* m_acl;
\r
90 class XMLRequestMapperImpl : public Override
\r
93 XMLRequestMapperImpl(const DOMElement* e, Category& log);
\r
95 ~XMLRequestMapperImpl() {
\r
97 m_document->release();
\r
100 void setDocument(DOMDocument* doc) {
\r
104 const Override* findOverride(const char* vhost, const char* path) const;
\r
107 map<string,Override*> m_extras;
\r
108 DOMDocument* m_document;
\r
111 #if defined (_MSC_VER)
\r
112 #pragma warning( push )
\r
113 #pragma warning( disable : 4250 )
\r
116 class XMLRequestMapper : public RequestMapper, public ReloadableXMLFile
\r
119 XMLRequestMapper(const DOMElement* e) : ReloadableXMLFile(e,Category::getInstance(SHIBSP_LOGCAT".RequestMapper")), m_impl(NULL) {
\r
123 ~XMLRequestMapper() {
\r
127 Settings getSettings(const SPRequest& request) const;
\r
130 pair<bool,DOMElement*> load();
\r
133 XMLRequestMapperImpl* m_impl;
\r
136 #if defined (_MSC_VER)
\r
137 #pragma warning( pop )
\r
140 RequestMapper* SHIBSP_DLLLOCAL XMLRequestMapperFactory(const DOMElement* const & e)
\r
142 return new XMLRequestMapper(e);
\r
145 static const XMLCh _AccessControl[] = UNICODE_LITERAL_13(A,c,c,e,s,s,C,o,n,t,r,o,l);
\r
146 static const XMLCh AccessControlProvider[] = UNICODE_LITERAL_21(A,c,c,e,s,s,C,o,n,t,r,o,l,P,r,o,v,i,d,e,r);
\r
147 static const XMLCh Host[] = UNICODE_LITERAL_4(H,o,s,t);
\r
148 static const XMLCh HostRegex[] = UNICODE_LITERAL_9(H,o,s,t,R,e,g,e,x);
\r
149 static const XMLCh htaccess[] = UNICODE_LITERAL_8(h,t,a,c,c,e,s,s);
\r
150 static const XMLCh ignoreCase[] = UNICODE_LITERAL_10(i,g,n,o,r,e,C,a,s,e);
\r
151 static const XMLCh ignoreOption[] = UNICODE_LITERAL_1(i);
\r
152 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
\r
153 static const XMLCh PathRegex[] = UNICODE_LITERAL_9(P,a,t,h,R,e,g,e,x);
\r
154 static const XMLCh name[] = UNICODE_LITERAL_4(n,a,m,e);
\r
155 static const XMLCh regex[] = UNICODE_LITERAL_5(r,e,g,e,x);
\r
156 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
\r
159 void SHIBSP_API shibsp::registerRequestMappers()
\r
161 SPConfig& conf=SPConfig::getConfig();
\r
162 conf.RequestMapperManager.registerFactory(XML_REQUEST_MAPPER, XMLRequestMapperFactory);
\r
163 conf.RequestMapperManager.registerFactory("edu.internet2.middleware.shibboleth.sp.provider.XMLRequestMapProvider", XMLRequestMapperFactory);
\r
164 conf.RequestMapperManager.registerFactory("edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap", XMLRequestMapperFactory);
\r
165 conf.RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER, XMLRequestMapperFactory);
\r
166 conf.RequestMapperManager.registerFactory("edu.internet2.middleware.shibboleth.sp.provider.NativeRequestMapProvider", XMLRequestMapperFactory);
\r
169 short Override::acceptNode(const DOMNode* node) const
\r
171 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
\r
172 return FILTER_ACCEPT;
\r
173 const XMLCh* name=node->getLocalName();
\r
174 if (XMLString::equals(name,Host) ||
\r
175 XMLString::equals(name,Path) ||
\r
176 XMLString::equals(name,_AccessControl) ||
\r
177 XMLString::equals(name,htaccess) ||
\r
178 XMLString::equals(name,AccessControlProvider))
\r
179 return FILTER_REJECT;
\r
181 return FILTER_ACCEPT;
\r
184 void Override::loadACL(const DOMElement* e, Category& log)
\r
187 const DOMElement* acl=XMLHelper::getFirstChildElement(e,htaccess);
\r
189 log.info("building Apache htaccess AccessControl provider...");
\r
190 m_acl=SPConfig::getConfig().AccessControlManager.newPlugin(HT_ACCESS_CONTROL,acl);
\r
193 acl=XMLHelper::getFirstChildElement(e,_AccessControl);
\r
195 log.info("building XML-based AccessControl provider...");
\r
196 m_acl=SPConfig::getConfig().AccessControlManager.newPlugin(XML_ACCESS_CONTROL,acl);
\r
199 acl=XMLHelper::getFirstChildElement(e,AccessControlProvider);
\r
201 auto_ptr_char type(acl->getAttributeNS(NULL,_type));
\r
202 log.info("building AccessControl provider of type %s...",type.get());
\r
203 m_acl=SPConfig::getConfig().AccessControlManager.newPlugin(type.get(),acl);
\r
208 catch (exception& ex) {
\r
209 log.crit("exception building AccessControl provider: %s", ex.what());
\r
210 m_acl = new AccessControlDummy();
\r
214 Override::Override(const DOMElement* e, Category& log, const Override* base) : m_base(base), m_acl(NULL)
\r
217 // Load the property set.
\r
220 // Load any AccessControl provider.
\r
223 // Handle nested Paths.
\r
224 DOMElement* path = XMLHelper::getFirstChildElement(e,Path);
\r
225 for (int i=1; path; ++i, path=XMLHelper::getNextSiblingElement(path,Path)) {
\r
226 const XMLCh* n=path->getAttributeNS(NULL,name);
\r
228 // Skip any leading slashes.
\r
229 while (n && *n==chForwardSlash)
\r
232 // Check for empty name.
\r
234 log.warn("skipping Path element (%d) with empty name attribute", i);
\r
238 // Check for an embedded slash.
\r
239 int slash=XMLString::indexOf(n,chForwardSlash);
\r
241 // Copy the first path segment.
\r
242 XMLCh* namebuf=new XMLCh[slash + 1];
\r
243 for (int pos=0; pos < slash; pos++)
\r
244 namebuf[pos]=n[pos];
\r
245 namebuf[slash]=chNull;
\r
247 // Move past the slash in the original pathname.
\r
250 // Skip any leading slashes again.
\r
251 while (*n==chForwardSlash)
\r
255 // Create a placeholder Path element for the first path segment and replant under it.
\r
256 DOMElement* newpath=path->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS,Path);
\r
257 newpath->setAttributeNS(NULL,name,namebuf);
\r
258 path->setAttributeNS(NULL,name,n);
\r
259 path->getParentNode()->replaceChild(newpath,path);
\r
260 newpath->appendChild(path);
\r
262 // Repoint our locals at the new parent.
\r
264 n=path->getAttributeNS(NULL,name);
\r
267 // All we had was a pathname with trailing slash(es), so just reset it without them.
\r
268 path->setAttributeNS(NULL,name,namebuf);
\r
269 n=path->getAttributeNS(NULL,name);
\r
274 Override* o=new Override(path,log,this);
\r
275 pair<bool,const char*> name=o->getString("name");
\r
276 char* dup=strdup(name.second);
\r
277 for (char* pch=dup; *pch; pch++)
\r
278 *pch=tolower(*pch);
\r
279 if (m_map.count(dup)) {
\r
280 log.warn("Skipping duplicate Path element (%s)",dup);
\r
286 log.debug("Added Path mapping (%s)", dup);
\r
290 if (!XMLString::equals(e->getLocalName(), PathRegex)) {
\r
291 // Handle nested PathRegexs.
\r
292 path = XMLHelper::getFirstChildElement(e,PathRegex);
\r
293 for (int i=1; path; ++i, path=XMLHelper::getNextSiblingElement(path,PathRegex)) {
\r
294 const XMLCh* n=path->getAttributeNS(NULL,regex);
\r
296 log.warn("Skipping PathRegex element (%d) with empty regex attribute",i);
\r
300 auto_ptr<Override> o(new Override(path,log,this));
\r
302 const XMLCh* flag=path->getAttributeNS(NULL,ignoreCase);
\r
304 auto_ptr<RegularExpression> re(
\r
305 new RegularExpression(n, (flag && (*flag==chLatin_f || *flag==chDigit_0)) ? &chNull : ignoreOption)
\r
307 m_regexps.push_back(make_pair(re.release(), o.release()));
\r
309 catch (XMLException& ex) {
\r
310 auto_ptr_char tmp(ex.getMessage());
\r
311 log.error("caught exception while parsing PathRegex regular expression (%d): %s", i, tmp.get());
\r
312 throw ConfigurationException("Invalid regular expression in PathRegex element.");
\r
315 log.debug("Added <PathRegex> mapping (%s)", m_regexps.back().second->getString("regex").second);
\r
319 catch (exception&) {
\r
321 for_each(m_map.begin(),m_map.end(),xmltooling::cleanup_pair<string,Override>());
\r
326 Override::~Override()
\r
329 for_each(m_map.begin(),m_map.end(),xmltooling::cleanup_pair<string,Override>());
\r
330 for (vector< pair<RegularExpression*,Override*> >::iterator i = m_regexps.begin(); i != m_regexps.end(); ++i) {
\r
336 pair<bool,bool> Override::getBool(const char* name, const char* ns) const
\r
338 pair<bool,bool> ret=DOMPropertySet::getBool(name,ns);
\r
341 return m_base ? m_base->getBool(name,ns) : ret;
\r
344 pair<bool,const char*> Override::getString(const char* name, const char* ns) const
\r
346 pair<bool,const char*> ret=DOMPropertySet::getString(name,ns);
\r
349 return m_base ? m_base->getString(name,ns) : ret;
\r
352 pair<bool,const XMLCh*> Override::getXMLString(const char* name, const char* ns) const
\r
354 pair<bool,const XMLCh*> ret=DOMPropertySet::getXMLString(name,ns);
\r
357 return m_base ? m_base->getXMLString(name,ns) : ret;
\r
360 pair<bool,unsigned int> Override::getUnsignedInt(const char* name, const char* ns) const
\r
362 pair<bool,unsigned int> ret=DOMPropertySet::getUnsignedInt(name,ns);
\r
365 return m_base ? m_base->getUnsignedInt(name,ns) : ret;
\r
368 pair<bool,int> Override::getInt(const char* name, const char* ns) const
\r
370 pair<bool,int> ret=DOMPropertySet::getInt(name,ns);
\r
373 return m_base ? m_base->getInt(name,ns) : ret;
\r
376 const PropertySet* Override::getPropertySet(const char* name, const char* ns) const
\r
378 const PropertySet* ret=DOMPropertySet::getPropertySet(name,ns);
\r
379 if (ret || !m_base)
\r
381 return m_base->getPropertySet(name,ns);
\r
384 const Override* Override::locate(const char* path) const
\r
386 // This function is confusing because it's *not* recursive.
\r
387 // The whole path is tokenized and mapped in a loop, so the
\r
388 // path parameter starts with the entire request path and
\r
389 // we can skip the leading slash as irrelevant.
\r
393 // Now we copy the path, chop the query string, and lower case it.
\r
394 char* dup=strdup(path);
\r
395 char* sep=strchr(dup,'?');
\r
398 for (char* pch=dup; *pch; pch++)
\r
399 *pch=tolower(*pch);
\r
401 // Default is for the current object to provide settings.
\r
402 const Override* o=this;
\r
404 // Tokenize the path by segment and try and map each segment.
\r
405 #ifdef HAVE_STRTOK_R
\r
407 const char* token=strtok_r(dup,"/",&pos);
\r
409 const char* token=strtok(dup,"/");
\r
412 map<string,Override*>::const_iterator i=o->m_map.find(token);
\r
413 if (i==o->m_map.end())
\r
414 break; // Once there's no match, we've consumed as much of the path as possible here.
\r
415 // We found a match, so reset the settings pointer.
\r
418 // We descended a step down the path, so we need to advance the original
\r
419 // parameter for the regex step later.
\r
420 path += strlen(token);
\r
424 // Get the next segment, if any.
\r
425 #ifdef HAVE_STRTOK_R
\r
426 token=strtok_r(NULL,"/",&pos);
\r
428 token=strtok(NULL,"/");
\r
434 // If there's anything left, we try for a regex match on the rest of the path.
\r
436 for (vector< pair<RegularExpression*,Override*> >::const_iterator re = o->m_regexps.begin(); re != o->m_regexps.end(); ++re) {
\r
437 if (re->first->matches(path))
\r
445 XMLRequestMapperImpl::XMLRequestMapperImpl(const DOMElement* e, Category& log) : m_document(NULL)
\r
448 xmltooling::NDC ndc("XMLRequestMapperImpl");
\r
451 // Load the property set.
\r
454 // Load any AccessControl provider.
\r
457 // Loop over the HostRegex elements.
\r
458 const DOMElement* host = XMLHelper::getFirstChildElement(e,HostRegex);
\r
459 for (int i=1; host; ++i, host=XMLHelper::getNextSiblingElement(host,HostRegex)) {
\r
460 const XMLCh* n=host->getAttributeNS(NULL,regex);
\r
462 log.warn("Skipping HostRegex element (%d) with empty regex attribute",i);
\r
466 auto_ptr<Override> o(new Override(host,log,this));
\r
468 const XMLCh* flag=host->getAttributeNS(NULL,ignoreCase);
\r
470 auto_ptr<RegularExpression> re(
\r
471 new RegularExpression(n, (flag && (*flag==chLatin_f || *flag==chDigit_0)) ? &chNull : ignoreOption)
\r
473 m_regexps.push_back(make_pair(re.release(), o.release()));
\r
475 catch (XMLException& ex) {
\r
476 auto_ptr_char tmp(ex.getMessage());
\r
477 log.error("caught exception while parsing HostRegex regular expression (%d): %s", i, tmp.get());
\r
480 log.debug("Added <HostRegex> mapping for %s", m_regexps.back().second->getString("regex").second);
\r
483 // Loop over the Host elements.
\r
484 host = XMLHelper::getFirstChildElement(e,Host);
\r
485 for (int i=1; host; ++i, host=XMLHelper::getNextSiblingElement(host,Host)) {
\r
486 const XMLCh* n=host->getAttributeNS(NULL,name);
\r
488 log.warn("Skipping Host element (%d) with empty name attribute",i);
\r
492 Override* o=new Override(host,log,this);
\r
493 pair<bool,const char*> name=o->getString("name");
\r
494 pair<bool,const char*> scheme=o->getString("scheme");
\r
495 pair<bool,const char*> port=o->getString("port");
\r
497 char* dup=strdup(name.second);
\r
498 for (char* pch=dup; *pch; pch++)
\r
499 *pch=tolower(*pch);
\r
500 auto_ptr<char> dupwrap(dup);
\r
502 if (!scheme.first && port.first) {
\r
503 // No scheme, but a port, so assume http.
\r
504 scheme = pair<bool,const char*>(true,"http");
\r
506 else if (scheme.first && !port.first) {
\r
507 // Scheme, no port, so default it.
\r
508 // XXX Use getservbyname instead?
\r
510 if (!strcmp(scheme.second,"http"))
\r
511 port.second = "80";
\r
512 else if (!strcmp(scheme.second,"https"))
\r
513 port.second = "443";
\r
514 else if (!strcmp(scheme.second,"ftp"))
\r
515 port.second = "21";
\r
516 else if (!strcmp(scheme.second,"ldap"))
\r
517 port.second = "389";
\r
518 else if (!strcmp(scheme.second,"ldaps"))
\r
519 port.second = "636";
\r
522 if (scheme.first) {
\r
523 string url(scheme.second);
\r
524 url=url + "://" + dup;
\r
526 // Is this the default port?
\r
527 if ((!strcmp(scheme.second,"http") && !strcmp(port.second,"80")) ||
\r
528 (!strcmp(scheme.second,"https") && !strcmp(port.second,"443")) ||
\r
529 (!strcmp(scheme.second,"ftp") && !strcmp(port.second,"21")) ||
\r
530 (!strcmp(scheme.second,"ldap") && !strcmp(port.second,"389")) ||
\r
531 (!strcmp(scheme.second,"ldaps") && !strcmp(port.second,"636"))) {
\r
532 // First store a port-less version.
\r
533 if (m_map.count(url) || m_extras.count(url)) {
\r
534 log.warn("Skipping duplicate Host element (%s)",url.c_str());
\r
539 log.debug("Added <Host> mapping for %s",url.c_str());
\r
541 // Now append the port. We use the extras vector, to avoid double freeing the object later.
\r
542 url=url + ':' + port.second;
\r
544 log.debug("Added <Host> mapping for %s",url.c_str());
\r
547 url=url + ':' + port.second;
\r
548 if (m_map.count(url) || m_extras.count(url)) {
\r
549 log.warn("Skipping duplicate Host element (%s)",url.c_str());
\r
554 log.debug("Added <Host> mapping for %s",url.c_str());
\r
558 // No scheme or port, so we enter dual hosts on http:80 and https:443
\r
559 string url("http://");
\r
561 if (m_map.count(url) || m_extras.count(url)) {
\r
562 log.warn("Skipping duplicate Host element (%s)",url.c_str());
\r
567 log.debug("Added <Host> mapping for %s",url.c_str());
\r
570 if (m_map.count(url) || m_extras.count(url)) {
\r
571 log.warn("Skipping duplicate Host element (%s)",url.c_str());
\r
575 log.debug("Added <Host> mapping for %s",url.c_str());
\r
579 if (m_map.count(url) || m_extras.count(url)) {
\r
580 log.warn("Skipping duplicate Host element (%s)",url.c_str());
\r
584 log.debug("Added <Host> mapping for %s",url.c_str());
\r
586 url = url + ":443";
\r
587 if (m_map.count(url) || m_extras.count(url)) {
\r
588 log.warn("Skipping duplicate Host element (%s)",url.c_str());
\r
592 log.debug("Added <Host> mapping for %s",url.c_str());
\r
597 const Override* XMLRequestMapperImpl::findOverride(const char* vhost, const char* path) const
\r
599 const Override* o=NULL;
\r
600 map<string,Override*>::const_iterator i=m_map.find(vhost);
\r
601 if (i!=m_map.end())
\r
604 i=m_extras.find(vhost);
\r
605 if (i!=m_extras.end())
\r
608 for (vector< pair<RegularExpression*,Override*> >::const_iterator re = m_regexps.begin(); !o && re != m_regexps.end(); ++re) {
\r
609 if (re->first->matches(vhost))
\r
615 return o ? o->locate(path) : this;
\r
618 pair<bool,DOMElement*> XMLRequestMapper::load()
\r
620 // Load from source using base class.
\r
621 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
\r
623 // If we own it, wrap it.
\r
624 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : NULL);
\r
626 XMLRequestMapperImpl* impl = new XMLRequestMapperImpl(raw.second,m_log);
\r
628 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
\r
629 impl->setDocument(docjanitor.release());
\r
634 return make_pair(false,(DOMElement*)NULL);
\r
637 RequestMapper::Settings XMLRequestMapper::getSettings(const SPRequest& request) const
\r
639 ostringstream vhost;
\r
640 vhost << request.getScheme() << "://" << request.getHostname() << ':' << request.getPort();
\r
642 const Override* o=m_impl->findOverride(vhost.str().c_str(), request.getRequestURI());
\r
644 if (m_log.isDebugEnabled()) {
\r
646 xmltooling::NDC ndc("getSettings");
\r
648 pair<bool,const char*> ret=o->getString("applicationId");
\r
649 m_log.debug("mapped %s%s to %s", vhost.str().c_str(), request.getRequestURI() ? request.getRequestURI() : "", ret.second);
\r
652 return Settings(o,o->getAC());
\r