X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.c;h=4f46bca7841af575abd0864b45688e426f7e73a7;hp=0cc7fe49669eb3d0a1c16ffae4194c5a43d74037;hb=87f0ae57e99080a66d8f925c655d60a5da4668a0;hpb=40e7fbc3038c7c66a5ed20e07eb9f1a591e070ff diff --git a/cgi.c b/cgi.c index 0cc7fe49..4f46bca7 100644 --- a/cgi.c +++ b/cgi.c @@ -1,4 +1,4 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.64 2002/04/24 02:17:21 oes Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.102 2008/02/23 16:33:43 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ @@ -11,8 +11,8 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.64 2002/04/24 02:17:21 oes Exp $"; * Functions declared include: * * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * Privoxy team. http://www.privoxy.org/ + * Copyright : Written by and Copyright (C) 2001-2004, 2006-2007 + * the SourceForge Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -38,6 +38,242 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.64 2002/04/24 02:17:21 oes Exp $"; * * Revisions : * $Log: cgi.c,v $ + * Revision 1.102 2008/02/23 16:33:43 fabiankeil + * Let forward_url() use the standard parameter ordering + * and mark its second parameter immutable. + * + * Revision 1.101 2008/02/03 15:45:06 fabiankeil + * Add SOCKS5 support for "Forwarding failure" CGI page. + * + * Revision 1.100 2007/10/17 18:40:53 fabiankeil + * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0. + * - White space fix. + * + * Revision 1.99 2007/08/05 13:42:22 fabiankeil + * #1763173 from Stefan Huehner: declare some more functions static. + * + * Revision 1.98 2007/05/14 10:33:51 fabiankeil + * - Use strlcpy() and strlcat() instead of strcpy() and strcat(). + * + * Revision 1.97 2007/04/09 18:11:35 fabiankeil + * Don't mistake VC++'s _snprintf() for a snprintf() replacement. + * + * Revision 1.96 2007/03/08 17:41:05 fabiankeil + * Use sizeof() more often. + * + * Revision 1.95 2007/02/10 17:01:37 fabiankeil + * Don't overlook map result for the forwarding-type. + * + * Revision 1.94 2007/02/08 19:44:49 fabiankeil + * Use a transparent background for the PNG replacement pattern. + * + * Revision 1.93 2007/02/07 10:45:22 fabiankeil + * - Save the reason for generating http_responses. + * - Fix --disable-toggle (again). + * - Use TBL birthday hack for 403 responses as well. + * - Uglify the @menu@ again to fix JavaScript + * errors on the "blocked" template. + * - Escape an ampersand in cgi_error_unknown(). + * + * Revision 1.92 2007/01/28 13:41:17 fabiankeil + * - Add HEAD support to finish_http_response. + * - Add error favicon to internal HTML error messages. + * + * Revision 1.91 2007/01/27 13:09:16 fabiankeil + * Add new config option "templdir" to + * change the templates directory. + * + * Revision 1.90 2007/01/25 13:47:26 fabiankeil + * Added "forwarding-failed" template support for error_response(). + * + * Revision 1.89 2007/01/23 15:51:16 fabiankeil + * Add favicon delivery functions. + * + * Revision 1.88 2007/01/23 13:14:32 fabiankeil + * - Map variables that aren't guaranteed to be + * pure ASCII html_encoded. + * - Use CGI_PREFIX to generate URL for user manual + * CGI page to make sure CGI_SITE_2_PATH is included. + * + * Revision 1.87 2007/01/22 15:34:13 fabiankeil + * - "Protect" against a rather lame JavaScript-based + * Privoxy detection "attack" and check the referrer + * before delivering the CGI style sheet. + * - Move referrer check for unsafe CGI pages into + * referrer_is_safe() and log the result. + * - Map @url@ in cgi-error-disabled page. + * It's required for the "go there anyway" link. + * - Mark *csp as immutable for grep_cgi_referrer(). + * + * Revision 1.86 2007/01/09 11:54:26 fabiankeil + * Fix strdup() error handling in cgi_error_unknown() + * and cgi_error_no_template(). Reported by Markus Elfring. + * + * Revision 1.85 2007/01/05 14:19:02 fabiankeil + * Handle pcrs_execute() errors in template_fill() properly. + * + * Revision 1.84 2006/12/28 17:54:22 fabiankeil + * Fixed gcc43 conversion warnings and replaced sprintf + * calls with snprintf to give OpenBSD's gcc one less reason + * to complain. + * + * Revision 1.83 2006/12/17 19:35:19 fabiankeil + * Escape ampersand in Privoxy menu. + * + * Revision 1.82 2006/12/17 17:53:39 fabiankeil + * Suppress the toggle link if remote toggling is disabled. + * + * Revision 1.81 2006/12/09 13:49:16 fabiankeil + * Fix configure option --disable-toggle. + * Thanks to Peter Thoenen for reporting this. + * + * Revision 1.80 2006/12/08 14:45:32 fabiankeil + * Don't lose the FORCE_PREFIX in case of + * connection problems. Fixes #612235. + * + * Revision 1.79 2006/11/13 19:05:50 fabiankeil + * Make pthread mutex locking more generic. Instead of + * checking for OSX and OpenBSD, check for FEATURE_PTHREAD + * and use mutex locking unless there is an _r function + * available. Better safe than sorry. + * + * Fixes "./configure --disable-pthread" and should result + * in less threading-related problems on pthread-using platforms, + * but it still doesn't fix BR#1122404. + * + * Revision 1.78 2006/09/21 19:22:07 fabiankeil + * Use CGI_PREFIX to check the referrer. + * The check for "http://config.privoxy.org/" fails + * if the user modified CGI_SITE_2_HOST. + * + * Revision 1.77 2006/09/21 15:17:23 fabiankeil + * Adjusted headers for Privoxy's cgi responses: + * Don't set Last-Modified, Expires and Cache-Control + * headers for redirects; always set "Connection: close". + * + * Revision 1.76 2006/09/07 14:06:38 fabiankeil + * Only predate the Last-Modified header for cgi responses + * that are delivered with status code 404 or 503. + * + * Revision 1.75 2006/09/07 11:56:39 fabiankeil + * Mark cgi_send_user_manual as harmless, + * to fix the access denied problem Hal spotted. + * The manual has no secret content, therefore we + * don't have to care about "secure" referrers. + * + * Revision 1.74 2006/09/06 18:45:03 fabiankeil + * Incorporate modified version of Roland Rosenfeld's patch to + * optionally access the user-manual via Privoxy. Closes patch 679075. + * + * Formatting changed to Privoxy style, added call to + * cgi_error_no_template if the requested file doesn't + * exist and modified check whether or not Privoxy itself + * should serve the manual. Should work cross-platform now. + * + * Revision 1.73 2006/08/03 02:46:41 david__schmidt + * Incorporate Fabian Keil's patch work: http://www.fabiankeil.de/sourcecode/privoxy/ + * + * Revision 1.72 2006/07/18 14:48:45 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.70.2.13 2004/02/17 13:30:23 oes + * Moved cgi_error_disabled() from cgiedit.c to + * cgi.c to re-enable build with --disable-editor. + * Fixes Bug #892744. Thanks to Matthew Fischer + * for spotting. + * + * Revision 1.70.2.12 2003/12/17 16:33:16 oes + * - Added new function cgi_redirect to handle creation of + * HTTP redirect messages formerly repeated in the code. + * - Send cgi_error_disabled instead of cgi_error_404 when + * referrer check fails + * - Dynamic content now gets Expires header field with date + * in the past + * + * Revision 1.70.2.11 2003/10/23 12:29:26 oes + * Bugfix: Transparent PNG was not transparent. Thanks to + * Dan Razzell of Starfish Systems for notice and new PNG. + * + * Revision 1.70.2.10 2003/06/06 07:54:25 oes + * Security fix: dspatch_known_cgi no longer considers an empty + * referrer safe for critical CGIs, since malicious links could + * reside on https:// locations which browsers don't advertize as + * referrers. Closes bug #749916, thanks to Jeff Epler for the + * hint. Goodbye One-Click[tm] toggling :-( + * + * Revision 1.70.2.9 2003/05/08 15:11:31 oes + * Nit + * + * Revision 1.70.2.8 2003/04/29 13:33:51 oes + * Killed a compiler warning on OSX + * + * Revision 1.70.2.7 2003/04/03 13:50:58 oes + * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS + * (fixes bug #710056) + * - Show toggle info only if we have it + * + * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt + * Move declaration of struct tm dummy outside of a control block so it is + * accessible later on during snprintf in get_http_time. + * + * Revision 1.70.2.5 2003/03/11 11:53:58 oes + * Cosmetic: Renamed cryptic variable + * + * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt + * Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX. Hopefully this will take care of all of those pesky crash reports. + * + * Revision 1.70.2.3 2002/11/28 18:14:32 oes + * Disable access to critical CGIs via untrusted referrers. + * This prevents users from being tricked by malicious websites + * into making unintentional configuration changes: + * + * - Added flag to each cgi_dispatcher that allows or denies + * external linking + * - Introduced proviorical function that greps for the + * referrer header before regular header parsing happens + * - Added safety check to dispatch_known_cgi. CGI is called + * if (cgi harmless || no referrer || we are referrer). + * Else a) toggle calls are modified not to change status and + * b) all other calls are denied. + * + * Revision 1.70.2.2 2002/11/12 16:20:37 oes + * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651 + * + * Revision 1.70.2.1 2002/08/05 11:17:46 oes + * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query + * + * Revision 1.70 2002/05/19 11:33:20 jongfoster + * If a CGI error was not handled, and propogated back to + * dispatch_known_cgi(), then it was assumed to be "out of memory". + * This gave a very misleading error message. + * + * Now other errors will cause a simple message giving the error + * number and asking the user to report a bug. + * + * Bug report: + * http://sourceforge.net/tracker/index.php?func=detail + * &aid=557905&group_id=11118&atid=111118 + * + * Revision 1.69 2002/05/14 21:28:40 oes + * - Fixed add_help_link to link to the (now split) actions + * part of the config chapter + * - Renamed helplink export to actions-help-prefix + * + * Revision 1.68 2002/05/12 21:36:29 jongfoster + * Correcting function comments + * + * Revision 1.67 2002/04/30 12:02:07 oes + * Nit: updated a comment + * + * Revision 1.66 2002/04/26 18:32:57 jongfoster + * Fixing a memory leak on error + * + * Revision 1.65 2002/04/26 12:53:51 oes + * - New function add_help_link + * - default_exports now exports links to the user manual + * and a prefix for links into the config chapter + * * Revision 1.64 2002/04/24 02:17:21 oes * - Better descriptions for CGIs * - Hide edit-actions, more shortcuts @@ -367,24 +603,25 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.64 2002/04/24 02:17:21 oes Exp $"; #include #include -#ifdef _WIN32 -#define snprintf _snprintf -#endif /* def _WIN32 */ - #include "project.h" #include "cgi.h" #include "list.h" #include "encode.h" #include "ssplit.h" #include "errlog.h" +#include "filters.h" #include "miscutil.h" #include "cgisimple.h" +#include "jbsockets.h" #ifdef FEATURE_CGI_EDIT_ACTIONS #include "cgiedit.h" #endif /* def FEATURE_CGI_EDIT_ACTIONS */ #include "loadcfg.h" -/* loadcfg.h is for g_bToggleIJB only */ - +/* loadcfg.h is for global_toggle_state only */ +#ifdef FEATURE_PTHREAD +#include "jcc.h" +/* jcc.h is for mutex semaphore globals only */ +#endif /* def FEATURE_PTHREAD */ const char cgi_h_rcs[] = CGI_H_VERSION; /* @@ -395,114 +632,138 @@ const char cgi_h_rcs[] = CGI_H_VERSION; static const struct cgi_dispatcher cgi_dispatchers[] = { { "", cgi_default, - "Privoxy main page" }, + "Privoxy main page", + TRUE }, #ifdef FEATURE_GRACEFUL_TERMINATION { "die", cgi_die, "Shut down - Do not deploy this build in a production environment, " - "this is a one click Denial Of Service attack!!!" }, + "this is a one click Denial Of Service attack!!!", + FALSE }, #endif { "show-status", cgi_show_status, - "View & change the current configuration" }, +#ifdef FEATURE_CGI_EDIT_ACTIONS + "View & change the current configuration", +#else + "View the current configuration", +#endif + TRUE }, { "show-version", cgi_show_version, - "View the source code version numbers" }, + "View the source code version numbers", + TRUE }, { "show-request", cgi_show_request, - "View the request headers." }, + "View the request headers.", + TRUE }, { "show-url-info", cgi_show_url_info, - "Look up which actions apply to a URL and why" }, + "Look up which actions apply to a URL and why", + TRUE }, #ifdef FEATURE_CGI_EDIT_ACTIONS +#ifdef FEATURE_TOGGLE { "toggle", cgi_toggle, - "Toggle Privoxy on or off" }, - + "Toggle Privoxy on or off", + FALSE }, +#endif /* def FEATURE_TOGGLE */ { "edit-actions", /* Edit the actions list */ cgi_edit_actions, - NULL }, + NULL, FALSE }, { "eaa", /* Shortcut for edit-actions-add-url-form */ cgi_edit_actions_add_url_form, - NULL }, + NULL, FALSE }, { "eau", /* Shortcut for edit-actions-url-form */ cgi_edit_actions_url_form, - NULL }, + NULL, FALSE }, { "ear", /* Shortcut for edit-actions-remove-url-form */ cgi_edit_actions_remove_url_form, - NULL }, + NULL, FALSE }, + { "eal", /* Shortcut for edit-actions-list */ + cgi_edit_actions_list, + NULL, FALSE }, { "eafu", /* Shortcut for edit-actions-for-url */ cgi_edit_actions_for_url, - NULL }, + NULL, FALSE }, { "eas", /* Shortcut for edit-actions-submit */ cgi_edit_actions_submit, - NULL }, + NULL, FALSE }, { "easa", /* Shortcut for edit-actions-section-add */ cgi_edit_actions_section_add, - NULL }, + NULL, FALSE }, { "easr", /* Shortcut for edit-actions-section-remove */ cgi_edit_actions_section_remove, - NULL }, + NULL, FALSE }, { "eass", /* Shortcut for edit-actions-section-swap */ cgi_edit_actions_section_swap, - NULL }, + NULL, FALSE }, { "edit-actions-for-url", cgi_edit_actions_for_url, - NULL /* Edit the actions for (a) specified URL(s) */ }, + NULL, FALSE /* Edit the actions for (a) specified URL(s) */ }, { "edit-actions-list", cgi_edit_actions_list, - NULL /* Edit the actions list */ }, + NULL, TRUE /* Edit the actions list */ }, { "edit-actions-submit", cgi_edit_actions_submit, - NULL /* Change the actions for (a) specified URL(s) */ }, + NULL, FALSE /* Change the actions for (a) specified URL(s) */ }, { "edit-actions-url", cgi_edit_actions_url, - NULL /* Change a URL pattern in the actionsfile */ }, + NULL, FALSE /* Change a URL pattern in the actionsfile */ }, { "edit-actions-url-form", cgi_edit_actions_url_form, - NULL /* Form to change a URL pattern in the actionsfile */ }, + NULL, FALSE /* Form to change a URL pattern in the actionsfile */ }, { "edit-actions-add-url", cgi_edit_actions_add_url, - NULL /* Add a URL pattern to the actionsfile */ }, + NULL, FALSE /* Add a URL pattern to the actionsfile */ }, { "edit-actions-add-url-form", cgi_edit_actions_add_url_form, - NULL /* Form to add a URL pattern to the actionsfile */ }, + NULL, FALSE /* Form to add a URL pattern to the actionsfile */ }, { "edit-actions-remove-url", cgi_edit_actions_remove_url, - NULL /* Remove a URL pattern from the actionsfile */ }, + NULL, FALSE /* Remove a URL pattern from the actionsfile */ }, { "edit-actions-remove-url-form", cgi_edit_actions_remove_url_form, - NULL /* Form to remove a URL pattern from the actionsfile */ }, + NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ }, { "edit-actions-section-add", cgi_edit_actions_section_add, - NULL /* Remove a section from the actionsfile */ }, + NULL, FALSE /* Remove a section from the actionsfile */ }, { "edit-actions-section-remove", cgi_edit_actions_section_remove, - NULL /* Remove a section from the actionsfile */ }, + NULL, FALSE /* Remove a section from the actionsfile */ }, { "edit-actions-section-swap", cgi_edit_actions_section_swap, - NULL /* Swap two sections in the actionsfile */ }, + NULL, FALSE /* Swap two sections in the actionsfile */ }, #endif /* def FEATURE_CGI_EDIT_ACTIONS */ + { "error-favicon.ico", + cgi_send_error_favicon, + NULL, TRUE /* Sends the favicon image for error pages. */ }, + { "favicon.ico", + cgi_send_default_favicon, + NULL, TRUE /* Sends the default favicon image. */ }, { "robots.txt", cgi_robots_txt, - NULL /* Sends a robots.txt file to tell robots to go away. */ }, + NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ }, { "send-banner", cgi_send_banner, - NULL /* Send a built-in image */ }, + NULL, TRUE /* Send a built-in image */ }, { "send-stylesheet", cgi_send_stylesheet, - NULL /* Send templates/cgi-style.css */ }, + NULL, FALSE /* Send templates/cgi-style.css */ }, { "t", cgi_transparent_image, - NULL /* Send a transparent image (short name) */ }, + NULL, TRUE /* Send a transparent image (short name) */ }, + { "user-manual", + cgi_send_user_manual, + NULL, TRUE /* Send user-manual */ }, { NULL, /* NULL Indicates end of list and default page */ cgi_error_404, - NULL /* Unknown CGI page */ } + NULL, TRUE /* Unknown CGI page */ } }; /* - * Bulit-in images for ad replacement + * Built-in images for ad replacement * * Hint: You can encode your own images like this: * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }' @@ -515,25 +776,23 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { */ const char image_pattern_data[] = "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104" - "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046" - "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310" - "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170" - "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342" - "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000" - "\000\000\000\111\105\116\104\256\102\140\202"; + "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251" + "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000" + "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010" + "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060" + "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143" + "\000\000\000\000\111\105\116\104\256\102\140\202"; /* * 1x1 transparant PNG. */ const char image_blank_data[] = "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122" - "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236" - "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070" - "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022" - "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115" - "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101" - "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006" - "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110" + "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126" + "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310" + "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000" + "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104" + "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030" "\000\000\000\000\111\105\116\104\256\102\140\202"; #else @@ -574,7 +833,7 @@ static struct map *parse_cgi_parameters(char *argstring); * Description : Checks if a request URL has either the magical * hostname CGI_SITE_1_HOST (usually http://p.p/) or * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually - * http://ijbswa.sourceforge.net/config). If so, it passes + * http://config.privoxy.org/). If so, it passes * the (rest of the) path onto dispatch_known_cgi, which * calls the relevant CGI handler function. * @@ -618,7 +877,7 @@ struct http_response *dispatch_cgi(struct client_state *csp) else if (*path != '\0') { /* - * wierdness: URL is /configXXX, where XXX is some string + * weirdness: URL is /configXXX, where XXX is some string * Do *NOT* intercept. */ return NULL; @@ -638,6 +897,90 @@ struct http_response *dispatch_cgi(struct client_state *csp) } +/********************************************************************* + * + * Function : grep_cgi_referrer + * + * Description : Ugly provisorical fix that greps the value of the + * referer HTTP header field out of a linked list of + * strings like found at csp->headers. Will disappear + * in Privoxy 3.1. + * + * FIXME: csp->headers ought to be csp->http->headers + * FIXME: Parsing all client header lines should + * happen right after the request is received! + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * + * Returns : pointer to value (no copy!), or NULL if none found. + * + *********************************************************************/ +static char *grep_cgi_referrer(const struct client_state *csp) +{ + struct list_entry *p; + + for (p = csp->headers->first; p != NULL; p = p->next) + { + if (p->str == NULL) continue; + if (strncmpic(p->str, "Referer: ", 9) == 0) + { + return ((p->str) + 9); + } + } + return NULL; + +} + + +/********************************************************************* + * + * Function : referrer_is_safe + * + * Description : Decides whether we trust the Referer for + * CGI pages which are only meant to be reachable + * through Privoxy's web interface directly. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * + * Returns : TRUE if the referrer is safe, or + * FALSE if the referrer is unsafe or not set. + * + *********************************************************************/ +static int referrer_is_safe(const struct client_state *csp) +{ + char *referrer; + const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/"; + + referrer = grep_cgi_referrer(csp); + + if (NULL == referrer) + { + /* No referrer, no access */ + log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.", + csp->http->url); + } + else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1) + || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix))))) + { + /* Trustworthy referrer */ + log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.", + csp->http->url, referrer); + + return TRUE; + } + else + { + /* Untrustworthy referrer */ + log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.", + csp->http->url, referrer); + } + + return FALSE; + +} + /********************************************************************* * * Function : dispatch_known_cgi @@ -672,24 +1015,32 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, { return cgi_error_memory(); } - query_args_start = path_copy; - while (*query_args_start && *query_args_start != '?') + while (*query_args_start && *query_args_start != '?' && *query_args_start != '/') { query_args_start++; } - if (*query_args_start == '?') + if (*query_args_start == '/') { *query_args_start++ = '\0'; + if ((param_list = new_map())) + { + map(param_list, "file", 1, url_decode(query_args_start), 0); + } } - - if (NULL == (param_list = parse_cgi_parameters(query_args_start))) + else { - free(path_copy); - return cgi_error_memory(); + if (*query_args_start == '?') + { + *query_args_start++ = '\0'; + } + if (NULL == (param_list = parse_cgi_parameters(query_args_start))) + { + free(path_copy); + return cgi_error_memory(); + } } - /* * At this point: * path_copy = CGI call name @@ -704,27 +1055,57 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, return cgi_error_memory(); } - log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path); - log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3", - csp->ip_addr_str, csp->http->cmd); - - /* Find and start the right CGI function*/ + /* + * Find and start the right CGI function + */ d = cgi_dispatchers; for (;;) { if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0)) { - err = (d->handler)(csp, rsp, param_list); + /* + * If the called CGI is either harmless, or referred + * from a trusted source, start it. + */ + if (d->harmless || referrer_is_safe(csp)) + { + err = (d->handler)(csp, rsp, param_list); + } + else + { + /* + * Else, modify toggle calls so that they only display + * the status, and deny all other calls. + */ + if (0 == strcmp(path_copy, "toggle")) + { + unmap(param_list, "set"); + err = (d->handler)(csp, rsp, param_list); + } + else + { + err = cgi_error_disabled(csp, rsp); + } + } + free(path_copy); free_map(param_list); + if (err == JB_ERR_CGI_PARAMS) { err = cgi_error_bad_param(csp, rsp); } + if (err && (err != JB_ERR_MEMORY)) + { + /* Unexpected error! Shouldn't get here */ + log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err); + err = cgi_error_unknown(csp, rsp, err); + } if (!err) { /* It worked */ - return finish_http_response(rsp); + rsp->reason = RSP_REASON_CGI_CALL; + return finish_http_response(csp, rsp); } else { @@ -736,8 +1117,8 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, d++; } } - - + + /********************************************************************* * * Function : parse_cgi_parameters @@ -746,7 +1127,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, * pairs and store them in a struct map list. * * Parameters : - * 1 : string = string to be parsed. Will be trashed. + * 1 : argstring = string to be parsed. Will be trashed. * * Returns : pointer to param list, or NULL if out of memory. * @@ -763,6 +1144,16 @@ static struct map *parse_cgi_parameters(char *argstring) return NULL; } + /* + * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends + * the fragment identifier along with the request, so we must + * cut it off here, so it won't pollute the CGI params: + */ + if (NULL != (p = strchr(argstring, '#'))) + { + *p = '\0'; + } + pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1); for (i = 0; i < pairs; i++) @@ -808,7 +1199,7 @@ char get_char_param(const struct map *parameters, ch = *(lookup(parameters, param_name)); if ((ch >= 'a') && (ch <= 'z')) { - ch = ch - 'a' + 'A'; + ch = (char)(ch - 'a' + 'A'); } return ch; @@ -940,7 +1331,7 @@ jb_err get_number_param(struct client_state *csp, return JB_ERR_CGI_PARAMS; } - ch -= '0'; + ch = (char)(ch - '0'); /* Note: * @@ -954,7 +1345,7 @@ jb_err get_number_param(struct client_state *csp, return JB_ERR_CGI_PARAMS; } - value = value * 10 + ch; + value = value * 10 + (unsigned)ch; } /* Success */ @@ -987,7 +1378,9 @@ struct http_response *error_response(struct client_state *csp, { jb_err err; struct http_response *rsp; - struct map * exports = default_exports(csp, NULL); + struct map *exports = default_exports(csp, NULL); + char *path = NULL; + if (exports == NULL) { return cgi_error_memory(); @@ -999,9 +1392,21 @@ struct http_response *error_response(struct client_state *csp, return cgi_error_memory(); } - err = map(exports, "host", 1, html_encode(csp->http->host), 0); +#ifdef FEATURE_FORCE_LOAD + if (csp->flags & CSP_FLAG_FORCED) + { + path = strdup(FORCE_PREFIX); + } + else +#endif /* def FEATURE_FORCE_LOAD */ + { + path = strdup(""); + } + err = string_append(&path, csp->http->path); + + if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0); if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0); - if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0); + if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0); if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0); if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); if (!err) @@ -1031,6 +1436,68 @@ struct http_response *error_response(struct client_state *csp, free_http_response(rsp); return cgi_error_memory(); } + rsp->reason = RSP_REASON_NO_SUCH_DOMAIN; + } + else if (!strcmp(templatename, "forwarding-failed")) + { + const struct forward_spec *fwd = forward_url(csp, csp->http); + char *socks_type = NULL; + if (fwd == NULL) + { + log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!"); + /* Never get here - LOG_LEVEL_FATAL causes program exit */ + } + + /* + * XXX: While the template is called forwarding-failed, + * it currently only handles socks forwarding failures. + */ + assert(fwd->type != SOCKS_NONE); + + /* + * Map failure reason, forwarding type and forwarder. + */ + if (NULL == csp->error_message) + { + /* + * Either we forgot to record the failure reason, + * or the memory allocation failed. + */ + log_error(LOG_LEVEL_ERROR, "Socks failure reason missing."); + csp->error_message = strdup("Failure reason missing. Check the log file for details."); + } + if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1); + + /* + * XXX: this is almost the same code as in cgi_show_url_info() + * and thus should be factored out and shared. + */ + switch (fwd->type) + { + case SOCKS_4: + socks_type = "socks4-"; + break; + case SOCKS_4A: + socks_type = "socks4a-"; + break; + case SOCKS_5: + socks_type = "socks5-"; + break; + default: + log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type); + } + + if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1); + if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0); + + if (!err) rsp->status = strdup("503 Forwarding failure"); + if ((rsp->status == NULL) || (NULL == csp->error_message) || err) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } + rsp->reason = RSP_REASON_FORWARDING_FAILED; } else if (!strcmp(templatename, "connect-failed")) { @@ -1041,6 +1508,7 @@ struct http_response *error_response(struct client_state *csp, free_http_response(rsp); return cgi_error_memory(); } + rsp->reason = RSP_REASON_CONNECT_FAILED; } err = template_fill_for_cgi(csp, templatename, exports, rsp); @@ -1050,7 +1518,50 @@ struct http_response *error_response(struct client_state *csp, return cgi_error_memory(); } - return finish_http_response(rsp); + return finish_http_response(csp, rsp); +} + + +/********************************************************************* + * + * Function : cgi_error_disabled + * + * Description : CGI function that is called to generate an error + * response if the actions editor or toggle CGI are + * accessed despite having being disabled at compile- + * or run-time, or if the user followed an untrusted link + * to access a unsafe CGI feature that is only reachable + * through Privoxy directly. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * + * CGI Parameters : none + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_disabled(struct client_state *csp, + struct http_response *rsp) +{ + struct map *exports; + + assert(csp); + assert(rsp); + + if (NULL == (exports = default_exports(csp, "cgi-error-disabled"))) + { + return JB_ERR_MEMORY; + } + if (map(exports, "url", 1, html_encode(csp->http->url), 0)) + { + /* Not important enough to do anything */ + log_error(LOG_LEVEL_ERROR, "Failed to fill in url."); + } + + return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp); } @@ -1075,7 +1586,10 @@ void cgi_init_error_messages(void) "\r\n"; cgi_error_memory_response->body = "\r\n" - "500 Internal Privoxy Error\r\n" + "\r\n" + " 500 Internal Privoxy Error\r\n" + " " + "\r\n" "\r\n" "

500 Internal Privoxy Error

\r\n" "

Privoxy ran out of memory while processing your request.

\r\n" @@ -1087,6 +1601,7 @@ void cgi_init_error_messages(void) strlen(cgi_error_memory_response->head); cgi_error_memory_response->content_length = strlen(cgi_error_memory_response->body); + cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY; } @@ -1097,14 +1612,10 @@ void cgi_init_error_messages(void) * Description : Called if a CGI function runs out of memory. * Returns a statically-allocated error response. * - * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : template_name = Name of template that could not - * be loaded. + * Parameters : N/A * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. + * Returns : http_response data structure for output. This is + * statically allocated, for obvious reasons. * *********************************************************************/ struct http_response *cgi_error_memory(void) @@ -1120,7 +1631,7 @@ struct http_response *cgi_error_memory(void) * * Function : cgi_error_no_template * - * Description : Almost-CGI function that is called if a templae + * Description : Almost-CGI function that is called if a template * cannot be loaded. Note this is not a true CGI, * it takes a template name rather than a map of * parameters. @@ -1143,7 +1654,10 @@ jb_err cgi_error_no_template(struct client_state *csp, "500 Internal Privoxy Error"; static const char body_prefix[] = "\r\n" - "500 Internal Privoxy Error\r\n" + "\r\n" + " 500 Internal Privoxy Error\r\n" + " " + "\r\n" "\r\n" "

500 Internal Privoxy Error

\r\n" "

Privoxy encountered an error while processing your request:

\r\n" @@ -1162,6 +1676,7 @@ jb_err cgi_error_no_template(struct client_state *csp, ").

\r\n" "\r\n" "\r\n"; + const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1; assert(csp); assert(rsp); @@ -1175,20 +1690,106 @@ jb_err cgi_error_no_template(struct client_state *csp, rsp->head_length = 0; rsp->is_static = 0; - rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1); + rsp->body = malloc(body_size); if (rsp->body == NULL) { return JB_ERR_MEMORY; } - strcpy(rsp->body, body_prefix); - strcat(rsp->body, template_name); - strcat(rsp->body, body_suffix); + strlcpy(rsp->body, body_prefix, body_size); + strlcat(rsp->body, template_name, body_size); + strlcat(rsp->body, body_suffix, body_size); rsp->status = strdup(status); + if (rsp->status == NULL) + { + return JB_ERR_MEMORY; + } + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : cgi_error_unknown + * + * Description : Almost-CGI function that is called if an unexpected + * error occurs in the top-level CGI dispatcher. + * In this context, "unexpected" means "anything other + * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are + * expected to handle all other errors internally, + * since they can give more relavent error messages + * that way. + * + * Note this is not a true CGI, it takes an error + * code rather than a map of parameters. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : error_to_report = Error code to report. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_unknown(struct client_state *csp, + struct http_response *rsp, + jb_err error_to_report) +{ + static const char status[] = + "500 Internal Privoxy Error"; + static const char body_prefix[] = + "\r\n" + "\r\n" + " 500 Internal Privoxy Error\r\n" + " " + "\r\n" + "\r\n" + "

500 Internal Privoxy Error

\r\n" + "

Privoxy encountered an error while processing your request:

\r\n" + "

Unexpected internal error: "; + static const char body_suffix[] = + "

\r\n" + "

Please " + "" + "file a bug report.

\r\n" + "\r\n" + "\r\n"; + char errnumbuf[30]; + /* + * Due to sizeof(errnumbuf), body_size will be slightly + * bigger than necessary but it doesn't really matter. + */ + const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1; + assert(csp); + assert(rsp); + + /* Reset rsp, if needed */ + freez(rsp->status); + freez(rsp->head); + freez(rsp->body); + rsp->content_length = 0; + rsp->head_length = 0; + rsp->is_static = 0; + rsp->reason = RSP_REASON_INTERNAL_ERROR; + + snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report); + + rsp->body = malloc(body_size); if (rsp->body == NULL) { return JB_ERR_MEMORY; } + strlcpy(rsp->body, body_prefix, body_size); + strlcat(rsp->body, errnumbuf, body_size); + strlcat(rsp->body, body_suffix, body_size); + + rsp->status = strdup(status); + if (rsp->status == NULL) + { + return JB_ERR_MEMORY; + } return JB_ERR_OK; } @@ -1228,34 +1829,84 @@ jb_err cgi_error_bad_param(struct client_state *csp, } +/********************************************************************* + * + * Function : cgi_redirect + * + * Description : CGI support function to generate a HTTP redirect + * message + * + * Parameters : + * 1 : rsp = http_response data structure for output + * 2 : target = string with the target URL + * + * CGI Parameters : None + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_redirect (struct http_response * rsp, const char *target) +{ + jb_err err; + + assert(rsp); + assert(target); + + err = enlist_unique_header(rsp->headers, "Location", target); + + rsp->status = strdup("302 Local Redirect from Privoxy"); + if (rsp->status == NULL) + { + return JB_ERR_MEMORY; + } + + return err; +} + + /********************************************************************* * * Function : add_help_link * * Description : Produce a copy of the string given as item, * embedded in an HTML link to its corresponding - * section (item name in uppercase) in the configuration + * section (item name in uppercase) in the actions * chapter of the user manual, (whose URL is given in * the config and defaults to our web site). * + * FIXME: I currently only work for actions, and would + * like to be generalized for other topics. + * * Parameters : * 1 : item = item (will NOT be free()d.) * It is assumed to be HTML-safe. + * 2 : config = The current configuration. * * Returns : String with item embedded in link, or NULL on * out-of-memory * *********************************************************************/ -char *add_help_link(const char *item, +char *add_help_link(const char *item, struct configuration_spec *config) { - char *result = strdup(""); + char *result; if (!item) return NULL; - - string_append(&result, "usermanual); - string_append(&result, HELP_LINK_PREFIX); + + result = strdup("usermanual, "file://", 7) || + !strncmpic(config->usermanual, "http", 4)) + { + string_append(&result, config->usermanual); + } + else + { + string_append(&result, "http://"); + string_append(&result, CGI_SITE_2_HOST); + string_append(&result, "/user-manual/"); + } + string_append(&result, ACTIONS_HELP_PREFIX); string_join (&result, string_toupper(item)); string_append(&result, "\">"); string_append(&result, item); @@ -1273,6 +1924,9 @@ char *add_help_link(const char *item, * HTTP header - e.g.: * "Sun, 06 Nov 1994 08:49:37 GMT" * + * XXX: Should probably get a third parameter for + * the buffer size. + * * Parameters : * 1 : time_offset = Time returned will be current time * plus this number of seconds. @@ -1292,6 +1946,15 @@ void get_http_time(int time_offset, char *buf) struct tm *t; time_t current_time; +#if defined(HAVE_GMTIME_R) + /* + * Declare dummy up here (instead of inside get/set gmt block) so it + * doesn't go out of scope before it's potentially used in snprintf later. + * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when + * !defined HAVE_GMTIME_R. + */ + struct tm dummy; +#endif assert(buf); @@ -1301,9 +1964,12 @@ void get_http_time(int time_offset, char *buf) /* get and save the gmt */ { -#ifdef HAVE_GMTIME_R - struct tm dummy; +#if HAVE_GMTIME_R t = gmtime_r(¤t_time, &dummy); +#elif FEATURE_PTHREAD + pthread_mutex_lock(&gmtime_mutex); + t = gmtime(¤t_time); + pthread_mutex_unlock(&gmtime_mutex); #else t = gmtime(¤t_time); #endif @@ -1330,6 +1996,8 @@ void get_http_time(int time_offset, char *buf) * * Description : Fill in the missing headers in an http response, * and flatten the headers to an http head. + * For HEAD requests the body is freed once + * the Content-Length header is set. * * Parameters : * 1 : rsp = pointer to http_response to be processed @@ -1338,7 +2006,7 @@ void get_http_time(int time_offset, char *buf) * On error, free()s rsp and returns cgi_error_memory() * *********************************************************************/ -struct http_response *finish_http_response(struct http_response *rsp) +struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp) { char buf[BUFFER_SIZE]; jb_err err; @@ -1352,9 +2020,12 @@ struct http_response *finish_http_response(struct http_response *rsp) } /* - * Fill in the HTTP Status + * Fill in the HTTP Status, using HTTP/1.1 + * unless the client asked for HTTP/1.0. */ - sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK"); + snprintf(buf, sizeof(buf), "%s %s", + strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0", + rsp->status ? rsp->status : "200 OK"); err = enlist_first(rsp->headers, buf); /* @@ -1366,14 +2037,41 @@ struct http_response *finish_http_response(struct http_response *rsp) } if (!err) { - sprintf(buf, "Content-Length: %d", (int)rsp->content_length); + snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length); err = enlist(rsp->headers, buf); } - /* - * Fill in the default headers: + if (0 == strcmpic(csp->http->gpc, "head")) + { + /* + * The client only asked for the head. Dispose + * the body and log an offensive message. + * + * While it may seem to be a bit inefficient to + * prepare the body if it isn't needed, it's the + * only way to get the Content-Length right for + * dynamic pages. We could have disposed the body + * earlier, but not without duplicating the + * Content-Length setting code above. + */ + log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str); + freez(rsp->body); + rsp->content_length = 0; + } + + if (strncmpic(rsp->status, "302", 3)) + { + /* + * If it's not a redirect without any content, + * set the Content-Type to text/html if it's + * not already specified. + */ + if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13); + } + + /* + * Fill in the rest of the default headers: * - * Content-Type: default to text/html if not already specified. * Date: set to current date/time. * Last-Modified: set to date/time the page was last changed. * Expires: set to date/time page next needs reloading. @@ -1381,8 +2079,6 @@ struct http_response *finish_http_response(struct http_response *rsp) * * See http://www.w3.org/Protocols/rfc2068/rfc2068 */ - if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13); - if (rsp->is_static) { /* @@ -1405,21 +2101,57 @@ struct http_response *finish_http_response(struct http_response *rsp) err = enlist_unique_header(rsp->headers, "Expires", buf); } } + else if (!strncmpic(rsp->status, "302", 3)) + { + get_http_time(0, buf); + if (!err) err = enlist_unique_header(rsp->headers, "Date", buf); + } else { /* - * Compliant browsers should not cache this due to the "Cache-Control" - * setting. However, to be certain, we also set both "Last-Modified" - * and "Expires" to the current time. + * Setting "Cache-Control" to "no-cache" and "Expires" to + * the current time doesn't exactly forbid caching, it just + * requires the client to revalidate the cached copy. + * + * If a temporary problem occurs and the user tries again after + * getting Privoxy's error message, a compliant browser may set the + * If-Modified-Since header with the content of the error page's + * Last-Modified header. More often than not, the document on the server + * is older than Privoxy's error message, the server would send status code + * 304 and the browser would display the outdated error message again and again. + * + * For documents delivered with status code 403, 404 and 503 we set "Last-Modified" + * to Tim Berners-Lee's birthday, which predates the age of any page on the web + * and can be safely used to "revalidate" without getting a status code 304. + * + * There is no need to let the useless If-Modified-Since header reach the + * server, it is therefore stripped by client_if_modified_since in parsers.c. */ if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache"); get_http_time(0, buf); if (!err) err = enlist_unique_header(rsp->headers, "Date", buf); - if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf); - if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf); + if (!strncmpic(rsp->status, "403", 3) + || !strncmpic(rsp->status, "404", 3) + || !strncmpic(rsp->status, "503", 3)) + { + if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT"); + } + else + { + if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf); + } + if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT"); + if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache"); } + /* + * Quoting RFC 2616: + * + * HTTP/1.1 applications that do not support persistent connections MUST + * include the "close" connection option in every message. + */ + if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close"); /* * Write the head @@ -1489,15 +2221,14 @@ void free_http_response(struct http_response *rsp) * Function : template_load * * Description : CGI support function that loads a given HTML - * template from the confdir, ignoring comment - * lines and following #include statements up to - * a depth of 1. + * template, ignoring comment lines and following + * #include statements up to a depth of 1. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : template_ptr = Destination for pointer to loaded * template text. - * 3 : template = name of the HTML template to be used + * 3 : templatename = name of the HTML template to be used * 4 : recursive = Flag set if this function calls itself * following an #include statament * @@ -1538,11 +2269,23 @@ jb_err template_load(struct client_state *csp, char **template_ptr, } } - /* Generate full path */ + /* + * Generate full path using either templdir + * or confdir/templates as base directory. + */ + if (NULL != csp->config->templdir) + { + templates_dir_path = strdup(csp->config->templdir); + } + else + { + templates_dir_path = make_path(csp->config->confdir, "templates"); + } - templates_dir_path = make_path(csp->config->confdir, "templates"); if (templates_dir_path == NULL) { + log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.", + templatename); return JB_ERR_MEMORY; } @@ -1550,6 +2293,8 @@ jb_err template_load(struct client_state *csp, char **template_ptr, free(templates_dir_path); if (full_path == NULL) { + log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.", + templatename); return JB_ERR_MEMORY; } @@ -1558,6 +2303,7 @@ jb_err template_load(struct client_state *csp, char **template_ptr, file_buffer = strdup(""); if (file_buffer == NULL) { + log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path); free(full_path); return JB_ERR_MEMORY; } @@ -1639,7 +2385,7 @@ jb_err template_load(struct client_state *csp, char **template_ptr, * Caller must free(). * 2 : exports = map with fill in symbol -> name pairs * - * Returns : JB_ERR_OK on success + * Returns : JB_ERR_OK on success (and for uncritical errors) * JB_ERR_MEMORY on out-of-memory error * *********************************************************************/ @@ -1710,15 +2456,35 @@ jb_err template_fill(char **template_ptr, const struct map *exports) } else { - pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size); - free(file_buffer); + error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size); + pcrs_free_job(job); if (NULL == tmp_out_buffer) { *template_ptr = NULL; return JB_ERR_MEMORY; } - file_buffer = tmp_out_buffer; + + if (error < 0) + { + /* + * Substitution failed, keep the original buffer, + * log the problem and ignore it. + * + * The user might see some unresolved @CGI_VARIABLES@, + * but returning a special CGI error page seems unreasonable + * and could mask more important error messages. + */ + free(tmp_out_buffer); + log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s", + buf, m->value, flags, pcrs_strerror(error)); + } + else + { + /* Substitution succeeded, use modified buffer. */ + free(file_buffer); + file_buffer = tmp_out_buffer; + } } } @@ -1744,6 +2510,7 @@ jb_err template_fill(char **template_ptr, const struct map *exports) * 2 : templatename = name of the HTML template to be used * 3 : exports = map with fill in symbol -> name pairs. * Will be freed by this function. + * 4 : rsp = Response structure to fill in. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory error @@ -1799,6 +2566,8 @@ struct map *default_exports(const struct client_state *csp, const char *caller) jb_err err; struct map * exports; int local_help_exists = 0; + char *ip_address = NULL; + char *hostname = NULL; assert(csp); @@ -1808,18 +2577,36 @@ struct map *default_exports(const struct client_state *csp, const char *caller) return NULL; } + get_host_information(csp->cfd, &ip_address, &hostname); + err = map(exports, "version", 1, html_encode(VERSION), 0); - if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0); - if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0); + if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0); + freez(ip_address); + if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0); + freez(hostname); if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0); if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0); - if (!err) err = map(exports, "menu", 1, make_menu(caller), 0); + if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0); if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1); - if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1); - if (!err) err = map(exports, "helplink", 1, HELP_LINK_PREFIX ,1); - if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB); + if (!strncmpic(csp->config->usermanual, "file://", 7) || + !strncmpic(csp->config->usermanual, "http", 4)) + { + /* Manual is located somewhere else, just link to it. */ + if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0); + } + else + { + /* Manual is delivered by Privoxy. */ + if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0); + } + if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1); +#ifdef FEATURE_TOGGLE + if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state); +#else + if (!err) err = map_block_killer(exports, "can-toggle"); +#endif - snprintf(buf, 20, "%d", csp->config->hport); + snprintf(buf, sizeof(buf), "%d", csp->config->hport); if (!err) err = map(exports, "my-port", 1, buf, 1); if(!strcmp(CODE_STATUS, "stable")) @@ -1888,7 +2675,7 @@ jb_err map_block_killer(struct map *exports, const char *name) assert(name); assert(strlen(name) < 490); - snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name); + snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name); return map(exports, buf, 1, "", 1); } @@ -1918,7 +2705,7 @@ jb_err map_block_keep(struct map *exports, const char *name) assert(name); assert(strlen(name) < 490); - snprintf(buf, 500, "if-%s-start", name); + snprintf(buf, sizeof(buf), "if-%s-start", name); err = map(exports, buf, 1, "", 1); if (err) @@ -1926,7 +2713,7 @@ jb_err map_block_keep(struct map *exports, const char *name) return err; } - snprintf(buf, 500, "if-%s-end", name); + snprintf(buf, sizeof(buf), "if-%s-end", name); return map(exports, buf, 1, "", 1); } @@ -1965,7 +2752,7 @@ jb_err map_conditional(struct map *exports, const char *name, int choose_first) assert(name); assert(strlen(name) < 480); - snprintf(buf, 1000, (choose_first + snprintf(buf, sizeof(buf), (choose_first ? "else-not-%s@.*@endif-%s" : "if-%s-then@.*@else-not-%s"), name, name); @@ -1976,7 +2763,7 @@ jb_err map_conditional(struct map *exports, const char *name, int choose_first) return err; } - snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name); + snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name); return map(exports, buf, 1, "", 1); } @@ -1987,14 +2774,18 @@ jb_err map_conditional(struct map *exports, const char *name, int choose_first) * * Description : Returns an HTML-formatted menu of the available * unhidden CGIs, excluding the one given in + * and the toggle CGI if toggling is disabled. * - * Parameters : self = name of CGI to leave out, can be NULL for + * Parameters : + * 1 : self = name of CGI to leave out, can be NULL for * complete listing. + * 2 : feature_flags = feature bitmap from csp->config + * * * Returns : menu string, or NULL on out-of-memory error. * *********************************************************************/ -char *make_menu(const char *self) +char *make_menu(const char *self, const unsigned feature_flags) { const struct cgi_dispatcher *d; char *result = strdup(""); @@ -2007,9 +2798,36 @@ char *make_menu(const char *self) /* List available unhidden CGI's and export as "other-cgis" */ for (d = cgi_dispatchers; d->name; d++) { + +#ifdef FEATURE_TOGGLE + if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle")) + { + /* + * Suppress the toggle link if remote toggling is disabled. + */ + continue; + } +#endif /* def FEATURE_TOGGLE */ + if (d->description && strcmp(d->name, self)) { - string_append(&result, "
  • name); string_append(&result, "\">"); string_append(&result, d->description);