X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgi.c;h=ad4768d394b68210a8ddbe487267c3d08db5214f;hp=6df1413c4163ce43aeeeaff51bb2fb872ed2a638;hb=301785fcc62a2dfc93e8d277552bb83bc274609f;hpb=7a8ed3a3f6b48f81b406e1f35559e67ce3fbbf41 diff --git a/cgi.c b/cgi.c index 6df1413c..ad4768d3 100644 --- a/cgi.c +++ b/cgi.c @@ -1,4 +1,4 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.60 2002/04/08 20:50:25 swa Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.68 2002/05/12 21:36:29 jongfoster Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ @@ -38,6 +38,37 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.60 2002/04/08 20:50:25 swa Exp $"; * * Revisions : * $Log: cgi.c,v $ + * 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 * @@ -347,6 +378,7 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.60 2002/04/08 20:50:25 swa Exp $"; #include #include #include +#include #include #ifdef _WIN32 @@ -386,25 +418,24 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { #endif { "show-status", cgi_show_status, - "Show information about the current configuration" }, + "View & change the current configuration" }, { "show-version", cgi_show_version, - "Show the source code version numbers" }, + "View the source code version numbers" }, { "show-request", cgi_show_request, - "Show the request headers." }, + "View the request headers." }, { "show-url-info", cgi_show_url_info, - "Show which actions apply to a URL and why" }, + "Look up which actions apply to a URL and why" }, #ifdef FEATURE_CGI_EDIT_ACTIONS { "toggle", cgi_toggle, "Toggle Privoxy on or off" }, - { "edit-actions", - cgi_edit_actions, - "Edit the actions list" }, - + { "edit-actions", /* Edit the actions list */ + cgi_edit_actions, + NULL }, { "eaa", /* Shortcut for edit-actions-add-url-form */ cgi_edit_actions_add_url_form, NULL }, @@ -414,9 +445,12 @@ static const struct cgi_dispatcher cgi_dispatchers[] = { { "ear", /* Shortcut for edit-actions-remove-url-form */ cgi_edit_actions_remove_url_form, NULL }, - { "eas", /* Shortcut for edit-actions-for-url */ + { "eafu", /* Shortcut for edit-actions-for-url */ cgi_edit_actions_for_url, NULL }, + { "eas", /* Shortcut for edit-actions-submit */ + cgi_edit_actions_submit, + NULL }, { "easa", /* Shortcut for edit-actions-section-add */ cgi_edit_actions_section_add, NULL }, @@ -552,9 +586,9 @@ static struct map *parse_cgi_parameters(char *argstring); * Function : dispatch_cgi * * Description : Checks if a request URL has either the magical - * hostname CGI_SITE_1_HOST (usully http://i.j.b/) or + * hostname CGI_SITE_1_HOST (usually http://p.p/) or * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually - * http://ijbswa.sourceforge.net/config). If so, it passes + * http://config.privoxy.org/). If so, it passes * the (rest of the) path onto dispatch_known_cgi, which * calls the relevant CGI handler function. * @@ -726,7 +760,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, * pairs and store them in a struct map list. * * Parameters : - * 1 : string = string to be parsed. Will be trashed. + * 1 : argstring = string to be parsed. Will be trashed. * * Returns : pointer to param list, or NULL if out of memory. * @@ -763,6 +797,188 @@ static struct map *parse_cgi_parameters(char *argstring) } +/********************************************************************* + * + * 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; + + assert(parameters); + assert(param_name); + + ch = *(lookup(parameters, param_name)); + if ((ch >= 'a') && (ch <= 'z')) + { + ch = ch - 'a' + 'A'; + } + + return ch; +} + + +/********************************************************************* + * + * Function : get_string_param + * + * Description : Get a string paramater, to be used as an + * ACTION_STRING or ACTION_MULTI paramater. + * 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 paramater. 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 paramater + * was not specified. + * JB_ERR_MEMORY on out-of-memory. + * JB_ERR_CGI_PARAMS if the paramater 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); + + *pparam = NULL; + + param = lookup(parameters, param_name); + if (!*param) + { + return JB_ERR_OK; + } + + if (strlen(param) >= CGI_PARAM_LEN_MAX) + { + /* + * 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; + } + + /* Check every character to see if it's legal */ + s = param; + while ((ch = *s++) != '\0') + { + if ( ((unsigned char)ch < (unsigned char)' ') + || (ch == '}') ) + { + /* Probable hack attempt, or user accidentally used '}'. */ + return JB_ERR_CGI_PARAMS; + } + } + + /* Success */ + *pparam = param; + + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : get_number_param + * + * Description : Get a non-negative integer from the parameters + * passed to a CGI function. + * + * Parameters : + * 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 : 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. + * + *********************************************************************/ +jb_err get_number_param(struct client_state *csp, + const struct map *parameters, + char *name, + unsigned *pvalue) +{ + const char *param; + char ch; + unsigned value; + + assert(csp); + assert(parameters); + assert(name); + assert(pvalue); + + *pvalue = 0; + + param = lookup(parameters, name); + if (!*param) + { + return JB_ERR_CGI_PARAMS; + } + + /* We don't use atoi because I want to check this carefully... */ + + value = 0; + while ((ch = *param++) != '\0') + { + if ((ch < '0') || (ch > '9')) + { + return JB_ERR_CGI_PARAMS; + } + + ch -= '0'; + + /* Note: + * + * defines UINT_MAX + * + * (UINT_MAX - ch) / 10 is the largest number that + * can be safely multiplied by 10 then have ch added. + */ + if (value > ((UINT_MAX - (unsigned)ch) / 10U)) + { + return JB_ERR_CGI_PARAMS; + } + + value = value * 10 + ch; + } + + /* Success */ + *pvalue = value; + + return JB_ERR_OK; + +} + + /********************************************************************* * * Function : error_response @@ -895,14 +1111,10 @@ void cgi_init_error_messages(void) * Description : Called if a CGI function runs out of memory. * Returns a statically-allocated error response. * - * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : template_name = Name of template that could not - * be loaded. + * Parameters : N/A * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. + * Returns : http_response data structure for output. This is + * statically allocated, for obvious reasons. * *********************************************************************/ struct http_response *cgi_error_memory(void) @@ -1026,6 +1238,47 @@ jb_err cgi_error_bad_param(struct client_state *csp, } +/********************************************************************* + * + * 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); + 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 @@ -1258,7 +1511,7 @@ void free_http_response(struct http_response *rsp) * 1 : csp = Current client state (buffers, headers, etc...) * 2 : template_ptr = Destination for pointer to loaded * template text. - * 3 : template = name of the HTML template to be used + * 3 : templatename = name of the HTML template to be used * 4 : recursive = Flag set if this function calls itself * following an #include statament * @@ -1275,6 +1528,7 @@ jb_err template_load(struct client_state *csp, char **template_ptr, char *full_path; char *file_buffer; char *included_module; + const char *p; FILE *fp; char buf[BUFFER_SIZE]; @@ -1284,9 +1538,21 @@ jb_err template_load(struct client_state *csp, char **template_ptr, *template_ptr = NULL; - /* - * Open template file or fail - */ + /* 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; + } + } + + /* Generate full path */ templates_dir_path = make_path(csp->config->confdir, "templates"); if (templates_dir_path == NULL) @@ -1301,6 +1567,8 @@ jb_err template_load(struct client_state *csp, char **template_ptr, return JB_ERR_MEMORY; } + /* Allocate buffer */ + file_buffer = strdup(""); if (file_buffer == NULL) { @@ -1308,6 +1576,8 @@ jb_err template_load(struct client_state *csp, char **template_ptr, return JB_ERR_MEMORY; } + /* Open template file */ + if (NULL == (fp = fopen(full_path, "r"))) { log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path); @@ -1318,7 +1588,7 @@ jb_err template_load(struct client_state *csp, char **template_ptr, free(full_path); /* - * Read the file, ignoring comments, and honring #include + * 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. @@ -1331,17 +1601,16 @@ jb_err template_load(struct client_state *csp, char **template_ptr, if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1))) { free(file_buffer); + fclose(fp); return err; } - if (string_append(&file_buffer, included_module)) + if (string_join(&file_buffer, included_module)) { fclose(fp); - free(included_module); return JB_ERR_MEMORY; } - free(included_module); continue; } @@ -1489,6 +1758,7 @@ jb_err template_fill(char **template_ptr, const struct map *exports) * 2 : templatename = name of the HTML template to be used * 3 : exports = map with fill in symbol -> name pairs. * Will be freed by this function. + * 4 : rsp = Response structure to fill in. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory error @@ -1560,6 +1830,8 @@ struct map *default_exports(const struct client_state *csp, const char *caller) 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, "code-status", 1, CODE_STATUS, 1); + if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1); + if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1); if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB); snprintf(buf, 20, "%d", csp->config->hport); @@ -1729,9 +2001,10 @@ jb_err map_conditional(struct map *exports, const char *name, int choose_first) * Function : make_menu * * Description : Returns an HTML-formatted menu of the available - * unhidden CGIs, excluding the one given in . + * unhidden CGIs, excluding the one given in * - * Parameters : self = name of CGI to leave out, can be NULL + * Parameters : self = name of CGI to leave out, can be NULL for + * complete listing. * * Returns : menu string, or NULL on out-of-memory error. * @@ -1767,7 +2040,7 @@ char *make_menu(const char *self) * * Function : dump_map * - * Description : HTML-dump a map for debugging + * Description : HTML-dump a map for debugging (as table) * * Parameters : * 1 : the_map = map to dump