2 * Copyright 2001-2009 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 * Base class for handlers based on a DOMPropertySet.
24 #include "Application.h"
25 #include "exceptions.h"
26 #include "ServiceProvider.h"
27 #include "SPRequest.h"
28 #include "handler/AbstractHandler.h"
29 #include "handler/LogoutHandler.h"
30 #include "remoting/ListenerService.h"
31 #include "util/CGIParser.h"
32 #include "util/SPConstants.h"
33 #include "util/TemplateParameters.h"
37 #include <xmltooling/XMLToolingConfig.h>
38 #include <xmltooling/util/PathResolver.h>
39 #include <xmltooling/util/URLEncoder.h>
43 # include <saml/saml1/core/Protocols.h>
44 # include <saml/saml2/core/Protocols.h>
45 # include <saml/saml2/metadata/Metadata.h>
46 # include <saml/saml2/metadata/MetadataCredentialCriteria.h>
47 # include <saml/util/SAMLConstants.h>
48 # include <saml/SAMLConfig.h>
49 # include <saml/binding/SAMLArtifact.h>
50 # include <xmltooling/util/StorageService.h>
51 using namespace opensaml::saml2md;
53 # include "lite/SAMLConstants.h"
56 #include <xmltooling/XMLToolingConfig.h>
57 #include <xmltooling/util/URLEncoder.h>
59 using namespace shibsp;
60 using namespace samlconstants;
61 using namespace opensaml;
62 using namespace xmltooling;
63 using namespace xercesc;
67 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory SAML1ConsumerFactory;
68 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory SAML2ConsumerFactory;
69 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory SAML2ArtifactResolutionFactory;
70 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory ChainingLogoutInitiatorFactory;
71 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory LocalLogoutInitiatorFactory;
72 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory SAML2LogoutInitiatorFactory;
73 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory SAML2LogoutFactory;
74 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory SAML2NameIDMgmtFactory;
75 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory AssertionLookupFactory;
76 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory MetadataGeneratorFactory;
77 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory StatusHandlerFactory;
78 SHIBSP_DLLLOCAL PluginManager< Handler,string,pair<const DOMElement*,const char*> >::Factory SessionHandlerFactory;
80 void SHIBSP_DLLLOCAL generateRandomHex(std::string& buf, unsigned int len) {
81 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
85 for (unsigned int i=0; i<len; i+=4) {
88 b2 = (0xFF00 & r) >> 8;
89 buf += (DIGITS[(0xF0 & b1) >> 4 ]);
90 buf += (DIGITS[0x0F & b1]);
91 buf += (DIGITS[(0xF0 & b2) >> 4 ]);
92 buf += (DIGITS[0x0F & b2]);
97 void SHIBSP_API shibsp::registerHandlers()
99 SPConfig& conf=SPConfig::getConfig();
101 conf.AssertionConsumerServiceManager.registerFactory(SAML1_PROFILE_BROWSER_ARTIFACT, SAML1ConsumerFactory);
102 conf.AssertionConsumerServiceManager.registerFactory(SAML1_PROFILE_BROWSER_POST, SAML1ConsumerFactory);
103 conf.AssertionConsumerServiceManager.registerFactory(SAML20_BINDING_HTTP_POST, SAML2ConsumerFactory);
104 conf.AssertionConsumerServiceManager.registerFactory(SAML20_BINDING_HTTP_POST_SIMPLESIGN, SAML2ConsumerFactory);
105 conf.AssertionConsumerServiceManager.registerFactory(SAML20_BINDING_HTTP_ARTIFACT, SAML2ConsumerFactory);
106 conf.AssertionConsumerServiceManager.registerFactory(SAML20_BINDING_PAOS, SAML2ConsumerFactory);
108 conf.ArtifactResolutionServiceManager.registerFactory(SAML20_BINDING_SOAP, SAML2ArtifactResolutionFactory);
110 conf.HandlerManager.registerFactory(SAML20_BINDING_URI, AssertionLookupFactory);
111 conf.HandlerManager.registerFactory(METADATA_GENERATOR_HANDLER, MetadataGeneratorFactory);
112 conf.HandlerManager.registerFactory(STATUS_HANDLER, StatusHandlerFactory);
113 conf.HandlerManager.registerFactory(SESSION_HANDLER, SessionHandlerFactory);
115 conf.LogoutInitiatorManager.registerFactory(CHAINING_LOGOUT_INITIATOR, ChainingLogoutInitiatorFactory);
116 conf.LogoutInitiatorManager.registerFactory(LOCAL_LOGOUT_INITIATOR, LocalLogoutInitiatorFactory);
117 conf.LogoutInitiatorManager.registerFactory(SAML2_LOGOUT_INITIATOR, SAML2LogoutInitiatorFactory);
118 conf.SingleLogoutServiceManager.registerFactory(SAML20_BINDING_SOAP, SAML2LogoutFactory);
119 conf.SingleLogoutServiceManager.registerFactory(SAML20_BINDING_HTTP_REDIRECT, SAML2LogoutFactory);
120 conf.SingleLogoutServiceManager.registerFactory(SAML20_BINDING_HTTP_POST, SAML2LogoutFactory);
121 conf.SingleLogoutServiceManager.registerFactory(SAML20_BINDING_HTTP_POST_SIMPLESIGN, SAML2LogoutFactory);
122 conf.SingleLogoutServiceManager.registerFactory(SAML20_BINDING_HTTP_ARTIFACT, SAML2LogoutFactory);
124 conf.ManageNameIDServiceManager.registerFactory(SAML20_BINDING_SOAP, SAML2NameIDMgmtFactory);
125 conf.ManageNameIDServiceManager.registerFactory(SAML20_BINDING_HTTP_REDIRECT, SAML2NameIDMgmtFactory);
126 conf.ManageNameIDServiceManager.registerFactory(SAML20_BINDING_HTTP_POST, SAML2NameIDMgmtFactory);
127 conf.ManageNameIDServiceManager.registerFactory(SAML20_BINDING_HTTP_POST_SIMPLESIGN, SAML2NameIDMgmtFactory);
128 conf.ManageNameIDServiceManager.registerFactory(SAML20_BINDING_HTTP_ARTIFACT, SAML2NameIDMgmtFactory);
131 AbstractHandler::AbstractHandler(
132 const DOMElement* e, Category& log, DOMNodeFilter* filter, const map<string,string>* remapper
133 ) : m_log(log), m_configNS(shibspconstants::SHIB2SPCONFIG_NS) {
134 load(e,NULL,filter,remapper);
139 void AbstractHandler::checkError(const XMLObject* response, const saml2md::RoleDescriptor* role) const
141 const saml2p::StatusResponseType* r2 = dynamic_cast<const saml2p::StatusResponseType*>(response);
143 const saml2p::Status* status = r2->getStatus();
145 const saml2p::StatusCode* sc = status->getStatusCode();
146 const XMLCh* code = sc ? sc->getValue() : NULL;
147 if (code && !XMLString::equals(code,saml2p::StatusCode::SUCCESS)) {
148 FatalProfileException ex("SAML response contained an error.");
149 annotateException(&ex, role, status); // throws it
154 const saml1p::Response* r1 = dynamic_cast<const saml1p::Response*>(response);
156 const saml1p::Status* status = r1->getStatus();
158 const saml1p::StatusCode* sc = status->getStatusCode();
159 const xmltooling::QName* code = sc ? sc->getValue() : NULL;
160 if (code && *code != saml1p::StatusCode::SUCCESS) {
161 FatalProfileException ex("SAML response contained an error.");
162 ex.addProperty("statusCode", code->toString().c_str());
163 if (sc->getStatusCode()) {
164 code = sc->getStatusCode()->getValue();
166 ex.addProperty("statusCode2", code->toString().c_str());
168 if (status->getStatusMessage()) {
169 auto_ptr_char msg(status->getStatusMessage()->getMessage());
170 if (msg.get() && *msg.get())
171 ex.addProperty("statusMessage", msg.get());
179 void AbstractHandler::fillStatus(saml2p::StatusResponseType& response, const XMLCh* code, const XMLCh* subcode, const char* msg) const
181 saml2p::Status* status = saml2p::StatusBuilder::buildStatus();
182 saml2p::StatusCode* scode = saml2p::StatusCodeBuilder::buildStatusCode();
183 status->setStatusCode(scode);
184 scode->setValue(code);
186 saml2p::StatusCode* ssubcode = saml2p::StatusCodeBuilder::buildStatusCode();
187 scode->setStatusCode(ssubcode);
188 ssubcode->setValue(subcode);
191 pair<bool,bool> flag = getBool("detailedErrors", m_configNS.get());
192 auto_ptr_XMLCh widemsg((flag.first && flag.second) ? msg : "Error processing request.");
193 saml2p::StatusMessage* sm = saml2p::StatusMessageBuilder::buildStatusMessage();
194 status->setStatusMessage(sm);
195 sm->setMessage(widemsg.get());
197 response.setStatus(status);
200 long AbstractHandler::sendMessage(
201 const MessageEncoder& encoder,
203 const char* relayState,
204 const char* destination,
205 const saml2md::RoleDescriptor* role,
206 const Application& application,
207 HTTPResponse& httpResponse,
211 const EntityDescriptor* entity = role ? dynamic_cast<const EntityDescriptor*>(role->getParent()) : NULL;
212 const PropertySet* relyingParty = application.getRelyingParty(entity);
213 pair<bool,const char*> flag = signIfPossible ? make_pair(true,(const char*)"true") : relyingParty->getString("signing");
214 if (role && flag.first &&
215 (!strcmp(flag.second, "true") ||
216 (encoder.isUserAgentPresent() && !strcmp(flag.second, "front")) ||
217 (!encoder.isUserAgentPresent() && !strcmp(flag.second, "back")))) {
218 CredentialResolver* credResolver=application.getCredentialResolver();
220 Locker credLocker(credResolver);
221 const Credential* cred = NULL;
222 pair<bool,const char*> keyName = relyingParty->getString("keyName");
223 pair<bool,const XMLCh*> sigalg = relyingParty->getXMLString("signingAlg");
225 MetadataCredentialCriteria mcc(*role);
226 mcc.setUsage(Credential::SIGNING_CREDENTIAL);
228 mcc.getKeyNames().insert(keyName.second);
230 mcc.setXMLAlgorithm(sigalg.second);
231 cred = credResolver->resolve(&mcc);
234 CredentialCriteria cc;
235 cc.setUsage(Credential::SIGNING_CREDENTIAL);
237 cc.getKeyNames().insert(keyName.second);
239 cc.setXMLAlgorithm(sigalg.second);
240 cred = credResolver->resolve(&cc);
244 return encoder.encode(
253 relyingParty->getXMLString("digestAlg").second
257 m_log.warn("no signing credential resolved, leaving message unsigned");
261 m_log.warn("no credential resolver installed, leaving message unsigned");
266 return encoder.encode(httpResponse, msg, destination, entity, relayState, &application);
271 void AbstractHandler::preserveRelayState(const Application& application, HTTPResponse& response, string& relayState) const
273 if (relayState.empty())
276 // No setting means just pass it by value.
277 pair<bool,const char*> mech=getString("relayState");
278 if (!mech.first || !mech.second || !*mech.second)
281 if (!strcmp(mech.second, "cookie")) {
282 // Here we store the state in a cookie and send a fixed
283 // value so we can recognize it on the way back.
284 if (relayState.find("cookie:") != 0) {
285 const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
286 pair<string,const char*> shib_cookie=application.getCookieNameProps("_shibstate_");
287 string stateval = urlenc->encode(relayState.c_str()) + shib_cookie.second;
288 // Generate a random key for the cookie name instead of the fixed name.
290 generateRandomHex(rsKey,5);
291 shib_cookie.first = "_shibstate_" + rsKey;
292 response.setCookie(shib_cookie.first.c_str(),stateval.c_str());
293 relayState = "cookie:" + rsKey;
296 else if (strstr(mech.second,"ss:")==mech.second) {
297 if (relayState.find("ss:") != 0) {
300 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
302 StorageService* storage = application.getServiceProvider().getStorageService(mech.second);
305 generateRandomHex(rsKey,5);
306 if (!storage->createString("RelayState", rsKey.c_str(), relayState.c_str(), time(NULL) + 600))
307 throw IOException("Attempted to insert duplicate storage key.");
308 relayState = string(mech.second-3) + ':' + rsKey;
311 m_log.error("Storage-backed RelayState with invalid StorageService ID (%s)", mech.second);
316 else if (SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
317 DDF out,in = DDF("set::RelayState").structure();
318 in.addmember("id").string(mech.second);
319 in.addmember("value").string(relayState.c_str());
320 DDFJanitor jin(in),jout(out);
321 out = application.getServiceProvider().getListenerService()->send(in);
323 throw IOException("StorageService-backed RelayState mechanism did not return a state key.");
324 relayState = string(mech.second-3) + ':' + out.string();
330 throw ConfigurationException("Unsupported relayState mechanism ($1).", params(1,mech.second));
333 void AbstractHandler::recoverRelayState(
334 const Application& application, const HTTPRequest& request, HTTPResponse& response, string& relayState, bool clear
337 SPConfig& conf = SPConfig::getConfig();
339 // Look for StorageService-backed state of the form "ss:SSID:key".
340 const char* state = relayState.c_str();
341 if (strstr(state,"ss:")==state) {
343 const char* key = strchr(state,':');
345 string ssid = relayState.substr(3, key - state);
347 if (!ssid.empty() && *key) {
348 if (conf.isEnabled(SPConfig::OutOfProcess)) {
350 StorageService* storage = conf.getServiceProvider()->getStorageService(ssid.c_str());
353 if (storage->readString("RelayState",ssid.c_str(),&relayState)>0) {
355 storage->deleteString("RelayState",ssid.c_str());
362 m_log.error("Storage-backed RelayState with invalid StorageService ID (%s)", ssid.c_str());
367 else if (conf.isEnabled(SPConfig::InProcess)) {
368 DDF out,in = DDF("get::RelayState").structure();
369 in.addmember("id").string(ssid.c_str());
370 in.addmember("key").string(key);
371 in.addmember("clear").integer(clear ? 1 : 0);
372 DDFJanitor jin(in),jout(out);
373 out = application.getServiceProvider().getListenerService()->send(in);
374 if (!out.isstring()) {
375 m_log.error("StorageService-backed RelayState mechanism did not return a state value.");
379 relayState = out.string();
387 // Look for cookie-backed state of the form "cookie:key".
388 if (strstr(state,"cookie:")==state) {
391 // Pull the value from the "relay state" cookie.
392 pair<string,const char*> relay_cookie = application.getCookieNameProps("_shibstate_");
393 relay_cookie.first = string("_shibstate_") + state;
394 state = request.getCookie(relay_cookie.first.c_str());
395 if (state && *state) {
396 // URL-decode the value.
397 char* rscopy=strdup(state);
398 XMLToolingConfig::getConfig().getURLEncoder()->decode(rscopy);
403 string exp(relay_cookie.second);
404 exp += "; expires=Mon, 01 Jan 2001 00:00:00 GMT";
405 response.setCookie(relay_cookie.first.c_str(), exp.c_str());
414 // Check for "default" value (or the old "cookie" value that might come from stale bookmarks).
415 if (relayState.empty() || relayState == "default" || relayState == "cookie") {
416 pair<bool,const char*> homeURL=application.getString("homeURL");
417 relayState=homeURL.first ? homeURL.second : "/";
421 /* Save posted data to a storage service.
422 We may not have to key the postdata cookie to the relay state,
423 but doing so gives a better assurance that the recovered data really belongs to the relayed request. */
424 void AbstractHandler::preservePostData(
425 const Application& application, const HTTPRequest& request, HTTPResponse& response, const char* relayState
428 if (strcmp(request.getMethod(), "POST"))
431 // No specs mean no save.
432 const PropertySet* props=application.getPropertySet("Sessions");
433 pair<bool,const char*> mech = props->getString("postData");
435 m_log.info("postData property not supplied, form data will not be preserved across SSO");
439 DDF postData = getPostData(application, request);
440 if (postData.isnull())
443 if (strstr(mech.second,"ss:") == mech.second) {
447 throw ConfigurationException("Unsupported postData mechanism ($1).", params(1, mech.second - 3));
451 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
452 DDFJanitor postjan(postData);
454 StorageService* storage = application.getServiceProvider().getStorageService(mech.second);
458 SAMLConfig::getConfig().generateRandomBytes(rsKey,20);
459 rsKey = SAMLArtifact::toHex(rsKey);
462 if (!storage->createString("PostData", rsKey.c_str(), out.str().c_str(), time(NULL) + 600))
463 throw IOException("Attempted to insert duplicate storage key.");
464 postkey = string(mech.second-3) + ':' + rsKey;
467 m_log.error("storage-backed PostData mechanism with invalid StorageService ID (%s)", mech.second);
471 else if (SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
472 DDF out,in = DDF("set::PostData").structure();
473 DDFJanitor jin(in),jout(out);
474 in.addmember("id").string(mech.second);
476 out = application.getServiceProvider().getListenerService()->send(in);
478 throw IOException("StorageService-backed PostData mechanism did not return a state key.");
479 postkey = string(mech.second-3) + ':' + out.string();
482 // Set a cookie with key info.
483 pair<string,const char*> shib_cookie = getPostCookieNameProps(application, relayState);
484 postkey += shib_cookie.second;
485 response.setCookie(shib_cookie.first.c_str(), postkey.c_str());
489 throw ConfigurationException("Unsupported postData mechanism ($1).", params(1,mech.second));
493 DDF AbstractHandler::recoverPostData(
494 const Application& application, const HTTPRequest& request, HTTPResponse& response, const char* relayState
497 // First we need the post recovery cookie.
498 pair<string,const char*> shib_cookie = getPostCookieNameProps(application, relayState);
499 const char* cookie = request.getCookie(shib_cookie.first.c_str());
500 if (!cookie || !*cookie)
504 string exp(shib_cookie.second);
505 exp += "; expires=Mon, 01 Jan 2001 00:00:00 GMT";
506 response.setCookie(shib_cookie.first.c_str(), exp.c_str());
508 // Look for StorageService-backed state of the form "ss:SSID:key".
509 const char* state = cookie;
510 if (strstr(state, "ss:") == state) {
512 const char* key = strchr(state, ':');
514 string ssid = string(cookie).substr(3, key - state);
516 if (!ssid.empty() && *key) {
517 SPConfig& conf = SPConfig::getConfig();
518 if (conf.isEnabled(SPConfig::OutOfProcess)) {
520 StorageService* storage = conf.getServiceProvider()->getStorageService(ssid.c_str());
522 if (storage->readString("PostData", key, &ssid) > 0) {
523 storage->deleteString("PostData", key);
524 istringstream inret(ssid);
530 m_log.error("failed to recover form post data using key (%s)", key);
534 m_log.error("storage-backed PostData with invalid StorageService ID (%s)", ssid.c_str());
538 else if (conf.isEnabled(SPConfig::InProcess)) {
539 DDF in = DDF("get::PostData").structure();
541 in.addmember("id").string(ssid.c_str());
542 in.addmember("key").string(key);
543 DDF out = application.getServiceProvider().getListenerService()->send(in);
547 m_log.error("storageService-backed PostData mechanism did not return preserved data.");
555 long AbstractHandler::sendPostResponse(
556 const Application& application, HTTPResponse& httpResponse, const char* url, DDF& postData
559 const PropertySet* props=application.getPropertySet("Sessions");
560 pair<bool,const char*> postTemplate = props->getString("postTemplate");
561 if (!postTemplate.first)
562 throw ConfigurationException("Missing postTemplate property, unable to recreate form post.");
564 string fname(postTemplate.second);
565 ifstream infile(XMLToolingConfig::getConfig().getPathResolver()->resolve(fname, PathResolver::XMLTOOLING_CFG_FILE).c_str());
567 throw ConfigurationException("Unable to access HTML template ($1).", params(1, fname.c_str()));
568 TemplateParameters respParam;
569 respParam.m_map["action"] = url;
571 // Load the parameters into objects for the template.
572 // TODO: rework the TemplateEngine to require only a single TemplateParameters object
573 vector<TemplateEngine::TemplateParameters> dataParams;
575 DDF param = postData.first();
576 while (param.isstring()) {
577 dataParams.push_back(TemplateEngine::TemplateParameters());
578 TemplateEngine::TemplateParameters& xp = dataParams.back();
579 xp.m_map["_name_"] = param.name();
580 xp.m_map["_value_"] = param.string();
581 param = postData.next();
583 respParam.m_collectionMap["PostedData"] = dataParams;
586 XMLToolingConfig::getConfig().getTemplateEngine()->run(infile, str, respParam);
588 httpResponse.setContentType("text/html");
589 httpResponse.setResponseHeader("Expires", "01-Jan-1997 12:00:00 GMT");
590 httpResponse.setResponseHeader("Cache-Control", "no-cache, no-store, must-revalidate, private");
\r
591 httpResponse.setResponseHeader("Pragma", "no-cache");
\r
592 return httpResponse.sendResponse(str);
595 // Decorates the name of the cookie with the relay state key, if any.
596 pair<string,const char*> AbstractHandler::getPostCookieNameProps(const Application& app, const char* relayState) const
598 pair<string,const char*> shib_cookie=app.getCookieNameProps("_shibpost_");
599 if (strstr(relayState, "cookie:") == relayState) {
600 shib_cookie.first += (relayState + 7);
602 else if (strstr(relayState, "ss:") == relayState) {
603 const char* pch = strchr(relayState + 3, ':');
605 shib_cookie.first += (pch + 1);
610 DDF AbstractHandler::getPostData(const Application& application, const HTTPRequest& request) const
612 string contentType = request.getContentType();
613 if (contentType.compare("application/x-www-form-urlencoded") == 0) {
614 const PropertySet* props=application.getPropertySet("Sessions");
615 pair<bool,unsigned int> plimit = props->getUnsignedInt("postLimit");
617 plimit.second = 1024 * 1024;
618 if (plimit.second == 0 || request.getContentLength() <= plimit.second) {
619 CGIParser cgi(request);
620 pair<CGIParser::walker,CGIParser::walker> params = cgi.getParameters(NULL);
621 if (params.first == params.second)
624 DDF ret = DDF("parameters").list();
625 for (; params.first != params.second; ++params.first) {
626 child = DDF(params.first->first.c_str()).string(params.first->second);
632 m_log.warn("POST limit exceeded, ignoring %d bytes of posted data", request.getContentLength());
636 m_log.info("ignoring POST data with non-standard encoding (%s)", contentType.c_str());