501ac8ec12a299d9a683bc0c229b0e8e027618af
[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         if (!m_rc->hdr_out)
526             m_rc->hdr_out = ap_make_table(m_req->pool, 5);
527         ap_table_add(m_rc->hdr_out, name, value);
528     }
529     else
530 #endif
531     ap_table_add(m_req->err_headers_out, name, value);
532   }
533   long sendResponse(istream& in, long status) {
534     if (status != XMLTOOLING_HTTP_STATUS_OK)
535         m_req->status = status;
536     ap_send_http_header(m_req);
537     char buf[1024];
538     while (in) {
539         in.read(buf,1024);
540         ap_rwrite(buf,in.gcount(),m_req);
541     }
542 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22))
543     if (status != XMLTOOLING_HTTP_STATUS_OK && status != XMLTOOLING_HTTP_STATUS_ERROR)
544         return status;
545 #endif
546     return DONE;
547   }
548   long sendRedirect(const char* url) {
549     ap_table_set(m_req->headers_out, "Location", url);
550     return REDIRECT;
551   }
552   const vector<string>& getClientCertificates() const {
553       if (m_certs.empty()) {
554           const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
555           if (cert)
556               m_certs.push_back(cert);
557           int i = 0;
558           do {
559               cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
560               if (cert)
561                   m_certs.push_back(cert);
562           } while (cert);
563       }
564       return m_certs;
565   }
566   long returnDecline(void) { return DECLINED; }
567   long returnOK(void) { return OK; }
568 };
569
570 /********************************************************************************/
571 // Apache handlers
572
573 extern "C" int shib_check_user(request_rec* r)
574 {
575   // Short-circuit entirely?
576   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
577     return DECLINED;
578
579   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
580
581   ostringstream threadid;
582   threadid << "[" << getpid() << "] shib_check_user" << '\0';
583   xmltooling::NDC ndc(threadid.str().c_str());
584
585   try {
586     ShibTargetApache sta(r,false,true);
587
588     // Check user authentication and export information, then set the handler bypass
589     pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
590     apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
591     // If directed, install a spoof key to recognize when we've already cleared headers.
592     if (!g_spoofKey.empty() && (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bUseHeaders==1))
593         ap_table_set(r->headers_in, "Shib-Spoof-Check", g_spoofKey.c_str());
594     if (res.first) return res.second;
595
596     // user auth was okay -- export the assertions now
597     res = sta.getServiceProvider().doExport(sta);
598     if (res.first) return res.second;
599
600     // export happened successfully..  this user is ok.
601     return OK;
602   }
603   catch (exception& e) {
604     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
605     return SERVER_ERROR;
606   }
607   catch (...) {
608     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an unknown exception!");
609     if (g_catchAll)
610       return SERVER_ERROR;
611     throw;
612   }
613 }
614
615 extern "C" int shib_handler(request_rec* r)
616 {
617   // Short-circuit entirely?
618   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
619     return DECLINED;
620
621   ostringstream threadid;
622   threadid << "[" << getpid() << "] shib_handler" << '\0';
623   xmltooling::NDC ndc(threadid.str().c_str());
624
625 #ifndef SHIB_APACHE_13
626   // With 2.x, this handler always runs, though last.
627   // We check if shib_check_user ran, because it will detect a handler request
628   // and dispatch it directly.
629   void* data;
630   apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
631   if (data==(const void*)42) {
632     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
633     return DECLINED;
634   }
635 #endif
636
637   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
638
639   try {
640     ShibTargetApache sta(r,true,false);
641
642     pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
643     if (res.first) return res.second;
644
645     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
646     return SERVER_ERROR;
647   }
648   catch (exception& e) {
649     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
650     return SERVER_ERROR;
651   }
652   catch (...) {
653     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an unknown exception!");
654     if (g_catchAll)
655       return SERVER_ERROR;
656     throw;
657   }
658 }
659
660 /*
661  * shib_auth_checker() -- a simple resource manager to
662  * process the .htaccess settings
663  */
664 extern "C" int shib_auth_checker(request_rec* r)
665 {
666   // Short-circuit entirely?
667   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
668     return DECLINED;
669
670   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
671
672   ostringstream threadid;
673   threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
674   xmltooling::NDC ndc(threadid.str().c_str());
675
676   try {
677     ShibTargetApache sta(r,false,false);
678
679     pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
680     if (res.first) return res.second;
681
682     // The SP method should always return true, so if we get this far, something unusual happened.
683     // Just let Apache (or some other module) decide what to do.
684     return DECLINED;
685   }
686   catch (exception& e) {
687     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
688     return SERVER_ERROR;
689   }
690   catch (...) {
691     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an unknown exception!");
692     if (g_catchAll)
693       return SERVER_ERROR;
694     throw;
695   }
696 }
697
698 // Access control plugin that enforces htaccess rules
699 class htAccessControl : virtual public AccessControl
700 {
701 public:
702     htAccessControl() {}
703     ~htAccessControl() {}
704     Lockable* lock() {return this;}
705     void unlock() {}
706     aclresult_t authorized(const SPRequest& request, const Session* session) const;
707 private:
708     bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
709 };
710
711 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
712 {
713     return new htAccessControl();
714 }
715
716 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
717 {
718 public:
719     ApacheRequestMapper(const xercesc::DOMElement* e);
720     ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
721     Lockable* lock() { return m_mapper->lock(); }
722     void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
723     Settings getSettings(const HTTPRequest& request) const;
724
725     const PropertySet* getParent() const { return NULL; }
726     void setParent(const PropertySet*) {}
727     pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
728     pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
729     pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
730     pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
731     pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
732     void getAll(map<string,const char*>& properties) const;
733     const PropertySet* getPropertySet(const char* name, const char* ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const;
734     const xercesc::DOMElement* getElement() const;
735
736 private:
737     RequestMapper* m_mapper;
738     ThreadKey* m_staKey;
739     ThreadKey* m_propsKey;
740     AccessControl* m_htaccess;
741 };
742
743 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
744 {
745     return new ApacheRequestMapper(e);
746 }
747
748 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
749 {
750     m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
751     m_htaccess=new htAccessControl();
752     m_staKey=ThreadKey::create(NULL);
753     m_propsKey=ThreadKey::create(NULL);
754 }
755
756 RequestMapper::Settings ApacheRequestMapper::getSettings(const HTTPRequest& request) const
757 {
758     Settings s=m_mapper->getSettings(request);
759     m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
760     m_propsKey->setData((void*)s.first);
761     return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
762 }
763
764 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
765 {
766     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
767     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
768     if (sta && !ns) {
769         // Override Apache-settable boolean properties.
770         if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
771             return make_pair(true, sta->m_dc->bRequireSession==1);
772         else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
773             return make_pair(true, sta->m_dc->bExportAssertion==1);
774         else if (sta->m_dc->tSettings) {
775             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
776             if (prop)
777                 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
778         }
779     }
780     return s ? s->getBool(name,ns) : make_pair(false,false);
781 }
782
783 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
784 {
785     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
786     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
787     if (sta && !ns) {
788         // Override Apache-settable string properties.
789         if (name && !strcmp(name,"authType")) {
790             const char *auth_type=ap_auth_type(sta->m_req);
791             if (auth_type) {
792                 // Check for Basic Hijack
793                 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
794                     auth_type = "shibboleth";
795                 return make_pair(true,auth_type);
796             }
797         }
798         else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
799             return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
800         else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
801             return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
802         else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
803             return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
804         else if (sta->m_dc->tSettings) {
805             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
806             if (prop)
807                 return make_pair(true, prop);
808         }
809     }
810     return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
811 }
812
813 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
814 {
815     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
816     return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
817 }
818
819 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
820 {
821     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
822     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
823     if (sta && !ns) {
824         // Override Apache-settable int properties.
825         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
826             return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, NULL, 10));
827         else if (sta->m_dc->tSettings) {
828             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
829             if (prop)
830                 return pair<bool,unsigned int>(true, atoi(prop));
831         }
832     }
833     return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
834 }
835
836 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
837 {
838     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
839     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
840     if (sta && !ns) {
841         // Override Apache-settable int properties.
842         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
843             return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
844         else if (sta->m_dc->tSettings) {
845             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
846             if (prop)
847                 return make_pair(true, atoi(prop));
848         }
849     }
850     return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
851 }
852
853 void ApacheRequestMapper::getAll(map<string,const char*>& properties) const
854 {
855     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
856     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
857
858     if (s)
859         s->getAll(properties);
860     if (!sta)
861         return;
862
863     const char* auth_type=ap_auth_type(sta->m_req);
864     if (auth_type) {
865         // Check for Basic Hijack
866         if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
867             auth_type = "shibboleth";
868         properties["authType"] = auth_type;
869     }
870
871     if (sta->m_dc->szApplicationId)
872         properties["applicationId"] = sta->m_dc->szApplicationId;
873     if (sta->m_dc->szRequireWith)
874         properties["requireSessionWith"] = sta->m_dc->szRequireWith;
875     if (sta->m_dc->szRedirectToSSL)
876         properties["redirectToSSL"] = sta->m_dc->szRedirectToSSL;
877     if (sta->m_dc->bRequireSession != 0)
878         properties["requireSession"] = (sta->m_dc->bRequireSession==1) ? "true" : "false";
879     if (sta->m_dc->bExportAssertion != 0)
880         properties["exportAssertion"] = (sta->m_dc->bExportAssertion==1) ? "true" : "false";
881 }
882
883 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
884 {
885     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
886     return s ? s->getPropertySet(name,ns) : NULL;
887 }
888
889 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
890 {
891     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
892     return s ? s->getElement() : NULL;
893 }
894
895 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
896 {
897     SH_AP_CONFIGFILE* f;
898     SH_AP_TABLE* grps=ap_make_table(r->pool,15);
899     char l[MAX_STRING_LEN];
900     const char *group_name, *ll, *w;
901
902 #ifdef SHIB_APACHE_13
903     if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
904 #else
905     if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
906 #endif
907         ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
908         return NULL;
909     }
910
911     SH_AP_POOL* sp;
912 #ifdef SHIB_APACHE_13
913     sp=ap_make_sub_pool(r->pool);
914 #else
915     if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
916         ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
917             "groups_for_user() could not create a subpool");
918         return NULL;
919     }
920 #endif
921
922     while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
923         if ((*l=='#') || (!*l))
924             continue;
925         ll = l;
926         ap_clear_pool(sp);
927
928         group_name=ap_getword(sp,&ll,':');
929
930         while (*ll) {
931             w=ap_getword_conf(sp,&ll);
932             if (!strcmp(w,user)) {
933                 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
934                 break;
935             }
936         }
937     }
938     ap_cfg_closefile(f);
939     ap_destroy_pool(sp);
940     return grps;
941 }
942
943 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
944 {
945     bool caseSensitive = attr->isCaseSensitive();
946     const vector<string>& vals = attr->getSerializedValues();
947     for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
948         if (re) {
949             auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
950             if (re->matches(trans.get())) {
951                 if (request.isPriorityEnabled(SPRequest::SPDebug))
952                     request.log(SPRequest::SPDebug, string("htaccess: expecting regexp ") + toMatch + ", got " + *v + ": acccepted");
953                 return true;
954             }
955         }
956         else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
957             if (request.isPriorityEnabled(SPRequest::SPDebug))
958                 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": accepted");
959             return true;
960         }
961         else if (request.isPriorityEnabled(SPRequest::SPDebug)) {
962             request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": rejected");
963         }
964     }
965     return false;
966 }
967
968 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
969 {
970     // Make sure the object is our type.
971     const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
972     if (!sta)
973         throw ConfigurationException("Request wrapper object was not of correct type.");
974
975     // mod_auth clone
976
977     int m=sta->m_req->method_number;
978     bool method_restricted=false;
979     const char *t, *w;
980
981     const array_header* reqs_arr=ap_requires(sta->m_req);
982     if (!reqs_arr)
983         return shib_acl_indeterminate;  // should never happen
984
985     require_line* reqs=(require_line*)reqs_arr->elts;
986
987     for (int x=0; x<reqs_arr->nelts; x++) {
988         // This rule should be completely ignored, the method doesn't fit.
989         // The rule just doesn't exist for our purposes.
990         if (!(reqs[x].method_mask & (1 << m)))
991             continue;
992
993         method_restricted=true; // this lets us know at the end that at least one rule was potentially enforcable.
994
995         // Tracks status of this rule's evaluation.
996         bool status = false;
997
998         string remote_user = request.getRemoteUser();
999
1000         t = reqs[x].requirement;
1001         w = ap_getword_white(sta->m_req->pool, &t);
1002
1003         if (!strcasecmp(w,"shibboleth")) {
1004             // This is a dummy rule needed because Apache conflates authn and authz.
1005             // Without some require rule, AuthType is ignored and no check_user hooks run.
1006             status = true;  // treat it as an "accepted" rule
1007         }
1008         else if (!strcmp(w,"valid-user") && session) {
1009             request.log(SPRequest::SPDebug, "htaccess: accepting valid-user based on active session");
1010             status = true;
1011         }
1012         else if (!strcmp(w,"user") && !remote_user.empty()) {
1013             bool regexp=false,negate=false;
1014             while (*t) {
1015                 w=ap_getword_conf(sta->m_req->pool,&t);
1016                 if (*w=='~') {
1017                     regexp=true;
1018                     continue;
1019                 }
1020                 else if (*w=='!') {
1021                     negate=true;
1022                     if (*(w+1)=='~')
1023                         regexp=true;
1024                     continue;
1025                 }
1026
1027                 // Figure out if there's a match.
1028                 bool match = false;
1029                 if (regexp) {
1030                     try {
1031                         // To do regex matching, we have to convert from UTF-8.
1032                         auto_arrayptr<XMLCh> trans(fromUTF8(w));
1033                         RegularExpression re(trans.get());
1034                         auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
1035                         match = re.matches(trans2.get());
1036                     }
1037                     catch (XMLException& ex) {
1038                         auto_ptr_char tmp(ex.getMessage());
1039                         request.log(SPRequest::SPError,
1040                             string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1041                     }
1042                 }
1043                 else if (remote_user==w) {
1044                     match = true;
1045                 }
1046
1047                 if (match) {
1048                     // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1049                     status = !negate;
1050                     if (request.isPriorityEnabled(SPRequest::SPDebug))
1051                         request.log(SPRequest::SPDebug,
1052                             string("htaccess: require user ") + (negate ? "rejecting (" : "accepting (") + remote_user + ")");
1053                     break;
1054                 }
1055             }
1056         }
1057         else if (!strcmp(w,"group")  && !remote_user.empty()) {
1058             SH_AP_TABLE* grpstatus=NULL;
1059             if (sta->m_dc->szAuthGrpFile) {
1060                 if (request.isPriorityEnabled(SPRequest::SPDebug))
1061                     request.log(SPRequest::SPDebug,string("htaccess plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
1062                 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
1063             }
1064
1065             bool negate=false;
1066             while (*t) {
1067                 w=ap_getword_conf(sta->m_req->pool,&t);
1068                 if (*w=='!') {
1069                     negate=true;
1070                     continue;
1071                 }
1072
1073                 if (grpstatus && ap_table_get(grpstatus,w)) {
1074                     // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1075                     status = !negate;
1076                     request.log(SPRequest::SPDebug, string("htaccess: require group ") + (negate ? "rejecting (" : "accepting (") + w + ")");
1077                     break;
1078                 }
1079             }
1080         }
1081         else if (!strcmp(w,"authnContextClassRef") || !strcmp(w,"authnContextDeclRef")) {
1082             const char* ref = !strcmp(w,"authnContextClassRef") ? session->getAuthnContextClassRef() : session->getAuthnContextDeclRef();
1083             bool regexp=false,negate=false;
1084             while (ref && *t) {
1085                 w=ap_getword_conf(sta->m_req->pool,&t);
1086                 if (*w=='~') {
1087                     regexp=true;
1088                     continue;
1089                 }
1090                 else if (*w=='!') {
1091                     negate=true;
1092                     if (*(w+1)=='~')
1093                         regexp=true;
1094                     continue;
1095                 }
1096
1097                 // Figure out if there's a match.
1098                 bool match = false;
1099                 if (regexp) {
1100                     try {
1101                         // To do regex matching, we have to convert from UTF-8.
1102                         RegularExpression re(w);
1103                         match = re.matches(ref);
1104                     }
1105                     catch (XMLException& ex) {
1106                         auto_ptr_char tmp(ex.getMessage());
1107                         request.log(SPRequest::SPError,
1108                             string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1109                     }
1110                 }
1111                 else if (!strcmp(w,ref)) {
1112                     match = true;
1113                 }
1114
1115                 if (match) {
1116                     // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1117                     status = !negate;
1118                     if (request.isPriorityEnabled(SPRequest::SPDebug))
1119                         request.log(SPRequest::SPDebug,
1120                             string("htaccess: require authnContext ") + (negate ? "rejecting (" : "accepting (") + ref + ")");
1121                     break;
1122                 }
1123             }
1124         }
1125         else if (!session) {
1126             request.log(SPRequest::SPError, string("htaccess: require ") + w + " not given a valid session, are you using lazy sessions?");
1127         }
1128         else {
1129             // Find the attribute(s) matching the require rule.
1130             pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1131                 session->getIndexedAttributes().equal_range(w);
1132
1133             bool regexp=false;
1134             while (!status && attrs.first!=attrs.second && *t) {
1135                 w=ap_getword_conf(sta->m_req->pool,&t);
1136                 if (*w=='~') {
1137                     regexp=true;
1138                     continue;
1139                 }
1140
1141                 try {
1142                     auto_ptr<RegularExpression> re;
1143                     if (regexp) {
1144                         delete re.release();
1145                         auto_arrayptr<XMLCh> trans(fromUTF8(w));
1146                         auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1147                         re=temp;
1148                     }
1149
1150                     for (; !status && attrs.first!=attrs.second; ++attrs.first) {
1151                         if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
1152                             status = true;
1153                         }
1154                     }
1155                 }
1156                 catch (XMLException& ex) {
1157                     auto_ptr_char tmp(ex.getMessage());
1158                     request.log(SPRequest::SPError,
1159                         string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1160                         );
1161                 }
1162             }
1163         }
1164
1165         // If status is false, we found a rule we couldn't satisfy.
1166         // Could be an unknown rule to us, or it just didn't match.
1167
1168         if (status && sta->m_dc->bRequireAll != 1) {
1169             // If we're not insisting that all rules be met, then we're done.
1170             request.log(SPRequest::SPDebug, "htaccess: a rule was successful, granting access");
1171             return shib_acl_true;
1172         }
1173         else if (!status && sta->m_dc->bRequireAll == 1) {
1174             // If we're insisting that all rules be met, which is not something Apache really handles well,
1175             // then we either return false or indeterminate based on the authoritative option, which defaults on.
1176             if (sta->m_dc->bAuthoritative != 0) {
1177                 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful, denying access");
1178                 return shib_acl_false;
1179             }
1180
1181             request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful but not authoritative, leaving it up to Apache");
1182             return shib_acl_indeterminate;
1183         }
1184
1185         // Otherwise, we keep going. If we're requring all, then we have to check every rule.
1186         // If not we just didn't find a successful rule yet, so we keep going anyway.
1187     }
1188
1189     // If we get here, we either "failed" or we're in require all mode (but not both).
1190     // If no rules possibly apply or we insisted that all rules check out, then we're good.
1191     if (!method_restricted) {
1192         request.log(SPRequest::SPDebug, "htaccess: no rules applied to this request method, granting access");
1193         return shib_acl_true;
1194     }
1195     else if (sta->m_dc->bRequireAll == 1) {
1196         request.log(SPRequest::SPDebug, "htaccess: all rules successful, granting access");
1197         return shib_acl_true;
1198     }
1199     else if (sta->m_dc->bAuthoritative != 0) {
1200         request.log(SPRequest::SPDebug, "htaccess: no rules were successful, denying access");
1201         return shib_acl_false;
1202     }
1203
1204     request.log(SPRequest::SPDebug, "htaccess: no rules were successful but not authoritative, leaving it up to Apache");
1205     return shib_acl_indeterminate;
1206 }
1207
1208
1209 // Initial look at a request - create the per-request structure
1210 static int shib_post_read(request_rec *r)
1211 {
1212     shib_request_config* rc = init_request_config(r);
1213     //ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1214     return DECLINED;
1215 }
1216
1217 // fixups: set environment vars
1218
1219 extern "C" int shib_fixups(request_rec* r)
1220 {
1221   shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1222   shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1223   if (dc->bOff==1 || dc->bUseEnvVars==0)
1224     return DECLINED;
1225
1226   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1227
1228   if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
1229         return DECLINED;
1230
1231   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1232   r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1233
1234   return OK;
1235 }
1236
1237 #ifdef SHIB_APACHE_13
1238 /*
1239  * shib_child_exit()
1240  *  Cleanup the (per-process) pool info.
1241  */
1242 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1243 {
1244     if (g_Config) {
1245         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1246         g_Config->term();
1247         g_Config = NULL;
1248         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1249     }
1250 }
1251 #else
1252 /*
1253  * shib_exit()
1254  *  Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1255  */
1256 extern "C" apr_status_t shib_exit(void* data)
1257 {
1258     if (g_Config) {
1259         g_Config->term();
1260         g_Config = NULL;
1261     }
1262     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
1263     return OK;
1264 }
1265 #endif
1266
1267 /*
1268  * shire_child_init()
1269  *  Things to do when the child process is initialized.
1270  *  (or after the configs are read in apache-2)
1271  */
1272 #ifdef SHIB_APACHE_13
1273 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1274 #else
1275 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1276 #endif
1277 {
1278     // Initialize runtime components.
1279
1280     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1281
1282     if (g_Config) {
1283         ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1284         exit(1);
1285     }
1286
1287     g_Config=&SPConfig::getConfig();
1288     g_Config->setFeatures(
1289         SPConfig::Listener |
1290         SPConfig::Caching |
1291         SPConfig::RequestMapping |
1292         SPConfig::InProcess |
1293         SPConfig::Logging |
1294         SPConfig::Handlers
1295         );
1296     if (!g_Config->init(g_szSchemaDir, g_szPrefix)) {
1297         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1298         exit(1);
1299     }
1300     g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1301     g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1302
1303     try {
1304         if (!g_Config->instantiate(g_szSHIBConfig, true))
1305             throw runtime_error("unknown error");
1306     }
1307     catch (exception& ex) {
1308         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1309         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1310         exit(1);
1311     }
1312
1313     ServiceProvider* sp=g_Config->getServiceProvider();
1314     xmltooling::Locker locker(sp);
1315     const PropertySet* props=sp->getPropertySet("Local");
1316     if (props) {
1317         pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1318         if (unsetValue.first)
1319             g_unsetHeaderValue = unsetValue.second;
1320         pair<bool,bool> flag=props->getBool("checkSpoofing");
1321         g_checkSpoofing = !flag.first || flag.second;
1322         if (g_checkSpoofing) {
1323             unsetValue=props->getString("spoofKey");
1324             if (unsetValue.first)
1325                 g_spoofKey = unsetValue.second;
1326         }
1327         flag=props->getBool("catchAll");
1328         g_catchAll = flag.first && flag.second;
1329     }
1330
1331     // Set the cleanup handler
1332     apr_pool_cleanup_register(p, NULL, &shib_exit, apr_pool_cleanup_null);
1333
1334     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1335 }
1336
1337 // Output filters
1338 #ifdef SHIB_DEFERRED_HEADERS
1339 static void set_output_filter(request_rec *r)
1340 {
1341    ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1342 }
1343
1344 static void set_error_filter(request_rec *r)
1345 {
1346    ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1347 }
1348
1349 static int _table_add(void *v, const char *key, const char *value)
1350 {
1351     apr_table_addn((apr_table_t*)v, key, value);
1352     return 1;
1353 }
1354
1355 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1356 {
1357     request_rec *r = f->r;
1358     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1359
1360     if (rc && rc->hdr_out) {
1361         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);
1362         // can't use overlap call because it will collapse Set-Cookie headers
1363         //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1364         apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1365     }
1366
1367     /* remove ourselves from the filter chain */
1368     ap_remove_output_filter(f);
1369
1370     /* send the data up the stack */
1371     return ap_pass_brigade(f->next,in);
1372 }
1373
1374 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1375 {
1376     request_rec *r = f->r;
1377     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1378
1379     if (rc && rc->hdr_out) {
1380         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);
1381         // can't use overlap call because it will collapse Set-Cookie headers
1382         //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1383         apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1384     }
1385
1386     /* remove ourselves from the filter chain */
1387     ap_remove_output_filter(f);
1388
1389     /* send the data up the stack */
1390     return ap_pass_brigade(f->next,in);
1391 }
1392 #endif // SHIB_DEFERRED_HEADERS
1393
1394 typedef const char* (*config_fn_t)(void);
1395
1396 #ifdef SHIB_APACHE_13
1397
1398 // SHIB Module commands
1399
1400 static command_rec shire_cmds[] = {
1401   {"ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1402    RSRC_CONF, TAKE1, "Shibboleth installation directory"},
1403   {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1404    RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1405   {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1406    RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1407
1408   {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1409    (void *) XtOffsetOf (shib_server_config, szScheme),
1410    RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1411
1412   {"ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1413    OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1414
1415   {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1416    (void *) XtOffsetOf (shib_dir_config, bOff),
1417    OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1418   {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1419    (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1420    OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1421   {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1422    (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1423    OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1424   {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1425    (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1426    OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1427   {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1428    (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1429    OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1430   {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1431    (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1432    OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1433   {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1434    (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1435    OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1436   {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1437    (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1438    OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1439   {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1440    (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1441    OR_AUTHCFG, FLAG, "All require directives must match"},
1442   {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1443    (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1444    OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1445   {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1446    (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1447    OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1448   {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1449    (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1450    OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1451
1452   {NULL}
1453 };
1454
1455 extern "C"{
1456 handler_rec shib_handlers[] = {
1457   { "shib-handler", shib_handler },
1458   { NULL }
1459 };
1460
1461 module MODULE_VAR_EXPORT mod_shib = {
1462     STANDARD_MODULE_STUFF,
1463     NULL,                        /* initializer */
1464     create_shib_dir_config,     /* dir config creater */
1465     merge_shib_dir_config,      /* dir merger --- default is to override */
1466     create_shib_server_config, /* server config */
1467     merge_shib_server_config,   /* merge server config */
1468     shire_cmds,                 /* command table */
1469     shib_handlers,              /* handlers */
1470     NULL,                       /* filename translation */
1471     shib_check_user,            /* check_user_id */
1472     shib_auth_checker,          /* check auth */
1473     NULL,                       /* check access */
1474     NULL,                       /* type_checker */
1475     shib_fixups,                /* fixups */
1476     NULL,                       /* logger */
1477     NULL,                       /* header parser */
1478     shib_child_init,            /* child_init */
1479     shib_child_exit,            /* child_exit */
1480     shib_post_read              /* post read-request */
1481 };
1482
1483 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1484
1485 extern "C" void shib_register_hooks (apr_pool_t *p)
1486 {
1487 #ifdef SHIB_DEFERRED_HEADERS
1488   ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1489   ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1490   ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1491   ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1492   ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1493 #endif
1494   ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1495   ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1496   ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1497   ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1498   ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1499 }
1500
1501 // SHIB Module commands
1502
1503 extern "C" {
1504 static command_rec shib_cmds[] = {
1505     AP_INIT_TAKE1("ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1506         RSRC_CONF, "Shibboleth installation directory"),
1507     AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1508         RSRC_CONF, "Path to shibboleth.xml config file"),
1509     AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1510         RSRC_CONF, "Paths of XML schema catalogs"),
1511
1512     AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1513         (void *) offsetof (shib_server_config, szScheme),
1514         RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1515
1516     AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1517         OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1518
1519     AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1520         (void *) offsetof (shib_dir_config, bOff),
1521         OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1522     AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1523         (void *) offsetof (shib_dir_config, szApplicationId),
1524         OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1525     AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1526         (void *) offsetof (shib_dir_config, bBasicHijack),
1527         OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1528     AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1529         (void *) offsetof (shib_dir_config, bRequireSession),
1530         OR_AUTHCFG, "Initiates a new session if one does not exist"),
1531     AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1532         (void *) offsetof (shib_dir_config, szRequireWith),
1533         OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1534     AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1535         (void *) offsetof (shib_dir_config, bExportAssertion),
1536         OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1537     AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1538         (void *) offsetof (shib_dir_config, szRedirectToSSL),
1539         OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1540     AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1541         (void *) offsetof (shib_dir_config, szAuthGrpFile),
1542         OR_AUTHCFG, "Text file containing group names and member user IDs"),
1543     AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1544         (void *) offsetof (shib_dir_config, bRequireAll),
1545         OR_AUTHCFG, "All require directives must match"),
1546     AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1547         (void *) offsetof (shib_dir_config, bAuthoritative),
1548         OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1549     AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1550         (void *) offsetof (shib_dir_config, bUseEnvVars),
1551         OR_AUTHCFG, "Export attributes using environment variables (default)"),
1552     AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1553         (void *) offsetof (shib_dir_config, bUseHeaders),
1554         OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1555
1556     {NULL}
1557 };
1558
1559 module AP_MODULE_DECLARE_DATA mod_shib = {
1560     STANDARD20_MODULE_STUFF,
1561     create_shib_dir_config,     /* create dir config */
1562     merge_shib_dir_config,      /* merge dir config --- default is to override */
1563     create_shib_server_config,  /* create server config */
1564     merge_shib_server_config,   /* merge server config */
1565     shib_cmds,                  /* command table */
1566     shib_register_hooks         /* register hooks */
1567 };
1568
1569 #else
1570 #error "unsupported Apache version"
1571 #endif
1572
1573 }