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.
18 * Shib1SessionInitiator.cpp
20 * Shibboleth 1.x AuthnRequest support.
24 #include "Application.h"
25 #include "exceptions.h"
26 #include "ServiceProvider.h"
27 #include "SPRequest.h"
28 #include "handler/AbstractHandler.h"
29 #include "handler/RemotedHandler.h"
30 #include "handler/SessionInitiator.h"
31 #include "util/SPConstants.h"
34 # include <saml/saml2/metadata/Metadata.h>
35 # include <saml/saml2/metadata/EndpointManager.h>
37 #include <xmltooling/XMLToolingConfig.h>
38 #include <xmltooling/util/URLEncoder.h>
40 using namespace shibsp;
41 using namespace opensaml::saml2md;
42 using namespace opensaml;
43 using namespace xmltooling;
44 using namespace log4cpp;
49 #if defined (_MSC_VER)
50 #pragma warning( push )
51 #pragma warning( disable : 4250 )
54 class SHIBSP_DLLLOCAL Shib1SessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
57 Shib1SessionInitiator(const DOMElement* e, const char* appId)
58 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator")), m_appId(appId) {
59 // If Location isn't set, defer address registration until the setParent call.
60 pair<bool,const char*> loc = getString("Location");
62 string address = m_appId + loc.second + "::run::Shib1SI";
63 setAddress(address.c_str());
66 virtual ~Shib1SessionInitiator() {}
68 void setParent(const PropertySet* parent);
69 void receive(DDF& in, ostream& out);
70 pair<bool,long> run(SPRequest& request, const char* entityID=NULL, bool isHandler=true) const;
73 pair<bool,long> doRequest(
74 const Application& application,
75 HTTPResponse& httpResponse,
77 const char* acsLocation,
83 #if defined (_MSC_VER)
84 #pragma warning( pop )
87 SessionInitiator* SHIBSP_DLLLOCAL Shib1SessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
89 return new Shib1SessionInitiator(p.first, p.second);
94 void Shib1SessionInitiator::setParent(const PropertySet* parent)
96 DOMPropertySet::setParent(parent);
97 pair<bool,const char*> loc = getString("Location");
99 string address = m_appId + loc.second + "::run::Shib1SI";
100 setAddress(address.c_str());
103 m_log.warn("no Location property in Shib1 SessionInitiator (or parent), can't register as remoted handler");
107 pair<bool,long> Shib1SessionInitiator::run(SPRequest& request, const char* entityID, bool isHandler) const
109 // We have to know the IdP to function.
110 if (!entityID || !*entityID)
111 return make_pair(false,0);
114 const Handler* ACS=NULL;
116 const Application& app=request.getApplication();
119 option=request.getParameter("acsIndex");
121 ACS = app.getAssertionConsumerServiceByIndex(atoi(option));
123 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using default ACS location");
126 option = request.getParameter("target");
130 // Since we're passing the ACS by value, we need to compute the return URL,
131 // so we'll need the target resource for real.
132 recoverRelayState(request.getApplication(), request, target, false);
135 // We're running as a "virtual handler" from within the filter.
136 // The target resource is the current one and everything else is defaulted.
137 target=request.getRequestURL();
140 // Since we're not passing by index, we need to fully compute the return URL.
142 pair<bool,unsigned int> index = getUnsignedInt("defaultACSIndex");
144 ACS = app.getAssertionConsumerServiceByIndex(index.second);
146 request.log(SPRequest::SPWarn, "invalid defaultACSIndex, using default ACS location");
149 ACS = app.getDefaultAssertionConsumerService();
152 // Compute the ACS URL. We add the ACS location to the base handlerURL.
153 string ACSloc=request.getHandlerURL(target.c_str());
154 pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
155 if (loc.first) ACSloc+=loc.second;
158 // We may already have RelayState set if we looped back here,
159 // but just in case target is a resource, we reset it back.
161 option = request.getParameter("target");
166 m_log.debug("attempting to initiate session using Shibboleth with provider (%s)", entityID);
168 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess))
169 return doRequest(app, request, entityID, ACSloc.c_str(), target);
172 DDF out,in = DDF(m_address.c_str()).structure();
173 DDFJanitor jin(in), jout(out);
174 in.addmember("application_id").string(app.getId());
175 in.addmember("entity_id").string(entityID);
176 in.addmember("acsLocation").string(ACSloc.c_str());
178 in.addmember("RelayState").string(target.c_str());
180 // Remote the processing.
181 out = request.getServiceProvider().getListenerService()->send(in);
182 return unwrap(request, out);
185 void Shib1SessionInitiator::receive(DDF& in, ostream& out)
188 const char* aid=in["application_id"].string();
189 const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
191 // Something's horribly wrong.
192 m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
193 throw ConfigurationException("Unable to locate application for new session, deleted?");
196 const char* entityID = in["entity_id"].string();
197 const char* acsLocation = in["acsLocation"].string();
198 if (!entityID || !acsLocation)
199 throw ConfigurationException("No entityID or acsLocation parameter supplied to remoted SessionInitiator.");
202 DDFJanitor jout(ret);
204 // Wrap the outgoing object with a Response facade.
205 auto_ptr<HTTPResponse> http(getResponse(ret));
207 string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
209 // Since we're remoted, the result should either be a throw, which we pass on,
210 // a false/0 return, which we just return as an empty structure, or a response/redirect,
211 // which we capture in the facade and send back.
212 doRequest(*app, *http.get(), entityID, acsLocation, relayState);
216 pair<bool,long> Shib1SessionInitiator::doRequest(
217 const Application& app,
218 HTTPResponse& httpResponse,
219 const char* entityID,
220 const char* acsLocation,
225 // Use metadata to invoke the SSO service directly.
226 MetadataProvider* m=app.getMetadataProvider();
228 const EntityDescriptor* entity=m->getEntityDescriptor(entityID);
230 m_log.error("unable to locate metadata for provider (%s)", entityID);
231 throw MetadataException("Unable to locate metadata for identity provider ($entityID)",
232 namedparams(1, "entityID", entityID));
234 const IDPSSODescriptor* role=entity->getIDPSSODescriptor(shibspconstants::SHIB1_PROTOCOL_ENUM);
236 m_log.error("unable to locate Shibboleth-aware identity provider role for provider (%s)", entityID);
237 return make_pair(false,0);
239 const EndpointType* ep=EndpointManager<SingleSignOnService>(role->getSingleSignOnServices()).getByBinding(
240 shibspconstants::SHIB1_AUTHNREQUEST_PROFILE_URI
243 m_log.error("unable to locate compatible SSO service for provider (%s)", entityID);
244 return make_pair(false,0);
247 preserveRelayState(app, httpResponse, relayState);
249 // Shib 1.x requires a target value.
250 if (relayState.empty())
251 relayState = "default";
254 sprintf(timebuf,"%lu",time(NULL));
255 const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
256 auto_ptr_char dest(ep->getLocation());
257 string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "shire=" + urlenc->encode(acsLocation) +
258 "&time=" + timebuf + "&target=" + urlenc->encode(relayState.c_str()) +
259 "&providerId=" + urlenc->encode(app.getString("entityID").second);
261 return make_pair(true, httpResponse.sendRedirect(req.c_str()));
263 return make_pair(false,0);