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 * XMLProtocolProvider.cpp
24 * XML-based protocol provider.
28 #include "exceptions.h"
29 #include "binding/ProtocolProvider.h"
30 #include "util/DOMPropertySet.h"
31 #include "util/SPConstants.h"
34 #include <boost/shared_ptr.hpp>
35 #include <xmltooling/io/HTTPResponse.h>
36 #include <xmltooling/util/NDC.h>
37 #include <xmltooling/util/ReloadableXMLFile.h>
38 #include <xmltooling/util/Threads.h>
39 #include <xmltooling/util/XMLHelper.h>
40 #include <xercesc/util/XMLUniDefs.hpp>
42 using shibspconstants::SHIB2SPPROTOCOLS_NS;
43 using namespace shibsp;
44 using namespace xmltooling;
45 using namespace boost;
49 static const XMLCh _id[] = UNICODE_LITERAL_2(i,d);
50 static const XMLCh Binding[] = UNICODE_LITERAL_7(B,i,n,d,i,n,g);
51 static const XMLCh Initiator[] = UNICODE_LITERAL_9(I,n,i,t,i,a,t,o,r);
52 static const XMLCh Protocol[] = UNICODE_LITERAL_8(P,r,o,t,o,c,o,l);
53 static const XMLCh Protocols[] = UNICODE_LITERAL_9(P,r,o,t,o,c,o,l,s);
54 static const XMLCh Service[] = UNICODE_LITERAL_7(S,e,r,v,i,c,e);
56 #if defined (_MSC_VER)
57 #pragma warning( push )
58 #pragma warning( disable : 4250 )
61 class SHIBSP_DLLLOCAL XMLProtocolProviderImpl : public DOMNodeFilter, DOMPropertySet
64 XMLProtocolProviderImpl(const DOMElement* e, Category& log);
65 ~XMLProtocolProviderImpl() {
67 m_document->release();
70 void setDocument(DOMDocument* doc) {
74 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
79 acceptNode(const DOMNode* node) const {
84 DOMDocument* m_document;
85 // Map of protocol/service pair to an Initiator propset plus an array of Binding propsets.
86 typedef map< pair<string,string>, pair< const PropertySet*,vector<const PropertySet*> > > protmap_t;
88 vector< boost::shared_ptr<PropertySet> > m_propsetJanitor; // needed to maintain vector API
90 friend class SHIBSP_DLLLOCAL XMLProtocolProvider;
93 class XMLProtocolProvider : public ProtocolProvider, public ReloadableXMLFile
96 XMLProtocolProvider(const DOMElement* e)
97 : ReloadableXMLFile(e, Category::getInstance(SHIBSP_LOGCAT".ProtocolProvider.XML")) {
98 background_load(); // guarantees an exception or the policy is loaded
101 ~XMLProtocolProvider() {
105 const PropertySet* getInitiator(const char* protocol, const char* service) const {
106 XMLProtocolProviderImpl::protmap_t::const_iterator i = m_impl->m_map.find(pair<string,string>(protocol,service));
107 return (i != m_impl->m_map.end()) ? i->second.first : nullptr;
110 const vector<const PropertySet*>& getBindings(const char* protocol, const char* service) const {
111 XMLProtocolProviderImpl::protmap_t::const_iterator i = m_impl->m_map.find(pair<string,string>(protocol,service));
112 return (i != m_impl->m_map.end()) ? i->second.second : m_noBindings;
116 pair<bool,DOMElement*> load(bool backup);
117 pair<bool,DOMElement*> background_load();
120 static vector<const PropertySet*> m_noBindings;
121 scoped_ptr<XMLProtocolProviderImpl> m_impl;
124 #if defined (_MSC_VER)
125 #pragma warning( pop )
128 ProtocolProvider* SHIBSP_DLLLOCAL XMLProtocolProviderFactory(const DOMElement* const & e)
130 return new XMLProtocolProvider(e);
134 void SHIBSP_API shibsp::registerProtocolProviders()
136 SPConfig::getConfig().ProtocolProviderManager.registerFactory(XML_PROTOCOL_PROVIDER, XMLProtocolProviderFactory);
139 ProtocolProvider::ProtocolProvider()
143 ProtocolProvider::~ProtocolProvider()
147 vector<const PropertySet*> XMLProtocolProvider::m_noBindings;
149 XMLProtocolProviderImpl::XMLProtocolProviderImpl(const DOMElement* e, Category& log) : m_document(nullptr)
152 xmltooling::NDC ndc("XMLProtocolProviderImpl");
154 if (!XMLHelper::isNodeNamed(e, SHIB2SPPROTOCOLS_NS, Protocols))
155 throw ConfigurationException("XML ProtocolProvider requires prot:Protocols at root of configuration.");
157 e = XMLHelper::getFirstChildElement(e, SHIB2SPPROTOCOLS_NS, Protocol);
159 string id = XMLHelper::getAttrString(e, nullptr, _id);
161 const DOMElement* svc = XMLHelper::getFirstChildElement(e, SHIB2SPPROTOCOLS_NS, Service);
163 string svcid = XMLHelper::getAttrString(svc, nullptr, _id);
164 if (!svcid.empty() && m_map.count(make_pair(id,svcid)) == 0) {
165 pair< const PropertySet*,vector<const PropertySet*> >& entry = m_map[make_pair(id,svcid)];
166 // Wrap the Initiator in a propset, if any.
167 const DOMElement* child = XMLHelper::getFirstChildElement(svc, SHIB2SPPROTOCOLS_NS, Initiator);
169 boost::shared_ptr<DOMPropertySet> initprop(new DOMPropertySet());
170 initprop->load(child, nullptr, this);
171 m_propsetJanitor.push_back(initprop);
172 entry.first = initprop.get();
175 entry.first = nullptr;
178 // Walk the Bindings.
179 child = XMLHelper::getFirstChildElement(svc, SHIB2SPPROTOCOLS_NS, Binding);
181 boost::shared_ptr<DOMPropertySet> bindprop(new DOMPropertySet());
182 bindprop->load(child, nullptr, this);
183 m_propsetJanitor.push_back(bindprop);
184 entry.second.push_back(bindprop.get());
185 child = XMLHelper::getNextSiblingElement(child, SHIB2SPPROTOCOLS_NS, Binding);
188 svc = XMLHelper::getNextSiblingElement(svc, SHIB2SPPROTOCOLS_NS, Service);
191 e = XMLHelper::getNextSiblingElement(e, SHIB2SPPROTOCOLS_NS, Protocol);
196 pair<bool,DOMElement*> XMLProtocolProvider::load(bool backup)
198 // Load from source using base class.
199 pair<bool,DOMElement*> raw = ReloadableXMLFile::load(backup);
201 // If we own it, wrap it.
202 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : nullptr);
204 scoped_ptr<XMLProtocolProviderImpl> impl(new XMLProtocolProviderImpl(raw.second, m_log));
206 // If we held the document, transfer it to the impl. If we didn't, it's a no-op.
207 impl->setDocument(docjanitor.release());
209 // Perform the swap inside a lock.
212 SharedLock locker(m_lock, false);
216 return make_pair(false,(DOMElement*)nullptr);
219 pair<bool,DOMElement*> XMLProtocolProvider::background_load()
225 if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED)
226 m_log.info("remote resource (%s) unchanged", m_source.c_str());
227 if (!m_loaded && !m_backing.empty())
231 catch (std::exception&) {
232 if (!m_loaded && !m_backing.empty())