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::saml1;
\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<xmltooling::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<xmltooling::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
159 // Provides filter to exclude special config elements.
\r
160 short acceptNode(const DOMNode* node) const;
\r
162 void setDocument(DOMDocument* doc) {
\r
167 void doExtensions(const DOMElement* e, const char* label, Category& log);
\r
169 const XMLConfig* m_outer;
\r
170 DOMDocument* m_document;
\r
173 class SHIBSP_DLLLOCAL XMLConfig : public ServiceProvider, public ReloadableXMLFile
\r
176 XMLConfig(const DOMElement* e)
\r
177 : ReloadableXMLFile(e), m_impl(NULL), m_listener(NULL), m_sessionCache(NULL) {
\r
186 delete m_sessionCache;
\r
189 XMLToolingConfig::getConfig().setReplayCache(NULL);
\r
190 for_each(m_storage.begin(), m_storage.end(), cleanup_pair<string,StorageService>());
\r
194 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const {return m_impl->getBool(name,ns);}
\r
195 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const {return m_impl->getString(name,ns);}
\r
196 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const {return m_impl->getXMLString(name,ns);}
\r
197 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const {return m_impl->getUnsignedInt(name,ns);}
\r
198 pair<bool,int> getInt(const char* name, const char* ns=NULL) const {return m_impl->getInt(name,ns);}
\r
199 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:target:config:1.0") const {return m_impl->getPropertySet(name,ns);}
\r
200 const DOMElement* getElement() const {return m_impl->getElement();}
\r
203 TransactionLog* getTransactionLog() const {
\r
206 throw ConfigurationException("No TransactionLog available.");
\r
209 StorageService* getStorageService(const char* id) const {
\r
211 map<string,StorageService*>::const_iterator i=m_storage.find(id);
\r
212 if (i!=m_storage.end())
\r
218 ListenerService* getListenerService(bool required=true) const {
\r
219 if (required && !m_listener)
\r
220 throw ConfigurationException("No ListenerService available.");
\r
224 SessionCache* getSessionCache(bool required=true) const {
\r
225 if (required && !m_sessionCache)
\r
226 throw ConfigurationException("No SessionCache available.");
\r
227 return m_sessionCache;
\r
230 RequestMapper* getRequestMapper(bool required=true) const {
\r
231 if (required && !m_impl->m_requestMapper)
\r
232 throw ConfigurationException("No RequestMapper available.");
\r
233 return m_impl->m_requestMapper;
\r
236 const Application* getApplication(const char* applicationId) const {
\r
237 map<string,Application*>::const_iterator i=m_impl->m_appmap.find(applicationId);
\r
238 return (i!=m_impl->m_appmap.end()) ? i->second : NULL;
\r
241 CredentialResolver* getCredentialResolver(const char* id) const {
\r
243 map<string,CredentialResolver*>::const_iterator i=m_impl->m_credResolverMap.find(id);
\r
244 if (i!=m_impl->m_credResolverMap.end())
\r
251 pair<bool,DOMElement*> load();
\r
254 friend class XMLConfigImpl;
\r
255 XMLConfigImpl* m_impl;
\r
256 mutable ListenerService* m_listener;
\r
257 mutable SessionCache* m_sessionCache;
\r
258 mutable TransactionLog* m_tranLog;
\r
259 mutable map<string,StorageService*> m_storage;
\r
262 #if defined (_MSC_VER)
\r
263 #pragma warning( pop )
\r
266 ServiceProvider* XMLServiceProviderFactory(const DOMElement* const & e)
\r
268 return new XMLConfig(e);
\r
271 static const XMLCh AAPProvider[] = UNICODE_LITERAL_11(A,A,P,P,r,o,v,i,d,e,r);
\r
272 static const XMLCh _Application[] = UNICODE_LITERAL_11(A,p,p,l,i,c,a,t,i,o,n);
\r
273 static const XMLCh Applications[] = UNICODE_LITERAL_12(A,p,p,l,i,c,a,t,i,o,n,s);
\r
274 static const XMLCh AttributeFactory[] = UNICODE_LITERAL_16(A,t,t,r,i,b,u,t,e,F,a,c,t,o,r,y);
\r
275 static const XMLCh Credentials[] = UNICODE_LITERAL_11(C,r,e,d,e,n,t,i,a,l,s);
\r
276 static const XMLCh CredentialsProvider[] = UNICODE_LITERAL_19(C,r,e,d,e,n,t,i,a,l,s,P,r,o,v,i,d,e,r);
\r
277 static const XMLCh CredentialUse[] = UNICODE_LITERAL_13(C,r,e,d,e,n,t,i,a,l,U,s,e);
\r
278 static const XMLCh DiagnosticService[] = UNICODE_LITERAL_17(D,i,a,g,n,o,s,t,i,c,S,e,r,v,i,c,e);
\r
279 static const XMLCh fatal[] = UNICODE_LITERAL_5(f,a,t,a,l);
\r
280 static const XMLCh FileResolver[] = UNICODE_LITERAL_12(F,i,l,e,R,e,s,o,l,v,e,r);
\r
281 static const XMLCh Global[] = UNICODE_LITERAL_6(G,l,o,b,a,l);
\r
282 static const XMLCh Id[] = UNICODE_LITERAL_2(I,d);
\r
283 static const XMLCh Implementation[] = UNICODE_LITERAL_14(I,m,p,l,e,m,e,n,t,a,t,i,o,n);
\r
284 static const XMLCh InProcess[] = UNICODE_LITERAL_9(I,n,P,r,o,c,e,s,s);
\r
285 static const XMLCh Library[] = UNICODE_LITERAL_7(L,i,b,r,a,r,y);
\r
286 static const XMLCh Listener[] = UNICODE_LITERAL_8(L,i,s,t,e,n,e,r);
\r
287 static const XMLCh Local[] = UNICODE_LITERAL_5(L,o,c,a,l);
\r
288 static const XMLCh logger[] = UNICODE_LITERAL_6(l,o,g,g,e,r);
\r
289 static const XMLCh MemoryListener[] = UNICODE_LITERAL_14(M,e,m,o,r,y,L,i,s,t,e,n,e,r);
\r
290 static const XMLCh MemorySessionCache[] = UNICODE_LITERAL_18(M,e,m,o,r,y,S,e,s,s,i,o,n,C,a,c,h,e);
\r
291 static const XMLCh RelyingParty[] = UNICODE_LITERAL_12(R,e,l,y,i,n,g,P,a,r,t,y);
\r
292 static const XMLCh _ReplayCache[] = UNICODE_LITERAL_11(R,e,p,l,a,y,C,a,c,h,e);
\r
293 static const XMLCh RequestMapProvider[] = UNICODE_LITERAL_18(R,e,q,u,e,s,t,M,a,p,P,r,o,v,i,d,e,r);
\r
294 static const XMLCh _SessionCache[] = UNICODE_LITERAL_12(S,e,s,s,i,o,n,C,a,c,h,e);
\r
295 static const XMLCh SessionInitiator[] = UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
\r
296 static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
\r
297 static const XMLCh OutOfProcess[] = UNICODE_LITERAL_12(O,u,t,O,f,P,r,o,c,e,s,s);
\r
298 static const XMLCh TCPListener[] = UNICODE_LITERAL_11(T,C,P,L,i,s,t,e,n,e,r);
\r
299 static const XMLCh TrustProvider[] = UNICODE_LITERAL_13(T,r,u,s,t,P,r,o,v,i,d,e,r);
\r
300 static const XMLCh UnixListener[] = UNICODE_LITERAL_12(U,n,i,x,L,i,s,t,e,n,e,r);
\r
301 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
\r
302 static const XMLCh _path[] = UNICODE_LITERAL_4(p,a,t,h);
\r
303 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
\r
306 XMLApplication::XMLApplication(
\r
307 const ServiceProvider* sp,
\r
308 const DOMElement* e,
\r
309 const XMLApplication* base
\r
310 ) : m_sp(sp), m_base(base), m_metadata(NULL), m_trust(NULL),
\r
311 m_credDefault(NULL), m_sessionInitDefault(NULL), m_acsDefault(NULL)
\r
314 xmltooling::NDC ndc("XMLApplication");
\r
316 Category& log=Category::getInstance(SHIBSP_LOGCAT".Application");
\r
319 // First load any property sets.
\r
320 map<string,string> root_remap;
\r
321 root_remap["shire"]="session";
\r
322 root_remap["shireURL"]="handlerURL";
\r
323 root_remap["shireSSL"]="handlerSSL";
\r
324 load(e,log,this,&root_remap);
\r
326 const PropertySet* propcheck=getPropertySet("Errors");
\r
327 if (propcheck && !propcheck->getString("session").first)
\r
328 throw ConfigurationException("<Errors> element requires 'session' (or deprecated 'shire') attribute");
\r
329 propcheck=getPropertySet("Sessions");
\r
330 if (propcheck && !propcheck->getString("handlerURL").first)
\r
331 throw ConfigurationException("<Sessions> element requires 'handlerURL' (or deprecated 'shireURL') attribute");
\r
333 SPConfig& conf=SPConfig::getConfig();
\r
334 SAMLConfig& samlConf=SAMLConfig::getConfig();
\r
335 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
\r
338 m_hash+=getString("providerId").second;
\r
339 m_hash=samlConf.hashSHA1(m_hash.c_str(), true);
\r
341 // Process handlers.
\r
342 Handler* handler=NULL;
\r
343 bool hardACS=false, hardSessionInit=false;
\r
344 const DOMElement* child = XMLHelper::getFirstChildElement(propcheck->getElement());
\r
346 xmltooling::auto_ptr_char bindprop(child->getAttributeNS(NULL,EndpointType::BINDING_ATTRIB_NAME));
\r
347 if (!bindprop.get() || !*(bindprop.get())) {
\r
348 log.warn("md:AssertionConsumerService element has no Binding attribute, skipping it...");
\r
349 child = XMLHelper::getNextSiblingElement(child);
\r
354 // A handler is based on the Binding property in conjunction with the element name.
\r
355 // If it's an ACS or SI, also handle index/id mappings and defaulting.
\r
356 if (XMLHelper::isNodeNamed(child,samlconstants::SAML20MD_NS,AssertionConsumerService::LOCAL_NAME)) {
\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 handler=conf.SessionInitiatorManager.newPlugin(bindprop.get(),child);
\r
380 pair<bool,const char*> si_id=handler->getString("id");
\r
381 if (si_id.first && si_id.second)
\r
382 m_sessionInitMap[si_id.second]=handler;
\r
383 if (!hardSessionInit) {
\r
384 pair<bool,bool> defprop=handler->getBool("isDefault");
\r
385 if (defprop.first) {
\r
386 if (defprop.second) {
\r
387 hardSessionInit=true;
\r
388 m_sessionInitDefault=handler;
\r
391 else if (!m_sessionInitDefault)
\r
392 m_sessionInitDefault=handler;
\r
395 else if (XMLHelper::isNodeNamed(child,samlconstants::SAML20MD_NS,SingleLogoutService::LOCAL_NAME)) {
\r
396 handler=conf.SingleLogoutServiceManager.newPlugin(bindprop.get(),child);
\r
398 else if (XMLHelper::isNodeNamed(child,samlconstants::SAML20MD_NS,ManageNameIDService::LOCAL_NAME)) {
\r
399 handler=conf.ManageNameIDServiceManager.newPlugin(bindprop.get(),child);
\r
402 handler=conf.HandlerManager.newPlugin(bindprop.get(),child);
\r
405 // Save off the objects after giving the property set to the handler for its use.
\r
406 m_handlers.push_back(handler);
\r
408 // Insert into location map.
\r
409 pair<bool,const char*> location=handler->getString("Location");
\r
410 if (location.first && *location.second == '/')
\r
411 m_handlerMap[location.second]=handler;
\r
412 else if (location.first)
\r
413 m_handlerMap[string("/") + location.second]=handler;
\r
416 catch (exception& ex) {
\r
417 log.error("caught exception processing handler element: %s", ex.what());
\r
420 child = XMLHelper::getNextSiblingElement(child);
\r
423 // If no handlers defined at the root, assume a legacy configuration.
\r
424 if (!m_base && m_handlers.empty()) {
\r
426 // A legacy config installs a SAML POST handler at the root handler location.
\r
427 // We use the Sessions element itself as the PropertySet.
\r
428 Handler* h1=conf.SessionInitiatorManager.newPlugin(
\r
429 shibspconstants::SHIB1_SESSIONINIT_PROFILE_URI,propcheck->getElement()
\r
431 m_handlers.push_back(h1);
\r
432 m_sessionInitDefault=h1;
\r
434 Handler* h2=conf.AssertionConsumerServiceManager.newPlugin(
\r
435 samlconstants::SAML1_PROFILE_BROWSER_POST,propcheck->getElement()
\r
437 m_handlers.push_back(h2);
\r
438 m_handlerMap[""] = h2;
\r
441 catch (exception& ex) {
\r
442 log.crit("error installing legacy handler configuration: %s", ex.what());
\r
446 DOMNodeList* nlist=e->getElementsByTagNameNS(samlconstants::SAML1_NS,Audience::LOCAL_NAME);
\r
447 for (XMLSize_t i=0; nlist && i<nlist->getLength(); i++)
\r
448 if (nlist->item(i)->getParentNode()->isSameNode(e) && nlist->item(i)->hasChildNodes())
\r
449 m_audiences.push_back(nlist->item(i)->getFirstChild()->getNodeValue());
\r
451 // Always include our own providerId as an audience.
\r
452 m_audiences.push_back(getXMLString("providerId").second);
\r
454 if (conf.isEnabled(SPConfig::AttributeResolver)) {
\r
455 child = XMLHelper::getFirstChildElement(e,AAPProvider);
\r
457 // TODO: some kind of compatibility
\r
458 child = XMLHelper::getNextSiblingElement(child,AAPProvider);
\r
462 if (conf.isEnabled(SPConfig::Metadata)) {
\r
463 vector<MetadataProvider*> os2providers;
\r
464 child = XMLHelper::getFirstChildElement(e,_MetadataProvider);
\r
466 xmltooling::auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
467 log.info("building metadata provider of type %s...",type.get());
\r
469 auto_ptr<MetadataProvider> mp(samlConf.MetadataProviderManager.newPlugin(type.get(),child));
\r
471 os2providers.push_back(mp.release());
\r
473 catch (exception& ex) {
\r
474 log.crit("error building/initializing metadata provider: %s", ex.what());
\r
477 child = XMLHelper::getNextSiblingElement(child,_MetadataProvider);
\r
480 if (os2providers.size()==1)
\r
481 m_metadata=os2providers.front();
\r
482 else if (os2providers.size()>1) {
\r
484 m_metadata = samlConf.MetadataProviderManager.newPlugin(CHAINING_METADATA_PROVIDER,NULL);
\r
485 ChainingMetadataProvider* chainMeta = dynamic_cast<ChainingMetadataProvider*>(m_metadata);
\r
486 while (!os2providers.empty()) {
\r
487 chainMeta->addMetadataProvider(os2providers.back());
\r
488 os2providers.pop_back();
\r
491 catch (exception& ex) {
\r
492 log.crit("error building chaining metadata provider wrapper: %s",ex.what());
\r
493 for_each(os2providers.begin(), os2providers.end(), xmltooling::cleanup<MetadataProvider>());
\r
498 if (conf.isEnabled(SPConfig::Trust)) {
\r
499 ChainingTrustEngine* chainTrust = NULL;
\r
500 child = XMLHelper::getFirstChildElement(e,TrustProvider);
\r
502 xmltooling::auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
503 log.info("building trust provider of type %s...",type.get());
\r
506 // For compatibility with old engine types, we're assuming a Shib engine is likely,
\r
507 // which requires chaining, so we'll build that regardless.
\r
508 m_trust = xmlConf.TrustEngineManager.newPlugin(CHAINING_TRUSTENGINE,NULL);
\r
509 chainTrust = dynamic_cast<ChainingTrustEngine*>(m_trust);
\r
511 if (!strcmp(type.get(),"edu.internet2.middleware.shibboleth.common.provider.ShibbolethTrust")) {
\r
512 chainTrust->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(EXPLICIT_KEY_TRUSTENGINE,child));
\r
513 chainTrust->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(SHIBBOLETH_PKIX_TRUSTENGINE,child));
\r
515 else if (!strcmp(type.get(),"edu.internet2.middleware.shibboleth.common.provider.BasicTrust")) {
\r
516 chainTrust->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(EXPLICIT_KEY_TRUSTENGINE,child));
\r
519 chainTrust->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(type.get(),child));
\r
522 catch (exception& ex) {
\r
523 log.crit("error building trust provider: %s",ex.what());
\r
526 child = XMLHelper::getNextSiblingElement(child,TrustProvider);
\r
530 // Finally, load credential mappings.
\r
531 child = XMLHelper::getFirstChildElement(e,CredentialUse);
\r
533 m_credDefault=new DOMPropertySet();
\r
534 m_credDefault->load(child,log,this);
\r
535 child = XMLHelper::getFirstChildElement(child,RelyingParty);
\r
537 DOMPropertySet* rp=new DOMPropertySet();
\r
538 rp->load(child,log,this);
\r
539 m_credMap[child->getAttributeNS(NULL,opensaml::saml2::Attribute::NAME_ATTRIB_NAME)]=rp;
\r
540 child = XMLHelper::getNextSiblingElement(child,RelyingParty);
\r
544 if (conf.isEnabled(SPConfig::OutOfProcess)) {
\r
545 // Really finally, build local browser profile and binding objects.
\r
546 // TODO: may need some bits here...
\r
549 catch (exception&) {
\r
561 void XMLApplication::cleanup()
\r
563 for_each(m_handlers.begin(),m_handlers.end(),xmltooling::cleanup<Handler>());
\r
565 delete m_credDefault;
\r
566 #ifdef HAVE_GOOD_STL
\r
567 for_each(m_credMap.begin(),m_credMap.end(),cleanup_pair<xmltooling::xstring,PropertySet>());
\r
569 for_each(m_credMap.begin(),m_credMap.end(),cleanup_pair<const XMLCh*,PropertySet>());
\r
576 short XMLApplication::acceptNode(const DOMNode* node) const
\r
578 if (XMLHelper::isNodeNamed(node,samlconstants::SAML1_NS,AttributeDesignator::LOCAL_NAME))
\r
579 return FILTER_REJECT;
\r
580 else if (XMLHelper::isNodeNamed(node,samlconstants::SAML20_NS,opensaml::saml1::Attribute::LOCAL_NAME))
\r
581 return FILTER_REJECT;
\r
582 else if (XMLHelper::isNodeNamed(node,samlconstants::SAML1_NS,Audience::LOCAL_NAME))
\r
583 return FILTER_REJECT;
\r
584 const XMLCh* name=node->getLocalName();
\r
585 if (XMLString::equals(name,_Application) ||
\r
586 XMLString::equals(name,AssertionConsumerService::LOCAL_NAME) ||
\r
587 XMLString::equals(name,SingleLogoutService::LOCAL_NAME) ||
\r
588 XMLString::equals(name,DiagnosticService) ||
\r
589 XMLString::equals(name,SessionInitiator) ||
\r
590 XMLString::equals(name,AAPProvider) ||
\r
591 XMLString::equals(name,CredentialUse) ||
\r
592 XMLString::equals(name,RelyingParty) ||
\r
593 XMLString::equals(name,_MetadataProvider) ||
\r
594 XMLString::equals(name,TrustProvider))
\r
595 return FILTER_REJECT;
\r
597 return FILTER_ACCEPT;
\r
600 pair<bool,bool> XMLApplication::getBool(const char* name, const char* ns) const
\r
602 pair<bool,bool> ret=DOMPropertySet::getBool(name,ns);
\r
605 return m_base ? m_base->getBool(name,ns) : ret;
\r
608 pair<bool,const char*> XMLApplication::getString(const char* name, const char* ns) const
\r
610 pair<bool,const char*> ret=DOMPropertySet::getString(name,ns);
\r
613 return m_base ? m_base->getString(name,ns) : ret;
\r
616 pair<bool,const XMLCh*> XMLApplication::getXMLString(const char* name, const char* ns) const
\r
618 pair<bool,const XMLCh*> ret=DOMPropertySet::getXMLString(name,ns);
\r
621 return m_base ? m_base->getXMLString(name,ns) : ret;
\r
624 pair<bool,unsigned int> XMLApplication::getUnsignedInt(const char* name, const char* ns) const
\r
626 pair<bool,unsigned int> ret=DOMPropertySet::getUnsignedInt(name,ns);
\r
629 return m_base ? m_base->getUnsignedInt(name,ns) : ret;
\r
632 pair<bool,int> XMLApplication::getInt(const char* name, const char* ns) const
\r
634 pair<bool,int> ret=DOMPropertySet::getInt(name,ns);
\r
637 return m_base ? m_base->getInt(name,ns) : ret;
\r
640 const PropertySet* XMLApplication::getPropertySet(const char* name, const char* ns) const
\r
642 const PropertySet* ret=DOMPropertySet::getPropertySet(name,ns);
\r
643 if (ret || !m_base)
\r
645 return m_base->getPropertySet(name,ns);
\r
648 MetadataProvider* XMLApplication::getMetadataProvider() const
\r
650 return (!m_metadata && m_base) ? m_base->getMetadataProvider() : m_metadata;
\r
653 TrustEngine* XMLApplication::getTrustEngine() const
\r
655 return (!m_trust && m_base) ? m_base->getTrustEngine() : m_trust;
\r
658 const vector<const XMLCh*>& XMLApplication::getAudiences() const
\r
660 return (m_audiences.empty() && m_base) ? m_base->getAudiences() : m_audiences;
\r
663 const PropertySet* XMLApplication::getCredentialUse(const EntityDescriptor* provider) const
\r
665 if (!m_credDefault && m_base)
\r
666 return m_base->getCredentialUse(provider);
\r
668 #ifdef HAVE_GOOD_STL
\r
669 map<xmltooling::xstring,PropertySet*>::const_iterator i=m_credMap.find(provider->getEntityID());
\r
670 if (i!=m_credMap.end())
\r
672 const EntitiesDescriptor* group=dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
\r
674 if (group->getName()) {
\r
675 i=m_credMap.find(group->getName());
\r
676 if (i!=m_credMap.end())
\r
679 group=dynamic_cast<const EntitiesDescriptor*>(group->getParent());
\r
682 map<const XMLCh*,PropertySet*>::const_iterator i=m_credMap.begin();
\r
683 for (; i!=m_credMap.end(); i++) {
\r
684 if (XMLString::equals(i->first,provider->getId()))
\r
686 const EntitiesDescriptor* group=dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
\r
688 if (XMLString::equals(i->first,group->getName()))
\r
690 group=dynamic_cast<const EntitiesDescriptor*>(group->getParent());
\r
694 return m_credDefault;
\r
697 const Handler* XMLApplication::getDefaultSessionInitiator() const
\r
699 if (m_sessionInitDefault) return m_sessionInitDefault;
\r
700 return m_base ? m_base->getDefaultSessionInitiator() : NULL;
\r
703 const Handler* XMLApplication::getSessionInitiatorById(const char* id) const
\r
705 map<string,const Handler*>::const_iterator i=m_sessionInitMap.find(id);
\r
706 if (i!=m_sessionInitMap.end()) return i->second;
\r
707 return m_base ? m_base->getSessionInitiatorById(id) : NULL;
\r
710 const Handler* XMLApplication::getDefaultAssertionConsumerService() const
\r
712 if (m_acsDefault) return m_acsDefault;
\r
713 return m_base ? m_base->getDefaultAssertionConsumerService() : NULL;
\r
716 const Handler* XMLApplication::getAssertionConsumerServiceByIndex(unsigned short index) const
\r
718 map<unsigned int,const Handler*>::const_iterator i=m_acsIndexMap.find(index);
\r
719 if (i!=m_acsIndexMap.end()) return i->second;
\r
720 return m_base ? m_base->getAssertionConsumerServiceByIndex(index) : NULL;
\r
723 const vector<const Handler*>& XMLApplication::getAssertionConsumerServicesByBinding(const XMLCh* binding) const
\r
725 #ifdef HAVE_GOOD_STL
\r
726 ACSBindingMap::const_iterator i=m_acsBindingMap.find(binding);
\r
728 xmltooling::auto_ptr_char temp(binding);
\r
729 ACSBindingMap::const_iterator i=m_acsBindingMap.find(temp.get());
\r
731 if (i!=m_acsBindingMap.end())
\r
733 return m_base ? m_base->getAssertionConsumerServicesByBinding(binding) : g_noHandlers;
\r
736 const Handler* XMLApplication::getHandler(const char* path) const
\r
739 map<string,const Handler*>::const_iterator i=m_handlerMap.find(wrap.substr(0,wrap.find('?')));
\r
740 if (i!=m_handlerMap.end())
\r
742 return m_base ? m_base->getHandler(path) : NULL;
\r
745 short XMLConfigImpl::acceptNode(const DOMNode* node) const
\r
747 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB1SPCONFIG_NS) &&
\r
748 !XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
\r
749 return FILTER_ACCEPT;
\r
750 const XMLCh* name=node->getLocalName();
\r
751 if (XMLString::equals(name,Applications) ||
\r
752 XMLString::equals(name,AttributeFactory) ||
\r
753 XMLString::equals(name,Credentials) ||
\r
754 XMLString::equals(name,CredentialsProvider) ||
\r
755 XMLString::equals(name,Extensions::LOCAL_NAME) ||
\r
756 XMLString::equals(name,Implementation) ||
\r
757 XMLString::equals(name,Listener) ||
\r
758 XMLString::equals(name,MemoryListener) ||
\r
759 XMLString::equals(name,MemorySessionCache) ||
\r
760 XMLString::equals(name,RequestMapProvider) ||
\r
761 XMLString::equals(name,_ReplayCache) ||
\r
762 XMLString::equals(name,_SessionCache) ||
\r
763 XMLString::equals(name,_StorageService) ||
\r
764 XMLString::equals(name,TCPListener) ||
\r
765 XMLString::equals(name,UnixListener))
\r
766 return FILTER_REJECT;
\r
768 return FILTER_ACCEPT;
\r
771 void XMLConfigImpl::doExtensions(const DOMElement* e, const char* label, Category& log)
\r
773 const DOMElement* exts=XMLHelper::getFirstChildElement(e,Extensions::LOCAL_NAME);
\r
775 exts=XMLHelper::getFirstChildElement(exts,Library);
\r
777 xmltooling::auto_ptr_char path(exts->getAttributeNS(NULL,_path));
\r
780 XMLToolingConfig::getConfig().load_library(path.get(),(void*)exts);
\r
781 log.debug("loaded %s extension library (%s)", label, path.get());
\r
784 catch (exception& e) {
\r
785 const XMLCh* fatal=exts->getAttributeNS(NULL,fatal);
\r
786 if (fatal && (*fatal==chLatin_t || *fatal==chDigit_1)) {
\r
787 log.fatal("unable to load mandatory %s extension library %s: %s", label, path.get(), e.what());
\r
791 log.crit("unable to load optional %s extension library %s: %s", label, path.get(), e.what());
\r
794 exts=XMLHelper::getNextSiblingElement(exts,Library);
\r
799 XMLConfigImpl::XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer) : m_outer(outer), m_document(NULL), m_requestMapper(NULL)
\r
802 xmltooling::NDC ndc("XMLConfigImpl");
\r
804 Category& log=Category::getInstance(SHIBSP_LOGCAT".Config");
\r
807 SPConfig& conf=SPConfig::getConfig();
\r
808 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
\r
809 const DOMElement* SHAR=XMLHelper::getFirstChildElement(e,OutOfProcess);
\r
811 SHAR=XMLHelper::getFirstChildElement(e,Global);
\r
812 const DOMElement* SHIRE=XMLHelper::getFirstChildElement(e,InProcess);
\r
814 SHIRE=XMLHelper::getFirstChildElement(e,Local);
\r
816 // Initialize log4cpp manually in order to redirect log messages as soon as possible.
\r
817 if (conf.isEnabled(SPConfig::Logging)) {
\r
818 const XMLCh* logconf=NULL;
\r
819 if (conf.isEnabled(SPConfig::OutOfProcess))
\r
820 logconf=SHAR->getAttributeNS(NULL,logger);
\r
821 else if (conf.isEnabled(SPConfig::InProcess))
\r
822 logconf=SHIRE->getAttributeNS(NULL,logger);
\r
823 if (!logconf || !*logconf)
\r
824 logconf=e->getAttributeNS(NULL,logger);
\r
825 if (logconf && *logconf) {
\r
826 xmltooling::auto_ptr_char logpath(logconf);
\r
827 log.debug("loading new logging configuration from (%s), check log destination for status of configuration",logpath.get());
\r
828 XMLToolingConfig::getConfig().log_config(logpath.get());
\r
832 m_outer->m_tranLog = new TransactionLog();
\r
835 // First load any property sets.
\r
836 map<string,string> root_remap;
\r
837 root_remap["Global"]="OutOfProcess";
\r
838 root_remap["Local"]="InProcess";
\r
839 load(e,log,this,&root_remap);
\r
841 const DOMElement* child;
\r
844 // Much of the processing can only occur on the first instantiation.
\r
847 pair<bool,unsigned int> skew=getUnsignedInt("clockSkew");
\r
849 xmlConf.clock_skew_secs=skew.second;
\r
852 doExtensions(e, "global", log);
\r
853 if (conf.isEnabled(SPConfig::OutOfProcess))
\r
854 doExtensions(SHAR, "out of process", log);
\r
856 if (conf.isEnabled(SPConfig::InProcess))
\r
857 doExtensions(SHIRE, "in process", log);
\r
859 // Instantiate the ListenerService and SessionCache objects.
\r
860 if (conf.isEnabled(SPConfig::Listener)) {
\r
861 child=XMLHelper::getFirstChildElement(SHAR,UnixListener);
\r
863 plugtype=UNIX_LISTENER_SERVICE;
\r
865 child=XMLHelper::getFirstChildElement(SHAR,TCPListener);
\r
867 plugtype=TCP_LISTENER_SERVICE;
\r
869 child=XMLHelper::getFirstChildElement(SHAR,MemoryListener);
\r
871 plugtype=MEMORY_LISTENER_SERVICE;
\r
873 child=XMLHelper::getFirstChildElement(SHAR,Listener);
\r
875 xmltooling::auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
877 plugtype=type.get();
\r
883 log.info("building ListenerService of type %s...", plugtype.c_str());
\r
884 m_outer->m_listener = conf.ListenerServiceManager.newPlugin(plugtype.c_str(),child);
\r
887 log.fatal("can't build ListenerService, missing conf:Listener element?");
\r
888 throw ConfigurationException("Can't build ListenerService, missing conf:Listener element?");
\r
892 if (conf.isEnabled(SPConfig::Caching)) {
\r
893 // TODO: This code's a mess, due to a very bad config layout for the caches...
\r
894 // Needs rework with the new config file.
\r
895 const DOMElement* container=conf.isEnabled(SPConfig::OutOfProcess) ? SHAR : SHIRE;
\r
897 // First build any StorageServices.
\r
899 child=XMLHelper::getFirstChildElement(container,_StorageService);
\r
901 xmltooling::auto_ptr_char id(child->getAttributeNS(NULL,Id));
\r
902 xmltooling::auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
903 if (id.get() && type.get()) {
\r
905 log.info("building StorageService (%s) of type %s...", id.get(), type.get());
\r
906 m_outer->m_storage[id.get()] = xmlConf.StorageServiceManager.newPlugin(type.get(),child);
\r
907 if (!strcmp(type.get(),MEMORY_STORAGE_SERVICE))
\r
908 inmemID = id.get();
\r
910 catch (exception& ex) {
\r
911 log.crit("failed to instantiate StorageService (%s): %s", id.get(), ex.what());
\r
914 child=XMLHelper::getNextSiblingElement(container,_StorageService);
\r
917 child=XMLHelper::getFirstChildElement(container,_SessionCache);
\r
919 xmltooling::auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
920 log.info("building Session Cache of type %s...",type.get());
\r
921 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(type.get(),child);
\r
923 else if (conf.isEnabled(SPConfig::OutOfProcess)) {
\r
924 log.warn("custom SessionCache unspecified or no longer supported, building SessionCache of type %s...",STORAGESERVICE_SESSION_CACHE);
\r
925 if (inmemID.empty()) {
\r
926 inmemID = "memory";
\r
927 log.info("no StorageServices configured, providing in-memory version for legacy config");
\r
928 m_outer->m_storage[inmemID] = xmlConf.StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE,NULL);
\r
930 child = container->getOwnerDocument()->createElementNS(NULL,_SessionCache);
\r
931 xmltooling::auto_ptr_XMLCh ssid(inmemID.c_str());
\r
932 const_cast<DOMElement*>(child)->setAttributeNS(NULL,_StorageService,ssid.get());
\r
933 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(STORAGESERVICE_SESSION_CACHE,child);
\r
936 log.warn("custom SessionCache unspecified or no longer supported, building SessionCache of type %s...",REMOTED_SESSION_CACHE);
\r
937 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(REMOTED_SESSION_CACHE,NULL);
\r
941 StorageService* replaySS=NULL;
\r
942 child=XMLHelper::getFirstChildElement(container,_ReplayCache);
\r
944 xmltooling::auto_ptr_char ssid(child->getAttributeNS(NULL,_StorageService));
\r
945 if (ssid.get() && *ssid.get()) {
\r
946 replaySS = m_outer->m_storage[ssid.get()];
\r
948 log.info("building ReplayCache on top of StorageService (%s)...", ssid.get());
\r
950 log.crit("unable to locate StorageService (%s) in configuration", ssid.get());
\r
954 log.info("building ReplayCache using in-memory StorageService...");
\r
955 if (inmemID.empty()) {
\r
956 inmemID = "memory";
\r
957 log.info("no StorageServices configured, providing in-memory version for legacy config");
\r
958 m_outer->m_storage[inmemID] = xmlConf.StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE,NULL);
\r
960 replaySS = m_outer->m_storage[inmemID];
\r
962 xmlConf.setReplayCache(new ReplayCache(replaySS));
\r
964 } // end of first-time-only stuff
\r
966 // Back to the fully dynamic stuff...next up is the RequestMapper.
\r
967 if (conf.isEnabled(SPConfig::RequestMapping)) {
\r
968 child=XMLHelper::getFirstChildElement(SHIRE,RequestMapProvider);
\r
970 xmltooling::auto_ptr_char type(child->getAttributeNS(NULL,_type));
\r
971 log.info("building RequestMapper of type %s...",type.get());
\r
972 m_requestMapper=conf.RequestMapperManager.newPlugin(type.get(),child);
\r
975 log.fatal("can't build RequestMapper, missing conf:RequestMapProvider element?");
\r
976 throw ConfigurationException("can't build RequestMapper, missing conf:RequestMapProvider element?");
\r
980 // Now we load the credentials map.
\r
981 if (conf.isEnabled(SPConfig::Credentials)) {
\r
982 // Old format was to wrap it in a CredentialsProvider plugin, we're inlining that...
\r
983 child = XMLHelper::getFirstChildElement(e,CredentialsProvider);
\r
984 child = XMLHelper::getFirstChildElement(child ? child : e,Credentials);
\r
986 // Step down and process resolvers.
\r
987 child=XMLHelper::getFirstChildElement(child);
\r
989 xmltooling::auto_ptr_char id(child->getAttributeNS(NULL,Id));
\r
990 if (!id.get() || !*(id.get())) {
\r
991 log.warn("skipping CredentialsResolver with no Id attribute");
\r
992 child = XMLHelper::getNextSiblingElement(child);
\r
996 if (XMLString::equals(child->getLocalName(),FileResolver))
\r
997 plugtype=FILESYSTEM_CREDENTIAL_RESOLVER;
\r
999 xmltooling::auto_ptr_char c(child->getAttributeNS(NULL,_type));
\r
1003 if (!plugtype.empty()) {
\r
1005 CredentialResolver* cr=
\r
1006 XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(plugtype.c_str(),child);
\r
1007 m_credResolverMap[id.get()] = cr;
\r
1009 catch (exception& ex) {
\r
1010 log.crit("failed to instantiate CredentialResolver (%s): %s", id.get(), ex.what());
\r
1014 log.error("unknown type of CredentialResolver with Id (%s)", id.get());
\r
1017 child = XMLHelper::getNextSiblingElement(child);
\r
1022 // Load the default application. This actually has a fixed ID of "default". ;-)
\r
1023 child=XMLHelper::getFirstChildElement(e,Applications);
\r
1025 log.fatal("can't build default Application object, missing conf:Applications element?");
\r
1026 throw ConfigurationException("can't build default Application object, missing conf:Applications element?");
\r
1028 XMLApplication* defapp=new XMLApplication(m_outer,child);
\r
1029 m_appmap[defapp->getId()]=defapp;
\r
1031 // Load any overrides.
\r
1032 child = XMLHelper::getFirstChildElement(child,_Application);
\r
1034 auto_ptr<XMLApplication> iapp(new XMLApplication(m_outer,child,defapp));
\r
1035 if (m_appmap.find(iapp->getId())!=m_appmap.end())
\r
1036 log.crit("found conf:Application element with duplicate Id attribute (%s), skipping it", iapp->getId());
\r
1038 m_appmap[iapp->getId()]=iapp.release();
\r
1040 child = XMLHelper::getNextSiblingElement(child,_Application);
\r
1043 catch (exception&) {
\r
1044 this->~XMLConfigImpl();
\r
1049 this->~XMLConfigImpl();
\r
1055 XMLConfigImpl::~XMLConfigImpl()
\r
1057 for_each(m_appmap.begin(),m_appmap.end(),cleanup_pair<string,Application>());
\r
1058 for_each(m_credResolverMap.begin(),m_credResolverMap.end(),cleanup_pair<string,CredentialResolver>());
\r
1059 delete m_requestMapper;
\r
1061 m_document->release();
\r
1064 pair<bool,DOMElement*> XMLConfig::load()
\r
1066 // Load from source using base class.
\r
1067 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
\r
1069 // If we own it, wrap it.
\r
1070 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : NULL);
\r
1072 XMLConfigImpl* impl = new XMLConfigImpl(raw.second,(m_impl==NULL),this);
\r
1074 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
\r
1075 impl->setDocument(docjanitor.release());
\r
1080 return make_pair(false,(DOMElement*)NULL);
\r