2 * Copyright 2001-2007 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 * Apache module implementation
26 #undef _XOPEN_SOURCE // causes gethostname conflict in unistd.h
30 # define _CRT_NONSTDC_NO_DEPRECATE 1
31 # define _CRT_SECURE_NO_DEPRECATE 1
34 #include <shibsp/AbstractSPRequest.h>
35 #include <shibsp/AccessControl.h>
36 #include <shibsp/exceptions.h>
37 #include <shibsp/RequestMapper.h>
38 #include <shibsp/SPConfig.h>
39 #include <shibsp/ServiceProvider.h>
40 #include <shibsp/SessionCache.h>
41 #include <shibsp/attribute/Attribute.h>
42 #include <xercesc/util/XMLUniDefs.hpp>
43 #include <xercesc/util/regx/RegularExpression.hpp>
44 #include <xmltooling/XMLToolingConfig.h>
45 #include <xmltooling/util/NDC.h>
46 #include <xmltooling/util/Threads.h>
47 #include <xmltooling/util/XMLConstants.h>
48 #include <xmltooling/util/XMLHelper.h>
56 // Apache specific header files
58 #include <http_config.h>
59 #include <http_protocol.h>
60 #include <http_main.h>
62 #include <http_core.h>
64 #include <http_request.h>
66 #ifndef SHIB_APACHE_13
67 #include <apr_buckets.h>
68 #include <apr_strings.h>
69 #include <apr_pools.h>
76 #include <unistd.h> // for getpid()
79 using namespace shibsp;
80 using namespace xmltooling;
82 using xercesc::RegularExpression;
83 using xercesc::XMLException;
85 extern "C" module MODULE_VAR_EXPORT mod_shib;
88 char* g_szSHIBConfig = SHIBSP_CONFIG;
89 char* g_szSchemaDir = SHIBSP_SCHEMAS;
90 SPConfig* g_Config = NULL;
91 string g_unsetHeaderValue;
92 bool g_checkSpoofing = true;
93 bool g_catchAll = false;
94 static const char* g_UserDataKey = "_shib_check_user_";
95 static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
96 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
99 /* Apache 2.2.x headers must be accumulated and set in the output filter.
100 Apache 2.0.49+ supports the filter method.
101 Apache 1.3.x and lesser 2.0.x must write the headers directly. */
103 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
104 #define SHIB_DEFERRED_HEADERS
107 /********************************************************************************/
108 // Basic Apache Configuration code.
111 // per-server module configuration structure
112 struct shib_server_config
117 // creates the per-server configuration
118 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
120 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
125 // overrides server configuration in virtual servers
126 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
128 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
129 shib_server_config* parent=(shib_server_config*)base;
130 shib_server_config* child=(shib_server_config*)sub;
133 sc->szScheme=ap_pstrdup(p,child->szScheme);
134 else if (parent->szScheme)
135 sc->szScheme=ap_pstrdup(p,parent->szScheme);
142 // per-dir module configuration structure
143 struct shib_dir_config
145 SH_AP_TABLE* tSettings; // generic table of extensible settings
148 char* szAuthGrpFile; // Auth GroupFile name
149 int bRequireAll; // all "known" require directives must match, otherwise OR logic
150 int bAuthoritative; // allow htaccess plugin to DECLINE when authz fails
152 // Content Configuration
153 char* szApplicationId; // Shib applicationId value
154 char* szRequireWith; // require a session using a specific initiator?
155 char* szRedirectToSSL; // redirect non-SSL requests to SSL port
156 int bOff; // flat-out disable all Shib processing
157 int bBasicHijack; // activate for AuthType Basic?
158 int bRequireSession; // require a session?
159 int bExportAssertion; // export SAML assertion to the environment?
160 int bUseEnvVars; // use environment?
161 int bUseHeaders; // use headers?
164 // creates per-directory config structure
165 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
167 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
168 dc->tSettings = NULL;
169 dc->szAuthGrpFile = NULL;
170 dc->bRequireAll = -1;
171 dc->bAuthoritative = -1;
172 dc->szApplicationId = NULL;
173 dc->szRequireWith = NULL;
174 dc->szRedirectToSSL = NULL;
176 dc->bBasicHijack = -1;
177 dc->bRequireSession = -1;
178 dc->bExportAssertion = -1;
179 dc->bUseEnvVars = -1;
180 dc->bUseHeaders = -1;
184 // overrides server configuration in directories
185 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
187 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
188 shib_dir_config* parent=(shib_dir_config*)base;
189 shib_dir_config* child=(shib_dir_config*)sub;
191 // The child supersedes any matching table settings in the parent.
192 dc->tSettings = NULL;
193 if (parent->tSettings)
194 dc->tSettings = ap_copy_table(p, parent->tSettings);
195 if (child->tSettings) {
197 ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
199 dc->tSettings = ap_copy_table(p, child->tSettings);
202 if (child->szAuthGrpFile)
203 dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
204 else if (parent->szAuthGrpFile)
205 dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
207 dc->szAuthGrpFile=NULL;
209 if (child->szApplicationId)
210 dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
211 else if (parent->szApplicationId)
212 dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
214 dc->szApplicationId=NULL;
216 if (child->szRequireWith)
217 dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
218 else if (parent->szRequireWith)
219 dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
221 dc->szRequireWith=NULL;
223 if (child->szRedirectToSSL)
224 dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
225 else if (parent->szRedirectToSSL)
226 dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
228 dc->szRedirectToSSL=NULL;
230 dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
231 dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
232 dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
233 dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
234 dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
235 dc->bAuthoritative=((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
236 dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
237 dc->bUseHeaders=((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
241 // per-request module structure
242 struct shib_request_config
244 SH_AP_TABLE *env; // environment vars
245 #ifdef SHIB_DEFERRED_HEADERS
246 SH_AP_TABLE *hdr_out; // headers to browser
250 // create a request record
251 static shib_request_config *init_request_config(request_rec *r)
253 shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
254 ap_set_module_config (r->request_config, &mod_shib, rc);
255 memset(rc, 0, sizeof(shib_request_config));
256 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
260 // generic global slot handlers
261 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
263 *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
267 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
269 char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
270 size_t offset=(size_t)parms->info;
271 *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
275 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
276 #ifdef SHIB_APACHE_13
277 char* arg1, char* arg2
279 void* arg1, const char* arg2
283 ap_set_file_slot(parms, arg1, arg2);
287 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
290 dc->tSettings = ap_make_table(parms->pool, 4);
291 ap_table_set(dc->tSettings, arg1, arg2);
295 /********************************************************************************/
296 // Apache ShibTarget subclass(es) here.
298 class ShibTargetApache : public AbstractSPRequest
301 mutable string m_body;
302 mutable bool m_gotBody;
303 mutable vector<string> m_certs;
304 set<string> m_allhttp;
308 shib_dir_config* m_dc;
309 shib_server_config* m_sc;
310 shib_request_config* m_rc;
312 ShibTargetApache(request_rec* req, bool handler) : m_handler(handler), m_gotBody(false) {
313 m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
314 m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
315 m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
318 virtual ~ShibTargetApache() {}
320 const char* getScheme() const {
321 return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
323 const char* getHostname() const {
324 return ap_get_server_name(m_req);
326 int getPort() const {
327 return ap_get_server_port(m_req);
329 const char* getRequestURI() const {
330 return m_req->unparsed_uri;
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 ap_send_http_header(m_req);
507 ap_rwrite(buf,in.gcount(),m_req);
509 if (status!=XMLTOOLING_HTTP_STATUS_OK)
510 m_req->status = status;
513 long sendRedirect(const char* url) {
514 ap_table_set(m_req->headers_out, "Location", url);
517 const vector<string>& getClientCertificates() const {
518 if (m_certs.empty()) {
519 const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
521 m_certs.push_back(cert);
524 cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
526 m_certs.push_back(cert);
531 long returnDecline(void) { return DECLINED; }
532 long returnOK(void) { return OK; }
535 /********************************************************************************/
538 extern "C" int shib_check_user(request_rec* r)
540 // Short-circuit entirely?
541 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
544 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
546 ostringstream threadid;
547 threadid << "[" << getpid() << "] shib_check_user" << '\0';
548 xmltooling::NDC ndc(threadid.str().c_str());
551 ShibTargetApache sta(r,false);
553 // Check user authentication and export information, then set the handler bypass
554 pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
555 apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
556 if (res.first) return res.second;
558 // user auth was okay -- export the assertions now
559 res = sta.getServiceProvider().doExport(sta);
560 if (res.first) return res.second;
562 // export happened successfully.. this user is ok.
565 catch (exception& e) {
566 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
571 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an uncaught exception!");
578 extern "C" int shib_handler(request_rec* r)
580 // Short-circuit entirely?
581 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
584 ostringstream threadid;
585 threadid << "[" << getpid() << "] shib_handler" << '\0';
586 xmltooling::NDC ndc(threadid.str().c_str());
588 #ifndef SHIB_APACHE_13
589 // With 2.x, this handler always runs, though last.
590 // We check if shib_check_user ran, because it will detect a handler request
591 // and dispatch it directly.
593 apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
594 if (data==(const void*)42) {
595 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
600 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
603 ShibTargetApache sta(r,true);
605 pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
606 if (res.first) return res.second;
608 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
611 catch (exception& e) {
612 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
617 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an uncaught exception!");
625 * shib_auth_checker() -- a simple resource manager to
626 * process the .htaccess settings
628 extern "C" int shib_auth_checker(request_rec* r)
630 // Short-circuit entirely?
631 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
634 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
636 ostringstream threadid;
637 threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
638 xmltooling::NDC ndc(threadid.str().c_str());
641 ShibTargetApache sta(r,false);
643 pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
644 if (res.first) return res.second;
646 // The SP method should always return true, so if we get this far, something unusual happened.
647 // Just let Apache (or some other module) decide what to do.
650 catch (exception& e) {
651 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
656 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an uncaught exception!");
663 // Access control plugin that enforces htaccess rules
664 class htAccessControl : virtual public AccessControl
668 ~htAccessControl() {}
669 Lockable* lock() {return this;}
671 aclresult_t authorized(const SPRequest& request, const Session* session) const;
673 bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
676 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
678 return new htAccessControl();
681 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
684 ApacheRequestMapper(const xercesc::DOMElement* e);
685 ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
686 Lockable* lock() { return m_mapper->lock(); }
687 void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
688 Settings getSettings(const HTTPRequest& request) const;
690 const PropertySet* getParent() const { return NULL; }
691 void setParent(const PropertySet*) {}
692 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
693 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
694 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
695 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
696 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
697 void getAll(map<string,const char*>& properties) const;
698 const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
699 const xercesc::DOMElement* getElement() const;
702 RequestMapper* m_mapper;
704 ThreadKey* m_propsKey;
705 AccessControl* m_htaccess;
708 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
710 return new ApacheRequestMapper(e);
713 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
715 m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
716 m_htaccess=new htAccessControl();
717 m_staKey=ThreadKey::create(NULL);
718 m_propsKey=ThreadKey::create(NULL);
721 RequestMapper::Settings ApacheRequestMapper::getSettings(const HTTPRequest& request) const
723 Settings s=m_mapper->getSettings(request);
724 m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
725 m_propsKey->setData((void*)s.first);
726 return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
729 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
731 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
732 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
734 // Override Apache-settable boolean properties.
735 if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
736 return make_pair(true, sta->m_dc->bRequireSession==1);
737 else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
738 return make_pair(true, sta->m_dc->bExportAssertion==1);
739 else if (sta->m_dc->tSettings) {
740 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
742 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
745 return s ? s->getBool(name,ns) : make_pair(false,false);
748 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
750 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
751 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
753 // Override Apache-settable string properties.
754 if (name && !strcmp(name,"authType")) {
755 const char *auth_type=ap_auth_type(sta->m_req);
757 // Check for Basic Hijack
758 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
759 auth_type = "shibboleth";
760 return make_pair(true,auth_type);
763 else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
764 return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
765 else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
766 return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
767 else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
768 return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
769 else if (sta->m_dc->tSettings) {
770 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
772 return make_pair(true, prop);
775 return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
778 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
780 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
781 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
784 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
786 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
787 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
789 // Override Apache-settable int properties.
790 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
791 return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, NULL, 10));
792 else if (sta->m_dc->tSettings) {
793 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
795 return make_pair(true, strtol(prop, NULL, 10));
798 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
801 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
803 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
804 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
806 // Override Apache-settable int properties.
807 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
808 return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
809 else if (sta->m_dc->tSettings) {
810 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
812 return make_pair(true, atoi(prop));
815 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
818 void ApacheRequestMapper::getAll(map<string,const char*>& properties) const
820 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
821 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
824 s->getAll(properties);
828 const char* auth_type=ap_auth_type(sta->m_req);
830 // Check for Basic Hijack
831 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
832 auth_type = "shibboleth";
833 properties["authType"] = auth_type;
836 if (sta->m_dc->szApplicationId)
837 properties["applicationId"] = sta->m_dc->szApplicationId;
838 if (sta->m_dc->szRequireWith)
839 properties["requireSessionWith"] = sta->m_dc->szRequireWith;
840 if (sta->m_dc->szRedirectToSSL)
841 properties["redirectToSSL"] = sta->m_dc->szRedirectToSSL;
842 if (sta->m_dc->bRequireSession != 0)
843 properties["requireSession"] = (sta->m_dc->bRequireSession==1) ? "true" : "false";
844 if (sta->m_dc->bExportAssertion != 0)
845 properties["exportAssertion"] = (sta->m_dc->bExportAssertion==1) ? "true" : "false";
848 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
850 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
851 return s ? s->getPropertySet(name,ns) : NULL;
854 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
856 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
857 return s ? s->getElement() : NULL;
860 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
863 SH_AP_TABLE* grps=ap_make_table(r->pool,15);
864 char l[MAX_STRING_LEN];
865 const char *group_name, *ll, *w;
867 #ifdef SHIB_APACHE_13
868 if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
870 if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
872 ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
877 #ifdef SHIB_APACHE_13
878 sp=ap_make_sub_pool(r->pool);
880 if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
881 ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
882 "groups_for_user() could not create a subpool");
887 while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
888 if ((*l=='#') || (!*l))
893 group_name=ap_getword(sp,&ll,':');
896 w=ap_getword_conf(sp,&ll);
897 if (!strcmp(w,user)) {
898 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
908 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
910 bool caseSensitive = attr->isCaseSensitive();
911 const vector<string>& vals = attr->getSerializedValues();
912 for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
914 auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
915 if (re->matches(trans.get())) {
916 request.log(SPRequest::SPDebug,
917 string("htAccessControl plugin expecting regexp ") + toMatch + ", got " + *v + ": authorization granted"
922 else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
923 request.log(SPRequest::SPDebug,
924 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization granted."
929 request.log(SPRequest::SPDebug,
930 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization not granted."
937 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
939 // Make sure the object is our type.
940 const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
942 throw ConfigurationException("Request wrapper object was not of correct type.");
946 int m=sta->m_req->method_number;
947 bool method_restricted=false;
950 const array_header* reqs_arr=ap_requires(sta->m_req);
952 return shib_acl_indeterminate; // should never happen
954 require_line* reqs=(require_line*)reqs_arr->elts;
956 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE nelts: %d", reqs_arr->nelts);
957 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE all: %d", sta->m_dc->bRequireAll);
959 vector<bool> auth_OK(reqs_arr->nelts,false);
961 #define SHIB_AP_CHECK_IS_OK { \
962 if (sta->m_dc->bRequireAll < 1) \
963 return shib_acl_true; \
968 for (int x=0; x<reqs_arr->nelts; x++) {
970 if (!(reqs[x].method_mask & (1 << m)))
972 method_restricted=true;
973 string remote_user = request.getRemoteUser();
975 t = reqs[x].requirement;
976 w = ap_getword_white(sta->m_req->pool, &t);
978 if (!strcasecmp(w,"shibboleth")) {
979 // This is a dummy rule needed because Apache conflates authn and authz.
980 // Without some require rule, AuthType is ignored and no check_user hooks run.
983 else if (!strcmp(w,"valid-user")) {
985 request.log(SPRequest::SPDebug,"htAccessControl plugin accepting valid-user based on active session");
989 request.log(SPRequest::SPError,"htAccessControl plugin rejecting access for valid-user rule, no session is active");
992 else if (!strcmp(w,"user") && !remote_user.empty()) {
995 w=ap_getword_conf(sta->m_req->pool,&t);
1003 // To do regex matching, we have to convert from UTF-8.
1004 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1005 RegularExpression re(trans.get());
1006 auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
1007 if (re.matches(trans2.get())) {
1008 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
1009 SHIB_AP_CHECK_IS_OK;
1012 catch (XMLException& ex) {
1013 auto_ptr_char tmp(ex.getMessage());
1014 request.log(SPRequest::SPError,
1015 string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1018 else if (remote_user==w) {
1019 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
1020 SHIB_AP_CHECK_IS_OK;
1024 else if (!strcmp(w,"group")) {
1025 SH_AP_TABLE* grpstatus=NULL;
1026 if (sta->m_dc->szAuthGrpFile && !remote_user.empty()) {
1027 request.log(SPRequest::SPDebug,string("htAccessControl plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
1028 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
1034 w=ap_getword_conf(sta->m_req->pool,&t);
1035 if (ap_table_get(grpstatus,w)) {
1036 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting group (") + w + ")");
1037 SHIB_AP_CHECK_IS_OK;
1041 else if (!strcmp(w,"authnContextClassRef")) {
1042 const char* ref = session->getAuthnContextClassRef();
1044 w=ap_getword_conf(sta->m_req->pool,&t);
1045 if (!strcmp(w, ref)) {
1046 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting authnContextClassRef (") + w + ")");
1047 SHIB_AP_CHECK_IS_OK;
1051 else if (!strcmp(w,"authnContextDeclRef")) {
1052 const char* ref = session->getAuthnContextDeclRef();
1054 w=ap_getword_conf(sta->m_req->pool,&t);
1055 if (!strcmp(w, ref)) {
1056 request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting authnContextDeclRef (") + w + ")");
1057 SHIB_AP_CHECK_IS_OK;
1062 // Map alias in rule to the attribute.
1064 request.log(SPRequest::SPError, "htAccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
1068 // Find the attribute(s) matching the require rule.
1069 pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1070 session->getIndexedAttributes().equal_range(w);
1071 if (attrs.first == attrs.second) {
1072 request.log(SPRequest::SPWarn, string("htAccessControl rule requires attribute (") + w + "), not found in session");
1078 while (!auth_OK[x] && *t) {
1079 w=ap_getword_conf(sta->m_req->pool,&t);
1086 auto_ptr<RegularExpression> re;
1088 delete re.release();
1089 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1090 auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1094 for (; !auth_OK[x] && attrs.first!=attrs.second; ++attrs.first) {
1095 if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
1096 SHIB_AP_CHECK_IS_OK;
1100 catch (XMLException& ex) {
1101 auto_ptr_char tmp(ex.getMessage());
1102 request.log(SPRequest::SPError,
1103 string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1110 // If we get here, we either "failed" or we're in require all mode.
1111 bool auth_all_OK = true;
1112 for (int i= 0; i<reqs_arr->nelts; i++) {
1113 auth_all_OK &= auth_OK[i];
1115 if (auth_all_OK || !method_restricted)
1116 return shib_acl_true;
1118 return (sta->m_dc->bAuthoritative != 0) ? shib_acl_false : shib_acl_indeterminate;
1122 // Initial look at a request - create the per-request structure
1123 static int shib_post_read(request_rec *r)
1125 shib_request_config* rc = init_request_config(r);
1127 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1129 #ifdef SHIB_DEFERRED_HEADERS
1130 rc->hdr_out = ap_make_table(r->pool, 5);
1135 // fixups: set environment vars
1137 extern "C" int shib_fixups(request_rec* r)
1139 shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1140 shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1141 if (dc->bOff==1 || dc->bUseEnvVars==0)
1144 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1146 if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
1149 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1150 r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1155 #ifdef SHIB_APACHE_13
1158 * Cleanup the (per-process) pool info.
1160 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1163 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1166 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1172 * Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1174 extern "C" apr_status_t shib_exit(void* data)
1180 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
1186 * shire_child_init()
1187 * Things to do when the child process is initialized.
1188 * (or after the configs are read in apache-2)
1190 #ifdef SHIB_APACHE_13
1191 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1193 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1196 // Initialize runtime components.
1198 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1201 ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1205 g_Config=&SPConfig::getConfig();
1206 g_Config->setFeatures(
1207 SPConfig::Listener |
1209 SPConfig::RequestMapping |
1210 SPConfig::InProcess |
1214 if (!g_Config->init(g_szSchemaDir)) {
1215 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1218 g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1219 g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1222 xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
1223 XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
1224 xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
1225 auto_ptr_XMLCh src(g_szSHIBConfig);
1226 dummy->setAttributeNS(NULL,path,src.get());
1227 dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
1229 g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
1230 g_Config->getServiceProvider()->init();
1232 catch (exception& ex) {
1233 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1234 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1238 ServiceProvider* sp=g_Config->getServiceProvider();
1239 xmltooling::Locker locker(sp);
1240 const PropertySet* props=sp->getPropertySet("Local");
1242 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1243 if (unsetValue.first)
1244 g_unsetHeaderValue = unsetValue.second;
1245 pair<bool,bool> flag=props->getBool("checkSpoofing");
1246 g_checkSpoofing = !flag.first || flag.second;
1247 flag=props->getBool("catchAll");
1248 g_catchAll = flag.first && flag.second;
1251 // Set the cleanup handler
1252 apr_pool_cleanup_register(p, NULL, &shib_exit, apr_pool_cleanup_null);
1254 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1258 #ifdef SHIB_DEFERRED_HEADERS
1259 static void set_output_filter(request_rec *r)
1261 ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1264 static void set_error_filter(request_rec *r)
1266 ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1269 static int _table_add(void *v, const char *key, const char *value)
1271 apr_table_addn((apr_table_t*)v, key, value);
1275 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1277 request_rec *r = f->r;
1278 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1281 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);
1282 apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1283 // can't use overlap call because it will collapse Set-Cookie headers
1284 //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1287 /* remove ourselves from the filter chain */
1288 ap_remove_output_filter(f);
1290 /* send the data up the stack */
1291 return ap_pass_brigade(f->next,in);
1294 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1296 request_rec *r = f->r;
1297 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1300 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);
1301 apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1302 // can't use overlap call because it will collapse Set-Cookie headers
1303 //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1306 /* remove ourselves from the filter chain */
1307 ap_remove_output_filter(f);
1309 /* send the data up the stack */
1310 return ap_pass_brigade(f->next,in);
1312 #endif // SHIB_DEFERRED_HEADERS
1314 typedef const char* (*config_fn_t)(void);
1316 #ifdef SHIB_APACHE_13
1318 // SHIB Module commands
1320 static command_rec shire_cmds[] = {
1321 {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1322 RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1323 {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1324 RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1325 {"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1326 RSRC_CONF, TAKE1, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"},
1328 {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1329 (void *) XtOffsetOf (shib_server_config, szScheme),
1330 RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1332 {"ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1333 OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1335 {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1336 (void *) XtOffsetOf (shib_dir_config, bOff),
1337 OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1338 {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1339 (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1340 OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1341 {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1342 (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1343 OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1344 {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1345 (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1346 OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1347 {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1348 (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1349 OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1350 {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1351 (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1352 OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1353 {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1354 (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1355 OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1356 {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1357 (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1358 OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1359 {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1360 (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1361 OR_AUTHCFG, FLAG, "All require directives must match"},
1362 {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1363 (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1364 OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1365 {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1366 (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1367 OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1368 {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1369 (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1370 OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1376 handler_rec shib_handlers[] = {
1377 { "shib-handler", shib_handler },
1381 module MODULE_VAR_EXPORT mod_shib = {
1382 STANDARD_MODULE_STUFF,
1383 NULL, /* initializer */
1384 create_shib_dir_config, /* dir config creater */
1385 merge_shib_dir_config, /* dir merger --- default is to override */
1386 create_shib_server_config, /* server config */
1387 merge_shib_server_config, /* merge server config */
1388 shire_cmds, /* command table */
1389 shib_handlers, /* handlers */
1390 NULL, /* filename translation */
1391 shib_check_user, /* check_user_id */
1392 shib_auth_checker, /* check auth */
1393 NULL, /* check access */
1394 NULL, /* type_checker */
1395 shib_fixups, /* fixups */
1397 NULL, /* header parser */
1398 shib_child_init, /* child_init */
1399 shib_child_exit, /* child_exit */
1400 shib_post_read /* post read-request */
1403 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1405 extern "C" void shib_register_hooks (apr_pool_t *p)
1407 #ifdef SHIB_DEFERRED_HEADERS
1408 ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1409 ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1410 ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1411 ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1412 ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1414 ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1415 ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1416 ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1417 ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1418 ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1421 // SHIB Module commands
1424 static command_rec shib_cmds[] = {
1425 AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1426 RSRC_CONF, "Path to shibboleth.xml config file"),
1427 AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1428 RSRC_CONF, "Paths of XML schema catalogs"),
1429 AP_INIT_TAKE1("ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1430 RSRC_CONF, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"),
1432 AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1433 (void *) offsetof (shib_server_config, szScheme),
1434 RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1436 AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1437 OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1439 AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1440 (void *) offsetof (shib_dir_config, bOff),
1441 OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1442 AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1443 (void *) offsetof (shib_dir_config, szApplicationId),
1444 OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1445 AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1446 (void *) offsetof (shib_dir_config, bBasicHijack),
1447 OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1448 AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1449 (void *) offsetof (shib_dir_config, bRequireSession),
1450 OR_AUTHCFG, "Initiates a new session if one does not exist"),
1451 AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1452 (void *) offsetof (shib_dir_config, szRequireWith),
1453 OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1454 AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1455 (void *) offsetof (shib_dir_config, bExportAssertion),
1456 OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1457 AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1458 (void *) offsetof (shib_dir_config, szRedirectToSSL),
1459 OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1460 AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1461 (void *) offsetof (shib_dir_config, szAuthGrpFile),
1462 OR_AUTHCFG, "Text file containing group names and member user IDs"),
1463 AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1464 (void *) offsetof (shib_dir_config, bRequireAll),
1465 OR_AUTHCFG, "All require directives must match"),
1466 AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1467 (void *) offsetof (shib_dir_config, bAuthoritative),
1468 OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1469 AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1470 (void *) offsetof (shib_dir_config, bUseEnvVars),
1471 OR_AUTHCFG, "Export attributes using environment variables (default)"),
1472 AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1473 (void *) offsetof (shib_dir_config, bUseHeaders),
1474 OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1479 module AP_MODULE_DECLARE_DATA mod_shib = {
1480 STANDARD20_MODULE_STUFF,
1481 create_shib_dir_config, /* create dir config */
1482 merge_shib_dir_config, /* merge dir config --- default is to override */
1483 create_shib_server_config, /* create server config */
1484 merge_shib_server_config, /* merge server config */
1485 shib_cmds, /* command table */
1486 shib_register_hooks /* register hooks */
1490 #error "unsupported Apache version"