https://issues.shibboleth.net/jira/browse/SSPCPP-155
[shibboleth/cpp-sp.git] / apache / mod_apache.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  * mod_apache.cpp
19  *
20  * Apache module implementation
21  */
22
23 #define SHIBSP_LITE
24
25 #ifdef SOLARIS2
26 #undef _XOPEN_SOURCE    // causes gethostname conflict in unistd.h
27 #endif
28
29 #ifdef WIN32
30 # define _CRT_NONSTDC_NO_DEPRECATE 1
31 # define _CRT_SECURE_NO_DEPRECATE 1
32 #endif
33
34 #include <shibsp/AbstractSPRequest.h>
35 #include <shibsp/AccessControl.h>
36 #include <shibsp/exceptions.h>
37 #include <shibsp/RequestMapper.h>
38 #include <shibsp/SPConfig.h>
39 #include <shibsp/ServiceProvider.h>
40 #include <shibsp/SessionCache.h>
41 #include <shibsp/attribute/Attribute.h>
42 #include <xercesc/util/XMLUniDefs.hpp>
43 #include <xercesc/util/regx/RegularExpression.hpp>
44 #include <xmltooling/XMLToolingConfig.h>
45 #include <xmltooling/util/NDC.h>
46 #include <xmltooling/util/Threads.h>
47 #include <xmltooling/util/XMLConstants.h>
48 #include <xmltooling/util/XMLHelper.h>
49
50 #ifdef WIN32
51 # include <winsock.h>
52 #endif
53
54 #undef _XPG4_2
55
56 // Apache specific header files
57 #include <httpd.h>
58 #include <http_config.h>
59 #include <http_protocol.h>
60 #include <http_main.h>
61 #define CORE_PRIVATE
62 #include <http_core.h>
63 #include <http_log.h>
64 #include <http_request.h>
65
66 #ifndef SHIB_APACHE_13
67 #include <apr_buckets.h>
68 #include <apr_strings.h>
69 #include <apr_pools.h>
70 #endif
71
72 #include <memory>
73 #include <fstream>
74 #include <sstream>
75 #include <stdexcept>
76
77 #ifdef HAVE_UNISTD_H
78 #include <unistd.h>             // for getpid()
79 #endif
80
81 using namespace shibsp;
82 using namespace xmltooling;
83 using namespace std;
84 using xercesc::RegularExpression;
85 using xercesc::XMLException;
86
87 extern "C" module MODULE_VAR_EXPORT mod_shib;
88
89 namespace {
90     char* g_szSHIBConfig = NULL;
91     char* g_szSchemaDir = NULL;
92     char* g_szPrefix = NULL;
93     SPConfig* g_Config = NULL;
94     string g_unsetHeaderValue,g_spoofKey;
95     bool g_checkSpoofing = true;
96     bool g_catchAll = false;
97     static const char* g_UserDataKey = "_shib_check_user_";
98     static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
99     static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
100 }
101
102 /* Apache 2.2.x headers must be accumulated and set in the output filter.
103    Apache 2.0.49+ supports the filter method.
104    Apache 1.3.x and lesser 2.0.x must write the headers directly. */
105
106 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
107 #define SHIB_DEFERRED_HEADERS
108 #endif
109
110 /********************************************************************************/
111 // Basic Apache Configuration code.
112 //
113
114 // per-server module configuration structure
115 struct shib_server_config
116 {
117     char* szScheme;
118 };
119
120 // creates the per-server configuration
121 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
122 {
123     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
124     sc->szScheme = NULL;
125     return sc;
126 }
127
128 // overrides server configuration in virtual servers
129 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
130 {
131     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
132     shib_server_config* parent=(shib_server_config*)base;
133     shib_server_config* child=(shib_server_config*)sub;
134
135     if (child->szScheme)
136         sc->szScheme=ap_pstrdup(p,child->szScheme);
137     else if (parent->szScheme)
138         sc->szScheme=ap_pstrdup(p,parent->szScheme);
139     else
140         sc->szScheme=NULL;
141
142     return sc;
143 }
144
145 // per-dir module configuration structure
146 struct shib_dir_config
147 {
148     SH_AP_TABLE* tSettings; // generic table of extensible settings
149
150     // RM Configuration
151     char* szAuthGrpFile;    // Auth GroupFile name
152     int bRequireAll;        // all "known" require directives must match, otherwise OR logic
153     int bAuthoritative;     // allow htaccess plugin to DECLINE when authz fails
154
155     // Content Configuration
156     char* szApplicationId;  // Shib applicationId value
157     char* szRequireWith;    // require a session using a specific initiator?
158     char* szRedirectToSSL;  // redirect non-SSL requests to SSL port
159     int bOff;               // flat-out disable all Shib processing
160     int bBasicHijack;       // activate for AuthType Basic?
161     int bRequireSession;    // require a session?
162     int bExportAssertion;   // export SAML assertion to the environment?
163     int bUseEnvVars;        // use environment?
164     int bUseHeaders;        // use headers?
165 };
166
167 // creates per-directory config structure
168 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
169 {
170     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
171     dc->tSettings = NULL;
172     dc->szAuthGrpFile = NULL;
173     dc->bRequireAll = -1;
174     dc->bAuthoritative = -1;
175     dc->szApplicationId = NULL;
176     dc->szRequireWith = NULL;
177     dc->szRedirectToSSL = NULL;
178     dc->bOff = -1;
179     dc->bBasicHijack = -1;
180     dc->bRequireSession = -1;
181     dc->bExportAssertion = -1;
182     dc->bUseEnvVars = -1;
183     dc->bUseHeaders = -1;
184     return dc;
185 }
186
187 // overrides server configuration in directories
188 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
189 {
190     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
191     shib_dir_config* parent=(shib_dir_config*)base;
192     shib_dir_config* child=(shib_dir_config*)sub;
193
194     // The child supersedes any matching table settings in the parent.
195     dc->tSettings = NULL;
196     if (parent->tSettings)
197         dc->tSettings = ap_copy_table(p, parent->tSettings);
198     if (child->tSettings) {
199         if (dc->tSettings)
200             ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
201         else
202             dc->tSettings = ap_copy_table(p, child->tSettings);
203     }
204
205     if (child->szAuthGrpFile)
206         dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
207     else if (parent->szAuthGrpFile)
208         dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
209     else
210         dc->szAuthGrpFile=NULL;
211
212     if (child->szApplicationId)
213         dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
214     else if (parent->szApplicationId)
215         dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
216     else
217         dc->szApplicationId=NULL;
218
219     if (child->szRequireWith)
220         dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
221     else if (parent->szRequireWith)
222         dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
223     else
224         dc->szRequireWith=NULL;
225
226     if (child->szRedirectToSSL)
227         dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
228     else if (parent->szRedirectToSSL)
229         dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
230     else
231         dc->szRedirectToSSL=NULL;
232
233     dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
234     dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
235     dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
236     dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
237     dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
238     dc->bAuthoritative=((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
239     dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
240     dc->bUseHeaders=((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
241     return dc;
242 }
243
244 // per-request module structure
245 struct shib_request_config
246 {
247     SH_AP_TABLE *env;        // environment vars
248 #ifdef SHIB_DEFERRED_HEADERS
249     SH_AP_TABLE *hdr_out;    // headers to browser
250 #endif
251 };
252
253 // create a request record
254 static shib_request_config *init_request_config(request_rec *r)
255 {
256     shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
257     ap_set_module_config (r->request_config, &mod_shib, rc);
258     memset(rc, 0, sizeof(shib_request_config));
259     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
260     return rc;
261 }
262
263 // generic global slot handlers
264 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
265 {
266     *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
267     return NULL;
268 }
269
270 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
271 {
272     char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
273     size_t offset=(size_t)parms->info;
274     *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
275     return NULL;
276 }
277
278 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
279 #ifdef SHIB_APACHE_13
280                                              char* arg1, char* arg2
281 #else
282                                              void* arg1, const char* arg2
283 #endif
284                                              )
285 {
286   ap_set_file_slot(parms, arg1, arg2);
287   return DECLINE_CMD;
288 }
289
290 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
291 {
292     if (!dc->tSettings)
293         dc->tSettings = ap_make_table(parms->pool, 4);
294     ap_table_set(dc->tSettings, arg1, arg2);
295     return NULL;
296 }
297
298 /********************************************************************************/
299 // Apache ShibTarget subclass(es) here.
300
301 class ShibTargetApache : public AbstractSPRequest
302 {
303   bool m_handler;
304   mutable string m_body;
305   mutable bool m_gotBody,m_firsttime;
306   mutable vector<string> m_certs;
307   set<string> m_allhttp;
308
309 public:
310   request_rec* m_req;
311   shib_dir_config* m_dc;
312   shib_server_config* m_sc;
313   shib_request_config* m_rc;
314
315   ShibTargetApache(request_rec* req, bool handler, bool shib_check_user)
316       : AbstractSPRequest(SHIBSP_LOGCAT".Apache"), m_handler(handler), m_gotBody(false),m_firsttime(true) {
317     m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
318     m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
319     m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
320     m_req = req;
321
322     setRequestURI(m_req->unparsed_uri);
323
324     if (shib_check_user && m_dc->bUseHeaders == 1) {
325         // Try and see if this request was already processed, to skip spoof checking.
326         if (!ap_is_initial_req(m_req)) {
327             m_firsttime = false;
328         }
329         else if (!g_spoofKey.empty()) {
330             const char* hdr = ap_table_get(m_req->headers_in, "Shib-Spoof-Check");
331             if (hdr && g_spoofKey == hdr)
332                 m_firsttime=false;
333         }
334
335         if (!m_firsttime)
336             log(SPDebug, "shib_check_user running more than once");
337     }
338   }
339   virtual ~ShibTargetApache() {}
340
341   const char* getScheme() const {
342     return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
343   }
344   const char* getHostname() const {
345     return ap_get_server_name(m_req);
346   }
347   int getPort() const {
348     return ap_get_server_port(m_req);
349   }
350   const char* getMethod() const {
351     return m_req->method;
352   }
353   string getContentType() const {
354     const char* type = ap_table_get(m_req->headers_in, "Content-Type");
355     return type ? type : "";
356   }
357   long getContentLength() const {
358       return m_gotBody ? m_body.length() : m_req->remaining;
359   }
360   string getRemoteAddr() const {
361     string ret = AbstractSPRequest::getRemoteAddr();
362     return ret.empty() ? m_req->connection->remote_ip : ret;
363   }
364   void log(SPLogLevel level, const string& msg) const {
365     AbstractSPRequest::log(level,msg);
366     ap_log_rerror(
367         APLOG_MARK,
368         (level == SPDebug ? APLOG_DEBUG :
369         (level == SPInfo ? APLOG_INFO :
370         (level == SPWarn ? APLOG_WARNING :
371         (level == SPError ? APLOG_ERR : APLOG_CRIT))))|APLOG_NOERRNO,
372         SH_AP_R(m_req),
373         msg.c_str()
374         );
375   }
376   const char* getQueryString() const { return m_req->args; }
377   const char* getRequestBody() const {
378     if (m_gotBody || m_req->method_number==M_GET)
379         return m_body.c_str();
380 #ifdef SHIB_APACHE_13
381     // Read the posted data
382     if (ap_setup_client_block(m_req, REQUEST_CHUNKED_DECHUNK) != OK) {
383         m_gotBody=true;
384         log(SPError, "Apache function (setup_client_block) failed while reading request body.");
385         return m_body.c_str();
386     }
387     if (!ap_should_client_block(m_req)) {
388         m_gotBody=true;
389         log(SPError, "Apache function (should_client_block) failed while reading request body.");
390         return m_body.c_str();
391     }
392     if (m_req->remaining > 1024*1024)
393         throw opensaml::SecurityPolicyException("Blocked request body larger than 1M size limit.");
394     m_gotBody=true;
395     int len;
396     char buff[HUGE_STRING_LEN];
397     ap_hard_timeout("[mod_shib] getRequestBody", m_req);
398     while ((len=ap_get_client_block(m_req, buff, sizeof(buff))) > 0) {
399       ap_reset_timeout(m_req);
400       m_body.append(buff, len);
401     }
402     ap_kill_timeout(m_req);
403 #else
404     const char *data;
405     apr_size_t len;
406     int seen_eos = 0;
407     apr_bucket_brigade* bb = apr_brigade_create(m_req->pool, m_req->connection->bucket_alloc);
408     do {
409         apr_bucket *bucket;
410         apr_status_t rv = ap_get_brigade(m_req->input_filters, bb, AP_MODE_READBYTES, APR_BLOCK_READ, HUGE_STRING_LEN);
411         if (rv != APR_SUCCESS) {
412             log(SPError, "Apache function (ap_get_brigade) failed while reading request body.");
413             break;
414         }
415
416         for (bucket = APR_BRIGADE_FIRST(bb); bucket != APR_BRIGADE_SENTINEL(bb); bucket = APR_BUCKET_NEXT(bucket)) {
417             if (APR_BUCKET_IS_EOS(bucket)) {
418                 seen_eos = 1;
419                 break;
420             }
421
422             /* We can't do much with this. */
423             if (APR_BUCKET_IS_FLUSH(bucket))
424                 continue;
425
426             /* read */
427             apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
428             if (len > 0)
429                 m_body.append(data, len);
430         }
431         apr_brigade_cleanup(bb);
432     } while (!seen_eos);
433     apr_brigade_destroy(bb);
434     m_gotBody=true;
435 #endif
436     return m_body.c_str();
437   }
438   void clearHeader(const char* rawname, const char* cginame) {
439     if (m_dc->bUseHeaders == 1) {
440        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: hdr\n");
441         if (g_checkSpoofing && m_firsttime) {
442             if (m_allhttp.empty()) {
443                 // First time, so populate set with "CGI" versions of client-supplied headers.
444 #ifdef SHIB_APACHE_13
445                 array_header *hdrs_arr = ap_table_elts(m_req->headers_in);
446                 table_entry *hdrs = (table_entry *) hdrs_arr->elts;
447 #else
448                 const apr_array_header_t *hdrs_arr = apr_table_elts(m_req->headers_in);
449                 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
450 #endif
451                 for (int i = 0; i < hdrs_arr->nelts; ++i) {
452                     if (!hdrs[i].key)
453                         continue;
454                     string cgiversion("HTTP_");
455                     const char* pch = hdrs[i].key;
456                     while (*pch) {
457                         cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
458                         pch++;
459                     }
460                     m_allhttp.insert(cgiversion);
461                 }
462             }
463
464             if (m_allhttp.count(cginame) > 0)
465                 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
466         }
467         ap_table_unset(m_req->headers_in, rawname);
468         ap_table_set(m_req->headers_in, rawname, g_unsetHeaderValue.c_str());
469     }
470   }
471   void setHeader(const char* name, const char* value) {
472     if (m_dc->bUseEnvVars != 0) {
473        if (!m_rc) {
474           // this happens on subrequests
475           // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_setheader: no_m_rc\n");
476           m_rc = init_request_config(m_req);
477        }
478        if (!m_rc->env)
479            m_rc->env = ap_make_table(m_req->pool, 10);
480        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_set_env: %s=%s\n", name, value?value:"Null");
481        ap_table_set(m_rc->env, name, value ? value : "");
482     }
483     if (m_dc->bUseHeaders == 1)
484        ap_table_set(m_req->headers_in, name, value);
485   }
486   string getHeader(const char* name) const {
487     const char* hdr = ap_table_get(m_req->headers_in, name);
488     return string(hdr ? hdr : "");
489   }
490   string getSecureHeader(const char* name) const {
491     if (m_dc->bUseEnvVars != 0) {
492        const char *hdr;
493        if (m_rc && m_rc->env)
494            hdr = ap_table_get(m_rc->env, name);
495        else
496            hdr = NULL;
497        return string(hdr ? hdr : "");
498     }
499     return getHeader(name);
500   }
501   void setRemoteUser(const char* user) {
502       SH_AP_USER(m_req) = user ? ap_pstrdup(m_req->pool, user) : NULL;
503       if (m_dc->bUseHeaders == 1) {
504           if (user) {
505               ap_table_set(m_req->headers_in, "REMOTE_USER", user);
506           }
507           else {
508               ap_table_unset(m_req->headers_in, "REMOTE_USER");
509               ap_table_set(m_req->headers_in, "REMOTE_USER", g_unsetHeaderValue.c_str());
510           }
511       }
512   }
513   string getRemoteUser() const {
514     return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
515   }
516   void setContentType(const char* type) {
517       m_req->content_type = ap_psprintf(m_req->pool, type);
518   }
519   void setResponseHeader(const char* name, const char* value) {
520 #ifdef SHIB_DEFERRED_HEADERS
521    if (!m_rc)
522       // this happens on subrequests
523       m_rc = init_request_config(m_req);
524     if (m_handler)
525         ap_table_add(m_rc->hdr_out, name, value);
526     else
527 #endif
528     ap_table_add(m_req->err_headers_out, name, value);
529   }
530   long sendResponse(istream& in, long status) {
531     if (status != XMLTOOLING_HTTP_STATUS_OK)
532         m_req->status = status;
533     ap_send_http_header(m_req);
534     char buf[1024];
535     while (in) {
536         in.read(buf,1024);
537         ap_rwrite(buf,in.gcount(),m_req);
538     }
539 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22))
540     if (status != XMLTOOLING_HTTP_STATUS_OK && status != XMLTOOLING_HTTP_STATUS_ERROR)
541         return status;
542 #endif
543     return DONE;
544   }
545   long sendRedirect(const char* url) {
546     ap_table_set(m_req->headers_out, "Location", url);
547     return REDIRECT;
548   }
549   const vector<string>& getClientCertificates() const {
550       if (m_certs.empty()) {
551           const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
552           if (cert)
553               m_certs.push_back(cert);
554           int i = 0;
555           do {
556               cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
557               if (cert)
558                   m_certs.push_back(cert);
559           } while (cert);
560       }
561       return m_certs;
562   }
563   long returnDecline(void) { return DECLINED; }
564   long returnOK(void) { return OK; }
565 };
566
567 /********************************************************************************/
568 // Apache handlers
569
570 extern "C" int shib_check_user(request_rec* r)
571 {
572   // Short-circuit entirely?
573   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
574     return DECLINED;
575
576   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
577
578   ostringstream threadid;
579   threadid << "[" << getpid() << "] shib_check_user" << '\0';
580   xmltooling::NDC ndc(threadid.str().c_str());
581
582   try {
583     ShibTargetApache sta(r,false,true);
584
585     // Check user authentication and export information, then set the handler bypass
586     pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
587     apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
588     // If directed, install a spoof key to recognize when we've already cleared headers.
589     if (!g_spoofKey.empty() && (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bUseHeaders==1))
590         ap_table_set(r->headers_in, "Shib-Spoof-Check", g_spoofKey.c_str());
591     if (res.first) return res.second;
592
593     // user auth was okay -- export the assertions now
594     res = sta.getServiceProvider().doExport(sta);
595     if (res.first) return res.second;
596
597     // export happened successfully..  this user is ok.
598     return OK;
599   }
600   catch (exception& e) {
601     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
602     return SERVER_ERROR;
603   }
604   catch (...) {
605     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an unknown exception!");
606     if (g_catchAll)
607       return SERVER_ERROR;
608     throw;
609   }
610 }
611
612 extern "C" int shib_handler(request_rec* r)
613 {
614   // Short-circuit entirely?
615   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
616     return DECLINED;
617
618   ostringstream threadid;
619   threadid << "[" << getpid() << "] shib_handler" << '\0';
620   xmltooling::NDC ndc(threadid.str().c_str());
621
622 #ifndef SHIB_APACHE_13
623   // With 2.x, this handler always runs, though last.
624   // We check if shib_check_user ran, because it will detect a handler request
625   // and dispatch it directly.
626   void* data;
627   apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
628   if (data==(const void*)42) {
629     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
630     return DECLINED;
631   }
632 #endif
633
634   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
635
636   try {
637     ShibTargetApache sta(r,true,false);
638
639     pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
640     if (res.first) return res.second;
641
642     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
643     return SERVER_ERROR;
644   }
645   catch (exception& e) {
646     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
647     return SERVER_ERROR;
648   }
649   catch (...) {
650     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an unknown exception!");
651     if (g_catchAll)
652       return SERVER_ERROR;
653     throw;
654   }
655 }
656
657 /*
658  * shib_auth_checker() -- a simple resource manager to
659  * process the .htaccess settings
660  */
661 extern "C" int shib_auth_checker(request_rec* r)
662 {
663   // Short-circuit entirely?
664   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
665     return DECLINED;
666
667   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
668
669   ostringstream threadid;
670   threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
671   xmltooling::NDC ndc(threadid.str().c_str());
672
673   try {
674     ShibTargetApache sta(r,false,false);
675
676     pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
677     if (res.first) return res.second;
678
679     // The SP method should always return true, so if we get this far, something unusual happened.
680     // Just let Apache (or some other module) decide what to do.
681     return DECLINED;
682   }
683   catch (exception& e) {
684     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
685     return SERVER_ERROR;
686   }
687   catch (...) {
688     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an unknown exception!");
689     if (g_catchAll)
690       return SERVER_ERROR;
691     throw;
692   }
693 }
694
695 // Access control plugin that enforces htaccess rules
696 class htAccessControl : virtual public AccessControl
697 {
698 public:
699     htAccessControl() {}
700     ~htAccessControl() {}
701     Lockable* lock() {return this;}
702     void unlock() {}
703     aclresult_t authorized(const SPRequest& request, const Session* session) const;
704 private:
705     bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
706 };
707
708 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
709 {
710     return new htAccessControl();
711 }
712
713 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
714 {
715 public:
716     ApacheRequestMapper(const xercesc::DOMElement* e);
717     ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
718     Lockable* lock() { return m_mapper->lock(); }
719     void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
720     Settings getSettings(const HTTPRequest& request) const;
721
722     const PropertySet* getParent() const { return NULL; }
723     void setParent(const PropertySet*) {}
724     pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
725     pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
726     pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
727     pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
728     pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
729     void getAll(map<string,const char*>& properties) const;
730     const PropertySet* getPropertySet(const char* name, const char* ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const;
731     const xercesc::DOMElement* getElement() const;
732
733 private:
734     RequestMapper* m_mapper;
735     ThreadKey* m_staKey;
736     ThreadKey* m_propsKey;
737     AccessControl* m_htaccess;
738 };
739
740 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
741 {
742     return new ApacheRequestMapper(e);
743 }
744
745 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
746 {
747     m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
748     m_htaccess=new htAccessControl();
749     m_staKey=ThreadKey::create(NULL);
750     m_propsKey=ThreadKey::create(NULL);
751 }
752
753 RequestMapper::Settings ApacheRequestMapper::getSettings(const HTTPRequest& request) const
754 {
755     Settings s=m_mapper->getSettings(request);
756     m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
757     m_propsKey->setData((void*)s.first);
758     return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
759 }
760
761 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
762 {
763     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
764     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
765     if (sta && !ns) {
766         // Override Apache-settable boolean properties.
767         if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
768             return make_pair(true, sta->m_dc->bRequireSession==1);
769         else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
770             return make_pair(true, sta->m_dc->bExportAssertion==1);
771         else if (sta->m_dc->tSettings) {
772             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
773             if (prop)
774                 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
775         }
776     }
777     return s ? s->getBool(name,ns) : make_pair(false,false);
778 }
779
780 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
781 {
782     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
783     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
784     if (sta && !ns) {
785         // Override Apache-settable string properties.
786         if (name && !strcmp(name,"authType")) {
787             const char *auth_type=ap_auth_type(sta->m_req);
788             if (auth_type) {
789                 // Check for Basic Hijack
790                 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
791                     auth_type = "shibboleth";
792                 return make_pair(true,auth_type);
793             }
794         }
795         else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
796             return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
797         else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
798             return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
799         else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
800             return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
801         else if (sta->m_dc->tSettings) {
802             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
803             if (prop)
804                 return make_pair(true, prop);
805         }
806     }
807     return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
808 }
809
810 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
811 {
812     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
813     return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
814 }
815
816 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
817 {
818     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
819     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
820     if (sta && !ns) {
821         // Override Apache-settable int properties.
822         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
823             return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, NULL, 10));
824         else if (sta->m_dc->tSettings) {
825             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
826             if (prop)
827                 return pair<bool,unsigned int>(true, atoi(prop));
828         }
829     }
830     return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
831 }
832
833 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
834 {
835     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
836     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
837     if (sta && !ns) {
838         // Override Apache-settable int properties.
839         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
840             return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
841         else if (sta->m_dc->tSettings) {
842             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
843             if (prop)
844                 return make_pair(true, atoi(prop));
845         }
846     }
847     return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
848 }
849
850 void ApacheRequestMapper::getAll(map<string,const char*>& properties) const
851 {
852     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
853     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
854
855     if (s)
856         s->getAll(properties);
857     if (!sta)
858         return;
859
860     const char* auth_type=ap_auth_type(sta->m_req);
861     if (auth_type) {
862         // Check for Basic Hijack
863         if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
864             auth_type = "shibboleth";
865         properties["authType"] = auth_type;
866     }
867
868     if (sta->m_dc->szApplicationId)
869         properties["applicationId"] = sta->m_dc->szApplicationId;
870     if (sta->m_dc->szRequireWith)
871         properties["requireSessionWith"] = sta->m_dc->szRequireWith;
872     if (sta->m_dc->szRedirectToSSL)
873         properties["redirectToSSL"] = sta->m_dc->szRedirectToSSL;
874     if (sta->m_dc->bRequireSession != 0)
875         properties["requireSession"] = (sta->m_dc->bRequireSession==1) ? "true" : "false";
876     if (sta->m_dc->bExportAssertion != 0)
877         properties["exportAssertion"] = (sta->m_dc->bExportAssertion==1) ? "true" : "false";
878 }
879
880 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
881 {
882     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
883     return s ? s->getPropertySet(name,ns) : NULL;
884 }
885
886 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
887 {
888     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
889     return s ? s->getElement() : NULL;
890 }
891
892 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
893 {
894     SH_AP_CONFIGFILE* f;
895     SH_AP_TABLE* grps=ap_make_table(r->pool,15);
896     char l[MAX_STRING_LEN];
897     const char *group_name, *ll, *w;
898
899 #ifdef SHIB_APACHE_13
900     if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
901 #else
902     if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
903 #endif
904         ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
905         return NULL;
906     }
907
908     SH_AP_POOL* sp;
909 #ifdef SHIB_APACHE_13
910     sp=ap_make_sub_pool(r->pool);
911 #else
912     if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
913         ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
914             "groups_for_user() could not create a subpool");
915         return NULL;
916     }
917 #endif
918
919     while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
920         if ((*l=='#') || (!*l))
921             continue;
922         ll = l;
923         ap_clear_pool(sp);
924
925         group_name=ap_getword(sp,&ll,':');
926
927         while (*ll) {
928             w=ap_getword_conf(sp,&ll);
929             if (!strcmp(w,user)) {
930                 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
931                 break;
932             }
933         }
934     }
935     ap_cfg_closefile(f);
936     ap_destroy_pool(sp);
937     return grps;
938 }
939
940 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
941 {
942     bool caseSensitive = attr->isCaseSensitive();
943     const vector<string>& vals = attr->getSerializedValues();
944     for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
945         if (re) {
946             auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
947             if (re->matches(trans.get())) {
948                 if (request.isPriorityEnabled(SPRequest::SPDebug))
949                     request.log(SPRequest::SPDebug, string("htaccess: expecting regexp ") + toMatch + ", got " + *v + ": acccepted");
950                 return true;
951             }
952         }
953         else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
954             if (request.isPriorityEnabled(SPRequest::SPDebug))
955                 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": accepted");
956             return true;
957         }
958         else if (request.isPriorityEnabled(SPRequest::SPDebug)) {
959             request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": rejected");
960         }
961     }
962     return false;
963 }
964
965 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
966 {
967     // Make sure the object is our type.
968     const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
969     if (!sta)
970         throw ConfigurationException("Request wrapper object was not of correct type.");
971
972     // mod_auth clone
973
974     int m=sta->m_req->method_number;
975     bool method_restricted=false;
976     const char *t, *w;
977
978     const array_header* reqs_arr=ap_requires(sta->m_req);
979     if (!reqs_arr)
980         return shib_acl_indeterminate;  // should never happen
981
982     require_line* reqs=(require_line*)reqs_arr->elts;
983
984     for (int x=0; x<reqs_arr->nelts; x++) {
985         // This rule should be completely ignored, the method doesn't fit.
986         // The rule just doesn't exist for our purposes.
987         if (!(reqs[x].method_mask & (1 << m)))
988             continue;
989
990         method_restricted=true; // this lets us know at the end that at least one rule was potentially enforcable.
991
992         // Tracks status of this rule's evaluation.
993         bool status = false;
994
995         string remote_user = request.getRemoteUser();
996
997         t = reqs[x].requirement;
998         w = ap_getword_white(sta->m_req->pool, &t);
999
1000         if (!strcasecmp(w,"shibboleth")) {
1001             // This is a dummy rule needed because Apache conflates authn and authz.
1002             // Without some require rule, AuthType is ignored and no check_user hooks run.
1003             status = true;  // treat it as an "accepted" rule
1004         }
1005         else if (!strcmp(w,"valid-user") && session) {
1006             request.log(SPRequest::SPDebug, "htaccess: accepting valid-user based on active session");
1007             status = true;
1008         }
1009         else if (!strcmp(w,"user") && !remote_user.empty()) {
1010             bool regexp=false,negate=false;
1011             while (*t) {
1012                 w=ap_getword_conf(sta->m_req->pool,&t);
1013                 if (*w=='~') {
1014                     regexp=true;
1015                     continue;
1016                 }
1017                 else if (*w=='!') {
1018                     negate=true;
1019                     if (*(w+1)=='~')
1020                         regexp=true;
1021                     continue;
1022                 }
1023
1024                 // Figure out if there's a match.
1025                 bool match = false;
1026                 if (regexp) {
1027                     try {
1028                         // To do regex matching, we have to convert from UTF-8.
1029                         auto_arrayptr<XMLCh> trans(fromUTF8(w));
1030                         RegularExpression re(trans.get());
1031                         auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
1032                         match = re.matches(trans2.get());
1033                     }
1034                     catch (XMLException& ex) {
1035                         auto_ptr_char tmp(ex.getMessage());
1036                         request.log(SPRequest::SPError,
1037                             string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1038                     }
1039                 }
1040                 else if (remote_user==w) {
1041                     match = true;
1042                 }
1043
1044                 if (match) {
1045                     // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1046                     status = !negate;
1047                     if (request.isPriorityEnabled(SPRequest::SPDebug))
1048                         request.log(SPRequest::SPDebug,
1049                             string("htaccess: require user ") + (negate ? "rejecting (" : "accepting (") + remote_user + ")");
1050                     break;
1051                 }
1052             }
1053         }
1054         else if (!strcmp(w,"group")  && !remote_user.empty()) {
1055             SH_AP_TABLE* grpstatus=NULL;
1056             if (sta->m_dc->szAuthGrpFile) {
1057                 if (request.isPriorityEnabled(SPRequest::SPDebug))
1058                     request.log(SPRequest::SPDebug,string("htaccess plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
1059                 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
1060             }
1061
1062             bool negate=false;
1063             while (*t) {
1064                 w=ap_getword_conf(sta->m_req->pool,&t);
1065                 if (*w=='!') {
1066                     negate=true;
1067                     continue;
1068                 }
1069
1070                 if (grpstatus && ap_table_get(grpstatus,w)) {
1071                     // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1072                     status = !negate;
1073                     request.log(SPRequest::SPDebug, string("htaccess: require group ") + (negate ? "rejecting (" : "accepting (") + w + ")");
1074                     break;
1075                 }
1076             }
1077         }
1078         else if (!strcmp(w,"authnContextClassRef") || !strcmp(w,"authnContextDeclRef")) {
1079             const char* ref = !strcmp(w,"authnContextClassRef") ? session->getAuthnContextClassRef() : session->getAuthnContextDeclRef();
1080             bool regexp=false,negate=false;
1081             while (ref && *t) {
1082                 w=ap_getword_conf(sta->m_req->pool,&t);
1083                 if (*w=='~') {
1084                     regexp=true;
1085                     continue;
1086                 }
1087                 else if (*w=='!') {
1088                     negate=true;
1089                     if (*(w+1)=='~')
1090                         regexp=true;
1091                     continue;
1092                 }
1093
1094                 // Figure out if there's a match.
1095                 bool match = false;
1096                 if (regexp) {
1097                     try {
1098                         // To do regex matching, we have to convert from UTF-8.
1099                         RegularExpression re(w);
1100                         match = re.matches(ref);
1101                     }
1102                     catch (XMLException& ex) {
1103                         auto_ptr_char tmp(ex.getMessage());
1104                         request.log(SPRequest::SPError,
1105                             string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1106                     }
1107                 }
1108                 else if (!strcmp(w,ref)) {
1109                     match = true;
1110                 }
1111
1112                 if (match) {
1113                     // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1114                     status = !negate;
1115                     if (request.isPriorityEnabled(SPRequest::SPDebug))
1116                         request.log(SPRequest::SPDebug,
1117                             string("htaccess: require authnContext ") + (negate ? "rejecting (" : "accepting (") + ref + ")");
1118                     break;
1119                 }
1120             }
1121         }
1122         else if (!session) {
1123             request.log(SPRequest::SPError, string("htaccess: require ") + w + " not given a valid session, are you using lazy sessions?");
1124         }
1125         else {
1126             // Find the attribute(s) matching the require rule.
1127             pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1128                 session->getIndexedAttributes().equal_range(w);
1129
1130             bool regexp=false;
1131             while (!status && attrs.first!=attrs.second && *t) {
1132                 w=ap_getword_conf(sta->m_req->pool,&t);
1133                 if (*w=='~') {
1134                     regexp=true;
1135                     continue;
1136                 }
1137
1138                 try {
1139                     auto_ptr<RegularExpression> re;
1140                     if (regexp) {
1141                         delete re.release();
1142                         auto_arrayptr<XMLCh> trans(fromUTF8(w));
1143                         auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1144                         re=temp;
1145                     }
1146
1147                     for (; !status && attrs.first!=attrs.second; ++attrs.first) {
1148                         if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
1149                             status = true;
1150                         }
1151                     }
1152                 }
1153                 catch (XMLException& ex) {
1154                     auto_ptr_char tmp(ex.getMessage());
1155                     request.log(SPRequest::SPError,
1156                         string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1157                         );
1158                 }
1159             }
1160         }
1161
1162         // If status is false, we found a rule we couldn't satisfy.
1163         // Could be an unknown rule to us, or it just didn't match.
1164
1165         if (status && sta->m_dc->bRequireAll != 1) {
1166             // If we're not insisting that all rules be met, then we're done.
1167             request.log(SPRequest::SPDebug, "htaccess: a rule was successful, granting access");
1168             return shib_acl_true;
1169         }
1170         else if (!status && sta->m_dc->bRequireAll == 1) {
1171             // If we're insisting that all rules be met, which is not something Apache really handles well,
1172             // then we either return false or indeterminate based on the authoritative option, which defaults on.
1173             if (sta->m_dc->bAuthoritative != 0) {
1174                 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful, denying access");
1175                 return shib_acl_false;
1176             }
1177
1178             request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful but not authoritative, leaving it up to Apache");
1179             return shib_acl_indeterminate;
1180         }
1181
1182         // Otherwise, we keep going. If we're requring all, then we have to check every rule.
1183         // If not we just didn't find a successful rule yet, so we keep going anyway.
1184     }
1185
1186     // If we get here, we either "failed" or we're in require all mode (but not both).
1187     // If no rules possibly apply or we insisted that all rules check out, then we're good.
1188     if (!method_restricted) {
1189         request.log(SPRequest::SPDebug, "htaccess: no rules applied to this request method, granting access");
1190         return shib_acl_true;
1191     }
1192     else if (sta->m_dc->bRequireAll == 1) {
1193         request.log(SPRequest::SPDebug, "htaccess: all rules successful, granting access");
1194         return shib_acl_true;
1195     }
1196     else if (sta->m_dc->bAuthoritative != 0) {
1197         request.log(SPRequest::SPDebug, "htaccess: no rules were successful, denying access");
1198         return shib_acl_false;
1199     }
1200
1201     request.log(SPRequest::SPDebug, "htaccess: no rules were successful but not authoritative, leaving it up to Apache");
1202     return shib_acl_indeterminate;
1203 }
1204
1205
1206 // Initial look at a request - create the per-request structure
1207 static int shib_post_read(request_rec *r)
1208 {
1209     shib_request_config* rc = init_request_config(r);
1210
1211     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1212
1213 #ifdef SHIB_DEFERRED_HEADERS
1214     rc->hdr_out = ap_make_table(r->pool, 5);
1215 #endif
1216     return DECLINED;
1217 }
1218
1219 // fixups: set environment vars
1220
1221 extern "C" int shib_fixups(request_rec* r)
1222 {
1223   shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1224   shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1225   if (dc->bOff==1 || dc->bUseEnvVars==0)
1226     return DECLINED;
1227
1228   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1229
1230   if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
1231         return DECLINED;
1232
1233   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1234   r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1235
1236   return OK;
1237 }
1238
1239 #ifdef SHIB_APACHE_13
1240 /*
1241  * shib_child_exit()
1242  *  Cleanup the (per-process) pool info.
1243  */
1244 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1245 {
1246     if (g_Config) {
1247         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1248         g_Config->term();
1249         g_Config = NULL;
1250         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1251     }
1252 }
1253 #else
1254 /*
1255  * shib_exit()
1256  *  Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1257  */
1258 extern "C" apr_status_t shib_exit(void* data)
1259 {
1260     if (g_Config) {
1261         g_Config->term();
1262         g_Config = NULL;
1263     }
1264     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
1265     return OK;
1266 }
1267 #endif
1268
1269 /*
1270  * shire_child_init()
1271  *  Things to do when the child process is initialized.
1272  *  (or after the configs are read in apache-2)
1273  */
1274 #ifdef SHIB_APACHE_13
1275 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1276 #else
1277 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1278 #endif
1279 {
1280     // Initialize runtime components.
1281
1282     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1283
1284     if (g_Config) {
1285         ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1286         exit(1);
1287     }
1288
1289     g_Config=&SPConfig::getConfig();
1290     g_Config->setFeatures(
1291         SPConfig::Listener |
1292         SPConfig::Caching |
1293         SPConfig::RequestMapping |
1294         SPConfig::InProcess |
1295         SPConfig::Logging |
1296         SPConfig::Handlers
1297         );
1298     if (!g_Config->init(g_szSchemaDir, g_szPrefix)) {
1299         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1300         exit(1);
1301     }
1302     g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1303     g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1304
1305     try {
1306         if (!g_Config->instantiate(g_szSHIBConfig, true))
1307             throw runtime_error("unknown error");
1308     }
1309     catch (exception& ex) {
1310         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1311         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1312         exit(1);
1313     }
1314
1315     ServiceProvider* sp=g_Config->getServiceProvider();
1316     xmltooling::Locker locker(sp);
1317     const PropertySet* props=sp->getPropertySet("Local");
1318     if (props) {
1319         pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1320         if (unsetValue.first)
1321             g_unsetHeaderValue = unsetValue.second;
1322         pair<bool,bool> flag=props->getBool("checkSpoofing");
1323         g_checkSpoofing = !flag.first || flag.second;
1324         if (g_checkSpoofing) {
1325             unsetValue=props->getString("spoofKey");
1326             if (unsetValue.first)
1327                 g_spoofKey = unsetValue.second;
1328         }
1329         flag=props->getBool("catchAll");
1330         g_catchAll = flag.first && flag.second;
1331     }
1332
1333     // Set the cleanup handler
1334     apr_pool_cleanup_register(p, NULL, &shib_exit, apr_pool_cleanup_null);
1335
1336     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1337 }
1338
1339 // Output filters
1340 #ifdef SHIB_DEFERRED_HEADERS
1341 static void set_output_filter(request_rec *r)
1342 {
1343    ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1344 }
1345
1346 static void set_error_filter(request_rec *r)
1347 {
1348    ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1349 }
1350
1351 static int _table_add(void *v, const char *key, const char *value)
1352 {
1353     apr_table_addn((apr_table_t*)v, key, value);
1354     return 1;
1355 }
1356
1357 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1358 {
1359     request_rec *r = f->r;
1360     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1361
1362     if (rc) {
1363         ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_out_filter: merging %d headers", apr_table_elts(rc->hdr_out)->nelts);
1364         apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1365         // can't use overlap call because it will collapse Set-Cookie headers
1366         //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1367     }
1368
1369     /* remove ourselves from the filter chain */
1370     ap_remove_output_filter(f);
1371
1372     /* send the data up the stack */
1373     return ap_pass_brigade(f->next,in);
1374 }
1375
1376 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1377 {
1378     request_rec *r = f->r;
1379     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1380
1381     if (rc) {
1382         ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_err_filter: merging %d headers", apr_table_elts(rc->hdr_out)->nelts);
1383         apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1384         // can't use overlap call because it will collapse Set-Cookie headers
1385         //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1386     }
1387
1388     /* remove ourselves from the filter chain */
1389     ap_remove_output_filter(f);
1390
1391     /* send the data up the stack */
1392     return ap_pass_brigade(f->next,in);
1393 }
1394 #endif // SHIB_DEFERRED_HEADERS
1395
1396 typedef const char* (*config_fn_t)(void);
1397
1398 #ifdef SHIB_APACHE_13
1399
1400 // SHIB Module commands
1401
1402 static command_rec shire_cmds[] = {
1403   {"ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1404    RSRC_CONF, TAKE1, "Shibboleth installation directory"},
1405   {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1406    RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1407   {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1408    RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1409
1410   {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1411    (void *) XtOffsetOf (shib_server_config, szScheme),
1412    RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1413
1414   {"ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1415    OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1416
1417   {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1418    (void *) XtOffsetOf (shib_dir_config, bOff),
1419    OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1420   {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1421    (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1422    OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1423   {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1424    (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1425    OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1426   {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1427    (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1428    OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1429   {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1430    (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1431    OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1432   {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1433    (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1434    OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1435   {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1436    (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1437    OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1438   {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1439    (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1440    OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1441   {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1442    (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1443    OR_AUTHCFG, FLAG, "All require directives must match"},
1444   {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1445    (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1446    OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1447   {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1448    (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1449    OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1450   {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1451    (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1452    OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1453
1454   {NULL}
1455 };
1456
1457 extern "C"{
1458 handler_rec shib_handlers[] = {
1459   { "shib-handler", shib_handler },
1460   { NULL }
1461 };
1462
1463 module MODULE_VAR_EXPORT mod_shib = {
1464     STANDARD_MODULE_STUFF,
1465     NULL,                        /* initializer */
1466     create_shib_dir_config,     /* dir config creater */
1467     merge_shib_dir_config,      /* dir merger --- default is to override */
1468     create_shib_server_config, /* server config */
1469     merge_shib_server_config,   /* merge server config */
1470     shire_cmds,                 /* command table */
1471     shib_handlers,              /* handlers */
1472     NULL,                       /* filename translation */
1473     shib_check_user,            /* check_user_id */
1474     shib_auth_checker,          /* check auth */
1475     NULL,                       /* check access */
1476     NULL,                       /* type_checker */
1477     shib_fixups,                /* fixups */
1478     NULL,                       /* logger */
1479     NULL,                       /* header parser */
1480     shib_child_init,            /* child_init */
1481     shib_child_exit,            /* child_exit */
1482     shib_post_read              /* post read-request */
1483 };
1484
1485 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1486
1487 extern "C" void shib_register_hooks (apr_pool_t *p)
1488 {
1489 #ifdef SHIB_DEFERRED_HEADERS
1490   ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1491   ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1492   ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1493   ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1494   ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1495 #endif
1496   ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1497   ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1498   ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1499   ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1500   ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1501 }
1502
1503 // SHIB Module commands
1504
1505 extern "C" {
1506 static command_rec shib_cmds[] = {
1507     AP_INIT_TAKE1("ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1508         RSRC_CONF, "Shibboleth installation directory"),
1509     AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1510         RSRC_CONF, "Path to shibboleth.xml config file"),
1511     AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1512         RSRC_CONF, "Paths of XML schema catalogs"),
1513
1514     AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1515         (void *) offsetof (shib_server_config, szScheme),
1516         RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1517
1518     AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1519         OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1520
1521     AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1522         (void *) offsetof (shib_dir_config, bOff),
1523         OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1524     AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1525         (void *) offsetof (shib_dir_config, szApplicationId),
1526         OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1527     AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1528         (void *) offsetof (shib_dir_config, bBasicHijack),
1529         OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1530     AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1531         (void *) offsetof (shib_dir_config, bRequireSession),
1532         OR_AUTHCFG, "Initiates a new session if one does not exist"),
1533     AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1534         (void *) offsetof (shib_dir_config, szRequireWith),
1535         OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1536     AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1537         (void *) offsetof (shib_dir_config, bExportAssertion),
1538         OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1539     AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1540         (void *) offsetof (shib_dir_config, szRedirectToSSL),
1541         OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1542     AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1543         (void *) offsetof (shib_dir_config, szAuthGrpFile),
1544         OR_AUTHCFG, "Text file containing group names and member user IDs"),
1545     AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1546         (void *) offsetof (shib_dir_config, bRequireAll),
1547         OR_AUTHCFG, "All require directives must match"),
1548     AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1549         (void *) offsetof (shib_dir_config, bAuthoritative),
1550         OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1551     AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1552         (void *) offsetof (shib_dir_config, bUseEnvVars),
1553         OR_AUTHCFG, "Export attributes using environment variables (default)"),
1554     AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1555         (void *) offsetof (shib_dir_config, bUseHeaders),
1556         OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1557
1558     {NULL}
1559 };
1560
1561 module AP_MODULE_DECLARE_DATA mod_shib = {
1562     STANDARD20_MODULE_STUFF,
1563     create_shib_dir_config,     /* create dir config */
1564     merge_shib_dir_config,      /* merge dir config --- default is to override */
1565     create_shib_server_config,  /* create server config */
1566     merge_shib_server_config,   /* merge server config */
1567     shib_cmds,                  /* command table */
1568     shib_register_hooks         /* register hooks */
1569 };
1570
1571 #else
1572 #error "unsupported Apache version"
1573 #endif
1574
1575 }