shibsp/handler/impl/TransformSessionInitiator.cpp

   1 /*
   2  *  Copyright 2001-2010 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * TransformSessionInitiator.cpp
  19  *
  20  * Support for mapping input into an entityID using a transform.
  21  */
  22
  23 #include "internal.h"
  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"
  32
  33 #ifndef SHIBSP_LITE
  34 # include "metadata/MetadataProviderCriteria.h"
  35 # include <saml/saml2/metadata/Metadata.h>
  36 #endif
  37 #include <xmltooling/XMLToolingConfig.h>
  38 #include <xmltooling/util/URLEncoder.h>
  39 #include <xercesc/util/XMLUniDefs.hpp>
  40 #include <xercesc/util/regx/RegularExpression.hpp>
  41
  42 using namespace shibsp;
  43 using namespace opensaml::saml2md;
  44 using namespace opensaml;
  45 using namespace xmltooling;
  46 using namespace std;
  47
  48 namespace shibsp {
  49
  50 #if defined (_MSC_VER)
  51     #pragma warning( push )
  52     #pragma warning( disable : 4250 )
  53 #endif
  54
  55     class SHIBSP_DLLLOCAL TransformSINodeFilter : public DOMNodeFilter
  56     {
  57     public:
  58 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
  59         short
  60 #else
  61         FilterAction
  62 #endif
  63         acceptNode(const DOMNode* node) const {
  64             return FILTER_REJECT;
  65         }
  66     };
  67
  68     static SHIBSP_DLLLOCAL TransformSINodeFilter g_TSINFilter;
  69
  70 #ifndef SHIBSP_LITE
  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);
  75 #endif
  76
  77     class SHIBSP_DLLLOCAL TransformSessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
  78     {
  79     public:
  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");
  84             if (loc.first) {
  85                 string address = m_appId + loc.second + "::run::TransformSI";
  86                 setAddress(address.c_str());
  87             }
  88             m_supportedOptions.insert("isPassive");
  89
  90 #ifndef SHIBSP_LITE
  91             if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
  92                 m_alwaysRun = getBool("alwaysRun").second;
  93                 e = XMLHelper::getFirstChildElement(e);
  94                 while (e) {
  95                     if (e->hasChildNodes()) {
  96                         const XMLCh* flag = e->getAttributeNS(NULL, force);
  97                         if (!flag)
  98                             flag = &chNull;
  99                         if (XMLString::equals(e->getLocalName(), Subst)) {
 100                             auto_ptr_char temp(e->getFirstChild()->getNodeValue());
 101                             m_subst.push_back(pair<bool,string>((*flag==chDigit_1 || *flag==chLatin_t), temp.get()));
 102                         }
 103                         else if (XMLString::equals(e->getLocalName(), Regex) && e->hasAttributeNS(NULL, match)) {
 104                             auto_ptr_char m(e->getAttributeNS(NULL, match));
 105                             auto_ptr_char repl(e->getFirstChild()->getNodeValue());
 106                             m_regex.push_back(make_pair((*flag==chDigit_1 || *flag==chLatin_t), pair<string,string>(m.get(), repl.get())));
 107                         }
 108                         else {
 109                             m_log.warn("Unknown element found in Transform SessionInitiator configuration, check for errors.");
 110                         }
 111                     }
 112                     e = XMLHelper::getNextSiblingElement(e);
 113                 }
 114             }
 115 #endif
 116         }
 117
 118         virtual ~TransformSessionInitiator() {}
 119
 120         void setParent(const PropertySet* parent);
 121         void receive(DDF& in, ostream& out);
 122         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
 123
 124     private:
 125         void doRequest(const Application& application, string& entityID) const;
 126         string m_appId;
 127 #ifndef SHIBSP_LITE
 128         bool m_alwaysRun;
 129         vector< pair<bool, string> > m_subst;
 130         vector< pair< bool, pair<string,string> > > m_regex;
 131 #endif
 132     };
 133
 134 #if defined (_MSC_VER)
 135     #pragma warning( pop )
 136 #endif
 137
 138     SessionInitiator* SHIBSP_DLLLOCAL TransformSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
 139     {
 140         return new TransformSessionInitiator(p.first, p.second);
 141     }
 142
 143 };
 144
 145 void TransformSessionInitiator::setParent(const PropertySet* parent)
 146 {
 147     DOMPropertySet::setParent(parent);
 148     pair<bool,const char*> loc = getString("Location");
 149     if (loc.first) {
 150         string address = m_appId + loc.second + "::run::TransformSI";
 151         setAddress(address.c_str());
 152     }
 153     else {
 154         m_log.warn("no Location property in Transform SessionInitiator (or parent), can't register as remoted handler");
 155     }
 156 }
 157
 158 pair<bool,long> TransformSessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
 159 {
 160     // We have to have a candidate name to function.
 161     if (entityID.empty() || !checkCompatibility(request, isHandler))
 162         return make_pair(false,0L);
 163
 164     string target;
 165     const Application& app=request.getApplication();
 166
 167     m_log.debug("attempting to transform input (%s) into a valid entityID", entityID.c_str());
 168
 169     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess))
 170         doRequest(app, entityID);
 171     else {
 172         // Remote the call.
 173         DDF out,in = DDF(m_address.c_str()).structure();
 174         DDFJanitor jin(in), jout(out);
 175         in.addmember("application_id").string(app.getId());
 176         in.addmember("entity_id").string(entityID.c_str());
 177
 178         // Remote the processing.
 179         out = request.getServiceProvider().getListenerService()->send(in);
 180         if (out.isstring())
 181             entityID = out.string();
 182     }
 183
 184     return make_pair(false,0L);
 185 }
 186
 187 void TransformSessionInitiator::receive(DDF& in, ostream& out)
 188 {
 189     // Find application.
 190     const char* aid=in["application_id"].string();
 191     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
 192     if (!app) {
 193         // Something's horribly wrong.
 194         m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
 195         throw ConfigurationException("Unable to locate application for new session, deleted?");
 196     }
 197
 198     const char* entityID = in["entity_id"].string();
 199     if (!entityID)
 200         throw ConfigurationException("No entityID parameter supplied to remoted SessionInitiator.");
 201
 202     string copy(entityID);
 203     doRequest(*app, copy);
 204     DDF ret = DDF(NULL).string(copy.c_str());
 205     DDFJanitor jout(ret);
 206     out << ret;
 207 }
 208
 209 void TransformSessionInitiator::doRequest(const Application& application, string& entityID) const
 210 {
 211 #ifndef SHIBSP_LITE
 212     MetadataProvider* m=application.getMetadataProvider();
 213     Locker locker(m);
 214
 215     MetadataProviderCriteria mc(application, entityID.c_str(), &IDPSSODescriptor::ELEMENT_QNAME);
 216     pair<const EntityDescriptor*,const RoleDescriptor*> entity;
 217     if (!m_alwaysRun) {
 218         // First check the original value, it might be valid already.
 219         entity = m->getEntityDescriptor(mc);
 220         if (entity.first)
 221             return;
 222     }
 223
 224     m_log.debug("attempting transform of (%s)", entityID.c_str());
 225
 226     // Guess not, try each subst.
 227     string transform;
 228     for (vector< pair<bool,string> >::const_iterator t = m_subst.begin(); t != m_subst.end(); ++t) {
 229         string::size_type pos = t->second.find("$entityID");
 230         if (pos == string::npos)
 231             continue;
 232         transform = t->second;
 233         transform.replace(pos, 9, entityID);
 234         if (t->first) {
 235             m_log.info("forcibly transformed entityID from (%s) to (%s)", entityID.c_str(), transform.c_str());
 236             entityID = transform;
 237         }
 238
 239         m_log.debug("attempting lookup with entityID (%s)", transform.c_str());
 240
 241         mc.entityID_ascii = transform.c_str();
 242         entity = m->getEntityDescriptor(mc);
 243         if (entity.first) {
 244             m_log.info("transformed entityID from (%s) to (%s)", entityID.c_str(), transform.c_str());
 245             if (!t->first)
 246                 entityID = transform;
 247             return;
 248         }
 249     }
 250
 251     // Now try regexs.
 252     for (vector< pair< bool, pair<string,string> > >::const_iterator r = m_regex.begin(); r != m_regex.end(); ++r) {
 253         try {
 254             RegularExpression exp(r->second.first.c_str());
 255             XMLCh* temp = exp.replace(entityID.c_str(), r->second.second.c_str());
 256             if (temp) {
 257                 auto_ptr_char narrow(temp);
 258                 XMLString::release(&temp);
 259
 260                 // For some reason it returns the match string if it doesn't match the expression.
 261                 if (entityID == narrow.get())
 262                     continue;
 263
 264                 if (r->first) {
 265                     m_log.info("forcibly transformed entityID from (%s) to (%s)", entityID.c_str(), narrow.get());
 266                     entityID = narrow.get();
 267                 }
 268
 269                 m_log.debug("attempting lookup with entityID (%s)", narrow.get());
 270
 271                 mc.entityID_ascii = narrow.get();
 272                 entity = m->getEntityDescriptor(mc);
 273                 if (entity.first) {
 274                     m_log.info("transformed entityID from (%s) to (%s)", entityID.c_str(), narrow.get());
 275                     if (!r->first)
 276                         entityID = narrow.get();
 277                     return;
 278                 }
 279             }
 280         }
 281         catch (XMLException& ex) {
 282             auto_ptr_char msg(ex.getMessage());
 283             m_log.error("caught error applying regular expression: %s", msg.get());
 284         }
 285     }
 286
 287     m_log.warn("unable to find a valid entityID based on the supplied input");
 288 #endif
 289 }