1 const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.109 2010/01/10 13:53:48 ler762 Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/loadcfg.c,v $
6 * Purpose : Loads settings from the configuration file into
7 * global variables. This file contains both the
8 * routine to load the configuration and the global
9 * variables it writes to.
11 * Copyright : Written by and Copyright (C) 2001-2009 the
12 * Privoxy team. http://www.privoxy.org/
14 * Based on the Internet Junkbuster originally written
15 * by and Copyright (C) 1997 Anonymous Coders and
16 * Junkbusters Corporation. http://www.junkbusters.com
18 * This program is free software; you can redistribute it
19 * and/or modify it under the terms of the GNU General
20 * Public License as published by the Free Software
21 * Foundation; either version 2 of the License, or (at
22 * your option) any later version.
24 * This program is distributed in the hope that it will
25 * be useful, but WITHOUT ANY WARRANTY; without even the
26 * implied warranty of MERCHANTABILITY or FITNESS FOR A
27 * PARTICULAR PURPOSE. See the GNU General Public
28 * License for more details.
30 * The GNU General Public License should be included with
31 * this file. If not, you can view it at
32 * http://www.gnu.org/copyleft/gpl.html
33 * or write to the Free Software Foundation, Inc., 59
34 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
36 *********************************************************************/
42 #include <sys/types.h>
61 # endif /* ndef _WIN_CONSOLE */
63 #else /* ifndef _WIN32 */
67 # include <sys/wait.h>
69 # include <sys/time.h>
70 # include <sys/stat.h>
88 const char loadcfg_h_rcs[] = LOADCFG_H_VERSION;
91 * Fix a problem with Solaris. There should be no effect on other
93 * Solaris's isspace() is a macro which uses it's argument directly
94 * as an array index. Therefore we need to make sure that high-bit
95 * characters generate +ve values, and ideally we also want to make
96 * the argument match the declared parameter type of "int".
98 #define ijb_isupper(__X) isupper((int)(unsigned char)(__X))
99 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
101 #ifdef FEATURE_TOGGLE
102 /* Privoxy is enabled by default. */
103 int global_toggle_state = 1;
104 #endif /* def FEATURE_TOGGLE */
106 /* The filename of the configfile */
107 const char *configfile = NULL;
110 * CGI functions will later need access to the invocation args,
111 * so we will make argc and argv global.
114 char * const * Argv = NULL;
116 static struct file_list *current_configfile = NULL;
120 * This takes the "cryptic" hash of each keyword and aliases them to
121 * something a little more readable. This also makes changing the
122 * hash values easier if they should change or the hash algorthm changes.
123 * Use the included "hash" program to find out what the hash will be
124 * for any string supplied on the command line. (Or just put it in the
125 * config file and read the number from the error message in the log).
127 * Please keep this list sorted alphabetically (but with the Windows
128 * console and GUI specific options last).
131 #define hash_actions_file 1196306641ul /* "actionsfile" */
132 #define hash_accept_intercepted_requests 1513024973ul /* "accept-intercepted-requests" */
133 #define hash_admin_address 4112573064ul /* "admin-address" */
134 #define hash_allow_cgi_request_crunching 258915987ul /* "allow-cgi-request-crunching" */
135 #define hash_buffer_limit 1881726070ul /* "buffer-limit */
136 #define hash_confdir 1978389ul /* "confdir" */
137 #define hash_connection_sharing 1348841265ul /* "connection-sharing" */
138 #define hash_debug 78263ul /* "debug" */
139 #define hash_default_server_timeout 2530089913ul /* "default-server-timeout" */
140 #define hash_deny_access 1227333715ul /* "deny-access" */
141 #define hash_enable_edit_actions 2517097536ul /* "enable-edit-actions" */
142 #define hash_enable_remote_toggle 2979744683ul /* "enable-remote-toggle" */
143 #define hash_enable_remote_http_toggle 110543988ul /* "enable-remote-http-toggle" */
144 #define hash_enforce_blocks 1862427469ul /* "enforce-blocks" */
145 #define hash_filterfile 250887266ul /* "filterfile" */
146 #define hash_forward 2029845ul /* "forward" */
147 #define hash_forward_socks4 3963965521ul /* "forward-socks4" */
148 #define hash_forward_socks4a 2639958518ul /* "forward-socks4a" */
149 #define hash_forward_socks5 3963965522ul /* "forward-socks5" */
150 #define hash_forwarded_connect_retries 101465292ul /* "forwarded-connect-retries" */
151 #define hash_handle_as_empty_returns_ok 1444873247ul /* "handle-as-empty-doc-returns-ok" */
152 #define hash_hostname 10308071ul /* "hostname" */
153 #define hash_keep_alive_timeout 3878599515ul /* "keep-alive-timeout" */
154 #define hash_listen_address 1255650842ul /* "listen-address" */
155 #define hash_logdir 422889ul /* "logdir" */
156 #define hash_logfile 2114766ul /* "logfile" */
157 #define hash_max_client_connections 3595884446ul /* "max-client-connections" */
158 #define hash_permit_access 3587953268ul /* "permit-access" */
159 #define hash_proxy_info_url 3903079059ul /* "proxy-info-url" */
160 #define hash_single_threaded 4250084780ul /* "single-threaded" */
161 #define hash_socket_timeout 1809001761ul /* "socket-timeout" */
162 #define hash_split_large_cgi_forms 671658948ul /* "split-large-cgi-forms" */
163 #define hash_suppress_blocklists 1948693308ul /* "suppress-blocklists" */
164 #define hash_templdir 11067889ul /* "templdir" */
165 #define hash_toggle 447966ul /* "toggle" */
166 #define hash_trust_info_url 430331967ul /* "trust-info-url" */
167 #define hash_trustfile 56494766ul /* "trustfile" */
168 #define hash_usermanual 1416668518ul /* "user-manual" */
169 #define hash_activity_animation 1817904738ul /* "activity-animation" */
170 #define hash_close_button_minimizes 3651284693ul /* "close-button-minimizes" */
171 #define hash_hide_console 2048809870ul /* "hide-console" */
172 #define hash_log_buffer_size 2918070425ul /* "log-buffer-size" */
173 #define hash_log_font_name 2866730124ul /* "log-font-name" */
174 #define hash_log_font_size 2866731014ul /* "log-font-size" */
175 #define hash_log_highlight_messages 4032101240ul /* "log-highlight-messages" */
176 #define hash_log_max_lines 2868344173ul /* "log-max-lines" */
177 #define hash_log_messages 2291744899ul /* "log-messages" */
178 #define hash_show_on_task_bar 215410365ul /* "show-on-task-bar" */
181 static void savearg(char *command, char *argument, struct configuration_spec * config);
183 /*********************************************************************
185 * Function : unload_configfile
187 * Description : Free the config structure and all components.
190 * 1 : data: struct configuration_spec to unload
194 *********************************************************************/
195 static void unload_configfile (void * data)
197 struct configuration_spec * config = (struct configuration_spec *)data;
198 struct forward_spec *cur_fwd = config->forward;
202 struct access_control_list *cur_acl = config->acl;
204 while (cur_acl != NULL)
206 struct access_control_list * next_acl = cur_acl->next;
211 #endif /* def FEATURE_ACL */
213 while (cur_fwd != NULL)
215 struct forward_spec * next_fwd = cur_fwd->next;
216 free_url_spec(cur_fwd->url);
218 freez(cur_fwd->gateway_host);
219 freez(cur_fwd->forward_host);
223 config->forward = NULL;
225 freez(config->confdir);
226 freez(config->logdir);
227 freez(config->templdir);
228 freez(config->hostname);
230 freez(config->haddr);
231 freez(config->logfile);
233 for (i = 0; i < MAX_AF_FILES; i++)
235 freez(config->actions_file_short[i]);
236 freez(config->actions_file[i]);
237 freez(config->re_filterfile_short[i]);
238 freez(config->re_filterfile[i]);
241 freez(config->admin_address);
242 freez(config->proxy_info_url);
243 freez(config->proxy_args);
244 freez(config->usermanual);
247 freez(config->trustfile);
248 list_remove_all(config->trust_info);
249 #endif /* def FEATURE_TRUST */
255 #ifdef FEATURE_GRACEFUL_TERMINATION
256 /*********************************************************************
258 * Function : unload_current_config_file
260 * Description : Unloads current config file - reset to state at
261 * beginning of program.
267 *********************************************************************/
268 void unload_current_config_file(void)
270 if (current_configfile)
272 current_configfile->unloader = unload_configfile;
273 current_configfile = NULL;
279 /*********************************************************************
281 * Function : load_config
283 * Description : Load the config file and all parameters.
285 * XXX: more than thousand lines long
286 * and thus in serious need of refactoring.
290 * Returns : The configuration_spec, or NULL on error.
292 *********************************************************************/
293 struct configuration_spec * load_config(void)
295 char buf[BUFFER_SIZE];
297 FILE *configfp = NULL;
298 struct configuration_spec * config = NULL;
299 struct client_state * fake_csp;
300 struct file_list *fs;
301 unsigned long linenum = 0;
303 char *logfile = NULL;
305 if (!check_file_changed(current_configfile, configfile, &fs))
307 /* No need to load */
308 return ((struct configuration_spec *)current_configfile->f);
312 log_error(LOG_LEVEL_FATAL,
313 "can't check configuration file '%s': %E", configfile);
317 if (NULL != current_configfile)
319 log_error(LOG_LEVEL_INFO, "Reloading configuration file '%s'", configfile);
322 #ifdef FEATURE_TOGGLE
323 global_toggle_state = 1;
324 #endif /* def FEATURE_TOGGLE */
326 fs->f = config = (struct configuration_spec *)zalloc(sizeof(*config));
332 log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
337 * This is backwards from how it's usually done.
338 * Following the usual pattern, "fs" would be stored in a member
339 * variable in "csp", and then we'd access "config" from "fs->f",
340 * using a cast. However, "config" is used so often that a
341 * cast each time would be very ugly, and the extra indirection
342 * would waste CPU cycles. Therefore we store "config" in
343 * "csp->config", and "fs" in "csp->config->config_file_list".
345 config->config_file_list = fs;
350 config->multi_threaded = 1;
351 config->buffer_limit = 4096 * 1024;
352 config->usermanual = strdup(USER_MANUAL_URL);
353 config->proxy_args = strdup("");
354 config->forwarded_connect_retries = 0;
355 config->max_client_connections = 0;
356 config->socket_timeout = 300; /* XXX: Should be a macro. */
357 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
358 config->default_server_timeout = 0;
359 config->keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
360 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
361 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
363 config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
364 config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
365 config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
366 config->feature_flags &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
368 configfp = fopen(configfile, "r");
369 if (NULL == configfp)
371 log_error(LOG_LEVEL_FATAL,
372 "can't open configuration file '%s': %E", configfile);
373 /* Never get here - LOG_LEVEL_FATAL causes program exit */
376 while (read_config_line(buf, sizeof(buf), configfp, &linenum) != NULL)
378 char cmd[BUFFER_SIZE];
379 char arg[BUFFER_SIZE];
380 char tmp[BUFFER_SIZE];
382 struct access_control_list *cur_acl;
383 #endif /* def FEATURE_ACL */
384 struct forward_spec *cur_fwd;
387 unsigned long directive_hash;
389 strlcpy(tmp, buf, sizeof(tmp));
391 /* Copy command (i.e. up to space or tab) into cmd */
394 while (*p && (*p != ' ') && (*p != '\t'))
400 /* Skip over the whitespace in buf */
401 while (*p && ((*p == ' ') || (*p == '\t')))
406 /* Copy the argument into arg */
407 strlcpy(arg, p, sizeof(arg));
409 /* Should never happen, but check this anyway */
415 /* Make sure the command field is lower case */
416 for (p = cmd; *p; p++)
420 *p = (char)ijb_tolower(*p);
424 directive_hash = hash_string(cmd);
425 switch (directive_hash)
427 /* *************************************************************************
428 * actionsfile actions-file-name
429 * In confdir by default
430 * *************************************************************************/
431 case hash_actions_file :
433 while ((i < MAX_AF_FILES) && (NULL != config->actions_file[i]))
438 if (i >= MAX_AF_FILES)
440 log_error(LOG_LEVEL_FATAL, "Too many 'actionsfile' directives in config file - limit is %d.\n"
441 "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
444 config->actions_file_short[i] = strdup(arg);
445 config->actions_file[i] = make_path(config->confdir, arg);
448 /* *************************************************************************
449 * accept-intercepted-requests
450 * *************************************************************************/
451 case hash_accept_intercepted_requests:
452 if ((*arg != '\0') && (0 != atoi(arg)))
454 config->feature_flags |= RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
458 config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
462 /* *************************************************************************
463 * admin-address email-address
464 * *************************************************************************/
465 case hash_admin_address :
466 freez(config->admin_address);
467 config->admin_address = strdup(arg);
470 /* *************************************************************************
471 * allow-cgi-request-crunching
472 * *************************************************************************/
473 case hash_allow_cgi_request_crunching:
474 if ((*arg != '\0') && (0 != atoi(arg)))
476 config->feature_flags |= RUNTIME_FEATURE_CGI_CRUNCHING;
480 config->feature_flags &= ~RUNTIME_FEATURE_CGI_CRUNCHING;
484 /* *************************************************************************
486 * *************************************************************************/
487 case hash_buffer_limit :
488 config->buffer_limit = (size_t)(1024 * atoi(arg));
491 /* *************************************************************************
492 * confdir directory-name
493 * *************************************************************************/
495 freez(config->confdir);
496 config->confdir = make_path( NULL, arg);
499 /* *************************************************************************
500 * connection-sharing (0|1)
501 * *************************************************************************/
502 #ifdef FEATURE_CONNECTION_SHARING
503 case hash_connection_sharing :
504 if ((*arg != '\0') && (0 != atoi(arg)))
506 config->feature_flags |= RUNTIME_FEATURE_CONNECTION_SHARING;
510 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
515 /* *************************************************************************
517 * Specifies debug level, multiple values are ORed together.
518 * *************************************************************************/
520 config->debug |= atoi(arg);
523 /* *************************************************************************
524 * default-server-timeout timeout
525 * *************************************************************************/
526 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
527 case hash_default_server_timeout :
530 int timeout = atoi(arg);
533 config->default_server_timeout = (unsigned int)timeout;
537 log_error(LOG_LEVEL_FATAL,
538 "Invalid default-server-timeout value: %s", arg);
544 /* *************************************************************************
545 * deny-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
546 * *************************************************************************/
548 case hash_deny_access:
549 strlcpy(tmp, arg, sizeof(tmp));
550 vec_count = ssplit(tmp, " \t", vec, SZ(vec), 1, 1);
552 if ((vec_count != 1) && (vec_count != 2))
554 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
555 "deny-access directive in configuration file.");
556 string_append(&config->proxy_args,
557 "<br>\nWARNING: Wrong number of parameters for "
558 "deny-access directive in configuration file.<br><br>\n");
562 /* allocate a new node */
563 cur_acl = (struct access_control_list *) zalloc(sizeof(*cur_acl));
567 log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
568 /* Never get here - LOG_LEVEL_FATAL causes program exit */
571 cur_acl->action = ACL_DENY;
573 if (acl_addr(vec[0], cur_acl->src) < 0)
575 log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
576 "for deny-access directive in configuration file: \"%s\"", vec[0]);
577 string_append(&config->proxy_args,
578 "<br>\nWARNING: Invalid source address, port or netmask "
579 "for deny-access directive in configuration file: \"");
580 string_append(&config->proxy_args,
582 string_append(&config->proxy_args,
589 if (acl_addr(vec[1], cur_acl->dst) < 0)
591 log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
592 "for deny-access directive in configuration file: \"%s\"", vec[1]);
593 string_append(&config->proxy_args,
594 "<br>\nWARNING: Invalid destination address, port or netmask "
595 "for deny-access directive in configuration file: \"");
596 string_append(&config->proxy_args,
598 string_append(&config->proxy_args,
607 cur_acl->wildcard_dst = 1;
609 #endif /* def HAVE_RFC2553 */
612 * Add it to the list. Note we reverse the list to get the
613 * behaviour the user expects. With both the ACL and
614 * actions file, the last match wins. However, the internal
615 * implementations are different: The actions file is stored
616 * in the same order as the file, and scanned completely.
617 * With the ACL, we reverse the order as we load it, then
618 * when we scan it we stop as soon as we get a match.
620 cur_acl->next = config->acl;
621 config->acl = cur_acl;
624 #endif /* def FEATURE_ACL */
626 /* *************************************************************************
627 * enable-edit-actions 0|1
628 * *************************************************************************/
629 #ifdef FEATURE_CGI_EDIT_ACTIONS
630 case hash_enable_edit_actions:
631 if ((*arg != '\0') && (0 != atoi(arg)))
633 config->feature_flags |= RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
637 config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
640 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
642 /* *************************************************************************
643 * enable-remote-toggle 0|1
644 * *************************************************************************/
645 #ifdef FEATURE_TOGGLE
646 case hash_enable_remote_toggle:
647 if ((*arg != '\0') && (0 != atoi(arg)))
649 config->feature_flags |= RUNTIME_FEATURE_CGI_TOGGLE;
653 config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
656 #endif /* def FEATURE_TOGGLE */
658 /* *************************************************************************
659 * enable-remote-http-toggle 0|1
660 * *************************************************************************/
661 case hash_enable_remote_http_toggle:
662 if ((*arg != '\0') && (0 != atoi(arg)))
664 config->feature_flags |= RUNTIME_FEATURE_HTTP_TOGGLE;
668 config->feature_flags &= ~RUNTIME_FEATURE_HTTP_TOGGLE;
672 /* *************************************************************************
674 * *************************************************************************/
675 case hash_enforce_blocks:
676 #ifdef FEATURE_FORCE_LOAD
677 if ((*arg != '\0') && (0 != atoi(arg)))
679 config->feature_flags |= RUNTIME_FEATURE_ENFORCE_BLOCKS;
683 config->feature_flags &= ~RUNTIME_FEATURE_ENFORCE_BLOCKS;
686 log_error(LOG_LEVEL_ERROR, "Ignoring directive 'enforce-blocks'. "
687 "FEATURE_FORCE_LOAD is disabled, blocks will always be enforced.");
688 #endif /* def FEATURE_FORCE_LOAD */
691 /* *************************************************************************
692 * filterfile file-name
693 * In confdir by default.
694 * *************************************************************************/
695 case hash_filterfile :
697 while ((i < MAX_AF_FILES) && (NULL != config->re_filterfile[i]))
702 if (i >= MAX_AF_FILES)
704 log_error(LOG_LEVEL_FATAL, "Too many 'filterfile' directives in config file - limit is %d.\n"
705 "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
708 config->re_filterfile_short[i] = strdup(arg);
709 config->re_filterfile[i] = make_path(config->confdir, arg);
713 /* *************************************************************************
714 * forward url-pattern (.|http-proxy-host[:port])
715 * *************************************************************************/
717 strlcpy(tmp, arg, sizeof(tmp));
718 vec_count = ssplit(tmp, " \t", vec, SZ(vec), 1, 1);
722 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for forward "
723 "directive in configuration file.");
724 string_append(&config->proxy_args,
725 "<br>\nWARNING: Wrong number of parameters for "
726 "forward directive in configuration file.");
730 /* allocate a new node */
731 cur_fwd = zalloc(sizeof(*cur_fwd));
734 log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
735 /* Never get here - LOG_LEVEL_FATAL causes program exit */
739 cur_fwd->type = SOCKS_NONE;
741 /* Save the URL pattern */
742 if (create_url_spec(cur_fwd->url, vec[0]))
744 log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward "
745 "directive in configuration file.");
746 string_append(&config->proxy_args,
747 "<br>\nWARNING: Bad URL specifier for "
748 "forward directive in configuration file.");
752 /* Parse the parent HTTP proxy host:port */
755 if (strcmp(p, ".") != 0)
757 cur_fwd->forward_port = 8000;
758 parse_forwarder_address(p, &cur_fwd->forward_host,
759 &cur_fwd->forward_port);
763 cur_fwd->next = config->forward;
764 config->forward = cur_fwd;
768 /* *************************************************************************
769 * forward-socks4 url-pattern socks-proxy[:port] (.|http-proxy[:port])
770 * *************************************************************************/
771 case hash_forward_socks4:
772 strlcpy(tmp, arg, sizeof(tmp));
773 vec_count = ssplit(tmp, " \t", vec, SZ(vec), 1, 1);
777 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
778 "forward-socks4 directive in configuration file.");
779 string_append(&config->proxy_args,
780 "<br>\nWARNING: Wrong number of parameters for "
781 "forward-socks4 directive in configuration file.");
785 /* allocate a new node */
786 cur_fwd = zalloc(sizeof(*cur_fwd));
789 log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
790 /* Never get here - LOG_LEVEL_FATAL causes program exit */
794 cur_fwd->type = SOCKS_4;
796 /* Save the URL pattern */
797 if (create_url_spec(cur_fwd->url, vec[0]))
799 log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward-socks4 "
800 "directive in configuration file.");
801 string_append(&config->proxy_args,
802 "<br>\nWARNING: Bad URL specifier for "
803 "forward-socks4 directive in configuration file.");
807 /* Parse the SOCKS proxy host[:port] */
810 /* XXX: This check looks like a bug. */
811 if (strcmp(p, ".") != 0)
813 cur_fwd->gateway_port = 1080;
814 parse_forwarder_address(p, &cur_fwd->gateway_host,
815 &cur_fwd->gateway_port);
818 /* Parse the parent HTTP proxy host[:port] */
821 if (strcmp(p, ".") != 0)
823 cur_fwd->forward_port = 8000;
824 parse_forwarder_address(p, &cur_fwd->forward_host,
825 &cur_fwd->forward_port);
829 cur_fwd->next = config->forward;
830 config->forward = cur_fwd;
834 /* *************************************************************************
835 * forward-socks4a url-pattern socks-proxy[:port] (.|http-proxy[:port])
836 * *************************************************************************/
837 case hash_forward_socks4a:
838 case hash_forward_socks5:
839 strlcpy(tmp, arg, sizeof(tmp));
840 vec_count = ssplit(tmp, " \t", vec, SZ(vec), 1, 1);
844 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
845 "forward-socks4a directive in configuration file.");
846 string_append(&config->proxy_args,
847 "<br>\nWARNING: Wrong number of parameters for "
848 "forward-socks4a directive in configuration file.");
852 /* allocate a new node */
853 cur_fwd = zalloc(sizeof(*cur_fwd));
856 log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
857 /* Never get here - LOG_LEVEL_FATAL causes program exit */
861 if (directive_hash == hash_forward_socks4a)
863 cur_fwd->type = SOCKS_4A;
867 cur_fwd->type = SOCKS_5;
870 /* Save the URL pattern */
871 if (create_url_spec(cur_fwd->url, vec[0]))
873 log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward-socks4a "
874 "directive in configuration file.");
875 string_append(&config->proxy_args,
876 "<br>\nWARNING: Bad URL specifier for "
877 "forward-socks4a directive in configuration file.");
881 /* Parse the SOCKS proxy host[:port] */
884 cur_fwd->gateway_port = 1080;
885 parse_forwarder_address(p, &cur_fwd->gateway_host,
886 &cur_fwd->gateway_port);
888 /* Parse the parent HTTP proxy host[:port] */
891 if (strcmp(p, ".") != 0)
893 cur_fwd->forward_port = 8000;
894 parse_forwarder_address(p, &cur_fwd->forward_host,
895 &cur_fwd->forward_port);
899 cur_fwd->next = config->forward;
900 config->forward = cur_fwd;
904 /* *************************************************************************
905 * forwarded-connect-retries n
906 * *************************************************************************/
907 case hash_forwarded_connect_retries :
908 config->forwarded_connect_retries = atoi(arg);
911 /* *************************************************************************
912 * handle-as-empty-doc-returns-ok 0|1
914 * Workaround for firefox hanging on blocked javascript pages.
915 * Block with the "+handle-as-empty-document" flag and set the
916 * "handle-as-empty-doc-returns-ok" run-time config flag so that
917 * Privoxy returns a 200/OK status instead of a 403/Forbidden status
918 * to the browser for blocked pages.
919 ***************************************************************************/
920 case hash_handle_as_empty_returns_ok:
921 if ((*arg != '\0') && (0 != atoi(arg)))
923 config->feature_flags |= RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
927 config->feature_flags &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
931 /* *************************************************************************
932 * hostname hostname-to-show-on-cgi-pages
933 * *************************************************************************/
935 freez(config->hostname);
936 config->hostname = strdup(arg);
937 if (NULL == config->hostname)
939 log_error(LOG_LEVEL_FATAL, "Out of memory saving hostname.");
943 /* *************************************************************************
944 * keep-alive-timeout timeout
945 * *************************************************************************/
946 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
947 case hash_keep_alive_timeout :
950 int timeout = atoi(arg);
953 config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
954 config->keep_alive_timeout = (unsigned int)timeout;
958 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
964 /* *************************************************************************
965 * listen-address [ip][:port]
966 * *************************************************************************/
967 case hash_listen_address :
968 freez(config->haddr);
969 config->haddr = strdup(arg);
972 /* *************************************************************************
973 * logdir directory-name
974 * *************************************************************************/
976 freez(config->logdir);
977 config->logdir = make_path(NULL, arg);
980 /* *************************************************************************
981 * logfile log-file-name
982 * In logdir by default
983 * *************************************************************************/
987 logfile = make_path(config->logdir, arg);
990 log_error(LOG_LEVEL_FATAL, "Out of memory while creating logfile path");
995 /* *************************************************************************
996 * max-client-connections number
997 * *************************************************************************/
998 case hash_max_client_connections :
1001 int max_client_connections = atoi(arg);
1002 if (0 <= max_client_connections)
1004 config->max_client_connections = max_client_connections;
1009 /* *************************************************************************
1010 * permit-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
1011 * *************************************************************************/
1013 case hash_permit_access:
1014 strlcpy(tmp, arg, sizeof(tmp));
1015 vec_count = ssplit(tmp, " \t", vec, SZ(vec), 1, 1);
1017 if ((vec_count != 1) && (vec_count != 2))
1019 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
1020 "permit-access directive in configuration file.");
1021 string_append(&config->proxy_args,
1022 "<br>\nWARNING: Wrong number of parameters for "
1023 "permit-access directive in configuration file.<br><br>\n");
1028 /* allocate a new node */
1029 cur_acl = (struct access_control_list *) zalloc(sizeof(*cur_acl));
1031 if (cur_acl == NULL)
1033 log_error(LOG_LEVEL_FATAL, "can't allocate memory for configuration");
1034 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1037 cur_acl->action = ACL_PERMIT;
1039 if (acl_addr(vec[0], cur_acl->src) < 0)
1041 log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
1042 "for permit-access directive in configuration file: \"%s\"", vec[0]);
1043 string_append(&config->proxy_args,
1044 "<br>\nWARNING: Invalid source address, port or netmask for "
1045 "permit-access directive in configuration file: \"");
1046 string_append(&config->proxy_args,
1048 string_append(&config->proxy_args,
1055 if (acl_addr(vec[1], cur_acl->dst) < 0)
1057 log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
1058 "for permit-access directive in configuration file: \"%s\"", vec[1]);
1059 string_append(&config->proxy_args,
1060 "<br>\nWARNING: Invalid destination address, port or netmask for "
1061 "permit-access directive in configuration file: \"");
1062 string_append(&config->proxy_args,
1064 string_append(&config->proxy_args,
1073 cur_acl->wildcard_dst = 1;
1075 #endif /* def HAVE_RFC2553 */
1078 * Add it to the list. Note we reverse the list to get the
1079 * behaviour the user expects. With both the ACL and
1080 * actions file, the last match wins. However, the internal
1081 * implementations are different: The actions file is stored
1082 * in the same order as the file, and scanned completely.
1083 * With the ACL, we reverse the order as we load it, then
1084 * when we scan it we stop as soon as we get a match.
1086 cur_acl->next = config->acl;
1087 config->acl = cur_acl;
1090 #endif /* def FEATURE_ACL */
1092 /* *************************************************************************
1093 * proxy-info-url url
1094 * *************************************************************************/
1095 case hash_proxy_info_url :
1096 freez(config->proxy_info_url);
1097 config->proxy_info_url = strdup(arg);
1100 /* *************************************************************************
1102 * *************************************************************************/
1103 case hash_single_threaded :
1104 config->multi_threaded = 0;
1107 /* *************************************************************************
1108 * socket-timeout numer_of_seconds
1109 * *************************************************************************/
1110 case hash_socket_timeout :
1113 int socket_timeout = atoi(arg);
1114 if (0 < socket_timeout)
1116 config->socket_timeout = socket_timeout;
1120 log_error(LOG_LEVEL_FATAL,
1121 "Invalid socket-timeout: '%s'", arg);
1126 /* *************************************************************************
1127 * split-large-cgi-forms
1128 * *************************************************************************/
1129 case hash_split_large_cgi_forms :
1130 if ((*arg != '\0') && (0 != atoi(arg)))
1132 config->feature_flags |= RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1136 config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1140 /* *************************************************************************
1141 * templdir directory-name
1142 * *************************************************************************/
1143 case hash_templdir :
1144 freez(config->templdir);
1145 config->templdir = make_path(NULL, arg);
1148 /* *************************************************************************
1150 * *************************************************************************/
1151 #ifdef FEATURE_TOGGLE
1153 global_toggle_state = atoi(arg);
1155 #endif /* def FEATURE_TOGGLE */
1157 /* *************************************************************************
1158 * trust-info-url url
1159 * *************************************************************************/
1160 #ifdef FEATURE_TRUST
1161 case hash_trust_info_url :
1162 enlist(config->trust_info, arg);
1164 #endif /* def FEATURE_TRUST */
1166 /* *************************************************************************
1167 * trustfile filename
1168 * (In confdir by default.)
1169 * *************************************************************************/
1170 #ifdef FEATURE_TRUST
1171 case hash_trustfile :
1172 freez(config->trustfile);
1173 config->trustfile = make_path(config->confdir, arg);
1175 #endif /* def FEATURE_TRUST */
1177 /* *************************************************************************
1179 * *************************************************************************/
1180 case hash_usermanual :
1182 * XXX: If this isn't the first config directive, the
1183 * show-status page links to the website documentation
1184 * for the directives that were already parsed. Lame.
1186 freez(config->usermanual);
1187 config->usermanual = strdup(arg);
1190 /* *************************************************************************
1191 * Win32 Console options:
1192 * *************************************************************************/
1194 /* *************************************************************************
1196 * *************************************************************************/
1198 case hash_hide_console :
1201 #endif /*def _WIN_CONSOLE*/
1204 /* *************************************************************************
1205 * Win32 GUI options:
1206 * *************************************************************************/
1208 #if defined(_WIN32) && ! defined(_WIN_CONSOLE)
1209 /* *************************************************************************
1210 * activity-animation (0|1)
1211 * *************************************************************************/
1212 case hash_activity_animation :
1213 g_bShowActivityAnimation = atoi(arg);
1216 /* *************************************************************************
1217 * close-button-minimizes (0|1)
1218 * *************************************************************************/
1219 case hash_close_button_minimizes :
1220 g_bCloseHidesWindow = atoi(arg);
1223 /* *************************************************************************
1224 * log-buffer-size (0|1)
1225 * *************************************************************************/
1226 case hash_log_buffer_size :
1227 g_bLimitBufferSize = atoi(arg);
1230 /* *************************************************************************
1231 * log-font-name fontname
1232 * *************************************************************************/
1233 case hash_log_font_name :
1234 if (strlcpy(g_szFontFaceName, arg,
1235 sizeof(g_szFontFaceName)) >= sizeof(g_szFontFaceName))
1237 log_error(LOG_LEVEL_FATAL,
1238 "log-font-name argument '%s' is longer than %u characters.",
1239 arg, sizeof(g_szFontFaceName)-1);
1243 /* *************************************************************************
1245 * *************************************************************************/
1246 case hash_log_font_size :
1247 g_nFontSize = atoi(arg);
1250 /* *************************************************************************
1251 * log-highlight-messages (0|1)
1252 * *************************************************************************/
1253 case hash_log_highlight_messages :
1254 g_bHighlightMessages = atoi(arg);
1257 /* *************************************************************************
1259 * *************************************************************************/
1260 case hash_log_max_lines :
1261 g_nMaxBufferLines = atoi(arg);
1264 /* *************************************************************************
1265 * log-messages (0|1)
1266 * *************************************************************************/
1267 case hash_log_messages :
1268 g_bLogMessages = atoi(arg);
1271 /* *************************************************************************
1272 * show-on-task-bar (0|1)
1273 * *************************************************************************/
1274 case hash_show_on_task_bar :
1275 g_bShowOnTaskBar = atoi(arg);
1278 #endif /* defined(_WIN32) && ! defined(_WIN_CONSOLE) */
1281 /* *************************************************************************
1282 * Warnings about unsupported features
1283 * *************************************************************************/
1285 case hash_deny_access:
1286 #endif /* ndef FEATURE_ACL */
1287 #ifndef FEATURE_CGI_EDIT_ACTIONS
1288 case hash_enable_edit_actions:
1289 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1290 #ifndef FEATURE_TOGGLE
1291 case hash_enable_remote_toggle:
1292 #endif /* ndef FEATURE_TOGGLE */
1294 case hash_permit_access:
1295 #endif /* ndef FEATURE_ACL */
1296 #ifndef FEATURE_TOGGLE
1298 #endif /* ndef FEATURE_TOGGLE */
1299 #ifndef FEATURE_TRUST
1300 case hash_trustfile :
1301 case hash_trust_info_url :
1302 #endif /* ndef FEATURE_TRUST */
1304 #ifndef _WIN_CONSOLE
1305 case hash_hide_console :
1306 #endif /* ndef _WIN_CONSOLE */
1308 #if defined(_WIN_CONSOLE) || ! defined(_WIN32)
1309 case hash_activity_animation :
1310 case hash_close_button_minimizes :
1311 case hash_log_buffer_size :
1312 case hash_log_font_name :
1313 case hash_log_font_size :
1314 case hash_log_highlight_messages :
1315 case hash_log_max_lines :
1316 case hash_log_messages :
1317 case hash_show_on_task_bar :
1318 #endif /* defined(_WIN_CONSOLE) || ! defined(_WIN32) */
1319 /* These warnings are annoying - so hide them. -- Jon */
1320 /* log_error(LOG_LEVEL_INFO, "Unsupported directive \"%s\" ignored.", cmd); */
1323 /* *************************************************************************/
1325 /* *************************************************************************/
1327 * I decided that I liked this better as a warning than an
1328 * error. To change back to an error, just change log level
1329 * to LOG_LEVEL_FATAL.
1331 log_error(LOG_LEVEL_ERROR, "Ignoring unrecognized directive '%s' (%luul) in line %lu "
1332 "in configuration file (%s).", buf, directive_hash, linenum, configfile);
1333 string_append(&config->proxy_args,
1334 " <strong class='warning'>Warning: Ignoring unrecognized directive:</strong>");
1337 /* *************************************************************************/
1338 } /* end switch( hash_string(cmd) ) */
1340 /* Save the argument for the show-status page. */
1341 savearg(cmd, arg, config);
1343 } /* end while ( read_config_line(...) ) */
1347 set_debug_level(config->debug);
1349 freez(config->logfile);
1353 if (NULL != logfile)
1355 config->logfile = logfile;
1356 init_error_log(Argv[0], config->logfile);
1364 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1365 if (config->default_server_timeout > config->keep_alive_timeout)
1367 log_error(LOG_LEVEL_ERROR,
1368 "Reducing the default-server-timeout from %d to the keep-alive-timeout %d.",
1369 config->default_server_timeout, config->keep_alive_timeout);
1370 config->default_server_timeout = config->keep_alive_timeout;
1372 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1374 #ifdef FEATURE_CONNECTION_SHARING
1375 if (config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1377 if (config->multi_threaded)
1379 set_keep_alive_timeout(config->keep_alive_timeout);
1384 * While we could use keep-alive without multiple threads
1385 * if we didn't bother with enforcing the connection timeout,
1386 * that might make Tor users sad, even though they shouldn't
1387 * enable the single-threaded option anyway.
1389 * XXX: We could still use Proxy-Connection: keep-alive.
1391 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1392 log_error(LOG_LEVEL_ERROR,
1393 "Config option single-threaded disables connection keep-alive.");
1396 else if ((config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING))
1398 log_error(LOG_LEVEL_ERROR, "Config option connection-sharing "
1399 "has no effect if keep-alive-timeout isn't set.");
1400 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
1402 #endif /* def FEATURE_CONNECTION_SHARING */
1404 if (NULL == config->proxy_args)
1406 log_error(LOG_LEVEL_FATAL, "Out of memory loading config - insufficient memory for config->proxy_args");
1409 if (config->actions_file[0])
1411 add_loader(load_action_files, config);
1414 if (config->re_filterfile[0])
1416 add_loader(load_re_filterfiles, config);
1419 #ifdef FEATURE_TRUST
1420 if (config->trustfile)
1422 add_loader(load_trustfile, config);
1424 #endif /* def FEATURE_TRUST */
1426 if ( NULL == config->haddr )
1428 config->haddr = strdup( HADDR_DEFAULT );
1431 if ( NULL != config->haddr )
1433 if ((*config->haddr == '[')
1434 && (NULL != (p = strchr(config->haddr, ']')))
1436 && (0 < (config->hport = atoi(p + 2))))
1439 memmove((void *)config->haddr, config->haddr + 1,
1440 (size_t)(p - config->haddr));
1442 else if (NULL != (p = strchr(config->haddr, ':'))
1443 && (0 < (config->hport = atoi(p + 1))))
1449 log_error(LOG_LEVEL_FATAL, "invalid bind port spec %s", config->haddr);
1450 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1452 if (*config->haddr == '\0')
1455 * Only the port specified. We stored it in config->hport
1456 * and don't need its text representation anymore.
1458 freez(config->haddr);
1463 * Want to run all the loaders once now.
1465 * Need to set up a fake csp, so they can get to the config.
1467 fake_csp = (struct client_state *) zalloc (sizeof(*fake_csp));
1468 fake_csp->config = config;
1470 if (run_loader(fake_csp))
1473 log_error(LOG_LEVEL_FATAL, "A loader failed while loading config file. Exiting.");
1474 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1478 /* FIXME: this is a kludge for win32 */
1479 #if defined(_WIN32) && !defined (_WIN_CONSOLE)
1481 g_default_actions_file = config->actions_file[1]; /* FIXME Hope this is default.action */
1482 g_user_actions_file = config->actions_file[2]; /* FIXME Hope this is user.action */
1483 g_re_filterfile = config->re_filterfile[0]; /* FIXME Hope this is default.filter */
1485 #ifdef FEATURE_TRUST
1486 g_trustfile = config->trustfile;
1487 #endif /* def FEATURE_TRUST */
1490 #endif /* defined(_WIN32) && !defined (_WIN_CONSOLE) */
1491 /* FIXME: end kludge */
1494 config->need_bind = 1;
1496 if (current_configfile)
1498 struct configuration_spec * oldcfg = (struct configuration_spec *)
1499 current_configfile->f;
1501 * Check if config->haddr,hport == oldcfg->haddr,hport
1503 * The following could be written more compactly as a single,
1504 * (unreadably long) if statement.
1506 config->need_bind = 0;
1507 if (config->hport != oldcfg->hport)
1509 config->need_bind = 1;
1511 else if (config->haddr == NULL)
1513 if (oldcfg->haddr != NULL)
1515 config->need_bind = 1;
1518 else if (oldcfg->haddr == NULL)
1520 config->need_bind = 1;
1522 else if (0 != strcmp(config->haddr, oldcfg->haddr))
1524 config->need_bind = 1;
1527 current_configfile->unloader = unload_configfile;
1530 fs->next = files->next;
1533 current_configfile = fs;
1539 /*********************************************************************
1541 * Function : savearg
1543 * Description : Called from `load_config'. It saves each non-empty
1544 * and non-comment line from config into
1545 * config->proxy_args. This is used to create the
1546 * show-proxy-args page. On error, frees
1547 * config->proxy_args and sets it to NULL
1550 * 1 : command = config setting that was found
1551 * 2 : argument = the setting's argument (if any)
1552 * 3 : config = Configuration to save into.
1556 *********************************************************************/
1557 static void savearg(char *command, char *argument, struct configuration_spec * config)
1566 * Add config option name embedded in
1567 * link to its section in the user-manual
1569 buf = strdup("\n<a href=\"");
1570 if (!strncmpic(config->usermanual, "file://", 7) ||
1571 !strncmpic(config->usermanual, "http", 4))
1573 string_append(&buf, config->usermanual);
1577 string_append(&buf, "http://" CGI_SITE_2_HOST "/user-manual/");
1579 string_append(&buf, CONFIG_HELP_PREFIX);
1580 string_join (&buf, string_toupper(command));
1581 string_append(&buf, "\">");
1582 string_append(&buf, command);
1583 string_append(&buf, "</a> ");
1587 freez(config->proxy_args);
1591 if ( (NULL != argument) && ('\0' != *argument) )
1593 s = html_encode(argument);
1597 freez(config->proxy_args);
1601 if (strncmpic(argument, "http://", 7) == 0)
1603 string_append(&buf, "<a href=\"");
1604 string_append(&buf, s);
1605 string_append(&buf, "\">");
1606 string_join (&buf, s);
1607 string_append(&buf, "</a>");
1611 string_join (&buf, s);
1615 string_append(&buf, "<br>");
1616 string_join(&config->proxy_args, buf);