X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.c;h=53587e9509c48cccbe7c799c8b53b76056119cf8;hp=60806b1605b4c899d4119e82229686451dd0ad05;hb=34a6a841e529579e2be4457ea0d4cb1befbc840a;hpb=a85e975c35ac3b3a13ea4d104c2094a191be882f diff --git a/cgi.c b/cgi.c index 60806b16..53587e95 100644 --- a/cgi.c +++ b/cgi.c @@ -1,22 +1,20 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.10 2001/07/13 13:53:13 oes Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ * * Purpose : Declares functions to intercept request, generate - * html or gif answers, and to compose HTTP resonses. - * - * Functions declared include: - * + * html or gif answers, and to compose HTTP responses. + * This only contains the framework functions, the + * actual handler functions are declared elsewhere. * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2020 + * members of the Privoxy team. https://www.privoxy.org/ * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -34,88 +32,8 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.10 2001/07/13 13:53:13 oes 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.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" @@ -124,52 +42,272 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.10 2001/07/13 13:53:13 oes Exp $"; #include #include #include +#include +#include -#ifdef _WIN32 -#define snprintf _snprintf -#endif /* def _WIN32 */ +#ifdef FEATURE_COMPRESSION +#include +#endif #include "project.h" #include "cgi.h" #include "list.h" #include "encode.h" #include "ssplit.h" -#include "jcc.h" -#include "filters.h" -#include "actions.h" #include "errlog.h" +#include "filters.h" #include "miscutil.h" -#include "showargs.h" +#include "cgisimple.h" +#include "jbsockets.h" +#if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE) +#include "cgiedit.h" +#endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */ +#ifdef FEATURE_HTTPS_INSPECTION +#include "ssl.h" +#endif + +/* loadcfg.h is for global_toggle_state only */ +#include "loadcfg.h" +/* jcc.h is for mutex semaphore globals only */ +#include "jcc.h" -const char cgi_h_rcs[] = CGI_H_VERSION; +static char *make_menu(const struct client_state *csp, const char *self); -const struct cgi_dispatcher cgi_dispatcher[] = { - { "show-status", - 11, cgi_show_status, - "Show information about the version and configuration" }, +/* + * List of CGI functions: name, handler, description + * Note: Do NOT use single quotes in the description; + * this will break the dynamic "blocked" template! + */ +static const struct cgi_dispatcher cgi_dispatchers[] = { + { "", + cgi_default, + "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!!!", + FALSE }, +#endif + { "show-status", + cgi_show_status, +#ifdef FEATURE_CGI_EDIT_ACTIONS + "View & change the current configuration", +#else + "View the current configuration", +#endif + TRUE }, +#ifdef FEATURE_CLIENT_TAGS + /* + * This is marked as harmless because despite the description + * used in the menu the actual toggling is done through another + * path ("/toggle-client-tag"). + */ + { "client-tags", + cgi_show_client_tags, + "View or toggle the tags that can be set based on the client's address", + TRUE }, +#endif + { "show-request", + cgi_show_request, + "View the request headers", + TRUE }, { "show-url-info", - 13, cgi_show_url_info, - "Show which actions apply to a URL and why" }, + cgi_show_url_info, + "Look up which actions apply to a URL and why", + TRUE }, +#ifdef FEATURE_TOGGLE + { "toggle", + cgi_toggle, + "Toggle Privoxy on or off", + FALSE }, +#endif /* def FEATURE_TOGGLE */ +#ifdef FEATURE_CLIENT_TAGS + { "toggle-client-tag", + cgi_toggle_client_tag, + NULL, + FALSE }, +#endif +#ifdef FEATURE_CGI_EDIT_ACTIONS + { "edit-actions", /* Edit the actions list */ + cgi_edit_actions, + NULL, FALSE }, + { "eaa", /* Shortcut for edit-actions-add-url-form */ + cgi_edit_actions_add_url_form, + NULL, FALSE }, + { "eau", /* Shortcut for edit-actions-url-form */ + cgi_edit_actions_url_form, + NULL, FALSE }, + { "ear", /* Shortcut for edit-actions-remove-url-form */ + cgi_edit_actions_remove_url_form, + 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, FALSE }, + { "eas", /* Shortcut for edit-actions-submit */ + cgi_edit_actions_submit, + NULL, FALSE }, + { "easa", /* Shortcut for edit-actions-section-add */ + cgi_edit_actions_section_add, + NULL, FALSE }, + { "easr", /* Shortcut for edit-actions-section-remove */ + cgi_edit_actions_section_remove, + NULL, FALSE }, + { "eass", /* Shortcut for edit-actions-section-swap */ + cgi_edit_actions_section_swap, + NULL, FALSE }, + { "edit-actions-for-url", + cgi_edit_actions_for_url, + NULL, FALSE /* Edit the actions for (a) specified URL(s) */ }, + { "edit-actions-list", + cgi_edit_actions_list, + NULL, TRUE /* Edit the actions list */ }, + { "edit-actions-submit", + cgi_edit_actions_submit, + NULL, FALSE /* Change the actions for (a) specified URL(s) */ }, + { "edit-actions-url", + cgi_edit_actions_url, + NULL, FALSE /* Change a URL pattern in the actionsfile */ }, + { "edit-actions-url-form", + cgi_edit_actions_url_form, + NULL, FALSE /* Form to change a URL pattern in the actionsfile */ }, + { "edit-actions-add-url", + cgi_edit_actions_add_url, + NULL, FALSE /* Add a URL pattern to the actionsfile */ }, + { "edit-actions-add-url-form", + cgi_edit_actions_add_url_form, + NULL, FALSE /* Form to add a URL pattern to the actionsfile */ }, + { "edit-actions-remove-url", + cgi_edit_actions_remove_url, + NULL, FALSE /* Remove a URL pattern from the actionsfile */ }, + { "edit-actions-remove-url-form", + cgi_edit_actions_remove_url_form, + NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ }, + { "edit-actions-section-add", + cgi_edit_actions_section_add, + NULL, FALSE /* Remove a section from the actionsfile */ }, + { "edit-actions-section-remove", + cgi_edit_actions_section_remove, + NULL, FALSE /* Remove a section from the actionsfile */ }, + { "edit-actions-section-swap", + 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. */ }, { "send-banner", - 11, cgi_send_banner, - "HIDE Send the transparent or \"Junkbuster\" gif" }, - { "", - 0, cgi_default, - "Junkbuster main page" }, - { NULL, 0, NULL, NULL } + cgi_send_banner, + NULL, TRUE /* Send a built-in image */ }, + { "send-stylesheet", + cgi_send_stylesheet, + 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 */ }, + { NULL, /* NULL Indicates end of list and default page */ + cgi_error_404, + NULL, TRUE /* Unknown CGI page */ } }; +/* + * 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)); }' + */ + +#ifdef FEATURE_NO_GIFS + +/* + * Checkerboard pattern, as a PNG. + */ +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\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 transparent 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\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 + +/* + * Checkerboard pattern, as a GIF. + */ +const char image_pattern_data[] = + "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310" + "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040" + "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000" + "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147" + "\270\005\000\073"; + +/* + * 1x1 transparent GIF. + */ +const char image_blank_data[] = + "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000" + "\000!\371\004\001\000\000\000\000,\000\000\000\000\001" + "\000\001\000\000\002\002D\001\000;"; +#endif + +const size_t image_pattern_length = sizeof(image_pattern_data) - 1; +const size_t image_blank_length = sizeof(image_blank_data) - 1; + +#ifdef FEATURE_COMPRESSION +/* + * Minimum length which a buffer has to reach before + * we bother to (re-)compress it. Completely arbitrary. + */ +const size_t LOWER_LENGTH_LIMIT_FOR_COMPRESSION = 1024U; +#endif + +static struct http_response cgi_error_memory_response[1]; + +static struct http_response *dispatch_known_cgi(struct client_state * csp, + const char * path); +static struct map *parse_cgi_parameters(char *argstring); + + /********************************************************************* - * + * * Function : dispatch_cgi * - * Description : Checks if a request URL has either the magical hostname - * i.j.b or matches HOME_PAGE_URL/config/. If so, it parses - * the (rest of the) path as a cgi name plus query string, - * prepares a map that maps CGI parameter names to their values, - * initializes the http_response struct, and calls the - * relevant CGI handler function. + * 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://config.privoxy.org/). If so, it passes + * the (rest of the) path onto dispatch_known_cgi, which + * calls the relevant CGI handler function. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) @@ -179,651 +317,1498 @@ const struct cgi_dispatcher cgi_dispatcher[] = { *********************************************************************/ struct http_response *dispatch_cgi(struct client_state *csp) { - char *argstring = NULL; - const struct cgi_dispatcher *d; - struct map *param_list; - struct http_response *rsp; + const char *host = csp->http->host; + const char *path = csp->http->path; /* * Should we intercept ? */ - /* Either the host matches CGI_PREFIX_HOST ..*/ - if (0 == strcmpic(csp->http->host, CGI_PREFIX_HOST)) + /* Note: "example.com" and "example.com." are equivalent hostnames. */ + + /* Either the host matches CGI_SITE_1_HOST ..*/ + if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST)) + || (0 == strcmpic(host, CGI_SITE_1_HOST "."))) + && (path[0] == '/')) { - /* ..then the path will all be for us */ - argstring = csp->http->path; + /* ..then the path will all be for us. Remove leading '/' */ + path++; } - /* Or it's the host part HOME_PAGE_URL, and the path /config ? */ - else if ( (0 == strcmpic(csp->http->host, HOME_PAGE_URL + 7 )) - && (0 == strncmpic(csp->http->path,"/config", 7)) - && ((csp->http->path[7] == '/') || (csp->http->path[7] == '\0'))) + /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */ + else if (( (0 == strcmpic(host, CGI_SITE_2_HOST)) + || (0 == strcmpic(host, CGI_SITE_2_HOST "."))) + && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH)))) { - /* then it's everything following "/config" */ - argstring = csp->http->path + 7; + /* take everything following CGI_SITE_2_PATH */ + path += strlen(CGI_SITE_2_PATH); + if (*path == '/') + { + /* skip the forward slash after CGI_SITE_2_PATH */ + path++; + } + else if (*path != '\0') + { + /* + * weirdness: URL is /configXXX, where XXX is some string + * Do *NOT* intercept. + */ + return NULL; + } } else { + /* Not a CGI */ return NULL; } - /* - * This is a CGI call. - */ - - /* Get mem for response or fail*/ - if (NULL == ( rsp = zalloc(sizeof(*rsp)))) - { - return NULL; - } - - /* Remove leading slash */ - if (*argstring == '/') - { - argstring++; - } - - 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*/ - for (d = cgi_dispatcher; d->handler; d++) + if (strcmpic(csp->http->gpc, "GET") + && strcmpic(csp->http->gpc, "HEAD")) { - if (strncmp(argstring, d->name, d->name_length) == 0) - { - param_list = parse_cgi_parameters(argstring + d->name_length); - if ((d->handler)(csp, rsp, param_list)) - { - freez(rsp); - } - - free_map(param_list); - return(finish_http_response(rsp)); - } + log_error(LOG_LEVEL_ERROR, + "CGI request with unsupported method received: %s", csp->http->gpc); + /* + * The CGI pages currently only support GET and HEAD requests. + * + * If the client used a different method, ditch any data following + * the current headers to reduce the likelihood of parse errors + * with the following request. + */ + csp->client_iob->eod = csp->client_iob->cur; } - /* Can't get here, since cgi_default will match all requests */ - freez(rsp); - return(NULL); + /* + * This is a CGI call. + */ + return dispatch_known_cgi(csp, path); } /********************************************************************* * - * Function : parse_cgi_parameters + * Function : grep_cgi_referrer * - * Description : Parse a URL-encoded argument string into name/value - * pairs and store them in a struct map list. + * 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 : string = string to be parsed + * 1 : csp = Current client state (buffers, headers, etc...) * - * Returns : poniter to param list, or NULL if failiure + * Returns : pointer to value (no copy!), or NULL if none found. * *********************************************************************/ -struct map *parse_cgi_parameters(char *argstring) +static char *grep_cgi_referrer(const struct client_state *csp) { - char *tmp, *p; - char *vector[BUFFER_SIZE]; - int pairs, i; - struct map *cgi_params = NULL; - - if(*argstring == '?') argstring++; - tmp = strdup(argstring); - - pairs = ssplit(tmp, "&", vector, SZ(vector), 1, 1); + struct list_entry *p; + struct list_entry *first_header = +#ifdef FEATURE_HTTPS_INSPECTION + client_use_ssl(csp) ? csp->https_headers->first : +#endif + csp->headers->first; - for (i = 0; i < pairs; i++) + for (p = first_header; p != NULL; p = p->next) { - if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0')) + if (p->str == NULL) continue; + if (strncmpic(p->str, "Referer: ", 9) == 0) { - *p = '\0'; - cgi_params = map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0); + return ((p->str) + 9); } } - - free(tmp); - return(cgi_params); + return NULL; } /********************************************************************* * - * Function : cgi_default + * 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. * - * Description : CGI function that is called if no action was given. - * Lists menu of available unhidden CGIs. - * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters + * 1 : csp = Current client state (buffers, headers, etc...) * - * Returns : 0 + * Returns : TRUE if the referrer is safe, or + * FALSE if the referrer is unsafe or not set. * *********************************************************************/ -int cgi_default(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +static int referrer_is_safe(const struct client_state *csp) { - char *p, *tmp = NULL; - struct map *exports = default_exports(csp, ""); + char *referrer; + static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/"; +#ifdef FEATURE_HTTPS_INSPECTION + static const char alt_prefix_https[] = "https://" CGI_SITE_1_HOST "/"; +#endif + const char *trusted_cgi_referrer = csp->config->trusted_cgi_referrer; + + 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_HTTP, sizeof(CGI_PREFIX_HTTP)-1)) +#ifdef FEATURE_HTTPS_INSPECTION + || (0 == strncmp(referrer, CGI_PREFIX_HTTPS, sizeof(CGI_PREFIX_HTTPS)-1)) + || (0 == strncmp(referrer, alt_prefix_https, strlen(alt_prefix_https))) +#endif + || (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); - /* If there were other parameters, export a dump as "cgi-parameters" */ - if(parameters) + return TRUE; + } + else if ((trusted_cgi_referrer != NULL) && (0 == strncmp(referrer, + trusted_cgi_referrer, strlen(trusted_cgi_referrer)))) { - p = dump_map(parameters); - tmp = strsav(tmp, "

What made you think this cgi takes parameters?\n" - "Anyway, here they are, in case you're interested:

\n"); - tmp = strsav(tmp, p); - exports = map(exports, "cgi-parameters", 1, tmp, 0); - free(p); + /* + * After some more testing this block should be merged with + * the previous one or the log level should bedowngraded. + */ + log_error(LOG_LEVEL_INFO, "Granting access to %s based on trusted referrer %s", + csp->http->url, referrer); + + return TRUE; } else { - exports = map(exports, "cgi-parameters", 1, "", 1); + /* Untrustworthy referrer */ + log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.", + csp->http->url, referrer); } - rsp->body = fill_template(csp, "default", exports); - free_map(exports); - return(0); + return FALSE; } - /********************************************************************* * - * Function : cgi_send_banner + * Function : dispatch_known_cgi * - * Description : CGI function that returns a banner. + * Description : Processes a CGI once dispatch_cgi has determined that + * it matches one of the magic prefixes. Parses the path + * as a cgi name plus query string, prepares a map that + * maps CGI parameter names to their values, initializes + * the http_response struct, and calls the relevant CGI + * handler function. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters - * - * CGI Parameters : - * type : Selects the type of banner between "trans" and "jb". - * Defaults to "jb" if absent or != "trans". + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : path = Path of CGI, with the CGI prefix removed. + * Should not have a leading "/". * - * Returns : 0 + * Returns : http_response, or NULL on handler failure or out of + * memory. * *********************************************************************/ -int cgi_send_banner(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +static struct http_response *dispatch_known_cgi(struct client_state * csp, + const char * path) { - if(strcmp(lookup(parameters, "type"), "trans")) + const struct cgi_dispatcher *d; + struct map *param_list; + struct http_response *rsp; + char *query_args_start; + char *path_copy; + jb_err err; + + if (NULL == (path_copy = strdup(path))) + { + return cgi_error_memory(); + } + query_args_start = path_copy; + while (*query_args_start && *query_args_start != '?' && *query_args_start != '/') + { + query_args_start++; + } + if (*query_args_start == '/') { - rsp->body = bindup(JBGIF, sizeof(JBGIF)); - rsp->content_length = sizeof(JBGIF); + *query_args_start++ = '\0'; + param_list = new_map(); + err = map(param_list, "file", 1, url_decode(query_args_start), 0); + if (JB_ERR_OK != err) + { + free(param_list); + free(path_copy); + return cgi_error_memory(); + } } else { - rsp->body = bindup(BLANKGIF, sizeof(BLANKGIF)); - rsp->content_length = sizeof(BLANKGIF); - } + 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 + * param_list = CGI params, as map + */ + + /* Get mem for response or fail*/ + if (NULL == (rsp = alloc_http_response())) + { + free(path_copy); + free_map(param_list); + return cgi_error_memory(); + } - enlist(rsp->headers, "Content-Type: image/gif"); + /* + * Find and start the right CGI function + */ + d = cgi_dispatchers; + for (;;) + { + if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0)) + { + /* + * 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); + } + } - return(0); + 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 */ + rsp->crunch_reason = CGI_CALL; + return finish_http_response(csp, rsp); + } + else + { + /* Error in handler, probably out-of-memory */ + free_http_response(rsp); + return cgi_error_memory(); + } + } + d++; + } } /********************************************************************* * - * Function : cgi_show_status + * Function : parse_cgi_parameters * - * Description : CGI function that returns a a web page describing the - * current status of IJB. + * Description : Parse a URL-encoded argument string into name/value + * pairs and store them in a struct map list. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters - * - * CGI Parameters : - * type : Selects the type of banner between "trans" and "jb". - * Defaults to "jb" if absent or != "trans". + * 1 : argstring = string to be parsed. Will be trashed. * - * Returns : 0 + * Returns : pointer to param list, or NULL if out of memory. * *********************************************************************/ -int cgi_show_status(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +static struct map *parse_cgi_parameters(char *argstring) { - char *s = NULL; - int i; - struct map *exports = default_exports(csp, "show-status"); - -#ifdef SPLIT_PROXY_ARGS - FILE * fp; - char buf[BUFFER_SIZE]; - char * p; - const char * filename = NULL; - char * file_description = NULL; - + char *p; + char **vector; + int pairs, i; + struct map *cgi_params; - p = lookup(parameters, "file"); - switch (*p) + /* + * XXX: This estimate is guaranteed to be high enough as we + * let ssplit() ignore empty fields, but also a bit wasteful. + * The same hack is used in get_last_url() so it looks like + * a real solution is needed. + */ + size_t max_segments = strlen(argstring) / 2; + if (max_segments == 0) { - case 'p': - if (csp->actions_list) - { - filename = csp->actions_list->filename; - file_description = "Actions List"; - } - break; + /* + * XXX: If the argstring is empty, there's really + * no point in creating a param list, but currently + * other parts of Privoxy depend on the list's existence. + */ + max_segments = 1; + } + vector = malloc_or_die(max_segments * sizeof(char *)); - case 'r': - if (csp->rlist) - { - filename = csp->rlist->filename; - file_description = "Regex Filter List"; - } - break; + cgi_params = new_map(); -#ifdef TRUST_FILES - case 't': - if (csp->tlist) - { - filename = csp->tlist->filename; - file_description = "Trust List"; - } - break; -#endif /* def TRUST_FILES */ + /* + * 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'; } - if (NULL != filename) + pairs = ssplit(argstring, "&", vector, max_segments); + assert(pairs != -1); + if (pairs == -1) { - exports = map(exports, "file-description", 1, file_description, 1); - exports = map(exports, "filepath", 1, html_encode(filename), 0); + freez(vector); + free_map(cgi_params); + return NULL; + } - if ((fp = fopen(filename, "r")) == NULL) - { - exports = map(exports, "content", 1, "

ERROR OPENING FILE!

", 1); - } - else + for (i = 0; i < pairs; i++) + { + if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0')) { - while (fgets(buf, sizeof(buf), fp)) + *p = '\0'; + if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0)) { - p = html_encode(buf); - if (p) - { - s = strsav(s, p); - freez(p); - s = strsav(s, "
"); - } + freez(vector); + free_map(cgi_params); + return NULL; } - fclose(fp); - exports = map(exports, "contents", 1, s, 0); } - rsp->body = fill_template(csp, "show-status-file", exports); - free_map(exports); - return(0); - } -#endif /* def SPLIT_PROXY_ARGS */ + freez(vector); - exports = map(exports, "redirect-url", 1, REDIRECT_URL, 1); - - s = NULL; - for (i=0; i < Argc; i++) - { - s = strsav(s, Argv[i]); - s = strsav(s, " "); - } - exports = map(exports, "invocation", 1, s, 0); + return cgi_params; - exports = map(exports, "options", 1, csp->config->proxy_args, 1); - s = show_rcs(); - exports = map(exports, "sourceversions", 1, s, 0); - s = show_defines(); - exports = map(exports, "defines", 1, s, 0); +} -#ifdef STATISTICS - exports = add_stats(exports); -#else - exports = map_block_killer(exports, "statistics"); -#endif /* ndef STATISTICS */ -#ifdef SPLIT_PROXY_ARGS +/********************************************************************* + * + * Function : get_char_param + * + * Description : Get a single-character parameter passed to a CGI + * function. + * + * Parameters : + * 1 : parameters = map of cgi parameters + * 2 : param_name = The name of the parameter to read + * + * Returns : Uppercase character on success, '\0' on error. + * + *********************************************************************/ +char get_char_param(const struct map *parameters, + const char *param_name) +{ + char ch; - exports = map_block_killer(exports, "no-split-args"); + assert(parameters); + assert(param_name); - if (csp->actions_list) - { - exports = map(exports, "actions-filename", 1, csp->actions_list->filename, 1); - } - else + ch = *(lookup(parameters, param_name)); + if ((ch >= 'a') && (ch <= 'z')) { - exports = map(exports, "actions-filename", 1, "None specified", 1); + ch = (char)(ch - 'a' + 'A'); } - if (csp->rlist) - { - exports = map(exports, "re-filter-filename", 1, csp->rlist->filename, 1); - } - else - { - exports = map(exports, "re-filter-filename", 1, "None specified", 1); - } + return ch; +} -#ifdef TRUST_FILES - if (csp->tlist) - { - exports = map(exports, "trust-filename", 1, csp->tlist->filename, 1); - } - else - { - exports = map(exports, "trust-filename", 1, "None specified", 1); - } -#else - exports = map_block_killer(exports, "trust-support"); -#endif /* ndef TRUST_FILES */ -#else /* ifndef SPLIT_PROXY_ARGS */ - exports = map_block_killer(exports, "split-args"); +/********************************************************************* + * + * Function : get_string_param + * + * Description : Get a string parameter, to be used as an + * ACTION_STRING or ACTION_MULTI parameter. + * Validates the input to prevent stupid/malicious + * users from corrupting their action file. + * + * Parameters : + * 1 : parameters = map of cgi parameters + * 2 : param_name = The name of the parameter to read + * 3 : pparam = destination for parameter. Allocated as + * part of the map "parameters", so don't free it. + * Set to NULL if not specified. + * + * Returns : JB_ERR_OK on success, or if the parameter + * was not specified. + * JB_ERR_MEMORY on out-of-memory. + * JB_ERR_CGI_PARAMS if the parameter is not valid. + * + *********************************************************************/ +jb_err get_string_param(const struct map *parameters, + const char *param_name, + const char **pparam) +{ + const char *param; + const char *s; + char ch; + + assert(parameters); + assert(param_name); + assert(pparam); - if (csp->clist) + *pparam = NULL; + + param = lookup(parameters, param_name); + if (!*param) { - map(exports, "clist", 1, csp->clist->proxy_args , 1); + return JB_ERR_OK; } - if (csp->rlist) + if (strlen(param) >= CGI_PARAM_LEN_MAX) { - map(exports, "rlist", 1, csp->rlist->proxy_args , 1); + /* + * Too long. + * + * Note that the length limit is arbitrary, it just seems + * sensible to limit it to *something*. There's no + * technical reason for any limit at all. + */ + return JB_ERR_CGI_PARAMS; } -#ifdef TRUST_FILES - if (csp->tlist) + /* Check every character to see if it's legal */ + s = param; + while ((ch = *s++) != '\0') { - map(exports, "tlist", 1, csp->tlist->proxy_args , 1); + if (((unsigned char)ch < (unsigned char)' ') + || (ch == '}')) + { + /* Probable hack attempt, or user accidentally used '}'. */ + return JB_ERR_CGI_PARAMS; + } } -#endif /* def TRUST_FILES */ - -#endif /* ndef SPLIT_PROXY_ARGS */ - rsp->body = fill_template(csp, "show-status", exports); - free_map(exports); - return(0); + /* Success */ + *pparam = param; + return JB_ERR_OK; } - - /********************************************************************* + +/********************************************************************* * - * Function : cgi_show_url_info + * Function : get_number_param * - * Description : CGI function that determines and shows which actions - * junkbuster will perform for a given url, and which - * matches starting from the defaults have lead to that. + * Description : Get a non-negative integer from the parameters + * passed to a CGI function. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : parameters = map of cgi parameters - * - * CGI Parameters : - * url : The url whose actions are to be determined. - * If url is unset, the url-given conditional will be - * set, so that all but the form can be suppressed in - * the template. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : parameters = map of cgi parameters + * 3 : name = Name of CGI parameter to read + * 4 : pvalue = destination for value. + * Set to -1 on error. * - * Returns : 0 + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory + * JB_ERR_CGI_PARAMS if the parameter was not specified + * or is not valid. * *********************************************************************/ -int cgi_show_url_info(struct client_state *csp, struct http_response *rsp, - struct map *parameters) +jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue) { - struct map *exports = default_exports(csp, "show-url-info"); - char *url_param, *host = NULL; + const char *param; + char *endptr; + + assert(csp); + assert(parameters); + assert(name); + assert(pvalue); - if (NULL == (url_param = strdup(lookup(parameters, "url"))) || *url_param == '\0') + *pvalue = 0; + + param = lookup(parameters, name); + if (!*param) { - exports = map_block_killer(exports, "url-given"); - exports = map(exports, "url", 1, "", 1); + return JB_ERR_CGI_PARAMS; } - else - { - char *matches = NULL; - char *path; - char *s; - int port = 80; - int hits = 0; - struct file_list *fl; - struct url_actions *b; - struct url_spec url[1]; - struct current_action_spec action[1]; - - host = url_param; - host += (strncmp(url_param, "http://", 7)) ? 0 : 7; - - exports = map(exports, "url", 1, host, 1); - exports = map(exports, "url-html", 1, html_encode(host), 0); - init_current_action(action); + *pvalue = (unsigned int)strtol(param, &endptr, 0); + if (*endptr != '\0') + { + return JB_ERR_CGI_PARAMS; + } - s = current_action_to_text(action); - exports = map(exports, "default", 1, s , 0); + return JB_ERR_OK; - if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL)) - { - exports = map(exports, "matches", 1, "none" , 1); - exports = map(exports, "final", 1, lookup(exports, "default"), 1); +} - freez(url_param); - free_current_action(action); - rsp->body = fill_template(csp, "show-url-info", exports); - free_map(exports); +/********************************************************************* + * + * Function : error_response + * + * Description : returns an http_response that explains the reason + * why a request failed. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : templatename = Which template should be used for the answer + * + * 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) +{ + jb_err err; + struct http_response *rsp; + struct map *exports = default_exports(csp, NULL); + char *path = NULL; + + if (exports == NULL) + { + return cgi_error_memory(); + } + + if (NULL == (rsp = alloc_http_response())) + { + free_map(exports); + return cgi_error_memory(); + } + +#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_and_free_original(path), 0); + if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); + if (!err) + { + err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0); + if (err) + { + /* Some failures, like "404 no such domain", don't have an IP address. */ + err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0); + } + } + + + if (err) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } - return 0; + if (!strcmp(templatename, "no-such-domain")) + { + rsp->status = strdup("404 No such domain"); + rsp->crunch_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 */ } - s = strchr(host, '/'); - if (s != NULL) + /* + * 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) { - path = strdup(s); - *s = '\0'; + /* + * 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."); } - else + 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) { - path = strdup(""); + case SOCKS_4: + socks_type = "socks4-"; + break; + case SOCKS_4A: + socks_type = "socks4a-"; + break; + case SOCKS_5: + socks_type = "socks5-"; + break; + case SOCKS_5T: + socks_type = "socks5t-"; + break; + case FORWARD_WEBSERVER: + socks_type = "webserver-"; + break; + default: + log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type); } - s = strchr(host, ':'); - if (s != NULL) + + 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) { - *s++ = '\0'; - port = atoi(s); - s = NULL; + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); } - *url = dsplit(host); + rsp->status = strdup("503 Forwarding failure"); + rsp->crunch_reason = FORWARDING_FAILED; + } + else if (!strcmp(templatename, "connect-failed")) + { + rsp->status = strdup("503 Connect failed"); + rsp->crunch_reason = CONNECT_FAILED; + } + else if (!strcmp(templatename, "connection-timeout")) + { + rsp->status = strdup("504 Connection timeout"); + rsp->crunch_reason = CONNECTION_TIMEOUT; + } + else if (!strcmp(templatename, "no-server-data")) + { + rsp->status = strdup("502 No data received from server or forwarder"); + rsp->crunch_reason = NO_SERVER_DATA; + } - /* if splitting the domain fails, punt */ - if (url->dbuf == NULL) - { - exports = map(exports, "matches", 1, "none" , 1); - exports = map(exports, "final", 1, lookup(exports, "default"), 1); + if (rsp->status == NULL) + { + free_map(exports); + free_http_response(rsp); + return cgi_error_memory(); + } - freez(url_param); - freez(path); - free_current_action(action); + err = template_fill_for_cgi(csp, templatename, exports, rsp); + if (err) + { + free_http_response(rsp); + return cgi_error_memory(); + } - rsp->body = fill_template(csp, "show-url-info", exports); - free_map(exports); + return finish_http_response(csp, rsp); +} - return 0; - } - for (b = b->next; NULL != b; b = b->next) - { - if ((b->url->port == 0) || (b->url->port == port)) - { - if ((b->url->domain[0] == '\0') || (domaincmp(b->url, url) == 0)) - { - if ((b->url->path == NULL) || -#ifdef REGEX - (regexec(b->url->preg, path, 0, NULL, 0) == 0) +/********************************************************************* + * + * 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(const struct client_state *csp, + struct http_response *rsp) +{ + struct map *exports; + + assert(csp); + assert(rsp); + + rsp->status = strdup_or_die("403 Request not trusted or feature disabled"); + + 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); +} + + +/********************************************************************* + * + * Function : cgi_init_error_messages + * + * Description : Call at the start of the program to initialize + * the error message used by cgi_error_memory(). + * + * Parameters : N/A + * + * Returns : N/A + * + *********************************************************************/ +void cgi_init_error_messages(void) +{ + memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response)); + cgi_error_memory_response->head = + "HTTP/1.0 500 Internal Privoxy Error\r\n" + "Content-Type: text/html\r\n" + "\r\n"; + cgi_error_memory_response->body = + "\n" + "\n" + " 500 Internal Privoxy Error\n" + " " + "\n" + "\n" + "

500 Internal Privoxy Error

\n" + "

Privoxy ran out of memory while processing your request.

\n" + "

Please contact your proxy administrator, or try again later

\n" + "\n" + "\n"; + + cgi_error_memory_response->head_length = + strlen(cgi_error_memory_response->head); + cgi_error_memory_response->content_length = + strlen(cgi_error_memory_response->body); + cgi_error_memory_response->crunch_reason = OUT_OF_MEMORY; +} + + +/********************************************************************* + * + * Function : cgi_error_memory + * + * Description : Called if a CGI function runs out of memory. + * Returns a statically-allocated error response. + * + * Parameters : N/A + * + * Returns : http_response data structure for output. This is + * statically allocated, for obvious reasons. + * + *********************************************************************/ +struct http_response *cgi_error_memory(void) +{ + /* assert that it's been initialized. */ + assert(cgi_error_memory_response->head); + + return cgi_error_memory_response; +} + + +/********************************************************************* + * + * Function : cgi_error_no_template + * + * 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. + * + * 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. + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_error_no_template(const struct client_state *csp, + struct http_response *rsp, + const char *template_name) +{ + static const char status[] = + "500 Internal Privoxy Error"; + static const char body_prefix[] = + "\n" + "\n" + " 500 Internal Privoxy Error\n" + " " + "\n" + "\n" + "

500 Internal Privoxy Error

\n" + "

Privoxy encountered an error while processing your request:

\n" + "

Could not load template file "; + static const char body_suffix[] = + " or one of its included components.

\n" + "

Please contact your proxy administrator.

\n" + "

If you are the proxy administrator, please put the required file(s)" + "in the (confdir)/templates directory. The " + "location of the (confdir) directory " + "is specified in the main Privoxy config " + "file. (It's typically the Privoxy install directory" +#ifndef _WIN32 + ", or /etc/privoxy/" +#endif /* ndef _WIN32 */ + ").

\n" + "\n" + "\n"; + const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1; + + assert(csp); + assert(rsp); + assert(template_name); + + /* 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->body = malloc_or_die(body_size); + 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 relevant 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(const 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[] = + "\n" + "\n" + " 500 Internal Privoxy Error\n" + " " + "\n" + "\n" + "

500 Internal Privoxy Error

\n" + "

Privoxy encountered an error while processing your request:

\n" + "

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

\n" + "

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

\n" + "\n" + "\n"; + /* Includes room for larger error numbers in the future. */ + const size_t body_size = sizeof(body_prefix) + sizeof(body_suffix) + 5; + 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->crunch_reason = INTERNAL_ERROR; + + rsp->body = malloc_or_die(body_size); + + snprintf(rsp->body, body_size, "%s%d%s", body_prefix, error_to_report, body_suffix); + + rsp->status = strdup(status); + if (rsp->status == NULL) + { + return JB_ERR_MEMORY; + } + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : cgi_error_bad_param + * + * Description : CGI function that is called if the parameters + * (query string) for a CGI were wrong. + * + * 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_bad_param(const struct client_state *csp, + struct http_response *rsp) +{ + struct map *exports; + + assert(csp); + assert(rsp); + + if (NULL == (exports = default_exports(csp, NULL))) + { + return JB_ERR_MEMORY; + } + + return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp); +} + + +/********************************************************************* + * + * 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 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, + struct configuration_spec *config) +{ + char *result; + + if (!item) return NULL; + + 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); + string_append(&result, ""); + + return result; +} + + +/********************************************************************* + * + * Function : get_http_time + * + * Description : Get the time in a format suitable for use in a + * HTTP header - e.g.: + * "Sun, 06 Nov 1994 08:49:37 GMT" + * + * Parameters : + * 1 : time_offset = Time returned will be current time + * plus this number of seconds. + * 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, size_t buffer_size) +{ + struct tm *t; + time_t current_time; +#if defined(HAVE_GMTIME_R) + struct tm dummy; +#endif + + assert(buf); + assert(buffer_size > (size_t)29); + + time(¤t_time); + + current_time += time_offset; + + /* get and save the gmt */ +#if HAVE_GMTIME_R + 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 - (strncmp(b->url->path, path, b->url->pathlen) == 0) + t = gmtime(¤t_time); #endif - ) - { - s = actions_to_text(b->action); - matches = strsav(matches, "{"); - matches = strsav(matches, s); - matches = strsav(matches, " }
\n"); - matches = strsav(matches, b->url->spec); - matches = strsav(matches, "
\n
\n"); - freez(s); - - merge_current_action(action, b->action); - hits++; - } - } - } - } - if (hits) - { - exports = map(exports, "matches", 1, matches , 0); - } - else - { - exports = map(exports, "matches", 1, "none", 1); - } - matches = NULL; + strftime(buf, buffer_size, "%a, %d %b %Y %H:%M:%S GMT", t); - freez(url->dbuf); - freez(url->dvec); +} - freez(url_param); - freez(path); +/********************************************************************* + * + * 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); +#else + timeptr = localtime(¤t_time); +#endif - s = current_action_to_text(action); - exports = map(exports, "final", 1, s, 0); - s = NULL; + strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr); - free_current_action(action); +#if !defined(HAVE_LOCALTIME_R) && defined(MUTEX_LOCKS_AVAILABLE) + privoxy_mutex_unlock(&localtime_mutex); +#endif +} + + +#ifdef FEATURE_COMPRESSION +/********************************************************************* + * + * Function : compress_buffer + * + * Description : Compresses the content of a buffer with zlib's deflate + * Allocates a new buffer for the result, free'ing it is + * up to the caller. + * + * Parameters : + * 1 : buffer = buffer whose content should be compressed + * 2 : buffer_length = length of the buffer + * 3 : compression_level = compression level for compress2() + * + * Returns : NULL on error, otherwise a pointer to the compressed + * content of the input buffer. + * + *********************************************************************/ +char *compress_buffer(char *buffer, size_t *buffer_length, int compression_level) +{ + char *compressed_buffer; + uLongf new_length; + assert(-1 <= compression_level && compression_level <= 9); + + /* Let zlib figure out the maximum length of the compressed data */ + new_length = compressBound((uLongf)*buffer_length); + + compressed_buffer = malloc_or_die(new_length); + + if (Z_OK != compress2((Bytef *)compressed_buffer, &new_length, + (Bytef *)buffer, *buffer_length, compression_level)) + { + log_error(LOG_LEVEL_ERROR, + "compress2() failed. Buffer size: %lu, compression level: %d.", + new_length, compression_level); + freez(compressed_buffer); + return NULL; } - rsp->body = fill_template(csp, "show-url-info", exports); - free_map(exports); - return 0; + log_error(LOG_LEVEL_RE_FILTER, + "Compressed content from %lu to %lu bytes. Compression level: %d", + *buffer_length, new_length, compression_level); + + *buffer_length = (size_t)new_length; + + return compressed_buffer; } +#endif /********************************************************************* * - * Function : error_response + * Function : finish_http_response * - * Description : returns an http_response that explains the reason - * why a request failed. + * 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 : csp = Current client state (buffers, headers, etc...) - * 2 : template = Which template should be used for the answer - * 3 : errno = system error number + * 1 : rsp = pointer to http_response to be processed * - * Returns : NULL if no memory, else http_response + * Returns : A http_response, usually the rsp parameter. + * On error, free()s rsp and returns cgi_error_memory() * *********************************************************************/ -struct http_response *error_response(struct client_state *csp, const char *template, int err) +struct http_response *finish_http_response(struct client_state *csp, struct http_response *rsp) { - struct http_response *rsp; - struct map *exports = default_exports(csp, NULL); + char buf[BUFFER_SIZE]; + jb_err err; + + /* Special case - do NOT change this statically allocated response, + * which is ready for output anyway. + */ + if (rsp == cgi_error_memory_response) + { + return rsp; + } + + /* + * Add "Cross-origin resource sharing" (CORS) headers if enabled + */ + if (NULL != csp->config->cors_allowed_origin) + { + enlist_unique_header(rsp->headers, "Access-Control-Allow-Origin", + csp->config->cors_allowed_origin); + enlist_unique_header(rsp->headers, "Access-Control-Allow-Methods", "GET,POST"); + enlist_unique_header(rsp->headers, "Access-Control-Allow-Headers", "X-Requested-With"); + enlist_unique_header(rsp->headers, "Access-Control-Max-Age", "86400"); + } + + /* + * Fill in the HTTP Status, using HTTP/1.1 + * unless the client asked for HTTP/1.0. + */ + snprintf(buf, sizeof(buf), "%s %s", + strcmpic(csp->http->version, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0", + rsp->status ? rsp->status : "200 OK"); + err = enlist_first(rsp->headers, buf); + + /* + * Set the Content-Length + */ + if (rsp->content_length == 0) + { + rsp->content_length = rsp->body ? strlen(rsp->body) : 0; + } + +#ifdef FEATURE_COMPRESSION + if (!err && (csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE) + && (rsp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION)) + { + char *compressed_content; + + compressed_content = compress_buffer(rsp->body, &rsp->content_length, + csp->config->compression_level); + if (NULL != compressed_content) + { + freez(rsp->body); + rsp->body = compressed_content; + err = enlist_unique_header(rsp->headers, "Content-Encoding", "deflate"); + } + } +#endif + + if (!err) + { + snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length); + /* + * Signal serve() that the client will be able to figure out + * the end of the response without having to close the connection. + */ + csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET; + 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 (NULL == ( rsp = (struct http_response *)zalloc(sizeof(*rsp)))) + /* + * Fill in the rest of the default headers: + * + * 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. + * Cache-Control: set to "no-cache" if applicable. + * + * See http://www.w3.org/Protocols/rfc2068/rfc2068 + */ + if (rsp->is_static) { - return NULL; - } + /* + * Set Expires to about 10 min into the future so it'll get reloaded + * occasionally, e.g. if Privoxy gets upgraded. + */ + + if (!err) + { + get_http_time(0, buf, sizeof(buf)); + err = enlist_unique_header(rsp->headers, "Date", buf); + } - exports = map(exports, "host-html", 1, html_encode(csp->http->host), 0); - exports = map(exports, "hostport", 1, csp->http->hostport, 1); - exports = map(exports, "hostport-html", 1, html_encode(csp->http->hostport), 0); - exports = map(exports, "path", 1, csp->http->path, 1); - exports = map(exports, "path-html", 1, html_encode(csp->http->path), 0); - exports = map(exports, "error", 1, safe_strerror(err), 0); - exports = map(exports, "host-ip", 1, csp->http->host_ip_addr_str, 1); + /* Some date in the past. */ + if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT"); - rsp->body = fill_template(csp, template, exports); - free_map(exports); - - if (!strcmp(template, "no-such-domain")) + if (!err) + { + 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, sizeof(buf)); + if (!err) err = enlist_unique_header(rsp->headers, "Date", buf); + } + else + { + /* + * 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, sizeof(buf)); + if (!err) err = enlist_unique_header(rsp->headers, "Date", buf); + if (!strncmpic(rsp->status, "403", 3) + || !strncmpic(rsp->status, "404", 3) + || !strncmpic(rsp->status, "502", 3) + || !strncmpic(rsp->status, "503", 3) + || !strncmpic(rsp->status, "504", 3)) { - rsp->status = strdup("404 No such domain"); + if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT"); } - else if (!strcmp(template, "connect-failed")) + else { - rsp->status = strdup("503 Connect failed"); + 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"); + } + + if (!err && (!(csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE) + || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))) + { + err = enlist_unique_header(rsp->headers, "Connection", "close"); + } + + /* + * Write the head + */ + if (err || (NULL == (rsp->head = list_to_text(rsp->headers)))) + { + free_http_response(rsp); + return cgi_error_memory(); + } + rsp->head_length = strlen(rsp->head); + + return rsp; - return(finish_http_response(rsp)); } /********************************************************************* * - * Function : finish_http_response + * Function : alloc_http_response * - * Description : Fill in the missing headers in an http response, - * and flatten the headers to an http head. + * Description : Allocates a new http_response structure. * - * Parameters : - * 1 : rsp = pointer to http_response to be processed + * Parameters : N/A * - * Returns : http_response, or NULL on failiure + * Returns : pointer to a new http_response, or NULL. * *********************************************************************/ -struct http_response *finish_http_response(struct http_response *rsp) +struct http_response *alloc_http_response(void) { - char buf[BUFFER_SIZE]; - - /* - * Fill in the HTTP Status - */ - sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK"); - enlist_first(rsp->headers, buf); - - /* - * Set the Content-Length - */ - if (rsp->content_length == 0) - { - rsp->content_length = rsp->body ? strlen(rsp->body) : 0; - } - sprintf(buf, "Content-Length: %d", rsp->content_length); - enlist(rsp->headers, buf); - - /* - * Fill in the default headers FIXME: Are these correct? sequence OK? check rfc! - */ - enlist_unique(rsp->headers, "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT", 14); - enlist_unique(rsp->headers, "Expires: Thu Jul 31, 1997 07:42:22 pm GMT", 8); - enlist_unique(rsp->headers, "Content-Type: text/html", 13); - enlist(rsp->headers, ""); - - - /* - * Write the head - */ - if (NULL == (rsp->head = list_to_text(rsp->headers))) - { - free_http_response(rsp); - return(NULL); - } - rsp->head_length = strlen(rsp->head); - - return(rsp); + return (struct http_response *) zalloc(sizeof(struct http_response)); } - + /********************************************************************* * @@ -840,13 +1825,16 @@ struct http_response *finish_http_response(struct http_response *rsp) *********************************************************************/ void free_http_response(struct http_response *rsp) { - if(rsp) + /* + * Must special case cgi_error_memory_response, which is never freed. + */ + if (rsp && (rsp != cgi_error_memory_response)) { freez(rsp->status); freez(rsp->head); freez(rsp->body); destroy_list(rsp->headers); - freez(rsp); + free(rsp); } } @@ -854,99 +1842,326 @@ void free_http_response(struct http_response *rsp) /********************************************************************* * - * Function : fill_template + * Function : template_load * * Description : CGI support function that loads a given HTML - * template from the confdir, and fills it in - * by replacing @name@ with value using pcrs, - * for each item in the output map. + * template, ignoring comment lines and following + * #include statements up to a depth of 1. * * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 3 : template = name of the HTML template to be used - * 2 : exports = map with fill in symbol -> name pairs + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : template_ptr = Destination for pointer to loaded + * template text. + * 3 : templatename = name of the HTML template to be used + * 4 : recursive = Flag set if this function calls itself + * following an #include statament * - * Returns : char * with filled out form, or NULL if failiure + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * JB_ERR_FILE if the template file cannot be read * *********************************************************************/ -char *fill_template(struct client_state *csp, const char *template, struct map *exports) +jb_err template_load(const struct client_state *csp, char **template_ptr, + const char *templatename, int recursive) { - struct map *m; - pcrs_job *job, *joblist = NULL; - char buf[BUFFER_SIZE]; - char *new, *old = NULL; - int size; + jb_err err; + char *templates_dir_path; + char *full_path; + char *file_buffer; + char *included_module; + const char *p; FILE *fp; + char buf[BUFFER_SIZE]; + + assert(csp); + assert(template_ptr); + assert(templatename); + *template_ptr = NULL; + + /* Validate template name. Paranoia. */ + for (p = templatename; *p != 0; p++) + { + if ( ((*p < 'a') || (*p > 'z')) + && ((*p < 'A') || (*p > 'Z')) + && ((*p < '0') || (*p > '9')) + && (*p != '-') + && (*p != '.')) + { + /* Illegal character */ + return JB_ERR_FILE; + } + } /* - * Open template file or fail + * Generate full path using either templdir + * or confdir/templates as base directory. */ - snprintf(buf, BUFFER_SIZE, "%s/templates/%s", csp->config->confdir, template); + if (NULL != csp->config->templdir) + { + templates_dir_path = strdup(csp->config->templdir); + } + else + { + templates_dir_path = make_path(csp->config->confdir, "templates"); + } - if(NULL == (fp = fopen(buf, "r"))) + if (templates_dir_path == NULL) { - log_error(LOG_LEVEL_ERROR, "error loading template %s: %E", buf); - return NULL; + log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.", + templatename); + return JB_ERR_MEMORY; } - - /* - * Assemble pcrs joblist from exports map - */ - for (m = exports; m; m = m->next) + full_path = make_path(templates_dir_path, templatename); + free(templates_dir_path); + if (full_path == NULL) { - int error; + log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.", + templatename); + return JB_ERR_MEMORY; + } - /* Enclose name in @@ */ - snprintf(buf, BUFFER_SIZE, "@%s@", m->name); + /* Allocate buffer */ - /* Make and chain job */ - if ( NULL == (job = (pcrs_compile(buf, m->value, "sigTU", &error))) ) - { - log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error); - } - else - { - job->next = joblist; - joblist = job; - } + 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; } + /* Open template file */ - /* - * Read the file, ignoring comments + if (NULL == (fp = fopen(full_path, "r"))) + { + log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path); + free(full_path); + free(file_buffer); + return JB_ERR_FILE; + } + free(full_path); + + /* + * Read the file, ignoring comments, and honoring #include + * statements, unless we're already called recursively. + * + * 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)) + { + if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1))) + { + free(file_buffer); + fclose(fp); + return err; + } + + if (string_join(&file_buffer, included_module)) + { + fclose(fp); + return JB_ERR_MEMORY; + } + + continue; + } + /* skip lines starting with '#' */ - if(*buf == '#') continue; - - old = strsav(old, buf); + if (*buf == '#') + { + continue; + } + + if (string_append(&file_buffer, buf)) + { + fclose(fp); + return JB_ERR_MEMORY; + } } fclose(fp); + *template_ptr = file_buffer; + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : template_fill + * + * Description : CGI support function that fills in a pre-loaded + * HTML template by replacing @name@ with value using + * pcrs, for each item in the output map. + * + * Note that a leading '$' character in the export map's + * values will be stripped and toggle on backreference + * interpretation. + * + * Parameters : + * 1 : template_ptr = IN: Template to be filled out. + * Will be free()d. + * OUT: Filled out template. + * Caller must free(). + * 2 : exports = map with fill in symbol -> name pairs + * + * Returns : JB_ERR_OK on success (and for uncritical errors) + * JB_ERR_MEMORY on out-of-memory error + * + *********************************************************************/ +jb_err template_fill(char **template_ptr, const struct map *exports) +{ + struct map_entry *m; + pcrs_job *job; + char buf[BUFFER_SIZE]; + char *tmp_out_buffer; + char *file_buffer; + size_t size; + int error; + const char *flags; + + assert(template_ptr); + assert(*template_ptr); + assert(exports); + + file_buffer = *template_ptr; + size = strlen(file_buffer) + 1; /* - * Execute the jobs + * Assemble pcrs joblist from exports map */ - size = strlen(old) + 1; - new = old; - - for (job = joblist; NULL != job; job = job->next) + for (m = exports->first; m != NULL; m = m->next) { - pcrs_execute(job, old, size, &new, &size); - if (old != buf) free(old); - old = new; - } + if (*m->name == '$') + { + /* + * First character of name is '$', so remove this flag + * character and allow backreferences ($1 etc) in the + * "replace with" text. + */ + snprintf(buf, sizeof(buf), "%s", m->name + 1); + flags = "sigU"; + } + else + { + /* + * Treat the "replace with" text as a literal string - + * no quoting needed, no backreferences allowed. + * ("Trivial" ['T'] flag). + */ + flags = "sigTU"; + + /* Enclose name in @@ */ + 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. */ + job = pcrs_compile(buf, m->value, flags, &error); + if (job == NULL) + { + if (error == PCRS_ERR_NOMEM) + { + free(file_buffer); + *template_ptr = NULL; + return JB_ERR_MEMORY; + } + else + { + log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error); + /* Hope it wasn't important and silently ignore the invalid job */ + } + } + else + { + 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; + } + 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; + } + } + } /* - * Free the jobs & return + * Return */ - pcrs_free_joblist(joblist); - return(new); + *template_ptr = file_buffer; + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : template_fill_for_cgi + * + * Description : CGI support function that loads a HTML template + * and fills it in. Handles file-not-found errors + * by sending a HTML error message. For convenience, + * this function also frees the passed "exports" map. + * + * Parameters : + * 1 : csp = Client state + * 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 + * + *********************************************************************/ +jb_err template_fill_for_cgi(const struct client_state *csp, + const char *templatename, + struct map *exports, + struct http_response *rsp) +{ + jb_err err; + assert(csp); + assert(templatename); + assert(exports); + assert(rsp); + + err = template_load(csp, &rsp->body, templatename, 0); + if (err == JB_ERR_FILE) + { + err = cgi_error_no_template(csp, rsp, templatename); + } + else if (err == JB_ERR_OK) + { + err = template_fill(&rsp->body, exports); + } + free_map(exports); + return err; } @@ -960,43 +2175,109 @@ char *fill_template(struct client_state *csp, const char *template, struct map * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : caller = name of CGI who calls us and which should - * be excluded from the generated menu. - * Returns : NULL if no memory, else map + * be excluded from the generated menu. May be + * NULL. + * Returns : NULL if no memory, else a new map. Caller frees. * *********************************************************************/ -struct map *default_exports(struct client_state *csp, char *caller) +struct map *default_exports(const struct client_state *csp, const char *caller) { - struct map *exports = NULL; - char buf[20]; + char buf[30]; + jb_err err; + struct map * exports; + int local_help_exists = 0; + char *ip_address = NULL; + char *port = NULL; + char *hostname = NULL; + + assert(csp); + + exports = new_map(); - exports = map(exports, "version", 1, VERSION, 1); - exports = map(exports, "my-ip-address", 1, csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown", 1); - exports = map(exports, "my-hostname", 1, csp->my_hostname ? csp->my_hostname : "unknown", 1); - exports = map(exports, "admin-address", 1, csp->config->admin_address ? csp->config->admin_address : "fill@me.in.please", 1); - exports = map(exports, "homepage", 1, HOME_PAGE_URL, 1); - exports = map(exports, "default-cgi", 1, HOME_PAGE_URL "/config", 1); - exports = map(exports, "menu", 1, make_menu(caller), 0); - exports = map(exports, "code-status", 1, CODE_STATUS, 1); + if (csp->config->hostname) + { + get_host_information(csp->cfd, &ip_address, &port, NULL); + hostname = strdup(csp->config->hostname); + } + else + { + get_host_information(csp->cfd, &ip_address, &port, &hostname); + } + + err = map(exports, "version", 1, html_encode(VERSION), 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-port", 1, html_encode(port ? port : "unknown"), 0); + freez(port); + 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(csp, caller), 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)) + { + /* 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); - exports = map(exports, "my-port", 1, buf, 1); + if (!strcmp(CODE_STATUS, "stable")) + { + if (!err) err = map_block_killer(exports, "unstable"); + } - if(!strcmp(CODE_STATUS, "stable")) + if (csp->config->admin_address != NULL) + { + if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0); + local_help_exists = 1; + } + else { - exports = map_block_killer(exports, "unstable"); + if (!err) err = map_block_killer(exports, "have-adminaddr-info"); } - if(csp->config->proxy_info_url != NULL) + if (csp->config->proxy_info_url != NULL) { - exports = map(exports, "proxy-info-url", 1, csp->config->proxy_info_url, 1); + if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0); + local_help_exists = 1; } else { - exports = map_block_killer(exports, "have-proxy-info"); - } + if (!err) err = map_block_killer(exports, "have-proxy-info"); + } + + if (local_help_exists == 0) + { + if (!err) err = map_block_killer(exports, "have-help-info"); + } - return(exports); + if (err) + { + free_map(exports); + return NULL; + } + return exports; } @@ -1010,149 +2291,219 @@ struct map *default_exports(struct client_state *csp, char *caller) * "if--start.*if--end" to the given * export list. * - * Parameters : + * Parameters : * 1 : exports = map to extend * 2 : name = name of conditional block * - * Returns : extended map + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -struct map *map_block_killer(struct map *exports, char *name) +jb_err map_block_killer(struct map *exports, const char *name) { char buf[1000]; /* Will do, since the names are hardwired */ - snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name); - exports = map(exports, buf, 1, "", 1); - - return(exports); + assert(exports); + assert(name); + assert(strlen(name) < (size_t)490); + snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name); + return map(exports, buf, 1, "", 1); } /********************************************************************* * - * Function : make_menu + * Function : map_block_keep * - * Description : Returns an HTML-formatted menu of the available - * unhidden CGIs, excluding the one given in . + * Description : Convenience function. Removes the markers used + * by map-block-killer, to save a few bytes. + * i.e. removes "@if--start@" and "@if--end@" * - * Parameters : self = name of CGI to leave out, can be NULL + * Parameters : + * 1 : exports = map to extend + * 2 : name = name of conditional block * - * Returns : menu string + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -char *make_menu(const char *self) +jb_err map_block_keep(struct map *exports, const char *name) { - const struct cgi_dispatcher *d; - char buf[BUFFER_SIZE], *tmp = NULL; + jb_err err; + char buf[500]; /* Will do, since the names are hardwired */ - if (self == NULL) self = "NO-SUCH-CGI!"; + assert(exports); + assert(name); + assert(strlen(name) < (size_t)490); - /* List available unhidden CGI's and export as "other-cgis" */ - for (d = cgi_dispatcher; d->handler; d++) + snprintf(buf, sizeof(buf), "if-%s-start", name); + err = map(exports, buf, 1, "", 1); + + if (err) { - if (strncmp(d->description, "HIDE", 4) && strcmp(d->name, self)) - { - snprintf(buf, BUFFER_SIZE, "
  • %s
    • \n", - HOME_PAGE_URL, d->name, d->description); - tmp = strsav(tmp, buf); - } + return err; } - return(tmp); + snprintf(buf, sizeof(buf), "if-%s-end", name); + return map(exports, buf, 1, "", 1); } /********************************************************************* * - * Function : dump_map + * Function : map_conditional + * + * Description : Convenience function. + * Adds an "if-then-else" for the conditional HTML-template + * block , i.e. a substitution of the form: + * @if--then@ + * True text + * @else-not-@ + * False text + * @endif-@ * - * Description : HTML-dump a map for debugging + * The control structure and one of the alternatives + * will be hidden. * * Parameters : - * 1 : map = map to dump + * 1 : exports = map to extend + * 2 : name = name of conditional block + * 3 : choose_first = nonzero for first, zero for second. * - * Returns : string with HTML + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -char *dump_map(struct map *map) +jb_err map_conditional(struct map *exports, const char *name, int choose_first) { - struct map *p = map; - char *ret = NULL; + char buf[1000]; /* Will do, since the names are hardwired */ + jb_err err; - ret = strsav(ret, "\n"); + assert(exports); + assert(name); + assert(strlen(name) < (size_t)480); - while (p) + snprintf(buf, sizeof(buf), (choose_first + ? "else-not-%s@.*@endif-%s" + : "if-%s-then@.*@else-not-%s"), + name, name); + + err = map(exports, buf, 1, "", 1); + if (err) { - ret = strsav(ret, "\n"); - p = p->next; + return err; } - ret = strsav(ret, "
    "); - ret = strsav(ret, p->name); - ret = strsav(ret, ""); - ret = strsav(ret, p->value); - ret = strsav(ret, "
    \n"); - return(ret); - + snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name); + return map(exports, buf, 1, "", 1); } -#ifdef STATISTICS /********************************************************************* * - * Function : add_stats + * Function : make_menu * - * Description : Add the blocking statistics to a given map. + * 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 : - * 1 : exports = map to write to. + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : self = name of CGI to leave out, can be NULL for + * complete listing. * - * Returns : pointer to extended map + * Returns : menu string, or NULL on out-of-memory error. * *********************************************************************/ -struct map *add_stats(struct map *exports) +char *make_menu(const struct client_state *csp, const char *self) { - float perc_rej; /* Percentage of http requests rejected */ - char buf[1000]; - int local_urls_read = urls_read; - int local_urls_rejected = urls_rejected; - - /* - * Need to alter the stats not to include the fetch of this - * page. - * - * Can't do following thread safely! doh! - * - * urls_read--; - * urls_rejected--; * This will be incremented subsequently * - */ + const struct cgi_dispatcher *d; + char *result = strdup(""); - if (local_urls_read == 0) + if (self == NULL) { - exports = map_block_killer(exports, "have-stats"); + self = "NO-SUCH-CGI!"; } - else + + /* List available unhidden CGI's and export as "other-cgis" */ + for (d = cgi_dispatchers; d->name; d++) { - exports = map_block_killer(exports, "have-no-stats"); - perc_rej = (float)local_urls_rejected * 100.0F / - (float)local_urls_read; +#ifdef FEATURE_TOGGLE + if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle")) + { + /* + * Suppress the toggle link if remote toggling is disabled. + */ + continue; + } +#endif /* def FEATURE_TOGGLE */ - sprintf(buf, "%d", local_urls_read); - exports = map(exports, "requests-received", 1, buf, 1); + if (d->description && strcmp(d->name, self)) + { + char *html_encoded_prefix; + + /* + * Line breaks would be great, but break + * the "blocked" template's JavaScript. + */ + string_append(&result, "
  • name); + string_append(&result, "\">"); + string_append(&result, d->description); + string_append(&result, "
    • "); + } + } - sprintf(buf, "%d", local_urls_rejected); - exports = map(exports, "requests-blocked", 1, buf, 1); + return result; +} - sprintf(buf, "%6.2f", perc_rej); - exports = map(exports, "percent-blocked", 1, buf, 1); - } - return(exports); +/********************************************************************* + * + * Function : dump_map + * + * Description : HTML-dump a map for debugging (as table) + * + * Parameters : + * 1 : the_map = map to dump + * + * Returns : string with HTML + * + *********************************************************************/ +char *dump_map(const struct map *the_map) +{ + struct map_entry *cur_entry; + char *ret = strdup(""); + + string_append(&ret, "\n"); + for (cur_entry = the_map->first; + (cur_entry != NULL) && (ret != NULL); + cur_entry = cur_entry->next) + { + string_append(&ret, "\n"); + } + + string_append(&ret, "
    "); + string_join (&ret, html_encode(cur_entry->name)); + string_append(&ret, ""); + string_join (&ret, html_encode(cur_entry->value)); + string_append(&ret, "
    \n"); + return ret; } -#endif /* def STATISTICS */ + /* Local Variables: