2 * Copyright 2001-2010 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 * Interface to a Shibboleth ServiceProvider instance.
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"
37 # include <saml/exceptions.h>
38 # include <saml/saml2/metadata/MetadataProvider.h>
40 #include <xmltooling/XMLToolingConfig.h>
41 #include <xmltooling/util/NDC.h>
42 #include <xmltooling/util/PathResolver.h>
43 #include <xmltooling/util/URLEncoder.h>
44 #include <xmltooling/util/XMLHelper.h>
46 using namespace shibsp;
47 using namespace xmltooling::logging;
48 using namespace xmltooling;
52 SHIBSP_DLLLOCAL PluginManager<ServiceProvider,string,const DOMElement*>::Factory XMLServiceProviderFactory;
54 long SHIBSP_DLLLOCAL sendError(
55 Category& log, SPRequest& request, const Application* app, const char* page, TemplateParameters& tp, bool mayRedirect=true
58 // The properties we need can be set in the RequestMap, or the Errors element.
59 bool mderror = dynamic_cast<const opensaml::saml2md::MetadataException*>(tp.getRichException())!=nullptr;
60 bool accesserror = (strcmp(page, "access")==0);
61 pair<bool,const char*> redirectErrors = pair<bool,const char*>(false,nullptr);
62 pair<bool,const char*> pathname = pair<bool,const char*>(false,nullptr);
64 // Strictly for error handling, detect a nullptr application and point at the default.
66 app = request.getServiceProvider().getApplication("default");
68 const PropertySet* props=app->getPropertySet("Errors");
70 // First look for settings in the request map of the form pageError.
72 RequestMapper::Settings settings = request.getRequestSettings();
74 pathname = settings.first->getString("metadataError");
75 if (!pathname.first) {
76 string pagename(page);
78 pathname = settings.first->getString(pagename.c_str());
81 redirectErrors = settings.first->getString("redirectErrors");
83 catch (exception& ex) {
87 // Check for redirection on errors instead of template.
89 if (!redirectErrors.first && props)
90 redirectErrors = props->getString("redirectErrors");
91 if (redirectErrors.first) {
92 string loc(redirectErrors.second);
93 loc = loc + '?' + tp.toQueryString();
94 return request.sendRedirect(loc.c_str());
98 request.setContentType("text/html");
99 request.setResponseHeader("Expires","01-Jan-1997 12:00:00 GMT");
100 request.setResponseHeader("Cache-Control","private,no-store,no-cache");
102 // Nothing in the request map, so check for a property named "page" in the Errors property set.
103 if (!pathname.first && props) {
105 pathname=props->getString("metadata");
107 pathname=props->getString(page);
110 // If there's still no template to use, just use pageError.html unless it's an access issue.
112 if (!pathname.first) {
114 fname = string(page) + "Error.html";
115 pathname.second = fname.c_str();
119 fname = pathname.second;
122 // If we have a template to use, use it.
123 if (!fname.empty()) {
124 ifstream infile(XMLToolingConfig::getConfig().getPathResolver()->resolve(fname, PathResolver::XMLTOOLING_CFG_FILE).c_str());
126 tp.setPropertySet(props);
128 XMLToolingConfig::getConfig().getTemplateEngine()->run(infile, str, tp, tp.getRichException());
129 return request.sendError(str);
133 // If we got here, then either it's an access error or a template failed.
135 istringstream msg("Access Denied");
136 return request.sendResponse(msg, HTTPResponse::XMLTOOLING_HTTP_STATUS_FORBIDDEN);
139 log.error("sendError could not process error template (%s)", pathname.second);
140 istringstream msg("Internal Server Error. Please contact the site administrator.");
141 return request.sendError(msg);
144 void SHIBSP_DLLLOCAL clearHeaders(SPRequest& request) {
145 const Application& app = request.getApplication();
146 app.clearHeader(request, "Shib-Session-ID", "HTTP_SHIB_SESSION_ID");
147 app.clearHeader(request, "Shib-Identity-Provider", "HTTP_SHIB_IDENTITY_PROVIDER");
148 app.clearHeader(request, "Shib-Authentication-Method", "HTTP_SHIB_AUTHENTICATION_METHOD");
149 app.clearHeader(request, "Shib-Authentication-Instant", "HTTP_SHIB_AUTHENTICATION_INSTANT");
150 app.clearHeader(request, "Shib-AuthnContext-Class", "HTTP_SHIB_AUTHNCONTEXT_CLASS");
151 app.clearHeader(request, "Shib-AuthnContext-Decl", "HTTP_SHIB_AUTHNCONTEXT_DECL");
152 app.clearHeader(request, "Shib-Assertion-Count", "HTTP_SHIB_ASSERTION_COUNT");
153 app.clearAttributeHeaders(request);
154 request.clearHeader("REMOTE_USER", "HTTP_REMOTE_USER");
158 void SHIBSP_API shibsp::registerServiceProviders()
160 SPConfig::getConfig().ServiceProviderManager.registerFactory(XML_SERVICE_PROVIDER, XMLServiceProviderFactory);
163 ServiceProvider::ServiceProvider()
167 ServiceProvider::~ServiceProvider()
171 pair<bool,long> ServiceProvider::doAuthentication(SPRequest& request, bool handler) const
174 xmltooling::NDC ndc("doAuthentication");
176 Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
178 const Application* app=nullptr;
179 string targetURL = request.getRequestURL();
182 RequestMapper::Settings settings = request.getRequestSettings();
183 app = &(request.getApplication());
185 // If not SSL, check to see if we should block or redirect it.
186 if (!request.isSecure()) {
187 pair<bool,const char*> redirectToSSL = settings.first->getString("redirectToSSL");
188 if (redirectToSSL.first) {
189 #ifdef HAVE_STRCASECMP
190 if (!strcasecmp("GET",request.getMethod()) || !strcasecmp("HEAD",request.getMethod())) {
192 if (!stricmp("GET",request.getMethod()) || !stricmp("HEAD",request.getMethod())) {
194 // Compute the new target URL
195 string redirectURL = string("https://") + request.getHostname();
196 if (strcmp(redirectToSSL.second,"443")) {
197 redirectURL = redirectURL + ':' + redirectToSSL.second;
199 redirectURL += request.getRequestURI();
200 return make_pair(true, request.sendRedirect(redirectURL.c_str()));
203 TemplateParameters tp;
204 tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
205 return make_pair(true,sendError(log, request, app, "ssl", tp, false));
210 const char* handlerURL=request.getHandlerURL(targetURL.c_str());
212 throw ConfigurationException("Cannot determine handler from resource URL, check configuration.");
214 // If the request URL contains the handler base URL for this application, either dispatch
215 // directly (mainly Apache 2.0) or just pass back control.
216 if (strstr(targetURL.c_str(),handlerURL)) {
218 return doHandler(request);
220 return make_pair(true, request.returnOK());
223 // Three settings dictate how to proceed.
224 pair<bool,const char*> authType = settings.first->getString("authType");
225 pair<bool,bool> requireSession = settings.first->getBool("requireSession");
226 pair<bool,const char*> requireSessionWith = settings.first->getString("requireSessionWith");
228 // If no session is required AND the AuthType (an Apache-derived concept) isn't shibboleth,
229 // then we ignore this request and consider it unprotected. Apache might lie to us if
230 // ShibBasicHijack is on, but that's up to it.
231 if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first &&
232 #ifdef HAVE_STRCASECMP
233 (!authType.first || strcasecmp(authType.second,"shibboleth")))
235 (!authType.first || _stricmp(authType.second,"shibboleth")))
237 return make_pair(true,request.returnDecline());
239 // Fix for secadv 20050901
240 clearHeaders(request);
242 Session* session = nullptr;
244 session = request.getSession();
246 catch (exception& e) {
247 log.warn("error during session lookup: %s", e.what());
248 // If it's not a retryable session failure, we throw to the outer handler for reporting.
249 if (dynamic_cast<opensaml::RetryableProfileException*>(&e)==nullptr)
254 // No session. Maybe that's acceptable?
255 if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first)
256 return make_pair(true,request.returnOK());
258 // No session, but we require one. Initiate a new session using the indicated method.
259 const SessionInitiator* initiator=nullptr;
260 if (requireSessionWith.first) {
261 initiator=app->getSessionInitiatorById(requireSessionWith.second);
263 throw ConfigurationException(
264 "No session initiator found with id ($1), check requireSessionWith command.", params(1,requireSessionWith.second)
269 initiator=app->getDefaultSessionInitiator();
271 throw ConfigurationException("No default session initiator found, check configuration.");
274 return initiator->run(request,false);
277 request.setAuthType("shibboleth");
279 // We're done. Everything is okay. Nothing to report. Nothing to do..
280 // Let the caller decide how to proceed.
281 log.debug("doAuthentication succeeded");
282 return make_pair(false,0L);
284 catch (exception& e) {
285 request.log(SPRequest::SPError, e.what());
286 TemplateParameters tp(&e);
287 tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
288 return make_pair(true,sendError(log, request, app, "session", tp));
292 pair<bool,long> ServiceProvider::doAuthorization(SPRequest& request) const
295 xmltooling::NDC ndc("doAuthorization");
297 Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
299 const Application* app=nullptr;
300 string targetURL = request.getRequestURL();
303 RequestMapper::Settings settings = request.getRequestSettings();
304 app = &(request.getApplication());
306 // Three settings dictate how to proceed.
307 pair<bool,const char*> authType = settings.first->getString("authType");
308 pair<bool,bool> requireSession = settings.first->getBool("requireSession");
309 pair<bool,const char*> requireSessionWith = settings.first->getString("requireSessionWith");
311 // If no session is required AND the AuthType (an Apache-derived concept) isn't shibboleth,
312 // then we ignore this request and consider it unprotected. Apache might lie to us if
313 // ShibBasicHijack is on, but that's up to it.
314 if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first &&
315 #ifdef HAVE_STRCASECMP
316 (!authType.first || strcasecmp(authType.second,"shibboleth")))
318 (!authType.first || _stricmp(authType.second,"shibboleth")))
320 return make_pair(true,request.returnDecline());
322 // Do we have an access control plugin?
323 if (settings.second) {
324 const Session* session = nullptr;
326 session = request.getSession(false);
328 catch (exception& e) {
329 log.warn("unable to obtain session to pass to access control provider: %s", e.what());
332 Locker acllock(settings.second);
333 switch (settings.second->authorized(request,session)) {
334 case AccessControl::shib_acl_true:
335 log.debug("access control provider granted access");
336 return make_pair(true,request.returnOK());
338 case AccessControl::shib_acl_false:
340 log.warn("access control provider denied access");
341 TemplateParameters tp;
342 tp.m_map["requestURL"] = targetURL;
343 return make_pair(true,sendError(log, request, app, "access", tp, false));
347 // Use the "DECLINE" interface to signal we don't know what to do.
348 return make_pair(true,request.returnDecline());
352 return make_pair(true,request.returnDecline());
355 catch (exception& e) {
356 request.log(SPRequest::SPError, e.what());
357 TemplateParameters tp(&e);
358 tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
359 return make_pair(true,sendError(log, request, app, "access", tp));
363 pair<bool,long> ServiceProvider::doExport(SPRequest& request, bool requireSession) const
366 xmltooling::NDC ndc("doExport");
368 Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
370 const Application* app=nullptr;
371 string targetURL = request.getRequestURL();
374 RequestMapper::Settings settings = request.getRequestSettings();
375 app = &(request.getApplication());
377 const Session* session = nullptr;
379 session = request.getSession(false);
381 catch (exception& e) {
382 log.warn("unable to obtain session to export to request: %s", e.what());
383 // If we have to have a session, then this is a fatal error.
391 throw opensaml::RetryableProfileException("Unable to obtain session to export to request.");
393 return make_pair(false,0L); // just bail silently
396 app->setHeader(request, "Shib-Application-ID", app->getId());
397 app->setHeader(request, "Shib-Session-ID", session->getID());
399 // Export the IdP name and Authn method/context info.
400 const char* hval = session->getEntityID();
402 app->setHeader(request, "Shib-Identity-Provider", hval);
403 hval = session->getAuthnInstant();
405 app->setHeader(request, "Shib-Authentication-Instant", hval);
406 hval = session->getAuthnContextClassRef();
408 app->setHeader(request, "Shib-Authentication-Method", hval);
409 app->setHeader(request, "Shib-AuthnContext-Class", hval);
411 hval = session->getAuthnContextDeclRef();
413 app->setHeader(request, "Shib-AuthnContext-Decl", hval);
415 // Maybe export the assertion keys.
416 pair<bool,bool> exp=settings.first->getBool("exportAssertion");
417 if (exp.first && exp.second) {
418 const PropertySet* sessions=app->getPropertySet("Sessions");
419 pair<bool,const char*> exportLocation = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,nullptr);
420 if (!exportLocation.first)
421 log.warn("can't export assertions without an exportLocation Sessions property");
423 const URLEncoder* encoder = XMLToolingConfig::getConfig().getURLEncoder();
424 string exportName = "Shib-Assertion-00";
426 if (!strncmp(exportLocation.second, "http", 4))
427 baseURL = exportLocation.second;
429 baseURL = string(request.getHandlerURL(targetURL.c_str())) + exportLocation.second;
430 baseURL = baseURL + "?key=" + session->getID() + "&ID=";
431 const vector<const char*>& tokens = session->getAssertionIDs();
432 vector<const char*>::size_type count = 0;
433 for (vector<const char*>::const_iterator tokenids = tokens.begin(); tokenids!=tokens.end(); ++tokenids) {
435 *(exportName.rbegin()) = '0' + (count%10);
436 *(++exportName.rbegin()) = '0' + (count/10);
437 string fullURL = baseURL + encoder->encode(*tokenids);
438 app->setHeader(request, exportName.c_str(), fullURL.c_str());
440 app->setHeader(request, "Shib-Assertion-Count", exportName.c_str() + 15);
444 // Export the attributes.
445 const multimap<string,const Attribute*>& attributes = session->getIndexedAttributes();
446 for (multimap<string,const Attribute*>::const_iterator a = attributes.begin(); a!=attributes.end(); ++a) {
447 if (a->second->isInternal())
449 string header(app->getSecureHeader(request, a->first.c_str()));
450 const vector<string>& vals = a->second->getSerializedValues();
451 for (vector<string>::const_iterator v = vals.begin(); v!=vals.end(); ++v) {
454 string::size_type pos = v->find_first_of(';',string::size_type(0));
455 if (pos!=string::npos) {
457 for (; pos != string::npos; pos = value.find_first_of(';',pos)) {
458 value.insert(pos, "\\");
467 app->setHeader(request, a->first.c_str(), header.c_str());
470 // Check for REMOTE_USER.
471 bool remoteUserSet = false;
472 const vector<string>& rmids = app->getRemoteUserAttributeIds();
473 for (vector<string>::const_iterator rmid = rmids.begin(); !remoteUserSet && rmid != rmids.end(); ++rmid) {
474 pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> matches =
475 attributes.equal_range(*rmid);
476 for (; matches.first != matches.second; ++matches.first) {
477 const vector<string>& vals = matches.first->second->getSerializedValues();
479 request.setRemoteUser(vals.front().c_str());
480 remoteUserSet = true;
486 return make_pair(false,0L);
488 catch (exception& e) {
489 request.log(SPRequest::SPError, e.what());
490 TemplateParameters tp(&e);
491 tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
492 return make_pair(true,sendError(log, request, app, "session", tp));
496 pair<bool,long> ServiceProvider::doHandler(SPRequest& request) const
499 xmltooling::NDC ndc("doHandler");
501 Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
503 const Application* app=nullptr;
504 string targetURL = request.getRequestURL();
507 RequestMapper::Settings settings = request.getRequestSettings();
508 app = &(request.getApplication());
510 // If not SSL, check to see if we should block or redirect it.
511 if (!request.isSecure()) {
512 pair<bool,const char*> redirectToSSL = settings.first->getString("redirectToSSL");
513 if (redirectToSSL.first) {
514 #ifdef HAVE_STRCASECMP
515 if (!strcasecmp("GET",request.getMethod()) || !strcasecmp("HEAD",request.getMethod())) {
517 if (!stricmp("GET",request.getMethod()) || !stricmp("HEAD",request.getMethod())) {
519 // Compute the new target URL
520 string redirectURL = string("https://") + request.getHostname();
521 if (strcmp(redirectToSSL.second,"443")) {
522 redirectURL = redirectURL + ':' + redirectToSSL.second;
524 redirectURL += request.getRequestURI();
525 return make_pair(true, request.sendRedirect(redirectURL.c_str()));
528 TemplateParameters tp;
529 tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
530 return make_pair(true,sendError(log, request, app, "ssl", tp, false));
535 const char* handlerURL=request.getHandlerURL(targetURL.c_str());
537 throw ConfigurationException("Cannot determine handler from resource URL, check configuration.");
539 // Make sure we only process handler requests.
540 if (!strstr(targetURL.c_str(),handlerURL))
541 return make_pair(true, request.returnDecline());
543 const PropertySet* sessionProps=app->getPropertySet("Sessions");
545 throw ConfigurationException("Unable to map request to application session settings, check configuration.");
547 // Process incoming request.
548 pair<bool,bool> handlerSSL=sessionProps->getBool("handlerSSL");
550 // Make sure this is SSL, if it should be
551 if ((!handlerSSL.first || handlerSSL.second) && !request.isSecure())
552 throw opensaml::FatalProfileException("Blocked non-SSL access to Shibboleth handler.");
554 // We dispatch based on our path info. We know the request URL begins with or equals the handler URL,
555 // so the path info is the next character (or null).
556 const Handler* handler=app->getHandler(targetURL.c_str() + strlen(handlerURL));
558 throw ConfigurationException("Shibboleth handler invoked at an unconfigured location.");
560 pair<bool,long> hret=handler->run(request);
562 // Did the handler run successfully?
566 throw ConfigurationException("Configured Shibboleth handler failed to process the request.");
568 catch (exception& e) {
569 request.log(SPRequest::SPError, e.what());
570 TemplateParameters tp(&e);
571 tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
572 tp.m_request = &request;
573 return make_pair(true,sendError(log, request, app, "session", tp));