2 * Copyright 2001-2010 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * XMLServiceProvider.cpp
20 * XML-based SP configuration and mgmt.
24 #include "exceptions.h"
26 #include "AccessControl.h"
27 #include "Application.h"
28 #include "RequestMapper.h"
29 #include "ServiceProvider.h"
30 #include "SessionCache.h"
32 #include "SPRequest.h"
33 #include "handler/SessionInitiator.h"
34 #include "remoting/ListenerService.h"
35 #include "util/DOMPropertySet.h"
36 #include "util/SPConstants.h"
38 #if defined(XMLTOOLING_LOG4SHIB)
39 # include <log4shib/PropertyConfigurator.hh>
40 #elif defined(XMLTOOLING_LOG4CPP)
41 # include <log4cpp/PropertyConfigurator.hh>
43 # error "Supported logging library not available."
46 #include <xercesc/util/XMLUniDefs.hpp>
47 #include <xmltooling/XMLToolingConfig.h>
48 #include <xmltooling/version.h>
49 #include <xmltooling/util/NDC.h>
50 #include <xmltooling/util/ReloadableXMLFile.h>
51 #include <xmltooling/util/TemplateEngine.h>
52 #include <xmltooling/util/Threads.h>
53 #include <xmltooling/util/XMLHelper.h>
56 # include "TransactionLog.h"
57 # include "attribute/filtering/AttributeFilter.h"
58 # include "attribute/resolver/AttributeExtractor.h"
59 # include "attribute/resolver/AttributeResolver.h"
60 # include "security/PKIXTrustEngine.h"
61 # include <saml/SAMLConfig.h>
62 # include <saml/version.h>
63 # include <saml/binding/ArtifactMap.h>
64 # include <saml/binding/SAMLArtifact.h>
65 # include <saml/binding/SecurityPolicyRule.h>
66 # include <saml/saml1/core/Assertions.h>
67 # include <saml/saml2/core/Assertions.h>
68 # include <saml/saml2/binding/SAML2ArtifactType0004.h>
69 # include <saml/saml2/metadata/Metadata.h>
70 # include <saml/saml2/metadata/MetadataProvider.h>
71 # include <saml/util/SAMLConstants.h>
72 # include <xmltooling/security/CredentialResolver.h>
73 # include <xmltooling/security/SecurityHelper.h>
74 # include <xmltooling/security/TrustEngine.h>
75 # include <xmltooling/util/ReplayCache.h>
76 # include <xmltooling/util/StorageService.h>
77 # include <xercesc/util/XMLStringTokenizer.hpp>
78 # include <xsec/utils/XSECPlatformUtils.hpp>
79 using namespace opensaml::saml2;
80 using namespace opensaml::saml2p;
81 using namespace opensaml::saml2md;
82 using namespace opensaml;
84 # include "lite/SAMLConstants.h"
87 using namespace shibsp;
88 using namespace xmltooling;
92 # define min(a,b) (((a) < (b)) ? (a) : (b))
97 #if defined (_MSC_VER)
98 #pragma warning( push )
99 #pragma warning( disable : 4250 )
102 static vector<const Handler*> g_noHandlers;
104 // Application configuration wrapper
105 class SHIBSP_DLLLOCAL XMLApplication : public Application, public Remoted, public DOMPropertySet, public DOMNodeFilter
108 XMLApplication(const ServiceProvider*, const DOMElement* e, const XMLApplication* base=NULL);
109 ~XMLApplication() { cleanup(); }
111 const char* getHash() const {return m_hash.c_str();}
114 SAMLArtifact* generateSAML1Artifact(const EntityDescriptor* relyingParty) const {
115 throw ConfigurationException("No support for SAML 1.x artifact generation.");
117 SAML2Artifact* generateSAML2Artifact(const EntityDescriptor* relyingParty) const {
118 pair<bool,int> index = make_pair(false,0);
119 const PropertySet* props = getRelyingParty(relyingParty);
120 index = props->getInt("artifactEndpointIndex");
122 index = getArtifactEndpointIndex();
123 pair<bool,const char*> entityID = props->getString("entityID");
124 return new SAML2ArtifactType0004(
125 SecurityHelper::doHash("SHA1", entityID.second, strlen(entityID.second), false),
126 index.first ? index.second : 1
130 MetadataProvider* getMetadataProvider(bool required=true) const {
131 if (required && !m_base && !m_metadata)
132 throw ConfigurationException("No MetadataProvider available.");
133 return (!m_metadata && m_base) ? m_base->getMetadataProvider() : m_metadata;
135 TrustEngine* getTrustEngine(bool required=true) const {
136 if (required && !m_base && !m_trust)
137 throw ConfigurationException("No TrustEngine available.");
138 return (!m_trust && m_base) ? m_base->getTrustEngine() : m_trust;
140 AttributeExtractor* getAttributeExtractor() const {
141 return (!m_attrExtractor && m_base) ? m_base->getAttributeExtractor() : m_attrExtractor;
143 AttributeFilter* getAttributeFilter() const {
144 return (!m_attrFilter && m_base) ? m_base->getAttributeFilter() : m_attrFilter;
146 AttributeResolver* getAttributeResolver() const {
147 return (!m_attrResolver && m_base) ? m_base->getAttributeResolver() : m_attrResolver;
149 CredentialResolver* getCredentialResolver() const {
150 return (!m_credResolver && m_base) ? m_base->getCredentialResolver() : m_credResolver;
152 const PropertySet* getRelyingParty(const EntityDescriptor* provider) const;
153 const PropertySet* getRelyingParty(const XMLCh* entityID) const;
154 const vector<const XMLCh*>* getAudiences() const {
155 return (m_audiences.empty() && m_base) ? m_base->getAudiences() : &m_audiences;
158 string getNotificationURL(const char* resource, bool front, unsigned int index) const;
160 const vector<string>& getRemoteUserAttributeIds() const {
161 return (m_remoteUsers.empty() && m_base) ? m_base->getRemoteUserAttributeIds() : m_remoteUsers;
164 void clearHeader(SPRequest& request, const char* rawname, const char* cginame) const;
165 void setHeader(SPRequest& request, const char* name, const char* value) const;
166 string getSecureHeader(const SPRequest& request, const char* name) const;
168 const SessionInitiator* getDefaultSessionInitiator() const;
169 const SessionInitiator* getSessionInitiatorById(const char* id) const;
170 const Handler* getDefaultAssertionConsumerService() const;
171 const Handler* getAssertionConsumerServiceByIndex(unsigned short index) const;
172 const vector<const Handler*>& getAssertionConsumerServicesByBinding(const XMLCh* binding) const;
173 const Handler* getHandler(const char* path) const;
174 void getHandlers(vector<const Handler*>& handlers) const;
176 void receive(DDF& in, ostream& out) {
177 // Only current function is to return the headers to clear.
179 DDF ret=DDF(NULL).list();
180 DDFJanitor jret(ret);
181 for (vector< pair<string,string> >::const_iterator i = m_unsetHeaders.begin(); i!=m_unsetHeaders.end(); ++i) {
182 header = DDF(i->first.c_str()).string(i->second.c_str());
188 // Provides filter to exclude special config elements.
189 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
194 acceptNode(const DOMNode* node) const;
198 const XMLApplication* m_base;
200 std::pair<std::string,std::string> m_attributePrefix;
202 MetadataProvider* m_metadata;
203 TrustEngine* m_trust;
204 AttributeExtractor* m_attrExtractor;
205 AttributeFilter* m_attrFilter;
206 AttributeResolver* m_attrResolver;
207 CredentialResolver* m_credResolver;
208 vector<const XMLCh*> m_audiences;
210 // RelyingParty properties
211 map<xstring,PropertySet*> m_partyMap;
213 vector<string> m_remoteUsers,m_frontLogout,m_backLogout;
215 // manage handler objects
216 vector<Handler*> m_handlers;
218 // maps location (path info) to applicable handlers
219 map<string,const Handler*> m_handlerMap;
221 // maps unique indexes to consumer services
222 map<unsigned int,const Handler*> m_acsIndexMap;
224 // pointer to default consumer service
225 const Handler* m_acsDefault;
227 // maps binding strings to supporting consumer service(s)
228 typedef map<xstring,vector<const Handler*> > ACSBindingMap;
229 ACSBindingMap m_acsBindingMap;
231 // pointer to default session initiator
232 const SessionInitiator* m_sessionInitDefault;
234 // maps unique ID strings to session initiators
235 map<string,const SessionInitiator*> m_sessionInitMap;
237 // pointer to default artifact resolution service
238 const Handler* m_artifactResolutionDefault;
240 pair<bool,int> getArtifactEndpointIndex() const {
241 if (m_artifactResolutionDefault) return m_artifactResolutionDefault->getInt("index");
242 return m_base ? m_base->getArtifactEndpointIndex() : make_pair(false,0);
246 // Top-level configuration implementation
247 class SHIBSP_DLLLOCAL XMLConfig;
248 class SHIBSP_DLLLOCAL XMLConfigImpl : public DOMPropertySet, public DOMNodeFilter
251 XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer, Category& log);
254 RequestMapper* m_requestMapper;
255 map<string,Application*> m_appmap;
257 map< string,pair< PropertySet*,vector<const SecurityPolicyRule*> > > m_policyMap;
258 vector< pair< string, pair<string,string> > > m_transportOptions;
261 // Provides filter to exclude special config elements.
262 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
267 acceptNode(const DOMNode* node) const;
269 void setDocument(DOMDocument* doc) {
274 void doExtensions(const DOMElement* e, const char* label, Category& log);
277 const XMLConfig* m_outer;
278 DOMDocument* m_document;
281 class SHIBSP_DLLLOCAL XMLConfig : public ServiceProvider, public ReloadableXMLFile
287 XMLConfig(const DOMElement* e) : ReloadableXMLFile(e, Category::getInstance(SHIBSP_LOGCAT".Config")),
288 m_impl(NULL), m_listener(NULL), m_sessionCache(NULL)
301 delete m_sessionCache;
305 SAMLConfig::getConfig().setArtifactMap(NULL);
306 XMLToolingConfig::getConfig().setReplayCache(NULL);
307 for_each(m_storage.begin(), m_storage.end(), cleanup_pair<string,StorageService>());
312 const PropertySet* getParent() const { return m_impl->getParent(); }
313 void setParent(const PropertySet* parent) {return m_impl->setParent(parent);}
314 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const {return m_impl->getBool(name,ns);}
315 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const {return m_impl->getString(name,ns);}
316 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const {return m_impl->getXMLString(name,ns);}
317 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const {return m_impl->getUnsignedInt(name,ns);}
318 pair<bool,int> getInt(const char* name, const char* ns=NULL) const {return m_impl->getInt(name,ns);}
319 void getAll(map<string,const char*>& properties) const {return m_impl->getAll(properties);}
320 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const {return m_impl->getPropertySet(name,ns);}
321 const DOMElement* getElement() const {return m_impl->getElement();}
326 void receive(DDF& in, ostream& out);
328 TransactionLog* getTransactionLog() const {
331 throw ConfigurationException("No TransactionLog available.");
334 StorageService* getStorageService(const char* id) const {
336 map<string,StorageService*>::const_iterator i=m_storage.find(id);
337 if (i!=m_storage.end())
344 ListenerService* getListenerService(bool required=true) const {
345 if (required && !m_listener)
346 throw ConfigurationException("No ListenerService available.");
350 SessionCache* getSessionCache(bool required=true) const {
351 if (required && !m_sessionCache)
352 throw ConfigurationException("No SessionCache available.");
353 return m_sessionCache;
356 RequestMapper* getRequestMapper(bool required=true) const {
357 if (required && !m_impl->m_requestMapper)
358 throw ConfigurationException("No RequestMapper available.");
359 return m_impl->m_requestMapper;
362 const Application* getApplication(const char* applicationId) const {
363 map<string,Application*>::const_iterator i=m_impl->m_appmap.find(applicationId);
364 return (i!=m_impl->m_appmap.end()) ? i->second : NULL;
368 const PropertySet* getPolicySettings(const char* id) const {
369 map<string,pair<PropertySet*,vector<const SecurityPolicyRule*> > >::const_iterator i = m_impl->m_policyMap.find(id);
370 if (i!=m_impl->m_policyMap.end())
371 return i->second.first;
372 throw ConfigurationException("Security Policy ($1) not found, check <SecurityPolicies> element.", params(1,id));
375 const vector<const SecurityPolicyRule*>& getPolicyRules(const char* id) const {
376 map<string,pair<PropertySet*,vector<const SecurityPolicyRule*> > >::const_iterator i = m_impl->m_policyMap.find(id);
377 if (i!=m_impl->m_policyMap.end())
378 return i->second.second;
379 throw ConfigurationException("Security Policy ($1) not found, check <SecurityPolicies> element.", params(1,id));
382 bool setTransportOptions(SOAPTransport& transport) const {
384 vector< pair< string, pair<string,string> > >::const_iterator opt;
385 for (opt = m_impl->m_transportOptions.begin(); opt != m_impl->m_transportOptions.end(); ++opt) {
386 if (!transport.setProviderOption(opt->first.c_str(), opt->second.first.c_str(), opt->second.second.c_str())) {
387 m_log.error("failed to set SOAPTransport option (%s)", opt->second.first.c_str());
396 pair<bool,DOMElement*> background_load();
399 friend class XMLConfigImpl;
400 XMLConfigImpl* m_impl;
401 mutable ListenerService* m_listener;
402 mutable SessionCache* m_sessionCache;
404 mutable TransactionLog* m_tranLog;
405 mutable map<string,StorageService*> m_storage;
409 #if defined (_MSC_VER)
410 #pragma warning( pop )
413 static const XMLCh AlgorithmBlacklist[] = UNICODE_LITERAL_18(A,l,g,o,r,i,t,h,m,B,l,a,c,k,l,i,s,t);
414 static const XMLCh AlgorithmWhitelist[] = UNICODE_LITERAL_18(A,l,g,o,r,i,t,h,m,W,h,i,t,e,l,i,s,t);
415 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);
416 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);
417 static const XMLCh _ArtifactMap[] = UNICODE_LITERAL_11(A,r,t,i,f,a,c,t,M,a,p);
418 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);
419 static const XMLCh _AttributeFilter[] = UNICODE_LITERAL_15(A,t,t,r,i,b,u,t,e,F,i,l,t,e,r);
420 static const XMLCh _AttributeResolver[] = UNICODE_LITERAL_17(A,t,t,r,i,b,u,t,e,R,e,s,o,l,v,e,r);
421 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);
422 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);
423 static const XMLCh _Audience[] = UNICODE_LITERAL_8(A,u,d,i,e,n,c,e);
424 static const XMLCh Binding[] = UNICODE_LITERAL_7(B,i,n,d,i,n,g);
425 static const XMLCh Channel[]= UNICODE_LITERAL_7(C,h,a,n,n,e,l);
426 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);
427 static const XMLCh _Extensions[] = UNICODE_LITERAL_10(E,x,t,e,n,s,i,o,n,s);
428 static const XMLCh _fatal[] = UNICODE_LITERAL_5(f,a,t,a,l);
429 static const XMLCh _Handler[] = UNICODE_LITERAL_7(H,a,n,d,l,e,r);
430 static const XMLCh _id[] = UNICODE_LITERAL_2(i,d);
431 static const XMLCh InProcess[] = UNICODE_LITERAL_9(I,n,P,r,o,c,e,s,s);
432 static const XMLCh Library[] = UNICODE_LITERAL_7(L,i,b,r,a,r,y);
433 static const XMLCh Listener[] = UNICODE_LITERAL_8(L,i,s,t,e,n,e,r);
434 static const XMLCh Location[] = UNICODE_LITERAL_8(L,o,c,a,t,i,o,n);
435 static const XMLCh logger[] = UNICODE_LITERAL_6(l,o,g,g,e,r);
436 static const XMLCh _LogoutInitiator[] = UNICODE_LITERAL_15(L,o,g,o,u,t,I,n,i,t,i,a,t,o,r);
437 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);
438 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
439 static const XMLCh Notify[] = UNICODE_LITERAL_6(N,o,t,i,f,y);
440 static const XMLCh _option[] = UNICODE_LITERAL_6(o,p,t,i,o,n);
441 static const XMLCh OutOfProcess[] = UNICODE_LITERAL_12(O,u,t,O,f,P,r,o,c,e,s,s);
442 static const XMLCh _path[] = UNICODE_LITERAL_4(p,a,t,h);
443 static const XMLCh Policy[] = UNICODE_LITERAL_6(P,o,l,i,c,y);
444 static const XMLCh PolicyRule[] = UNICODE_LITERAL_10(P,o,l,i,c,y,R,u,l,e);
445 static const XMLCh _provider[] = UNICODE_LITERAL_8(p,r,o,v,i,d,e,r);
446 static const XMLCh RelyingParty[] = UNICODE_LITERAL_12(R,e,l,y,i,n,g,P,a,r,t,y);
447 static const XMLCh _ReplayCache[] = UNICODE_LITERAL_11(R,e,p,l,a,y,C,a,c,h,e);
448 static const XMLCh _RequestMapper[] = UNICODE_LITERAL_13(R,e,q,u,e,s,t,M,a,p,p,e,r);
449 static const XMLCh Rule[] = UNICODE_LITERAL_4(R,u,l,e);
450 static const XMLCh SecurityPolicies[] = UNICODE_LITERAL_16(S,e,c,u,r,i,t,y,P,o,l,i,c,i,e,s);
451 static const XMLCh _SessionCache[] = UNICODE_LITERAL_12(S,e,s,s,i,o,n,C,a,c,h,e);
452 static const XMLCh _SessionInitiator[] = UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
453 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);
454 static const XMLCh Site[] = UNICODE_LITERAL_4(S,i,t,e);
455 static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
456 static const XMLCh TCPListener[] = UNICODE_LITERAL_11(T,C,P,L,i,s,t,e,n,e,r);
457 static const XMLCh TransportOption[] = UNICODE_LITERAL_15(T,r,a,n,s,p,o,r,t,O,p,t,i,o,n);
458 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
459 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
460 static const XMLCh UnixListener[] = UNICODE_LITERAL_12(U,n,i,x,L,i,s,t,e,n,e,r);
463 class SHIBSP_DLLLOCAL PolicyNodeFilter : public DOMNodeFilter
466 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
471 acceptNode(const DOMNode* node) const {
472 return FILTER_REJECT;
479 ServiceProvider* XMLServiceProviderFactory(const DOMElement* const & e)
481 return new XMLConfig(e);
485 XMLApplication::XMLApplication(
486 const ServiceProvider* sp,
488 const XMLApplication* base
489 ) : Application(sp), m_base(base),
491 m_metadata(NULL), m_trust(NULL),
492 m_attrExtractor(NULL), m_attrFilter(NULL), m_attrResolver(NULL),
493 m_credResolver(NULL),
495 m_acsDefault(NULL), m_sessionInitDefault(NULL), m_artifactResolutionDefault(NULL)
498 xmltooling::NDC ndc("XMLApplication");
500 Category& log=Category::getInstance(SHIBSP_LOGCAT".Application");
503 // First load any property sets.
508 SPConfig& conf=SPConfig::getConfig();
510 SAMLConfig& samlConf=SAMLConfig::getConfig();
511 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
514 // This used to be an actual hash, but now it's just a hex-encode to avoid xmlsec.
515 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
516 string tohash=getId();
517 tohash+=getString("entityID").second;
518 for (const char* ch = tohash.c_str(); *ch; ++ch) {
519 m_hash += (DIGITS[((unsigned char)(0xF0 & *ch)) >> 4 ]);
520 m_hash += (DIGITS[0x0F & *ch]);
523 // Populate prefix pair.
524 m_attributePrefix.second = "HTTP_";
525 pair<bool,const char*> prefix = getString("attributePrefix");
527 m_attributePrefix.first = prefix.second;
528 const char* pch = prefix.second;
530 m_attributePrefix.second += (isalnum(*pch) ? toupper(*pch) : '_');
535 // Load attribute ID lists for REMOTE_USER and header clearing.
536 if (conf.isEnabled(SPConfig::InProcess)) {
537 pair<bool,const char*> attributes = getString("REMOTE_USER");
538 if (attributes.first) {
539 char* dup = strdup(attributes.second);
542 while (start && *start) {
543 while (*start && isspace(*start))
547 pos = strchr(start,' ');
550 m_remoteUsers.push_back(start);
551 start = pos ? pos+1 : NULL;
556 attributes = getString("unsetHeaders");
557 if (attributes.first) {
558 string transformedprefix(m_attributePrefix.second);
560 prefix = getString("metadataAttributePrefix");
564 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
568 char* dup = strdup(attributes.second);
571 while (start && *start) {
572 while (*start && isspace(*start))
576 pos = strchr(start,' ');
583 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
587 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + start, m_attributePrefix.second + transformed));
589 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + start, transformedprefix + transformed));
590 start = pos ? pos+1 : NULL;
593 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
597 Handler* handler=NULL;
598 const PropertySet* sessions = getPropertySet("Sessions");
600 // Process assertion export handler.
601 pair<bool,const char*> location = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,NULL);
602 if (location.first) {
604 DOMElement* exportElement = e->getOwnerDocument()->createElementNS(shibspconstants::SHIB2SPCONFIG_NS,_Handler);
605 exportElement->setAttributeNS(NULL,Location,sessions->getXMLString("exportLocation").second);
606 pair<bool,const XMLCh*> exportACL = sessions->getXMLString("exportACL");
607 if (exportACL.first) {
608 static const XMLCh _acl[] = UNICODE_LITERAL_9(e,x,p,o,r,t,A,C,L);
609 exportElement->setAttributeNS(NULL,_acl,exportACL.second);
611 handler = conf.HandlerManager.newPlugin(
612 samlconstants::SAML20_BINDING_URI, pair<const DOMElement*,const char*>(exportElement, getId())
614 m_handlers.push_back(handler);
616 // Insert into location map. If it contains the handlerURL, we skip past that part.
617 const char* pch = strstr(location.second, sessions->getString("handlerURL").second);
619 location.second = pch + strlen(sessions->getString("handlerURL").second);
620 if (*location.second == '/')
621 m_handlerMap[location.second]=handler;
623 m_handlerMap[string("/") + location.second]=handler;
625 catch (exception& ex) {
626 log.error("caught exception installing assertion lookup handler: %s", ex.what());
630 // Process other handlers.
631 bool hardACS=false, hardSessionInit=false, hardArt=false;
632 const DOMElement* child = sessions ? XMLHelper::getFirstChildElement(sessions->getElement()) : NULL;
635 // A handler is based on the Binding property in conjunction with the element name.
636 // If it's an ACS or SI, also handle index/id mappings and defaulting.
637 if (XMLString::equals(child->getLocalName(),_AssertionConsumerService)) {
638 auto_ptr_char bindprop(child->getAttributeNS(NULL,Binding));
639 if (!bindprop.get() || !*(bindprop.get())) {
640 log.warn("md:AssertionConsumerService element has no Binding attribute, skipping it...");
641 child = XMLHelper::getNextSiblingElement(child);
644 handler=conf.AssertionConsumerServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
645 // Map by binding (may be > 1 per binding, e.g. SAML 1.0 vs 1.1)
646 m_acsBindingMap[handler->getXMLString("Binding").second].push_back(handler);
647 m_acsIndexMap[handler->getUnsignedInt("index").second]=handler;
650 pair<bool,bool> defprop=handler->getBool("isDefault");
652 if (defprop.second) {
654 m_acsDefault=handler;
657 else if (!m_acsDefault)
658 m_acsDefault=handler;
661 else if (XMLString::equals(child->getLocalName(),_SessionInitiator)) {
662 auto_ptr_char type(child->getAttributeNS(NULL,_type));
663 if (!type.get() || !*(type.get())) {
664 log.warn("SessionInitiator element has no type attribute, skipping it...");
665 child = XMLHelper::getNextSiblingElement(child);
668 SessionInitiator* sihandler=conf.SessionInitiatorManager.newPlugin(type.get(),make_pair(child, getId()));
670 pair<bool,const char*> si_id=handler->getString("id");
671 if (si_id.first && si_id.second)
672 m_sessionInitMap[si_id.second]=sihandler;
673 if (!hardSessionInit) {
674 pair<bool,bool> defprop=handler->getBool("isDefault");
676 if (defprop.second) {
677 hardSessionInit=true;
678 m_sessionInitDefault=sihandler;
681 else if (!m_sessionInitDefault)
682 m_sessionInitDefault=sihandler;
685 else if (XMLString::equals(child->getLocalName(),_LogoutInitiator)) {
686 auto_ptr_char type(child->getAttributeNS(NULL,_type));
687 if (!type.get() || !*(type.get())) {
688 log.warn("LogoutInitiator element has no type attribute, skipping it...");
689 child = XMLHelper::getNextSiblingElement(child);
692 handler=conf.LogoutInitiatorManager.newPlugin(type.get(),make_pair(child, getId()));
694 else if (XMLString::equals(child->getLocalName(),_ArtifactResolutionService)) {
695 auto_ptr_char bindprop(child->getAttributeNS(NULL,Binding));
696 if (!bindprop.get() || !*(bindprop.get())) {
697 log.warn("md:ArtifactResolutionService element has no Binding attribute, skipping it...");
698 child = XMLHelper::getNextSiblingElement(child);
701 handler=conf.ArtifactResolutionServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
704 pair<bool,bool> defprop=handler->getBool("isDefault");
706 if (defprop.second) {
708 m_artifactResolutionDefault=handler;
711 else if (!m_artifactResolutionDefault)
712 m_artifactResolutionDefault=handler;
715 else if (XMLString::equals(child->getLocalName(),_SingleLogoutService)) {
716 auto_ptr_char bindprop(child->getAttributeNS(NULL,Binding));
717 if (!bindprop.get() || !*(bindprop.get())) {
718 log.warn("md:SingleLogoutService element has no Binding attribute, skipping it...");
719 child = XMLHelper::getNextSiblingElement(child);
722 handler=conf.SingleLogoutServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
724 else if (XMLString::equals(child->getLocalName(),_ManageNameIDService)) {
725 auto_ptr_char bindprop(child->getAttributeNS(NULL,Binding));
726 if (!bindprop.get() || !*(bindprop.get())) {
727 log.warn("md:ManageNameIDService element has no Binding attribute, skipping it...");
728 child = XMLHelper::getNextSiblingElement(child);
731 handler=conf.ManageNameIDServiceManager.newPlugin(bindprop.get(),make_pair(child, getId()));
734 auto_ptr_char type(child->getAttributeNS(NULL,_type));
735 if (!type.get() || !*(type.get())) {
736 log.warn("Handler element has no type attribute, skipping it...");
737 child = XMLHelper::getNextSiblingElement(child);
740 handler=conf.HandlerManager.newPlugin(type.get(),make_pair(child, getId()));
743 m_handlers.push_back(handler);
745 // Insert into location map.
746 location=handler->getString("Location");
747 if (location.first && *location.second == '/')
748 m_handlerMap[location.second]=handler;
749 else if (location.first)
750 m_handlerMap[string("/") + location.second]=handler;
753 catch (exception& ex) {
754 log.error("caught exception processing handler element: %s", ex.what());
757 child = XMLHelper::getNextSiblingElement(child);
761 DOMNodeList* nlist=e->getElementsByTagNameNS(shibspconstants::SHIB2SPCONFIG_NS,Notify);
762 for (XMLSize_t i=0; nlist && i<nlist->getLength(); i++) {
763 if (nlist->item(i)->getParentNode()->isSameNode(e)) {
764 const XMLCh* channel = static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(NULL,Channel);
765 auto_ptr_char loc(static_cast<DOMElement*>(nlist->item(i))->getAttributeNS(NULL,Location));
766 if (loc.get() && *loc.get()) {
767 if (channel && *channel == chLatin_f)
768 m_frontLogout.push_back(loc.get());
770 m_backLogout.push_back(loc.get());
776 nlist=e->getElementsByTagNameNS(samlconstants::SAML20_NS,Audience::LOCAL_NAME);
777 if (nlist && nlist->getLength()) {
778 log.warn("use of <saml:Audience> elements outside of a Security Policy Rule is deprecated");
779 for (XMLSize_t i=0; i<nlist->getLength(); i++)
780 if (nlist->item(i)->getParentNode()->isSameNode(e) && nlist->item(i)->hasChildNodes())
781 m_audiences.push_back(nlist->item(i)->getFirstChild()->getNodeValue());
784 if (conf.isEnabled(SPConfig::Metadata)) {
785 child = XMLHelper::getFirstChildElement(e,_MetadataProvider);
787 auto_ptr_char type(child->getAttributeNS(NULL,_type));
788 log.info("building MetadataProvider of type %s...",type.get());
790 auto_ptr<MetadataProvider> mp(samlConf.MetadataProviderManager.newPlugin(type.get(),child));
792 m_metadata = mp.release();
794 catch (exception& ex) {
795 log.crit("error building/initializing MetadataProvider: %s", ex.what());
800 if (conf.isEnabled(SPConfig::Trust)) {
801 child = XMLHelper::getFirstChildElement(e,_TrustEngine);
803 auto_ptr_char type(child->getAttributeNS(NULL,_type));
804 log.info("building TrustEngine of type %s...",type.get());
806 m_trust = xmlConf.TrustEngineManager.newPlugin(type.get(),child);
808 catch (exception& ex) {
809 log.crit("error building TrustEngine: %s", ex.what());
814 if (conf.isEnabled(SPConfig::AttributeResolution)) {
815 child = XMLHelper::getFirstChildElement(e,_AttributeExtractor);
817 auto_ptr_char type(child->getAttributeNS(NULL,_type));
818 log.info("building AttributeExtractor of type %s...",type.get());
820 m_attrExtractor = conf.AttributeExtractorManager.newPlugin(type.get(),child);
822 catch (exception& ex) {
823 log.crit("error building AttributeExtractor: %s", ex.what());
827 child = XMLHelper::getFirstChildElement(e,_AttributeFilter);
829 auto_ptr_char type(child->getAttributeNS(NULL,_type));
830 log.info("building AttributeFilter of type %s...",type.get());
832 m_attrFilter = conf.AttributeFilterManager.newPlugin(type.get(),child);
834 catch (exception& ex) {
835 log.crit("error building AttributeFilter: %s", ex.what());
839 child = XMLHelper::getFirstChildElement(e,_AttributeResolver);
841 auto_ptr_char type(child->getAttributeNS(NULL,_type));
842 log.info("building AttributeResolver of type %s...",type.get());
844 m_attrResolver = conf.AttributeResolverManager.newPlugin(type.get(),child);
846 catch (exception& ex) {
847 log.crit("error building AttributeResolver: %s", ex.what());
851 if (m_unsetHeaders.empty()) {
852 vector<string> unsetHeaders;
853 if (m_attrExtractor) {
854 Locker extlock(m_attrExtractor);
855 m_attrExtractor->getAttributeIds(unsetHeaders);
857 else if (m_base && m_base->m_attrExtractor) {
858 Locker extlock(m_base->m_attrExtractor);
859 m_base->m_attrExtractor->getAttributeIds(unsetHeaders);
861 if (m_attrResolver) {
862 Locker reslock(m_attrResolver);
863 m_attrResolver->getAttributeIds(unsetHeaders);
865 else if (m_base && m_base->m_attrResolver) {
866 Locker extlock(m_base->m_attrResolver);
867 m_base->m_attrResolver->getAttributeIds(unsetHeaders);
869 if (!unsetHeaders.empty()) {
870 string transformedprefix(m_attributePrefix.second);
872 pair<bool,const char*> prefix = getString("metadataAttributePrefix");
876 transformedprefix += (isalnum(*pch) ? toupper(*pch) : '_');
880 for (vector<string>::const_iterator hdr = unsetHeaders.begin(); hdr!=unsetHeaders.end(); ++hdr) {
884 transformed += (isalnum(*pch) ? toupper(*pch) : '_');
887 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + *hdr, m_attributePrefix.second + transformed));
889 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + prefix.second + *hdr, transformedprefix + transformed));
892 m_unsetHeaders.push_back(pair<string,string>(m_attributePrefix.first + "Shib-Application-ID", m_attributePrefix.second + "SHIB_APPLICATION_ID"));
896 if (conf.isEnabled(SPConfig::Credentials)) {
897 child = XMLHelper::getFirstChildElement(e,_CredentialResolver);
899 auto_ptr_char type(child->getAttributeNS(NULL,_type));
900 log.info("building CredentialResolver of type %s...",type.get());
902 m_credResolver = xmlConf.CredentialResolverManager.newPlugin(type.get(),child);
904 catch (exception& ex) {
905 log.crit("error building CredentialResolver: %s", ex.what());
910 // Finally, load relying parties.
911 child = XMLHelper::getFirstChildElement(e,RelyingParty);
913 auto_ptr<DOMPropertySet> rp(new DOMPropertySet());
914 rp->load(child,NULL,this);
916 m_partyMap[child->getAttributeNS(NULL,saml2::Attribute::NAME_ATTRIB_NAME)]=rp.release();
917 child = XMLHelper::getNextSiblingElement(child,RelyingParty);
921 // Out of process only, we register a listener endpoint.
922 if (!conf.isEnabled(SPConfig::InProcess)) {
923 ListenerService* listener = sp->getListenerService(false);
925 string addr=string(getId()) + "::getHeaders::Application";
926 listener->regListener(addr.c_str(),this);
929 log.info("no ListenerService available, Application remoting disabled");
944 void XMLApplication::cleanup()
946 ListenerService* listener=getServiceProvider().getListenerService(false);
947 if (listener && SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess) && !SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
948 string addr=string(getId()) + "::getHeaders::Application";
949 listener->unregListener(addr.c_str(),this);
951 for_each(m_handlers.begin(),m_handlers.end(),xmltooling::cleanup<Handler>());
954 for_each(m_partyMap.begin(),m_partyMap.end(),cleanup_pair<xstring,PropertySet>());
956 delete m_credResolver;
957 m_credResolver = NULL;
958 delete m_attrResolver;
959 m_attrResolver = NULL;
962 delete m_attrExtractor;
963 m_attrExtractor = NULL;
971 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
974 DOMNodeFilter::FilterAction
976 XMLApplication::acceptNode(const DOMNode* node) const
978 const XMLCh* name=node->getLocalName();
979 if (XMLString::equals(name,ApplicationOverride) ||
980 XMLString::equals(name,_Audience) ||
981 XMLString::equals(name,Notify) ||
982 XMLString::equals(name,_Handler) ||
983 XMLString::equals(name,_AssertionConsumerService) ||
984 XMLString::equals(name,_ArtifactResolutionService) ||
985 XMLString::equals(name,_LogoutInitiator) ||
986 XMLString::equals(name,_ManageNameIDService) ||
987 XMLString::equals(name,_SessionInitiator) ||
988 XMLString::equals(name,_SingleLogoutService) ||
989 XMLString::equals(name,RelyingParty) ||
990 XMLString::equals(name,_MetadataProvider) ||
991 XMLString::equals(name,_TrustEngine) ||
992 XMLString::equals(name,_CredentialResolver) ||
993 XMLString::equals(name,_AttributeFilter) ||
994 XMLString::equals(name,_AttributeExtractor) ||
995 XMLString::equals(name,_AttributeResolver))
996 return FILTER_REJECT;
998 return FILTER_ACCEPT;
1003 const PropertySet* XMLApplication::getRelyingParty(const EntityDescriptor* provider) const
1008 map<xstring,PropertySet*>::const_iterator i=m_partyMap.find(provider->getEntityID());
1009 if (i!=m_partyMap.end())
1011 const EntitiesDescriptor* group=dynamic_cast<const EntitiesDescriptor*>(provider->getParent());
1013 if (group->getName()) {
1014 i=m_partyMap.find(group->getName());
1015 if (i!=m_partyMap.end())
1018 group=dynamic_cast<const EntitiesDescriptor*>(group->getParent());
1023 const PropertySet* XMLApplication::getRelyingParty(const XMLCh* entityID) const
1028 map<xstring,PropertySet*>::const_iterator i=m_partyMap.find(entityID);
1029 if (i!=m_partyMap.end())
1036 string XMLApplication::getNotificationURL(const char* resource, bool front, unsigned int index) const
1038 const vector<string>& locs = front ? m_frontLogout : m_backLogout;
1040 return m_base ? m_base->getNotificationURL(resource, front, index) : string();
1041 else if (index >= locs.size())
1044 #ifdef HAVE_STRCASECMP
1045 if (!resource || (strncasecmp(resource,"http://",7) && strncasecmp(resource,"https://",8)))
1047 if (!resource || (strnicmp(resource,"http://",7) && strnicmp(resource,"https://",8)))
1049 throw ConfigurationException("Request URL was not absolute.");
1051 const char* handler=locs[index].c_str();
1053 // Should never happen...
1054 if (!handler || (*handler!='/' && strncmp(handler,"http:",5) && strncmp(handler,"https:",6)))
1055 throw ConfigurationException(
1056 "Invalid Location property ($1) in Notify element for Application ($2)",
1057 params(2, handler ? handler : "null", getId())
1060 // The "Location" property can be in one of three formats:
1062 // 1) a full URI: http://host/foo/bar
1063 // 2) a hostless URI: http:///foo/bar
1064 // 3) a relative path: /foo/bar
1066 // # Protocol Host Path
1067 // 1 handler handler handler
1068 // 2 handler resource handler
1069 // 3 resource resource handler
1071 const char* path = NULL;
1073 // Decide whether to use the handler or the resource for the "protocol"
1075 if (*handler != '/') {
1083 // break apart the "protocol" string into protocol, host, and "the rest"
1084 const char* colon=strchr(prot,':');
1086 const char* slash=strchr(colon,'/');
1090 // Compute the actual protocol and store.
1091 string notifyURL(prot, colon-prot);
1093 // create the "host" from either the colon/slash or from the target string
1094 // If prot == handler then we're in either #1 or #2, else #3.
1095 // If slash == colon then we're in #2.
1096 if (prot != handler || slash == colon) {
1097 colon = strchr(resource, ':');
1098 colon += 3; // Get past the ://
1099 slash = strchr(colon, '/');
1101 string host(colon, (slash ? slash-colon : strlen(colon)));
1104 notifyURL += host + path;
1108 void XMLApplication::clearHeader(SPRequest& request, const char* rawname, const char* cginame) const
1110 if (!m_attributePrefix.first.empty()) {
1111 string temp = m_attributePrefix.first + rawname;
1112 string temp2 = m_attributePrefix.second + (cginame + 5);
1113 request.clearHeader(temp.c_str(), temp2.c_str());
1116 m_base->clearHeader(request, rawname, cginame);
1119 request.clearHeader(rawname, cginame);
1123 void XMLApplication::setHeader(SPRequest& request, const char* name, const char* value) const
1125 if (!m_attributePrefix.first.empty()) {
1126 string temp = m_attributePrefix.first + name;
1127 request.setHeader(temp.c_str(), value);
1130 m_base->setHeader(request, name, value);
1133 request.setHeader(name, value);
1137 string XMLApplication::getSecureHeader(const SPRequest& request, const char* name) const
1139 if (!m_attributePrefix.first.empty()) {
1140 string temp = m_attributePrefix.first + name;
1141 return request.getSecureHeader(temp.c_str());
1144 return m_base->getSecureHeader(request,name);
1147 return request.getSecureHeader(name);
1151 const SessionInitiator* XMLApplication::getDefaultSessionInitiator() const
1153 if (m_sessionInitDefault) return m_sessionInitDefault;
1154 return m_base ? m_base->getDefaultSessionInitiator() : NULL;
1157 const SessionInitiator* XMLApplication::getSessionInitiatorById(const char* id) const
1159 map<string,const SessionInitiator*>::const_iterator i=m_sessionInitMap.find(id);
1160 if (i!=m_sessionInitMap.end()) return i->second;
1161 return m_base ? m_base->getSessionInitiatorById(id) : NULL;
1164 const Handler* XMLApplication::getDefaultAssertionConsumerService() const
1166 if (m_acsDefault) return m_acsDefault;
1167 return m_base ? m_base->getDefaultAssertionConsumerService() : NULL;
1170 const Handler* XMLApplication::getAssertionConsumerServiceByIndex(unsigned short index) const
1172 map<unsigned int,const Handler*>::const_iterator i=m_acsIndexMap.find(index);
1173 if (i!=m_acsIndexMap.end()) return i->second;
1174 return m_base ? m_base->getAssertionConsumerServiceByIndex(index) : NULL;
1177 const vector<const Handler*>& XMLApplication::getAssertionConsumerServicesByBinding(const XMLCh* binding) const
1179 ACSBindingMap::const_iterator i=m_acsBindingMap.find(binding);
1180 if (i!=m_acsBindingMap.end())
1182 return m_base ? m_base->getAssertionConsumerServicesByBinding(binding) : g_noHandlers;
1185 const Handler* XMLApplication::getHandler(const char* path) const
1188 wrap = wrap.substr(0,wrap.find(';'));
1189 map<string,const Handler*>::const_iterator i=m_handlerMap.find(wrap.substr(0,wrap.find('?')));
1190 if (i!=m_handlerMap.end())
1192 return m_base ? m_base->getHandler(path) : NULL;
1195 void XMLApplication::getHandlers(vector<const Handler*>& handlers) const
1197 handlers.insert(handlers.end(), m_handlers.begin(), m_handlers.end());
1199 for (map<string,const Handler*>::const_iterator h = m_base->m_handlerMap.begin(); h != m_base->m_handlerMap.end(); ++h) {
1200 if (m_handlerMap.count(h->first) == 0)
1201 handlers.push_back(h->second);
1206 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
1209 DOMNodeFilter::FilterAction
1211 XMLConfigImpl::acceptNode(const DOMNode* node) const
1213 if (!XMLString::equals(node->getNamespaceURI(),shibspconstants::SHIB2SPCONFIG_NS))
1214 return FILTER_ACCEPT;
1215 const XMLCh* name=node->getLocalName();
1216 if (XMLString::equals(name,ApplicationDefaults) ||
1217 XMLString::equals(name,_ArtifactMap) ||
1218 XMLString::equals(name,_Extensions) ||
1219 XMLString::equals(name,Listener) ||
1220 XMLString::equals(name,_RequestMapper) ||
1221 XMLString::equals(name,_ReplayCache) ||
1222 XMLString::equals(name,SecurityPolicies) ||
1223 XMLString::equals(name,_SessionCache) ||
1224 XMLString::equals(name,Site) ||
1225 XMLString::equals(name,_StorageService) ||
1226 XMLString::equals(name,TCPListener) ||
1227 XMLString::equals(name,TransportOption) ||
1228 XMLString::equals(name,UnixListener))
1229 return FILTER_REJECT;
1231 return FILTER_ACCEPT;
1234 void XMLConfigImpl::doExtensions(const DOMElement* e, const char* label, Category& log)
1236 const DOMElement* exts=XMLHelper::getFirstChildElement(e,_Extensions);
1238 exts=XMLHelper::getFirstChildElement(exts,Library);
1240 auto_ptr_char path(exts->getAttributeNS(NULL,_path));
1243 if (!XMLToolingConfig::getConfig().load_library(path.get(),(void*)exts))
1244 throw ConfigurationException("XMLToolingConfig::load_library failed.");
1245 log.debug("loaded %s extension library (%s)", label, path.get());
1248 catch (exception& e) {
1249 const XMLCh* fatal=exts->getAttributeNS(NULL,_fatal);
1250 if (fatal && (*fatal==chLatin_t || *fatal==chDigit_1)) {
1251 log.fatal("unable to load mandatory %s extension library %s: %s", label, path.get(), e.what());
1255 log.crit("unable to load optional %s extension library %s: %s", label, path.get(), e.what());
1258 exts=XMLHelper::getNextSiblingElement(exts,Library);
1263 XMLConfigImpl::XMLConfigImpl(const DOMElement* e, bool first, const XMLConfig* outer, Category& log)
1264 : m_requestMapper(NULL), m_outer(outer), m_document(NULL)
1267 xmltooling::NDC ndc("XMLConfigImpl");
1271 SPConfig& conf=SPConfig::getConfig();
1273 SAMLConfig& samlConf=SAMLConfig::getConfig();
1275 XMLToolingConfig& xmlConf=XMLToolingConfig::getConfig();
1276 const DOMElement* SHAR=XMLHelper::getFirstChildElement(e,OutOfProcess);
1277 const DOMElement* SHIRE=XMLHelper::getFirstChildElement(e,InProcess);
1279 // Initialize log4cpp manually in order to redirect log messages as soon as possible.
1280 if (conf.isEnabled(SPConfig::Logging)) {
1281 const XMLCh* logconf=NULL;
1282 if (conf.isEnabled(SPConfig::OutOfProcess))
1283 logconf=SHAR->getAttributeNS(NULL,logger);
1284 else if (conf.isEnabled(SPConfig::InProcess))
1285 logconf=SHIRE->getAttributeNS(NULL,logger);
1286 if (!logconf || !*logconf)
1287 logconf=e->getAttributeNS(NULL,logger);
1288 if (logconf && *logconf) {
1289 auto_ptr_char logpath(logconf);
1290 log.debug("loading new logging configuration from (%s), check log destination for status of configuration",logpath.get());
1291 if (!XMLToolingConfig::getConfig().log_config(logpath.get()))
1292 log.crit("failed to load new logging configuration from (%s)", logpath.get());
1297 m_outer->m_tranLog = new TransactionLog();
1301 // Re-log library versions now that logging is set up.
1302 log.info("Shibboleth SP Version %s", PACKAGE_VERSION);
1305 "Library versions: Xerces-C %s, XML-Security-C %s, XMLTooling-C %s, OpenSAML-C %s, Shibboleth %s",
1306 XERCES_FULLVERSIONDOT, XSEC_FULLVERSIONDOT, XMLTOOLING_FULLVERSIONDOT, OPENSAML_FULLVERSIONDOT, SHIBSP_FULLVERSIONDOT
1310 "Library versions: Xerces-C %s, XMLTooling-C %s, Shibboleth %s",
1311 XERCES_FULLVERSIONDOT, XMLTOOLING_FULLVERSIONDOT, SHIBSP_FULLVERSIONDOT
1315 // First load any property sets.
1318 const DOMElement* child;
1321 // Much of the processing can only occur on the first instantiation.
1324 pair<bool,unsigned int> skew=getUnsignedInt("clockSkew");
1326 xmlConf.clock_skew_secs=min(skew.second,(60*60*24*7*28));
1328 pair<bool,const char*> unsafe = getString("unsafeChars");
1330 TemplateEngine::unsafe_chars = unsafe.second;
1332 unsafe = getString("allowedSchemes");
1334 HTTPResponse::getAllowedSchemes().clear();
1335 string schemes=unsafe.second;
1336 unsigned int j_sch=0;
1337 for (unsigned int i_sch=0; i_sch < schemes.length(); i_sch++) {
1338 if (schemes.at(i_sch)==' ') {
1339 HTTPResponse::getAllowedSchemes().push_back(schemes.substr(j_sch, i_sch-j_sch));
1343 HTTPResponse::getAllowedSchemes().push_back(schemes.substr(j_sch, schemes.length()-j_sch));
1347 doExtensions(e, "global", log);
1348 if (conf.isEnabled(SPConfig::OutOfProcess))
1349 doExtensions(SHAR, "out of process", log);
1351 if (conf.isEnabled(SPConfig::InProcess))
1352 doExtensions(SHIRE, "in process", log);
1354 // Instantiate the ListenerService and SessionCache objects.
1355 if (conf.isEnabled(SPConfig::Listener)) {
1356 child=XMLHelper::getFirstChildElement(e,UnixListener);
1358 plugtype=UNIX_LISTENER_SERVICE;
1360 child=XMLHelper::getFirstChildElement(e,TCPListener);
1362 plugtype=TCP_LISTENER_SERVICE;
1364 child=XMLHelper::getFirstChildElement(e,Listener);
1366 auto_ptr_char type(child->getAttributeNS(NULL,_type));
1368 plugtype=type.get();
1373 log.info("building ListenerService of type %s...", plugtype.c_str());
1374 m_outer->m_listener = conf.ListenerServiceManager.newPlugin(plugtype.c_str(), child);
1377 log.fatal("can't build ListenerService, missing conf:Listener element?");
1378 throw ConfigurationException("Can't build ListenerService, missing conf:Listener element?");
1383 if (m_outer->m_listener && conf.isEnabled(SPConfig::OutOfProcess) && !conf.isEnabled(SPConfig::InProcess)) {
1384 m_outer->m_listener->regListener("set::RelayState", const_cast<XMLConfig*>(m_outer));
1385 m_outer->m_listener->regListener("get::RelayState", const_cast<XMLConfig*>(m_outer));
1386 m_outer->m_listener->regListener("set::PostData", const_cast<XMLConfig*>(m_outer));
1387 m_outer->m_listener->regListener("get::PostData", const_cast<XMLConfig*>(m_outer));
1391 if (conf.isEnabled(SPConfig::Caching)) {
1392 if (conf.isEnabled(SPConfig::OutOfProcess)) {
1394 // First build any StorageServices.
1395 child=XMLHelper::getFirstChildElement(e,_StorageService);
1397 auto_ptr_char id(child->getAttributeNS(NULL,_id));
1398 auto_ptr_char type(child->getAttributeNS(NULL,_type));
1400 log.info("building StorageService (%s) of type %s...", id.get(), type.get());
1401 m_outer->m_storage[id.get()] = xmlConf.StorageServiceManager.newPlugin(type.get(),child);
1403 catch (exception& ex) {
1404 log.crit("failed to instantiate StorageService (%s): %s", id.get(), ex.what());
1406 child=XMLHelper::getNextSiblingElement(child,_StorageService);
1410 StorageService* replaySS=NULL;
1411 child=XMLHelper::getFirstChildElement(e,_ReplayCache);
1413 auto_ptr_char ssid(child->getAttributeNS(NULL,_StorageService));
1414 if (ssid.get() && *ssid.get()) {
1415 if (m_outer->m_storage.count(ssid.get()))
1416 replaySS = m_outer->m_storage[ssid.get()];
1418 log.info("building ReplayCache on top of StorageService (%s)...", ssid.get());
1420 log.warn("unable to locate StorageService (%s) for ReplayCache, using dedicated in-memory instance", ssid.get());
1422 xmlConf.setReplayCache(new ReplayCache(replaySS));
1425 log.warn("no ReplayCache built, missing conf:ReplayCache element?");
1429 child=XMLHelper::getFirstChildElement(e,_ArtifactMap);
1431 auto_ptr_char ssid(child->getAttributeNS(NULL,_StorageService));
1432 if (ssid.get() && *ssid.get() && m_outer->m_storage.count(ssid.get())) {
1433 log.info("building ArtifactMap on top of StorageService (%s)...", ssid.get());
1434 samlConf.setArtifactMap(new ArtifactMap(child, m_outer->m_storage[ssid.get()]));
1437 if (samlConf.getArtifactMap()==NULL) {
1438 log.info("building in-memory ArtifactMap...");
1439 samlConf.setArtifactMap(new ArtifactMap(child));
1443 child=XMLHelper::getFirstChildElement(e,_SessionCache);
1445 auto_ptr_char type(child->getAttributeNS(NULL,_type));
1446 log.info("building SessionCache of type %s...",type.get());
1447 m_outer->m_sessionCache=conf.SessionCacheManager.newPlugin(type.get(), child);
1450 log.fatal("can't build SessionCache, missing conf:SessionCache element?");
1451 throw ConfigurationException("Can't build SessionCache, missing conf:SessionCache element?");
1456 child = XMLHelper::getLastChildElement(e, SecurityPolicies);
1458 const XMLCh* algs = NULL;
1459 const DOMElement* alglist = XMLHelper::getLastChildElement(child, AlgorithmBlacklist);
1460 if (alglist && alglist->hasChildNodes()) {
1461 algs = alglist->getFirstChild()->getNodeValue();
1463 else if ((alglist = XMLHelper::getLastChildElement(child, AlgorithmWhitelist)) && alglist->hasChildNodes()) {
1464 algs = alglist->getFirstChild()->getNodeValue();
1467 #ifdef SHIBSP_XMLSEC_WHITELISTING
1469 XMLStringTokenizer tokenizer(algs);
1470 while (tokenizer.hasMoreTokens()) {
1471 token = tokenizer.nextToken();
1473 if (XMLString::equals(alglist->getLocalName(), AlgorithmBlacklist))
1474 XSECPlatformUtils::blacklistAlgorithm(token);
1476 XSECPlatformUtils::whitelistAlgorithm(token);
1480 log.fatal("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists");
1481 throw ConfigurationException("XML-Security-C library prior to 1.6.0 does not support algorithm white/blacklists.");
1486 } // end of first-time-only stuff
1488 // Back to the fully dynamic stuff...next up is the RequestMapper.
1489 if (conf.isEnabled(SPConfig::RequestMapping)) {
1490 child=XMLHelper::getFirstChildElement(e,_RequestMapper);
1492 auto_ptr_char type(child->getAttributeNS(NULL,_type));
1493 log.info("building RequestMapper of type %s...",type.get());
1494 m_requestMapper=conf.RequestMapperManager.newPlugin(type.get(),child);
1497 log.fatal("can't build RequestMapper, missing conf:RequestMapper element?");
1498 throw ConfigurationException("Can't build RequestMapper, missing conf:RequestMapper element?");
1503 // Load security policies.
1504 child = XMLHelper::getLastChildElement(e,SecurityPolicies);
1506 PolicyNodeFilter filter;
1507 child = XMLHelper::getFirstChildElement(child,Policy);
1509 auto_ptr_char id(child->getAttributeNS(NULL,_id));
1510 pair< PropertySet*,vector<const SecurityPolicyRule*> >& rules = m_policyMap[id.get()];
1512 auto_ptr<DOMPropertySet> settings(new DOMPropertySet());
1513 settings->load(child, NULL, &filter);
1514 rules.first = settings.release();
1516 // Process PolicyRule elements.
1517 const DOMElement* rule = XMLHelper::getFirstChildElement(child,PolicyRule);
1519 auto_ptr_char type(rule->getAttributeNS(NULL,_type));
1521 rules.second.push_back(samlConf.SecurityPolicyRuleManager.newPlugin(type.get(),rule));
1523 catch (exception& ex) {
1524 log.crit("error instantiating policy rule (%s) in policy (%s): %s", type.get(), id.get(), ex.what());
1526 rule = XMLHelper::getNextSiblingElement(rule,PolicyRule);
1529 if (rules.second.size() == 0) {
1530 // Process Rule elements.
1531 log.warn("detected legacy Policy configuration, please convert to new PolicyRule syntax");
1532 rule = XMLHelper::getFirstChildElement(child,Rule);
1534 auto_ptr_char type(rule->getAttributeNS(NULL,_type));
1536 rules.second.push_back(samlConf.SecurityPolicyRuleManager.newPlugin(type.get(),rule));
1538 catch (exception& ex) {
1539 log.crit("error instantiating policy rule (%s) in policy (%s): %s", type.get(), id.get(), ex.what());
1541 rule = XMLHelper::getNextSiblingElement(rule,Rule);
1544 // Manually add a basic Conditions rule.
1545 log.info("installing a default Conditions rule in policy (%s) for compatibility with legacy configuration", id.get());
1546 rules.second.push_back(samlConf.SecurityPolicyRuleManager.newPlugin(CONDITIONS_POLICY_RULE, NULL));
1549 child = XMLHelper::getNextSiblingElement(child,Policy);
1553 // Process TransportOption elements.
1554 child = XMLHelper::getLastChildElement(e,TransportOption);
1556 if (child->hasChildNodes()) {
1557 auto_ptr_char provider(child->getAttributeNS(NULL,_provider));
1558 auto_ptr_char option(child->getAttributeNS(NULL,_option));
1559 auto_ptr_char value(child->getFirstChild()->getNodeValue());
1560 if (provider.get() && *provider.get() && option.get() && *option.get() && value.get() && *value.get()) {
1561 m_transportOptions.push_back(make_pair(string(provider.get()), make_pair(string(option.get()), string(value.get()))));
1564 child = XMLHelper::getPreviousSiblingElement(child,TransportOption);
1568 // Load the default application. This actually has a fixed ID of "default". ;-)
1569 child=XMLHelper::getLastChildElement(e,ApplicationDefaults);
1571 log.fatal("can't build default Application object, missing conf:ApplicationDefaults element?");
1572 throw ConfigurationException("can't build default Application object, missing conf:ApplicationDefaults element?");
1574 XMLApplication* defapp=new XMLApplication(m_outer,child);
1575 m_appmap[defapp->getId()]=defapp;
1577 // Load any overrides.
1578 child = XMLHelper::getFirstChildElement(child,ApplicationOverride);
1580 auto_ptr<XMLApplication> iapp(new XMLApplication(m_outer,child,defapp));
1581 if (m_appmap.count(iapp->getId()))
1582 log.crit("found conf:ApplicationOverride element with duplicate id attribute (%s), skipping it", iapp->getId());
1584 const char* iappid=iapp->getId();
1585 m_appmap[iappid]=iapp.release();
1588 child = XMLHelper::getNextSiblingElement(child,ApplicationOverride);
1591 catch (exception&) {
1597 XMLConfigImpl::~XMLConfigImpl()
1602 void XMLConfigImpl::cleanup()
1604 for_each(m_appmap.begin(),m_appmap.end(),cleanup_pair<string,Application>());
1607 for (map< string,pair<PropertySet*,vector<const SecurityPolicyRule*> > >::iterator i=m_policyMap.begin(); i!=m_policyMap.end(); ++i) {
1608 delete i->second.first;
1609 for_each(i->second.second.begin(), i->second.second.end(), xmltooling::cleanup<SecurityPolicyRule>());
1611 m_policyMap.clear();
1613 delete m_requestMapper;
1614 m_requestMapper = NULL;
1616 m_document->release();
1621 void XMLConfig::receive(DDF& in, ostream& out)
1623 if (!strcmp(in.name(), "get::RelayState")) {
1624 const char* id = in["id"].string();
1625 const char* key = in["key"].string();
1627 throw ListenerException("Required parameters missing for RelayState recovery.");
1630 StorageService* storage = getStorageService(id);
1632 if (storage->readString("RelayState",key,&relayState)>0) {
1633 if (in["clear"].integer())
1634 storage->deleteString("RelayState",key);
1638 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1639 "Storage-backed RelayState with invalid StorageService ID (%s)", id
1643 // Repack for return to caller.
1644 DDF ret=DDF(NULL).unsafe_string(relayState.c_str());
1645 DDFJanitor jret(ret);
1648 else if (!strcmp(in.name(), "set::RelayState")) {
1649 const char* id = in["id"].string();
1650 const char* value = in["value"].string();
1652 throw ListenerException("Required parameters missing for RelayState creation.");
1655 StorageService* storage = getStorageService(id);
1657 SAMLConfig::getConfig().generateRandomBytes(rsKey,20);
1658 rsKey = SAMLArtifact::toHex(rsKey);
1659 storage->createString("RelayState", rsKey.c_str(), value, time(NULL) + 600);
1662 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1663 "Storage-backed RelayState with invalid StorageService ID (%s)", id
1667 // Repack for return to caller.
1668 DDF ret=DDF(NULL).string(rsKey.c_str());
1669 DDFJanitor jret(ret);
1672 else if (!strcmp(in.name(), "get::PostData")) {
1673 const char* id = in["id"].string();
1674 const char* key = in["key"].string();
1676 throw ListenerException("Required parameters missing for PostData recovery.");
1679 StorageService* storage = getStorageService(id);
1681 if (storage->readString("PostData",key,&postData) > 0) {
1682 storage->deleteString("PostData",key);
1686 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1687 "Storage-backed PostData with invalid StorageService ID (%s)", id
1690 // If the data's empty, we'll send nothing back.
1691 // If not, we don't need to round trip it, just send back the serialized DDF list.
1692 if (postData.empty()) {
1694 DDFJanitor jret(ret);
1701 else if (!strcmp(in.name(), "set::PostData")) {
1702 const char* id = in["id"].string();
1703 if (!id || !in["parameters"].islist())
1704 throw ListenerException("Required parameters missing for PostData creation.");
1707 StorageService* storage = getStorageService(id);
1709 SAMLConfig::getConfig().generateRandomBytes(rsKey,20);
1710 rsKey = SAMLArtifact::toHex(rsKey);
1711 ostringstream params;
1712 params << in["parameters"];
1713 storage->createString("PostData", rsKey.c_str(), params.str().c_str(), time(NULL) + 600);
1716 Category::getInstance(SHIBSP_LOGCAT".ServiceProvider").error(
1717 "Storage-backed PostData with invalid StorageService ID (%s)", id
1721 // Repack for return to caller.
1722 DDF ret=DDF(NULL).string(rsKey.c_str());
1723 DDFJanitor jret(ret);
1729 pair<bool,DOMElement*> XMLConfig::background_load()
1731 // Load from source using base class.
1732 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
1734 // If we own it, wrap it.
1735 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : NULL);
1737 XMLConfigImpl* impl = new XMLConfigImpl(raw.second, (m_impl==NULL), this, m_log);
1739 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
1740 impl->setDocument(docjanitor.release());
1742 // Perform the swap inside a lock.
1745 SharedLock locker(m_lock, false);
1749 return make_pair(false,(DOMElement*)NULL);