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 static const char* g_UserDataKey = "_shib_check_user_";
94 static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
95 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
98 /* Apache 2.2.x headers must be accumulated and set in the output filter.
99 Apache 2.0.49+ supports the filter method.
100 Apache 1.3.x and lesser 2.0.x must write the headers directly. */
102 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
103 #define SHIB_DEFERRED_HEADERS
106 /********************************************************************************/
107 // Basic Apache Configuration code.
110 // per-server module configuration structure
111 struct shib_server_config
116 // creates the per-server configuration
117 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
119 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
124 // overrides server configuration in virtual servers
125 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
127 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
128 shib_server_config* parent=(shib_server_config*)base;
129 shib_server_config* child=(shib_server_config*)sub;
132 sc->szScheme=ap_pstrdup(p,child->szScheme);
133 else if (parent->szScheme)
134 sc->szScheme=ap_pstrdup(p,parent->szScheme);
141 // per-dir module configuration structure
142 struct shib_dir_config
144 SH_AP_TABLE* tSettings; // generic table of extensible settings
147 char* szAuthGrpFile; // Auth GroupFile name
148 int bRequireAll; // all "known" require directives must match, otherwise OR logic
149 int bAuthoritative; // allow htaccess plugin to DECLINE when authz fails
151 // Content Configuration
152 char* szApplicationId; // Shib applicationId value
153 char* szRequireWith; // require a session using a specific initiator?
154 char* szRedirectToSSL; // redirect non-SSL requests to SSL port
155 int bOff; // flat-out disable all Shib processing
156 int bBasicHijack; // activate for AuthType Basic?
157 int bRequireSession; // require a session?
158 int bExportAssertion; // export SAML assertion to the environment?
159 int bUseEnvVars; // use environment?
160 int bUseHeaders; // use headers?
163 // creates per-directory config structure
164 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
166 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
167 dc->tSettings = NULL;
168 dc->szAuthGrpFile = NULL;
169 dc->bRequireAll = -1;
170 dc->bAuthoritative = -1;
171 dc->szApplicationId = NULL;
172 dc->szRequireWith = NULL;
173 dc->szRedirectToSSL = NULL;
175 dc->bBasicHijack = -1;
176 dc->bRequireSession = -1;
177 dc->bExportAssertion = -1;
178 dc->bUseEnvVars = -1;
179 dc->bUseHeaders = -1;
183 // overrides server configuration in directories
184 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
186 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
187 shib_dir_config* parent=(shib_dir_config*)base;
188 shib_dir_config* child=(shib_dir_config*)sub;
190 // The child supersedes any matching table settings in the parent.
191 dc->tSettings = NULL;
192 if (parent->tSettings)
193 dc->tSettings = ap_copy_table(p, parent->tSettings);
194 if (child->tSettings) {
196 ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
198 dc->tSettings = ap_copy_table(p, child->tSettings);
201 if (child->szAuthGrpFile)
202 dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
203 else if (parent->szAuthGrpFile)
204 dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
206 dc->szAuthGrpFile=NULL;
208 if (child->szApplicationId)
209 dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
210 else if (parent->szApplicationId)
211 dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
213 dc->szApplicationId=NULL;
215 if (child->szRequireWith)
216 dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
217 else if (parent->szRequireWith)
218 dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
220 dc->szRequireWith=NULL;
222 if (child->szRedirectToSSL)
223 dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
224 else if (parent->szRedirectToSSL)
225 dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
227 dc->szRedirectToSSL=NULL;
229 dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
230 dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
231 dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
232 dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
233 dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
234 dc->bAuthoritative=((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
235 dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
236 dc->bUseHeaders=((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
240 // per-request module structure
241 struct shib_request_config
243 SH_AP_TABLE *env; // environment vars
244 #ifdef SHIB_DEFERRED_HEADERS
245 SH_AP_TABLE *hdr_out; // headers to browser
249 // create a request record
250 static shib_request_config *init_request_config(request_rec *r)
252 shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
253 ap_set_module_config (r->request_config, &mod_shib, rc);
254 memset(rc, 0, sizeof(shib_request_config));
255 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
259 // generic global slot handlers
260 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
262 *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
266 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
268 char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
269 size_t offset=(size_t)parms->info;
270 *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
274 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
275 #ifdef SHIB_APACHE_13
276 char* arg1, char* arg2
278 void* arg1, const char* arg2
282 ap_set_file_slot(parms, arg1, arg2);
286 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
289 dc->tSettings = ap_make_table(parms->pool, 4);
290 ap_table_set(dc->tSettings, arg1, arg2);
294 /********************************************************************************/
295 // Apache ShibTarget subclass(es) here.
297 class ShibTargetApache : public AbstractSPRequest
300 mutable string m_body;
301 mutable bool m_gotBody;
302 mutable vector<string> m_certs;
303 set<string> m_allhttp;
307 shib_dir_config* m_dc;
308 shib_server_config* m_sc;
309 shib_request_config* m_rc;
311 ShibTargetApache(request_rec* req, bool handler) : m_handler(handler), m_gotBody(false) {
312 m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
313 m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
314 m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
317 virtual ~ShibTargetApache() {}
319 const char* getScheme() const {
320 return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
322 const char* getHostname() const {
323 return ap_get_server_name(m_req);
325 int getPort() const {
326 return ap_get_server_port(m_req);
328 const char* getRequestURI() const {
329 return m_req->unparsed_uri;
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 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());
570 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an uncaught 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());
615 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an uncaught 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());
653 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an uncaught 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 SPRequest& 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 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
694 const xercesc::DOMElement* getElement() const;
697 RequestMapper* m_mapper;
699 ThreadKey* m_propsKey;
700 AccessControl* m_htaccess;
703 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
705 return new ApacheRequestMapper(e);
708 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
710 m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
711 m_htaccess=new htAccessControl();
712 m_staKey=ThreadKey::create(NULL);
713 m_propsKey=ThreadKey::create(NULL);
716 RequestMapper::Settings ApacheRequestMapper::getSettings(const SPRequest& request) const
718 Settings s=m_mapper->getSettings(request);
719 m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
720 m_propsKey->setData((void*)s.first);
721 return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
724 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
726 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
727 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
729 // Override Apache-settable boolean properties.
730 if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
731 return make_pair(true, sta->m_dc->bRequireSession==1);
732 else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
733 return make_pair(true, sta->m_dc->bExportAssertion==1);
734 else if (sta->m_dc->tSettings) {
735 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
737 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
740 return s ? s->getBool(name,ns) : make_pair(false,false);
743 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
745 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
746 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
748 // Override Apache-settable string properties.
749 if (name && !strcmp(name,"authType")) {
750 const char *auth_type=ap_auth_type(sta->m_req);
752 // Check for Basic Hijack
753 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
754 auth_type = "shibboleth";
755 return make_pair(true,auth_type);
758 else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
759 return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
760 else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
761 return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
762 else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
763 return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
764 else if (sta->m_dc->tSettings) {
765 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
767 return make_pair(true, prop);
770 return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
773 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
775 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
776 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
779 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
781 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
782 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
784 // Override Apache-settable int properties.
785 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
786 return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, NULL, 10));
787 else if (sta->m_dc->tSettings) {
788 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
790 return make_pair(true, strtol(prop, NULL, 10));
793 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
796 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
798 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
799 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
801 // Override Apache-settable int properties.
802 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
803 return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
804 else if (sta->m_dc->tSettings) {
805 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
807 return make_pair(true, atoi(prop));
810 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
813 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
815 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
816 return s ? s->getPropertySet(name,ns) : NULL;
819 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
821 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
822 return s ? s->getElement() : NULL;
825 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
828 SH_AP_TABLE* grps=ap_make_table(r->pool,15);
829 char l[MAX_STRING_LEN];
830 const char *group_name, *ll, *w;
832 #ifdef SHIB_APACHE_13
833 if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
835 if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
837 ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
842 #ifdef SHIB_APACHE_13
843 sp=ap_make_sub_pool(r->pool);
845 if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
846 ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
847 "groups_for_user() could not create a subpool");
852 while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
853 if ((*l=='#') || (!*l))
858 group_name=ap_getword(sp,&ll,':');
861 w=ap_getword_conf(sp,&ll);
862 if (!strcmp(w,user)) {
863 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
873 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
875 bool caseSensitive = attr->isCaseSensitive();
876 const vector<string>& vals = attr->getSerializedValues();
877 for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
879 auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
880 if (re->matches(trans.get())) {
881 request.log(SPRequest::SPDebug,
882 string("htAccessControl plugin expecting regexp ") + toMatch + ", got " + *v + ": authorization granted"
887 else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
888 request.log(SPRequest::SPDebug,
889 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization granted."
894 request.log(SPRequest::SPDebug,
895 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization not granted."
902 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
904 // Make sure the object is our type.
905 const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
907 throw ConfigurationException("Request wrapper object was not of correct type.");
911 int m=sta->m_req->method_number;
912 bool method_restricted=false;
915 const array_header* reqs_arr=ap_requires(sta->m_req);
917 return shib_acl_indeterminate; // should never happen
919 require_line* reqs=(require_line*)reqs_arr->elts;
921 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE nelts: %d", reqs_arr->nelts);
922 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE all: %d", sta->m_dc->bRequireAll);
924 vector<bool> auth_OK(reqs_arr->nelts,false);
926 #define SHIB_AP_CHECK_IS_OK { \
927 if (sta->m_dc->bRequireAll < 1) \
928 return shib_acl_true; \
933 for (int x=0; x<reqs_arr->nelts; x++) {
935 if (!(reqs[x].method_mask & (1 << m)))
937 method_restricted=true;
938 string remote_user = request.getRemoteUser();
940 t = reqs[x].requirement;
941 w = ap_getword_white(sta->m_req->pool, &t);
943 if (!strcasecmp(w,"shibboleth")) {
944 // This is a dummy rule needed because Apache conflates authn and authz.
945 // Without some require rule, AuthType is ignored and no check_user hooks run.
948 else if (!strcmp(w,"valid-user")) {
950 request.log(SPRequest::SPDebug,"htAccessControl plugin accepting valid-user based on active session");
954 request.log(SPRequest::SPError,"htAccessControl plugin rejecting access for valid-user rule, no session is active");
957 else if (!strcmp(w,"user") && !remote_user.empty()) {
960 w=ap_getword_conf(sta->m_req->pool,&t);
968 // To do regex matching, we have to convert from UTF-8.
969 auto_arrayptr<XMLCh> trans(fromUTF8(w));
970 RegularExpression re(trans.get());
971 auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
972 if (re.matches(trans2.get())) {
973 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
977 catch (XMLException& ex) {
978 auto_ptr_char tmp(ex.getMessage());
979 request.log(SPRequest::SPError,
980 string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
983 else if (remote_user==w) {
984 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
989 else if (!strcmp(w,"group")) {
990 SH_AP_TABLE* grpstatus=NULL;
991 if (sta->m_dc->szAuthGrpFile && !remote_user.empty()) {
992 request.log(SPRequest::SPDebug,string("htAccessControl plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
993 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
999 w=ap_getword_conf(sta->m_req->pool,&t);
1000 if (ap_table_get(grpstatus,w)) {
1001 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting group (") + w + ")");
1002 SHIB_AP_CHECK_IS_OK;
1007 // Map alias in rule to the attribute.
1009 request.log(SPRequest::SPError, "htAccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
1013 // Find the attribute(s) matching the require rule.
1014 pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1015 session->getIndexedAttributes().equal_range(w);
1016 if (attrs.first == attrs.second) {
1017 request.log(SPRequest::SPWarn, string("htAccessControl rule requires attribute (") + w + "), not found in session");
1023 while (!auth_OK[x] && *t) {
1024 w=ap_getword_conf(sta->m_req->pool,&t);
1031 auto_ptr<RegularExpression> re;
1033 delete re.release();
1034 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1035 auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1039 for (; !auth_OK[x] && attrs.first!=attrs.second; ++attrs.first) {
1040 if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
1041 SHIB_AP_CHECK_IS_OK;
1045 catch (XMLException& ex) {
1046 auto_ptr_char tmp(ex.getMessage());
1047 request.log(SPRequest::SPError,
1048 string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1055 // If we get here, we either "failed" or we're in require all mode.
1056 bool auth_all_OK = true;
1057 for (int i= 0; i<reqs_arr->nelts; i++) {
1058 auth_all_OK &= auth_OK[i];
1060 if (auth_all_OK || !method_restricted)
1061 return shib_acl_true;
1063 return (sta->m_dc->bAuthoritative != 0) ? shib_acl_false : shib_acl_indeterminate;
1067 // Initial look at a request - create the per-request structure
1068 static int shib_post_read(request_rec *r)
1070 shib_request_config* rc = init_request_config(r);
1072 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1074 #ifdef SHIB_DEFERRED_HEADERS
1075 rc->hdr_out = ap_make_table(r->pool, 5);
1080 // fixups: set environment vars
1082 extern "C" int shib_fixups(request_rec* r)
1084 shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1085 shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1086 if (dc->bOff==1 || dc->bUseEnvVars==0)
1089 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1091 if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
1094 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1095 r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1100 #ifdef SHIB_APACHE_13
1103 * Cleanup the (per-process) pool info.
1105 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1108 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1111 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1117 * Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1119 extern "C" apr_status_t shib_exit(void* data)
1125 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
1131 * shire_child_init()
1132 * Things to do when the child process is initialized.
1133 * (or after the configs are read in apache-2)
1135 #ifdef SHIB_APACHE_13
1136 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1138 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1141 // Initialize runtime components.
1143 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1146 ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1150 g_Config=&SPConfig::getConfig();
1151 g_Config->setFeatures(
1152 SPConfig::Listener |
1154 SPConfig::RequestMapping |
1155 SPConfig::InProcess |
1159 if (!g_Config->init(g_szSchemaDir)) {
1160 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1163 g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1164 g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1167 xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
1168 XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
1169 xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
1170 auto_ptr_XMLCh src(g_szSHIBConfig);
1171 dummy->setAttributeNS(NULL,path,src.get());
1172 dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
1174 g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
1175 g_Config->getServiceProvider()->init();
1177 catch (exception& ex) {
1178 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1179 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1183 ServiceProvider* sp=g_Config->getServiceProvider();
1184 xmltooling::Locker locker(sp);
1185 const PropertySet* props=sp->getPropertySet("Local");
1187 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1188 if (unsetValue.first)
1189 g_unsetHeaderValue = unsetValue.second;
1190 pair<bool,bool> checkSpoofing=props->getBool("checkSpoofing");
1191 if (checkSpoofing.first && !checkSpoofing.second)
1192 g_checkSpoofing = false;
1195 // Set the cleanup handler
1196 apr_pool_cleanup_register(p, NULL, &shib_exit, apr_pool_cleanup_null);
1198 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1202 #ifdef SHIB_DEFERRED_HEADERS
1203 static void set_output_filter(request_rec *r)
1205 ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1208 static void set_error_filter(request_rec *r)
1210 ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1213 static int _table_add(void *v, const char *key, const char *value)
1215 apr_table_addn((apr_table_t*)v, key, value);
1219 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1221 request_rec *r = f->r;
1222 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1225 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);
1226 apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1227 // can't use overlap call because it will collapse Set-Cookie headers
1228 //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1231 /* remove ourselves from the filter chain */
1232 ap_remove_output_filter(f);
1234 /* send the data up the stack */
1235 return ap_pass_brigade(f->next,in);
1238 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1240 request_rec *r = f->r;
1241 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1244 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);
1245 apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1246 // can't use overlap call because it will collapse Set-Cookie headers
1247 //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1250 /* remove ourselves from the filter chain */
1251 ap_remove_output_filter(f);
1253 /* send the data up the stack */
1254 return ap_pass_brigade(f->next,in);
1256 #endif // SHIB_DEFERRED_HEADERS
1258 typedef const char* (*config_fn_t)(void);
1260 #ifdef SHIB_APACHE_13
1262 // SHIB Module commands
1264 static command_rec shire_cmds[] = {
1265 {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1266 RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1267 {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1268 RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1269 {"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1270 RSRC_CONF, TAKE1, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"},
1272 {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1273 (void *) XtOffsetOf (shib_server_config, szScheme),
1274 RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1276 {"ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1277 OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1279 {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1280 (void *) XtOffsetOf (shib_dir_config, bOff),
1281 OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1282 {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1283 (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1284 OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1285 {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1286 (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1287 OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1288 {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1289 (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1290 OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1291 {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1292 (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1293 OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1294 {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1295 (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1296 OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1297 {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1298 (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1299 OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1300 {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1301 (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1302 OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1303 {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1304 (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1305 OR_AUTHCFG, FLAG, "All require directives must match"},
1306 {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1307 (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1308 OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1309 {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1310 (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1311 OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1312 {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1313 (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1314 OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1320 handler_rec shib_handlers[] = {
1321 { "shib-handler", shib_handler },
1325 module MODULE_VAR_EXPORT mod_shib = {
1326 STANDARD_MODULE_STUFF,
1327 NULL, /* initializer */
1328 create_shib_dir_config, /* dir config creater */
1329 merge_shib_dir_config, /* dir merger --- default is to override */
1330 create_shib_server_config, /* server config */
1331 merge_shib_server_config, /* merge server config */
1332 shire_cmds, /* command table */
1333 shib_handlers, /* handlers */
1334 NULL, /* filename translation */
1335 shib_check_user, /* check_user_id */
1336 shib_auth_checker, /* check auth */
1337 NULL, /* check access */
1338 NULL, /* type_checker */
1339 shib_fixups, /* fixups */
1341 NULL, /* header parser */
1342 shib_child_init, /* child_init */
1343 shib_child_exit, /* child_exit */
1344 shib_post_read /* post read-request */
1347 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1349 extern "C" void shib_register_hooks (apr_pool_t *p)
1351 #ifdef SHIB_DEFERRED_HEADERS
1352 ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1353 ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1354 ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1355 ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1356 ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1358 ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1359 ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1360 ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1361 ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1362 ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1365 // SHIB Module commands
1368 static command_rec shib_cmds[] = {
1369 AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1370 RSRC_CONF, "Path to shibboleth.xml config file"),
1371 AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1372 RSRC_CONF, "Paths of XML schema catalogs"),
1373 AP_INIT_TAKE1("ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1374 RSRC_CONF, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"),
1376 AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1377 (void *) offsetof (shib_server_config, szScheme),
1378 RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1380 AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1381 OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1383 AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1384 (void *) offsetof (shib_dir_config, bOff),
1385 OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1386 AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1387 (void *) offsetof (shib_dir_config, szApplicationId),
1388 OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1389 AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1390 (void *) offsetof (shib_dir_config, bBasicHijack),
1391 OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1392 AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1393 (void *) offsetof (shib_dir_config, bRequireSession),
1394 OR_AUTHCFG, "Initiates a new session if one does not exist"),
1395 AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1396 (void *) offsetof (shib_dir_config, szRequireWith),
1397 OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1398 AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1399 (void *) offsetof (shib_dir_config, bExportAssertion),
1400 OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1401 AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1402 (void *) offsetof (shib_dir_config, szRedirectToSSL),
1403 OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1404 AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1405 (void *) offsetof (shib_dir_config, szAuthGrpFile),
1406 OR_AUTHCFG, "Text file containing group names and member user IDs"),
1407 AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1408 (void *) offsetof (shib_dir_config, bRequireAll),
1409 OR_AUTHCFG, "All require directives must match"),
1410 AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1411 (void *) offsetof (shib_dir_config, bAuthoritative),
1412 OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1413 AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1414 (void *) offsetof (shib_dir_config, bUseEnvVars),
1415 OR_AUTHCFG, "Export attributes using environment variables (default)"),
1416 AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1417 (void *) offsetof (shib_dir_config, bUseHeaders),
1418 OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1423 module AP_MODULE_DECLARE_DATA mod_shib = {
1424 STANDARD20_MODULE_STUFF,
1425 create_shib_dir_config, /* create dir config */
1426 merge_shib_dir_config, /* merge dir config --- default is to override */
1427 create_shib_server_config, /* create server config */
1428 merge_shib_server_config, /* merge server config */
1429 shib_cmds, /* command table */
1430 shib_register_hooks /* register hooks */
1434 #error "unsupported Apache version"