2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 * Apache module implementation
26 #undef _XOPEN_SOURCE // causes gethostname conflict in unistd.h
30 # define _CRT_NONSTDC_NO_DEPRECATE 1
31 # define _CRT_SECURE_NO_DEPRECATE 1
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>
56 // Apache specific header files
58 #include <http_config.h>
59 #include <http_protocol.h>
60 #include <http_main.h>
62 #include <http_core.h>
64 #include <http_request.h>
66 #ifndef SHIB_APACHE_13
67 #include <apr_buckets.h>
68 #include <apr_strings.h>
69 #include <apr_pools.h>
76 #include <unistd.h> // for getpid()
79 using namespace shibsp;
80 using namespace xmltooling;
82 using xercesc::RegularExpression;
83 using xercesc::XMLException;
85 extern "C" module MODULE_VAR_EXPORT mod_shib;
88 char* g_szSHIBConfig = SHIBSP_CONFIG;
89 char* g_szSchemaDir = SHIBSP_SCHEMAS;
90 SPConfig* g_Config = NULL;
91 string g_unsetHeaderValue;
92 bool g_checkSpoofing = true;
93 bool g_catchAll = false;
94 static const char* g_UserDataKey = "_shib_check_user_";
95 static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
96 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
99 /* Apache 2.2.x headers must be accumulated and set in the output filter.
100 Apache 2.0.49+ supports the filter method.
101 Apache 1.3.x and lesser 2.0.x must write the headers directly. */
103 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
104 #define SHIB_DEFERRED_HEADERS
107 /********************************************************************************/
108 // Basic Apache Configuration code.
111 // per-server module configuration structure
112 struct shib_server_config
117 // creates the per-server configuration
118 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
120 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
125 // overrides server configuration in virtual servers
126 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
128 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
129 shib_server_config* parent=(shib_server_config*)base;
130 shib_server_config* child=(shib_server_config*)sub;
133 sc->szScheme=ap_pstrdup(p,child->szScheme);
134 else if (parent->szScheme)
135 sc->szScheme=ap_pstrdup(p,parent->szScheme);
142 // per-dir module configuration structure
143 struct shib_dir_config
145 SH_AP_TABLE* tSettings; // generic table of extensible settings
148 char* szAuthGrpFile; // Auth GroupFile name
149 int bRequireAll; // all "known" require directives must match, otherwise OR logic
150 int bAuthoritative; // allow htaccess plugin to DECLINE when authz fails
152 // Content Configuration
153 char* szApplicationId; // Shib applicationId value
154 char* szRequireWith; // require a session using a specific initiator?
155 char* szRedirectToSSL; // redirect non-SSL requests to SSL port
156 int bOff; // flat-out disable all Shib processing
157 int bBasicHijack; // activate for AuthType Basic?
158 int bRequireSession; // require a session?
159 int bExportAssertion; // export SAML assertion to the environment?
160 int bUseEnvVars; // use environment?
161 int bUseHeaders; // use headers?
164 // creates per-directory config structure
165 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
167 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
168 dc->tSettings = NULL;
169 dc->szAuthGrpFile = NULL;
170 dc->bRequireAll = -1;
171 dc->bAuthoritative = -1;
172 dc->szApplicationId = NULL;
173 dc->szRequireWith = NULL;
174 dc->szRedirectToSSL = NULL;
176 dc->bBasicHijack = -1;
177 dc->bRequireSession = -1;
178 dc->bExportAssertion = -1;
179 dc->bUseEnvVars = -1;
180 dc->bUseHeaders = -1;
184 // overrides server configuration in directories
185 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
187 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
188 shib_dir_config* parent=(shib_dir_config*)base;
189 shib_dir_config* child=(shib_dir_config*)sub;
191 // The child supersedes any matching table settings in the parent.
192 dc->tSettings = NULL;
193 if (parent->tSettings)
194 dc->tSettings = ap_copy_table(p, parent->tSettings);
195 if (child->tSettings) {
197 ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
199 dc->tSettings = ap_copy_table(p, child->tSettings);
202 if (child->szAuthGrpFile)
203 dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
204 else if (parent->szAuthGrpFile)
205 dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
207 dc->szAuthGrpFile=NULL;
209 if (child->szApplicationId)
210 dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
211 else if (parent->szApplicationId)
212 dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
214 dc->szApplicationId=NULL;
216 if (child->szRequireWith)
217 dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
218 else if (parent->szRequireWith)
219 dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
221 dc->szRequireWith=NULL;
223 if (child->szRedirectToSSL)
224 dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
225 else if (parent->szRedirectToSSL)
226 dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
228 dc->szRedirectToSSL=NULL;
230 dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
231 dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
232 dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
233 dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
234 dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
235 dc->bAuthoritative=((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
236 dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
237 dc->bUseHeaders=((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
241 // per-request module structure
242 struct shib_request_config
244 SH_AP_TABLE *env; // environment vars
245 #ifdef SHIB_DEFERRED_HEADERS
246 SH_AP_TABLE *hdr_out; // headers to browser
250 // create a request record
251 static shib_request_config *init_request_config(request_rec *r)
253 shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
254 ap_set_module_config (r->request_config, &mod_shib, rc);
255 memset(rc, 0, sizeof(shib_request_config));
256 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
260 // generic global slot handlers
261 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
263 *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
267 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
269 char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
270 size_t offset=(size_t)parms->info;
271 *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
275 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
276 #ifdef SHIB_APACHE_13
277 char* arg1, char* arg2
279 void* arg1, const char* arg2
283 ap_set_file_slot(parms, arg1, arg2);
287 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
290 dc->tSettings = ap_make_table(parms->pool, 4);
291 ap_table_set(dc->tSettings, arg1, arg2);
295 /********************************************************************************/
296 // Apache ShibTarget subclass(es) here.
298 class ShibTargetApache : public AbstractSPRequest
301 mutable string m_body;
302 mutable bool m_gotBody;
303 mutable vector<string> m_certs;
304 set<string> m_allhttp;
308 shib_dir_config* m_dc;
309 shib_server_config* m_sc;
310 shib_request_config* m_rc;
312 ShibTargetApache(request_rec* req, bool handler) : m_handler(handler), m_gotBody(false) {
313 m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
314 m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
315 m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
318 setRequestURI(m_req->unparsed_uri);
320 virtual ~ShibTargetApache() {}
322 const char* getScheme() const {
323 return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
325 const char* getHostname() const {
326 return ap_get_server_name(m_req);
328 int getPort() const {
329 return ap_get_server_port(m_req);
331 const char* getMethod() const {
332 return m_req->method;
334 string getContentType() const {
335 const char* type = ap_table_get(m_req->headers_in, "Content-Type");
336 return type ? type : "";
338 long getContentLength() const {
339 return m_gotBody ? m_body.length() : m_req->remaining;
341 string getRemoteAddr() const {
342 return m_req->connection->remote_ip;
344 void log(SPLogLevel level, const string& msg) const {
345 AbstractSPRequest::log(level,msg);
348 (level == SPDebug ? APLOG_DEBUG :
349 (level == SPInfo ? APLOG_INFO :
350 (level == SPWarn ? APLOG_WARNING :
351 (level == SPError ? APLOG_ERR : APLOG_CRIT))))|APLOG_NOERRNO,
356 const char* getQueryString() const { return m_req->args; }
357 const char* getRequestBody() const {
358 if (m_gotBody || m_req->method_number==M_GET)
359 return m_body.c_str();
360 #ifdef SHIB_APACHE_13
361 // Read the posted data
362 if (ap_setup_client_block(m_req, REQUEST_CHUNKED_DECHUNK) != OK) {
364 log(SPError, "Apache function (setup_client_block) failed while reading request body.");
365 return m_body.c_str();
367 if (!ap_should_client_block(m_req)) {
369 log(SPError, "Apache function (should_client_block) failed while reading request body.");
370 return m_body.c_str();
372 if (m_req->remaining > 1024*1024)
373 throw opensaml::SecurityPolicyException("Blocked request body larger than 1M size limit.");
376 char buff[HUGE_STRING_LEN];
377 ap_hard_timeout("[mod_shib] getRequestBody", m_req);
378 while ((len=ap_get_client_block(m_req, buff, sizeof(buff))) > 0) {
379 ap_reset_timeout(m_req);
380 m_body.append(buff, len);
382 ap_kill_timeout(m_req);
387 apr_bucket_brigade* bb = apr_brigade_create(m_req->pool, m_req->connection->bucket_alloc);
390 apr_status_t rv = ap_get_brigade(m_req->input_filters, bb, AP_MODE_READBYTES, APR_BLOCK_READ, HUGE_STRING_LEN);
391 if (rv != APR_SUCCESS) {
392 log(SPError, "Apache function (ap_get_brigade) failed while reading request body.");
396 for (bucket = APR_BRIGADE_FIRST(bb); bucket != APR_BRIGADE_SENTINEL(bb); bucket = APR_BUCKET_NEXT(bucket)) {
397 if (APR_BUCKET_IS_EOS(bucket)) {
402 /* We can't do much with this. */
403 if (APR_BUCKET_IS_FLUSH(bucket))
407 apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
409 m_body.append(data, len);
411 apr_brigade_cleanup(bb);
413 apr_brigade_destroy(bb);
416 return m_body.c_str();
418 void clearHeader(const char* rawname, const char* cginame) {
419 if (m_dc->bUseHeaders == 1) {
420 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: hdr\n");
421 if (g_checkSpoofing && ap_is_initial_req(m_req)) {
422 if (m_allhttp.empty()) {
423 // First time, so populate set with "CGI" versions of client-supplied headers.
424 #ifdef SHIB_APACHE_13
425 array_header *hdrs_arr = ap_table_elts(m_req->headers_in);
426 table_entry *hdrs = (table_entry *) hdrs_arr->elts;
428 const apr_array_header_t *hdrs_arr = apr_table_elts(m_req->headers_in);
429 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
431 for (int i = 0; i < hdrs_arr->nelts; ++i) {
434 string cgiversion("HTTP_");
435 const char* pch = hdrs[i].key;
437 cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
440 m_allhttp.insert(cgiversion);
444 if (m_allhttp.count(cginame) > 0)
445 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
447 ap_table_unset(m_req->headers_in, rawname);
448 ap_table_set(m_req->headers_in, rawname, g_unsetHeaderValue.c_str());
451 void setHeader(const char* name, const char* value) {
452 if (m_dc->bUseEnvVars != 0) {
454 // this happens on subrequests
455 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_setheader: no_m_rc\n");
456 m_rc = init_request_config(m_req);
459 m_rc->env = ap_make_table(m_req->pool, 10);
460 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_set_env: %s=%s\n", name, value?value:"Null");
461 ap_table_set(m_rc->env, name, value ? value : "");
463 if (m_dc->bUseHeaders == 1)
464 ap_table_set(m_req->headers_in, name, value);
466 string getHeader(const char* name) const {
467 const char* hdr = ap_table_get(m_req->headers_in, name);
468 return string(hdr ? hdr : "");
470 string getSecureHeader(const char* name) const {
471 if (m_dc->bUseEnvVars != 0) {
473 if (m_rc && m_rc->env)
474 hdr = ap_table_get(m_rc->env, name);
477 return string(hdr ? hdr : "");
479 return getHeader(name);
481 void setRemoteUser(const char* user) {
482 SH_AP_USER(m_req) = user ? ap_pstrdup(m_req->pool, user) : NULL;
484 string getRemoteUser() const {
485 return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
487 void setContentType(const char* type) {
488 m_req->content_type = ap_psprintf(m_req->pool, type);
490 void setResponseHeader(const char* name, const char* value) {
491 #ifdef SHIB_DEFERRED_HEADERS
493 // this happens on subrequests
494 m_rc = init_request_config(m_req);
496 ap_table_add(m_rc->hdr_out, name, value);
499 ap_table_add(m_req->err_headers_out, name, value);
501 long sendResponse(istream& in, long status) {
502 ap_send_http_header(m_req);
506 ap_rwrite(buf,in.gcount(),m_req);
508 if (status!=XMLTOOLING_HTTP_STATUS_OK)
509 return m_req->status = status;
512 long sendRedirect(const char* url) {
513 ap_table_set(m_req->headers_out, "Location", url);
516 const vector<string>& getClientCertificates() const {
517 if (m_certs.empty()) {
518 const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
520 m_certs.push_back(cert);
523 cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
525 m_certs.push_back(cert);
530 long returnDecline(void) { return DECLINED; }
531 long returnOK(void) { return OK; }
534 /********************************************************************************/
537 extern "C" int shib_check_user(request_rec* r)
539 // Short-circuit entirely?
540 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
543 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
545 ostringstream threadid;
546 threadid << "[" << getpid() << "] shib_check_user" << '\0';
547 xmltooling::NDC ndc(threadid.str().c_str());
550 ShibTargetApache sta(r,false);
552 // Check user authentication and export information, then set the handler bypass
553 pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
554 apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
555 if (res.first) return res.second;
557 // user auth was okay -- export the assertions now
558 res = sta.getServiceProvider().doExport(sta);
559 if (res.first) return res.second;
561 // export happened successfully.. this user is ok.
564 catch (exception& e) {
565 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
569 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an unknown exception!");
576 extern "C" int shib_handler(request_rec* r)
578 // Short-circuit entirely?
579 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
582 ostringstream threadid;
583 threadid << "[" << getpid() << "] shib_handler" << '\0';
584 xmltooling::NDC ndc(threadid.str().c_str());
586 #ifndef SHIB_APACHE_13
587 // With 2.x, this handler always runs, though last.
588 // We check if shib_check_user ran, because it will detect a handler request
589 // and dispatch it directly.
591 apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
592 if (data==(const void*)42) {
593 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
598 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
601 ShibTargetApache sta(r,true);
603 pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
604 if (res.first) return res.second;
606 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
609 catch (exception& e) {
610 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
614 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an unknown exception!");
622 * shib_auth_checker() -- a simple resource manager to
623 * process the .htaccess settings
625 extern "C" int shib_auth_checker(request_rec* r)
627 // Short-circuit entirely?
628 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
631 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
633 ostringstream threadid;
634 threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
635 xmltooling::NDC ndc(threadid.str().c_str());
638 ShibTargetApache sta(r,false);
640 pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
641 if (res.first) return res.second;
643 // The SP method should always return true, so if we get this far, something unusual happened.
644 // Just let Apache (or some other module) decide what to do.
647 catch (exception& e) {
648 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
652 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an unknown exception!");
659 // Access control plugin that enforces htaccess rules
660 class htAccessControl : virtual public AccessControl
664 ~htAccessControl() {}
665 Lockable* lock() {return this;}
667 aclresult_t authorized(const SPRequest& request, const Session* session) const;
669 bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
672 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
674 return new htAccessControl();
677 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
680 ApacheRequestMapper(const xercesc::DOMElement* e);
681 ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
682 Lockable* lock() { return m_mapper->lock(); }
683 void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
684 Settings getSettings(const HTTPRequest& request) const;
686 const PropertySet* getParent() const { return NULL; }
687 void setParent(const PropertySet*) {}
688 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
689 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
690 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
691 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
692 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
693 void getAll(map<string,const char*>& properties) const;
694 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
695 const xercesc::DOMElement* getElement() const;
698 RequestMapper* m_mapper;
700 ThreadKey* m_propsKey;
701 AccessControl* m_htaccess;
704 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
706 return new ApacheRequestMapper(e);
709 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
711 m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
712 m_htaccess=new htAccessControl();
713 m_staKey=ThreadKey::create(NULL);
714 m_propsKey=ThreadKey::create(NULL);
717 RequestMapper::Settings ApacheRequestMapper::getSettings(const HTTPRequest& request) const
719 Settings s=m_mapper->getSettings(request);
720 m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
721 m_propsKey->setData((void*)s.first);
722 return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
725 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
727 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
728 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
730 // Override Apache-settable boolean properties.
731 if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
732 return make_pair(true, sta->m_dc->bRequireSession==1);
733 else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
734 return make_pair(true, sta->m_dc->bExportAssertion==1);
735 else if (sta->m_dc->tSettings) {
736 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
738 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
741 return s ? s->getBool(name,ns) : make_pair(false,false);
744 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
746 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
747 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
749 // Override Apache-settable string properties.
750 if (name && !strcmp(name,"authType")) {
751 const char *auth_type=ap_auth_type(sta->m_req);
753 // Check for Basic Hijack
754 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
755 auth_type = "shibboleth";
756 return make_pair(true,auth_type);
759 else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
760 return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
761 else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
762 return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
763 else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
764 return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
765 else if (sta->m_dc->tSettings) {
766 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
768 return make_pair(true, prop);
771 return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
774 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
776 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
777 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
780 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
782 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
783 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
785 // Override Apache-settable int properties.
786 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
787 return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, NULL, 10));
788 else if (sta->m_dc->tSettings) {
789 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
791 return pair<bool,unsigned int>(true, atoi(prop));
794 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
797 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
799 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
800 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
802 // Override Apache-settable int properties.
803 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
804 return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
805 else if (sta->m_dc->tSettings) {
806 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
808 return make_pair(true, atoi(prop));
811 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
814 void ApacheRequestMapper::getAll(map<string,const char*>& properties) const
816 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
817 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
820 s->getAll(properties);
824 const char* auth_type=ap_auth_type(sta->m_req);
826 // Check for Basic Hijack
827 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
828 auth_type = "shibboleth";
829 properties["authType"] = auth_type;
832 if (sta->m_dc->szApplicationId)
833 properties["applicationId"] = sta->m_dc->szApplicationId;
834 if (sta->m_dc->szRequireWith)
835 properties["requireSessionWith"] = sta->m_dc->szRequireWith;
836 if (sta->m_dc->szRedirectToSSL)
837 properties["redirectToSSL"] = sta->m_dc->szRedirectToSSL;
838 if (sta->m_dc->bRequireSession != 0)
839 properties["requireSession"] = (sta->m_dc->bRequireSession==1) ? "true" : "false";
840 if (sta->m_dc->bExportAssertion != 0)
841 properties["exportAssertion"] = (sta->m_dc->bExportAssertion==1) ? "true" : "false";
844 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
846 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
847 return s ? s->getPropertySet(name,ns) : NULL;
850 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
852 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
853 return s ? s->getElement() : NULL;
856 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
859 SH_AP_TABLE* grps=ap_make_table(r->pool,15);
860 char l[MAX_STRING_LEN];
861 const char *group_name, *ll, *w;
863 #ifdef SHIB_APACHE_13
864 if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
866 if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
868 ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
873 #ifdef SHIB_APACHE_13
874 sp=ap_make_sub_pool(r->pool);
876 if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
877 ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
878 "groups_for_user() could not create a subpool");
883 while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
884 if ((*l=='#') || (!*l))
889 group_name=ap_getword(sp,&ll,':');
892 w=ap_getword_conf(sp,&ll);
893 if (!strcmp(w,user)) {
894 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
904 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
906 bool caseSensitive = attr->isCaseSensitive();
907 const vector<string>& vals = attr->getSerializedValues();
908 for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
910 auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
911 if (re->matches(trans.get())) {
912 if (request.isPriorityEnabled(SPRequest::SPDebug))
913 request.log(SPRequest::SPDebug, string("htaccess: expecting regexp ") + toMatch + ", got " + *v + ": acccepted");
917 else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
918 if (request.isPriorityEnabled(SPRequest::SPDebug))
919 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": accepted");
922 else if (request.isPriorityEnabled(SPRequest::SPDebug)) {
923 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": rejected");
929 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
931 // Make sure the object is our type.
932 const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
934 throw ConfigurationException("Request wrapper object was not of correct type.");
938 int m=sta->m_req->method_number;
939 bool method_restricted=false;
942 const array_header* reqs_arr=ap_requires(sta->m_req);
944 return shib_acl_indeterminate; // should never happen
946 require_line* reqs=(require_line*)reqs_arr->elts;
948 for (int x=0; x<reqs_arr->nelts; x++) {
949 // This rule should be completely ignored, the method doesn't fit.
950 // The rule just doesn't exist for our purposes.
951 if (!(reqs[x].method_mask & (1 << m)))
954 method_restricted=true; // this lets us know at the end that at least one rule was potentially enforcable.
956 // Tracks status of this rule's evaluation.
959 string remote_user = request.getRemoteUser();
961 t = reqs[x].requirement;
962 w = ap_getword_white(sta->m_req->pool, &t);
964 if (!strcasecmp(w,"shibboleth")) {
965 // This is a dummy rule needed because Apache conflates authn and authz.
966 // Without some require rule, AuthType is ignored and no check_user hooks run.
967 status = true; // treat it as an "accepted" rule
969 else if (!strcmp(w,"valid-user") && session) {
970 request.log(SPRequest::SPDebug, "htaccess: accepting valid-user based on active session");
973 else if (!strcmp(w,"user") && !remote_user.empty()) {
974 bool regexp=false,negate=false;
976 w=ap_getword_conf(sta->m_req->pool,&t);
988 // Figure out if there's a match.
992 // To do regex matching, we have to convert from UTF-8.
993 auto_arrayptr<XMLCh> trans(fromUTF8(w));
994 RegularExpression re(trans.get());
995 auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
996 match = re.matches(trans2.get());
998 catch (XMLException& ex) {
999 auto_ptr_char tmp(ex.getMessage());
1000 request.log(SPRequest::SPError,
1001 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1004 else if (remote_user==w) {
1009 // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1011 if (request.isPriorityEnabled(SPRequest::SPDebug))
1012 request.log(SPRequest::SPDebug,
1013 string("htaccess: require user ") + (negate ? "rejecting (" : "accepting (") + remote_user + ")");
1018 else if (!strcmp(w,"group") && !remote_user.empty()) {
1019 SH_AP_TABLE* grpstatus=NULL;
1020 if (sta->m_dc->szAuthGrpFile) {
1021 if (request.isPriorityEnabled(SPRequest::SPDebug))
1022 request.log(SPRequest::SPDebug,string("htaccess plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
1023 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
1028 w=ap_getword_conf(sta->m_req->pool,&t);
1034 if (grpstatus && ap_table_get(grpstatus,w)) {
1035 // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1037 request.log(SPRequest::SPDebug, string("htaccess: require group ") + (negate ? "rejecting (" : "accepting (") + w + ")");
1042 else if (!strcmp(w,"authnContextClassRef") || !strcmp(w,"authnContextDeclRef")) {
1043 const char* ref = !strcmp(w,"authnContextClassRef") ? session->getAuthnContextClassRef() : session->getAuthnContextDeclRef();
1044 bool regexp=false,negate=false;
1046 w=ap_getword_conf(sta->m_req->pool,&t);
1058 // Figure out if there's a match.
1062 // To do regex matching, we have to convert from UTF-8.
1063 RegularExpression re(w);
1064 match = re.matches(ref);
1066 catch (XMLException& ex) {
1067 auto_ptr_char tmp(ex.getMessage());
1068 request.log(SPRequest::SPError,
1069 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1072 else if (!strcmp(w,ref)) {
1077 // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1079 if (request.isPriorityEnabled(SPRequest::SPDebug))
1080 request.log(SPRequest::SPDebug,
1081 string("htaccess: require authnContext ") + (negate ? "rejecting (" : "accepting (") + ref + ")");
1086 else if (!session) {
1087 request.log(SPRequest::SPError, string("htaccess: require ") + w + " not given a valid session, are you using lazy sessions?");
1090 // Find the attribute(s) matching the require rule.
1091 pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1092 session->getIndexedAttributes().equal_range(w);
1095 while (!status && attrs.first!=attrs.second && *t) {
1096 w=ap_getword_conf(sta->m_req->pool,&t);
1103 auto_ptr<RegularExpression> re;
1105 delete re.release();
1106 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1107 auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1111 for (; !status && attrs.first!=attrs.second; ++attrs.first) {
1112 if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
1117 catch (XMLException& ex) {
1118 auto_ptr_char tmp(ex.getMessage());
1119 request.log(SPRequest::SPError,
1120 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1126 // If status is false, we found a rule we couldn't satisfy.
1127 // Could be an unknown rule to us, or it just didn't match.
1129 if (status && sta->m_dc->bRequireAll != 1) {
1130 // If we're not insisting that all rules be met, then we're done.
1131 request.log(SPRequest::SPDebug, "htaccess: a rule was successful, granting access");
1132 return shib_acl_true;
1134 else if (!status && sta->m_dc->bRequireAll == 1) {
1135 // If we're insisting that all rules be met, which is not something Apache really handles well,
1136 // then we either return false or indeterminate based on the authoritative option, which defaults on.
1137 if (sta->m_dc->bAuthoritative != 0) {
1138 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful, denying access");
1139 return shib_acl_false;
1142 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful but not authoritative, leaving it up to Apache");
1143 return shib_acl_indeterminate;
1146 // Otherwise, we keep going. If we're requring all, then we have to check every rule.
1147 // If not we just didn't find a successful rule yet, so we keep going anyway.
1150 // If we get here, we either "failed" or we're in require all mode (but not both).
1151 // If no rules possibly apply or we insisted that all rules check out, then we're good.
1152 if (!method_restricted) {
1153 request.log(SPRequest::SPDebug, "htaccess: no rules applied to this request method, granting access");
1154 return shib_acl_true;
1156 else if (sta->m_dc->bRequireAll == 1) {
1157 request.log(SPRequest::SPDebug, "htaccess: all rules successful, granting access");
1158 return shib_acl_true;
1160 else if (sta->m_dc->bAuthoritative != 0) {
1161 request.log(SPRequest::SPDebug, "htaccess: no rules were successful, denying access");
1162 return shib_acl_false;
1165 request.log(SPRequest::SPDebug, "htaccess: no rules were successful but not authoritative, leaving it up to Apache");
1166 return shib_acl_indeterminate;
1170 // Initial look at a request - create the per-request structure
1171 static int shib_post_read(request_rec *r)
1173 shib_request_config* rc = init_request_config(r);
1175 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1177 #ifdef SHIB_DEFERRED_HEADERS
1178 rc->hdr_out = ap_make_table(r->pool, 5);
1183 // fixups: set environment vars
1185 extern "C" int shib_fixups(request_rec* r)
1187 shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1188 shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1189 if (dc->bOff==1 || dc->bUseEnvVars==0)
1192 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1194 if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
1197 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1198 r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1203 #ifdef SHIB_APACHE_13
1206 * Cleanup the (per-process) pool info.
1208 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1211 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1214 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1220 * Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1222 extern "C" apr_status_t shib_exit(void* data)
1228 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
1234 * shire_child_init()
1235 * Things to do when the child process is initialized.
1236 * (or after the configs are read in apache-2)
1238 #ifdef SHIB_APACHE_13
1239 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1241 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1244 // Initialize runtime components.
1246 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1249 ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1253 g_Config=&SPConfig::getConfig();
1254 g_Config->setFeatures(
1255 SPConfig::Listener |
1257 SPConfig::RequestMapping |
1258 SPConfig::InProcess |
1262 if (!g_Config->init(g_szSchemaDir)) {
1263 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1266 g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1267 g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1270 xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
1271 XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
1272 xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
1273 auto_ptr_XMLCh src(g_szSHIBConfig);
1274 dummy->setAttributeNS(NULL,path,src.get());
1275 dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
1277 g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
1278 g_Config->getServiceProvider()->init();
1280 catch (exception& ex) {
1281 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1282 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1286 ServiceProvider* sp=g_Config->getServiceProvider();
1287 xmltooling::Locker locker(sp);
1288 const PropertySet* props=sp->getPropertySet("Local");
1290 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1291 if (unsetValue.first)
1292 g_unsetHeaderValue = unsetValue.second;
1293 pair<bool,bool> flag=props->getBool("checkSpoofing");
1294 g_checkSpoofing = !flag.first || flag.second;
1295 flag=props->getBool("catchAll");
1296 g_catchAll = flag.first && flag.second;
1299 // Set the cleanup handler
1300 apr_pool_cleanup_register(p, NULL, &shib_exit, apr_pool_cleanup_null);
1302 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1306 #ifdef SHIB_DEFERRED_HEADERS
1307 static void set_output_filter(request_rec *r)
1309 ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1312 static void set_error_filter(request_rec *r)
1314 ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1317 static int _table_add(void *v, const char *key, const char *value)
1319 apr_table_addn((apr_table_t*)v, key, value);
1323 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1325 request_rec *r = f->r;
1326 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1329 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);
1330 apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1331 // can't use overlap call because it will collapse Set-Cookie headers
1332 //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1335 /* remove ourselves from the filter chain */
1336 ap_remove_output_filter(f);
1338 /* send the data up the stack */
1339 return ap_pass_brigade(f->next,in);
1342 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1344 request_rec *r = f->r;
1345 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1348 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);
1349 apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1350 // can't use overlap call because it will collapse Set-Cookie headers
1351 //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1354 /* remove ourselves from the filter chain */
1355 ap_remove_output_filter(f);
1357 /* send the data up the stack */
1358 return ap_pass_brigade(f->next,in);
1360 #endif // SHIB_DEFERRED_HEADERS
1362 typedef const char* (*config_fn_t)(void);
1364 #ifdef SHIB_APACHE_13
1366 // SHIB Module commands
1368 static command_rec shire_cmds[] = {
1369 {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1370 RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1371 {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1372 RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1373 {"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1374 RSRC_CONF, TAKE1, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"},
1376 {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1377 (void *) XtOffsetOf (shib_server_config, szScheme),
1378 RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1380 {"ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1381 OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1383 {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1384 (void *) XtOffsetOf (shib_dir_config, bOff),
1385 OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1386 {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1387 (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1388 OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1389 {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1390 (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1391 OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1392 {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1393 (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1394 OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1395 {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1396 (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1397 OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1398 {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1399 (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1400 OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1401 {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1402 (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1403 OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1404 {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1405 (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1406 OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1407 {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1408 (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1409 OR_AUTHCFG, FLAG, "All require directives must match"},
1410 {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1411 (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1412 OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1413 {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1414 (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1415 OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1416 {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1417 (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1418 OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1424 handler_rec shib_handlers[] = {
1425 { "shib-handler", shib_handler },
1429 module MODULE_VAR_EXPORT mod_shib = {
1430 STANDARD_MODULE_STUFF,
1431 NULL, /* initializer */
1432 create_shib_dir_config, /* dir config creater */
1433 merge_shib_dir_config, /* dir merger --- default is to override */
1434 create_shib_server_config, /* server config */
1435 merge_shib_server_config, /* merge server config */
1436 shire_cmds, /* command table */
1437 shib_handlers, /* handlers */
1438 NULL, /* filename translation */
1439 shib_check_user, /* check_user_id */
1440 shib_auth_checker, /* check auth */
1441 NULL, /* check access */
1442 NULL, /* type_checker */
1443 shib_fixups, /* fixups */
1445 NULL, /* header parser */
1446 shib_child_init, /* child_init */
1447 shib_child_exit, /* child_exit */
1448 shib_post_read /* post read-request */
1451 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1453 extern "C" void shib_register_hooks (apr_pool_t *p)
1455 #ifdef SHIB_DEFERRED_HEADERS
1456 ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1457 ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1458 ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1459 ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1460 ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1462 ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1463 ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1464 ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1465 ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1466 ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1469 // SHIB Module commands
1472 static command_rec shib_cmds[] = {
1473 AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1474 RSRC_CONF, "Path to shibboleth.xml config file"),
1475 AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1476 RSRC_CONF, "Paths of XML schema catalogs"),
1477 AP_INIT_TAKE1("ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1478 RSRC_CONF, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"),
1480 AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1481 (void *) offsetof (shib_server_config, szScheme),
1482 RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1484 AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1485 OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1487 AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1488 (void *) offsetof (shib_dir_config, bOff),
1489 OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1490 AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1491 (void *) offsetof (shib_dir_config, szApplicationId),
1492 OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1493 AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1494 (void *) offsetof (shib_dir_config, bBasicHijack),
1495 OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1496 AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1497 (void *) offsetof (shib_dir_config, bRequireSession),
1498 OR_AUTHCFG, "Initiates a new session if one does not exist"),
1499 AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1500 (void *) offsetof (shib_dir_config, szRequireWith),
1501 OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1502 AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1503 (void *) offsetof (shib_dir_config, bExportAssertion),
1504 OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1505 AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1506 (void *) offsetof (shib_dir_config, szRedirectToSSL),
1507 OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1508 AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1509 (void *) offsetof (shib_dir_config, szAuthGrpFile),
1510 OR_AUTHCFG, "Text file containing group names and member user IDs"),
1511 AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1512 (void *) offsetof (shib_dir_config, bRequireAll),
1513 OR_AUTHCFG, "All require directives must match"),
1514 AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1515 (void *) offsetof (shib_dir_config, bAuthoritative),
1516 OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1517 AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1518 (void *) offsetof (shib_dir_config, bUseEnvVars),
1519 OR_AUTHCFG, "Export attributes using environment variables (default)"),
1520 AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1521 (void *) offsetof (shib_dir_config, bUseHeaders),
1522 OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1527 module AP_MODULE_DECLARE_DATA mod_shib = {
1528 STANDARD20_MODULE_STUFF,
1529 create_shib_dir_config, /* create dir config */
1530 merge_shib_dir_config, /* merge dir config --- default is to override */
1531 create_shib_server_config, /* create server config */
1532 merge_shib_server_config, /* merge server config */
1533 shib_cmds, /* command table */
1534 shib_register_hooks /* register hooks */
1538 #error "unsupported Apache version"