2 * mod_shire.cpp -- the SHIRE Apache Module
4 * Created by: Derek Atkins <derek@ihtfp.com>
9 // Apache specific header files
11 #include "http_config.h"
12 #include "http_protocol.h"
13 #include "http_main.h"
14 #include "util_script.h"
16 #include "http_core.h"
19 // For POST processing from Apache
20 #include <libapreq/apache_request.h>
27 #include <shib-target.h>
34 using namespace shibboleth;
35 using namespace shibtarget;
37 static RPCHandle *rpc_handle = NULL;
39 extern "C" module MODULE_VAR_EXPORT shire_module;
40 char* g_szSHIREConfig = NULL;
42 // per-server configuration structure
43 struct shire_server_config
45 char* szCookieName; // name of session token
46 char* szWAYFLocation; // URL of WAYF service
47 char* szSHIRELocation; // URL of SHIRE acceptance point
48 int bSSLOnly; // SSL only for this SHIRE?
49 int bNormalizeRequest; // normalize requested URL based on server name?
52 // creates the per-server configuration
53 extern "C" void* create_shire_server_config (pool * p, server_rec * s)
55 shire_server_config* sc=(shire_server_config*)ap_pcalloc(p,sizeof(shire_server_config));
56 sc->szCookieName = NULL;
57 sc->szWAYFLocation = NULL;
58 sc->szSHIRELocation = NULL;
60 sc->bNormalizeRequest = -1;
64 // overrides server configuration in virtual servers
65 extern "C" void* merge_shire_server_config (pool* p, void* base, void* sub)
67 shire_server_config* sc=(shire_server_config*)ap_pcalloc(p,sizeof(shire_server_config));
68 shire_server_config* parent=(shire_server_config*)base;
69 shire_server_config* child=(shire_server_config*)sub;
71 if (child->szCookieName)
72 sc->szCookieName=ap_pstrdup(p,child->szCookieName);
73 else if (parent->szCookieName)
74 sc->szCookieName=ap_pstrdup(p,parent->szCookieName);
76 sc->szCookieName=NULL;
78 if (child->szWAYFLocation)
79 sc->szWAYFLocation=ap_pstrdup(p,child->szWAYFLocation);
80 else if (parent->szWAYFLocation)
81 sc->szWAYFLocation=ap_pstrdup(p,parent->szWAYFLocation);
83 sc->szWAYFLocation=NULL;
85 if (child->szSHIRELocation)
86 sc->szSHIRELocation=ap_pstrdup(p,child->szSHIRELocation);
87 else if (parent->szSHIRELocation)
88 sc->szSHIRELocation=ap_pstrdup(p,parent->szSHIRELocation);
90 sc->szSHIRELocation=NULL;
92 sc->bSSLOnly=((child->bSSLOnly==-1) ? parent->bSSLOnly : child->bSSLOnly);
93 sc->bNormalizeRequest=((child->bNormalizeRequest==-1) ? parent->bNormalizeRequest : child->bNormalizeRequest);
97 // per-dir module configuration structure
98 struct shire_dir_config
100 int bBasicHijack; // activate for AuthType Basic?
101 int bSSLOnly; // only over SSL?
102 int checkIPAddress; // placeholder for check
103 SHIREConfig config; // SHIRE Configuration
106 // creates per-directory config structure
107 extern "C" void* create_shire_dir_config (pool* p, char* d)
109 shire_dir_config* dc=(shire_dir_config*)ap_pcalloc(p,sizeof(shire_dir_config));
110 dc->bBasicHijack = -1;
112 dc->checkIPAddress = -1;
113 dc->config.lifetime = -1;
114 dc->config.timeout = -1;
118 // overrides server configuration in directories
119 extern "C" void* merge_shire_dir_config (pool* p, void* base, void* sub)
121 shire_dir_config* dc=(shire_dir_config*)ap_pcalloc(p,sizeof(shire_dir_config));
122 shire_dir_config* parent=(shire_dir_config*)base;
123 shire_dir_config* child=(shire_dir_config*)sub;
125 dc->bSSLOnly=((child->bSSLOnly==-1) ? parent->bSSLOnly : child->bSSLOnly);
126 dc->bBasicHijack=((child->bBasicHijack==-1) ? parent->bBasicHijack : child->bBasicHijack);
127 dc->checkIPAddress=((child->checkIPAddress==-1) ? parent->checkIPAddress : child->checkIPAddress);
128 dc->config.lifetime=((child->config.lifetime==-1) ? parent->config.lifetime : child->config.lifetime);
129 dc->config.timeout=((child->config.timeout==-1) ? parent->config.timeout : child->config.timeout);
133 // generic global slot handlers
134 extern "C" const char* ap_set_global_string_slot(cmd_parms* parms, void*, const char* arg)
136 *((char**)(parms->info))=ap_pstrdup(parms->pool,arg);
140 // generic per-server slot handlers
141 extern "C" const char* ap_set_server_string_slot(cmd_parms* parms, void*, const char* arg)
143 char* base=(char*)ap_get_module_config(parms->server->module_config,&shire_module);
144 int offset=(int)parms->info;
145 *((char**)(base + offset))=ap_pstrdup(parms->pool,arg);
149 extern "C" const char* set_normalize(cmd_parms* parms, shire_server_config* sc, const char* arg)
151 sc->bNormalizeRequest=atoi(arg);
155 // some shortcuts for directory config slots
156 extern "C" const char* set_lifetime(cmd_parms* parms, shire_dir_config* dc, const char* arg)
158 dc->config.lifetime=atoi(arg);
162 extern "C" const char* set_timeout(cmd_parms* parms, shire_dir_config* dc, const char* arg)
164 dc->config.timeout=atoi(arg);
171 typedef const char* (*config_fn_t)(void);
173 // SHIRE Module commands
175 static command_rec shire_cmds[] = {
176 {"SHIREConfig", (config_fn_t)ap_set_global_string_slot, &g_szSHIREConfig,
177 RSRC_CONF, TAKE1, "Path to SHIRE ini file."},
179 {"SHIRELocation", (config_fn_t)ap_set_server_string_slot,
180 (void *) XtOffsetOf (shire_server_config, szSHIRELocation),
181 RSRC_CONF, TAKE1, "URL of SHIRE handle acceptance point."},
182 {"SHIRESSLOnly", (config_fn_t)ap_set_flag_slot,
183 (void *) XtOffsetOf (shire_server_config, bSSLOnly),
184 RSRC_CONF, FLAG, "Require SSL when POSTING to the SHIRE?"},
185 {"WAYFLocation", (config_fn_t)ap_set_server_string_slot,
186 (void *) XtOffsetOf (shire_server_config, szWAYFLocation),
187 RSRC_CONF, TAKE1, "URL of WAYF service."},
188 {"ShibCookieName", (config_fn_t)ap_set_server_string_slot,
189 (void *) XtOffsetOf (shire_server_config, szCookieName),
190 RSRC_CONF, TAKE1, "Name of cookie to use as session token."},
191 {"ShibNormalizeRequest", (config_fn_t)set_normalize, NULL,
192 RSRC_CONF, TAKE1, "Normalize/convert browser requests using server name when redirecting."},
194 {"ShibBasicHijack", (config_fn_t)ap_set_flag_slot,
195 (void *) XtOffsetOf (shire_dir_config, bBasicHijack),
196 OR_AUTHCFG, FLAG, "Respond to AuthType Basic and convert to shib?"},
197 {"ShibSSLOnly", (config_fn_t)ap_set_flag_slot,
198 (void *) XtOffsetOf (shire_dir_config, bSSLOnly),
199 OR_AUTHCFG, FLAG, "Require SSL when accessing a secured directory?"},
200 {"ShibCheckAddress", (config_fn_t)ap_set_flag_slot,
201 (void *) XtOffsetOf (shire_dir_config, checkIPAddress),
202 OR_AUTHCFG, FLAG, "Verify IP address of requester matches token?"},
203 {"ShibAuthLifetime", (config_fn_t)set_lifetime, NULL,
204 OR_AUTHCFG, TAKE1, "Lifetime of session in seconds."},
205 {"ShibAuthTimeout", (config_fn_t)set_timeout, NULL,
206 OR_AUTHCFG, TAKE1, "Timeout for session in seconds."},
215 * Things to do when the child process is initialized.
217 extern "C" void shire_child_init(server_rec* s, pool* p)
219 // Initialize runtime components.
221 if (shib_target_initialize (SHIBTARGET_SHIRE, g_szSHIREConfig)) {
222 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,s,
223 "shire_child_init() failed to initialize SHIB Target");
227 // Create the RPC Handle.. Note: this should be per _thread_
228 // if there is some way to do that reasonably..
229 rpc_handle = new RPCHandle(SHIB_SHAR_SOCKET, SHIBRPC_PROG, SHIBRPC_VERS_1);
231 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,s,"shire_child_init() done");
239 extern "C" void shire_child_exit(server_rec* s, pool* p)
242 shib_target_finalize();
243 ap_log_error(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,s,"shire_child_exit() done");
246 inline char hexchar(unsigned short s)
248 return (s<=9) ? ('0' + s) : ('A' + s - 10);
251 static char* url_encode(request_rec* r, const char* s)
253 static char badchars[]="\"\\+<>#%{}|^~[]`;/?:@=&";
254 char* ret=(char*)ap_palloc(r->pool,sizeof(char)*3*strlen(s)+1);
256 unsigned long count=0;
259 if (strchr(badchars,*s)!=NULL || *s<=0x1F || *s>=0x7F)
262 ret[count++]=hexchar(*s >> 4);
263 ret[count++]=hexchar(*s & 0x0F);
272 static const char* get_target(request_rec* r, const char* target)
274 shire_server_config* sc=
275 (shire_server_config*)ap_get_module_config(r->server->module_config,&shire_module);
276 if (sc->bNormalizeRequest)
278 const char* colon=strchr(target,':');
279 const char* slash=strchr(colon+3,'/');
280 const char* second_colon=strchr(colon+3,':');
281 return ap_pstrcat(r->pool,ap_pstrndup(r->pool,target,colon+3-target),ap_get_server_name(r),
282 (second_colon && second_colon < slash) ? second_colon : slash,NULL);
287 static const char* get_shire_location(request_rec* r, const char* target, bool encode)
289 shire_server_config* sc=
290 (shire_server_config*)ap_get_module_config(r->server->module_config,&shire_module);
291 if (*(sc->szSHIRELocation)!='/') {
293 return url_encode(r,sc->szSHIRELocation);
295 return sc->szSHIRELocation;
297 const char* colon=strchr(target,':');
298 const char* slash=strchr(colon+3,'/');
300 return url_encode(r,ap_pstrcat(r->pool,ap_pstrndup(r->pool,target,slash-target),
301 sc->szSHIRELocation,NULL));
303 return ap_pstrcat(r->pool,ap_pstrndup(r->pool,target,slash-target),
304 sc->szSHIRELocation,NULL);
307 static bool is_shire_location(const char* target, const char* shire)
309 if (!strstr(target, shire))
312 const char* colon=strchr(target,':');
313 const char* slash=strchr(colon+3,'/');
314 return (!strcmp(slash,shire));
317 extern "C" int shire_check_user(request_rec* r)
319 ap_log_rerror(APLOG_MARK,APLOG_INFO|APLOG_NOERRNO,r,
320 "shire_check_user: ENTER");
322 shire_server_config* sc=
323 (shire_server_config*)ap_get_module_config(r->server->module_config,&shire_module);
324 shire_dir_config* dc=
325 (shire_dir_config*)ap_get_module_config(r->per_dir_config,&shire_module);
327 const char* targeturl=get_target(r,ap_construct_url(r->pool,r->unparsed_uri,r));
329 const char * shire_location = get_shire_location(r,targeturl,true);
330 string shire_url = get_shire_location(r,targeturl,false);
331 dc->config.checkIPAddress = (dc->checkIPAddress == 1 ? true : false);
332 SHIRE shire(rpc_handle, dc->config, shire_url);
334 if (is_shire_location (targeturl, sc->szSHIRELocation)) {
335 // Process SHIRE POST
337 ap_log_rerror(APLOG_MARK,APLOG_INFO|APLOG_NOERRNO,r,
338 "shire_check_user() Beginning SHIRE POST processing");
341 // Make sure this is SSL, if it should be
342 if (sc->bSSLOnly==1 && strcmp(ap_http_method(r),"https"))
344 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
345 "shire_check_user() blocked non-SSL access to SHIRE POST processor");
349 // Make sure this is a POST
350 if (strcasecmp (r->method, "POST")) {
351 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
352 "shire_check_user() blocked non-POST to SHIRE POST processor");
356 // Sure sure this POST is an appropriate content type
357 const char *ct = ap_table_get (r->headers_in, "Content-type");
358 if (strcasecmp (ct, "application/x-www-form-urlencoded")) {
359 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
360 "shire_check_user() blocked bad content-type to SHIRE POST processor");
365 // Make sure the "bytes sent" is a reasonable number
366 if (r->bytes_sent > 1024*1024) { // 1MB?
367 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
368 "shire_check_user() blocked too-large a post to SHIRE POST processor");
373 // Read the posted data
374 ApacheRequest *ap_req = ApacheRequest_new(r);
375 int err = ApacheRequest_parse(ap_req);
377 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
378 "shire_check_user() ApacheRequest_parse() failed with %d.", err);
383 // Make sure the target parameter exists
384 const char *target = ApacheRequest_param(ap_req, "TARGET");
385 if (!target || *target == '\0') {
387 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
388 "shire_check_user() SHIRE POST failed to find TARGET");
393 // Make sure the SAML Response parameter exists
394 const char *post = ApacheRequest_param(ap_req, "SAMLResponse");
395 if (!post || *post == '\0') {
397 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
398 "shire_check_user() SHIRE POST failed to find SAMLResponse");
403 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
404 "shire_check_user() Processing POST for target: %s", target);
407 "PFJlc3BvbnNlIHhtbG5zPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoxLjA6cHJvdG9jb2wi"
408 "IHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoxLjA6cHJvdG9jb2wiIElz"
409 "c3VlSW5zdGFudD0iMjAwMi0wOS0xN1QwNDowMDowMFoiIE1ham9yVmVyc2lvbj0iMSIgTWlu"
410 "b3JWZXJzaW9uPSIwIiBSZWNpcGllbnQ9Imh0dHA6Ly9sb2NhbGhvc3Qvc2hpYmJvbGV0aC9T"
411 "SElSRSIgUmVzcG9uc2VJRD0iYmI3ZjZmYjQtMmU0YS00YzY1LTgzY2QtYjIyMjQ0OWQwYmY4"
412 "Ij48U3RhdHVzPjxTdGF0dXNDb2RlIFZhbHVlPSJzYW1scDpTdWNjZXNzIj48L1N0YXR1c0Nv"
413 "ZGU+PC9TdGF0dXM+PEFzc2VydGlvbiB4bWxucz0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6"
414 "MS4wOmFzc2VydGlvbiIgQXNzZXJ0aW9uSUQ9IjZhYzUxYTg2LTJhNTgtNDM2My1hZjlkLTQy"
415 "YjQzYTRhMGNiZSIgSXNzdWVJbnN0YW50PSIyMDAyLTA5LTE3VDA0OjAwOjAwWiIgSXNzdWVy"
416 "PSJzaGlicHJvZDAuaW50ZXJuZXQyLmVkdSIgTWFqb3JWZXJzaW9uPSIxIiBNaW5vclZlcnNp"
417 "b249IjAiPjxDb25kaXRpb25zIE5vdEJlZm9yZT0iMjAwMi0wOS0xN1QwMjo1MDowMFoiIE5v"
418 "dE9uT3JBZnRlcj0iMjAwMi0wOS0xN1QwNDowMDowMFoiPjxBdWRpZW5jZVJlc3RyaWN0aW9u"
419 "Q29uZGl0aW9uPjxBdWRpZW5jZT5odHRwOi8vbWlkZGxld2FyZS5pbnRlcm5ldDIuZWR1L3No"
420 "aWJib2xldGgvY2x1YnMvY2x1YnNoaWIvMjAwMi8wNS88L0F1ZGllbmNlPjwvQXVkaWVuY2VS"
421 "ZXN0cmljdGlvbkNvbmRpdGlvbj48L0NvbmRpdGlvbnM+PEF1dGhlbnRpY2F0aW9uU3RhdGVt"
422 "ZW50IEF1dGhlbnRpY2F0aW9uSW5zdGFudD0iMjAwMi0wOS0xN1QwNDowMDowMFoiIEF1dGhl"
423 "bnRpY2F0aW9uTWV0aG9kPSJCYXNpYyI+PFN1YmplY3Q+PE5hbWVJZGVudGlmaWVyIE5hbWVR"
424 "dWFsaWZpZXI9ImV4YW1wbGUuZWR1Ij40YzBmYjg2Yi01NjQwLTQ1ZTUtOTM3Ny1mNTJkNjhh"
425 "ZDNiNjQ8L05hbWVJZGVudGlmaWVyPjxTdWJqZWN0Q29uZmlybWF0aW9uPjxDb25maXJtYXRp"
426 "b25NZXRob2Q+dXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6MS4wOmNtOkJlYXJlcjwvQ29uZmly"
427 "bWF0aW9uTWV0aG9kPjwvU3ViamVjdENvbmZpcm1hdGlvbj48L1N1YmplY3Q+PFN1YmplY3RM"
428 "b2NhbGl0eSBJUEFkZHJlc3M9IjE4LjEwMS4xLjEyIj48L1N1YmplY3RMb2NhbGl0eT48QXV0"
429 "aG9yaXR5QmluZGluZyBBdXRob3JpdHlLaW5kPSJzYW1scDpBdHRyaWJ1dGVRdWVyeSIgQmlu"
430 "ZGluZz0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6MS4wOmJpbmRpbmdzOlNPQVAtYmluZGlu"
431 "ZyIgTG9jYXRpb249Imh0dHBzOi8vc2hpYnByb2QwLmludGVybmV0Mi5lZHUvc2hpYmJvbGV0"
432 "aC9BQSI+PC9BdXRob3JpdHlCaW5kaW5nPjwvQXV0aGVudGljYXRpb25TdGF0ZW1lbnQ+PC9B"
433 "c3NlcnRpb24+PC9SZXNwb25zZT4K";
437 RPCError status = shire.sessionCreate(post, r->connection->remote_ip, cookie);
439 if (status.isError()) {
440 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
441 "shire_check_user() POST processes failed (%d): %s",
442 status.status, status.error_msg.c_str());
444 // XXX: respond to the user here?
448 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
449 "shire_check_user() POST process succeeded. New cookie: %s",
452 // We've got a good session, set the cookie...
453 char * domain = NULL;
454 char * new_cookie = ap_psprintf(r->pool, "%s=%s; path=/%s%s",
457 (domain ? "; domain=" : ""),
458 (domain ? domain : ""));
460 ap_table_setn(r->err_headers_out, "Set-Cookie", new_cookie);
461 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
462 "shire_check_user() Set cookie: %s", new_cookie);
465 const char* stored_cookie = ap_table_get(r->err_headers_out, "Set-Cookie");
466 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
467 "shire_check_user() Stored cookie: %s", stored_cookie);
470 // ... and redirect to the target
471 char* redir=ap_pstrcat(r->pool,url_encode(r,target),NULL);
472 ap_table_setn(r->headers_out, "Location", target);
476 // Regular access to arbitrary resource...check AuthType
478 const char *auth_type=ap_auth_type (r);
482 if (strcasecmp(auth_type,"shibboleth"))
484 if (!strcasecmp(auth_type,"basic") && dc->bBasicHijack==1)
486 core_dir_config* conf=
487 (core_dir_config*)ap_get_module_config(r->per_dir_config,
488 ap_find_linked_module("http_core.c"));
489 conf->ap_auth_type="shibboleth";
495 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
496 "shire_check_user() Shib check for %s", targeturl);
499 if (dc->bSSLOnly==1 && strcmp(ap_http_method(r),"https"))
501 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
502 "shire_check_user() blocked non-SSL access");
506 // We're in charge, so check for cookie.
507 const char* session_id=NULL;
508 const char* cookies=ap_table_get(r->headers_in,"Cookie");
511 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
512 "shire_check_user() cookies found: %s",
515 if (!cookies || !(session_id=strstr(cookies,sc->szCookieName)))
517 // No cookie. Redirect to WAYF.
518 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
519 "shire_check_user() no cookie found -- redirecting to WAYF");
520 char* wayf=ap_pstrcat(r->pool,sc->szWAYFLocation,
521 "?shire=",shire_location,
522 "&target=",url_encode(r,targeturl),NULL);
523 ap_table_setn(r->headers_out,"Location",wayf);
527 // Yep, we found a cookie -- pull it out (our session_id)
528 session_id+=strlen(sc->szCookieName) + 1; /* Skip over the '=' */
529 char* cookiebuf = ap_pstrdup(r->pool,session_id);
530 char* cookieend = strchr(cookiebuf,';');
532 *cookieend = '\0'; /* Ignore anyting after a ; */
533 session_id=cookiebuf;
535 // Make sure this session is still valid
536 RPCError status = shire.sessionIsValid(session_id, r->connection->remote_ip);
539 if (status.isError()) {
541 ap_log_rerror(APLOG_MARK,APLOG_INFO|APLOG_NOERRNO,r,
542 "shire_check_user() session invalid: %s",
543 status.error_msg.c_str());
545 // Oops, session is invalid. Redirect to WAYF.
546 char* wayf=ap_pstrcat(r->pool,sc->szWAYFLocation,
547 "?shire=",shire_location,
548 "&target=",url_encode(r,targeturl),NULL);
549 ap_table_setn(r->headers_out,"Location",wayf);
553 ap_log_rerror(APLOG_MARK,APLOG_DEBUG|APLOG_NOERRNO,r,
554 "shire_check_user() success");
559 ap_log_rerror(APLOG_MARK,APLOG_ERR|APLOG_NOERRNO,r,
560 "shire_check_user() server error");
565 module MODULE_VAR_EXPORT shire_module = {
566 STANDARD_MODULE_STUFF,
567 NULL, /* initializer */
568 create_shire_dir_config, /* dir config creater */
569 merge_shire_dir_config, /* dir merger --- default is to override */
570 create_shire_server_config, /* server config */
571 merge_shire_server_config, /* merge server config */
572 shire_cmds, /* command table */
574 NULL, /* filename translation */
575 shire_check_user, /* check_user_id */
576 NULL, /* check auth */
577 NULL, /* check access */
578 NULL, /* type_checker */
581 NULL, /* header parser */
582 shire_child_init, /* child_init */
583 shire_child_exit, /* child_exit */
584 NULL /* post read-request */