2 * Copyright 2001-2005 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * mod_apache.cpp -- the core Apache Module code
20 * Created by: Derek Atkins <derek@ihtfp.com>
26 #undef _XOPEN_SOURCE // causes gethostname conflict in unistd.h
30 #include <saml/saml.h>
31 #include <shib/shib.h>
32 #include <shib/shib-threads.h>
33 #include <shib-target/shib-target.h>
34 #include <xercesc/util/regx/RegularExpression.hpp>
38 // Apache specific header files
40 #include <http_config.h>
41 #include <http_protocol.h>
42 #include <http_main.h>
44 #include <http_core.h>
47 #ifndef SHIB_APACHE_13
48 #include <http_request.h>
49 #include <apr_strings.h>
50 #include <apr_pools.h>
57 #include <unistd.h> // for getpid()
62 using namespace shibboleth;
63 using namespace shibtarget;
65 extern "C" module MODULE_VAR_EXPORT mod_shib;
68 char* g_szSHIBConfig = NULL;
69 char* g_szSchemaDir = NULL;
70 ShibTargetConfig* g_Config = NULL;
71 string g_unsetHeaderValue;
72 static const char* g_UserDataKey = "_shib_check_user_";
75 /********************************************************************************/
76 // Basic Apache Configuration code.
79 // per-server module configuration structure
80 struct shib_server_config
85 // creates the per-server configuration
86 extern "C" void* create_shib_server_config(SH_AP_POOL* p, server_rec* s)
88 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
93 // overrides server configuration in virtual servers
94 extern "C" void* merge_shib_server_config (SH_AP_POOL* p, void* base, void* sub)
96 shib_server_config* sc=(shib_server_config*)ap_pcalloc(p,sizeof(shib_server_config));
97 shib_server_config* parent=(shib_server_config*)base;
98 shib_server_config* child=(shib_server_config*)sub;
101 sc->szScheme=ap_pstrdup(p,child->szScheme);
102 else if (parent->szScheme)
103 sc->szScheme=ap_pstrdup(p,parent->szScheme);
110 // per-dir module configuration structure
111 struct shib_dir_config
114 char* szAuthGrpFile; // Auth GroupFile name
115 int bRequireAll; // all require directives must match, otherwise OR logic
117 // Content Configuration
118 char* szApplicationId; // Shib applicationId value
119 char* szRequireWith; // require a session using a specific initiator?
120 char* szRedirectToSSL; // redirect non-SSL requests to SSL port
121 int bOff; // flat-out disable all Shib processing
122 int bBasicHijack; // activate for AuthType Basic?
123 int bRequireSession; // require a session?
124 int bExportAssertion; // export SAML assertion to the environment?
127 // creates per-directory config structure
128 extern "C" void* create_shib_dir_config (SH_AP_POOL* p, char* d)
130 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
132 dc->bBasicHijack = -1;
133 dc->bRequireSession = -1;
134 dc->bExportAssertion = -1;
135 dc->bRequireAll = -1;
136 dc->szRedirectToSSL = NULL;
137 dc->szAuthGrpFile = NULL;
138 dc->szApplicationId = NULL;
139 dc->szRequireWith = NULL;
143 // overrides server configuration in directories
144 extern "C" void* merge_shib_dir_config (SH_AP_POOL* p, void* base, void* sub)
146 shib_dir_config* dc=(shib_dir_config*)ap_pcalloc(p,sizeof(shib_dir_config));
147 shib_dir_config* parent=(shib_dir_config*)base;
148 shib_dir_config* child=(shib_dir_config*)sub;
150 if (child->szAuthGrpFile)
151 dc->szAuthGrpFile=ap_pstrdup(p,child->szAuthGrpFile);
152 else if (parent->szAuthGrpFile)
153 dc->szAuthGrpFile=ap_pstrdup(p,parent->szAuthGrpFile);
155 dc->szAuthGrpFile=NULL;
157 if (child->szApplicationId)
158 dc->szApplicationId=ap_pstrdup(p,child->szApplicationId);
159 else if (parent->szApplicationId)
160 dc->szApplicationId=ap_pstrdup(p,parent->szApplicationId);
162 dc->szApplicationId=NULL;
164 if (child->szRequireWith)
165 dc->szRequireWith=ap_pstrdup(p,child->szRequireWith);
166 else if (parent->szRequireWith)
167 dc->szRequireWith=ap_pstrdup(p,parent->szRequireWith);
169 dc->szRequireWith=NULL;
171 if (child->szRedirectToSSL)
172 dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
173 else if (parent->szRedirectToSSL)
174 dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
176 dc->szRedirectToSSL=NULL;
178 dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
179 dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
180 dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
181 dc->bExportAssertion=((child->bExportAssertion==-1) ? parent->bExportAssertion : child->bExportAssertion);
182 dc->bRequireAll=((child->bRequireAll==-1) ? parent->bRequireAll : child->bRequireAll);
186 // generic global slot handlers
187 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
189 *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
193 extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
195 char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
196 int offset=(int)parms->info;
197 *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
201 extern "C" const char* shib_ap_set_file_slot(cmd_parms* parms,
202 #ifdef SHIB_APACHE_13
203 char* arg1, char* arg2
205 void* arg1, const char* arg2
209 ap_set_file_slot(parms, arg1, arg2);
213 /********************************************************************************/
214 // Apache ShibTarget subclass(es) here.
216 class ShibTargetApache : public ShibTarget
219 ShibTargetApache(request_rec* req) {
220 m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
221 m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
224 m_sc->szScheme ? m_sc->szScheme : ap_http_method(req),
225 ap_get_server_name(req),
226 (int)ap_get_server_port(req),
228 ap_table_get(req->headers_in, "Content-type"),
229 req->connection->remote_ip,
235 ~ShibTargetApache() { }
237 virtual void log(ShibLogLevel level, const string &msg) {
238 ShibTarget::log(level,msg);
239 #ifdef SHIB_APACHE_13
240 ap_log_rerror(APLOG_MARK,
241 (level == LogLevelDebug ? APLOG_DEBUG :
242 (level == LogLevelInfo ? APLOG_INFO :
243 (level == LogLevelWarn ? APLOG_WARNING : APLOG_ERR)))|APLOG_NOERRNO, SH_AP_R(m_req), msg.c_str());
245 if (level == LogLevelError)
246 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(m_req), msg.c_str());
249 virtual string getCookies(void) const {
250 const char *c = ap_table_get(m_req->headers_in, "Cookie");
251 return string(c ? c : "");
253 virtual void setCookie(const string &name, const string &value) {
254 char* val = ap_psprintf(m_req->pool, "%s=%s", name.c_str(), value.c_str());
255 ap_table_addn(m_req->err_headers_out, "Set-Cookie", val);
257 virtual string getArgs(void) { return string(m_req->args ? m_req->args : ""); }
258 virtual string getPostData(void) {
259 // Read the posted data
260 if (ap_setup_client_block(m_req, REQUEST_CHUNKED_ERROR))
261 throw FatalProfileException("Apache function (setup_client_block) failed while reading profile submission.");
262 if (!ap_should_client_block(m_req))
263 throw FatalProfileException("Apache function (should_client_block) failed while reading profile submission.");
264 if (m_req->remaining > 1024*1024)
265 throw FatalProfileException("Blocked too-large a submission to profile endpoint.");
267 char buff[HUGE_STRING_LEN];
268 ap_hard_timeout("[mod_shib] getPostData", m_req);
269 memset(buff, 0, sizeof(buff));
270 while (ap_get_client_block(m_req, buff, sizeof(buff)-1) > 0) {
271 ap_reset_timeout(m_req);
273 memset(buff, 0, sizeof(buff));
275 ap_kill_timeout(m_req);
279 virtual void clearHeader(const string &name) {
280 ap_table_unset(m_req->headers_in, name.c_str());
281 ap_table_set(m_req->headers_in, name.c_str(), g_unsetHeaderValue.c_str());
283 virtual void setHeader(const string &name, const string &value) {
284 ap_table_set(m_req->headers_in, name.c_str(), value.c_str());
286 virtual string getHeader(const string &name) {
287 const char *hdr = ap_table_get(m_req->headers_in, name.c_str());
288 return string(hdr ? hdr : "");
290 virtual void setRemoteUser(const string &user) {
291 SH_AP_USER(m_req) = ap_pstrdup(m_req->pool, user.c_str());
293 virtual string getRemoteUser(void) {
294 return string(SH_AP_USER(m_req) ? SH_AP_USER(m_req) : "");
296 virtual void* sendPage(
299 const string& content_type="text/html",
300 const Iterator<header_t>& headers=EMPTY(header_t)
302 m_req->content_type = ap_psprintf(m_req->pool, content_type.c_str());
303 while (headers.hasNext()) {
304 const header_t& h=headers.next();
305 ap_table_set(m_req->headers_out, h.first.c_str(), h.second.c_str());
307 ap_send_http_header(m_req);
308 ap_rprintf(m_req, msg.c_str());
309 return (void*)((code==200) ? DONE : code);
311 virtual void* sendRedirect(const string& url) {
312 ap_table_set(m_req->headers_out, "Location", url.c_str());
313 return (void*)REDIRECT;
315 virtual void* returnDecline(void) { return (void*)DECLINED; }
316 virtual void* returnOK(void) { return (void*)OK; }
319 shib_dir_config* m_dc;
320 shib_server_config* m_sc;
323 /********************************************************************************/
326 extern "C" int shib_check_user(request_rec* r)
328 // Short-circuit entirely?
329 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
332 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_check_user(%d): ENTER\n", (int)getpid());
334 ostringstream threadid;
335 threadid << "[" << getpid() << "] shib_check_user" << '\0';
336 saml::NDC ndc(threadid.str().c_str());
339 ShibTargetApache sta(r);
341 // Check user authentication and export information, then set the handler bypass
342 pair<bool,void*> res = sta.doCheckAuthN(true);
343 apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
344 if (res.first) return (int)res.second;
346 // user auth was okay -- export the assertions now
347 res = sta.doExportAssertions();
348 if (res.first) return (int)res.second;
350 // export happened successfully.. this user is ok.
353 catch (SAMLException& e) {
354 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
359 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an uncaught exception!");
365 extern "C" int shib_handler(request_rec* r)
367 // Short-circuit entirely?
368 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
371 ostringstream threadid;
372 threadid << "[" << getpid() << "] shib_handler" << '\0';
373 saml::NDC ndc(threadid.str().c_str());
375 #ifndef SHIB_APACHE_13
376 // With 2.x, this handler always runs, though last.
377 // We check if shib_check_user ran, because it will detect a handler request
378 // and dispatch it directly.
380 apr_pool_userdata_get(&data,g_UserDataKey,r->pool);
381 if (data==(const void*)42) {
382 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler skipped since check_user ran");
387 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
390 ShibTargetApache sta(r);
392 pair<bool,void*> res = sta.doHandler();
393 if (res.first) return (int)res.second;
395 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
398 catch (SAMLException& e) {
399 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
404 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an uncaught exception!");
411 * shib_auth_checker() -- a simple resource manager to
412 * process the .htaccess settings
414 extern "C" int shib_auth_checker(request_rec* r)
416 // Short-circuit entirely?
417 if (((shib_dir_config*)ap_get_module_config(r->per_dir_config, &mod_shib))->bOff==1)
420 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r), "shib_auth_checker(%d): ENTER", (int)getpid());
422 ostringstream threadid;
423 threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
424 saml::NDC ndc(threadid.str().c_str());
427 ShibTargetApache sta(r);
429 pair<bool,void*> res = sta.doCheckAuthZ();
430 if (res.first) return (int)res.second;
435 catch (SAMLException& e) {
436 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
441 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an uncaught exception!");
447 // Access control plugin that enforces htaccess rules
448 class htAccessControl : virtual public IAccessControl
452 ~htAccessControl() {}
457 ISessionCacheEntry* entry
461 IPlugIn* htAccessFactory(const DOMElement* e)
463 return new htAccessControl();
466 class ApacheRequestMapper : public virtual IRequestMapper, public virtual IPropertySet
469 ApacheRequestMapper(const DOMElement* e);
470 ~ApacheRequestMapper() { delete m_mapper; delete m_htaccess; delete m_staKey; delete m_propsKey; }
471 void lock() { m_mapper->lock(); }
472 void unlock() { m_staKey->setData(NULL); m_propsKey->setData(NULL); m_mapper->unlock(); }
473 Settings getSettings(ShibTarget* st) const;
475 pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
476 pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
477 pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
478 pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
479 pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
480 const IPropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:target:config:1.0") const;
481 const DOMElement* getElement() const;
484 IRequestMapper* m_mapper;
486 ThreadKey* m_propsKey;
487 IAccessControl* m_htaccess;
490 IPlugIn* ApacheRequestMapFactory(const DOMElement* e)
492 return new ApacheRequestMapper(e);
495 ApacheRequestMapper::ApacheRequestMapper(const DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
497 IPlugIn* p=SAMLConfig::getConfig().getPlugMgr().newPlugin(shibtarget::XML::XMLRequestMapType,e);
498 m_mapper=dynamic_cast<IRequestMapper*>(p);
501 throw UnsupportedExtensionException("Embedded request mapper plugin was not of correct type.");
503 m_htaccess=new htAccessControl();
504 m_staKey=ThreadKey::create(NULL);
505 m_propsKey=ThreadKey::create(NULL);
508 IRequestMapper::Settings ApacheRequestMapper::getSettings(ShibTarget* st) const
510 Settings s=m_mapper->getSettings(st);
511 m_staKey->setData(dynamic_cast<ShibTargetApache*>(st));
512 m_propsKey->setData((void*)s.first);
513 return pair<const IPropertySet*,IAccessControl*>(this,s.second ? s.second : m_htaccess);
516 pair<bool,bool> ApacheRequestMapper::getBool(const char* name, const char* ns) const
518 ShibTargetApache* sta=reinterpret_cast<ShibTargetApache*>(m_staKey->getData());
519 const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
521 // Override Apache-settable boolean properties.
522 if (name && !strcmp(name,"requireSession") && sta->m_dc->bRequireSession==1)
523 return make_pair(true,true);
524 else if (name && !strcmp(name,"exportAssertion") && sta->m_dc->bExportAssertion==1)
525 return make_pair(true,true);
527 return s ? s->getBool(name,ns) : make_pair(false,false);
530 pair<bool,const char*> ApacheRequestMapper::getString(const char* name, const char* ns) const
532 ShibTargetApache* sta=reinterpret_cast<ShibTargetApache*>(m_staKey->getData());
533 const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
535 // Override Apache-settable string properties.
536 if (name && !strcmp(name,"authType")) {
537 const char *auth_type=ap_auth_type(sta->m_req);
539 // Check for Basic Hijack
540 if (!strcasecmp(auth_type, "basic") && sta->m_dc->bBasicHijack == 1)
541 auth_type = "shibboleth";
542 return make_pair(true,auth_type);
545 else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
546 return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
547 else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
548 return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
549 else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
550 return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
552 return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
555 pair<bool,const XMLCh*> ApacheRequestMapper::getXMLString(const char* name, const char* ns) const
557 const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
558 return s ? s->getXMLString(name,ns) : pair<bool,const XMLCh*>(false,NULL);
561 pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
563 ShibTargetApache* sta=reinterpret_cast<ShibTargetApache*>(m_staKey->getData());
564 const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
566 // Override Apache-settable int properties.
567 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
568 return pair<bool,unsigned int>(true,strtol(sta->m_dc->szRedirectToSSL,NULL,10));
570 return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
573 pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
575 ShibTargetApache* sta=reinterpret_cast<ShibTargetApache*>(m_staKey->getData());
576 const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
578 // Override Apache-settable int properties.
579 if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
580 return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
582 return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
585 const IPropertySet* ApacheRequestMapper::getPropertySet(const char* name, const char* ns) const
587 const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
588 return s ? s->getPropertySet(name,ns) : NULL;
591 const DOMElement* ApacheRequestMapper::getElement() const
593 const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
594 return s ? s->getElement() : NULL;
597 static SH_AP_TABLE* groups_for_user(request_rec* r, const char* user, char* grpfile)
600 SH_AP_TABLE* grps=ap_make_table(r->pool,15);
601 char l[MAX_STRING_LEN];
602 const char *group_name, *ll, *w;
604 #ifdef SHIB_APACHE_13
605 if (!(f=ap_pcfg_openfile(r->pool,grpfile))) {
607 if (ap_pcfg_openfile(&f,r->pool,grpfile) != APR_SUCCESS) {
609 ap_log_rerror(APLOG_MARK,APLOG_DEBUG,SH_AP_R(r),"groups_for_user() could not open group file: %s\n",grpfile);
614 #ifdef SHIB_APACHE_13
615 sp=ap_make_sub_pool(r->pool);
617 if (apr_pool_create(&sp,r->pool) != APR_SUCCESS) {
618 ap_log_rerror(APLOG_MARK,APLOG_ERR,0,r,
619 "groups_for_user() could not create a subpool");
624 while (!(ap_cfg_getline(l,MAX_STRING_LEN,f))) {
625 if ((*l=='#') || (!*l))
630 group_name=ap_getword(sp,&ll,':');
633 w=ap_getword_conf(sp,&ll);
634 if (!strcmp(w,user)) {
635 ap_table_setn(grps,ap_pstrdup(r->pool,group_name),"in");
645 bool htAccessControl::authorized(
647 ISessionCacheEntry* entry
650 // Make sure the object is our type.
651 ShibTargetApache* sta=dynamic_cast<ShibTargetApache*>(st);
653 throw ConfigurationException("Request wrapper object was not of correct type.");
657 int m=sta->m_req->method_number;
658 bool method_restricted=false;
661 const array_header* reqs_arr=ap_requires(sta->m_req);
665 require_line* reqs=(require_line*)reqs_arr->elts;
667 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE nelts: %d", reqs_arr->nelts);
668 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(sta->m_req),"REQUIRE all: %d", sta->m_dc->bRequireAll);
670 vector<bool> auth_OK(reqs_arr->nelts,false);
672 #define SHIB_AP_CHECK_IS_OK { \
673 if (sta->m_dc->bRequireAll < 1) \
679 for (int x=0; x<reqs_arr->nelts; x++) {
681 if (!(reqs[x].method_mask & (1 << m)))
683 method_restricted=true;
684 string remote_user = st->getRemoteUser();
686 t = reqs[x].requirement;
687 w = ap_getword_white(sta->m_req->pool, &t);
689 if (!strcasecmp(w,"shibboleth")) {
690 // This is a dummy rule needed because Apache conflates authn and authz.
691 // Without some require rule, AuthType is ignored and no check_user hooks run.
694 else if (!strcmp(w,"valid-user")) {
696 st->log(ShibTarget::LogLevelDebug,"htAccessControl plugin accepting valid-user based on active session");
700 st->log(ShibTarget::LogLevelError,"htAccessControl plugin rejecting access for valid-user rule, no session is active");
702 else if (!strcmp(w,"user") && !remote_user.empty()) {
705 w=ap_getword_conf(sta->m_req->pool,&t);
713 // To do regex matching, we have to convert from UTF-8.
714 auto_ptr<XMLCh> trans(fromUTF8(w));
715 RegularExpression re(trans.get());
716 auto_ptr<XMLCh> trans2(fromUTF8(remote_user.c_str()));
717 if (re.matches(trans2.get())) {
718 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin accepting user (") + w + ")");
722 catch (XMLException& ex) {
723 auto_ptr_char tmp(ex.getMessage());
724 st->log(ShibTarget::LogLevelError,
725 string("htAccessControl plugin caught exception while parsing regular expression (") + w + "): " + tmp.get());
728 else if (remote_user==w) {
729 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin accepting user (") + w + ")");
734 else if (!strcmp(w,"group")) {
735 SH_AP_TABLE* grpstatus=NULL;
736 if (sta->m_dc->szAuthGrpFile && !remote_user.empty()) {
737 st->log(ShibTarget::LogLevelDebug,string("htAccessControl plugin using groups file: ") + sta->m_dc->szAuthGrpFile);
738 grpstatus=groups_for_user(sta->m_req,remote_user.c_str(),sta->m_dc->szAuthGrpFile);
744 w=ap_getword_conf(sta->m_req->pool,&t);
745 if (ap_table_get(grpstatus,w)) {
746 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin accepting group (") + w + ")");
752 Iterator<IAAP*> provs=st->getApplication()->getAAPProviders();
753 AAP wrapper(provs,w);
754 if (wrapper.fail()) {
755 st->log(ShibTarget::LogLevelWarn, string("htAccessControl plugin didn't recognize require rule: ") + w);
761 if (!strcmp(wrapper->getHeader(),"REMOTE_USER"))
762 vals=remote_user.c_str();
764 vals=ap_table_get(sta->m_req->headers_in,wrapper->getHeader());
765 while (*t && vals && *vals) {
766 w=ap_getword_conf(sta->m_req->pool,&t);
773 auto_ptr<RegularExpression> re;
776 auto_ptr<XMLCh> trans(fromUTF8(w));
777 auto_ptr<RegularExpression> temp(new RegularExpression(trans.get()));
781 string vals_str(vals);
783 for (unsigned int i = 0; i < vals_str.length(); i++) {
784 if (vals_str.at(i) == ';') {
786 st->log(ShibTarget::LogLevelError, string("htAccessControl plugin found invalid header encoding (") +
787 vals + "): starts with a semicolon");
788 throw SAMLException("Invalid information supplied to authorization plugin.");
791 if (vals_str.at(i-1) == '\\') {
792 vals_str.erase(i-1, 1);
797 string val = vals_str.substr(j, i-j);
800 auto_ptr<XMLCh> trans(fromUTF8(val.c_str()));
801 if (re->matches(trans.get())) {
802 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin expecting ") + w +
803 ", got " + val + ": authorization granted");
807 else if ((wrapper->getCaseSensitive() && val==w) || (!wrapper->getCaseSensitive() && !strcasecmp(val.c_str(),w))) {
808 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin expecting ") + w +
809 ", got " + val + ": authorization granted.");
813 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin expecting ") + w +
814 ", got " + val + ": authoritzation not granted.");
819 string val = vals_str.substr(j, vals_str.length()-j);
821 auto_ptr<XMLCh> trans(fromUTF8(val.c_str()));
822 if (re->matches(trans.get())) {
823 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin expecting ") + w +
824 ", got " + val + ": authorization granted.");
828 else if ((wrapper->getCaseSensitive() && val==w) || (!wrapper->getCaseSensitive() && !strcasecmp(val.c_str(),w))) {
829 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin expecting ") + w +
830 ", got " + val + ": authorization granted");
834 st->log(ShibTarget::LogLevelDebug, string("htAccessControl plugin expecting ") + w +
835 ", got " + val + ": authorization not granted");
838 catch (XMLException& ex) {
839 auto_ptr_char tmp(ex.getMessage());
840 st->log(ShibTarget::LogLevelError, string("htAccessControl plugin caught exception while parsing regular expression (")
841 + w + "): " + tmp.get());
847 // check if all require directives are true
848 bool auth_all_OK = true;
849 for (int i= 0; i<reqs_arr->nelts; i++) {
850 auth_all_OK &= auth_OK[i];
852 if (auth_all_OK || !method_restricted)
858 #ifndef SHIB_APACHE_13
861 * Empty cleanup hook, Apache 2.x doesn't check NULL very well...
863 extern "C" apr_status_t shib_exit(void* data)
866 g_Config->shutdown();
869 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,0,NULL,"shib_exit() done\n");
877 * Cleanup the (per-process) pool info.
879 #ifdef SHIB_APACHE_13
880 extern "C" void shib_child_exit(server_rec* s, SH_AP_POOL* p)
883 extern "C" apr_status_t shib_child_exit(void* data)
885 server_rec* s = NULL;
888 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit(%d) dealing with g_Config..", (int)getpid());
889 g_Config->shutdown();
891 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_exit() done\n");
893 #ifndef SHIB_APACHE_13
900 * Things to do when the child process is initialized.
901 * (or after the configs are read in apache-2)
903 #ifdef SHIB_APACHE_13
904 extern "C" void shib_child_init(server_rec* s, SH_AP_POOL* p)
906 extern "C" void shib_child_init(apr_pool_t* p, server_rec* s)
909 // Initialize runtime components.
911 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init(%d) starting", (int)getpid());
914 ap_log_error(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() already initialized!");
919 g_Config=&ShibTargetConfig::getConfig();
920 g_Config->setFeatures(
921 ShibTargetConfig::Listener |
922 ShibTargetConfig::Metadata |
923 ShibTargetConfig::AAP |
924 ShibTargetConfig::RequestMapper |
925 ShibTargetConfig::LocalExtensions |
926 ShibTargetConfig::Logging
928 if (!g_Config->init(g_szSchemaDir)) {
929 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
932 SAMLConfig::getConfig().getPlugMgr().regFactory(shibtarget::XML::htAccessControlType,&htAccessFactory);
933 SAMLConfig::getConfig().getPlugMgr().regFactory(shibtarget::XML::NativeRequestMapType,&ApacheRequestMapFactory);
934 // We hijack the legacy type so that 1.2 config files will load this plugin
935 SAMLConfig::getConfig().getPlugMgr().regFactory(shibtarget::XML::LegacyRequestMapType,&ApacheRequestMapFactory);
937 if (!g_Config->load(g_szSHIBConfig)) {
938 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
942 IConfig* conf=g_Config->getINI();
944 const IPropertySet* props=conf->getPropertySet("Local");
946 pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
947 if (unsetValue.first)
948 g_unsetHeaderValue = unsetValue.second;
952 ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize system");
956 // Set the cleanup handler
957 apr_pool_cleanup_register(p, NULL, &shib_exit, &shib_child_exit);
959 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() done");
962 typedef const char* (*config_fn_t)(void);
964 #ifdef SHIB_APACHE_13
966 // SHIB Module commands
968 static command_rec shire_cmds[] = {
969 {"SHIREConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
970 RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
971 {"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
972 RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
973 {"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
974 RSRC_CONF, TAKE1, "Path to Shibboleth XML schema directory"},
976 {"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
977 (void *) XtOffsetOf (shib_server_config, szScheme),
978 RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
980 {"ShibDisable", (config_fn_t)ap_set_flag_slot,
981 (void *) XtOffsetOf (shib_dir_config, bOff),
982 OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
983 {"ShibApplicationId", (config_fn_t)ap_set_string_slot,
984 (void *) XtOffsetOf (shib_dir_config, szApplicationId),
985 OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
986 {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
987 (void *) XtOffsetOf (shib_dir_config, bBasicHijack),
988 OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
989 {"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
990 (void *) XtOffsetOf (shib_dir_config, bRequireSession),
991 OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
992 {"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
993 (void *) XtOffsetOf (shib_dir_config, szRequireWith),
994 OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
995 {"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
996 (void *) XtOffsetOf (shib_dir_config, bExportAssertion),
997 OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
998 {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
999 (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
1000 OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
1001 {"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1002 (void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
1003 OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
1004 {"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1005 (void *) XtOffsetOf (shib_dir_config, bRequireAll),
1006 OR_AUTHCFG, FLAG, "All require directives must match"},
1012 handler_rec shib_handlers[] = {
1013 { "shib-handler", shib_handler },
1017 module MODULE_VAR_EXPORT mod_shib = {
1018 STANDARD_MODULE_STUFF,
1019 NULL, /* initializer */
1020 create_shib_dir_config, /* dir config creater */
1021 merge_shib_dir_config, /* dir merger --- default is to override */
1022 create_shib_server_config, /* server config */
1023 merge_shib_server_config, /* merge server config */
1024 shire_cmds, /* command table */
1025 shib_handlers, /* handlers */
1026 NULL, /* filename translation */
1027 shib_check_user, /* check_user_id */
1028 shib_auth_checker, /* check auth */
1029 NULL, /* check access */
1030 NULL, /* type_checker */
1033 NULL, /* header parser */
1034 shib_child_init, /* child_init */
1035 shib_child_exit, /* child_exit */
1036 NULL /* post read-request */
1039 #elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
1041 extern "C" void shib_register_hooks (apr_pool_t *p)
1043 ap_hook_child_init(shib_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1044 ap_hook_check_user_id(shib_check_user, NULL, NULL, APR_HOOK_MIDDLE);
1045 ap_hook_auth_checker(shib_auth_checker, NULL, NULL, APR_HOOK_FIRST);
1046 ap_hook_handler(shib_handler, NULL, NULL, APR_HOOK_LAST);
1049 // SHIB Module commands
1052 static command_rec shib_cmds[] = {
1053 AP_INIT_TAKE1("ShibConfig",
1054 (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
1055 RSRC_CONF, "Path to shibboleth.xml config file"),
1056 AP_INIT_TAKE1("ShibSchemaDir",
1057 (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
1058 RSRC_CONF, "Path to Shibboleth XML schema directory"),
1060 AP_INIT_TAKE1("ShibURLScheme",
1061 (config_fn_t)shib_set_server_string_slot,
1062 (void *) offsetof (shib_server_config, szScheme),
1063 RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
1065 AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
1066 (void *) offsetof (shib_dir_config, bOff),
1067 OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
1068 AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
1069 (void *) offsetof (shib_dir_config, szApplicationId),
1070 OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
1071 AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
1072 (void *) offsetof (shib_dir_config, bBasicHijack),
1073 OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
1074 AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
1075 (void *) offsetof (shib_dir_config, bRequireSession),
1076 OR_AUTHCFG, "Initiates a new session if one does not exist"),
1077 AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
1078 (void *) offsetof (shib_dir_config, szRequireWith),
1079 OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
1080 AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
1081 (void *) offsetof (shib_dir_config, bExportAssertion),
1082 OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
1083 AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
1084 (void *) offsetof (shib_dir_config, szRedirectToSSL),
1085 OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
1086 AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
1087 (void *) offsetof (shib_dir_config, szAuthGrpFile),
1088 OR_AUTHCFG, "Text file containing group names and member user IDs"),
1089 AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
1090 (void *) offsetof (shib_dir_config, bRequireAll),
1091 OR_AUTHCFG, "All require directives must match"),
1096 module AP_MODULE_DECLARE_DATA mod_shib = {
1097 STANDARD20_MODULE_STUFF,
1098 create_shib_dir_config, /* create dir config */
1099 merge_shib_dir_config, /* merge dir config --- default is to override */
1100 create_shib_server_config, /* create server config */
1101 merge_shib_server_config, /* merge server config */
1102 shib_cmds, /* command table */
1103 shib_register_hooks /* register hooks */
1107 #error "undefined APACHE version"