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())
355 else if (!m_storage.empty())
356 return m_storage.begin()->second;
361 ListenerService* getListenerService(bool required=true) const {
362 if (required && !m_listener)
363 throw ConfigurationException("No ListenerService available.");
367 SessionCache* getSessionCache(bool required=true) const {
368 if (required && !m_sessionCache)
369 throw ConfigurationException("No SessionCache available.");
370 return m_sessionCache;
373 RequestMapper* getRequestMapper(bool required=true) const {
374 if (required && !m_impl->m_requestMapper)
375 throw ConfigurationException("No RequestMapper available.");
376 return m_impl->m_requestMapper;
379 const Application* getApplication(const char* applicationId) const {
380 map<string,Application*>::const_iterator i=m_impl->m_appmap.find(applicationId ? applicationId : "default");
381 return (i!=m_impl->m_appmap.end()) ? i->second : nullptr;
385 SecurityPolicyProvider* getSecurityPolicyProvider(bool required=true) const {
386 if (required && !m_impl->m_policy)
387 throw ConfigurationException("No SecurityPolicyProvider available.");
388 return m_impl->m_policy;
391 const PropertySet* getPolicySettings(const char* id) const {
392 return getSecurityPolicyProvider()->getPolicySettings(id);
395 const vector<const SecurityPolicyRule*>& getPolicyRules(const char* id) const {
396 return getSecurityPolicyProvider()->getPolicyRules(id);
399 bool setTransportOptions(SOAPTransport& transport) const {
401 vector< pair< string, pair<string,string> > >::const_iterator opt;
402 for (opt = m_impl->m_transportOptions.begin(); opt != m_impl->m_transportOptions.end(); ++opt) {
403 if (!transport.setProviderOption(opt->first.c_str(), opt->second.first.c_str(), opt->second.second.c_str())) {
404 m_log.error("failed to set SOAPTransport option (%s)", opt->second.first.c_str());
413 pair<bool,DOMElement*> background_load();
416 friend class XMLConfigImpl;
417 XMLConfigImpl* m_impl;
418 mutable ListenerService* m_listener;
419 mutable SessionCache* m_sessionCache;
421 mutable TransactionLog* m_tranLog;
422 mutable map<string,StorageService*> m_storage;
426 #if defined (_MSC_VER)
427 #pragma warning( pop )
430 static const XMLCh applicationId[] = UNICODE_LITERAL_13(a,p,p,l,i,c,a,t,i,o,n,I,d);
431 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);
432 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);
433 static const XMLCh _ArtifactMap[] = UNICODE_LITERAL_11(A,r,t,i,f,a,c,t,M,a,p);
434 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);
435 static const XMLCh _AttributeFilter[] = UNICODE_LITERAL_15(A,t,t,r,i,b,u,t,e,F,i,l,t,e,r);
436 static const XMLCh _AttributeResolver[] = UNICODE_LITERAL_17(A,t,t,r,i,b,u,t,e,R,e,s,o,l,v,e,r);
437 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);
438 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);
439 static const XMLCh _Audience[] = UNICODE_LITERAL_8(A,u,d,i,e,n,c,e);
440 static const XMLCh Binding[] = UNICODE_LITERAL_7(B,i,n,d,i,n,g);
441 static const XMLCh Channel[]= UNICODE_LITERAL_7(C,h,a,n,n,e,l);
442 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);
443 static const XMLCh _default[] = UNICODE_LITERAL_7(d,e,f,a,u,l,t);
444 static const XMLCh _Extensions[] = UNICODE_LITERAL_10(E,x,t,e,n,s,i,o,n,s);
445 static const XMLCh _fatal[] = UNICODE_LITERAL_5(f,a,t,a,l);
446 static const XMLCh _Handler[] = UNICODE_LITERAL_7(H,a,n,d,l,e,r);
447 static const XMLCh _id[] = UNICODE_LITERAL_2(i,d);
448 static const XMLCh InProcess[] = UNICODE_LITERAL_9(I,n,P,r,o,c,e,s,s);
449 static const XMLCh Library[] = UNICODE_LITERAL_7(L,i,b,r,a,r,y);
450 static const XMLCh Listener[] = UNICODE_LITERAL_8(L,i,s,t,e,n,e,r);
451 static const XMLCh Location[] = UNICODE_LITERAL_8(L,o,c,a,t,i,o,n);
452 static const XMLCh logger[] = UNICODE_LITERAL_6(l,o,g,g,e,r);
453 static const XMLCh _LogoutInitiator[] = UNICODE_LITERAL_15(L,o,g,o,u,t,I,n,i,t,i,a,t,o,r);
454 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);
455 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
456 static const XMLCh Notify[] = UNICODE_LITERAL_6(N,o,t,i,f,y);
457 static const XMLCh _option[] = UNICODE_LITERAL_6(o,p,t,i,o,n);
458 static const XMLCh OutOfProcess[] = UNICODE_LITERAL_12(O,u,t,O,f,P,r,o,c,e,s,s);
459 static const XMLCh _path[] = UNICODE_LITERAL_4(p,a,t,h);
460 static const XMLCh _provider[] = UNICODE_LITERAL_8(p,r,o,v,i,d,e,r);
461 static const XMLCh RelyingParty[] = UNICODE_LITERAL_12(R,e,l,y,i,n,g,P,a,r,t,y);
462 static const XMLCh _ReplayCache[] = UNICODE_LITERAL_11(R,e,p,l,a,y,C,a,c,h,e);
463 static const XMLCh _RequestMapper[] = UNICODE_LITERAL_13(R,e,q,u,e,s,t,M,a,p,p,e,r);
464 static const XMLCh RequestMap[] = UNICODE_LITERAL_10(R,e,q,u,e,s,t,M,a,p);
465 static const XMLCh SecurityPolicies[] = UNICODE_LITERAL_16(S,e,c,u,r,i,t,y,P,o,l,i,c,i,e,s);
466 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);
467 static const XMLCh _SessionCache[] = UNICODE_LITERAL_12(S,e,s,s,i,o,n,C,a,c,h,e);
468 static const XMLCh _SessionInitiator[] = UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
469 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);
470 static const XMLCh Site[] = UNICODE_LITERAL_4(S,i,t,e);
471 static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
472 static const XMLCh TCPListener[] = UNICODE_LITERAL_11(T,C,P,L,i,s,t,e,n,e,r);
473 static const XMLCh TransportOption[] = UNICODE_LITERAL_15(T,r,a,n,s,p,o,r,t,O,p,t,i,o,n);
474 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
475 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
476 static const XMLCh UnixListener[] = UNICODE_LITERAL_12(U,n,i,x,L,i,s,t,e,n,e,r);
480 ServiceProvider* XMLServiceProviderFactory(const DOMElement* const & e)
482 return new XMLConfig(e);
486 XMLApplication::XMLApplication(
487 const ServiceProvider* sp,
489 const XMLApplication* base
490 ) : Application(sp), m_base(base),
492 m_metadata(nullptr), m_trust(nullptr),
493 m_attrExtractor(nullptr), m_attrFilter(nullptr), m_attrResolver(nullptr),
494 m_credResolver(nullptr),
496 m_acsDefault(nullptr), m_sessionInitDefault(nullptr), m_artifactResolutionDefault(nullptr)
499 xmltooling::NDC ndc("XMLApplication");
501 Category& log=Category::getInstance(SHIBSP_LOGCAT".Application");
504 // First load any property sets.
505 load(e,nullptr,this);
509 SPConfig& conf=SPConfig::getConfig();
511 SAMLConfig& samlConf=SAMLConfig::getConfig();
512 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
515 // This used to be an actual hash, but now it's just a hex-encode to avoid xmlsec dependency.
516 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
517 string tohash=getId();
518 tohash+=getString("entityID").second;
519 for (const char* ch = tohash.c_str(); *ch; ++ch) {
520 m_hash += (DIGITS[((unsigned char)(0xF0 & *ch)) >> 4 ]);
521 m_hash += (DIGITS[0x0F & *ch]);
524 // Populate prefix pair.
525 m_attributePrefix.second = "HTTP_";
526 pair<bool,const char*> prefix = getString("attributePrefix");
528 m_attributePrefix.first = prefix.second;
529 const char* pch = prefix.second;
531 m_attributePrefix.second += (isalnum(*pch) ? toupper(*pch) : '_');
536 // Load attribute ID lists for REMOTE_USER and header clearing.
537 if (conf.isEnabled(SPConfig::InProcess)) {
538 pair<bool,const char*> attributes = getString("REMOTE_USER");
539 if (attributes.first) {
540 char* dup = strdup(attributes.second);
543 while (start && *start) {
544 while (*start && isspace(*start))
548 pos = strchr(start,' ');
551 m_remoteUsers.push_back(start);
552 start = pos ? pos+1 : nullptr;
557 attributes = getString("unsetHeaders");
558 if (attributes.first) {
559 string transformedprefix(m_attributePrefix.second);
561 prefix = getString("metadataAttributePrefix");
565 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
569 char* dup = strdup(attributes.second);
572 while (start && *start) {
573 while (*start && isspace(*start))
577 pos = strchr(start,' ');
584 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
588 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + start, m_attributePrefix.second + transformed));
590 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + start, transformedprefix + transformed));
591 start = pos ? pos+1 : nullptr;
594 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
598 Handler* handler=nullptr;
599 const PropertySet* sessions = getPropertySet("Sessions");
601 // Process assertion export handler.
602 pair<bool,const char*> location = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,nullptr);
603 if (location.first) {
605 DOMElement* exportElement = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS,_Handler);
606 exportElement->setAttributeNS(nullptr,Location,sessions->getXMLString("exportLocation").second);
607 pair<bool,const XMLCh*> exportACL = sessions->getXMLString("exportACL");
608 if (exportACL.first) {
609 static const XMLCh _acl[] = UNICODE_LITERAL_9(e,x,p,o,r,t,A,C,L);
610 exportElement->setAttributeNS(nullptr,_acl,exportACL.second);
612 handler = conf.HandlerManager.newPlugin(
613 samlconstants::SAML20_BINDING_URI, pair<const DOMElement*,const char*>(exportElement, getId())
615 m_handlers.push_back(handler);
617 // Insert into location map. If it contains the handlerURL, we skip past that part.
618 const char* pch = strstr(location.second, sessions->getString("handlerURL").second);
620 location.second = pch + strlen(sessions->getString("handlerURL").second);
621 if (*location.second == '/')
622 m_handlerMap[location.second]=handler;
624 m_handlerMap[string("/") + location.second]=handler;
626 catch (exception& ex) {
627 log.error("caught exception installing assertion lookup handler: %s", ex.what());
631 // Process other handlers.
632 bool hardACS=false, hardSessionInit=false, hardArt=false;
633 const DOMElement* child = sessions ? XMLHelper::getFirstChildElement(sessions->getElement()) : nullptr;
635 if (!child->hasAttributeNS(nullptr, Location)) {
636 auto_ptr_char hclass(child->getLocalName());
637 log.error("%s handler with no Location property cannot be processed", hclass.get());
638 child = XMLHelper::getNextSiblingElement(child);
642 if (XMLString::equals(child->getLocalName(),_AssertionConsumerService)) {
643 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
644 if (!bindprop.get() || !*(bindprop.get())) {
645 log.warn("md:AssertionConsumerService element has no Binding attribute, skipping it...");
646 child = XMLHelper::getNextSiblingElement(child);
649 handler=conf.AssertionConsumerServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
650 // Map by binding (may be > 1 per binding, e.g. SAML 1.0 vs 1.1)
651 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler);
652 m_acsIndexMap[handler->getUnsignedInt("index").second]=handler;
655 pair<bool,bool> defprop=handler->getBool("isDefault");
657 if (defprop.second) {
659 m_acsDefault=handler;
662 else if (!m_acsDefault)
663 m_acsDefault=handler;
666 else if (XMLString::equals(child->getLocalName(),_SessionInitiator)) {
667 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
668 if (!type.get() || !*(type.get())) {
669 log.warn("SessionInitiator element has no type attribute, skipping it...");
670 child = XMLHelper::getNextSiblingElement(child);
673 SessionInitiator* sihandler=conf.SessionInitiatorManager.newPlugin(type.get(),make_pair(child, getId()));
675 pair<bool,const char*> si_id=handler->getString("id");
676 if (si_id.first && si_id.second)
677 m_sessionInitMap[si_id.second]=sihandler;
678 if (!hardSessionInit) {
679 pair<bool,bool> defprop=handler->getBool("isDefault");
681 if (defprop.second) {
682 hardSessionInit=true;
683 m_sessionInitDefault=sihandler;
686 else if (!m_sessionInitDefault)
687 m_sessionInitDefault=sihandler;
690 else if (XMLString::equals(child->getLocalName(),_LogoutInitiator)) {
691 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
692 if (!type.get() || !*(type.get())) {
693 log.warn("LogoutInitiator element has no type attribute, skipping it...");
694 child = XMLHelper::getNextSiblingElement(child);
697 handler=conf.LogoutInitiatorManager.newPlugin(type.get(),make_pair(child, getId()));
699 else if (XMLString::equals(child->getLocalName(),_ArtifactResolutionService)) {
700 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
701 if (!bindprop.get() || !*(bindprop.get())) {
702 log.warn("md:ArtifactResolutionService element has no Binding attribute, skipping it...");
703 child = XMLHelper::getNextSiblingElement(child);
706 handler=conf.ArtifactResolutionServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
709 pair<bool,bool> defprop=handler->getBool("isDefault");
711 if (defprop.second) {
713 m_artifactResolutionDefault=handler;
716 else if (!m_artifactResolutionDefault)
717 m_artifactResolutionDefault=handler;
720 else if (XMLString::equals(child->getLocalName(),_SingleLogoutService)) {
721 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
722 if (!bindprop.get() || !*(bindprop.get())) {
723 log.warn("md:SingleLogoutService element has no Binding attribute, skipping it...");
724 child = XMLHelper::getNextSiblingElement(child);
727 handler=conf.SingleLogoutServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
729 else if (XMLString::equals(child->getLocalName(),_ManageNameIDService)) {
730 auto_ptr_char bindprop(child->getAttributeNS(nullptr,Binding));
731 if (!bindprop.get() || !*(bindprop.get())) {
732 log.warn("md:ManageNameIDService element has no Binding attribute, skipping it...");
733 child = XMLHelper::getNextSiblingElement(child);
736 handler=conf.ManageNameIDServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
739 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
740 if (!type.get() || !*(type.get())) {
741 log.warn("Handler element has no type attribute, skipping it...");
742 child = XMLHelper::getNextSiblingElement(child);
745 handler=conf.HandlerManager.newPlugin(type.get(),make_pair(child, getId()));
748 m_handlers.push_back(handler);
750 // Insert into location map.
751 location=handler->getString("Location");
752 if (location.first && *location.second == '/')
753 m_handlerMap[location.second]=handler;
754 else if (location.first)
755 m_handlerMap[string("/") + location.second]=handler;
758 catch (exception& ex) {
759 log.error("caught exception processing handler element: %s", ex.what());
762 child = XMLHelper::getNextSiblingElement(child);
766 DOMNodeList* nlist=e->getElementsByTagNameNS(shibspconstants::SHIB2SPCONFIG_NS,Notify);
767 for (XMLSize_t i=0; nlist && i<nlist->getLength(); i++) {
768 if (nlist->item(i)->getParentNode()->isSameNode(e)) {
769 const XMLCh* channel = static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(nullptr,Channel);
770 auto_ptr_char loc(static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(nullptr,Location));
771 if (loc.get() && *loc.get()) {
772 if (channel && *channel == chLatin_f)
773 m_frontLogout.push_back(loc.get());
775 m_backLogout.push_back(loc.get());
781 nlist=e->getElementsByTagNameNS(samlconstants::SAML20_NS,Audience::LOCAL_NAME);
782 if (nlist && nlist->getLength()) {
783 log.warn("use of <saml:Audience> elements outside of a Security Policy Rule is deprecated");
784 for (XMLSize_t i=0; i<nlist->getLength(); i++)
785 if (nlist->item(i)->getParentNode()->isSameNode(e) && nlist->item(i)->hasChildNodes())
786 m_audiences.push_back(nlist->item(i)->getFirstChild()->getNodeValue());
789 if (conf.isEnabled(SPConfig::Metadata)) {
790 child = XMLHelper::getFirstChildElement(e,_MetadataProvider);
792 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
793 log.info("building MetadataProvider of type %s...",type.get());
795 auto_ptr<MetadataProvider> mp(samlConf.MetadataProviderManager.newPlugin(type.get(),child));
797 m_metadata = mp.release();
799 catch (exception& ex) {
800 log.crit("error building/initializing MetadataProvider: %s", ex.what());
805 if (conf.isEnabled(SPConfig::Trust)) {
806 child = XMLHelper::getFirstChildElement(e,_TrustEngine);
808 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
809 log.info("building TrustEngine of type %s...",type.get());
811 m_trust = xmlConf.TrustEngineManager.newPlugin(type.get(),child);
813 catch (exception& ex) {
814 log.crit("error building TrustEngine: %s", ex.what());
819 if (conf.isEnabled(SPConfig::AttributeResolution)) {
820 child = XMLHelper::getFirstChildElement(e,_AttributeExtractor);
822 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
823 log.info("building AttributeExtractor of type %s...",type.get());
825 m_attrExtractor = conf.AttributeExtractorManager.newPlugin(type.get(),child);
827 catch (exception& ex) {
828 log.crit("error building AttributeExtractor: %s", ex.what());
832 child = XMLHelper::getFirstChildElement(e,_AttributeFilter);
834 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
835 log.info("building AttributeFilter of type %s...",type.get());
837 m_attrFilter = conf.AttributeFilterManager.newPlugin(type.get(),child);
839 catch (exception& ex) {
840 log.crit("error building AttributeFilter: %s", ex.what());
844 child = XMLHelper::getFirstChildElement(e,_AttributeResolver);
846 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
847 log.info("building AttributeResolver of type %s...",type.get());
849 m_attrResolver = conf.AttributeResolverManager.newPlugin(type.get(),child);
851 catch (exception& ex) {
852 log.crit("error building AttributeResolver: %s", ex.what());
856 if (m_unsetHeaders.empty()) {
857 vector<string> unsetHeaders;
858 if (m_attrExtractor) {
859 Locker extlock(m_attrExtractor);
860 m_attrExtractor->getAttributeIds(unsetHeaders);
862 else if (m_base && m_base->m_attrExtractor) {
863 Locker extlock(m_base->m_attrExtractor);
864 m_base->m_attrExtractor->getAttributeIds(unsetHeaders);
866 if (m_attrResolver) {
867 Locker reslock(m_attrResolver);
868 m_attrResolver->getAttributeIds(unsetHeaders);
870 else if (m_base && m_base->m_attrResolver) {
871 Locker extlock(m_base->m_attrResolver);
872 m_base->m_attrResolver->getAttributeIds(unsetHeaders);
874 if (!unsetHeaders.empty()) {
875 string transformedprefix(m_attributePrefix.second);
877 pair<bool,const char*> prefix = getString("metadataAttributePrefix");
881 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
885 for (vector<string>::const_iterator hdr = unsetHeaders.begin(); hdr!=unsetHeaders.end(); ++hdr) {
889 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
892 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + *hdr, m_attributePrefix.second + transformed));
894 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + *hdr, transformedprefix + transformed));
897 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
901 if (conf.isEnabled(SPConfig::Credentials)) {
902 child = XMLHelper::getFirstChildElement(e,_CredentialResolver);
904 auto_ptr_char type(child->getAttributeNS(nullptr,_type));
905 log.info("building CredentialResolver of type %s...",type.get());
907 m_credResolver = xmlConf.CredentialResolverManager.newPlugin(type.get(),child);
909 catch (exception& ex) {
910 log.crit("error building CredentialResolver: %s", ex.what());
915 // Finally, load relying parties.
916 child = XMLHelper::getFirstChildElement(e,RelyingParty);
918 auto_ptr<DOMPropertySet> rp(new DOMPropertySet());
919 rp->load(child,nullptr,this);
921 m_partyMap[child->getAttributeNS(nullptr,saml2::Attribute::NAME_ATTRIB_NAME)]=rp.release();
922 child = XMLHelper::getNextSiblingElement(child,RelyingParty);
926 // Out of process only, we register a listener endpoint.
927 if (!conf.isEnabled(SPConfig::InProcess)) {
928 ListenerService* listener = sp->getListenerService(false);
930 string addr=string(getId()) + "::getHeaders::Application";
931 listener->regListener(addr.c_str(),this);
934 log.info("no ListenerService available, Application remoting disabled");
949 void XMLApplication::cleanup()
951 ListenerService* listener=getServiceProvider().getListenerService(false);
952 if (listener && SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess) && !SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
953 string addr=string(getId()) + "::getHeaders::Application";
954 listener->unregListener(addr.c_str(),this);
956 for_each(m_handlers.begin(),m_handlers.end(),xmltooling::cleanup<Handler>());
959 for_each(m_partyMap.begin(),m_partyMap.end(),cleanup_pair<xstring,PropertySet>());
961 delete m_credResolver;
962 m_credResolver = nullptr;
963 delete m_attrResolver;
964 m_attrResolver = nullptr;
966 m_attrFilter = nullptr;
967 delete m_attrExtractor;
968 m_attrExtractor = nullptr;
972 m_metadata = nullptr;
976 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
979 DOMNodeFilter::FilterAction
981 XMLApplication::acceptNode(const DOMNode* node) const
983 const XMLCh* name=node->getLocalName();
984 if (XMLString::equals(name,ApplicationOverride) ||
985 XMLString::equals(name,_Audience) ||
986 XMLString::equals(name,Notify) ||
987 XMLString::equals(name,_Handler) ||
988 XMLString::equals(name,_AssertionConsumerService) ||
989 XMLString::equals(name,_ArtifactResolutionService) ||
990 XMLString::equals(name,_LogoutInitiator) ||
991 XMLString::equals(name,_ManageNameIDService) ||
992 XMLString::equals(name,_SessionInitiator) ||
993 XMLString::equals(name,_SingleLogoutService) ||
994 XMLString::equals(name,RelyingParty) ||
995 XMLString::equals(name,_MetadataProvider) ||
996 XMLString::equals(name,_TrustEngine) ||
997 XMLString::equals(name,_CredentialResolver) ||
998 XMLString::equals(name,_AttributeFilter) ||
999 XMLString::equals(name,_AttributeExtractor) ||
1000 XMLString::equals(name,_AttributeResolver))
1001 return FILTER_REJECT;
1003 return FILTER_ACCEPT;
1008 const PropertySet* XMLApplication::getRelyingParty(const EntityDescriptor* provider) const
1013 map<xstring,PropertySet*>::const_iterator i=m_partyMap.find(provider->getEntityID());
1014 if (i!=m_partyMap.end())
1016 const EntitiesDescriptor* group=dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
1018 if (group->getName()) {
1019 i=m_partyMap.find(group->getName());
1020 if (i!=m_partyMap.end())
1023 group=dynamic_cast<const EntitiesDescriptor*>(group->getParent());
1028 const PropertySet* XMLApplication::getRelyingParty(const XMLCh* entityID) const
1033 map<xstring,PropertySet*>::const_iterator i=m_partyMap.find(entityID);
1034 if (i!=m_partyMap.end())
1041 string XMLApplication::getNotificationURL(const char* resource, bool front, unsigned int index) const
1043 const vector<string>& locs = front ? m_frontLogout : m_backLogout;
1045 return m_base ? m_base->getNotificationURL(resource, front, index) : string();
1046 else if (index >= locs.size())
1049 #ifdef HAVE_STRCASECMP
1050 if (!resource || (strncasecmp(resource,"http://",7) && strncasecmp(resource,"https://",8)))
1052 if (!resource || (strnicmp(resource,"http://",7) && strnicmp(resource,"https://",8)))
1054 throw ConfigurationException("Request URL was not absolute.");
1056 const char* handler=locs[index].c_str();
1058 // Should never happen...
1059 if (!handler || (*handler!='/' && strncmp(handler,"http:",5) && strncmp(handler,"https:",6)))
1060 throw ConfigurationException(
1061 "Invalid Location property ($1) in Notify element for Application ($2)",
1062 params(2, handler ? handler : "null", getId())
1065 // The "Location" property can be in one of three formats:
1067 // 1) a full URI: http://host/foo/bar
1068 // 2) a hostless URI: http:///foo/bar
1069 // 3) a relative path: /foo/bar
1071 // # Protocol Host Path
1072 // 1 handler handler handler
1073 // 2 handler resource handler
1074 // 3 resource resource handler
1076 const char* path = nullptr;
1078 // Decide whether to use the handler or the resource for the "protocol"
1080 if (*handler != '/') {
1088 // break apart the "protocol" string into protocol, host, and "the rest"
1089 const char* colon=strchr(prot,':');
1091 const char* slash=strchr(colon,'/');
1095 // Compute the actual protocol and store.
1096 string notifyURL(prot, colon-prot);
1098 // create the "host" from either the colon/slash or from the target string
1099 // If prot == handler then we're in either #1 or #2, else #3.
1100 // If slash == colon then we're in #2.
1101 if (prot != handler || slash == colon) {
1102 colon = strchr(resource, ':');
1103 colon += 3; // Get past the ://
1104 slash = strchr(colon, '/');
1106 string host(colon, (slash ? slash-colon : strlen(colon)));
1109 notifyURL += host + path;
1113 void XMLApplication::clearHeader(SPRequest& request, const char* rawname, const char* cginame) const
1115 if (!m_attributePrefix.first.empty()) {
1116 string temp = m_attributePrefix.first + rawname;
1117 string temp2 = m_attributePrefix.second + (cginame + 5);
1118 request.clearHeader(temp.c_str(), temp2.c_str());
1121 m_base->clearHeader(request, rawname, cginame);
1124 request.clearHeader(rawname, cginame);
1128 void XMLApplication::setHeader(SPRequest& request, const char* name, const char* value) const
1130 if (!m_attributePrefix.first.empty()) {
1131 string temp = m_attributePrefix.first + name;
1132 request.setHeader(temp.c_str(), value);
1135 m_base->setHeader(request, name, value);
1138 request.setHeader(name, value);
1142 string XMLApplication::getSecureHeader(const SPRequest& request, const char* name) const
1144 if (!m_attributePrefix.first.empty()) {
1145 string temp = m_attributePrefix.first + name;
1146 return request.getSecureHeader(temp.c_str());
1149 return m_base->getSecureHeader(request,name);
1152 return request.getSecureHeader(name);
1156 const SessionInitiator* XMLApplication::getDefaultSessionInitiator() const
1158 if (m_sessionInitDefault) return m_sessionInitDefault;
1159 return m_base ? m_base->getDefaultSessionInitiator() : nullptr;
1162 const SessionInitiator* XMLApplication::getSessionInitiatorById(const char* id) const
1164 map<string,const SessionInitiator*>::const_iterator i=m_sessionInitMap.find(id);
1165 if (i!=m_sessionInitMap.end()) return i->second;
1166 return m_base ? m_base->getSessionInitiatorById(id) : nullptr;
1169 const Handler* XMLApplication::getDefaultAssertionConsumerService() const
1171 if (m_acsDefault) return m_acsDefault;
1172 return m_base ? m_base->getDefaultAssertionConsumerService() : nullptr;
1175 const Handler* XMLApplication::getAssertionConsumerServiceByIndex(unsigned short index) const
1177 map<unsigned int,const Handler*>::const_iterator i=m_acsIndexMap.find(index);
1178 if (i!=m_acsIndexMap.end()) return i->second;
1179 return m_base ? m_base->getAssertionConsumerServiceByIndex(index) : nullptr;
1182 const vector<const Handler*>& XMLApplication::getAssertionConsumerServicesByBinding(const XMLCh* binding) const
1184 ACSBindingMap::const_iterator i=m_acsBindingMap.find(binding);
1185 if (i!=m_acsBindingMap.end())
1187 return m_base ? m_base->getAssertionConsumerServicesByBinding(binding) : g_noHandlers;
1190 const Handler* XMLApplication::getHandler(const char* path) const
1193 wrap = wrap.substr(0,wrap.find(';'));
1194 map<string,const Handler*>::const_iterator i=m_handlerMap.find(wrap.substr(0,wrap.find('?')));
1195 if (i!=m_handlerMap.end())
1197 return m_base ? m_base->getHandler(path) : nullptr;
1200 void XMLApplication::getHandlers(vector<const Handler*>& handlers) const
1202 handlers.insert(handlers.end(), m_handlers.begin(), m_handlers.end());
1204 for (map<string,const Handler*>::const_iterator h = m_base->m_handlerMap.begin(); h != m_base->m_handlerMap.end(); ++h) {
1205 if (m_handlerMap.count(h->first) == 0)
1206 handlers.push_back(h->second);
1211 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
1214 DOMNodeFilter::FilterAction
1216 XMLConfigImpl::acceptNode(const DOMNode* node) const
1218 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
1219 return FILTER_ACCEPT;
1220 const XMLCh* name=node->getLocalName();
1221 if (XMLString::equals(name,ApplicationDefaults) ||
1222 XMLString::equals(name,_ArtifactMap) ||
1223 XMLString::equals(name,_Extensions) ||
1224 XMLString::equals(name,Listener) ||
1225 XMLString::equals(name,_RequestMapper) ||
1226 XMLString::equals(name,_ReplayCache) ||
1227 XMLString::equals(name,SecurityPolicies) ||
1228 XMLString::equals(name,SecurityPolicyProvider) ||
1229 XMLString::equals(name,_SessionCache) ||
1230 XMLString::equals(name,Site) ||
1231 XMLString::equals(name,_StorageService) ||
1232 XMLString::equals(name,TCPListener) ||
1233 XMLString::equals(name,TransportOption) ||
1234 XMLString::equals(name,UnixListener))
1235 return FILTER_REJECT;
1237 return FILTER_ACCEPT;
1240 void XMLConfigImpl::doExtensions(const DOMElement* e, const char* label, Category& log)
1242 const DOMElement* exts = XMLHelper::getFirstChildElement(e, _Extensions);
1244 exts = XMLHelper::getFirstChildElement(exts, Library);
1246 string path(XMLHelper::getAttrString(exts, nullptr, _path));
1248 if (!path.empty()) {
1249 if (!XMLToolingConfig::getConfig().load_library(path.c_str(), (void*)exts))
1250 throw ConfigurationException("XMLToolingConfig::load_library failed.");
1251 log.debug("loaded %s extension library (%s)", label, path.c_str());
1254 catch (exception& e) {
1255 if (XMLHelper::getAttrBool(exts, false, _fatal)) {
1256 log.fatal("unable to load mandatory %s extension library %s: %s", label, path.c_str(), e.what());
1260 log.crit("unable to load optional %s extension library %s: %s", label, path.c_str(), e.what());
1263 exts = XMLHelper::getNextSiblingElement(exts, Library);
1268 XMLConfigImpl::XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer, Category& log)
1269 : m_requestMapper(nullptr),
1273 m_outer(outer), m_document(nullptr)
1276 xmltooling::NDC ndc("XMLConfigImpl");
1280 SPConfig& conf=SPConfig::getConfig();
1282 SAMLConfig& samlConf=SAMLConfig::getConfig();
1284 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
1285 const DOMElement* SHAR=XMLHelper::getFirstChildElement(e, OutOfProcess);
1286 const DOMElement* SHIRE=XMLHelper::getFirstChildElement(e, InProcess);
1288 // Initialize logging manually in order to redirect log messages as soon as possible.
1289 if (conf.isEnabled(SPConfig::Logging)) {
1291 if (conf.isEnabled(SPConfig::OutOfProcess))
1292 logconf = XMLHelper::getAttrString(SHAR, nullptr, logger);
1293 else if (conf.isEnabled(SPConfig::InProcess))
1294 logconf = XMLHelper::getAttrString(SHIRE, nullptr, logger);
1295 if (logconf.empty())
1296 logconf = XMLHelper::getAttrString(e, nullptr, logger);
1297 if (logconf.empty() && !getenv("SHIBSP_LOGGING")) {
1298 // No properties found, so default them.
1299 if (conf.isEnabled(SPConfig::OutOfProcess) && !conf.isEnabled(SPConfig::InProcess))
1300 logconf = "shibd.logger";
1301 else if (!conf.isEnabled(SPConfig::OutOfProcess) && conf.isEnabled(SPConfig::InProcess))
1302 logconf = "native.logger";
1304 logconf = "shibboleth.logger";
1306 if (!logconf.empty()) {
1307 log.debug("loading new logging configuration from (%s), check log destination for status of configuration", logconf.c_str());
1308 if (!XMLToolingConfig::getConfig().log_config(logconf.c_str()))
1309 log.crit("failed to load new logging configuration from (%s)", logconf.c_str());
1314 m_outer->m_tranLog = new TransactionLog();
1318 // Re-log library versions now that logging is set up.
1319 log.info("Shibboleth SP Version %s", PACKAGE_VERSION);
1322 "Library versions: Xerces-C %s, XML-Security-C %s, XMLTooling-C %s, OpenSAML-C %s, Shibboleth %s",
1323 XERCES_FULLVERSIONDOT, XSEC_FULLVERSIONDOT, XMLTOOLING_FULLVERSIONDOT, OPENSAML_FULLVERSIONDOT, SHIBSP_FULLVERSIONDOT
1327 "Library versions: Xerces-C %s, XMLTooling-C %s, Shibboleth %s",
1328 XERCES_FULLVERSIONDOT, XMLTOOLING_FULLVERSIONDOT, SHIBSP_FULLVERSIONDOT
1332 // First load any property sets.
1333 load(e,nullptr,this);
1337 // Much of the processing can only occur on the first instantiation.
1340 pair<bool,unsigned int> skew=getUnsignedInt("clockSkew");
1342 xmlConf.clock_skew_secs=min(skew.second,(60*60*24*7*28));
1344 pair<bool,const char*> unsafe = getString("unsafeChars");
1346 TemplateEngine::unsafe_chars = unsafe.second;
1348 unsafe = getString("allowedSchemes");
1350 HTTPResponse::getAllowedSchemes().clear();
1351 string schemes=unsafe.second;
1352 unsigned int j_sch=0;
1353 for (unsigned int i_sch=0; i_sch < schemes.length(); i_sch++) {
1354 if (schemes.at(i_sch)==' ') {
1355 HTTPResponse::getAllowedSchemes().push_back(schemes.substr(j_sch, i_sch-j_sch));
1359 HTTPResponse::getAllowedSchemes().push_back(schemes.substr(j_sch, schemes.length()-j_sch));
1363 doExtensions(e, "global", log);
1364 if (conf.isEnabled(SPConfig::OutOfProcess))
1365 doExtensions(SHAR, "out of process", log);
1367 if (conf.isEnabled(SPConfig::InProcess))
1368 doExtensions(SHIRE, "in process", log);
1370 // Instantiate the ListenerService and SessionCache objects.
1371 if (conf.isEnabled(SPConfig::Listener)) {
1373 string plugtype(TCP_LISTENER_SERVICE);
1375 string plugtype(UNIX_LISTENER_SERVICE);
1377 child = XMLHelper::getFirstChildElement(e, UnixListener);
1379 plugtype = UNIX_LISTENER_SERVICE;
1381 child = XMLHelper::getFirstChildElement(e, TCPListener);
1383 plugtype = TCP_LISTENER_SERVICE;
1385 child = XMLHelper::getFirstChildElement(e, Listener);
1387 auto_ptr_char type(child->getAttributeNS(nullptr, _type));
1388 if (type.get() && *type.get())
1389 plugtype = type.get();
1394 log.info("building ListenerService of type %s...", plugtype.c_str());
1395 m_outer->m_listener = conf.ListenerServiceManager.newPlugin(plugtype.c_str(), child);
1399 if (m_outer->m_listener && conf.isEnabled(SPConfig::OutOfProcess) && !conf.isEnabled(SPConfig::InProcess)) {
1400 m_outer->m_listener->regListener("set::RelayState", const_cast<XMLConfig*>(m_outer));
1401 m_outer->m_listener->regListener("get::RelayState", const_cast<XMLConfig*>(m_outer));
1402 m_outer->m_listener->regListener("set::PostData", const_cast<XMLConfig*>(m_outer));
1403 m_outer->m_listener->regListener("get::PostData", const_cast<XMLConfig*>(m_outer));
1407 if (conf.isEnabled(SPConfig::Caching)) {
1409 if (conf.isEnabled(SPConfig::OutOfProcess)) {
1410 // First build any StorageServices.
1411 child = XMLHelper::getFirstChildElement(e, _StorageService);
1413 string id(XMLHelper::getAttrString(child, nullptr, _id));
1414 string t(XMLHelper::getAttrString(child, nullptr, _type));
1417 log.info("building StorageService (%s) of type %s...", id.c_str(), t.c_str());
1418 m_outer->m_storage[id] = xmlConf.StorageServiceManager.newPlugin(t.c_str(), child);
1420 catch (exception& ex) {
1421 log.crit("failed to instantiate StorageService (%s): %s", id.c_str(), ex.what());
1424 child = XMLHelper::getNextSiblingElement(child, _StorageService);
1427 if (m_outer->m_storage.empty()) {
1428 log.info("no StorageService plugin(s) installed, using (mem) in-memory instance");
1429 m_outer->m_storage["id"] = xmlConf.StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE, nullptr);
1433 StorageService* replaySS = nullptr;
1434 child = XMLHelper::getFirstChildElement(e, _ReplayCache);
1436 string ssid(XMLHelper::getAttrString(child, nullptr, _StorageService));
1437 if (!ssid.empty()) {
1438 if (m_outer->m_storage.count(ssid)) {
1439 log.info("building ReplayCache on top of StorageService (%s)...", ssid.c_str());
1440 replaySS = m_outer->m_storage[ssid];
1443 log.error("unable to locate StorageService (%s), using arbitrary instance for ReplayCache", ssid.c_str());
1444 replaySS = m_outer->m_storage.begin()->second;
1448 log.info("no StorageService specified for ReplayCache, using arbitrary instance");
1449 replaySS = m_outer->m_storage.begin()->second;
1453 log.info("no ReplayCache specified, using arbitrary StorageService instance");
1454 replaySS = m_outer->m_storage.begin()->second;
1456 xmlConf.setReplayCache(new ReplayCache(replaySS));
1459 child = XMLHelper::getFirstChildElement(e, _ArtifactMap);
1461 string ssid(XMLHelper::getAttrString(child, nullptr, _StorageService));
1462 if (!ssid.empty()) {
1463 if (m_outer->m_storage.count(ssid)) {
1464 log.info("building ArtifactMap on top of StorageService (%s)...", ssid.c_str());
1465 samlConf.setArtifactMap(new ArtifactMap(child, m_outer->m_storage[ssid]));
1468 log.error("unable to locate StorageService (%s), using in-memory ArtifactMap", ssid.c_str());
1469 samlConf.setArtifactMap(new ArtifactMap(child));
1473 log.info("no StorageService specified, using in-memory ArtifactMap");
1474 samlConf.setArtifactMap(new ArtifactMap(child));
1478 log.info("no ArtifactMap specified, building in-memory ArtifactMap...");
1479 samlConf.setArtifactMap(new ArtifactMap(child));
1481 } // end of out of process caching components
1484 child = XMLHelper::getFirstChildElement(e, _SessionCache);
1486 string t(XMLHelper::getAttrString(child, nullptr, _type));
1488 log.info("building SessionCache of type %s...", t.c_str());
1489 m_outer->m_sessionCache = conf.SessionCacheManager.newPlugin(t.c_str(), child);
1492 if (!m_outer->m_sessionCache) {
1493 log.info("no SessionCache specified, using StorageService-backed instance");
1494 m_outer->m_sessionCache = conf.SessionCacheManager.newPlugin(STORAGESERVICE_SESSION_CACHE, nullptr);
1497 } // end of first-time-only stuff
1499 // Back to the fully dynamic stuff...next up is the RequestMapper.
1500 if (conf.isEnabled(SPConfig::RequestMapping)) {
1501 if (child = XMLHelper::getFirstChildElement(e, _RequestMapper)) {
1502 string t(XMLHelper::getAttrString(child, nullptr, _type));
1504 log.info("building RequestMapper of type %s...", t.c_str());
1505 m_requestMapper = conf.RequestMapperManager.newPlugin(t.c_str(), child);
1508 if (!m_requestMapper) {
1509 log.info("no RequestMapper specified, using 'Native' plugin with empty/default map");
1510 child = e->getOwnerDocument()->createElementNS(nullptr, _RequestMapper);
1511 DOMElement* mapperDummy = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, RequestMap);
1512 mapperDummy->setAttributeNS(nullptr, applicationId, _default);
1513 child->appendChild(mapperDummy);
1514 m_requestMapper = conf.RequestMapperManager.newPlugin(NATIVE_REQUEST_MAPPER, child);
1519 // Load security policies.
1520 if (child = XMLHelper::getLastChildElement(e, SecurityPolicyProvider)) {
1521 string t(XMLHelper::getAttrString(child, nullptr, _type));
1523 log.info("building SecurityPolicyProvider of type %s...", t.c_str());
1524 m_policy = conf.SecurityPolicyProviderManager.newPlugin(t.c_str(), child);
1527 throw ConfigurationException("can't build SecurityPolicyProvider, no type specified");
1530 else if (child = XMLHelper::getLastChildElement(e, SecurityPolicies)) {
1531 // For backward compatibility, wrap in a plugin element.
1532 DOMElement* polwrapper = e->getOwnerDocument()->createElementNS(nullptr, SecurityPolicyProvider);
1533 polwrapper->appendChild(child);
1534 log.info("building SecurityPolicyProvider of type %s...", XML_SECURITYPOLICY_PROVIDER);
1535 m_policy = conf.SecurityPolicyProviderManager.newPlugin(XML_SECURITYPOLICY_PROVIDER, polwrapper);
1538 log.fatal("can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
1539 throw ConfigurationException("Can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
1543 #ifdef SHIBSP_XMLSEC_WHITELISTING
1544 vector<xstring>::const_iterator alg;
1545 if (!m_policy->getAlgorithmBlacklist().empty()) {
1546 for (alg = m_policy->getAlgorithmBlacklist().begin(); alg != m_policy->getAlgorithmBlacklist().end(); ++alg)
1547 XSECPlatformUtils::blacklistAlgorithm(alg->c_str());
1549 else if (!m_policy->getAlgorithmWhitelist().empty()) {
1550 for (alg = m_policy->getAlgorithmWhitelist().begin(); alg != m_policy->getAlgorithmWhitelist().end(); ++alg)
1551 XSECPlatformUtils::whitelistAlgorithm(alg->c_str());
1554 log.fatal("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists");
1555 throw ConfigurationException("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists.");
1559 // Process TransportOption elements.
1560 child = XMLHelper::getLastChildElement(e, TransportOption);
1562 if (child->hasChildNodes()) {
1563 string provider(XMLHelper::getAttrString(child, nullptr, _provider));
1564 string option(XMLHelper::getAttrString(child, nullptr, _option));
1565 auto_ptr_char value(child->getFirstChild()->getNodeValue());
1566 if (!provider.empty() && !option.empty() && value.get() && *value.get()) {
1567 m_transportOptions.push_back(make_pair(provider, make_pair(option, string(value.get()))));
1570 child = XMLHelper::getPreviousSiblingElement(child, TransportOption);
1574 // Load the default application.
1575 child = XMLHelper::getLastChildElement(e, ApplicationDefaults);
1577 log.fatal("can't build default Application object, missing conf:ApplicationDefaults element?");
1578 throw ConfigurationException("can't build default Application object, missing conf:ApplicationDefaults element?");
1580 XMLApplication* defapp = new XMLApplication(m_outer, child);
1581 m_appmap[defapp->getId()] = defapp;
1583 // Load any overrides.
1584 child = XMLHelper::getFirstChildElement(child, ApplicationOverride);
1586 auto_ptr<XMLApplication> iapp(new XMLApplication(m_outer, child, defapp));
1587 if (m_appmap.count(iapp->getId()))
1588 log.crit("found conf:ApplicationOverride element with duplicate id attribute (%s), skipping it", iapp->getId());
1590 const char* iappid=iapp->getId();
1591 m_appmap[iappid] = iapp.release();
1594 child = XMLHelper::getNextSiblingElement(child, ApplicationOverride);
1597 catch (exception&) {
1603 XMLConfigImpl::~XMLConfigImpl()
1608 void XMLConfigImpl::cleanup()
1610 for_each(m_appmap.begin(),m_appmap.end(),cleanup_pair<string,Application>());
1616 delete m_requestMapper;
1617 m_requestMapper = nullptr;
1619 m_document->release();
1620 m_document = nullptr;
1624 void XMLConfig::receive(DDF& in, ostream& out)
1626 if (!strcmp(in.name(), "get::RelayState")) {
1627 const char* id = in["id"].string();
1628 const char* key = in["key"].string();
1630 throw ListenerException("Required parameters missing for RelayState recovery.");
1633 StorageService* storage = getStorageService(id);
1635 if (storage->readString("RelayState",key,&relayState)>0) {
1636 if (in["clear"].integer())
1637 storage->deleteString("RelayState",key);
1641 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1642 "Storage-backed RelayState with invalid StorageService ID (%s)", id
1646 // Repack for return to caller.
1647 DDF ret=DDF(nullptr).unsafe_string(relayState.c_str());
1648 DDFJanitor jret(ret);
1651 else if (!strcmp(in.name(), "set::RelayState")) {
1652 const char* id = in["id"].string();
1653 const char* value = in["value"].string();
1655 throw ListenerException("Required parameters missing for RelayState creation.");
1658 StorageService* storage = getStorageService(id);
1660 SAMLConfig::getConfig().generateRandomBytes(rsKey,20);
1661 rsKey = SAMLArtifact::toHex(rsKey);
1662 storage->createString("RelayState", rsKey.c_str(), value, time(nullptr) + 600);
1665 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1666 "Storage-backed RelayState with invalid StorageService ID (%s)", id
1670 // Repack for return to caller.
1671 DDF ret=DDF(nullptr).string(rsKey.c_str());
1672 DDFJanitor jret(ret);
1675 else if (!strcmp(in.name(), "get::PostData")) {
1676 const char* id = in["id"].string();
1677 const char* key = in["key"].string();
1679 throw ListenerException("Required parameters missing for PostData recovery.");
1682 StorageService* storage = getStorageService(id);
1684 if (storage->readString("PostData",key,&postData) > 0) {
1685 storage->deleteString("PostData",key);
1689 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1690 "Storage-backed PostData with invalid StorageService ID (%s)", id
1693 // If the data's empty, we'll send nothing back.
1694 // If not, we don't need to round trip it, just send back the serialized DDF list.
1695 if (postData.empty()) {
1697 DDFJanitor jret(ret);
1704 else if (!strcmp(in.name(), "set::PostData")) {
1705 const char* id = in["id"].string();
1706 if (!id || !in["parameters"].islist())
1707 throw ListenerException("Required parameters missing for PostData creation.");
1710 StorageService* storage = getStorageService(id);
1712 SAMLConfig::getConfig().generateRandomBytes(rsKey,20);
1713 rsKey = SAMLArtifact::toHex(rsKey);
1714 ostringstream params;
1715 params << in["parameters"];
1716 storage->createString("PostData", rsKey.c_str(), params.str().c_str(), time(nullptr) + 600);
1719 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1720 "Storage-backed PostData with invalid StorageService ID (%s)", id
1724 // Repack for return to caller.
1725 DDF ret=DDF(nullptr).string(rsKey.c_str());
1726 DDFJanitor jret(ret);
1732 pair<bool,DOMElement*> XMLConfig::background_load()
1734 // Load from source using base class.
1735 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
1737 // If we own it, wrap it.
1738 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : nullptr);
1740 XMLConfigImpl* impl = new XMLConfigImpl(raw.second, (m_impl==nullptr), this, m_log);
1742 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
1743 impl->setDocument(docjanitor.release());
1745 // Perform the swap inside a lock.
1748 SharedLock locker(m_lock, false);
1752 return make_pair(false,(DOMElement*)nullptr);