const char cgiedit_rcs[] = "$Id: cgiedit.c,v 1.70 2011/09/04 11:10:56 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgiedit.c,v $ * * Purpose : CGI-based actionsfile editor. * * Functions declared include: cgi_edit_* * * NOTE: The CGIs in this file use parameter names * such as "f" and "s" which are really *BAD* choices. * However, I'm trying to save bytes in the * edit-actions-list HTML page - the standard actions * file generated a 550kbyte page, which is ridiculous. * * Stick to the short names in this file for consistency. * * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * * 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 * your option) any later version. * * This program is distributed in the hope that it will * be useful, but WITHOUT ANY WARRANTY; without even the * implied warranty of MERCHANTABILITY or FITNESS FOR A * PARTICULAR PURPOSE. See the GNU General Public * License for more details. * * The GNU General Public License should be included with * this file. If not, you can view it at * http://www.gnu.org/copyleft/gpl.html * or write to the Free Software Foundation, Inc., 59 * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * **********************************************************************/ #include "config.h" /* * FIXME: Following includes copied from cgi.c - which are actually needed? */ #include #include #include #include #include #include #include #include "project.h" #include "cgi.h" #include "cgiedit.h" #include "cgisimple.h" #include "list.h" #include "encode.h" #include "actions.h" #include "miscutil.h" #include "errlog.h" #include "loaders.h" #ifdef FEATURE_TOGGLE /* loadcfg.h is for global_toggle_state only */ #include "loadcfg.h" #endif /* def FEATURE_TOGGLE */ #include "urlmatch.h" const char cgiedit_h_rcs[] = CGIEDIT_H_VERSION; #ifdef FEATURE_CGI_EDIT_ACTIONS /** * A line in an editable_file. */ struct file_line { /** Next entry in the linked list */ struct file_line * next; /** The raw data, to write out if this line is unmodified. */ char * raw; /** Comments and/or whitespace to put before this line if it's modified and then written out. */ char * prefix; /** The actual data, as a string. Line continuation and comment removal are performed on the data read from file before it's stored here, so it will be a single line of data. */ char * unprocessed; /** The type of data on this line. One of the FILE_LINE_xxx constants. */ int type; /** The actual data, processed into some sensible data type. */ union { /** An action specification. */ struct action_spec action[1]; /** A name=value pair. */ struct { /** The name in the name=value pair. */ char * name; /** The value in the name=value pair, as a string. */ char * svalue; /** The value in the name=value pair, as an integer. */ int ivalue; } setting; /* Add more data types here... e.g. struct url_spec url[1]; struct { struct action_spec action[1]; const char * name; } alias; */ } data; }; /** This file_line has not been processed yet. */ #define FILE_LINE_UNPROCESSED 1 /** This file_line is blank. Can only appear at the end of a file, due to the way the parser works. */ #define FILE_LINE_BLANK 2 /** This file_line says {{alias}}. */ #define FILE_LINE_ALIAS_HEADER 3 /** This file_line defines an alias. */ #define FILE_LINE_ALIAS_ENTRY 4 /** This file_line defines an {action}. */ #define FILE_LINE_ACTION 5 /** This file_line specifies a URL pattern. */ #define FILE_LINE_URL 6 /** This file_line says {{settings}}. */ #define FILE_LINE_SETTINGS_HEADER 7 /** This file_line is in a {{settings}} block. */ #define FILE_LINE_SETTINGS_ENTRY 8 /** This file_line says {{description}}. */ #define FILE_LINE_DESCRIPTION_HEADER 9 /** This file_line is in a {{description}} block. */ #define FILE_LINE_DESCRIPTION_ENTRY 10 /* * Number of file modification time mismatches * before the CGI editor gets turned off. */ #define ACCEPTABLE_TIMESTAMP_MISMATCHES 3 /** * A configuration file, in a format that can be edited and written back to * disk. */ struct editable_file { struct file_line * lines; /**< The contents of the file. A linked list of lines. */ const char * filename; /**< Full pathname - e.g. "/etc/privoxy/wibble.action". */ unsigned identifier; /**< The file name's position in csp->config->actions_file[]. */ const char * version_str; /**< Last modification time, as a string. For CGI param. */ /**< Can be used in URL without using url_param(). */ unsigned version; /**< Last modification time - prevents chaos with the browser's "back" button. Note that this is a time_t cast to an unsigned. When comparing, always cast the time_t to an unsigned, and *NOT* vice-versa. This may lose the top few bits, but they're not significant anyway. */ int newline; /**< Newline convention - one of the NEWLINE_xxx constants. Note that changing this after the file has been read in will cause a mess. */ struct file_line * parse_error; /**< On parse error, this is the offending line. */ const char * parse_error_text; /**< On parse error, this is the problem. (Statically allocated) */ }; /** * Information about the filter types. * Used for macro replacement in cgi_edit_actions_for_url. */ struct filter_type_info { const int multi_action_index; /**< The multi action index as defined in project.h */ const char *macro_name; /**< Name of the macro that has to be replaced with the prepared templates. For example "content-filter-params" */ const char *type; /**< Name of the filter type, for example "server-header-filter". */ /* XXX: check if these two can be combined. */ const char *disable_all_option; /**< Name of the catch-all radio option that has to be checked or unchecked for this filter type. */ const char *disable_all_param; /**< Name of the parameter that causes all filters of this type to be disabled. */ const char *abbr_type; /**< Abbreviation of the filter type, usually the first or second character capitalized */ const char *anchor; /**< Anchor for the User Manual link, for example "SERVER-HEADER-FILTER" */ }; /* Accessed by index, keep the order in the way the FT_ macros are defined. */ static const struct filter_type_info filter_type_info[] = { { ACTION_MULTI_FILTER, "content-filter-params", "filter", "filter-all", "filter_all", "F", "FILTER" }, { ACTION_MULTI_CLIENT_HEADER_FILTER, "client-header-filter-params", "client-header-filter", "client-header-filter-all", "client_header_filter_all", "C", "CLIENT-HEADER-FILTER" }, { ACTION_MULTI_SERVER_HEADER_FILTER, "server-header-filter-params", "server-header-filter", "server-header-filter-all", "server_header_filter_all", "S", "SERVER-HEADER-FILTER" }, { ACTION_MULTI_CLIENT_HEADER_TAGGER, "client-header-tagger-params", "client-header-tagger", "client-header-tagger-all", "client_header_tagger_all", "L", "CLIENT-HEADER-TAGGER" }, { ACTION_MULTI_SERVER_HEADER_TAGGER, "server-header-tagger-params", "server-header-tagger", "server-header-tagger-all", "server_header_tagger_all", "E", "SERVER-HEADER-TAGGER" }, }; /* FIXME: Following non-static functions should be prototyped in .h or made static */ /* Functions to read and write arbitrary config files */ jb_err edit_read_file(struct client_state *csp, const struct map *parameters, int require_version, struct editable_file **pfile); jb_err edit_write_file(struct editable_file * file); void edit_free_file(struct editable_file * file); /* Functions to read and write actions files */ jb_err edit_parse_actions_file(struct editable_file * file); jb_err edit_read_actions_file(struct client_state *csp, struct http_response *rsp, const struct map *parameters, int require_version, struct editable_file **pfile); /* Error handlers */ jb_err cgi_error_modified(struct client_state *csp, struct http_response *rsp, const char *filename); jb_err cgi_error_parse(struct client_state *csp, struct http_response *rsp, struct editable_file *file); jb_err cgi_error_file(struct client_state *csp, struct http_response *rsp, const char *filename); jb_err cgi_error_file_read_only(struct client_state *csp, struct http_response *rsp, const char *filename); /* Internal arbitrary config file support functions */ static jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline); static void edit_free_file_lines(struct file_line * first_line); /* Internal actions file support functions */ static int match_actions_file_header_line(const char * line, const char * name); static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue); /* Internal parameter parsing functions */ static jb_err get_url_spec_param(struct client_state *csp, const struct map *parameters, const char *name, char **pvalue); /* Internal actionsfile <==> HTML conversion functions */ static jb_err map_radio(struct map * exports, const char * optionname, const char * values, int value); static jb_err actions_to_radio(struct map * exports, const struct action_spec *action); static jb_err actions_from_radio(const struct map * parameters, struct action_spec *action); static jb_err map_copy_parameter_html(struct map *out, const struct map *in, const char *name); static jb_err get_file_name_param(struct client_state *csp, const struct map *parameters, const char *param_name, const char **pfilename); /* Internal convenience functions */ static char *section_target(const unsigned sectionid); /********************************************************************* * * Function : section_target * * Description : Given an unsigned (section id) n, produce a dynamically * allocated string of the form #l, for use in link * targets. * * XXX: The hash should be moved into the templates * to make this function more generic and render * stringify() obsolete. * * Parameters : * 1 : sectionid = start line number of section * * Returns : String with link target, or NULL if out of * memory * *********************************************************************/ static char *section_target(const unsigned sectionid) { char buf[30]; snprintf(buf, sizeof(buf), "#l%d", sectionid); return(strdup(buf)); } /********************************************************************* * * Function : stringify * * Description : Convert a number into a dynamically allocated string. * * Parameters : * 1 : number = The number to convert. * * Returns : String with link target, or NULL if out of memory * *********************************************************************/ static char *stringify(const unsigned number) { char buf[6]; snprintf(buf, sizeof(buf), "%i", number); return strdup(buf); } /********************************************************************* * * Function : map_copy_parameter_html * * Description : Copy a CGI parameter from one map to another, HTML * encoding it. * * Parameters : * 1 : out = target map * 2 : in = source map * 3 : name = name of cgi parameter to copy * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if the parameter doesn't exist * in the source map * *********************************************************************/ static jb_err map_copy_parameter_html(struct map *out, const struct map *in, const char *name) { const char * value; jb_err err; assert(out); assert(in); assert(name); value = lookup(in, name); err = map(out, name, 1, html_encode(value), 0); if (err) { /* Out of memory */ return err; } else if (*value == '\0') { return JB_ERR_CGI_PARAMS; } else { return JB_ERR_OK; } } /********************************************************************* * * Function : cgi_edit_actions_url_form * * Description : CGI function that displays a form for * edit-actions-url * * 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 * i : (action index) Identifies the file to edit * v : (version) File's last-modified time * p : (pattern) Line number of pattern to edit * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if the CGI parameters are not * specified or not valid. * *********************************************************************/ jb_err cgi_edit_actions_url_form(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { struct map * exports; unsigned patternid; struct editable_file * file; struct file_line * cur_line; unsigned line_number; unsigned section_start_line_number = 0; jb_err err; assert(csp); assert(rsp); assert(parameters); if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { return cgi_error_disabled(csp, rsp); } err = get_number_param(csp, parameters, "p", &patternid); if (err) { return err; } err = edit_read_actions_file(csp, rsp, parameters, 1, &file); if (err) { /* No filename specified, can't read file, modified, or out of memory. */ return (err == JB_ERR_FILE ? JB_ERR_OK : err); } cur_line = file->lines; for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++) { if (cur_line->type == FILE_LINE_ACTION) { section_start_line_number = line_number; } cur_line = cur_line->next; } if ( (cur_line == NULL) || (line_number != patternid) || (patternid < 1U) || (cur_line->type != FILE_LINE_URL)) { /* Invalid "patternid" parameter */ edit_free_file(file); return JB_ERR_CGI_PARAMS; } if (NULL == (exports = default_exports(csp, NULL))) { edit_free_file(file); return JB_ERR_MEMORY; } err = map(exports, "f", 1, stringify(file->identifier), 0); if (!err) err = map(exports, "v", 1, file->version_str, 1); if (!err) err = map(exports, "p", 1, url_encode(lookup(parameters, "p")), 0); if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0); if (!err) err = map(exports, "jumptarget", 1, section_target(section_start_line_number), 0); edit_free_file(file); if (err) { free_map(exports); return err; } return template_fill_for_cgi(csp, "edit-actions-url-form", exports, rsp); } /********************************************************************* * * Function : cgi_edit_actions_add_url_form * * Description : CGI function that displays a form for * edit-actions-url * * 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 : * f : (filename) Identifies the file to edit * v : (version) File's last-modified time * s : (section) Line number of section to edit * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if the CGI parameters are not * specified or not valid. * *********************************************************************/ jb_err cgi_edit_actions_add_url_form(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { struct map *exports; jb_err err; assert(csp); assert(rsp); assert(parameters); if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { return cgi_error_disabled(csp, rsp); } if (NULL == (exports = default_exports(csp, NULL))) { return JB_ERR_MEMORY; } err = map_copy_parameter_html(exports, parameters, "f"); if (!err) err = map_copy_parameter_html(exports, parameters, "v"); if (!err) err = map_copy_parameter_html(exports, parameters, "s"); if (err) { free_map(exports); return err; } return template_fill_for_cgi(csp, "edit-actions-add-url-form", exports, rsp); } /********************************************************************* * * Function : cgi_edit_actions_remove_url_form * * Description : CGI function that displays a form for * edit-actions-url * * 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 : * f : (number) The action file identifier. * v : (version) File's last-modified time * p : (pattern) Line number of pattern to edit * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if the CGI parameters are not * specified or not valid. * *********************************************************************/ jb_err cgi_edit_actions_remove_url_form(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { struct map * exports; unsigned patternid; struct editable_file * file; struct file_line * cur_line; unsigned line_number; unsigned section_start_line_number = 0; jb_err err; assert(csp); assert(rsp); assert(parameters); if (0 == (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { return cgi_error_disabled(csp, rsp); } err = get_number_param(csp, parameters, "p", &patternid); if (err) { return err; } err = edit_read_actions_file(csp, rsp, parameters, 1, &file); if (err) { /* No filename specified, can't read file, modified, or out of memory. */ return (err == JB_ERR_FILE ? JB_ERR_OK : err); } cur_line = file->lines; for (line_number = 1; (cur_line != NULL) && (line_number < patternid); line_number++) { if (cur_line->type == FILE_LINE_ACTION) { section_start_line_number = line_number; } cur_line = cur_line->next; } if ( (cur_line == NULL) || (line_number != patternid) || (patternid < 1U) || (cur_line->type != FILE_LINE_URL)) { /* Invalid "patternid" parameter */ edit_free_file(file); return JB_ERR_CGI_PARAMS; } if (NULL == (exports = default_exports(csp, NULL))) { edit_free_file(file); return JB_ERR_MEMORY; } err = map(exports, "f", 1, stringify(file->identifier), 0); if (!err) err = map(exports, "v", 1, file->version_str, 1); if (!err) err = map(exports, "p", 1, url_encode(lookup(parameters, "p")), 0); if (!err) err = map(exports, "u", 1, html_encode(cur_line->unprocessed), 0); if (!err) err = map(exports, "jumptarget", 1, section_target(section_start_line_number), 0); if (!err) err = map(exports, "actions-file", 1, html_encode(file->filename), 0); edit_free_file(file); if (err) { free_map(exports); return err; } return template_fill_for_cgi(csp, "edit-actions-remove-url-form", exports, rsp); } /********************************************************************* * * Function : edit_write_file * * Description : Write a complete file to disk. * * Parameters : * 1 : file = File to write. * * Returns : JB_ERR_OK on success * JB_ERR_FILE on error writing to file. * JB_ERR_MEMORY on out of memory * *********************************************************************/ jb_err edit_write_file(struct editable_file * file) { FILE * fp; struct file_line * cur_line; struct stat statbuf[1]; char version_buf[22]; /* 22 = ceil(log10(2^64)) + 2 = max number of digits in time_t, assuming this is a 64-bit machine, plus null terminator, plus one for paranoia */ assert(file); assert(file->filename); if (NULL == (fp = fopen(file->filename, "wb"))) { return JB_ERR_FILE; } cur_line = file->lines; while (cur_line != NULL) { if (cur_line->raw) { if (fputs(cur_line->raw, fp) < 0) { fclose(fp); return JB_ERR_FILE; } } else { if (cur_line->prefix) { if (fputs(cur_line->prefix, fp) < 0) { fclose(fp); return JB_ERR_FILE; } } if (cur_line->unprocessed) { if (NULL != strchr(cur_line->unprocessed, '#')) { /* Must quote '#' characters */ int numhash = 0; size_t len; char * src; char * dest; char * str; /* Count number of # characters, so we know length of output string */ src = cur_line->unprocessed; while (NULL != (src = strchr(src, '#'))) { numhash++; src++; } assert(numhash > 0); /* Allocate new memory for string */ len = strlen(cur_line->unprocessed) + (size_t)numhash; if (NULL == (str = malloc(len + 1))) { /* Uh oh, just trashed file! */ fclose(fp); return JB_ERR_MEMORY; } /* Copy string but quote hashes */ src = cur_line->unprocessed; dest = str; while (*src) { if (*src == '#') { *dest++ = '\\'; numhash--; assert(numhash >= 0); } *dest++ = *src++; } *dest = '\0'; assert(numhash == 0); assert(strlen(str) == len); assert(str == dest - len); assert(src - len <= cur_line->unprocessed); if ((strlen(str) != len) || (numhash != 0)) { /* * Escaping didn't work as expected, go spread the news. * Only reached in non-debugging builds. */ log_error(LOG_LEVEL_ERROR, "Looks like hash escaping failed. %s might be corrupted now.", file->filename); } if (fputs(str, fp) < 0) { free(str); fclose(fp); return JB_ERR_FILE; } free(str); } else { /* Can write without quoting '#' characters. */ if (fputs(cur_line->unprocessed, fp) < 0) { fclose(fp); return JB_ERR_FILE; } } if (fputs(NEWLINE(file->newline), fp) < 0) { fclose(fp); return JB_ERR_FILE; } } else { /* FIXME: Write data from file->data->whatever */ assert(0); } } cur_line = cur_line->next; } fclose(fp); /* Update the version stamp in the file structure, since we just * wrote to the file & changed it's date. */ if (stat(file->filename, statbuf) < 0) { /* Error, probably file not found. */ return JB_ERR_FILE; } file->version = (unsigned)statbuf->st_mtime; /* Correct file->version_str */ freez(file->version_str); snprintf(version_buf, sizeof(version_buf), "%u", file->version); version_buf[sizeof(version_buf)-1] = '\0'; file->version_str = strdup(version_buf); if (version_buf == NULL) { return JB_ERR_MEMORY; } return JB_ERR_OK; } /********************************************************************* * * Function : edit_free_file * * Description : Free a complete file in memory. * * Parameters : * 1 : file = Data structure to free. * * Returns : N/A * *********************************************************************/ void edit_free_file(struct editable_file * file) { if (!file) { /* Silently ignore NULL pointer */ return; } edit_free_file_lines(file->lines); freez(file->version_str); file->version = 0; file->parse_error_text = NULL; /* Statically allocated */ file->parse_error = NULL; free(file); } /********************************************************************* * * Function : edit_free_file_lines * * Description : Free an entire linked list of file lines. * * Parameters : * 1 : first_line = Data structure to free. * * Returns : N/A * *********************************************************************/ static void edit_free_file_lines(struct file_line * first_line) { struct file_line * next_line; while (first_line != NULL) { next_line = first_line->next; first_line->next = NULL; freez(first_line->raw); freez(first_line->prefix); freez(first_line->unprocessed); switch(first_line->type) { case 0: /* special case if memory zeroed */ case FILE_LINE_UNPROCESSED: case FILE_LINE_BLANK: case FILE_LINE_ALIAS_HEADER: case FILE_LINE_SETTINGS_HEADER: case FILE_LINE_DESCRIPTION_HEADER: case FILE_LINE_DESCRIPTION_ENTRY: case FILE_LINE_ALIAS_ENTRY: case FILE_LINE_URL: /* No data is stored for these */ break; case FILE_LINE_ACTION: free_action(first_line->data.action); break; case FILE_LINE_SETTINGS_ENTRY: freez(first_line->data.setting.name); freez(first_line->data.setting.svalue); break; default: /* Should never happen */ assert(0); break; } first_line->type = 0; /* paranoia */ free(first_line); first_line = next_line; } } /********************************************************************* * * Function : match_actions_file_header_line * * Description : Match an actions file {{header}} line * * Parameters : * 1 : line = String from file * 2 : name = Header to match against * * Returns : 0 iff they match. * *********************************************************************/ static int match_actions_file_header_line(const char * line, const char * name) { size_t len; assert(line); assert(name); /* Look for "{{" */ if ((line[0] != '{') || (line[1] != '{')) { return 1; } line += 2; /* Look for optional whitespace */ while ( (*line == ' ') || (*line == '\t') ) { line++; } /* Look for the specified name (case-insensitive) */ len = strlen(name); if (0 != strncmpic(line, name, len)) { return 1; } line += len; /* Look for optional whitespace */ while ( (*line == ' ') || (*line == '\t') ) { line++; } /* Look for "}}" and end of string*/ if ((line[0] != '}') || (line[1] != '}') || (line[2] != '\0')) { return 1; } /* It matched!! */ return 0; } /********************************************************************* * * Function : match_actions_file_header_line * * Description : Match an actions file {{header}} line * * Parameters : * 1 : line = String from file. Must not start with * whitespace (else infinite loop!) * 2 : pname = Destination for name * 2 : pvalue = Destination for value * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_PARSE if there's no "=" sign, or if there's * nothing before the "=" sign (but empty * values *after* the "=" sign are legal). * *********************************************************************/ static jb_err split_line_on_equals(const char * line, char ** pname, char ** pvalue) { const char * name_end; const char * value_start; size_t name_len; assert(line); assert(pname); assert(pvalue); assert(*line != ' '); assert(*line != '\t'); *pname = NULL; *pvalue = NULL; value_start = strchr(line, '='); if ((value_start == NULL) || (value_start == line)) { return JB_ERR_PARSE; } name_end = value_start - 1; /* Eat any whitespace before the '=' */ while ((*name_end == ' ') || (*name_end == '\t')) { /* * we already know we must have at least 1 non-ws char * at start of buf - no need to check */ name_end--; } name_len = (size_t)(name_end - line) + 1; /* Length excluding \0 */ if (NULL == (*pname = (char *) malloc(name_len + 1))) { return JB_ERR_MEMORY; } strncpy(*pname, line, name_len); (*pname)[name_len] = '\0'; /* Eat any the whitespace after the '=' */ value_start++; while ((*value_start == ' ') || (*value_start == '\t')) { value_start++; } if (NULL == (*pvalue = strdup(value_start))) { free(*pname); *pname = NULL; return JB_ERR_MEMORY; } return JB_ERR_OK; } /********************************************************************* * * Function : edit_parse_actions_file * * Description : Parse an actions file in memory. * * Passed linked list must have the "data" member * zeroed, and must contain valid "next" and * "unprocessed" fields. The "raw" and "prefix" * fields are ignored, and "type" is just overwritten. * * Note that on error the file may have been * partially parsed. * * Parameters : * 1 : file = Actions file to be parsed in-place. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_PARSE on error * *********************************************************************/ jb_err edit_parse_actions_file(struct editable_file * file) { struct file_line * cur_line; size_t len; const char * text; /* Text from a line */ char * name; /* For lines of the form name=value */ char * value; /* For lines of the form name=value */ struct action_alias * alias_list = NULL; jb_err err = JB_ERR_OK; /* alias_list contains the aliases defined in this file. * It might be better to use the "file_line.data" fields * in the relavent places instead. */ cur_line = file->lines; /* A note about blank line support: Blank lines should only * ever occur as the last line in the file. This function * is more forgiving than that - FILE_LINE_BLANK can occur * anywhere. */ /* Skip leading blanks. Should only happen if file is * empty (which is valid, but pointless). */ while ( (cur_line != NULL) && (cur_line->unprocessed[0] == '\0') ) { /* Blank line */ cur_line->type = FILE_LINE_BLANK; cur_line = cur_line->next; } if ( (cur_line != NULL) && (cur_line->unprocessed[0] != '{') ) { /* File doesn't start with a header */ file->parse_error = cur_line; file->parse_error_text = "First (non-comment) line of the file must contain a header."; return JB_ERR_PARSE; } if ( (cur_line != NULL) && (0 == match_actions_file_header_line(cur_line->unprocessed, "settings") ) ) { cur_line->type = FILE_LINE_SETTINGS_HEADER; cur_line = cur_line->next; while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{')) { if (cur_line->unprocessed[0]) { cur_line->type = FILE_LINE_SETTINGS_ENTRY; err = split_line_on_equals(cur_line->unprocessed, &cur_line->data.setting.name, &cur_line->data.setting.svalue); if (err == JB_ERR_MEMORY) { return err; } else if (err != JB_ERR_OK) { /* Line does not contain a name=value pair */ file->parse_error = cur_line; file->parse_error_text = "Expected a name=value pair on this {{description}} line, but couldn't find one."; return JB_ERR_PARSE; } } else { cur_line->type = FILE_LINE_BLANK; } cur_line = cur_line->next; } } if ( (cur_line != NULL) && (0 == match_actions_file_header_line(cur_line->unprocessed, "description") ) ) { cur_line->type = FILE_LINE_DESCRIPTION_HEADER; cur_line = cur_line->next; while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{')) { if (cur_line->unprocessed[0]) { cur_line->type = FILE_LINE_DESCRIPTION_ENTRY; } else { cur_line->type = FILE_LINE_BLANK; } cur_line = cur_line->next; } } if ( (cur_line != NULL) && (0 == match_actions_file_header_line(cur_line->unprocessed, "alias") ) ) { cur_line->type = FILE_LINE_ALIAS_HEADER; cur_line = cur_line->next; while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{')) { if (cur_line->unprocessed[0]) { /* define an alias */ struct action_alias * new_alias; cur_line->type = FILE_LINE_ALIAS_ENTRY; err = split_line_on_equals(cur_line->unprocessed, &name, &value); if (err == JB_ERR_MEMORY) { return err; } else if (err != JB_ERR_OK) { /* Line does not contain a name=value pair */ file->parse_error = cur_line; file->parse_error_text = "Expected a name=value pair on this {{alias}} line, but couldn't find one."; return JB_ERR_PARSE; } if ((new_alias = zalloc(sizeof(*new_alias))) == NULL) { /* Out of memory */ free(name); free(value); free_alias_list(alias_list); return JB_ERR_MEMORY; } err = get_actions(value, alias_list, new_alias->action); if (err) { /* Invalid action or out of memory */ free(name); free(value); free(new_alias); free_alias_list(alias_list); if (err == JB_ERR_MEMORY) { return err; } else { /* Line does not contain a name=value pair */ file->parse_error = cur_line; file->parse_error_text = "This alias does not specify a valid set of actions."; return JB_ERR_PARSE; } } free(value); new_alias->name = name; /* add to list */ new_alias->next = alias_list; alias_list = new_alias; } else { cur_line->type = FILE_LINE_BLANK; } cur_line = cur_line->next; } } /* Header done, process the main part of the file */ while (cur_line != NULL) { /* At this point, (cur_line->unprocessed[0] == '{') */ assert(cur_line->unprocessed[0] == '{'); text = cur_line->unprocessed + 1; len = strlen(text) - 1; if (text[len] != '}') { /* No closing } on header */ free_alias_list(alias_list); file->parse_error = cur_line; file->parse_error_text = "Headers starting with '{' must have a " "closing bracket ('}'). Headers starting with two brackets ('{{') " "must close with two brackets ('}}')."; return JB_ERR_PARSE; } if (text[0] == '{') { /* An invalid {{ header. */ free_alias_list(alias_list); file->parse_error = cur_line; file->parse_error_text = "Unknown or unexpected two-bracket header. " "Please remember that the system (two-bracket) headers must " "appear in the order {{settings}}, {{description}}, {{alias}}, " "and must appear before any actions (one-bracket) headers. " "Also note that system headers may not be repeated."; return JB_ERR_PARSE; } while ( (*text == ' ') || (*text == '\t') ) { text++; len--; } while ( (len > (size_t)0) && ( (text[len - 1] == ' ') || (text[len - 1] == '\t') ) ) { len--; } cur_line->type = FILE_LINE_ACTION; /* Remove {} and make copy */ if (NULL == (value = (char *) malloc(len + 1))) { /* Out of memory */ free_alias_list(alias_list); return JB_ERR_MEMORY; } strncpy(value, text, len); value[len] = '\0'; /* Get actions */ err = get_actions(value, alias_list, cur_line->data.action); if (err) { /* Invalid action or out of memory */ free(value); free_alias_list(alias_list); if (err == JB_ERR_MEMORY) { return err; } else { /* Line does not contain a name=value pair */ file->parse_error = cur_line; file->parse_error_text = "This header does not specify a valid set of actions."; return JB_ERR_PARSE; } } /* Done with string - it was clobbered anyway */ free(value); /* Process next line */ cur_line = cur_line->next; /* Loop processing URL patterns */ while ((cur_line != NULL) && (cur_line->unprocessed[0] != '{')) { if (cur_line->unprocessed[0]) { /* Could parse URL here, but this isn't currently needed */ cur_line->type = FILE_LINE_URL; } else { cur_line->type = FILE_LINE_BLANK; } cur_line = cur_line->next; } } /* End main while(cur_line != NULL) loop */ free_alias_list(alias_list); return JB_ERR_OK; } /********************************************************************* * * Function : edit_read_file_lines * * Description : Read all the lines of a file into memory. * Handles whitespace, comments and line continuation. * * Parameters : * 1 : fp = File to read from. On return, this will be * at EOF but it will not have been closed. * 2 : pfile = Destination for a linked list of file_lines. * Will be set to NULL on error. * 3 : newline = How to handle newlines. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * *********************************************************************/ jb_err edit_read_file_lines(FILE *fp, struct file_line ** pfile, int *newline) { struct file_line * first_line; /* Keep for return value or to free */ struct file_line * cur_line; /* Current line */ struct file_line * prev_line; /* Entry with prev_line->next = cur_line */ jb_err rval; assert(fp); assert(pfile); *pfile = NULL; cur_line = first_line = zalloc(sizeof(struct file_line)); if (cur_line == NULL) { return JB_ERR_MEMORY; } cur_line->type = FILE_LINE_UNPROCESSED; rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL); if (rval) { /* Out of memory or empty file. */ /* Note that empty file is not an error we propagate up */ free(cur_line); return ((rval == JB_ERR_FILE) ? JB_ERR_OK : rval); } do { prev_line = cur_line; cur_line = prev_line->next = zalloc(sizeof(struct file_line)); if (cur_line == NULL) { /* Out of memory */ edit_free_file_lines(first_line); return JB_ERR_MEMORY; } cur_line->type = FILE_LINE_UNPROCESSED; rval = edit_read_line(fp, &cur_line->raw, &cur_line->prefix, &cur_line->unprocessed, newline, NULL); if ((rval != JB_ERR_OK) && (rval != JB_ERR_FILE)) { /* Out of memory */ edit_free_file_lines(first_line); return JB_ERR_MEMORY; } } while (rval != JB_ERR_FILE); /* EOF */ /* We allocated one too many - free it */ prev_line->next = NULL; free(cur_line); *pfile = first_line; return JB_ERR_OK; } /********************************************************************* * * Function : edit_read_file * * Description : Read a complete file into memory. * Handles CGI parameter parsing. If requested, also * checks the file's modification timestamp. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : parameters = map of cgi parameters. * 3 : require_version = true to check "ver" parameter. * 4 : pfile = Destination for the file. Will be set * to NULL on error. * * CGI Parameters : * f : The action file identifier. * ver : (Only if require_version is nonzero) * Timestamp of the actions file. If wrong, this * function fails with JB_ERR_MODIFIED. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if "filename" was not specified * or is not valid. * JB_ERR_FILE if the file cannot be opened or * contains no data * JB_ERR_MODIFIED if version checking was requested and * failed - the file was modified outside * of this CGI editor instance. * *********************************************************************/ jb_err edit_read_file(struct client_state *csp, const struct map *parameters, int require_version, struct editable_file **pfile) { struct file_line * lines; FILE * fp; jb_err err; const char *filename = NULL; struct editable_file * file; unsigned version = 0; struct stat statbuf[1]; char version_buf[22]; int newline = NEWLINE_UNKNOWN; unsigned i; assert(csp); assert(parameters); assert(pfile); *pfile = NULL; err = get_number_param(csp, parameters, "f", &i); if ((JB_ERR_OK == err) && (i < MAX_AF_FILES) && (NULL != csp->config->actions_file[i])) { filename = csp->config->actions_file[i]; } else if (JB_ERR_CGI_PARAMS == err) { /* * Probably an old-school URL like * http://config.privoxy.org/edit-actions-list?f=default */ get_file_name_param(csp, parameters, "f", &filename); } if (NULL == filename || stat(filename, statbuf) < 0) { /* Error, probably file not found. */ return JB_ERR_FILE; } version = (unsigned) statbuf->st_mtime; if (require_version) { unsigned specified_version; err = get_number_param(csp, parameters, "v", &specified_version); if (err) { return err; } if (version != specified_version) { return JB_ERR_MODIFIED; } } if (NULL == (fp = fopen(filename,"rb"))) { return JB_ERR_FILE; } err = edit_read_file_lines(fp, &lines, &newline); fclose(fp); if (err) { return err; } file = (struct editable_file *) zalloc(sizeof(*file)); if (err) { edit_free_file_lines(lines); return err; } file->lines = lines; file->newline = newline; file->filename = filename; file->version = version; file->identifier = i; /* Correct file->version_str */ freez(file->version_str); snprintf(version_buf, sizeof(version_buf), "%u", file->version); version_buf[sizeof(version_buf)-1] = '\0'; file->version_str = strdup(version_buf); if (version_buf == NULL) { edit_free_file(file); return JB_ERR_MEMORY; } *pfile = file; return JB_ERR_OK; } /********************************************************************* * * Function : edit_read_actions_file * * Description : Read a complete actions file into memory. * Handles CGI parameter parsing. If requested, also * checks the file's modification timestamp. * * If this function detects an error in the categories * JB_ERR_FILE, JB_ERR_MODIFIED, or JB_ERR_PARSE, * then it handles it by filling in the specified * response structure and returning JB_ERR_FILE. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : rsp = HTTP response. Only filled in on error. * 2 : parameters = map of cgi parameters. * 3 : require_version = true to check "ver" parameter. * 4 : pfile = Destination for the file. Will be set * to NULL on error. * * CGI Parameters : * f : The actions file identifier. * ver : (Only if require_version is nonzero) * Timestamp of the actions file. If wrong, this * function fails with JB_ERR_MODIFIED. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if "filename" was not specified * or is not valid. * JB_ERR_FILE if the file does not contain valid data, * or if file cannot be opened or * contains no data, or if version * checking was requested and failed. * *********************************************************************/ jb_err edit_read_actions_file(struct client_state *csp, struct http_response *rsp, const struct map *parameters, int require_version, struct editable_file **pfile) { jb_err err; struct editable_file *file; static int acceptable_failures = ACCEPTABLE_TIMESTAMP_MISMATCHES - 1; assert(csp); assert(parameters); assert(pfile); *pfile = NULL; err = edit_read_file(csp, parameters, require_version, &file); if (err) { /* Try to handle if possible */ if (err == JB_ERR_FILE) { err = cgi_error_file(csp, rsp, lookup(parameters, "f")); } else if (err == JB_ERR_MODIFIED) { assert(require_version); err = cgi_error_modified(csp, rsp, lookup(parameters, "f")); log_error(LOG_LEVEL_ERROR, "Blocking CGI edit request due to modification time mismatch."); if (acceptable_failures > 0) { log_error(LOG_LEVEL_INFO, "The CGI editor will be turned off after another %d mismatche(s).", acceptable_failures); acceptable_failures--; } else { log_error(LOG_LEVEL_INFO, "Timestamp mismatch limit reached, turning CGI editor off. " "Reload the configuration file to re-enable it."); csp->config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS; } } if (err == JB_ERR_OK) { /* * Signal to higher-level CGI code that there was a problem but we * handled it, they should just return JB_ERR_OK. */ err = JB_ERR_FILE; } return err; } err = edit_parse_actions_file(file); if (err) { if (err == JB_ERR_PARSE) { err = cgi_error_parse(csp, rsp, file); if (err == JB_ERR_OK) { /* * Signal to higher-level CGI code that there was a problem but we * handled it, they should just return JB_ERR_OK. */ err = JB_ERR_FILE; } } edit_free_file(file); return err; } *pfile = file; return JB_ERR_OK; } /********************************************************************* * * Function : get_file_name_param * * Description : Get the name of the file to edit from the parameters * passed to a CGI function using the old syntax. * This function handles security checks and only * accepts files that Privoxy already knows. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) * 2 : parameters = map of cgi parameters * 3 : param_name = The name of the parameter to read * 4 : pfilename = pointer to the filename in * csp->config->actions_file[] if found. Set to NULL on error. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory * JB_ERR_CGI_PARAMS if "filename" was not specified * or is not valid. * *********************************************************************/ static jb_err get_file_name_param(struct client_state *csp, const struct map *parameters, const char *param_name, const char **pfilename) { const char *param; const char suffix[] = ".action"; const char *s; char *name; char *fullpath; char ch; size_t len; size_t name_size; int i; assert(csp); assert(parameters); assert(pfilename); *pfilename = NULL; param = lookup(parameters, param_name); if (!*param) { return JB_ERR_CGI_PARAMS; } len = strlen(param); if (len >= FILENAME_MAX) { /* Too long. */ return JB_ERR_CGI_PARAMS; } /* * Check every character to see if it's legal. * Totally unnecessary but we do it anyway. */ s = param; while ((ch = *s++) != '\0') { if ( ((ch < 'A') || (ch > 'Z')) && ((ch < 'a') || (ch > 'z')) && ((ch < '0') || (ch > '9')) && (ch != '-') && (ch != '_') ) { /* Probable hack attempt. */ return JB_ERR_CGI_PARAMS; } } /* Append extension */ name_size = len + strlen(suffix) + 1; name = malloc(name_size); if (name == NULL) { return JB_ERR_MEMORY; } strlcpy(name, param, name_size); strlcat(name, suffix, name_size); /* Prepend path */ fullpath = make_path(csp->config->confdir, name); free(name); if (fullpath == NULL) { return JB_ERR_MEMORY; } /* Check if the file is known */ for (i = 0; i < MAX_AF_FILES; i++) { if (NULL != csp->config->actions_file[i] && !strcmp(fullpath, csp->config->actions_file[i])) { /* Success */ *pfilename = csp->config->actions_file[i]; freez(fullpath); return JB_ERR_OK; } } freez(fullpath); return JB_ERR_CGI_PARAMS; } /********************************************************************* * * Function : get_url_spec_param * * Description : Get a URL pattern from the parameters * passed to a CGI function. Removes leading/trailing * spaces and validates it. * * 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. Will be malloc()'d. * Set to NULL 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. * *********************************************************************/ static jb_err get_url_spec_param(struct client_state *csp, const struct map *parameters, const char *name, char **pvalue) { const char *orig_param; char *param; char *s; struct url_spec compiled[1]; jb_err err; assert(csp); assert(parameters); assert(name); assert(pvalue); *pvalue = NULL; orig_param = lookup(parameters, name); if (!*orig_param) { return JB_ERR_CGI_PARAMS; } /* Copy and trim whitespace */ param = strdup(orig_param); if (param == NULL) { return JB_ERR_MEMORY; } chomp(param); /* Must be non-empty, and can't allow 1st character to be '{' */ if (param[0] == '\0' || param[0] == '{') { free(param); return JB_ERR_CGI_PARAMS; } /* Check for embedded newlines */ for (s = param; *s != '\0'; s++) { if ((*s == '\r') || (*s == '\n')) { free(param); return JB_ERR_CGI_PARAMS; } } /* Check that regex is valid */ s = strdup(param); if (s == NULL) { free(param); return JB_ERR_MEMORY; } err = create_url_spec(compiled, s); free(s); if (err) { free(param); return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS; } free_url_spec(compiled); if (param[strlen(param) - 1] == '\\') { /* * Must protect trailing '\\' from becoming line continuation character. * Two methods: 1) If it's a domain only, add a trailing '/'. * 2) For path, add the do-nothing PCRE expression (?:) to the end */ if (strchr(param, '/') == NULL) { err = string_append(¶m, "/"); } else { err = string_append(¶m, "(?:)"); } if (err) { return err; } /* Check that the modified regex is valid */ s = strdup(param); if (s == NULL) { free(param); return JB_ERR_MEMORY; } err = create_url_spec(compiled, s); free(s); if (err) { free(param); return (err == JB_ERR_MEMORY) ? JB_ERR_MEMORY : JB_ERR_CGI_PARAMS; } free_url_spec(compiled); } *pvalue = param; return JB_ERR_OK; } /********************************************************************* * * Function : map_radio * * Description : Map a set of radio button values. E.g. if you have * 3 radio buttons, declare them as: *