shibsp/handler/impl/WAYFSessionInitiator.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  * WAYFSessionInitiator.cpp
  19  *
  20  * Shibboleth WAYF support.
  21  */
  22
  23 #include "internal.h"
  24 #include "Application.h"
  25 #include "exceptions.h"
  26 #include "SPRequest.h"
  27 #include "handler/AbstractHandler.h"
  28 #include "handler/SessionInitiator.h"
  29
  30 #ifndef SHIBSP_LITE
  31 # include <saml/util/SAMLConstants.h>
  32 #else
  33 # include "lite/SAMLConstants.h"
  34 #endif
  35
  36 #include <ctime>
  37 #include <xmltooling/XMLToolingConfig.h>
  38 #include <xmltooling/util/URLEncoder.h>
  39
  40 using namespace shibsp;
  41 using namespace opensaml;
  42 using namespace xmltooling;
  43 using namespace std;
  44
  45 namespace shibsp {
  46
  47 #if defined (_MSC_VER)
  48     #pragma warning( push )
  49     #pragma warning( disable : 4250 )
  50 #endif
  51
  52     class SHIBSP_DLLLOCAL WAYFSessionInitiator : public SessionInitiator, public AbstractHandler
  53     {
  54     public:
  55         WAYFSessionInitiator(const DOMElement* e, const char* appId)
  56                 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.WAYF"), nullptr, &m_remapper), m_url(nullptr) {
  57             pair<bool,const char*> url = getString("URL");
  58             if (!url.first)
  59                 throw ConfigurationException("WAYF SessionInitiator requires a URL property.");
  60             m_url = url.second;
  61         }
  62         virtual ~WAYFSessionInitiator() {}
  63
  64         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
  65
  66         const XMLCh* getProtocolFamily() const {
  67             return samlconstants::SAML11_PROTOCOL_ENUM;
  68         }
  69
  70     private:
  71         const char* m_url;
  72     };
  73
  74 #if defined (_MSC_VER)
  75     #pragma warning( pop )
  76 #endif
  77
  78     SessionInitiator* SHIBSP_DLLLOCAL WAYFSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
  79     {
  80         return new WAYFSessionInitiator(p.first, p.second);
  81     }
  82
  83 };
  84
  85 pair<bool,long> WAYFSessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
  86 {
  87     // The IdP CANNOT be specified for us to run. Otherwise, we'd be redirecting to a WAYF
  88     // anytime the IdP's metadata was wrong.
  89     if (!entityID.empty() || !checkCompatibility(request, isHandler))
  90         return make_pair(false,0L);
  91
  92     string target;
  93     pair<bool,const char*> prop;
  94     const Handler* ACS=nullptr;
  95     const Application& app=request.getApplication();
  96     pair<bool,const char*> discoveryURL = pair<bool,const char*>(true, m_url);
  97
  98     if (isHandler) {
  99         prop.second = request.getParameter("acsIndex");
 100         if (prop.second && *prop.second) {
 101             ACS = app.getAssertionConsumerServiceByIndex(atoi(prop.second));
 102             if (!ACS)
 103                 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using acsIndex property");
 104         }
 105
 106         prop = getString("target", request);
 107         if (prop.first)
 108             target = prop.second;
 109
 110         // Since we're passing the ACS by value, we need to compute the return URL,
 111         // so we'll need the target resource for real.
 112         recoverRelayState(request.getApplication(), request, request, target, false);
 113
 114         prop.second = request.getParameter("discoveryURL");
 115         if (prop.second && *prop.second)
 116             discoveryURL.second = prop.second;
 117     }
 118     else {
 119         // Check for a hardwired target value in the map or handler.
 120         prop = getString("target", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 121         if (prop.first)
 122             target = prop.second;
 123         else
 124             target = request.getRequestURL();
 125
 126         discoveryURL = request.getRequestSettings().first->getString("discoveryURL");
 127     }
 128
 129     if (!ACS) {
 130         // Try fixed index property.
 131         pair<bool,unsigned int> index = getUnsignedInt("acsIndex", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 132         if (index.first)
 133             ACS = app.getAssertionConsumerServiceByIndex(index.second);
 134     }
 135
 136     // If we picked by index, validate the ACS for use with this protocol.
 137     if (!ACS || !XMLString::equals(samlconstants::SAML11_PROTOCOL_ENUM, ACS->getProtocolFamily())) {
 138         if (ACS)
 139             request.log(SPRequest::SPWarn, "invalid acsIndex property, or non-SAML 1.x ACS, using default SAML 1.x ACS");
 140         ACS = app.getAssertionConsumerServiceByProtocol(getProtocolFamily());
 141         if (!ACS)
 142             throw ConfigurationException("Unable to locate a SAML 1.x ACS endpoint to use for response.");
 143     }
 144
 145     if (!discoveryURL.first)
 146         discoveryURL.second = m_url;
 147     m_log.debug("sending request to WAYF (%s)", discoveryURL.second);
 148
 149     // Since we're not passing by index, we need to fully compute the return URL.
 150     // Compute the ACS URL. We add the ACS location to the base handlerURL.
 151     string ACSloc = request.getHandlerURL(target.c_str());
 152     prop = ACS->getString("Location");
 153     if (prop.first)
 154         ACSloc += prop.second;
 155
 156     if (isHandler) {
 157         // We may already have RelayState set if we looped back here,
 158         // but we've turned it back into a resource by this point, so if there's
 159         // a target on the URL, reset to that value.
 160         prop.second = request.getParameter("target");
 161         if (prop.second && *prop.second)
 162             target = prop.second;
 163     }
 164
 165     preserveRelayState(app, request, target);
 166     if (!isHandler)
 167         preservePostData(app, request, request, target.c_str());
 168
 169     // WAYF requires a target value.
 170     if (target.empty())
 171         target = "default";
 172
 173     char timebuf[16];
 174     sprintf(timebuf,"%lu",time(nullptr));
 175     const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
 176     string req=string(discoveryURL.second) + (strchr(discoveryURL.second,'?') ? '&' : '?') + "shire=" + urlenc->encode(ACSloc.c_str()) +
 177         "&time=" + timebuf + "&target=" + urlenc->encode(target.c_str()) +
 178         "&providerId=" + urlenc->encode(app.getString("entityID").second);
 179
 180     return make_pair(true, request.sendRedirect(req.c_str()));
 181 }