/*
- * Copyright 2001-2006 Internet2
+ * Copyright 2001-2007 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*/
#include "internal.h"
+#include "exceptions.h"
+#include "AccessControl.h"
+#include "Application.h"
#include "ServiceProvider.h"
+#include "SessionCache.h"
+#include "SPRequest.h"
+#include "attribute/Attribute.h"
+#include "handler/SessionInitiator.h"
+#include "util/TemplateParameters.h"
-#include <xercesc/dom/DOM.hpp>
+#include <fstream>
+#include <sstream>
+#include <xmltooling/XMLToolingConfig.h>
+#include <xmltooling/util/NDC.h>
+#include <xmltooling/util/PathResolver.h>
+#include <xmltooling/util/URLEncoder.h>
+#include <xmltooling/util/XMLHelper.h>
using namespace shibsp;
+using namespace xmltooling::logging;
using namespace xmltooling;
-using namespace xercesc;
using namespace std;
namespace shibsp {
- //SHIBSP_DLLLOCAL PluginManager<ServiceProvider,const DOMElement*>::Factory XMLServiceProviderFactory;
+ SHIBSP_DLLLOCAL PluginManager<ServiceProvider,string,const DOMElement*>::Factory XMLServiceProviderFactory;
+
+ long SHIBSP_DLLLOCAL sendError(
+ Category& log, SPRequest& request, const Application* app, const char* page, TemplateParameters& tp, bool mayRedirect=true
+ )
+ {
+ // The properties we need can be set in the RequestMap, or the Errors element.
+ bool mderror = dynamic_cast<const opensaml::saml2md::MetadataException*>(tp.getRichException())!=NULL;
+ pair<bool,const char*> redirectErrors = pair<bool,const char*>(false,NULL);
+ pair<bool,const char*> pathname = pair<bool,const char*>(false,NULL);
+ const PropertySet* props=app ? app->getPropertySet("Errors") : NULL;
+
+ try {
+ RequestMapper::Settings settings = request.getRequestSettings();
+ if (mderror)
+ pathname = settings.first->getString("metadataError");
+ if (!pathname.first) {
+ string pagename(page);
+ pagename += "Error";
+ pathname = settings.first->getString(pagename.c_str());
+ }
+ if (mayRedirect)
+ redirectErrors = settings.first->getString("redirectErrors");
+ }
+ catch (exception& ex) {
+ log.error(ex.what());
+ }
+
+ if (mayRedirect) {
+ // Check for redirection on errors instead of template.
+ if (!redirectErrors.first && props)
+ redirectErrors = props->getString("redirectErrors");
+ if (redirectErrors.first) {
+ string loc(redirectErrors.second);
+ loc = loc + '?' + tp.toQueryString();
+ return request.sendRedirect(loc.c_str());
+ }
+ }
+
+ request.setContentType("text/html");
+ request.setResponseHeader("Expires","01-Jan-1997 12:00:00 GMT");
+ request.setResponseHeader("Cache-Control","private,no-store,no-cache");
+
+ if (!pathname.first && props) {
+ if (mderror)
+ pathname=props->getString("metadata");
+ if (!pathname.first)
+ pathname=props->getString(page);
+ }
+ if (pathname.first) {
+ string fname(pathname.second);
+ ifstream infile(XMLToolingConfig::getConfig().getPathResolver()->resolve(fname, PathResolver::XMLTOOLING_CFG_FILE).c_str());
+ if (infile) {
+ tp.setPropertySet(props);
+ stringstream str;
+ XMLToolingConfig::getConfig().getTemplateEngine()->run(infile, str, tp, tp.getRichException());
+ return request.sendResponse(str);
+ }
+ }
+
+ if (!strcmp(page,"access")) {
+ istringstream msg("Access Denied");
+ return request.sendResponse(msg, HTTPResponse::XMLTOOLING_HTTP_STATUS_UNAUTHORIZED);
+ }
+
+ log.error("sendError could not process error template (%s)", page);
+ istringstream msg("Internal Server Error. Please contact the site administrator.");
+ return request.sendError(msg);
+ }
+
+ void SHIBSP_DLLLOCAL clearHeaders(SPRequest& request) {
+ request.clearHeader("Shib-Session-ID", "HTTP_SHIB_SESSION_ID");
+ request.clearHeader("Shib-Identity-Provider", "HTTP_SHIB_IDENTITY_PROVIDER");
+ request.clearHeader("Shib-Authentication-Method", "HTTP_SHIB_AUTHENTICATION_METHOD");
+ request.clearHeader("Shib-Authentication-Instant", "HTTP_SHIB_AUTHENTICATION_INSTANT");
+ request.clearHeader("Shib-AuthnContext-Class", "HTTP_SHIB_AUTHNCONTEXT_CLASS");
+ request.clearHeader("Shib-AuthnContext-Decl", "HTTP_SHIB_AUTHNCONTEXT_DECL");
+ request.clearHeader("Shib-Assertion-Count", "HTTP_SHIB_ASSERTION_COUNT");
+ request.clearHeader("REMOTE_USER", "HTTP_REMOTE_USER");
+ //request.clearHeader("Shib-Application-ID"); handle inside app method
+ request.getApplication().clearAttributeHeaders(request);
+ }
};
void SHIBSP_API shibsp::registerServiceProviders()
{
- //SPConfig::getConfig().ServiceProviderManager.registerFactory(XML_SERVICE_PROVIDER, XMLServiceProviderFactory);
+ SPConfig::getConfig().ServiceProviderManager.registerFactory(XML_SERVICE_PROVIDER, XMLServiceProviderFactory);
+}
+
+pair<bool,long> ServiceProvider::doAuthentication(SPRequest& request, bool handler) const
+{
+#ifdef _DEBUG
+ xmltooling::NDC ndc("doAuthentication");
+#endif
+ Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
+
+ const Application* app=NULL;
+ string targetURL = request.getRequestURL();
+
+ try {
+ RequestMapper::Settings settings = request.getRequestSettings();
+ app = &(request.getApplication());
+
+ // If not SSL, check to see if we should block or redirect it.
+ if (!request.isSecure()) {
+ pair<bool,const char*> redirectToSSL = settings.first->getString("redirectToSSL");
+ if (redirectToSSL.first) {
+#ifdef HAVE_STRCASECMP
+ if (!strcasecmp("GET",request.getMethod()) || !strcasecmp("HEAD",request.getMethod())) {
+#else
+ if (!stricmp("GET",request.getMethod()) || !stricmp("HEAD",request.getMethod())) {
+#endif
+ // Compute the new target URL
+ string redirectURL = string("https://") + request.getHostname();
+ if (strcmp(redirectToSSL.second,"443")) {
+ redirectURL = redirectURL + ':' + redirectToSSL.second;
+ }
+ redirectURL += request.getRequestURI();
+ return make_pair(true, request.sendRedirect(redirectURL.c_str()));
+ }
+ else {
+ TemplateParameters tp;
+ tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
+ return make_pair(true,sendError(log, request, app, "ssl", tp, false));
+ }
+ }
+ }
+
+ const char* handlerURL=request.getHandlerURL(targetURL.c_str());
+ if (!handlerURL)
+ throw ConfigurationException("Cannot determine handler from resource URL, check configuration.");
+
+ // If the request URL contains the handler base URL for this application, either dispatch
+ // directly (mainly Apache 2.0) or just pass back control.
+ if (strstr(targetURL.c_str(),handlerURL)) {
+ if (handler)
+ return doHandler(request);
+ else
+ return make_pair(true, request.returnOK());
+ }
+
+ // Three settings dictate how to proceed.
+ pair<bool,const char*> authType = settings.first->getString("authType");
+ pair<bool,bool> requireSession = settings.first->getBool("requireSession");
+ pair<bool,const char*> requireSessionWith = settings.first->getString("requireSessionWith");
+
+ // If no session is required AND the AuthType (an Apache-derived concept) isn't shibboleth,
+ // then we ignore this request and consider it unprotected. Apache might lie to us if
+ // ShibBasicHijack is on, but that's up to it.
+ if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first &&
+#ifdef HAVE_STRCASECMP
+ (!authType.first || strcasecmp(authType.second,"shibboleth")))
+#else
+ (!authType.first || _stricmp(authType.second,"shibboleth")))
+#endif
+ return make_pair(true,request.returnDecline());
+
+ // Fix for secadv 20050901
+ clearHeaders(request);
+
+ Session* session = NULL;
+ try {
+ session = request.getSession();
+ }
+ catch (exception& e) {
+ log.warn("error during session lookup: %s", e.what());
+ // If it's not a retryable session failure, we throw to the outer handler for reporting.
+ if (dynamic_cast<opensaml::RetryableProfileException*>(&e)==NULL)
+ throw;
+ }
+
+ if (!session) {
+ // No session. Maybe that's acceptable?
+ if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first)
+ return make_pair(true,request.returnOK());
+
+ // No session, but we require one. Initiate a new session using the indicated method.
+ const Handler* initiator=NULL;
+ if (requireSessionWith.first) {
+ initiator=app->getSessionInitiatorById(requireSessionWith.second);
+ if (!initiator) {
+ throw ConfigurationException(
+ "No session initiator found with id ($1), check requireSessionWith command.", params(1,requireSessionWith.second)
+ );
+ }
+ }
+ else {
+ initiator=app->getDefaultSessionInitiator();
+ if (!initiator)
+ throw ConfigurationException("No default session initiator found, check configuration.");
+ }
+
+ return initiator->run(request,false);
+ }
+
+ // We're done. Everything is okay. Nothing to report. Nothing to do..
+ // Let the caller decide how to proceed.
+ log.debug("doAuthentication succeeded");
+ return make_pair(false,0L);
+ }
+ catch (exception& e) {
+ TemplateParameters tp(&e);
+ tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
+ return make_pair(true,sendError(log, request, app, "session", tp));
+ }
+}
+
+pair<bool,long> ServiceProvider::doAuthorization(SPRequest& request) const
+{
+#ifdef _DEBUG
+ xmltooling::NDC ndc("doAuthorization");
+#endif
+ Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
+
+ const Application* app=NULL;
+ string targetURL = request.getRequestURL();
+
+ try {
+ RequestMapper::Settings settings = request.getRequestSettings();
+ app = &(request.getApplication());
+
+ // Three settings dictate how to proceed.
+ pair<bool,const char*> authType = settings.first->getString("authType");
+ pair<bool,bool> requireSession = settings.first->getBool("requireSession");
+ pair<bool,const char*> requireSessionWith = settings.first->getString("requireSessionWith");
+
+ // If no session is required AND the AuthType (an Apache-derived concept) isn't shibboleth,
+ // then we ignore this request and consider it unprotected. Apache might lie to us if
+ // ShibBasicHijack is on, but that's up to it.
+ if ((!requireSession.first || !requireSession.second) && !requireSessionWith.first &&
+#ifdef HAVE_STRCASECMP
+ (!authType.first || strcasecmp(authType.second,"shibboleth")))
+#else
+ (!authType.first || _stricmp(authType.second,"shibboleth")))
+#endif
+ return make_pair(true,request.returnDecline());
+
+ // Do we have an access control plugin?
+ if (settings.second) {
+ const Session* session = NULL;
+ try {
+ session = request.getSession(false);
+ }
+ catch (exception& e) {
+ log.warn("unable to obtain session to pass to access control provider: %s", e.what());
+ }
+
+ Locker acllock(settings.second);
+ switch (settings.second->authorized(request,session)) {
+ case AccessControl::shib_acl_true:
+ log.debug("access control provider granted access");
+ return make_pair(true,request.returnOK());
+
+ case AccessControl::shib_acl_false:
+ {
+ log.warn("access control provider denied access");
+ TemplateParameters tp;
+ tp.m_map["requestURL"] = targetURL;
+ return make_pair(true,sendError(log, request, app, "access", tp, false));
+ }
+
+ default:
+ // Use the "DECLINE" interface to signal we don't know what to do.
+ return make_pair(true,request.returnDecline());
+ }
+ }
+ else {
+ return make_pair(true,request.returnDecline());
+ }
+ }
+ catch (exception& e) {
+ TemplateParameters tp(&e);
+ tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
+ return make_pair(true,sendError(log, request, app, "access", tp));
+ }
+}
+
+pair<bool,long> ServiceProvider::doExport(SPRequest& request, bool requireSession) const
+{
+#ifdef _DEBUG
+ xmltooling::NDC ndc("doExport");
+#endif
+ Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
+
+ const Application* app=NULL;
+ string targetURL = request.getRequestURL();
+
+ try {
+ RequestMapper::Settings settings = request.getRequestSettings();
+ app = &(request.getApplication());
+
+ const Session* session = NULL;
+ try {
+ session = request.getSession(false);
+ }
+ catch (exception& e) {
+ log.warn("unable to obtain session to export to request: %s", e.what());
+ // If we have to have a session, then this is a fatal error.
+ if (requireSession)
+ throw;
+ }
+
+ // Still no data?
+ if (!session) {
+ if (requireSession)
+ throw opensaml::RetryableProfileException("Unable to obtain session to export to request.");
+ else
+ return make_pair(false,0L); // just bail silently
+ }
+
+ request.setHeader("Shib-Application-ID", app->getId());
+ request.setHeader("Shib-Session-ID", session->getID());
+
+ // Export the IdP name and Authn method/context info.
+ const char* hval = session->getEntityID();
+ if (hval)
+ request.setHeader("Shib-Identity-Provider", hval);
+ hval = session->getAuthnInstant();
+ if (hval)
+ request.setHeader("Shib-Authentication-Instant", hval);
+ hval = session->getAuthnContextClassRef();
+ if (hval) {
+ request.setHeader("Shib-Authentication-Method", hval);
+ request.setHeader("Shib-AuthnContext-Class", hval);
+ }
+ hval = session->getAuthnContextDeclRef();
+ if (hval)
+ request.setHeader("Shib-AuthnContext-Decl", hval);
+
+ // Maybe export the assertion keys.
+ pair<bool,bool> exp=settings.first->getBool("exportAssertion");
+ if (exp.first && exp.second) {
+ const PropertySet* sessions=app->getPropertySet("Sessions");
+ pair<bool,const char*> exportLocation = sessions ? sessions->getString("exportLocation") : pair<bool,const char*>(false,NULL);
+ if (!exportLocation.first)
+ log.warn("can't export assertions without an exportLocation Sessions property");
+ else {
+ const URLEncoder* encoder = XMLToolingConfig::getConfig().getURLEncoder();
+ string exportName = "Shib-Assertion-00";
+ string baseURL;
+ if (!strncmp(exportLocation.second, "http", 4))
+ baseURL = exportLocation.second;
+ else
+ baseURL = string(request.getHandlerURL(targetURL.c_str())) + exportLocation.second;
+ baseURL = baseURL + "?key=" + session->getID() + "&ID=";
+ const vector<const char*>& tokens = session->getAssertionIDs();
+ vector<const char*>::size_type count = 0;
+ for (vector<const char*>::const_iterator tokenids = tokens.begin(); tokenids!=tokens.end(); ++tokenids) {
+ count++;
+ *(exportName.rbegin()) = '0' + (count%10);
+ *(++exportName.rbegin()) = '0' + (count/10);
+ string fullURL = baseURL + encoder->encode(*tokenids);
+ request.setHeader(exportName.c_str(), fullURL.c_str());
+ }
+ request.setHeader("Shib-Assertion-Count", exportName.c_str() + 15);
+ }
+ }
+
+ // Export the attributes.
+ const multimap<string,const Attribute*>& attributes = session->getIndexedAttributes();
+ for (multimap<string,const Attribute*>::const_iterator a = attributes.begin(); a!=attributes.end(); ++a) {
+ string header(request.getSecureHeader(a->first.c_str()));
+ const vector<string>& vals = a->second->getSerializedValues();
+ for (vector<string>::const_iterator v = vals.begin(); v!=vals.end(); ++v) {
+ if (!header.empty())
+ header += ";";
+ string::size_type pos = v->find_first_of(';',string::size_type(0));
+ if (pos!=string::npos) {
+ string value(*v);
+ for (; pos != string::npos; pos = value.find_first_of(';',pos)) {
+ value.insert(pos, "\\");
+ pos += 2;
+ }
+ header += value;
+ }
+ else {
+ header += (*v);
+ }
+ }
+ request.setHeader(a->first.c_str(), header.c_str());
+ }
+
+ // Check for REMOTE_USER.
+ bool remoteUserSet = false;
+ const vector<string>& rmids = app->getRemoteUserAttributeIds();
+ for (vector<string>::const_iterator rmid = rmids.begin(); !remoteUserSet && rmid != rmids.end(); ++rmid) {
+ pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> matches =
+ attributes.equal_range(*rmid);
+ while (matches.first != matches.second) {
+ const vector<string>& vals = matches.first->second->getSerializedValues();
+ if (!vals.empty()) {
+ request.setRemoteUser(vals.front().c_str());
+ remoteUserSet = true;
+ break;
+ }
+ }
+ }
+
+ return make_pair(false,0L);
+ }
+ catch (exception& e) {
+ TemplateParameters tp(&e);
+ tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
+ return make_pair(true,sendError(log, request, app, "session", tp));
+ }
+}
+
+pair<bool,long> ServiceProvider::doHandler(SPRequest& request) const
+{
+#ifdef _DEBUG
+ xmltooling::NDC ndc("doHandler");
+#endif
+ Category& log = Category::getInstance(SHIBSP_LOGCAT".ServiceProvider");
+
+ const Application* app=NULL;
+ string targetURL = request.getRequestURL();
+
+ try {
+ RequestMapper::Settings settings = request.getRequestSettings();
+ app = &(request.getApplication());
+
+ // If not SSL, check to see if we should block or redirect it.
+ if (!request.isSecure()) {
+ pair<bool,const char*> redirectToSSL = settings.first->getString("redirectToSSL");
+ if (redirectToSSL.first) {
+#ifdef HAVE_STRCASECMP
+ if (!strcasecmp("GET",request.getMethod()) || !strcasecmp("HEAD",request.getMethod())) {
+#else
+ if (!stricmp("GET",request.getMethod()) || !stricmp("HEAD",request.getMethod())) {
+#endif
+ // Compute the new target URL
+ string redirectURL = string("https://") + request.getHostname();
+ if (strcmp(redirectToSSL.second,"443")) {
+ redirectURL = redirectURL + ':' + redirectToSSL.second;
+ }
+ redirectURL += request.getRequestURI();
+ return make_pair(true, request.sendRedirect(redirectURL.c_str()));
+ }
+ else {
+ TemplateParameters tp;
+ tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
+ return make_pair(true,sendError(log, request, app, "ssl", tp, false));
+ }
+ }
+ }
+
+ const char* handlerURL=request.getHandlerURL(targetURL.c_str());
+ if (!handlerURL)
+ throw ConfigurationException("Cannot determine handler from resource URL, check configuration.");
+
+ // Make sure we only process handler requests.
+ if (!strstr(targetURL.c_str(),handlerURL))
+ return make_pair(true, request.returnDecline());
+
+ const PropertySet* sessionProps=app->getPropertySet("Sessions");
+ if (!sessionProps)
+ throw ConfigurationException("Unable to map request to application session settings, check configuration.");
+
+ // Process incoming request.
+ pair<bool,bool> handlerSSL=sessionProps->getBool("handlerSSL");
+
+ // Make sure this is SSL, if it should be
+ if ((!handlerSSL.first || handlerSSL.second) && !request.isSecure())
+ throw opensaml::FatalProfileException("Blocked non-SSL access to Shibboleth handler.");
+
+ // We dispatch based on our path info. We know the request URL begins with or equals the handler URL,
+ // so the path info is the next character (or null).
+ const Handler* handler=app->getHandler(targetURL.c_str() + strlen(handlerURL));
+ if (!handler)
+ throw ConfigurationException("Shibboleth handler invoked at an unconfigured location.");
+
+ pair<bool,long> hret=handler->run(request);
+
+ // Did the handler run successfully?
+ if (hret.first)
+ return hret;
+
+ throw ConfigurationException("Configured Shibboleth handler failed to process the request.");
+ }
+ catch (exception& e) {
+ TemplateParameters tp(&e);
+ tp.m_map["requestURL"] = targetURL.substr(0,targetURL.find('?'));
+ tp.m_request = &request;
+ return make_pair(true,sendError(log, request, app, "session", tp));
+ }
}