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 _ProtocolProvider[] = UNICODE_LITERAL_16(P,r,o,t,o,c,o,l,P,r,o,v,i,d,e,r);
507 static const XMLCh _provider[] = UNICODE_LITERAL_8(p,r,o,v,i,d,e,r);
508 static const XMLCh RelyingParty[] = UNICODE_LITERAL_12(R,e,l,y,i,n,g,P,a,r,t,y);
509 static const XMLCh _ReplayCache[] = UNICODE_LITERAL_11(R,e,p,l,a,y,C,a,c,h,e);
510 static const XMLCh _RequestMapper[] = UNICODE_LITERAL_13(R,e,q,u,e,s,t,M,a,p,p,e,r);
511 static const XMLCh RequestMap[] = UNICODE_LITERAL_10(R,e,q,u,e,s,t,M,a,p);
512 static const XMLCh SecurityPolicies[] = UNICODE_LITERAL_16(S,e,c,u,r,i,t,y,P,o,l,i,c,i,e,s);
513 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);
514 static const XMLCh _SessionCache[] = UNICODE_LITERAL_12(S,e,s,s,i,o,n,C,a,c,h,e);
515 static const XMLCh _SessionInitiator[] = UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
516 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);
517 static const XMLCh Site[] = UNICODE_LITERAL_4(S,i,t,e);
518 static const XMLCh SSO[] = UNICODE_LITERAL_3(S,S,O);
519 static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
520 static const XMLCh TCPListener[] = UNICODE_LITERAL_11(T,C,P,L,i,s,t,e,n,e,r);
521 static const XMLCh tranLogFiller[] = UNICODE_LITERAL_13(t,r,a,n,L,o,g,F,i,l,l,e,r);
522 static const XMLCh tranLogFormat[] = UNICODE_LITERAL_13(t,r,a,n,L,o,g,F,o,r,m,a,t);
523 static const XMLCh TransportOption[] = UNICODE_LITERAL_15(T,r,a,n,s,p,o,r,t,O,p,t,i,o,n);
524 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
525 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
526 static const XMLCh UnixListener[] = UNICODE_LITERAL_12(U,n,i,x,L,i,s,t,e,n,e,r);
530 ServiceProvider* XMLServiceProviderFactory(const DOMElement* const & e)
532 return new XMLConfig(e);
536 XMLApplication::XMLApplication(
537 const ServiceProvider* sp,
538 const ProtocolProvider* pp,
540 const XMLApplication* base
541 ) : Application(sp), m_base(base), m_acsDefault(nullptr), m_sessionInitDefault(nullptr), m_artifactResolutionDefault(nullptr)
544 xmltooling::NDC ndc("XMLApplication");
546 Category& log = Category::getInstance(SHIBSP_LOGCAT".Application");
548 // First load any property sets.
549 map<string,string> remapper;
550 remapper["relayStateLimit"] = "redirectLimit";
551 remapper["relayStateWhitelist"] = "redirectWhitelist";
552 load(e, nullptr, this, &remapper);
554 // Process redirect limit policy. Do this before assigning the parent pointer
555 // to ensure we get only our Sessions element.
556 const PropertySet* sessionProps = getPropertySet("Sessions");
558 pair<bool,const char*> redirectLimit = sessionProps->getString("redirectLimit");
559 if (redirectLimit.first) {
560 if (!strcmp(redirectLimit.second, "none"))
561 m_redirectLimit = REDIRECT_LIMIT_NONE;
562 else if (!strcmp(redirectLimit.second, "exact"))
563 m_redirectLimit = REDIRECT_LIMIT_EXACT;
564 else if (!strcmp(redirectLimit.second, "host"))
565 m_redirectLimit = REDIRECT_LIMIT_HOST;
567 if (!strcmp(redirectLimit.second, "exact+whitelist"))
568 m_redirectLimit = REDIRECT_LIMIT_EXACT_WHITELIST;
569 else if (!strcmp(redirectLimit.second, "exact+host"))
570 m_redirectLimit = REDIRECT_LIMIT_HOST_WHITELIST;
571 else if (!strcmp(redirectLimit.second, "exact+host"))
572 m_redirectLimit = REDIRECT_LIMIT_WHITELIST;
574 throw ConfigurationException("Unrecognized redirectLimit setting ($1)", params(1, redirectLimit.second));
575 redirectLimit = sessionProps->getString("redirectWhitelist");
576 if (redirectLimit.first) {
577 string dup(redirectLimit.second);
578 split(m_redirectWhitelist, dup, is_space(), algorithm::token_compress_on);
583 m_redirectLimit = base ? REDIRECT_LIMIT_INHERIT : REDIRECT_LIMIT_NONE;
587 m_redirectLimit = base ? REDIRECT_LIMIT_INHERIT : REDIRECT_LIMIT_NONE;
594 SPConfig& conf=SPConfig::getConfig();
596 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
599 // This used to be an actual hash, but now it's just a hex-encode to avoid xmlsec dependency.
600 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
601 string tohash=getId();
602 tohash+=getString("entityID").second;
603 for (const char* ch = tohash.c_str(); *ch; ++ch) {
604 m_hash += (DIGITS[((unsigned char)(0xF0 & *ch)) >> 4 ]);
605 m_hash += (DIGITS[0x0F & *ch]);
610 if (conf.isEnabled(SPConfig::Handlers))
611 doHandlers(pp, e, log);
614 DOMNodeList* nlist = e->getElementsByTagNameNS(shibspconstants::SHIB2SPCONFIG_NS, Notify);
615 for (XMLSize_t i = 0; nlist && i < nlist->getLength(); ++i) {
616 if (nlist->item(i)->getParentNode()->isSameNode(e)) {
617 const XMLCh* channel = static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(nullptr, Channel);
618 string loc(XMLHelper::getAttrString(static_cast<DOMElement*>(nlist->item(i)), nullptr, Location));
620 if (channel && *channel == chLatin_f)
621 m_frontLogout.push_back(loc);
623 m_backLogout.push_back(loc);
629 nlist = e->getElementsByTagNameNS(samlconstants::SAML20_NS, Audience::LOCAL_NAME);
630 if (nlist && nlist->getLength()) {
631 log.warn("use of <saml:Audience> elements outside of a Security Policy Rule is deprecated");
632 for (XMLSize_t i = 0; i < nlist->getLength(); ++i)
633 if (nlist->item(i)->getParentNode()->isSameNode(e) && nlist->item(i)->hasChildNodes())
634 m_audiences.push_back(nlist->item(i)->getFirstChild()->getNodeValue());
637 if (conf.isEnabled(SPConfig::Metadata)) {
640 SAMLConfig::getConfig().MetadataProviderManager, "MetadataProvider", CHAINING_METADATA_PROVIDER, _MetadataProvider, e, log
647 log.crit("no MetadataProvider available, configuration is probably unusable");
649 catch (std::exception& ex) {
650 log.crit("error initializing MetadataProvider: %s", ex.what());
654 if (conf.isEnabled(SPConfig::Trust)) {
655 m_trust.reset(doChainedPlugins(xmlConf.TrustEngineManager, "TrustEngine", CHAINING_TRUSTENGINE, _TrustEngine, e, log));
656 if (!m_trust && !m_base) {
658 "no TrustEngine specified or installed, using default chain {%s, %s}",
659 EXPLICIT_KEY_TRUSTENGINE, SHIBBOLETH_PKIX_TRUSTENGINE
661 m_trust.reset(xmlConf.TrustEngineManager.newPlugin(CHAINING_TRUSTENGINE, nullptr));
662 ChainingTrustEngine* trustchain = dynamic_cast<ChainingTrustEngine*>(m_trust.get());
664 trustchain->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(EXPLICIT_KEY_TRUSTENGINE, nullptr));
665 trustchain->addTrustEngine(xmlConf.TrustEngineManager.newPlugin(SHIBBOLETH_PKIX_TRUSTENGINE, nullptr));
670 if (conf.isEnabled(SPConfig::AttributeResolution)) {
671 doAttributePlugins(e, log);
674 if (conf.isEnabled(SPConfig::Credentials)) {
675 m_credResolver.reset(
676 doChainedPlugins(xmlConf.CredentialResolverManager, "CredentialResolver", CHAINING_CREDENTIAL_RESOLVER, _CredentialResolver, e, log)
680 // Finally, load relying parties.
681 const DOMElement* child = XMLHelper::getFirstChildElement(e, RelyingParty);
683 if (child->hasAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)) {
684 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
685 rp->load(child, nullptr, this);
687 m_partyMap[child->getAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)] = rp;
689 else if (child->hasAttributeNS(nullptr, _type)) {
690 string emtype(XMLHelper::getAttrString(child, nullptr, _type));
691 boost::shared_ptr<EntityMatcher> em(SAMLConfig::getConfig().EntityMatcherManager.newPlugin(emtype, child));
692 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
693 rp->load(child, nullptr, this);
695 m_partyVec.push_back(make_pair(em, rp));
697 child = XMLHelper::getNextSiblingElement(child, RelyingParty);
699 if (base && m_partyMap.empty() && m_partyVec.empty() && (!base->m_partyMap.empty() || !base->m_partyVec.empty())) {
700 // For inheritance of RPs to work, we have to pull them in to the override by cloning the DOM.
701 child = XMLHelper::getFirstChildElement(base->getElement(), RelyingParty);
703 if (child->hasAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)) {
704 DOMElement* rpclone = static_cast<DOMElement*>(child->cloneNode(true));
705 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
706 rp->load(rpclone, nullptr, this);
708 m_partyMap[rpclone->getAttributeNS(nullptr, saml2::Attribute::NAME_ATTRIB_NAME)] = rp;
710 else if (child->hasAttributeNS(nullptr, _type)) {
711 DOMElement* rpclone = static_cast<DOMElement*>(child->cloneNode(true));
712 string emtype(XMLHelper::getAttrString(rpclone, nullptr, _type));
713 boost::shared_ptr<EntityMatcher> em(SAMLConfig::getConfig().EntityMatcherManager.newPlugin(emtype, rpclone));
714 boost::shared_ptr<DOMPropertySet> rp(new DOMPropertySet());
715 rp->load(rpclone, nullptr, this);
717 m_partyVec.push_back(make_pair(em, rp));
719 child = XMLHelper::getNextSiblingElement(child, RelyingParty);
724 // Out of process only, we register a listener endpoint.
725 if (!conf.isEnabled(SPConfig::InProcess)) {
726 ListenerService* listener = sp->getListenerService(false);
728 string addr=string(getId()) + "::getHeaders::Application";
729 listener->regListener(addr.c_str(), this);
732 log.info("no ListenerService available, Application remoting disabled");
737 XMLApplication::~XMLApplication()
739 ListenerService* listener=getServiceProvider().getListenerService(false);
740 if (listener && SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess) && !SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
741 string addr=string(getId()) + "::getHeaders::Application";
742 listener->unregListener(addr.c_str(), this);
746 template <class T> T* XMLApplication::doChainedPlugins(
747 PluginManager<T,string,const DOMElement*>& pluginMgr,
748 const char* pluginType,
749 const char* chainingType,
750 const XMLCh* localName,
753 const char* dummyType
757 DOMElement* child = XMLHelper::getFirstChildElement(e, localName);
759 // Check for multiple.
760 if (XMLHelper::getNextSiblingElement(child, localName)) {
761 log.info("multiple %s plugins, wrapping in a chain", pluginType);
762 DOMElement* chain = child->getOwnerDocument()->createElementNS(nullptr, localName);
764 chain->appendChild(child);
765 child = XMLHelper::getFirstChildElement(e, localName);
769 e->appendChild(chain);
772 // Only a single one.
773 t = XMLHelper::getAttrString(child, nullptr, _type);
778 log.info("building %s of type %s...", pluginType, t.c_str());
779 return pluginMgr.newPlugin(t.c_str(), child);
782 throw ConfigurationException("$1 element had no type attribute.", params(1, pluginType));
785 catch (std::exception& ex) {
786 log.crit("error building %s: %s", pluginType, ex.what());
788 // Install a dummy version as a safety valve.
789 log.crit("installing safe %s in place of failed version", pluginType);
790 return pluginMgr.newPlugin(dummyType, nullptr);
798 void XMLApplication::doAttributeInfo()
800 // Populate prefix pair.
801 m_attributePrefix.second = "HTTP_";
802 pair<bool,const char*> prefix = getString("attributePrefix");
804 m_attributePrefix.first = prefix.second;
805 const char* pch = prefix.second;
807 m_attributePrefix.second += (isalnum(*pch) ? toupper(*pch) : '_');
812 pair<bool,const char*> attributes = getString("REMOTE_USER");
813 if (attributes.first) {
814 string dup(attributes.second);
815 split(m_remoteUsers, dup, is_space(), algorithm::token_compress_on);
818 // Load attribute ID lists for REMOTE_USER and header clearing.
819 if (SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
820 attributes = getString("unsetHeaders");
821 if (attributes.first) {
822 string transformedprefix(m_attributePrefix.second);
824 prefix = getString("metadataAttributePrefix");
828 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
833 string dup(attributes.second);
834 vector<string> headerNames;
835 split(headerNames, dup, is_space(), algorithm::token_compress_on);
836 for (vector<string>::const_iterator h = headerNames.begin(); h != headerNames.end(); ++h) {
838 const char* pch = h->c_str();
840 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
843 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + *h, m_attributePrefix.second + transformed));
845 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + *h, transformedprefix + transformed));
847 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
852 void XMLApplication::doHandlers(const ProtocolProvider* pp, const DOMElement* e, Category& log)
854 SPConfig& conf = SPConfig::getConfig();
856 const PropertySet* sessions = getPropertySet("Sessions");
858 // Process assertion export handler.
859 pair<bool,const char*> location = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,nullptr);
860 if (location.first) {
862 DOMElement* exportElement = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _Handler);
863 exportElement->setAttributeNS(nullptr,Location,sessions->getXMLString("exportLocation").second);
864 pair<bool,const XMLCh*> exportACL = sessions->getXMLString("exportACL");
865 if (exportACL.first) {
866 static const XMLCh _acl[] = UNICODE_LITERAL_9(e,x,p,o,r,t,A,C,L);
867 exportElement->setAttributeNS(nullptr,_acl,exportACL.second);
869 boost::shared_ptr<Handler> exportHandler(
870 conf.HandlerManager.newPlugin(samlconstants::SAML20_BINDING_URI, pair<const DOMElement*,const char*>(exportElement, getId()))
872 m_handlers.push_back(exportHandler);
874 // Insert into location map. If it contains the handlerURL, we skip past that part.
875 const char* hurl = sessions->getString("handlerURL").second;
877 hurl = "/Shibboleth.sso";
878 const char* pch = strstr(location.second, hurl);
880 location.second = pch + strlen(hurl);
881 if (*location.second == '/')
882 m_handlerMap[location.second] = exportHandler.get();
884 m_handlerMap[string("/") + location.second] = exportHandler.get();
886 catch (std::exception& ex) {
887 log.error("caught exception installing assertion lookup handler: %s", ex.what());
891 // Look for "shorthand" elements first.
892 set<string> protocols;
893 DOMElement* child = sessions ? XMLHelper::getFirstChildElement(sessions->getElement()) : nullptr;
895 if (XMLHelper::isNodeNamed(child, shibspconstants::SHIB2SPCONFIG_NS, SSO)) {
897 doSSO(*pp, protocols, child, log);
899 log.error("no ProtocolProvider, SSO auto-configure unsupported");
901 else if (XMLHelper::isNodeNamed(child, shibspconstants::SHIB2SPCONFIG_NS, Logout)) {
903 doLogout(*pp, protocols, child, log);
905 log.error("no ProtocolProvider, Logout auto-configure unsupported");
907 else if (XMLHelper::isNodeNamed(child, shibspconstants::SHIB2SPCONFIG_NS, NameIDMgmt)) {
909 doNameIDMgmt(*pp, protocols, child, log);
911 log.error("no ProtocolProvider, NameIDMgmt auto-configure unsupported");
914 break; // drop into next while loop
916 child = XMLHelper::getNextSiblingElement(child);
919 // Process other handlers.
920 bool hardACS=false, hardSessionInit=false, hardArt=false;
922 if (!child->hasAttributeNS(nullptr, Location)) {
923 auto_ptr_char hclass(child->getLocalName());
924 log.error("%s handler with no Location property cannot be processed", hclass.get());
925 child = XMLHelper::getNextSiblingElement(child);
929 boost::shared_ptr<Handler> handler;
930 if (XMLString::equals(child->getLocalName(), _AssertionConsumerService)) {
931 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
932 if (bindprop.empty()) {
933 log.error("AssertionConsumerService element has no Binding attribute, skipping it...");
934 child = XMLHelper::getNextSiblingElement(child);
937 handler.reset(conf.AssertionConsumerServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
938 // Map by binding and protocol (may be > 1 per protocol and binding)
939 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler.get());
940 const XMLCh* protfamily = handler->getProtocolFamily();
942 m_acsProtocolMap[protfamily].push_back(handler.get());
943 m_acsIndexMap[handler->getUnsignedInt("index").second] = handler.get();
946 pair<bool,bool> defprop = handler->getBool("isDefault");
948 if (defprop.second) {
950 m_acsDefault = handler.get();
953 else if (!m_acsDefault)
954 m_acsDefault = handler.get();
957 else if (XMLString::equals(child->getLocalName(), _SessionInitiator)) {
958 string t(XMLHelper::getAttrString(child, nullptr, _type));
960 log.error("SessionInitiator element has no type attribute, skipping it...");
961 child = XMLHelper::getNextSiblingElement(child);
964 boost::shared_ptr<SessionInitiator> sihandler(
965 conf.SessionInitiatorManager.newPlugin(t.c_str(), pair<const DOMElement*,const char*>(child, getId()))
968 pair<bool,const char*> si_id = handler->getString("id");
969 if (si_id.first && si_id.second)
970 m_sessionInitMap[si_id.second] = sihandler.get();
971 if (!hardSessionInit) {
972 pair<bool,bool> defprop = handler->getBool("isDefault");
974 if (defprop.second) {
975 hardSessionInit = true;
976 m_sessionInitDefault = sihandler.get();
979 else if (!m_sessionInitDefault) {
980 m_sessionInitDefault = sihandler.get();
984 else if (XMLString::equals(child->getLocalName(), _LogoutInitiator)) {
985 string t(XMLHelper::getAttrString(child, nullptr, _type));
987 log.error("LogoutInitiator element has no type attribute, skipping it...");
988 child = XMLHelper::getNextSiblingElement(child);
991 handler.reset(conf.LogoutInitiatorManager.newPlugin(t.c_str(), pair<const DOMElement*,const char*>(child, getId())));
993 else if (XMLString::equals(child->getLocalName(), _ArtifactResolutionService)) {
994 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
995 if (bindprop.empty()) {
996 log.error("ArtifactResolutionService element has no Binding attribute, skipping it...");
997 child = XMLHelper::getNextSiblingElement(child);
1000 handler.reset(conf.ArtifactResolutionServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1003 pair<bool,bool> defprop = handler->getBool("isDefault");
1004 if (defprop.first) {
1005 if (defprop.second) {
1007 m_artifactResolutionDefault = handler.get();
1010 else if (!m_artifactResolutionDefault)
1011 m_artifactResolutionDefault = handler.get();
1014 else if (XMLString::equals(child->getLocalName(), _SingleLogoutService)) {
1015 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
1016 if (bindprop.empty()) {
1017 log.error("SingleLogoutService element has no Binding attribute, skipping it...");
1018 child = XMLHelper::getNextSiblingElement(child);
1021 handler.reset(conf.SingleLogoutServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1023 else if (XMLString::equals(child->getLocalName(), _ManageNameIDService)) {
1024 string bindprop(XMLHelper::getAttrString(child, nullptr, Binding));
1025 if (bindprop.empty()) {
1026 log.error("ManageNameIDService element has no Binding attribute, skipping it...");
1027 child = XMLHelper::getNextSiblingElement(child);
1030 handler.reset(conf.ManageNameIDServiceManager.newPlugin(bindprop.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1033 string t(XMLHelper::getAttrString(child, nullptr, _type));
1035 log.error("Handler element has no type attribute, skipping it...");
1036 child = XMLHelper::getNextSiblingElement(child);
1039 handler.reset(conf.HandlerManager.newPlugin(t.c_str(), pair<const DOMElement*,const char*>(child, getId())));
1042 m_handlers.push_back(handler);
1044 // Insert into location map.
1045 location = handler->getString("Location");
1046 if (location.first && *location.second == '/')
1047 m_handlerMap[location.second] = handler.get();
1048 else if (location.first)
1049 m_handlerMap[string("/") + location.second] = handler.get();
1051 catch (std::exception& ex) {
1052 log.error("caught exception processing handler element: %s", ex.what());
1055 child = XMLHelper::getNextSiblingElement(child);
1059 void XMLApplication::doSSO(const ProtocolProvider& pp, set<string>& protocols, DOMElement* e, Category& log)
1061 if (!e->hasChildNodes())
1064 SPConfig& conf = SPConfig::getConfig();
1066 int index = 0; // track ACS indexes globally across all protocols
1068 // Tokenize the protocol list inside the element.
1069 XMLStringTokenizer prottokens(e->getTextContent());
1070 while (prottokens.hasMoreTokens()) {
1071 auto_ptr_char prot(prottokens.nextToken());
1073 // Look for initiator.
1074 const PropertySet* initiator = pp.getInitiator(prot.get(), "SSO");
1076 log.info("auto-configuring SSO initiation for protocol (%s)", prot.get());
1077 pair<bool,const XMLCh*> inittype = initiator->getXMLString("id");
1078 if (inittype.first) {
1079 // Append a session initiator element of the designated type to the root element.
1080 DOMElement* sidom = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _SessionInitiator);
1081 sidom->setAttributeNS(nullptr, _type, inittype.second);
1082 e->appendChild(sidom);
1083 log.info("adding SessionInitiator of type (%s) to chain (/Login)", initiator->getString("id").second);
1085 doArtifactResolution(pp, prot.get(), e, log);
1086 protocols.insert(prot.get());
1089 log.error("missing id property on Initiator element, check config for protocol (%s)", prot.get());
1093 // Look for incoming bindings.
1094 const vector<const PropertySet*>& bindings = pp.getBindings(prot.get(), "SSO");
1095 if (!bindings.empty()) {
1096 log.info("auto-configuring SSO endpoints for protocol (%s)", prot.get());
1097 pair<bool,const XMLCh*> idprop,pathprop;
1098 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b, ++index) {
1099 idprop = (*b)->getXMLString("id");
1100 pathprop = (*b)->getXMLString("path");
1101 if (idprop.first && pathprop.first) {
1102 DOMElement* acsdom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _AssertionConsumerService);
1103 acsdom->setAttributeNS(nullptr, Binding, idprop.second);
1104 acsdom->setAttributeNS(nullptr, Location, pathprop.second);
1105 xstring indexbuf(1, chDigit_1 + (index % 10));
1107 indexbuf = (XMLCh)(chDigit_1 + (index / 10)) + indexbuf;
1108 acsdom->setAttributeNS(nullptr, _index, indexbuf.c_str());
1110 log.info("adding AssertionConsumerService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1111 boost::shared_ptr<Handler> handler(
1112 conf.AssertionConsumerServiceManager.newPlugin(
1113 (*b)->getString("id").second, pair<const DOMElement*,const char*>(acsdom, getId())
1116 m_handlers.push_back(handler);
1118 // Setup maps and defaults.
1119 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler.get());
1120 const XMLCh* protfamily = handler->getProtocolFamily();
1122 m_acsProtocolMap[protfamily].push_back(handler.get());
1123 m_acsIndexMap[handler->getUnsignedInt("index").second] = handler.get();
1125 m_acsDefault = handler.get();
1127 // Insert into location map.
1128 pair<bool,const char*> location = handler->getString("Location");
1129 if (location.first && *location.second == '/')
1130 m_handlerMap[location.second] = handler.get();
1131 else if (location.first)
1132 m_handlerMap[string("/") + location.second] = handler.get();
1135 log.error("missing id or path property on Binding element, check config for protocol (%s)", prot.get());
1140 if (!initiator && bindings.empty()) {
1141 log.error("no SSO Initiator or Binding config for protocol (%s)", prot.get());
1145 // Handle discovery.
1146 static const XMLCh discoveryProtocol[] = UNICODE_LITERAL_17(d,i,s,c,o,v,e,r,y,P,r,o,t,o,c,o,l);
1147 static const XMLCh discoveryURL[] = UNICODE_LITERAL_12(d,i,s,c,o,v,e,r,y,U,R,L);
1148 static const XMLCh _URL[] = UNICODE_LITERAL_3(U,R,L);
1149 const XMLCh* discop = e->getAttributeNS(nullptr, discoveryProtocol);
1150 if (discop && *discop) {
1151 const XMLCh* discou = e->getAttributeNS(nullptr, discoveryURL);
1152 if (discou && *discou) {
1153 // Append a session initiator element of the designated type to the root element.
1154 DOMElement* sidom = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _SessionInitiator);
1155 sidom->setAttributeNS(nullptr, _type, discop);
1156 sidom->setAttributeNS(nullptr, _URL, discou);
1157 e->appendChild(sidom);
1158 if (log.isInfoEnabled()) {
1159 auto_ptr_char dp(discop);
1160 log.info("adding SessionInitiator of type (%s) to chain (/Login)", dp.get());
1164 log.error("SSO discoveryProtocol specified without discoveryURL");
1168 // Attach default Location to SSO element.
1169 static const XMLCh _loc[] = { chForwardSlash, chLatin_L, chLatin_o, chLatin_g, chLatin_i, chLatin_n, chNull };
1170 e->setAttributeNS(nullptr, Location, _loc);
1172 // Instantiate Chaining initiator around the SSO element.
1173 boost::shared_ptr<SessionInitiator> chain(
1174 conf.SessionInitiatorManager.newPlugin(CHAINING_SESSION_INITIATOR, pair<const DOMElement*,const char*>(e, getId()))
1176 m_handlers.push_back(chain);
1177 m_sessionInitDefault = chain.get();
1178 m_handlerMap["/Login"] = chain.get();
1181 void XMLApplication::doLogout(const ProtocolProvider& pp, set<string>& protocols, DOMElement* e, Category& log)
1183 if (!e->hasChildNodes())
1186 SPConfig& conf = SPConfig::getConfig();
1188 // Tokenize the protocol list inside the element.
1189 XMLStringTokenizer prottokens(e->getTextContent());
1190 while (prottokens.hasMoreTokens()) {
1191 auto_ptr_char prot(prottokens.nextToken());
1193 // Look for initiator.
1194 const PropertySet* initiator = pp.getInitiator(prot.get(), "Logout");
1196 log.info("auto-configuring Logout initiation for protocol (%s)", prot.get());
1197 pair<bool,const XMLCh*> inittype = initiator->getXMLString("id");
1198 if (inittype.first) {
1199 // Append a logout initiator element of the designated type to the root element.
1200 DOMElement* lidom = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, _LogoutInitiator);
1201 lidom->setAttributeNS(nullptr, _type, inittype.second);
1202 e->appendChild(lidom);
1203 log.info("adding LogoutInitiator of type (%s) to chain (/Logout)", initiator->getString("id").second);
1205 if (protocols.count(prot.get()) == 0) {
1206 doArtifactResolution(pp, prot.get(), e, log);
1207 protocols.insert(prot.get());
1211 log.error("missing id property on Initiator element, check config for protocol (%s)", prot.get());
1215 // Look for incoming bindings.
1216 const vector<const PropertySet*>& bindings = pp.getBindings(prot.get(), "Logout");
1217 if (!bindings.empty()) {
1218 log.info("auto-configuring Logout endpoints for protocol (%s)", prot.get());
1219 pair<bool,const XMLCh*> idprop,pathprop;
1220 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
1221 idprop = (*b)->getXMLString("id");
1222 pathprop = (*b)->getXMLString("path");
1223 if (idprop.first && pathprop.first) {
1224 DOMElement* slodom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _SingleLogoutService);
1225 slodom->setAttributeNS(nullptr, Binding, idprop.second);
1226 slodom->setAttributeNS(nullptr, Location, pathprop.second);
1228 log.info("adding SingleLogoutService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1229 boost::shared_ptr<Handler> handler(
1230 conf.SingleLogoutServiceManager.newPlugin((*b)->getString("id").second, pair<const DOMElement*,const char*>(slodom, getId()))
1232 m_handlers.push_back(handler);
1234 // Insert into location map.
1235 pair<bool,const char*> location = handler->getString("Location");
1236 if (location.first && *location.second == '/')
1237 m_handlerMap[location.second] = handler.get();
1238 else if (location.first)
1239 m_handlerMap[string("/") + location.second] = handler.get();
1242 log.error("missing id or path property on Binding element, check config for protocol (%s)", prot.get());
1246 if (protocols.count(prot.get()) == 0) {
1247 doArtifactResolution(pp, prot.get(), e, log);
1248 protocols.insert(prot.get());
1252 if (!initiator && bindings.empty()) {
1253 log.error("no Logout Initiator or Binding config for protocol (%s)", prot.get());
1257 // Attach default Location to Logout element.
1258 static const XMLCh _loc[] = { chForwardSlash, chLatin_L, chLatin_o, chLatin_g, chLatin_o, chLatin_u, chLatin_t, chNull };
1259 e->setAttributeNS(nullptr, Location, _loc);
1261 // Instantiate Chaining initiator around the SSO element.
1262 boost::shared_ptr<Handler> chain(
1263 conf.LogoutInitiatorManager.newPlugin(CHAINING_LOGOUT_INITIATOR, pair<const DOMElement*,const char*>(e, getId()))
1265 m_handlers.push_back(chain);
1266 m_handlerMap["/Logout"] = chain.get();
1269 void XMLApplication::doNameIDMgmt(const ProtocolProvider& pp, set<string>& protocols, DOMElement* e, Category& log)
1271 if (!e->hasChildNodes())
1274 SPConfig& conf = SPConfig::getConfig();
1276 // Tokenize the protocol list inside the element.
1277 XMLStringTokenizer prottokens(e->getTextContent());
1278 while (prottokens.hasMoreTokens()) {
1279 auto_ptr_char prot(prottokens.nextToken());
1281 // Look for incoming bindings.
1282 const vector<const PropertySet*>& bindings = pp.getBindings(prot.get(), "NameIDMgmt");
1283 if (!bindings.empty()) {
1284 log.info("auto-configuring NameIDMgmt endpoints for protocol (%s)", prot.get());
1285 pair<bool,const XMLCh*> idprop,pathprop;
1286 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
1287 idprop = (*b)->getXMLString("id");
1288 pathprop = (*b)->getXMLString("path");
1289 if (idprop.first && pathprop.first) {
1290 DOMElement* nimdom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _ManageNameIDService);
1291 nimdom->setAttributeNS(nullptr, Binding, idprop.second);
1292 nimdom->setAttributeNS(nullptr, Location, pathprop.second);
1294 log.info("adding ManageNameIDService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1295 boost::shared_ptr<Handler> handler(
1296 conf.ManageNameIDServiceManager.newPlugin((*b)->getString("id").second, pair<const DOMElement*,const char*>(nimdom, getId()))
1298 m_handlers.push_back(handler);
1300 // Insert into location map.
1301 pair<bool,const char*> location = handler->getString("Location");
1302 if (location.first && *location.second == '/')
1303 m_handlerMap[location.second] = handler.get();
1304 else if (location.first)
1305 m_handlerMap[string("/") + location.second] = handler.get();
1308 log.error("missing id or path property on Binding element, check config for protocol (%s)", prot.get());
1312 if (protocols.count(prot.get()) == 0) {
1313 doArtifactResolution(pp, prot.get(), e, log);
1314 protocols.insert(prot.get());
1318 log.error("no NameIDMgmt Binding config for protocol (%s)", prot.get());
1323 void XMLApplication::doArtifactResolution(const ProtocolProvider& pp, const char* protocol, DOMElement* e, Category& log)
1325 SPConfig& conf = SPConfig::getConfig();
1327 int index = 0; // track indexes globally across all protocols
1329 // Look for incoming bindings.
1330 const vector<const PropertySet*>& bindings = pp.getBindings(protocol, "ArtifactResolution");
1331 if (!bindings.empty()) {
1332 log.info("auto-configuring ArtifactResolution endpoints for protocol (%s)", protocol);
1333 pair<bool,const XMLCh*> idprop,pathprop;
1334 for (vector<const PropertySet*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b, ++index) {
1335 idprop = (*b)->getXMLString("id");
1336 pathprop = (*b)->getXMLString("path");
1337 if (idprop.first && pathprop.first) {
1338 DOMElement* artdom = e->getOwnerDocument()->createElementNS(samlconstants::SAML20MD_NS, _ArtifactResolutionService);
1339 artdom->setAttributeNS(nullptr, Binding, idprop.second);
1340 artdom->setAttributeNS(nullptr, Location, pathprop.second);
1341 xstring indexbuf(1, chDigit_1 + (index % 10));
1343 indexbuf = (XMLCh)(chDigit_1 + (index / 10)) + indexbuf;
1344 artdom->setAttributeNS(nullptr, _index, indexbuf.c_str());
1346 log.info("adding ArtifactResolutionService for Binding (%s) at (%s)", (*b)->getString("id").second, (*b)->getString("path").second);
1347 boost::shared_ptr<Handler> handler(
1348 conf.ArtifactResolutionServiceManager.newPlugin((*b)->getString("id").second, pair<const DOMElement*,const char*>(artdom, getId()))
1350 m_handlers.push_back(handler);
1352 if (!m_artifactResolutionDefault)
1353 m_artifactResolutionDefault = handler.get();
1355 // Insert into location map.
1356 pair<bool,const char*> location = handler->getString("Location");
1357 if (location.first && *location.second == '/')
1358 m_handlerMap[location.second] = handler.get();
1359 else if (location.first)
1360 m_handlerMap[string("/") + location.second] = handler.get();
1363 log.error("missing id or path property on Binding element, check config for protocol (%s)", protocol);
1370 void XMLApplication::doAttributePlugins(DOMElement* e, Category& log)
1372 SPConfig& conf = SPConfig::getConfig();
1374 m_attrExtractor.reset(
1375 doChainedPlugins(conf.AttributeExtractorManager, "AttributeExtractor", CHAINING_ATTRIBUTE_EXTRACTOR, _AttributeExtractor, e, log)
1379 doChainedPlugins(conf.AttributeFilterManager, "AttributeFilter", CHAINING_ATTRIBUTE_FILTER, _AttributeFilter, e, log, DUMMY_ATTRIBUTE_FILTER)
1382 m_attrResolver.reset(
1383 doChainedPlugins(conf.AttributeResolverManager, "AttributeResolver", CHAINING_ATTRIBUTE_RESOLVER, _AttributeResolver, e, log)
1386 if (m_unsetHeaders.empty()) {
1387 vector<string> unsetHeaders;
1388 if (m_attrExtractor) {
1389 Locker extlock(m_attrExtractor.get());
1390 m_attrExtractor->getAttributeIds(unsetHeaders);
1392 else if (m_base && m_base->m_attrExtractor) {
1393 Locker extlock(m_base->m_attrExtractor.get());
1394 m_base->m_attrExtractor->getAttributeIds(unsetHeaders);
1396 if (m_attrResolver) {
1397 Locker reslock(m_attrResolver.get());
1398 m_attrResolver->getAttributeIds(unsetHeaders);
1400 else if (m_base && m_base->m_attrResolver) {
1401 Locker extlock(m_base->m_attrResolver.get());
1402 m_base->m_attrResolver->getAttributeIds(unsetHeaders);
1404 if (!unsetHeaders.empty()) {
1405 string transformedprefix(m_attributePrefix.second);
1407 pair<bool,const char*> prefix = getString("metadataAttributePrefix");
1409 pch = prefix.second;
1411 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
1415 for (vector<string>::const_iterator hdr = unsetHeaders.begin(); hdr!=unsetHeaders.end(); ++hdr) {
1419 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
1422 m_unsetHeaders.push_back(make_pair(m_attributePrefix.first + *hdr, m_attributePrefix.second + transformed));
1424 m_unsetHeaders.push_back(make_pair(m_attributePrefix.first + prefix.second + *hdr, transformedprefix + transformed));
1427 m_unsetHeaders.push_back(make_pair(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
1432 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
1435 DOMNodeFilter::FilterAction
1437 XMLApplication::acceptNode(const DOMNode* node) const
1439 const XMLCh* name=node->getLocalName();
1440 if (XMLString::equals(name,ApplicationOverride) ||
1441 XMLString::equals(name,_Audience) ||
1442 XMLString::equals(name,Notify) ||
1443 XMLString::equals(name,_Handler) ||
1444 XMLString::equals(name,_AssertionConsumerService) ||
1445 XMLString::equals(name,_ArtifactResolutionService) ||
1446 XMLString::equals(name,Logout) ||
1447 XMLString::equals(name,_LogoutInitiator) ||
1448 XMLString::equals(name,_ManageNameIDService) ||
1449 XMLString::equals(name,NameIDMgmt) ||
1450 XMLString::equals(name,_SessionInitiator) ||
1451 XMLString::equals(name,_SingleLogoutService) ||
1452 XMLString::equals(name,SSO) ||
1453 XMLString::equals(name,RelyingParty) ||
1454 XMLString::equals(name,_MetadataProvider) ||
1455 XMLString::equals(name,_TrustEngine) ||
1456 XMLString::equals(name,_CredentialResolver) ||
1457 XMLString::equals(name,_AttributeFilter) ||
1458 XMLString::equals(name,_AttributeExtractor) ||
1459 XMLString::equals(name,_AttributeResolver))
1460 return FILTER_REJECT;
1462 return FILTER_ACCEPT;
1467 const PropertySet* XMLApplication::getRelyingParty(const EntityDescriptor* provider) const
1472 // Check for exact match on name.
1473 map< xstring,boost::shared_ptr<PropertySet> >::const_iterator i = m_partyMap.find(provider->getEntityID());
1474 if (i != m_partyMap.end())
1475 return i->second.get();
1477 // Check for extensible matching.
1478 vector < pair< boost::shared_ptr<EntityMatcher>,boost::shared_ptr<PropertySet> > >::const_iterator j;
1479 for (j = m_partyVec.begin(); j != m_partyVec.end(); ++j) {
1480 if (j->first->matches(*provider))
1481 return j->second.get();
1484 // Check for group match.
1485 const EntitiesDescriptor* group = dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
1487 if (group->getName()) {
1488 i = m_partyMap.find(group->getName());
1489 if (i != m_partyMap.end())
1490 return i->second.get();
1492 group = dynamic_cast<const EntitiesDescriptor*>(group->getParent());
1497 const PropertySet* XMLApplication::getRelyingParty(const XMLCh* entityID) const
1501 map< xstring,boost::shared_ptr<PropertySet> >::const_iterator i = m_partyMap.find(entityID);
1502 return (i != m_partyMap.end()) ? i->second.get() : this;
1507 string XMLApplication::getNotificationURL(const char* resource, bool front, unsigned int index) const
1509 const vector<string>& locs = front ? m_frontLogout : m_backLogout;
1511 return m_base ? m_base->getNotificationURL(resource, front, index) : string();
1512 else if (index >= locs.size())
1515 #ifdef HAVE_STRCASECMP
1516 if (!resource || (strncasecmp(resource,"http://",7) && strncasecmp(resource,"https://",8)))
1518 if (!resource || (strnicmp(resource,"http://",7) && strnicmp(resource,"https://",8)))
1520 throw ConfigurationException("Request URL was not absolute.");
1522 const char* handler = locs[index].c_str();
1524 // Should never happen...
1525 if (!handler || (*handler!='/' && strncmp(handler,"http:",5) && strncmp(handler,"https:",6)))
1526 throw ConfigurationException(
1527 "Invalid Location property ($1) in Notify element for Application ($2)",
1528 params(2, handler ? handler : "null", getId())
1531 // The "Location" property can be in one of three formats:
1533 // 1) a full URI: http://host/foo/bar
1534 // 2) a hostless URI: http:///foo/bar
1535 // 3) a relative path: /foo/bar
1537 // # Protocol Host Path
1538 // 1 handler handler handler
1539 // 2 handler resource handler
1540 // 3 resource resource handler
1542 const char* path = nullptr;
1544 // Decide whether to use the handler or the resource for the "protocol"
1546 if (*handler != '/') {
1554 // break apart the "protocol" string into protocol, host, and "the rest"
1555 const char* colon=strchr(prot,':');
1557 const char* slash=strchr(colon,'/');
1561 // Compute the actual protocol and store.
1562 string notifyURL(prot, colon-prot);
1564 // create the "host" from either the colon/slash or from the target string
1565 // If prot == handler then we're in either #1 or #2, else #3.
1566 // If slash == colon then we're in #2.
1567 if (prot != handler || slash == colon) {
1568 colon = strchr(resource, ':');
1569 colon += 3; // Get past the ://
1570 slash = strchr(colon, '/');
1572 string host(colon, (slash ? slash-colon : strlen(colon)));
1575 notifyURL += host + path;
1579 void XMLApplication::clearHeader(SPRequest& request, const char* rawname, const char* cginame) const
1581 if (!m_attributePrefix.first.empty()) {
1582 string temp = m_attributePrefix.first + rawname;
1583 string temp2 = m_attributePrefix.second + (cginame + 5);
1584 request.clearHeader(temp.c_str(), temp2.c_str());
1587 m_base->clearHeader(request, rawname, cginame);
1590 request.clearHeader(rawname, cginame);
1594 void XMLApplication::setHeader(SPRequest& request, const char* name, const char* value) const
1596 if (!m_attributePrefix.first.empty()) {
1597 string temp = m_attributePrefix.first + name;
1598 request.setHeader(temp.c_str(), value);
1601 m_base->setHeader(request, name, value);
1604 request.setHeader(name, value);
1608 string XMLApplication::getSecureHeader(const SPRequest& request, const char* name) const
1610 if (!m_attributePrefix.first.empty()) {
1611 string temp = m_attributePrefix.first + name;
1612 return request.getSecureHeader(temp.c_str());
1615 return m_base->getSecureHeader(request,name);
1618 return request.getSecureHeader(name);
1622 const SessionInitiator* XMLApplication::getDefaultSessionInitiator() const
1624 if (m_sessionInitDefault) return m_sessionInitDefault;
1625 return m_base ? m_base->getDefaultSessionInitiator() : nullptr;
1628 const SessionInitiator* XMLApplication::getSessionInitiatorById(const char* id) const
1630 map<string,const SessionInitiator*>::const_iterator i = m_sessionInitMap.find(id);
1631 if (i != m_sessionInitMap.end()) return i->second;
1632 return m_base ? m_base->getSessionInitiatorById(id) : nullptr;
1635 const Handler* XMLApplication::getDefaultAssertionConsumerService() const
1637 if (m_acsDefault) return m_acsDefault;
1638 return m_base ? m_base->getDefaultAssertionConsumerService() : nullptr;
1641 const Handler* XMLApplication::getAssertionConsumerServiceByIndex(unsigned short index) const
1643 map<unsigned int,const Handler*>::const_iterator i = m_acsIndexMap.find(index);
1644 if (i != m_acsIndexMap.end()) return i->second;
1645 return m_base ? m_base->getAssertionConsumerServiceByIndex(index) : nullptr;
1648 const Handler* XMLApplication::getAssertionConsumerServiceByProtocol(const XMLCh* protocol, const char* binding) const
1650 ACSProtocolMap::const_iterator i = m_acsProtocolMap.find(protocol);
1651 if (i != m_acsProtocolMap.end() && !i->second.empty()) {
1652 if (!binding || !*binding)
1653 return i->second.front();
1654 for (ACSProtocolMap::value_type::second_type::const_iterator j = i->second.begin(); j != i->second.end(); ++j) {
1655 if (!strcmp(binding, (*j)->getString("Binding").second))
1659 return m_base ? m_base->getAssertionConsumerServiceByProtocol(protocol, binding) : nullptr;
1662 const vector<const Handler*>& XMLApplication::getAssertionConsumerServicesByBinding(const XMLCh* binding) const
1664 ACSBindingMap::const_iterator i = m_acsBindingMap.find(binding);
1665 if (i != m_acsBindingMap.end())
1667 return m_base ? m_base->getAssertionConsumerServicesByBinding(binding) : g_noHandlers;
1670 const Handler* XMLApplication::getHandler(const char* path) const
1673 wrap = wrap.substr(0, wrap.find(';'));
1674 map<string,const Handler*>::const_iterator i = m_handlerMap.find(wrap.substr(0, wrap.find('?')));
1675 if (i != m_handlerMap.end())
1677 return m_base ? m_base->getHandler(path) : nullptr;
1680 void XMLApplication::getHandlers(vector<const Handler*>& handlers) const
1682 static void (vector<const Handler*>::* pb)(const Handler* const&) = &vector<const Handler*>::push_back;
1683 for_each(m_handlers.begin(), m_handlers.end(), boost::bind(pb, boost::ref(handlers), boost::bind(&boost::shared_ptr<Handler>::get, _1)));
1685 for (map<string,const Handler*>::const_iterator h = m_base->m_handlerMap.begin(); h != m_base->m_handlerMap.end(); ++h) {
1686 if (m_handlerMap.count(h->first) == 0)
1687 handlers.push_back(h->second);
1692 void XMLApplication::limitRedirect(const GenericRequest& request, const char* url) const
1694 if (!url || *url == '/')
1696 if (m_redirectLimit == REDIRECT_LIMIT_INHERIT)
1697 return m_base->limitRedirect(request, url);
1698 if (m_redirectLimit != REDIRECT_LIMIT_NONE) {
1699 vector<string> whitelist;
1700 if (m_redirectLimit == REDIRECT_LIMIT_EXACT || m_redirectLimit == REDIRECT_LIMIT_EXACT_WHITELIST) {
1701 // Scheme and hostname have to match.
1702 if (request.isDefaultPort()) {
1703 whitelist.push_back(string(request.getScheme()) + "://" + request.getHostname() + '/');
1705 whitelist.push_back(string(request.getScheme()) + "://" + request.getHostname() + ':' + lexical_cast<string>(request.getPort()) + '/');
1707 else if (m_redirectLimit == REDIRECT_LIMIT_HOST || m_redirectLimit == REDIRECT_LIMIT_HOST_WHITELIST) {
1708 // Allow any scheme or port.
1709 whitelist.push_back(string("https://") + request.getHostname() + '/');
1710 whitelist.push_back(string("http://") + request.getHostname() + '/');
1711 whitelist.push_back(string("https://") + request.getHostname() + ':');
1712 whitelist.push_back(string("http://") + request.getHostname() + ':');
1715 static bool (*startsWithI)(const char*,const char*) = XMLString::startsWithI;
1716 if (!whitelist.empty() && find_if(whitelist.begin(), whitelist.end(),
1717 boost::bind(startsWithI, url, boost::bind(&string::c_str, _1))) != whitelist.end()) {
1720 else if (!m_redirectWhitelist.empty() && find_if(m_redirectWhitelist.begin(), m_redirectWhitelist.end(),
1721 boost::bind(startsWithI, url, boost::bind(&string::c_str, _1))) != m_redirectWhitelist.end()) {
1724 Category::getInstance(SHIBSP_LOGCAT".Application").warn("redirectLimit policy enforced, blocked redirect to (%s)", url);
1725 throw opensaml::SecurityPolicyException("Blocked unacceptable redirect location.");
1729 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
1732 DOMNodeFilter::FilterAction
1734 XMLConfigImpl::acceptNode(const DOMNode* node) const
1736 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
1737 return FILTER_ACCEPT;
1738 const XMLCh* name=node->getLocalName();
1739 if (XMLString::equals(name,ApplicationDefaults) ||
1740 XMLString::equals(name,_ArtifactMap) ||
1741 XMLString::equals(name,_Extensions) ||
1742 XMLString::equals(name,Listener) ||
1743 XMLString::equals(name,_ProtocolProvider) ||
1744 XMLString::equals(name,_RequestMapper) ||
1745 XMLString::equals(name,_ReplayCache) ||
1746 XMLString::equals(name,SecurityPolicies) ||
1747 XMLString::equals(name,_SecurityPolicyProvider) ||
1748 XMLString::equals(name,_SessionCache) ||
1749 XMLString::equals(name,Site) ||
1750 XMLString::equals(name,_StorageService) ||
1751 XMLString::equals(name,TCPListener) ||
1752 XMLString::equals(name,TransportOption) ||
1753 XMLString::equals(name,UnixListener))
1754 return FILTER_REJECT;
1756 return FILTER_ACCEPT;
1759 void XMLConfigImpl::doExtensions(const DOMElement* e, const char* label, Category& log)
1761 const DOMElement* exts = XMLHelper::getFirstChildElement(e, _Extensions);
1763 exts = XMLHelper::getFirstChildElement(exts, Library);
1765 string path(XMLHelper::getAttrString(exts, nullptr, _path));
1767 if (!path.empty()) {
1768 if (!XMLToolingConfig::getConfig().load_library(path.c_str(), (void*)exts))
1769 throw ConfigurationException("XMLToolingConfig::load_library failed.");
1770 log.debug("loaded %s extension library (%s)", label, path.c_str());
1773 catch (std::exception& e) {
1774 if (XMLHelper::getAttrBool(exts, false, _fatal)) {
1775 log.fatal("unable to load mandatory %s extension library %s: %s", label, path.c_str(), e.what());
1779 log.crit("unable to load optional %s extension library %s: %s", label, path.c_str(), e.what());
1782 exts = XMLHelper::getNextSiblingElement(exts, Library);
1787 void XMLConfigImpl::doListener(const DOMElement* e, XMLConfig* conf, Category& log)
1790 string plugtype(TCP_LISTENER_SERVICE);
1792 string plugtype(UNIX_LISTENER_SERVICE);
1794 DOMElement* child = XMLHelper::getFirstChildElement(e, UnixListener);
1796 plugtype = UNIX_LISTENER_SERVICE;
1798 child = XMLHelper::getFirstChildElement(e, TCPListener);
1800 plugtype = TCP_LISTENER_SERVICE;
1802 child = XMLHelper::getFirstChildElement(e, Listener);
1804 auto_ptr_char type(child->getAttributeNS(nullptr, _type));
1805 if (type.get() && *type.get())
1806 plugtype = type.get();
1811 log.info("building ListenerService of type %s...", plugtype.c_str());
1812 conf->m_listener.reset(SPConfig::getConfig().ListenerServiceManager.newPlugin(plugtype.c_str(), child));
1815 void XMLConfigImpl::doCaching(const DOMElement* e, XMLConfig* conf, Category& log)
1817 SPConfig& spConf = SPConfig::getConfig();
1819 SAMLConfig& samlConf = SAMLConfig::getConfig();
1824 if (spConf.isEnabled(SPConfig::OutOfProcess)) {
1825 XMLToolingConfig& xmlConf = XMLToolingConfig::getConfig();
1826 // First build any StorageServices.
1827 child = XMLHelper::getFirstChildElement(e, _StorageService);
1829 string id(XMLHelper::getAttrString(child, nullptr, _id));
1830 string t(XMLHelper::getAttrString(child, nullptr, _type));
1833 log.info("building StorageService (%s) of type %s...", id.c_str(), t.c_str());
1834 conf->m_storage[id] = boost::shared_ptr<StorageService>(xmlConf.StorageServiceManager.newPlugin(t.c_str(), child));
1836 catch (std::exception& ex) {
1837 log.crit("failed to instantiate StorageService (%s): %s", id.c_str(), ex.what());
1840 child = XMLHelper::getNextSiblingElement(child, _StorageService);
1843 if (conf->m_storage.empty()) {
1844 log.info("no StorageService plugin(s) installed, using (mem) in-memory instance");
1845 conf->m_storage["mem"] = boost::shared_ptr<StorageService>(xmlConf.StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE, nullptr));
1849 StorageService* replaySS = nullptr;
1850 child = XMLHelper::getFirstChildElement(e, _ReplayCache);
1852 string ssid(XMLHelper::getAttrString(child, nullptr, _StorageService));
1853 if (!ssid.empty()) {
1854 if (conf->m_storage.count(ssid)) {
1855 log.info("building ReplayCache on top of StorageService (%s)...", ssid.c_str());
1856 replaySS = conf->m_storage[ssid].get();
1859 log.error("unable to locate StorageService (%s), using arbitrary instance for ReplayCache", ssid.c_str());
1860 replaySS = conf->m_storage.begin()->second.get();
1864 log.info("no StorageService specified for ReplayCache, using arbitrary instance");
1865 replaySS = conf->m_storage.begin()->second.get();
1869 log.info("no ReplayCache specified, using arbitrary StorageService instance");
1870 replaySS = conf->m_storage.begin()->second.get();
1872 xmlConf.setReplayCache(new ReplayCache(replaySS));
1875 child = XMLHelper::getFirstChildElement(e, _ArtifactMap);
1877 string ssid(XMLHelper::getAttrString(child, nullptr, _StorageService));
1878 if (!ssid.empty()) {
1879 if (conf->m_storage.count(ssid)) {
1880 log.info("building ArtifactMap on top of StorageService (%s)...", ssid.c_str());
1881 samlConf.setArtifactMap(new ArtifactMap(child, conf->m_storage[ssid].get()));
1884 log.error("unable to locate StorageService (%s), using in-memory ArtifactMap", ssid.c_str());
1885 samlConf.setArtifactMap(new ArtifactMap(child));
1889 log.info("no StorageService specified, using in-memory ArtifactMap");
1890 samlConf.setArtifactMap(new ArtifactMap(child));
1894 log.info("no ArtifactMap specified, building in-memory ArtifactMap...");
1895 samlConf.setArtifactMap(new ArtifactMap(child));
1897 } // end of out of process caching components
1900 child = XMLHelper::getFirstChildElement(e, _SessionCache);
1902 string t(XMLHelper::getAttrString(child, nullptr, _type));
1904 log.info("building SessionCache of type %s...", t.c_str());
1905 conf->m_sessionCache.reset(spConf.SessionCacheManager.newPlugin(t.c_str(), child));
1908 if (!conf->m_sessionCache) {
1909 log.info("no SessionCache specified, using StorageService-backed instance");
1910 conf->m_sessionCache.reset(spConf.SessionCacheManager.newPlugin(STORAGESERVICE_SESSION_CACHE, nullptr));
1914 XMLConfigImpl::XMLConfigImpl(const DOMElement* e, bool first, XMLConfig* outer, Category& log) : m_document(nullptr)
1917 xmltooling::NDC ndc("XMLConfigImpl");
1919 SPConfig& conf=SPConfig::getConfig();
1920 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
1921 const DOMElement* SHAR=XMLHelper::getFirstChildElement(e, OutOfProcess);
1922 const DOMElement* SHIRE=XMLHelper::getFirstChildElement(e, InProcess);
1924 // Initialize logging manually in order to redirect log messages as soon as possible.
1925 if (conf.isEnabled(SPConfig::Logging)) {
1927 if (conf.isEnabled(SPConfig::OutOfProcess))
1928 logconf = XMLHelper::getAttrString(SHAR, nullptr, logger);
1929 else if (conf.isEnabled(SPConfig::InProcess))
1930 logconf = XMLHelper::getAttrString(SHIRE, nullptr, logger);
1931 if (logconf.empty())
1932 logconf = XMLHelper::getAttrString(e, nullptr, logger);
1933 if (logconf.empty() && !getenv("SHIBSP_LOGGING")) {
1934 // No properties found, so default them.
1935 if (conf.isEnabled(SPConfig::OutOfProcess) && !conf.isEnabled(SPConfig::InProcess))
1936 logconf = "shibd.logger";
1937 else if (!conf.isEnabled(SPConfig::OutOfProcess) && conf.isEnabled(SPConfig::InProcess))
1938 logconf = "native.logger";
1940 logconf = "shibboleth.logger";
1942 if (!logconf.empty()) {
1943 log.debug("loading new logging configuration from (%s), check log destination for status of configuration", logconf.c_str());
1944 if (!XMLToolingConfig::getConfig().log_config(logconf.c_str()))
1945 log.crit("failed to load new logging configuration from (%s)", logconf.c_str());
1951 XMLHelper::getAttrString(SHAR, nullptr, tranLogFormat).c_str(),
1952 XMLHelper::getAttrString(SHAR, nullptr, tranLogFiller).c_str()
1958 // Re-log library versions now that logging is set up.
1959 log.info("Shibboleth SP Version %s", PACKAGE_VERSION);
1962 "Library versions: %s %s, Xerces-C %s, XML-Security-C %s, XMLTooling-C %s, OpenSAML-C %s, Shibboleth %s",
1963 # if defined(LOG4SHIB_VERSION)
1964 "log4shib", LOG4SHIB_VERSION,
1965 # elif defined(LOG4CPP_VERSION)
1966 "log4cpp", LOG4CPP_VERSION,
1970 XERCES_FULLVERSIONDOT, XSEC_FULLVERSIONDOT, gXMLToolingDotVersionStr, gOpenSAMLDotVersionStr, gShibSPDotVersionStr
1974 "Library versions: %s %s, Xerces-C %s, XMLTooling-C %s, Shibboleth %s",
1975 # if defined(LOG4SHIB_VERSION)
1976 "log4shib", LOG4SHIB_VERSION,
1977 # elif defined(LOG4CPP_VERSION)
1978 "log4cpp", LOG4CPP_VERSION,
1982 XERCES_FULLVERSIONDOT, gXMLToolingDotVersionStr, gShibSPDotVersionStr
1986 // First load any property sets.
1987 load(e, nullptr, this);
1991 // Much of the processing can only occur on the first instantiation.
1994 pair<bool,unsigned int> skew=getUnsignedInt("clockSkew");
1996 xmlConf.clock_skew_secs=min(skew.second,(60*60*24*7*28));
1998 pair<bool,const char*> unsafe = getString("unsafeChars");
2000 TemplateEngine::unsafe_chars = unsafe.second;
2002 unsafe = getString("allowedSchemes");
2004 HTTPResponse::getAllowedSchemes().clear();
2005 string schemes(unsafe.second);
2006 split(HTTPResponse::getAllowedSchemes(), schemes, is_space(), algorithm::token_compress_on);
2009 // Default language handling.
2010 pair<bool,bool> langFromClient = getBool("langFromClient");
2011 pair<bool,const XMLCh*> langPriority = getXMLString("langPriority");
2012 GenericRequest::setLangDefaults(!langFromClient.first || langFromClient.second, langPriority.second);
2015 langPriority = getXMLString("contactPriority");
2016 if (langPriority.first)
2017 SAMLConfig::getConfig().setContactPriority(langPriority.second);
2021 doExtensions(e, "global", log);
2022 if (conf.isEnabled(SPConfig::OutOfProcess))
2023 doExtensions(SHAR, "out of process", log);
2025 if (conf.isEnabled(SPConfig::InProcess))
2026 doExtensions(SHIRE, "in process", log);
2028 // Instantiate the ListenerService and SessionCache objects.
2029 if (conf.isEnabled(SPConfig::Listener))
2030 doListener(e, outer, log);
2033 if (outer->m_listener && conf.isEnabled(SPConfig::OutOfProcess) && !conf.isEnabled(SPConfig::InProcess)) {
2034 outer->m_listener->regListener("set::RelayState", outer);
2035 outer->m_listener->regListener("get::RelayState", outer);
2036 outer->m_listener->regListener("set::PostData", outer);
2037 outer->m_listener->regListener("get::PostData", outer);
2040 if (conf.isEnabled(SPConfig::Caching))
2041 doCaching(e, outer, log);
2042 } // end of first-time-only stuff
2044 // Back to the fully dynamic stuff...next up is the RequestMapper.
2045 if (conf.isEnabled(SPConfig::RequestMapping)) {
2046 if (child = XMLHelper::getFirstChildElement(e, _RequestMapper)) {
2047 string t(XMLHelper::getAttrString(child, nullptr, _type));
2049 log.info("building RequestMapper of type %s...", t.c_str());
2050 m_requestMapper.reset(conf.RequestMapperManager.newPlugin(t.c_str(), child));
2053 if (!m_requestMapper) {
2054 log.info("no RequestMapper specified, using 'Native' plugin with empty/default map");
2055 child = e->getOwnerDocument()->createElementNS(nullptr, _RequestMapper);
2056 DOMElement* mapperDummy = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS, RequestMap);
2057 mapperDummy->setAttributeNS(nullptr, applicationId, _default);
2058 child->appendChild(mapperDummy);
2059 m_requestMapper.reset(conf.RequestMapperManager.newPlugin(NATIVE_REQUEST_MAPPER, child));
2064 // Load security policies.
2065 if (child = XMLHelper::getLastChildElement(e, _SecurityPolicyProvider)) {
2066 string t(XMLHelper::getAttrString(child, nullptr, _type));
2068 log.info("building SecurityPolicyProvider of type %s...", t.c_str());
2069 m_policy.reset(conf.SecurityPolicyProviderManager.newPlugin(t.c_str(), child));
2072 throw ConfigurationException("can't build SecurityPolicyProvider, no type specified");
2075 else if (child = XMLHelper::getLastChildElement(e, SecurityPolicies)) {
2076 // For backward compatibility, wrap in a plugin element.
2077 DOMElement* polwrapper = e->getOwnerDocument()->createElementNS(nullptr, _SecurityPolicyProvider);
2078 polwrapper->appendChild(child);
2079 log.info("building SecurityPolicyProvider of type %s...", XML_SECURITYPOLICY_PROVIDER);
2080 m_policy.reset(conf.SecurityPolicyProviderManager.newPlugin(XML_SECURITYPOLICY_PROVIDER, polwrapper));
2083 log.fatal("can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
2084 throw ConfigurationException("Can't build SecurityPolicyProvider, missing conf:SecurityPolicyProvider element?");
2088 if (!m_policy->getAlgorithmBlacklist().empty()) {
2089 #ifdef SHIBSP_XMLSEC_WHITELISTING
2091 m_policy->getAlgorithmBlacklist().begin(), m_policy->getAlgorithmBlacklist().end(),
2092 boost::bind(&XSECPlatformUtils::blacklistAlgorithm, boost::bind(&xstring::c_str, _1))
2095 log.crit("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists");
2098 else if (!m_policy->getAlgorithmWhitelist().empty()) {
2099 #ifdef SHIBSP_XMLSEC_WHITELISTING
2101 m_policy->getAlgorithmWhitelist().begin(), m_policy->getAlgorithmWhitelist().end(),
2102 boost::bind(&XSECPlatformUtils::whitelistAlgorithm, boost::bind(&xstring::c_str, _1))
2105 log.crit("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists");
2110 // Process TransportOption elements.
2111 child = XMLHelper::getLastChildElement(e, TransportOption);
2113 if (child->hasChildNodes()) {
2114 string provider(XMLHelper::getAttrString(child, nullptr, _provider));
2115 string option(XMLHelper::getAttrString(child, nullptr, _option));
2116 auto_ptr_char value(child->getFirstChild()->getNodeValue());
2117 if (!provider.empty() && !option.empty() && value.get() && *value.get()) {
2118 m_transportOptions.push_back(make_tuple(provider, option, string(value.get())));
2121 child = XMLHelper::getPreviousSiblingElement(child, TransportOption);
2125 scoped_ptr<ProtocolProvider> pp;
2126 if (conf.isEnabled(SPConfig::Handlers)) {
2127 if (child = XMLHelper::getLastChildElement(e, _ProtocolProvider)) {
2128 string t(XMLHelper::getAttrString(child, nullptr, _type));
2130 log.info("building ProtocolProvider of type %s...", t.c_str());
2131 pp.reset(conf.ProtocolProviderManager.newPlugin(t.c_str(), child));
2135 Locker pplocker(pp.get());
2137 // Load the default application.
2138 child = XMLHelper::getLastChildElement(e, ApplicationDefaults);
2140 log.fatal("can't build default Application object, missing conf:ApplicationDefaults element?");
2141 throw ConfigurationException("can't build default Application object, missing conf:ApplicationDefaults element?");
2143 boost::shared_ptr<XMLApplication> defapp(new XMLApplication(outer, pp.get(), child));
2144 m_appmap[defapp->getId()] = defapp;
2146 // Load any overrides.
2147 child = XMLHelper::getFirstChildElement(child, ApplicationOverride);
2149 boost::shared_ptr<XMLApplication> iapp(new XMLApplication(outer, pp.get(), child, defapp.get()));
2150 if (m_appmap.count(iapp->getId()))
2151 log.crit("found conf:ApplicationOverride element with duplicate id attribute (%s), skipping it", iapp->getId());
2153 m_appmap[iapp->getId()] = iapp;
2155 child = XMLHelper::getNextSiblingElement(child, ApplicationOverride);
2158 // Check for extra AuthTypes to recognize.
2159 if (conf.isEnabled(SPConfig::InProcess)) {
2160 const PropertySet* inprocs = getPropertySet("InProcess");
2162 pair<bool,const char*> extraAuthTypes = inprocs->getString("extraAuthTypes");
2163 if (extraAuthTypes.first) {
2164 string types(extraAuthTypes.second);
2165 split(outer->m_authTypes, types, is_space(), algorithm::token_compress_on);
2166 outer->m_authTypes.insert("shibboleth");
2173 void XMLConfig::receive(DDF& in, ostream& out)
2175 if (!strcmp(in.name(), "get::RelayState")) {
2176 const char* id = in["id"].string();
2177 const char* key = in["key"].string();
2179 throw ListenerException("Required parameters missing for RelayState recovery.");
2182 StorageService* storage = getStorageService(id);
2184 if (storage->readString("RelayState",key,&relayState)>0) {
2185 if (in["clear"].integer())
2186 storage->deleteString("RelayState",key);
2188 else if (storage->readText("RelayState",key,&relayState)>0) {
2189 if (in["clear"].integer())
2190 storage->deleteText("RelayState",key);
2194 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2195 "Storage-backed RelayState with invalid StorageService ID (%s)", id
2199 // Repack for return to caller.
2200 DDF ret=DDF(nullptr).unsafe_string(relayState.c_str());
2201 DDFJanitor jret(ret);
2204 else if (!strcmp(in.name(), "set::RelayState")) {
2205 const char* id = in["id"].string();
2206 const char* value = in["value"].string();
2208 throw ListenerException("Required parameters missing for RelayState creation.");
2211 StorageService* storage = getStorageService(id);
2213 SAMLConfig::getConfig().generateRandomBytes(rsKey,32);
2214 rsKey = SAMLArtifact::toHex(rsKey);
2215 if (strlen(value) <= storage->getCapabilities().getStringSize())
2216 storage->createString("RelayState", rsKey.c_str(), value, time(nullptr) + 600);
2218 storage->createText("RelayState", rsKey.c_str(), value, time(nullptr) + 600);
2221 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2222 "Storage-backed RelayState with invalid StorageService ID (%s)", id
2226 // Repack for return to caller.
2227 DDF ret=DDF(nullptr).string(rsKey.c_str());
2228 DDFJanitor jret(ret);
2231 else if (!strcmp(in.name(), "get::PostData")) {
2232 const char* id = in["id"].string();
2233 const char* key = in["key"].string();
2235 throw ListenerException("Required parameters missing for PostData recovery.");
2238 StorageService* storage = getStorageService(id);
2240 if (storage->readText("PostData",key,&postData) > 0) {
2241 storage->deleteText("PostData",key);
2245 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2246 "Storage-backed PostData with invalid StorageService ID (%s)", id
2249 // If the data's empty, we'll send nothing back.
2250 // If not, we don't need to round trip it, just send back the serialized DDF list.
2251 if (postData.empty()) {
2253 DDFJanitor jret(ret);
2260 else if (!strcmp(in.name(), "set::PostData")) {
2261 const char* id = in["id"].string();
2262 if (!id || !in["parameters"].islist())
2263 throw ListenerException("Required parameters missing for PostData creation.");
2266 StorageService* storage = getStorageService(id);
2268 SAMLConfig::getConfig().generateRandomBytes(rsKey,32);
2269 rsKey = SAMLArtifact::toHex(rsKey);
2270 ostringstream params;
2271 params << in["parameters"];
2272 storage->createText("PostData", rsKey.c_str(), params.str().c_str(), time(nullptr) + 600);
2275 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
2276 "Storage-backed PostData with invalid StorageService ID (%s)", id
2280 // Repack for return to caller.
2281 DDF ret=DDF(nullptr).string(rsKey.c_str());
2282 DDFJanitor jret(ret);
2288 pair<bool,DOMElement*> XMLConfig::background_load()
2290 // Load from source using base class.
2291 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
2293 // If we own it, wrap it.
2294 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : nullptr);
2296 scoped_ptr<XMLConfigImpl> impl(new XMLConfigImpl(raw.second, (m_impl==nullptr), this, m_log));
2298 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
2299 impl->setDocument(docjanitor.release());
2301 // Perform the swap inside a lock.
2304 SharedLock locker(m_lock, false);
2307 return make_pair(false,(DOMElement*)nullptr);