shibsp/handler/impl/Shib1SessionInitiator.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  * Shib1SessionInitiator.cpp
  19  *
  20  * Shibboleth 1.x AuthnRequest support.
  21  */
  22
  23 #include "internal.h"
  24 #include "Application.h"
  25 #include "exceptions.h"
  26 #include "ServiceProvider.h"
  27 #include "handler/AbstractHandler.h"
  28 #include "handler/RemotedHandler.h"
  29 #include "handler/SessionInitiator.h"
  30 #include "util/SPConstants.h"
  31
  32 #ifndef SHIBSP_LITE
  33 # include "metadata/MetadataProviderCriteria.h"
  34 # include <saml/saml2/metadata/Metadata.h>
  35 # include <saml/saml2/metadata/EndpointManager.h>
  36 # include <saml/util/SAMLConstants.h>
  37 #else
  38 # include "lite/SAMLConstants.h"
  39 #endif
  40 #include <xmltooling/XMLToolingConfig.h>
  41 #include <xmltooling/util/URLEncoder.h>
  42
  43 using namespace shibsp;
  44 using namespace opensaml::saml2md;
  45 using namespace opensaml;
  46 using namespace xmltooling;
  47 using namespace std;
  48
  49 namespace shibsp {
  50
  51 #if defined (_MSC_VER)
  52     #pragma warning( push )
  53     #pragma warning( disable : 4250 )
  54 #endif
  55
  56     class SHIBSP_DLLLOCAL Shib1SessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
  57     {
  58     public:
  59         Shib1SessionInitiator(const DOMElement* e, const char* appId)
  60                 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.Shib1"), NULL, &m_remapper), m_appId(appId) {
  61             // If Location isn't set, defer address registration until the setParent call.
  62             pair<bool,const char*> loc = getString("Location");
  63             if (loc.first) {
  64                 string address = m_appId + loc.second + "::run::Shib1SI";
  65                 setAddress(address.c_str());
  66             }
  67         }
  68         virtual ~Shib1SessionInitiator() {}
  69
  70         void setParent(const PropertySet* parent);
  71         void receive(DDF& in, ostream& out);
  72         pair<bool,long> unwrap(SPRequest& request, DDF& out) const;
  73         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
  74
  75     private:
  76         pair<bool,long> doRequest(
  77             const Application& application,
  78             const HTTPRequest* httpRequest,
  79             HTTPResponse& httpResponse,
  80             const char* entityID,
  81             const char* acsLocation,
  82             bool artifact,
  83             string& relayState
  84             ) const;
  85         string m_appId;
  86     };
  87
  88 #if defined (_MSC_VER)
  89     #pragma warning( pop )
  90 #endif
  91
  92     SessionInitiator* SHIBSP_DLLLOCAL Shib1SessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
  93     {
  94         return new Shib1SessionInitiator(p.first, p.second);
  95     }
  96
  97 };
  98
  99 void Shib1SessionInitiator::setParent(const PropertySet* parent)
 100 {
 101     DOMPropertySet::setParent(parent);
 102     pair<bool,const char*> loc = getString("Location");
 103     if (loc.first) {
 104         string address = m_appId + loc.second + "::run::Shib1SI";
 105         setAddress(address.c_str());
 106     }
 107     else {
 108         m_log.warn("no Location property in Shib1 SessionInitiator (or parent), can't register as remoted handler");
 109     }
 110 }
 111
 112 pair<bool,long> Shib1SessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
 113 {
 114     // We have to know the IdP to function.
 115     if (entityID.empty() || !checkCompatibility(request, isHandler))
 116         return make_pair(false,0L);
 117
 118     string target;
 119     string postData;
 120     const Handler* ACS=NULL;
 121     const char* option;
 122     const Application& app=request.getApplication();
 123
 124     if (isHandler) {
 125         option=request.getParameter("acsIndex");
 126         if (option) {
 127             ACS = app.getAssertionConsumerServiceByIndex(atoi(option));
 128             if (!ACS)
 129                 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using acsIndex property");
 130         }
 131
 132         option = request.getParameter("target");
 133         if (option)
 134             target = option;
 135
 136         // Since we're passing the ACS by value, we need to compute the return URL,
 137         // so we'll need the target resource for real.
 138         recoverRelayState(request.getApplication(), request, request, target, false);
 139     }
 140     else {
 141         // We're running as a "virtual handler" from within the filter.
 142         // The target resource is the current one and everything else is defaulted.
 143         target=request.getRequestURL();
 144     }
 145
 146     // Since we're not passing by index, we need to fully compute the return URL.
 147     if (!ACS) {
 148         pair<bool,unsigned int> index = getUnsignedInt("acsIndex");
 149         if (index.first) {
 150             ACS = app.getAssertionConsumerServiceByIndex(index.second);
 151             if (!ACS)
 152                 request.log(SPRequest::SPWarn, "invalid acsIndex property, using default ACS location");
 153         }
 154         if (!ACS)
 155             ACS = app.getDefaultAssertionConsumerService();
 156     }
 157
 158     // Validate the ACS for use with this protocol.
 159     pair<bool,const char*> ACSbinding = ACS ? ACS->getString("Binding") : pair<bool,const char*>(false,NULL);
 160     if (ACSbinding.first) {
 161         pair<bool,const char*> compatibleBindings = getString("compatibleBindings");
 162         if (compatibleBindings.first && strstr(compatibleBindings.second, ACSbinding.second) == NULL) {
 163             m_log.error("configured or requested ACS has non-SAML 1.x binding");
 164             throw ConfigurationException("Configured or requested ACS has non-SAML 1.x binding ($1).", params(1, ACSbinding.second));
 165         }
 166         else if (strcmp(ACSbinding.second, samlconstants::SAML1_PROFILE_BROWSER_POST) &&
 167                  strcmp(ACSbinding.second, samlconstants::SAML1_PROFILE_BROWSER_ARTIFACT)) {
 168             m_log.error("configured or requested ACS has non-SAML 1.x binding");
 169             throw ConfigurationException("Configured or requested ACS has non-SAML 1.x binding ($1).", params(1, ACSbinding.second));
 170         }
 171     }
 172
 173     // Compute the ACS URL. We add the ACS location to the base handlerURL.
 174     string ACSloc=request.getHandlerURL(target.c_str());
 175     pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
 176     if (loc.first) ACSloc+=loc.second;
 177
 178     if (isHandler) {
 179         // We may already have RelayState set if we looped back here,
 180         // but just in case target is a resource, we reset it back.
 181         target.erase();
 182         option = request.getParameter("target");
 183         if (option)
 184             target = option;
 185     }
 186
 187     // Is the in-bound binding artifact?
 188     bool artifactInbound = ACS ? XMLString::equals(ACS->getString("Binding").second, samlconstants::SAML1_PROFILE_BROWSER_ARTIFACT) : false;
 189
 190     m_log.debug("attempting to initiate session using Shibboleth with provider (%s)", entityID.c_str());
 191
 192     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 193         // Out of process means the POST data via the request can be exposed directly to the private method.
 194         // The method will handle POST preservation if necessary *before* issuing the response, but only if
 195         // it dispatches to an IdP.
 196         return doRequest(app, &request, request, entityID.c_str(), ACSloc.c_str(), artifactInbound, target);
 197     }
 198
 199     // Remote the call.
 200     DDF out,in = DDF(m_address.c_str()).structure();
 201     DDFJanitor jin(in), jout(out);
 202     in.addmember("application_id").string(app.getId());
 203     in.addmember("entity_id").string(entityID.c_str());
 204     in.addmember("acsLocation").string(ACSloc.c_str());
 205     if (artifactInbound)
 206         in.addmember("artifact").integer(1);
 207     if (!target.empty())
 208         in.addmember("RelayState").unsafe_string(target.c_str());
 209
 210     // Remote the processing. Our unwrap method will handle POST data if necessary.
 211     out = request.getServiceProvider().getListenerService()->send(in);
 212     return unwrap(request, out);
 213 }
 214
 215 pair<bool,long> Shib1SessionInitiator::unwrap(SPRequest& request, DDF& out) const
 216 {
 217     // See if there's any response to send back.
 218     if (!out["redirect"].isnull() || !out["response"].isnull()) {
 219         // If so, we're responsible for handling the POST data, probably by dropping a cookie.
 220         preservePostData(request.getApplication(), request, request, out["RelayState"].string());
 221     }
 222     return RemotedHandler::unwrap(request, out);
 223 }
 224
 225 void Shib1SessionInitiator::receive(DDF& in, ostream& out)
 226 {
 227     // Find application.
 228     const char* aid=in["application_id"].string();
 229     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
 230     if (!app) {
 231         // Something's horribly wrong.
 232         m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
 233         throw ConfigurationException("Unable to locate application for new session, deleted?");
 234     }
 235
 236     const char* entityID = in["entity_id"].string();
 237     const char* acsLocation = in["acsLocation"].string();
 238     if (!entityID || !acsLocation)
 239         throw ConfigurationException("No entityID or acsLocation parameter supplied to remoted SessionInitiator.");
 240
 241     DDF ret(NULL);
 242     DDFJanitor jout(ret);
 243
 244     // Wrap the outgoing object with a Response facade.
 245     auto_ptr<HTTPResponse> http(getResponse(ret));
 246
 247     string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
 248
 249     // Since we're remoted, the result should either be a throw, which we pass on,
 250     // a false/0 return, which we just return as an empty structure, or a response/redirect,
 251     // which we capture in the facade and send back.
 252     doRequest(*app, NULL, *http.get(), entityID, acsLocation, (in["artifact"].integer() != 0), relayState);
 253     if (!ret.isstruct())
 254         ret.structure();
 255     ret.addmember("RelayState").unsafe_string(relayState.c_str());
 256     out << ret;
 257 }
 258
 259 pair<bool,long> Shib1SessionInitiator::doRequest(
 260     const Application& app,
 261     const HTTPRequest* httpRequest,
 262     HTTPResponse& httpResponse,
 263     const char* entityID,
 264     const char* acsLocation,
 265     bool artifact,
 266     string& relayState
 267     ) const
 268 {
 269 #ifndef SHIBSP_LITE
 270     // Use metadata to invoke the SSO service directly.
 271     MetadataProvider* m=app.getMetadataProvider();
 272     Locker locker(m);
 273     MetadataProviderCriteria mc(app, entityID, &IDPSSODescriptor::ELEMENT_QNAME, shibspconstants::SHIB1_PROTOCOL_ENUM);
 274     pair<const EntityDescriptor*,const RoleDescriptor*> entity = m->getEntityDescriptor(mc);
 275     if (!entity.first) {
 276         m_log.warn("unable to locate metadata for provider (%s)", entityID);
 277         throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
 278     }
 279     else if (!entity.second) {
 280         m_log.log(getParent() ? Priority::INFO : Priority::WARN, "unable to locate Shibboleth-aware identity provider role for provider (%s)", entityID);
 281         if (getParent())
 282             return make_pair(false,0L);
 283         throw MetadataException("Unable to locate Shibboleth-aware identity provider role for provider ($entityID)", namedparams(1, "entityID", entityID));
 284     }
 285     else if (artifact && !SPConfig::getConfig().getArtifactResolver()->isSupported(dynamic_cast<const SSODescriptorType&>(*entity.second))) {
 286         m_log.warn("artifact profile selected for response, but identity provider lacks support");
 287         if (getParent())
 288             return make_pair(false,0L);
 289         throw MetadataException("Identity provider ($entityID) lacks SAML artifact support.", namedparams(1, "entityID", entityID));
 290     }
 291
 292     const EndpointType* ep=EndpointManager<SingleSignOnService>(
 293         dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleSignOnServices()
 294         ).getByBinding(shibspconstants::SHIB1_AUTHNREQUEST_PROFILE_URI);
 295     if (!ep) {
 296         m_log.warn("unable to locate compatible SSO service for provider (%s)", entityID);
 297         if (getParent())
 298             return make_pair(false,0L);
 299         throw MetadataException("Unable to locate compatible SSO service for provider ($entityID)", namedparams(1, "entityID", entityID));
 300     }
 301
 302     preserveRelayState(app, httpResponse, relayState);
 303
 304     // Shib 1.x requires a target value.
 305     if (relayState.empty())
 306         relayState = "default";
 307
 308     char timebuf[16];
 309     sprintf(timebuf,"%lu",time(NULL));
 310     const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
 311     auto_ptr_char dest(ep->getLocation());
 312     string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "shire=" + urlenc->encode(acsLocation) +
 313         "&time=" + timebuf + "&target=" + urlenc->encode(relayState.c_str()) +
 314         "&providerId=" + urlenc->encode(app.getRelyingParty(entity.first)->getString("entityID").second);
 315
 316     if (httpRequest) {
 317         // If the request object is available, we're responsible for the POST data.
 318         preservePostData(app, *httpRequest, httpResponse, relayState.c_str());
 319     }
 320
 321     return make_pair(true, httpResponse.sendRedirect(req.c_str()));
 322 #else
 323     return make_pair(false,0L);
 324 #endif
 325 }