2 * Copyright 2001-2010 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/exceptions.h>
35 #include <shibsp/AbstractSPRequest.h>
36 #include <shibsp/AccessControl.h>
37 #include <shibsp/GSSRequest.h>
38 #include <shibsp/RequestMapper.h>
39 #include <shibsp/SPConfig.h>
40 #include <shibsp/ServiceProvider.h>
41 #include <shibsp/SessionCache.h>
42 #include <shibsp/attribute/Attribute.h>
44 #include <xercesc/util/XMLUniDefs.hpp>
45 #include <xercesc/util/regx/RegularExpression.hpp>
46 #include <xmltooling/XMLToolingConfig.h>
47 #include <xmltooling/util/NDC.h>
48 #include <xmltooling/util/ParserPool.h>
49 #include <xmltooling/util/Threads.h>
50 #include <xmltooling/util/XMLConstants.h>
51 #include <xmltooling/util/XMLHelper.h>
59 // Apache specific header files
61 #include <http_config.h>
62 #include <http_protocol.h>
63 #include <http_main.h>
65 #include <http_core.h>
67 #include <http_request.h>
69 #ifndef SHIB_APACHE_13
70 #include <apr_buckets.h>
71 #include <apr_strings.h>
72 #include <apr_pools.h>
82 #include <unistd.h> // for getpid()
85 using namespace shibsp;
86 using namespace xmltooling;
88 using xercesc::RegularExpression;
89 using xercesc::XMLException;
91 extern "C" module MODULE_VAR_EXPORT mod_shib;
94 char* g_szSHIBConfig = nullptr;
95 char* g_szSchemaDir = nullptr;
96 char* g_szPrefix = nullptr;
97 SPConfig* g_Config = nullptr;
98 string g_unsetHeaderValue,g_spoofKey;
99 bool g_checkSpoofing = true;
100 bool g_catchAll = false;
101 #ifndef SHIB_APACHE_13
102 char* g_szGSSContextKey = "mod_auth_gssapi:gss_ctx";
104 static const char* g_UserDataKey = "urn:mace:shibboleth:Apache:shib_check_user";
107 /* Apache 2.2.x headers must be accumulated and set in the output filter.
108 Apache 2.0.49+ supports the filter method.
109 Apache 1.3.x and lesser 2.0.x must write the headers directly. */
111 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
112 #define SHIB_DEFERRED_HEADERS
115 /********************************************************************************/
116 // Basic Apache Configuration code.
119 // per-server module configuration structure
120 struct shib_server_config
125 // creates the per-server configuration
126 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
128 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
129 sc->szScheme = nullptr;
133 // overrides server configuration in virtual servers
134 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
136 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
137 shib_server_config* parent=(shib_server_config*)base;
138 shib_server_config* child=(shib_server_config*)sub;
141 sc->szScheme=ap_pstrdup(p,child->szScheme);
142 else if (parent->szScheme)
143 sc->szScheme=ap_pstrdup(p,parent->szScheme);
145 sc->szScheme=nullptr;
150 // per-dir module configuration structure
151 struct shib_dir_config
153 SH_AP_TABLE* tSettings; // generic table of extensible settings
156 char* szAuthGrpFile; // Auth GroupFile name
157 int bRequireAll; // all "known" require directives must match, otherwise OR logic
158 int bAuthoritative; // allow htaccess plugin to DECLINE when authz fails
160 // Content Configuration
161 char* szApplicationId; // Shib applicationId value
162 char* szRequireWith; // require a session using a specific initiator?
163 char* szRedirectToSSL; // redirect non-SSL requests to SSL port
164 char* szAccessControlType; // type of "external" AccessControl plugin
165 char* szAccessControlPath; // path to AccessControl content
166 int bOff; // flat-out disable all Shib processing
167 int bBasicHijack; // activate for AuthType Basic?
168 int bRequireSession; // require a session?
169 int bExportAssertion; // export SAML assertion to the environment?
170 int bUseEnvVars; // use environment?
171 int bUseHeaders; // use headers?
174 // creates per-directory config structure
175 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
177 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
178 dc->tSettings = nullptr;
179 dc->szAuthGrpFile = nullptr;
180 dc->bRequireAll = -1;
181 dc->bAuthoritative = -1;
182 dc->szApplicationId = nullptr;
183 dc->szRequireWith = nullptr;
184 dc->szRedirectToSSL = nullptr;
185 dc->szAccessControlType = nullptr;
186 dc->szAccessControlPath = nullptr;
188 dc->bBasicHijack = -1;
189 dc->bRequireSession = -1;
190 dc->bExportAssertion = -1;
191 dc->bUseEnvVars = -1;
192 dc->bUseHeaders = -1;
196 // overrides server configuration in directories
197 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
199 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
200 shib_dir_config* parent=(shib_dir_config*)base;
201 shib_dir_config* child=(shib_dir_config*)sub;
203 // The child supersedes any matching table settings in the parent.
204 dc->tSettings = nullptr;
205 if (parent->tSettings)
206 dc->tSettings = ap_copy_table(p, parent->tSettings);
207 if (child->tSettings) {
209 ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
211 dc->tSettings = ap_copy_table(p, child->tSettings);
214 if (child->szAuthGrpFile)
215 dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
216 else if (parent->szAuthGrpFile)
217 dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
219 dc->szAuthGrpFile=nullptr;
221 if (child->szApplicationId)
222 dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
223 else if (parent->szApplicationId)
224 dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
226 dc->szApplicationId=nullptr;
228 if (child->szRequireWith)
229 dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
230 else if (parent->szRequireWith)
231 dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
233 dc->szRequireWith=nullptr;
235 if (child->szRedirectToSSL)
236 dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
237 else if (parent->szRedirectToSSL)
238 dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
240 dc->szRedirectToSSL=nullptr;
242 if (child->szAccessControlType)
243 dc->szAccessControlType=ap_pstrdup(p,child->szAccessControlType);
244 else if (parent->szAccessControlType)
245 dc->szAccessControlType=ap_pstrdup(p,parent->szAccessControlType);
247 dc->szAccessControlType=nullptr;
249 if (child->szAccessControlPath)
250 dc->szAccessControlPath=ap_pstrdup(p,child->szAccessControlPath);
251 else if (parent->szAccessControlPath)
252 dc->szAccessControlPath=ap_pstrdup(p,parent->szAccessControlPath);
254 dc->szAccessControlPath=nullptr;
256 dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
257 dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
258 dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
259 dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
260 dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
261 dc->bAuthoritative=((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
262 dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
263 dc->bUseHeaders=((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
267 // per-request module structure
268 struct shib_request_config
270 SH_AP_TABLE *env; // environment vars
271 #ifdef SHIB_DEFERRED_HEADERS
272 SH_AP_TABLE *hdr_out; // headers to browser
276 // create a request record
277 static shib_request_config *init_request_config(request_rec *r)
279 shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
280 ap_set_module_config (r->request_config, &mod_shib, rc);
281 memset(rc, 0, sizeof(shib_request_config));
282 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
286 // generic global slot handlers
287 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
289 *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
293 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
295 char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
296 size_t offset=(size_t)parms->info;
297 *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
301 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
302 #ifdef SHIB_APACHE_13
303 char* arg1, char* arg2
305 void* arg1, const char* arg2
309 ap_set_file_slot(parms, arg1, arg2);
313 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
316 dc->tSettings = ap_make_table(parms->pool, 4);
317 ap_table_set(dc->tSettings, arg1, arg2);
321 extern "C" const char* shib_acl_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
323 dc->szAccessControlType = ap_pstrdup(parms->pool, arg1);
324 dc->szAccessControlPath = ap_pstrdup(parms->pool, arg2);
329 class ShibTargetApache : public AbstractSPRequest
330 #if defined(HAVE_GSSAPI) && !defined(SHIB_APACHE_13)
335 mutable string m_body;
336 mutable bool m_gotBody,m_firsttime;
337 mutable vector<string> m_certs;
338 set<string> m_allhttp;
342 shib_dir_config* m_dc;
343 shib_server_config* m_sc;
344 shib_request_config* m_rc;
346 ShibTargetApache(request_rec* req, bool handler, bool shib_check_user)
347 : AbstractSPRequest(SHIBSP_LOGCAT".Apache"), m_handler(handler), m_gotBody(false),m_firsttime(true) {
348 m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
349 m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
350 m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
353 setRequestURI(m_req->unparsed_uri);
355 if (shib_check_user && m_dc->bUseHeaders == 1) {
356 // Try and see if this request was already processed, to skip spoof checking.
357 if (!ap_is_initial_req(m_req)) {
360 else if (!g_spoofKey.empty()) {
361 const char* hdr = ap_table_get(m_req->headers_in, "Shib-Spoof-Check");
362 if (hdr && g_spoofKey == hdr)
367 log(SPDebug, "shib_check_user running more than once");
370 virtual ~ShibTargetApache() {}
372 const char* getScheme() const {
373 return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
375 const char* getHostname() const {
376 return ap_get_server_name(m_req);
378 int getPort() const {
379 return ap_get_server_port(m_req);
381 const char* getMethod() const {
382 return m_req->method;
384 string getContentType() const {
385 const char* type = ap_table_get(m_req->headers_in, "Content-Type");
386 return type ? type : "";
388 long getContentLength() const {
389 return m_gotBody ? m_body.length() : m_req->remaining;
391 string getRemoteAddr() const {
392 string ret = AbstractSPRequest::getRemoteAddr();
393 return ret.empty() ? m_req->connection->remote_ip : ret;
395 void log(SPLogLevel level, const string& msg) const {
396 AbstractSPRequest::log(level,msg);
399 (level == SPDebug ? APLOG_DEBUG :
400 (level == SPInfo ? APLOG_INFO :
401 (level == SPWarn ? APLOG_WARNING :
402 (level == SPError ? APLOG_ERR : APLOG_CRIT))))|APLOG_NOERRNO,
407 const char* getQueryString() const { return m_req->args; }
408 const char* getRequestBody() const {
409 if (m_gotBody || m_req->method_number==M_GET)
410 return m_body.c_str();
411 #ifdef SHIB_APACHE_13
412 // Read the posted data
413 if (ap_setup_client_block(m_req, REQUEST_CHUNKED_DECHUNK) != OK) {
415 log(SPError, "Apache function (setup_client_block) failed while reading request body.");
416 return m_body.c_str();
418 if (!ap_should_client_block(m_req)) {
420 log(SPError, "Apache function (should_client_block) failed while reading request body.");
421 return m_body.c_str();
423 if (m_req->remaining > 1024*1024)
424 throw opensaml::SecurityPolicyException("Blocked request body larger than 1M size limit.");
427 char buff[HUGE_STRING_LEN];
428 ap_hard_timeout("[mod_shib] getRequestBody", m_req);
429 while ((len=ap_get_client_block(m_req, buff, sizeof(buff))) > 0) {
430 ap_reset_timeout(m_req);
431 m_body.append(buff, len);
433 ap_kill_timeout(m_req);
438 apr_bucket_brigade* bb = apr_brigade_create(m_req->pool, m_req->connection->bucket_alloc);
441 apr_status_t rv = ap_get_brigade(m_req->input_filters, bb, AP_MODE_READBYTES, APR_BLOCK_READ, HUGE_STRING_LEN);
442 if (rv != APR_SUCCESS) {
443 log(SPError, "Apache function (ap_get_brigade) failed while reading request body.");
447 for (bucket = APR_BRIGADE_FIRST(bb); bucket != APR_BRIGADE_SENTINEL(bb); bucket = APR_BUCKET_NEXT(bucket)) {
448 if (APR_BUCKET_IS_EOS(bucket)) {
453 /* We can't do much with this. */
454 if (APR_BUCKET_IS_FLUSH(bucket))
458 apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
460 m_body.append(data, len);
462 apr_brigade_cleanup(bb);
464 apr_brigade_destroy(bb);
467 return m_body.c_str();
469 void clearHeader(const char* rawname, const char* cginame) {
470 if (m_dc->bUseHeaders == 1) {
471 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: hdr\n");
472 if (g_checkSpoofing && m_firsttime) {
473 if (m_allhttp.empty()) {
474 // First time, so populate set with "CGI" versions of client-supplied headers.
475 #ifdef SHIB_APACHE_13
476 array_header *hdrs_arr = ap_table_elts(m_req->headers_in);
477 table_entry *hdrs = (table_entry *) hdrs_arr->elts;
479 const apr_array_header_t *hdrs_arr = apr_table_elts(m_req->headers_in);
480 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
482 for (int i = 0; i < hdrs_arr->nelts; ++i) {
485 string cgiversion("HTTP_");
486 const char* pch = hdrs[i].key;
488 cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
491 m_allhttp.insert(cgiversion);
495 if (m_allhttp.count(cginame) > 0)
496 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
498 ap_table_unset(m_req->headers_in, rawname);
499 ap_table_set(m_req->headers_in, rawname, g_unsetHeaderValue.c_str());
502 void setHeader(const char* name, const char* value) {
503 if (m_dc->bUseEnvVars != 0) {
505 // this happens on subrequests
506 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_setheader: no_m_rc\n");
507 m_rc = init_request_config(m_req);
510 m_rc->env = ap_make_table(m_req->pool, 10);
511 // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_set_env: %s=%s\n", name, value?value:"Null");
512 ap_table_set(m_rc->env, name, value ? value : "");
514 if (m_dc->bUseHeaders == 1)
515 ap_table_set(m_req->headers_in, name, value);
517 string getHeader(const char* name) const {
518 const char* hdr = ap_table_get(m_req->headers_in, name);
519 return string(hdr ? hdr : "");
521 string getSecureHeader(const char* name) const {
522 if (m_dc->bUseEnvVars != 0) {
524 if (m_rc && m_rc->env)
525 hdr = ap_table_get(m_rc->env, name);
528 return string(hdr ? hdr : "");
530 return getHeader(name);
532 void setRemoteUser(const char* user) {
533 SH_AP_USER(m_req) = user ? ap_pstrdup(m_req->pool, user) : nullptr;
534 if (m_dc->bUseHeaders == 1) {
536 ap_table_set(m_req->headers_in, "REMOTE_USER", user);
539 ap_table_unset(m_req->headers_in, "REMOTE_USER");
540 ap_table_set(m_req->headers_in, "REMOTE_USER", g_unsetHeaderValue.c_str());
544 string getRemoteUser() const {
545 return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
547 void setAuthType(const char* authtype) {
548 if (authtype && m_dc->bBasicHijack == 1)
550 SH_AP_AUTH_TYPE(m_req) = authtype ? ap_pstrdup(m_req->pool, authtype) : nullptr;
552 string getAuthType() const {
553 return string(SH_AP_AUTH_TYPE(m_req) ? SH_AP_AUTH_TYPE(m_req) : "");
555 void setContentType(const char* type) {
556 m_req->content_type = ap_psprintf(m_req->pool, type);
558 void setResponseHeader(const char* name, const char* value) {
559 HTTPResponse::setResponseHeader(name, value);
560 #ifdef SHIB_DEFERRED_HEADERS
562 // this happens on subrequests
563 m_rc = init_request_config(m_req);
566 m_rc->hdr_out = ap_make_table(m_req->pool, 5);
567 ap_table_add(m_rc->hdr_out, name, value);
571 ap_table_add(m_req->err_headers_out, name, value);
573 long sendResponse(istream& in, long status) {
574 if (status != XMLTOOLING_HTTP_STATUS_OK)
575 m_req->status = status;
576 ap_send_http_header(m_req);
580 ap_rwrite(buf,in.gcount(),m_req);
582 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22))
583 if (status != XMLTOOLING_HTTP_STATUS_OK && status != XMLTOOLING_HTTP_STATUS_ERROR)
588 long sendRedirect(const char* url) {
589 HTTPResponse::sendRedirect(url);
590 ap_table_set(m_req->headers_out, "Location", url);
593 const vector<string>& getClientCertificates() const {
594 if (m_certs.empty()) {
595 const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
597 m_certs.push_back(cert);
600 cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
602 m_certs.push_back(cert);
607 long returnDecline(void) { return DECLINED; }
608 long returnOK(void) { return OK; }
609 #if defined(HAVE_GSSAPI) && !defined(SHIB_APACHE_13)
610 gss_ctx_id_t getGSSContext() const {
611 gss_ctx_id_t ctx = GSS_C_NO_CONTEXT;
612 apr_pool_userdata_get((void**)&ctx, g_szGSSContextKey, m_req->pool);
618 /********************************************************************************/
621 extern "C" int shib_check_user(request_rec* r)
623 // Short-circuit entirely?
624 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
627 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
629 ostringstream threadid;
630 threadid << "[" << getpid() << "] shib_check_user" << '\0';
631 xmltooling::NDC ndc(threadid.str().c_str());
634 ShibTargetApache sta(r,false,true);
636 // Check user authentication and export information, then set the handler bypass
637 pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
638 apr_pool_userdata_setn((const void*)42,g_UserDataKey,nullptr,r->pool);
639 // If directed, install a spoof key to recognize when we've already cleared headers.
640 if (!g_spoofKey.empty() && (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bUseHeaders==1))
641 ap_table_set(r->headers_in, "Shib-Spoof-Check", g_spoofKey.c_str());
642 if (res.first) return res.second;
644 // user auth was okay -- export the assertions now
645 res = sta.getServiceProvider().doExport(sta);
646 if (res.first) return res.second;
648 // export happened successfully.. this user is ok.
651 catch (exception& e) {
652 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
656 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an unknown exception!");
663 extern "C" int shib_handler(request_rec* r)
665 // Short-circuit entirely?
666 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
669 ostringstream threadid;
670 threadid << "[" << getpid() << "] shib_handler" << '\0';
671 xmltooling::NDC ndc(threadid.str().c_str());
673 #ifndef SHIB_APACHE_13
674 // With 2.x, this handler always runs, though last.
675 // We check if shib_check_user ran, because it will detect a handler request
676 // and dispatch it directly.
678 apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
679 if (data==(const void*)42) {
680 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
685 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
688 ShibTargetApache sta(r,true,false);
690 pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
691 if (res.first) return res.second;
693 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
696 catch (exception& e) {
697 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
701 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an unknown exception!");
709 * shib_auth_checker() -- a simple resource manager to
710 * process the .htaccess settings
712 extern "C" int shib_auth_checker(request_rec* r)
714 // Short-circuit entirely?
715 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
718 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
720 ostringstream threadid;
721 threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
722 xmltooling::NDC ndc(threadid.str().c_str());
725 ShibTargetApache sta(r,false,false);
727 pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
728 if (res.first) return res.second;
730 // The SP method should always return true, so if we get this far, something unusual happened.
731 // Just let Apache (or some other module) decide what to do.
734 catch (exception& e) {
735 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
739 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an unknown exception!");
746 // Access control plugin that enforces htaccess rules
747 class htAccessControl : virtual public AccessControl
751 ~htAccessControl() {}
752 Lockable* lock() {return this;}
754 aclresult_t authorized(const SPRequest& request, const Session* session) const;
756 bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
759 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
761 return new htAccessControl();
764 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
767 ApacheRequestMapper(const xercesc::DOMElement* e);
768 ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
769 Lockable* lock() { return m_mapper->lock(); }
770 void unlock() { m_staKey->setData(nullptr); m_propsKey->setData(nullptr); m_mapper->unlock(); }
771 Settings getSettings(const HTTPRequest& request) const;
773 const PropertySet* getParent() const { return nullptr; }
774 void setParent(const PropertySet*) {}
775 pair<bool,bool> getBool(const char* name, const char* ns=nullptr) const;
776 pair<bool,const char*> getString(const char* name, const char* ns=nullptr) const;
777 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=nullptr) const;
778 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=nullptr) const;
779 pair<bool,int> getInt(const char* name, const char* ns=nullptr) const;
780 void getAll(map<string,const char*>& properties) const;
781 const PropertySet* getPropertySet(const char* name, const char* ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const;
782 const xercesc::DOMElement* getElement() const;
785 RequestMapper* m_mapper;
787 ThreadKey* m_propsKey;
788 AccessControl* m_htaccess;
791 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
793 return new ApacheRequestMapper(e);
796 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(nullptr), m_staKey(nullptr), m_propsKey(nullptr), m_htaccess(nullptr)
798 m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
799 m_htaccess=new htAccessControl();
800 m_staKey=ThreadKey::create(nullptr);
801 m_propsKey=ThreadKey::create(nullptr);
804 RequestMapper::Settings ApacheRequestMapper::getSettings(const HTTPRequest& request) const
806 Settings s=m_mapper->getSettings(request);
807 m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
808 m_propsKey->setData((void*)s.first);
809 return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
812 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
814 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
815 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
817 // Override Apache-settable boolean properties.
818 if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
819 return make_pair(true, sta->m_dc->bRequireSession==1);
820 else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
821 return make_pair(true, sta->m_dc->bExportAssertion==1);
822 else if (sta->m_dc->tSettings) {
823 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
825 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
828 return s ? s->getBool(name,ns) : make_pair(false,false);
831 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
833 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
834 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
836 // Override Apache-settable string properties.
837 if (name && !strcmp(name,"authType")) {
838 const char *auth_type=ap_auth_type(sta->m_req);
840 // Check for Basic Hijack
841 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
842 auth_type = "shibboleth";
843 return make_pair(true,auth_type);
846 else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
847 return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
848 else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
849 return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
850 else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
851 return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
852 else if (sta->m_dc->tSettings) {
853 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
855 return make_pair(true, prop);
858 return s ? s->getString(name,ns) : pair<bool,const char*>(false,nullptr);
861 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
863 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
864 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,nullptr);
867 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
869 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
870 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
872 // Override Apache-settable int properties.
873 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
874 return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, nullptr, 10));
875 else if (sta->m_dc->tSettings) {
876 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
878 return pair<bool,unsigned int>(true, atoi(prop));
881 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
884 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
886 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
887 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
889 // Override Apache-settable int properties.
890 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
891 return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
892 else if (sta->m_dc->tSettings) {
893 const char* prop = ap_table_get(sta->m_dc->tSettings, name);
895 return make_pair(true, atoi(prop));
898 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
901 static int _rm_get_all_table_walk(void *v, const char *key, const char *value)
903 reinterpret_cast<map<string,const char*>*>(v)->insert(pair<string,const char*>(key, value));
907 void ApacheRequestMapper::getAll(map<string,const char*>& properties) const
909 const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
910 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
913 s->getAll(properties);
917 const char* auth_type=ap_auth_type(sta->m_req);
919 // Check for Basic Hijack
920 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
921 auth_type = "shibboleth";
922 properties["authType"] = auth_type;
925 if (sta->m_dc->szApplicationId)
926 properties["applicationId"] = sta->m_dc->szApplicationId;
927 if (sta->m_dc->szRequireWith)
928 properties["requireSessionWith"] = sta->m_dc->szRequireWith;
929 if (sta->m_dc->szRedirectToSSL)
930 properties["redirectToSSL"] = sta->m_dc->szRedirectToSSL;
931 if (sta->m_dc->bRequireSession != 0)
932 properties["requireSession"] = (sta->m_dc->bRequireSession==1) ? "true" : "false";
933 if (sta->m_dc->bExportAssertion != 0)
934 properties["exportAssertion"] = (sta->m_dc->bExportAssertion==1) ? "true" : "false";
936 if (sta->m_dc->tSettings)
937 ap_table_do(_rm_get_all_table_walk, &properties, sta->m_dc->tSettings, nullptr);
940 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
942 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
943 return s ? s->getPropertySet(name,ns) : nullptr;
946 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
948 const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
949 return s ? s->getElement() : nullptr;
952 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
955 SH_AP_TABLE* grps=ap_make_table(r->pool,15);
956 char l[MAX_STRING_LEN];
957 const char *group_name, *ll, *w;
959 #ifdef SHIB_APACHE_13
960 if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
962 if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
964 ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
969 #ifdef SHIB_APACHE_13
970 sp=ap_make_sub_pool(r->pool);
972 if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
973 ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
974 "groups_for_user() could not create a subpool");
979 while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
980 if ((*l=='#') || (!*l))
985 group_name=ap_getword(sp,&ll,':');
988 w=ap_getword_conf(sp,&ll);
989 if (!strcmp(w,user)) {
990 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
1000 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
1002 bool caseSensitive = attr->isCaseSensitive();
1003 const vector<string>& vals = attr->getSerializedValues();
1004 for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
1006 auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
1007 if (re->matches(trans.get())) {
1008 if (request.isPriorityEnabled(SPRequest::SPDebug))
1009 request.log(SPRequest::SPDebug, string("htaccess: expecting regexp ") + toMatch + ", got " + *v + ": acccepted");
1013 else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
1014 if (request.isPriorityEnabled(SPRequest::SPDebug))
1015 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": accepted");
1018 else if (request.isPriorityEnabled(SPRequest::SPDebug)) {
1019 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": rejected");
1025 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
1027 // Make sure the object is our type.
1028 const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
1030 throw ConfigurationException("Request wrapper object was not of correct type.");
1032 int m=sta->m_req->method_number;
1033 bool method_restricted=false;
1036 const array_header* reqs_arr=ap_requires(sta->m_req);
1038 return shib_acl_indeterminate; // should never happen
1040 // Check for an "embedded" AccessControl plugin.
1041 if (sta->m_dc->szAccessControlType && sta->m_dc->szAccessControlPath) {
1042 xercesc::DOMDocument* acldoc = XMLToolingConfig::getConfig().getParser().newDocument();
1043 XercesJanitor<xercesc::DOMDocument> docjanitor(acldoc);
1044 static XMLCh ACL[] = UNICODE_LITERAL_3(A,C,L);
1045 static XMLCh _path[] = UNICODE_LITERAL_4(p,a,t,h);
1046 static XMLCh _reloadChanges[] = UNICODE_LITERAL_13(r,e,l,o,a,d,C,h,a,n,g,e,s);
1047 static XMLCh _false[] = { xercesc::chDigit_0, xercesc::chNull };
1048 xercesc::DOMElement* acldom = acldoc->createElementNS(nullptr, ACL);
1049 auto_ptr_XMLCh aclpath(sta->m_dc->szAccessControlPath);
1050 acldom->setAttributeNS(nullptr, _path, aclpath.get());
1051 acldom->setAttributeNS(nullptr, _reloadChanges, _false);
1052 aclresult_t result = shib_acl_false;
1054 auto_ptr<AccessControl> aclplugin(SPConfig::getConfig().AccessControlManager.newPlugin(sta->m_dc->szAccessControlType, acldom));
1055 Locker acllock(aclplugin.get());
1056 result = aclplugin->authorized(request, session);
1058 catch (exception& ex) {
1059 request.log(SPRequest::SPError, ex.what());
1062 if (result == shib_acl_true && sta->m_dc->bRequireAll != 1) {
1063 // If we're not insisting that all rules be met, then we're done.
1064 request.log(SPRequest::SPDebug, "htaccess: embedded AccessControl plugin was successful, granting access");
1065 return shib_acl_true;
1067 else if (result != shib_acl_true && sta->m_dc->bRequireAll == 1) {
1068 // If we're insisting that all rules be met, which is not something Apache really handles well,
1069 // then we either return false or indeterminate based on the authoritative option, which defaults on.
1070 if (sta->m_dc->bAuthoritative != 0) {
1071 request.log(SPRequest::SPDebug, "htaccess: embedded AccessControl plugin was unsuccessful, denying access");
1072 return shib_acl_false;
1075 request.log(SPRequest::SPDebug, "htaccess: embedded AccessControl plugin was unsuccessful but not authoritative, leaving it up to Apache");
1076 return shib_acl_indeterminate;
1080 require_line* reqs=(require_line*)reqs_arr->elts;
1082 for (int x=0; x<reqs_arr->nelts; x++) {
1083 // This rule should be completely ignored, the method doesn't fit.
1084 // The rule just doesn't exist for our purposes.
1085 if (!(reqs[x].method_mask & (1 << m)))
1088 method_restricted=true; // this lets us know at the end that at least one rule was potentially enforcable.
1090 // Tracks status of this rule's evaluation.
1091 bool status = false;
1093 string remote_user = request.getRemoteUser();
1095 t = reqs[x].requirement;
1096 w = ap_getword_white(sta->m_req->pool, &t);
1098 if (!strcasecmp(w,"shibboleth")) {
1099 // This is a dummy rule needed because Apache conflates authn and authz.
1100 // Without some require rule, AuthType is ignored and no check_user hooks run.
1101 status = true; // treat it as an "accepted" rule
1103 else if (!strcmp(w,"valid-user") && session) {
1104 request.log(SPRequest::SPDebug, "htaccess: accepting valid-user based on active session");
1107 else if (!strcmp(w,"user") && !remote_user.empty()) {
1108 bool regexp = false;
1110 w = ap_getword_conf(sta->m_req->pool,&t);
1115 else if (*w == '!') {
1116 // A negated rule presumes success unless a match is found.
1123 // Figure out if there's a match.
1127 // To do regex matching, we have to convert from UTF-8.
1128 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1129 RegularExpression re(trans.get());
1130 auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
1131 match = re.matches(trans2.get());
1133 catch (XMLException& ex) {
1134 auto_ptr_char tmp(ex.getMessage());
1135 request.log(SPRequest::SPError,
1136 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1139 else if (remote_user == w) {
1144 // If we matched, then we're done with this rule either way and we flip status to reflect the outcome.
1146 if (request.isPriorityEnabled(SPRequest::SPDebug))
1147 request.log(SPRequest::SPDebug,
1148 string("htaccess: require user ") + (!status ? "rejecting (" : "accepting (") + remote_user + ")");
1153 else if (!strcmp(w,"group") && !remote_user.empty()) {
1154 SH_AP_TABLE* grpstatus = nullptr;
1155 if (sta->m_dc->szAuthGrpFile) {
1156 if (request.isPriorityEnabled(SPRequest::SPDebug))
1157 request.log(SPRequest::SPDebug,string("htaccess plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
1158 grpstatus = groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
1162 w = ap_getword_conf(sta->m_req->pool,&t);
1164 // A negated rule presumes success unless a match is found.
1169 if (grpstatus && ap_table_get(grpstatus,w)) {
1170 // If we matched, then we're done with this rule either way and we flip status to reflect the outcome.
1172 request.log(SPRequest::SPDebug, string("htaccess: require group ") + (!status ? "rejecting (" : "accepting (") + w + ")");
1177 else if (!strcmp(w,"authnContextClassRef") || !strcmp(w,"authnContextDeclRef")) {
1178 const char* ref = !strcmp(w,"authnContextClassRef") ? session->getAuthnContextClassRef() : session->getAuthnContextDeclRef();
1180 bool regexp = false;
1182 w = ap_getword_conf(sta->m_req->pool,&t);
1187 else if (*w == '!') {
1188 // A negated rule presumes success unless a match is found.
1195 // Figure out if there's a match.
1199 // To do regex matching, we have to convert from UTF-8.
1200 RegularExpression re(w);
1201 match = re.matches(ref);
1203 catch (XMLException& ex) {
1204 auto_ptr_char tmp(ex.getMessage());
1205 request.log(SPRequest::SPError,
1206 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1209 else if (!strcmp(w,ref)) {
1214 // If we matched, then we're done with this rule either way and we flip status to reflect the outcome.
1216 if (request.isPriorityEnabled(SPRequest::SPDebug))
1217 request.log(SPRequest::SPDebug,
1218 string("htaccess: require authnContext ") + (!status ? "rejecting (" : "accepting (") + ref + ")");
1223 else if (request.isPriorityEnabled(SPRequest::SPDebug)) {
1224 request.log(SPRequest::SPDebug, "htaccess: require authnContext rejecting session with no context associated");
1227 else if (!session) {
1228 request.log(SPRequest::SPError, string("htaccess: require ") + w + " not given a valid session, are you using lazy sessions?");
1231 // Find the attribute(s) matching the require rule.
1232 pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1233 session->getIndexedAttributes().equal_range(w);
1236 while (!status && attrs.first!=attrs.second && *t) {
1237 w=ap_getword_conf(sta->m_req->pool,&t);
1244 auto_ptr<RegularExpression> re;
1246 delete re.release();
1247 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1248 auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1252 pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs2(attrs);
1253 for (; !status && attrs2.first!=attrs2.second; ++attrs2.first) {
1254 if (checkAttribute(request, attrs2.first->second, w, regexp ? re.get() : nullptr)) {
1259 catch (XMLException& ex) {
1260 auto_ptr_char tmp(ex.getMessage());
1261 request.log(SPRequest::SPError,
1262 string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1268 // If status is false, we found a rule we couldn't satisfy.
1269 // Could be an unknown rule to us, or it just didn't match.
1271 if (status && sta->m_dc->bRequireAll != 1) {
1272 // If we're not insisting that all rules be met, then we're done.
1273 request.log(SPRequest::SPDebug, "htaccess: a rule was successful, granting access");
1274 return shib_acl_true;
1276 else if (!status && sta->m_dc->bRequireAll == 1) {
1277 // If we're insisting that all rules be met, which is not something Apache really handles well,
1278 // then we either return false or indeterminate based on the authoritative option, which defaults on.
1279 if (sta->m_dc->bAuthoritative != 0) {
1280 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful, denying access");
1281 return shib_acl_false;
1284 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful but not authoritative, leaving it up to Apache");
1285 return shib_acl_indeterminate;
1288 // Otherwise, we keep going. If we're requring all, then we have to check every rule.
1289 // If not we just didn't find a successful rule yet, so we keep going anyway.
1292 // If we get here, we either "failed" or we're in require all mode (but not both).
1293 // If no rules possibly apply or we insisted that all rules check out, then we're good.
1294 if (!method_restricted) {
1295 request.log(SPRequest::SPDebug, "htaccess: no rules applied to this request method, granting access");
1296 return shib_acl_true;
1298 else if (sta->m_dc->bRequireAll == 1) {
1299 request.log(SPRequest::SPDebug, "htaccess: all rules successful, granting access");
1300 return shib_acl_true;
1302 else if (sta->m_dc->bAuthoritative != 0) {
1303 request.log(SPRequest::SPDebug, "htaccess: no rules were successful, denying access");
1304 return shib_acl_false;
1307 request.log(SPRequest::SPDebug, "htaccess: no rules were successful but not authoritative, leaving it up to Apache");
1308 return shib_acl_indeterminate;
1312 // Initial look at a request - create the per-request structure
1313 static int shib_post_read(request_rec *r)
1315 shib_request_config* rc = init_request_config(r);
1316 //ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1320 // fixups: set environment vars
1322 extern "C" int shib_fixups(request_rec* r)
1324 shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1325 shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1326 if (dc->bOff==1 || dc->bUseEnvVars==0)
1329 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1331 if (rc==nullptr || rc->env==nullptr || ap_is_empty_table(rc->env))
1334 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1335 r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1340 #ifdef SHIB_APACHE_13
1343 * Cleanup the (per-process) pool info.
1345 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1348 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1351 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1357 * Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1359 extern "C" apr_status_t shib_exit(void* data)
1365 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,nullptr,"shib_exit() done");
1371 * shire_child_init()
1372 * Things to do when the child process is initialized.
1373 * (or after the configs are read in apache-2)
1375 #ifdef SHIB_APACHE_13
1376 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1378 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1381 // Initialize runtime components.
1383 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1386 ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1390 g_Config=&SPConfig::getConfig();
1391 g_Config->setFeatures(
1392 SPConfig::Listener |
1394 SPConfig::RequestMapping |
1395 SPConfig::InProcess |
1399 if (!g_Config->init(g_szSchemaDir, g_szPrefix)) {
1400 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1403 g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1404 g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1407 if (!g_Config->instantiate(g_szSHIBConfig, true))
1408 throw runtime_error("unknown error");
1410 catch (exception& ex) {
1411 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1412 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1416 ServiceProvider* sp=g_Config->getServiceProvider();
1417 xmltooling::Locker locker(sp);
1418 const PropertySet* props=sp->getPropertySet("InProcess");
1420 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1421 if (unsetValue.first)
1422 g_unsetHeaderValue = unsetValue.second;
1423 pair<bool,bool> flag=props->getBool("checkSpoofing");
1424 g_checkSpoofing = !flag.first || flag.second;
1425 if (g_checkSpoofing) {
1426 unsetValue=props->getString("spoofKey");
1427 if (unsetValue.first)
1428 g_spoofKey = unsetValue.second;
1430 flag=props->getBool("catchAll");
1431 g_catchAll = flag.first && flag.second;
1434 // Set the cleanup handler
1435 apr_pool_cleanup_register(p, nullptr, &shib_exit, apr_pool_cleanup_null);
1437 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1441 #ifdef SHIB_DEFERRED_HEADERS
1442 static void set_output_filter(request_rec *r)
1444 ap_add_output_filter("SHIB_HEADERS_OUT", nullptr, r, r->connection);
1447 static void set_error_filter(request_rec *r)
1449 ap_add_output_filter("SHIB_HEADERS_ERR", nullptr, r, r->connection);
1452 static int _table_add(void *v, const char *key, const char *value)
1454 apr_table_addn((apr_table_t*)v, key, value);
1458 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1460 request_rec *r = f->r;
1461 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1463 if (rc && rc->hdr_out) {
1464 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);
1465 // can't use overlap call because it will collapse Set-Cookie headers
1466 //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1467 apr_table_do(_table_add,r->headers_out, rc->hdr_out,nullptr);
1470 /* remove ourselves from the filter chain */
1471 ap_remove_output_filter(f);
1473 /* send the data up the stack */
1474 return ap_pass_brigade(f->next,in);
1477 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1479 request_rec *r = f->r;
1480 shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1482 if (rc && rc->hdr_out) {
1483 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);
1484 // can't use overlap call because it will collapse Set-Cookie headers
1485 //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1486 apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,nullptr);
1489 /* remove ourselves from the filter chain */
1490 ap_remove_output_filter(f);
1492 /* send the data up the stack */
1493 return ap_pass_brigade(f->next,in);
1495 #endif // SHIB_DEFERRED_HEADERS
1497 typedef const char* (*config_fn_t)(void);
1499 #ifdef SHIB_APACHE_13
1501 // SHIB Module commands
1503 static command_rec shire_cmds[] = {
1504 {"ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1505 RSRC_CONF, TAKE1, "Shibboleth installation directory"},
1506 {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1507 RSRC_CONF, TAKE1, "Path to shibboleth2.xml config file"},
1508 {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1509 RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1511 {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1512 (void *) XtOffsetOf (shib_server_config, szScheme),
1513 RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1515 {"ShibRequestSetting", (config_fn_t)shib_table_set, nullptr,
1516 OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1518 {"ShibAccessControl", (config_fn_t)shib_acl_set, nullptr,
1519 OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth access control plugin for content"},
1521 {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1522 (void *) XtOffsetOf (shib_dir_config, bOff),
1523 OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1524 {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1525 (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1526 OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1527 {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1528 (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1529 OR_AUTHCFG, FLAG, "(DEPRECATED) Respond to AuthType Basic and convert to shibboleth"},
1530 {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1531 (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1532 OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1533 {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1534 (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1535 OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1536 {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1537 (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1538 OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1539 {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1540 (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1541 OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1542 {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1543 (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1544 OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1545 {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1546 (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1547 OR_AUTHCFG, FLAG, "All require directives must match"},
1548 {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1549 (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1550 OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1551 {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1552 (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1553 OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1554 {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1555 (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1556 OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1562 handler_rec shib_handlers[] = {
1563 { "shib-handler", shib_handler },
1567 module MODULE_VAR_EXPORT mod_shib = {
1568 STANDARD_MODULE_STUFF,
1569 nullptr, /* initializer */
1570 create_shib_dir_config, /* dir config creater */
1571 merge_shib_dir_config, /* dir merger --- default is to override */
1572 create_shib_server_config, /* server config */
1573 merge_shib_server_config, /* merge server config */
1574 shire_cmds, /* command table */
1575 shib_handlers, /* handlers */
1576 nullptr, /* filename translation */
1577 shib_check_user, /* check_user_id */
1578 shib_auth_checker, /* check auth */
1579 nullptr, /* check access */
1580 nullptr, /* type_checker */
1581 shib_fixups, /* fixups */
1582 nullptr, /* logger */
1583 nullptr, /* header parser */
1584 shib_child_init, /* child_init */
1585 shib_child_exit, /* child_exit */
1586 shib_post_read /* post read-request */
1589 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1591 //static const char * const authnPre[] = { "mod_gss.c", nullptr };
1593 extern "C" void shib_register_hooks (apr_pool_t *p)
1595 #ifdef SHIB_DEFERRED_HEADERS
1596 ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, nullptr, AP_FTYPE_CONTENT_SET);
1597 ap_hook_insert_filter(set_output_filter, nullptr, nullptr, APR_HOOK_LAST);
1598 ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, nullptr, AP_FTYPE_CONTENT_SET);
1599 ap_hook_insert_error_filter(set_error_filter, nullptr, nullptr, APR_HOOK_LAST);
1600 ap_hook_post_read_request(shib_post_read, nullptr, nullptr, APR_HOOK_MIDDLE);
1602 ap_hook_child_init(shib_child_init, nullptr, nullptr, APR_HOOK_MIDDLE);
1603 const char* prereq = getenv("SHIBSP_APACHE_PREREQ");
1604 if (prereq && *prereq) {
1605 const char* const authnPre[] = { prereq, nullptr };
1606 ap_hook_check_user_id(shib_check_user, authnPre, nullptr, APR_HOOK_MIDDLE);
1609 ap_hook_check_user_id(shib_check_user, nullptr, nullptr, APR_HOOK_MIDDLE);
1611 ap_hook_auth_checker(shib_auth_checker, nullptr, nullptr, APR_HOOK_FIRST);
1612 ap_hook_handler(shib_handler, nullptr, nullptr, APR_HOOK_LAST);
1613 ap_hook_fixups(shib_fixups, nullptr, nullptr, APR_HOOK_MIDDLE);
1616 // SHIB Module commands
1619 static command_rec shib_cmds[] = {
1620 AP_INIT_TAKE1("ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1621 RSRC_CONF, "Shibboleth installation directory"),
1622 AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1623 RSRC_CONF, "Path to shibboleth2.xml config file"),
1624 AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1625 RSRC_CONF, "Paths of XML schema catalogs"),
1626 AP_INIT_TAKE1("ShibGSSKey", (config_fn_t)ap_set_global_string_slot, &g_szGSSContextKey,
1627 RSRC_CONF, "Name of user data key containing GSS context established by GSS module"),
1629 AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1630 (void *) offsetof (shib_server_config, szScheme),
1631 RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1633 AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, nullptr,
1634 OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1636 AP_INIT_TAKE2("ShibAccessControl", (config_fn_t)shib_acl_set, nullptr,
1637 OR_AUTHCFG, "Set arbitrary Shibboleth access control plugin for content"),
1639 AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1640 (void *) offsetof (shib_dir_config, bOff),
1641 OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1642 AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1643 (void *) offsetof (shib_dir_config, szApplicationId),
1644 OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1645 AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1646 (void *) offsetof (shib_dir_config, bBasicHijack),
1647 OR_AUTHCFG, "(DEPRECATED) Respond to AuthType Basic and convert to shibboleth"),
1648 AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1649 (void *) offsetof (shib_dir_config, bRequireSession),
1650 OR_AUTHCFG, "Initiates a new session if one does not exist"),
1651 AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1652 (void *) offsetof (shib_dir_config, szRequireWith),
1653 OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1654 AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1655 (void *) offsetof (shib_dir_config, bExportAssertion),
1656 OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1657 AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1658 (void *) offsetof (shib_dir_config, szRedirectToSSL),
1659 OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1660 AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1661 (void *) offsetof (shib_dir_config, szAuthGrpFile),
1662 OR_AUTHCFG, "Text file containing group names and member user IDs"),
1663 AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1664 (void *) offsetof (shib_dir_config, bRequireAll),
1665 OR_AUTHCFG, "All require directives must match"),
1666 AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1667 (void *) offsetof (shib_dir_config, bAuthoritative),
1668 OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1669 AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1670 (void *) offsetof (shib_dir_config, bUseEnvVars),
1671 OR_AUTHCFG, "Export attributes using environment variables (default)"),
1672 AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1673 (void *) offsetof (shib_dir_config, bUseHeaders),
1674 OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1679 module AP_MODULE_DECLARE_DATA mod_shib = {
1680 STANDARD20_MODULE_STUFF,
1681 create_shib_dir_config, /* create dir config */
1682 merge_shib_dir_config, /* merge dir config --- default is to override */
1683 create_shib_server_config, /* create server config */
1684 merge_shib_server_config, /* merge server config */
1685 shib_cmds, /* command table */
1686 shib_register_hooks /* register hooks */
1690 #error "unsupported Apache version"