shibsp/handler/impl/Shib1SessionInitiator.cpp

   1 /*
   2  *  Copyright 2001-2007 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 "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 # include <saml/saml2/metadata/EndpointManager.h>
  37 #endif
  38 #include <xmltooling/XMLToolingConfig.h>
  39 #include <xmltooling/util/URLEncoder.h>
  40
  41 using namespace shibsp;
  42 using namespace opensaml::saml2md;
  43 using namespace opensaml;
  44 using namespace xmltooling;
  45 using namespace std;
  46
  47 namespace shibsp {
  48
  49 #if defined (_MSC_VER)
  50     #pragma warning( push )
  51     #pragma warning( disable : 4250 )
  52 #endif
  53
  54     class SHIBSP_DLLLOCAL Shib1SessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
  55     {
  56     public:
  57         Shib1SessionInitiator(const DOMElement* e, const char* appId)
  58                 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.Shib1")), m_appId(appId) {
  59             // If Location isn't set, defer address registration until the setParent call.
  60             pair<bool,const char*> loc = getString("Location");
  61             if (loc.first) {
  62                 string address = m_appId + loc.second + "::run::Shib1SI";
  63                 setAddress(address.c_str());
  64             }
  65         }
  66         virtual ~Shib1SessionInitiator() {}
  67
  68         void setParent(const PropertySet* parent);
  69         void receive(DDF& in, ostream& out);
  70         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
  71
  72     private:
  73         pair<bool,long> doRequest(
  74             const Application& application,
  75             HTTPResponse& httpResponse,
  76             const char* entityID,
  77             const char* acsLocation,
  78             string& relayState
  79             ) const;
  80         string m_appId;
  81     };
  82
  83 #if defined (_MSC_VER)
  84     #pragma warning( pop )
  85 #endif
  86
  87     SessionInitiator* SHIBSP_DLLLOCAL Shib1SessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
  88     {
  89         return new Shib1SessionInitiator(p.first, p.second);
  90     }
  91
  92 };
  93
  94 void Shib1SessionInitiator::setParent(const PropertySet* parent)
  95 {
  96     DOMPropertySet::setParent(parent);
  97     pair<bool,const char*> loc = getString("Location");
  98     if (loc.first) {
  99         string address = m_appId + loc.second + "::run::Shib1SI";
 100         setAddress(address.c_str());
 101     }
 102     else {
 103         m_log.warn("no Location property in Shib1 SessionInitiator (or parent), can't register as remoted handler");
 104     }
 105 }
 106
 107 pair<bool,long> Shib1SessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
 108 {
 109     // We have to know the IdP to function.
 110     if (entityID.empty())
 111         return make_pair(false,0L);
 112
 113     string target;
 114     const Handler* ACS=NULL;
 115     const char* option;
 116     const Application& app=request.getApplication();
 117
 118     if (isHandler) {
 119         option=request.getParameter("acsIndex");
 120         if (option) {
 121             ACS = app.getAssertionConsumerServiceByIndex(atoi(option));
 122             if (!ACS)
 123                 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using default ACS location");
 124         }
 125
 126         option = request.getParameter("target");
 127         if (option)
 128             target = option;
 129
 130         // Since we're passing the ACS by value, we need to compute the return URL,
 131         // so we'll need the target resource for real.
 132         recoverRelayState(request.getApplication(), request, request, target, false);
 133     }
 134     else {
 135         // We're running as a "virtual handler" from within the filter.
 136         // The target resource is the current one and everything else is defaulted.
 137         target=request.getRequestURL();
 138     }
 139
 140     // Since we're not passing by index, we need to fully compute the return URL.
 141     if (!ACS) {
 142         pair<bool,unsigned int> index = getUnsignedInt("defaultACSIndex");
 143         if (index.first) {
 144             ACS = app.getAssertionConsumerServiceByIndex(index.second);
 145             if (!ACS)
 146                 request.log(SPRequest::SPWarn, "invalid defaultACSIndex, using default ACS location");
 147         }
 148         if (!ACS)
 149             ACS = app.getDefaultAssertionConsumerService();
 150     }
 151
 152     // Compute the ACS URL. We add the ACS location to the base handlerURL.
 153     string ACSloc=request.getHandlerURL(target.c_str());
 154     pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
 155     if (loc.first) ACSloc+=loc.second;
 156
 157     if (isHandler) {
 158         // We may already have RelayState set if we looped back here,
 159         // but just in case target is a resource, we reset it back.
 160         target.erase();
 161         option = request.getParameter("target");
 162         if (option)
 163             target = option;
 164     }
 165
 166     m_log.debug("attempting to initiate session using Shibboleth with provider (%s)", entityID.c_str());
 167
 168     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess))
 169         return doRequest(app, request, entityID.c_str(), ACSloc.c_str(), target);
 170
 171     // Remote the call.
 172     DDF out,in = DDF(m_address.c_str()).structure();
 173     DDFJanitor jin(in), jout(out);
 174     in.addmember("application_id").string(app.getId());
 175     in.addmember("entity_id").string(entityID.c_str());
 176     in.addmember("acsLocation").string(ACSloc.c_str());
 177     if (!target.empty())
 178         in.addmember("RelayState").string(target.c_str());
 179
 180     // Remote the processing.
 181     out = request.getServiceProvider().getListenerService()->send(in);
 182     return unwrap(request, out);
 183 }
 184
 185 void Shib1SessionInitiator::receive(DDF& in, ostream& out)
 186 {
 187     // Find application.
 188     const char* aid=in["application_id"].string();
 189     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
 190     if (!app) {
 191         // Something's horribly wrong.
 192         m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
 193         throw ConfigurationException("Unable to locate application for new session, deleted?");
 194     }
 195
 196     const char* entityID = in["entity_id"].string();
 197     const char* acsLocation = in["acsLocation"].string();
 198     if (!entityID || !acsLocation)
 199         throw ConfigurationException("No entityID or acsLocation parameter supplied to remoted SessionInitiator.");
 200
 201     DDF ret(NULL);
 202     DDFJanitor jout(ret);
 203
 204     // Wrap the outgoing object with a Response facade.
 205     auto_ptr<HTTPResponse> http(getResponse(ret));
 206
 207     string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
 208
 209     // Since we're remoted, the result should either be a throw, which we pass on,
 210     // a false/0 return, which we just return as an empty structure, or a response/redirect,
 211     // which we capture in the facade and send back.
 212     doRequest(*app, *http.get(), entityID, acsLocation, relayState);
 213     out << ret;
 214 }
 215
 216 pair<bool,long> Shib1SessionInitiator::doRequest(
 217     const Application& app,
 218     HTTPResponse& httpResponse,
 219     const char* entityID,
 220     const char* acsLocation,
 221     string& relayState
 222     ) const
 223 {
 224 #ifndef SHIBSP_LITE
 225     // Use metadata to invoke the SSO service directly.
 226     MetadataProvider* m=app.getMetadataProvider();
 227     Locker locker(m);
 228     MetadataProviderCriteria mc(app, entityID, &IDPSSODescriptor::ELEMENT_QNAME, shibspconstants::SHIB1_PROTOCOL_ENUM);
 229     pair<const EntityDescriptor*,const RoleDescriptor*> entity = m->getEntityDescriptor(mc);
 230     if (!entity.first) {
 231         m_log.warn("unable to locate metadata for provider (%s)", entityID);
 232         throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
 233     }
 234     else if (!entity.second) {
 235         m_log.warn("unable to locate Shibboleth-aware identity provider role for provider (%s)", entityID);
 236         if (getParent())
 237             return make_pair(false,0L);
 238         throw MetadataException("Unable to locate Shibboleth-aware identity provider role for provider ($entityID)", namedparams(1, "entityID", entityID));
 239     }
 240     const EndpointType* ep=EndpointManager<SingleSignOnService>(
 241         dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleSignOnServices()
 242         ).getByBinding(shibspconstants::SHIB1_AUTHNREQUEST_PROFILE_URI);
 243     if (!ep) {
 244         m_log.warn("unable to locate compatible SSO service for provider (%s)", entityID);
 245         if (getParent())
 246             return make_pair(false,0L);
 247         throw MetadataException("Unable to locate compatible SSO service for provider ($entityID)", namedparams(1, "entityID", entityID));
 248     }
 249
 250     preserveRelayState(app, httpResponse, relayState);
 251
 252     // Shib 1.x requires a target value.
 253     if (relayState.empty())
 254         relayState = "default";
 255
 256     char timebuf[16];
 257     sprintf(timebuf,"%lu",time(NULL));
 258     const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
 259     auto_ptr_char dest(ep->getLocation());
 260     string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "shire=" + urlenc->encode(acsLocation) +
 261         "&time=" + timebuf + "&target=" + urlenc->encode(relayState.c_str()) +
 262         "&providerId=" + urlenc->encode(app.getRelyingParty(entity.first)->getString("entityID").second);
 263
 264     return make_pair(true, httpResponse.sendRedirect(req.c_str()));
 265 #else
 266     return make_pair(false,0L);
 267 #endif
 268 }