shibsp/ServiceProvider.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  * ServiceProvider.cpp
  19  *
  20  * Interface to a Shibboleth ServiceProvider instance.
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "AccessControl.h"
  26 #include "Application.h"
  27 #include "ServiceProvider.h"
  28 #include "SessionCache.h"
  29 #include "SPRequest.h"
  30 #include "attribute/Attribute.h"
  31 #include "handler/SessionInitiator.h"
  32 #include "util/TemplateParameters.h"
  33
  34 #include <fstream>
  35 #include <sstream>
  36 #include <xmltooling/XMLToolingConfig.h>
  37 #include <xmltooling/util/NDC.h>
  38 #include <xmltooling/util/URLEncoder.h>
  39 #include <xmltooling/util/XMLHelper.h>
  40
  41 using namespace shibsp;
  42 using namespace xmltooling;
  43 using namespace std;
  44
  45 namespace shibsp {
  46     SHIBSP_DLLLOCAL PluginManager<ServiceProvider,string,const DOMElement*>::Factory XMLServiceProviderFactory;
  47
  48     long SHIBSP_DLLLOCAL sendError(SPRequest& request, const Application* app, const char* page, TemplateParameters& tp, bool mayRedirect=false)
  49     {
  50         if (mayRedirect) {
  51             // Check for redirection on errors instead of template.
  52             pair<bool,const char*> redirectErrors = app ? app->getString("redirectErrors") : pair<bool,const char*>(false,NULL);
  53             if (redirectErrors.first) {
  54                 string loc(redirectErrors.second);
  55                 loc = loc + '?' + tp.toQueryString();
  56                 return request.sendRedirect(loc.c_str());
  57             }
  58         }
  59
  60         request.setContentType("text/html");
  61         request.setResponseHeader("Expires","01-Jan-1997 12:00:00 GMT");
  62         request.setResponseHeader("Cache-Control","private,no-store,no-cache");
  63
  64         // Error templates come from the request's settings or from the Errors property set.
  65         pair<bool,const char*> pathname = pair<bool,const char*>(false,NULL);
  66         try {
  67             RequestMapper::Settings settings = request.getRequestSettings();
  68             string pagename(page);
  69             pagename += "Error";
  70             pathname = settings.first->getString(pagename.c_str());
  71         }
  72         catch (exception& ex) {
  73             request.log(SPRequest::SPError, ex.what());
  74         }
  75
  76         // Nothing for request, so check app properties.
  77         const PropertySet* props=app ? app->getPropertySet("Errors") : NULL;
  78         if (!pathname.first && props)
  79             pathname=props->getString(page);
  80
  81         if (pathname.first) {
  82             ifstream infile(pathname.second);
  83             if (infile) {
  84                 tp.setPropertySet(props);
  85                 stringstream str;
  86                 XMLToolingConfig::getConfig().getTemplateEngine()->run(infile, str, tp, tp.getRichException());
  87                 return request.sendResponse(str);
  88             }
  89         }
  90
  91         if (!strcmp(page,"access")) {
  92             istringstream msg("Access Denied");
  93             return request.sendResponse(msg, HTTPResponse::XMLTOOLING_HTTP_STATUS_FORBIDDEN);
  94         }
  95
  96         string errstr = string("sendError could not process error template (") + page + ")";
  97         request.log(SPRequest::SPError, errstr);
  98         istringstream msg("Internal Server Error. Please contact the site administrator.");
  99         return request.sendError(msg);
 100     }
 101
 102     void SHIBSP_DLLLOCAL clearHeaders(SPRequest& request) {
 103         request.clearHeader("Shib-Session-ID", "HTTP_SHIB_SESSION_ID");
 104         request.clearHeader("Shib-Identity-Provider", "HTTP_SHIB_IDENTITY_PROVIDER");
 105         request.clearHeader("Shib-Authentication-Method", "HTTP_SHIB_AUTHENTICATION_METHOD");
 106         request.clearHeader("Shib-AuthnContext-Class", "HTTP_SHIB_AUTHNCONTEXT_CLASS");
 107         request.clearHeader("Shib-AuthnContext-Decl", "HTTP_SHIB_AUTHNCONTEXT_DECL");
 108         request.clearHeader("Shib-Assertion-Count", "HTTP_SHIB_ASSERTION_COUNT");
 109         request.clearHeader("REMOTE_USER", "HTTP_REMOTE_USER");
 110         //request.clearHeader("Shib-Application-ID");   handle inside app method
 111         request.getApplication().clearAttributeHeaders(request);
 112     }
 113 };
 114
 115 void SHIBSP_API shibsp::registerServiceProviders()
 116 {
 117     SPConfig::getConfig().ServiceProviderManager.registerFactory(XML_SERVICE_PROVIDER, XMLServiceProviderFactory);
 118 }
 119
 120 pair<bool,long> ServiceProvider::doAuthentication(SPRequest& request, bool handler) const
 121 {
 122 #ifdef _DEBUG
 123     xmltooling::NDC ndc("doAuthentication");
 124 #endif
 125
 126     const Application* app=NULL;
 127     string targetURL = request.getRequestURL();
 128
 129     try {
 130         RequestMapper::Settings settings = request.getRequestSettings();
 131         app = &(request.getApplication());
 132
 133         // If not SSL, check to see if we should block or redirect it.
 134         if (!request.isSecure()) {
 135             pair<bool,const char*> redirectToSSL = settings.first->getString("redirectToSSL");
 136             if (redirectToSSL.first) {
 137 #ifdef HAVE_STRCASECMP
 138                 if (!strcasecmp("GET",request.getMethod()) || !strcasecmp("HEAD",request.getMethod())) {
 139 #else
 140                 if (!stricmp("GET",request.getMethod()) || !stricmp("HEAD",request.getMethod())) {
 141 #endif
 142                     // Compute the new target URL
 143                     string redirectURL = string("https://") + request.getHostname();
 144                     if (strcmp(redirectToSSL.second,"443")) {
 145                         redirectURL = redirectURL + ':' + redirectToSSL.second;
 146                     }
 147                     redirectURL += request.getRequestURI();
 148                     return make_pair(true, request.sendRedirect(redirectURL.c_str()));
 149                 }
 150                 else {
 151                     TemplateParameters tp;
 152                     tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
 153                     return make_pair(true,sendError(request, app, "ssl", tp));
 154                 }
 155             }
 156         }
 157
 158         const char* handlerURL=request.getHandlerURL(targetURL.c_str());
 159         if (!handlerURL)
 160             throw ConfigurationException("Cannot determine handler from resource URL, check configuration.");
 161
 162         // If the request URL contains the handler base URL for this application, either dispatch
 163         // directly (mainly Apache 2.0) or just pass back control.
 164         if (strstr(targetURL.c_str(),handlerURL)) {
 165             if (handler)
 166                 return doHandler(request);
 167             else
 168                 return make_pair(true, request.returnOK());
 169         }
 170
 171         // Three settings dictate how to proceed.
 172         pair<bool,const char*> authType = settings.first->getString("authType");
 173         pair<bool,bool> requireSession = settings.first->getBool("requireSession");
 174         pair<bool,const char*> requireSessionWith = settings.first->getString("requireSessionWith");
 175
 176         // If no session is required AND the AuthType (an Apache-derived concept) isn't shibboleth,
 177         // then we ignore this request and consider it unprotected. Apache might lie to us if
 178         // ShibBasicHijack is on, but that's up to it.
 179         if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first &&
 180 #ifdef HAVE_STRCASECMP
 181                 (!authType.first || strcasecmp(authType.second,"shibboleth")))
 182 #else
 183                 (!authType.first || _stricmp(authType.second,"shibboleth")))
 184 #endif
 185             return make_pair(true,request.returnDecline());
 186
 187         // Fix for secadv 20050901
 188         clearHeaders(request);
 189
 190         Session* session = NULL;
 191         try {
 192             session = request.getSession();
 193         }
 194         catch (exception& e) {
 195             request.log(SPRequest::SPWarn, string("error during session lookup: ") + e.what());
 196             // If it's not a retryable session failure, we throw to the outer handler for reporting.
 197             if (dynamic_cast<opensaml::RetryableProfileException*>(&e)==NULL)
 198                 throw;
 199         }
 200
 201         if (!session) {
 202             // No session.  Maybe that's acceptable?
 203             if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first)
 204                 return make_pair(true,request.returnOK());
 205
 206             // No session, but we require one. Initiate a new session using the indicated method.
 207             const Handler* initiator=NULL;
 208             if (requireSessionWith.first) {
 209                 initiator=app->getSessionInitiatorById(requireSessionWith.second);
 210                 if (!initiator)
 211                     throw ConfigurationException(
 212                         "No session initiator found with id ($1), check requireSessionWith command.",
 213                         params(1,requireSessionWith.second)
 214                         );
 215             }
 216             else {
 217                 initiator=app->getDefaultSessionInitiator();
 218                 if (!initiator)
 219                     throw ConfigurationException("No default session initiator found, check configuration.");
 220             }
 221
 222             return initiator->run(request,false);
 223         }
 224
 225         // We're done.  Everything is okay.  Nothing to report.  Nothing to do..
 226         // Let the caller decide how to proceed.
 227         request.log(SPRequest::SPDebug, "doAuthentication succeeded");
 228         return make_pair(false,0);
 229     }
 230     catch (exception& e) {
 231         TemplateParameters tp(&e);
 232         tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
 233         return make_pair(true,sendError(request, app, "session", tp));
 234     }
 235 }
 236
 237 pair<bool,long> ServiceProvider::doAuthorization(SPRequest& request) const
 238 {
 239 #ifdef _DEBUG
 240     xmltooling::NDC ndc("doAuthorization");
 241 #endif
 242
 243     const Application* app=NULL;
 244     string targetURL = request.getRequestURL();
 245
 246     try {
 247         RequestMapper::Settings settings = request.getRequestSettings();
 248         app = &(request.getApplication());
 249
 250         // Three settings dictate how to proceed.
 251         pair<bool,const char*> authType = settings.first->getString("authType");
 252         pair<bool,bool> requireSession = settings.first->getBool("requireSession");
 253         pair<bool,const char*> requireSessionWith = settings.first->getString("requireSessionWith");
 254
 255         // If no session is required AND the AuthType (an Apache-derived concept) isn't shibboleth,
 256         // then we ignore this request and consider it unprotected. Apache might lie to us if
 257         // ShibBasicHijack is on, but that's up to it.
 258         if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first &&
 259 #ifdef HAVE_STRCASECMP
 260                 (!authType.first || strcasecmp(authType.second,"shibboleth")))
 261 #else
 262                 (!authType.first || _stricmp(authType.second,"shibboleth")))
 263 #endif
 264             return make_pair(true,request.returnDecline());
 265
 266         // Do we have an access control plugin?
 267         if (settings.second) {
 268             const Session* session = NULL;
 269             try {
 270                 session = request.getSession(false);
 271             }
 272             catch (exception& e) {
 273                 request.log(SPRequest::SPWarn, string("unable to obtain session to pass to access control provider: ") + e.what());
 274             }
 275
 276             Locker acllock(settings.second);
 277             switch (settings.second->authorized(request,session)) {
 278                 case AccessControl::shib_acl_true:
 279                     request.log(SPRequest::SPDebug, "access control provider granted access");
 280                     return make_pair(true,request.returnOK());
 281
 282                 case AccessControl::shib_acl_false:
 283                 {
 284                     request.log(SPRequest::SPWarn, "access control provider denied access");
 285                     TemplateParameters tp;
 286                     tp.m_map["requestURL"] = targetURL;
 287                     return make_pair(true,sendError(request, app, "access", tp));
 288                 }
 289
 290                 default:
 291                     // Use the "DECLINE" interface to signal we don't know what to do.
 292                     return make_pair(true,request.returnDecline());
 293             }
 294         }
 295         else {
 296             return make_pair(true,request.returnDecline());
 297         }
 298     }
 299     catch (exception& e) {
 300         TemplateParameters tp(&e);
 301         tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
 302         return make_pair(true,sendError(request, app, "access", tp));
 303     }
 304 }
 305
 306 pair<bool,long> ServiceProvider::doExport(SPRequest& request, bool requireSession) const
 307 {
 308 #ifdef _DEBUG
 309     xmltooling::NDC ndc("doExport");
 310 #endif
 311
 312     const Application* app=NULL;
 313     string targetURL = request.getRequestURL();
 314
 315     try {
 316         RequestMapper::Settings settings = request.getRequestSettings();
 317         app = &(request.getApplication());
 318
 319         const Session* session = NULL;
 320         try {
 321             session = request.getSession(false);
 322         }
 323         catch (exception& e) {
 324             request.log(SPRequest::SPWarn, string("unable to obtain session to export to request: ") +  e.what());
 325                 // If we have to have a session, then this is a fatal error.
 326                 if (requireSession)
 327                         throw;
 328         }
 329
 330                 // Still no data?
 331         if (!session) {
 332                 if (requireSession)
 333                 throw opensaml::RetryableProfileException("Unable to obtain session to export to request.");
 334                 else
 335                         return make_pair(false,0);      // just bail silently
 336         }
 337
 338         request.setHeader("Shib-Application-ID", app->getId());
 339         request.setHeader("Shib-Session-ID", session->getID());
 340
 341         // Export the IdP name and Authn method/context info.
 342         const char* hval = session->getEntityID();
 343         if (hval)
 344             request.setHeader("Shib-Identity-Provider", hval);
 345         hval = session->getAuthnContextClassRef();
 346         if (hval) {
 347             request.setHeader("Shib-Authentication-Method", hval);
 348             request.setHeader("Shib-AuthnContext-Class", hval);
 349         }
 350         hval = session->getAuthnContextDeclRef();
 351         if (hval)
 352             request.setHeader("Shib-AuthnContext-Decl", hval);
 353
 354         // Maybe export the assertion keys.
 355         pair<bool,bool> exp=settings.first->getBool("exportAssertion");
 356         if (exp.first && exp.second) {
 357             const PropertySet* sessions=app->getPropertySet("Sessions");
 358             pair<bool,const char*> exportLocation = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,NULL);
 359             if (!exportLocation.first)
 360                 request.log(SPRequest::SPWarn, "can't export assertions without an exportLocation Sessions property");
 361             else {
 362                 const URLEncoder* encoder = XMLToolingConfig::getConfig().getURLEncoder();
 363                 string exportName = "Shib-Assertion-00";
 364                 string baseURL;
 365                 if (!strncmp(exportLocation.second, "http", 4))
 366                     baseURL = exportLocation.second;
 367                 else
 368                     baseURL = string(request.getHandlerURL(targetURL.c_str())) + exportLocation.second;
 369                 baseURL = baseURL + "?key=" + session->getID() + "&ID=";
 370                 const vector<const char*>& tokens = session->getAssertionIDs();
 371                 vector<const char*>::size_type count = 0;
 372                 for (vector<const char*>::const_iterator tokenids = tokens.begin(); tokenids!=tokens.end(); ++tokenids) {
 373                     count++;
 374                     *(exportName.rbegin()) = '0' + (count%10);
 375                     *(++exportName.rbegin()) = '0' + (count/10);
 376                     string fullURL = baseURL + encoder->encode(*tokenids);
 377                     request.setHeader(exportName.c_str(), fullURL.c_str());
 378                 }
 379                 request.setHeader("Shib-Assertion-Count", exportName.c_str() + 15);
 380             }
 381         }
 382
 383         // Export the attributes.
 384         bool remoteUserSet = false;
 385         const multimap<string,const Attribute*>& attributes = session->getIndexedAttributes();
 386         for (multimap<string,const Attribute*>::const_iterator a = attributes.begin(); a!=attributes.end(); ++a) {
 387             const vector<string>& vals = a->second->getSerializedValues();
 388
 389             // See if this needs to be set as the REMOTE_USER value.
 390             if (!remoteUserSet && !vals.empty() && app->getRemoteUserAttributeIds().count(a->first)) {
 391                 request.setRemoteUser(vals.front().c_str());
 392                 remoteUserSet = true;
 393             }
 394
 395             // Handle the normal export case.
 396             string header(request.getSecureHeader(a->first.c_str()));
 397             for (vector<string>::const_iterator v = vals.begin(); v!=vals.end(); ++v) {
 398                 if (!header.empty())
 399                     header += ";";
 400                 string::size_type pos = v->find_first_of(';',string::size_type(0));
 401                 if (pos!=string::npos) {
 402                     string value(*v);
 403                     for (; pos != string::npos; pos = value.find_first_of(';',pos)) {
 404                         value.insert(pos, "\\");
 405                         pos += 2;
 406                     }
 407                     header += value;
 408                 }
 409                 else {
 410                     header += (*v);
 411                 }
 412             }
 413             request.setHeader(a->first.c_str(), header.c_str());
 414         }
 415
 416         return make_pair(false,0);
 417     }
 418     catch (exception& e) {
 419         TemplateParameters tp(&e);
 420         tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
 421         return make_pair(true,sendError(request, app, "session", tp));
 422     }
 423 }
 424
 425 pair<bool,long> ServiceProvider::doHandler(SPRequest& request) const
 426 {
 427 #ifdef _DEBUG
 428     xmltooling::NDC ndc("doHandler");
 429 #endif
 430
 431     const Application* app=NULL;
 432     string targetURL = request.getRequestURL();
 433
 434     try {
 435         RequestMapper::Settings settings = request.getRequestSettings();
 436         app = &(request.getApplication());
 437
 438         const char* handlerURL=request.getHandlerURL(targetURL.c_str());
 439         if (!handlerURL)
 440             throw ConfigurationException("Cannot determine handler from resource URL, check configuration.");
 441
 442         // Make sure we only process handler requests.
 443         if (!strstr(targetURL.c_str(),handlerURL))
 444             return make_pair(true, request.returnDecline());
 445
 446         const PropertySet* sessionProps=app->getPropertySet("Sessions");
 447         if (!sessionProps)
 448             throw ConfigurationException("Unable to map request to application session settings, check configuration.");
 449
 450         // Process incoming request.
 451         pair<bool,bool> handlerSSL=sessionProps->getBool("handlerSSL");
 452
 453         // Make sure this is SSL, if it should be
 454         if ((!handlerSSL.first || handlerSSL.second) && !request.isSecure())
 455             throw opensaml::FatalProfileException("Blocked non-SSL access to Shibboleth handler.");
 456
 457         // We dispatch based on our path info. We know the request URL begins with or equals the handler URL,
 458         // so the path info is the next character (or null).
 459         const Handler* handler=app->getHandler(targetURL.c_str() + strlen(handlerURL));
 460         if (!handler)
 461             throw ConfigurationException("Shibboleth handler invoked at an unconfigured location.");
 462
 463         pair<bool,long> hret=handler->run(request);
 464
 465         // Did the handler run successfully?
 466         if (hret.first)
 467             return hret;
 468
 469         throw ConfigurationException("Configured Shibboleth handler failed to process the request.");
 470     }
 471     catch (opensaml::saml2md::MetadataException& e) {
 472         TemplateParameters tp(&e);
 473         tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
 474         // See if a metadata error page is installed.
 475         const PropertySet* props=app ? app->getPropertySet("Errors") : NULL;
 476         if (props) {
 477             pair<bool,const char*> p=props->getString("metadata");
 478             if (p.first)
 479                 return make_pair(true,sendError(request, app, "metadata", tp, true));
 480         }
 481         return make_pair(true,sendError(request, app, "session", tp, true));
 482     }
 483     catch (exception& e) {
 484         TemplateParameters tp(&e);
 485         tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
 486         return make_pair(true,sendError(request, app, "session", tp, true));
 487     }
 488 }