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 * TransformSessionInitiator.cpp
20 * Support for mapping input into an entityID using a transform.
24 #include "Application.h"
25 #include "exceptions.h"
26 #include "ServiceProvider.h"
27 #include "SPRequest.h"
28 #include "handler/AbstractHandler.h"
29 #include "handler/RemotedHandler.h"
30 #include "handler/SessionInitiator.h"
31 #include "util/SPConstants.h"
34 # include "metadata/MetadataProviderCriteria.h"
35 # include <saml/saml2/metadata/Metadata.h>
37 #include <xmltooling/XMLToolingConfig.h>
38 #include <xmltooling/util/URLEncoder.h>
39 #include <xercesc/util/XMLUniDefs.hpp>
40 #include <xercesc/util/regx/RegularExpression.hpp>
42 using namespace shibsp;
43 using namespace opensaml::saml2md;
44 using namespace opensaml;
45 using namespace xmltooling;
50 #if defined (_MSC_VER)
51 #pragma warning( push )
52 #pragma warning( disable : 4250 )
55 class SHIBSP_DLLLOCAL TransformSINodeFilter : public DOMNodeFilter
58 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
63 acceptNode(const DOMNode* node) const {
68 static SHIBSP_DLLLOCAL TransformSINodeFilter g_TSINFilter;
71 static const XMLCh force[] = UNICODE_LITERAL_5(f,o,r,c,e);
72 static const XMLCh match[] = UNICODE_LITERAL_5(m,a,t,c,h);
73 static const XMLCh Regex[] = UNICODE_LITERAL_5(R,e,g,e,x);
74 static const XMLCh Subst[] = UNICODE_LITERAL_5(S,u,b,s,t);
77 class SHIBSP_DLLLOCAL TransformSessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
80 TransformSessionInitiator(const DOMElement* e, const char* appId)
81 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.Transform"), &g_TSINFilter), m_appId(appId) {
82 // If Location isn't set, defer address registration until the setParent call.
83 pair<bool,const char*> loc = getString("Location");
85 string address = m_appId + loc.second + "::run::TransformSI";
86 setAddress(address.c_str());
88 m_supportedOptions.insert("isPassive");
91 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
92 m_alwaysRun = getBool("alwaysRun").second;
93 e = XMLHelper::getFirstChildElement(e);
95 if (e->hasChildNodes()) {
96 const XMLCh* flag = e->getAttributeNS(NULL, force);
99 if (XMLString::equals(e->getLocalName(), Subst)) {
100 auto_ptr_char temp(e->getFirstChild()->getNodeValue());
101 if (temp.get() && *temp.get())
102 m_subst.push_back(pair<bool,string>((*flag==chDigit_1 || *flag==chLatin_t), temp.get()));
104 else if (XMLString::equals(e->getLocalName(), Regex) && e->hasAttributeNS(NULL, match)) {
105 auto_ptr_char m(e->getAttributeNS(NULL, match));
106 auto_ptr_char repl(e->getFirstChild()->getNodeValue());
107 if (m.get() && *m.get() && repl.get() && *repl.get())
108 m_regex.push_back(make_pair((*flag==chDigit_1 || *flag==chLatin_t), pair<string,string>(m.get(), repl.get())));
111 m_log.warn("Unknown element found in Transform SessionInitiator configuration, check for errors.");
114 e = XMLHelper::getNextSiblingElement(e);
120 virtual ~TransformSessionInitiator() {}
122 void setParent(const PropertySet* parent);
123 void receive(DDF& in, ostream& out);
124 pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
127 void doRequest(const Application& application, string& entityID) const;
131 vector< pair<bool, string> > m_subst;
132 vector< pair< bool, pair<string,string> > > m_regex;
136 #if defined (_MSC_VER)
137 #pragma warning( pop )
140 SessionInitiator* SHIBSP_DLLLOCAL TransformSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
142 return new TransformSessionInitiator(p.first, p.second);
147 void TransformSessionInitiator::setParent(const PropertySet* parent)
149 DOMPropertySet::setParent(parent);
150 pair<bool,const char*> loc = getString("Location");
152 string address = m_appId + loc.second + "::run::TransformSI";
153 setAddress(address.c_str());
156 m_log.warn("no Location property in Transform SessionInitiator (or parent), can't register as remoted handler");
160 pair<bool,long> TransformSessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
162 // We have to have a candidate name to function.
163 if (entityID.empty() || !checkCompatibility(request, isHandler))
164 return make_pair(false,0L);
167 const Application& app=request.getApplication();
169 m_log.debug("attempting to transform input (%s) into a valid entityID", entityID.c_str());
171 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess))
172 doRequest(app, entityID);
175 DDF out,in = DDF(m_address.c_str()).structure();
176 DDFJanitor jin(in), jout(out);
177 in.addmember("application_id").string(app.getId());
178 in.addmember("entity_id").string(entityID.c_str());
180 // Remote the processing.
181 out = request.getServiceProvider().getListenerService()->send(in);
183 entityID = out.string();
186 return make_pair(false,0L);
189 void TransformSessionInitiator::receive(DDF& in, ostream& out)
192 const char* aid=in["application_id"].string();
193 const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
195 // Something's horribly wrong.
196 m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
197 throw ConfigurationException("Unable to locate application for new session, deleted?");
200 const char* entityID = in["entity_id"].string();
202 throw ConfigurationException("No entityID parameter supplied to remoted SessionInitiator.");
204 string copy(entityID);
205 doRequest(*app, copy);
206 DDF ret = DDF(NULL).string(copy.c_str());
207 DDFJanitor jout(ret);
211 void TransformSessionInitiator::doRequest(const Application& application, string& entityID) const
214 MetadataProvider* m=application.getMetadataProvider();
217 MetadataProviderCriteria mc(application, entityID.c_str(), &IDPSSODescriptor::ELEMENT_QNAME);
218 pair<const EntityDescriptor*,const RoleDescriptor*> entity;
220 // First check the original value, it might be valid already.
221 entity = m->getEntityDescriptor(mc);
226 m_log.debug("attempting transform of (%s)", entityID.c_str());
228 // Guess not, try each subst.
230 for (vector< pair<bool,string> >::const_iterator t = m_subst.begin(); t != m_subst.end(); ++t) {
231 string::size_type pos = t->second.find("$entityID");
232 if (pos == string::npos)
234 transform = t->second;
235 transform.replace(pos, 9, entityID);
237 m_log.info("forcibly transformed entityID from (%s) to (%s)", entityID.c_str(), transform.c_str());
238 entityID = transform;
241 m_log.debug("attempting lookup with entityID (%s)", transform.c_str());
243 mc.entityID_ascii = transform.c_str();
244 entity = m->getEntityDescriptor(mc);
246 m_log.info("transformed entityID from (%s) to (%s)", entityID.c_str(), transform.c_str());
248 entityID = transform;
254 for (vector< pair< bool, pair<string,string> > >::const_iterator r = m_regex.begin(); r != m_regex.end(); ++r) {
256 RegularExpression exp(r->second.first.c_str());
257 XMLCh* temp = exp.replace(entityID.c_str(), r->second.second.c_str());
259 auto_ptr_char narrow(temp);
260 XMLString::release(&temp);
262 // For some reason it returns the match string if it doesn't match the expression.
263 if (entityID == narrow.get())
267 m_log.info("forcibly transformed entityID from (%s) to (%s)", entityID.c_str(), narrow.get());
268 entityID = narrow.get();
271 m_log.debug("attempting lookup with entityID (%s)", narrow.get());
273 mc.entityID_ascii = narrow.get();
274 entity = m->getEntityDescriptor(mc);
276 m_log.info("transformed entityID from (%s) to (%s)", entityID.c_str(), narrow.get());
278 entityID = narrow.get();
283 catch (XMLException& ex) {
284 auto_ptr_char msg(ex.getMessage());
285 m_log.error("caught error applying regular expression: %s", msg.get());
289 m_log.warn("unable to find a valid entityID based on the supplied input");