2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * XMLServiceProvider.cpp
24 * XML-based SP configuration and mgmt.
28 #include "exceptions.h"
30 #include "AccessControl.h"
31 #include "Application.h"
32 #include "RequestMapper.h"
33 #include "ServiceProvider.h"
34 #include "SessionCache.h"
36 #include "SPRequest.h"
37 #include "binding/ProtocolProvider.h"
38 #include "handler/LogoutInitiator.h"
39 #include "handler/SessionInitiator.h"
40 #include "remoting/ListenerService.h"
41 #include "util/DOMPropertySet.h"
42 #include "util/SPConstants.h"
44 #if defined(XMLTOOLING_LOG4SHIB)
45 # include <log4shib/PropertyConfigurator.hh>
46 #elif defined(XMLTOOLING_LOG4CPP)
47 # include <log4cpp/PropertyConfigurator.hh>
49 # error "Supported logging library not available."
52 #include <boost/bind.hpp>
53 #include <boost/lexical_cast.hpp>
54 #include <boost/shared_ptr.hpp>
55 #include <boost/algorithm/string.hpp>
56 #include <boost/tuple/tuple.hpp>
57 #include <xercesc/util/XMLUniDefs.hpp>
58 #include <xercesc/util/XMLStringTokenizer.hpp>
59 #include <xmltooling/XMLToolingConfig.h>
60 #include <xmltooling/version.h>
61 #include <xmltooling/util/NDC.h>
62 #include <xmltooling/util/ReloadableXMLFile.h>
63 #include <xmltooling/util/TemplateEngine.h>
64 #include <xmltooling/util/Threads.h>
65 #include <xmltooling/util/XMLHelper.h>
68 # include "attribute/filtering/AttributeFilter.h"
69 # include "attribute/resolver/AttributeExtractor.h"
70 # include "attribute/resolver/AttributeResolver.h"
71 # include "security/PKIXTrustEngine.h"
72 # include "security/SecurityPolicyProvider.h"
73 # include <saml/exceptions.h>
74 # include <saml/version.h>
75 # include <saml/SAMLConfig.h>
76 # include <saml/binding/ArtifactMap.h>
77 # include <saml/binding/SAMLArtifact.h>
78 # include <saml/saml1/core/Assertions.h>
79 # include <saml/saml2/core/Assertions.h>
80 # include <saml/saml2/binding/SAML2ArtifactType0004.h>
81 # include <saml/saml2/metadata/EntityMatcher.h>
82 # include <saml/saml2/metadata/Metadata.h>
83 # include <saml/saml2/metadata/MetadataProvider.h>
84 # include <saml/util/SAMLConstants.h>
85 # include <xmltooling/security/ChainingTrustEngine.h>
86 # include <xmltooling/security/CredentialResolver.h>
87 # include <xmltooling/security/SecurityHelper.h>
88 # include <xmltooling/util/ReplayCache.h>
89 # include <xmltooling/util/StorageService.h>
90 # include <xsec/utils/XSECPlatformUtils.hpp>
91 using namespace opensaml::saml2;
92 using namespace opensaml::saml2p;
93 using namespace opensaml::saml2md;
94 using namespace opensaml;
96 # include "lite/SAMLConstants.h"
99 using namespace shibsp;
100 using namespace xmltooling;
101 using namespace boost;
105 # define min(a,b) (((a) < (b)) ? (a) : (b))
110 #if defined (_MSC_VER)
111 #pragma warning( push )
112 #pragma warning( disable : 4250 )
115 static vector<const Handler*> g_noHandlers;
117 // Application configuration wrapper
118 class SHIBSP_DLLLOCAL XMLApplication : public Application, public Remoted, public DOMPropertySet, public DOMNodeFilter
121 XMLApplication(const ServiceProvider*, const ProtocolProvider*, DOMElement*, const XMLApplication* base=nullptr);
124 const char* getHash() const {return m_hash.c_str();}
127 SAMLArtifact* generateSAML1Artifact(const EntityDescriptor* relyingParty) const {
128 throw ConfigurationException("No support for SAML 1.x artifact generation.");
130 SAML2Artifact* generateSAML2Artifact(const EntityDescriptor* relyingParty) const {
131 pair<bool,int> index = make_pair(false,0);
132 const PropertySet* props = getRelyingParty(relyingParty);
133 index = props->getInt("artifactEndpointIndex");
135 index = getArtifactEndpointIndex();
136 pair<bool,const char*> entityID = props->getString("entityID");
137 return new SAML2ArtifactType0004(
138 SecurityHelper::doHash("SHA1", entityID.second, strlen(entityID.second), false),
139 index.first ? index.second : 1
143 MetadataProvider* getMetadataProvider(bool required=true) const {
144 if (required && !m_base && !m_metadata)
145 throw ConfigurationException("No MetadataProvider available.");
146 return (!m_metadata && m_base) ? m_base->getMetadataProvider(required) : m_metadata.get();
148 TrustEngine* getTrustEngine(bool required=true) const {
149 if (required && !m_base && !m_trust)
150 throw ConfigurationException("No TrustEngine available.");
151 return (!m_trust && m_base) ? m_base->getTrustEngine(required) : m_trust.get();
153 AttributeExtractor* getAttributeExtractor() const {
154 return (!m_attrExtractor && m_base) ? m_base->getAttributeExtractor() : m_attrExtractor.get();
156 AttributeFilter* getAttributeFilter() const {
157 return (!m_attrFilter && m_base) ? m_base->getAttributeFilter() : m_attrFilter.get();
159 AttributeResolver* getAttributeResolver() const {
160 return (!m_attrResolver && m_base) ? m_base->getAttributeResolver() : m_attrResolver.get();
162 CredentialResolver* getCredentialResolver() const {
163 return (!m_credResolver && m_base) ? m_base->getCredentialResolver() : m_credResolver.get();
165 const PropertySet* getRelyingParty(const EntityDescriptor* provider) const;
166 const PropertySet* getRelyingParty(const XMLCh* entityID) const;
168 const vector<const XMLCh*>* getAudiences() const {
169 return (m_audiences.empty() && m_base) ? m_base->getAudiences() : &m_audiences;
172 string getNotificationURL(const char* resource, bool front, unsigned int index) const;
174 const vector<string>& getRemoteUserAttributeIds() const {
175 return (m_remoteUsers.empty() && m_base) ? m_base->getRemoteUserAttributeIds() : m_remoteUsers;
178 void clearHeader(SPRequest& request, const char* rawname, const char* cginame) const;
179 void setHeader(SPRequest& request, const char* name, const char* value) const;
180 string getSecureHeader(const SPRequest& request, const char* name) const;
182 const SessionInitiator* getDefaultSessionInitiator() const;
183 const SessionInitiator* getSessionInitiatorById(const char* id) const;
184 const Handler* getDefaultAssertionConsumerService() const;
185 const Handler* getAssertionConsumerServiceByIndex(unsigned short index) const;
186 const Handler* getAssertionConsumerServiceByProtocol(const XMLCh* protocol, const char* binding=nullptr) const;
187 const vector<const Handler*>& getAssertionConsumerServicesByBinding(const XMLCh* binding) const;
188 const Handler* getHandler(const char* path) const;
189 void getHandlers(vector<const Handler*>& handlers) const;
190 void limitRedirect(const GenericRequest& request, const char* url) const;
192 void receive(DDF& in, ostream& out) {
193 // Only current function is to return the headers to clear.
195 DDF ret=DDF(nullptr).list();
196 DDFJanitor jret(ret);
197 for (vector< pair<string,string> >::const_iterator i = m_unsetHeaders.begin(); i!=m_unsetHeaders.end(); ++i) {
198 header = DDF(i->first.c_str()).string(i->second.c_str());
204 // Provides filter to exclude special config elements.
205 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
210 acceptNode(const DOMNode* node) const;
213 template <class T> T* doChainedPlugins(
214 PluginManager<T,string,const DOMElement*>& pluginMgr,
215 const char* pluginType,
216 const char* chainingType,
217 const XMLCh* localName,
220 const char* dummyType=nullptr
222 void doAttributeInfo();
223 void doHandlers(const ProtocolProvider*, const DOMElement*, Category&);
224 void doSSO(const ProtocolProvider&, set<string>&, DOMElement*, Category&);
225 void doLogout(const ProtocolProvider&, set<string>&, DOMElement*, Category&);
226 void doNameIDMgmt(const ProtocolProvider&, set<string>&, DOMElement*, Category&);
227 void doArtifactResolution(const ProtocolProvider&, const char*, DOMElement*, Category&);
228 const XMLApplication* m_base;
230 std::pair<std::string,std::string> m_attributePrefix;
232 void doAttributePlugins(DOMElement*, Category&);
233 scoped_ptr<MetadataProvider> m_metadata;
234 scoped_ptr<TrustEngine> m_trust;
235 scoped_ptr<AttributeExtractor> m_attrExtractor;
236 scoped_ptr<AttributeFilter> m_attrFilter;
237 scoped_ptr<AttributeResolver> m_attrResolver;
238 scoped_ptr<CredentialResolver> m_credResolver;
239 vector<const XMLCh*> m_audiences;
241 // RelyingParty properties
242 map< xstring,boost::shared_ptr<PropertySet> > m_partyMap; // name-based matching
243 vector< pair< boost::shared_ptr<EntityMatcher>,boost::shared_ptr<PropertySet> > > m_partyVec; // plugin-based matching
245 vector<string> m_remoteUsers,m_frontLogout,m_backLogout;
247 // manage handler objects
248 vector< boost::shared_ptr<Handler> > m_handlers;
250 // maps location (path info) to applicable handlers
251 map<string,const Handler*> m_handlerMap;
253 // maps unique indexes to consumer services
254 map<unsigned int,const Handler*> m_acsIndexMap;
256 // pointer to default consumer service
257 const Handler* m_acsDefault;
259 // maps binding strings to supporting consumer service(s)
260 typedef map< xstring,vector<const Handler*> > ACSBindingMap;
261 ACSBindingMap m_acsBindingMap;
263 // maps protocol strings to supporting consumer service(s)
264 typedef map< xstring,vector<const Handler*> > ACSProtocolMap;
265 ACSProtocolMap m_acsProtocolMap;
267 // pointer to default session initiator
268 const SessionInitiator* m_sessionInitDefault;
270 // maps unique ID strings to session initiators
271 map<string,const SessionInitiator*> m_sessionInitMap;
273 // pointer to default artifact resolution service
274 const Handler* m_artifactResolutionDefault;
276 pair<bool,int> getArtifactEndpointIndex() const {
277 if (m_artifactResolutionDefault) return m_artifactResolutionDefault->getInt("index");
278 return m_base ? m_base->getArtifactEndpointIndex() : make_pair(false,0);
282 REDIRECT_LIMIT_INHERIT,
284 REDIRECT_LIMIT_EXACT,
286 REDIRECT_LIMIT_WHITELIST,
287 REDIRECT_LIMIT_EXACT_WHITELIST,
288 REDIRECT_LIMIT_HOST_WHITELIST
290 vector<string> m_redirectWhitelist;
293 // Top-level configuration implementation
294 class SHIBSP_DLLLOCAL XMLConfig;
295 class SHIBSP_DLLLOCAL XMLConfigImpl : public DOMPropertySet, public DOMNodeFilter
298 XMLConfigImpl(const DOMElement* e, bool first, XMLConfig* outer, Category& log);
301 m_document->release();
305 scoped_ptr<TransactionLog> m_tranLog;
306 scoped_ptr<SecurityPolicyProvider> m_policy;
307 vector< tuple<string,string,string> > m_transportOptions;
309 scoped_ptr<RequestMapper> m_requestMapper;
310 map< string,boost::shared_ptr<Application> > m_appmap;
312 // Provides filter to exclude special config elements.
313 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
318 acceptNode(const DOMNode* node) const;
320 void setDocument(DOMDocument* doc) {
325 void doExtensions(const DOMElement*, const char*, Category&);
326 void doListener(const DOMElement*, XMLConfig*, Category&);
327 void doCaching(const DOMElement*, XMLConfig*, Category&);
329 DOMDocument* m_document;
332 class SHIBSP_DLLLOCAL XMLConfig : public ServiceProvider, public ReloadableXMLFile
338 XMLConfig(const DOMElement* e) : ReloadableXMLFile(e, Category::getInstance(SHIBSP_LOGCAT".Config")) {}
347 SAMLConfig::getConfig().setArtifactMap(nullptr);
348 XMLToolingConfig::getConfig().setReplayCache(nullptr);
355 ReloadableXMLFile::lock();
356 if (m_impl->m_policy)
357 m_impl->m_policy->lock();
361 if (m_impl->m_policy)
362 m_impl->m_policy->unlock();
363 ReloadableXMLFile::unlock();
368 const PropertySet* getParent() const { return m_impl->getParent(); }
369 void setParent(const PropertySet* parent) {return m_impl->setParent(parent);}
370 pair<bool,bool> getBool(const char* name, const char* ns=nullptr) const {return m_impl->getBool(name,ns);}
371 pair<bool,const char*> getString(const char* name, const char* ns=nullptr) const {return m_impl->getString(name,ns);}
372 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=nullptr) const {return m_impl->getXMLString(name,ns);}
373 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=nullptr) const {return m_impl->getUnsignedInt(name,ns);}
374 pair<bool,int> getInt(const char* name, const char* ns=nullptr) const {return m_impl->getInt(name,ns);}
375 void getAll(map<string,const char*>& properties) const {return m_impl->getAll(properties);}
376 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const {return m_impl->getPropertySet(name,ns);}
377 const DOMElement* getElement() const {return m_impl->getElement();}
382 void receive(DDF& in, ostream& out);
384 TransactionLog* getTransactionLog() const {
385 if (m_impl->m_tranLog)
386 return m_impl->m_tranLog.get();
387 throw ConfigurationException("No TransactionLog available.");
390 StorageService* getStorageService(const char* id) const {
392 map< string,boost::shared_ptr<StorageService> >::const_iterator i = m_storage.find(id);
393 if (i != m_storage.end())
394 return i->second.get();
396 else if (!m_storage.empty())
397 return m_storage.begin()->second.get();
402 ListenerService* getListenerService(bool required=true) const {
403 if (required && !m_listener)
404 throw ConfigurationException("No ListenerService available.");
405 return m_listener.get();
408 SessionCache* getSessionCache(bool required=true) const {
409 if (required && !m_sessionCache)
410 throw ConfigurationException("No SessionCache available.");
411 return m_sessionCache.get();
414 RequestMapper* getRequestMapper(bool required=true) const {
415 if (required && !m_impl->m_requestMapper)
416 throw ConfigurationException("No RequestMapper available.");
417 return m_impl->m_requestMapper.get();
420 const Application* getApplication(const char* applicationId) const {
421 map< string,boost::shared_ptr<Application> >::const_iterator i = m_impl->m_appmap.find(applicationId ? applicationId : "default");
422 return (i != m_impl->m_appmap.end()) ? i->second.get() : nullptr;
426 SecurityPolicyProvider* getSecurityPolicyProvider(bool required=true) const {
427 if (required && !m_impl->m_policy)
428 throw ConfigurationException("No SecurityPolicyProvider available.");
429 return m_impl->m_policy.get();
432 const PropertySet* getPolicySettings(const char* id) const {
433 return getSecurityPolicyProvider()->getPolicySettings(id);
436 const vector<const SecurityPolicyRule*>& getPolicyRules(const char* id) const {
437 return getSecurityPolicyProvider()->getPolicyRules(id);
440 bool setTransportOptions(SOAPTransport& transport) const {
442 for (vector< tuple<string,string,string> >::const_iterator opt = m_impl->m_transportOptions.begin();
443 opt != m_impl->m_transportOptions.end(); ++opt) {
444 if (!transport.setProviderOption(opt->get<0>().c_str(), opt->get<1>().c_str(), opt->get<2>().c_str())) {
445 m_log.error("failed to set SOAPTransport option (%s)", opt->get<1>().c_str());
454 pair<bool,DOMElement*> background_load();
457 friend class XMLConfigImpl;
458 // The order of these members actually matters. If we want to rely on auto-destruction, then
459 // anything dependent on anything else has to come later in the object so it will pop first.
460 // Storage is the lowest, then remoting, then the cache, and finally the rest.
462 map< string,boost::shared_ptr<StorageService> > m_storage;
464 scoped_ptr<ListenerService> m_listener;
465 scoped_ptr<SessionCache> m_sessionCache;
466 scoped_ptr<XMLConfigImpl> m_impl;
469 #if defined (_MSC_VER)
470 #pragma warning( pop )
473 static const XMLCh applicationId[] = UNICODE_LITERAL_13(a,p,p,l,i,c,a,t,i,o,n,I,d);
474 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);
475 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);
476 static const XMLCh _ArtifactMap[] = UNICODE_LITERAL_11(A,r,t,i,f,a,c,t,M,a,p);
477 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);
478 static const XMLCh _AttributeFilter[] = UNICODE_LITERAL_15(A,t,t,r,i,b,u,t,e,F,i,l,t,e,r);
479 static const XMLCh _AttributeResolver[] = UNICODE_LITERAL_17(A,t,t,r,i,b,u,t,e,R,e,s,o,l,v,e,r);
480 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);
481 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);
482 static const XMLCh _Audience[] = UNICODE_LITERAL_8(A,u,d,i,e,n,c,e);
483 static const XMLCh Binding[] = UNICODE_LITERAL_7(B,i,n,d,i,n,g);
484 static const XMLCh Channel[]= UNICODE_LITERAL_7(C,h,a,n,n,e,l);
485 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);
486 static const XMLCh _default[] = UNICODE_LITERAL_7(d,e,f,a,u,l,t);
487 static const XMLCh _Extensions[] = UNICODE_LITERAL_10(E,x,t,e,n,s,i,o,n,s);
488 static const XMLCh _fatal[] = UNICODE_LITERAL_5(f,a,t,a,l);
489 static const XMLCh _Handler[] = UNICODE_LITERAL_7(H,a,n,d,l,e,r);
490 static const XMLCh _id[] = UNICODE_LITERAL_2(i,d);
491 static const XMLCh _index[] = UNICODE_LITERAL_5(i,n,d,e,x);
492 static const XMLCh InProcess[] = UNICODE_LITERAL_9(I,n,P,r,o,c,e,s,s);
493 static const XMLCh Library[] = UNICODE_LITERAL_7(L,i,b,r,a,r,y);
494 static const XMLCh Listener[] = UNICODE_LITERAL_8(L,i,s,t,e,n,e,r);
495 static const XMLCh Location[] = UNICODE_LITERAL_8(L,o,c,a,t,i,o,n);
496 static const XMLCh logger[] = UNICODE_LITERAL_6(l,o,g,g,e,r);
497 static const XMLCh Logout[] = UNICODE_LITERAL_6(L,o,g,o,u,t);
498 static const XMLCh _LogoutInitiator[] = UNICODE_LITERAL_15(L,o,g,o,u,t,I,n,i,t,i,a,t,o,r);
499 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);
500 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
501 static const XMLCh NameIDMgmt[] = UNICODE_LITERAL_10(N,a,m,e,I,D,M,g,m,t);
502 static const XMLCh Notify[] = UNICODE_LITERAL_6(N,o,t,i,f,y);
503 static const XMLCh _option[] = UNICODE_LITERAL_6(o,p,t,i,o,n);
504 static const XMLCh OutOfProcess[] = UNICODE_LITERAL_12(O,u,t,O,f,P,r,o,c,e,s,s);
505 static const XMLCh _path[] = UNICODE_LITERAL_4(p,a,t,h);
506 static const XMLCh _policyId[] = UNICODE_LITERAL_8(p,o,l,i,c,y,I,d);
507 static const XMLCh _ProtocolProvider[] = UNICODE_LITERAL_16(P,r,o,t,o,c,o,l,P,r,o,v,i,d,e,r);
508 static const XMLCh _provider[] = UNICODE_LITERAL_8(p,r,o,v,i,d,e,r);
509 static const XMLCh RelyingParty[] = UNICODE_LITERAL_12(R,e,l,y,i,n,g,P,a,r,t,y);
510 static const XMLCh _ReplayCache[] = UNICODE_LITERAL_11(R,e,p,l,a,y,C,a,c,h,e);
511 static const XMLCh _RequestMapper[] = UNICODE_LITERAL_13(R,e,q,u,e,s,t,M,a,p,p,e,r);
512 static const XMLCh RequestMap[] = UNICODE_LITERAL_10(R,e,q,u,e,s,t,M,a,p);
513 static const XMLCh SecurityPolicies[] = UNICODE_LITERAL_16(S,e,c,u,r,i,t,y,P,o,l,i,c,i,e,s);
514 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);
515 static const XMLCh _SessionCache[] = UNICODE_LITERAL_12(S,e,s,s,i,o,n,C,a,c,h,e);
516 static const XMLCh _SessionInitiator[] = UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
517 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);
518 static const XMLCh Site[] = UNICODE_LITERAL_4(S,i,t,e);
519 static const XMLCh SSO[] = UNICODE_LITERAL_3(S,S,O);
520 static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
521 static const XMLCh TCPListener[] = UNICODE_LITERAL_11(T,C,P,L,i,s,t,e,n,e,r);
522 static const XMLCh tranLogFiller[] = UNICODE_LITERAL_13(t,r,a,n,L,o,g,F,i,l,l,e,r);
523 static const XMLCh tranLogFormat[] = UNICODE_LITERAL_13(t,r,a,n,L,o,g,F,o,r,m,a,t);
524 static const XMLCh TransportOption[] = UNICODE_LITERAL_15(T,r,a,n,s,p,o,r,t,O,p,t,i,o,n);
525 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
526 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
527 static const XMLCh UnixListener[] = UNICODE_LITERAL_12(U,n,i,x,L,i,s,t,e,n,e,r);
531 ServiceProvider* XMLServiceProviderFactory(const DOMElement* const & e)
533 return new XMLConfig(e);
537 XMLApplication::XMLApplication(
538 const ServiceProvider* sp,
539 const ProtocolProvider* pp,
541 const XMLApplication* base
542 ) : Application(sp), m_base(base), m_acsDefault(nullptr), m_sessionInitDefault(nullptr), m_artifactResolutionDefault(nullptr)
545 xmltooling::NDC ndc("XMLApplication");
547 Category& log = Category::getInstance(SHIBSP_LOGCAT".Application");
549 // First load any property sets.
550 map<string,string> remapper;
551 remapper["relayStateLimit"] = "redirectLimit";
552 remapper["relayStateWhitelist"] = "redirectWhitelist";
553 load(e, nullptr, this, &remapper);
555 // Process redirect limit policy. Do this before assigning the parent pointer
556 // to ensure we get only our Sessions element.
557 const PropertySet* sessionProps = getPropertySet("Sessions");
559 pair<bool,const char*> prop = sessionProps->getString("redirectLimit");
561 if (!strcmp(prop.second, "none"))
562 m_redirectLimit = REDIRECT_LIMIT_NONE;
563 else if (!strcmp(prop.second, "exact"))
564 m_redirectLimit = REDIRECT_LIMIT_EXACT;
565 else if (!strcmp(prop.second, "host"))
566 m_redirectLimit = REDIRECT_LIMIT_HOST;
568 if (!strcmp(prop.second, "exact+whitelist"))
569 m_redirectLimit = REDIRECT_LIMIT_EXACT_WHITELIST;
570 else if (!strcmp(prop.second, "host+whitelist"))
571 m_redirectLimit = REDIRECT_LIMIT_HOST_WHITELIST;
572 else if (!strcmp(prop.second, "whitelist"))
573 m_redirectLimit = REDIRECT_LIMIT_WHITELIST;
575 throw ConfigurationException("Unrecognized redirectLimit setting ($1)", params(1, prop.second));
576 prop = sessionProps->getString("redirectWhitelist");
578 string dup(prop.second);
579 split(m_redirectWhitelist, dup, is_space(), algorithm::token_compress_on);
584 m_redirectLimit = base ? REDIRECT_LIMIT_INHERIT : REDIRECT_LIMIT_NONE;
587 // Audit some additional settings for logging purposes.
588 prop = sessionProps->getString("cookieProps");
590 log.warn("empty/missing cookieProps setting, set to \"https\" for SSL/TLS-only usage");
592 else if (!strcmp(prop.second, "http")) {
593 log.warn("insecure cookieProps setting, set to \"https\" for SSL/TLS-only usage");
595 else if (strcmp(prop.second, "https")) {
596 if (!strstr(prop.second, ";secure") && !strstr(prop.second, "; secure"))
597 log.warn("custom cookieProps setting should include \"; secure\" for SSL/TLS-only usage");
598 else if (!strstr(prop.second, ";HttpOnly") && !strstr(prop.second, "; HttpOnly"))
599 log.warn("custom cookieProps setting should include \"; HttpOnly\", site is vulnerable to client-side cookie theft");
602 pair<bool,bool> handlerSSL = sessionProps->getBool("handlerSSL");
603 if (handlerSSL.first && !handlerSSL.second)
604 log.warn("handlerSSL should be enabled for SSL/TLS-enabled web sites");
607 m_redirectLimit = base ? REDIRECT_LIMIT_INHERIT : REDIRECT_LIMIT_NONE;
614 SPConfig& conf=SPConfig::getConfig();
616 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
619 // This used to be an actual hash, but now it's just a hex-encode to avoid xmlsec dependency.
620 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
621 string tohash=getId();
622 tohash+=getString("entityID").second;
623 for (const char* ch = tohash.c_str(); *ch; ++ch) {
624 m_hash += (DIGITS[((unsigned char)(0xF0 & *ch)) >> 4 ]);
625 m_hash += (DIGITS[0x0F & *ch]);
630 if (conf.isEnabled(SPConfig::Handlers))
631 doHandlers(pp, e, log);
634 DOMNodeList* nlist = e->getElementsByTagNameNS(shibspconstants::SHIB2SPCONFIG_NS, Notify);
635 for (XMLSize_t i = 0; nlist && i < nlist->getLength(); ++i) {
636 if (nlist->item(i)->getParentNode()->isSameNode(e)) {
637 const XMLCh* channel = static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(nullptr, Channel);
638 string loc(XMLHelper::getAttrString(static_cast<DOMElement*>(nlist->item(i)), nullptr, Location));
640 if (channel && *channel == chLatin_f)
641 m_frontLogout.push_back(loc);
643 m_backLogout.push_back(loc);
649 nlist = e->getElementsByTagNameNS(samlconstants::SAML20_NS, Audience::LOCAL_NAME);
650 if (nlist && nlist->getLength()) {
651 log.warn("use of <saml:Audience> elements outside of a Security Policy Rule is deprecated");
652 for (XMLSize_t i = 0; i < nlist->getLength(); ++i)
653 if (nlist->item(i)->getParentNode()->isSameNode(e) && nlist->item(i)->hasChildNodes())
654 m_audiences.push_back(nlist->item(i)->getFirstChild()->getNodeValue());
657 if (conf.isEnabled(SPConfig::Metadata)) {
660 SAMLConfig::getConfig().MetadataProviderManager, "MetadataProvider", CHAINING_METADATA_PROVIDER, _MetadataProvider, e, log
667 log.warn("no MetadataProvider available, configure at least one for standard SSO usage");
669 catch (std::exception& ex) {
670 log.crit("error initializing MetadataProvider: %s", ex.what());
674 if (conf.isEnabled(SPConfig::Trust)) {
675 m_trust.reset(doChainedPlugins(xmlConf.TrustEngineManager, "TrustEngine", CHAINING_TRUSTENGINE, _TrustEngine, e, log));
676 if (!m_trust && !m_base) {
678 "no TrustEngine specified or installed, using default chain {%s, %s}",
679 EXPLICIT_KEY_TRUSTENGINE, SHIBBOLETH_PKIX_TRUSTENGINE
681 m_trust.reset(xmlConf.TrustEngineManager.newPlugin(CHAINING_TRUSTENGINE, nullptr));
682 ChainingTrustEngine* trustchain = dynamic_cast<ChainingTrustEngine*>(m_trust.get());
684 trustchain->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(EXPLICIT_KEY_TRUSTENGINE, nullptr));
685 trustchain->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(SHIBBOLETH_PKIX_TRUSTENGINE, nullptr));
690 if (conf.isEnabled(SPConfig::AttributeResolution)) {
691 doAttributePlugins(e, log);
694 if (conf.isEnabled(SPConfig::Credentials)) {
695 m_credResolver.reset(
696 doChainedPlugins(xmlConf.CredentialResolverManager, "CredentialResolver", CHAINING_CREDENTIAL_RESOLVER, _CredentialResolver, e, log)
700 // Finally, load relying parties.
701 const DOMElement* child = XMLHelper::getFirstChildElement(e, RelyingParty);
703 if (child->hasAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)) {
704 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
705 rp->load(child, nullptr, this);
707 m_partyMap[child->getAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)] = rp;
709 else if (child->hasAttributeNS(nullptr, _type)) {
710 string emtype(XMLHelper::getAttrString(child, nullptr, _type));
711 boost::shared_ptr<EntityMatcher> em(SAMLConfig::getConfig().EntityMatcherManager.newPlugin(emtype, child));
712 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
713 rp->load(child, nullptr, this);
715 m_partyVec.push_back(make_pair(em, rp));
717 child = XMLHelper::getNextSiblingElement(child, RelyingParty);
719 if (base && m_partyMap.empty() && m_partyVec.empty() && (!base->m_partyMap.empty() || !base->m_partyVec.empty())) {
720 // For inheritance of RPs to work, we have to pull them in to the override by cloning the DOM.
721 child = XMLHelper::getFirstChildElement(base->getElement(), RelyingParty);
723 if (child->hasAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)) {
724 DOMElement* rpclone = static_cast<DOMElement*>(child->cloneNode(true));
725 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
726 rp->load(rpclone, nullptr, this);
728 m_partyMap[rpclone->getAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)] = rp;
730 else if (child->hasAttributeNS(nullptr, _type)) {
731 DOMElement* rpclone = static_cast<DOMElement*>(child->cloneNode(true));
732 string emtype(XMLHelper::getAttrString(rpclone, nullptr, _type));
733 boost::shared_ptr<EntityMatcher> em(SAMLConfig::getConfig().EntityMatcherManager.newPlugin(emtype, rpclone));
734 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
735 rp->load(rpclone, nullptr, this);
737 m_partyVec.push_back(make_pair(em, rp));
739 child = XMLHelper::getNextSiblingElement(child, RelyingParty);
744 // Out of process only, we register a listener endpoint.
745 if (!conf.isEnabled(SPConfig::InProcess)) {
746 ListenerService* listener = sp->getListenerService(false);
748 string addr=string(getId()) + "::getHeaders::Application";
749 listener->regListener(addr.c_str(), this);
752 log.info("no ListenerService available, Application remoting disabled");
757 XMLApplication::~XMLApplication()
759 ListenerService* listener=getServiceProvider().getListenerService(false);
760 if (listener && SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess) && !SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
761 string addr=string(getId()) + "::getHeaders::Application";
762 listener->unregListener(addr.c_str(), this);
766 template <class T> T* XMLApplication::doChainedPlugins(
767 PluginManager<T,string,const DOMElement*>& pluginMgr,
768 const char* pluginType,
769 const char* chainingType,
770 const XMLCh* localName,
773 const char* dummyType
777 DOMElement* child = XMLHelper::getFirstChildElement(e, localName);
779 // Check for multiple.
780 if (XMLHelper::getNextSiblingElement(child, localName)) {
781 log.info("multiple %s plugins, wrapping in a chain", pluginType);
782 DOMElement* chain = child->getOwnerDocument()->createElementNS(nullptr, localName);
784 chain->appendChild(child);
785 child = XMLHelper::getFirstChildElement(e, localName);
789 e->appendChild(chain);
792 // Only a single one.
793 t = XMLHelper::getAttrString(child, nullptr, _type);
798 log.info("building %s of type %s...", pluginType, t.c_str());
799 return pluginMgr.newPlugin(t.c_str(), child);
802 throw ConfigurationException("$1 element had no type attribute.", params(1, pluginType));
805 catch (std::exception& ex) {
806 log.crit("error building %s: %s", pluginType, ex.what());
808 // Install a dummy version as a safety valve.
809 log.crit("installing safe %s in place of failed version", pluginType);
810 return pluginMgr.newPlugin(dummyType, nullptr);
818 void XMLApplication::doAttributeInfo()
820 // Populate prefix pair.
821 m_attributePrefix.second = "HTTP_";
822 pair<bool,const char*> prefix = getString("attributePrefix");
824 m_attributePrefix.first = prefix.second;
825 const char* pch = prefix.second;
827 m_attributePrefix.second += (isalnum(*pch) ? toupper(*pch) : '_');
832 pair<bool,const char*> attributes = getString("REMOTE_USER");
833 if (attributes.first) {
834 string dup(attributes.second);
835 split(m_remoteUsers, dup, is_space(), algorithm::token_compress_on);
838 // Load attribute ID lists for REMOTE_USER and header clearing.
839 if (SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
840 attributes = getString("unsetHeaders");
841 if (attributes.first) {
842 string transformedprefix(m_attributePrefix.second);
844 prefix = getString("metadataAttributePrefix");
848 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
853 string dup(attributes.second);
854 vector<string> headerNames;
855 split(headerNames, dup, is_space(), algorithm::token_compress_on);
856 for (vector<string>::const_iterator h = headerNames.begin(); h != headerNames.end(); ++h) {
858 const char* pch = h->c_str();
860 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
863 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + *h, m_attributePrefix.second + transformed));
865 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + *h, transformedprefix + transformed));
867 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
872 void XMLApplication::doHandlers(const ProtocolProvider* pp, const DOMElement* e, Category& log)
874 SPConfig& conf = SPConfig::getConfig();
876 const PropertySet* sessions = getPropertySet("Sessions");
878 // Process assertion export handler.
879 pair<bool,const char*> location = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,nullptr);
880 if (location.first) {
882 DOMElement* exportElement = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _Handler);
883 exportElement->setAttributeNS(nullptr,Location,sessions->getXMLString("exportLocation").second);
884 pair<bool,const XMLCh*> exportACL = sessions->getXMLString("exportACL");
885 if (exportACL.first) {
886 static const XMLCh _acl[] = UNICODE_LITERAL_9(e,x,p,o,r,t,A,C,L);
887 exportElement->setAttributeNS(nullptr,_acl,exportACL.second);
889 boost::shared_ptr<Handler> exportHandler(
890 conf.HandlerManager.newPlugin(samlconstants::SAML20_BINDING_URI, pair<const DOMElement*,const char*>(exportElement, getId()))
892 m_handlers.push_back(exportHandler);
894 // Insert into location map. If it contains the handlerURL, we skip past that part.
895 const char* hurl = sessions->getString("handlerURL").second;
897 hurl = "/Shibboleth.sso";
898 const char* pch = strstr(location.second, hurl);
900 location.second = pch + strlen(hurl);
901 if (*location.second == '/')
902 m_handlerMap[location.second] = exportHandler.get();
904 m_handlerMap[string("/") + location.second] = exportHandler.get();
906 catch (std::exception& ex) {
907 log.error("caught exception installing assertion lookup handler: %s", ex.what());
911 // Look for "shorthand" elements first.
912 set<string> protocols;
913 DOMElement* child = sessions ? XMLHelper::getFirstChildElement(sessions->getElement()) : nullptr;
915 if (XMLHelper::isNodeNamed(child, shibspconstants::SHIB2SPCONFIG_NS, SSO)) {
917 doSSO(*pp, protocols, child, log);
919 log.error("no ProtocolProvider, SSO auto-configure unsupported");
921 else if (XMLHelper::isNodeNamed(child, shibspconstants::SHIB2SPCONFIG_NS, Logout)) {
923 doLogout(*pp, protocols, child, log);
925 log.error("no ProtocolProvider, Logout auto-configure unsupported");
927 else if (XMLHelper::isNodeNamed(child, shibspconstants::SHIB2SPCONFIG_NS, NameIDMgmt)) {
929 doNameIDMgmt(*pp, protocols, child, log);
931 log.error("no ProtocolProvider, NameIDMgmt auto-configure unsupported");
934 break; // drop into next while loop
936 child = XMLHelper::getNextSiblingElement(child);
939 // Process other handlers.
940 bool hardACS=false, hardSessionInit=false, hardArt=false;
942 if (!child->hasAttributeNS(nullptr, Location)) {
943 auto_ptr_char hclass(child->getLocalName());
944 log.error("%s handler with no Location property cannot be processed", hclass.get());
945 child = XMLHelper::getNextSiblingElement(child);
949 boost::shared_ptr<Handler> handler;
950 if (XMLString::equals(child->getLocalName(), _AssertionConsumerService)) {
951 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
952 if (bindprop.empty()) {
953 log.error("AssertionConsumerService element has no Binding attribute, skipping it...");
954 child = XMLHelper::getNextSiblingElement(child);
957 handler.reset(conf.AssertionConsumerServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
958 // Map by binding and protocol (may be > 1 per protocol and binding)
959 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler.get());
960 const XMLCh* protfamily = handler->getProtocolFamily();
962 m_acsProtocolMap[protfamily].push_back(handler.get());
963 m_acsIndexMap[handler->getUnsignedInt("index").second] = handler.get();
966 pair<bool,bool> defprop = handler->getBool("isDefault");
968 if (defprop.second) {
970 m_acsDefault = handler.get();
973 else if (!m_acsDefault)
974 m_acsDefault = handler.get();
977 else if (XMLString::equals(child->getLocalName(), _SessionInitiator)) {
978 string t(XMLHelper::getAttrString(child, nullptr, _type));
980 log.error("SessionInitiator element has no type attribute, skipping it...");
981 child = XMLHelper::getNextSiblingElement(child);
984 boost::shared_ptr<SessionInitiator> sihandler(
985 conf.SessionInitiatorManager.newPlugin(t.c_str(), pair<const DOMElement*,const char*>(child, getId()))
988 pair<bool,const char*> si_id = handler->getString("id");
989 if (si_id.first && si_id.second)
990 m_sessionInitMap[si_id.second] = sihandler.get();
991 if (!hardSessionInit) {
992 pair<bool,bool> defprop = handler->getBool("isDefault");
994 if (defprop.second) {
995 hardSessionInit = true;
996 m_sessionInitDefault = sihandler.get();
999 else if (!m_sessionInitDefault) {
1000 m_sessionInitDefault = sihandler.get();
1004 else if (XMLString::equals(child->getLocalName(), _LogoutInitiator)) {
1005 string t(XMLHelper::getAttrString(child, nullptr, _type));
1007 log.error("LogoutInitiator element has no type attribute, skipping it...");
1008 child = XMLHelper::getNextSiblingElement(child);
1011 handler.reset(conf.LogoutInitiatorManager.newPlugin(t.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1013 else if (XMLString::equals(child->getLocalName(), _ArtifactResolutionService)) {
1014 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
1015 if (bindprop.empty()) {
1016 log.error("ArtifactResolutionService element has no Binding attribute, skipping it...");
1017 child = XMLHelper::getNextSiblingElement(child);
1020 handler.reset(conf.ArtifactResolutionServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1023 pair<bool,bool> defprop = handler->getBool("isDefault");
1024 if (defprop.first) {
1025 if (defprop.second) {
1027 m_artifactResolutionDefault = handler.get();
1030 else if (!m_artifactResolutionDefault)
1031 m_artifactResolutionDefault = handler.get();
1034 else if (XMLString::equals(child->getLocalName(), _SingleLogoutService)) {
1035 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
1036 if (bindprop.empty()) {
1037 log.error("SingleLogoutService element has no Binding attribute, skipping it...");
1038 child = XMLHelper::getNextSiblingElement(child);
1041 handler.reset(conf.SingleLogoutServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1043 else if (XMLString::equals(child->getLocalName(), _ManageNameIDService)) {
1044 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
1045 if (bindprop.empty()) {
1046 log.error("ManageNameIDService element has no Binding attribute, skipping it...");
1047 child = XMLHelper::getNextSiblingElement(child);
1050 handler.reset(conf.ManageNameIDServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1053 string t(XMLHelper::getAttrString(child, nullptr, _type));
1055 log.error("Handler element has no type attribute, skipping it...");
1056 child = XMLHelper::getNextSiblingElement(child);
1059 handler.reset(conf.HandlerManager.newPlugin(t.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1062 m_handlers.push_back(handler);
1064 // Insert into location map.
1065 location = handler->getString("Location");
1066 if (location.first && *location.second == '/')
1067 m_handlerMap[location.second] = handler.get();
1068 else if (location.first)
1069 m_handlerMap[string("/") + location.second] = handler.get();
1071 catch (std::exception& ex) {
1072 log.error("caught exception processing handler element: %s", ex.what());
1075 child = XMLHelper::getNextSiblingElement(child);
1079 void XMLApplication::doSSO(const ProtocolProvider& pp, set<string>& protocols, DOMElement* e, Category& log)
1081 if (!e->hasChildNodes())
1084 SPConfig& conf = SPConfig::getConfig();
1086 int index = 0; // track ACS indexes globally across all protocols
1088 // Tokenize the protocol list inside the element.
1089 XMLStringTokenizer prottokens(e->getTextContent());
1090 while (prottokens.hasMoreTokens()) {
1091 auto_ptr_char prot(prottokens.nextToken());
1093 // Look for initiator.
1094 const PropertySet* initiator = pp.getInitiator(prot.get(), "SSO");
1096 log.info("auto-configuring SSO initiation for protocol (%s)", prot.get());
1097 pair<bool,const XMLCh*> inittype = initiator->getXMLString("id");
1098 if (inittype.first) {
1099 // Append a session initiator element of the designated type to the root element.
1100 DOMElement* sidom = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _SessionInitiator);
1101 sidom->setAttributeNS(nullptr, _type, inittype.second);
1102 e->appendChild(sidom);
1103 log.info("adding SessionInitiator of type (%s) to chain (/Login)", initiator->getString("id").second);
1105 doArtifactResolution(pp, prot.get(), e, log);
1106 protocols.insert(prot.get());
1109 log.error("missing id property on Initiator element, check config for protocol (%s)", prot.get());
1113 // Look for incoming bindings.
1114 const vector<const PropertySet*>& bindings = pp.getBindings(prot.get(), "SSO");
1115 if (!bindings.empty()) {
1116 log.info("auto-configuring SSO endpoints for protocol (%s)", prot.get());
1117 pair<bool,const XMLCh*> idprop,pathprop;
1118 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b, ++index) {
1119 idprop = (*b)->getXMLString("id");
1120 pathprop = (*b)->getXMLString("path");
1121 if (idprop.first && pathprop.first) {
1122 DOMElement* acsdom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _AssertionConsumerService);
1123 acsdom->setAttributeNS(nullptr, Binding, idprop.second);
1124 acsdom->setAttributeNS(nullptr, Location, pathprop.second);
1125 xstring indexbuf(1, chDigit_1 + (index % 10));
1127 indexbuf = (XMLCh)(chDigit_1 + (index / 10)) + indexbuf;
1128 acsdom->setAttributeNS(nullptr, _index, indexbuf.c_str());
1129 if (e->hasAttributeNS(nullptr, _policyId))
1130 acsdom->setAttributeNS(shibspconstants::SHIB2SPCONFIG_NS, _policyId, e->getAttributeNS(nullptr, _policyId));
1132 log.info("adding AssertionConsumerService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1133 boost::shared_ptr<Handler> handler(
1134 conf.AssertionConsumerServiceManager.newPlugin(
1135 (*b)->getString("id").second, pair<const DOMElement*,const char*>(acsdom, getId())
1138 m_handlers.push_back(handler);
1140 // Setup maps and defaults.
1141 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler.get());
1142 const XMLCh* protfamily = handler->getProtocolFamily();
1144 m_acsProtocolMap[protfamily].push_back(handler.get());
1145 m_acsIndexMap[handler->getUnsignedInt("index").second] = handler.get();
1147 m_acsDefault = handler.get();
1149 // Insert into location map.
1150 pair<bool,const char*> location = handler->getString("Location");
1151 if (location.first && *location.second == '/')
1152 m_handlerMap[location.second] = handler.get();
1153 else if (location.first)
1154 m_handlerMap[string("/") + location.second] = handler.get();
1157 log.error("missing id or path property on Binding element, check config for protocol (%s)", prot.get());
1162 if (!initiator && bindings.empty()) {
1163 log.error("no SSO Initiator or Binding config for protocol (%s)", prot.get());
1167 // Handle discovery.
1168 static const XMLCh discoveryProtocol[] = UNICODE_LITERAL_17(d,i,s,c,o,v,e,r,y,P,r,o,t,o,c,o,l);
1169 static const XMLCh discoveryURL[] = UNICODE_LITERAL_12(d,i,s,c,o,v,e,r,y,U,R,L);
1170 static const XMLCh _URL[] = UNICODE_LITERAL_3(U,R,L);
1171 const XMLCh* discop = e->getAttributeNS(nullptr, discoveryProtocol);
1172 if (discop && *discop) {
1173 const XMLCh* discou = e->getAttributeNS(nullptr, discoveryURL);
1174 if (discou && *discou) {
1175 // Append a session initiator element of the designated type to the root element.
1176 DOMElement* sidom = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _SessionInitiator);
1177 sidom->setAttributeNS(nullptr, _type, discop);
1178 sidom->setAttributeNS(nullptr, _URL, discou);
1179 e->appendChild(sidom);
1180 if (log.isInfoEnabled()) {
1181 auto_ptr_char dp(discop);
1182 log.info("adding SessionInitiator of type (%s) to chain (/Login)", dp.get());
1186 log.error("SSO discoveryProtocol specified without discoveryURL");
1190 // Attach default Location to SSO element.
1191 static const XMLCh _loc[] = { chForwardSlash, chLatin_L, chLatin_o, chLatin_g, chLatin_i, chLatin_n, chNull };
1192 e->setAttributeNS(nullptr, Location, _loc);
1194 // Instantiate Chaining initiator around the SSO element.
1195 boost::shared_ptr<SessionInitiator> chain(
1196 conf.SessionInitiatorManager.newPlugin(CHAINING_SESSION_INITIATOR, pair<const DOMElement*,const char*>(e, getId()))
1198 m_handlers.push_back(chain);
1199 m_sessionInitDefault = chain.get();
1200 m_handlerMap["/Login"] = chain.get();
1203 void XMLApplication::doLogout(const ProtocolProvider& pp, set<string>& protocols, DOMElement* e, Category& log)
1205 if (!e->hasChildNodes())
1208 SPConfig& conf = SPConfig::getConfig();
1210 // Tokenize the protocol list inside the element.
1211 XMLStringTokenizer prottokens(e->getTextContent());
1212 while (prottokens.hasMoreTokens()) {
1213 auto_ptr_char prot(prottokens.nextToken());
1215 // Look for initiator.
1216 const PropertySet* initiator = pp.getInitiator(prot.get(), "Logout");
1218 log.info("auto-configuring Logout initiation for protocol (%s)", prot.get());
1219 pair<bool,const XMLCh*> inittype = initiator->getXMLString("id");
1220 if (inittype.first) {
1221 // Append a logout initiator element of the designated type to the root element.
1222 DOMElement* lidom = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _LogoutInitiator);
1223 lidom->setAttributeNS(nullptr, _type, inittype.second);
1224 e->appendChild(lidom);
1225 log.info("adding LogoutInitiator of type (%s) to chain (/Logout)", initiator->getString("id").second);
1227 if (protocols.count(prot.get()) == 0) {
1228 doArtifactResolution(pp, prot.get(), e, log);
1229 protocols.insert(prot.get());
1233 log.error("missing id property on Initiator element, check config for protocol (%s)", prot.get());
1237 // Look for incoming bindings.
1238 const vector<const PropertySet*>& bindings = pp.getBindings(prot.get(), "Logout");
1239 if (!bindings.empty()) {
1240 log.info("auto-configuring Logout endpoints for protocol (%s)", prot.get());
1241 pair<bool,const XMLCh*> idprop,pathprop;
1242 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
1243 idprop = (*b)->getXMLString("id");
1244 pathprop = (*b)->getXMLString("path");
1245 if (idprop.first && pathprop.first) {
1246 DOMElement* slodom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _SingleLogoutService);
1247 slodom->setAttributeNS(nullptr, Binding, idprop.second);
1248 slodom->setAttributeNS(nullptr, Location, pathprop.second);
1249 if (e->hasAttributeNS(nullptr, _policyId))
1250 slodom->setAttributeNS(shibspconstants::SHIB2SPCONFIG_NS, _policyId, e->getAttributeNS(nullptr, _policyId));
1252 log.info("adding SingleLogoutService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1253 boost::shared_ptr<Handler> handler(
1254 conf.SingleLogoutServiceManager.newPlugin((*b)->getString("id").second, pair<const DOMElement*,const char*>(slodom, getId()))
1256 m_handlers.push_back(handler);
1258 // Insert into location map.
1259 pair<bool,const char*> location = handler->getString("Location");
1260 if (location.first && *location.second == '/')
1261 m_handlerMap[location.second] = handler.get();
1262 else if (location.first)
1263 m_handlerMap[string("/") + location.second] = handler.get();
1266 log.error("missing id or path property on Binding element, check config for protocol (%s)", prot.get());
1270 if (protocols.count(prot.get()) == 0) {
1271 doArtifactResolution(pp, prot.get(), e, log);
1272 protocols.insert(prot.get());
1276 if (!initiator && bindings.empty()) {
1277 log.error("no Logout Initiator or Binding config for protocol (%s)", prot.get());
1281 // Attach default Location to Logout element.
1282 static const XMLCh _loc[] = { chForwardSlash, chLatin_L, chLatin_o, chLatin_g, chLatin_o, chLatin_u, chLatin_t, chNull };
1283 e->setAttributeNS(nullptr, Location, _loc);
1285 // Instantiate Chaining initiator around the SSO element.
1286 boost::shared_ptr<Handler> chain(
1287 conf.LogoutInitiatorManager.newPlugin(CHAINING_LOGOUT_INITIATOR, pair<const DOMElement*,const char*>(e, getId()))
1289 m_handlers.push_back(chain);
1290 m_handlerMap["/Logout"] = chain.get();
1293 void XMLApplication::doNameIDMgmt(const ProtocolProvider& pp, set<string>& protocols, DOMElement* e, Category& log)
1295 if (!e->hasChildNodes())
1298 SPConfig& conf = SPConfig::getConfig();
1300 // Tokenize the protocol list inside the element.
1301 XMLStringTokenizer prottokens(e->getTextContent());
1302 while (prottokens.hasMoreTokens()) {
1303 auto_ptr_char prot(prottokens.nextToken());
1305 // Look for incoming bindings.
1306 const vector<const PropertySet*>& bindings = pp.getBindings(prot.get(), "NameIDMgmt");
1307 if (!bindings.empty()) {
1308 log.info("auto-configuring NameIDMgmt endpoints for protocol (%s)", prot.get());
1309 pair<bool,const XMLCh*> idprop,pathprop;
1310 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
1311 idprop = (*b)->getXMLString("id");
1312 pathprop = (*b)->getXMLString("path");
1313 if (idprop.first && pathprop.first) {
1314 DOMElement* nimdom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _ManageNameIDService);
1315 nimdom->setAttributeNS(nullptr, Binding, idprop.second);
1316 nimdom->setAttributeNS(nullptr, Location, pathprop.second);
1317 if (e->hasAttributeNS(nullptr, _policyId))
1318 nimdom->setAttributeNS(shibspconstants::SHIB2SPCONFIG_NS, _policyId, e->getAttributeNS(nullptr, _policyId));
1320 log.info("adding ManageNameIDService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1321 boost::shared_ptr<Handler> handler(
1322 conf.ManageNameIDServiceManager.newPlugin((*b)->getString("id").second, pair<const DOMElement*,const char*>(nimdom, getId()))
1324 m_handlers.push_back(handler);
1326 // Insert into location map.
1327 pair<bool,const char*> location = handler->getString("Location");
1328 if (location.first && *location.second == '/')
1329 m_handlerMap[location.second] = handler.get();
1330 else if (location.first)
1331 m_handlerMap[string("/") + location.second] = handler.get();
1334 log.error("missing id or path property on Binding element, check config for protocol (%s)", prot.get());
1338 if (protocols.count(prot.get()) == 0) {
1339 doArtifactResolution(pp, prot.get(), e, log);
1340 protocols.insert(prot.get());
1344 log.error("no NameIDMgmt Binding config for protocol (%s)", prot.get());
1349 void XMLApplication::doArtifactResolution(const ProtocolProvider& pp, const char* protocol, DOMElement* e, Category& log)
1351 SPConfig& conf = SPConfig::getConfig();
1353 int index = 0; // track indexes globally across all protocols
1355 // Look for incoming bindings.
1356 const vector<const PropertySet*>& bindings = pp.getBindings(protocol, "ArtifactResolution");
1357 if (!bindings.empty()) {
1358 log.info("auto-configuring ArtifactResolution endpoints for protocol (%s)", protocol);
1359 pair<bool,const XMLCh*> idprop,pathprop;
1360 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b, ++index) {
1361 idprop = (*b)->getXMLString("id");
1362 pathprop = (*b)->getXMLString("path");
1363 if (idprop.first && pathprop.first) {
1364 DOMElement* artdom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _ArtifactResolutionService);
1365 artdom->setAttributeNS(nullptr, Binding, idprop.second);
1366 artdom->setAttributeNS(nullptr, Location, pathprop.second);
1367 xstring indexbuf(1, chDigit_1 + (index % 10));
1369 indexbuf = (XMLCh)(chDigit_1 + (index / 10)) + indexbuf;
1370 artdom->setAttributeNS(nullptr, _index, indexbuf.c_str());
1372 log.info("adding ArtifactResolutionService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1373 boost::shared_ptr<Handler> handler(
1374 conf.ArtifactResolutionServiceManager.newPlugin((*b)->getString("id").second, pair<const DOMElement*,const char*>(artdom, getId()))
1376 m_handlers.push_back(handler);
1378 if (!m_artifactResolutionDefault)
1379 m_artifactResolutionDefault = handler.get();
1381 // Insert into location map.
1382 pair<bool,const char*> location = handler->getString("Location");
1383 if (location.first && *location.second == '/')
1384 m_handlerMap[location.second] = handler.get();
1385 else if (location.first)
1386 m_handlerMap[string("/") + location.second] = handler.get();
1389 log.error("missing id or path property on Binding element, check config for protocol (%s)", protocol);
1396 void XMLApplication::doAttributePlugins(DOMElement* e, Category& log)
1398 SPConfig& conf = SPConfig::getConfig();
1400 m_attrExtractor.reset(
1401 doChainedPlugins(conf.AttributeExtractorManager, "AttributeExtractor", CHAINING_ATTRIBUTE_EXTRACTOR, _AttributeExtractor, e, log)
1405 doChainedPlugins(conf.AttributeFilterManager, "AttributeFilter", CHAINING_ATTRIBUTE_FILTER, _AttributeFilter, e, log, DUMMY_ATTRIBUTE_FILTER)
1408 m_attrResolver.reset(
1409 doChainedPlugins(conf.AttributeResolverManager, "AttributeResolver", CHAINING_ATTRIBUTE_RESOLVER, _AttributeResolver, e, log)
1412 if (m_unsetHeaders.empty()) {
1413 vector<string> unsetHeaders;
1414 if (m_attrExtractor) {
1415 Locker extlock(m_attrExtractor.get());
1416 m_attrExtractor->getAttributeIds(unsetHeaders);
1418 else if (m_base && m_base->m_attrExtractor) {
1419 Locker extlock(m_base->m_attrExtractor.get());
1420 m_base->m_attrExtractor->getAttributeIds(unsetHeaders);
1422 if (m_attrResolver) {
1423 Locker reslock(m_attrResolver.get());
1424 m_attrResolver->getAttributeIds(unsetHeaders);
1426 else if (m_base && m_base->m_attrResolver) {
1427 Locker extlock(m_base->m_attrResolver.get());
1428 m_base->m_attrResolver->getAttributeIds(unsetHeaders);
1430 if (!unsetHeaders.empty()) {
1431 string transformedprefix(m_attributePrefix.second);
1433 pair<bool,const char*> prefix = getString("metadataAttributePrefix");
1435 pch = prefix.second;
1437 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
1441 for (vector<string>::const_iterator hdr = unsetHeaders.begin(); hdr!=unsetHeaders.end(); ++hdr) {
1445 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
1448 m_unsetHeaders.push_back(make_pair(m_attributePrefix.first + *hdr, m_attributePrefix.second + transformed));
1450 m_unsetHeaders.push_back(make_pair(m_attributePrefix.first + prefix.second + *hdr, transformedprefix + transformed));
1453 m_unsetHeaders.push_back(make_pair(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
1458 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
1461 DOMNodeFilter::FilterAction
1463 XMLApplication::acceptNode(const DOMNode* node) const
1465 const XMLCh* name=node->getLocalName();
1466 if (XMLString::equals(name,ApplicationOverride) ||
1467 XMLString::equals(name,_Audience) ||
1468 XMLString::equals(name,Notify) ||
1469 XMLString::equals(name,_Handler) ||
1470 XMLString::equals(name,_AssertionConsumerService) ||
1471 XMLString::equals(name,_ArtifactResolutionService) ||
1472 XMLString::equals(name,Logout) ||
1473 XMLString::equals(name,_LogoutInitiator) ||
1474 XMLString::equals(name,_ManageNameIDService) ||
1475 XMLString::equals(name,NameIDMgmt) ||
1476 XMLString::equals(name,_SessionInitiator) ||
1477 XMLString::equals(name,_SingleLogoutService) ||
1478 XMLString::equals(name,SSO) ||
1479 XMLString::equals(name,RelyingParty) ||
1480 XMLString::equals(name,_MetadataProvider) ||
1481 XMLString::equals(name,_TrustEngine) ||
1482 XMLString::equals(name,_CredentialResolver) ||
1483 XMLString::equals(name,_AttributeFilter) ||
1484 XMLString::equals(name,_AttributeExtractor) ||
1485 XMLString::equals(name,_AttributeResolver))
1486 return FILTER_REJECT;
1488 return FILTER_ACCEPT;
1493 const PropertySet* XMLApplication::getRelyingParty(const EntityDescriptor* provider) const
1498 // Check for exact match on name.
1499 map< xstring,boost::shared_ptr<PropertySet> >::const_iterator i = m_partyMap.find(provider->getEntityID());
1500 if (i != m_partyMap.end())
1501 return i->second.get();
1503 // Check for extensible matching.
1504 vector < pair< boost::shared_ptr<EntityMatcher>,boost::shared_ptr<PropertySet> > >::const_iterator j;
1505 for (j = m_partyVec.begin(); j != m_partyVec.end(); ++j) {
1506 if (j->first->matches(*provider))
1507 return j->second.get();
1510 // Check for group match.
1511 const EntitiesDescriptor* group = dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
1513 if (group->getName()) {
1514 i = m_partyMap.find(group->getName());
1515 if (i != m_partyMap.end())
1516 return i->second.get();
1518 group = dynamic_cast<const EntitiesDescriptor*>(group->getParent());
1523 const PropertySet* XMLApplication::getRelyingParty(const XMLCh* entityID) const
1527 map< xstring,boost::shared_ptr<PropertySet> >::const_iterator i = m_partyMap.find(entityID);
1528 return (i != m_partyMap.end()) ? i->second.get() : this;
1533 string XMLApplication::getNotificationURL(const char* resource, bool front, unsigned int index) const
1535 const vector<string>& locs = front ? m_frontLogout : m_backLogout;
1537 return m_base ? m_base->getNotificationURL(resource, front, index) : string();
1538 else if (index >= locs.size())
1541 #ifdef HAVE_STRCASECMP
1542 if (!resource || (strncasecmp(resource,"http://",7) && strncasecmp(resource,"https://",8)))
1544 if (!resource || (strnicmp(resource,"http://",7) && strnicmp(resource,"https://",8)))
1546 throw ConfigurationException("Request URL was not absolute.");
1548 const char* handler = locs[index].c_str();
1550 // Should never happen...
1551 if (!handler || (*handler!='/' && strncmp(handler,"http:",5) && strncmp(handler,"https:",6)))
1552 throw ConfigurationException(
1553 "Invalid Location property ($1) in Notify element for Application ($2)",
1554 params(2, handler ? handler : "null", getId())
1557 // The "Location" property can be in one of three formats:
1559 // 1) a full URI: http://host/foo/bar
1560 // 2) a hostless URI: http:///foo/bar
1561 // 3) a relative path: /foo/bar
1563 // # Protocol Host Path
1564 // 1 handler handler handler
1565 // 2 handler resource handler
1566 // 3 resource resource handler
1568 const char* path = nullptr;
1570 // Decide whether to use the handler or the resource for the "protocol"
1572 if (*handler != '/') {
1580 // break apart the "protocol" string into protocol, host, and "the rest"
1581 const char* colon=strchr(prot,':');
1583 const char* slash=strchr(colon,'/');
1587 // Compute the actual protocol and store.
1588 string notifyURL(prot, colon-prot);
1590 // create the "host" from either the colon/slash or from the target string
1591 // If prot == handler then we're in either #1 or #2, else #3.
1592 // If slash == colon then we're in #2.
1593 if (prot != handler || slash == colon) {
1594 colon = strchr(resource, ':');
1595 colon += 3; // Get past the ://
1596 slash = strchr(colon, '/');
1598 string host(colon, (slash ? slash-colon : strlen(colon)));
1601 notifyURL += host + path;
1605 void XMLApplication::clearHeader(SPRequest& request, const char* rawname, const char* cginame) const
1607 if (!m_attributePrefix.first.empty()) {
1608 string temp = m_attributePrefix.first + rawname;
1609 string temp2 = m_attributePrefix.second + (cginame + 5);
1610 request.clearHeader(temp.c_str(), temp2.c_str());
1613 m_base->clearHeader(request, rawname, cginame);
1616 request.clearHeader(rawname, cginame);
1620 void XMLApplication::setHeader(SPRequest& request, const char* name, const char* value) const
1622 if (!m_attributePrefix.first.empty()) {
1623 string temp = m_attributePrefix.first + name;
1624 request.setHeader(temp.c_str(), value);
1627 m_base->setHeader(request, name, value);
1630 request.setHeader(name, value);
1634 string XMLApplication::getSecureHeader(const SPRequest& request, const char* name) const
1636 if (!m_attributePrefix.first.empty()) {
1637 string temp = m_attributePrefix.first + name;
1638 return request.getSecureHeader(temp.c_str());
1641 return m_base->getSecureHeader(request,name);
1644 return request.getSecureHeader(name);
1648 const SessionInitiator* XMLApplication::getDefaultSessionInitiator() const
1650 if (m_sessionInitDefault) return m_sessionInitDefault;
1651 return m_base ? m_base->getDefaultSessionInitiator() : nullptr;
1654 const SessionInitiator* XMLApplication::getSessionInitiatorById(const char* id) const
1656 map<string,const SessionInitiator*>::const_iterator i = m_sessionInitMap.find(id);
1657 if (i != m_sessionInitMap.end()) return i->second;
1658 return m_base ? m_base->getSessionInitiatorById(id) : nullptr;
1661 const Handler* XMLApplication::getDefaultAssertionConsumerService() const
1663 if (m_acsDefault) return m_acsDefault;
1664 return m_base ? m_base->getDefaultAssertionConsumerService() : nullptr;
1667 const Handler* XMLApplication::getAssertionConsumerServiceByIndex(unsigned short index) const
1669 map<unsigned int,const Handler*>::const_iterator i = m_acsIndexMap.find(index);
1670 if (i != m_acsIndexMap.end()) return i->second;
1671 return m_base ? m_base->getAssertionConsumerServiceByIndex(index) : nullptr;
1674 const Handler* XMLApplication::getAssertionConsumerServiceByProtocol(const XMLCh* protocol, const char* binding) const
1676 ACSProtocolMap::const_iterator i = m_acsProtocolMap.find(protocol);
1677 if (i != m_acsProtocolMap.end() && !i->second.empty()) {
1678 if (!binding || !*binding)
1679 return i->second.front();
1680 for (ACSProtocolMap::value_type::second_type::const_iterator j = i->second.begin(); j != i->second.end(); ++j) {
1681 if (!strcmp(binding, (*j)->getString("Binding").second))
1685 return m_base ? m_base->getAssertionConsumerServiceByProtocol(protocol, binding) : nullptr;
1688 const vector<const Handler*>& XMLApplication::getAssertionConsumerServicesByBinding(const XMLCh* binding) const
1690 ACSBindingMap::const_iterator i = m_acsBindingMap.find(binding);
1691 if (i != m_acsBindingMap.end())
1693 return m_base ? m_base->getAssertionConsumerServicesByBinding(binding) : g_noHandlers;
1696 const Handler* XMLApplication::getHandler(const char* path) const
1699 wrap = wrap.substr(0, wrap.find(';'));
1700 map<string,const Handler*>::const_iterator i = m_handlerMap.find(wrap.substr(0, wrap.find('?')));
1701 if (i != m_handlerMap.end())
1703 return m_base ? m_base->getHandler(path) : nullptr;
1706 void XMLApplication::getHandlers(vector<const Handler*>& handlers) const
1708 static void (vector<const Handler*>::* pb)(const Handler* const&) = &vector<const Handler*>::push_back;
1709 for_each(m_handlers.begin(), m_handlers.end(), boost::bind(pb, boost::ref(handlers), boost::bind(&boost::shared_ptr<Handler>::get, _1)));
1711 for (map<string,const Handler*>::const_iterator h = m_base->m_handlerMap.begin(); h != m_base->m_handlerMap.end(); ++h) {
1712 if (m_handlerMap.count(h->first) == 0)
1713 handlers.push_back(h->second);
1718 void XMLApplication::limitRedirect(const GenericRequest& request, const char* url) const
1720 if (!url || *url == '/')
1722 if (m_redirectLimit == REDIRECT_LIMIT_INHERIT)
1723 return m_base->limitRedirect(request, url);
1724 if (m_redirectLimit != REDIRECT_LIMIT_NONE) {
1725 vector<string> whitelist;
1726 if (m_redirectLimit == REDIRECT_LIMIT_EXACT || m_redirectLimit == REDIRECT_LIMIT_EXACT_WHITELIST) {
1727 // Scheme and hostname have to match.
1728 if (request.isDefaultPort()) {
1729 whitelist.push_back(string(request.getScheme()) + "://" + request.getHostname() + '/');
1731 whitelist.push_back(string(request.getScheme()) + "://" + request.getHostname() + ':' + lexical_cast<string>(request.getPort()) + '/');
1733 else if (m_redirectLimit == REDIRECT_LIMIT_HOST || m_redirectLimit == REDIRECT_LIMIT_HOST_WHITELIST) {
1734 // Allow any scheme or port.
1735 whitelist.push_back(string("https://") + request.getHostname() + '/');
1736 whitelist.push_back(string("http://") + request.getHostname() + '/');
1737 whitelist.push_back(string("https://") + request.getHostname() + ':');
1738 whitelist.push_back(string("http://") + request.getHostname() + ':');
1741 static bool (*startsWithI)(const char*,const char*) = XMLString::startsWithI;
1742 if (!whitelist.empty() && find_if(whitelist.begin(), whitelist.end(),
1743 boost::bind(startsWithI, url, boost::bind(&string::c_str, _1))) != whitelist.end()) {
1746 else if (!m_redirectWhitelist.empty() && find_if(m_redirectWhitelist.begin(), m_redirectWhitelist.end(),
1747 boost::bind(startsWithI, url, boost::bind(&string::c_str, _1))) != m_redirectWhitelist.end()) {
1750 Category::getInstance(SHIBSP_LOGCAT".Application").warn("redirectLimit policy enforced, blocked redirect to (%s)", url);
1751 throw opensaml::SecurityPolicyException("Blocked unacceptable redirect location.");
1755 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
1758 DOMNodeFilter::FilterAction
1760 XMLConfigImpl::acceptNode(const DOMNode* node) const
1762 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
1763 return FILTER_ACCEPT;
1764 const XMLCh* name=node->getLocalName();
1765 if (XMLString::equals(name,ApplicationDefaults) ||
1766 XMLString::equals(name,_ArtifactMap) ||
1767 XMLString::equals(name,_Extensions) ||
1768 XMLString::equals(name,Listener) ||
1769 XMLString::equals(name,_ProtocolProvider) ||
1770 XMLString::equals(name,_RequestMapper) ||
1771 XMLString::equals(name,_ReplayCache) ||
1772 XMLString::equals(name,SecurityPolicies) ||
1773 XMLString::equals(name,_SecurityPolicyProvider) ||
1774 XMLString::equals(name,_SessionCache) ||
1775 XMLString::equals(name,Site) ||
1776 XMLString::equals(name,_StorageService) ||
1777 XMLString::equals(name,TCPListener) ||
1778 XMLString::equals(name,TransportOption) ||
1779 XMLString::equals(name,UnixListener))
1780 return FILTER_REJECT;
1782 return FILTER_ACCEPT;
1785 void XMLConfigImpl::doExtensions(const DOMElement* e, const char* label, Category& log)
1787 const DOMElement* exts = XMLHelper::getFirstChildElement(e, _Extensions);
1789 exts = XMLHelper::getFirstChildElement(exts, Library);
1791 string path(XMLHelper::getAttrString(exts, nullptr, _path));
1793 if (!path.empty()) {
1794 if (!XMLToolingConfig::getConfig().load_library(path.c_str(), (void*)exts))
1795 throw ConfigurationException("XMLToolingConfig::load_library failed.");
1796 log.debug("loaded %s extension library (%s)", label, path.c_str());
1799 catch (std::exception& e) {
1800 if (XMLHelper::getAttrBool(exts, false, _fatal)) {
1801 log.fatal("unable to load mandatory %s extension library %s: %s", label, path.c_str(), e.what());
1805 log.crit("unable to load optional %s extension library %s: %s", label, path.c_str(), e.what());
1808 exts = XMLHelper::getNextSiblingElement(exts, Library);
1813 void XMLConfigImpl::doListener(const DOMElement* e, XMLConfig* conf, Category& log)
1816 string plugtype(TCP_LISTENER_SERVICE);
1818 string plugtype(UNIX_LISTENER_SERVICE);
1820 DOMElement* child = XMLHelper::getFirstChildElement(e, UnixListener);
1822 plugtype = UNIX_LISTENER_SERVICE;
1824 child = XMLHelper::getFirstChildElement(e, TCPListener);
1826 plugtype = TCP_LISTENER_SERVICE;
1828 child = XMLHelper::getFirstChildElement(e, Listener);
1830 auto_ptr_char type(child->getAttributeNS(nullptr, _type));
1831 if (type.get() && *type.get())
1832 plugtype = type.get();
1837 log.info("building ListenerService of type %s...", plugtype.c_str());
1838 conf->m_listener.reset(SPConfig::getConfig().ListenerServiceManager.newPlugin(plugtype.c_str(), child));
1841 void XMLConfigImpl::doCaching(const DOMElement* e, XMLConfig* conf, Category& log)
1843 SPConfig& spConf = SPConfig::getConfig();
1845 SAMLConfig& samlConf = SAMLConfig::getConfig();
1850 if (spConf.isEnabled(SPConfig::OutOfProcess)) {
1851 XMLToolingConfig& xmlConf = XMLToolingConfig::getConfig();
1852 // First build any StorageServices.
1853 child = XMLHelper::getFirstChildElement(e, _StorageService);
1855 string id(XMLHelper::getAttrString(child, nullptr, _id));
1856 string t(XMLHelper::getAttrString(child, nullptr, _type));
1859 log.info("building StorageService (%s) of type %s...", id.c_str(), t.c_str());
1860 conf->m_storage[id] = boost::shared_ptr<StorageService>(xmlConf.StorageServiceManager.newPlugin(t.c_str(), child));
1862 catch (std::exception& ex) {
1863 log.crit("failed to instantiate StorageService (%s): %s", id.c_str(), ex.what());
1866 child = XMLHelper::getNextSiblingElement(child, _StorageService);
1869 if (conf->m_storage.empty()) {
1870 log.info("no StorageService plugin(s) installed, using (mem) in-memory instance");
1871 conf->m_storage["mem"] = boost::shared_ptr<StorageService>(xmlConf.StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE, nullptr));
1875 StorageService* replaySS = nullptr;
1876 child = XMLHelper::getFirstChildElement(e, _ReplayCache);
1878 string ssid(XMLHelper::getAttrString(child, nullptr, _StorageService));
1879 if (!ssid.empty()) {
1880 if (conf->m_storage.count(ssid)) {
1881 log.info("building ReplayCache on top of StorageService (%s)...", ssid.c_str());
1882 replaySS = conf->m_storage[ssid].get();
1885 log.error("unable to locate StorageService (%s), using arbitrary instance for ReplayCache", ssid.c_str());
1886 replaySS = conf->m_storage.begin()->second.get();
1890 log.info("no StorageService specified for ReplayCache, using arbitrary instance");
1891 replaySS = conf->m_storage.begin()->second.get();
1895 log.info("no ReplayCache specified, using arbitrary StorageService instance");
1896 replaySS = conf->m_storage.begin()->second.get();
1898 xmlConf.setReplayCache(new ReplayCache(replaySS));
1901 child = XMLHelper::getFirstChildElement(e, _ArtifactMap);
1903 string ssid(XMLHelper::getAttrString(child, nullptr, _StorageService));
1904 if (!ssid.empty()) {
1905 if (conf->m_storage.count(ssid)) {
1906 log.info("building ArtifactMap on top of StorageService (%s)...", ssid.c_str());
1907 samlConf.setArtifactMap(new ArtifactMap(child, conf->m_storage[ssid].get()));
1910 log.error("unable to locate StorageService (%s), using in-memory ArtifactMap", ssid.c_str());
1911 samlConf.setArtifactMap(new ArtifactMap(child));
1915 log.info("no StorageService specified, using in-memory ArtifactMap");
1916 samlConf.setArtifactMap(new ArtifactMap(child));
1920 log.info("no ArtifactMap specified, building in-memory ArtifactMap...");
1921 samlConf.setArtifactMap(new ArtifactMap(child));
1923 } // end of out of process caching components
1926 child = XMLHelper::getFirstChildElement(e, _SessionCache);
1928 string t(XMLHelper::getAttrString(child, nullptr, _type));
1930 log.info("building SessionCache of type %s...", t.c_str());
1931 conf->m_sessionCache.reset(spConf.SessionCacheManager.newPlugin(t.c_str(), child));
1934 if (!conf->m_sessionCache) {
1935 log.info("no SessionCache specified, using StorageService-backed instance");
1936 conf->m_sessionCache.reset(spConf.SessionCacheManager.newPlugin(STORAGESERVICE_SESSION_CACHE, nullptr));
1940 XMLConfigImpl::XMLConfigImpl(const DOMElement* e, bool first, XMLConfig* outer, Category& log) : m_document(nullptr)
1943 xmltooling::NDC ndc("XMLConfigImpl");
1945 SPConfig& conf=SPConfig::getConfig();
1946 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
1947 const DOMElement* SHAR=XMLHelper::getFirstChildElement(e, OutOfProcess);
1948 const DOMElement* SHIRE=XMLHelper::getFirstChildElement(e, InProcess);
1950 // Initialize logging manually in order to redirect log messages as soon as possible.
1951 // If no explicit config is supplied, we now assume the caller has done this, so that
1952 // setuid processes can potentially do this as root.
1953 if (conf.isEnabled(SPConfig::Logging)) {
1955 if (conf.isEnabled(SPConfig::OutOfProcess))
1956 logconf = XMLHelper::getAttrString(SHAR, nullptr, logger);
1957 else if (conf.isEnabled(SPConfig::InProcess))
1958 logconf = XMLHelper::getAttrString(SHIRE, nullptr, logger);
1959 if (logconf.empty())
1960 logconf = XMLHelper::getAttrString(e, nullptr, logger);
1961 if (!logconf.empty()) {
1962 log.debug("loading new logging configuration from (%s), check log destination for status of configuration", logconf.c_str());
1963 if (!XMLToolingConfig::getConfig().log_config(logconf.c_str()))
1964 log.crit("failed to load new logging configuration from (%s)", logconf.c_str());
1970 XMLHelper::getAttrString(SHAR, nullptr, tranLogFormat).c_str(),
1971 XMLHelper::getAttrString(SHAR, nullptr, tranLogFiller).c_str()
1977 // Re-log library versions now that logging is set up.
1978 log.info("Shibboleth SP Version %s", PACKAGE_VERSION);
1981 "Library versions: %s %s, Xerces-C %s, XML-Security-C %s, XMLTooling-C %s, OpenSAML-C %s, Shibboleth %s",
1982 # if defined(LOG4SHIB_VERSION)
1983 "log4shib", LOG4SHIB_VERSION,
1984 # elif defined(LOG4CPP_VERSION)
1985 "log4cpp", LOG4CPP_VERSION,
1989 XERCES_FULLVERSIONDOT, XSEC_FULLVERSIONDOT, gXMLToolingDotVersionStr, gOpenSAMLDotVersionStr, gShibSPDotVersionStr
1993 "Library versions: %s %s, Xerces-C %s, XMLTooling-C %s, Shibboleth %s",
1994 # if defined(LOG4SHIB_VERSION)
1995 "log4shib", LOG4SHIB_VERSION,
1996 # elif defined(LOG4CPP_VERSION)
1997 "log4cpp", LOG4CPP_VERSION,
2001 XERCES_FULLVERSIONDOT, gXMLToolingDotVersionStr, gShibSPDotVersionStr
2005 // First load any property sets.
2006 load(e, nullptr, this);
2010 // Much of the processing can only occur on the first instantiation.
2013 pair<bool,unsigned int> skew=getUnsignedInt("clockSkew");
2015 xmlConf.clock_skew_secs=min(skew.second,(60*60*24*7*28));
2017 pair<bool,const char*> unsafe = getString("unsafeChars");
2019 TemplateEngine::unsafe_chars = unsafe.second;
2021 unsafe = getString("allowedSchemes");
2023 HTTPResponse::getAllowedSchemes().clear();
2024 string schemes(unsafe.second);
2025 split(HTTPResponse::getAllowedSchemes(), schemes, is_space(), algorithm::token_compress_on);
2028 // Default language handling.
2029 pair<bool,bool> langFromClient = getBool("langFromClient");
2030 pair<bool,const XMLCh*> langPriority = getXMLString("langPriority");
2031 GenericRequest::setLangDefaults(!langFromClient.first || langFromClient.second, langPriority.second);
2034 langPriority = getXMLString("contactPriority");
2035 if (langPriority.first)
2036 SAMLConfig::getConfig().setContactPriority(langPriority.second);
2040 doExtensions(e, "global", log);
2041 if (conf.isEnabled(SPConfig::OutOfProcess))
2042 doExtensions(SHAR, "out of process", log);
2044 if (conf.isEnabled(SPConfig::InProcess))
2045 doExtensions(SHIRE, "in process", log);
2047 // Instantiate the ListenerService and SessionCache objects.
2048 if (conf.isEnabled(SPConfig::Listener))
2049 doListener(e, outer, log);
2052 if (outer->m_listener && conf.isEnabled(SPConfig::OutOfProcess) && !conf.isEnabled(SPConfig::InProcess)) {
2053 outer->m_listener->regListener("set::RelayState", outer);
2054 outer->m_listener->regListener("get::RelayState", outer);
2055 outer->m_listener->regListener("set::PostData", outer);
2056 outer->m_listener->regListener("get::PostData", outer);
2059 if (conf.isEnabled(SPConfig::Caching))
2060 doCaching(e, outer, log);
2061 } // end of first-time-only stuff
2063 // Back to the fully dynamic stuff...next up is the RequestMapper.
2064 if (conf.isEnabled(SPConfig::RequestMapping)) {
2065 if (child = XMLHelper::getFirstChildElement(e, _RequestMapper)) {
2066 string t(XMLHelper::getAttrString(child, nullptr, _type));
2068 log.info("building RequestMapper of type %s...", t.c_str());
2069 m_requestMapper.reset(conf.RequestMapperManager.newPlugin(t.c_str(), child));
2072 if (!m_requestMapper) {
2073 log.info("no RequestMapper specified, using 'Native' plugin with empty/default map");
2074 child = e->getOwnerDocument()->createElementNS(nullptr, _RequestMapper);
2075 DOMElement* mapperDummy = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, RequestMap);
2076 mapperDummy->setAttributeNS(nullptr, applicationId, _default);
2077 child->appendChild(mapperDummy);
2078 m_requestMapper.reset(conf.RequestMapperManager.newPlugin(NATIVE_REQUEST_MAPPER, child));
2083 // Load security policies.
2084 if (child = XMLHelper::getLastChildElement(e, _SecurityPolicyProvider)) {
2085 string t(XMLHelper::getAttrString(child, nullptr, _type));
2087 log.info("building SecurityPolicyProvider of type %s...", t.c_str());
2088 m_policy.reset(conf.SecurityPolicyProviderManager.newPlugin(t.c_str(), child));
2091 throw ConfigurationException("can't build SecurityPolicyProvider, no type specified");
2094 else if (child = XMLHelper::getLastChildElement(e, SecurityPolicies)) {
2095 // For backward compatibility, wrap in a plugin element.
2096 DOMElement* polwrapper = e->getOwnerDocument()->createElementNS(nullptr, _SecurityPolicyProvider);
2097 polwrapper->appendChild(child);
2098 log.warn("deprecated/legacy SecurityPolicy configuration, consider externalizing with <SecurityPolicyProvider>");
2099 m_policy.reset(conf.SecurityPolicyProviderManager.newPlugin(XML_SECURITYPOLICY_PROVIDER, polwrapper));
2102 log.fatal("can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
2103 throw ConfigurationException("Can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
2107 if (!m_policy->getAlgorithmWhitelist().empty()) {
2108 #ifdef SHIBSP_XMLSEC_WHITELISTING
2109 for (vector<xstring>::const_iterator white = m_policy->getAlgorithmWhitelist().begin();
2110 white != m_policy->getAlgorithmWhitelist().end(); ++white) {
2111 XSECPlatformUtils::whitelistAlgorithm(white->c_str());
2112 auto_ptr_char whitelog(white->c_str());
2113 log.info("explicitly whitelisting security algorithm (%s)", whitelog.get());
2116 log.crit("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists");
2119 else if (!m_policy->getDefaultAlgorithmBlacklist().empty() || !m_policy->getAlgorithmBlacklist().empty()) {
2120 #ifdef SHIBSP_XMLSEC_WHITELISTING
2121 for (vector<xstring>::const_iterator black = m_policy->getDefaultAlgorithmBlacklist().begin();
2122 black != m_policy->getDefaultAlgorithmBlacklist().end(); ++black) {
2123 XSECPlatformUtils::blacklistAlgorithm(black->c_str());
2124 auto_ptr_char blacklog(black->c_str());
2125 log.info("automatically blacklisting security algorithm (%s)", blacklog.get());
2127 for (vector<xstring>::const_iterator black = m_policy->getAlgorithmBlacklist().begin();
2128 black != m_policy->getAlgorithmBlacklist().end(); ++black) {
2129 XSECPlatformUtils::blacklistAlgorithm(black->c_str());
2130 auto_ptr_char blacklog(black->c_str());
2131 log.info("explicitly blacklisting security algorithm (%s)", blacklog.get());
2134 log.crit("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists");
2139 // Process TransportOption elements.
2140 child = XMLHelper::getLastChildElement(e, TransportOption);
2142 if (child->hasChildNodes()) {
2143 string provider(XMLHelper::getAttrString(child, nullptr, _provider));
2144 string option(XMLHelper::getAttrString(child, nullptr, _option));
2145 auto_ptr_char value(child->getFirstChild()->getNodeValue());
2146 if (!provider.empty() && !option.empty() && value.get() && *value.get()) {
2147 m_transportOptions.push_back(make_tuple(provider, option, string(value.get())));
2150 child = XMLHelper::getPreviousSiblingElement(child, TransportOption);
2154 scoped_ptr<ProtocolProvider> pp;
2155 if (conf.isEnabled(SPConfig::Handlers)) {
2156 if (child = XMLHelper::getLastChildElement(e, _ProtocolProvider)) {
2157 string t(XMLHelper::getAttrString(child, nullptr, _type));
2159 log.info("building ProtocolProvider of type %s...", t.c_str());
2160 pp.reset(conf.ProtocolProviderManager.newPlugin(t.c_str(), child));
2164 Locker pplocker(pp.get());
2166 // Load the default application.
2167 child = XMLHelper::getLastChildElement(e, ApplicationDefaults);
2169 log.fatal("can't build default Application object, missing conf:ApplicationDefaults element?");
2170 throw ConfigurationException("can't build default Application object, missing conf:ApplicationDefaults element?");
2172 boost::shared_ptr<XMLApplication> defapp(new XMLApplication(outer, pp.get(), child));
2173 m_appmap[defapp->getId()] = defapp;
2175 // Load any overrides.
2176 child = XMLHelper::getFirstChildElement(child, ApplicationOverride);
2178 boost::shared_ptr<XMLApplication> iapp(new XMLApplication(outer, pp.get(), child, defapp.get()));
2179 if (m_appmap.count(iapp->getId()))
2180 log.crit("found conf:ApplicationOverride element with duplicate id attribute (%s), skipping it", iapp->getId());
2182 m_appmap[iapp->getId()] = iapp;
2184 child = XMLHelper::getNextSiblingElement(child, ApplicationOverride);
2187 // Check for extra AuthTypes to recognize.
2188 if (conf.isEnabled(SPConfig::InProcess)) {
2189 const PropertySet* inprocs = getPropertySet("InProcess");
2191 pair<bool,const char*> extraAuthTypes = inprocs->getString("extraAuthTypes");
2192 if (extraAuthTypes.first) {
2193 string types(extraAuthTypes.second);
2194 split(outer->m_authTypes, types, is_space(), algorithm::token_compress_on);
2195 outer->m_authTypes.insert("shibboleth");
2202 void XMLConfig::receive(DDF& in, ostream& out)
2204 if (!strcmp(in.name(), "get::RelayState")) {
2205 const char* id = in["id"].string();
2206 const char* key = in["key"].string();
2208 throw ListenerException("Required parameters missing for RelayState recovery.");
2211 StorageService* storage = getStorageService(id);
2213 if (storage->readString("RelayState",key,&relayState)>0) {
2214 if (in["clear"].integer())
2215 storage->deleteString("RelayState",key);
2217 else if (storage->readText("RelayState",key,&relayState)>0) {
2218 if (in["clear"].integer())
2219 storage->deleteText("RelayState",key);
2223 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2224 "Storage-backed RelayState with invalid StorageService ID (%s)", id
2228 // Repack for return to caller.
2229 DDF ret=DDF(nullptr).unsafe_string(relayState.c_str());
2230 DDFJanitor jret(ret);
2233 else if (!strcmp(in.name(), "set::RelayState")) {
2234 const char* id = in["id"].string();
2235 const char* value = in["value"].string();
2237 throw ListenerException("Required parameters missing for RelayState creation.");
2240 StorageService* storage = getStorageService(id);
2242 SAMLConfig::getConfig().generateRandomBytes(rsKey,32);
2243 rsKey = SAMLArtifact::toHex(rsKey);
2244 if (strlen(value) <= storage->getCapabilities().getStringSize())
2245 storage->createString("RelayState", rsKey.c_str(), value, time(nullptr) + 600);
2247 storage->createText("RelayState", rsKey.c_str(), value, time(nullptr) + 600);
2250 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2251 "Storage-backed RelayState with invalid StorageService ID (%s)", id
2255 // Repack for return to caller.
2256 DDF ret=DDF(nullptr).string(rsKey.c_str());
2257 DDFJanitor jret(ret);
2260 else if (!strcmp(in.name(), "get::PostData")) {
2261 const char* id = in["id"].string();
2262 const char* key = in["key"].string();
2264 throw ListenerException("Required parameters missing for PostData recovery.");
2267 StorageService* storage = getStorageService(id);
2269 if (storage->readText("PostData",key,&postData) > 0) {
2270 storage->deleteText("PostData",key);
2274 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2275 "Storage-backed PostData with invalid StorageService ID (%s)", id
2278 // If the data's empty, we'll send nothing back.
2279 // If not, we don't need to round trip it, just send back the serialized DDF list.
2280 if (postData.empty()) {
2282 DDFJanitor jret(ret);
2289 else if (!strcmp(in.name(), "set::PostData")) {
2290 const char* id = in["id"].string();
2291 if (!id || !in["parameters"].islist())
2292 throw ListenerException("Required parameters missing for PostData creation.");
2295 StorageService* storage = getStorageService(id);
2297 SAMLConfig::getConfig().generateRandomBytes(rsKey,32);
2298 rsKey = SAMLArtifact::toHex(rsKey);
2299 ostringstream params;
2300 params << in["parameters"];
2301 storage->createText("PostData", rsKey.c_str(), params.str().c_str(), time(nullptr) + 600);
2304 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2305 "Storage-backed PostData with invalid StorageService ID (%s)", id
2309 // Repack for return to caller.
2310 DDF ret=DDF(nullptr).string(rsKey.c_str());
2311 DDFJanitor jret(ret);
2317 pair<bool,DOMElement*> XMLConfig::background_load()
2319 // Load from source using base class.
2320 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
2322 // If we own it, wrap it.
2323 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : nullptr);
2325 scoped_ptr<XMLConfigImpl> impl(new XMLConfigImpl(raw.second, (m_impl==nullptr), this, m_log));
2327 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
2328 impl->setDocument(docjanitor.release());
2330 // Perform the swap inside a lock.
2333 SharedLock locker(m_lock, false);
2336 return make_pair(false,(DOMElement*)nullptr);