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 * Shibboleth NSAPI filter
25 #if defined (_MSC_VER) || defined(__BORLANDC__)
26 # include "config_win32.h"
32 # define _CRT_NONSTDC_NO_DEPRECATE 1
33 # define _CRT_SECURE_NO_DEPRECATE 1
36 #include <shibsp/AbstractSPRequest.h>
37 #include <shibsp/RequestMapper.h>
38 #include <shibsp/SPConfig.h>
39 #include <shibsp/ServiceProvider.h>
40 #include <xmltooling/XMLToolingConfig.h>
41 #include <xmltooling/util/NDC.h>
42 #include <xmltooling/util/Threads.h>
43 #include <xmltooling/util/XMLConstants.h>
44 #include <xmltooling/util/XMLHelper.h>
45 #include <xercesc/util/XMLUniDefs.hpp>
67 using namespace shibsp;
68 using namespace xmltooling;
71 // macros to output text to client
72 #define NET_WRITE(str) \
73 if (IO_ERROR==net_write(sn->csd,str,strlen(str))) return REQ_EXIT
76 SPConfig* g_Config=NULL;
78 string g_ServerScheme;
79 string g_unsetHeaderValue;
80 bool g_checkSpoofing = true;
81 bool g_catchAll = false;
83 static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
84 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
87 PluginManager<RequestMapper,string,const xercesc::DOMElement*>::Factory SunRequestMapFactory;
89 extern "C" NSAPI_PUBLIC void nsapi_shib_exit(void*)
96 extern "C" NSAPI_PUBLIC int nsapi_shib_init(pblock* pb, ::Session* sn, Request* rq)
98 // Save off a default hostname for this virtual server.
99 char* name=pblock_findval("server-name",pb);
103 name=server_hostname;
107 name=util_hostname();
113 pblock_nvinsert("error","unable to determine web server hostname",pb);
118 name=pblock_findval("server-scheme",pb);
122 log_error(LOG_INFORM,"nsapi_shib_init",sn,rq,"nsapi_shib loaded for host (%s)",g_ServerName.c_str());
124 const char* schemadir=pblock_findval("shib-schemas",pb);
125 const char* prefix=pblock_findval("shib-prefix",pb);
127 g_Config=&SPConfig::getConfig();
128 g_Config->setFeatures(
131 SPConfig::RequestMapping |
132 SPConfig::InProcess |
136 if (!g_Config->init(schemadir,prefix)) {
138 pblock_nvinsert("error","unable to initialize Shibboleth libraries",pb);
142 g_Config->RequestMapperManager.registerFactory(XML_REQUEST_MAPPER,&SunRequestMapFactory);
145 if (!g_Config->instantiate(pblock_findval("shib-config",pb), true))
146 throw runtime_error("unknown error");
148 catch (exception& ex) {
149 pblock_nvinsert("error",ex.what(),pb);
155 daemon_atrestart(nsapi_shib_exit,NULL);
157 ServiceProvider* sp=g_Config->getServiceProvider();
159 const PropertySet* props=sp->getPropertySet("Local");
161 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
162 if (unsetValue.first)
163 g_unsetHeaderValue = unsetValue.second;
164 pair<bool,bool> flag=props->getBool("checkSpoofing");
165 g_checkSpoofing = !flag.first || flag.second;
166 flag=props->getBool("catchAll");
167 g_catchAll = flag.first && flag.second;
172 /********************************************************************************/
173 // NSAPI Shib Target Subclass
175 class ShibTargetNSAPI : public AbstractSPRequest
177 mutable string m_body;
178 mutable bool m_gotBody,m_firsttime;
179 mutable vector<string> m_certs;
180 set<string> m_allhttp;
187 ShibTargetNSAPI(pblock* pb, ::Session* sn, Request* rq)
188 : AbstractSPRequest(SHIBSP_LOGCAT".NSAPI"), m_gotBody(false), m_firsttime(true), m_pb(pb), m_sn(sn), m_rq(rq) {
190 const char* uri=pblock_findval("uri", rq->reqpb);
191 const char* qstr=pblock_findval("query", rq->reqpb);
194 string temp = string(uri) + '?' + qstr;
195 setRequestURI(temp.c_str());
201 // See if this is the first time we've run.
202 qstr = pblock_findval("auth-type", rq->vars);
203 if (qstr && !strcmp(qstr, "shibboleth"))
205 if (!m_firsttime || rq->orig_rq)
206 log(SPDebug, "nsapi_shib function running more than once");
208 ~ShibTargetNSAPI() { }
210 const char* getScheme() const {
211 return security_active ? "https" : "http";
213 const char* getHostname() const {
214 #ifdef vs_is_default_vs
215 // This is 6.0 or later, so we can distinguish requests to name-based vhosts.
216 if (!vs_is_default_vs(request_get_vs(m_rq)))
217 // The beauty here is, a non-default vhost can *only* be accessed if the client
218 // specified the exact name in the Host header. So we can trust the Host header.
219 return pblock_findval("host", m_rq->headers);
222 // In other cases, we're going to rely on the initialization process...
223 return g_ServerName.c_str();
225 int getPort() const {
226 return server_portnum;
228 const char* getMethod() const {
229 return pblock_findval("method", m_rq->reqpb);
231 string getContentType() const {
232 char* content_type = "";
233 request_header("content-type", &content_type, m_sn, m_rq);
236 long getContentLength() const {
238 return m_body.length();
239 char* content_length="";
240 request_header("content-length", &content_length, m_sn, m_rq);
241 return atoi(content_length);
243 string getRemoteAddr() const {
244 return pblock_findval("ip", m_sn->client);
246 void log(SPLogLevel level, const string& msg) const {
247 AbstractSPRequest::log(level,msg);
249 log_error(LOG_FAILURE, "nsapi_shib", m_sn, m_rq, const_cast<char*>(msg.c_str()));
251 const char* getQueryString() const {
252 return pblock_findval("query", m_rq->reqpb);
254 const char* getRequestBody() const {
256 return m_body.c_str();
257 char* content_length=NULL;
258 if (request_header("content-length", &content_length, m_sn, m_rq)!=REQ_PROCEED || atoi(content_length) > 1024*1024) // 1MB?
259 throw opensaml::SecurityPolicyException("Blocked request body exceeding 1M size limit.");
262 int cl=atoi(content_length);
264 while (cl && ch != IO_EOF) {
265 ch=netbuf_getc(m_sn->inbuf);
273 throw IOException("Error reading request body from browser.");
274 return m_body.c_str();
277 void clearHeader(const char* rawname, const char* cginame) {
278 if (g_checkSpoofing && m_firsttime && !m_rq->orig_rq) {
279 if (m_allhttp.empty()) {
280 // Populate the set of client-supplied headers for spoof checking.
281 const pb_entry* entry;
282 for (int i=0; i<m_rq->headers->hsize; ++i) {
283 entry = m_rq->headers->ht[i];
285 string cgiversion("HTTP_");
286 const char* pch = entry->param->name;
288 cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
291 m_allhttp.insert(cgiversion);
296 if (m_allhttp.count(cginame) > 0)
297 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
299 param_free(pblock_remove(rawname, m_rq->headers));
300 pblock_nvinsert(rawname, g_unsetHeaderValue.c_str(), m_rq->headers);
302 void setHeader(const char* name, const char* value) {
303 param_free(pblock_remove(name, m_rq->headers));
304 pblock_nvinsert(name, value, m_rq->headers);
306 string getHeader(const char* name) const {
307 // NSAPI headers tend to be lower case. We'll special case "cookie" since it's used a lot.
309 int cookie = strcmp(name, "Cookie");
312 if (request_header(const_cast<char*>(name), &hdr, m_sn, m_rq) != REQ_PROCEED) {
313 // We didn't get a hit, so we'll try a lower-casing operation, unless we already did...
318 n += tolower(*(name++));
319 if (request_header(const_cast<char*>(n.c_str()), &hdr, m_sn, m_rq) != REQ_PROCEED)
322 return string(hdr ? hdr : "");
324 void setRemoteUser(const char* user) {
325 pblock_nvinsert("auth-user", user, m_rq->vars);
327 string getRemoteUser() const {
328 const char* ru = pblock_findval("auth-user", m_rq->vars);
331 void setResponseHeader(const char* name, const char* value) {
332 pblock_nvinsert(name, value, m_rq->srvhdrs);
335 long sendResponse(istream& in, long status) {
340 msg.append(buf,in.gcount());
342 pblock_nvinsert("connection","close",m_rq->srvhdrs);
343 pblock_nninsert("content-length", msg.length(), m_rq->srvhdrs);
344 protocol_status(m_sn, m_rq, status, NULL);
345 protocol_start_response(m_sn, m_rq);
346 net_write(m_sn->csd,const_cast<char*>(msg.c_str()),msg.length());
349 long sendRedirect(const char* url) {
350 param_free(pblock_remove("content-type", m_rq->srvhdrs));
351 pblock_nninsert("content-length", 0, m_rq->srvhdrs);
352 pblock_nvinsert("expires", "01-Jan-1997 12:00:00 GMT", m_rq->srvhdrs);
353 pblock_nvinsert("cache-control", "private,no-store,no-cache", m_rq->srvhdrs);
354 pblock_nvinsert("location", url, m_rq->srvhdrs);
355 pblock_nvinsert("connection","close",m_rq->srvhdrs);
356 protocol_status(m_sn, m_rq, PROTOCOL_REDIRECT, NULL);
357 protocol_start_response(m_sn, m_rq);
360 long returnDecline() { return REQ_NOACTION; }
361 long returnOK() { return REQ_PROCEED; }
362 const vector<string>& getClientCertificates() const {
363 if (m_certs.empty()) {
364 const char* cert = pblock_findval("auth-cert", m_rq->vars);
366 m_certs.push_back(cert);
372 /********************************************************************************/
374 int WriteClientError(::Session* sn, Request* rq, char* func, char* msg)
376 log_error(LOG_FAILURE,func,sn,rq,msg);
377 protocol_status(sn,rq,PROTOCOL_SERVER_ERROR,msg);
382 #define FUNC "shibboleth"
383 extern "C" NSAPI_PUBLIC int nsapi_shib(pblock* pb, ::Session* sn, Request* rq)
385 ostringstream threadid;
386 threadid << "[" << getpid() << "] nsapi_shib" << '\0';
387 xmltooling::NDC ndc(threadid.str().c_str());
390 ShibTargetNSAPI stn(pb, sn, rq);
392 // Check user authentication
393 pair<bool,long> res = stn.getServiceProvider().doAuthentication(stn);
394 if (res.first) return (int)res.second;
396 // user authN was okay -- export the assertions now
397 param_free(pblock_remove("auth-user",rq->vars));
398 // This seems to be required in order to eventually set
399 // the auth-user var.
400 pblock_nvinsert("auth-type","shibboleth",rq->vars);
401 res = stn.getServiceProvider().doExport(stn);
402 if (res.first) return (int)res.second;
404 // Check the Authorization
405 res = stn.getServiceProvider().doAuthorization(stn);
406 if (res.first) return (int)res.second;
411 catch (exception& e) {
412 log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>(e.what()));
413 return WriteClientError(sn, rq, FUNC, "Shibboleth module threw an exception, see web server log for error.");
416 log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>("Shibboleth module threw an unknown exception."));
418 return WriteClientError(sn, rq, FUNC, "Shibboleth module threw an unknown exception.");
425 #define FUNC "shib_handler"
426 extern "C" NSAPI_PUBLIC int shib_handler(pblock* pb, ::Session* sn, Request* rq)
428 ostringstream threadid;
429 threadid << "[" << getpid() << "] shib_handler" << '\0';
430 xmltooling::NDC ndc(threadid.str().c_str());
433 ShibTargetNSAPI stn(pb, sn, rq);
435 pair<bool,long> res = stn.getServiceProvider().doHandler(stn);
436 if (res.first) return (int)res.second;
438 return WriteClientError(sn, rq, FUNC, "Shibboleth handler did not do anything.");
440 catch (exception& e) {
441 log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>(e.what()));
442 return WriteClientError(sn, rq, FUNC, "Shibboleth handler threw an exception, see web server log for error.");
446 return WriteClientError(sn, rq, FUNC, "Shibboleth handler threw an unknown exception.");
452 class SunRequestMapper : public virtual RequestMapper, public virtual PropertySet
455 SunRequestMapper(const xercesc::DOMElement* e);
456 ~SunRequestMapper() { delete m_mapper; delete m_stKey; delete m_propsKey; }
457 Lockable* lock() { return m_mapper->lock(); }
458 void unlock() { m_stKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
459 Settings getSettings(const HTTPRequest& request) const;
461 const PropertySet* getParent() const { return NULL; }
462 void setParent(const PropertySet*) {}
463 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
464 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
465 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
466 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
467 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
468 void getAll(map<string,const char*>& properties) const;
469 const PropertySet* getPropertySet(const char* name, const char* ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const;
470 const xercesc::DOMElement* getElement() const;
473 RequestMapper* m_mapper;
475 ThreadKey* m_propsKey;
478 RequestMapper* SunRequestMapFactory(const xercesc::DOMElement* const & e)
480 return new SunRequestMapper(e);
483 SunRequestMapper::SunRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_stKey(NULL), m_propsKey(NULL)
485 m_mapper = SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
486 m_stKey=ThreadKey::create(NULL);
487 m_propsKey=ThreadKey::create(NULL);
490 RequestMapper::Settings SunRequestMapper::getSettings(const HTTPRequest& request) const
492 Settings s=m_mapper->getSettings(request);
493 m_stKey->setData((void*)dynamic_cast<const ShibTargetNSAPI*>(&request));
494 m_propsKey->setData((void*)s.first);
495 return pair<const PropertySet*,AccessControl*>(this,s.second);
498 pair<bool,bool> SunRequestMapper::getBool(const char* name, const char* ns) const
500 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
501 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
502 if (stn && !ns && name) {
503 // Override boolean properties.
504 const char* param=pblock_findval(name,stn->m_pb);
505 if (param && (!strcmp(param,"1") || !strcasecmp(param,"true")))
506 return make_pair(true,true);
508 return s ? s->getBool(name,ns) : make_pair(false,false);
511 pair<bool,const char*> SunRequestMapper::getString(const char* name, const char* ns) const
513 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
514 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
515 if (stn && !ns && name) {
516 // Override string properties.
517 if (!strcmp(name,"authType"))
518 return pair<bool,const char*>(true,"shibboleth");
520 const char* param=pblock_findval(name,stn->m_pb);
522 return make_pair(true,param);
525 return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
528 pair<bool,const XMLCh*> SunRequestMapper::getXMLString(const char* name, const char* ns) const
530 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
531 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
534 pair<bool,unsigned int> SunRequestMapper::getUnsignedInt(const char* name, const char* ns) const
536 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
537 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
538 if (stn && !ns && name) {
539 // Override int properties.
540 const char* param=pblock_findval(name,stn->m_pb);
542 return pair<bool,unsigned int>(true,strtol(param,NULL,10));
544 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
547 pair<bool,int> SunRequestMapper::getInt(const char* name, const char* ns) const
549 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
550 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
551 if (stn && !ns && name) {
552 // Override int properties.
553 const char* param=pblock_findval(name,stn->m_pb);
555 return pair<bool,int>(true,atoi(param));
557 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
560 void SunRequestMapper::getAll(map<string,const char*>& properties) const
562 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
563 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
565 s->getAll(properties);
568 properties["authType"] = "shibboleth";
569 const pb_entry* entry;
570 for (int i=0; i<stn->m_pb->hsize; ++i) {
571 entry = stn->m_pb->ht[i];
573 properties[entry->param->name] = entry->param->value;
579 const PropertySet* SunRequestMapper::getPropertySet(const char* name, const char* ns) const
581 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
582 return s ? s->getPropertySet(name,ns) : NULL;
585 const xercesc::DOMElement* SunRequestMapper::getElement() const
587 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
588 return s ? s->getElement() : NULL;