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 * AbstractSPRequest.cpp
20 * Abstract base for SPRequest implementations
24 #include "AbstractSPRequest.h"
25 #include "Application.h"
26 #include "ServiceProvider.h"
27 #include "SessionCache.h"
29 #include <log4cpp/Category.hh>
31 using namespace shibsp;
32 using namespace opensaml;
33 using namespace xmltooling;
34 using namespace log4cpp;
37 AbstractSPRequest::AbstractSPRequest()
38 : m_sp(NULL), m_mapper(NULL), m_app(NULL), m_sessionTried(false), m_session(NULL),
39 m_log(&Category::getInstance(SHIBSP_LOGCAT".SPRequest")), m_parser(NULL)
41 m_sp=SPConfig::getConfig().getServiceProvider();
45 AbstractSPRequest::~AbstractSPRequest()
56 RequestMapper::Settings AbstractSPRequest::getRequestSettings() const
61 // Map request to application and content settings.
62 m_mapper=m_sp->getRequestMapper();
64 return m_settings = m_mapper->getSettings(*this);
68 const Application& AbstractSPRequest::getApplication() const
71 // Now find the application from the URL settings
72 m_app=m_sp->getApplication(getRequestSettings().first->getString("applicationId").second);
74 throw ConfigurationException("Unable to map request to application settings, check configuration.");
79 Session* AbstractSPRequest::getSession() const
81 // Only attempt this once.
84 m_sessionTried = true;
86 // Get session ID from cookie.
87 const Application& app = getApplication();
88 pair<string,const char*> shib_cookie = app.getCookieNameProps("_shibsession_");
89 const char* session_id = getCookie(shib_cookie.first.c_str());
90 if (!session_id || !*session_id)
93 // Need address checking and timeout settings.
96 const PropertySet* props=app.getPropertySet("Sessions");
98 pair<bool,unsigned int> p=props->getUnsignedInt("timeout");
101 pair<bool,bool> pcheck=props->getBool("consistentAddress");
103 consistent = pcheck.second;
106 // The cache will either silently pass a session or NULL back, or throw an exception out.
107 return m_session = getServiceProvider().getSessionCache()->find(
108 session_id, app, consistent ? getRemoteAddr().c_str() : NULL, timeout
112 const char* AbstractSPRequest::getRequestURL() const {
114 // Compute the full target URL
115 int port = getPort();
116 const char* scheme = getScheme();
117 m_url = string(scheme) + "://" + getHostname();
118 if ((!strcmp(scheme,"http") && port!=80) || (!strcmp(scheme,"https") && port!=443)) {
119 ostringstream portstr;
121 m_url += ":" + portstr.str();
123 scheme = getRequestURI();
127 return m_url.c_str();
130 const char* AbstractSPRequest::getParameter(const char* name) const
133 m_parser=new CGIParser(*this);
135 pair<CGIParser::walker,CGIParser::walker> bounds=m_parser->getParameters(name);
136 return (bounds.first==bounds.second) ? NULL : bounds.first->second;
139 vector<const char*>::size_type AbstractSPRequest::getParameters(const char* name, vector<const char*>& values) const
142 m_parser=new CGIParser(*this);
144 pair<CGIParser::walker,CGIParser::walker> bounds=m_parser->getParameters(name);
145 while (bounds.first!=bounds.second) {
146 values.push_back(bounds.first->second);
149 return values.size();
152 const char* AbstractSPRequest::getCookie(const char* name) const
154 if (m_cookieMap.empty()) {
155 string cookies=getHeader("Cookie");
157 string::size_type pos=0,cname,namelen,val,vallen;
158 while (pos !=string::npos && pos < cookies.length()) {
159 while (isspace(cookies[pos])) pos++;
161 pos=cookies.find_first_of("=",pos);
162 if (pos == string::npos)
166 if (pos==cookies.length())
169 pos=cookies.find_first_of(";",pos);
170 if (pos != string::npos) {
173 m_cookieMap.insert(make_pair(cookies.substr(cname,namelen),cookies.substr(val,vallen)));
176 m_cookieMap.insert(make_pair(cookies.substr(cname,namelen),cookies.substr(val)));
179 map<string,string>::const_iterator lookup=m_cookieMap.find(name);
180 return (lookup==m_cookieMap.end()) ? NULL : lookup->second.c_str();
183 const char* AbstractSPRequest::getHandlerURL(const char* resource) const
185 if (!m_handlerURL.empty() && resource && !strcmp(getRequestURL(),resource))
186 return m_handlerURL.c_str();
188 #ifdef HAVE_STRCASECMP
189 if (!resource || (strncasecmp(resource,"http://",7) && strncasecmp(resource,"https://",8)))
191 if (!resource || (strnicmp(resource,"http://",7) && strnicmp(resource,"https://",8)))
193 throw ConfigurationException("Target resource was not an absolute URL.");
196 const char* handler=NULL;
197 const PropertySet* props=m_app->getPropertySet("Sessions");
199 pair<bool,bool> p=props->getBool("handlerSSL");
202 pair<bool,const char*> p2=props->getString("handlerURL");
207 // Should never happen...
208 if (!handler || (*handler!='/' && strncmp(handler,"http:",5) && strncmp(handler,"https:",6)))
209 throw ConfigurationException(
210 "Invalid handlerURL property ($1) in Application ($2)",
211 params(2, handler ? handler : "null", m_app->getId())
214 // The "handlerURL" property can be in one of three formats:
216 // 1) a full URI: http://host/foo/bar
217 // 2) a hostless URI: http:///foo/bar
218 // 3) a relative path: /foo/bar
220 // # Protocol Host Path
221 // 1 handler handler handler
222 // 2 handler resource handler
223 // 3 resource resource handler
225 // note: if ssl_only is true, make sure the protocol is https
227 const char* path = NULL;
229 // Decide whether to use the handler or the resource for the "protocol"
231 if (*handler != '/') {
239 // break apart the "protocol" string into protocol, host, and "the rest"
240 const char* colon=strchr(prot,':');
242 const char* slash=strchr(colon,'/');
246 // Compute the actual protocol and store in member.
248 m_handlerURL.assign("https://");
250 m_handlerURL.assign(prot, colon-prot);
252 // create the "host" from either the colon/slash or from the target string
253 // If prot == handler then we're in either #1 or #2, else #3.
254 // If slash == colon then we're in #2.
255 if (prot != handler || slash == colon) {
256 colon = strchr(resource, ':');
257 colon += 3; // Get past the ://
258 slash = strchr(colon, '/');
260 string host(colon, (slash ? slash-colon : strlen(colon)));
262 // Build the handler URL
263 m_handlerURL += host + path;
264 return m_handlerURL.c_str();
267 void AbstractSPRequest::log(SPLogLevel level, const std::string& msg) const
269 reinterpret_cast<Category*>(m_log)->log(
270 (level == SPDebug ? log4cpp::Priority::DEBUG :
271 (level == SPInfo ? log4cpp::Priority::INFO :
272 (level == SPWarn ? log4cpp::Priority::WARN :
273 (level == SPError ? log4cpp::Priority::ERROR : log4cpp::Priority::CRIT)))),
278 bool AbstractSPRequest::isPriorityEnabled(SPLogLevel level) const
280 return reinterpret_cast<Category*>(m_log)->isPriorityEnabled(
281 (level == SPDebug ? log4cpp::Priority::DEBUG :
282 (level == SPInfo ? log4cpp::Priority::INFO :
283 (level == SPWarn ? log4cpp::Priority::WARN :
284 (level == SPError ? log4cpp::Priority::ERROR : log4cpp::Priority::CRIT))))