apache/mod_apache.cpp

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * mod_apache.cpp
  19  *
  20  * Apache module implementation
  21  */
  22
  23 #define SHIBSP_LITE
  24
  25 #ifdef SOLARIS2
  26 #undef _XOPEN_SOURCE    // causes gethostname conflict in unistd.h
  27 #endif
  28
  29 #ifdef WIN32
  30 # define _CRT_NONSTDC_NO_DEPRECATE 1
  31 # define _CRT_SECURE_NO_DEPRECATE 1
  32 #endif
  33
  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>
  49
  50 #ifdef WIN32
  51 # include <winsock.h>
  52 #endif
  53
  54 #undef _XPG4_2
  55
  56 // Apache specific header files
  57 #include <httpd.h>
  58 #include <http_config.h>
  59 #include <http_protocol.h>
  60 #include <http_main.h>
  61 #define CORE_PRIVATE
  62 #include <http_core.h>
  63 #include <http_log.h>
  64 #include <http_request.h>
  65
  66 #ifndef SHIB_APACHE_13
  67 #include <apr_buckets.h>
  68 #include <apr_strings.h>
  69 #include <apr_pools.h>
  70 #endif
  71
  72 #include <fstream>
  73 #include <sstream>
  74
  75 #ifdef HAVE_UNISTD_H
  76 #include <unistd.h>             // for getpid()
  77 #endif
  78
  79 using namespace shibsp;
  80 using namespace xmltooling;
  81 using namespace std;
  82 using xercesc::RegularExpression;
  83 using xercesc::XMLException;
  84
  85 extern "C" module MODULE_VAR_EXPORT mod_shib;
  86
  87 namespace {
  88     char* g_szSHIBConfig = SHIBSP_CONFIG;
  89     char* g_szSchemaDir = SHIBSP_SCHEMAS;
  90     SPConfig* g_Config = NULL;
  91     string g_unsetHeaderValue;
  92     bool g_checkSpoofing = true;
  93     static const char* g_UserDataKey = "_shib_check_user_";
  94     static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
  95     static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
  96 }
  97
  98 /* Apache 2.2.x headers must be accumulated and set in the output filter.
  99    Apache 2.0.49+ supports the filter method.
 100    Apache 1.3.x and lesser 2.0.x must write the headers directly. */
 101
 102 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
 103 #define SHIB_DEFERRED_HEADERS
 104 #endif
 105
 106 /********************************************************************************/
 107 // Basic Apache Configuration code.
 108 //
 109
 110 // per-server module configuration structure
 111 struct shib_server_config
 112 {
 113     char* szScheme;
 114 };
 115
 116 // creates the per-server configuration
 117 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
 118 {
 119     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
 120     sc->szScheme = NULL;
 121     return sc;
 122 }
 123
 124 // overrides server configuration in virtual servers
 125 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
 126 {
 127     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
 128     shib_server_config* parent=(shib_server_config*)base;
 129     shib_server_config* child=(shib_server_config*)sub;
 130
 131     if (child->szScheme)
 132         sc->szScheme=ap_pstrdup(p,child->szScheme);
 133     else if (parent->szScheme)
 134         sc->szScheme=ap_pstrdup(p,parent->szScheme);
 135     else
 136         sc->szScheme=NULL;
 137
 138     return sc;
 139 }
 140
 141 // per-dir module configuration structure
 142 struct shib_dir_config
 143 {
 144     SH_AP_TABLE* tSettings; // generic table of extensible settings
 145
 146     // RM Configuration
 147     char* szAuthGrpFile;    // Auth GroupFile name
 148     int bRequireAll;        // all "known" require directives must match, otherwise OR logic
 149     int bAuthoritative;     // allow htaccess plugin to DECLINE when authz fails
 150
 151     // Content Configuration
 152     char* szApplicationId;  // Shib applicationId value
 153     char* szRequireWith;    // require a session using a specific initiator?
 154     char* szRedirectToSSL;  // redirect non-SSL requests to SSL port
 155     int bOff;               // flat-out disable all Shib processing
 156     int bBasicHijack;       // activate for AuthType Basic?
 157     int bRequireSession;    // require a session?
 158     int bExportAssertion;   // export SAML assertion to the environment?
 159     int bUseEnvVars;        // use environment?
 160     int bUseHeaders;        // use headers?
 161 };
 162
 163 // creates per-directory config structure
 164 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
 165 {
 166     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
 167     dc->tSettings = NULL;
 168     dc->szAuthGrpFile = NULL;
 169     dc->bRequireAll = -1;
 170     dc->bAuthoritative = -1;
 171     dc->szApplicationId = NULL;
 172     dc->szRequireWith = NULL;
 173     dc->szRedirectToSSL = NULL;
 174     dc->bOff = -1;
 175     dc->bBasicHijack = -1;
 176     dc->bRequireSession = -1;
 177     dc->bExportAssertion = -1;
 178     dc->bUseEnvVars = -1;
 179     dc->bUseHeaders = -1;
 180     return dc;
 181 }
 182
 183 // overrides server configuration in directories
 184 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
 185 {
 186     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
 187     shib_dir_config* parent=(shib_dir_config*)base;
 188     shib_dir_config* child=(shib_dir_config*)sub;
 189
 190     // The child supersedes any matching table settings in the parent.
 191     dc->tSettings = NULL;
 192     if (parent->tSettings)
 193         dc->tSettings = ap_copy_table(p, parent->tSettings);
 194     if (child->tSettings) {
 195         if (dc->tSettings)
 196             ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
 197         else
 198             dc->tSettings = ap_copy_table(p, child->tSettings);
 199     }
 200
 201     if (child->szAuthGrpFile)
 202         dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
 203     else if (parent->szAuthGrpFile)
 204         dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
 205     else
 206         dc->szAuthGrpFile=NULL;
 207
 208     if (child->szApplicationId)
 209         dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
 210     else if (parent->szApplicationId)
 211         dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
 212     else
 213         dc->szApplicationId=NULL;
 214
 215     if (child->szRequireWith)
 216         dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
 217     else if (parent->szRequireWith)
 218         dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
 219     else
 220         dc->szRequireWith=NULL;
 221
 222     if (child->szRedirectToSSL)
 223         dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
 224     else if (parent->szRedirectToSSL)
 225         dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
 226     else
 227         dc->szRedirectToSSL=NULL;
 228
 229     dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
 230     dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
 231     dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
 232     dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
 233     dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
 234     dc->bAuthoritative=((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
 235     dc->bUseEnvVars=((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
 236     dc->bUseHeaders=((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
 237     return dc;
 238 }
 239
 240 // per-request module structure
 241 struct shib_request_config
 242 {
 243     SH_AP_TABLE *env;        // environment vars
 244 #ifdef SHIB_DEFERRED_HEADERS
 245     SH_AP_TABLE *hdr_out;    // headers to browser
 246 #endif
 247 };
 248
 249 // create a request record
 250 static shib_request_config *init_request_config(request_rec *r)
 251 {
 252     shib_request_config* rc=(shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
 253     ap_set_module_config (r->request_config, &mod_shib, rc);
 254     memset(rc, 0, sizeof(shib_request_config));
 255     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_init_rc");
 256     return rc;
 257 }
 258
 259 // generic global slot handlers
 260 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
 261 {
 262     *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
 263     return NULL;
 264 }
 265
 266 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
 267 {
 268     char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
 269     size_t offset=(size_t)parms->info;
 270     *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
 271     return NULL;
 272 }
 273
 274 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
 275 #ifdef SHIB_APACHE_13
 276                                              char* arg1, char* arg2
 277 #else
 278                                              void* arg1, const char* arg2
 279 #endif
 280                                              )
 281 {
 282   ap_set_file_slot(parms, arg1, arg2);
 283   return DECLINE_CMD;
 284 }
 285
 286 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
 287 {
 288     if (!dc->tSettings)
 289         dc->tSettings = ap_make_table(parms->pool, 4);
 290     ap_table_set(dc->tSettings, arg1, arg2);
 291     return NULL;
 292 }
 293
 294 /********************************************************************************/
 295 // Apache ShibTarget subclass(es) here.
 296
 297 class ShibTargetApache : public AbstractSPRequest
 298 {
 299   bool m_handler;
 300   mutable string m_body;
 301   mutable bool m_gotBody;
 302   mutable vector<string> m_certs;
 303   set<string> m_allhttp;
 304
 305 public:
 306   request_rec* m_req;
 307   shib_dir_config* m_dc;
 308   shib_server_config* m_sc;
 309   shib_request_config* m_rc;
 310
 311   ShibTargetApache(request_rec* req, bool handler) : m_handler(handler), m_gotBody(false) {
 312     m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
 313     m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
 314     m_rc = (shib_request_config*)ap_get_module_config(req->request_config, &mod_shib);
 315     m_req = req;
 316   }
 317   virtual ~ShibTargetApache() {}
 318
 319   const char* getScheme() const {
 320     return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
 321   }
 322   const char* getHostname() const {
 323     return ap_get_server_name(m_req);
 324   }
 325   int getPort() const {
 326     return ap_get_server_port(m_req);
 327   }
 328   const char* getRequestURI() const {
 329     return m_req->unparsed_uri;
 330   }
 331   const char* getMethod() const {
 332     return m_req->method;
 333   }
 334   string getContentType() const {
 335     const char* type = ap_table_get(m_req->headers_in, "Content-Type");
 336     return type ? type : "";
 337   }
 338   long getContentLength() const {
 339       return m_gotBody ? m_body.length() : m_req->remaining;
 340   }
 341   string getRemoteAddr() const {
 342     return m_req->connection->remote_ip;
 343   }
 344   void log(SPLogLevel level, const string& msg) const {
 345     AbstractSPRequest::log(level,msg);
 346     ap_log_rerror(
 347         APLOG_MARK,
 348         (level == SPDebug ? APLOG_DEBUG :
 349         (level == SPInfo ? APLOG_INFO :
 350         (level == SPWarn ? APLOG_WARNING :
 351         (level == SPError ? APLOG_ERR : APLOG_CRIT))))|APLOG_NOERRNO,
 352         SH_AP_R(m_req),
 353         msg.c_str()
 354         );
 355   }
 356   const char* getQueryString() const { return m_req->args; }
 357   const char* getRequestBody() const {
 358     if (m_gotBody || m_req->method_number==M_GET)
 359         return m_body.c_str();
 360 #ifdef SHIB_APACHE_13
 361     // Read the posted data
 362     if (ap_setup_client_block(m_req, REQUEST_CHUNKED_DECHUNK) != OK) {
 363         m_gotBody=true;
 364         log(SPError, "Apache function (setup_client_block) failed while reading request body.");
 365         return m_body.c_str();
 366     }
 367     if (!ap_should_client_block(m_req)) {
 368         m_gotBody=true;
 369         log(SPError, "Apache function (should_client_block) failed while reading request body.");
 370         return m_body.c_str();
 371     }
 372     if (m_req->remaining > 1024*1024)
 373         throw opensaml::SecurityPolicyException("Blocked request body larger than 1M size limit.");
 374     m_gotBody=true;
 375     int len;
 376     char buff[HUGE_STRING_LEN];
 377     ap_hard_timeout("[mod_shib] getRequestBody", m_req);
 378     while ((len=ap_get_client_block(m_req, buff, sizeof(buff))) > 0) {
 379       ap_reset_timeout(m_req);
 380       m_body.append(buff, len);
 381     }
 382     ap_kill_timeout(m_req);
 383 #else
 384     const char *data;
 385     apr_size_t len;
 386     int seen_eos = 0;
 387     apr_bucket_brigade* bb = apr_brigade_create(m_req->pool, m_req->connection->bucket_alloc);
 388     do {
 389         apr_bucket *bucket;
 390         apr_status_t rv = ap_get_brigade(m_req->input_filters, bb, AP_MODE_READBYTES, APR_BLOCK_READ, HUGE_STRING_LEN);
 391         if (rv != APR_SUCCESS) {
 392             log(SPError, "Apache function (ap_get_brigade) failed while reading request body.");
 393             break;
 394         }
 395
 396         for (bucket = APR_BRIGADE_FIRST(bb); bucket != APR_BRIGADE_SENTINEL(bb); bucket = APR_BUCKET_NEXT(bucket)) {
 397             if (APR_BUCKET_IS_EOS(bucket)) {
 398                 seen_eos = 1;
 399                 break;
 400             }
 401
 402             /* We can't do much with this. */
 403             if (APR_BUCKET_IS_FLUSH(bucket))
 404                 continue;
 405
 406             /* read */
 407             apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
 408             if (len > 0)
 409                 m_body.append(data, len);
 410         }
 411         apr_brigade_cleanup(bb);
 412     } while (!seen_eos);
 413     apr_brigade_destroy(bb);
 414     m_gotBody=true;
 415 #endif
 416     return m_body.c_str();
 417   }
 418   void clearHeader(const char* rawname, const char* cginame) {
 419     if (m_dc->bUseHeaders == 1) {
 420        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: hdr\n");
 421         if (g_checkSpoofing && ap_is_initial_req(m_req)) {
 422             if (m_allhttp.empty()) {
 423                 // First time, so populate set with "CGI" versions of client-supplied headers.
 424 #ifdef SHIB_APACHE_13
 425                 array_header *hdrs_arr = ap_table_elts(m_req->headers_in);
 426                 table_entry *hdrs = (table_entry *) hdrs_arr->elts;
 427 #else
 428                 const apr_array_header_t *hdrs_arr = apr_table_elts(m_req->headers_in);
 429                 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
 430 #endif
 431                 for (int i = 0; i < hdrs_arr->nelts; ++i) {
 432                     if (!hdrs[i].key)
 433                         continue;
 434                     string cgiversion("HTTP_");
 435                     const char* pch = hdrs[i].key;
 436                     while (*pch) {
 437                         cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
 438                         pch++;
 439                     }
 440                     m_allhttp.insert(cgiversion);
 441                 }
 442             }
 443
 444             if (m_allhttp.count(cginame) > 0)
 445                 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
 446         }
 447         ap_table_unset(m_req->headers_in, rawname);
 448         ap_table_set(m_req->headers_in, rawname, g_unsetHeaderValue.c_str());
 449     }
 450   }
 451   void setHeader(const char* name, const char* value) {
 452     if (m_dc->bUseEnvVars != 0) {
 453        if (!m_rc) {
 454           // this happens on subrequests
 455           // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_setheader: no_m_rc\n");
 456           m_rc = init_request_config(m_req);
 457        }
 458        if (!m_rc->env)
 459            m_rc->env = ap_make_table(m_req->pool, 10);
 460        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_set_env: %s=%s\n", name, value?value:"Null");
 461        ap_table_set(m_rc->env, name, value ? value : "");
 462     }
 463     if (m_dc->bUseHeaders == 1)
 464        ap_table_set(m_req->headers_in, name, value);
 465   }
 466   string getHeader(const char* name) const {
 467     const char* hdr = ap_table_get(m_req->headers_in, name);
 468     return string(hdr ? hdr : "");
 469   }
 470   string getSecureHeader(const char* name) const {
 471     if (m_dc->bUseEnvVars != 0) {
 472        const char *hdr;
 473        if (m_rc && m_rc->env)
 474            hdr = ap_table_get(m_rc->env, name);
 475        else
 476            hdr = NULL;
 477        return string(hdr ? hdr : "");
 478     }
 479     return getHeader(name);
 480   }
 481   void setRemoteUser(const char* user) {
 482       SH_AP_USER(m_req) = user ? ap_pstrdup(m_req->pool, user) : NULL;
 483   }
 484   string getRemoteUser() const {
 485     return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
 486   }
 487   void setContentType(const char* type) {
 488       m_req->content_type = ap_psprintf(m_req->pool, type);
 489   }
 490   void setResponseHeader(const char* name, const char* value) {
 491 #ifdef SHIB_DEFERRED_HEADERS
 492    if (!m_rc)
 493       // this happens on subrequests
 494       m_rc = init_request_config(m_req);
 495     if (m_handler)
 496         ap_table_add(m_rc->hdr_out, name, value);
 497     else
 498 #endif
 499     ap_table_add(m_req->err_headers_out, name, value);
 500   }
 501   long sendResponse(istream& in, long status) {
 502     ap_send_http_header(m_req);
 503     char buf[1024];
 504     while (in) {
 505         in.read(buf,1024);
 506         ap_rwrite(buf,in.gcount(),m_req);
 507     }
 508     if (status!=XMLTOOLING_HTTP_STATUS_OK)
 509         m_req->status = status;
 510     return DONE;
 511   }
 512   long sendRedirect(const char* url) {
 513     ap_table_set(m_req->headers_out, "Location", url);
 514     return REDIRECT;
 515   }
 516   const vector<string>& getClientCertificates() const {
 517       if (m_certs.empty()) {
 518           const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
 519           if (cert)
 520               m_certs.push_back(cert);
 521           int i = 0;
 522           do {
 523               cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
 524               if (cert)
 525                   m_certs.push_back(cert);
 526           } while (cert);
 527       }
 528       return m_certs;
 529   }
 530   long returnDecline(void) { return DECLINED; }
 531   long returnOK(void) { return OK; }
 532 };
 533
 534 /********************************************************************************/
 535 // Apache handlers
 536
 537 extern "C" int shib_check_user(request_rec* r)
 538 {
 539   // Short-circuit entirely?
 540   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
 541     return DECLINED;
 542
 543   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
 544
 545   ostringstream threadid;
 546   threadid << "[" << getpid() << "] shib_check_user" << '\0';
 547   xmltooling::NDC ndc(threadid.str().c_str());
 548
 549   try {
 550     ShibTargetApache sta(r,false);
 551
 552     // Check user authentication and export information, then set the handler bypass
 553     pair<bool,long> res = sta.getServiceProvider().doAuthentication(sta,true);
 554     apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
 555     if (res.first) return res.second;
 556
 557     // user auth was okay -- export the assertions now
 558     res = sta.getServiceProvider().doExport(sta);
 559     if (res.first) return res.second;
 560
 561     // export happened successfully..  this user is ok.
 562     return OK;
 563   }
 564   catch (exception& e) {
 565     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
 566     return SERVER_ERROR;
 567   }
 568 #ifndef _DEBUG
 569   catch (...) {
 570     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an uncaught exception!");
 571     return SERVER_ERROR;
 572   }
 573 #endif
 574 }
 575
 576 extern "C" int shib_handler(request_rec* r)
 577 {
 578   // Short-circuit entirely?
 579   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
 580     return DECLINED;
 581
 582   ostringstream threadid;
 583   threadid << "[" << getpid() << "] shib_handler" << '\0';
 584   xmltooling::NDC ndc(threadid.str().c_str());
 585
 586 #ifndef SHIB_APACHE_13
 587   // With 2.x, this handler always runs, though last.
 588   // We check if shib_check_user ran, because it will detect a handler request
 589   // and dispatch it directly.
 590   void* data;
 591   apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
 592   if (data==(const void*)42) {
 593     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
 594     return DECLINED;
 595   }
 596 #endif
 597
 598   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
 599
 600   try {
 601     ShibTargetApache sta(r,true);
 602
 603     pair<bool,long> res = sta.getServiceProvider().doHandler(sta);
 604     if (res.first) return res.second;
 605
 606     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
 607     return SERVER_ERROR;
 608   }
 609   catch (exception& e) {
 610     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
 611     return SERVER_ERROR;
 612   }
 613 #ifndef _DEBUG
 614   catch (...) {
 615     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an uncaught exception!");
 616     return SERVER_ERROR;
 617   }
 618 #endif
 619 }
 620
 621 /*
 622  * shib_auth_checker() -- a simple resource manager to
 623  * process the .htaccess settings
 624  */
 625 extern "C" int shib_auth_checker(request_rec* r)
 626 {
 627   // Short-circuit entirely?
 628   if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
 629     return DECLINED;
 630
 631   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
 632
 633   ostringstream threadid;
 634   threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
 635   xmltooling::NDC ndc(threadid.str().c_str());
 636
 637   try {
 638     ShibTargetApache sta(r,false);
 639
 640     pair<bool,long> res = sta.getServiceProvider().doAuthorization(sta);
 641     if (res.first) return res.second;
 642
 643     // The SP method should always return true, so if we get this far, something unusual happened.
 644     // Just let Apache (or some other module) decide what to do.
 645     return DECLINED;
 646   }
 647   catch (exception& e) {
 648     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
 649     return SERVER_ERROR;
 650   }
 651 #ifndef _DEBUG
 652   catch (...) {
 653     ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an uncaught exception!");
 654     return SERVER_ERROR;
 655   }
 656 #endif
 657 }
 658
 659 // Access control plugin that enforces htaccess rules
 660 class htAccessControl : virtual public AccessControl
 661 {
 662 public:
 663     htAccessControl() {}
 664     ~htAccessControl() {}
 665     Lockable* lock() {return this;}
 666     void unlock() {}
 667     aclresult_t authorized(const SPRequest& request, const Session* session) const;
 668 private:
 669     bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
 670 };
 671
 672 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
 673 {
 674     return new htAccessControl();
 675 }
 676
 677 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
 678 {
 679 public:
 680     ApacheRequestMapper(const xercesc::DOMElement* e);
 681     ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
 682     Lockable* lock() { return m_mapper->lock(); }
 683     void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
 684     Settings getSettings(const SPRequest& request) const;
 685
 686     const PropertySet* getParent() const { return NULL; }
 687     void setParent(const PropertySet*) {}
 688     pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
 689     pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
 690     pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
 691     pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
 692     pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
 693     const PropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:2.0:native:sp:config") const;
 694     const xercesc::DOMElement* getElement() const;
 695
 696 private:
 697     RequestMapper* m_mapper;
 698     ThreadKey* m_staKey;
 699     ThreadKey* m_propsKey;
 700     AccessControl* m_htaccess;
 701 };
 702
 703 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
 704 {
 705     return new ApacheRequestMapper(e);
 706 }
 707
 708 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
 709 {
 710     m_mapper=SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e);
 711     m_htaccess=new htAccessControl();
 712     m_staKey=ThreadKey::create(NULL);
 713     m_propsKey=ThreadKey::create(NULL);
 714 }
 715
 716 RequestMapper::Settings ApacheRequestMapper::getSettings(const SPRequest& request) const
 717 {
 718     Settings s=m_mapper->getSettings(request);
 719     m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
 720     m_propsKey->setData((void*)s.first);
 721     return pair<const PropertySet*,AccessControl*>(this,s.second ? s.second : m_htaccess);
 722 }
 723
 724 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
 725 {
 726     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
 727     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
 728     if (sta && !ns) {
 729         // Override Apache-settable boolean properties.
 730         if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
 731             return make_pair(true, sta->m_dc->bRequireSession==1);
 732         else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
 733             return make_pair(true, sta->m_dc->bExportAssertion==1);
 734         else if (sta->m_dc->tSettings) {
 735             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
 736             if (prop)
 737                 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
 738         }
 739     }
 740     return s ? s->getBool(name,ns) : make_pair(false,false);
 741 }
 742
 743 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
 744 {
 745     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
 746     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
 747     if (sta && !ns) {
 748         // Override Apache-settable string properties.
 749         if (name && !strcmp(name,"authType")) {
 750             const char *auth_type=ap_auth_type(sta->m_req);
 751             if (auth_type) {
 752                 // Check for Basic Hijack
 753                 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
 754                     auth_type = "shibboleth";
 755                 return make_pair(true,auth_type);
 756             }
 757         }
 758         else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
 759             return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
 760         else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
 761             return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
 762         else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
 763             return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
 764         else if (sta->m_dc->tSettings) {
 765             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
 766             if (prop)
 767                 return make_pair(true, prop);
 768         }
 769     }
 770     return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
 771 }
 772
 773 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
 774 {
 775     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
 776     return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
 777 }
 778
 779 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
 780 {
 781     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
 782     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
 783     if (sta && !ns) {
 784         // Override Apache-settable int properties.
 785         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
 786             return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, NULL, 10));
 787         else if (sta->m_dc->tSettings) {
 788             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
 789             if (prop)
 790                 return make_pair(true, strtol(prop, NULL, 10));
 791         }
 792     }
 793     return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
 794 }
 795
 796 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
 797 {
 798     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
 799     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
 800     if (sta && !ns) {
 801         // Override Apache-settable int properties.
 802         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
 803             return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
 804         else if (sta->m_dc->tSettings) {
 805             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
 806             if (prop)
 807                 return make_pair(true, atoi(prop));
 808         }
 809     }
 810     return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
 811 }
 812
 813 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
 814 {
 815     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
 816     return s ? s->getPropertySet(name,ns) : NULL;
 817 }
 818
 819 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
 820 {
 821     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
 822     return s ? s->getElement() : NULL;
 823 }
 824
 825 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
 826 {
 827     SH_AP_CONFIGFILE* f;
 828     SH_AP_TABLE* grps=ap_make_table(r->pool,15);
 829     char l[MAX_STRING_LEN];
 830     const char *group_name, *ll, *w;
 831
 832 #ifdef SHIB_APACHE_13
 833     if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
 834 #else
 835     if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
 836 #endif
 837         ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
 838         return NULL;
 839     }
 840
 841     SH_AP_POOL* sp;
 842 #ifdef SHIB_APACHE_13
 843     sp=ap_make_sub_pool(r->pool);
 844 #else
 845     if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
 846         ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
 847             "groups_for_user() could not create a subpool");
 848         return NULL;
 849     }
 850 #endif
 851
 852     while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
 853         if ((*l=='#') || (!*l))
 854             continue;
 855         ll = l;
 856         ap_clear_pool(sp);
 857
 858         group_name=ap_getword(sp,&ll,':');
 859
 860         while (*ll) {
 861             w=ap_getword_conf(sp,&ll);
 862             if (!strcmp(w,user)) {
 863                 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
 864                 break;
 865             }
 866         }
 867     }
 868     ap_cfg_closefile(f);
 869     ap_destroy_pool(sp);
 870     return grps;
 871 }
 872
 873 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
 874 {
 875     bool caseSensitive = attr->isCaseSensitive();
 876     const vector<string>& vals = attr->getSerializedValues();
 877     for (vector<string>::const_iterator v=vals.begin(); v!=vals.end(); ++v) {
 878         if (re) {
 879             auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
 880             if (re->matches(trans.get())) {
 881                 request.log(SPRequest::SPDebug,
 882                     string("htAccessControl plugin expecting regexp ") + toMatch + ", got " + *v + ": authorization granted"
 883                     );
 884                 return true;
 885             }
 886         }
 887         else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
 888             request.log(SPRequest::SPDebug,
 889                 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization granted."
 890                 );
 891             return true;
 892         }
 893         else {
 894             request.log(SPRequest::SPDebug,
 895                 string("htAccessControl plugin expecting ") + toMatch + ", got " + *v + ": authorization not granted."
 896                 );
 897         }
 898     }
 899     return false;
 900 }
 901
 902 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
 903 {
 904     // Make sure the object is our type.
 905     const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
 906     if (!sta)
 907         throw ConfigurationException("Request wrapper object was not of correct type.");
 908
 909     // mod_auth clone
 910
 911     int m=sta->m_req->method_number;
 912     bool method_restricted=false;
 913     const char *t, *w;
 914
 915     const array_header* reqs_arr=ap_requires(sta->m_req);
 916     if (!reqs_arr)
 917         return shib_acl_indeterminate;  // should never happen
 918
 919     require_line* reqs=(require_line*)reqs_arr->elts;
 920
 921     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE nelts: %d", reqs_arr->nelts);
 922     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE all: %d", sta->m_dc->bRequireAll);
 923
 924     vector<bool> auth_OK(reqs_arr->nelts,false);
 925
 926 #define SHIB_AP_CHECK_IS_OK {           \
 927      if (sta->m_dc->bRequireAll < 1)    \
 928          return shib_acl_true;          \
 929      auth_OK[x] = true;                 \
 930      continue;                          \
 931 }
 932
 933     for (int x=0; x<reqs_arr->nelts; x++) {
 934         auth_OK[x] = false;
 935         if (!(reqs[x].method_mask & (1 << m)))
 936             continue;
 937         method_restricted=true;
 938         string remote_user = request.getRemoteUser();
 939
 940         t = reqs[x].requirement;
 941         w = ap_getword_white(sta->m_req->pool, &t);
 942
 943         if (!strcasecmp(w,"shibboleth")) {
 944             // This is a dummy rule needed because Apache conflates authn and authz.
 945             // Without some require rule, AuthType is ignored and no check_user hooks run.
 946             SHIB_AP_CHECK_IS_OK;
 947         }
 948         else if (!strcmp(w,"valid-user")) {
 949             if (session) {
 950                 request.log(SPRequest::SPDebug,"htAccessControl plugin accepting valid-user based on active session");
 951                 SHIB_AP_CHECK_IS_OK;
 952             }
 953             else {
 954                 request.log(SPRequest::SPError,"htAccessControl plugin rejecting access for valid-user rule, no session is active");
 955             }
 956         }
 957         else if (!strcmp(w,"user") && !remote_user.empty()) {
 958             bool regexp=false;
 959             while (*t) {
 960                 w=ap_getword_conf(sta->m_req->pool,&t);
 961                 if (*w=='~') {
 962                     regexp=true;
 963                     continue;
 964                 }
 965
 966                 if (regexp) {
 967                     try {
 968                         // To do regex matching, we have to convert from UTF-8.
 969                         auto_arrayptr<XMLCh> trans(fromUTF8(w));
 970                         RegularExpression re(trans.get());
 971                         auto_arrayptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
 972                         if (re.matches(trans2.get())) {
 973                             request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
 974                             SHIB_AP_CHECK_IS_OK;
 975                         }
 976                     }
 977                     catch (XMLException& ex) {
 978                         auto_ptr_char tmp(ex.getMessage());
 979                         request.log(SPRequest::SPError,
 980                             string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
 981                     }
 982                 }
 983                 else if (remote_user==w) {
 984                     request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting user (") + w + ")");
 985                     SHIB_AP_CHECK_IS_OK;
 986                 }
 987             }
 988         }
 989         else if (!strcmp(w,"group")) {
 990             SH_AP_TABLE* grpstatus=NULL;
 991             if (sta->m_dc->szAuthGrpFile && !remote_user.empty()) {
 992                 request.log(SPRequest::SPDebug,string("htAccessControl plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
 993                 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
 994             }
 995             if (!grpstatus)
 996                 continue;
 997
 998             while (*t) {
 999                 w=ap_getword_conf(sta->m_req->pool,&t);
1000                 if (ap_table_get(grpstatus,w)) {
1001                     request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting group (") + w + ")");
1002                     SHIB_AP_CHECK_IS_OK;
1003                 }
1004             }
1005         }
1006         else if (!strcmp(w,"authnContextClassRef")) {
1007             const char* ref = session->getAuthnContextClassRef();
1008             while (ref && *t) {
1009                 w=ap_getword_conf(sta->m_req->pool,&t);
1010                 if (!strcmp(w, ref)) {
1011                     request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting authnContextClassRef (") + w + ")");
1012                     SHIB_AP_CHECK_IS_OK;
1013                 }
1014             }
1015         }
1016         else if (!strcmp(w,"authnContextDeclRef")) {
1017             const char* ref = session->getAuthnContextDeclRef();
1018             while (ref && *t) {
1019                 w=ap_getword_conf(sta->m_req->pool,&t);
1020                 if (!strcmp(w, ref)) {
1021                     request.log(SPRequest::SPDebug, string("htAccessControl plugin accepting authnContextDeclRef (") + w + ")");
1022                     SHIB_AP_CHECK_IS_OK;
1023                 }
1024             }
1025         }
1026         else {
1027             // Map alias in rule to the attribute.
1028             if (!session) {
1029                 request.log(SPRequest::SPError, "htAccessControl plugin not given a valid session to evaluate, are you using lazy sessions?");
1030                 continue;
1031             }
1032
1033             // Find the attribute(s) matching the require rule.
1034             pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1035                 session->getIndexedAttributes().equal_range(w);
1036             if (attrs.first == attrs.second) {
1037                 request.log(SPRequest::SPWarn, string("htAccessControl rule requires attribute (") + w + "), not found in session");
1038                 continue;
1039             }
1040
1041             bool regexp=false;
1042
1043             while (!auth_OK[x] && *t) {
1044                 w=ap_getword_conf(sta->m_req->pool,&t);
1045                 if (*w=='~') {
1046                     regexp=true;
1047                     continue;
1048                 }
1049
1050                 try {
1051                     auto_ptr<RegularExpression> re;
1052                     if (regexp) {
1053                         delete re.release();
1054                         auto_arrayptr<XMLCh> trans(fromUTF8(w));
1055                         auto_ptr<xercesc::RegularExpression> temp(new xercesc::RegularExpression(trans.get()));
1056                         re=temp;
1057                     }
1058
1059                     for (; !auth_OK[x] && attrs.first!=attrs.second; ++attrs.first) {
1060                         if (checkAttribute(request, attrs.first->second, w, regexp ? re.get() : NULL)) {
1061                             SHIB_AP_CHECK_IS_OK;
1062                         }
1063                     }
1064                 }
1065                 catch (XMLException& ex) {
1066                     auto_ptr_char tmp(ex.getMessage());
1067                     request.log(SPRequest::SPError,
1068                         string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get()
1069                         );
1070                 }
1071             }
1072         }
1073     }
1074
1075     // If we get here, we either "failed" or we're in require all mode.
1076     bool auth_all_OK = true;
1077     for (int i= 0; i<reqs_arr->nelts; i++) {
1078         auth_all_OK &= auth_OK[i];
1079     }
1080     if (auth_all_OK || !method_restricted)
1081         return shib_acl_true;
1082
1083     return (sta->m_dc->bAuthoritative != 0) ? shib_acl_false : shib_acl_indeterminate;
1084 }
1085
1086
1087 // Initial look at a request - create the per-request structure
1088 static int shib_post_read(request_rec *r)
1089 {
1090     shib_request_config* rc = init_request_config(r);
1091
1092     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_post_read");
1093
1094 #ifdef SHIB_DEFERRED_HEADERS
1095     rc->hdr_out = ap_make_table(r->pool, 5);
1096 #endif
1097     return DECLINED;
1098 }
1099
1100 // fixups: set environment vars
1101
1102 extern "C" int shib_fixups(request_rec* r)
1103 {
1104   shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1105   shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
1106   if (dc->bOff==1 || dc->bUseEnvVars==0)
1107     return DECLINED;
1108
1109   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
1110
1111   if (rc==NULL || rc->env==NULL || ap_is_empty_table(rc->env))
1112         return DECLINED;
1113
1114   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
1115   r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
1116
1117   return OK;
1118 }
1119
1120 #ifdef SHIB_APACHE_13
1121 /*
1122  * shib_child_exit()
1123  *  Cleanup the (per-process) pool info.
1124  */
1125 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1126 {
1127     if (g_Config) {
1128         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1129         g_Config->term();
1130         g_Config = NULL;
1131         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1132     }
1133 }
1134 #else
1135 /*
1136  * shib_exit()
1137  *  Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1138  */
1139 extern "C" apr_status_t shib_exit(void* data)
1140 {
1141     if (g_Config) {
1142         g_Config->term();
1143         g_Config = NULL;
1144     }
1145     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done");
1146     return OK;
1147 }
1148 #endif
1149
1150 /*
1151  * shire_child_init()
1152  *  Things to do when the child process is initialized.
1153  *  (or after the configs are read in apache-2)
1154  */
1155 #ifdef SHIB_APACHE_13
1156 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1157 #else
1158 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1159 #endif
1160 {
1161     // Initialize runtime components.
1162
1163     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1164
1165     if (g_Config) {
1166         ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1167         exit(1);
1168     }
1169
1170     g_Config=&SPConfig::getConfig();
1171     g_Config->setFeatures(
1172         SPConfig::Listener |
1173         SPConfig::Caching |
1174         SPConfig::RequestMapping |
1175         SPConfig::InProcess |
1176         SPConfig::Logging |
1177         SPConfig::Handlers
1178         );
1179     if (!g_Config->init(g_szSchemaDir)) {
1180         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1181         exit(1);
1182     }
1183     g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL,&htAccessFactory);
1184     g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER,&ApacheRequestMapFactory);
1185
1186     try {
1187         xercesc::DOMDocument* dummydoc=XMLToolingConfig::getConfig().getParser().newDocument();
1188         XercesJanitor<xercesc::DOMDocument> docjanitor(dummydoc);
1189         xercesc::DOMElement* dummy = dummydoc->createElementNS(NULL,path);
1190         auto_ptr_XMLCh src(g_szSHIBConfig);
1191         dummy->setAttributeNS(NULL,path,src.get());
1192         dummy->setAttributeNS(NULL,validate,xmlconstants::XML_ONE);
1193
1194         g_Config->setServiceProvider(g_Config->ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
1195         g_Config->getServiceProvider()->init();
1196     }
1197     catch (exception& ex) {
1198         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),ex.what());
1199         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1200         exit(1);
1201     }
1202
1203     ServiceProvider* sp=g_Config->getServiceProvider();
1204     xmltooling::Locker locker(sp);
1205     const PropertySet* props=sp->getPropertySet("Local");
1206     if (props) {
1207         pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
1208         if (unsetValue.first)
1209             g_unsetHeaderValue = unsetValue.second;
1210         pair<bool,bool> checkSpoofing=props->getBool("checkSpoofing");
1211         if (checkSpoofing.first && !checkSpoofing.second)
1212             g_checkSpoofing = false;
1213     }
1214
1215     // Set the cleanup handler
1216     apr_pool_cleanup_register(p, NULL, &shib_exit, apr_pool_cleanup_null);
1217
1218     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
1219 }
1220
1221 // Output filters
1222 #ifdef SHIB_DEFERRED_HEADERS
1223 static void set_output_filter(request_rec *r)
1224 {
1225    ap_add_output_filter("SHIB_HEADERS_OUT", NULL, r, r->connection);
1226 }
1227
1228 static void set_error_filter(request_rec *r)
1229 {
1230    ap_add_output_filter("SHIB_HEADERS_ERR", NULL, r, r->connection);
1231 }
1232
1233 static int _table_add(void *v, const char *key, const char *value)
1234 {
1235     apr_table_addn((apr_table_t*)v, key, value);
1236     return 1;
1237 }
1238
1239 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1240 {
1241     request_rec *r = f->r;
1242     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1243
1244     if (rc) {
1245         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);
1246         apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1247         // can't use overlap call because it will collapse Set-Cookie headers
1248         //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1249     }
1250
1251     /* remove ourselves from the filter chain */
1252     ap_remove_output_filter(f);
1253
1254     /* send the data up the stack */
1255     return ap_pass_brigade(f->next,in);
1256 }
1257
1258 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1259 {
1260     request_rec *r = f->r;
1261     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1262
1263     if (rc) {
1264         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);
1265         apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1266         // can't use overlap call because it will collapse Set-Cookie headers
1267         //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1268     }
1269
1270     /* remove ourselves from the filter chain */
1271     ap_remove_output_filter(f);
1272
1273     /* send the data up the stack */
1274     return ap_pass_brigade(f->next,in);
1275 }
1276 #endif // SHIB_DEFERRED_HEADERS
1277
1278 typedef const char* (*config_fn_t)(void);
1279
1280 #ifdef SHIB_APACHE_13
1281
1282 // SHIB Module commands
1283
1284 static command_rec shire_cmds[] = {
1285   {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1286    RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
1287   {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1288    RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1289   {"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1290    RSRC_CONF, TAKE1, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"},
1291
1292   {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1293    (void *) XtOffsetOf (shib_server_config, szScheme),
1294    RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1295
1296   {"ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1297    OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1298
1299   {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1300    (void *) XtOffsetOf (shib_dir_config, bOff),
1301    OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1302   {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1303    (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1304    OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1305   {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1306    (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1307    OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
1308   {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1309    (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1310    OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1311   {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1312    (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1313    OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1314   {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1315    (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1316    OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1317   {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1318    (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1319    OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1320   {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1321    (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1322    OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1323   {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1324    (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1325    OR_AUTHCFG, FLAG, "All require directives must match"},
1326   {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1327    (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1328    OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1329   {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1330    (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1331    OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1332   {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1333    (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1334    OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1335
1336   {NULL}
1337 };
1338
1339 extern "C"{
1340 handler_rec shib_handlers[] = {
1341   { "shib-handler", shib_handler },
1342   { NULL }
1343 };
1344
1345 module MODULE_VAR_EXPORT mod_shib = {
1346     STANDARD_MODULE_STUFF,
1347     NULL,                        /* initializer */
1348     create_shib_dir_config,     /* dir config creater */
1349     merge_shib_dir_config,      /* dir merger --- default is to override */
1350     create_shib_server_config, /* server config */
1351     merge_shib_server_config,   /* merge server config */
1352     shire_cmds,                 /* command table */
1353     shib_handlers,              /* handlers */
1354     NULL,                       /* filename translation */
1355     shib_check_user,            /* check_user_id */
1356     shib_auth_checker,          /* check auth */
1357     NULL,                       /* check access */
1358     NULL,                       /* type_checker */
1359     shib_fixups,                /* fixups */
1360     NULL,                       /* logger */
1361     NULL,                       /* header parser */
1362     shib_child_init,            /* child_init */
1363     shib_child_exit,            /* child_exit */
1364     shib_post_read              /* post read-request */
1365 };
1366
1367 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1368
1369 extern "C" void shib_register_hooks (apr_pool_t *p)
1370 {
1371 #ifdef SHIB_DEFERRED_HEADERS
1372   ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, NULL, AP_FTYPE_CONTENT_SET);
1373   ap_hook_insert_filter(set_output_filter, NULL, NULL, APR_HOOK_LAST);
1374   ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, NULL, AP_FTYPE_CONTENT_SET);
1375   ap_hook_insert_error_filter(set_error_filter, NULL, NULL, APR_HOOK_LAST);
1376   ap_hook_post_read_request(shib_post_read, NULL, NULL, APR_HOOK_MIDDLE);
1377 #endif
1378   ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1379   ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1380   ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1381   ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1382   ap_hook_fixups(shib_fixups, NULL, NULL, APR_HOOK_MIDDLE);
1383 }
1384
1385 // SHIB Module commands
1386
1387 extern "C" {
1388 static command_rec shib_cmds[] = {
1389     AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1390         RSRC_CONF, "Path to shibboleth.xml config file"),
1391     AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1392         RSRC_CONF, "Paths of XML schema catalogs"),
1393     AP_INIT_TAKE1("ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1394         RSRC_CONF, "Paths of XML schema catalogs (deprecated in favor of ShibCatalogs)"),
1395
1396     AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1397         (void *) offsetof (shib_server_config, szScheme),
1398         RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1399
1400     AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, NULL,
1401         OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
1402
1403     AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1404         (void *) offsetof (shib_dir_config, bOff),
1405         OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1406     AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1407         (void *) offsetof (shib_dir_config, szApplicationId),
1408         OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1409     AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1410         (void *) offsetof (shib_dir_config, bBasicHijack),
1411         OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1412     AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1413         (void *) offsetof (shib_dir_config, bRequireSession),
1414         OR_AUTHCFG, "Initiates a new session if one does not exist"),
1415     AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1416         (void *) offsetof (shib_dir_config, szRequireWith),
1417         OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1418     AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1419         (void *) offsetof (shib_dir_config, bExportAssertion),
1420         OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1421     AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1422         (void *) offsetof (shib_dir_config, szRedirectToSSL),
1423         OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1424     AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1425         (void *) offsetof (shib_dir_config, szAuthGrpFile),
1426         OR_AUTHCFG, "Text file containing group names and member user IDs"),
1427     AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1428         (void *) offsetof (shib_dir_config, bRequireAll),
1429         OR_AUTHCFG, "All require directives must match"),
1430     AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1431         (void *) offsetof (shib_dir_config, bAuthoritative),
1432         OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
1433     AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1434         (void *) offsetof (shib_dir_config, bUseEnvVars),
1435         OR_AUTHCFG, "Export attributes using environment variables (default)"),
1436     AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1437         (void *) offsetof (shib_dir_config, bUseHeaders),
1438         OR_AUTHCFG, "Export attributes using custom HTTP headers"),
1439
1440     {NULL}
1441 };
1442
1443 module AP_MODULE_DECLARE_DATA mod_shib = {
1444     STANDARD20_MODULE_STUFF,
1445     create_shib_dir_config,     /* create dir config */
1446     merge_shib_dir_config,      /* merge dir config --- default is to override */
1447     create_shib_server_config,  /* create server config */
1448     merge_shib_server_config,   /* merge server config */
1449     shib_cmds,                  /* command table */
1450     shib_register_hooks         /* register hooks */
1451 };
1452
1453 #else
1454 #error "unsupported Apache version"
1455 #endif
1456
1457 }