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 = NULL;
89 char* g_szSchemaDir = NULL;
90 char* g_szPrefix = NULL;
91 SPConfig* g_Config = NULL;
92 string g_unsetHeaderValue;
93 bool g_checkSpoofing = true;
94 bool g_catchAll = false;
95 static const char* g_UserDataKey = "_shib_check_user_";
96 static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
97 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
100 /* Apache 2.2.x headers must be accumulated and set in the output filter.
101 Apache 2.0.49+ supports the filter method.
102 Apache 1.3.x and lesser 2.0.x must write the headers directly. */
104 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
105 #define SHIB_DEFERRED_HEADERS
108 /********************************************************************************/
109 // Basic Apache Configuration code.
112 // per-server module configuration structure
113 struct shib_server_config
118 // creates the per-server configuration
119 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
121 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
126 // overrides server configuration in virtual servers
127 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
129 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
130 shib_server_config* parent=(shib_server_config*)base;
131 shib_server_config* child=(shib_server_config*)sub;
134 sc->szScheme=ap_pstrdup(p,child->szScheme);
135 else if (parent->szScheme)
136 sc->szScheme=ap_pstrdup(p,parent->szScheme);
143 // per-dir module configuration structure
144 struct shib_dir_config
146 SH_AP_TABLE* tSettings; // generic table of extensible settings
149 char* szAuthGrpFile; // Auth GroupFile name
150 int bRequireAll; // all "known" require directives must match, otherwise OR logic
151 int bAuthoritative; // allow htaccess plugin to DECLINE when authz fails
153 // Content Configuration
154 char* szApplicationId; // Shib applicationId value
155 char* szRequireWith; // require a session using a specific initiator?
156 char* szRedirectToSSL; // redirect non-SSL requests to SSL port
157 int bOff; // flat-out disable all Shib processing
158 int bBasicHijack; // activate for AuthType Basic?
159 int bRequireSession; // require a session?
160 int bExportAssertion; // export SAML assertion to the environment?
161 int bUseEnvVars; // use environment?
162 int bUseHeaders; // use headers?
165 // creates per-directory config structure
166 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
168 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
169 dc->tSettings = NULL;
170 dc->szAuthGrpFile = NULL;
171 dc->bRequireAll = -1;
172 dc->bAuthoritative = -1;
173 dc->szApplicationId = NULL;
174 dc->szRequireWith = NULL;
175 dc->szRedirectToSSL = NULL;
177 dc->bBasicHijack = -1;
178 dc->bRequireSession = -1;
179 dc->bExportAssertion = -1;
180 dc->bUseEnvVars = -1;
181 dc->bUseHeaders = -1;
185 // overrides server configuration in directories
186 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
188 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
189 shib_dir_config* parent=(shib_dir_config*)base;
190 shib_dir_config* child=(shib_dir_config*)sub;
192 // The child supersedes any matching table settings in the parent.
193 dc->tSettings = NULL;
194 if (parent->tSettings)
195 dc->tSettings = ap_copy_table(p, parent->tSettings);
196 if (child->tSettings) {
198 ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
200 dc->tSettings = ap_copy_table(p, child->tSettings);
203 if (child->szAuthGrpFile)
204 dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
205 else if (parent->szAuthGrpFile)
206 dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
208 dc->szAuthGrpFile=NULL;
210 if (child->szApplicationId)
211 dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
212 else if (parent->szApplicationId)
213 dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
215 dc->szApplicationId=NULL;
217 if (child->szRequireWith)
218 dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
219 else if (parent->szRequireWith)
220 dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
222 dc->szRequireWith=NULL;
224 if (child->szRedirectToSSL)
225 dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
226 else if (parent->szRedirectToSSL)
227 dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
229 dc->szRedirectToSSL=NULL;
231 dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
232 dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
233 dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
234 dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
235 dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
236 dc->bAuthoritative=((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
237 dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
238 dc->bUseHeaders=((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
242 // per-request module structure
243 struct shib_request_config
245 SH_AP_TABLE *env; // environment vars
246 #ifdef SHIB_DEFERRED_HEADERS
247 SH_AP_TABLE *hdr_out; // headers to browser
251 // create a request record
252 static shib_request_config *init_request_config(request_rec *r)
254 shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
255 ap_set_module_config (r->request_config, &mod_shib, rc);
256 memset(rc, 0, sizeof(shib_request_config));
257 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
261 // generic global slot handlers
262 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
264 *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
268 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
270 char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
271 size_t offset=(size_t)parms->info;
272 *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
276 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
277 #ifdef SHIB_APACHE_13
278 char* arg1, char* arg2
280 void* arg1, const char* arg2
284 ap_set_file_slot(parms, arg1, arg2);
288 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
291 dc->tSettings = ap_make_table(parms->pool, 4);
292 ap_table_set(dc->tSettings, arg1, arg2);
296 /********************************************************************************/
297 // Apache ShibTarget subclass(es) here.
299 class ShibTargetApache : public AbstractSPRequest
302 mutable string m_body;
303 mutable bool m_gotBody;
304 mutable vector<string> m_certs;
305 set<string> m_allhttp;
309 shib_dir_config* m_dc;
310 shib_server_config* m_sc;
311 shib_request_config* m_rc;
313 ShibTargetApache(request_rec* req, bool handler) : AbstractSPRequest(SHIBSP_LOGCAT".Apache"), m_handler(handler), m_gotBody(false) {
314 m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
315 m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
316 m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
319 setRequestURI(m_req->unparsed_uri);
321 virtual ~ShibTargetApache() {}
323 const char* getScheme() const {
324 return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
326 const char* getHostname() const {
327 return ap_get_server_name(m_req);
329 int getPort() const {
330 return ap_get_server_port(m_req);
332 const char* getMethod() const {
333 return m_req->method;
335 string getContentType() const {
336 const char* type = ap_table_get(m_req->headers_in, "Content-Type");
337 return type ? type : "";
339 long getContentLength() const {
340 return m_gotBody ? m_body.length() : m_req->remaining;
342 string getRemoteAddr() const {
343 return m_req->connection->remote_ip;
345 void log(SPLogLevel level, const string& msg) const {
346 AbstractSPRequest::log(level,msg);
349 (level == SPDebug ? APLOG_DEBUG :
350 (level == SPInfo ? APLOG_INFO :
351 (level == SPWarn ? APLOG_WARNING :
352 (level == SPError ? APLOG_ERR : APLOG_CRIT))))|APLOG_NOERRNO,
357 const char* getQueryString() const { return m_req->args; }
358 const char* getRequestBody() const {
359 if (m_gotBody || m_req->method_number==M_GET)
360 return m_body.c_str();
361 #ifdef SHIB_APACHE_13
362 // Read the posted data
363 if (ap_setup_client_block(m_req, REQUEST_CHUNKED_DECHUNK) != OK) {
365 log(SPError, "Apache function (setup_client_block) failed while reading request body.");
366 return m_body.c_str();
368 if (!ap_should_client_block(m_req)) {
370 log(SPError, "Apache function (should_client_block) failed while reading request body.");
371 return m_body.c_str();
373 if (m_req->remaining > 1024*1024)
374 throw opensaml::SecurityPolicyException("Blocked request body larger than 1M size limit.");
377 char buff[HUGE_STRING_LEN];
378 ap_hard_timeout("[mod_shib] getRequestBody", m_req);
379 while ((len=ap_get_client_block(m_req, buff, sizeof(buff))) > 0) {
380 ap_reset_timeout(m_req);
381 m_body.append(buff, len);
383 ap_kill_timeout(m_req);
388 apr_bucket_brigade* bb = apr_brigade_create(m_req->pool, m_req->connection->bucket_alloc);
391 apr_status_t rv = ap_get_brigade(m_req->input_filters, bb, AP_MODE_READBYTES, APR_BLOCK_READ, HUGE_STRING_LEN);
392 if (rv != APR_SUCCESS) {
393 log(SPError, "Apache function (ap_get_brigade) failed while reading request body.");
397 for (bucket = APR_BRIGADE_FIRST(bb); bucket != APR_BRIGADE_SENTINEL(bb); bucket = APR_BUCKET_NEXT(bucket)) {
398 if (APR_BUCKET_IS_EOS(bucket)) {
403 /* We can't do much with this. */
404 if (APR_BUCKET_IS_FLUSH(bucket))
408 apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
410 m_body.append(data, len);
412 apr_brigade_cleanup(bb);
414 apr_brigade_destroy(bb);
417 return m_body.c_str();
419 void clearHeader(const char* rawname, const char* cginame) {
420 if (m_dc->bUseHeaders == 1) {
421 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: hdr\n");
422 if (g_checkSpoofing && ap_is_initial_req(m_req)) {
423 if (m_allhttp.empty()) {
424 // First time, so populate set with "CGI" versions of client-supplied headers.
425 #ifdef SHIB_APACHE_13
426 array_header *hdrs_arr = ap_table_elts(m_req->headers_in);
427 table_entry *hdrs = (table_entry *) hdrs_arr->elts;
429 const apr_array_header_t *hdrs_arr = apr_table_elts(m_req->headers_in);
430 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
432 for (int i = 0; i < hdrs_arr->nelts; ++i) {
435 string cgiversion("HTTP_");
436 const char* pch = hdrs[i].key;
438 cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
441 m_allhttp.insert(cgiversion);
445 if (m_allhttp.count(cginame) > 0)
446 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
448 ap_table_unset(m_req->headers_in, rawname);
449 ap_table_set(m_req->headers_in, rawname, g_unsetHeaderValue.c_str());
452 void setHeader(const char* name, const char* value) {
453 if (m_dc->bUseEnvVars != 0) {
455 // this happens on subrequests
456 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_setheader: no_m_rc\n");
457 m_rc = init_request_config(m_req);
460 m_rc->env = ap_make_table(m_req->pool, 10);
461 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_set_env: %s=%s\n", name, value?value:"Null");
462 ap_table_set(m_rc->env, name, value ? value : "");
464 if (m_dc->bUseHeaders == 1)
465 ap_table_set(m_req->headers_in, name, value);
467 string getHeader(const char* name) const {
468 const char* hdr = ap_table_get(m_req->headers_in, name);
469 return string(hdr ? hdr : "");
471 string getSecureHeader(const char* name) const {
472 if (m_dc->bUseEnvVars != 0) {
474 if (m_rc && m_rc->env)
475 hdr = ap_table_get(m_rc->env, name);
478 return string(hdr ? hdr : "");
480 return getHeader(name);
482 void setRemoteUser(const char* user) {
483 SH_AP_USER(m_req) = user ? ap_pstrdup(m_req->pool, user) : NULL;
485 string getRemoteUser() const {
486 return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
488 void setContentType(const char* type) {
489 m_req->content_type = ap_psprintf(m_req->pool, type);
491 void setResponseHeader(const char* name, const char* value) {
492 #ifdef SHIB_DEFERRED_HEADERS
494 // this happens on subrequests
495 m_rc = init_request_config(m_req);
497 ap_table_add(m_rc->hdr_out, name, value);
500 ap_table_add(m_req->err_headers_out, name, value);
502 long sendResponse(istream& in, long status) {
503 if (status != XMLTOOLING_HTTP_STATUS_OK)
504 m_req->status = status;
505 ap_send_http_header(m_req);
509 ap_rwrite(buf,in.gcount(),m_req);
511 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22))
512 if (status != XMLTOOLING_HTTP_STATUS_OK && status != XMLTOOLING_HTTP_STATUS_ERROR)
517 long sendRedirect(const char* url) {
518 ap_table_set(m_req->headers_out, "Location", url);
521 const vector<string>& getClientCertificates() const {
522 if (m_certs.empty()) {
523 const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
525 m_certs.push_back(cert);
528 cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
530 m_certs.push_back(cert);
535 long returnDecline(void) { return DECLINED; }
536 long returnOK(void) { return OK; }
539 /********************************************************************************/
542 extern "C" int shib_check_user(request_rec* r)
544 // Short-circuit entirely?
545 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
548 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
550 ostringstream threadid;
551 threadid << "[" << getpid() << "] shib_check_user" << '\0';
552 xmltooling::NDC ndc(threadid.str().c_str());
555 ShibTargetApache sta(r,false);
557 // Check user authentication and export information, then set the handler bypass
558 pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
559 apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
560 if (res.first) return res.second;
562 // user auth was okay -- export the assertions now
563 res = sta.getServiceProvider().doExport(sta);
564 if (res.first) return res.second;
566 // export happened successfully.. this user is ok.
569 catch (exception& e) {
570 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
574 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an unknown exception!");
581 extern "C" int shib_handler(request_rec* r)
583 // Short-circuit entirely?
584 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
587 ostringstream threadid;
588 threadid << "[" << getpid() << "] shib_handler" << '\0';
589 xmltooling::NDC ndc(threadid.str().c_str());
591 #ifndef SHIB_APACHE_13
592 // With 2.x, this handler always runs, though last.
593 // We check if shib_check_user ran, because it will detect a handler request
594 // and dispatch it directly.
596 apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
597 if (data==(const void*)42) {
598 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
603 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
606 ShibTargetApache sta(r,true);
608 pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
609 if (res.first) return res.second;
611 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
614 catch (exception& e) {
615 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
619 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an unknown exception!");
627 * shib_auth_checker() -- a simple resource manager to
628 * process the .htaccess settings
630 extern "C" int shib_auth_checker(request_rec* r)
632 // Short-circuit entirely?
633 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
636 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
638 ostringstream threadid;
639 threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
640 xmltooling::NDC ndc(threadid.str().c_str());
643 ShibTargetApache sta(r,false);
645 pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
646 if (res.first) return res.second;
648 // The SP method should always return true, so if we get this far, something unusual happened.
649 // Just let Apache (or some other module) decide what to do.
652 catch (exception& e) {
653 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
657 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an unknown exception!");
664 // Access control plugin that enforces htaccess rules
665 class htAccessControl : virtual public AccessControl
669 ~htAccessControl() {}
670 Lockable* lock() {return this;}
672 aclresult_t authorized(const SPRequest& request, const Session* session) const;
674 bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
677 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
679 return new htAccessControl();
682 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
685 ApacheRequestMapper(const xercesc::DOMElement* e);
686 ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
687 Lockable* lock() { return m_mapper->lock(); }
688 void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
689 Settings getSettings(const HTTPRequest& request) const;
691 const PropertySet* getParent() const { return NULL; }
692 void setParent(const PropertySet*) {}
693 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
694 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
695 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
696 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
697 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
698 void getAll(map<string,const char*>& properties) const;
699 const PropertySet* getPropertySet(const char* name, const char* ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const;
700 const xercesc::DOMElement* getElement() const;
703 RequestMapper* m_mapper;
705 ThreadKey* m_propsKey;
706 AccessControl* m_htaccess;
709 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
711 return new ApacheRequestMapper(e);
714 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
716 m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
717 m_htaccess=new htAccessControl();
718 m_staKey=ThreadKey::create(NULL);
719 m_propsKey=ThreadKey::create(NULL);
722 RequestMapper::Settings ApacheRequestMapper::getSettings(const HTTPRequest& request) const
724 Settings s=m_mapper->getSettings(request);
725 m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
726 m_propsKey->setData((void*)s.first);
727 return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
730 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
732 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
733 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
735 // Override Apache-settable boolean properties.
736 if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
737 return make_pair(true, sta->m_dc->bRequireSession==1);
738 else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
739 return make_pair(true, sta->m_dc->bExportAssertion==1);
740 else if (sta->m_dc->tSettings) {
741 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
743 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
746 return s ? s->getBool(name,ns) : make_pair(false,false);
749 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
751 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
752 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
754 // Override Apache-settable string properties.
755 if (name && !strcmp(name,"authType")) {
756 const char *auth_type=ap_auth_type(sta->m_req);
758 // Check for Basic Hijack
759 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
760 auth_type = "shibboleth";
761 return make_pair(true,auth_type);
764 else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
765 return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
766 else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
767 return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
768 else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
769 return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
770 else if (sta->m_dc->tSettings) {
771 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
773 return make_pair(true, prop);
776 return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
779 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
781 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
782 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
785 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
787 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
788 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
790 // Override Apache-settable int properties.
791 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
792 return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, NULL, 10));
793 else if (sta->m_dc->tSettings) {
794 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
796 return pair<bool,unsigned int>(true, atoi(prop));
799 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
802 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
804 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
805 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
807 // Override Apache-settable int properties.
808 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
809 return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
810 else if (sta->m_dc->tSettings) {
811 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
813 return make_pair(true, atoi(prop));
816 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
819 void ApacheRequestMapper::getAll(map<string,const char*>& properties) const
821 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
822 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
825 s->getAll(properties);
829 const char* auth_type=ap_auth_type(sta->m_req);
831 // Check for Basic Hijack
832 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
833 auth_type = "shibboleth";
834 properties["authType"] = auth_type;
837 if (sta->m_dc->szApplicationId)
838 properties["applicationId"] = sta->m_dc->szApplicationId;
839 if (sta->m_dc->szRequireWith)
840 properties["requireSessionWith"] = sta->m_dc->szRequireWith;
841 if (sta->m_dc->szRedirectToSSL)
842 properties["redirectToSSL"] = sta->m_dc->szRedirectToSSL;
843 if (sta->m_dc->bRequireSession != 0)
844 properties["requireSession"] = (sta->m_dc->bRequireSession==1) ? "true" : "false";
845 if (sta->m_dc->bExportAssertion != 0)
846 properties["exportAssertion"] = (sta->m_dc->bExportAssertion==1) ? "true" : "false";
849 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
851 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
852 return s ? s->getPropertySet(name,ns) : NULL;
855 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
857 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
858 return s ? s->getElement() : NULL;
861 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
864 SH_AP_TABLE* grps=ap_make_table(r->pool,15);
865 char l[MAX_STRING_LEN];
866 const char *group_name, *ll, *w;
868 #ifdef SHIB_APACHE_13
869 if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
871 if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
873 ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
878 #ifdef SHIB_APACHE_13
879 sp=ap_make_sub_pool(r->pool);
881 if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
882 ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
883 "groups_for_user() could not create a subpool");
888 while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
889 if ((*l=='#') || (!*l))
894 group_name=ap_getword(sp,&ll,':');
897 w=ap_getword_conf(sp,&ll);
898 if (!strcmp(w,user)) {
899 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
909 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
911 bool caseSensitive = attr->isCaseSensitive();
912 const vector<string>& vals = attr->getSerializedValues();
913 for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
915 auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
916 if (re->matches(trans.get())) {
917 if (request.isPriorityEnabled(SPRequest::SPDebug))
918 request.log(SPRequest::SPDebug, string("htaccess: expecting regexp ") + toMatch + ", got " + *v + ": acccepted");
922 else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
923 if (request.isPriorityEnabled(SPRequest::SPDebug))
924 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": accepted");
927 else if (request.isPriorityEnabled(SPRequest::SPDebug)) {
928 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": rejected");
934 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
936 // Make sure the object is our type.
937 const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
939 throw ConfigurationException("Request wrapper object was not of correct type.");
943 int m=sta->m_req->method_number;
944 bool method_restricted=false;
947 const array_header* reqs_arr=ap_requires(sta->m_req);
949 return shib_acl_indeterminate; // should never happen
951 require_line* reqs=(require_line*)reqs_arr->elts;
953 for (int x=0; x<reqs_arr->nelts; x++) {
954 // This rule should be completely ignored, the method doesn't fit.
955 // The rule just doesn't exist for our purposes.
956 if (!(reqs[x].method_mask & (1 << m)))
959 method_restricted=true; // this lets us know at the end that at least one rule was potentially enforcable.
961 // Tracks status of this rule's evaluation.
964 string remote_user = request.getRemoteUser();
966 t = reqs[x].requirement;
967 w = ap_getword_white(sta->m_req->pool, &t);
969 if (!strcasecmp(w,"shibboleth")) {
970 // This is a dummy rule needed because Apache conflates authn and authz.
971 // Without some require rule, AuthType is ignored and no check_user hooks run.
972 status = true; // treat it as an "accepted" rule
974 else if (!strcmp(w,"valid-user") && session) {
975 request.log(SPRequest::SPDebug, "htaccess: accepting valid-user based on active session");
978 else if (!strcmp(w,"user") && !remote_user.empty()) {
979 bool regexp=false,negate=false;
981 w=ap_getword_conf(sta->m_req->pool,&t);
993 // Figure out if there's a match.
997 // To do regex matching, we have to convert from UTF-8.
998 auto_arrayptr<XMLCh> trans(fromUTF8(w));
999 RegularExpression re(trans.get());
1000 auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
1001 match = re.matches(trans2.get());
1003 catch (XMLException& ex) {
1004 auto_ptr_char tmp(ex.getMessage());
1005 request.log(SPRequest::SPError,
1006 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1009 else if (remote_user==w) {
1014 // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1016 if (request.isPriorityEnabled(SPRequest::SPDebug))
1017 request.log(SPRequest::SPDebug,
1018 string("htaccess: require user ") + (negate ? "rejecting (" : "accepting (") + remote_user + ")");
1023 else if (!strcmp(w,"group") && !remote_user.empty()) {
1024 SH_AP_TABLE* grpstatus=NULL;
1025 if (sta->m_dc->szAuthGrpFile) {
1026 if (request.isPriorityEnabled(SPRequest::SPDebug))
1027 request.log(SPRequest::SPDebug,string("htaccess plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
1028 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
1033 w=ap_getword_conf(sta->m_req->pool,&t);
1039 if (grpstatus && ap_table_get(grpstatus,w)) {
1040 // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1042 request.log(SPRequest::SPDebug, string("htaccess: require group ") + (negate ? "rejecting (" : "accepting (") + w + ")");
1047 else if (!strcmp(w,"authnContextClassRef") || !strcmp(w,"authnContextDeclRef")) {
1048 const char* ref = !strcmp(w,"authnContextClassRef") ? session->getAuthnContextClassRef() : session->getAuthnContextDeclRef();
1049 bool regexp=false,negate=false;
1051 w=ap_getword_conf(sta->m_req->pool,&t);
1063 // Figure out if there's a match.
1067 // To do regex matching, we have to convert from UTF-8.
1068 RegularExpression re(w);
1069 match = re.matches(ref);
1071 catch (XMLException& ex) {
1072 auto_ptr_char tmp(ex.getMessage());
1073 request.log(SPRequest::SPError,
1074 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1077 else if (!strcmp(w,ref)) {
1082 // If we matched, then we're done with this rule either way and status is set to reflect the outcome.
1084 if (request.isPriorityEnabled(SPRequest::SPDebug))
1085 request.log(SPRequest::SPDebug,
1086 string("htaccess: require authnContext ") + (negate ? "rejecting (" : "accepting (") + ref + ")");
1091 else if (!session) {
1092 request.log(SPRequest::SPError, string("htaccess: require ") + w + " not given a valid session, are you using lazy sessions?");
1095 // Find the attribute(s) matching the require rule.
1096 pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1097 session->getIndexedAttributes().equal_range(w);
1100 while (!status && attrs.first!=attrs.second && *t) {
1101 w=ap_getword_conf(sta->m_req->pool,&t);
1108 auto_ptr<RegularExpression> re;
1110 delete re.release();
1111 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1112 auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1116 for (; !status && attrs.first!=attrs.second; ++attrs.first) {
1117 if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
1122 catch (XMLException& ex) {
1123 auto_ptr_char tmp(ex.getMessage());
1124 request.log(SPRequest::SPError,
1125 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1131 // If status is false, we found a rule we couldn't satisfy.
1132 // Could be an unknown rule to us, or it just didn't match.
1134 if (status && sta->m_dc->bRequireAll != 1) {
1135 // If we're not insisting that all rules be met, then we're done.
1136 request.log(SPRequest::SPDebug, "htaccess: a rule was successful, granting access");
1137 return shib_acl_true;
1139 else if (!status && sta->m_dc->bRequireAll == 1) {
1140 // If we're insisting that all rules be met, which is not something Apache really handles well,
1141 // then we either return false or indeterminate based on the authoritative option, which defaults on.
1142 if (sta->m_dc->bAuthoritative != 0) {
1143 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful, denying access");
1144 return shib_acl_false;
1147 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful but not authoritative, leaving it up to Apache");
1148 return shib_acl_indeterminate;
1151 // Otherwise, we keep going. If we're requring all, then we have to check every rule.
1152 // If not we just didn't find a successful rule yet, so we keep going anyway.
1155 // If we get here, we either "failed" or we're in require all mode (but not both).
1156 // If no rules possibly apply or we insisted that all rules check out, then we're good.
1157 if (!method_restricted) {
1158 request.log(SPRequest::SPDebug, "htaccess: no rules applied to this request method, granting access");
1159 return shib_acl_true;
1161 else if (sta->m_dc->bRequireAll == 1) {
1162 request.log(SPRequest::SPDebug, "htaccess: all rules successful, granting access");
1163 return shib_acl_true;
1165 else if (sta->m_dc->bAuthoritative != 0) {
1166 request.log(SPRequest::SPDebug, "htaccess: no rules were successful, denying access");
1167 return shib_acl_false;
1170 request.log(SPRequest::SPDebug, "htaccess: no rules were successful but not authoritative, leaving it up to Apache");
1171 return shib_acl_indeterminate;
1175 // Initial look at a request - create the per-request structure
1176 static int shib_post_read(request_rec *r)
1178 shib_request_config* rc = init_request_config(r);
1180 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1182 #ifdef SHIB_DEFERRED_HEADERS
1183 rc->hdr_out = ap_make_table(r->pool, 5);
1188 // fixups: set environment vars
1190 extern "C" int shib_fixups(request_rec* r)
1192 shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1193 shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1194 if (dc->bOff==1 || dc->bUseEnvVars==0)
1197 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1199 if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
1202 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1203 r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1208 #ifdef SHIB_APACHE_13
1211 * Cleanup the (per-process) pool info.
1213 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1216 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1219 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1225 * Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1227 extern "C" apr_status_t shib_exit(void* data)
1233 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
1239 * shire_child_init()
1240 * Things to do when the child process is initialized.
1241 * (or after the configs are read in apache-2)
1243 #ifdef SHIB_APACHE_13
1244 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1246 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1249 // Initialize runtime components.
1251 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1254 ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1258 g_Config=&SPConfig::getConfig();
1259 g_Config->setFeatures(
1260 SPConfig::Listener |
1262 SPConfig::RequestMapping |
1263 SPConfig::InProcess |
1267 if (!g_Config->init(g_szSchemaDir, g_szPrefix)) {
1268 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1271 g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1272 g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1274 if (!g_szSHIBConfig)
1275 g_szSHIBConfig=getenv("SHIBSP_CONFIG");
1276 if (!g_szSHIBConfig)
1277 g_szSHIBConfig=SHIBSP_CONFIG;
1280 xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
1281 XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
1282 xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
1283 auto_ptr_XMLCh src(g_szSHIBConfig);
1284 dummy->setAttributeNS(NULL,path,src.get());
1285 dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
1287 g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
1288 g_Config->getServiceProvider()->init();
1290 catch (exception& ex) {
1291 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1292 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1296 ServiceProvider* sp=g_Config->getServiceProvider();
1297 xmltooling::Locker locker(sp);
1298 const PropertySet* props=sp->getPropertySet("Local");
1300 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1301 if (unsetValue.first)
1302 g_unsetHeaderValue = unsetValue.second;
1303 pair<bool,bool> flag=props->getBool("checkSpoofing");
1304 g_checkSpoofing = !flag.first || flag.second;
1305 flag=props->getBool("catchAll");
1306 g_catchAll = flag.first && flag.second;
1309 // Set the cleanup handler
1310 apr_pool_cleanup_register(p, NULL, &shib_exit, apr_pool_cleanup_null);
1312 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1316 #ifdef SHIB_DEFERRED_HEADERS
1317 static void set_output_filter(request_rec *r)
1319 ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1322 static void set_error_filter(request_rec *r)
1324 ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1327 static int _table_add(void *v, const char *key, const char *value)
1329 apr_table_addn((apr_table_t*)v, key, value);
1333 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1335 request_rec *r = f->r;
1336 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1339 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);
1340 apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1341 // can't use overlap call because it will collapse Set-Cookie headers
1342 //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1345 /* remove ourselves from the filter chain */
1346 ap_remove_output_filter(f);
1348 /* send the data up the stack */
1349 return ap_pass_brigade(f->next,in);
1352 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1354 request_rec *r = f->r;
1355 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1358 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);
1359 apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1360 // can't use overlap call because it will collapse Set-Cookie headers
1361 //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1364 /* remove ourselves from the filter chain */
1365 ap_remove_output_filter(f);
1367 /* send the data up the stack */
1368 return ap_pass_brigade(f->next,in);
1370 #endif // SHIB_DEFERRED_HEADERS
1372 typedef const char* (*config_fn_t)(void);
1374 #ifdef SHIB_APACHE_13
1376 // SHIB Module commands
1378 static command_rec shire_cmds[] = {
1379 {"ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1380 RSRC_CONF, TAKE1, "Shibboleth installation directory"},
1381 {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1382 RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1383 {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1384 RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1385 {"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1386 RSRC_CONF, TAKE1, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"},
1388 {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1389 (void *) XtOffsetOf (shib_server_config, szScheme),
1390 RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1392 {"ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1393 OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1395 {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1396 (void *) XtOffsetOf (shib_dir_config, bOff),
1397 OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1398 {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1399 (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1400 OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1401 {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1402 (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1403 OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1404 {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1405 (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1406 OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1407 {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1408 (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1409 OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1410 {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1411 (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1412 OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1413 {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1414 (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1415 OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1416 {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1417 (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1418 OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1419 {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1420 (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1421 OR_AUTHCFG, FLAG, "All require directives must match"},
1422 {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1423 (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1424 OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1425 {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1426 (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1427 OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1428 {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1429 (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1430 OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1436 handler_rec shib_handlers[] = {
1437 { "shib-handler", shib_handler },
1441 module MODULE_VAR_EXPORT mod_shib = {
1442 STANDARD_MODULE_STUFF,
1443 NULL, /* initializer */
1444 create_shib_dir_config, /* dir config creater */
1445 merge_shib_dir_config, /* dir merger --- default is to override */
1446 create_shib_server_config, /* server config */
1447 merge_shib_server_config, /* merge server config */
1448 shire_cmds, /* command table */
1449 shib_handlers, /* handlers */
1450 NULL, /* filename translation */
1451 shib_check_user, /* check_user_id */
1452 shib_auth_checker, /* check auth */
1453 NULL, /* check access */
1454 NULL, /* type_checker */
1455 shib_fixups, /* fixups */
1457 NULL, /* header parser */
1458 shib_child_init, /* child_init */
1459 shib_child_exit, /* child_exit */
1460 shib_post_read /* post read-request */
1463 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1465 extern "C" void shib_register_hooks (apr_pool_t *p)
1467 #ifdef SHIB_DEFERRED_HEADERS
1468 ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1469 ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1470 ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1471 ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1472 ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1474 ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1475 ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1476 ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1477 ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1478 ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1481 // SHIB Module commands
1484 static command_rec shib_cmds[] = {
1485 AP_INIT_TAKE1("ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1486 RSRC_CONF, "Shibboleth installation directory"),
1487 AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1488 RSRC_CONF, "Path to shibboleth.xml config file"),
1489 AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1490 RSRC_CONF, "Paths of XML schema catalogs"),
1491 AP_INIT_TAKE1("ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1492 RSRC_CONF, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"),
1494 AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1495 (void *) offsetof (shib_server_config, szScheme),
1496 RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1498 AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1499 OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1501 AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1502 (void *) offsetof (shib_dir_config, bOff),
1503 OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1504 AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1505 (void *) offsetof (shib_dir_config, szApplicationId),
1506 OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1507 AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1508 (void *) offsetof (shib_dir_config, bBasicHijack),
1509 OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1510 AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1511 (void *) offsetof (shib_dir_config, bRequireSession),
1512 OR_AUTHCFG, "Initiates a new session if one does not exist"),
1513 AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1514 (void *) offsetof (shib_dir_config, szRequireWith),
1515 OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1516 AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1517 (void *) offsetof (shib_dir_config, bExportAssertion),
1518 OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1519 AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1520 (void *) offsetof (shib_dir_config, szRedirectToSSL),
1521 OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1522 AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1523 (void *) offsetof (shib_dir_config, szAuthGrpFile),
1524 OR_AUTHCFG, "Text file containing group names and member user IDs"),
1525 AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1526 (void *) offsetof (shib_dir_config, bRequireAll),
1527 OR_AUTHCFG, "All require directives must match"),
1528 AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1529 (void *) offsetof (shib_dir_config, bAuthoritative),
1530 OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1531 AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1532 (void *) offsetof (shib_dir_config, bUseEnvVars),
1533 OR_AUTHCFG, "Export attributes using environment variables (default)"),
1534 AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1535 (void *) offsetof (shib_dir_config, bUseHeaders),
1536 OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1541 module AP_MODULE_DECLARE_DATA mod_shib = {
1542 STANDARD20_MODULE_STUFF,
1543 create_shib_dir_config, /* create dir config */
1544 merge_shib_dir_config, /* merge dir config --- default is to override */
1545 create_shib_server_config, /* create server config */
1546 merge_shib_server_config, /* merge server config */
1547 shib_cmds, /* command table */
1548 shib_register_hooks /* register hooks */
1552 #error "unsupported Apache version"