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 * To find out the hash for a new directive put it in the config file
124 * and read the number from the error message in the log).
126 * Please keep this list sorted alphabetically (but with the Windows
127 * console and GUI specific options last).
130 #define hash_actions_file 1196306641U /* "actionsfile" */
131 #define hash_accept_intercepted_requests 1513024973U /* "accept-intercepted-requests" */
132 #define hash_admin_address 4112573064U /* "admin-address" */
133 #define hash_allow_cgi_request_crunching 258915987U /* "allow-cgi-request-crunching" */
134 #define hash_buffer_limit 1881726070U /* "buffer-limit */
135 #define hash_ca_cert_file 1622923720U /* "ca-cert-file" */
136 #define hash_ca_directory 1623615670U /* "ca-directory" */
137 #define hash_ca_key_file 1184187891U /* "ca-key-file" */
138 #define hash_ca_password 1184543320U /* "ca-password" */
139 #define hash_certificate_directory 1367994217U /* "certificate-directory" */
140 #define hash_cipher_list 1225729316U /* "cipher-list" */
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 3239141416U /* "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->cipher_list);
285 freez(config->trusted_cas_file);
289 freez(config->trustfile);
290 list_remove_all(config->trust_info);
291 #endif /* def FEATURE_TRUST */
293 #ifdef FEATURE_CLIENT_TAGS
294 free_client_specific_tags(config->client_tags);
301 #ifdef FEATURE_GRACEFUL_TERMINATION
302 /*********************************************************************
304 * Function : unload_current_config_file
306 * Description : Unloads current config file - reset to state at
307 * beginning of program.
313 *********************************************************************/
314 void unload_current_config_file(void)
316 if (current_configfile)
318 current_configfile->unloader = unload_configfile;
319 current_configfile = NULL;
325 #ifdef FEATURE_CLIENT_TAGS
326 /*********************************************************************
328 * Function : register_tag
330 * Description : Registers a client-specific-tag and its description
333 * 1 : config: The tag list
334 * 2 : name: The name of the client-specific-tag
335 * 3 : description: The human-readable description for the tag
339 *********************************************************************/
340 static void register_tag(struct client_tag_spec *tag_list,
341 const char *name, const char *description)
343 struct client_tag_spec *new_tag;
344 struct client_tag_spec *last_tag;
347 while (last_tag->next != NULL)
349 last_tag = last_tag->next;
351 if (last_tag->name == NULL)
358 new_tag = zalloc_or_die(sizeof(struct client_tag_spec));
360 new_tag->name = strdup_or_die(name);
361 new_tag->description = strdup_or_die(description);
362 if (new_tag != last_tag)
364 last_tag->next = new_tag;
369 /*********************************************************************
371 * Function : free_client_specific_tags
373 * Description : Frees client-specific tags and their descriptions
376 * 1 : tag_list: The tag list to free
380 *********************************************************************/
381 static void free_client_specific_tags(struct client_tag_spec *tag_list)
383 struct client_tag_spec *this_tag;
384 struct client_tag_spec *next_tag;
390 next_tag = next_tag->next;
392 freez(this_tag->name);
393 freez(this_tag->description);
395 if (this_tag != tag_list)
399 } while (next_tag != NULL);
401 #endif /* def FEATURE_CLIENT_TAGS */
404 /*********************************************************************
406 * Function : parse_numeric_value
408 * Description : Parse the value of a directive that can only have
409 * a single numeric value. Terminates with a fatal error
410 * if the value is NULL or not numeric.
413 * 1 : name: The name of the directive. Used for log messages.
414 * 2 : value: The value to parse
417 * Returns : The numerical value as integer
419 *********************************************************************/
420 static int parse_numeric_value(const char *name, const char *value)
425 assert(name != NULL);
426 assert(value != NULL);
428 if ((value == NULL) || (*value == '\0'))
430 log_error(LOG_LEVEL_FATAL, "Directive %s used without argument", name);
433 number = (int)strtol(value, &endptr, 0);
436 log_error(LOG_LEVEL_FATAL,
437 "Directive '%s' used with non-numerical value: '%s'", name, value);
445 /*********************************************************************
447 * Function : parse_toggle_value
449 * Description : Parse the value of a directive that can only be
450 * enabled or disabled. Terminates with a fatal error
451 * if the value is NULL or something other than 0 or 1.
454 * 1 : name: The name of the directive. Used for log messages.
455 * 2 : value: The value to parse
458 * Returns : The numerical toggle state
460 *********************************************************************/
461 static int parse_toggle_state(const char *name, const char *value)
464 assert(name != NULL);
465 assert(value != NULL);
467 if ((value == NULL) || (*value == '\0'))
469 log_error(LOG_LEVEL_FATAL, "Directive %s used without argument", name);
472 toggle_state = atoi(value);
475 * Also check the length as atoi() doesn't mind
476 * garbage after a valid integer, but we do.
478 if (((toggle_state != 0) && (toggle_state != 1)) || (strlen(value) != 1))
480 log_error(LOG_LEVEL_FATAL,
481 "Directive %s used with invalid argument '%s'. Use either '0' or '1'.",
490 /*********************************************************************
492 * Function : parse_client_header_order
494 * Description : Parse the value of the header-order directive
497 * 1 : ordered_header_list: List to insert the ordered
499 * 2 : ordered_headers: The ordered header names separated
505 *********************************************************************/
506 static void parse_client_header_order(struct list *ordered_header_list, const char *ordered_headers)
508 char *original_headers_copy;
511 int number_of_headers;
514 assert(ordered_header_list != NULL);
515 assert(ordered_headers != NULL);
517 if (ordered_headers == NULL)
519 log_error(LOG_LEVEL_FATAL, "header-order used without argument");
523 * XXX: This estimate is guaranteed to be high enough as we
524 * let ssplit() ignore empty fields, but also a bit wasteful.
525 * The same hack is used in get_last_url() so it looks like
526 * a real solution is needed.
528 max_segments = strlen(ordered_headers) / 2;
529 if (max_segments == 0)
533 vector = malloc_or_die(max_segments * sizeof(char *));
535 original_headers_copy = strdup_or_die(ordered_headers);
537 number_of_headers = ssplit(original_headers_copy, "\t ", vector, max_segments);
538 if (number_of_headers == -1)
540 log_error(LOG_LEVEL_FATAL, "Failed to split ordered headers");
543 for (i = 0; i < number_of_headers; i++)
545 if (JB_ERR_OK != enlist(ordered_header_list, vector[i]))
547 log_error(LOG_LEVEL_FATAL,
548 "Failed to enlist ordered header: %s", vector[i]);
553 freez(original_headers_copy);
560 /*********************************************************************
562 * Function : load_config
564 * Description : Load the config file and all parameters.
566 * XXX: more than thousand lines long
567 * and thus in serious need of refactoring.
571 * Returns : The configuration_spec, or NULL on error.
573 *********************************************************************/
574 struct configuration_spec * load_config(void)
578 FILE *configfp = NULL;
579 struct configuration_spec * config = NULL;
580 struct client_state * fake_csp;
581 struct file_list *fs;
582 unsigned long linenum = 0;
584 char *logfile = NULL;
585 #ifdef FEATURE_HTTPS_INSPECTION
586 char *ca_cert_file = NULL;
587 char *ca_key_file = NULL;
588 char *ca_directory = NULL;
589 char *trusted_cas_file = NULL;
590 char *certificate_directory = NULL;
593 if (!check_file_changed(current_configfile, configfile, &fs))
595 /* No need to load */
596 return ((struct configuration_spec *)current_configfile->f);
600 log_error(LOG_LEVEL_FATAL,
601 "can't check configuration file '%s': %E", configfile);
605 if (NULL != current_configfile)
607 log_error(LOG_LEVEL_INFO, "Reloading configuration file '%s'", configfile);
610 #ifdef FEATURE_TOGGLE
611 global_toggle_state = 1;
612 #endif /* def FEATURE_TOGGLE */
614 fs->f = config = zalloc_or_die(sizeof(*config));
617 * This is backwards from how it's usually done.
618 * Following the usual pattern, "fs" would be stored in a member
619 * variable in "csp", and then we'd access "config" from "fs->f",
620 * using a cast. However, "config" is used so often that a
621 * cast each time would be very ugly, and the extra indirection
622 * would waste CPU cycles. Therefore we store "config" in
623 * "csp->config", and "fs" in "csp->config->config_file_list".
625 config->config_file_list = fs;
630 config->multi_threaded = 1;
631 config->buffer_limit = 4096 * 1024;
632 config->receive_buffer_size = BUFFER_SIZE;
633 config->usermanual = strdup_or_die(USER_MANUAL_URL);
634 config->proxy_args = strdup_or_die("");
635 config->forwarded_connect_retries = 0;
636 #ifdef FEATURE_HTTPS_INSPECTION
637 config->ca_password = strdup_or_die("");
638 ca_cert_file = strdup_or_die("cacert.crt");
639 ca_key_file = strdup_or_die("cakey.pem");
640 ca_directory = strdup_or_die("./CA");
641 trusted_cas_file = strdup_or_die("trustedCAs.pem");
642 certificate_directory = strdup_or_die("./certs");
645 #ifdef FEATURE_CLIENT_TAGS
646 config->client_tag_lifetime = 60;
648 config->trust_x_forwarded_for = 0;
649 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
650 config->enable_accept_filter = 0;
652 config->listen_backlog = DEFAULT_LISTEN_BACKLOG;
653 config->trusted_cgi_referrer = NULL;
655 * 128 client sockets ought to be enough for everybody who can't
656 * be bothered to read the documentation to figure out how to
657 * increase the limit.
659 config->max_client_connections = 128;
660 config->socket_timeout = 300; /* XXX: Should be a macro. */
661 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
662 config->default_server_timeout = 0;
663 config->keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
664 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
665 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
667 config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
668 config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
669 config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
670 config->feature_flags &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
671 config->feature_flags &= ~RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
672 #ifdef FEATURE_COMPRESSION
673 config->feature_flags &= ~RUNTIME_FEATURE_COMPRESSION;
675 * XXX: Run some benchmarks to see if there are better default values.
677 config->compression_level = 1;
679 config->feature_flags &= ~RUNTIME_FEATURE_TOLERATE_PIPELINING;
680 config->cors_allowed_origin = NULL;
682 configfp = fopen(configfile, "r");
683 if (NULL == configfp)
685 log_error(LOG_LEVEL_FATAL,
686 "can't open configuration file '%s': %E", configfile);
687 /* Never get here - LOG_LEVEL_FATAL causes program exit */
690 while (read_config_line(configfp, &linenum, &buf) != NULL)
692 char cmd[BUFFER_SIZE];
693 char arg[BUFFER_SIZE];
694 char tmp[BUFFER_SIZE];
696 struct access_control_list *cur_acl;
697 #endif /* def FEATURE_ACL */
698 struct forward_spec *cur_fwd;
701 unsigned int directive_hash;
703 strlcpy(tmp, buf, sizeof(tmp));
705 /* Copy command (i.e. up to space or tab) into cmd */
708 while (*p && (*p != ' ') && (*p != '\t'))
714 /* Skip over the whitespace in buf */
715 while (*p && ((*p == ' ') || (*p == '\t')))
720 /* Copy the argument into arg */
721 if (strlcpy(arg, p, sizeof(arg)) >= sizeof(arg))
723 log_error(LOG_LEVEL_FATAL, "Config line too long: %s", buf);
726 /* Should never happen, but check this anyway */
733 /* Make sure the command field is lower case */
734 for (p = cmd; *p; p++)
736 if (privoxy_isupper(*p))
738 *p = (char)privoxy_tolower(*p);
742 directive_hash = hash_string(cmd);
743 switch (directive_hash)
745 /* *************************************************************************
746 * actionsfile actions-file-name
747 * In confdir by default
748 * *************************************************************************/
749 case hash_actions_file :
751 while ((i < MAX_AF_FILES) && (NULL != config->actions_file[i]))
756 if (i >= MAX_AF_FILES)
758 log_error(LOG_LEVEL_FATAL, "Too many 'actionsfile' directives in config file - limit is %d.\n"
759 "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
762 config->actions_file_short[i] = strdup_or_die(arg);
763 config->actions_file[i] = make_path(config->confdir, arg);
766 /* *************************************************************************
767 * accept-intercepted-requests
768 * *************************************************************************/
769 case hash_accept_intercepted_requests:
770 if (parse_toggle_state(cmd, arg) == 1)
772 config->feature_flags |= RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
776 config->feature_flags &= ~RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS;
780 /* *************************************************************************
781 * admin-address email-address
782 * *************************************************************************/
783 case hash_admin_address :
784 freez(config->admin_address);
785 config->admin_address = strdup_or_die(arg);
788 /* *************************************************************************
789 * allow-cgi-request-crunching
790 * *************************************************************************/
791 case hash_allow_cgi_request_crunching:
792 if (parse_toggle_state(cmd, arg) == 1)
794 config->feature_flags |= RUNTIME_FEATURE_CGI_CRUNCHING;
798 config->feature_flags &= ~RUNTIME_FEATURE_CGI_CRUNCHING;
802 /* *************************************************************************
804 * *************************************************************************/
805 case hash_buffer_limit :
806 config->buffer_limit = (size_t)(1024 * parse_numeric_value(cmd, arg));
809 /* *************************************************************************
810 * client-header-order header-1 header-2 ... header-n
811 * *************************************************************************/
812 case hash_client_header_order:
813 list_remove_all(config->ordered_client_headers);
814 parse_client_header_order(config->ordered_client_headers, arg);
817 /* *************************************************************************
818 * client-specific-tag tag-name description
819 * *************************************************************************/
820 #ifdef FEATURE_CLIENT_TAGS
821 case hash_client_specific_tag:
827 description = strstr(arg, " ");
828 if (description == NULL)
830 log_error(LOG_LEVEL_FATAL,
831 "client-specific-tag '%s' lacks a description.", name);
835 * The length is limited because we don't want truncated
836 * HTML caused by the cgi interface using static buffer
839 if (strlen(name) > CLIENT_TAG_LENGTH_MAX)
841 log_error(LOG_LEVEL_FATAL,
842 "client-specific-tag '%s' is longer than %d characters.",
843 name, CLIENT_TAG_LENGTH_MAX);
846 register_tag(config->client_tags, name, description);
849 #endif /* def FEATURE_CLIENT_TAGS */
851 /* *************************************************************************
852 * client-tag-lifetime ttl
853 * *************************************************************************/
854 #ifdef FEATURE_CLIENT_TAGS
855 case hash_client_tag_lifetime:
857 int ttl = parse_numeric_value(cmd, arg);
860 config->client_tag_lifetime = (unsigned)ttl;
864 log_error(LOG_LEVEL_FATAL,
865 "client-tag-lifetime can't be negative.");
869 #endif /* def FEATURE_CLIENT_TAGS */
871 /* *************************************************************************
872 * confdir directory-name
873 * *************************************************************************/
875 freez(config->confdir);
876 config->confdir = make_path(NULL, arg);
879 /* *************************************************************************
880 * compression-level 0-9
881 * *************************************************************************/
882 #ifdef FEATURE_COMPRESSION
883 case hash_compression_level :
885 int compression_level = parse_numeric_value(cmd, arg);
886 if (-1 <= compression_level && compression_level <= 9)
888 config->compression_level = compression_level;
892 log_error(LOG_LEVEL_FATAL,
893 "Invalid compression-level value: %s", arg);
899 /* *************************************************************************
900 * connection-sharing (0|1)
901 * *************************************************************************/
902 #ifdef FEATURE_CONNECTION_SHARING
903 case hash_connection_sharing :
904 if (parse_toggle_state(cmd, arg) == 1)
906 config->feature_flags |= RUNTIME_FEATURE_CONNECTION_SHARING;
910 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
915 /* *************************************************************************
916 * cors-allowed-origin http://www.example.org
917 * *************************************************************************/
918 case hash_cors_allowed_origin :
920 * We don't validate the specified referrer as
921 * it's only used for string comparison.
923 freez(config->cors_allowed_origin);
924 config->cors_allowed_origin = strdup_or_die(arg);
927 /* *************************************************************************
929 * Specifies debug level, multiple values are ORed together.
930 * *************************************************************************/
932 config->debug |= parse_numeric_value(cmd, arg);
935 /* *************************************************************************
936 * default-server-timeout timeout
937 * *************************************************************************/
938 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
939 case hash_default_server_timeout :
941 int timeout = parse_numeric_value(cmd, arg);
944 config->default_server_timeout = (unsigned int)timeout;
948 log_error(LOG_LEVEL_FATAL,
949 "Invalid default-server-timeout value: %s", arg);
955 /* *************************************************************************
956 * deny-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
957 * *************************************************************************/
959 case hash_deny_access:
960 strlcpy(tmp, arg, sizeof(tmp));
961 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
963 if ((vec_count != 1) && (vec_count != 2))
965 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
966 "deny-access directive in configuration file.");
967 string_append(&config->proxy_args,
968 "<br>\nWARNING: Wrong number of parameters for "
969 "deny-access directive in configuration file.<br><br>\n");
973 /* allocate a new node */
974 cur_acl = zalloc_or_die(sizeof(*cur_acl));
975 cur_acl->action = ACL_DENY;
977 if (acl_addr(vec[0], cur_acl->src) < 0)
979 log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
980 "for deny-access directive in configuration file: \"%s\"", vec[0]);
981 string_append(&config->proxy_args,
982 "<br>\nWARNING: Invalid source address, port or netmask "
983 "for deny-access directive in configuration file: \"");
984 string_append(&config->proxy_args,
986 string_append(&config->proxy_args,
993 if (acl_addr(vec[1], cur_acl->dst) < 0)
995 log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
996 "for deny-access directive in configuration file: \"%s\"", vec[1]);
997 string_append(&config->proxy_args,
998 "<br>\nWARNING: Invalid destination address, port or netmask "
999 "for deny-access directive in configuration file: \"");
1000 string_append(&config->proxy_args,
1002 string_append(&config->proxy_args,
1011 cur_acl->wildcard_dst = 1;
1013 #endif /* def HAVE_RFC2553 */
1016 * Add it to the list. Note we reverse the list to get the
1017 * behaviour the user expects. With both the ACL and
1018 * actions file, the last match wins. However, the internal
1019 * implementations are different: The actions file is stored
1020 * in the same order as the file, and scanned completely.
1021 * With the ACL, we reverse the order as we load it, then
1022 * when we scan it we stop as soon as we get a match.
1024 cur_acl->next = config->acl;
1025 config->acl = cur_acl;
1028 #endif /* def FEATURE_ACL */
1030 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
1031 /* *************************************************************************
1032 * enable-accept-filter 0|1
1033 * *************************************************************************/
1034 case hash_enable_accept_filter :
1035 config->enable_accept_filter = parse_toggle_state(cmd, arg);
1037 #endif /* defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER) */
1039 /* *************************************************************************
1040 * enable-edit-actions 0|1
1041 * *************************************************************************/
1042 #ifdef FEATURE_CGI_EDIT_ACTIONS
1043 case hash_enable_edit_actions:
1044 if (parse_toggle_state(cmd, arg) == 1)
1046 config->feature_flags |= RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
1050 config->feature_flags &= ~RUNTIME_FEATURE_CGI_EDIT_ACTIONS;
1053 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1055 /* *************************************************************************
1056 * enable-compression 0|1
1057 * *************************************************************************/
1058 #ifdef FEATURE_COMPRESSION
1059 case hash_enable_compression:
1060 if (parse_toggle_state(cmd, arg) == 1)
1062 config->feature_flags |= RUNTIME_FEATURE_COMPRESSION;
1066 config->feature_flags &= ~RUNTIME_FEATURE_COMPRESSION;
1069 #endif /* def FEATURE_COMPRESSION */
1071 /* *************************************************************************
1072 * enable-proxy-authentication-forwarding 0|1
1073 * *************************************************************************/
1074 case hash_enable_proxy_authentication_forwarding:
1075 if (parse_toggle_state(cmd, arg) == 1)
1077 config->feature_flags |= RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
1081 config->feature_flags &= ~RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS;
1085 /* *************************************************************************
1086 * enable-remote-toggle 0|1
1087 * *************************************************************************/
1088 #ifdef FEATURE_TOGGLE
1089 case hash_enable_remote_toggle:
1090 if (parse_toggle_state(cmd, arg) == 1)
1092 config->feature_flags |= RUNTIME_FEATURE_CGI_TOGGLE;
1096 config->feature_flags &= ~RUNTIME_FEATURE_CGI_TOGGLE;
1099 #endif /* def FEATURE_TOGGLE */
1101 /* *************************************************************************
1102 * enable-remote-http-toggle 0|1
1103 * *************************************************************************/
1104 case hash_enable_remote_http_toggle:
1105 if (parse_toggle_state(cmd, arg) == 1)
1107 config->feature_flags |= RUNTIME_FEATURE_HTTP_TOGGLE;
1111 config->feature_flags &= ~RUNTIME_FEATURE_HTTP_TOGGLE;
1115 /* *************************************************************************
1116 * enforce-blocks 0|1
1117 * *************************************************************************/
1118 case hash_enforce_blocks:
1119 #ifdef FEATURE_FORCE_LOAD
1120 if (parse_toggle_state(cmd, arg) == 1)
1122 config->feature_flags |= RUNTIME_FEATURE_ENFORCE_BLOCKS;
1126 config->feature_flags &= ~RUNTIME_FEATURE_ENFORCE_BLOCKS;
1129 log_error(LOG_LEVEL_ERROR, "Ignoring directive 'enforce-blocks'. "
1130 "FEATURE_FORCE_LOAD is disabled, blocks will always be enforced.");
1131 #endif /* def FEATURE_FORCE_LOAD */
1134 /* *************************************************************************
1135 * filterfile file-name
1136 * In confdir by default.
1137 * *************************************************************************/
1138 case hash_filterfile :
1140 while ((i < MAX_AF_FILES) && (NULL != config->re_filterfile[i]))
1145 if (i >= MAX_AF_FILES)
1147 log_error(LOG_LEVEL_FATAL, "Too many 'filterfile' directives in config file - limit is %d.\n"
1148 "(You can increase this limit by changing MAX_AF_FILES in project.h and recompiling).",
1151 config->re_filterfile_short[i] = strdup_or_die(arg);
1152 config->re_filterfile[i] = make_path(config->confdir, arg);
1156 /* *************************************************************************
1157 * forward url-pattern (.|http-proxy-host[:port])
1158 * *************************************************************************/
1160 strlcpy(tmp, arg, sizeof(tmp));
1161 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1165 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for forward "
1166 "directive in configuration file.");
1167 string_append(&config->proxy_args,
1168 "<br>\nWARNING: Wrong number of parameters for "
1169 "forward directive in configuration file.");
1173 /* allocate a new node */
1174 cur_fwd = zalloc_or_die(sizeof(*cur_fwd));
1175 cur_fwd->type = SOCKS_NONE;
1177 /* Save the URL pattern */
1178 if (create_pattern_spec(cur_fwd->url, vec[0]))
1180 log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward "
1181 "directive in configuration file.");
1182 string_append(&config->proxy_args,
1183 "<br>\nWARNING: Bad URL specifier for "
1184 "forward directive in configuration file.");
1189 /* Parse the parent HTTP proxy host:port */
1192 if (strcmp(p, ".") != 0)
1194 cur_fwd->forward_port = 8000;
1195 parse_forwarder_address(p,
1196 &cur_fwd->forward_host, &cur_fwd->forward_port,
1201 cur_fwd->next = config->forward;
1202 config->forward = cur_fwd;
1206 /* *************************************************************************
1207 * forward-socks4 url-pattern socks-proxy[:port] (.|http-proxy[:port])
1208 * *************************************************************************/
1209 case hash_forward_socks4:
1210 strlcpy(tmp, arg, sizeof(tmp));
1211 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1215 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
1216 "forward-socks4 directive in configuration file.");
1217 string_append(&config->proxy_args,
1218 "<br>\nWARNING: Wrong number of parameters for "
1219 "forward-socks4 directive in configuration file.");
1223 /* allocate a new node */
1224 cur_fwd = zalloc_or_die(sizeof(*cur_fwd));
1225 cur_fwd->type = SOCKS_4;
1227 /* Save the URL pattern */
1228 if (create_pattern_spec(cur_fwd->url, vec[0]))
1230 log_error(LOG_LEVEL_ERROR, "Bad URL specifier for forward-socks4 "
1231 "directive in configuration file.");
1232 string_append(&config->proxy_args,
1233 "<br>\nWARNING: Bad URL specifier for "
1234 "forward-socks4 directive in configuration file.");
1239 /* Parse the SOCKS proxy host[:port] */
1242 /* XXX: This check looks like a bug. */
1243 if (strcmp(p, ".") != 0)
1245 cur_fwd->gateway_port = 1080;
1246 parse_forwarder_address(p,
1247 &cur_fwd->gateway_host, &cur_fwd->gateway_port,
1251 /* Parse the parent HTTP proxy host[:port] */
1254 if (strcmp(p, ".") != 0)
1256 cur_fwd->forward_port = 8000;
1257 parse_forwarder_address(p,
1258 &cur_fwd->forward_host, &cur_fwd->forward_port,
1263 cur_fwd->next = config->forward;
1264 config->forward = cur_fwd;
1268 /* *************************************************************************
1269 * forward-socks4a url-pattern socks-proxy[:port] (.|http-proxy[:port])
1270 * *************************************************************************/
1271 case hash_forward_socks4a:
1272 case hash_forward_socks5:
1273 case hash_forward_socks5t:
1274 strlcpy(tmp, arg, sizeof(tmp));
1275 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1279 log_error(LOG_LEVEL_ERROR,
1280 "Wrong number of parameters for %s in configuration file.",
1282 string_append(&config->proxy_args,
1283 "<br>\nWARNING: Wrong number of parameters for ");
1284 string_append(&config->proxy_args, cmd);
1285 string_append(&config->proxy_args,
1286 "directive in configuration file.");
1290 /* allocate a new node */
1291 cur_fwd = zalloc_or_die(sizeof(*cur_fwd));
1293 if (directive_hash == hash_forward_socks4a)
1295 cur_fwd->type = SOCKS_4A;
1297 else if (directive_hash == hash_forward_socks5)
1299 cur_fwd->type = SOCKS_5;
1303 assert(directive_hash == hash_forward_socks5t);
1304 cur_fwd->type = SOCKS_5T;
1307 /* Save the URL pattern */
1308 if (create_pattern_spec(cur_fwd->url, vec[0]))
1310 log_error(LOG_LEVEL_ERROR,
1311 "Bad URL specifier for %s in configuration file.",
1313 string_append(&config->proxy_args,
1314 "<br>\nWARNING: Bad URL specifier for ");
1315 string_append(&config->proxy_args, cmd);
1316 string_append(&config->proxy_args,
1317 "directive in configuration file.");
1322 /* Parse the SOCKS proxy [user:pass@]host[:port] */
1325 cur_fwd->gateway_port = 1080;
1326 parse_forwarder_address(p,
1327 &cur_fwd->gateway_host, &cur_fwd->gateway_port,
1328 &cur_fwd->auth_username, &cur_fwd->auth_password);
1330 /* Parse the parent HTTP proxy host[:port] */
1333 if (strcmp(p, ".") != 0)
1335 cur_fwd->forward_port = 8000;
1336 parse_forwarder_address(p,
1337 &cur_fwd->forward_host, &cur_fwd->forward_port,
1342 cur_fwd->next = config->forward;
1343 config->forward = cur_fwd;
1347 /* *************************************************************************
1348 * forwarded-connect-retries n
1349 * *************************************************************************/
1350 case hash_forwarded_connect_retries :
1351 config->forwarded_connect_retries = parse_numeric_value(cmd, arg);
1354 /* *************************************************************************
1355 * handle-as-empty-doc-returns-ok 0|1
1357 * Workaround for firefox hanging on blocked javascript pages.
1358 * Block with the "+handle-as-empty-document" flag and set the
1359 * "handle-as-empty-doc-returns-ok" run-time config flag so that
1360 * Privoxy returns a 200/OK status instead of a 403/Forbidden status
1361 * to the browser for blocked pages.
1362 ***************************************************************************/
1363 case hash_handle_as_empty_returns_ok:
1364 if (parse_toggle_state(cmd, arg) == 1)
1366 config->feature_flags |= RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
1370 config->feature_flags &= ~RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK;
1374 /* *************************************************************************
1375 * hostname hostname-to-show-on-cgi-pages
1376 * *************************************************************************/
1377 case hash_hostname :
1378 freez(config->hostname);
1379 config->hostname = strdup_or_die(arg);
1382 /* *************************************************************************
1383 * keep-alive-timeout timeout
1384 * *************************************************************************/
1385 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1386 case hash_keep_alive_timeout :
1388 int timeout = parse_numeric_value(cmd, arg);
1391 config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1392 config->keep_alive_timeout = (unsigned int)timeout;
1396 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
1402 /* *************************************************************************
1403 * listen-address [ip][:port]
1404 * *************************************************************************/
1405 case hash_listen_address :
1407 while ((i < MAX_LISTENING_SOCKETS) && (NULL != config->haddr[i]))
1412 if (i >= MAX_LISTENING_SOCKETS)
1414 log_error(LOG_LEVEL_FATAL, "Too many 'listen-address' directives in config file - limit is %d.\n"
1415 "(You can increase this limit by changing MAX_LISTENING_SOCKETS in project.h and recompiling).",
1416 MAX_LISTENING_SOCKETS);
1418 config->haddr[i] = strdup_or_die(arg);
1421 /* *************************************************************************
1423 * *************************************************************************/
1424 case hash_listen_backlog :
1426 * We don't enfore an upper or lower limit because on
1427 * many platforms all values are valid and negative
1428 * number mean "use the highest value allowed".
1430 config->listen_backlog = parse_numeric_value(cmd, arg);
1433 /* *************************************************************************
1434 * logdir directory-name
1435 * *************************************************************************/
1437 freez(config->logdir);
1438 config->logdir = make_path(NULL, arg);
1441 /* *************************************************************************
1442 * logfile log-file-name
1443 * In logdir by default
1444 * *************************************************************************/
1448 logfile = make_path(config->logdir, arg);
1449 if (NULL == logfile)
1451 log_error(LOG_LEVEL_FATAL, "Out of memory while creating logfile path");
1456 /* *************************************************************************
1457 * max-client-connections number
1458 * *************************************************************************/
1459 case hash_max_client_connections :
1461 int max_client_connections = parse_numeric_value(cmd, arg);
1463 #if !defined(_WIN32) && !defined(HAVE_POLL)
1465 * Reject values below 1 for obvious reasons and values above
1466 * FD_SETSIZE/2 because Privoxy needs two sockets to serve
1467 * client connections that need forwarding.
1469 * We ignore the fact that the first three file descriptors
1470 * are usually set to /dev/null, one is used for logging
1471 * and yet another file descriptor is required to load
1474 if ((max_client_connections < 1) || (FD_SETSIZE/2 < max_client_connections))
1476 log_error(LOG_LEVEL_FATAL, "max-client-connections value %d"
1477 " is invalid. Value needs to be above 1 and below %d"
1478 " (FD_SETSIZE/2).", max_client_connections, FD_SETSIZE/2);
1482 * The Windows libc uses FD_SETSIZE for an array used
1483 * by select(), but has no problems with file descriptors
1484 * above the limit as long as no more than FD_SETSIZE are
1485 * passed to select().
1486 * https://msdn.microsoft.com/en-us/library/windows/desktop/ms739169%28v=vs.85%29.aspx
1488 * On platforms were we use poll() we don't have to enforce
1489 * an upper connection limit either.
1491 if (max_client_connections < 1)
1493 log_error(LOG_LEVEL_FATAL, "max-client-connections value"
1494 " has to be a number above 1. %d is invalid.",
1495 max_client_connections);
1498 config->max_client_connections = max_client_connections;
1502 /* *************************************************************************
1503 * permit-access source-ip[/significant-bits] [dest-ip[/significant-bits]]
1504 * *************************************************************************/
1506 case hash_permit_access:
1507 strlcpy(tmp, arg, sizeof(tmp));
1508 vec_count = ssplit(tmp, " \t", vec, SZ(vec));
1510 if ((vec_count != 1) && (vec_count != 2))
1512 log_error(LOG_LEVEL_ERROR, "Wrong number of parameters for "
1513 "permit-access directive in configuration file.");
1514 string_append(&config->proxy_args,
1515 "<br>\nWARNING: Wrong number of parameters for "
1516 "permit-access directive in configuration file.<br><br>\n");
1521 /* allocate a new node */
1522 cur_acl = zalloc_or_die(sizeof(*cur_acl));
1523 cur_acl->action = ACL_PERMIT;
1525 if (acl_addr(vec[0], cur_acl->src) < 0)
1527 log_error(LOG_LEVEL_ERROR, "Invalid source address, port or netmask "
1528 "for permit-access directive in configuration file: \"%s\"", vec[0]);
1529 string_append(&config->proxy_args,
1530 "<br>\nWARNING: Invalid source address, port or netmask for "
1531 "permit-access directive in configuration file: \"");
1532 string_append(&config->proxy_args,
1534 string_append(&config->proxy_args,
1541 if (acl_addr(vec[1], cur_acl->dst) < 0)
1543 log_error(LOG_LEVEL_ERROR, "Invalid destination address, port or netmask "
1544 "for permit-access directive in configuration file: \"%s\"", vec[1]);
1545 string_append(&config->proxy_args,
1546 "<br>\nWARNING: Invalid destination address, port or netmask for "
1547 "permit-access directive in configuration file: \"");
1548 string_append(&config->proxy_args,
1550 string_append(&config->proxy_args,
1559 cur_acl->wildcard_dst = 1;
1561 #endif /* def HAVE_RFC2553 */
1564 * Add it to the list. Note we reverse the list to get the
1565 * behaviour the user expects. With both the ACL and
1566 * actions file, the last match wins. However, the internal
1567 * implementations are different: The actions file is stored
1568 * in the same order as the file, and scanned completely.
1569 * With the ACL, we reverse the order as we load it, then
1570 * when we scan it we stop as soon as we get a match.
1572 cur_acl->next = config->acl;
1573 config->acl = cur_acl;
1576 #endif /* def FEATURE_ACL */
1578 /* *************************************************************************
1579 * proxy-info-url url
1580 * *************************************************************************/
1581 case hash_proxy_info_url :
1582 freez(config->proxy_info_url);
1583 config->proxy_info_url = strdup_or_die(arg);
1587 /* *************************************************************************
1588 * receive-buffer-size n
1589 * *************************************************************************/
1590 case hash_receive_buffer_size :
1591 config->receive_buffer_size = (size_t)parse_numeric_value(cmd, arg);
1592 if (config->receive_buffer_size < BUFFER_SIZE)
1594 log_error(LOG_LEVEL_INFO,
1595 "receive-buffer-size %lu seems low and may cause problems. "
1596 "Consider setting it to at least %d.",
1597 config->receive_buffer_size, BUFFER_SIZE);
1601 /* *************************************************************************
1602 * single-threaded 0|1
1603 * *************************************************************************/
1604 case hash_single_threaded :
1605 config->multi_threaded = 0 == parse_toggle_state(cmd, arg);
1608 /* *************************************************************************
1609 * socket-timeout numer_of_seconds
1610 * *************************************************************************/
1611 case hash_socket_timeout :
1613 int socket_timeout = parse_numeric_value(cmd, arg);
1614 if (0 <= socket_timeout)
1616 config->socket_timeout = socket_timeout;
1620 log_error(LOG_LEVEL_FATAL, "Invalid socket-timeout: '%s'", arg);
1625 /* *************************************************************************
1626 * split-large-cgi-forms
1627 * *************************************************************************/
1628 case hash_split_large_cgi_forms :
1629 if (parse_toggle_state(cmd, arg) == 1)
1631 config->feature_flags |= RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1635 config->feature_flags &= ~RUNTIME_FEATURE_SPLIT_LARGE_FORMS;
1639 /* *************************************************************************
1640 * templdir directory-name
1641 * *************************************************************************/
1642 case hash_templdir :
1643 freez(config->templdir);
1644 config->templdir = make_path(NULL, arg);
1647 #ifdef FEATURE_EXTERNAL_FILTERS
1648 /* *************************************************************************
1649 * temporary-directory directory-name
1650 * *************************************************************************/
1651 case hash_temporary_directory :
1652 freez(config->temporary_directory);
1653 config->temporary_directory = make_path(NULL, arg);
1657 /* *************************************************************************
1658 * tolerate-pipelining (0|1)
1659 * *************************************************************************/
1660 case hash_tolerate_pipelining :
1661 if (parse_toggle_state(cmd, arg) == 1)
1663 config->feature_flags |= RUNTIME_FEATURE_TOLERATE_PIPELINING;
1667 config->feature_flags &= ~RUNTIME_FEATURE_TOLERATE_PIPELINING;
1671 /* *************************************************************************
1673 * *************************************************************************/
1674 #ifdef FEATURE_TOGGLE
1676 global_toggle_state = parse_toggle_state(cmd, arg);
1678 #endif /* def FEATURE_TOGGLE */
1680 /* *************************************************************************
1681 * trust-info-url url
1682 * *************************************************************************/
1683 #ifdef FEATURE_TRUST
1684 case hash_trust_info_url :
1685 enlist(config->trust_info, arg);
1687 #endif /* def FEATURE_TRUST */
1689 /* *************************************************************************
1690 * trust-x-forwarded-for (0|1)
1691 * *************************************************************************/
1692 case hash_trust_x_forwarded_for :
1693 config->trust_x_forwarded_for = parse_toggle_state(cmd, arg);
1696 /* *************************************************************************
1697 * trusted-cgi-referrer http://www.example.org/some/path.html
1698 * *************************************************************************/
1699 case hash_trusted_cgi_referrer :
1701 * We don't validate the specified referrer as
1702 * it's only used for string comparison.
1704 freez(config->trusted_cgi_referrer);
1705 config->trusted_cgi_referrer = strdup_or_die(arg);
1708 /* *************************************************************************
1709 * trustfile filename
1710 * (In confdir by default.)
1711 * *************************************************************************/
1712 #ifdef FEATURE_TRUST
1713 case hash_trustfile :
1714 freez(config->trustfile);
1715 config->trustfile = make_path(config->confdir, arg);
1717 #endif /* def FEATURE_TRUST */
1719 /* *************************************************************************
1721 * *************************************************************************/
1722 case hash_usermanual :
1724 * XXX: If this isn't the first config directive, the
1725 * show-status page links to the website documentation
1726 * for the directives that were already parsed. Lame.
1728 freez(config->usermanual);
1729 config->usermanual = strdup_or_die(arg);
1732 #ifdef FEATURE_HTTPS_INSPECTION
1733 /* *************************************************************************
1734 * ca private key file password
1735 * *************************************************************************/
1736 case hash_ca_password:
1737 freez(config->ca_password);
1738 config->ca_password = strdup(arg);
1741 /* *************************************************************************
1742 * ca-directory directory
1743 * *************************************************************************/
1744 case hash_ca_directory:
1745 freez(ca_directory);
1746 ca_directory = make_path(NULL, arg);
1748 if (NULL == ca_directory)
1750 log_error(LOG_LEVEL_FATAL, "Out of memory while creating ca dir path");
1755 /* *************************************************************************
1756 * ca cert file ca-cert-file
1757 * In ca dir by default
1758 * *************************************************************************/
1759 case hash_ca_cert_file:
1760 freez(ca_cert_file);
1761 ca_cert_file = make_path(config->ca_directory, arg);
1763 if (NULL == ca_cert_file)
1765 log_error(LOG_LEVEL_FATAL, "Out of memory while creating ca certificate file path");
1770 /* *************************************************************************
1771 * ca key file ca-key-file
1772 * In ca dir by default
1773 * *************************************************************************/
1774 case hash_ca_key_file:
1776 ca_key_file = make_path(config->ca_directory, arg);
1778 if (NULL == ca_key_file)
1780 log_error(LOG_LEVEL_FATAL, "Out of memory while creating ca key file path");
1785 /* *************************************************************************
1786 * certificate-directory directory
1787 * *************************************************************************/
1788 case hash_certificate_directory:
1789 freez(certificate_directory);
1790 certificate_directory = make_path(NULL, arg);
1792 if (NULL == certificate_directory)
1794 log_error(LOG_LEVEL_FATAL,
1795 "Out of memory while creating certificate directory path");
1800 /* *************************************************************************
1801 * cipher-list list-of-ciphers
1802 * *************************************************************************/
1803 case hash_cipher_list:
1804 freez(config->cipher_list);
1805 config->cipher_list = strdup_or_die(arg);
1809 /* *************************************************************************
1810 * trusted CAs file name trusted-cas-file
1811 * *************************************************************************/
1812 case hash_trusted_cas_file:
1813 freez(trusted_cas_file);
1814 trusted_cas_file = make_path(config->ca_directory, arg);
1816 if (NULL == trusted_cas_file)
1818 log_error(LOG_LEVEL_FATAL, "Out of memory while creating trusted CAs file path");
1824 /* *************************************************************************
1825 * Win32 Console options:
1826 * *************************************************************************/
1828 /* *************************************************************************
1830 * *************************************************************************/
1832 case hash_hide_console :
1835 #endif /*def _WIN_CONSOLE*/
1838 /* *************************************************************************
1839 * Win32 GUI options:
1840 * *************************************************************************/
1842 #if defined(_WIN32) && ! defined(_WIN_CONSOLE)
1843 /* *************************************************************************
1844 * activity-animation (0|1)
1845 * *************************************************************************/
1846 case hash_activity_animation :
1847 g_bShowActivityAnimation = parse_toggle_state(cmd, arg);
1850 /* *************************************************************************
1851 * close-button-minimizes (0|1)
1852 * *************************************************************************/
1853 case hash_close_button_minimizes :
1854 g_bCloseHidesWindow = parse_toggle_state(cmd, arg);
1857 /* *************************************************************************
1858 * log-buffer-size (0|1)
1859 * *************************************************************************/
1860 case hash_log_buffer_size :
1861 g_bLimitBufferSize = parse_toggle_state(cmd, arg);
1864 /* *************************************************************************
1865 * log-font-name fontname
1866 * *************************************************************************/
1867 case hash_log_font_name :
1868 if (strlcpy(g_szFontFaceName, arg,
1869 sizeof(g_szFontFaceName)) >= sizeof(g_szFontFaceName))
1871 log_error(LOG_LEVEL_FATAL,
1872 "log-font-name argument '%s' is longer than %u characters.",
1873 arg, sizeof(g_szFontFaceName)-1);
1877 /* *************************************************************************
1879 * *************************************************************************/
1880 case hash_log_font_size :
1881 g_nFontSize = parse_numeric_value(cmd, arg);
1884 /* *************************************************************************
1885 * log-highlight-messages (0|1)
1886 * *************************************************************************/
1887 case hash_log_highlight_messages :
1888 g_bHighlightMessages = parse_toggle_state(cmd, arg);
1891 /* *************************************************************************
1893 * *************************************************************************/
1894 case hash_log_max_lines :
1895 g_nMaxBufferLines = parse_numeric_value(cmd, arg);
1898 /* *************************************************************************
1899 * log-messages (0|1)
1900 * *************************************************************************/
1901 case hash_log_messages :
1902 g_bLogMessages = parse_toggle_state(cmd, arg);
1905 /* *************************************************************************
1906 * show-on-task-bar (0|1)
1907 * *************************************************************************/
1908 case hash_show_on_task_bar :
1909 g_bShowOnTaskBar = parse_toggle_state(cmd, arg);
1912 #endif /* defined(_WIN32) && ! defined(_WIN_CONSOLE) */
1915 /* *************************************************************************
1916 * Warnings about unsupported features
1917 * *************************************************************************/
1919 case hash_deny_access:
1920 #endif /* ndef FEATURE_ACL */
1921 #ifndef FEATURE_CGI_EDIT_ACTIONS
1922 case hash_enable_edit_actions:
1923 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1924 #ifndef FEATURE_TOGGLE
1925 case hash_enable_remote_toggle:
1926 #endif /* ndef FEATURE_TOGGLE */
1928 case hash_permit_access:
1929 #endif /* ndef FEATURE_ACL */
1930 #ifndef FEATURE_TOGGLE
1932 #endif /* ndef FEATURE_TOGGLE */
1933 #ifndef FEATURE_TRUST
1934 case hash_trustfile :
1935 case hash_trust_info_url :
1936 #endif /* ndef FEATURE_TRUST */
1938 #ifndef _WIN_CONSOLE
1939 case hash_hide_console :
1940 #endif /* ndef _WIN_CONSOLE */
1942 #if defined(_WIN_CONSOLE) || ! defined(_WIN32)
1943 case hash_activity_animation :
1944 case hash_close_button_minimizes :
1945 case hash_log_buffer_size :
1946 case hash_log_font_name :
1947 case hash_log_font_size :
1948 case hash_log_highlight_messages :
1949 case hash_log_max_lines :
1950 case hash_log_messages :
1951 case hash_show_on_task_bar :
1952 #endif /* defined(_WIN_CONSOLE) || ! defined(_WIN32) */
1953 /* These warnings are annoying - so hide them. -- Jon */
1954 /* log_error(LOG_LEVEL_INFO, "Unsupported directive \"%s\" ignored.", cmd); */
1957 /* *************************************************************************/
1959 /* *************************************************************************/
1961 * I decided that I liked this better as a warning than an
1962 * error. To change back to an error, just change log level
1963 * to LOG_LEVEL_FATAL.
1965 log_error(LOG_LEVEL_ERROR, "Ignoring unrecognized directive "
1966 "'%s' (%uU) in line %lu in configuration file (%s).",
1967 buf, directive_hash, linenum, configfile);
1968 string_append(&config->proxy_args,
1969 " <strong class='warning'>Warning: Ignoring unrecognized directive:</strong>");
1972 /* *************************************************************************/
1973 } /* end switch(hash_string(cmd)) */
1975 /* Save the argument for the show-status page. */
1976 savearg(cmd, arg, config);
1978 } /* end while (read_config_line(...)) */
1982 set_debug_level(config->debug);
1984 freez(config->logfile);
1988 if (NULL != logfile)
1990 config->logfile = logfile;
1991 init_error_log(Argv[0], config->logfile);
1999 #ifdef FEATURE_HTTPS_INSPECTION
2001 * Setting SSL parameters from loaded values into structures
2003 freez(config->ca_directory);
2004 config->ca_directory = make_path(NULL, ca_directory);
2005 freez(ca_directory);
2007 freez(config->ca_cert_file);
2008 config->ca_cert_file = make_path(config->ca_directory, ca_cert_file);
2009 freez(ca_cert_file);
2011 freez(config->ca_key_file);
2012 config->ca_key_file = make_path(config->ca_directory, ca_key_file);
2015 freez(config->trusted_cas_file);
2016 config->trusted_cas_file = make_path(config->ca_directory, trusted_cas_file);
2017 freez(trusted_cas_file);
2019 freez(config->certificate_directory);
2020 config->certificate_directory = make_path(NULL, certificate_directory);
2021 freez(certificate_directory);
2023 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2024 if (config->default_server_timeout > config->keep_alive_timeout)
2026 log_error(LOG_LEVEL_ERROR,
2027 "Reducing the default-server-timeout from %d to the keep-alive-timeout %d.",
2028 config->default_server_timeout, config->keep_alive_timeout);
2029 config->default_server_timeout = config->keep_alive_timeout;
2031 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2033 #ifdef FEATURE_CONNECTION_SHARING
2034 if (config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2036 if (!config->multi_threaded)
2039 * While we could use keep-alive without multiple threads
2040 * if we didn't bother with enforcing the connection timeout,
2041 * that might make Tor users sad, even though they shouldn't
2042 * enable the single-threaded option anyway.
2044 * XXX: We could still use Proxy-Connection: keep-alive.
2046 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
2047 log_error(LOG_LEVEL_ERROR,
2048 "Config option single-threaded disables connection keep-alive.");
2051 else if ((config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING))
2053 log_error(LOG_LEVEL_ERROR, "Config option connection-sharing "
2054 "has no effect if keep-alive-timeout isn't set.");
2055 config->feature_flags &= ~RUNTIME_FEATURE_CONNECTION_SHARING;
2057 #endif /* def FEATURE_CONNECTION_SHARING */
2059 if (NULL == config->proxy_args)
2061 log_error(LOG_LEVEL_FATAL, "Out of memory loading config - insufficient memory for config->proxy_args");
2064 if (config->re_filterfile[0])
2066 add_loader(load_re_filterfiles, config);
2069 if (config->actions_file[0])
2071 add_loader(load_action_files, config);
2074 #ifdef FEATURE_TRUST
2075 if (config->trustfile)
2077 add_loader(load_trustfile, config);
2079 #endif /* def FEATURE_TRUST */
2081 if (NULL == config->haddr[0])
2083 config->haddr[0] = strdup_or_die(HADDR_DEFAULT);
2086 for (i = 0; i < MAX_LISTENING_SOCKETS && NULL != config->haddr[i]; i++)
2088 if ((*config->haddr[i] == '[')
2089 && (NULL != (p = strchr(config->haddr[i], ']')))
2091 && (0 < (config->hport[i] = atoi(p + 2))))
2094 memmove((void *)config->haddr[i], config->haddr[i] + 1,
2095 (size_t)(p - config->haddr[i]));
2097 else if (NULL != (p = strchr(config->haddr[i], ':'))
2098 && (0 < (config->hport[i] = atoi(p + 1))))
2104 log_error(LOG_LEVEL_FATAL, "invalid bind port spec %s", config->haddr[i]);
2105 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2107 if (*config->haddr[i] == '\0')
2110 * Only the port specified. We stored it in config->hport[i]
2111 * and don't need its text representation anymore.
2112 * Use config->hport[i] == 0 to iterate listening addresses since
2115 freez(config->haddr[i]);
2120 * Want to run all the loaders once now.
2122 * Need to set up a fake csp, so they can get to the config.
2124 fake_csp = zalloc_or_die(sizeof(*fake_csp));
2125 fake_csp->config = config;
2127 if (run_loader(fake_csp))
2130 log_error(LOG_LEVEL_FATAL, "A loader failed while loading config file. Exiting.");
2131 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2135 /* FIXME: this is a kludge for win32 */
2136 #if defined(_WIN32) && !defined (_WIN_CONSOLE)
2138 g_default_actions_file = config->actions_file[1]; /* FIXME Hope this is default.action */
2139 g_user_actions_file = config->actions_file[2]; /* FIXME Hope this is user.action */
2140 g_default_filterfile = config->re_filterfile[0]; /* FIXME Hope this is default.filter */
2141 g_user_filterfile = config->re_filterfile[1]; /* FIXME Hope this is user.filter */
2143 #ifdef FEATURE_TRUST
2144 g_trustfile = config->trustfile;
2145 #endif /* def FEATURE_TRUST */
2148 #endif /* defined(_WIN32) && !defined (_WIN_CONSOLE) */
2149 /* FIXME: end kludge */
2152 if (current_configfile == NULL)
2154 config->need_bind = 1;
2158 struct configuration_spec * oldcfg = (struct configuration_spec *)
2159 current_configfile->f;
2161 * Check if config->haddr[i],hport[i] == oldcfg->haddr[i],hport[i]
2163 config->need_bind = 0;
2165 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
2167 if (config->hport[i] != oldcfg->hport[i])
2169 config->need_bind = 1;
2171 else if (config->haddr[i] == NULL)
2173 if (oldcfg->haddr[i] != NULL)
2175 config->need_bind = 1;
2178 else if (oldcfg->haddr[i] == NULL)
2180 config->need_bind = 1;
2182 else if (0 != strcmp(config->haddr[i], oldcfg->haddr[i]))
2184 config->need_bind = 1;
2188 current_configfile->unloader = unload_configfile;
2191 fs->next = files->next;
2194 current_configfile = fs;
2200 /*********************************************************************
2202 * Function : savearg
2204 * Description : Called from `load_config'. It saves each non-empty
2205 * and non-comment line from config into
2206 * config->proxy_args. This is used to create the
2207 * show-status page. On error, frees
2208 * config->proxy_args and sets it to NULL
2211 * 1 : command = config setting that was found
2212 * 2 : argument = the setting's argument (if any)
2213 * 3 : config = Configuration to save into.
2217 *********************************************************************/
2218 static void savearg(char *command, char *argument, struct configuration_spec * config)
2227 * Add config option name embedded in
2228 * link to its section in the user-manual
2230 buf = strdup_or_die("\n<a href=\"");
2231 if (!strncmpic(config->usermanual, "file://", 7) ||
2232 !strncmpic(config->usermanual, "http", 4))
2234 string_append(&buf, config->usermanual);
2238 string_append(&buf, "http://" CGI_SITE_2_HOST "/user-manual/");
2240 string_append(&buf, CONFIG_HELP_PREFIX);
2241 string_join (&buf, string_toupper(command));
2242 string_append(&buf, "\">");
2243 string_append(&buf, command);
2244 string_append(&buf, "</a> ");
2248 freez(config->proxy_args);
2252 if ((NULL != argument) && ('\0' != *argument))
2254 s = html_encode(argument);
2258 freez(config->proxy_args);
2262 if (strncmpic(argument, "http://", 7) == 0)
2264 string_append(&buf, "<a href=\"");
2265 string_append(&buf, s);
2266 string_append(&buf, "\">");
2267 string_join (&buf, s);
2268 string_append(&buf, "</a>");
2272 string_join (&buf, s);
2276 string_append(&buf, "<br>");
2277 string_join(&config->proxy_args, buf);