ccbc0c3802680ce78034b6fe4827b18ca02a1785
[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 -- the core Apache Module code
19  *
20  * Created by:  Derek Atkins <derek@ihtfp.com>
21  *
22  * $Id$
23  */
24
25 #define SHIBSP_LITE
26
27 #ifdef SOLARIS2
28 #undef _XOPEN_SOURCE    // causes gethostname conflict in unistd.h
29 #endif
30
31 #ifdef WIN32
32 # define _CRT_NONSTDC_NO_DEPRECATE 1
33 # define _CRT_SECURE_NO_DEPRECATE 1
34 #endif
35
36 #include <shibsp/AbstractSPRequest.h>
37 #include <shibsp/AccessControl.h>
38 #include <shibsp/exceptions.h>
39 #include <shibsp/RequestMapper.h>
40 #include <shibsp/SPConfig.h>
41 #include <shibsp/ServiceProvider.h>
42 #include <shibsp/SessionCache.h>
43 #include <shibsp/attribute/Attribute.h>
44
45 #include <xercesc/util/regx/RegularExpression.hpp>
46 #include <xmltooling/XMLToolingConfig.h>
47 #include <xmltooling/util/NDC.h>
48 #include <xmltooling/util/Threads.h>
49 #include <xmltooling/util/XMLConstants.h>
50 #include <xmltooling/util/XMLHelper.h>
51
52 #ifdef WIN32
53 # include <winsock.h>
54 #endif
55
56 #undef _XPG4_2
57
58 // Apache specific header files
59 #include <httpd.h>
60 #include <http_config.h>
61 #include <http_protocol.h>
62 #include <http_main.h>
63 #define CORE_PRIVATE
64 #include <http_core.h>
65 #include <http_log.h>
66
67 #ifndef SHIB_APACHE_13
68 #include <http_request.h>
69 #include <apr_strings.h>
70 #include <apr_pools.h>
71 #endif
72
73 #include <fstream>
74 #include <sstream>
75
76 #ifdef HAVE_UNISTD_H
77 #include <unistd.h>             // for getpid()
78 #endif
79
80 using namespace shibsp;
81 using namespace xmltooling;
82 using namespace std;
83 using xercesc::RegularExpression;
84 using xercesc::XMLException;
85
86 extern "C" module MODULE_VAR_EXPORT mod_shib;
87
88 namespace {
89     char* g_szSHIBConfig = SHIBSP_CONFIG;
90     char* g_szSchemaDir = SHIBSP_SCHEMAS;
91     SPConfig* g_Config = NULL;
92     string g_unsetHeaderValue;
93     static const char* g_UserDataKey = "_shib_check_user_";
94     static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
95     static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
96 }
97
98 /* Apache 2.2.x headers must be accumulated and set in the output filter.
99    Apache 2.0.49+ supports the filter method.
100    Apache 1.3.x and lesser 2.0.x must write the headers directly. */
101
102 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
103 #define SHIB_DEFERRED_HEADERS
104 #endif
105
106 /********************************************************************************/
107 // Basic Apache Configuration code.
108 //
109
110 // per-server module configuration structure
111 struct shib_server_config
112 {
113     char* szScheme;
114 };
115
116 // creates the per-server configuration
117 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
118 {
119     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
120     sc->szScheme = NULL;
121     return sc;
122 }
123
124 // overrides server configuration in virtual servers
125 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
126 {
127     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
128     shib_server_config* parent=(shib_server_config*)base;
129     shib_server_config* child=(shib_server_config*)sub;
130
131     if (child->szScheme)
132         sc->szScheme=ap_pstrdup(p,child->szScheme);
133     else if (parent->szScheme)
134         sc->szScheme=ap_pstrdup(p,parent->szScheme);
135     else
136         sc->szScheme=NULL;
137
138     return sc;
139 }
140
141 // per-dir module configuration structure
142 struct shib_dir_config
143 {
144     // RM Configuration
145     char* szAuthGrpFile;    // Auth GroupFile name
146     int bRequireAll;        // all require directives must match, otherwise OR logic
147
148     // Content Configuration
149     char* szApplicationId;  // Shib applicationId value
150     char* szRequireWith;    // require a session using a specific initiator?
151     char* szRedirectToSSL;  // redirect non-SSL requests to SSL port
152     int bOff;               // flat-out disable all Shib processing
153     int bBasicHijack;       // activate for AuthType Basic?
154     int bRequireSession;    // require a session?
155     int bExportAssertion;   // export SAML assertion to the environment?
156     int bUseEnvVars;        // use environment instead of headers?
157 };
158
159 // creates per-directory config structure
160 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
161 {
162     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
163     dc->bOff = -1;
164     dc->bBasicHijack = -1;
165     dc->bRequireSession = -1;
166     dc->bExportAssertion = -1;
167     dc->bRequireAll = -1;
168     dc->szRedirectToSSL = NULL;
169     dc->szAuthGrpFile = NULL;
170     dc->szApplicationId = NULL;
171     dc->szRequireWith = NULL;
172     dc->bUseEnvVars = -1;
173     return dc;
174 }
175
176 // overrides server configuration in directories
177 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
178 {
179     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
180     shib_dir_config* parent=(shib_dir_config*)base;
181     shib_dir_config* child=(shib_dir_config*)sub;
182
183     if (child->szAuthGrpFile)
184         dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
185     else if (parent->szAuthGrpFile)
186         dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
187     else
188         dc->szAuthGrpFile=NULL;
189
190     if (child->szApplicationId)
191         dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
192     else if (parent->szApplicationId)
193         dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
194     else
195         dc->szApplicationId=NULL;
196
197     if (child->szRequireWith)
198         dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
199     else if (parent->szRequireWith)
200         dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
201     else
202         dc->szRequireWith=NULL;
203
204     if (child->szRedirectToSSL)
205         dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
206     else if (parent->szRedirectToSSL)
207         dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
208     else
209         dc->szRedirectToSSL=NULL;
210
211     dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
212     dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
213     dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
214     dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
215     dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
216     dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
217     return dc;
218 }
219
220 // per-request module structure
221 struct shib_request_config
222 {
223     SH_AP_TABLE *env;        // environment vars
224 #ifdef SHIB_DEFERRED_HEADERS
225     SH_AP_TABLE *hdr_out;    // headers to browser
226     SH_AP_TABLE *hdr_err;    // err headers to browser
227 #endif
228 };
229
230 // create a request record
231 static shib_request_config *init_request_config(request_rec *r)
232 {
233     shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
234     ap_set_module_config (r->request_config, &mod_shib, rc);
235     memset(rc, 0, sizeof(shib_request_config));
236     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
237     return rc;
238 }
239
240 // generic global slot handlers
241 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
242 {
243     *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
244     return NULL;
245 }
246
247 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
248 {
249     char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
250     size_t offset=(size_t)parms->info;
251     *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
252     return NULL;
253 }
254
255 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
256 #ifdef SHIB_APACHE_13
257                                              char* arg1, char* arg2
258 #else
259                                              void* arg1, const char* arg2
260 #endif
261                                              )
262 {
263   ap_set_file_slot(parms, arg1, arg2);
264   return DECLINE_CMD;
265 }
266
267 /********************************************************************************/
268 // Apache ShibTarget subclass(es) here.
269
270 class ShibTargetApache : public AbstractSPRequest
271 {
272   mutable string m_body;
273   mutable bool m_gotBody;
274   vector<string> m_certs;
275
276 public:
277   request_rec* m_req;
278   shib_dir_config* m_dc;
279   shib_server_config* m_sc;
280   shib_request_config* m_rc;
281
282   ShibTargetApache(request_rec* req) : m_gotBody(false) {
283     m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
284     m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
285     m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
286     m_req = req;
287   }
288   virtual ~ShibTargetApache() {}
289
290   const char* getScheme() const {
291     return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
292   }
293   const char* getHostname() const {
294     return ap_get_server_name(m_req);
295   }
296   int getPort() const {
297     return ap_get_server_port(m_req);
298   }
299   const char* getRequestURI() const {
300     return m_req->unparsed_uri;
301   }
302   const char* getMethod() const {
303     return m_req->method;
304   }
305   string getContentType() const {
306     const char* type = ap_table_get(m_req->headers_in, "Content-Type");
307     return type ? type : "";
308   }
309   long getContentLength() const {
310       return m_gotBody ? m_body.length() : m_req->remaining;
311   }
312   string getRemoteAddr() const {
313     return m_req->connection->remote_ip;
314   }
315   void log(SPLogLevel level, const string& msg) const {
316     AbstractSPRequest::log(level,msg);
317     ap_log_rerror(
318         APLOG_MARK,
319         (level == SPDebug ? APLOG_DEBUG :
320         (level == SPInfo ? APLOG_INFO :
321         (level == SPWarn ? APLOG_WARNING :
322         (level == SPError ? APLOG_ERR : APLOG_CRIT))))|APLOG_NOERRNO,
323         SH_AP_R(m_req),
324         msg.c_str()
325         );
326   }
327   const char* getQueryString() const { return m_req->args; }
328   const char* getRequestBody() const {
329     if (m_gotBody || m_req->method_number==M_GET)
330         return m_body.c_str();
331     // Read the posted data
332     if (ap_setup_client_block(m_req, REQUEST_CHUNKED_DECHUNK) != OK) {
333         m_gotBody=true;
334         log(SPError, "Apache function (setup_client_block) failed while reading request body.");
335         return m_body.c_str();
336     }
337     if (!ap_should_client_block(m_req)) {
338         m_gotBody=true;
339         log(SPError, "Apache function (should_client_block) failed while reading request body.");
340         return m_body.c_str();
341     }
342     if (m_req->remaining > 1024*1024)
343         throw opensaml::SecurityPolicyException("Blocked request body larger than 1M size limit.");
344     m_gotBody=true;
345     int len;
346     char buff[HUGE_STRING_LEN];
347     ap_hard_timeout("[mod_shib] getRequestBody", m_req);
348     while ((len=ap_get_client_block(m_req, buff, sizeof(buff))) > 0) {
349       ap_reset_timeout(m_req);
350       m_body.append(buff, len);
351     }
352     ap_kill_timeout(m_req);
353     return m_body.c_str();
354   }
355   void clearHeader(const char* name) {
356     if (m_dc->bUseEnvVars!=0) {
357        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: env\n");
358        if (m_rc && m_rc->env) ap_table_unset(m_rc->env, name);
359     } else {
360        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: hdr\n");
361        ap_table_unset(m_req->headers_in, name);
362        ap_table_set(m_req->headers_in, name, g_unsetHeaderValue.c_str());
363     }
364   }
365   void setHeader(const char* name, const char* value) {
366     if (m_dc->bUseEnvVars!=0) {
367        if (!m_rc) {
368           // this happens on subrequests
369           // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_setheader: no_m_rc\n");
370           m_rc = init_request_config(m_req);
371        }
372        if (!m_rc->env) m_rc->env = ap_make_table(m_req->pool, 10);
373        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_set_env: %s=%s\n", name, value?value:"Null");
374        ap_table_set(m_rc->env, name, value?value:"");
375     }
376     else {
377        ap_table_set(m_req->headers_in, name, value);
378     }
379   }
380   string getHeader(const char* name) const {
381     const char* hdr = ap_table_get(m_req->headers_in, name);
382     return string(hdr ? hdr : "");
383   }
384   string getSecureHeader(const char* name) const {
385     if (m_dc->bUseEnvVars!=0) {
386        const char *hdr;
387        if (m_rc && m_rc->env)
388            hdr = ap_table_get(m_rc->env, name);
389        else
390            hdr = NULL;
391        return string(hdr ? hdr : "");
392     }
393     return getHeader(name);
394   }
395   void setRemoteUser(const char* user) {
396       SH_AP_USER(m_req) = user ? ap_pstrdup(m_req->pool, user) : NULL;
397   }
398   string getRemoteUser() const {
399     return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
400   }
401   void setContentType(const char* type) {
402       m_req->content_type = ap_psprintf(m_req->pool, type);
403   }
404   void setResponseHeader(const char* name, const char* value) {
405 #ifdef SHIB_DEFERRED_HEADERS
406    if (!m_rc)
407       // this happens on subrequests
408       m_rc = init_request_config(m_req);
409     ap_table_add(m_rc->hdr_err, name, value);
410     ap_table_add(m_rc->hdr_out, name, value);
411 #else
412     ap_table_add(m_req->err_headers_out, name, value);
413 #endif
414   }
415   long sendResponse(istream& in, long status) {
416     ap_send_http_header(m_req);
417     char buf[1024];
418     while (in) {
419         in.read(buf,1024);
420         ap_rwrite(buf,in.gcount(),m_req);
421     }
422     return ((status==XMLTOOLING_HTTP_STATUS_OK) ? DONE : status);
423   }
424   long sendRedirect(const char* url) {
425     ap_table_set(m_req->headers_out, "Location", url);
426     return REDIRECT;
427   }
428   const vector<string>& getClientCertificates() const {
429       return m_certs;
430   }
431   long returnDecline(void) { return DECLINED; }
432   long returnOK(void) { return OK; }
433 };
434
435 /********************************************************************************/
436 // Apache handlers
437
438 extern "C" int shib_check_user(request_rec* r)
439 {
440   // Short-circuit entirely?
441   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
442     return DECLINED;
443     
444   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER\n", (int)getpid());
445
446   ostringstream threadid;
447   threadid << "[" << getpid() << "] shib_check_user" << '\0';
448   xmltooling::NDC ndc(threadid.str().c_str());
449
450   try {
451     ShibTargetApache sta(r);
452
453     // Check user authentication and export information, then set the handler bypass
454     pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
455     apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
456     if (res.first) return res.second;
457
458     // user auth was okay -- export the assertions now
459     res = sta.getServiceProvider().doExport(sta);
460     if (res.first) return res.second;
461
462     // export happened successfully..  this user is ok.
463     return OK;
464   }
465   catch (exception& e) {
466     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
467     return SERVER_ERROR;
468   }
469 #ifndef _DEBUG
470   catch (...) {
471     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an uncaught exception!");
472     return SERVER_ERROR;
473   }
474 #endif
475 }
476
477 extern "C" int shib_handler(request_rec* r)
478 {
479   // Short-circuit entirely?
480   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
481     return DECLINED;
482
483   ostringstream threadid;
484   threadid << "[" << getpid() << "] shib_handler" << '\0';
485   xmltooling::NDC ndc(threadid.str().c_str());
486
487 #ifndef SHIB_APACHE_13
488   // With 2.x, this handler always runs, though last.
489   // We check if shib_check_user ran, because it will detect a handler request
490   // and dispatch it directly.
491   void* data;
492   apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
493   if (data==(const void*)42) {
494     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
495     return DECLINED;
496   }
497 #endif
498
499   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
500
501   try {
502     ShibTargetApache sta(r);
503
504     pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
505     if (res.first) return res.second;
506
507     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
508     return SERVER_ERROR;
509   }
510   catch (exception& e) {
511     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
512     return SERVER_ERROR;
513   }
514 #ifndef _DEBUG
515   catch (...) {
516     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an uncaught exception!");
517     return SERVER_ERROR;
518   }
519 #endif
520 }
521
522 /*
523  * shib_auth_checker() -- a simple resource manager to
524  * process the .htaccess settings
525  */
526 extern "C" int shib_auth_checker(request_rec* r)
527 {
528   // Short-circuit entirely?
529   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
530     return DECLINED;
531
532   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
533
534   ostringstream threadid;
535   threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
536   xmltooling::NDC ndc(threadid.str().c_str());
537
538   try {
539     ShibTargetApache sta(r);
540
541     pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
542     if (res.first) return res.second;
543
544     // We're all okay.
545     return OK;
546   }
547   catch (exception& e) {
548     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
549     return SERVER_ERROR;
550   }
551 #ifndef _DEBUG
552   catch (...) {
553     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an uncaught exception!");
554     return SERVER_ERROR;
555   }
556 #endif
557 }
558
559 // Access control plugin that enforces htaccess rules
560 class htAccessControl : virtual public AccessControl
561 {
562 public:
563     htAccessControl() {}
564     ~htAccessControl() {}
565     Lockable* lock() {return this;}
566     void unlock() {}
567     bool authorized(const SPRequest& request, const Session* session) const;
568 private:
569     bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
570 };
571
572 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
573 {
574     return new htAccessControl();
575 }
576
577 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
578 {
579 public:
580     ApacheRequestMapper(const xercesc::DOMElement* e);
581     ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
582     Lockable* lock() { return m_mapper->lock(); }
583     void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
584     Settings getSettings(const SPRequest& request) const;
585     
586     void setParent(const PropertySet*) {}
587     pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
588     pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
589     pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
590     pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
591     pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
592     const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
593     const xercesc::DOMElement* getElement() const;
594
595 private:
596     RequestMapper* m_mapper;
597     ThreadKey* m_staKey;
598     ThreadKey* m_propsKey;
599     AccessControl* m_htaccess;
600 };
601
602 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
603 {
604     return new ApacheRequestMapper(e);
605 }
606
607 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
608 {
609     m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
610     m_htaccess=new htAccessControl();
611     m_staKey=ThreadKey::create(NULL);
612     m_propsKey=ThreadKey::create(NULL);
613 }
614
615 RequestMapper::Settings ApacheRequestMapper::getSettings(const SPRequest& request) const
616 {
617     Settings s=m_mapper->getSettings(request);
618     m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
619     m_propsKey->setData((void*)s.first);
620     return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
621 }
622
623 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
624 {
625     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
626     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
627     if (sta && !ns) {
628         // Override Apache-settable boolean properties.
629         if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession==1)
630             return make_pair(true,true);
631         else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion==1)
632             return make_pair(true,true);
633     }
634     return s ? s->getBool(name,ns) : make_pair(false,false);
635 }
636
637 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
638 {
639     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
640     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
641     if (sta && !ns) {
642         // Override Apache-settable string properties.
643         if (name && !strcmp(name,"authType")) {
644             const char *auth_type=ap_auth_type(sta->m_req);
645             if (auth_type) {
646                 // Check for Basic Hijack
647                 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
648                     auth_type = "shibboleth";
649                 return make_pair(true,auth_type);
650             }
651         }
652         else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
653             return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
654         else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
655             return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
656         else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
657             return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
658     }
659     return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
660 }
661
662 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
663 {
664     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
665     return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
666 }
667
668 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
669 {
670     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
671     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
672     if (sta && !ns) {
673         // Override Apache-settable int properties.
674         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
675             return pair<bool,unsigned int>(true,strtol(sta->m_dc->szRedirectToSSL,NULL,10));
676     }
677     return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
678 }
679
680 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
681 {
682     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
683     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
684     if (sta && !ns) {
685         // Override Apache-settable int properties.
686         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
687             return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
688     }
689     return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
690 }
691
692 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
693 {
694     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
695     return s ? s->getPropertySet(name,ns) : NULL;
696 }
697
698 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
699 {
700     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
701     return s ? s->getElement() : NULL;
702 }
703
704 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
705 {
706     SH_AP_CONFIGFILE* f;
707     SH_AP_TABLE* grps=ap_make_table(r->pool,15);
708     char l[MAX_STRING_LEN];
709     const char *group_name, *ll, *w;
710
711 #ifdef SHIB_APACHE_13
712     if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
713 #else
714     if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
715 #endif
716         ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
717         return NULL;
718     }
719
720     SH_AP_POOL* sp;
721 #ifdef SHIB_APACHE_13
722     sp=ap_make_sub_pool(r->pool);
723 #else
724     if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
725         ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
726             "groups_for_user() could not create a subpool");
727         return NULL;
728     }
729 #endif
730
731     while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
732         if ((*l=='#') || (!*l))
733             continue;
734         ll = l;
735         ap_clear_pool(sp);
736
737         group_name=ap_getword(sp,&ll,':');
738
739         while (*ll) {
740             w=ap_getword_conf(sp,&ll);
741             if (!strcmp(w,user)) {
742                 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
743                 break;
744             }
745         }
746     }
747     ap_cfg_closefile(f);
748     ap_destroy_pool(sp);
749     return grps;
750 }
751
752 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
753 {
754     bool caseSensitive = attr->isCaseSensitive();
755     const vector<string>& vals = attr->getSerializedValues();
756     for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
757         if (re) {
758             auto_ptr<XMLCh> trans(fromUTF8(v->c_str()));
759             if (re->matches(trans.get())) {
760                 request.log(SPRequest::SPDebug,
761                     string("htAccessControl plugin expecting regexp ") + toMatch + ", got " + *v + ": authorization granted"
762                     );
763                 return true;
764             }
765         }
766         else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
767             request.log(SPRequest::SPDebug,
768                 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization granted."
769                 );
770             return true;
771         }
772         else {
773             request.log(SPRequest::SPDebug,
774                 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization not granted."
775                 );
776         }
777     }
778     return false;
779 }
780
781 bool htAccessControl::authorized(const SPRequest& request, const Session* session) const
782 {
783     // Make sure the object is our type.
784     const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
785     if (!sta)
786         throw ConfigurationException("Request wrapper object was not of correct type.");
787
788     // mod_auth clone
789
790     int m=sta->m_req->method_number;
791     bool method_restricted=false;
792     const char *t, *w;
793     
794     const array_header* reqs_arr=ap_requires(sta->m_req);
795     if (!reqs_arr)
796         return true;
797
798     require_line* reqs=(require_line*)reqs_arr->elts;
799     
800     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE nelts: %d", reqs_arr->nelts);
801     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE all: %d", sta->m_dc->bRequireAll);
802
803     vector<bool> auth_OK(reqs_arr->nelts,false);
804
805 #define SHIB_AP_CHECK_IS_OK {           \
806      if (sta->m_dc->bRequireAll < 1)    \
807          return true;                   \
808      auth_OK[x] = true;                 \
809      continue;                          \
810 }
811
812     for (int x=0; x<reqs_arr->nelts; x++) {
813         auth_OK[x] = false;
814         if (!(reqs[x].method_mask & (1 << m)))
815             continue;
816         method_restricted=true;
817         string remote_user = request.getRemoteUser();
818
819         t = reqs[x].requirement;
820         w = ap_getword_white(sta->m_req->pool, &t);
821
822         if (!strcasecmp(w,"shibboleth")) {
823             // This is a dummy rule needed because Apache conflates authn and authz.
824             // Without some require rule, AuthType is ignored and no check_user hooks run.
825             SHIB_AP_CHECK_IS_OK;
826         }
827         else if (!strcmp(w,"valid-user")) {
828             if (session) {
829                 request.log(SPRequest::SPDebug,"htAccessControl plugin accepting valid-user based on active session");
830                 SHIB_AP_CHECK_IS_OK;
831             }
832             else
833                 request.log(SPRequest::SPError,"htAccessControl plugin rejecting access for valid-user rule, no session is active");
834         }
835         else if (!strcmp(w,"user") && !remote_user.empty()) {
836             bool regexp=false;
837             while (*t) {
838                 w=ap_getword_conf(sta->m_req->pool,&t);
839                 if (*w=='~') {
840                     regexp=true;
841                     continue;
842                 }
843                 
844                 if (regexp) {
845                     try {
846                         // To do regex matching, we have to convert from UTF-8.
847                         auto_ptr<XMLCh> trans(fromUTF8(w));
848                         RegularExpression re(trans.get());
849                         auto_ptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
850                         if (re.matches(trans2.get())) {
851                             request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
852                             SHIB_AP_CHECK_IS_OK;
853                         }
854                     }
855                     catch (XMLException& ex) {
856                         auto_ptr_char tmp(ex.getMessage());
857                         request.log(SPRequest::SPError,
858                             string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
859                     }
860                 }
861                 else if (remote_user==w) {
862                     request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
863                     SHIB_AP_CHECK_IS_OK;
864                 }
865             }
866         }
867         else if (!strcmp(w,"group")) {
868             SH_AP_TABLE* grpstatus=NULL;
869             if (sta->m_dc->szAuthGrpFile && !remote_user.empty()) {
870                 request.log(SPRequest::SPDebug,string("htAccessControl plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
871                 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
872             }
873             if (!grpstatus)
874                 continue;
875     
876             while (*t) {
877                 w=ap_getword_conf(sta->m_req->pool,&t);
878                 if (ap_table_get(grpstatus,w)) {
879                     request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting group (") + w + ")");
880                     SHIB_AP_CHECK_IS_OK;
881                 }
882             }
883         }
884         else {
885             // Map alias in rule to the attribute.
886             if (!session) {
887                 request.log(SPRequest::SPError, "htAccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
888                 continue;
889             }
890             
891             // Find the attribute(s) matching the require rule.
892             pair<multimap<string,Attribute*>::const_iterator,multimap<string,Attribute*>::const_iterator> attrs =
893                 session->getAttributes().equal_range(w);
894             if (attrs.first == attrs.second) {
895                 request.log(SPRequest::SPWarn, string("htAccessControl rule requires attribute (") + w + "), not found in session");
896                 continue;
897             }
898
899             bool regexp=false;
900
901             while (!auth_OK[x] && *t) {
902                 w=ap_getword_conf(sta->m_req->pool,&t);
903                 if (*w=='~') {
904                     regexp=true;
905                     continue;
906                 }
907
908                 try {
909                     auto_ptr<RegularExpression> re;
910                     if (regexp) {
911                         delete re.release();
912                         auto_ptr<XMLCh> trans(fromUTF8(w));
913                         auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
914                         re=temp;
915                     }
916                     
917                     for (; !auth_OK[x] && attrs.first!=attrs.second; ++attrs.first) {
918                         if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
919                             SHIB_AP_CHECK_IS_OK;
920                         }
921                     }
922                 }
923                 catch (XMLException& ex) {
924                     auto_ptr_char tmp(ex.getMessage());
925                     request.log(SPRequest::SPError,
926                         string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
927                         );
928                 }
929             }
930         }
931     }
932
933     // check if all require directives are true
934     bool auth_all_OK = true;
935     for (int i= 0; i<reqs_arr->nelts; i++) {
936         auth_all_OK &= auth_OK[i];
937     }
938     if (auth_all_OK || !method_restricted)
939         return true;
940
941     return false;
942 }
943
944 #ifndef SHIB_APACHE_13
945 /*
946  * shib_exit()
947  *  Empty cleanup hook, Apache 2.x doesn't check NULL very well...
948  */
949 extern "C" apr_status_t shib_exit(void* data)
950 {
951     if (g_Config) {
952         g_Config->term();
953         g_Config = NULL;
954     }
955     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
956     return OK;
957 }
958 #endif
959
960
961 // Initial look at a request - create the per-request structure
962 static int shib_post_read(request_rec *r)
963 {
964     shib_request_config* rc = init_request_config(r);
965
966     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read: E=%s", rc->env?"env":"hdr");
967
968 #ifdef SHIB_DEFERRED_HEADERS
969     rc->hdr_out = ap_make_table(r->pool, 5);
970     rc->hdr_err = ap_make_table(r->pool, 5);
971 #endif
972     return DECLINED;
973 }
974
975 // fixups: set environment vars
976
977 extern "C" int shib_fixups(request_rec* r)
978 {
979   shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
980   shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
981   if (dc->bOff==1 || dc->bUseEnvVars==0)
982     return DECLINED;
983
984   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
985
986   if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
987         return DECLINED;
988
989   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
990   r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
991
992   return OK;
993 }
994
995 /*
996  * shib_child_exit()
997  *  Cleanup the (per-process) pool info.
998  */
999 #ifdef SHIB_APACHE_13
1000 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1001 {
1002 #else
1003 extern "C" apr_status_t shib_child_exit(void* data)
1004 {
1005   server_rec* s = NULL;
1006 #endif
1007
1008     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1009     g_Config->term();
1010     g_Config = NULL;
1011     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1012
1013 #ifndef SHIB_APACHE_13
1014     return OK;
1015 #endif
1016 }
1017
1018 /* 
1019  * shire_child_init()
1020  *  Things to do when the child process is initialized.
1021  *  (or after the configs are read in apache-2)
1022  */
1023 #ifdef SHIB_APACHE_13
1024 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1025 #else
1026 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1027 #endif
1028 {
1029     // Initialize runtime components.
1030
1031     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1032
1033     if (g_Config) {
1034         ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1035         exit(1);
1036     }
1037
1038     g_Config=&SPConfig::getConfig();
1039     g_Config->setFeatures(
1040         SPConfig::Listener |
1041         SPConfig::Caching |
1042         SPConfig::RequestMapping |
1043         SPConfig::InProcess |
1044         SPConfig::Logging
1045         );
1046     if (!g_Config->init(g_szSchemaDir)) {
1047         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1048         exit(1);
1049     }
1050     g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1051     g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1052     
1053     try {
1054         xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
1055         XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
1056         xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
1057         auto_ptr_XMLCh src(g_szSHIBConfig);
1058         dummy->setAttributeNS(NULL,path,src.get());
1059         dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
1060
1061         g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
1062         g_Config->getServiceProvider()->init();
1063     }
1064     catch (exception& ex) {
1065         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1066         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1067         exit(1);
1068     }
1069
1070     ServiceProvider* sp=g_Config->getServiceProvider();
1071     xmltooling::Locker locker(sp);
1072     const PropertySet* props=sp->getPropertySet("Local");
1073     if (props) {
1074         pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1075         if (unsetValue.first)
1076             g_unsetHeaderValue = unsetValue.second;
1077     }
1078
1079     // Set the cleanup handler
1080     apr_pool_cleanup_register(p, NULL, &shib_exit, &shib_child_exit);
1081
1082     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1083 }
1084
1085 // Output filters
1086 #ifdef SHIB_DEFERRED_HEADERS
1087 static void set_output_filter(request_rec *r)
1088 {
1089    ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1090 }
1091
1092 static void set_error_filter(request_rec *r)
1093 {
1094    ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1095 }
1096
1097 static int _table_add(void *v, const char *key, const char *value)
1098 {
1099     apr_table_addn((apr_table_t*)v, key, value);
1100     return 1;
1101 }
1102
1103 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1104 {
1105     request_rec *r = f->r;
1106     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1107
1108     if (rc) {
1109         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);
1110         apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1111         // can't use overlap call because it will collapse Set-Cookie headers
1112         //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1113     }
1114
1115     /* remove ourselves from the filter chain */
1116     ap_remove_output_filter(f);
1117
1118     /* send the data up the stack */
1119     return ap_pass_brigade(f->next,in);
1120 }
1121
1122 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1123 {
1124     request_rec *r = f->r;
1125     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1126
1127     if (rc) {
1128         ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_err_filter: merging %d headers", apr_table_elts(rc->hdr_err)->nelts);
1129         apr_table_do(_table_add,r->err_headers_out, rc->hdr_err,NULL);
1130         // can't use overlap call because it will collapse Set-Cookie headers
1131         //apr_table_overlap(r->err_headers_out, rc->hdr_err, APR_OVERLAP_TABLES_MERGE);
1132     }
1133
1134     /* remove ourselves from the filter chain */
1135     ap_remove_output_filter(f);
1136
1137     /* send the data up the stack */
1138     return ap_pass_brigade(f->next,in);
1139 }
1140 #endif // SHIB_DEFERRED_HEADERS
1141
1142 typedef const char* (*config_fn_t)(void);
1143
1144 #ifdef SHIB_APACHE_13
1145
1146 // SHIB Module commands
1147
1148 static command_rec shire_cmds[] = {
1149   {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1150    RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1151   {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1152    RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1153   {"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1154    RSRC_CONF, TAKE1, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"},
1155
1156   {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1157    (void *) XtOffsetOf (shib_server_config, szScheme),
1158    RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1159    
1160   {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1161    (void *) XtOffsetOf (shib_dir_config, bOff),
1162    OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1163   {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1164    (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1165    OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1166   {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1167    (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1168    OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1169   {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1170    (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1171    OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1172   {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1173    (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1174    OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1175   {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1176    (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1177    OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1178   {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1179    (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1180    OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1181   {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1182    (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1183    OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1184   {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1185    (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1186    OR_AUTHCFG, FLAG, "All require directives must match"},
1187   {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1188    (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1189    OR_AUTHCFG, FLAG, "Export data in environment instead of headers (default)"},
1190
1191   {NULL}
1192 };
1193
1194 extern "C"{
1195 handler_rec shib_handlers[] = {
1196   { "shib-handler", shib_handler },
1197   { NULL }
1198 };
1199
1200 module MODULE_VAR_EXPORT mod_shib = {
1201     STANDARD_MODULE_STUFF,
1202     NULL,                        /* initializer */
1203     create_shib_dir_config,     /* dir config creater */
1204     merge_shib_dir_config,      /* dir merger --- default is to override */
1205     create_shib_server_config, /* server config */
1206     merge_shib_server_config,   /* merge server config */
1207     shire_cmds,                 /* command table */
1208     shib_handlers,              /* handlers */
1209     NULL,                       /* filename translation */
1210     shib_check_user,            /* check_user_id */
1211     shib_auth_checker,          /* check auth */
1212     NULL,                       /* check access */
1213     NULL,                       /* type_checker */
1214     shib_fixups,                /* fixups */
1215     NULL,                       /* logger */
1216     NULL,                       /* header parser */
1217     shib_child_init,            /* child_init */
1218     shib_child_exit,            /* child_exit */
1219     shib_post_read              /* post read-request */
1220 };
1221
1222 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1223
1224 extern "C" void shib_register_hooks (apr_pool_t *p)
1225 {
1226 #ifdef SHIB_DEFERRED_HEADERS
1227   ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1228   ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1229   ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1230   ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1231   ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1232 #endif
1233   ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1234   ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1235   ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1236   ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1237   ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1238 }
1239
1240 // SHIB Module commands
1241
1242 extern "C" {
1243 static command_rec shib_cmds[] = {
1244   AP_INIT_TAKE1("ShibConfig",
1245                 (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1246                 RSRC_CONF, "Path to shibboleth.xml config file"),
1247   AP_INIT_TAKE1("ShibCatalogs",
1248      (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1249       RSRC_CONF, "Paths of XML schema catalogs"),
1250   AP_INIT_TAKE1("ShibSchemaDir",
1251      (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1252       RSRC_CONF, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"),
1253
1254   AP_INIT_TAKE1("ShibURLScheme",
1255      (config_fn_t)shib_set_server_string_slot,
1256      (void *) offsetof (shib_server_config, szScheme),
1257       RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1258
1259   AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1260         (void *) offsetof (shib_dir_config, bOff),
1261         OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1262   AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1263         (void *) offsetof (shib_dir_config, szApplicationId),
1264         OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1265   AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1266         (void *) offsetof (shib_dir_config, bBasicHijack),
1267         OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1268   AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1269         (void *) offsetof (shib_dir_config, bRequireSession),
1270         OR_AUTHCFG, "Initiates a new session if one does not exist"),
1271   AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1272         (void *) offsetof (shib_dir_config, szRequireWith),
1273         OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1274   AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1275         (void *) offsetof (shib_dir_config, bExportAssertion),
1276         OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1277   AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1278         (void *) offsetof (shib_dir_config, szRedirectToSSL),
1279         OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1280   AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1281                 (void *) offsetof (shib_dir_config, szAuthGrpFile),
1282                 OR_AUTHCFG, "Text file containing group names and member user IDs"),
1283   AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1284         (void *) offsetof (shib_dir_config, bRequireAll),
1285         OR_AUTHCFG, "All require directives must match"),
1286   AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1287         (void *) offsetof (shib_dir_config, bUseEnvVars),
1288         OR_AUTHCFG, "Export data in environment instead of headers (default)"),
1289
1290   {NULL}
1291 };
1292
1293 module AP_MODULE_DECLARE_DATA mod_shib = {
1294     STANDARD20_MODULE_STUFF,
1295     create_shib_dir_config,     /* create dir config */
1296     merge_shib_dir_config,      /* merge dir config --- default is to override */
1297     create_shib_server_config,  /* create server config */
1298     merge_shib_server_config,   /* merge server config */
1299     shib_cmds,                  /* command table */
1300     shib_register_hooks         /* register hooks */
1301 };
1302
1303 #else
1304 #error "undefined APACHE version"
1305 #endif
1306
1307 }