apache/mod_apache.cpp

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * mod_apache.cpp
  23  *
  24  * Apache module implementation.
  25  */
  26
  27 #define SHIBSP_LITE
  28
  29 #ifdef SOLARIS2
  30 #undef _XOPEN_SOURCE    // causes gethostname conflict in unistd.h
  31 #endif
  32
  33 #ifdef WIN32
  34 # define _CRT_NONSTDC_NO_DEPRECATE 1
  35 # define _CRT_SECURE_NO_DEPRECATE 1
  36 #endif
  37
  38 #include <shibsp/exceptions.h>
  39 #include <shibsp/AbstractSPRequest.h>
  40 #include <shibsp/AccessControl.h>
  41 #include <shibsp/GSSRequest.h>
  42 #include <shibsp/RequestMapper.h>
  43 #include <shibsp/SPConfig.h>
  44 #include <shibsp/ServiceProvider.h>
  45 #include <shibsp/SessionCache.h>
  46 #include <shibsp/attribute/Attribute.h>
  47
  48 #include <xercesc/util/XMLUniDefs.hpp>
  49 #include <xercesc/util/regx/RegularExpression.hpp>
  50 #include <xmltooling/XMLToolingConfig.h>
  51 #include <xmltooling/util/NDC.h>
  52 #include <xmltooling/util/ParserPool.h>
  53 #include <xmltooling/util/Threads.h>
  54 #include <xmltooling/util/XMLConstants.h>
  55 #include <xmltooling/util/XMLHelper.h>
  56
  57 #ifdef WIN32
  58 # include <winsock2.h>
  59 # include <ws2tcpip.h>
  60 #endif
  61
  62 #undef _XPG4_2
  63
  64 #include <set>
  65 #include <memory>
  66 #include <fstream>
  67 #include <stdexcept>
  68 #include <boost/lexical_cast.hpp>
  69
  70 // Apache specific header files
  71 #include <httpd.h>
  72 #include <http_config.h>
  73 #include <http_protocol.h>
  74 #include <http_main.h>
  75 #define CORE_PRIVATE
  76 #include <http_core.h>
  77 #include <http_log.h>
  78 #include <http_request.h>
  79
  80 #ifndef SHIB_APACHE_13
  81 #include <apr_buckets.h>
  82 #include <apr_strings.h>
  83 #include <apr_pools.h>
  84 #endif
  85
  86 #ifdef SHIB_APACHE_24
  87 #include <mod_auth.h>
  88 #endif
  89
  90 #include <cstddef>
  91 #ifdef HAVE_UNISTD_H
  92 #include <unistd.h>             // for getpid()
  93 #endif
  94
  95 using namespace shibsp;
  96 using namespace xmltooling;
  97 using namespace boost;
  98 using namespace std;
  99 using xercesc::RegularExpression;
 100 using xercesc::XMLException;
 101
 102 #ifdef APLOG_USE_MODULE
 103     extern "C" module AP_MODULE_DECLARE_DATA mod_shib;
 104     static int* const aplog_module_index = &(mod_shib.module_index);
 105 #else
 106     extern "C" module MODULE_VAR_EXPORT mod_shib;
 107 #endif
 108
 109 namespace {
 110     char* g_szSHIBConfig = nullptr;
 111     char* g_szSchemaDir = nullptr;
 112     char* g_szPrefix = nullptr;
 113     SPConfig* g_Config = nullptr;
 114     string g_unsetHeaderValue,g_spoofKey;
 115     bool g_checkSpoofing = true;
 116     bool g_catchAll = false;
 117 #ifndef SHIB_APACHE_13
 118     char* g_szGSSContextKey = "mod_auth_gssapi:gss_ctx";
 119 #endif
 120     static const char* g_UserDataKey = "urn:mace:shibboleth:Apache:shib_check_user";
 121 }
 122
 123 /* Apache 2.2.x headers must be accumulated and set in the output filter.
 124    Apache 2.0.49+ supports the filter method.
 125    Apache 1.3.x and lesser 2.0.x must write the headers directly. */
 126
 127 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22) || defined(SHIB_APACHE_24)) && AP_MODULE_MAGIC_AT_LEAST(20020903,6)
 128 #define SHIB_DEFERRED_HEADERS
 129 #endif
 130
 131 /********************************************************************************/
 132 // Basic Apache Configuration code.
 133 //
 134
 135 // per-server module configuration structure
 136 struct shib_server_config
 137 {
 138     char* szScheme;
 139 };
 140
 141 // creates the per-server configuration
 142 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
 143 {
 144     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
 145     sc->szScheme = nullptr;
 146     return sc;
 147 }
 148
 149 // overrides server configuration in virtual servers
 150 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
 151 {
 152     shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
 153     shib_server_config* parent=(shib_server_config*)base;
 154     shib_server_config* child=(shib_server_config*)sub;
 155
 156     if (child->szScheme)
 157         sc->szScheme=ap_pstrdup(p,child->szScheme);
 158     else if (parent->szScheme)
 159         sc->szScheme=ap_pstrdup(p,parent->szScheme);
 160     else
 161         sc->szScheme=nullptr;
 162
 163     return sc;
 164 }
 165
 166 // per-dir module configuration structure
 167 struct shib_dir_config
 168 {
 169     SH_AP_TABLE* tSettings; // generic table of extensible settings
 170
 171     // RM Configuration
 172 #ifdef SHIB_APACHE_24
 173     int bRequestMapperAuthz;// support RequestMapper AccessControl plugins
 174 #else
 175     char* szAuthGrpFile;    // Auth GroupFile name
 176         char* szAccessControl;  // path to "external" AccessControl plugin file
 177     int bRequireAll;        // all "known" require directives must match, otherwise OR logic
 178     int bAuthoritative;     // allow htaccess plugin to DECLINE when authz fails
 179     int bCompatWith24;      // support 2.4-reserved require logic for compatibility
 180 #endif
 181
 182     // Content Configuration
 183     char* szApplicationId;  // Shib applicationId value
 184     char* szRequireWith;    // require a session using a specific initiator?
 185     char* szRedirectToSSL;  // redirect non-SSL requests to SSL port
 186     int bOff;               // flat-out disable all Shib processing
 187     int bBasicHijack;       // activate for AuthType Basic?
 188     int bRequireSession;    // require a session?
 189     int bExportAssertion;   // export SAML assertion to the environment?
 190     int bUseEnvVars;        // use environment?
 191     int bUseHeaders;        // use headers?
 192     int bExpireRedirects;   // expire redirects?
 193 };
 194
 195 // creates per-directory config structure
 196 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
 197 {
 198     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
 199     dc->tSettings = nullptr;
 200 #ifdef SHIB_APACHE_24
 201     dc->bRequestMapperAuthz = -1;
 202 #else
 203     dc->szAuthGrpFile = nullptr;
 204         dc->szAccessControl = nullptr;
 205     dc->bRequireAll = -1;
 206     dc->bAuthoritative = -1;
 207     dc->bCompatWith24 = -1;
 208 #endif
 209     dc->szApplicationId = nullptr;
 210     dc->szRequireWith = nullptr;
 211     dc->szRedirectToSSL = nullptr;
 212     dc->bOff = -1;
 213     dc->bBasicHijack = -1;
 214     dc->bRequireSession = -1;
 215     dc->bExportAssertion = -1;
 216     dc->bUseEnvVars = -1;
 217     dc->bUseHeaders = -1;
 218     dc->bExpireRedirects = -1;
 219     return dc;
 220 }
 221
 222 // overrides server configuration in directories
 223 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
 224 {
 225     shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
 226     shib_dir_config* parent=(shib_dir_config*)base;
 227     shib_dir_config* child=(shib_dir_config*)sub;
 228
 229     // The child supersedes any matching table settings in the parent.
 230     dc->tSettings = nullptr;
 231     if (parent->tSettings)
 232         dc->tSettings = ap_copy_table(p, parent->tSettings);
 233     if (child->tSettings) {
 234         if (dc->tSettings)
 235             ap_overlap_tables(dc->tSettings, child->tSettings, AP_OVERLAP_TABLES_SET);
 236         else
 237             dc->tSettings = ap_copy_table(p, child->tSettings);
 238     }
 239
 240 #ifdef SHIB_APACHE_24
 241     dc->bRequestMapperAuthz = ((child->bRequestMapperAuthz==-1) ? parent->bRequestMapperAuthz : child->bRequestMapperAuthz);
 242 #else
 243     if (child->szAuthGrpFile)
 244         dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
 245     else if (parent->szAuthGrpFile)
 246         dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
 247     else
 248         dc->szAuthGrpFile=nullptr;
 249
 250         if (child->szAccessControl)
 251         dc->szAccessControl=ap_pstrdup(p,child->szAccessControl);
 252     else if (parent->szAccessControl)
 253         dc->szAccessControl=ap_pstrdup(p,parent->szAccessControl);
 254     else
 255         dc->szAccessControl=nullptr;
 256 #endif
 257
 258     if (child->szApplicationId)
 259         dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
 260     else if (parent->szApplicationId)
 261         dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
 262     else
 263         dc->szApplicationId=nullptr;
 264
 265     if (child->szRequireWith)
 266         dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
 267     else if (parent->szRequireWith)
 268         dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
 269     else
 270         dc->szRequireWith=nullptr;
 271
 272     if (child->szRedirectToSSL)
 273         dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
 274     else if (parent->szRedirectToSSL)
 275         dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
 276     else
 277         dc->szRedirectToSSL=nullptr;
 278
 279     dc->bOff = ((child->bOff==-1) ? parent->bOff : child->bOff);
 280     dc->bBasicHijack = ((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
 281     dc->bRequireSession = ((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
 282     dc->bExportAssertion = ((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
 283 #ifndef SHIB_APACHE_24
 284     dc->bRequireAll = ((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
 285     dc->bAuthoritative = ((child->bAuthoritative==-1) ? parent->bAuthoritative : child->bAuthoritative);
 286     dc->bCompatWith24 = ((child->bCompatWith24==-1) ? parent->bCompatWith24 : child->bCompatWith24);
 287 #endif
 288     dc->bUseEnvVars = ((child->bUseEnvVars==-1) ? parent->bUseEnvVars : child->bUseEnvVars);
 289     dc->bUseHeaders = ((child->bUseHeaders==-1) ? parent->bUseHeaders : child->bUseHeaders);
 290     dc->bExpireRedirects = ((child->bExpireRedirects==-1) ? parent->bExpireRedirects : child->bExpireRedirects);
 291     return dc;
 292 }
 293
 294 class ShibTargetApache; // forward decl
 295
 296 // per-request module structure
 297 struct shib_request_config
 298 {
 299     SH_AP_TABLE* env;        // environment vars
 300 #ifdef SHIB_DEFERRED_HEADERS
 301     SH_AP_TABLE* hdr_out;    // headers to browser
 302 #endif
 303 #ifndef SHIB_APACHE_13
 304     ShibTargetApache* sta;  // SP per-request structure wrapped around Apache's request
 305 #endif
 306 };
 307
 308 // create a request record
 309 static shib_request_config* init_request_config(request_rec *r)
 310 {
 311     shib_request_config* rc = (shib_request_config*)ap_pcalloc(r->pool,sizeof(shib_request_config));
 312     memset(rc, 0, sizeof(shib_request_config));
 313     ap_set_module_config(r->request_config, &mod_shib, rc);
 314     ap_log_rerror(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, SH_AP_R(r), "shib_init_rc");
 315     return rc;
 316 }
 317
 318 class ShibTargetApache : public AbstractSPRequest
 319 #if defined(SHIBSP_HAVE_GSSAPI) && !defined(SHIB_APACHE_13)
 320     , public GSSRequest
 321 #endif
 322 {
 323   mutable string m_body;
 324   mutable bool m_gotBody,m_firsttime;
 325   mutable vector<string> m_certs;
 326   set<string> m_allhttp;
 327
 328 public:
 329   bool m_handler;
 330   request_rec* m_req;
 331   shib_dir_config* m_dc;
 332   shib_server_config* m_sc;
 333   shib_request_config* m_rc;
 334
 335   ShibTargetApache(request_rec* req) : AbstractSPRequest(SHIBSP_LOGCAT".Apache"),
 336         m_gotBody(false),m_firsttime(true), m_handler(false), m_req(req), m_dc(nullptr), m_sc(nullptr), m_rc(nullptr) {
 337   }
 338   virtual ~ShibTargetApache() {}
 339
 340   bool isInitialized() const {
 341       return (m_sc != nullptr);
 342   }
 343
 344   bool init(bool handler, bool check_user) {
 345     m_handler = handler;
 346     if (m_sc)
 347         return !check_user; // only initialize once
 348     m_sc = (shib_server_config*)ap_get_module_config(m_req->server->module_config, &mod_shib);
 349     m_dc = (shib_dir_config*)ap_get_module_config(m_req->per_dir_config, &mod_shib);
 350     m_rc = (shib_request_config*)ap_get_module_config(m_req->request_config, &mod_shib);
 351
 352     setRequestURI(m_req->unparsed_uri);
 353
 354     if (check_user && m_dc->bUseHeaders == 1) {
 355         // Try and see if this request was already processed, to skip spoof checking.
 356         if (!ap_is_initial_req(m_req)) {
 357             m_firsttime = false;
 358         }
 359         else if (!g_spoofKey.empty()) {
 360             const char* hdr = ap_table_get(m_req->headers_in, "Shib-Spoof-Check");
 361             if (hdr && g_spoofKey == hdr)
 362                 m_firsttime = false;
 363         }
 364         if (!m_firsttime)
 365             log(SPDebug, "shib_check_user running more than once");
 366     }
 367     return true;
 368   }
 369
 370   const char* getScheme() const {
 371     return m_sc->szScheme ? m_sc->szScheme : ap_http_method(m_req);
 372   }
 373   bool isSecure() const {
 374       return HTTPRequest::isSecure();
 375   }
 376   const char* getHostname() const {
 377     return ap_get_server_name(m_req);
 378   }
 379   int getPort() const {
 380     return ap_get_server_port(m_req);
 381   }
 382   const char* getMethod() const {
 383     return m_req->method;
 384   }
 385   string getContentType() const {
 386     const char* type = ap_table_get(m_req->headers_in, "Content-Type");
 387     return type ? type : "";
 388   }
 389   long getContentLength() const {
 390       return m_gotBody ? m_body.length() : m_req->remaining;
 391   }
 392   string getRemoteAddr() const {
 393     string ret = AbstractSPRequest::getRemoteAddr();
 394     if (!ret.empty())
 395         return ret;
 396 #ifdef SHIB_APACHE_24
 397     return m_req->useragent_ip;
 398 #else
 399     return m_req->connection->remote_ip;
 400 #endif
 401   }
 402   void log(SPLogLevel level, const string& msg) const {
 403     AbstractSPRequest::log(level,msg);
 404     ap_log_rerror(
 405         APLOG_MARK,
 406         (level == SPDebug ? APLOG_DEBUG :
 407         (level == SPInfo ? APLOG_INFO :
 408         (level == SPWarn ? APLOG_WARNING :
 409         (level == SPError ? APLOG_ERR : APLOG_CRIT))))|APLOG_NOERRNO,
 410         SH_AP_R(m_req),
 411         "%s",
 412         msg.c_str()
 413         );
 414   }
 415   const char* getQueryString() const { return m_req->args; }
 416   const char* getRequestBody() const {
 417     if (m_gotBody || m_req->method_number==M_GET)
 418         return m_body.c_str();
 419 #ifdef SHIB_APACHE_13
 420     // Read the posted data
 421     if (ap_setup_client_block(m_req, REQUEST_CHUNKED_DECHUNK) != OK) {
 422         m_gotBody=true;
 423         log(SPError, "Apache function (setup_client_block) failed while reading request body.");
 424         return m_body.c_str();
 425     }
 426     if (!ap_should_client_block(m_req)) {
 427         m_gotBody=true;
 428         log(SPError, "Apache function (should_client_block) failed while reading request body.");
 429         return m_body.c_str();
 430     }
 431     if (m_req->remaining > 1024*1024)
 432         throw opensaml::SecurityPolicyException("Blocked request body larger than 1M size limit.");
 433     m_gotBody=true;
 434     int len;
 435     char buff[HUGE_STRING_LEN];
 436     ap_hard_timeout("[mod_shib] getRequestBody", m_req);
 437     while ((len=ap_get_client_block(m_req, buff, sizeof(buff))) > 0) {
 438       ap_reset_timeout(m_req);
 439       m_body.append(buff, len);
 440     }
 441     ap_kill_timeout(m_req);
 442 #else
 443     const char *data;
 444     apr_size_t len;
 445     int seen_eos = 0;
 446     apr_bucket_brigade* bb = apr_brigade_create(m_req->pool, m_req->connection->bucket_alloc);
 447     do {
 448         apr_bucket *bucket;
 449         apr_status_t rv = ap_get_brigade(m_req->input_filters, bb, AP_MODE_READBYTES, APR_BLOCK_READ, HUGE_STRING_LEN);
 450         if (rv != APR_SUCCESS) {
 451             log(SPError, "Apache function (ap_get_brigade) failed while reading request body.");
 452             break;
 453         }
 454
 455         for (bucket = APR_BRIGADE_FIRST(bb); bucket != APR_BRIGADE_SENTINEL(bb); bucket = APR_BUCKET_NEXT(bucket)) {
 456             if (APR_BUCKET_IS_EOS(bucket)) {
 457                 seen_eos = 1;
 458                 break;
 459             }
 460
 461             /* We can't do much with this. */
 462             if (APR_BUCKET_IS_FLUSH(bucket))
 463                 continue;
 464
 465             /* read */
 466             apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
 467             if (len > 0)
 468                 m_body.append(data, len);
 469         }
 470         apr_brigade_cleanup(bb);
 471     } while (!seen_eos);
 472     apr_brigade_destroy(bb);
 473     m_gotBody=true;
 474 #endif
 475     return m_body.c_str();
 476   }
 477   const char* getParameter(const char* name) const {
 478       return AbstractSPRequest::getParameter(name);
 479   }
 480   vector<const char*>::size_type getParameters(const char* name, vector<const char*>& values) const {
 481       return AbstractSPRequest::getParameters(name, values);
 482   }
 483   void clearHeader(const char* rawname, const char* cginame) {
 484     if (m_dc->bUseHeaders == 1) {
 485        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_clear_header: hdr\n");
 486         if (g_checkSpoofing && m_firsttime) {
 487             if (m_allhttp.empty()) {
 488                 // First time, so populate set with "CGI" versions of client-supplied headers.
 489 #ifdef SHIB_APACHE_13
 490                 array_header *hdrs_arr = ap_table_elts(m_req->headers_in);
 491                 table_entry *hdrs = (table_entry *) hdrs_arr->elts;
 492 #else
 493                 const apr_array_header_t *hdrs_arr = apr_table_elts(m_req->headers_in);
 494                 const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
 495 #endif
 496                 for (int i = 0; i < hdrs_arr->nelts; ++i) {
 497                     if (!hdrs[i].key)
 498                         continue;
 499                     string cgiversion("HTTP_");
 500                     const char* pch = hdrs[i].key;
 501                     while (*pch) {
 502                         cgiversion += (isalnum(*pch) ? toupper(*pch) : '_');
 503                         pch++;
 504                     }
 505                     m_allhttp.insert(cgiversion);
 506                 }
 507             }
 508
 509             if (m_allhttp.count(cginame) > 0)
 510                 throw opensaml::SecurityPolicyException("Attempt to spoof header ($1) was detected.", params(1, rawname));
 511         }
 512         ap_table_unset(m_req->headers_in, rawname);
 513         ap_table_set(m_req->headers_in, rawname, g_unsetHeaderValue.c_str());
 514     }
 515   }
 516   void setHeader(const char* name, const char* value) {
 517     if (m_dc->bUseEnvVars != 0) {
 518        if (!m_rc) {
 519           // this happens on subrequests
 520           // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_setheader: no_m_rc\n");
 521           m_rc = init_request_config(m_req);
 522        }
 523        if (!m_rc->env)
 524            m_rc->env = ap_make_table(m_req->pool, 10);
 525        // ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(m_req), "shib_set_env: %s=%s\n", name, value?value:"Null");
 526        ap_table_set(m_rc->env, name, value ? value : "");
 527     }
 528     if (m_dc->bUseHeaders == 1)
 529        ap_table_set(m_req->headers_in, name, value);
 530   }
 531   string getHeader(const char* name) const {
 532     const char* hdr = ap_table_get(m_req->headers_in, name);
 533     return string(hdr ? hdr : "");
 534   }
 535   string getSecureHeader(const char* name) const {
 536     if (m_dc->bUseEnvVars != 0) {
 537        const char *hdr;
 538        if (m_rc && m_rc->env)
 539            hdr = ap_table_get(m_rc->env, name);
 540        else
 541            hdr = nullptr;
 542        return string(hdr ? hdr : "");
 543     }
 544     return getHeader(name);
 545   }
 546   void setRemoteUser(const char* user) {
 547       SH_AP_USER(m_req) = user ? ap_pstrdup(m_req->pool, user) : nullptr;
 548       if (m_dc->bUseHeaders == 1) {
 549           if (user) {
 550               ap_table_set(m_req->headers_in, "REMOTE_USER", user);
 551           }
 552           else {
 553               ap_table_unset(m_req->headers_in, "REMOTE_USER");
 554               ap_table_set(m_req->headers_in, "REMOTE_USER", g_unsetHeaderValue.c_str());
 555           }
 556       }
 557   }
 558   string getRemoteUser() const {
 559     return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
 560   }
 561   void setAuthType(const char* authtype) {
 562       if (authtype && m_dc->bBasicHijack == 1)
 563           authtype = "Basic";
 564       SH_AP_AUTH_TYPE(m_req) = authtype ? ap_pstrdup(m_req->pool, authtype) : nullptr;
 565   }
 566   string getAuthType() const {
 567     return string(SH_AP_AUTH_TYPE(m_req) ? SH_AP_AUTH_TYPE(m_req) : "");
 568   }
 569   void setContentType(const char* type) {
 570       m_req->content_type = ap_psprintf(m_req->pool, "%s", type);
 571   }
 572   void setResponseHeader(const char* name, const char* value) {
 573    HTTPResponse::setResponseHeader(name, value);
 574 #ifdef SHIB_DEFERRED_HEADERS
 575    if (!m_rc)
 576       // this happens on subrequests
 577       m_rc = init_request_config(m_req);
 578     if (m_handler) {
 579         if (!m_rc->hdr_out)
 580             m_rc->hdr_out = ap_make_table(m_req->pool, 5);
 581         ap_table_add(m_rc->hdr_out, name, value);
 582     }
 583     else
 584 #endif
 585     ap_table_add(m_req->err_headers_out, name, value);
 586   }
 587   long sendResponse(istream& in, long status) {
 588     if (status != XMLTOOLING_HTTP_STATUS_OK)
 589         m_req->status = status;
 590     ap_send_http_header(m_req);
 591     char buf[1024];
 592     while (in) {
 593         in.read(buf,1024);
 594         ap_rwrite(buf,in.gcount(),m_req);
 595     }
 596 #if (defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22) || defined(SHIB_APACHE_24))
 597     if (status != XMLTOOLING_HTTP_STATUS_OK && status != XMLTOOLING_HTTP_STATUS_ERROR)
 598         return status;
 599 #endif
 600     return DONE;
 601   }
 602   long sendRedirect(const char* url) {
 603     HTTPResponse::sendRedirect(url);
 604     ap_table_set(m_req->headers_out, "Location", url);
 605     if (m_dc->bExpireRedirects != 0) {
 606         ap_table_set(m_req->err_headers_out, "Expires", "Wed, 01 Jan 1997 12:00:00 GMT");
 607         ap_table_set(m_req->err_headers_out, "Cache-Control", "private,no-store,no-cache,max-age=0");
 608     }
 609     return REDIRECT;
 610   }
 611   const vector<string>& getClientCertificates() const {
 612       if (m_certs.empty()) {
 613           const char* cert = ap_table_get(m_req->subprocess_env, "SSL_CLIENT_CERT");
 614           if (cert)
 615               m_certs.push_back(cert);
 616           int i = 0;
 617           do {
 618               cert = ap_table_get(m_req->subprocess_env, ap_psprintf(m_req->pool, "SSL_CLIENT_CERT_CHAIN_%d", i++));
 619               if (cert)
 620                   m_certs.push_back(cert);
 621           } while (cert);
 622       }
 623       return m_certs;
 624   }
 625   long returnDecline(void) { return DECLINED; }
 626   long returnOK(void) { return OK; }
 627 #if defined(SHIBSP_HAVE_GSSAPI) && !defined(SHIB_APACHE_13)
 628   gss_ctx_id_t getGSSContext() const {
 629     gss_ctx_id_t ctx = GSS_C_NO_CONTEXT;
 630     apr_pool_userdata_get((void**)&ctx, g_szGSSContextKey, m_req->pool);
 631     return ctx;
 632   }
 633 #endif
 634 };
 635
 636 /********************************************************************************/
 637 // Apache hooks
 638
 639 #ifndef SHIB_APACHE_13
 640 extern "C" apr_status_t shib_request_cleanup(void* r)
 641 {
 642     if (r)
 643         delete reinterpret_cast<ShibTargetApache*>(r);
 644     return APR_SUCCESS;
 645 }
 646 #endif
 647
 648 // Initial look at a request - create the per-request structure
 649 static int shib_post_read(request_rec *r)
 650 {
 651     shib_request_config* rc = init_request_config(r);
 652 #ifdef SHIB_APACHE_24
 653     rc->sta = new ShibTargetApache(r);
 654     apr_pool_cleanup_register(r->pool, rc->sta, shib_request_cleanup, apr_pool_cleanup_null);
 655 #endif
 656     return DECLINED;
 657 }
 658
 659 // Performs authentication and enforce session requirements.
 660 // Also does header/env export from session, and will dispatch
 661 // SP handler requests if it detects a handler URL.
 662 extern "C" int shib_check_user(request_rec* r)
 663 {
 664     // Short-circuit entirely?
 665     if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff == 1)
 666         return DECLINED;
 667
 668     ap_log_rerror(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user(%d): ENTER", (int)getpid());
 669
 670     string threadid("[");
 671     threadid += lexical_cast<string>(getpid()) + "] shib_check_user";
 672     xmltooling::NDC ndc(threadid.c_str());
 673
 674     try {
 675 #ifndef SHIB_APACHE_24
 676         ShibTargetApache sta(r);
 677         ShibTargetApache* psta = &sta;
 678 #else
 679         shib_request_config* rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
 680         if (!rc || !rc->sta) {
 681             ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user found no per-request structure");
 682             return SERVER_ERROR;
 683         }
 684         ShibTargetApache* psta = rc->sta;
 685 #endif
 686         if (!psta->init(false, true)) {
 687             ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user unable to initialize SP request object");
 688             return SERVER_ERROR;
 689         }
 690
 691         // Check user authentication and export information, then set the handler bypass
 692         pair<bool,long> res = psta->getServiceProvider().doAuthentication(*psta, true);
 693         apr_pool_userdata_setn((const void*)42,g_UserDataKey,nullptr,r->pool);
 694         // If directed, install a spoof key to recognize when we've already cleared headers.
 695         if (!g_spoofKey.empty() && (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bUseHeaders==1))
 696             ap_table_set(r->headers_in, "Shib-Spoof-Check", g_spoofKey.c_str());
 697         if (res.first) {
 698 #ifdef SHIB_APACHE_24
 699             // This is insane, but Apache's internal request.c logic insists that an auth module
 700             // returning OK MUST set r->user to avoid a failure. But they check for NULL and not
 701             // for an empty string. If this turns out to cause trouble, there's no solution except
 702             // to set a dummy ID any time it's not set.
 703             if (res.second == OK && !r->user)
 704                 r->user = "";
 705 #endif
 706             return res.second;
 707         }
 708
 709         // user auth was okay -- export the session data now
 710         res = psta->getServiceProvider().doExport(*psta);
 711         if (res.first) {
 712 #ifdef SHIB_APACHE_24
 713             // See above for explanation of this hack.
 714             if (res.second == OK && !r->user)
 715                 r->user = "";
 716 #endif
 717             return res.second;
 718         }
 719
 720 #ifdef SHIB_APACHE_24
 721         // See above for explanation of this hack.
 722         if (!r->user)
 723             r->user = "";
 724 #endif
 725         return OK;
 726     }
 727     catch (std::exception& e) {
 728         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
 729         return SERVER_ERROR;
 730     }
 731     catch (...) {
 732         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an unknown exception!");
 733         if (g_catchAll)
 734             return SERVER_ERROR;
 735         throw;
 736     }
 737 }
 738
 739 // Runs SP handler requests when invoked directly.
 740 extern "C" int shib_handler(request_rec* r)
 741 {
 742     // Short-circuit entirely?
 743     if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff == 1)
 744         return DECLINED;
 745
 746     string threadid("[");
 747     threadid += lexical_cast<string>(getpid()) + "] shib_handler";
 748     xmltooling::NDC ndc(threadid.c_str());
 749
 750 #ifndef SHIB_APACHE_13
 751     // With 2.x, this handler always runs, though last.
 752     // We check if shib_check_user ran, because it will detect a handler request
 753     // and dispatch it directly.
 754     void* data;
 755     apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
 756     if (data==(const void*)42) {
 757         ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
 758         return DECLINED;
 759     }
 760 #endif
 761
 762     ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
 763
 764     try {
 765 #ifndef SHIB_APACHE_24
 766         ShibTargetApache sta(r);
 767         ShibTargetApache* psta = &sta;
 768 #else
 769         shib_request_config* rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
 770         if (!rc || !rc->sta) {
 771             ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler found no per-request structure");
 772             return SERVER_ERROR;
 773         }
 774         ShibTargetApache* psta = rc->sta;
 775 #endif
 776         if (!psta->init(true, false)) {
 777             ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler unable to initialize SP request object");
 778             return SERVER_ERROR;
 779         }
 780
 781         pair<bool,long> res = psta->getServiceProvider().doHandler(*psta);
 782         if (res.first) return res.second;
 783
 784         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
 785         return SERVER_ERROR;
 786     }
 787     catch (std::exception& e) {
 788         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
 789         return SERVER_ERROR;
 790     }
 791     catch (...) {
 792         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an unknown exception!");
 793         if (g_catchAll)
 794           return SERVER_ERROR;
 795         throw;
 796     }
 797 }
 798
 799 // This performs authorization functions to limit access.
 800 // On all versions, this runs any RequestMap-attached plugins.
 801 // For pre-2.4 versions, the RequestMap will always find an htAccess plugin
 802 // that runs code to parse and enforce Apache Require rules.
 803 // On 2.4, we have to short-circuit that and let Apache run callbacks
 804 // for each Require rule we handle.
 805 extern "C" int shib_auth_checker(request_rec* r)
 806 {
 807     // Short-circuit entirely?
 808     shib_dir_config* dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
 809     if (dc->bOff == 1
 810 #ifdef SHIB_APACHE_24
 811         || dc->bRequestMapperAuthz == 0     // this allows for bypass of the full auth_checker hook if only htaccess is used
 812 #endif
 813         ) {
 814         return DECLINED;
 815     }
 816
 817     ap_log_rerror(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
 818
 819     string threadid("[");
 820     threadid += lexical_cast<string>(getpid()) + "] shib_auth_checker";
 821     xmltooling::NDC ndc(threadid.c_str());
 822
 823     try {
 824 #ifndef SHIB_APACHE_24
 825         ShibTargetApache sta(r);
 826         ShibTargetApache* psta = &sta;
 827 #else
 828         shib_request_config* rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
 829         if (!rc || !rc->sta) {
 830             ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker found no per-request structure");
 831             return SERVER_ERROR;
 832         }
 833         ShibTargetApache* psta = rc->sta;
 834 #endif
 835         if (!psta->init(false, false)) {
 836             ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker unable to initialize SP request object");
 837             return SERVER_ERROR;
 838         }
 839
 840         pair<bool,long> res = psta->getServiceProvider().doAuthorization(*psta);
 841         if (res.first) return res.second;
 842
 843         // The SP method should always return true, so if we get this far, something unusual happened.
 844         // Just let Apache (or some other module) decide what to do.
 845         return DECLINED;
 846     }
 847     catch (std::exception& e) {
 848         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
 849         return SERVER_ERROR;
 850     }
 851     catch (...) {
 852         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an unknown exception!");
 853         if (g_catchAll)
 854           return SERVER_ERROR;
 855         throw;
 856     }
 857 }
 858
 859 // Overlays environment variables on top of subprocess table.
 860 extern "C" int shib_fixups(request_rec* r)
 861 {
 862   shib_dir_config *dc = (shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib);
 863   if (dc->bOff==1 || dc->bUseEnvVars==0)
 864     return DECLINED;
 865
 866   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup(%d): ENTER", (int)getpid());
 867
 868   shib_request_config *rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
 869   if (rc==nullptr || rc->env==nullptr || ap_is_empty_table(rc->env))
 870         return DECLINED;
 871
 872   ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_fixup adding %d vars", ap_table_elts(rc->env)->nelts);
 873   r->subprocess_env = ap_overlay_tables(r->pool, r->subprocess_env, rc->env);
 874
 875   return OK;
 876 }
 877
 878
 879 // Access control plugin that enforces pre-2.4 htaccess rules.
 880 // Post-2.4, we have to register individual methods to respond
 881 // to each require rule we want to handle, and have those call
 882 // into these methods directly.
 883 class htAccessControl : virtual public AccessControl
 884 {
 885 public:
 886     htAccessControl() {}
 887     ~htAccessControl() {}
 888     Lockable* lock() {return this;}
 889     void unlock() {}
 890     aclresult_t authorized(const SPRequest& request, const Session* session) const;
 891
 892     aclresult_t doAccessControl(const ShibTargetApache& sta, const Session* session, const char* plugin) const;
 893     aclresult_t doUser(const ShibTargetApache& sta, const char* params) const;
 894 #ifndef SHIB_APACHE_24
 895     aclresult_t doGroup(const ShibTargetApache& sta, const char* params) const;
 896 #endif
 897     aclresult_t doAuthnContext(const ShibTargetApache& sta, const char* acRef, const char* params) const;
 898     aclresult_t doShibAttr(const ShibTargetApache& sta, const Session* session, const char* rule, const char* params) const;
 899
 900 private:
 901     bool checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const;
 902 };
 903
 904 AccessControl* htAccessFactory(const xercesc::DOMElement* const & e)
 905 {
 906     return new htAccessControl();
 907 }
 908
 909 AccessControl::aclresult_t htAccessControl::doAccessControl(const ShibTargetApache& sta, const Session* session, const char* plugin) const
 910 {
 911         aclresult_t result = shib_acl_false;
 912         try {
 913         ifstream aclfile(plugin);
 914         if (!aclfile)
 915             throw ConfigurationException("Unable to open access control file ($1).", params(1, plugin));
 916         xercesc::DOMDocument* acldoc = XMLToolingConfig::getConfig().getParser().parse(aclfile);
 917                 XercesJanitor<xercesc::DOMDocument> docjanitor(acldoc);
 918                 static XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
 919         string t(XMLHelper::getAttrString(acldoc ? acldoc->getDocumentElement() : nullptr, nullptr, _type));
 920         if (t.empty())
 921             throw ConfigurationException("Missing type attribute in AccessControl plugin configuration.");
 922         scoped_ptr<AccessControl> aclplugin(SPConfig::getConfig().AccessControlManager.newPlugin(t.c_str(), acldoc->getDocumentElement()));
 923                 Locker acllock(aclplugin.get());
 924                 result = aclplugin->authorized(sta, session);
 925         }
 926         catch (std::exception& ex) {
 927                 sta.log(SPRequest::SPError, ex.what());
 928         }
 929     return result;
 930 }
 931
 932 AccessControl::aclresult_t htAccessControl::doUser(const ShibTargetApache& sta, const char* params) const
 933 {
 934     bool regexp = false;
 935     bool negated = false;
 936     while (*params) {
 937         const char* w = ap_getword_conf(sta.m_req->pool, &params);
 938         if (*w == '~') {
 939             regexp = true;
 940             continue;
 941         }
 942         else if (*w == '!') {
 943             // A negated rule presumes success unless a match is found.
 944             negated = true;
 945             if (*(w+1) == '~')
 946                 regexp = true;
 947             continue;
 948         }
 949
 950         // Figure out if there's a match.
 951         bool match = false;
 952         if (regexp) {
 953             try {
 954                 // To do regex matching, we have to convert from UTF-8.
 955                 auto_arrayptr<XMLCh> trans(fromUTF8(w));
 956                 RegularExpression re(trans.get());
 957                 auto_arrayptr<XMLCh> trans2(fromUTF8(sta.getRemoteUser().c_str()));
 958                 match = re.matches(trans2.get());
 959             }
 960             catch (XMLException& ex) {
 961                 auto_ptr_char tmp(ex.getMessage());
 962                 sta.log(SPRequest::SPError,
 963                     string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
 964             }
 965         }
 966         else if (sta.getRemoteUser() == w) {
 967             match = true;
 968         }
 969
 970         if (match) {
 971             if (sta.isPriorityEnabled(SPRequest::SPDebug))
 972                 sta.log(SPRequest::SPDebug,
 973                     string("htaccess: require user ") + (negated ? "rejecting (" : "accepting (") + sta.getRemoteUser() + ")");
 974             return (negated ? shib_acl_false : shib_acl_true);
 975         }
 976     }
 977     return (negated ? shib_acl_true : shib_acl_false);
 978 }
 979
 980 #ifndef SHIB_APACHE_24
 981 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
 982 {
 983     SH_AP_CONFIGFILE* f;
 984     SH_AP_TABLE* grps=ap_make_table(r->pool,15);
 985     char l[MAX_STRING_LEN];
 986     const char *group_name, *ll, *w;
 987
 988 #ifdef SHIB_APACHE_13
 989     if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
 990 #else
 991     if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
 992 #endif
 993         ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
 994         return nullptr;
 995     }
 996
 997     SH_AP_POOL* sp;
 998 #ifdef SHIB_APACHE_13
 999     sp=ap_make_sub_pool(r->pool);
1000 #else
1001     if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
1002         ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
1003             "groups_for_user() could not create a subpool");
1004         return nullptr;
1005     }
1006 #endif
1007
1008     while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
1009         if ((*l=='#') || (!*l))
1010             continue;
1011         ll = l;
1012         ap_clear_pool(sp);
1013         group_name = ap_getword(sp,&ll,':');
1014         while (*ll) {
1015             w=ap_getword_conf(sp,&ll);
1016             if (!strcmp(w,user)) {
1017                 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
1018                 break;
1019             }
1020         }
1021     }
1022     ap_cfg_closefile(f);
1023     ap_destroy_pool(sp);
1024     return grps;
1025 }
1026
1027 AccessControl::aclresult_t htAccessControl::doGroup(const ShibTargetApache& sta, const char* params) const
1028 {
1029     SH_AP_TABLE* grpstatus = nullptr;
1030     if (sta.m_dc->szAuthGrpFile) {
1031         if (sta.isPriorityEnabled(SPRequest::SPDebug))
1032             sta.log(SPRequest::SPDebug, string("htaccess plugin using groups file: ") + sta.m_dc->szAuthGrpFile);
1033         grpstatus = groups_for_user(sta.m_req, sta.getRemoteUser().c_str(), sta.m_dc->szAuthGrpFile);
1034     }
1035
1036     bool negated = false;
1037     while (*params) {
1038         const char* w = ap_getword_conf(sta.m_req->pool, &params);
1039         if (*w == '!') {
1040             // A negated rule presumes success unless a match is found.
1041             negated = true;
1042             continue;
1043         }
1044
1045         if (grpstatus && ap_table_get(grpstatus, w)) {
1046             // If we matched, then we're done with this rule either way and we flip status to reflect the outcome.
1047             sta.log(SPRequest::SPDebug, string("htaccess: require group ") + (negated ? "rejecting (" : "accepting (") + w + ")");
1048             return (negated ? shib_acl_false : shib_acl_true);
1049         }
1050     }
1051
1052     return (negated ? shib_acl_true : shib_acl_false);
1053 }
1054 #endif
1055
1056 AccessControl::aclresult_t htAccessControl::doAuthnContext(const ShibTargetApache& sta, const char* ref, const char* params) const
1057 {
1058     if (ref && *ref) {
1059         bool regexp = false;
1060         bool negated = false;
1061         while (ref && *params) {
1062             const char* w = ap_getword_conf(sta.m_req->pool, &params);
1063             if (*w == '~') {
1064                 regexp = true;
1065                 continue;
1066             }
1067             else if (*w == '!') {
1068                 // A negated rule presumes success unless a match is found.
1069                 negated = true;
1070                 if (*(w+1) == '~')
1071                     regexp = true;
1072                 continue;
1073             }
1074
1075             // Figure out if there's a match.
1076             bool match = false;
1077             if (regexp) {
1078                 try {
1079                     RegularExpression re(w);
1080                     match = re.matches(ref);
1081                 }
1082                 catch (XMLException& ex) {
1083                     auto_ptr_char tmp(ex.getMessage());
1084                     sta.log(SPRequest::SPError,
1085                         string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1086                 }
1087             }
1088             else if (!strcmp(w, ref)) {
1089                 match = true;
1090             }
1091
1092             if (match) {
1093                 if (sta.isPriorityEnabled(SPRequest::SPDebug))
1094                     sta.log(SPRequest::SPDebug,
1095                         string("htaccess: require authnContext ") + (negated ? "rejecting (" : "accepting (") + ref + ")");
1096                 return (negated ? shib_acl_false : shib_acl_true);
1097             }
1098         }
1099         return (negated ? shib_acl_true : shib_acl_false);
1100     }
1101
1102     if (sta.isPriorityEnabled(SPRequest::SPDebug))
1103         sta.log(SPRequest::SPDebug, "htaccess: require authnContext rejecting session with no context associated");
1104     return shib_acl_false;
1105 }
1106
1107 bool htAccessControl::checkAttribute(const SPRequest& request, const Attribute* attr, const char* toMatch, RegularExpression* re) const
1108 {
1109     bool caseSensitive = attr->isCaseSensitive();
1110     const vector<string>& vals = attr->getSerializedValues();
1111     for (vector<string>::const_iterator v = vals.begin(); v != vals.end(); ++v) {
1112         if (re) {
1113             auto_arrayptr<XMLCh> trans(fromUTF8(v->c_str()));
1114             if (re->matches(trans.get())) {
1115                 if (request.isPriorityEnabled(SPRequest::SPDebug))
1116                     request.log(SPRequest::SPDebug, string("htaccess: expecting regexp ") + toMatch + ", got " + *v + ": acccepted");
1117                 return true;
1118             }
1119         }
1120         else if ((caseSensitive && *v == toMatch) || (!caseSensitive && !strcasecmp(v->c_str(), toMatch))) {
1121             if (request.isPriorityEnabled(SPRequest::SPDebug))
1122                 request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": accepted");
1123             return true;
1124         }
1125         else if (request.isPriorityEnabled(SPRequest::SPDebug)) {
1126             request.log(SPRequest::SPDebug, string("htaccess: expecting ") + toMatch + ", got " + *v + ": rejected");
1127         }
1128     }
1129     return false;
1130 }
1131
1132 AccessControl::aclresult_t htAccessControl::doShibAttr(const ShibTargetApache& sta, const Session* session, const char* rule, const char* params) const
1133 {
1134 #ifndef SHIB_APACHE_24
1135     // Look for the new shib-attr placeholder and move past it.
1136     if (sta.m_dc->bCompatWith24 == 1 && rule && !strcmp(rule, "shib-attr")) {
1137         if (*params)
1138             rule = ap_getword_conf(sta.m_req->pool, &params);
1139     }
1140 #endif
1141
1142     // Find the attribute(s) matching the require rule.
1143     pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs =
1144         session->getIndexedAttributes().equal_range(rule ? rule : "");
1145
1146     bool regexp = false;
1147     while (attrs.first != attrs.second && *params) {
1148         const char* w = ap_getword_conf(sta.m_req->pool, &params);
1149         if (*w == '~') {
1150             regexp = true;
1151             continue;
1152         }
1153
1154         try {
1155             scoped_ptr<RegularExpression> re;
1156             if (regexp) {
1157                 auto_arrayptr<XMLCh> trans(fromUTF8(w));
1158                 re.reset(new xercesc::RegularExpression(trans.get()));
1159             }
1160
1161             pair<multimap<string,const Attribute*>::const_iterator,multimap<string,const Attribute*>::const_iterator> attrs2(attrs);
1162             for (; attrs2.first != attrs2.second; ++attrs2.first) {
1163                 if (checkAttribute(sta, attrs2.first->second, w, regexp ? re.get() : nullptr)) {
1164                     return shib_acl_true;
1165                 }
1166             }
1167         }
1168         catch (XMLException& ex) {
1169             auto_ptr_char tmp(ex.getMessage());
1170             sta.log(SPRequest::SPError, string("htaccess plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
1171         }
1172     }
1173     return shib_acl_false;
1174 }
1175
1176 AccessControl::aclresult_t htAccessControl::authorized(const SPRequest& request, const Session* session) const
1177 {
1178 #ifdef SHIB_APACHE_24
1179     // We should never be invoked in 2.4 as an SP plugin.
1180     throw ConfigurationException("Save my walrus!");
1181 #else
1182     // Make sure the object is our type.
1183     const ShibTargetApache* sta=dynamic_cast<const ShibTargetApache*>(&request);
1184     if (!sta)
1185         throw ConfigurationException("Request wrapper object was not of correct type.");
1186
1187     int m = sta->m_req->method_number;
1188     bool method_restricted = false;
1189     const char *t, *w;
1190
1191     const array_header* reqs_arr = ap_requires(sta->m_req);
1192     if (!reqs_arr)
1193         return shib_acl_indeterminate;  // should never happen
1194
1195         // Check for an "embedded" AccessControl plugin.
1196         if (sta->m_dc->szAccessControl) {
1197         aclresult_t result = doAccessControl(*sta, session, sta->m_dc->szAccessControl);
1198         if (result == shib_acl_true && sta->m_dc->bRequireAll != 1) {
1199             // If we're not insisting that all rules be met, then we're done.
1200             request.log(SPRequest::SPDebug, "htaccess: embedded AccessControl plugin was successful, granting access");
1201             return shib_acl_true;
1202         }
1203         else if (result != shib_acl_true && sta->m_dc->bRequireAll == 1) {
1204             // If we're insisting that all rules be met, which is not something Apache really handles well,
1205             // then we either return false or indeterminate based on the authoritative option, which defaults on.
1206             if (sta->m_dc->bAuthoritative != 0) {
1207                 request.log(SPRequest::SPDebug, "htaccess: embedded AccessControl plugin was unsuccessful, denying access");
1208                 return shib_acl_false;
1209             }
1210
1211             request.log(SPRequest::SPDebug, "htaccess: embedded AccessControl plugin was unsuccessful but not authoritative, leaving it up to Apache");
1212             return shib_acl_indeterminate;
1213         }
1214     }
1215
1216     require_line* reqs = (require_line*)reqs_arr->elts;
1217
1218     for (int x = 0; x < reqs_arr->nelts; ++x) {
1219         // This rule should be completely ignored, the method doesn't fit.
1220         // The rule just doesn't exist for our purposes.
1221         if (!(reqs[x].method_mask & (1 << m)))
1222             continue;
1223
1224         method_restricted = true; // this lets us know at the end that at least one rule was potentially enforcable.
1225
1226         // Tracks status of this rule's evaluation.
1227         bool status = false;
1228
1229         string remote_user = request.getRemoteUser();
1230
1231         t = reqs[x].requirement;
1232         w = ap_getword_white(sta->m_req->pool, &t);
1233
1234         if (!strcasecmp(w,"shibboleth")) {
1235             // This is a dummy rule needed because Apache conflates authn and authz.
1236             // Without some require rule, AuthType is ignored and no check_user hooks run.
1237
1238             // We evaluate to false if ShibAccessControl is used and ShibRequireAll is off.
1239             // This allows actual rules to dictate the result, since ShibAccessControl returned
1240             // non-true, and if nothing else is used, access will be denied.
1241             if (!sta->m_dc->szAccessControl || sta->m_dc->bRequireAll == 1) {
1242                 // We evaluate to true, because ShibRequireAll is enabled (so a true is just a no-op)
1243                 // or because there was no other AccessControl rule in place, so this may be the only
1244                 // rule in effect.
1245                 status = true;
1246             }
1247         }
1248         else if (!strcmp(w,"valid-user") && session) {
1249             request.log(SPRequest::SPDebug, "htaccess: accepting valid-user based on active session");
1250             status = true;
1251         }
1252         else if (!strcmp(w,"user") && !remote_user.empty()) {
1253             status = (doUser(*sta, t) == shib_acl_true);
1254         }
1255         else if (!strcmp(w,"group")  && !remote_user.empty()) {
1256             status = (doGroup(*sta, t) == shib_acl_true);
1257         }
1258         else if (!strcmp(w,"authnContextClassRef") || !strcmp(w,"authnContextDeclRef")) {
1259             const char* ref = !strcmp(w, "authnContextClassRef") ? session->getAuthnContextClassRef() : session->getAuthnContextDeclRef();
1260             status = (doAuthnContext(*sta, ref, t) == shib_acl_true);
1261         }
1262         else if (!session) {
1263             request.log(SPRequest::SPError, string("htaccess: require ") + w + " not given a valid session, are you using lazy sessions?");
1264         }
1265         else if (sta->m_dc->bCompatWith24 == 1 && !strcmp(w,"shib-plugin")) {
1266             w = ap_getword_conf(sta->m_req->pool, &t);
1267             if (w) {
1268                 status = (doAccessControl(*sta, session, w) == shib_acl_true);
1269             }
1270         }
1271         else {
1272             status = (doShibAttr(*sta, session, w, t) == shib_acl_true);
1273         }
1274
1275         // If status is false, we found a rule we couldn't satisfy.
1276         // Could be an unknown rule to us, or it just didn't match.
1277
1278         if (status && sta->m_dc->bRequireAll != 1) {
1279             // If we're not insisting that all rules be met, then we're done.
1280             request.log(SPRequest::SPDebug, "htaccess: a rule was successful, granting access");
1281             return shib_acl_true;
1282         }
1283         else if (!status && sta->m_dc->bRequireAll == 1) {
1284             // If we're insisting that all rules be met, which is not something Apache really handles well,
1285             // then we either return false or indeterminate based on the authoritative option, which defaults on.
1286             if (sta->m_dc->bAuthoritative != 0) {
1287                 request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful, denying access");
1288                 return shib_acl_false;
1289             }
1290
1291             request.log(SPRequest::SPDebug, "htaccess: a rule was unsuccessful but not authoritative, leaving it up to Apache");
1292             return shib_acl_indeterminate;
1293         }
1294
1295         // Otherwise, we keep going. If we're requring all, then we have to check every rule.
1296         // If not we just didn't find a successful rule yet, so we keep going anyway.
1297     }
1298
1299     // If we get here, we either "failed" or we're in require all mode (but not both).
1300     // If no rules possibly apply or we insisted that all rules check out, then we're good.
1301     if (!method_restricted) {
1302         request.log(SPRequest::SPDebug, "htaccess: no rules applied to this request method, granting access");
1303         return shib_acl_true;
1304     }
1305     else if (sta->m_dc->bRequireAll == 1) {
1306         request.log(SPRequest::SPDebug, "htaccess: all rules successful, granting access");
1307         return shib_acl_true;
1308     }
1309     else if (sta->m_dc->bAuthoritative != 0) {
1310         request.log(SPRequest::SPDebug, "htaccess: no rules were successful, denying access");
1311         return shib_acl_false;
1312     }
1313
1314     request.log(SPRequest::SPDebug, "htaccess: no rules were successful but not authoritative, leaving it up to Apache");
1315     return shib_acl_indeterminate;
1316 #endif
1317 }
1318
1319 class ApacheRequestMapper : public virtual RequestMapper, public virtual PropertySet
1320 {
1321 public:
1322     ApacheRequestMapper(const xercesc::DOMElement* e);
1323     ~ApacheRequestMapper() {}
1324     Lockable* lock() { return m_mapper->lock(); }
1325     void unlock() { m_staKey->setData(nullptr); m_propsKey->setData(nullptr); m_mapper->unlock(); }
1326     Settings getSettings(const HTTPRequest& request) const;
1327
1328     const PropertySet* getParent() const { return nullptr; }
1329     void setParent(const PropertySet*) {}
1330     pair<bool,bool> getBool(const char* name, const char* ns=nullptr) const;
1331     pair<bool,const char*> getString(const char* name, const char* ns=nullptr) const;
1332     pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=nullptr) const;
1333     pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=nullptr) const;
1334     pair<bool,int> getInt(const char* name, const char* ns=nullptr) const;
1335     void getAll(map<string,const char*>& properties) const;
1336     const PropertySet* getPropertySet(const char* name, const char* ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const;
1337     const xercesc::DOMElement* getElement() const;
1338
1339     const htAccessControl& getHTAccessControl() const { return m_htaccess; }
1340
1341 private:
1342     scoped_ptr<RequestMapper> m_mapper;
1343     scoped_ptr<ThreadKey> m_staKey,m_propsKey;
1344     mutable htAccessControl m_htaccess;
1345 };
1346
1347 RequestMapper* ApacheRequestMapFactory(const xercesc::DOMElement* const & e)
1348 {
1349     return new ApacheRequestMapper(e);
1350 }
1351
1352 ApacheRequestMapper::ApacheRequestMapper(const xercesc::DOMElement* e)
1353     : m_mapper(SPConfig::getConfig().RequestMapperManager.newPlugin(XML_REQUEST_MAPPER,e)),
1354         m_staKey(ThreadKey::create(nullptr)), m_propsKey(ThreadKey::create(nullptr))
1355 {
1356 }
1357
1358 RequestMapper::Settings ApacheRequestMapper::getSettings(const HTTPRequest& request) const
1359 {
1360     Settings s = m_mapper->getSettings(request);
1361     m_staKey->setData((void*)dynamic_cast<const ShibTargetApache*>(&request));
1362     m_propsKey->setData((void*)s.first);
1363     // Only return the htAccess plugin for pre-2.4 servers.
1364 #ifdef SHIB_APACHE_24
1365     return pair<const PropertySet*,AccessControl*>(this, s.second);
1366 #else
1367     return pair<const PropertySet*,AccessControl*>(this, s.second ? s.second : &m_htaccess);
1368 #endif
1369 }
1370
1371 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
1372 {
1373     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
1374     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1375     if (sta && !ns) {
1376         // Override Apache-settable boolean properties.
1377         if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession != -1)
1378             return make_pair(true, sta->m_dc->bRequireSession==1);
1379         else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion != -1)
1380             return make_pair(true, sta->m_dc->bExportAssertion==1);
1381         else if (sta->m_dc->tSettings) {
1382             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
1383             if (prop)
1384                 return make_pair(true, !strcmp(prop, "true") || !strcmp(prop, "1") || !strcmp(prop, "On"));
1385         }
1386     }
1387     return s ? s->getBool(name,ns) : make_pair(false,false);
1388 }
1389
1390 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
1391 {
1392     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
1393     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1394     if (sta && !ns) {
1395         // Override Apache-settable string properties.
1396         if (name && !strcmp(name,"authType")) {
1397             const char* auth_type = ap_auth_type(sta->m_req);
1398             if (auth_type) {
1399                 // Check for Basic Hijack
1400                 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
1401                     auth_type = "shibboleth";
1402                 return make_pair(true, auth_type);
1403             }
1404         }
1405         else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
1406             return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
1407         else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
1408             return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
1409         else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
1410             return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
1411         else if (sta->m_dc->tSettings) {
1412             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
1413             if (prop)
1414                 return make_pair(true, prop);
1415         }
1416     }
1417     return s ? s->getString(name,ns) : pair<bool,const char*>(false,nullptr);
1418 }
1419
1420 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
1421 {
1422     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1423     return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,nullptr);
1424 }
1425
1426 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
1427 {
1428     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
1429     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1430     if (sta && !ns) {
1431         // Override Apache-settable int properties.
1432         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
1433             return pair<bool,unsigned int>(true, strtol(sta->m_dc->szRedirectToSSL, nullptr, 10));
1434         else if (sta->m_dc->tSettings) {
1435             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
1436             if (prop)
1437                 return pair<bool,unsigned int>(true, atoi(prop));
1438         }
1439     }
1440     return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
1441 }
1442
1443 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
1444 {
1445     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
1446     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1447     if (sta && !ns) {
1448         // Override Apache-settable int properties.
1449         if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
1450             return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
1451         else if (sta->m_dc->tSettings) {
1452             const char* prop = ap_table_get(sta->m_dc->tSettings, name);
1453             if (prop)
1454                 return make_pair(true, atoi(prop));
1455         }
1456     }
1457     return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
1458 }
1459
1460 static int _rm_get_all_table_walk(void *v, const char *key, const char *value)
1461 {
1462     reinterpret_cast<map<string,const char*>*>(v)->insert(pair<string,const char*>(key, value));
1463     return 1;
1464 }
1465
1466 void ApacheRequestMapper::getAll(map<string,const char*>& properties) const
1467 {
1468     const ShibTargetApache* sta=reinterpret_cast<const ShibTargetApache*>(m_staKey->getData());
1469     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1470
1471     if (s)
1472         s->getAll(properties);
1473     if (!sta)
1474         return;
1475
1476     const char* auth_type=ap_auth_type(sta->m_req);
1477     if (auth_type) {
1478         // Check for Basic Hijack
1479         if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
1480             auth_type = "shibboleth";
1481         properties["authType"] = auth_type;
1482     }
1483
1484     if (sta->m_dc->szApplicationId)
1485         properties["applicationId"] = sta->m_dc->szApplicationId;
1486     if (sta->m_dc->szRequireWith)
1487         properties["requireSessionWith"] = sta->m_dc->szRequireWith;
1488     if (sta->m_dc->szRedirectToSSL)
1489         properties["redirectToSSL"] = sta->m_dc->szRedirectToSSL;
1490     if (sta->m_dc->bRequireSession != 0)
1491         properties["requireSession"] = (sta->m_dc->bRequireSession==1) ? "true" : "false";
1492     if (sta->m_dc->bExportAssertion != 0)
1493         properties["exportAssertion"] = (sta->m_dc->bExportAssertion==1) ? "true" : "false";
1494
1495     if (sta->m_dc->tSettings)
1496         ap_table_do(_rm_get_all_table_walk, &properties, sta->m_dc->tSettings, NULL);
1497 }
1498
1499 const PropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
1500 {
1501     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1502     return s ? s->getPropertySet(name,ns) : nullptr;
1503 }
1504
1505 const xercesc::DOMElement* ApacheRequestMapper::getElement() const
1506 {
1507     const PropertySet* s=reinterpret_cast<const PropertySet*>(m_propsKey->getData());
1508     return s ? s->getElement() : nullptr;
1509 }
1510
1511 // Authz callbacks for Apache 2.4
1512 #ifdef SHIB_APACHE_24
1513 pair<ShibTargetApache*,authz_status> shib_base_check_authz(request_rec* r)
1514 {
1515     shib_request_config* rc = (shib_request_config*)ap_get_module_config(r->request_config, &mod_shib);
1516     if (!rc || !rc->sta) {
1517         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_base_check_authz found no per-request structure");
1518         return make_pair((ShibTargetApache*)nullptr, AUTHZ_GENERAL_ERROR);
1519     }
1520     else if (!rc->sta->isInitialized()) {
1521         return make_pair((ShibTargetApache*)nullptr, AUTHZ_DENIED_NO_USER);
1522     }
1523     return make_pair(rc->sta, AUTHZ_GRANTED);
1524 }
1525
1526 extern "C" authz_status shib_shibboleth_check_authz(request_rec* r, const char* require_line, const void*)
1527 {
1528     pair<ShibTargetApache*,authz_status> sta = shib_base_check_authz(r);
1529     if (!sta.first)
1530         return sta.second;
1531     return AUTHZ_GRANTED;
1532 }
1533
1534 extern "C" authz_status shib_validuser_check_authz(request_rec* r, const char* require_line, const void*)
1535 {
1536     pair<ShibTargetApache*,authz_status> sta = shib_base_check_authz(r);
1537     if (!sta.first)
1538         return sta.second;
1539
1540     try {
1541         const Session* session = sta.first->getSession(false);
1542         if (session) {
1543             sta.first->log(SPRequest::SPDebug, "htaccess: accepting valid-user based on active session");
1544             return AUTHZ_GRANTED;
1545         }
1546     }
1547     catch (std::exception& e) {
1548         sta.first->log(SPRequest::SPWarn, string("htaccess: unable to obtain session for access control check: ") +  e.what());
1549     }
1550
1551     return AUTHZ_DENIED_NO_USER;
1552 }
1553
1554 extern "C" authz_status shib_user_check_authz(request_rec* r, const char* require_line, const void*)
1555 {
1556     if (!r->user || !*(r->user))
1557         return AUTHZ_DENIED_NO_USER;
1558     pair<ShibTargetApache*,authz_status> sta = shib_base_check_authz(r);
1559     if (!sta.first)
1560         return sta.second;
1561
1562     const htAccessControl& hta = dynamic_cast<const ApacheRequestMapper*>(sta.first->getRequestSettings().first)->getHTAccessControl();
1563     if (hta.doUser(*sta.first, require_line) == AccessControl::shib_acl_true)
1564         return AUTHZ_GRANTED;
1565     return AUTHZ_DENIED;
1566 }
1567
1568 extern "C" authz_status shib_acclass_check_authz(request_rec* r, const char* require_line, const void*)
1569 {
1570     pair<ShibTargetApache*,authz_status> sta = shib_base_check_authz(r);
1571     if (!sta.first)
1572         return sta.second;
1573
1574     const htAccessControl& hta = dynamic_cast<const ApacheRequestMapper*>(sta.first->getRequestSettings().first)->getHTAccessControl();
1575
1576     try {
1577         const Session* session = sta.first->getSession(false);
1578         if (session && hta.doAuthnContext(*sta.first, session->getAuthnContextClassRef(), require_line) == AccessControl::shib_acl_true)
1579             return AUTHZ_GRANTED;
1580         return session ? AUTHZ_DENIED : AUTHZ_DENIED_NO_USER;
1581     }
1582     catch (std::exception& e) {
1583         sta.first->log(SPRequest::SPWarn, string("htaccess: unable to obtain session for access control check: ") +  e.what());
1584     }
1585
1586     return AUTHZ_GENERAL_ERROR;
1587 }
1588
1589 extern "C" authz_status shib_acdecl_check_authz(request_rec* r, const char* require_line, const void*)
1590 {
1591     pair<ShibTargetApache*,authz_status> sta = shib_base_check_authz(r);
1592     if (!sta.first)
1593         return sta.second;
1594
1595     const htAccessControl& hta = dynamic_cast<const ApacheRequestMapper*>(sta.first->getRequestSettings().first)->getHTAccessControl();
1596
1597     try {
1598         const Session* session = sta.first->getSession(false);
1599         if (session && hta.doAuthnContext(*sta.first, session->getAuthnContextDeclRef(), require_line) == AccessControl::shib_acl_true)
1600             return AUTHZ_GRANTED;
1601         return session ? AUTHZ_DENIED : AUTHZ_DENIED_NO_USER;
1602     }
1603     catch (std::exception& e) {
1604         sta.first->log(SPRequest::SPWarn, string("htaccess: unable to obtain session for access control check: ") +  e.what());
1605     }
1606
1607     return AUTHZ_GENERAL_ERROR;
1608 }
1609
1610 extern "C" authz_status shib_attr_check_authz(request_rec* r, const char* require_line, const void*)
1611 {
1612     pair<ShibTargetApache*,authz_status> sta = shib_base_check_authz(r);
1613     if (!sta.first)
1614         return sta.second;
1615
1616     const htAccessControl& hta = dynamic_cast<const ApacheRequestMapper*>(sta.first->getRequestSettings().first)->getHTAccessControl();
1617
1618     try {
1619         const Session* session = sta.first->getSession(false);
1620         if (session) {
1621             const char* rule = ap_getword_conf(r->pool, &require_line);
1622             if (rule && hta.doShibAttr(*sta.first, session, rule, require_line) == AccessControl::shib_acl_true)
1623                 return AUTHZ_GRANTED;
1624         }
1625         return session ? AUTHZ_DENIED : AUTHZ_DENIED_NO_USER;
1626     }
1627     catch (std::exception& e) {
1628         sta.first->log(SPRequest::SPWarn, string("htaccess: unable to obtain session for access control check: ") +  e.what());
1629     }
1630
1631     return AUTHZ_GENERAL_ERROR;
1632 }
1633
1634 extern "C" authz_status shib_plugin_check_authz(request_rec* r, const char* require_line, const void*)
1635 {
1636     pair<ShibTargetApache*,authz_status> sta = shib_base_check_authz(r);
1637     if (!sta.first)
1638         return sta.second;
1639
1640     const htAccessControl& hta = dynamic_cast<const ApacheRequestMapper*>(sta.first->getRequestSettings().first)->getHTAccessControl();
1641
1642     try {
1643         const Session* session = sta.first->getSession(false);
1644         if (session) {
1645             const char* config = ap_getword_conf(r->pool, &require_line);
1646             if (config && hta.doAccessControl(*sta.first, session, config) == AccessControl::shib_acl_true)
1647                 return AUTHZ_GRANTED;
1648         }
1649         return session ? AUTHZ_DENIED : AUTHZ_DENIED_NO_USER;
1650     }
1651     catch (std::exception& e) {
1652         sta.first->log(SPRequest::SPWarn, string("htaccess: unable to obtain session for access control check: ") +  e.what());
1653     }
1654
1655     return AUTHZ_GENERAL_ERROR;
1656 }
1657 #endif
1658
1659 // Command manipulation functions
1660
1661 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
1662 {
1663     *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
1664     return nullptr;
1665 }
1666
1667 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
1668 {
1669     char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
1670     size_t offset=(size_t)parms->info;
1671     *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
1672     return nullptr;
1673 }
1674
1675 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
1676 #ifdef SHIB_APACHE_13
1677                                              char* arg1, char* arg2
1678 #else
1679                                              void* arg1, const char* arg2
1680 #endif
1681                                              )
1682 {
1683   ap_set_file_slot(parms, arg1, arg2);
1684   return DECLINE_CMD;
1685 }
1686
1687 extern "C" const char* shib_table_set(cmd_parms* parms, shib_dir_config* dc, const char* arg1, const char* arg2)
1688 {
1689     if (!dc->tSettings)
1690         dc->tSettings = ap_make_table(parms->pool, 4);
1691     ap_table_set(dc->tSettings, arg1, arg2);
1692     return nullptr;
1693 }
1694
1695 #ifndef SHIB_APACHE_24
1696 extern "C" const char* shib_set_acl_slot(cmd_parms* params, shib_dir_config* dc, char* arg)
1697 {
1698     bool absolute;
1699     switch (*arg) {
1700         case 0:
1701             absolute = false;
1702             break;
1703         case '/':
1704         case '\\':
1705             absolute = true;
1706             break;
1707         case '.':
1708             absolute = (*(arg+1) == '.' || *(arg+1) == '/' || *(arg+1) == '\\');
1709             break;
1710         default:
1711             absolute = *(arg+1) == ':';
1712     }
1713
1714     if (absolute || !params->path)
1715         dc->szAccessControl = ap_pstrdup(params->pool, arg);
1716     else
1717         dc->szAccessControl = ap_pstrcat(params->pool, params->path, arg);
1718     return nullptr;
1719 }
1720 #endif
1721
1722
1723 #ifdef SHIB_APACHE_13
1724 /*
1725  * shib_child_exit()
1726  *  Cleanup the (per-process) pool info.
1727  */
1728 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
1729 {
1730     if (g_Config) {
1731         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
1732         g_Config->term();
1733         g_Config = nullptr;
1734         ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done");
1735     }
1736 }
1737 #else
1738 /*
1739  * shib_exit()
1740  *  Apache 2.x doesn't allow for per-child cleanup, causes CGI forks to hang.
1741  */
1742 extern "C" apr_status_t shib_exit(void* data)
1743 {
1744     if (g_Config) {
1745         g_Config->term();
1746         g_Config = nullptr;
1747     }
1748     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,nullptr,"shib_exit() done");
1749     return OK;
1750 }
1751 #endif
1752
1753 /*
1754  * shire_child_init()
1755  *  Things to do when the child process is initialized.
1756  *  (or after the configs are read in apache-2)
1757  */
1758 #ifdef SHIB_APACHE_13
1759 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
1760 #else
1761 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
1762 #endif
1763 {
1764     // Initialize runtime components.
1765
1766     ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
1767
1768     if (g_Config) {
1769         ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
1770         exit(1);
1771     }
1772
1773     g_Config=&SPConfig::getConfig();
1774     g_Config->setFeatures(
1775         SPConfig::Listener |
1776         SPConfig::Caching |
1777         SPConfig::RequestMapping |
1778         SPConfig::InProcess |
1779         SPConfig::Logging |
1780         SPConfig::Handlers
1781         );
1782     if (!g_Config->init(g_szSchemaDir, g_szPrefix)) {
1783         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
1784         exit(1);
1785     }
1786 #ifndef SHIB_APACHE_24
1787     g_Config->AccessControlManager.registerFactory(HT_ACCESS_CONTROL, &htAccessFactory);
1788 #endif
1789     g_Config->RequestMapperManager.registerFactory(NATIVE_REQUEST_MAPPER, &ApacheRequestMapFactory);
1790
1791     try {
1792         if (!g_Config->instantiate(g_szSHIBConfig, true))
1793             throw runtime_error("unknown error");
1794     }
1795     catch (std::exception& ex) {
1796         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"%s",ex.what());
1797         ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
1798         exit(1);
1799     }
1800
1801     ServiceProvider* sp = g_Config->getServiceProvider();
1802     xmltooling::Locker locker(sp);
1803     const PropertySet* props = sp->getPropertySet("InProcess");
1804     if (props) {
1805         pair<bool,const char*> unsetValue = props->getString("unsetHeaderValue");
1806         if (unsetValue.first)
1807             g_unsetHeaderValue = unsetValue.second;
1808         pair<bool,bool> flag=props->getBool("checkSpoofing");
1809         g_checkSpoofing = !flag.first || flag.second;
1810         if (g_checkSpoofing) {
1811             unsetValue=props->getString("spoofKey");
1812             if (unsetValue.first)
1813                 g_spoofKey = unsetValue.second;
1814         }
1815         flag=props->getBool("catchAll");
1816         g_catchAll = flag.first && flag.second;
1817     }
1818
1819     // Set the cleanup handler
1820     apr_pool_cleanup_register(p, nullptr, &shib_exit, apr_pool_cleanup_null);
1821
1822     ap_log_error(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, SH_AP_R(s), "shib_child_init() done");
1823 }
1824
1825 // Output filters
1826 #ifdef SHIB_DEFERRED_HEADERS
1827 static void set_output_filter(request_rec *r)
1828 {
1829    ap_add_output_filter("SHIB_HEADERS_OUT", nullptr, r, r->connection);
1830 }
1831
1832 static void set_error_filter(request_rec *r)
1833 {
1834    ap_add_output_filter("SHIB_HEADERS_ERR", nullptr, r, r->connection);
1835 }
1836
1837 static int _table_add(void *v, const char *key, const char *value)
1838 {
1839     apr_table_addn((apr_table_t*)v, key, value);
1840     return 1;
1841 }
1842
1843 static apr_status_t do_output_filter(ap_filter_t *f, apr_bucket_brigade *in)
1844 {
1845     request_rec *r = f->r;
1846     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1847
1848     if (rc && rc->hdr_out) {
1849         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);
1850         // can't use overlap call because it will collapse Set-Cookie headers
1851         //apr_table_overlap(r->headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1852         apr_table_do(_table_add,r->headers_out, rc->hdr_out,NULL);
1853     }
1854
1855     /* remove ourselves from the filter chain */
1856     ap_remove_output_filter(f);
1857
1858     /* send the data up the stack */
1859     return ap_pass_brigade(f->next,in);
1860 }
1861
1862 static apr_status_t do_error_filter(ap_filter_t *f, apr_bucket_brigade *in)
1863 {
1864     request_rec *r = f->r;
1865     shib_request_config *rc = (shib_request_config*) ap_get_module_config(r->request_config, &mod_shib);
1866
1867     if (rc && rc->hdr_out) {
1868         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);
1869         // can't use overlap call because it will collapse Set-Cookie headers
1870         //apr_table_overlap(r->err_headers_out, rc->hdr_out, APR_OVERLAP_TABLES_MERGE);
1871         apr_table_do(_table_add,r->err_headers_out, rc->hdr_out,NULL);
1872     }
1873
1874     /* remove ourselves from the filter chain */
1875     ap_remove_output_filter(f);
1876
1877     /* send the data up the stack */
1878     return ap_pass_brigade(f->next,in);
1879 }
1880 #endif // SHIB_DEFERRED_HEADERS
1881
1882 typedef const char* (*config_fn_t)(void);
1883
1884 #ifdef SHIB_APACHE_13
1885
1886 // SHIB Module commands
1887
1888 static command_rec shire_cmds[] = {
1889   {"ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
1890    RSRC_CONF, TAKE1, "Shibboleth installation directory"},
1891   {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1892    RSRC_CONF, TAKE1, "Path to shibboleth2.xml config file"},
1893   {"ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1894    RSRC_CONF, TAKE1, "Paths of XML schema catalogs"},
1895
1896   {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
1897    (void *) XtOffsetOf (shib_server_config, szScheme),
1898    RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
1899
1900   {"ShibRequestSetting", (config_fn_t)shib_table_set, nullptr,
1901    OR_AUTHCFG, TAKE2, "Set arbitrary Shibboleth request property for content"},
1902
1903   {"ShibAccessControl", (config_fn_t)shib_set_acl_slot, nullptr,
1904    OR_AUTHCFG, TAKE1, "Set arbitrary Shibboleth access control plugin for content"},
1905
1906   {"ShibDisable", (config_fn_t)ap_set_flag_slot,
1907    (void *) XtOffsetOf (shib_dir_config, bOff),
1908    OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
1909   {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
1910    (void *) XtOffsetOf (shib_dir_config, szApplicationId),
1911    OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
1912   {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1913    (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
1914    OR_AUTHCFG, FLAG, "(DEPRECATED) Respond to AuthType Basic and convert to shibboleth"},
1915   {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1916    (void *) XtOffsetOf (shib_dir_config, bRequireSession),
1917    OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
1918   {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1919    (void *) XtOffsetOf (shib_dir_config, szRequireWith),
1920    OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
1921   {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1922    (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
1923    OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
1924   {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1925    (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1926    OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1927   {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1928    (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1929    OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1930   {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1931    (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1932    OR_AUTHCFG, FLAG, "All require directives must match"},
1933   {"AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
1934    (void *) XtOffsetOf (shib_dir_config, bAuthoritative),
1935    OR_AUTHCFG, FLAG, "Allow failed mod_shib htaccess authorization to fall through to other modules"},
1936   {"ShibCompatWith24", (config_fn_t)ap_set_flag_slot,
1937    (void *) XtOffsetOf (shib_dir_config, bCompatWith24),
1938    OR_AUTHCFG, FLAG, "Support Apache 2.4-style require rules"},
1939   {"ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
1940    (void *) XtOffsetOf (shib_dir_config, bUseEnvVars),
1941    OR_AUTHCFG, FLAG, "Export attributes using environment variables (default)"},
1942   {"ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
1943    (void *) XtOffsetOf (shib_dir_config, bUseHeaders),
1944    OR_AUTHCFG, FLAG, "Export attributes using custom HTTP headers"},
1945   {"ShibExpireRedirects", (config_fn_t)ap_set_flag_slot,
1946    (void *) XtOffsetOf (shib_dir_config, bExpireRedirects),
1947    OR_AUTHCFG, FLAG, "Expire SP-generated redirects"},
1948
1949   {nullptr}
1950 };
1951
1952 extern "C"{
1953 handler_rec shib_handlers[] = {
1954   { "shib-handler", shib_handler },
1955   { nullptr }
1956 };
1957
1958 module MODULE_VAR_EXPORT mod_shib = {
1959     STANDARD_MODULE_STUFF,
1960     nullptr,                        /* initializer */
1961     create_shib_dir_config,     /* dir config creater */
1962     merge_shib_dir_config,      /* dir merger --- default is to override */
1963     create_shib_server_config, /* server config */
1964     merge_shib_server_config,   /* merge server config */
1965     shire_cmds,                 /* command table */
1966     shib_handlers,              /* handlers */
1967     nullptr,                    /* filename translation */
1968     shib_check_user,            /* check_user_id */
1969     shib_auth_checker,          /* check auth */
1970     nullptr,                    /* check access */
1971     nullptr,                    /* type_checker */
1972     shib_fixups,                /* fixups */
1973     nullptr,                    /* logger */
1974     nullptr,                    /* header parser */
1975     shib_child_init,            /* child_init */
1976     shib_child_exit,            /* child_exit */
1977     shib_post_read              /* post read-request */
1978 };
1979
1980 #else
1981
1982 #ifdef SHIB_APACHE_24
1983 extern "C" const authz_provider shib_authz_shibboleth_provider = { &shib_shibboleth_check_authz, nullptr };
1984 extern "C" const authz_provider shib_authz_validuser_provider = { &shib_validuser_check_authz, nullptr };
1985 extern "C" const authz_provider shib_authz_user_provider = { &shib_user_check_authz, nullptr };
1986 extern "C" const authz_provider shib_authz_acclass_provider = { &shib_acclass_check_authz, nullptr };
1987 extern "C" const authz_provider shib_authz_acdecl_provider = { &shib_acdecl_check_authz, nullptr };
1988 extern "C" const authz_provider shib_authz_attr_provider = { &shib_attr_check_authz, nullptr };
1989 extern "C" const authz_provider shib_authz_plugin_provider = { &shib_plugin_check_authz, nullptr };
1990 #endif
1991
1992 extern "C" void shib_register_hooks (apr_pool_t *p)
1993 {
1994 #ifdef SHIB_DEFERRED_HEADERS
1995     ap_register_output_filter("SHIB_HEADERS_OUT", do_output_filter, nullptr, AP_FTYPE_CONTENT_SET);
1996     ap_hook_insert_filter(set_output_filter, nullptr, nullptr, APR_HOOK_LAST);
1997     ap_register_output_filter("SHIB_HEADERS_ERR", do_error_filter, nullptr, AP_FTYPE_CONTENT_SET);
1998     ap_hook_insert_error_filter(set_error_filter, nullptr, nullptr, APR_HOOK_LAST);
1999     ap_hook_post_read_request(shib_post_read, nullptr, nullptr, APR_HOOK_MIDDLE);
2000 #endif
2001     ap_hook_child_init(shib_child_init, nullptr, nullptr, APR_HOOK_MIDDLE);
2002     const char* prereq = getenv("SHIBSP_APACHE_PREREQ");
2003 #ifdef SHIB_APACHE_24
2004     if (prereq && *prereq) {
2005         const char* const authnPre[] = { prereq, nullptr };
2006         ap_hook_check_authn(shib_check_user, authnPre, nullptr, APR_HOOK_MIDDLE, AP_AUTH_INTERNAL_PER_URI);
2007     }
2008     else {
2009         ap_hook_check_authn(shib_check_user, nullptr, nullptr, APR_HOOK_MIDDLE, AP_AUTH_INTERNAL_PER_URI);
2010     }
2011     ap_hook_check_authz(shib_auth_checker, nullptr, nullptr, APR_HOOK_FIRST, AP_AUTH_INTERNAL_PER_URI);
2012 #else
2013     if (prereq && *prereq) {
2014         const char* const authnPre[] = { prereq, nullptr };
2015         ap_hook_check_user_id(shib_check_user, authnPre, nullptr, APR_HOOK_MIDDLE);
2016     }
2017     else {
2018         ap_hook_check_user_id(shib_check_user, nullptr, nullptr, APR_HOOK_MIDDLE);
2019     }
2020     ap_hook_auth_checker(shib_auth_checker, nullptr, nullptr, APR_HOOK_FIRST);
2021 #endif
2022     ap_hook_handler(shib_handler, nullptr, nullptr, APR_HOOK_LAST);
2023     ap_hook_fixups(shib_fixups, nullptr, nullptr, APR_HOOK_MIDDLE);
2024
2025 #ifdef SHIB_APACHE_24
2026     ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "shibboleth", AUTHZ_PROVIDER_VERSION, &shib_authz_shibboleth_provider, AP_AUTH_INTERNAL_PER_CONF);
2027     ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "valid-user", AUTHZ_PROVIDER_VERSION, &shib_authz_validuser_provider, AP_AUTH_INTERNAL_PER_CONF);
2028     ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "user", AUTHZ_PROVIDER_VERSION, &shib_authz_user_provider, AP_AUTH_INTERNAL_PER_CONF);
2029     ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "authnContextClassRef", AUTHZ_PROVIDER_VERSION, &shib_authz_acclass_provider, AP_AUTH_INTERNAL_PER_CONF);
2030     ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "authnContextDeclRef", AUTHZ_PROVIDER_VERSION, &shib_authz_acdecl_provider, AP_AUTH_INTERNAL_PER_CONF);
2031     ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "shib-attr", AUTHZ_PROVIDER_VERSION, &shib_authz_attr_provider, AP_AUTH_INTERNAL_PER_CONF);
2032     ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "shib-plugin", AUTHZ_PROVIDER_VERSION, &shib_authz_plugin_provider, AP_AUTH_INTERNAL_PER_CONF);
2033 #endif
2034 }
2035
2036 // SHIB Module commands
2037
2038 extern "C" {
2039 static command_rec shib_cmds[] = {
2040     AP_INIT_TAKE1("ShibPrefix", (config_fn_t)ap_set_global_string_slot, &g_szPrefix,
2041         RSRC_CONF, "Shibboleth installation directory"),
2042     AP_INIT_TAKE1("ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
2043         RSRC_CONF, "Path to shibboleth2.xml config file"),
2044     AP_INIT_TAKE1("ShibCatalogs", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
2045         RSRC_CONF, "Paths of XML schema catalogs"),
2046     AP_INIT_TAKE1("ShibGSSKey", (config_fn_t)ap_set_global_string_slot, &g_szGSSContextKey,
2047         RSRC_CONF, "Name of user data key containing GSS context established by GSS module"),
2048
2049     AP_INIT_TAKE1("ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
2050         (void *) offsetof (shib_server_config, szScheme),
2051         RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
2052
2053     AP_INIT_TAKE2("ShibRequestSetting", (config_fn_t)shib_table_set, nullptr,
2054         OR_AUTHCFG, "Set arbitrary Shibboleth request property for content"),
2055
2056     AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
2057         (void *) offsetof (shib_dir_config, bOff),
2058         OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
2059     AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
2060         (void *) offsetof (shib_dir_config, szApplicationId),
2061         OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
2062     AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
2063         (void *) offsetof (shib_dir_config, bBasicHijack),
2064         OR_AUTHCFG, "(DEPRECATED) Respond to AuthType Basic and convert to shibboleth"),
2065     AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
2066         (void *) offsetof (shib_dir_config, bRequireSession),
2067         OR_AUTHCFG, "Initiates a new session if one does not exist"),
2068     AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
2069         (void *) offsetof (shib_dir_config, szRequireWith),
2070         OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
2071     AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
2072         (void *) offsetof (shib_dir_config, bExportAssertion),
2073         OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
2074     AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
2075         (void *) offsetof (shib_dir_config, szRedirectToSSL),
2076         OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
2077 #ifdef SHIB_APACHE_24
2078     AP_INIT_FLAG("ShibRequestMapperAuthz", (config_fn_t)ap_set_flag_slot,
2079         (void *) offsetof (shib_dir_config, bRequestMapperAuthz),
2080         OR_AUTHCFG, "Support access control via shibboleth2.xml / RequestMapper"),
2081 #else
2082     AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
2083         (void *) offsetof (shib_dir_config, szAuthGrpFile),
2084         OR_AUTHCFG, "Text file containing group names and member user IDs"),
2085     AP_INIT_TAKE1("ShibAccessControl", (config_fn_t)shib_set_acl_slot, nullptr,
2086         OR_AUTHCFG, "Set arbitrary Shibboleth access control plugin for content"),
2087     AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
2088         (void *) offsetof (shib_dir_config, bRequireAll),
2089         OR_AUTHCFG, "All require directives must match"),
2090     AP_INIT_FLAG("AuthzShibAuthoritative", (config_fn_t)ap_set_flag_slot,
2091         (void *) offsetof (shib_dir_config, bAuthoritative),
2092         OR_AUTHCFG, "Allow failed mod_shib htaccess authorization to fall through to other modules"),
2093     AP_INIT_FLAG("ShibCompatWith24", (config_fn_t)ap_set_flag_slot,
2094         (void *) offsetof (shib_dir_config, bCompatWith24),
2095         OR_AUTHCFG, "Support Apache 2.4-style require rules"),
2096 #endif
2097     AP_INIT_FLAG("ShibUseEnvironment", (config_fn_t)ap_set_flag_slot,
2098         (void *) offsetof (shib_dir_config, bUseEnvVars),
2099         OR_AUTHCFG, "Export attributes using environment variables (default)"),
2100     AP_INIT_FLAG("ShibUseHeaders", (config_fn_t)ap_set_flag_slot,
2101         (void *) offsetof (shib_dir_config, bUseHeaders),
2102         OR_AUTHCFG, "Export attributes using custom HTTP headers"),
2103     AP_INIT_FLAG("ShibExpireRedirects", (config_fn_t)ap_set_flag_slot,
2104         (void *) offsetof (shib_dir_config, bExpireRedirects),
2105         OR_AUTHCFG, "Expire SP-generated redirects"),
2106
2107     {nullptr}
2108 };
2109
2110 module AP_MODULE_DECLARE_DATA mod_shib = {
2111     STANDARD20_MODULE_STUFF,
2112     create_shib_dir_config,     /* create dir config */
2113     merge_shib_dir_config,      /* merge dir config --- default is to override */
2114     create_shib_server_config,  /* create server config */
2115     merge_shib_server_config,   /* merge server config */
2116     shib_cmds,                  /* command table */
2117     shib_register_hooks         /* register hooks */
2118 };
2119
2120 #endif
2121
2122 }