2 * Copyright 2001-2007 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 "remoting/ListenerService.h"
30 #include "util/SPConstants.h"
33 # include <saml/SAMLConfig.h>
34 # include <saml/binding/SAMLArtifact.h>
35 # include <saml/saml1/core/Protocols.h>
36 # include <saml/saml2/core/Protocols.h>
37 # include <saml/util/SAMLConstants.h>
38 # include <xmltooling/util/StorageService.h>
40 # include "lite/SAMLConstants.h"
43 #include <xmltooling/XMLToolingConfig.h>
44 #include <xmltooling/util/URLEncoder.h>
46 using namespace shibsp;
47 using namespace samlconstants;
48 using namespace opensaml;
49 using namespace xmltooling;
50 using namespace log4cpp;
51 using namespace xercesc;
55 SHIBSP_DLLLOCAL PluginManager<Handler,string,pair<const DOMElement*,const char*>>::Factory SAML1ConsumerFactory;
56 SHIBSP_DLLLOCAL PluginManager<Handler,string,pair<const DOMElement*,const char*>>::Factory SAML2ConsumerFactory;
57 SHIBSP_DLLLOCAL PluginManager<Handler,string,pair<const DOMElement*,const char*>>::Factory SAML2ArtifactResolutionFactory;
58 SHIBSP_DLLLOCAL PluginManager<Handler,string,pair<const DOMElement*,const char*>>::Factory AssertionLookupFactory;
61 void SHIBSP_API shibsp::registerHandlers()
63 SPConfig& conf=SPConfig::getConfig();
65 conf.AssertionConsumerServiceManager.registerFactory(SAML1_PROFILE_BROWSER_ARTIFACT, SAML1ConsumerFactory);
66 conf.AssertionConsumerServiceManager.registerFactory(SAML1_PROFILE_BROWSER_POST, SAML1ConsumerFactory);
67 conf.AssertionConsumerServiceManager.registerFactory(SAML20_BINDING_HTTP_ARTIFACT, SAML2ConsumerFactory);
68 conf.AssertionConsumerServiceManager.registerFactory(SAML20_BINDING_HTTP_POST, SAML2ConsumerFactory);
69 conf.AssertionConsumerServiceManager.registerFactory(SAML20_BINDING_HTTP_POST_SIMPLESIGN, SAML2ConsumerFactory);
71 conf.ArtifactResolutionServiceManager.registerFactory(SAML20_BINDING_SOAP, SAML2ArtifactResolutionFactory);
73 conf.HandlerManager.registerFactory(SAML20_BINDING_URI, AssertionLookupFactory);
76 AbstractHandler::AbstractHandler(
77 const DOMElement* e, log4cpp::Category& log, DOMNodeFilter* filter, const map<string,string>* remapper
78 ) : m_log(log), m_configNS(shibspconstants::SHIB2SPCONFIG_NS) {
79 load(e,log,filter,remapper);
83 void AbstractHandler::checkError(const XMLObject* response) const
85 const saml2p::StatusResponseType* r2 = dynamic_cast<const saml2p::StatusResponseType*>(response);
87 const saml2p::Status* status = r2->getStatus();
89 const saml2p::StatusCode* sc = status->getStatusCode();
90 const XMLCh* code = sc ? sc->getValue() : NULL;
91 if (code && !XMLString::equals(code,saml2p::StatusCode::SUCCESS)) {
92 FatalProfileException ex("SAML Response message contained an error.");
93 auto_ptr_char c1(code);
94 ex.addProperty("StatusCode", c1.get());
95 if (sc->getStatusCode()) {
96 code = sc->getStatusCode()->getValue();
97 auto_ptr_char c2(code);
98 ex.addProperty("StatusCode2", c2.get());
100 if (status->getStatusMessage()) {
101 auto_ptr_char msg(status->getStatusMessage()->getMessage());
102 ex.addProperty("StatusMessage", msg.get());
108 const saml1p::Response* r1 = dynamic_cast<const saml1p::Response*>(response);
110 const saml1p::Status* status = r1->getStatus();
112 const saml1p::StatusCode* sc = status->getStatusCode();
113 const QName* code = sc ? sc->getValue() : NULL;
114 if (code && *code != saml1p::StatusCode::SUCCESS) {
115 FatalProfileException ex("SAML Response message contained an error.");
116 ex.addProperty("StatusCode", code->toString().c_str());
117 if (sc->getStatusCode()) {
118 code = sc->getStatusCode()->getValue();
120 ex.addProperty("StatusCode2", code->toString().c_str());
122 if (status->getStatusMessage()) {
123 auto_ptr_char msg(status->getStatusMessage()->getMessage());
124 ex.addProperty("StatusMessage", msg.get());
131 void AbstractHandler::prepareResponse(saml2p::StatusResponseType& response, const XMLCh* code, const XMLCh* subcode, const char* msg) const
133 saml2p::Status* status = saml2p::StatusBuilder::buildStatus();
134 saml2p::StatusCode* scode = saml2p::StatusCodeBuilder::buildStatusCode();
135 status->setStatusCode(scode);
136 scode->setValue(code);
138 saml2p::StatusCode* ssubcode = saml2p::StatusCodeBuilder::buildStatusCode();
139 scode->setStatusCode(ssubcode);
140 ssubcode->setValue(subcode);
143 pair<bool,bool> flag = getBool("detailedErrors", m_configNS.get());
144 auto_ptr_XMLCh widemsg((flag.first && flag.second) ? msg : "Error processing request.");
145 saml2p::StatusMessage* sm = saml2p::StatusMessageBuilder::buildStatusMessage();
146 status->setStatusMessage(sm);
147 sm->setMessage(widemsg.get());
149 response.setStatus(status);
153 void AbstractHandler::preserveRelayState(const Application& application, HTTPResponse& response, string& relayState) const
155 if (relayState.empty())
158 // No setting means just pass it by value.
159 pair<bool,const char*> mech=getString("relayState");
160 if (!mech.first || !mech.second || !*mech.second)
163 if (!strcmp(mech.second, "cookie")) {
164 // Here we store the state in a cookie and send a fixed
165 // value so we can recognize it on the way back.
166 if (relayState != "cookie") {
167 const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
168 pair<string,const char*> shib_cookie=application.getCookieNameProps("_shibstate_");
169 string stateval = urlenc->encode(relayState.c_str()) + shib_cookie.second;
170 response.setCookie(shib_cookie.first.c_str(),stateval.c_str());
171 relayState = "cookie";
174 else if (strstr(mech.second,"ss:")==mech.second) {
175 if (relayState.find("ss:")!=0) {
178 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
180 StorageService* storage = application.getServiceProvider().getStorageService(mech.second);
183 SAMLConfig::getConfig().generateRandomBytes(rsKey,10);
184 rsKey = SAMLArtifact::toHex(rsKey);
185 storage->createString("RelayState", rsKey.c_str(), relayState.c_str(), time(NULL) + 600);
186 relayState = string(mech.second-3) + ':' + rsKey;
189 m_log.error("Storage-backed RelayState with invalid StorageService ID (%s)", mech.second);
194 else if (SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
195 DDF out,in = DDF("set::RelayState").structure();
196 in.addmember("id").string(mech.second);
197 in.addmember("value").string(relayState.c_str());
198 DDFJanitor jin(in),jout(out);
199 out = application.getServiceProvider().getListenerService()->send(in);
201 throw IOException("StorageService-backed RelayState mechanism did not return a state key.");
202 relayState = string(mech.second-3) + ':' + out.string();
208 throw ConfigurationException("Unsupported relayState mechanism ($1).", params(1,mech.second));
211 void AbstractHandler::recoverRelayState(const Application& application, HTTPRequest& httpRequest, string& relayState, bool clear) const
213 SPConfig& conf = SPConfig::getConfig();
215 // Look for StorageService-backed state of the form "ss:SSID:key".
216 const char* state = relayState.c_str();
217 if (strstr(state,"ss:")==state) {
219 const char* key = strchr(state,':');
221 string ssid = relayState.substr(3, key - state);
223 if (!ssid.empty() && *key) {
224 if (conf.isEnabled(SPConfig::OutOfProcess)) {
226 StorageService* storage = conf.getServiceProvider()->getStorageService(ssid.c_str());
229 if (storage->readString("RelayState",ssid.c_str(),&relayState)>0) {
231 storage->deleteString("RelayState",ssid.c_str());
238 Category::getInstance(SHIBSP_LOGCAT".Handler").error(
239 "Storage-backed RelayState with invalid StorageService ID (%s)", ssid.c_str()
245 else if (conf.isEnabled(SPConfig::InProcess)) {
246 DDF out,in = DDF("get::RelayState").structure();
247 in.addmember("id").string(ssid.c_str());
248 in.addmember("key").string(key);
249 in.addmember("clear").integer(clear ? 1 : 0);
250 DDFJanitor jin(in),jout(out);
251 out = application.getServiceProvider().getListenerService()->send(in);
252 if (!out.isstring()) {
253 m_log.error("StorageService-backed RelayState mechanism did not return a state value.");
257 relayState = out.string();
265 if (conf.isEnabled(SPConfig::InProcess)) {
266 if (relayState == "cookie") {
267 // Pull the value from the "relay state" cookie.
268 pair<string,const char*> relay_cookie = application.getCookieNameProps("_shibstate_");
269 // In process, we should be able to cast down to a full SPRequest.
270 SPRequest& request = dynamic_cast<SPRequest&>(httpRequest);
271 const char* state = request.getCookie(relay_cookie.first.c_str());
272 if (state && *state) {
273 // URL-decode the value.
274 char* rscopy=strdup(state);
275 XMLToolingConfig::getConfig().getURLEncoder()->decode(rscopy);
280 request.setCookie(relay_cookie.first.c_str(),relay_cookie.second);
287 // Check for "default" value.
288 if (relayState.empty() || relayState == "default") {
289 pair<bool,const char*> homeURL=application.getString("homeURL");
290 relayState=homeURL.first ? homeURL.second : "/";
295 if (relayState == "default")