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>
65 using namespace shibsp;
66 using namespace xmltooling;
69 // macros to output text to client
70 #define NET_WRITE(str) \
71 if (IO_ERROR==net_write(sn->csd,str,strlen(str))) return REQ_EXIT
74 SPConfig* g_Config=NULL;
76 string g_ServerScheme;
77 string g_unsetHeaderValue;
78 bool g_checkSpoofing = true;
79 bool g_catchAll = false;
81 static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
82 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
85 PluginManager<RequestMapper,string,const xercesc::DOMElement*>::Factory SunRequestMapFactory;
87 extern "C" NSAPI_PUBLIC void nsapi_shib_exit(void*)
94 extern "C" NSAPI_PUBLIC int nsapi_shib_init(pblock* pb, ::Session* sn, Request* rq)
96 // Save off a default hostname for this virtual server.
97 char* name=pblock_findval("server-name",pb);
101 name=server_hostname;
105 name=util_hostname();
111 pblock_nvinsert("error","unable to determine web server hostname",pb);
116 name=pblock_findval("server-scheme",pb);
120 log_error(LOG_INFORM,"nsapi_shib_init",sn,rq,"nsapi_shib loaded for host (%s)",g_ServerName.c_str());
122 const char* schemadir=pblock_findval("shib-schemas",pb);
123 const char* prefix=pblock_findval("shib-prefix",pb);
125 g_Config=&SPConfig::getConfig();
126 g_Config->setFeatures(
129 SPConfig::RequestMapping |
130 SPConfig::InProcess |
134 if (!g_Config->init(schemadir,prefix)) {
136 pblock_nvinsert("error","unable to initialize Shibboleth libraries",pb);
140 g_Config->RequestMapperManager.registerFactory(XML_REQUEST_MAPPER,&SunRequestMapFactory);
142 const char* config=pblock_findval("shib-config",pb);
144 config=getenv("SHIBSP_CONFIG");
146 config=SHIBSP_CONFIG;
149 xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
150 XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
151 xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
152 auto_ptr_XMLCh src(config);
153 dummy->setAttributeNS(NULL,path,src.get());
154 dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
156 g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
157 g_Config->getServiceProvider()->init();
159 catch (exception& ex) {
160 pblock_nvinsert("error",ex.what(),pb);
166 daemon_atrestart(nsapi_shib_exit,NULL);
168 ServiceProvider* sp=g_Config->getServiceProvider();
170 const PropertySet* props=sp->getPropertySet("Local");
172 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
173 if (unsetValue.first)
174 g_unsetHeaderValue = unsetValue.second;
175 pair<bool,bool> flag=props->getBool("checkSpoofing");
176 g_checkSpoofing = !flag.first || flag.second;
177 flag=props->getBool("catchAll");
178 g_catchAll = flag.first && flag.second;
183 /********************************************************************************/
184 // NSAPI Shib Target Subclass
186 class ShibTargetNSAPI : public AbstractSPRequest
188 mutable string m_body;
189 mutable bool m_gotBody,m_firsttime;
190 mutable vector<string> m_certs;
191 set<string> m_allhttp;
198 ShibTargetNSAPI(pblock* pb, ::Session* sn, Request* rq)
199 : AbstractSPRequest(SHIBSP_LOGCAT".NSAPI"), m_gotBody(false), m_firsttime(true), m_pb(pb), m_sn(sn), m_rq(rq) {
201 const char* uri=pblock_findval("uri", rq->reqpb);
202 const char* qstr=pblock_findval("query", rq->reqpb);
205 string temp = string(uri) + '?' + qstr;
206 setRequestURI(temp.c_str());
212 // See if this is the first time we've run.
213 qstr = pblock_findval("auth-type", rq->vars);
214 if (qstr && !strcmp(qstr, "shibboleth"))
216 if (!m_firsttime || rq->orig_rq)
217 log(SPDebug, "nsapi_shib function running more than once");
219 ~ShibTargetNSAPI() { }
221 const char* getScheme() const {
222 return security_active ? "https" : "http";
224 const char* getHostname() const {
225 #ifdef vs_is_default_vs
226 // This is 6.0 or later, so we can distinguish requests to name-based vhosts.
227 if (!vs_is_default_vs(request_get_vs(m_rq)))
228 // The beauty here is, a non-default vhost can *only* be accessed if the client
229 // specified the exact name in the Host header. So we can trust the Host header.
230 return pblock_findval("host", m_rq->headers);
233 // In other cases, we're going to rely on the initialization process...
234 return g_ServerName.c_str();
236 int getPort() const {
237 return server_portnum;
239 const char* getMethod() const {
240 return pblock_findval("method", m_rq->reqpb);
242 string getContentType() const {
243 char* content_type = "";
244 request_header("content-type", &content_type, m_sn, m_rq);
247 long getContentLength() const {
249 return m_body.length();
250 char* content_length="";
251 request_header("content-length", &content_length, m_sn, m_rq);
252 return atoi(content_length);
254 string getRemoteAddr() const {
255 return pblock_findval("ip", m_sn->client);
257 void log(SPLogLevel level, const string& msg) const {
258 AbstractSPRequest::log(level,msg);
260 log_error(LOG_FAILURE, "nsapi_shib", m_sn, m_rq, const_cast<char*>(msg.c_str()));
262 const char* getQueryString() const {
263 return pblock_findval("query", m_rq->reqpb);
265 const char* getRequestBody() const {
267 return m_body.c_str();
268 char* content_length=NULL;
269 if (request_header("content-length", &content_length, m_sn, m_rq)!=REQ_PROCEED || atoi(content_length) > 1024*1024) // 1MB?
270 throw opensaml::SecurityPolicyException("Blocked request body exceeding 1M size limit.");
273 int cl=atoi(content_length);
275 while (cl && ch != IO_EOF) {
276 ch=netbuf_getc(m_sn->inbuf);
284 throw IOException("Error reading request body from browser.");
285 return m_body.c_str();
288 void clearHeader(const char* rawname, const char* cginame) {
289 if (g_checkSpoofing && m_firsttime && !m_rq->orig_rq) {
290 if (m_allhttp.empty()) {
291 // Populate the set of client-supplied headers for spoof checking.
292 const pb_entry* entry;
293 for (int i=0; i<m_rq->headers->hsize; ++i) {
294 entry = m_rq->headers->ht[i];
296 string cgiversion("HTTP_");
297 const char* pch = entry->param->name;
299 cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
302 m_allhttp.insert(cgiversion);
307 if (m_allhttp.count(cginame) > 0)
308 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
310 param_free(pblock_remove(rawname, m_rq->headers));
311 pblock_nvinsert(rawname, g_unsetHeaderValue.c_str(), m_rq->headers);
313 void setHeader(const char* name, const char* value) {
314 param_free(pblock_remove(name, m_rq->headers));
315 pblock_nvinsert(name, value, m_rq->headers);
317 string getHeader(const char* name) const {
318 // NSAPI headers tend to be lower case. We'll special case "cookie" since it's used a lot.
320 int cookie = strcmp(name, "Cookie");
323 if (request_header(const_cast<char*>(name), &hdr, m_sn, m_rq) != REQ_PROCEED) {
324 // We didn't get a hit, so we'll try a lower-casing operation, unless we already did...
329 n += tolower(*(name++));
330 if (request_header(const_cast<char*>(n.c_str()), &hdr, m_sn, m_rq) != REQ_PROCEED)
333 return string(hdr ? hdr : "");
335 void setRemoteUser(const char* user) {
336 pblock_nvinsert("auth-user", user, m_rq->vars);
338 string getRemoteUser() const {
339 const char* ru = pblock_findval("auth-user", m_rq->vars);
342 void setResponseHeader(const char* name, const char* value) {
343 pblock_nvinsert(name, value, m_rq->srvhdrs);
346 long sendResponse(istream& in, long status) {
351 msg.append(buf,in.gcount());
353 pblock_nvinsert("connection","close",m_rq->srvhdrs);
354 pblock_nninsert("content-length", msg.length(), m_rq->srvhdrs);
355 protocol_status(m_sn, m_rq, status, NULL);
356 protocol_start_response(m_sn, m_rq);
357 net_write(m_sn->csd,const_cast<char*>(msg.c_str()),msg.length());
360 long sendRedirect(const char* url) {
361 param_free(pblock_remove("content-type", m_rq->srvhdrs));
362 pblock_nninsert("content-length", 0, m_rq->srvhdrs);
363 pblock_nvinsert("expires", "01-Jan-1997 12:00:00 GMT", m_rq->srvhdrs);
364 pblock_nvinsert("cache-control", "private,no-store,no-cache", m_rq->srvhdrs);
365 pblock_nvinsert("location", url, m_rq->srvhdrs);
366 pblock_nvinsert("connection","close",m_rq->srvhdrs);
367 protocol_status(m_sn, m_rq, PROTOCOL_REDIRECT, NULL);
368 protocol_start_response(m_sn, m_rq);
371 long returnDecline() { return REQ_NOACTION; }
372 long returnOK() { return REQ_PROCEED; }
373 const vector<string>& getClientCertificates() const {
374 if (m_certs.empty()) {
375 const char* cert = pblock_findval("auth-cert", m_rq->vars);
377 m_certs.push_back(cert);
383 /********************************************************************************/
385 int WriteClientError(::Session* sn, Request* rq, char* func, char* msg)
387 log_error(LOG_FAILURE,func,sn,rq,msg);
388 protocol_status(sn,rq,PROTOCOL_SERVER_ERROR,msg);
393 #define FUNC "shibboleth"
394 extern "C" NSAPI_PUBLIC int nsapi_shib(pblock* pb, ::Session* sn, Request* rq)
396 ostringstream threadid;
397 threadid << "[" << getpid() << "] nsapi_shib" << '\0';
398 xmltooling::NDC ndc(threadid.str().c_str());
401 ShibTargetNSAPI stn(pb, sn, rq);
403 // Check user authentication
404 pair<bool,long> res = stn.getServiceProvider().doAuthentication(stn);
405 if (res.first) return (int)res.second;
407 // user authN was okay -- export the assertions now
408 param_free(pblock_remove("auth-user",rq->vars));
409 // This seems to be required in order to eventually set
410 // the auth-user var.
411 pblock_nvinsert("auth-type","shibboleth",rq->vars);
412 res = stn.getServiceProvider().doExport(stn);
413 if (res.first) return (int)res.second;
415 // Check the Authorization
416 res = stn.getServiceProvider().doAuthorization(stn);
417 if (res.first) return (int)res.second;
422 catch (exception& e) {
423 log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>(e.what()));
424 return WriteClientError(sn, rq, FUNC, "Shibboleth module threw an exception, see web server log for error.");
427 log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>("Shibboleth module threw an unknown exception."));
429 return WriteClientError(sn, rq, FUNC, "Shibboleth module threw an unknown exception.");
436 #define FUNC "shib_handler"
437 extern "C" NSAPI_PUBLIC int shib_handler(pblock* pb, ::Session* sn, Request* rq)
439 ostringstream threadid;
440 threadid << "[" << getpid() << "] shib_handler" << '\0';
441 xmltooling::NDC ndc(threadid.str().c_str());
444 ShibTargetNSAPI stn(pb, sn, rq);
446 pair<bool,long> res = stn.getServiceProvider().doHandler(stn);
447 if (res.first) return (int)res.second;
449 return WriteClientError(sn, rq, FUNC, "Shibboleth handler did not do anything.");
451 catch (exception& e) {
452 log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>(e.what()));
453 return WriteClientError(sn, rq, FUNC, "Shibboleth handler threw an exception, see web server log for error.");
457 return WriteClientError(sn, rq, FUNC, "Shibboleth handler threw an unknown exception.");
463 class SunRequestMapper : public virtual RequestMapper, public virtual PropertySet
466 SunRequestMapper(const xercesc::DOMElement* e);
467 ~SunRequestMapper() { delete m_mapper; delete m_stKey; delete m_propsKey; }
468 Lockable* lock() { return m_mapper->lock(); }
469 void unlock() { m_stKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
470 Settings getSettings(const HTTPRequest& request) const;
472 const PropertySet* getParent() const { return NULL; }
473 void setParent(const PropertySet*) {}
474 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
475 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
476 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
477 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
478 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
479 void getAll(map<string,const char*>& properties) const;
480 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
481 const xercesc::DOMElement* getElement() const;
484 RequestMapper* m_mapper;
486 ThreadKey* m_propsKey;
489 RequestMapper* SunRequestMapFactory(const xercesc::DOMElement* const & e)
491 return new SunRequestMapper(e);
494 SunRequestMapper::SunRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_stKey(NULL), m_propsKey(NULL)
496 m_mapper = SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
497 m_stKey=ThreadKey::create(NULL);
498 m_propsKey=ThreadKey::create(NULL);
501 RequestMapper::Settings SunRequestMapper::getSettings(const HTTPRequest& request) const
503 Settings s=m_mapper->getSettings(request);
504 m_stKey->setData((void*)dynamic_cast<const ShibTargetNSAPI*>(&request));
505 m_propsKey->setData((void*)s.first);
506 return pair<const PropertySet*,AccessControl*>(this,s.second);
509 pair<bool,bool> SunRequestMapper::getBool(const char* name, const char* ns) const
511 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
512 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
513 if (stn && !ns && name) {
514 // Override boolean properties.
515 const char* param=pblock_findval(name,stn->m_pb);
516 if (param && (!strcmp(param,"1") || !strcasecmp(param,"true")))
517 return make_pair(true,true);
519 return s ? s->getBool(name,ns) : make_pair(false,false);
522 pair<bool,const char*> SunRequestMapper::getString(const char* name, const char* ns) const
524 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
525 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
526 if (stn && !ns && name) {
527 // Override string properties.
528 if (!strcmp(name,"authType"))
529 return pair<bool,const char*>(true,"shibboleth");
531 const char* param=pblock_findval(name,stn->m_pb);
533 return make_pair(true,param);
536 return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
539 pair<bool,const XMLCh*> SunRequestMapper::getXMLString(const char* name, const char* ns) const
541 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
542 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
545 pair<bool,unsigned int> SunRequestMapper::getUnsignedInt(const char* name, const char* ns) const
547 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
548 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
549 if (stn && !ns && name) {
550 // Override int properties.
551 const char* param=pblock_findval(name,stn->m_pb);
553 return pair<bool,unsigned int>(true,strtol(param,NULL,10));
555 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
558 pair<bool,int> SunRequestMapper::getInt(const char* name, const char* ns) const
560 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
561 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
562 if (stn && !ns && name) {
563 // Override int properties.
564 const char* param=pblock_findval(name,stn->m_pb);
566 return pair<bool,int>(true,atoi(param));
568 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
571 void SunRequestMapper::getAll(map<string,const char*>& properties) const
573 const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
574 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
576 s->getAll(properties);
579 properties["authType"] = "shibboleth";
580 const pb_entry* entry;
581 for (int i=0; i<stn->m_pb->hsize; ++i) {
582 entry = stn->m_pb->ht[i];
584 properties[entry->param->name] = entry->param->value;
590 const PropertySet* SunRequestMapper::getPropertySet(const char* name, const char* ns) const
592 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
593 return s ? s->getPropertySet(name,ns) : NULL;
596 const xercesc::DOMElement* SunRequestMapper::getElement() const
598 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
599 return s ? s->getElement() : NULL;