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 * SAMLDSSessionInitiator.cpp
20 * SAML Discovery Service support.
24 #include "Application.h"
25 #include "exceptions.h"
26 #include "SPRequest.h"
27 #include "handler/AbstractHandler.h"
28 #include "handler/SessionInitiator.h"
30 #include <xmltooling/XMLToolingConfig.h>
31 #include <xmltooling/util/URLEncoder.h>
33 using namespace shibsp;
34 using namespace opensaml;
35 using namespace xmltooling;
40 #if defined (_MSC_VER)
41 #pragma warning( push )
42 #pragma warning( disable : 4250 )
45 class SHIBSP_DLLLOCAL SAMLDSSessionInitiator : public SessionInitiator, public AbstractHandler
48 SAMLDSSessionInitiator(const DOMElement* e, const char* appId)
49 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.SAMLDS")), m_url(NULL), m_returnParam(NULL) {
50 pair<bool,const char*> url = getString("URL");
52 throw ConfigurationException("SAMLDS SessionInitiator requires a URL property.");
54 url = getString("entityIDParam");
56 m_returnParam = url.second;
58 virtual ~SAMLDSSessionInitiator() {}
60 pair<bool,long> run(SPRequest& request, const char* entityID=NULL, bool isHandler=true) const;
64 const char* m_returnParam;
67 #if defined (_MSC_VER)
68 #pragma warning( pop )
71 SessionInitiator* SHIBSP_DLLLOCAL SAMLDSSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
73 return new SAMLDSSessionInitiator(p.first, p.second);
78 pair<bool,long> SAMLDSSessionInitiator::run(SPRequest& request, const char* entityID, bool isHandler) const
80 // The IdP CANNOT be specified for us to run. Otherwise, we'd be redirecting to a DS
81 // anytime the IdP's metadata was wrong.
82 if (entityID && *entityID)
83 return make_pair(false,0L);
88 const Application& app=request.getApplication();
91 option = request.getParameter("SAMLDS");
92 if (option && !strcmp(option,"1")) {
93 saml2md::MetadataException ex("No identity provider was selected by user.");
94 ex.addProperty("statusCode", "urn:oasis:names:tc:SAML:2.0:status:Requester");
95 ex.addProperty("statusCode2", "urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP");
99 option = request.getParameter("target");
102 recoverRelayState(request.getApplication(), request, request, target, false);
104 option = request.getParameter("isPassive");
106 isPassive = !strcmp(option,"true");
109 // We're running as a "virtual handler" from within the filter.
110 // The target resource is the current one and everything else is
111 // defaulted or set by content policy.
112 target=request.getRequestURL();
113 pair<bool,bool> passopt = getBool("isPassive");
114 isPassive = passopt.first && passopt.second;
117 m_log.debug("sending request to SAMLDS (%s)", m_url);
119 // Compute the return URL. We start with a self-referential link.
120 string returnURL=request.getHandlerURL(target.c_str());
121 pair<bool,const char*> thisloc = getString("Location");
122 if (thisloc.first) returnURL += thisloc.second;
123 returnURL += "?SAMLDS=1"; // signals us not to loop if we get no answer back
126 // We may already have RelayState set if we looped back here,
127 // but just in case target is a resource, we reset it back.
128 option = request.getParameter("target");
132 preserveRelayState(request.getApplication(), request, target);
134 const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
136 // Now the hard part. The base assumption is to append the entire query string, if any,
137 // to the self-link. But we want to replace target with the RelayState-preserved value
138 // to hide it from the DS.
139 const char* query = request.getQueryString();
141 // See if it starts with target.
142 if (!strncmp(query, "target=", 7)) {
143 // We skip this altogether and advance the query past it to the first separator.
144 query = strchr(query, '&');
145 // If we still have more, just append it.
146 if (query && *(++query))
147 returnURL = returnURL + '&' + query;
150 // There's something in the query before target appears, so we have to find it.
151 thisloc.second = strstr(query,"&target=");
152 if (thisloc.second) {
153 // We found it, so first append everything up to it.
155 returnURL.append(query, thisloc.second - query);
156 query = thisloc.second + 8; // move up just past the equals sign.
157 thisloc.second = strchr(query, '&');
159 returnURL += thisloc.second;
162 // No target in the existing query, so just append it as is.
163 returnURL = returnURL + '&' + query;
168 // Now append the sanitized target as needed.
170 returnURL = returnURL + "&target=" + urlenc->encode(target.c_str());
172 else if (!target.empty()) {
173 // For a virtual handler, we just append target to the return link.
174 returnURL = returnURL + "&target=" + urlenc->encode(target.c_str());;
177 string req=string(m_url) + (strchr(m_url,'?') ? '&' : '?') + "entityID=" + urlenc->encode(app.getString("entityID").second) +
178 "&return=" + urlenc->encode(returnURL.c_str());
180 req = req + "&returnIDParam=" + m_returnParam;
182 req += "&isPassive=true";
184 return make_pair(true, request.sendRedirect(req.c_str()));