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