2 * Copyright 2001-2010 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * XMLServiceProvider.cpp
20 * XML-based SP configuration and mgmt.
24 #include "exceptions.h"
26 #include "AccessControl.h"
27 #include "Application.h"
28 #include "RequestMapper.h"
29 #include "ServiceProvider.h"
30 #include "SessionCache.h"
32 #include "SPRequest.h"
33 #include "handler/SessionInitiator.h"
34 #include "remoting/ListenerService.h"
35 #include "util/DOMPropertySet.h"
36 #include "util/SPConstants.h"
38 #if defined(XMLTOOLING_LOG4SHIB)
39 # include <log4shib/PropertyConfigurator.hh>
40 #elif defined(XMLTOOLING_LOG4CPP)
41 # include <log4cpp/PropertyConfigurator.hh>
43 # error "Supported logging library not available."
46 #include <xercesc/util/XMLUniDefs.hpp>
47 #include <xmltooling/XMLToolingConfig.h>
48 #include <xmltooling/version.h>
49 #include <xmltooling/util/NDC.h>
50 #include <xmltooling/util/ReloadableXMLFile.h>
51 #include <xmltooling/util/TemplateEngine.h>
52 #include <xmltooling/util/Threads.h>
53 #include <xmltooling/util/XMLHelper.h>
56 # include "TransactionLog.h"
57 # include "attribute/filtering/AttributeFilter.h"
58 # include "attribute/resolver/AttributeExtractor.h"
59 # include "attribute/resolver/AttributeResolver.h"
60 # include "security/PKIXTrustEngine.h"
61 # include "security/SecurityPolicyProvider.h"
62 # include <saml/SAMLConfig.h>
63 # include <saml/version.h>
64 # include <saml/binding/ArtifactMap.h>
65 # include <saml/binding/SAMLArtifact.h>
66 # include <saml/saml1/core/Assertions.h>
67 # include <saml/saml2/core/Assertions.h>
68 # include <saml/saml2/binding/SAML2ArtifactType0004.h>
69 # include <saml/saml2/metadata/Metadata.h>
70 # include <saml/saml2/metadata/MetadataProvider.h>
71 # include <saml/util/SAMLConstants.h>
72 # include <xmltooling/security/CredentialResolver.h>
73 # include <xmltooling/security/SecurityHelper.h>
74 # include <xmltooling/security/TrustEngine.h>
75 # include <xmltooling/util/ReplayCache.h>
76 # include <xmltooling/util/StorageService.h>
77 # include <xsec/utils/XSECPlatformUtils.hpp>
78 using namespace opensaml::saml2;
79 using namespace opensaml::saml2p;
80 using namespace opensaml::saml2md;
81 using namespace opensaml;
83 # include "lite/SAMLConstants.h"
86 using namespace shibsp;
87 using namespace xmltooling;
91 # define min(a,b) (((a) < (b)) ? (a) : (b))
96 #if defined (_MSC_VER)
97 #pragma warning( push )
98 #pragma warning( disable : 4250 )
101 static vector<const Handler*> g_noHandlers;
103 // Application configuration wrapper
104 class SHIBSP_DLLLOCAL XMLApplication : public Application, public Remoted, public DOMPropertySet, public DOMNodeFilter
107 XMLApplication(const ServiceProvider*, const DOMElement* e, const XMLApplication* base=nullptr);
108 ~XMLApplication() { cleanup(); }
110 const char* getHash() const {return m_hash.c_str();}
113 SAMLArtifact* generateSAML1Artifact(const EntityDescriptor* relyingParty) const {
114 throw ConfigurationException("No support for SAML 1.x artifact generation.");
116 SAML2Artifact* generateSAML2Artifact(const EntityDescriptor* relyingParty) const {
117 pair<bool,int> index = make_pair(false,0);
118 const PropertySet* props = getRelyingParty(relyingParty);
119 index = props->getInt("artifactEndpointIndex");
121 index = getArtifactEndpointIndex();
122 pair<bool,const char*> entityID = props->getString("entityID");
123 return new SAML2ArtifactType0004(
124 SecurityHelper::doHash("SHA1", entityID.second, strlen(entityID.second), false),
125 index.first ? index.second : 1
129 MetadataProvider* getMetadataProvider(bool required=true) const {
130 if (required && !m_base && !m_metadata)
131 throw ConfigurationException("No MetadataProvider available.");
132 return (!m_metadata && m_base) ? m_base->getMetadataProvider() : m_metadata;
134 TrustEngine* getTrustEngine(bool required=true) const {
135 if (required && !m_base && !m_trust)
136 throw ConfigurationException("No TrustEngine available.");
137 return (!m_trust && m_base) ? m_base->getTrustEngine() : m_trust;
139 AttributeExtractor* getAttributeExtractor() const {
140 return (!m_attrExtractor && m_base) ? m_base->getAttributeExtractor() : m_attrExtractor;
142 AttributeFilter* getAttributeFilter() const {
143 return (!m_attrFilter && m_base) ? m_base->getAttributeFilter() : m_attrFilter;
145 AttributeResolver* getAttributeResolver() const {
146 return (!m_attrResolver && m_base) ? m_base->getAttributeResolver() : m_attrResolver;
148 CredentialResolver* getCredentialResolver() const {
149 return (!m_credResolver && m_base) ? m_base->getCredentialResolver() : m_credResolver;
151 const PropertySet* getRelyingParty(const EntityDescriptor* provider) const;
152 const PropertySet* getRelyingParty(const XMLCh* entityID) const;
153 const vector<const XMLCh*>* getAudiences() const {
154 return (m_audiences.empty() && m_base) ? m_base->getAudiences() : &m_audiences;
157 string getNotificationURL(const char* resource, bool front, unsigned int index) const;
159 const vector<string>& getRemoteUserAttributeIds() const {
160 return (m_remoteUsers.empty() && m_base) ? m_base->getRemoteUserAttributeIds() : m_remoteUsers;
163 void clearHeader(SPRequest& request, const char* rawname, const char* cginame) const;
164 void setHeader(SPRequest& request, const char* name, const char* value) const;
165 string getSecureHeader(const SPRequest& request, const char* name) const;
167 const SessionInitiator* getDefaultSessionInitiator() const;
168 const SessionInitiator* getSessionInitiatorById(const char* id) const;
169 const Handler* getDefaultAssertionConsumerService() const;
170 const Handler* getAssertionConsumerServiceByIndex(unsigned short index) const;
171 const vector<const Handler*>& getAssertionConsumerServicesByBinding(const XMLCh* binding) const;
172 const Handler* getHandler(const char* path) const;
173 void getHandlers(vector<const Handler*>& handlers) const;
175 void receive(DDF& in, ostream& out) {
176 // Only current function is to return the headers to clear.
178 DDF ret=DDF(nullptr).list();
179 DDFJanitor jret(ret);
180 for (vector< pair<string,string> >::const_iterator i = m_unsetHeaders.begin(); i!=m_unsetHeaders.end(); ++i) {
181 header = DDF(i->first.c_str()).string(i->second.c_str());
187 // Provides filter to exclude special config elements.
188 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
193 acceptNode(const DOMNode* node) const;
197 const XMLApplication* m_base;
199 std::pair<std::string,std::string> m_attributePrefix;
201 MetadataProvider* m_metadata;
202 TrustEngine* m_trust;
203 AttributeExtractor* m_attrExtractor;
204 AttributeFilter* m_attrFilter;
205 AttributeResolver* m_attrResolver;
206 CredentialResolver* m_credResolver;
207 vector<const XMLCh*> m_audiences;
209 // RelyingParty properties
210 map<xstring,PropertySet*> m_partyMap;
212 vector<string> m_remoteUsers,m_frontLogout,m_backLogout;
214 // manage handler objects
215 vector<Handler*> m_handlers;
217 // maps location (path info) to applicable handlers
218 map<string,const Handler*> m_handlerMap;
220 // maps unique indexes to consumer services
221 map<unsigned int,const Handler*> m_acsIndexMap;
223 // pointer to default consumer service
224 const Handler* m_acsDefault;
226 // maps binding strings to supporting consumer service(s)
227 typedef map<xstring,vector<const Handler*> > ACSBindingMap;
228 ACSBindingMap m_acsBindingMap;
230 // pointer to default session initiator
231 const SessionInitiator* m_sessionInitDefault;
233 // maps unique ID strings to session initiators
234 map<string,const SessionInitiator*> m_sessionInitMap;
236 // pointer to default artifact resolution service
237 const Handler* m_artifactResolutionDefault;
239 pair<bool,int> getArtifactEndpointIndex() const {
240 if (m_artifactResolutionDefault) return m_artifactResolutionDefault->getInt("index");
241 return m_base ? m_base->getArtifactEndpointIndex() : make_pair(false,0);
245 // Top-level configuration implementation
246 class SHIBSP_DLLLOCAL XMLConfig;
247 class SHIBSP_DLLLOCAL XMLConfigImpl : public DOMPropertySet, public DOMNodeFilter
250 XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer, Category& log);
253 RequestMapper* m_requestMapper;
254 map<string,Application*> m_appmap;
256 SecurityPolicyProvider* m_policy;
257 vector< pair< string, pair<string,string> > > m_transportOptions;
260 // Provides filter to exclude special config elements.
261 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
266 acceptNode(const DOMNode* node) const;
268 void setDocument(DOMDocument* doc) {
273 void doExtensions(const DOMElement* e, const char* label, Category& log);
276 const XMLConfig* m_outer;
277 DOMDocument* m_document;
280 class SHIBSP_DLLLOCAL XMLConfig : public ServiceProvider, public ReloadableXMLFile
286 XMLConfig(const DOMElement* e) : ReloadableXMLFile(e, Category::getInstance(SHIBSP_LOGCAT".Config")),
287 m_impl(nullptr), m_listener(nullptr), m_sessionCache(nullptr)
301 delete m_sessionCache;
305 SAMLConfig::getConfig().setArtifactMap(nullptr);
306 XMLToolingConfig::getConfig().setReplayCache(nullptr);
307 for_each(m_storage.begin(), m_storage.end(), cleanup_pair<string,StorageService>());
314 ReloadableXMLFile::lock();
315 if (m_impl->m_policy)
316 m_impl->m_policy->lock();
320 if (m_impl->m_policy)
321 m_impl->m_policy->unlock();
322 ReloadableXMLFile::unlock();
327 const PropertySet* getParent() const { return m_impl->getParent(); }
328 void setParent(const PropertySet* parent) {return m_impl->setParent(parent);}
329 pair<bool,bool> getBool(const char* name, const char* ns=nullptr) const {return m_impl->getBool(name,ns);}
330 pair<bool,const char*> getString(const char* name, const char* ns=nullptr) const {return m_impl->getString(name,ns);}
331 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=nullptr) const {return m_impl->getXMLString(name,ns);}
332 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=nullptr) const {return m_impl->getUnsignedInt(name,ns);}
333 pair<bool,int> getInt(const char* name, const char* ns=nullptr) const {return m_impl->getInt(name,ns);}
334 void getAll(map<string,const char*>& properties) const {return m_impl->getAll(properties);}
335 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const {return m_impl->getPropertySet(name,ns);}
336 const DOMElement* getElement() const {return m_impl->getElement();}
341 void receive(DDF& in, ostream& out);
343 TransactionLog* getTransactionLog() const {
346 throw ConfigurationException("No TransactionLog available.");
349 StorageService* getStorageService(const char* id) const {
351 map<string,StorageService*>::const_iterator i=m_storage.find(id);
352 if (i!=m_storage.end())
359 ListenerService* getListenerService(bool required=true) const {
360 if (required && !m_listener)
361 throw ConfigurationException("No ListenerService available.");
365 SessionCache* getSessionCache(bool required=true) const {
366 if (required && !m_sessionCache)
367 throw ConfigurationException("No SessionCache available.");
368 return m_sessionCache;
371 RequestMapper* getRequestMapper(bool required=true) const {
372 if (required && !m_impl->m_requestMapper)
373 throw ConfigurationException("No RequestMapper available.");
374 return m_impl->m_requestMapper;
377 const Application* getApplication(const char* applicationId) const {
378 map<string,Application*>::const_iterator i=m_impl->m_appmap.find(applicationId);
379 return (i!=m_impl->m_appmap.end()) ? i->second : nullptr;
383 SecurityPolicyProvider* getSecurityPolicyProvider(bool required=true) const {
384 if (required && !m_impl->m_policy)
385 throw ConfigurationException("No SecurityPolicyProvider available.");
386 return m_impl->m_policy;
389 const PropertySet* getPolicySettings(const char* id) const {
390 return getSecurityPolicyProvider()->getPolicySettings(id);
393 const vector<const SecurityPolicyRule*>& getPolicyRules(const char* id) const {
394 return getSecurityPolicyProvider()->getPolicyRules(id);
397 bool setTransportOptions(SOAPTransport& transport) const {
399 vector< pair< string, pair<string,string> > >::const_iterator opt;
400 for (opt = m_impl->m_transportOptions.begin(); opt != m_impl->m_transportOptions.end(); ++opt) {
401 if (!transport.setProviderOption(opt->first.c_str(), opt->second.first.c_str(), opt->second.second.c_str())) {
402 m_log.error("failed to set SOAPTransport option (%s)", opt->second.first.c_str());
411 pair<bool,DOMElement*> background_load();
414 friend class XMLConfigImpl;
415 XMLConfigImpl* m_impl;
416 mutable ListenerService* m_listener;
417 mutable SessionCache* m_sessionCache;
419 mutable TransactionLog* m_tranLog;
420 mutable map<string,StorageService*> m_storage;
424 #if defined (_MSC_VER)
425 #pragma warning( pop )
428 static const XMLCh ApplicationOverride[] = UNICODE_LITERAL_19(A,p,p,l,i,c,a,t,i,o,n,O,v,e,r,r,i,d,e);
429 static const XMLCh ApplicationDefaults[] = UNICODE_LITERAL_19(A,p,p,l,i,c,a,t,i,o,n,D,e,f,a,u,l,t,s);
430 static const XMLCh _ArtifactMap[] = UNICODE_LITERAL_11(A,r,t,i,f,a,c,t,M,a,p);
431 static const XMLCh _AttributeExtractor[] = UNICODE_LITERAL_18(A,t,t,r,i,b,u,t,e,E,x,t,r,a,c,t,o,r);
432 static const XMLCh _AttributeFilter[] = UNICODE_LITERAL_15(A,t,t,r,i,b,u,t,e,F,i,l,t,e,r);
433 static const XMLCh _AttributeResolver[] = UNICODE_LITERAL_17(A,t,t,r,i,b,u,t,e,R,e,s,o,l,v,e,r);
434 static const XMLCh _AssertionConsumerService[] = UNICODE_LITERAL_24(A,s,s,e,r,t,i,o,n,C,o,n,s,u,m,e,r,S,e,r,v,i,c,e);
435 static const XMLCh _ArtifactResolutionService[] =UNICODE_LITERAL_25(A,r,t,i,f,a,c,t,R,e,s,o,l,u,t,i,o,n,S,e,r,v,i,c,e);
436 static const XMLCh _Audience[] = UNICODE_LITERAL_8(A,u,d,i,e,n,c,e);
437 static const XMLCh Binding[] = UNICODE_LITERAL_7(B,i,n,d,i,n,g);
438 static const XMLCh Channel[]= UNICODE_LITERAL_7(C,h,a,n,n,e,l);
439 static const XMLCh _CredentialResolver[] = UNICODE_LITERAL_18(C,r,e,d,e,n,t,i,a,l,R,e,s,o,l,v,e,r);
440 static const XMLCh _Extensions[] = UNICODE_LITERAL_10(E,x,t,e,n,s,i,o,n,s);
441 static const XMLCh _fatal[] = UNICODE_LITERAL_5(f,a,t,a,l);
442 static const XMLCh _Handler[] = UNICODE_LITERAL_7(H,a,n,d,l,e,r);
443 static const XMLCh _id[] = UNICODE_LITERAL_2(i,d);
444 static const XMLCh InProcess[] = UNICODE_LITERAL_9(I,n,P,r,o,c,e,s,s);
445 static const XMLCh Library[] = UNICODE_LITERAL_7(L,i,b,r,a,r,y);
446 static const XMLCh Listener[] = UNICODE_LITERAL_8(L,i,s,t,e,n,e,r);
447 static const XMLCh Location[] = UNICODE_LITERAL_8(L,o,c,a,t,i,o,n);
448 static const XMLCh logger[] = UNICODE_LITERAL_6(l,o,g,g,e,r);
449 static const XMLCh _LogoutInitiator[] = UNICODE_LITERAL_15(L,o,g,o,u,t,I,n,i,t,i,a,t,o,r);
450 static const XMLCh _ManageNameIDService[] = UNICODE_LITERAL_19(M,a,n,a,g,e,N,a,m,e,I,D,S,e,r,v,i,c,e);
451 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
452 static const XMLCh Notify[] = UNICODE_LITERAL_6(N,o,t,i,f,y);
453 static const XMLCh _option[] = UNICODE_LITERAL_6(o,p,t,i,o,n);
454 static const XMLCh OutOfProcess[] = UNICODE_LITERAL_12(O,u,t,O,f,P,r,o,c,e,s,s);
455 static const XMLCh _path[] = UNICODE_LITERAL_4(p,a,t,h);
456 static const XMLCh _provider[] = UNICODE_LITERAL_8(p,r,o,v,i,d,e,r);
457 static const XMLCh RelyingParty[] = UNICODE_LITERAL_12(R,e,l,y,i,n,g,P,a,r,t,y);
458 static const XMLCh _ReplayCache[] = UNICODE_LITERAL_11(R,e,p,l,a,y,C,a,c,h,e);
459 static const XMLCh _RequestMapper[] = UNICODE_LITERAL_13(R,e,q,u,e,s,t,M,a,p,p,e,r);
460 static const XMLCh SecurityPolicies[] = UNICODE_LITERAL_16(S,e,c,u,r,i,t,y,P,o,l,i,c,i,e,s);
461 static const XMLCh SecurityPolicyProvider[] = UNICODE_LITERAL_22(S,e,c,u,r,i,t,y,P,o,l,i,c,y,P,r,o,v,i,d,e,r);
462 static const XMLCh _SessionCache[] = UNICODE_LITERAL_12(S,e,s,s,i,o,n,C,a,c,h,e);
463 static const XMLCh _SessionInitiator[] = UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
464 static const XMLCh _SingleLogoutService[] = UNICODE_LITERAL_19(S,i,n,g,l,e,L,o,g,o,u,t,S,e,r,v,i,c,e);
465 static const XMLCh Site[] = UNICODE_LITERAL_4(S,i,t,e);
466 static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
467 static const XMLCh TCPListener[] = UNICODE_LITERAL_11(T,C,P,L,i,s,t,e,n,e,r);
468 static const XMLCh TransportOption[] = UNICODE_LITERAL_15(T,r,a,n,s,p,o,r,t,O,p,t,i,o,n);
469 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
470 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
471 static const XMLCh UnixListener[] = UNICODE_LITERAL_12(U,n,i,x,L,i,s,t,e,n,e,r);
475 ServiceProvider* XMLServiceProviderFactory(const DOMElement* const & e)
477 return new XMLConfig(e);
481 XMLApplication::XMLApplication(
482 const ServiceProvider* sp,
484 const XMLApplication* base
485 ) : Application(sp), m_base(base),
487 m_metadata(nullptr), m_trust(nullptr),
488 m_attrExtractor(nullptr), m_attrFilter(nullptr), m_attrResolver(nullptr),
489 m_credResolver(nullptr),
491 m_acsDefault(nullptr), m_sessionInitDefault(nullptr), m_artifactResolutionDefault(nullptr)
494 xmltooling::NDC ndc("XMLApplication");
496 Category& log=Category::getInstance(SHIBSP_LOGCAT".Application");
499 // First load any property sets.
500 load(e,nullptr,this);
504 SPConfig& conf=SPConfig::getConfig();
506 SAMLConfig& samlConf=SAMLConfig::getConfig();
507 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
510 // This used to be an actual hash, but now it's just a hex-encode to avoid xmlsec.
511 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
512 string tohash=getId();
513 tohash+=getString("entityID").second;
514 for (const char* ch = tohash.c_str(); *ch; ++ch) {
515 m_hash += (DIGITS[((unsigned char)(0xF0 & *ch)) >> 4 ]);
516 m_hash += (DIGITS[0x0F & *ch]);
519 // Populate prefix pair.
520 m_attributePrefix.second = "HTTP_";
521 pair<bool,const char*> prefix = getString("attributePrefix");
523 m_attributePrefix.first = prefix.second;
524 const char* pch = prefix.second;
526 m_attributePrefix.second += (isalnum(*pch) ? toupper(*pch) : '_');
531 // Load attribute ID lists for REMOTE_USER and header clearing.
532 if (conf.isEnabled(SPConfig::InProcess)) {
533 pair<bool,const char*> attributes = getString("REMOTE_USER");
534 if (attributes.first) {
535 char* dup = strdup(attributes.second);
538 while (start && *start) {
539 while (*start && isspace(*start))
543 pos = strchr(start,' ');
546 m_remoteUsers.push_back(start);
547 start = pos ? pos+1 : nullptr;
552 attributes = getString("unsetHeaders");
553 if (attributes.first) {
554 string transformedprefix(m_attributePrefix.second);
556 prefix = getString("metadataAttributePrefix");
560 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
564 char* dup = strdup(attributes.second);
567 while (start && *start) {
568 while (*start && isspace(*start))
572 pos = strchr(start,' ');
579 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
583 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + start, m_attributePrefix.second + transformed));
585 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + start, transformedprefix + transformed));
586 start = pos ? pos+1 : nullptr;
589 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
593 Handler* handler=nullptr;
594 const PropertySet* sessions = getPropertySet("Sessions");
596 // Process assertion export handler.
597 pair<bool,const char*> location = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,nullptr);
598 if (location.first) {
600 DOMElement* exportElement = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS,_Handler);
601 exportElement->setAttributeNS(nullptr,Location,sessions->getXMLString("exportLocation").second);
602 pair<bool,const XMLCh*> exportACL = sessions->getXMLString("exportACL");
603 if (exportACL.first) {
604 static const XMLCh _acl[] = UNICODE_LITERAL_9(e,x,p,o,r,t,A,C,L);
605 exportElement->setAttributeNS(nullptr,_acl,exportACL.second);
607 handler = conf.HandlerManager.newPlugin(
608 samlconstants::SAML20_BINDING_URI, pair<const DOMElement*,const char*>(exportElement, getId())
610 m_handlers.push_back(handler);
612 // Insert into location map. If it contains the handlerURL, we skip past that part.
613 const char* pch = strstr(location.second, sessions->getString("handlerURL").second);
615 location.second = pch + strlen(sessions->getString("handlerURL").second);
616 if (*location.second == '/')
617 m_handlerMap[location.second]=handler;
619 m_handlerMap[string("/") + location.second]=handler;
621 catch (exception& ex) {
622 log.error("caught exception installing assertion lookup handler: %s", ex.what());
626 // Process other handlers.
627 bool hardACS=false, hardSessionInit=false, hardArt=false;
628 const DOMElement* child = sessions ? XMLHelper::getFirstChildElement(sessions->getElement()) : nullptr;
630 if (!child->hasAttributeNS(nullptr, Location)) {
631 auto_ptr_char hclass(child->getLocalName());
632 log.error("%s handler with no Location property cannot be processed", hclass.get());
633 child = XMLHelper::getNextSiblingElement(child);
637 if (XMLString::equals(child->getLocalName(),_AssertionConsumerService)) {
638 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
639 if (!bindprop.get() || !*(bindprop.get())) {
640 log.warn("md:AssertionConsumerService element has no Binding attribute, skipping it...");
641 child = XMLHelper::getNextSiblingElement(child);
644 handler=conf.AssertionConsumerServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
645 // Map by binding (may be > 1 per binding, e.g. SAML 1.0 vs 1.1)
646 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler);
647 m_acsIndexMap[handler->getUnsignedInt("index").second]=handler;
650 pair<bool,bool> defprop=handler->getBool("isDefault");
652 if (defprop.second) {
654 m_acsDefault=handler;
657 else if (!m_acsDefault)
658 m_acsDefault=handler;
661 else if (XMLString::equals(child->getLocalName(),_SessionInitiator)) {
662 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
663 if (!type.get() || !*(type.get())) {
664 log.warn("SessionInitiator element has no type attribute, skipping it...");
665 child = XMLHelper::getNextSiblingElement(child);
668 SessionInitiator* sihandler=conf.SessionInitiatorManager.newPlugin(type.get(),make_pair(child, getId()));
670 pair<bool,const char*> si_id=handler->getString("id");
671 if (si_id.first && si_id.second)
672 m_sessionInitMap[si_id.second]=sihandler;
673 if (!hardSessionInit) {
674 pair<bool,bool> defprop=handler->getBool("isDefault");
676 if (defprop.second) {
677 hardSessionInit=true;
678 m_sessionInitDefault=sihandler;
681 else if (!m_sessionInitDefault)
682 m_sessionInitDefault=sihandler;
685 else if (XMLString::equals(child->getLocalName(),_LogoutInitiator)) {
686 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
687 if (!type.get() || !*(type.get())) {
688 log.warn("LogoutInitiator element has no type attribute, skipping it...");
689 child = XMLHelper::getNextSiblingElement(child);
692 handler=conf.LogoutInitiatorManager.newPlugin(type.get(),make_pair(child, getId()));
694 else if (XMLString::equals(child->getLocalName(),_ArtifactResolutionService)) {
695 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
696 if (!bindprop.get() || !*(bindprop.get())) {
697 log.warn("md:ArtifactResolutionService element has no Binding attribute, skipping it...");
698 child = XMLHelper::getNextSiblingElement(child);
701 handler=conf.ArtifactResolutionServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
704 pair<bool,bool> defprop=handler->getBool("isDefault");
706 if (defprop.second) {
708 m_artifactResolutionDefault=handler;
711 else if (!m_artifactResolutionDefault)
712 m_artifactResolutionDefault=handler;
715 else if (XMLString::equals(child->getLocalName(),_SingleLogoutService)) {
716 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
717 if (!bindprop.get() || !*(bindprop.get())) {
718 log.warn("md:SingleLogoutService element has no Binding attribute, skipping it...");
719 child = XMLHelper::getNextSiblingElement(child);
722 handler=conf.SingleLogoutServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
724 else if (XMLString::equals(child->getLocalName(),_ManageNameIDService)) {
725 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
726 if (!bindprop.get() || !*(bindprop.get())) {
727 log.warn("md:ManageNameIDService element has no Binding attribute, skipping it...");
728 child = XMLHelper::getNextSiblingElement(child);
731 handler=conf.ManageNameIDServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
734 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
735 if (!type.get() || !*(type.get())) {
736 log.warn("Handler element has no type attribute, skipping it...");
737 child = XMLHelper::getNextSiblingElement(child);
740 handler=conf.HandlerManager.newPlugin(type.get(),make_pair(child, getId()));
743 m_handlers.push_back(handler);
745 // Insert into location map.
746 location=handler->getString("Location");
747 if (location.first && *location.second == '/')
748 m_handlerMap[location.second]=handler;
749 else if (location.first)
750 m_handlerMap[string("/") + location.second]=handler;
753 catch (exception& ex) {
754 log.error("caught exception processing handler element: %s", ex.what());
757 child = XMLHelper::getNextSiblingElement(child);
761 DOMNodeList* nlist=e->getElementsByTagNameNS(shibspconstants::SHIB2SPCONFIG_NS,Notify);
762 for (XMLSize_t i=0; nlist && i<nlist->getLength(); i++) {
763 if (nlist->item(i)->getParentNode()->isSameNode(e)) {
764 const XMLCh* channel = static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(nullptr,Channel);
765 auto_ptr_char loc(static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(nullptr,Location));
766 if (loc.get() && *loc.get()) {
767 if (channel && *channel == chLatin_f)
768 m_frontLogout.push_back(loc.get());
770 m_backLogout.push_back(loc.get());
776 nlist=e->getElementsByTagNameNS(samlconstants::SAML20_NS,Audience::LOCAL_NAME);
777 if (nlist && nlist->getLength()) {
778 log.warn("use of <saml:Audience> elements outside of a Security Policy Rule is deprecated");
779 for (XMLSize_t i=0; i<nlist->getLength(); i++)
780 if (nlist->item(i)->getParentNode()->isSameNode(e) && nlist->item(i)->hasChildNodes())
781 m_audiences.push_back(nlist->item(i)->getFirstChild()->getNodeValue());
784 if (conf.isEnabled(SPConfig::Metadata)) {
785 child = XMLHelper::getFirstChildElement(e,_MetadataProvider);
787 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
788 log.info("building MetadataProvider of type %s...",type.get());
790 auto_ptr<MetadataProvider> mp(samlConf.MetadataProviderManager.newPlugin(type.get(),child));
792 m_metadata = mp.release();
794 catch (exception& ex) {
795 log.crit("error building/initializing MetadataProvider: %s", ex.what());
800 if (conf.isEnabled(SPConfig::Trust)) {
801 child = XMLHelper::getFirstChildElement(e,_TrustEngine);
803 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
804 log.info("building TrustEngine of type %s...",type.get());
806 m_trust = xmlConf.TrustEngineManager.newPlugin(type.get(),child);
808 catch (exception& ex) {
809 log.crit("error building TrustEngine: %s", ex.what());
814 if (conf.isEnabled(SPConfig::AttributeResolution)) {
815 child = XMLHelper::getFirstChildElement(e,_AttributeExtractor);
817 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
818 log.info("building AttributeExtractor of type %s...",type.get());
820 m_attrExtractor = conf.AttributeExtractorManager.newPlugin(type.get(),child);
822 catch (exception& ex) {
823 log.crit("error building AttributeExtractor: %s", ex.what());
827 child = XMLHelper::getFirstChildElement(e,_AttributeFilter);
829 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
830 log.info("building AttributeFilter of type %s...",type.get());
832 m_attrFilter = conf.AttributeFilterManager.newPlugin(type.get(),child);
834 catch (exception& ex) {
835 log.crit("error building AttributeFilter: %s", ex.what());
839 child = XMLHelper::getFirstChildElement(e,_AttributeResolver);
841 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
842 log.info("building AttributeResolver of type %s...",type.get());
844 m_attrResolver = conf.AttributeResolverManager.newPlugin(type.get(),child);
846 catch (exception& ex) {
847 log.crit("error building AttributeResolver: %s", ex.what());
851 if (m_unsetHeaders.empty()) {
852 vector<string> unsetHeaders;
853 if (m_attrExtractor) {
854 Locker extlock(m_attrExtractor);
855 m_attrExtractor->getAttributeIds(unsetHeaders);
857 else if (m_base && m_base->m_attrExtractor) {
858 Locker extlock(m_base->m_attrExtractor);
859 m_base->m_attrExtractor->getAttributeIds(unsetHeaders);
861 if (m_attrResolver) {
862 Locker reslock(m_attrResolver);
863 m_attrResolver->getAttributeIds(unsetHeaders);
865 else if (m_base && m_base->m_attrResolver) {
866 Locker extlock(m_base->m_attrResolver);
867 m_base->m_attrResolver->getAttributeIds(unsetHeaders);
869 if (!unsetHeaders.empty()) {
870 string transformedprefix(m_attributePrefix.second);
872 pair<bool,const char*> prefix = getString("metadataAttributePrefix");
876 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
880 for (vector<string>::const_iterator hdr = unsetHeaders.begin(); hdr!=unsetHeaders.end(); ++hdr) {
884 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
887 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + *hdr, m_attributePrefix.second + transformed));
889 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + *hdr, transformedprefix + transformed));
892 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
896 if (conf.isEnabled(SPConfig::Credentials)) {
897 child = XMLHelper::getFirstChildElement(e,_CredentialResolver);
899 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
900 log.info("building CredentialResolver of type %s...",type.get());
902 m_credResolver = xmlConf.CredentialResolverManager.newPlugin(type.get(),child);
904 catch (exception& ex) {
905 log.crit("error building CredentialResolver: %s", ex.what());
910 // Finally, load relying parties.
911 child = XMLHelper::getFirstChildElement(e,RelyingParty);
913 auto_ptr<DOMPropertySet> rp(new DOMPropertySet());
914 rp->load(child,nullptr,this);
916 m_partyMap[child->getAttributeNS(nullptr,saml2::Attribute::NAME_ATTRIB_NAME)]=rp.release();
917 child = XMLHelper::getNextSiblingElement(child,RelyingParty);
921 // Out of process only, we register a listener endpoint.
922 if (!conf.isEnabled(SPConfig::InProcess)) {
923 ListenerService* listener = sp->getListenerService(false);
925 string addr=string(getId()) + "::getHeaders::Application";
926 listener->regListener(addr.c_str(),this);
929 log.info("no ListenerService available, Application remoting disabled");
944 void XMLApplication::cleanup()
946 ListenerService* listener=getServiceProvider().getListenerService(false);
947 if (listener && SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess) && !SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
948 string addr=string(getId()) + "::getHeaders::Application";
949 listener->unregListener(addr.c_str(),this);
951 for_each(m_handlers.begin(),m_handlers.end(),xmltooling::cleanup<Handler>());
954 for_each(m_partyMap.begin(),m_partyMap.end(),cleanup_pair<xstring,PropertySet>());
956 delete m_credResolver;
957 m_credResolver = nullptr;
958 delete m_attrResolver;
959 m_attrResolver = nullptr;
961 m_attrFilter = nullptr;
962 delete m_attrExtractor;
963 m_attrExtractor = nullptr;
967 m_metadata = nullptr;
971 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
974 DOMNodeFilter::FilterAction
976 XMLApplication::acceptNode(const DOMNode* node) const
978 const XMLCh* name=node->getLocalName();
979 if (XMLString::equals(name,ApplicationOverride) ||
980 XMLString::equals(name,_Audience) ||
981 XMLString::equals(name,Notify) ||
982 XMLString::equals(name,_Handler) ||
983 XMLString::equals(name,_AssertionConsumerService) ||
984 XMLString::equals(name,_ArtifactResolutionService) ||
985 XMLString::equals(name,_LogoutInitiator) ||
986 XMLString::equals(name,_ManageNameIDService) ||
987 XMLString::equals(name,_SessionInitiator) ||
988 XMLString::equals(name,_SingleLogoutService) ||
989 XMLString::equals(name,RelyingParty) ||
990 XMLString::equals(name,_MetadataProvider) ||
991 XMLString::equals(name,_TrustEngine) ||
992 XMLString::equals(name,_CredentialResolver) ||
993 XMLString::equals(name,_AttributeFilter) ||
994 XMLString::equals(name,_AttributeExtractor) ||
995 XMLString::equals(name,_AttributeResolver))
996 return FILTER_REJECT;
998 return FILTER_ACCEPT;
1003 const PropertySet* XMLApplication::getRelyingParty(const EntityDescriptor* provider) const
1008 map<xstring,PropertySet*>::const_iterator i=m_partyMap.find(provider->getEntityID());
1009 if (i!=m_partyMap.end())
1011 const EntitiesDescriptor* group=dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
1013 if (group->getName()) {
1014 i=m_partyMap.find(group->getName());
1015 if (i!=m_partyMap.end())
1018 group=dynamic_cast<const EntitiesDescriptor*>(group->getParent());
1023 const PropertySet* XMLApplication::getRelyingParty(const XMLCh* entityID) const
1028 map<xstring,PropertySet*>::const_iterator i=m_partyMap.find(entityID);
1029 if (i!=m_partyMap.end())
1036 string XMLApplication::getNotificationURL(const char* resource, bool front, unsigned int index) const
1038 const vector<string>& locs = front ? m_frontLogout : m_backLogout;
1040 return m_base ? m_base->getNotificationURL(resource, front, index) : string();
1041 else if (index >= locs.size())
1044 #ifdef HAVE_STRCASECMP
1045 if (!resource || (strncasecmp(resource,"http://",7) && strncasecmp(resource,"https://",8)))
1047 if (!resource || (strnicmp(resource,"http://",7) && strnicmp(resource,"https://",8)))
1049 throw ConfigurationException("Request URL was not absolute.");
1051 const char* handler=locs[index].c_str();
1053 // Should never happen...
1054 if (!handler || (*handler!='/' && strncmp(handler,"http:",5) && strncmp(handler,"https:",6)))
1055 throw ConfigurationException(
1056 "Invalid Location property ($1) in Notify element for Application ($2)",
1057 params(2, handler ? handler : "null", getId())
1060 // The "Location" property can be in one of three formats:
1062 // 1) a full URI: http://host/foo/bar
1063 // 2) a hostless URI: http:///foo/bar
1064 // 3) a relative path: /foo/bar
1066 // # Protocol Host Path
1067 // 1 handler handler handler
1068 // 2 handler resource handler
1069 // 3 resource resource handler
1071 const char* path = nullptr;
1073 // Decide whether to use the handler or the resource for the "protocol"
1075 if (*handler != '/') {
1083 // break apart the "protocol" string into protocol, host, and "the rest"
1084 const char* colon=strchr(prot,':');
1086 const char* slash=strchr(colon,'/');
1090 // Compute the actual protocol and store.
1091 string notifyURL(prot, colon-prot);
1093 // create the "host" from either the colon/slash or from the target string
1094 // If prot == handler then we're in either #1 or #2, else #3.
1095 // If slash == colon then we're in #2.
1096 if (prot != handler || slash == colon) {
1097 colon = strchr(resource, ':');
1098 colon += 3; // Get past the ://
1099 slash = strchr(colon, '/');
1101 string host(colon, (slash ? slash-colon : strlen(colon)));
1104 notifyURL += host + path;
1108 void XMLApplication::clearHeader(SPRequest& request, const char* rawname, const char* cginame) const
1110 if (!m_attributePrefix.first.empty()) {
1111 string temp = m_attributePrefix.first + rawname;
1112 string temp2 = m_attributePrefix.second + (cginame + 5);
1113 request.clearHeader(temp.c_str(), temp2.c_str());
1116 m_base->clearHeader(request, rawname, cginame);
1119 request.clearHeader(rawname, cginame);
1123 void XMLApplication::setHeader(SPRequest& request, const char* name, const char* value) const
1125 if (!m_attributePrefix.first.empty()) {
1126 string temp = m_attributePrefix.first + name;
1127 request.setHeader(temp.c_str(), value);
1130 m_base->setHeader(request, name, value);
1133 request.setHeader(name, value);
1137 string XMLApplication::getSecureHeader(const SPRequest& request, const char* name) const
1139 if (!m_attributePrefix.first.empty()) {
1140 string temp = m_attributePrefix.first + name;
1141 return request.getSecureHeader(temp.c_str());
1144 return m_base->getSecureHeader(request,name);
1147 return request.getSecureHeader(name);
1151 const SessionInitiator* XMLApplication::getDefaultSessionInitiator() const
1153 if (m_sessionInitDefault) return m_sessionInitDefault;
1154 return m_base ? m_base->getDefaultSessionInitiator() : nullptr;
1157 const SessionInitiator* XMLApplication::getSessionInitiatorById(const char* id) const
1159 map<string,const SessionInitiator*>::const_iterator i=m_sessionInitMap.find(id);
1160 if (i!=m_sessionInitMap.end()) return i->second;
1161 return m_base ? m_base->getSessionInitiatorById(id) : nullptr;
1164 const Handler* XMLApplication::getDefaultAssertionConsumerService() const
1166 if (m_acsDefault) return m_acsDefault;
1167 return m_base ? m_base->getDefaultAssertionConsumerService() : nullptr;
1170 const Handler* XMLApplication::getAssertionConsumerServiceByIndex(unsigned short index) const
1172 map<unsigned int,const Handler*>::const_iterator i=m_acsIndexMap.find(index);
1173 if (i!=m_acsIndexMap.end()) return i->second;
1174 return m_base ? m_base->getAssertionConsumerServiceByIndex(index) : nullptr;
1177 const vector<const Handler*>& XMLApplication::getAssertionConsumerServicesByBinding(const XMLCh* binding) const
1179 ACSBindingMap::const_iterator i=m_acsBindingMap.find(binding);
1180 if (i!=m_acsBindingMap.end())
1182 return m_base ? m_base->getAssertionConsumerServicesByBinding(binding) : g_noHandlers;
1185 const Handler* XMLApplication::getHandler(const char* path) const
1188 wrap = wrap.substr(0,wrap.find(';'));
1189 map<string,const Handler*>::const_iterator i=m_handlerMap.find(wrap.substr(0,wrap.find('?')));
1190 if (i!=m_handlerMap.end())
1192 return m_base ? m_base->getHandler(path) : nullptr;
1195 void XMLApplication::getHandlers(vector<const Handler*>& handlers) const
1197 handlers.insert(handlers.end(), m_handlers.begin(), m_handlers.end());
1199 for (map<string,const Handler*>::const_iterator h = m_base->m_handlerMap.begin(); h != m_base->m_handlerMap.end(); ++h) {
1200 if (m_handlerMap.count(h->first) == 0)
1201 handlers.push_back(h->second);
1206 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
1209 DOMNodeFilter::FilterAction
1211 XMLConfigImpl::acceptNode(const DOMNode* node) const
1213 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
1214 return FILTER_ACCEPT;
1215 const XMLCh* name=node->getLocalName();
1216 if (XMLString::equals(name,ApplicationDefaults) ||
1217 XMLString::equals(name,_ArtifactMap) ||
1218 XMLString::equals(name,_Extensions) ||
1219 XMLString::equals(name,Listener) ||
1220 XMLString::equals(name,_RequestMapper) ||
1221 XMLString::equals(name,_ReplayCache) ||
1222 XMLString::equals(name,SecurityPolicies) ||
1223 XMLString::equals(name,SecurityPolicyProvider) ||
1224 XMLString::equals(name,_SessionCache) ||
1225 XMLString::equals(name,Site) ||
1226 XMLString::equals(name,_StorageService) ||
1227 XMLString::equals(name,TCPListener) ||
1228 XMLString::equals(name,TransportOption) ||
1229 XMLString::equals(name,UnixListener))
1230 return FILTER_REJECT;
1232 return FILTER_ACCEPT;
1235 void XMLConfigImpl::doExtensions(const DOMElement* e, const char* label, Category& log)
1237 const DOMElement* exts=XMLHelper::getFirstChildElement(e,_Extensions);
1239 exts=XMLHelper::getFirstChildElement(exts,Library);
1241 auto_ptr_char path(exts->getAttributeNS(nullptr,_path));
1244 if (!XMLToolingConfig::getConfig().load_library(path.get(),(void*)exts))
1245 throw ConfigurationException("XMLToolingConfig::load_library failed.");
1246 log.debug("loaded %s extension library (%s)", label, path.get());
1249 catch (exception& e) {
1250 const XMLCh* fatal=exts->getAttributeNS(nullptr,_fatal);
1251 if (fatal && (*fatal==chLatin_t || *fatal==chDigit_1)) {
1252 log.fatal("unable to load mandatory %s extension library %s: %s", label, path.get(), e.what());
1256 log.crit("unable to load optional %s extension library %s: %s", label, path.get(), e.what());
1259 exts=XMLHelper::getNextSiblingElement(exts,Library);
1264 XMLConfigImpl::XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer, Category& log)
1265 : m_requestMapper(nullptr),
1269 m_outer(outer), m_document(nullptr)
1272 xmltooling::NDC ndc("XMLConfigImpl");
1276 SPConfig& conf=SPConfig::getConfig();
1278 SAMLConfig& samlConf=SAMLConfig::getConfig();
1280 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
1281 const DOMElement* SHAR=XMLHelper::getFirstChildElement(e,OutOfProcess);
1282 const DOMElement* SHIRE=XMLHelper::getFirstChildElement(e,InProcess);
1284 // Initialize log4cpp manually in order to redirect log messages as soon as possible.
1285 if (conf.isEnabled(SPConfig::Logging)) {
1286 const XMLCh* logconf=nullptr;
1287 if (conf.isEnabled(SPConfig::OutOfProcess))
1288 logconf=SHAR->getAttributeNS(nullptr,logger);
1289 else if (conf.isEnabled(SPConfig::InProcess))
1290 logconf=SHIRE->getAttributeNS(nullptr,logger);
1291 if (!logconf || !*logconf)
1292 logconf=e->getAttributeNS(nullptr,logger);
1293 if (logconf && *logconf) {
1294 auto_ptr_char logpath(logconf);
1295 log.debug("loading new logging configuration from (%s), check log destination for status of configuration",logpath.get());
1296 if (!XMLToolingConfig::getConfig().log_config(logpath.get()))
1297 log.crit("failed to load new logging configuration from (%s)", logpath.get());
1302 m_outer->m_tranLog = new TransactionLog();
1306 // Re-log library versions now that logging is set up.
1307 log.info("Shibboleth SP Version %s", PACKAGE_VERSION);
1310 "Library versions: Xerces-C %s, XML-Security-C %s, XMLTooling-C %s, OpenSAML-C %s, Shibboleth %s",
1311 XERCES_FULLVERSIONDOT, XSEC_FULLVERSIONDOT, XMLTOOLING_FULLVERSIONDOT, OPENSAML_FULLVERSIONDOT, SHIBSP_FULLVERSIONDOT
1315 "Library versions: Xerces-C %s, XMLTooling-C %s, Shibboleth %s",
1316 XERCES_FULLVERSIONDOT, XMLTOOLING_FULLVERSIONDOT, SHIBSP_FULLVERSIONDOT
1320 // First load any property sets.
1321 load(e,nullptr,this);
1325 // Much of the processing can only occur on the first instantiation.
1328 pair<bool,unsigned int> skew=getUnsignedInt("clockSkew");
1330 xmlConf.clock_skew_secs=min(skew.second,(60*60*24*7*28));
1332 pair<bool,const char*> unsafe = getString("unsafeChars");
1334 TemplateEngine::unsafe_chars = unsafe.second;
1336 unsafe = getString("allowedSchemes");
1338 HTTPResponse::getAllowedSchemes().clear();
1339 string schemes=unsafe.second;
1340 unsigned int j_sch=0;
1341 for (unsigned int i_sch=0; i_sch < schemes.length(); i_sch++) {
1342 if (schemes.at(i_sch)==' ') {
1343 HTTPResponse::getAllowedSchemes().push_back(schemes.substr(j_sch, i_sch-j_sch));
1347 HTTPResponse::getAllowedSchemes().push_back(schemes.substr(j_sch, schemes.length()-j_sch));
1351 doExtensions(e, "global", log);
1352 if (conf.isEnabled(SPConfig::OutOfProcess))
1353 doExtensions(SHAR, "out of process", log);
1355 if (conf.isEnabled(SPConfig::InProcess))
1356 doExtensions(SHIRE, "in process", log);
1358 // Instantiate the ListenerService and SessionCache objects.
1359 if (conf.isEnabled(SPConfig::Listener)) {
1361 string plugtype(TCP_LISTENER_SERVICE);
1363 string plugtype(UNIX_LISTENER_SERVICE);
1365 child = XMLHelper::getFirstChildElement(e, UnixListener);
1367 plugtype = UNIX_LISTENER_SERVICE;
1369 child = XMLHelper::getFirstChildElement(e, TCPListener);
1371 plugtype = TCP_LISTENER_SERVICE;
1373 child = XMLHelper::getFirstChildElement(e, Listener);
1375 auto_ptr_char type(child->getAttributeNS(nullptr, _type));
1376 if (type.get() && *type.get())
1377 plugtype = type.get();
1382 log.info("building ListenerService of type %s...", plugtype.c_str());
1383 m_outer->m_listener = conf.ListenerServiceManager.newPlugin(plugtype.c_str(), child);
1387 if (m_outer->m_listener && conf.isEnabled(SPConfig::OutOfProcess) && !conf.isEnabled(SPConfig::InProcess)) {
1388 m_outer->m_listener->regListener("set::RelayState", const_cast<XMLConfig*>(m_outer));
1389 m_outer->m_listener->regListener("get::RelayState", const_cast<XMLConfig*>(m_outer));
1390 m_outer->m_listener->regListener("set::PostData", const_cast<XMLConfig*>(m_outer));
1391 m_outer->m_listener->regListener("get::PostData", const_cast<XMLConfig*>(m_outer));
1395 if (conf.isEnabled(SPConfig::Caching)) {
1396 if (conf.isEnabled(SPConfig::OutOfProcess)) {
1398 // First build any StorageServices.
1399 child=XMLHelper::getFirstChildElement(e,_StorageService);
1401 auto_ptr_char id(child->getAttributeNS(nullptr,_id));
1402 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
1404 log.info("building StorageService (%s) of type %s...", id.get(), type.get());
1405 m_outer->m_storage[id.get()] = xmlConf.StorageServiceManager.newPlugin(type.get(),child);
1407 catch (exception& ex) {
1408 log.crit("failed to instantiate StorageService (%s): %s", id.get(), ex.what());
1410 child=XMLHelper::getNextSiblingElement(child,_StorageService);
1414 StorageService* replaySS=nullptr;
1415 child=XMLHelper::getFirstChildElement(e,_ReplayCache);
1417 auto_ptr_char ssid(child->getAttributeNS(nullptr,_StorageService));
1418 if (ssid.get() && *ssid.get()) {
1419 if (m_outer->m_storage.count(ssid.get()))
1420 replaySS = m_outer->m_storage[ssid.get()];
1422 log.info("building ReplayCache on top of StorageService (%s)...", ssid.get());
1424 log.warn("unable to locate StorageService (%s) for ReplayCache, using dedicated in-memory instance", ssid.get());
1426 xmlConf.setReplayCache(new ReplayCache(replaySS));
1429 log.warn("no ReplayCache built, missing conf:ReplayCache element?");
1433 child=XMLHelper::getFirstChildElement(e,_ArtifactMap);
1435 auto_ptr_char ssid(child->getAttributeNS(nullptr,_StorageService));
1436 if (ssid.get() && *ssid.get() && m_outer->m_storage.count(ssid.get())) {
1437 log.info("building ArtifactMap on top of StorageService (%s)...", ssid.get());
1438 samlConf.setArtifactMap(new ArtifactMap(child, m_outer->m_storage[ssid.get()]));
1441 if (samlConf.getArtifactMap()==nullptr) {
1442 log.info("building in-memory ArtifactMap...");
1443 samlConf.setArtifactMap(new ArtifactMap(child));
1447 child=XMLHelper::getFirstChildElement(e,_SessionCache);
1449 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
1450 log.info("building SessionCache of type %s...",type.get());
1451 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(type.get(), child);
1454 log.fatal("can't build SessionCache, missing conf:SessionCache element?");
1455 throw ConfigurationException("Can't build SessionCache, missing conf:SessionCache element?");
1458 } // end of first-time-only stuff
1460 // Back to the fully dynamic stuff...next up is the RequestMapper.
1461 if (conf.isEnabled(SPConfig::RequestMapping)) {
1462 if (child = XMLHelper::getFirstChildElement(e,_RequestMapper)) {
1463 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
1464 log.info("building RequestMapper of type %s...",type.get());
1465 m_requestMapper=conf.RequestMapperManager.newPlugin(type.get(),child);
1468 log.fatal("can't build RequestMapper, missing conf:RequestMapper element?");
1469 throw ConfigurationException("Can't build RequestMapper, missing conf:RequestMapper element?");
1474 // Load security policies.
1475 if (child = XMLHelper::getLastChildElement(e, SecurityPolicyProvider)) {
1476 auto_ptr_char type(child->getAttributeNS(nullptr, _type));
1477 log.info("building SecurityPolicyProvider of type %s...", type.get());
1478 m_policy = conf.SecurityPolicyProviderManager.newPlugin(type.get(), child);
1480 else if (child = XMLHelper::getLastChildElement(e, SecurityPolicies)) {
1481 // For backward compatibility, wrap in a plugin element.
1482 DOMElement* polwrapper = e->getOwnerDocument()->createElementNS(nullptr, SecurityPolicyProvider);
1483 polwrapper->appendChild(child);
1484 log.info("building SecurityPolicyProvider of type %s...", XML_SECURITYPOLICY_PROVIDER);
1485 m_policy = conf.SecurityPolicyProviderManager.newPlugin(XML_SECURITYPOLICY_PROVIDER, polwrapper);
1488 log.fatal("can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
1489 throw ConfigurationException("Can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
1493 #ifdef SHIBSP_XMLSEC_WHITELISTING
1494 vector<xstring>::const_iterator alg;
1495 if (!m_policy->getAlgorithmBlacklist().empty()) {
1496 for (alg = m_policy->getAlgorithmBlacklist().begin(); alg != m_policy->getAlgorithmBlacklist().end(); ++alg)
1497 XSECPlatformUtils::blacklistAlgorithm(alg->c_str());
1499 else if (!m_policy->getAlgorithmWhitelist().empty()) {
1500 for (alg = m_policy->getAlgorithmWhitelist().begin(); alg != m_policy->getAlgorithmWhitelist().end(); ++alg)
1501 XSECPlatformUtils::whitelistAlgorithm(alg->c_str());
1504 log.fatal("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists");
1505 throw ConfigurationException("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists.");
1509 // Process TransportOption elements.
1510 child = XMLHelper::getLastChildElement(e,TransportOption);
1512 if (child->hasChildNodes()) {
1513 auto_ptr_char provider(child->getAttributeNS(nullptr,_provider));
1514 auto_ptr_char option(child->getAttributeNS(nullptr,_option));
1515 auto_ptr_char value(child->getFirstChild()->getNodeValue());
1516 if (provider.get() && *provider.get() && option.get() && *option.get() && value.get() && *value.get()) {
1517 m_transportOptions.push_back(make_pair(string(provider.get()), make_pair(string(option.get()), string(value.get()))));
1520 child = XMLHelper::getPreviousSiblingElement(child,TransportOption);
1524 // Load the default application. This actually has a fixed ID of "default". ;-)
1525 child=XMLHelper::getLastChildElement(e,ApplicationDefaults);
1527 log.fatal("can't build default Application object, missing conf:ApplicationDefaults element?");
1528 throw ConfigurationException("can't build default Application object, missing conf:ApplicationDefaults element?");
1530 XMLApplication* defapp=new XMLApplication(m_outer,child);
1531 m_appmap[defapp->getId()]=defapp;
1533 // Load any overrides.
1534 child = XMLHelper::getFirstChildElement(child,ApplicationOverride);
1536 auto_ptr<XMLApplication> iapp(new XMLApplication(m_outer,child,defapp));
1537 if (m_appmap.count(iapp->getId()))
1538 log.crit("found conf:ApplicationOverride element with duplicate id attribute (%s), skipping it", iapp->getId());
1540 const char* iappid=iapp->getId();
1541 m_appmap[iappid]=iapp.release();
1544 child = XMLHelper::getNextSiblingElement(child,ApplicationOverride);
1547 catch (exception&) {
1553 XMLConfigImpl::~XMLConfigImpl()
1558 void XMLConfigImpl::cleanup()
1560 for_each(m_appmap.begin(),m_appmap.end(),cleanup_pair<string,Application>());
1566 delete m_requestMapper;
1567 m_requestMapper = nullptr;
1569 m_document->release();
1570 m_document = nullptr;
1574 void XMLConfig::receive(DDF& in, ostream& out)
1576 if (!strcmp(in.name(), "get::RelayState")) {
1577 const char* id = in["id"].string();
1578 const char* key = in["key"].string();
1580 throw ListenerException("Required parameters missing for RelayState recovery.");
1583 StorageService* storage = getStorageService(id);
1585 if (storage->readString("RelayState",key,&relayState)>0) {
1586 if (in["clear"].integer())
1587 storage->deleteString("RelayState",key);
1591 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1592 "Storage-backed RelayState with invalid StorageService ID (%s)", id
1596 // Repack for return to caller.
1597 DDF ret=DDF(nullptr).unsafe_string(relayState.c_str());
1598 DDFJanitor jret(ret);
1601 else if (!strcmp(in.name(), "set::RelayState")) {
1602 const char* id = in["id"].string();
1603 const char* value = in["value"].string();
1605 throw ListenerException("Required parameters missing for RelayState creation.");
1608 StorageService* storage = getStorageService(id);
1610 SAMLConfig::getConfig().generateRandomBytes(rsKey,20);
1611 rsKey = SAMLArtifact::toHex(rsKey);
1612 storage->createString("RelayState", rsKey.c_str(), value, time(nullptr) + 600);
1615 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1616 "Storage-backed RelayState with invalid StorageService ID (%s)", id
1620 // Repack for return to caller.
1621 DDF ret=DDF(nullptr).string(rsKey.c_str());
1622 DDFJanitor jret(ret);
1625 else if (!strcmp(in.name(), "get::PostData")) {
1626 const char* id = in["id"].string();
1627 const char* key = in["key"].string();
1629 throw ListenerException("Required parameters missing for PostData recovery.");
1632 StorageService* storage = getStorageService(id);
1634 if (storage->readString("PostData",key,&postData) > 0) {
1635 storage->deleteString("PostData",key);
1639 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1640 "Storage-backed PostData with invalid StorageService ID (%s)", id
1643 // If the data's empty, we'll send nothing back.
1644 // If not, we don't need to round trip it, just send back the serialized DDF list.
1645 if (postData.empty()) {
1647 DDFJanitor jret(ret);
1654 else if (!strcmp(in.name(), "set::PostData")) {
1655 const char* id = in["id"].string();
1656 if (!id || !in["parameters"].islist())
1657 throw ListenerException("Required parameters missing for PostData creation.");
1660 StorageService* storage = getStorageService(id);
1662 SAMLConfig::getConfig().generateRandomBytes(rsKey,20);
1663 rsKey = SAMLArtifact::toHex(rsKey);
1664 ostringstream params;
1665 params << in["parameters"];
1666 storage->createString("PostData", rsKey.c_str(), params.str().c_str(), time(nullptr) + 600);
1669 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1670 "Storage-backed PostData with invalid StorageService ID (%s)", id
1674 // Repack for return to caller.
1675 DDF ret=DDF(nullptr).string(rsKey.c_str());
1676 DDFJanitor jret(ret);
1682 pair<bool,DOMElement*> XMLConfig::background_load()
1684 // Load from source using base class.
1685 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
1687 // If we own it, wrap it.
1688 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : nullptr);
1690 XMLConfigImpl* impl = new XMLConfigImpl(raw.second, (m_impl==nullptr), this, m_log);
1692 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
1693 impl->setDocument(docjanitor.release());
1695 // Perform the swap inside a lock.
1698 SharedLock locker(m_lock, false);
1702 return make_pair(false,(DOMElement*)nullptr);