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