apache/mod_apache.cpp

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