/*
+ * Copyright 2001-2005 Internet2
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
* mod_apache.cpp -- the core Apache Module code
*
* Created by: Derek Atkins <derek@ihtfp.com>
#undef _XOPEN_SOURCE // causes gethostname conflict in unistd.h
#endif
+#ifdef WIN32
+# define _CRT_NONSTDC_NO_DEPRECATE 1
+# define _CRT_SECURE_NO_DEPRECATE 1
+#endif
+
// SAML Runtime
#include <saml/saml.h>
#include <shib/shib.h>
-#include <shib/shib-threads.h>
#include <shib-target/shib-target.h>
+#include <shibsp/SPConfig.h>
#include <xercesc/util/regx/RegularExpression.hpp>
+#ifdef WIN32
+# include <winsock.h>
+#endif
+
#undef _XPG4_2
// Apache specific header files
#include <unistd.h> // for getpid()
#endif
-using namespace std;
-using namespace saml;
-using namespace shibboleth;
+using namespace shibsp;
using namespace shibtarget;
+using namespace saml;
+using namespace xmltooling;
+using namespace std;
extern "C" module MODULE_VAR_EXPORT mod_shib;
char* g_szSHIBConfig = NULL;
char* g_szSchemaDir = NULL;
ShibTargetConfig* g_Config = NULL;
+ string g_unsetHeaderValue;
static const char* g_UserDataKey = "_shib_check_user_";
}
// Content Configuration
char* szApplicationId; // Shib applicationId value
char* szRequireWith; // require a session using a specific initiator?
+ char* szRedirectToSSL; // redirect non-SSL requests to SSL port
int bOff; // flat-out disable all Shib processing
int bBasicHijack; // activate for AuthType Basic?
int bRequireSession; // require a session?
dc->bRequireSession = -1;
dc->bExportAssertion = -1;
dc->bRequireAll = -1;
+ dc->szRedirectToSSL = NULL;
dc->szAuthGrpFile = NULL;
dc->szApplicationId = NULL;
dc->szRequireWith = NULL;
else
dc->szRequireWith=NULL;
+ if (child->szRedirectToSSL)
+ dc->szRedirectToSSL=ap_pstrdup(p,child->szRedirectToSSL);
+ else if (parent->szRedirectToSSL)
+ dc->szRedirectToSSL=ap_pstrdup(p,parent->szRedirectToSSL);
+ else
+ dc->szRedirectToSSL=NULL;
+
dc->bOff=((child->bOff==-1) ? parent->bOff : child->bOff);
dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
dc->bRequireSession=((child->bRequireSession==-1) ? parent->bRequireSession : child->bRequireSession);
extern "C" const char* shib_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
{
char* base=(char*)ap_get_module_config(parms->server->module_config,&mod_shib);
- int offset=(int)parms->info;
+ size_t offset=(size_t)parms->info;
*((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
return NULL;
}
class ShibTargetApache : public ShibTarget
{
+ mutable string m_body;
+ mutable bool m_gotBody;
+
public:
- ShibTargetApache(request_rec* req) {
+ request_rec* m_req;
+ shib_dir_config* m_dc;
+ shib_server_config* m_sc;
+
+ ShibTargetApache(request_rec* req) : m_gotBody(false) {
m_sc = (shib_server_config*)ap_get_module_config(req->server->module_config, &mod_shib);
m_dc = (shib_dir_config*)ap_get_module_config(req->per_dir_config, &mod_shib);
m_req = req;
}
- ~ShibTargetApache() { }
+ virtual ~ShibTargetApache() {}
virtual void log(ShibLogLevel level, const string &msg) {
ShibTarget::log(level,msg);
char* val = ap_psprintf(m_req->pool, "%s=%s", name.c_str(), value.c_str());
ap_table_addn(m_req->err_headers_out, "Set-Cookie", val);
}
- virtual string getArgs(void) { return string(m_req->args ? m_req->args : ""); }
- virtual string getPostData(void) {
+ virtual const char* getQueryString() const { return m_req->args; }
+ virtual const char* getRequestBody() const {
+ if (m_gotBody)
+ return m_body.c_str();
// Read the posted data
if (ap_setup_client_block(m_req, REQUEST_CHUNKED_ERROR))
- throw FatalProfileException("Apache function (setup_client_block) failed while reading profile submission.");
+ throw SAMLException("Apache function (setup_client_block) failed while reading POST request body.");
if (!ap_should_client_block(m_req))
- throw FatalProfileException("Apache function (should_client_block) failed while reading profile submission.");
+ throw SAMLException("Apache function (should_client_block) failed while reading POST request body.");
if (m_req->remaining > 1024*1024)
- throw FatalProfileException("Blocked too-large a submission to profile endpoint.");
- string cgistr;
+ throw SAMLException("Blocked POST request body larger than size limit.");
+ m_gotBody=true;
char buff[HUGE_STRING_LEN];
- ap_hard_timeout("[mod_shib] getPostData", m_req);
+ ap_hard_timeout("[mod_shib] getRequestBody", m_req);
memset(buff, 0, sizeof(buff));
while (ap_get_client_block(m_req, buff, sizeof(buff)-1) > 0) {
ap_reset_timeout(m_req);
- cgistr += buff;
+ m_body += buff;
memset(buff, 0, sizeof(buff));
}
ap_kill_timeout(m_req);
-
- return cgistr;
+ return m_body.c_str();
}
virtual void clearHeader(const string &name) {
ap_table_unset(m_req->headers_in, name.c_str());
+ ap_table_set(m_req->headers_in, name.c_str(), g_unsetHeaderValue.c_str());
}
virtual void setHeader(const string &name, const string &value) {
ap_table_set(m_req->headers_in, name.c_str(), value.c_str());
}
virtual void* returnDecline(void) { return (void*)DECLINED; }
virtual void* returnOK(void) { return (void*)OK; }
-
- request_rec* m_req;
- shib_dir_config* m_dc;
- shib_server_config* m_sc;
};
/********************************************************************************/
threadid << "[" << getpid() << "] shib_check_user" << '\0';
saml::NDC ndc(threadid.str().c_str());
-#ifndef _DEBUG
try {
-#endif
ShibTargetApache sta(r);
- // Check user authentication, the set the handler bypass
+ // Check user authentication and export information, then set the handler bypass
pair<bool,void*> res = sta.doCheckAuthN(true);
apr_pool_userdata_setn((const void*)42,g_UserDataKey,NULL,r->pool);
if (res.first) return (int)res.second;
// export happened successfully.. this user is ok.
return OK;
-
+ }
+ catch (SAMLException& e) {
+ ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an exception: %s", e.what());
+ return SERVER_ERROR;
+ }
#ifndef _DEBUG
- } catch (...) {
+ catch (...) {
ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_check_user threw an uncaught exception!");
return SERVER_ERROR;
}
ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,SH_AP_R(r),"shib_handler(%d): ENTER: %s", (int)getpid(), r->handler);
-#ifndef _DEBUG
try {
-#endif
ShibTargetApache sta(r);
pair<bool,void*> res = sta.doHandler();
ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "doHandler() did not do anything.");
return SERVER_ERROR;
-
+ }
+ catch (SAMLException& e) {
+ ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an exception: %s", e.what());
+ return SERVER_ERROR;
+ }
#ifndef _DEBUG
- } catch (...) {
+ catch (...) {
ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_handler threw an uncaught exception!");
return SERVER_ERROR;
}
threadid << "[" << getpid() << "] shib_auth_checker" << '\0';
saml::NDC ndc(threadid.str().c_str());
-#ifndef _DEBUG
try {
-#endif
ShibTargetApache sta(r);
pair<bool,void*> res = sta.doCheckAuthZ();
// We're all okay.
return OK;
-
+ }
+ catch (SAMLException& e) {
+ ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an exception: %s", e.what());
+ return SERVER_ERROR;
+ }
#ifndef _DEBUG
- } catch (...) {
+ catch (...) {
ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, SH_AP_R(r), "shib_auth_checker threw an uncaught exception!");
return SERVER_ERROR;
}
return new ApacheRequestMapper(e);
}
-ApacheRequestMapper::ApacheRequestMapper(const DOMElement* e) : m_mapper(NULL), m_htaccess(NULL), m_staKey(NULL), m_propsKey(NULL)
+ApacheRequestMapper::ApacheRequestMapper(const DOMElement* e) : m_mapper(NULL), m_staKey(NULL), m_propsKey(NULL), m_htaccess(NULL)
{
IPlugIn* p=SAMLConfig::getConfig().getPlugMgr().newPlugin(shibtarget::XML::XMLRequestMapType,e);
m_mapper=dynamic_cast<IRequestMapper*>(p);
}
}
else if (name && !strcmp(name,"applicationId") && sta->m_dc->szApplicationId)
- return make_pair(true,sta->m_dc->szApplicationId);
+ return pair<bool,const char*>(true,sta->m_dc->szApplicationId);
else if (name && !strcmp(name,"requireSessionWith") && sta->m_dc->szRequireWith)
- return make_pair(true,sta->m_dc->szRequireWith);
+ return pair<bool,const char*>(true,sta->m_dc->szRequireWith);
+ else if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
+ return pair<bool,const char*>(true,sta->m_dc->szRedirectToSSL);
}
return s ? s->getString(name,ns) : pair<bool,const char*>(false,NULL);
}
pair<bool,unsigned int> ApacheRequestMapper::getUnsignedInt(const char* name, const char* ns) const
{
+ ShibTargetApache* sta=reinterpret_cast<ShibTargetApache*>(m_staKey->getData());
const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
+ if (sta && !ns) {
+ // Override Apache-settable int properties.
+ if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
+ return pair<bool,unsigned int>(true,strtol(sta->m_dc->szRedirectToSSL,NULL,10));
+ }
return s ? s->getUnsignedInt(name,ns) : pair<bool,unsigned int>(false,0);
}
pair<bool,int> ApacheRequestMapper::getInt(const char* name, const char* ns) const
{
+ ShibTargetApache* sta=reinterpret_cast<ShibTargetApache*>(m_staKey->getData());
const IPropertySet* s=reinterpret_cast<const IPropertySet*>(m_propsKey->getData());
+ if (sta && !ns) {
+ // Override Apache-settable int properties.
+ if (name && !strcmp(name,"redirectToSSL") && sta->m_dc->szRedirectToSSL)
+ return pair<bool,int>(true,atoi(sta->m_dc->szRedirectToSSL));
+ }
return s ? s->getInt(name,ns) : pair<bool,int>(false,0);
}
t = reqs[x].requirement;
w = ap_getword_white(sta->m_req->pool, &t);
- if (!strcasecmp(w,"Shibboleth")) {
+ if (!strcasecmp(w,"shibboleth")) {
// This is a dummy rule needed because Apache conflates authn and authz.
// Without some require rule, AuthType is ignored and no check_user hooks run.
SHIB_AP_CHECK_IS_OK;
}
else if (!strcmp(w,"valid-user")) {
- st->log(ShibTarget::LogLevelDebug,"htAccessControl plugin accepting valid-user");
- SHIB_AP_CHECK_IS_OK;
+ if (entry) {
+ st->log(ShibTarget::LogLevelDebug,"htAccessControl plugin accepting valid-user based on active session");
+ SHIB_AP_CHECK_IS_OK;
+ }
+ else
+ st->log(ShibTarget::LogLevelError,"htAccessControl plugin rejecting access for valid-user rule, no session is active");
}
else if (!strcmp(w,"user") && !remote_user.empty()) {
bool regexp=false;
}
}
else {
- Iterator<IAAP*> provs=st->getApplication()->getAAPProviders();
- AAP wrapper(provs,w);
+ Iterator<shibboleth::IAAP*> provs=st->getApplication()->getAAPProviders();
+ shibboleth::AAP wrapper(provs,w);
if (wrapper.fail()) {
st->log(ShibTarget::LogLevelWarn, string("htAccessControl plugin didn't recognize require rule: ") + w);
continue;
}
bool regexp=false;
- const char* vals=ap_table_get(sta->m_req->headers_in,wrapper->getHeader());
- while (*t && vals) {
+ const char* vals;
+ if (!strcmp(wrapper->getHeader(),"REMOTE_USER"))
+ vals=remote_user.c_str();
+ else
+ vals=ap_table_get(sta->m_req->headers_in,wrapper->getHeader());
+ while (*t && vals && *vals) {
w=ap_getword_conf(sta->m_req->pool,&t);
if (*w=='~') {
regexp=true;
string vals_str(vals);
int j = 0;
- for (int i = 0; i < vals_str.length(); i++) {
+ for (unsigned int i = 0; i < vals_str.length(); i++) {
if (vals_str.at(i) == ';') {
if (i == 0) {
st->log(ShibTarget::LogLevelError, string("htAccessControl plugin found invalid header encoding (") +
try {
g_Config=&ShibTargetConfig::getConfig();
- g_Config->setFeatures(
- ShibTargetConfig::Listener |
- ShibTargetConfig::Metadata |
- ShibTargetConfig::AAP |
- ShibTargetConfig::RequestMapper |
- ShibTargetConfig::LocalExtensions |
- ShibTargetConfig::Logging
+ SPConfig::getConfig().setFeatures(
+ SPConfig::Caching |
+ SPConfig::Listener |
+ SPConfig::Metadata |
+ SPConfig::AAP |
+ SPConfig::RequestMapper |
+ SPConfig::InProcess |
+ SPConfig::Logging
);
if (!g_Config->init(g_szSchemaDir)) {
ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize libraries");
ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to load configuration");
exit(1);
}
+
+ IConfig* conf=g_Config->getINI();
+ Locker locker(conf);
+ const IPropertySet* props=conf->getPropertySet("Local");
+ if (props) {
+ pair<bool,const char*> unsetValue=props->getString("unsetHeaderValue");
+ if (unsetValue.first)
+ g_unsetHeaderValue = unsetValue.second;
+ }
}
catch (...) {
ap_log_error(APLOG_MARK,APLOG_CRIT|APLOG_NOERRNO,SH_AP_R(s),"shib_child_init() failed to initialize system");
// SHIB Module commands
static command_rec shire_cmds[] = {
- {"SHIREConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
- RSRC_CONF, TAKE1, "Path to shibboleth.xml config file."},
{"ShibConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
- RSRC_CONF, TAKE1, "Path to shibboleth.xml config file."},
+ RSRC_CONF, TAKE1, "Path to shibboleth.xml config file"},
{"ShibSchemaDir", (config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
- RSRC_CONF, TAKE1, "Path to Shibboleth XML schema directory."},
+ RSRC_CONF, TAKE1, "Path to Shibboleth XML schema directory"},
{"ShibURLScheme", (config_fn_t)shib_set_server_string_slot,
(void *) XtOffsetOf (shib_server_config, szScheme),
- RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost."},
+ RSRC_CONF, TAKE1, "URL scheme to force into generated URLs for a vhost"},
{"ShibDisable", (config_fn_t)ap_set_flag_slot,
(void *) XtOffsetOf (shib_dir_config, bOff),
OR_AUTHCFG, FLAG, "Disable all Shib module activity here to save processing effort"},
{"ShibApplicationId", (config_fn_t)ap_set_string_slot,
(void *) XtOffsetOf (shib_dir_config, szApplicationId),
- OR_AUTHCFG, FLAG, "Set Shibboleth applicationId property for content"},
+ OR_AUTHCFG, TAKE1, "Set Shibboleth applicationId property for content"},
{"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
(void *) XtOffsetOf (shib_dir_config, bBasicHijack),
- OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shib?"},
+ OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shibboleth"},
{"ShibRequireSession", (config_fn_t)ap_set_flag_slot,
(void *) XtOffsetOf (shib_dir_config, bRequireSession),
- OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist."},
+ OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist"},
{"ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
(void *) XtOffsetOf (shib_dir_config, szRequireWith),
- OR_AUTHCFG, FLAG, "Initiates a new session if one does not exist using a specific SessionInitiator"},
+ OR_AUTHCFG, TAKE1, "Initiates a new session if one does not exist using a specific SessionInitiator"},
{"ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
(void *) XtOffsetOf (shib_dir_config, bExportAssertion),
- OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header?"},
+ OR_AUTHCFG, FLAG, "Export SAML attribute assertion(s) to Shib-Attributes header"},
+ {"ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
+ (void *) XtOffsetOf (shib_dir_config, szRedirectToSSL),
+ OR_AUTHCFG, TAKE1, "Redirect non-SSL requests to designated port" },
{"AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
(void *) XtOffsetOf (shib_dir_config, szAuthGrpFile),
OR_AUTHCFG, TAKE1, "text file containing group names and member user IDs"},
{"ShibRequireAll", (config_fn_t)ap_set_flag_slot,
(void *) XtOffsetOf (shib_dir_config, bRequireAll),
- OR_AUTHCFG, FLAG, "All require directives must match!"},
+ OR_AUTHCFG, FLAG, "All require directives must match"},
{NULL}
};
NULL /* post read-request */
};
-#elif defined(SHIB_APACHE_20)
+#elif defined(SHIB_APACHE_20) || defined(SHIB_APACHE_22)
extern "C" void shib_register_hooks (apr_pool_t *p)
{
static command_rec shib_cmds[] = {
AP_INIT_TAKE1("ShibConfig",
(config_fn_t)ap_set_global_string_slot, &g_szSHIBConfig,
- RSRC_CONF, "Path to shibboleth.xml config file."),
+ RSRC_CONF, "Path to shibboleth.xml config file"),
AP_INIT_TAKE1("ShibSchemaDir",
(config_fn_t)ap_set_global_string_slot, &g_szSchemaDir,
- RSRC_CONF, "Path to Shibboleth XML schema directory."),
+ RSRC_CONF, "Path to Shibboleth XML schema directory"),
AP_INIT_TAKE1("ShibURLScheme",
(config_fn_t)shib_set_server_string_slot,
(void *) offsetof (shib_server_config, szScheme),
- RSRC_CONF, "URL scheme to force into generated URLs for a vhost."),
+ RSRC_CONF, "URL scheme to force into generated URLs for a vhost"),
AP_INIT_FLAG("ShibDisable", (config_fn_t)ap_set_flag_slot,
- (void *) offsetof (shib_dir_config, bOff),
+ (void *) offsetof (shib_dir_config, bOff),
OR_AUTHCFG, "Disable all Shib module activity here to save processing effort"),
- AP_INIT_FLAG("ShibApplicationId", (config_fn_t)ap_set_string_slot,
- (void *) offsetof (shib_dir_config, szApplicationId),
+ AP_INIT_TAKE1("ShibApplicationId", (config_fn_t)ap_set_string_slot,
+ (void *) offsetof (shib_dir_config, szApplicationId),
OR_AUTHCFG, "Set Shibboleth applicationId property for content"),
AP_INIT_FLAG("ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
- (void *) offsetof (shib_dir_config, bBasicHijack),
- OR_AUTHCFG, "Respond to AuthType Basic and convert to shib?"),
+ (void *) offsetof (shib_dir_config, bBasicHijack),
+ OR_AUTHCFG, "Respond to AuthType Basic and convert to shibboleth"),
AP_INIT_FLAG("ShibRequireSession", (config_fn_t)ap_set_flag_slot,
- (void *) offsetof (shib_dir_config, bRequireSession),
- OR_AUTHCFG, "Initiates a new session if one does not exist."),
- AP_INIT_FLAG("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
- (void *) offsetof (shib_dir_config, szRequireWith),
+ (void *) offsetof (shib_dir_config, bRequireSession),
+ OR_AUTHCFG, "Initiates a new session if one does not exist"),
+ AP_INIT_TAKE1("ShibRequireSessionWith", (config_fn_t)ap_set_string_slot,
+ (void *) offsetof (shib_dir_config, szRequireWith),
OR_AUTHCFG, "Initiates a new session if one does not exist using a specific SessionInitiator"),
AP_INIT_FLAG("ShibExportAssertion", (config_fn_t)ap_set_flag_slot,
- (void *) offsetof (shib_dir_config, bExportAssertion),
- OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header?"),
+ (void *) offsetof (shib_dir_config, bExportAssertion),
+ OR_AUTHCFG, "Export SAML attribute assertion(s) to Shib-Attributes header"),
+ AP_INIT_TAKE1("ShibRedirectToSSL", (config_fn_t)ap_set_string_slot,
+ (void *) offsetof (shib_dir_config, szRedirectToSSL),
+ OR_AUTHCFG, "Redirect non-SSL requests to designated port"),
AP_INIT_TAKE1("AuthGroupFile", (config_fn_t)shib_ap_set_file_slot,
(void *) offsetof (shib_dir_config, szAuthGrpFile),
OR_AUTHCFG, "Text file containing group names and member user IDs"),
AP_INIT_FLAG("ShibRequireAll", (config_fn_t)ap_set_flag_slot,
- (void *) offsetof (shib_dir_config, bRequireAll),
- OR_AUTHCFG, "All require directives must match!"),
+ (void *) offsetof (shib_dir_config, bRequireAll),
+ OR_AUTHCFG, "All require directives must match"),
{NULL}
};