X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.c;h=20f2fc422639e311e4838d723d48c577232ee44b;hp=da9d0870197f88111525134aacb8549b043dfe07;hb=effa99e4df3dbc95aafd3dd940c0454ca0a2ce44;hpb=d9ab2562dfeadc4f1d2bcae73e9fae62208eaa8e diff --git a/cgi.c b/cgi.c index da9d0870..20f2fc42 100644 --- a/cgi.c +++ b/cgi.c @@ -1,4 +1,4 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.78 2006/09/21 19:22:07 fabiankeil Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.122 2009/06/11 11:47:16 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ @@ -11,8 +11,8 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.78 2006/09/21 19:22:07 fabiankeil 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-2008 + * the SourceForge Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -36,459 +36,8 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.78 2006/09/21 19:22:07 fabiankeil Exp $"; * or write to the Free Software Foundation, Inc., 59 * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - * Revisions : - * $Log: cgi.c,v $ - * 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 - * - Moved get_char_param, get_string_param and get_number_param here - * from cgiedit.c - * - * Revision 1.63 2002/04/15 19:06:43 jongfoster - * Typos - * - * Revision 1.62 2002/04/10 19:59:46 jongfoster - * Fixes to #include in templates: - * - Didn't close main file if loading an included template fails. - * - I'm paranoid and want to disallow "#include /etc/passwd". - * - * Revision 1.61 2002/04/10 13:37:48 oes - * Made templates modular: template_load now recursive with max depth 1 - * - * Revision 1.60 2002/04/08 20:50:25 swa - * fixed JB spelling - * - * Revision 1.59 2002/04/05 15:51:51 oes - * - added send-stylesheet CGI - * - bugfix: error-pages now get correct request protocol - * - fixed - * - kludged CGI descriptions and menu not to break JS syntax - * - * Revision 1.58 2002/03/29 03:33:13 david__schmidt - * Fix Mac OSX compiler warnings - * - * Revision 1.57 2002/03/26 22:29:54 swa - * we have a new homepage! - * - * Revision 1.56 2002/03/24 17:50:46 jongfoster - * Fixing compile error if actions file editor disabled - * - * Revision 1.55 2002/03/24 16:55:06 oes - * Making GIF checkerboard transparent - * - * Revision 1.54 2002/03/24 16:18:15 jongfoster - * Removing old logo - * - * Revision 1.53 2002/03/24 16:06:00 oes - * Correct transparency for checkerboard PNG. Thanks, Magnus! - * - * Revision 1.52 2002/03/24 15:23:33 jongfoster - * Name changes - * - * Revision 1.51 2002/03/24 13:25:43 swa - * name change related issues - * - * Revision 1.50 2002/03/16 23:54:06 jongfoster - * Adding graceful termination feature, to help look for memory leaks. - * If you enable this (which, by design, has to be done by hand - * editing config.h) and then go to http://i.j.b/die, then the program - * will exit cleanly after the *next* request. It should free all the - * memory that was used. - * - * Revision 1.49 2002/03/13 00:27:04 jongfoster - * Killing warnings - * - * Revision 1.48 2002/03/08 17:47:07 jongfoster - * Adding comments - * - * Revision 1.47 2002/03/08 16:41:33 oes - * Added GIF images again - * - * Revision 1.46 2002/03/07 03:48:38 oes - * - Changed built-in images from GIF to PNG - * (with regard to Unisys patent issue) - * - Added a 4x4 pattern PNG which is less intrusive - * than the logo but also clearly marks the deleted banners - * - * Revision 1.45 2002/03/06 22:54:35 jongfoster - * Automated function-comment nitpicking. - * - * Revision 1.44 2002/03/05 22:43:45 david__schmidt - * - Better error reporting on OS/2 - * - Fix double-slash comment (oops) - * - * Revision 1.43 2002/03/05 21:33:45 david__schmidt - * - Re-enable OS/2 building after new parms were added - * - Fix false out of memory report when resolving CGI templates when no IP - * address is available of failed attempt (a la no such domain) - * - * Revision 1.42 2002/01/21 00:33:20 jongfoster - * Replacing strsav() with the safer string_append() or string_join(). - * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML. - * Adding missing html_encode() to error message generators. - * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs. - * - * Revision 1.41 2002/01/17 20:56:22 jongfoster - * Replacing hard references to the URL of the config interface - * with #defines from project.h - * - * Revision 1.40 2002/01/09 14:26:46 oes - * Added support for thread-safe gmtime_r call. - * - * Revision 1.39 2001/11/16 00:48:13 jongfoster - * Fixing a compiler warning - * - * Revision 1.38 2001/11/13 00:31:21 jongfoster - * - Adding new CGIs for use by non-JavaScript browsers: - * edit-actions-url-form - * edit-actions-add-url-form - * edit-actions-remove-url-form - * - Fixing make_menu()'s HTML generation - it now quotes the href parameter. - * - Fixing || bug. - * - * Revision 1.37 2001/11/01 14:28:47 david__schmidt - * Show enablement/disablement status in almost all templates. - * There is a little trickiness here: apparent recursive resolution of - * @if-enabled-then@ caused the toggle template to show status out-of-phase with - * the actual enablement status. So a similar construct, - * @if-enabled-display-then@, is used to resolve the status display on non-'toggle' - * templates. - * - * Revision 1.36 2001/10/26 17:33:27 oes - * marginal bugfix - * - * Revision 1.35 2001/10/23 21:48:19 jongfoster - * Cleaning up error handling in CGI functions - they now send back - * a HTML error page and should never cause a FATAL error. (Fixes one - * potential source of "denial of service" attacks). - * - * CGI actions file editor that works and is actually useful. - * - * Ability to toggle Junkbuster remotely using a CGI call. - * - * You can turn off both the above features in the main configuration - * file, e.g. if you are running a multi-user proxy. - * - * Revision 1.34 2001/10/18 22:22:09 david__schmidt - * Only show "Local support" on templates conditionally: - * - if either 'admin-address' or 'proxy-info-url' are uncommented in config - * - if not, no Local support section appears - * - * Revision 1.33 2001/10/14 22:28:41 jongfoster - * Fixing stupid typo. - * - * Revision 1.32 2001/10/14 22:20:18 jongfoster - * - Changes to CGI dispatching method to match CGI names exactly, - * rather than doing a prefix match. - * - No longer need to count the length of the CGI handler names by hand. - * - Adding new handler for 404 error when disptching a CGI, if none of - * the handlers match. - * - Adding new handlers for CGI actionsfile editor. - * - * Revision 1.31 2001/10/10 10:56:39 oes - * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c - * - * Revision 1.30 2001/10/02 15:30:57 oes - * Introduced show-request cgi - * - * Revision 1.29 2001/09/20 15:47:44 steudten - * - * Fix BUG: Modify int size to size_t size in fill_template() - * - removes big trouble on machines where sizeof(int) != sizeof(size_t). - * - * Revision 1.28 2001/09/19 18:00:37 oes - * - Deletef time() FIXME (Can't fail under Linux either, if - * the argument is guaranteed to be in out address space, - * which it is.) - * - Fixed comments - * - Pointer notation cosmetics - * - Fixed a minor bug in template_fill(): Failiure of - * pcrs_execute() now secure. - * - * Revision 1.27 2001/09/16 17:08:54 jongfoster - * Moving simple CGI functions from cgi.c to new file cgisimple.c - * - * Revision 1.26 2001/09/16 15:47:37 jongfoster - * First version of CGI-based edit interface. This is very much a - * work-in-progress, and you can't actually use it to edit anything - * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes - * to have any effect. - * - * Revision 1.25 2001/09/16 15:02:35 jongfoster - * Adding i.j.b/robots.txt. - * Inlining add_stats() since it's only ever called from one place. - * - * Revision 1.24 2001/09/16 11:38:01 jongfoster - * Splitting fill_template() into 2 functions: - * template_load() loads the file - * template_fill() performs the PCRS regexps. - * This is because the CGI edit interface has a "table row" - * template which is used many times in the page - this - * change means it's only loaded from disk once. - * - * Revision 1.23 2001/09/16 11:16:05 jongfoster - * Better error handling in dispatch_cgi() and parse_cgi_parameters() - * - * Revision 1.22 2001/09/16 11:00:10 jongfoster - * New function alloc_http_response, for symmetry with free_http_response - * - * Revision 1.21 2001/09/13 23:53:03 jongfoster - * Support for both static and dynamically generated CGI pages. - * Correctly setting Last-Modified: and Expires: HTTP headers. - * - * Revision 1.20 2001/09/13 23:40:36 jongfoster - * (Cosmetic only) Indentation correction - * - * Revision 1.19 2001/09/13 23:31:25 jongfoster - * Moving image data to cgi.c rather than cgi.h. - * - * Revision 1.18 2001/08/05 16:06:20 jongfoster - * Modifiying "struct map" so that there are now separate header and - * "map_entry" structures. This means that functions which modify a - * map no longer need to return a pointer to the modified map. - * Also, it no longer reverses the order of the entries (which may be - * important with some advanced template substitutions). - * - * Revision 1.17 2001/08/05 15:57:38 oes - * Adapted finish_http_response to new list_to_text - * - * Revision 1.16 2001/08/01 21:33:18 jongfoster - * Changes to fill_template() that reduce memory usage without having - * an impact on performance. I also renamed some variables so as not - * to clash with the C++ keywords "new" and "template". - * - * Revision 1.15 2001/08/01 21:19:22 jongfoster - * Moving file version information to a separate CGI page. - * - * Revision 1.14 2001/08/01 00:19:03 jongfoster - * New function: map_conditional() for an if-then-else syntax. - * Changing to use new version of show_defines() - * - * Revision 1.13 2001/07/30 22:08:36 jongfoster - * Tidying up #defines: - * - All feature #defines are now of the form FEATURE_xxx - * - Permanently turned off WIN_GUI_EDIT - * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS - * - * Revision 1.12 2001/07/29 18:47:05 jongfoster - * Adding missing #include "loadcfg.h" - * - * Revision 1.11 2001/07/18 17:24:37 oes - * Changed to conform to new pcrs interface - * - * Revision 1.10 2001/07/13 13:53:13 oes - * Removed all #ifdef PCRS and related code - * - * Revision 1.9 2001/06/29 21:45:41 oes - * Indentation, CRLF->LF, Tab-> Space - * - * Revision 1.8 2001/06/29 13:21:46 oes - * - Cosmetics: renamed and reordered functions, variables, - * texts, improved comments etc - * - * - Removed ij_untrusted_url() The relevant - * info is now part of the "untrusted" page, - * which is generated by filters.c:trust_url() - * - * - Generators of content now call finish_http_response() - * themselves, making jcc.c:chat() a little less - * cluttered - * - * - Removed obsolete "Pragma: no-cache" from our headers - * - * - http_responses now know their head length - * - * - fill_template now uses the new interface to pcrs, so that - * - long jobs (like whole files) no longer have to be assembled - * in a fixed size buffer - * - the new T (trivial) option is used, and the replacement may - * contain Perl syntax backrefs without confusing pcrs - * - * - Introduced default_exports() which generates a set of exports - * common to all CGIs and other content generators - * - * - Introduced convenience function map_block_killer() - * - * - Introduced convenience function make_menu() - * - * - Introduced CGI-like function error_response() which generates - * the "No such domain" and "Connect failed" messages using the - * CGI platform - * - * - cgi_show_url_info: - * - adapted to new CGI features - * - form and answers now generated from same template - * - http:// prefix in URL now OK - * - * - cgi_show_status: - * - adapted to new CGI features - * - no longer uses csp->init_proxy_args - * - * - cgi_default: - * - moved menu generation to make_menu() - * - * - add_stats now writes single export map entries instead - * of a fixed string - * - * - Moved redirect_url() to filters.c - * - * - Fixed mem leak in free_http_response(), map_block_killer(), - * - * - Removed logentry from cancelled commit - * - * Revision 1.7 2001/06/09 10:51:58 jongfoster - * Changing "show URL info" handler to new style. - * Changing BUFSIZ ==> BUFFER_SIZE - * - * Revision 1.6 2001/06/07 23:05:19 jongfoster - * Removing code related to old forward and ACL files. - * - * Revision 1.5 2001/06/05 19:59:16 jongfoster - * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++). - * - * Revision 1.4 2001/06/04 10:41:52 swa - * show version string of cgi.h and cgi.c - * - * Revision 1.3 2001/06/03 19:12:16 oes - * introduced new cgi handling - * - * No revisions before 1.3 - * **********************************************************************/ - + #include "config.h" @@ -500,27 +49,25 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.78 2006/09/21 19:22:07 fabiankeil 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" -#ifdef FEATURE_CGI_EDIT_ACTIONS +#include "jbsockets.h" +#if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE) #include "cgiedit.h" -#endif /* def FEATURE_CGI_EDIT_ACTIONS */ -#include "loadcfg.h" +#endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */ + /* loadcfg.h is for global_toggle_state only */ -#ifdef FEATURE_PTHREAD -#include "jcc.h" +#include "loadcfg.h" /* jcc.h is for mutex semaphore globals only */ -#endif /* def FEATURE_PTHREAD */ +#include "jcc.h" + const char cgi_h_rcs[] = CGI_H_VERSION; /* @@ -543,7 +90,7 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { { "show-status", cgi_show_status, #ifdef FEATURE_CGI_EDIT_ACTIONS - "View & change the current configuration", + "View & change the current configuration", #else "View the current configuration", #endif @@ -554,17 +101,19 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { 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", TRUE }, -#ifdef FEATURE_CGI_EDIT_ACTIONS +#ifdef FEATURE_TOGGLE { "toggle", cgi_toggle, "Toggle Privoxy on or off", FALSE }, +#endif /* def FEATURE_TOGGLE */ +#ifdef FEATURE_CGI_EDIT_ACTIONS { "edit-actions", /* Edit the actions list */ cgi_edit_actions, NULL, FALSE }, @@ -632,6 +181,12 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { cgi_edit_actions_section_swap, 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, TRUE /* Sends a robots.txt file to tell robots to go away. */ }, @@ -640,10 +195,13 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { NULL, TRUE /* Send a built-in image */ }, { "send-stylesheet", cgi_send_stylesheet, - NULL, TRUE /* Send templates/cgi-style.css */ }, + NULL, FALSE /* Send templates/cgi-style.css */ }, { "t", cgi_transparent_image, NULL, TRUE /* Send a transparent image (short name) */ }, + { "url-info-osd.xml", + cgi_send_url_info_osd, + NULL, TRUE /* Send templates/url-info-osd.xml */ }, { "user-manual", cgi_send_user_manual, NULL, TRUE /* Send user-manual */ }, @@ -667,12 +225,12 @@ 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. @@ -807,7 +365,7 @@ struct http_response *dispatch_cgi(struct client_state *csp) * Returns : pointer to value (no copy!), or NULL if none found. * *********************************************************************/ -char *grep_cgi_referrer(struct client_state *csp) +static char *grep_cgi_referrer(const struct client_state *csp) { struct list_entry *p; @@ -824,6 +382,54 @@ char *grep_cgi_referrer(struct client_state *csp) } +/********************************************************************* + * + * 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; + static 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 @@ -852,7 +458,6 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, struct http_response *rsp; char *query_args_start; char *path_copy; - char *referrer; jb_err err; if (NULL == (path_copy = strdup(path))) @@ -899,10 +504,6 @@ 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 */ @@ -915,10 +516,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, * If the called CGI is either harmless, or referred * from a trusted source, start it. */ - if (d->harmless - || ((NULL != (referrer = grep_cgi_referrer(csp))) - && (0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1))) - ) + if (d->harmless || referrer_is_safe(csp)) { err = (d->handler)(csp, rsp, param_list); } @@ -955,7 +553,8 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, if (!err) { /* It worked */ - return finish_http_response(rsp); + rsp->reason = RSP_REASON_CGI_CALL; + return finish_http_response(csp, rsp); } else { @@ -1049,7 +648,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; @@ -1181,7 +780,7 @@ jb_err get_number_param(struct client_state *csp, return JB_ERR_CGI_PARAMS; } - ch -= '0'; + ch = (char)(ch - '0'); /* Note: * @@ -1195,7 +794,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 */ @@ -1216,19 +815,19 @@ jb_err get_number_param(struct client_state *csp, * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : templatename = Which template should be used for the answer - * 3 : sys_err = system error number * * Returns : A http_response. If we run out of memory, this * will be cgi_error_memory(). * *********************************************************************/ struct http_response *error_response(struct client_state *csp, - const char *templatename, - int sys_err) + const char *templatename) { 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(); @@ -1240,10 +839,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, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0); + if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0); if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); if (!err) { @@ -1266,22 +876,91 @@ struct http_response *error_response(struct client_state *csp, if (!strcmp(templatename, "no-such-domain")) { rsp->status = strdup("404 No such domain"); - if (rsp->status == NULL) + 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 != NULL); + 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 ((NULL == csp->error_message) || err) { free_map(exports); free_http_response(rsp); return cgi_error_memory(); } + if (!err) rsp->status = strdup("503 Forwarding failure"); + rsp->reason = RSP_REASON_FORWARDING_FAILED; } else if (!strcmp(templatename, "connect-failed")) { rsp->status = strdup("503 Connect failed"); - if (rsp->status == NULL) - { - free_map(exports); - free_http_response(rsp); - return cgi_error_memory(); - } + rsp->reason = RSP_REASON_CONNECT_FAILED; + } + else if (!strcmp(templatename, "connection-timeout")) + { + rsp->status = strdup("504 Connection timeout"); + rsp->reason = RSP_REASON_CONNECTION_TIMEOUT; + } + else if (!strcmp(templatename, "no-server-data")) + { + rsp->status = strdup("502 No data received from server or forwarder"); + rsp->reason = RSP_REASON_NO_SERVER_DATA; + } + + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); } err = template_fill_for_cgi(csp, templatename, exports, rsp); @@ -1291,7 +970,7 @@ struct http_response *error_response(struct client_state *csp, return cgi_error_memory(); } - return finish_http_response(rsp); + return finish_http_response(csp, rsp); } @@ -1302,7 +981,9 @@ struct http_response *error_response(struct client_state *csp, * 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 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...) @@ -1314,7 +995,7 @@ struct http_response *error_response(struct client_state *csp, * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -jb_err cgi_error_disabled(struct client_state *csp, +jb_err cgi_error_disabled(const struct client_state *csp, struct http_response *rsp) { struct map *exports; @@ -1322,10 +1003,15 @@ jb_err cgi_error_disabled(struct client_state *csp, assert(csp); assert(rsp); - if (NULL == (exports = default_exports(csp, NULL))) + 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); } @@ -1352,7 +1038,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" @@ -1364,6 +1053,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; } @@ -1408,7 +1098,7 @@ struct http_response *cgi_error_memory(void) * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -jb_err cgi_error_no_template(struct client_state *csp, +jb_err cgi_error_no_template(const struct client_state *csp, struct http_response *rsp, const char *template_name) { @@ -1416,13 +1106,16 @@ 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" "

Could not load template file "; static const char body_suffix[] = - " or one of it's included components.

\r\n" + " or one of its included components.

\r\n" "

Please contact your proxy administrator.

\r\n" "

If you are the proxy administrator, please put the required file(s)" "in the (confdir)/templates directory. The " @@ -1435,6 +1128,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); @@ -1448,17 +1142,17 @@ 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->body == NULL) + if (rsp->status == NULL) { return JB_ERR_MEMORY; } @@ -1491,7 +1185,7 @@ jb_err cgi_error_no_template(struct client_state *csp, * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -jb_err cgi_error_unknown(struct client_state *csp, +jb_err cgi_error_unknown(const struct client_state *csp, struct http_response *rsp, jb_err error_to_report) { @@ -1499,7 +1193,10 @@ jb_err cgi_error_unknown(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" @@ -1507,11 +1204,16 @@ jb_err cgi_error_unknown(struct client_state *csp, 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); @@ -1522,20 +1224,21 @@ jb_err cgi_error_unknown(struct client_state *csp, rsp->content_length = 0; rsp->head_length = 0; rsp->is_static = 0; + rsp->reason = RSP_REASON_INTERNAL_ERROR; - sprintf(errnumbuf, "%d", error_to_report); + snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report); - rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + 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, errnumbuf); - strcat(rsp->body, body_suffix); + 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->body == NULL) + if (rsp->status == NULL) { return JB_ERR_MEMORY; } @@ -1561,7 +1264,7 @@ jb_err cgi_error_unknown(struct client_state *csp, * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -jb_err cgi_error_bad_param(struct client_state *csp, +jb_err cgi_error_bad_param(const struct client_state *csp, struct http_response *rsp) { struct map *exports; @@ -1676,13 +1379,15 @@ char *add_help_link(const char *item, * Parameters : * 1 : time_offset = Time returned will be current time * plus this number of seconds. - * 2 : buf = Destination for result. Must be long enough - * to hold 29 characters plus a trailing zero. + * 2 : buf = Destination for result. + * 3 : buffer_size = Size of the buffer above. Must be big + * enough to hold 29 characters plus a + * trailing zero. * * Returns : N/A * *********************************************************************/ -void get_http_time(int time_offset, char *buf) +void get_http_time(int time_offset, char *buf, size_t buffer_size) { static const char day_names[7][4] = { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" }; @@ -1693,36 +1398,29 @@ 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; + struct tm dummy; #endif assert(buf); + assert(buffer_size > (size_t)29); - time(¤t_time); /* get current time */ + time(¤t_time); current_time += time_offset; /* get and save the gmt */ - { #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); + t = gmtime_r(¤t_time, &dummy); +#elif defined(MUTEX_LOCKS_AVAILABLE) + privoxy_mutex_lock(&gmtime_mutex); + t = gmtime(¤t_time); + privoxy_mutex_unlock(&gmtime_mutex); #else - t = gmtime(¤t_time); + t = gmtime(¤t_time); #endif - } /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */ - snprintf(buf, 30, + snprintf(buf, buffer_size, "%s, %02d %s %4d %02d:%02d:%02d GMT", day_names[t->tm_wday], t->tm_mday, @@ -1735,6 +1433,51 @@ void get_http_time(int time_offset, char *buf) } +/********************************************************************* + * + * Function : get_locale_time + * + * Description : Get the time in a date(1)-like format + * according to the current locale - e.g.: + * "Fri Aug 29 19:37:12 CEST 2008" + * + * XXX: Should we allow the user to change the format? + * + * Parameters : + * 1 : buf = Destination for result. + * 2 : buffer_size = Size of the buffer above. Must be big + * enough to hold 29 characters plus a + * trailing zero. + * + * Returns : N/A + * + *********************************************************************/ +static void get_locale_time(char *buf, size_t buffer_size) +{ + struct tm *timeptr; + time_t current_time; +#if defined(HAVE_LOCALTIME_R) + struct tm dummy; +#endif + + assert(buf); + assert(buffer_size > (size_t)29); + + time(¤t_time); + +#if HAVE_LOCALTIME_R + timeptr = localtime_r(¤t_time, &dummy); +#elif defined(MUTEX_LOCKS_AVAILABLE) + privoxy_mutex_lock(&localtime_mutex); + timeptr = localtime(¤t_time); + privoxy_mutex_unlock(&localtime_mutex); +#else + timeptr = localtime(¤t_time); +#endif + + strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr); + +} /********************************************************************* * @@ -1742,6 +1485,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 @@ -1750,7 +1495,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; @@ -1764,9 +1509,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); /* @@ -1778,18 +1526,36 @@ 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); } + 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); + /* + * 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); } /* @@ -1811,7 +1577,7 @@ struct http_response *finish_http_response(struct http_response *rsp) if (!err) { - get_http_time(0, buf); + get_http_time(0, buf, sizeof(buf)); err = enlist_unique_header(rsp->headers, "Date", buf); } @@ -1820,13 +1586,13 @@ struct http_response *finish_http_response(struct http_response *rsp) if (!err) { - get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */ + get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */ err = enlist_unique_header(rsp->headers, "Expires", buf); } } else if (!strncmpic(rsp->status, "302", 3)) { - get_http_time(0, buf); + get_http_time(0, buf, sizeof(buf)); if (!err) err = enlist_unique_header(rsp->headers, "Date", buf); } else @@ -1843,7 +1609,7 @@ struct http_response *finish_http_response(struct http_response *rsp) * 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 404 or 503 we set "Last-Modified" + * 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. * @@ -1852,9 +1618,11 @@ struct http_response *finish_http_response(struct http_response *rsp) */ if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache"); - get_http_time(0, buf); + get_http_time(0, buf, sizeof(buf)); if (!err) err = enlist_unique_header(rsp->headers, "Date", buf); - if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3)) + 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"); } @@ -1942,9 +1710,8 @@ 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...) @@ -1959,7 +1726,7 @@ void free_http_response(struct http_response *rsp) * JB_ERR_FILE if the template file cannot be read * *********************************************************************/ -jb_err template_load(struct client_state *csp, char **template_ptr, +jb_err template_load(const struct client_state *csp, char **template_ptr, const char *templatename, int recursive) { jb_err err; @@ -1991,11 +1758,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; } @@ -2003,6 +1782,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; } @@ -2011,6 +1792,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; } @@ -2030,10 +1812,10 @@ jb_err template_load(struct client_state *csp, char **template_ptr, * Read the file, ignoring comments, and honoring #include * statements, unless we're already called recursively. * - * FIXME: The comment handling could break with lines >BUFFER_SIZE long. - * This is unlikely in practise. + * XXX: The comment handling could break with lines lengths > sizeof(buf). + * This is unlikely in practise. */ - while (fgets(buf, BUFFER_SIZE, fp)) + while (fgets(buf, sizeof(buf), fp)) { if (!recursive && !strncmp(buf, "#include ", 9)) { @@ -2092,7 +1874,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 * *********************************************************************/ @@ -2103,7 +1885,7 @@ jb_err template_fill(char **template_ptr, const struct map *exports) char buf[BUFFER_SIZE]; char *tmp_out_buffer; char *file_buffer; - size_t size; + size_t size; int error; const char *flags; @@ -2126,7 +1908,7 @@ jb_err template_fill(char **template_ptr, const struct map *exports) * character and allow backreferences ($1 etc) in the * "replace with" text. */ - snprintf(buf, BUFFER_SIZE, "%s", m->name + 1); + snprintf(buf, sizeof(buf), "%s", m->name + 1); flags = "sigU"; } else @@ -2139,10 +1921,9 @@ jb_err template_fill(char **template_ptr, const struct map *exports) flags = "sigTU"; /* Enclose name in @@ */ - snprintf(buf, BUFFER_SIZE, "@%s@", m->name); + snprintf(buf, sizeof(buf), "@%s@", m->name); } - log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags); /* Make and run job. */ @@ -2163,15 +1944,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; + } } } @@ -2203,7 +2004,7 @@ jb_err template_fill(char **template_ptr, const struct map *exports) * JB_ERR_MEMORY on out-of-memory error * *********************************************************************/ -jb_err template_fill_for_cgi(struct client_state *csp, +jb_err template_fill_for_cgi(const struct client_state *csp, const char *templatename, struct map *exports, struct http_response *rsp) @@ -2249,10 +2050,12 @@ jb_err template_fill_for_cgi(struct client_state *csp, *********************************************************************/ struct map *default_exports(const struct client_state *csp, const char *caller) { - char buf[20]; + char buf[30]; jb_err err; struct map * exports; int local_help_exists = 0; + char *ip_address = NULL; + char *hostname = NULL; assert(csp); @@ -2262,21 +2065,37 @@ struct map *default_exports(const struct client_state *csp, const char *caller) return NULL; } + if (csp->config->hostname) + { + get_host_information(csp->cfd, &ip_address, NULL); + hostname = strdup(csp->config->hostname); + } + else + { + 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); + get_locale_time(buf, sizeof(buf)); + if (!err) err = map(exports, "time", 1, html_encode(buf), 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 (!strncmpic(csp->config->usermanual, "file://", 7) || !strncmpic(csp->config->usermanual, "http", 4)) { - if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1); + /* Manual is located somewhere else, just link to it. */ + if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0); } else { - if (!err) err = map(exports, "user-manual", 1, "http://"CGI_SITE_2_HOST"/user-manual/" ,1); + /* 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 @@ -2285,7 +2104,7 @@ struct map *default_exports(const struct client_state *csp, const char *caller) 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")) @@ -2352,9 +2171,9 @@ jb_err map_block_killer(struct map *exports, const char *name) assert(exports); assert(name); - assert(strlen(name) < 490); + assert(strlen(name) < (size_t)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); } @@ -2382,9 +2201,9 @@ jb_err map_block_keep(struct map *exports, const char *name) assert(exports); assert(name); - assert(strlen(name) < 490); + assert(strlen(name) < (size_t)490); - snprintf(buf, 500, "if-%s-start", name); + snprintf(buf, sizeof(buf), "if-%s-start", name); err = map(exports, buf, 1, "", 1); if (err) @@ -2392,7 +2211,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); } @@ -2429,9 +2248,9 @@ jb_err map_conditional(struct map *exports, const char *name, int choose_first) assert(exports); assert(name); - assert(strlen(name) < 480); + assert(strlen(name) < (size_t)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); @@ -2442,7 +2261,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); } @@ -2453,14 +2272,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(""); @@ -2473,9 +2296,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);