1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/loadcfg.c,v $
5 * Purpose : Loads settings from the configuration file into
6 * global variables. This file contains both the
7 * routine to load the configuration and the global
8 * variables it writes to.
10 * Copyright : Written by and Copyright (C) 2001-2017 the
11 * Privoxy team. https://www.privoxy.org/
13 * Based on the Internet Junkbuster originally written
14 * by and Copyright (C) 1997 Anonymous Coders and
15 * Junkbusters Corporation. http://www.junkbusters.com
17 * This program is free software; you can redistribute it
18 * and/or modify it under the terms of the GNU General
19 * Public License as published by the Free Software
20 * Foundation; either version 2 of the License, or (at
21 * your option) any later version.
23 * This program is distributed in the hope that it will
24 * be useful, but WITHOUT ANY WARRANTY; without even the
25 * implied warranty of MERCHANTABILITY or FITNESS FOR A
26 * PARTICULAR PURPOSE. See the GNU General Public
27 * License for more details.
29 * The GNU General Public License should be included with
30 * this file. If not, you can view it at
31 * http://www.gnu.org/copyleft/gpl.html
32 * or write to the Free Software Foundation, Inc., 59
33 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
35 *********************************************************************/
41 #include <sys/types.h>
55 # include <winsock2.h>
61 # endif /* ndef _WIN_CONSOLE */
63 #else /* ifndef _WIN32 */
66 # include <sys/wait.h>
67 # include <sys/time.h>
68 # include <sys/stat.h>
86 #ifdef FEATURE_CLIENT_TAGS
87 #include "client-tags.h"
91 * Default number of seconds after which an
92 * open connection will no longer be reused.
94 #define DEFAULT_KEEP_ALIVE_TIMEOUT 180
97 * Default backlog passed to listen().
99 #define DEFAULT_LISTEN_BACKLOG 128
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 algorithm 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 1196306641U /* "actionsfile" */
132 #define hash_accept_intercepted_requests 1513024973U /* "accept-intercepted-requests" */
133 #define hash_admin_address 4112573064U /* "admin-address" */
134 #define hash_allow_cgi_request_crunching 258915987U /* "allow-cgi-request-crunching" */
135 #define hash_buffer_limit 1881726070U /* "buffer-limit */
136 #define hash_ca_cert_file 1622923720U /* "ca-cert-file" */
137 #define hash_ca_directory 1623615670U /* "ca-directory" */
138 #define hash_ca_key_file 1184187891U /* "ca-key-file" */
139 #define hash_ca_password 1184543320U /* "ca-password" */
140 #define hash_certificate_directory 1367994217U /* "certificate-directory" */
141 #define hash_client_header_order 2701453514U /* "client-header-order" */
142 #define hash_client_specific_tag 3353703383U /* "client-specific-tag" */
143 #define hash_client_tag_lifetime 647957580U /* "client-tag-lifetime" */
144 #define hash_compression_level 2464423563U /* "compression-level" */
145 #define hash_confdir 1978389U /* "confdir" */
146 #define hash_connection_sharing 1348841265U /* "connection-sharing" */
147 #define hash_cors_allowed_origin 2769345637U /* "cors-allowed-origin" */
148 #define hash_debug 78263U /* "debug" */
149 #define hash_default_server_timeout 2530089913U /* "default-server-timeout" */
150 #define hash_deny_access 1227333715U /* "deny-access" */
151 #define hash_enable_accept_filter 2909040407U /* "enable-accept-filter" */
152 #define hash_enable_edit_actions 2517097536U /* "enable-edit-actions" */
153 #define hash_enable_compression 3943696946U /* "enable-compression" */
154 #define hash_enable_proxy_authentication_forwarding 4040610791U /* enable-proxy-authentication-forwarding */
155 #define hash_enable_remote_toggle 2979744683U /* "enable-remote-toggle" */
156 #define hash_enable_remote_http_toggle 110543988U /* "enable-remote-http-toggle" */
157 #define hash_enforce_blocks 1862427469U /* "enforce-blocks" */
158 #define hash_filterfile 250887266U /* "filterfile" */
159 #define hash_forward 2029845U /* "forward" */
160 #define hash_forward_socks4 3963965521U /* "forward-socks4" */
161 #define hash_forward_socks4a 2639958518U /* "forward-socks4a" */
162 #define hash_forward_socks5 3963965522U /* "forward-socks5" */
163 #define hash_forward_socks5t 2639958542U /* "forward-socks5t" */
164 #define hash_forwarded_connect_retries 101465292U /* "forwarded-connect-retries" */
165 #define hash_handle_as_empty_returns_ok 1444873247U /* "handle-as-empty-doc-returns-ok" */
166 #define hash_hostname 10308071U /* "hostname" */
167 #define hash_keep_alive_timeout 3878599515U /* "keep-alive-timeout" */
168 #define hash_listen_address 1255650842U /* "listen-address" */
169 #define hash_listen_backlog 1255655735U /* "listen-backlog" */
170 #define hash_logdir 422889U /* "logdir" */
171 #define hash_logfile 2114766U /* "logfile" */
172 #define hash_max_client_connections 3595884446U /* "max-client-connections" */
173 #define hash_permit_access 3587953268U /* "permit-access" */
174 #define hash_proxy_info_url 3903079059U /* "proxy-info-url" */
175 #define hash_receive_buffer_size 2880297454U /* "receive-buffer-size */
176 #define hash_single_threaded 4250084780U /* "single-threaded" */
177 #define hash_socket_timeout 1809001761U /* "socket-timeout" */
178 #define hash_split_large_cgi_forms 671658948U /* "split-large-cgi-forms" */
179 #define hash_suppress_blocklists 1948693308U /* "suppress-blocklists" */
180 #define hash_templdir 11067889U /* "templdir" */
181 #define hash_temporary_directory 1824125181U /* "temporary-directory" */
182 #define hash_tolerate_pipelining 1360286620U /* "tolerate-pipelining" */
183 #define hash_toggle 447966U /* "toggle" */
184 #define hash_trust_info_url 430331967U /* "trust-info-url" */
185 #define hash_trust_x_forwarded_for 2971537414U /* "trust-x-forwarded-for" */
186 #define hash_trusted_cgi_referrer 4270883427U /* "trusted-cgi-referrer" */
187 #define hash_trusted_cas_file 2679803024U /* "trusted-cas-files" */
188 #define hash_trustfile 56494766U /* "trustfile" */
189 #define hash_usermanual 1416668518U /* "user-manual" */
190 #define hash_activity_animation 1817904738U /* "activity-animation" */
191 #define hash_close_button_minimizes 3651284693U /* "close-button-minimizes" */
192 #define hash_hide_console 2048809870U /* "hide-console" */
193 #define hash_log_buffer_size 2918070425U /* "log-buffer-size" */
194 #define hash_log_font_name 2866730124U /* "log-font-name" */
195 #define hash_log_font_size 2866731014U /* "log-font-size" */
196 #define hash_log_highlight_messages 4032101240U /* "log-highlight-messages" */
197 #define hash_log_max_lines 2868344173U /* "log-max-lines" */
198 #define hash_log_messages 2291744899U /* "log-messages" */
199 #define hash_show_on_task_bar 215410365U /* "show-on-task-bar" */
202 static void savearg(char *command, char *argument, struct configuration_spec * config);
203 #ifdef FEATURE_CLIENT_TAGS
204 static void free_client_specific_tags(struct client_tag_spec *tag_list);
207 /*********************************************************************
209 * Function : unload_configfile
211 * Description : Free the config structure and all components.
214 * 1 : data: struct configuration_spec to unload
218 *********************************************************************/
219 static void unload_configfile (void * data)
221 struct configuration_spec * config = (struct configuration_spec *)data;
222 struct forward_spec *cur_fwd = config->forward;
226 struct access_control_list *cur_acl = config->acl;
228 while (cur_acl != NULL)
230 struct access_control_list * next_acl = cur_acl->next;
235 #endif /* def FEATURE_ACL */
237 while (cur_fwd != NULL)
239 struct forward_spec * next_fwd = cur_fwd->next;
241 unload_forward_spec(cur_fwd);
245 config->forward = NULL;
247 freez(config->confdir);
248 freez(config->logdir);
249 freez(config->templdir);
250 freez(config->hostname);
251 #ifdef FEATURE_EXTERNAL_FILTERS
252 freez(config->temporary_directory);
255 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
257 freez(config->haddr[i]);
259 freez(config->logfile);
261 for (i = 0; i < MAX_AF_FILES; i++)
263 freez(config->actions_file_short[i]);
264 freez(config->actions_file[i]);
265 freez(config->re_filterfile_short[i]);
266 freez(config->re_filterfile[i]);
269 list_remove_all(config->ordered_client_headers);
271 freez(config->admin_address);
272 freez(config->cors_allowed_origin);
273 freez(config->proxy_info_url);
274 freez(config->proxy_args);
275 freez(config->usermanual);
276 freez(config->trusted_cgi_referrer);
278 #ifdef FEATURE_HTTPS_INSPECTION
279 freez(config->ca_password);
280 freez(config->ca_directory);
281 freez(config->ca_cert_file);
282 freez(config->ca_key_file);
283 freez(config->certificate_directory);
284 freez(config->trusted_cas_file);
288 freez(config->trustfile);
289 list_remove_all(config->trust_info);
290 #endif /* def FEATURE_TRUST */
292 #ifdef FEATURE_CLIENT_TAGS
293 free_client_specific_tags(config->client_tags);
300 #ifdef FEATURE_GRACEFUL_TERMINATION
301 /*********************************************************************
303 * Function : unload_current_config_file
305 * Description : Unloads current config file - reset to state at
306 * beginning of program.
312 *********************************************************************/
313 void unload_current_config_file(void)
315 if (current_configfile)
317 current_configfile->unloader = unload_configfile;
318 current_configfile = NULL;
324 #ifdef FEATURE_CLIENT_TAGS
325 /*********************************************************************
327 * Function : register_tag
329 * Description : Registers a client-specific-tag and its description
332 * 1 : config: The tag list
333 * 2 : name: The name of the client-specific-tag
334 * 3 : description: The human-readable description for the tag
338 *********************************************************************/
339 static void register_tag(struct client_tag_spec *tag_list,
340 const char *name, const char *description)
342 struct client_tag_spec *new_tag;
343 struct client_tag_spec *last_tag;
346 while (last_tag->next != NULL)
348 last_tag = last_tag->next;
350 if (last_tag->name == NULL)
357 new_tag = zalloc_or_die(sizeof(struct client_tag_spec));
359 new_tag->name = strdup_or_die(name);
360 new_tag->description = strdup_or_die(description);
361 if (new_tag != last_tag)
363 last_tag->next = new_tag;
368 /*********************************************************************
370 * Function : free_client_specific_tags
372 * Description : Frees client-specific tags and their descriptions
375 * 1 : tag_list: The tag list to free
379 *********************************************************************/
380 static void free_client_specific_tags(struct client_tag_spec *tag_list)
382 struct client_tag_spec *this_tag;
383 struct client_tag_spec *next_tag;
389 next_tag = next_tag->next;
391 freez(this_tag->name);
392 freez(this_tag->description);
394 if (this_tag != tag_list)
398 } while (next_tag != NULL);
400 #endif /* def FEATURE_CLIENT_TAGS */
403 /*********************************************************************
405 * Function : parse_numeric_value
407 * Description : Parse the value of a directive that can only have
408 * a single numeric value. Terminates with a fatal error
409 * if the value is NULL or not numeric.
412 * 1 : name: The name of the directive. Used for log messages.
413 * 2 : value: The value to parse
416 * Returns : The numerical value as integer
418 *********************************************************************/
419 static int parse_numeric_value(const char *name, const char *value)
424 assert(name != NULL);
425 assert(value != NULL);
427 if ((value == NULL) || (*value == '\0'))
429 log_error(LOG_LEVEL_FATAL, "Directive %s used without argument", name);
432 number = (int)strtol(value, &endptr, 0);
435 log_error(LOG_LEVEL_FATAL,
436 "Directive '%s' used with non-numerical value: '%s'", name, value);
444 /*********************************************************************
446 * Function : parse_toggle_value
448 * Description : Parse the value of a directive that can only be
449 * enabled or disabled. Terminates with a fatal error
450 * if the value is NULL or something other than 0 or 1.
453 * 1 : name: The name of the directive. Used for log messages.
454 * 2 : value: The value to parse
457 * Returns : The numerical toggle state
459 *********************************************************************/
460 static int parse_toggle_state(const char *name, const char *value)
463 assert(name != NULL);
464 assert(value != NULL);
466 if ((value == NULL) || (*value == '\0'))
468 log_error(LOG_LEVEL_FATAL, "Directive %s used without argument", name);
471 toggle_state = atoi(value);
474 * Also check the length as atoi() doesn't mind
475 * garbage after a valid integer, but we do.
477 if (((toggle_state != 0) && (toggle_state != 1)) || (strlen(value) != 1))
479 log_error(LOG_LEVEL_FATAL,
480 "Directive %s used with invalid argument '%s'. Use either '0' or '1'.",
489 /*********************************************************************
491 * Function : parse_client_header_order
493 * Description : Parse the value of the header-order directive
496 * 1 : ordered_header_list: List to insert the ordered
498 * 2 : ordered_headers: The ordered header names separated
504 *********************************************************************/
505 static void parse_client_header_order(struct list *ordered_header_list, const char *ordered_headers)
507 char *original_headers_copy;
510 int number_of_headers;
513 assert(ordered_header_list != NULL);
514 assert(ordered_headers != NULL);
516 if (ordered_headers == NULL)
518 log_error(LOG_LEVEL_FATAL, "header-order used without argument");
522 * XXX: This estimate is guaranteed to be high enough as we
523 * let ssplit() ignore empty fields, but also a bit wasteful.
524 * The same hack is used in get_last_url() so it looks like
525 * a real solution is needed.
527 max_segments = strlen(ordered_headers) / 2;
528 if (max_segments == 0)
532 vector = malloc_or_die(max_segments * sizeof(char *));
534 original_headers_copy = strdup_or_die(ordered_headers);
536 number_of_headers = ssplit(original_headers_copy, "\t ", vector, max_segments);
537 if (number_of_headers == -1)
539 log_error(LOG_LEVEL_FATAL, "Failed to split ordered headers");
542 for (i = 0; i < number_of_headers; i++)
544 if (JB_ERR_OK != enlist(ordered_header_list, vector[i]))
546 log_error(LOG_LEVEL_FATAL,
547 "Failed to enlist ordered header: %s", vector[i]);
552 freez(original_headers_copy);
559 /*********************************************************************
561 * Function : load_config
563 * Description : Load the config file and all parameters.
565 * XXX: more than thousand lines long
566 * and thus in serious need of refactoring.
570 * Returns : The configuration_spec, or NULL on error.
572 *********************************************************************/
573 struct configuration_spec * load_config(void)
577 FILE *configfp = NULL;
578 struct configuration_spec * config = NULL;
579 struct client_state * fake_csp;
580 struct file_list *fs;
581 unsigned long linenum = 0;
583 char *logfile = NULL;
584 #ifdef FEATURE_HTTPS_INSPECTION
585 char *ca_cert_file = NULL;
586 char *ca_key_file = NULL;
587 char *ca_directory = NULL;
588 char *trusted_cas_file = NULL;
589 char *certificate_directory = NULL;
592 if (!check_file_changed(current_configfile, configfile, &fs))
594 /* No need to load */
595 return ((struct configuration_spec *)current_configfile->f);
599 log_error(LOG_LEVEL_FATAL,
600 "can't check configuration file '%s': %E", configfile);
604 if (NULL != current_configfile)
606 log_error(LOG_LEVEL_INFO, "Reloading configuration file '%s'", configfile);
609 #ifdef FEATURE_TOGGLE
610 global_toggle_state = 1;
611 #endif /* def FEATURE_TOGGLE */
613 fs->f = config = zalloc_or_die(sizeof(*config));
616 * This is backwards from how it's usually done.
617 * Following the usual pattern, "fs" would be stored in a member
618 * variable in "csp", and then we'd access "config" from "fs->f",
619 * using a cast. However, "config" is used so often that a
620 * cast each time would be very ugly, and the extra indirection
621 * would waste CPU cycles. Therefore we store "config" in
622 * "csp->config", and "fs" in "csp->config->config_file_list".
624 config->config_file_list = fs;
629 config->multi_threaded = 1;
630 config->buffer_limit = 4096 * 1024;
631 config->receive_buffer_size = BUFFER_SIZE;
632 config->usermanual = strdup_or_die(USER_MANUAL_URL);
633 config->proxy_args = strdup_or_die("");
634 config->forwarded_connect_retries = 0;
635 #ifdef FEATURE_HTTPS_INSPECTION
636 config->ca_password = strdup("");
637 ca_cert_file = strdup("cacert.crt");
638 ca_key_file = strdup("cakey.pem");
639 ca_directory = strdup("./CA");
640 trusted_cas_file = strdup("trustedCAs.pem");
641 certificate_directory = strdup("./certs");
644 #ifdef FEATURE_CLIENT_TAGS
645 config->client_tag_lifetime = 60;
647 config->trust_x_forwarded_for = 0;
648 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
649 config->enable_accept_filter = 0;
651 config->listen_backlog = DEFAULT_LISTEN_BACKLOG;
652 config->trusted_cgi_referrer = NULL;
654 * 128 client sockets ought to be enough for everybody who can't
655 * be bothered to read the documentation to figure out how to
656 * increase the limit.
658 config->max_client_connections = 128;
659 config->socket_timeout = 300; /* XXX: Should be a macro. */
660 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
661 config->default_server_timeout = 0;
662 config->keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
663 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
664 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
666 config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
667 config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
668 config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
669 config->feature_flags &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
670 config->feature_flags &= ~RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
671 #ifdef FEATURE_COMPRESSION
672 config->feature_flags &= ~RUNTIME_FEATURE_COMPRESSION;
674 * XXX: Run some benchmarks to see if there are better default values.
676 config->compression_level = 1;
678 config->feature_flags &= ~RUNTIME_FEATURE_TOLERATE_PIPELINING;
679 config->cors_allowed_origin = NULL;
681 configfp = fopen(configfile, "r");
682 if (NULL == configfp)
684 log_error(LOG_LEVEL_FATAL,
685 "can't open configuration file '%s': %E", configfile);
686 /* Never get here - LOG_LEVEL_FATAL causes program exit */
689 while (read_config_line(configfp, &linenum, &buf) != NULL)
691 char cmd[BUFFER_SIZE];
692 char arg[BUFFER_SIZE];
693 char tmp[BUFFER_SIZE];
695 struct access_control_list *cur_acl;
696 #endif /* def FEATURE_ACL */
697 struct forward_spec *cur_fwd;
700 unsigned int directive_hash;
702 strlcpy(tmp, buf, sizeof(tmp));
704 /* Copy command (i.e. up to space or tab) into cmd */
707 while (*p && (*p != ' ') && (*p != '\t'))
713 /* Skip over the whitespace in buf */
714 while (*p && ((*p == ' ') || (*p == '\t')))
719 /* Copy the argument into arg */
720 if (strlcpy(arg, p, sizeof(arg)) >= sizeof(arg))
722 log_error(LOG_LEVEL_FATAL, "Config line too long: %s", buf);
725 /* Should never happen, but check this anyway */
732 /* Make sure the command field is lower case */
733 for (p = cmd; *p; p++)
735 if (privoxy_isupper(*p))
737 *p = (char)privoxy_tolower(*p);
741 directive_hash = hash_string(cmd);
742 switch (directive_hash)
744 /* *************************************************************************
745 * actionsfile actions-file-name
746 * In confdir by default
747 * *************************************************************************/
748 case hash_actions_file :
750 while ((i < MAX_AF_FILES) && (NULL != config->actions_file[i]))
755 if (i >= MAX_AF_FILES)
757 log_error(LOG_LEVEL_FATAL, "Too many 'actionsfile' directives in config file - limit is %d.\n"
758 "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
761 config->actions_file_short[i] = strdup_or_die(arg);
762 config->actions_file[i] = make_path(config->confdir, arg);
765 /* *************************************************************************
766 * accept-intercepted-requests
767 * *************************************************************************/
768 case hash_accept_intercepted_requests:
769 if (parse_toggle_state(cmd, arg) == 1)
771 config->feature_flags |= RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
775 config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
779 /* *************************************************************************
780 * admin-address email-address
781 * *************************************************************************/
782 case hash_admin_address :
783 freez(config->admin_address);
784 config->admin_address = strdup_or_die(arg);
787 /* *************************************************************************
788 * allow-cgi-request-crunching
789 * *************************************************************************/
790 case hash_allow_cgi_request_crunching:
791 if (parse_toggle_state(cmd, arg) == 1)
793 config->feature_flags |= RUNTIME_FEATURE_CGI_CRUNCHING;
797 config->feature_flags &= ~RUNTIME_FEATURE_CGI_CRUNCHING;
801 /* *************************************************************************
803 * *************************************************************************/
804 case hash_buffer_limit :
805 config->buffer_limit = (size_t)(1024 * parse_numeric_value(cmd, arg));
808 /* *************************************************************************
809 * client-header-order header-1 header-2 ... header-n
810 * *************************************************************************/
811 case hash_client_header_order:
812 list_remove_all(config->ordered_client_headers);
813 parse_client_header_order(config->ordered_client_headers, arg);
816 /* *************************************************************************
817 * client-specific-tag tag-name description
818 * *************************************************************************/
819 #ifdef FEATURE_CLIENT_TAGS
820 case hash_client_specific_tag:
826 description = strstr(arg, " ");
827 if (description == NULL)
829 log_error(LOG_LEVEL_FATAL,
830 "client-specific-tag '%s' lacks a description.", name);
834 * The length is limited because we don't want truncated
835 * HTML caused by the cgi interface using static buffer
838 if (strlen(name) > CLIENT_TAG_LENGTH_MAX)
840 log_error(LOG_LEVEL_FATAL,
841 "client-specific-tag '%s' is longer than %d characters.",
842 name, CLIENT_TAG_LENGTH_MAX);
845 register_tag(config->client_tags, name, description);
848 #endif /* def FEATURE_CLIENT_TAGS */
850 /* *************************************************************************
851 * client-tag-lifetime ttl
852 * *************************************************************************/
853 #ifdef FEATURE_CLIENT_TAGS
854 case hash_client_tag_lifetime:
856 int ttl = parse_numeric_value(cmd, arg);
859 config->client_tag_lifetime = (unsigned)ttl;
863 log_error(LOG_LEVEL_FATAL,
864 "client-tag-lifetime can't be negative.");
868 #endif /* def FEATURE_CLIENT_TAGS */
870 /* *************************************************************************
871 * confdir directory-name
872 * *************************************************************************/
874 freez(config->confdir);
875 config->confdir = make_path(NULL, arg);
878 /* *************************************************************************
879 * compression-level 0-9
880 * *************************************************************************/
881 #ifdef FEATURE_COMPRESSION
882 case hash_compression_level :
884 int compression_level = parse_numeric_value(cmd, arg);
885 if (-1 <= compression_level && compression_level <= 9)
887 config->compression_level = compression_level;
891 log_error(LOG_LEVEL_FATAL,
892 "Invalid compression-level value: %s", arg);
898 /* *************************************************************************
899 * connection-sharing (0|1)
900 * *************************************************************************/
901 #ifdef FEATURE_CONNECTION_SHARING
902 case hash_connection_sharing :
903 if (parse_toggle_state(cmd, arg) == 1)
905 config->feature_flags |= RUNTIME_FEATURE_CONNECTION_SHARING;
909 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
914 /* *************************************************************************
915 * cors-allowed-origin http://www.example.org
916 * *************************************************************************/
917 case hash_cors_allowed_origin :
919 * We don't validate the specified referrer as
920 * it's only used for string comparison.
922 freez(config->cors_allowed_origin);
923 config->cors_allowed_origin = strdup_or_die(arg);
926 /* *************************************************************************
928 * Specifies debug level, multiple values are ORed together.
929 * *************************************************************************/
931 config->debug |= parse_numeric_value(cmd, arg);
934 /* *************************************************************************
935 * default-server-timeout timeout
936 * *************************************************************************/
937 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
938 case hash_default_server_timeout :
940 int timeout = parse_numeric_value(cmd, arg);
943 config->default_server_timeout = (unsigned int)timeout;
947 log_error(LOG_LEVEL_FATAL,
948 "Invalid default-server-timeout value: %s", arg);
954 /* *************************************************************************
955 * deny-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
956 * *************************************************************************/
958 case hash_deny_access:
959 strlcpy(tmp, arg, sizeof(tmp));
960 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
962 if ((vec_count != 1) && (vec_count != 2))
964 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
965 "deny-access directive in configuration file.");
966 string_append(&config->proxy_args,
967 "<br>\nWARNING: Wrong number of parameters for "
968 "deny-access directive in configuration file.<br><br>\n");
972 /* allocate a new node */
973 cur_acl = zalloc_or_die(sizeof(*cur_acl));
974 cur_acl->action = ACL_DENY;
976 if (acl_addr(vec[0], cur_acl->src) < 0)
978 log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
979 "for deny-access directive in configuration file: \"%s\"", vec[0]);
980 string_append(&config->proxy_args,
981 "<br>\nWARNING: Invalid source address, port or netmask "
982 "for deny-access directive in configuration file: \"");
983 string_append(&config->proxy_args,
985 string_append(&config->proxy_args,
992 if (acl_addr(vec[1], cur_acl->dst) < 0)
994 log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
995 "for deny-access directive in configuration file: \"%s\"", vec[1]);
996 string_append(&config->proxy_args,
997 "<br>\nWARNING: Invalid destination address, port or netmask "
998 "for deny-access directive in configuration file: \"");
999 string_append(&config->proxy_args,
1001 string_append(&config->proxy_args,
1010 cur_acl->wildcard_dst = 1;
1012 #endif /* def HAVE_RFC2553 */
1015 * Add it to the list. Note we reverse the list to get the
1016 * behaviour the user expects. With both the ACL and
1017 * actions file, the last match wins. However, the internal
1018 * implementations are different: The actions file is stored
1019 * in the same order as the file, and scanned completely.
1020 * With the ACL, we reverse the order as we load it, then
1021 * when we scan it we stop as soon as we get a match.
1023 cur_acl->next = config->acl;
1024 config->acl = cur_acl;
1027 #endif /* def FEATURE_ACL */
1029 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
1030 /* *************************************************************************
1031 * enable-accept-filter 0|1
1032 * *************************************************************************/
1033 case hash_enable_accept_filter :
1034 config->enable_accept_filter = parse_toggle_state(cmd, arg);
1036 #endif /* defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER) */
1038 /* *************************************************************************
1039 * enable-edit-actions 0|1
1040 * *************************************************************************/
1041 #ifdef FEATURE_CGI_EDIT_ACTIONS
1042 case hash_enable_edit_actions:
1043 if (parse_toggle_state(cmd, arg) == 1)
1045 config->feature_flags |= RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
1049 config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
1052 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1054 /* *************************************************************************
1055 * enable-compression 0|1
1056 * *************************************************************************/
1057 #ifdef FEATURE_COMPRESSION
1058 case hash_enable_compression:
1059 if (parse_toggle_state(cmd, arg) == 1)
1061 config->feature_flags |= RUNTIME_FEATURE_COMPRESSION;
1065 config->feature_flags &= ~RUNTIME_FEATURE_COMPRESSION;
1068 #endif /* def FEATURE_COMPRESSION */
1070 /* *************************************************************************
1071 * enable-proxy-authentication-forwarding 0|1
1072 * *************************************************************************/
1073 case hash_enable_proxy_authentication_forwarding:
1074 if (parse_toggle_state(cmd, arg) == 1)
1076 config->feature_flags |= RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
1080 config->feature_flags &= ~RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
1084 /* *************************************************************************
1085 * enable-remote-toggle 0|1
1086 * *************************************************************************/
1087 #ifdef FEATURE_TOGGLE
1088 case hash_enable_remote_toggle:
1089 if (parse_toggle_state(cmd, arg) == 1)
1091 config->feature_flags |= RUNTIME_FEATURE_CGI_TOGGLE;
1095 config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
1098 #endif /* def FEATURE_TOGGLE */
1100 /* *************************************************************************
1101 * enable-remote-http-toggle 0|1
1102 * *************************************************************************/
1103 case hash_enable_remote_http_toggle:
1104 if (parse_toggle_state(cmd, arg) == 1)
1106 config->feature_flags |= RUNTIME_FEATURE_HTTP_TOGGLE;
1110 config->feature_flags &= ~RUNTIME_FEATURE_HTTP_TOGGLE;
1114 /* *************************************************************************
1115 * enforce-blocks 0|1
1116 * *************************************************************************/
1117 case hash_enforce_blocks:
1118 #ifdef FEATURE_FORCE_LOAD
1119 if (parse_toggle_state(cmd, arg) == 1)
1121 config->feature_flags |= RUNTIME_FEATURE_ENFORCE_BLOCKS;
1125 config->feature_flags &= ~RUNTIME_FEATURE_ENFORCE_BLOCKS;
1128 log_error(LOG_LEVEL_ERROR, "Ignoring directive 'enforce-blocks'. "
1129 "FEATURE_FORCE_LOAD is disabled, blocks will always be enforced.");
1130 #endif /* def FEATURE_FORCE_LOAD */
1133 /* *************************************************************************
1134 * filterfile file-name
1135 * In confdir by default.
1136 * *************************************************************************/
1137 case hash_filterfile :
1139 while ((i < MAX_AF_FILES) && (NULL != config->re_filterfile[i]))
1144 if (i >= MAX_AF_FILES)
1146 log_error(LOG_LEVEL_FATAL, "Too many 'filterfile' directives in config file - limit is %d.\n"
1147 "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
1150 config->re_filterfile_short[i] = strdup_or_die(arg);
1151 config->re_filterfile[i] = make_path(config->confdir, arg);
1155 /* *************************************************************************
1156 * forward url-pattern (.|http-proxy-host[:port])
1157 * *************************************************************************/
1159 strlcpy(tmp, arg, sizeof(tmp));
1160 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1164 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for forward "
1165 "directive in configuration file.");
1166 string_append(&config->proxy_args,
1167 "<br>\nWARNING: Wrong number of parameters for "
1168 "forward directive in configuration file.");
1172 /* allocate a new node */
1173 cur_fwd = zalloc_or_die(sizeof(*cur_fwd));
1174 cur_fwd->type = SOCKS_NONE;
1176 /* Save the URL pattern */
1177 if (create_pattern_spec(cur_fwd->url, vec[0]))
1179 log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward "
1180 "directive in configuration file.");
1181 string_append(&config->proxy_args,
1182 "<br>\nWARNING: Bad URL specifier for "
1183 "forward directive in configuration file.");
1188 /* Parse the parent HTTP proxy host:port */
1191 if (strcmp(p, ".") != 0)
1193 cur_fwd->forward_port = 8000;
1194 parse_forwarder_address(p,
1195 &cur_fwd->forward_host, &cur_fwd->forward_port,
1200 cur_fwd->next = config->forward;
1201 config->forward = cur_fwd;
1205 /* *************************************************************************
1206 * forward-socks4 url-pattern socks-proxy[:port] (.|http-proxy[:port])
1207 * *************************************************************************/
1208 case hash_forward_socks4:
1209 strlcpy(tmp, arg, sizeof(tmp));
1210 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1214 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
1215 "forward-socks4 directive in configuration file.");
1216 string_append(&config->proxy_args,
1217 "<br>\nWARNING: Wrong number of parameters for "
1218 "forward-socks4 directive in configuration file.");
1222 /* allocate a new node */
1223 cur_fwd = zalloc_or_die(sizeof(*cur_fwd));
1224 cur_fwd->type = SOCKS_4;
1226 /* Save the URL pattern */
1227 if (create_pattern_spec(cur_fwd->url, vec[0]))
1229 log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward-socks4 "
1230 "directive in configuration file.");
1231 string_append(&config->proxy_args,
1232 "<br>\nWARNING: Bad URL specifier for "
1233 "forward-socks4 directive in configuration file.");
1238 /* Parse the SOCKS proxy host[:port] */
1241 /* XXX: This check looks like a bug. */
1242 if (strcmp(p, ".") != 0)
1244 cur_fwd->gateway_port = 1080;
1245 parse_forwarder_address(p,
1246 &cur_fwd->gateway_host, &cur_fwd->gateway_port,
1250 /* Parse the parent HTTP proxy host[:port] */
1253 if (strcmp(p, ".") != 0)
1255 cur_fwd->forward_port = 8000;
1256 parse_forwarder_address(p,
1257 &cur_fwd->forward_host, &cur_fwd->forward_port,
1262 cur_fwd->next = config->forward;
1263 config->forward = cur_fwd;
1267 /* *************************************************************************
1268 * forward-socks4a url-pattern socks-proxy[:port] (.|http-proxy[:port])
1269 * *************************************************************************/
1270 case hash_forward_socks4a:
1271 case hash_forward_socks5:
1272 case hash_forward_socks5t:
1273 strlcpy(tmp, arg, sizeof(tmp));
1274 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1278 log_error(LOG_LEVEL_ERROR,
1279 "Wrong number of parameters for %s in configuration file.",
1281 string_append(&config->proxy_args,
1282 "<br>\nWARNING: Wrong number of parameters for ");
1283 string_append(&config->proxy_args, cmd);
1284 string_append(&config->proxy_args,
1285 "directive in configuration file.");
1289 /* allocate a new node */
1290 cur_fwd = zalloc_or_die(sizeof(*cur_fwd));
1292 if (directive_hash == hash_forward_socks4a)
1294 cur_fwd->type = SOCKS_4A;
1296 else if (directive_hash == hash_forward_socks5)
1298 cur_fwd->type = SOCKS_5;
1302 assert(directive_hash == hash_forward_socks5t);
1303 cur_fwd->type = SOCKS_5T;
1306 /* Save the URL pattern */
1307 if (create_pattern_spec(cur_fwd->url, vec[0]))
1309 log_error(LOG_LEVEL_ERROR,
1310 "Bad URL specifier for %s in configuration file.",
1312 string_append(&config->proxy_args,
1313 "<br>\nWARNING: Bad URL specifier for ");
1314 string_append(&config->proxy_args, cmd);
1315 string_append(&config->proxy_args,
1316 "directive in configuration file.");
1321 /* Parse the SOCKS proxy [user:pass@]host[:port] */
1324 cur_fwd->gateway_port = 1080;
1325 parse_forwarder_address(p,
1326 &cur_fwd->gateway_host, &cur_fwd->gateway_port,
1327 &cur_fwd->auth_username, &cur_fwd->auth_password);
1329 /* Parse the parent HTTP proxy host[:port] */
1332 if (strcmp(p, ".") != 0)
1334 cur_fwd->forward_port = 8000;
1335 parse_forwarder_address(p,
1336 &cur_fwd->forward_host, &cur_fwd->forward_port,
1341 cur_fwd->next = config->forward;
1342 config->forward = cur_fwd;
1346 /* *************************************************************************
1347 * forwarded-connect-retries n
1348 * *************************************************************************/
1349 case hash_forwarded_connect_retries :
1350 config->forwarded_connect_retries = parse_numeric_value(cmd, arg);
1353 /* *************************************************************************
1354 * handle-as-empty-doc-returns-ok 0|1
1356 * Workaround for firefox hanging on blocked javascript pages.
1357 * Block with the "+handle-as-empty-document" flag and set the
1358 * "handle-as-empty-doc-returns-ok" run-time config flag so that
1359 * Privoxy returns a 200/OK status instead of a 403/Forbidden status
1360 * to the browser for blocked pages.
1361 ***************************************************************************/
1362 case hash_handle_as_empty_returns_ok:
1363 if (parse_toggle_state(cmd, arg) == 1)
1365 config->feature_flags |= RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
1369 config->feature_flags &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
1373 /* *************************************************************************
1374 * hostname hostname-to-show-on-cgi-pages
1375 * *************************************************************************/
1376 case hash_hostname :
1377 freez(config->hostname);
1378 config->hostname = strdup_or_die(arg);
1381 /* *************************************************************************
1382 * keep-alive-timeout timeout
1383 * *************************************************************************/
1384 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1385 case hash_keep_alive_timeout :
1387 int timeout = parse_numeric_value(cmd, arg);
1390 config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1391 config->keep_alive_timeout = (unsigned int)timeout;
1395 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1401 /* *************************************************************************
1402 * listen-address [ip][:port]
1403 * *************************************************************************/
1404 case hash_listen_address :
1406 while ((i < MAX_LISTENING_SOCKETS) && (NULL != config->haddr[i]))
1411 if (i >= MAX_LISTENING_SOCKETS)
1413 log_error(LOG_LEVEL_FATAL, "Too many 'listen-address' directives in config file - limit is %d.\n"
1414 "(You can increase this limit by changing MAX_LISTENING_SOCKETS in project.h and recompiling).",
1415 MAX_LISTENING_SOCKETS);
1417 config->haddr[i] = strdup_or_die(arg);
1420 /* *************************************************************************
1422 * *************************************************************************/
1423 case hash_listen_backlog :
1425 * We don't enfore an upper or lower limit because on
1426 * many platforms all values are valid and negative
1427 * number mean "use the highest value allowed".
1429 config->listen_backlog = parse_numeric_value(cmd, arg);
1432 /* *************************************************************************
1433 * logdir directory-name
1434 * *************************************************************************/
1436 freez(config->logdir);
1437 config->logdir = make_path(NULL, arg);
1440 /* *************************************************************************
1441 * logfile log-file-name
1442 * In logdir by default
1443 * *************************************************************************/
1447 logfile = make_path(config->logdir, arg);
1448 if (NULL == logfile)
1450 log_error(LOG_LEVEL_FATAL, "Out of memory while creating logfile path");
1455 /* *************************************************************************
1456 * max-client-connections number
1457 * *************************************************************************/
1458 case hash_max_client_connections :
1460 int max_client_connections = parse_numeric_value(cmd, arg);
1462 #if !defined(_WIN32) && !defined(HAVE_POLL)
1464 * Reject values below 1 for obvious reasons and values above
1465 * FD_SETSIZE/2 because Privoxy needs two sockets to serve
1466 * client connections that need forwarding.
1468 * We ignore the fact that the first three file descriptors
1469 * are usually set to /dev/null, one is used for logging
1470 * and yet another file descriptor is required to load
1473 if ((max_client_connections < 1) || (FD_SETSIZE/2 < max_client_connections))
1475 log_error(LOG_LEVEL_FATAL, "max-client-connections value %d"
1476 " is invalid. Value needs to be above 1 and below %d"
1477 " (FD_SETSIZE/2).", max_client_connections, FD_SETSIZE/2);
1481 * The Windows libc uses FD_SETSIZE for an array used
1482 * by select(), but has no problems with file descriptors
1483 * above the limit as long as no more than FD_SETSIZE are
1484 * passed to select().
1485 * https://msdn.microsoft.com/en-us/library/windows/desktop/ms739169%28v=vs.85%29.aspx
1487 * On platforms were we use poll() we don't have to enforce
1488 * an upper connection limit either.
1490 if (max_client_connections < 1)
1492 log_error(LOG_LEVEL_FATAL, "max-client-connections value"
1493 " has to be a number above 1. %d is invalid.",
1494 max_client_connections);
1497 config->max_client_connections = max_client_connections;
1501 /* *************************************************************************
1502 * permit-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
1503 * *************************************************************************/
1505 case hash_permit_access:
1506 strlcpy(tmp, arg, sizeof(tmp));
1507 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1509 if ((vec_count != 1) && (vec_count != 2))
1511 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
1512 "permit-access directive in configuration file.");
1513 string_append(&config->proxy_args,
1514 "<br>\nWARNING: Wrong number of parameters for "
1515 "permit-access directive in configuration file.<br><br>\n");
1520 /* allocate a new node */
1521 cur_acl = zalloc_or_die(sizeof(*cur_acl));
1522 cur_acl->action = ACL_PERMIT;
1524 if (acl_addr(vec[0], cur_acl->src) < 0)
1526 log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
1527 "for permit-access directive in configuration file: \"%s\"", vec[0]);
1528 string_append(&config->proxy_args,
1529 "<br>\nWARNING: Invalid source address, port or netmask for "
1530 "permit-access directive in configuration file: \"");
1531 string_append(&config->proxy_args,
1533 string_append(&config->proxy_args,
1540 if (acl_addr(vec[1], cur_acl->dst) < 0)
1542 log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
1543 "for permit-access directive in configuration file: \"%s\"", vec[1]);
1544 string_append(&config->proxy_args,
1545 "<br>\nWARNING: Invalid destination address, port or netmask for "
1546 "permit-access directive in configuration file: \"");
1547 string_append(&config->proxy_args,
1549 string_append(&config->proxy_args,
1558 cur_acl->wildcard_dst = 1;
1560 #endif /* def HAVE_RFC2553 */
1563 * Add it to the list. Note we reverse the list to get the
1564 * behaviour the user expects. With both the ACL and
1565 * actions file, the last match wins. However, the internal
1566 * implementations are different: The actions file is stored
1567 * in the same order as the file, and scanned completely.
1568 * With the ACL, we reverse the order as we load it, then
1569 * when we scan it we stop as soon as we get a match.
1571 cur_acl->next = config->acl;
1572 config->acl = cur_acl;
1575 #endif /* def FEATURE_ACL */
1577 /* *************************************************************************
1578 * proxy-info-url url
1579 * *************************************************************************/
1580 case hash_proxy_info_url :
1581 freez(config->proxy_info_url);
1582 config->proxy_info_url = strdup_or_die(arg);
1586 /* *************************************************************************
1587 * receive-buffer-size n
1588 * *************************************************************************/
1589 case hash_receive_buffer_size :
1590 config->receive_buffer_size = (size_t)parse_numeric_value(cmd, arg);
1591 if (config->receive_buffer_size < BUFFER_SIZE)
1593 log_error(LOG_LEVEL_INFO,
1594 "receive-buffer-size %lu seems low and may cause problems."
1595 "Consider setting it to at least %d.",
1596 config->receive_buffer_size, BUFFER_SIZE);
1600 /* *************************************************************************
1601 * single-threaded 0|1
1602 * *************************************************************************/
1603 case hash_single_threaded :
1604 config->multi_threaded = 0 == parse_toggle_state(cmd, arg);
1607 /* *************************************************************************
1608 * socket-timeout numer_of_seconds
1609 * *************************************************************************/
1610 case hash_socket_timeout :
1612 int socket_timeout = parse_numeric_value(cmd, arg);
1613 if (0 <= socket_timeout)
1615 config->socket_timeout = socket_timeout;
1619 log_error(LOG_LEVEL_FATAL, "Invalid socket-timeout: '%s'", arg);
1624 /* *************************************************************************
1625 * split-large-cgi-forms
1626 * *************************************************************************/
1627 case hash_split_large_cgi_forms :
1628 if (parse_toggle_state(cmd, arg) == 1)
1630 config->feature_flags |= RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1634 config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1638 /* *************************************************************************
1639 * templdir directory-name
1640 * *************************************************************************/
1641 case hash_templdir :
1642 freez(config->templdir);
1643 config->templdir = make_path(NULL, arg);
1646 #ifdef FEATURE_EXTERNAL_FILTERS
1647 /* *************************************************************************
1648 * temporary-directory directory-name
1649 * *************************************************************************/
1650 case hash_temporary_directory :
1651 freez(config->temporary_directory);
1652 config->temporary_directory = make_path(NULL, arg);
1656 /* *************************************************************************
1657 * tolerate-pipelining (0|1)
1658 * *************************************************************************/
1659 case hash_tolerate_pipelining :
1660 if (parse_toggle_state(cmd, arg) == 1)
1662 config->feature_flags |= RUNTIME_FEATURE_TOLERATE_PIPELINING;
1666 config->feature_flags &= ~RUNTIME_FEATURE_TOLERATE_PIPELINING;
1670 /* *************************************************************************
1672 * *************************************************************************/
1673 #ifdef FEATURE_TOGGLE
1675 global_toggle_state = parse_toggle_state(cmd, arg);
1677 #endif /* def FEATURE_TOGGLE */
1679 /* *************************************************************************
1680 * trust-info-url url
1681 * *************************************************************************/
1682 #ifdef FEATURE_TRUST
1683 case hash_trust_info_url :
1684 enlist(config->trust_info, arg);
1686 #endif /* def FEATURE_TRUST */
1688 /* *************************************************************************
1689 * trust-x-forwarded-for (0|1)
1690 * *************************************************************************/
1691 case hash_trust_x_forwarded_for :
1692 config->trust_x_forwarded_for = parse_toggle_state(cmd, arg);
1695 /* *************************************************************************
1696 * trusted-cgi-referrer http://www.example.org/some/path.html
1697 * *************************************************************************/
1698 case hash_trusted_cgi_referrer :
1700 * We don't validate the specified referrer as
1701 * it's only used for string comparison.
1703 freez(config->trusted_cgi_referrer);
1704 config->trusted_cgi_referrer = strdup_or_die(arg);
1707 /* *************************************************************************
1708 * trustfile filename
1709 * (In confdir by default.)
1710 * *************************************************************************/
1711 #ifdef FEATURE_TRUST
1712 case hash_trustfile :
1713 freez(config->trustfile);
1714 config->trustfile = make_path(config->confdir, arg);
1716 #endif /* def FEATURE_TRUST */
1718 /* *************************************************************************
1720 * *************************************************************************/
1721 case hash_usermanual :
1723 * XXX: If this isn't the first config directive, the
1724 * show-status page links to the website documentation
1725 * for the directives that were already parsed. Lame.
1727 freez(config->usermanual);
1728 config->usermanual = strdup_or_die(arg);
1731 #ifdef FEATURE_HTTPS_INSPECTION
1732 /* *************************************************************************
1733 * ca private key file password
1734 * *************************************************************************/
1735 case hash_ca_password:
1736 freez(config->ca_password);
1737 config->ca_password = strdup(arg);
1740 /* *************************************************************************
1741 * ca-directory directory
1742 * *************************************************************************/
1743 case hash_ca_directory:
1744 freez(ca_directory);
1745 ca_directory = make_path(NULL, arg);
1747 if (NULL == ca_directory)
1749 log_error(LOG_LEVEL_FATAL, "Out of memory while creating ca dir path");
1754 /* *************************************************************************
1755 * ca cert file ca-cert-file
1756 * In ca dir by default
1757 * *************************************************************************/
1758 case hash_ca_cert_file:
1759 freez(ca_cert_file);
1760 ca_cert_file = make_path(config->ca_directory, arg);
1762 if (NULL == ca_cert_file)
1764 log_error(LOG_LEVEL_FATAL, "Out of memory while creating ca certificate file path");
1769 /* *************************************************************************
1770 * ca key file ca-key-file
1771 * In ca dir by default
1772 * *************************************************************************/
1773 case hash_ca_key_file:
1775 ca_key_file = make_path(config->ca_directory, arg);
1777 if (NULL == ca_key_file)
1779 log_error(LOG_LEVEL_FATAL, "Out of memory while creating ca key file path");
1784 /* *************************************************************************
1785 * certificate-directory directory
1786 * *************************************************************************/
1787 case hash_certificate_directory:
1788 freez(certificate_directory);
1789 certificate_directory = make_path(NULL, arg);
1791 if (NULL == certificate_directory)
1793 log_error(LOG_LEVEL_FATAL,
1794 "Out of memory while creating certificate directory path");
1799 /* *************************************************************************
1800 * trusted CAs file name trusted-cas-file
1801 * *************************************************************************/
1802 case hash_trusted_cas_file:
1803 freez(trusted_cas_file);
1804 trusted_cas_file = make_path(config->ca_directory, arg);
1806 if (NULL == trusted_cas_file)
1808 log_error(LOG_LEVEL_FATAL, "Out of memory while creating trusted CAs file path");
1814 /* *************************************************************************
1815 * Win32 Console options:
1816 * *************************************************************************/
1818 /* *************************************************************************
1820 * *************************************************************************/
1822 case hash_hide_console :
1825 #endif /*def _WIN_CONSOLE*/
1828 /* *************************************************************************
1829 * Win32 GUI options:
1830 * *************************************************************************/
1832 #if defined(_WIN32) && ! defined(_WIN_CONSOLE)
1833 /* *************************************************************************
1834 * activity-animation (0|1)
1835 * *************************************************************************/
1836 case hash_activity_animation :
1837 g_bShowActivityAnimation = parse_toggle_state(cmd, arg);
1840 /* *************************************************************************
1841 * close-button-minimizes (0|1)
1842 * *************************************************************************/
1843 case hash_close_button_minimizes :
1844 g_bCloseHidesWindow = parse_toggle_state(cmd, arg);
1847 /* *************************************************************************
1848 * log-buffer-size (0|1)
1849 * *************************************************************************/
1850 case hash_log_buffer_size :
1851 g_bLimitBufferSize = parse_toggle_state(cmd, arg);
1854 /* *************************************************************************
1855 * log-font-name fontname
1856 * *************************************************************************/
1857 case hash_log_font_name :
1858 if (strlcpy(g_szFontFaceName, arg,
1859 sizeof(g_szFontFaceName)) >= sizeof(g_szFontFaceName))
1861 log_error(LOG_LEVEL_FATAL,
1862 "log-font-name argument '%s' is longer than %u characters.",
1863 arg, sizeof(g_szFontFaceName)-1);
1867 /* *************************************************************************
1869 * *************************************************************************/
1870 case hash_log_font_size :
1871 g_nFontSize = parse_numeric_value(cmd, arg);
1874 /* *************************************************************************
1875 * log-highlight-messages (0|1)
1876 * *************************************************************************/
1877 case hash_log_highlight_messages :
1878 g_bHighlightMessages = parse_toggle_state(cmd, arg);
1881 /* *************************************************************************
1883 * *************************************************************************/
1884 case hash_log_max_lines :
1885 g_nMaxBufferLines = parse_numeric_value(cmd, arg);
1888 /* *************************************************************************
1889 * log-messages (0|1)
1890 * *************************************************************************/
1891 case hash_log_messages :
1892 g_bLogMessages = parse_toggle_state(cmd, arg);
1895 /* *************************************************************************
1896 * show-on-task-bar (0|1)
1897 * *************************************************************************/
1898 case hash_show_on_task_bar :
1899 g_bShowOnTaskBar = parse_toggle_state(cmd, arg);
1902 #endif /* defined(_WIN32) && ! defined(_WIN_CONSOLE) */
1905 /* *************************************************************************
1906 * Warnings about unsupported features
1907 * *************************************************************************/
1909 case hash_deny_access:
1910 #endif /* ndef FEATURE_ACL */
1911 #ifndef FEATURE_CGI_EDIT_ACTIONS
1912 case hash_enable_edit_actions:
1913 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1914 #ifndef FEATURE_TOGGLE
1915 case hash_enable_remote_toggle:
1916 #endif /* ndef FEATURE_TOGGLE */
1918 case hash_permit_access:
1919 #endif /* ndef FEATURE_ACL */
1920 #ifndef FEATURE_TOGGLE
1922 #endif /* ndef FEATURE_TOGGLE */
1923 #ifndef FEATURE_TRUST
1924 case hash_trustfile :
1925 case hash_trust_info_url :
1926 #endif /* ndef FEATURE_TRUST */
1928 #ifndef _WIN_CONSOLE
1929 case hash_hide_console :
1930 #endif /* ndef _WIN_CONSOLE */
1932 #if defined(_WIN_CONSOLE) || ! defined(_WIN32)
1933 case hash_activity_animation :
1934 case hash_close_button_minimizes :
1935 case hash_log_buffer_size :
1936 case hash_log_font_name :
1937 case hash_log_font_size :
1938 case hash_log_highlight_messages :
1939 case hash_log_max_lines :
1940 case hash_log_messages :
1941 case hash_show_on_task_bar :
1942 #endif /* defined(_WIN_CONSOLE) || ! defined(_WIN32) */
1943 /* These warnings are annoying - so hide them. -- Jon */
1944 /* log_error(LOG_LEVEL_INFO, "Unsupported directive \"%s\" ignored.", cmd); */
1947 /* *************************************************************************/
1949 /* *************************************************************************/
1951 * I decided that I liked this better as a warning than an
1952 * error. To change back to an error, just change log level
1953 * to LOG_LEVEL_FATAL.
1955 log_error(LOG_LEVEL_ERROR, "Ignoring unrecognized directive "
1956 "'%s' (%uU) in line %lu in configuration file (%s).",
1957 buf, directive_hash, linenum, configfile);
1958 string_append(&config->proxy_args,
1959 " <strong class='warning'>Warning: Ignoring unrecognized directive:</strong>");
1962 /* *************************************************************************/
1963 } /* end switch(hash_string(cmd)) */
1965 /* Save the argument for the show-status page. */
1966 savearg(cmd, arg, config);
1968 } /* end while (read_config_line(...)) */
1972 set_debug_level(config->debug);
1974 freez(config->logfile);
1978 if (NULL != logfile)
1980 config->logfile = logfile;
1981 init_error_log(Argv[0], config->logfile);
1989 #ifdef FEATURE_HTTPS_INSPECTION
1991 * Setting SSL parameters from loaded values into structures
1993 freez(config->ca_directory);
1994 config->ca_directory = make_path(NULL, ca_directory);
1995 freez(ca_directory);
1997 freez(config->ca_cert_file);
1998 config->ca_cert_file = make_path(config->ca_directory, ca_cert_file);
1999 freez(ca_cert_file);
2001 freez(config->ca_key_file);
2002 config->ca_key_file = make_path(config->ca_directory, ca_key_file);
2005 freez(config->trusted_cas_file);
2006 config->trusted_cas_file = make_path(config->ca_directory, trusted_cas_file);
2007 freez(trusted_cas_file);
2009 freez(config->certificate_directory);
2010 config->certificate_directory = make_path(NULL, certificate_directory);
2011 freez(certificate_directory);
2013 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2014 if (config->default_server_timeout > config->keep_alive_timeout)
2016 log_error(LOG_LEVEL_ERROR,
2017 "Reducing the default-server-timeout from %d to the keep-alive-timeout %d.",
2018 config->default_server_timeout, config->keep_alive_timeout);
2019 config->default_server_timeout = config->keep_alive_timeout;
2021 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2023 #ifdef FEATURE_CONNECTION_SHARING
2024 if (config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2026 if (!config->multi_threaded)
2029 * While we could use keep-alive without multiple threads
2030 * if we didn't bother with enforcing the connection timeout,
2031 * that might make Tor users sad, even though they shouldn't
2032 * enable the single-threaded option anyway.
2034 * XXX: We could still use Proxy-Connection: keep-alive.
2036 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
2037 log_error(LOG_LEVEL_ERROR,
2038 "Config option single-threaded disables connection keep-alive.");
2041 else if ((config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING))
2043 log_error(LOG_LEVEL_ERROR, "Config option connection-sharing "
2044 "has no effect if keep-alive-timeout isn't set.");
2045 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
2047 #endif /* def FEATURE_CONNECTION_SHARING */
2049 if (NULL == config->proxy_args)
2051 log_error(LOG_LEVEL_FATAL, "Out of memory loading config - insufficient memory for config->proxy_args");
2054 if (config->re_filterfile[0])
2056 add_loader(load_re_filterfiles, config);
2059 if (config->actions_file[0])
2061 add_loader(load_action_files, config);
2064 #ifdef FEATURE_TRUST
2065 if (config->trustfile)
2067 add_loader(load_trustfile, config);
2069 #endif /* def FEATURE_TRUST */
2071 if (NULL == config->haddr[0])
2073 config->haddr[0] = strdup_or_die(HADDR_DEFAULT);
2076 for (i = 0; i < MAX_LISTENING_SOCKETS && NULL != config->haddr[i]; i++)
2078 if ((*config->haddr[i] == '[')
2079 && (NULL != (p = strchr(config->haddr[i], ']')))
2081 && (0 < (config->hport[i] = atoi(p + 2))))
2084 memmove((void *)config->haddr[i], config->haddr[i] + 1,
2085 (size_t)(p - config->haddr[i]));
2087 else if (NULL != (p = strchr(config->haddr[i], ':'))
2088 && (0 < (config->hport[i] = atoi(p + 1))))
2094 log_error(LOG_LEVEL_FATAL, "invalid bind port spec %s", config->haddr[i]);
2095 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2097 if (*config->haddr[i] == '\0')
2100 * Only the port specified. We stored it in config->hport[i]
2101 * and don't need its text representation anymore.
2102 * Use config->hport[i] == 0 to iterate listening addresses since
2105 freez(config->haddr[i]);
2110 * Want to run all the loaders once now.
2112 * Need to set up a fake csp, so they can get to the config.
2114 fake_csp = zalloc_or_die(sizeof(*fake_csp));
2115 fake_csp->config = config;
2117 if (run_loader(fake_csp))
2120 log_error(LOG_LEVEL_FATAL, "A loader failed while loading config file. Exiting.");
2121 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2125 /* FIXME: this is a kludge for win32 */
2126 #if defined(_WIN32) && !defined (_WIN_CONSOLE)
2128 g_default_actions_file = config->actions_file[1]; /* FIXME Hope this is default.action */
2129 g_user_actions_file = config->actions_file[2]; /* FIXME Hope this is user.action */
2130 g_default_filterfile = config->re_filterfile[0]; /* FIXME Hope this is default.filter */
2131 g_user_filterfile = config->re_filterfile[1]; /* FIXME Hope this is user.filter */
2133 #ifdef FEATURE_TRUST
2134 g_trustfile = config->trustfile;
2135 #endif /* def FEATURE_TRUST */
2138 #endif /* defined(_WIN32) && !defined (_WIN_CONSOLE) */
2139 /* FIXME: end kludge */
2142 if (current_configfile == NULL)
2144 config->need_bind = 1;
2148 struct configuration_spec * oldcfg = (struct configuration_spec *)
2149 current_configfile->f;
2151 * Check if config->haddr[i],hport[i] == oldcfg->haddr[i],hport[i]
2153 config->need_bind = 0;
2155 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
2157 if (config->hport[i] != oldcfg->hport[i])
2159 config->need_bind = 1;
2161 else if (config->haddr[i] == NULL)
2163 if (oldcfg->haddr[i] != NULL)
2165 config->need_bind = 1;
2168 else if (oldcfg->haddr[i] == NULL)
2170 config->need_bind = 1;
2172 else if (0 != strcmp(config->haddr[i], oldcfg->haddr[i]))
2174 config->need_bind = 1;
2178 current_configfile->unloader = unload_configfile;
2181 fs->next = files->next;
2184 current_configfile = fs;
2190 /*********************************************************************
2192 * Function : savearg
2194 * Description : Called from `load_config'. It saves each non-empty
2195 * and non-comment line from config into
2196 * config->proxy_args. This is used to create the
2197 * show-status page. On error, frees
2198 * config->proxy_args and sets it to NULL
2201 * 1 : command = config setting that was found
2202 * 2 : argument = the setting's argument (if any)
2203 * 3 : config = Configuration to save into.
2207 *********************************************************************/
2208 static void savearg(char *command, char *argument, struct configuration_spec * config)
2217 * Add config option name embedded in
2218 * link to its section in the user-manual
2220 buf = strdup_or_die("\n<a href=\"");
2221 if (!strncmpic(config->usermanual, "file://", 7) ||
2222 !strncmpic(config->usermanual, "http", 4))
2224 string_append(&buf, config->usermanual);
2228 string_append(&buf, "http://" CGI_SITE_2_HOST "/user-manual/");
2230 string_append(&buf, CONFIG_HELP_PREFIX);
2231 string_join (&buf, string_toupper(command));
2232 string_append(&buf, "\">");
2233 string_append(&buf, command);
2234 string_append(&buf, "</a> ");
2238 freez(config->proxy_args);
2242 if ((NULL != argument) && ('\0' != *argument))
2244 s = html_encode(argument);
2248 freez(config->proxy_args);
2252 if (strncmpic(argument, "http://", 7) == 0)
2254 string_append(&buf, "<a href=\"");
2255 string_append(&buf, s);
2256 string_append(&buf, "\">");
2257 string_join (&buf, s);
2258 string_append(&buf, "</a>");
2262 string_join (&buf, s);
2266 string_append(&buf, "<br>");
2267 string_join(&config->proxy_args, buf);