Adjust logging categories.
[shibboleth/sp.git] / nsapi_shib / nsapi_shib.cpp
1 /*
2  *  Copyright 2001-2007 Internet2
3  * 
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
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 /**
18  * nsapi_shib.cpp
19  * 
20  * Shibboleth NSAPI filter
21  */
22
23 #define SHIBSP_LITE
24
25 #if defined (_MSC_VER) || defined(__BORLANDC__)
26 # include "config_win32.h"
27 #else
28 # include "config.h"
29 #endif
30
31 #ifdef WIN32
32 # define _CRT_NONSTDC_NO_DEPRECATE 1
33 # define _CRT_SECURE_NO_DEPRECATE 1
34 #endif
35
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>
46
47 #include <fstream>
48 #include <sstream>
49
50 #ifdef WIN32
51 # include <process.h>
52 # define XP_WIN32
53 #else
54 # define XP_UNIX
55 #endif
56
57 #define MCC_HTTPD
58 #define NET_SSL
59
60 extern "C"
61 {
62 #include <nsapi.h>
63 }
64
65 using namespace shibsp;
66 using namespace xmltooling;
67 using namespace std;
68
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
72
73 namespace {
74     SPConfig* g_Config=NULL;
75     string g_ServerName;
76     string g_ServerScheme;
77     string g_unsetHeaderValue;
78     bool g_checkSpoofing = true;
79     bool g_catchAll = false;
80
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);
83 }
84
85 PluginManager<RequestMapper,string,const xercesc::DOMElement*>::Factory SunRequestMapFactory;
86
87 extern "C" NSAPI_PUBLIC void nsapi_shib_exit(void*)
88 {
89     if (g_Config)
90         g_Config->term();
91     g_Config = NULL;
92 }
93
94 extern "C" NSAPI_PUBLIC int nsapi_shib_init(pblock* pb, ::Session* sn, Request* rq)
95 {
96     // Save off a default hostname for this virtual server.
97     char* name=pblock_findval("server-name",pb);
98     if (name)
99         g_ServerName=name;
100     else {
101         name=server_hostname;
102         if (name)
103             g_ServerName=name;
104         else {
105             name=util_hostname();
106             if (name) {
107                 g_ServerName=name;
108                 FREE(name);
109             }
110             else {
111                 pblock_nvinsert("error","unable to determine web server hostname",pb);
112                 return REQ_ABORTED;
113             }
114         }
115     }
116     name=pblock_findval("server-scheme",pb);
117     if (name)
118         g_ServerScheme=name;
119
120     log_error(LOG_INFORM,"nsapi_shib_init",sn,rq,"nsapi_shib loaded for host (%s)",g_ServerName.c_str());
121
122     const char* schemadir=pblock_findval("shib-schemas",pb);
123     if (!schemadir)
124         schemadir=getenv("SHIBSP_SCHEMAS");
125     if (!schemadir)
126         schemadir=SHIBSP_SCHEMAS;
127     const char* config=pblock_findval("shib-config",pb);
128     if (!config)
129         config=getenv("SHIBSP_CONFIG");
130     if (!config)
131         config=SHIBSP_CONFIG;
132     g_Config=&SPConfig::getConfig();
133     g_Config->setFeatures(
134         SPConfig::Listener |
135         SPConfig::Caching |
136         SPConfig::RequestMapping |
137         SPConfig::InProcess |
138         SPConfig::Logging |
139         SPConfig::Handlers
140         );
141     if (!g_Config->init(schemadir)) {
142         g_Config=NULL;
143         pblock_nvinsert("error","unable to initialize Shibboleth libraries",pb);
144         return REQ_ABORTED;
145     }
146
147     g_Config->RequestMapperManager.registerFactory(XML_REQUEST_MAPPER,&SunRequestMapFactory);
148
149     try {
150         xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
151         XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
152         xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
153         auto_ptr_XMLCh src(config);
154         dummy->setAttributeNS(NULL,path,src.get());
155         dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
156
157         g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
158         g_Config->getServiceProvider()->init();
159     }
160     catch (exception& ex) {
161         pblock_nvinsert("error",ex.what(),pb);
162         g_Config->term();
163         g_Config=NULL;
164         return REQ_ABORTED;
165     }
166
167     daemon_atrestart(nsapi_shib_exit,NULL);
168
169     ServiceProvider* sp=g_Config->getServiceProvider();
170     Locker locker(sp);
171     const PropertySet* props=sp->getPropertySet("Local");
172     if (props) {
173         pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
174         if (unsetValue.first)
175             g_unsetHeaderValue = unsetValue.second;
176         pair<bool,bool> flag=props->getBool("checkSpoofing");
177         g_checkSpoofing = !flag.first || flag.second;
178         flag=props->getBool("catchAll");
179         g_catchAll = flag.first && flag.second;
180     }
181     return REQ_PROCEED;
182 }
183
184 /********************************************************************************/
185 // NSAPI Shib Target Subclass
186
187 class ShibTargetNSAPI : public AbstractSPRequest
188 {
189   mutable string m_body;
190   mutable bool m_gotBody;
191   mutable vector<string> m_certs;
192   set<string> m_allhttp;
193
194 public:
195   ShibTargetNSAPI(pblock* pb, ::Session* sn, Request* rq) : AbstractSPRequest(SHIBSP_LOGCAT".NSAPI"), m_gotBody(false) {
196     m_pb = pb;
197     m_sn = sn;
198     m_rq = rq;
199
200     const char* uri=pblock_findval("uri", rq->reqpb);
201     const char* qstr=pblock_findval("query", rq->reqpb);
202
203     if (qstr) {
204         string temp = string(uri) + '?' + qstr;
205         setRequestURI(temp.c_str());
206     }
207     else {
208         setRequestURI(uri);
209     }
210   }
211   ~ShibTargetNSAPI() { }
212
213   const char* getScheme() const {
214     return security_active ? "https" : "http";
215   }
216   const char* getHostname() const {
217 #ifdef vs_is_default_vs
218     // This is 6.0 or later, so we can distinguish requests to name-based vhosts.
219     if (!vs_is_default_vs(request_get_vs(m_rq)))
220         // The beauty here is, a non-default vhost can *only* be accessed if the client
221         // specified the exact name in the Host header. So we can trust the Host header.
222         return pblock_findval("host", m_rq->headers);
223     else
224 #endif
225     // In other cases, we're going to rely on the initialization process...
226     return g_ServerName.c_str();
227   }
228   int getPort() const {
229     return server_portnum;
230   }
231   const char* getMethod() const {
232     return pblock_findval("method", m_rq->reqpb);
233   }
234   string getContentType() const {
235     char* content_type = "";
236     request_header("content-type", &content_type, m_sn, m_rq);
237     return content_type;
238   }
239   long getContentLength() const {
240     if (m_gotBody)
241         return m_body.length();
242     char* content_length="";
243     request_header("content-length", &content_length, m_sn, m_rq);
244     return atoi(content_length);
245   }
246   string getRemoteAddr() const {
247     return pblock_findval("ip", m_sn->client);
248   }
249   void log(SPLogLevel level, const string& msg) const {
250     AbstractSPRequest::log(level,msg);
251     if (level>=SPError)
252         log_error(LOG_FAILURE, "nsapi_shib", m_sn, m_rq, const_cast<char*>(msg.c_str()));
253   }
254   const char* getQueryString() const { 
255     return pblock_findval("query", m_rq->reqpb);
256   }
257   const char* getRequestBody() const {
258     if (m_gotBody)
259         return m_body.c_str();
260     char* content_length=NULL;
261     if (request_header("content-length", &content_length, m_sn, m_rq)!=REQ_PROCEED || atoi(content_length) > 1024*1024) // 1MB?
262       throw opensaml::SecurityPolicyException("Blocked request body exceeding 1M size limit.");
263     else {
264       char ch=IO_EOF+1;
265       int cl=atoi(content_length);
266       m_gotBody=true;
267       while (cl && ch != IO_EOF) {
268         ch=netbuf_getc(m_sn->inbuf);
269         // Check for error.
270         if(ch==IO_ERROR)
271           break;
272         m_body += ch;
273         cl--;
274       }
275       if (cl)
276         throw IOException("Error reading request body from browser.");
277       return m_body.c_str();
278     }
279   }
280   void clearHeader(const char* rawname, const char* cginame) {
281     if (g_checkSpoofing) {
282         if (m_allhttp.empty()) {
283             // Populate the set of client-supplied headers for spoof checking.
284             const pb_entry* entry;
285             for (int i=0; i<m_rq->headers->hsize; ++i) {
286                 entry = m_rq->headers->ht[i];
287                 while (entry) {
288                     string cgiversion("HTTP_");
289                     const char* pch = entry->param->name;
290                     while (*pch) {
291                         cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
292                         pch++;
293                     }
294                     m_allhttp.insert(cgiversion);
295                     entry = entry->next;
296                 }
297             }
298         }
299         if (m_allhttp.count(cginame) > 0)
300             throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
301     }
302     param_free(pblock_remove(rawname, m_rq->headers));
303     pblock_nvinsert(rawname, g_unsetHeaderValue.c_str(), m_rq->headers);
304   }
305   void setHeader(const char* name, const char* value) {
306     param_free(pblock_remove(name, m_rq->headers));
307     pblock_nvinsert(name, value, m_rq->headers);
308   }
309   string getHeader(const char* name) const {
310     // NSAPI headers tend to be lower case. We'll special case "cookie" since it's used a lot.
311     char* hdr = NULL;
312     int cookie = strcmp(name, "Cookie");
313     if (cookie == 0)
314         name = "cookie";
315     if (request_header(const_cast<char*>(name), &hdr, m_sn, m_rq) != REQ_PROCEED) {
316       // We didn't get a hit, so we'll try a lower-casing operation, unless we already did...
317       if (cookie == 0)
318           return "";
319       string n;
320       while (*name)
321           n += tolower(*(name++));
322       if (request_header(const_cast<char*>(n.c_str()), &hdr, m_sn, m_rq) != REQ_PROCEED)
323           return "";
324     }
325     return string(hdr ? hdr : "");
326   }
327   void setRemoteUser(const char* user) {
328     pblock_nvinsert("auth-user", user, m_rq->vars);
329   }
330   string getRemoteUser() const {
331     const char* ru = pblock_findval("auth-user", m_rq->vars);
332     return ru ? ru : "";
333   }
334   void setResponseHeader(const char* name, const char* value) {
335     pblock_nvinsert(name, value, m_rq->srvhdrs);
336   }
337
338   long sendResponse(istream& in, long status) {
339     string msg;
340     char buf[1024];
341     while (in) {
342         in.read(buf,1024);
343         msg.append(buf,in.gcount());
344     }
345     pblock_nvinsert("connection","close",m_rq->srvhdrs);
346     pblock_nninsert("content-length", msg.length(), m_rq->srvhdrs);
347     protocol_status(m_sn, m_rq, status, NULL);
348     protocol_start_response(m_sn, m_rq);
349     net_write(m_sn->csd,const_cast<char*>(msg.c_str()),msg.length());
350     return REQ_EXIT;
351   }
352   long sendRedirect(const char* url) {
353     param_free(pblock_remove("content-type", m_rq->srvhdrs));
354     pblock_nninsert("content-length", 0, m_rq->srvhdrs);
355     pblock_nvinsert("expires", "01-Jan-1997 12:00:00 GMT", m_rq->srvhdrs);
356     pblock_nvinsert("cache-control", "private,no-store,no-cache", m_rq->srvhdrs);
357     pblock_nvinsert("location", url, m_rq->srvhdrs);
358     pblock_nvinsert("connection","close",m_rq->srvhdrs);
359     protocol_status(m_sn, m_rq, PROTOCOL_REDIRECT, NULL);
360     protocol_start_response(m_sn, m_rq);
361     return REQ_ABORTED;
362   }
363   long returnDecline() { return REQ_NOACTION; }
364   long returnOK() { return REQ_PROCEED; }
365   const vector<string>& getClientCertificates() const {
366       if (m_certs.empty()) {
367           const char* cert = pblock_findval("auth-cert", m_rq->vars);
368           if (cert)
369               m_certs.push_back(cert);
370       }
371       return m_certs;
372   }
373
374   pblock* m_pb;
375   ::Session* m_sn;
376   Request* m_rq;
377 };
378
379 /********************************************************************************/
380
381 int WriteClientError(::Session* sn, Request* rq, char* func, char* msg)
382 {
383     log_error(LOG_FAILURE,func,sn,rq,msg);
384     protocol_status(sn,rq,PROTOCOL_SERVER_ERROR,msg);
385     return REQ_ABORTED;
386 }
387
388 #undef FUNC
389 #define FUNC "shibboleth"
390 extern "C" NSAPI_PUBLIC int nsapi_shib(pblock* pb, ::Session* sn, Request* rq)
391 {
392   ostringstream threadid;
393   threadid << "[" << getpid() << "] nsapi_shib" << '\0';
394   xmltooling::NDC ndc(threadid.str().c_str());
395
396   try {
397     ShibTargetNSAPI stn(pb, sn, rq);
398
399     // Check user authentication
400     pair<bool,long> res = stn.getServiceProvider().doAuthentication(stn);
401     if (res.first) return (int)res.second;
402
403     // user authN was okay -- export the assertions now
404     param_free(pblock_remove("auth-user",rq->vars));
405     // This seems to be required in order to eventually set
406     // the auth-user var.
407     pblock_nvinsert("auth-type","shibboleth",rq->vars);
408     res = stn.getServiceProvider().doExport(stn);
409     if (res.first) return (int)res.second;
410
411     // Check the Authorization
412     res = stn.getServiceProvider().doAuthorization(stn);
413     if (res.first) return (int)res.second;
414
415     // this user is ok.
416     return REQ_PROCEED;
417   }
418   catch (exception& e) {
419     log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>(e.what()));
420     return WriteClientError(sn, rq, FUNC, "Shibboleth module threw an exception, see web server log for error.");
421   }
422   catch (...) {
423     log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>("Shibboleth module threw an unknown exception."));
424     if (g_catchAll)
425         return WriteClientError(sn, rq, FUNC, "Shibboleth module threw an unknown exception.");
426     throw;
427   }
428 }
429
430
431 #undef FUNC
432 #define FUNC "shib_handler"
433 extern "C" NSAPI_PUBLIC int shib_handler(pblock* pb, ::Session* sn, Request* rq)
434 {
435   ostringstream threadid;
436   threadid << "[" << getpid() << "] shib_handler" << '\0';
437   xmltooling::NDC ndc(threadid.str().c_str());
438
439   try {
440     ShibTargetNSAPI stn(pb, sn, rq);
441
442     pair<bool,long> res = stn.getServiceProvider().doHandler(stn);
443     if (res.first) return (int)res.second;
444
445     return WriteClientError(sn, rq, FUNC, "Shibboleth handler did not do anything.");
446   }
447   catch (exception& e) {
448     log_error(LOG_FAILURE,FUNC,sn,rq,const_cast<char*>(e.what()));
449     return WriteClientError(sn, rq, FUNC, "Shibboleth handler threw an exception, see web server log for error.");
450   }
451   catch (...) {
452     if (g_catchAll)
453         return WriteClientError(sn, rq, FUNC, "Shibboleth handler threw an unknown exception.");
454     throw;
455   }
456 }
457
458
459 class SunRequestMapper : public virtual RequestMapper, public virtual PropertySet
460 {
461 public:
462     SunRequestMapper(const xercesc::DOMElement* e);
463     ~SunRequestMapper() { delete m_mapper; delete m_stKey; delete m_propsKey; }
464     Lockable* lock() { return m_mapper->lock(); }
465     void unlock() { m_stKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
466     Settings getSettings(const HTTPRequest& request) const;
467     
468     const PropertySet* getParent() const { return NULL; }
469     void setParent(const PropertySet*) {}
470     pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
471     pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
472     pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
473     pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
474     pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
475     void getAll(map<string,const char*>& properties) const;
476     const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
477     const xercesc::DOMElement* getElement() const;
478
479 private:
480     RequestMapper* m_mapper;
481     ThreadKey* m_stKey;
482     ThreadKey* m_propsKey;
483 };
484
485 RequestMapper* SunRequestMapFactory(const xercesc::DOMElement* const & e)
486 {
487     return new SunRequestMapper(e);
488 }
489
490 SunRequestMapper::SunRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_stKey(NULL), m_propsKey(NULL)
491 {
492     m_mapper = SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
493     m_stKey=ThreadKey::create(NULL);
494     m_propsKey=ThreadKey::create(NULL);
495 }
496
497 RequestMapper::Settings SunRequestMapper::getSettings(const HTTPRequest& request) const
498 {
499     Settings s=m_mapper->getSettings(request);
500     m_stKey->setData((void*)dynamic_cast<const ShibTargetNSAPI*>(&request));
501     m_propsKey->setData((void*)s.first);
502     return pair<const PropertySet*,AccessControl*>(this,s.second);
503 }
504
505 pair<bool,bool> SunRequestMapper::getBool(const char* name, const char* ns) const
506 {
507     const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
508     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
509     if (stn && !ns && name) {
510         // Override boolean properties.
511         const char* param=pblock_findval(name,stn->m_pb);
512         if (param && (!strcmp(param,"1") || !strcasecmp(param,"true")))
513             return make_pair(true,true);
514     }
515     return s ? s->getBool(name,ns) : make_pair(false,false);
516 }
517
518 pair<bool,const char*> SunRequestMapper::getString(const char* name, const char* ns) const
519 {
520     const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
521     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
522     if (stn && !ns && name) {
523         // Override string properties.
524         if (!strcmp(name,"authType"))
525             return pair<bool,const char*>(true,"shibboleth");
526         else {
527             const char* param=pblock_findval(name,stn->m_pb);
528             if (param)
529                 return make_pair(true,param);
530         }
531     }
532     return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
533 }
534
535 pair<bool,const XMLCh*> SunRequestMapper::getXMLString(const char* name, const char* ns) const
536 {
537     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
538     return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
539 }
540
541 pair<bool,unsigned int> SunRequestMapper::getUnsignedInt(const char* name, const char* ns) const
542 {
543     const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
544     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
545     if (stn && !ns && name) {
546         // Override int properties.
547         const char* param=pblock_findval(name,stn->m_pb);
548         if (param)
549             return pair<bool,unsigned int>(true,strtol(param,NULL,10));
550     }
551     return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
552 }
553
554 pair<bool,int> SunRequestMapper::getInt(const char* name, const char* ns) const
555 {
556     const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
557     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
558     if (stn && !ns && name) {
559         // Override int properties.
560         const char* param=pblock_findval(name,stn->m_pb);
561         if (param)
562             return pair<bool,int>(true,atoi(param));
563     }
564     return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
565 }
566
567 void SunRequestMapper::getAll(map<string,const char*>& properties) const
568 {
569     const ShibTargetNSAPI* stn=reinterpret_cast<const ShibTargetNSAPI*>(m_stKey->getData());
570     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
571     if (s)
572         s->getAll(properties);
573     if (!stn)
574         return;
575     properties["authType"] = "shibboleth";
576     const pb_entry* entry;
577     for (int i=0; i<stn->m_pb->hsize; ++i) {
578         entry = stn->m_pb->ht[i];
579         while (entry) {
580             properties[entry->param->name] = entry->param->value;
581             entry = entry->next;
582         }
583     }
584 }
585
586 const PropertySet* SunRequestMapper::getPropertySet(const char* name, const char* ns) const
587 {
588     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
589     return s ? s->getPropertySet(name,ns) : NULL;
590 }
591
592 const xercesc::DOMElement* SunRequestMapper::getElement() const
593 {
594     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
595     return s ? s->getElement() : NULL;
596 }