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
18 * XMLServiceProvider.cpp
\r
20 * XML-based SP configuration and mgmt
\r
23 #include "internal.h"
\r
24 #include "exceptions.h"
\r
25 #include "AccessControl.h"
\r
26 #include "Application.h"
\r
27 #include "Handler.h"
\r
28 #include "RequestMapper.h"
\r
29 #include "ServiceProvider.h"
\r
30 #include "SessionCache.h"
\r
31 #include "SPConfig.h"
\r
32 #include "SPRequest.h"
\r
33 #include "TransactionLog.h"
\r
34 #include "attribute/Attribute.h"
\r
35 #include "remoting/ListenerService.h"
\r
36 #include "security/PKIXTrustEngine.h"
\r
37 #include "util/DOMPropertySet.h"
\r
38 #include "util/SPConstants.h"
\r
40 #include <sys/types.h>
\r
41 #include <sys/stat.h>
\r
42 #include <log4cpp/Category.hh>
\r
43 #include <log4cpp/PropertyConfigurator.hh>
\r
44 #include <saml/SAMLConfig.h>
\r
45 #include <saml/saml1/core/Assertions.h>
\r
46 #include <saml/saml2/metadata/ChainingMetadataProvider.h>
\r
47 #include <xmltooling/XMLToolingConfig.h>
\r
48 #include <xmltooling/security/ChainingTrustEngine.h>
\r
49 #include <xmltooling/util/NDC.h>
\r
50 #include <xmltooling/util/ReloadableXMLFile.h>
\r
51 #include <xmltooling/util/ReplayCache.h>
\r
53 using namespace shibsp;
\r
54 using namespace opensaml::saml2;
\r
55 using namespace opensaml::saml2md;
\r
56 using namespace opensaml;
\r
57 using namespace xmltooling;
\r
58 using namespace log4cpp;
\r
59 using namespace std;
\r
60 using xmlsignature::CredentialResolver;
\r
64 #if defined (_MSC_VER)
\r
65 #pragma warning( push )
\r
66 #pragma warning( disable : 4250 )
\r
69 static vector<const Handler*> g_noHandlers;
\r
71 // Application configuration wrapper
\r
72 class SHIBSP_DLLLOCAL XMLApplication : public virtual Application, public DOMPropertySet, public DOMNodeFilter
\r
75 XMLApplication(const ServiceProvider*, const DOMElement* e, const XMLApplication* base=NULL);
\r
76 ~XMLApplication() { cleanup(); }
\r
79 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
\r
80 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
\r
81 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
\r
82 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
\r
83 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
\r
84 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:target:config:1.0") const;
\r
87 const char* getId() const {return getString("id").second;}
\r
88 const char* getHash() const {return m_hash.c_str();}
\r
89 MetadataProvider* getMetadataProvider() const;
\r
90 TrustEngine* getTrustEngine() const;
\r
91 const vector<const XMLCh*>& getAudiences() const;
\r
92 const PropertySet* getCredentialUse(const EntityDescriptor* provider) const;
\r
94 const Handler* getDefaultSessionInitiator() const;
\r
95 const Handler* getSessionInitiatorById(const char* id) const;
\r
96 const Handler* getDefaultAssertionConsumerService() const;
\r
97 const Handler* getAssertionConsumerServiceByIndex(unsigned short index) const;
\r
98 const vector<const Handler*>& getAssertionConsumerServicesByBinding(const XMLCh* binding) const;
\r
99 const Handler* getHandler(const char* path) const;
\r
101 // Provides filter to exclude special config elements.
\r
102 short acceptNode(const DOMNode* node) const;
\r
106 const ServiceProvider* m_sp; // this is ok because its locking scope includes us
\r
107 const XMLApplication* m_base;
\r
109 MetadataProvider* m_metadata;
\r
110 TrustEngine* m_trust;
\r
111 vector<const XMLCh*> m_audiences;
\r
113 // manage handler objects
\r
114 vector<Handler*> m_handlers;
\r
116 // maps location (path info) to applicable handlers
\r
117 map<string,const Handler*> m_handlerMap;
\r
119 // maps unique indexes to consumer services
\r
120 map<unsigned int,const Handler*> m_acsIndexMap;
\r
122 // pointer to default consumer service
\r
123 const Handler* m_acsDefault;
\r
125 // maps binding strings to supporting consumer service(s)
\r
126 #ifdef HAVE_GOOD_STL
\r
127 typedef map<xstring,vector<const Handler*> > ACSBindingMap;
\r
129 typedef map<string,vector<const Handler*> > ACSBindingMap;
\r
131 ACSBindingMap m_acsBindingMap;
\r
133 // maps unique ID strings to session initiators
\r
134 map<string,const Handler*> m_sessionInitMap;
\r
136 // pointer to default session initiator
\r
137 const Handler* m_sessionInitDefault;
\r
139 DOMPropertySet* m_credDefault;
\r
140 #ifdef HAVE_GOOD_STL
\r
141 map<xstring,PropertySet*> m_credMap;
\r
143 map<const XMLCh*,PropertySet*> m_credMap;
\r
147 // Top-level configuration implementation
\r
148 class SHIBSP_DLLLOCAL XMLConfig;
\r
149 class SHIBSP_DLLLOCAL XMLConfigImpl : public DOMPropertySet, public DOMNodeFilter
\r
152 XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer);
\r
155 RequestMapper* m_requestMapper;
\r
156 map<string,Application*> m_appmap;
\r
157 map<string,CredentialResolver*> m_credResolverMap;
\r
158 map< string,vector<const SecurityPolicyRule*> > m_policyMap;
\r
159 string m_policyDefault;
\r
161 // Provides filter to exclude special config elements.
\r
162 short acceptNode(const DOMNode* node) const;
\r
164 void setDocument(DOMDocument* doc) {
\r
169 void doExtensions(const DOMElement* e, const char* label, Category& log);
\r
171 const XMLConfig* m_outer;
\r
172 DOMDocument* m_document;
\r
175 class SHIBSP_DLLLOCAL XMLConfig : public ServiceProvider, public ReloadableXMLFile
\r
178 XMLConfig(const DOMElement* e)
\r
179 : ReloadableXMLFile(e), m_impl(NULL), m_listener(NULL), m_sessionCache(NULL), m_tranLog(NULL) {
\r
188 delete m_sessionCache;
\r
191 XMLToolingConfig::getConfig().setReplayCache(NULL);
\r
192 for_each(m_storage.begin(), m_storage.end(), cleanup_pair<string,StorageService>());
\r
196 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const {return m_impl->getBool(name,ns);}
\r
197 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const {return m_impl->getString(name,ns);}
\r
198 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const {return m_impl->getXMLString(name,ns);}
\r
199 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const {return m_impl->getUnsignedInt(name,ns);}
\r
200 pair<bool,int> getInt(const char* name, const char* ns=NULL) const {return m_impl->getInt(name,ns);}
\r
201 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:sp:config:2.0") const {return m_impl->getPropertySet(name,ns);}
\r
202 const DOMElement* getElement() const {return m_impl->getElement();}
\r
205 TransactionLog* getTransactionLog() const {
\r
208 throw ConfigurationException("No TransactionLog available.");
\r
211 StorageService* getStorageService(const char* id) const {
\r
213 map<string,StorageService*>::const_iterator i=m_storage.find(id);
\r
214 if (i!=m_storage.end())
\r
220 ListenerService* getListenerService(bool required=true) const {
\r
221 if (required && !m_listener)
\r
222 throw ConfigurationException("No ListenerService available.");
\r
226 SessionCache* getSessionCache(bool required=true) const {
\r
227 if (required && !m_sessionCache)
\r
228 throw ConfigurationException("No SessionCache available.");
\r
229 return m_sessionCache;
\r
232 RequestMapper* getRequestMapper(bool required=true) const {
\r
233 if (required && !m_impl->m_requestMapper)
\r
234 throw ConfigurationException("No RequestMapper available.");
\r
235 return m_impl->m_requestMapper;
\r
238 const Application* getApplication(const char* applicationId) const {
\r
239 map<string,Application*>::const_iterator i=m_impl->m_appmap.find(applicationId);
\r
240 return (i!=m_impl->m_appmap.end()) ? i->second : NULL;
\r
243 CredentialResolver* getCredentialResolver(const char* id) const {
\r
245 map<string,CredentialResolver*>::const_iterator i=m_impl->m_credResolverMap.find(id);
\r
246 if (i!=m_impl->m_credResolverMap.end())
\r
252 vector<const SecurityPolicyRule*>& getPolicyRules(const Handler& handler) const {
\r
253 pair<bool,const char*> pid = handler.getString("policyId", "urn:mace:shibboleth:sp:config:2.0");
\r
255 pid.second = m_impl->m_policyDefault.c_str();
\r
256 if (m_impl->m_policyMap.count(pid.second))
\r
257 return m_impl->m_policyMap[pid.second];
\r
258 throw ConfigurationException("Security Policy ($1) not found, check <SecurityPolicies> element.", params(1,pid.second));
\r
262 pair<bool,DOMElement*> load();
\r
265 friend class XMLConfigImpl;
\r
266 XMLConfigImpl* m_impl;
\r
267 mutable ListenerService* m_listener;
\r
268 mutable SessionCache* m_sessionCache;
\r
269 mutable TransactionLog* m_tranLog;
\r
270 mutable map<string,StorageService*> m_storage;
\r
273 #if defined (_MSC_VER)
\r
274 #pragma warning( pop )
\r
277 static const XMLCh _Application[] = UNICODE_LITERAL_11(A,p,p,l,i,c,a,t,i,o,n);
\r
278 static const XMLCh Applications[] = UNICODE_LITERAL_12(A,p,p,l,i,c,a,t,i,o,n,s);
\r
279 static const XMLCh Credentials[] = UNICODE_LITERAL_11(C,r,e,d,e,n,t,i,a,l,s);
\r
280 static const XMLCh CredentialUse[] = UNICODE_LITERAL_13(C,r,e,d,e,n,t,i,a,l,U,s,e);
\r
281 static const XMLCh _default[] = UNICODE_LITERAL_7(d,e,f,a,u,l,t);
\r
282 static const XMLCh fatal[] = UNICODE_LITERAL_5(f,a,t,a,l);
\r
283 static const XMLCh _Handler[] = UNICODE_LITERAL_7(H,a,n,d,l,e,r);
\r
284 static const XMLCh _id[] = UNICODE_LITERAL_2(i,d);
\r
285 static const XMLCh Implementation[] = UNICODE_LITERAL_14(I,m,p,l,e,m,e,n,t,a,t,i,o,n);
\r
286 static const XMLCh InProcess[] = UNICODE_LITERAL_9(I,n,P,r,o,c,e,s,s);
\r
287 static const XMLCh Library[] = UNICODE_LITERAL_7(L,i,b,r,a,r,y);
\r
288 static const XMLCh Listener[] = UNICODE_LITERAL_8(L,i,s,t,e,n,e,r);
\r
289 static const XMLCh logger[] = UNICODE_LITERAL_6(l,o,g,g,e,r);
\r
290 static const XMLCh MemoryListener[] = UNICODE_LITERAL_14(M,e,m,o,r,y,L,i,s,t,e,n,e,r);
\r
291 static const XMLCh Policy[] = UNICODE_LITERAL_6(P,o,l,i,c,y);
\r
292 static const XMLCh RelyingParty[] = UNICODE_LITERAL_12(R,e,l,y,i,n,g,P,a,r,t,y);
\r
293 static const XMLCh _ReplayCache[] = UNICODE_LITERAL_11(R,e,p,l,a,y,C,a,c,h,e);
\r
294 static const XMLCh _RequestMapper[] = UNICODE_LITERAL_13(R,e,q,u,e,s,t,M,a,p,p,e,r);
\r
295 static const XMLCh Rule[] = UNICODE_LITERAL_4(R,u,l,e);
\r
296 static const XMLCh SecurityPolicies[] = UNICODE_LITERAL_16(S,e,c,u,r,i,t,y,P,o,l,i,c,i,e,s);
\r
297 static const XMLCh _SessionCache[] = UNICODE_LITERAL_12(S,e,s,s,i,o,n,C,a,c,h,e);
\r
298 static const XMLCh SessionInitiator[] = UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
\r
299 static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
\r
300 static const XMLCh OutOfProcess[] = UNICODE_LITERAL_12(O,u,t,O,f,P,r,o,c,e,s,s);
\r
301 static const XMLCh TCPListener[] = UNICODE_LITERAL_11(T,C,P,L,i,s,t,e,n,e,r);
\r
302 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
\r
303 static const XMLCh UnixListener[] = UNICODE_LITERAL_12(U,n,i,x,L,i,s,t,e,n,e,r);
\r
304 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
\r
305 static const XMLCh _path[] = UNICODE_LITERAL_4(p,a,t,h);
\r
306 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
\r
310 ServiceProvider* XMLServiceProviderFactory(const DOMElement* const & e)
\r
312 return new XMLConfig(e);
\r
316 XMLApplication::XMLApplication(
\r
317 const ServiceProvider* sp,
\r
318 const DOMElement* e,
\r
319 const XMLApplication* base
\r
320 ) : m_sp(sp), m_base(base), m_metadata(NULL), m_trust(NULL),
\r
321 m_credDefault(NULL), m_sessionInitDefault(NULL), m_acsDefault(NULL)
\r
324 xmltooling::NDC ndc("XMLApplication");
\r
326 Category& log=Category::getInstance(SHIBSP_LOGCAT".Application");
\r
329 // First load any property sets.
\r
332 SPConfig& conf=SPConfig::getConfig();
\r
333 SAMLConfig& samlConf=SAMLConfig::getConfig();
\r
334 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
\r
337 m_hash+=getString("providerId").second;
\r
338 m_hash=samlConf.hashSHA1(m_hash.c_str(), true);
\r
340 const PropertySet* sessions = getPropertySet("Sessions");
\r
342 // Process handlers.
\r
343 Handler* handler=NULL;
\r
344 bool hardACS=false, hardSessionInit=false;
\r
345 const DOMElement* child = sessions ? XMLHelper::getFirstChildElement(sessions->getElement()) : NULL;
\r
348 // A handler is based on the Binding property in conjunction with the element name.
\r
349 // If it's an ACS or SI, also handle index/id mappings and defaulting.
\r
350 if (XMLHelper::isNodeNamed(child,samlconstants::SAML20MD_NS,AssertionConsumerService::LOCAL_NAME)) {
\r
351 auto_ptr_char bindprop(child->getAttributeNS(NULL,EndpointType::BINDING_ATTRIB_NAME));
\r
352 if (!bindprop.get() || !*(bindprop.get())) {
\r
353 log.warn("md:AssertionConsumerService element has no Binding attribute, skipping it...");
\r
354 child = XMLHelper::getNextSiblingElement(child);
\r
357 handler=conf.AssertionConsumerServiceManager.newPlugin(bindprop.get(),child);
\r
358 // Map by binding (may be > 1 per binding, e.g. SAML 1.0 vs 1.1)
\r
359 #ifdef HAVE_GOOD_STL
\r
360 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler);
\r
362 m_acsBindingMap[handler->getString("Binding").second].push_back(handler);
\r
364 m_acsIndexMap[handler->getUnsignedInt("index").second]=handler;
\r
367 pair<bool,bool> defprop=handler->getBool("isDefault");
\r
368 if (defprop.first) {
\r
369 if (defprop.second) {
\r
371 m_acsDefault=handler;
\r
374 else if (!m_acsDefault)
\r
375 m_acsDefault=handler;
\r
378 else if (XMLString::equals(child->getLocalName(),SessionInitiator)) {
\r
379 auto_ptr_char bindprop(child->getAttributeNS(NULL,EndpointType::BINDING_ATTRIB_NAME));
\r
380 if (!bindprop.get() || !*(bindprop.get())) {
\r
381 log.warn("SessionInitiator element has no Binding attribute, skipping it...");
\r
382 child = XMLHelper::getNextSiblingElement(child);
\r
385 handler=conf.SessionInitiatorManager.newPlugin(bindprop.get(),child);
\r
386 pair<bool,const char*> si_id=handler->getString("id");
\r
387 if (si_id.first && si_id.second)
\r
388 m_sessionInitMap[si_id.second]=handler;
\r
389 if (!hardSessionInit) {
\r
390 pair<bool,bool> defprop=handler->getBool("isDefault");
\r
391 if (defprop.first) {
\r
392 if (defprop.second) {
\r
393 hardSessionInit=true;
\r
394 m_sessionInitDefault=handler;
\r
397 else if (!m_sessionInitDefault)
\r
398 m_sessionInitDefault=handler;
\r
401 else if (XMLHelper::isNodeNamed(child,samlconstants::SAML20MD_NS,SingleLogoutService::LOCAL_NAME)) {
\r
402 auto_ptr_char bindprop(child->getAttributeNS(NULL,EndpointType::BINDING_ATTRIB_NAME));
\r
403 if (!bindprop.get() || !*(bindprop.get())) {
\r
404 log.warn("md:SingleLogoutService element has no Binding attribute, skipping it...");
\r
405 child = XMLHelper::getNextSiblingElement(child);
\r
408 handler=conf.SingleLogoutServiceManager.newPlugin(bindprop.get(),child);
\r
410 else if (XMLHelper::isNodeNamed(child,samlconstants::SAML20MD_NS,ManageNameIDService::LOCAL_NAME)) {
\r
411 auto_ptr_char bindprop(child->getAttributeNS(NULL,EndpointType::BINDING_ATTRIB_NAME));
\r
412 if (!bindprop.get() || !*(bindprop.get())) {
\r
413 log.warn("md:ManageNameIDService element has no Binding attribute, skipping it...");
\r
414 child = XMLHelper::getNextSiblingElement(child);
\r
417 handler=conf.ManageNameIDServiceManager.newPlugin(bindprop.get(),child);
\r
420 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
421 if (!type.get() || !*(type.get())) {
\r
422 log.warn("Handler element has no type attribute, skipping it...");
\r
423 child = XMLHelper::getNextSiblingElement(child);
\r
426 handler=conf.HandlerManager.newPlugin(type.get(),child);
\r
429 // Save off the objects after giving the property set to the handler for its use.
\r
430 m_handlers.push_back(handler);
\r
432 // Insert into location map.
\r
433 pair<bool,const char*> location=handler->getString("Location");
\r
434 if (location.first && *location.second == '/')
\r
435 m_handlerMap[location.second]=handler;
\r
436 else if (location.first)
\r
437 m_handlerMap[string("/") + location.second]=handler;
\r
440 catch (exception& ex) {
\r
441 log.error("caught exception processing handler element: %s", ex.what());
\r
444 child = XMLHelper::getNextSiblingElement(child);
\r
447 DOMNodeList* nlist=e->getElementsByTagNameNS(samlconstants::SAML20_NS,Audience::LOCAL_NAME);
\r
448 for (XMLSize_t i=0; nlist && i<nlist->getLength(); i++)
\r
449 if (nlist->item(i)->getParentNode()->isSameNode(e) && nlist->item(i)->hasChildNodes())
\r
450 m_audiences.push_back(nlist->item(i)->getFirstChild()->getNodeValue());
\r
452 // Always include our own providerId as an audience.
\r
453 m_audiences.push_back(getXMLString("providerId").second);
\r
455 if (conf.isEnabled(SPConfig::AttributeResolver)) {
\r
459 if (conf.isEnabled(SPConfig::Metadata)) {
\r
460 child = XMLHelper::getFirstChildElement(e,_MetadataProvider);
\r
462 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
463 log.info("building metadata provider of type %s...",type.get());
\r
465 auto_ptr<MetadataProvider> mp(samlConf.MetadataProviderManager.newPlugin(type.get(),child));
\r
467 m_metadata = mp.release();
\r
469 catch (exception& ex) {
\r
470 log.crit("error building/initializing metadata provider: %s", ex.what());
\r
475 if (conf.isEnabled(SPConfig::Trust)) {
\r
476 child = XMLHelper::getFirstChildElement(e,_TrustEngine);
\r
478 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
479 log.info("building trust engine of type %s...",type.get());
\r
481 m_trust = xmlConf.TrustEngineManager.newPlugin(type.get(),child);
\r
483 catch (exception& ex) {
\r
484 log.crit("error building trust engine: %s",ex.what());
\r
489 // Finally, load credential mappings.
\r
490 child = XMLHelper::getFirstChildElement(e,CredentialUse);
\r
492 m_credDefault=new DOMPropertySet();
\r
493 m_credDefault->load(child,log,this);
\r
494 child = XMLHelper::getFirstChildElement(child,RelyingParty);
\r
496 DOMPropertySet* rp=new DOMPropertySet();
\r
497 rp->load(child,log,this);
\r
498 m_credMap[child->getAttributeNS(NULL,opensaml::saml2::Attribute::NAME_ATTRIB_NAME)]=rp;
\r
499 child = XMLHelper::getNextSiblingElement(child,RelyingParty);
\r
503 if (conf.isEnabled(SPConfig::OutOfProcess)) {
\r
504 // Really finally, build local browser profile and binding objects.
\r
505 // TODO: may need some bits here...
\r
508 catch (exception&) {
\r
520 void XMLApplication::cleanup()
\r
522 for_each(m_handlers.begin(),m_handlers.end(),xmltooling::cleanup<Handler>());
\r
524 delete m_credDefault;
\r
525 #ifdef HAVE_GOOD_STL
\r
526 for_each(m_credMap.begin(),m_credMap.end(),cleanup_pair<xstring,PropertySet>());
\r
528 for_each(m_credMap.begin(),m_credMap.end(),cleanup_pair<const XMLCh*,PropertySet>());
\r
535 short XMLApplication::acceptNode(const DOMNode* node) const
\r
537 if (XMLHelper::isNodeNamed(node,samlconstants::SAML20_NS,opensaml::saml2::Attribute::LOCAL_NAME))
\r
538 return FILTER_REJECT;
\r
539 else if (XMLHelper::isNodeNamed(node,samlconstants::SAML20_NS,Audience::LOCAL_NAME))
\r
540 return FILTER_REJECT;
\r
541 const XMLCh* name=node->getLocalName();
\r
542 if (XMLString::equals(name,_Application) ||
\r
543 XMLString::equals(name,AssertionConsumerService::LOCAL_NAME) ||
\r
544 XMLString::equals(name,SingleLogoutService::LOCAL_NAME) ||
\r
545 XMLString::equals(name,ManageNameIDService::LOCAL_NAME) ||
\r
546 XMLString::equals(name,SessionInitiator) ||
\r
547 XMLString::equals(name,CredentialUse) ||
\r
548 XMLString::equals(name,RelyingParty) ||
\r
549 XMLString::equals(name,_MetadataProvider) ||
\r
550 XMLString::equals(name,_TrustEngine))
\r
551 return FILTER_REJECT;
\r
553 return FILTER_ACCEPT;
\r
556 pair<bool,bool> XMLApplication::getBool(const char* name, const char* ns) const
\r
558 pair<bool,bool> ret=DOMPropertySet::getBool(name,ns);
\r
561 return m_base ? m_base->getBool(name,ns) : ret;
\r
564 pair<bool,const char*> XMLApplication::getString(const char* name, const char* ns) const
\r
566 pair<bool,const char*> ret=DOMPropertySet::getString(name,ns);
\r
569 return m_base ? m_base->getString(name,ns) : ret;
\r
572 pair<bool,const XMLCh*> XMLApplication::getXMLString(const char* name, const char* ns) const
\r
574 pair<bool,const XMLCh*> ret=DOMPropertySet::getXMLString(name,ns);
\r
577 return m_base ? m_base->getXMLString(name,ns) : ret;
\r
580 pair<bool,unsigned int> XMLApplication::getUnsignedInt(const char* name, const char* ns) const
\r
582 pair<bool,unsigned int> ret=DOMPropertySet::getUnsignedInt(name,ns);
\r
585 return m_base ? m_base->getUnsignedInt(name,ns) : ret;
\r
588 pair<bool,int> XMLApplication::getInt(const char* name, const char* ns) const
\r
590 pair<bool,int> ret=DOMPropertySet::getInt(name,ns);
\r
593 return m_base ? m_base->getInt(name,ns) : ret;
\r
596 const PropertySet* XMLApplication::getPropertySet(const char* name, const char* ns) const
\r
598 const PropertySet* ret=DOMPropertySet::getPropertySet(name,ns);
\r
599 if (ret || !m_base)
\r
601 return m_base->getPropertySet(name,ns);
\r
604 MetadataProvider* XMLApplication::getMetadataProvider() const
\r
606 return (!m_metadata && m_base) ? m_base->getMetadataProvider() : m_metadata;
\r
609 TrustEngine* XMLApplication::getTrustEngine() const
\r
611 return (!m_trust && m_base) ? m_base->getTrustEngine() : m_trust;
\r
614 const vector<const XMLCh*>& XMLApplication::getAudiences() const
\r
616 return (m_audiences.empty() && m_base) ? m_base->getAudiences() : m_audiences;
\r
619 const PropertySet* XMLApplication::getCredentialUse(const EntityDescriptor* provider) const
\r
621 if (!m_credDefault && m_base)
\r
622 return m_base->getCredentialUse(provider);
\r
624 #ifdef HAVE_GOOD_STL
\r
625 map<xstring,PropertySet*>::const_iterator i=m_credMap.find(provider->getEntityID());
\r
626 if (i!=m_credMap.end())
\r
628 const EntitiesDescriptor* group=dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
\r
630 if (group->getName()) {
\r
631 i=m_credMap.find(group->getName());
\r
632 if (i!=m_credMap.end())
\r
635 group=dynamic_cast<const EntitiesDescriptor*>(group->getParent());
\r
638 map<const XMLCh*,PropertySet*>::const_iterator i=m_credMap.begin();
\r
639 for (; i!=m_credMap.end(); i++) {
\r
640 if (XMLString::equals(i->first,provider->getId()))
\r
642 const EntitiesDescriptor* group=dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
\r
644 if (XMLString::equals(i->first,group->getName()))
\r
646 group=dynamic_cast<const EntitiesDescriptor*>(group->getParent());
\r
650 return m_credDefault;
\r
653 const Handler* XMLApplication::getDefaultSessionInitiator() const
\r
655 if (m_sessionInitDefault) return m_sessionInitDefault;
\r
656 return m_base ? m_base->getDefaultSessionInitiator() : NULL;
\r
659 const Handler* XMLApplication::getSessionInitiatorById(const char* id) const
\r
661 map<string,const Handler*>::const_iterator i=m_sessionInitMap.find(id);
\r
662 if (i!=m_sessionInitMap.end()) return i->second;
\r
663 return m_base ? m_base->getSessionInitiatorById(id) : NULL;
\r
666 const Handler* XMLApplication::getDefaultAssertionConsumerService() const
\r
668 if (m_acsDefault) return m_acsDefault;
\r
669 return m_base ? m_base->getDefaultAssertionConsumerService() : NULL;
\r
672 const Handler* XMLApplication::getAssertionConsumerServiceByIndex(unsigned short index) const
\r
674 map<unsigned int,const Handler*>::const_iterator i=m_acsIndexMap.find(index);
\r
675 if (i!=m_acsIndexMap.end()) return i->second;
\r
676 return m_base ? m_base->getAssertionConsumerServiceByIndex(index) : NULL;
\r
679 const vector<const Handler*>& XMLApplication::getAssertionConsumerServicesByBinding(const XMLCh* binding) const
\r
681 #ifdef HAVE_GOOD_STL
\r
682 ACSBindingMap::const_iterator i=m_acsBindingMap.find(binding);
\r
684 auto_ptr_char temp(binding);
\r
685 ACSBindingMap::const_iterator i=m_acsBindingMap.find(temp.get());
\r
687 if (i!=m_acsBindingMap.end())
\r
689 return m_base ? m_base->getAssertionConsumerServicesByBinding(binding) : g_noHandlers;
\r
692 const Handler* XMLApplication::getHandler(const char* path) const
\r
695 map<string,const Handler*>::const_iterator i=m_handlerMap.find(wrap.substr(0,wrap.find('?')));
\r
696 if (i!=m_handlerMap.end())
\r
698 return m_base ? m_base->getHandler(path) : NULL;
\r
701 short XMLConfigImpl::acceptNode(const DOMNode* node) const
\r
703 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
\r
704 return FILTER_ACCEPT;
\r
705 const XMLCh* name=node->getLocalName();
\r
706 if (XMLString::equals(name,Applications) ||
\r
707 XMLString::equals(name,Credentials) ||
\r
708 XMLString::equals(name,Extensions::LOCAL_NAME) ||
\r
709 XMLString::equals(name,Implementation) ||
\r
710 XMLString::equals(name,Listener) ||
\r
711 XMLString::equals(name,MemoryListener) ||
\r
712 XMLString::equals(name,Policy) ||
\r
713 XMLString::equals(name,_RequestMapper) ||
\r
714 XMLString::equals(name,_ReplayCache) ||
\r
715 XMLString::equals(name,_SessionCache) ||
\r
716 XMLString::equals(name,_StorageService) ||
\r
717 XMLString::equals(name,TCPListener) ||
\r
718 XMLString::equals(name,UnixListener))
\r
719 return FILTER_REJECT;
\r
721 return FILTER_ACCEPT;
\r
724 void XMLConfigImpl::doExtensions(const DOMElement* e, const char* label, Category& log)
\r
726 const DOMElement* exts=XMLHelper::getFirstChildElement(e,Extensions::LOCAL_NAME);
\r
728 exts=XMLHelper::getFirstChildElement(exts,Library);
\r
730 auto_ptr_char path(exts->getAttributeNS(NULL,_path));
\r
733 XMLToolingConfig::getConfig().load_library(path.get(),(void*)exts);
\r
734 log.debug("loaded %s extension library (%s)", label, path.get());
\r
737 catch (exception& e) {
\r
738 const XMLCh* fatal=exts->getAttributeNS(NULL,fatal);
\r
739 if (fatal && (*fatal==chLatin_t || *fatal==chDigit_1)) {
\r
740 log.fatal("unable to load mandatory %s extension library %s: %s", label, path.get(), e.what());
\r
744 log.crit("unable to load optional %s extension library %s: %s", label, path.get(), e.what());
\r
747 exts=XMLHelper::getNextSiblingElement(exts,Library);
\r
752 XMLConfigImpl::XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer) : m_requestMapper(NULL), m_outer(outer), m_document(NULL)
\r
755 xmltooling::NDC ndc("XMLConfigImpl");
\r
757 Category& log=Category::getInstance(SHIBSP_LOGCAT".Config");
\r
760 SPConfig& conf=SPConfig::getConfig();
\r
761 SAMLConfig& samlConf=SAMLConfig::getConfig();
\r
762 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
\r
763 const DOMElement* SHAR=XMLHelper::getFirstChildElement(e,OutOfProcess);
\r
764 const DOMElement* SHIRE=XMLHelper::getFirstChildElement(e,InProcess);
\r
766 // Initialize log4cpp manually in order to redirect log messages as soon as possible.
\r
767 if (conf.isEnabled(SPConfig::Logging)) {
\r
768 const XMLCh* logconf=NULL;
\r
769 if (conf.isEnabled(SPConfig::OutOfProcess))
\r
770 logconf=SHAR->getAttributeNS(NULL,logger);
\r
771 else if (conf.isEnabled(SPConfig::InProcess))
\r
772 logconf=SHIRE->getAttributeNS(NULL,logger);
\r
773 if (!logconf || !*logconf)
\r
774 logconf=e->getAttributeNS(NULL,logger);
\r
775 if (logconf && *logconf) {
\r
776 auto_ptr_char logpath(logconf);
\r
777 log.debug("loading new logging configuration from (%s), check log destination for status of configuration",logpath.get());
\r
778 XMLToolingConfig::getConfig().log_config(logpath.get());
\r
782 m_outer->m_tranLog = new TransactionLog();
\r
785 // First load any property sets.
\r
788 const DOMElement* child;
\r
791 // Much of the processing can only occur on the first instantiation.
\r
794 pair<bool,unsigned int> skew=getUnsignedInt("clockSkew");
\r
796 xmlConf.clock_skew_secs=skew.second;
\r
799 doExtensions(e, "global", log);
\r
800 if (conf.isEnabled(SPConfig::OutOfProcess))
\r
801 doExtensions(SHAR, "out of process", log);
\r
803 if (conf.isEnabled(SPConfig::InProcess))
\r
804 doExtensions(SHIRE, "in process", log);
\r
806 // Instantiate the ListenerService and SessionCache objects.
\r
807 if (conf.isEnabled(SPConfig::Listener)) {
\r
808 child=XMLHelper::getFirstChildElement(SHAR,UnixListener);
\r
810 plugtype=UNIX_LISTENER_SERVICE;
\r
812 child=XMLHelper::getFirstChildElement(SHAR,TCPListener);
\r
814 plugtype=TCP_LISTENER_SERVICE;
\r
816 child=XMLHelper::getFirstChildElement(SHAR,MemoryListener);
\r
818 plugtype=MEMORY_LISTENER_SERVICE;
\r
820 child=XMLHelper::getFirstChildElement(SHAR,Listener);
\r
822 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
824 plugtype=type.get();
\r
830 log.info("building ListenerService of type %s...", plugtype.c_str());
\r
831 m_outer->m_listener = conf.ListenerServiceManager.newPlugin(plugtype.c_str(),child);
\r
834 log.fatal("can't build ListenerService, missing conf:Listener element?");
\r
835 throw ConfigurationException("Can't build ListenerService, missing conf:Listener element?");
\r
839 if (conf.isEnabled(SPConfig::Caching)) {
\r
840 if (conf.isEnabled(SPConfig::OutOfProcess)) {
\r
841 // First build any StorageServices.
\r
843 child=XMLHelper::getFirstChildElement(SHAR,_StorageService);
\r
845 auto_ptr_char id(child->getAttributeNS(NULL,_id));
\r
846 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
848 log.info("building StorageService (%s) of type %s...", id.get(), type.get());
\r
849 m_outer->m_storage[id.get()] = xmlConf.StorageServiceManager.newPlugin(type.get(),child);
\r
850 if (!strcmp(type.get(),MEMORY_STORAGE_SERVICE))
\r
851 inmemID = id.get();
\r
853 catch (exception& ex) {
\r
854 log.crit("failed to instantiate StorageService (%s): %s", id.get(), ex.what());
\r
856 child=XMLHelper::getNextSiblingElement(child,_StorageService);
\r
859 child=XMLHelper::getFirstChildElement(SHAR,_SessionCache);
\r
861 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
862 log.info("building SessionCache of type %s...",type.get());
\r
863 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(type.get(),child);
\r
866 log.warn("SessionCache unspecified, building SessionCache of type %s...",STORAGESERVICE_SESSION_CACHE);
\r
867 if (inmemID.empty()) {
\r
868 inmemID = "memory";
\r
869 log.info("no StorageServices configured, providing in-memory version for session cache");
\r
870 m_outer->m_storage[inmemID] = xmlConf.StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE,NULL);
\r
872 child = e->getOwnerDocument()->createElementNS(NULL,_SessionCache);
\r
873 auto_ptr_XMLCh ssid(inmemID.c_str());
\r
874 const_cast<DOMElement*>(child)->setAttributeNS(NULL,_StorageService,ssid.get());
\r
875 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(STORAGESERVICE_SESSION_CACHE,child);
\r
879 StorageService* replaySS=NULL;
\r
880 child=XMLHelper::getFirstChildElement(SHAR,_ReplayCache);
\r
882 auto_ptr_char ssid(child->getAttributeNS(NULL,_StorageService));
\r
883 if (ssid.get() && *ssid.get()) {
\r
884 if (m_outer->m_storage.count(ssid.get()))
\r
885 replaySS = m_outer->m_storage[ssid.get()];
\r
887 log.info("building ReplayCache on top of StorageService (%s)...", ssid.get());
\r
889 log.crit("unable to locate StorageService (%s) in configuration", ssid.get());
\r
893 log.info("building ReplayCache using in-memory StorageService...");
\r
894 if (inmemID.empty()) {
\r
895 inmemID = "memory";
\r
896 log.info("no StorageServices configured, providing in-memory version for legacy config");
\r
897 m_outer->m_storage[inmemID] = xmlConf.StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE,NULL);
\r
899 replaySS = m_outer->m_storage[inmemID];
\r
901 xmlConf.setReplayCache(new ReplayCache(replaySS));
\r
904 log.info("building in-process SessionCache of type %s...",REMOTED_SESSION_CACHE);
\r
905 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(REMOTED_SESSION_CACHE,NULL);
\r
908 } // end of first-time-only stuff
\r
910 // Back to the fully dynamic stuff...next up is the RequestMapper.
\r
911 if (conf.isEnabled(SPConfig::RequestMapping)) {
\r
912 child=XMLHelper::getFirstChildElement(SHIRE,_RequestMapper);
\r
914 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
915 log.info("building RequestMapper of type %s...",type.get());
\r
916 m_requestMapper=conf.RequestMapperManager.newPlugin(type.get(),child);
\r
920 // Now we load the credentials map.
\r
921 if (conf.isEnabled(SPConfig::Credentials)) {
\r
922 child = XMLHelper::getLastChildElement(e,Credentials);
\r
924 // Step down and process resolvers.
\r
925 child=XMLHelper::getFirstChildElement(child);
\r
927 auto_ptr_char id(child->getAttributeNS(NULL,_id));
\r
928 auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
930 CredentialResolver* cr=xmlConf.CredentialResolverManager.newPlugin(type.get(),child);
\r
931 m_credResolverMap[id.get()] = cr;
\r
933 catch (exception& ex) {
\r
934 log.crit("failed to instantiate CredentialResolver (%s): %s", id.get(), ex.what());
\r
936 child = XMLHelper::getNextSiblingElement(child);
\r
941 // Load the default application. This actually has a fixed ID of "default". ;-)
\r
942 child=XMLHelper::getLastChildElement(e,Applications);
\r
944 log.fatal("can't build default Application object, missing conf:Applications element?");
\r
945 throw ConfigurationException("can't build default Application object, missing conf:Applications element?");
\r
947 XMLApplication* defapp=new XMLApplication(m_outer,child);
\r
948 m_appmap[defapp->getId()]=defapp;
\r
950 // Load any overrides.
\r
951 child = XMLHelper::getFirstChildElement(child,_Application);
\r
953 auto_ptr<XMLApplication> iapp(new XMLApplication(m_outer,child,defapp));
\r
954 if (m_appmap.count(iapp->getId()))
\r
955 log.crit("found conf:Application element with duplicate id attribute (%s), skipping it", iapp->getId());
\r
957 m_appmap[iapp->getId()]=iapp.release();
\r
959 child = XMLHelper::getNextSiblingElement(child,_Application);
\r
962 // Load security policies.
\r
963 child = XMLHelper::getLastChildElement(e,SecurityPolicies);
\r
965 auto_ptr_char def(child->getAttributeNS(NULL,_default));
\r
966 m_policyDefault = def.get();
\r
967 child = XMLHelper::getFirstChildElement(child,Policy);
\r
969 auto_ptr_char id(child->getAttributeNS(NULL,_id));
\r
970 vector<const SecurityPolicyRule*>& rules = m_policyMap[id.get()];
\r
971 const DOMElement* rule = XMLHelper::getFirstChildElement(child,Rule);
\r
973 auto_ptr_char type(rule->getAttributeNS(NULL,_type));
\r
975 rules.push_back(samlConf.SecurityPolicyRuleManager.newPlugin(type.get(),rule));
\r
977 catch (exception& ex) {
\r
978 log.crit("error instantiating policy rule (%s) in policy (%s): %s", type.get(), id.get(), ex.what());
\r
980 rule = XMLHelper::getNextSiblingElement(rule,Rule);
\r
982 child = XMLHelper::getNextSiblingElement(child,Policy);
\r
984 if (!m_policyMap.count(m_policyDefault))
\r
985 throw ConfigurationException("Default security policy ($1) not found in conf:SecurityPolicies element.", params(1,m_policyDefault.c_str()));
\r
988 catch (exception&) {
\r
989 this->~XMLConfigImpl();
\r
994 this->~XMLConfigImpl();
\r
1000 XMLConfigImpl::~XMLConfigImpl()
\r
1002 for_each(m_appmap.begin(),m_appmap.end(),cleanup_pair<string,Application>());
\r
1003 for_each(m_credResolverMap.begin(),m_credResolverMap.end(),cleanup_pair<string,CredentialResolver>());
\r
1004 for (map< string,vector<const SecurityPolicyRule*> >::iterator i=m_policyMap.begin(); i!=m_policyMap.end(); ++i)
\r
1005 for_each(i->second.begin(), i->second.end(), xmltooling::cleanup<SecurityPolicyRule>());
\r
1006 delete m_requestMapper;
\r
1008 m_document->release();
\r
1011 pair<bool,DOMElement*> XMLConfig::load()
\r
1013 // Load from source using base class.
\r
1014 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
\r
1016 // If we own it, wrap it.
\r
1017 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : NULL);
\r
1019 XMLConfigImpl* impl = new XMLConfigImpl(raw.second,(m_impl==NULL),this);
\r
1021 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
\r
1022 impl->setDocument(docjanitor.release());
\r
1027 return make_pair(false,(DOMElement*)NULL);
\r