1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.91 2007/03/05 13:28:03 fabiankeil Exp $"
5 /*********************************************************************
7 * File : $Source: /cvsroot/ijbswa/current/project.h,v $
9 * Purpose : Defines data structures which are widely used in the
10 * project. Does not define any variables or functions
11 * (though it does declare some macros).
13 * Copyright : Written by and Copyright (C) 2001 - 2007 the SourceForge
14 * Privoxy team. http://www.privoxy.org/
16 * Based on the Internet Junkbuster originally written
17 * by and Copyright (C) 1997 Anonymous Coders and
18 * Junkbusters Corporation. http://www.junkbusters.com
20 * This program is free software; you can redistribute it
21 * and/or modify it under the terms of the GNU General
22 * Public License as published by the Free Software
23 * Foundation; either version 2 of the License, or (at
24 * your option) any later version.
26 * This program is distributed in the hope that it will
27 * be useful, but WITHOUT ANY WARRANTY; without even the
28 * implied warranty of MERCHANTABILITY or FITNESS FOR A
29 * PARTICULAR PURPOSE. See the GNU General Public
30 * License for more details.
32 * The GNU General Public License should be included with
33 * this file. If not, you can view it at
34 * http://www.gnu.org/copyleft/gpl.html
35 * or write to the Free Software Foundation, Inc., 59
36 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
40 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
41 * Add some CSP_FLAGs for the header parsers.
43 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
44 * Add new http_response member to save
45 * the reason why the response was generated.
47 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
48 * Add new config option "templdir" to
49 * change the templates directory.
51 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
52 * Add csp->error_message for failure reasons
53 * that should be embedded into the CGI pages.
55 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
56 * Integrate a modified version of Wil Mahan's
57 * zlib patch (PR #895531).
59 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
60 * Added config option accept-intercepted-requests
61 * and disabled it by default.
63 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
64 * Fix gcc43 compiler warnings and a comment.
66 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
67 * Add config option "split-large-forms"
68 * to work around the browser bug reported
71 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
72 * Moved HTTP snipplets into jcc.c. They aren't
75 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
76 * Doubled size of HOSTENT_BUFFER_SIZE to mask
77 * problems with gethostbyname_r and some
78 * /etc/hosts configurations. Only a workaround
79 * until we get the real fix ready.
80 * Thanks FĂ©lix Rauch for reporting.
82 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
84 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
85 * Respond with 400 and a short text message
86 * if the client tries to use Privoxy as FTP proxy.
88 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
89 * Added config option enable-remote-http-toggle
90 * to specify if Privoxy should recognize special
91 * headers (currently only X-Filter) to change its
92 * behaviour. Disabled by default.
94 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
95 * Make number of retries in case of forwarded-connect problems
96 * a config file option (forwarded-connect-retries) and use 0 as
99 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
100 * Work around a buffer overflow that caused Privoxy to
101 * segfault if too many trusted referrers were used. Good
102 * enough for now, but should be replaced with a real
103 * solution after the next release.
105 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
108 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
109 * Split filter-headers{} into filter-client-headers{}
110 * and filter-server-headers{}.
111 * Added parse_header_time() to share some code.
112 * Replaced timegm() with mktime().
114 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
115 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
117 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
118 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
119 * with what was really the latest development (the v_3_0_branch branch)
121 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
122 * Multiple filter file support
124 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
125 * Add the ability to check jpeg images for invalid
126 * lengths of comment blocks. Defensive strategy
127 * against the exploit:
128 * Microsoft Security Bulletin MS04-028
129 * Buffer Overrun in JPEG Processing (GDI+) Could
130 * Allow Code Execution (833987)
131 * Enabled with +inspect-jpegs in actions files.
133 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
134 * Updated the copyright note
136 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
137 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
139 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
140 * Introduced RC_FLAG_* flags for use in child process return code
142 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
143 * Added flag to each cgi_dispatcher that allows or denies
144 * external linking and removed const qualifier from
145 * struct list_entry.str.
147 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
148 * - Include config.h for access to config data
149 * - Include <pcre*.h> depending on where they are
151 * Revision 1.72 2002/05/14 21:35:49 oes
152 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
153 * because of split in user-manual
155 * Revision 1.71 2002/05/12 21:39:36 jongfoster
156 * - Adding Doxygen-style comments to structures and #defines.
158 * Revision 1.70 2002/05/12 16:05:50 jongfoster
159 * Fixing ACTION_MASK_ALL to be unsigned long rather than
160 * just unsigned int. I don't know if anyone is porting
161 * Privoxy to 16-bit platforms, but if so, +limit-connect
162 * wouldn't have worked because of this bug.
164 * Revision 1.69 2002/05/08 16:00:16 oes
165 * Added size member to struct iob, so it can
166 * be alloced larger than needed.
168 * Revision 1.68 2002/04/26 12:56:00 oes
169 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
171 * Revision 1.67 2002/04/24 02:12:43 oes
172 * - Jon's multiple AF patch:
173 * - Make csp->actions_list an array
174 * - #define MAX_AF_FILES
175 * - Moved CGI_PARAM_LEN_MAX (500) here
177 * Revision 1.66 2002/04/15 19:06:43 jongfoster
180 * Revision 1.65 2002/04/04 00:36:36 gliptak
181 * always use pcre for matching
183 * Revision 1.64 2002/04/03 22:28:03 gliptak
184 * Removed references to gnu_regex
186 * Revision 1.63 2002/03/31 17:19:00 jongfoster
187 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
189 * Revision 1.62 2002/03/26 22:48:49 swa
192 * Revision 1.61 2002/03/26 22:29:55 swa
193 * we have a new homepage!
195 * Revision 1.60 2002/03/24 15:52:17 jongfoster
196 * Changing CGI URL prefixes for new name
198 * Revision 1.59 2002/03/24 15:23:33 jongfoster
201 * Revision 1.58 2002/03/24 13:25:43 swa
202 * name change related issues
204 * Revision 1.57 2002/03/16 20:28:34 oes
205 * Added descriptions to the filters so users will know what they select in the cgi editor
207 * Revision 1.56 2002/03/13 20:27:30 oes
208 * Fixing bug with CT_TABOO
210 * Revision 1.55 2002/03/12 01:42:50 oes
211 * Introduced modular filters
213 * Revision 1.54 2002/03/09 20:03:52 jongfoster
214 * - Making various functions return int rather than size_t.
215 * (Undoing a recent change). Since size_t is unsigned on
216 * Windows, functions like read_socket that return -1 on
217 * error cannot return a size_t.
219 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
220 * crashes, and also frequently caused JB to jump to 100%
221 * CPU and stay there. (Because it thought it had just
222 * read ((unsigned)-1) == 4Gb of data...)
224 * - The signature of write_socket has changed, it now simply
225 * returns success=0/failure=nonzero.
227 * - Trying to get rid of a few warnings --with-debug on
228 * Windows, I've introduced a new type "jb_socket". This is
229 * used for the socket file descriptors. On Windows, this
230 * is SOCKET (a typedef for unsigned). Everywhere else, it's
231 * an int. The error value can't be -1 any more, so it's
232 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
233 * Windows it maps to the #define INVALID_SOCKET.)
235 * - The signature of bind_port has changed.
237 * Revision 1.53 2002/03/08 16:48:55 oes
238 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
240 * Revision 1.52 2002/03/07 03:46:17 oes
241 * Fixed compiler warnings
243 * Revision 1.51 2002/03/05 04:52:42 oes
244 * Deleted non-errlog debugging code
246 * Revision 1.50 2002/03/04 19:32:07 oes
247 * Changed default port to 8118
249 * Revision 1.49 2002/03/04 18:28:55 oes
250 * Deleted PID_FILE_NAME
252 * Revision 1.48 2002/03/03 14:50:40 oes
253 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
255 * Revision 1.47 2002/02/20 23:15:13 jongfoster
256 * Parsing functions now handle out-of-memory gracefully by returning
259 * Revision 1.46 2002/01/17 21:06:09 jongfoster
260 * Now #defining the URLs of the config interface
262 * Minor changes to struct http_request and struct url_spec due to
263 * standardizing that struct http_request is used to represent a URL, and
264 * struct url_spec is used to represent a URL pattern. (Before, URLs were
265 * represented as seperate variables and a partially-filled-in url_spec).
267 * Revision 1.45 2002/01/09 14:33:27 oes
268 * Added HOSTENT_BUFFER_SIZE
270 * Revision 1.44 2001/12/30 14:07:32 steudten
271 * - Add signal handling (unix)
272 * - Add SIGHUP handler (unix)
273 * - Add creation of pidfile (unix)
274 * - Add action 'top' in rc file (RH)
275 * - Add entry 'SIGNALS' to manpage
276 * - Add exit message to logfile (unix)
278 * Revision 1.43 2001/11/22 21:57:51 jongfoster
279 * Making action_spec->flags into an unsigned long rather than just an
281 * Adding ACTION_NO_COOKIE_KEEP
283 * Revision 1.42 2001/11/05 21:42:41 steudten
284 * Include DBG() macro.
286 * Revision 1.41 2001/10/28 19:12:06 jongfoster
287 * Adding ijb_toupper()
289 * Revision 1.40 2001/10/26 17:40:47 oes
290 * Moved ijb_isspace and ijb_tolower to project.h
291 * Removed http->user_agent, csp->referrer and csp->accept_types
293 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
294 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
295 * macro when called with a cast; so moving the cast to the macro def'n
296 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
297 * doesn't make macro expansion complain. Hope this works for everyone else
300 * Revision 1.38 2001/10/23 21:19:04 jongfoster
301 * New error-handling support: jb_err type and JB_ERR_xxx constants
302 * CGI functions now return a jb_err, and their parameters map is const.
303 * Support for RUNTIME_FEATUREs to enable/disable config editor
304 * Adding a few comments
306 * Revision 1.37 2001/10/14 22:14:01 jongfoster
307 * Removing name_length field from struct cgi_dispatcher, as this is
308 * now calculated at runtime from the "name" field.
310 * Revision 1.36 2001/10/10 16:45:15 oes
311 * Added LIMIT_CONNECT action and string
312 * Fixed HTTP message line termination
313 * Added CFORBIDDEN HTTP message
315 * Revision 1.35 2001/10/07 18:06:43 oes
316 * Added status member to struct http_request
318 * Revision 1.34 2001/10/07 15:45:25 oes
319 * Added url member to struct http_request and commented all
324 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
326 * Replaced struct client_state members rejected,
327 * force, active and toggled_on with "flags" bitmap.
329 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
331 * Added buffer_limit to struct configuration_spec
333 * Revision 1.33 2001/09/20 13:30:08 steudten
335 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
336 * Last case will set z to NULL in free(z) and thats bad..
338 * Revision 1.32 2001/09/16 23:02:51 jongfoster
341 * Revision 1.31 2001/09/16 13:20:29 jongfoster
342 * Rewrite of list library. Now has seperate header and list_entry
343 * structures. Also added a large sprinking of assert()s to the list
346 * Revision 1.30 2001/09/13 23:52:00 jongfoster
347 * Support for both static and dynamically generated CGI pages
349 * Revision 1.29 2001/09/13 23:29:43 jongfoster
350 * Defining FORWARD_SPEC_INITIALIZER
352 * Revision 1.28 2001/09/13 23:05:50 jongfoster
353 * Changing the string paramater to the header parsers a "const".
355 * Revision 1.27 2001/08/05 16:06:20 jongfoster
356 * Modifiying "struct map" so that there are now separate header and
357 * "map_entry" structures. This means that functions which modify a
358 * map no longer need to return a pointer to the modified map.
359 * Also, it no longer reverses the order of the entries (which may be
360 * important with some advanced template substitutions).
362 * Revision 1.26 2001/07/30 22:08:36 jongfoster
363 * Tidying up #defines:
364 * - All feature #defines are now of the form FEATURE_xxx
365 * - Permanently turned off WIN_GUI_EDIT
366 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
368 * Revision 1.25 2001/07/29 18:43:08 jongfoster
369 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
372 * Revision 1.24 2001/07/25 17:20:27 oes
373 * Introduced http->user_agent
375 * Revision 1.23 2001/07/18 12:32:23 oes
376 * - Added ACTION_STRING_DEANIMATE
377 * - moved #define freez from jcc.h to project.h
379 * Revision 1.22 2001/07/15 17:51:41 jongfoster
380 * Renaming #define STATIC to STATIC_PCRE
382 * Revision 1.21 2001/07/13 14:03:19 oes
383 * - Reorganized regex header inclusion and #defines to
384 * comply to the scheme in configure.in
385 * - Added csp->content_type and its CT_* keys
386 * - Added ACTION_DEANIMATE
387 * - Removed all #ifdef PCRS
389 * Revision 1.20 2001/06/29 21:45:41 oes
390 * Indentation, CRLF->LF, Tab-> Space
392 * Revision 1.19 2001/06/29 13:33:36 oes
393 * - Improved comments
394 * - Introduced http_request.host_ip_addr_str
395 * - Introduced http_response.head_length
396 * - Introduced config.my_ip_addr_str, config.my_hostname,
397 * config.admin_address and config.proxy_info_url
398 * - Removed config.proxy_args_header and config.proxy_args_trailer,
399 * renamed config.proxy_args_invocation to config.proxy_args
400 * - Removed HTML snipplets and GIFs
401 * - Removed logentry from cancelled commit
403 * Revision 1.18 2001/06/09 10:57:39 jongfoster
404 * Adding definition of BUFFER_SIZE.
405 * Changing struct cgi_dispatcher to use "const" strings.
407 * Revision 1.17 2001/06/07 23:15:09 jongfoster
408 * Merging ACL and forward files into config file.
409 * Moving struct gateway members into struct forward_spec
410 * Removing config->proxy_args_gateways
411 * Cosmetic: Adding a few comments
413 * Revision 1.16 2001/06/04 18:31:58 swa
414 * files are now prefixed with either `confdir' or `logdir'.
415 * `make redhat-dist' replaces both entries confdir and logdir
418 * Revision 1.15 2001/06/04 11:28:53 swa
419 * redirect did not work due to missing /
421 * Revision 1.14 2001/06/03 11:03:48 oes
423 * added struct http_response,
424 * changed struct interceptors to struct cgi_dispatcher,
425 * moved HTML stuff to cgi.h
427 * Revision 1.13 2001/06/01 20:05:36 jongfoster
428 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
429 * constant, and removed csp->tinygif.
431 * Revision 1.12 2001/06/01 18:49:17 jongfoster
432 * Replaced "list_share" with "list" - the tiny memory gain was not
433 * worth the extra complexity.
435 * Revision 1.11 2001/06/01 10:32:47 oes
436 * Added constants for anchoring selection bitmap
438 * Revision 1.10 2001/05/31 21:33:53 jongfoster
439 * Changes for new actions file, replacing permissionsfile
440 * and parts of the config file. Also added support for
443 * Revision 1.9 2001/05/31 17:32:31 oes
445 * - Enhanced domain part globbing with infix and prefix asterisk
446 * matching and optional unanchored operation
448 * Revision 1.8 2001/05/29 20:09:15 joergs
449 * HTTP_REDIRECT_TEMPLATE fixed.
451 * Revision 1.7 2001/05/29 09:50:24 jongfoster
452 * Unified blocklist/imagelist/actionslist.
453 * File format is still under discussion, but the internal changes
456 * Also modified interceptor behaviour:
457 * - We now intercept all URLs beginning with one of the following
458 * prefixes (and *only* these prefixes):
460 * * http://ijbswa.sf.net/config/
461 * * http://ijbswa.sourceforge.net/config/
462 * - New interceptors "home page" - go to http://i.j.b/ to see it.
463 * - Internal changes so that intercepted and fast redirect pages
464 * are not replaced with an image.
465 * - Interceptors now have the option to send a binary page direct
466 * to the client. (i.e. ijb-send-banner uses this)
467 * - Implemented show-url-info interceptor. (Which is why I needed
468 * the above interceptors changes - a typical URL is
469 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
470 * The previous mechanism would not have intercepted that, and
471 * if it had been intercepted then it then it would have replaced
474 * Revision 1.6 2001/05/27 22:17:04 oes
476 * - re_process_buffer no longer writes the modified buffer
477 * to the client, which was very ugly. It now returns the
478 * buffer, which it is then written by chat.
480 * - content_length now adjusts the Content-Length: header
481 * for modified documents rather than crunch()ing it.
482 * (Length info in csp->content_length, which is 0 for
483 * unmodified documents)
485 * - For this to work, sed() is called twice when filtering.
487 * Revision 1.5 2001/05/26 00:28:36 jongfoster
488 * Automatic reloading of config file.
489 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
490 * Most of the global variables have been moved to a new
491 * struct configuration_spec, accessed through csp->config->globalname
492 * Most of the globals remaining are used by the Win32 GUI.
494 * Revision 1.4 2001/05/22 18:46:04 oes
496 * - Enabled filtering banners by size rather than URL
497 * by adding patterns that replace all standard banner
498 * sizes with the "Junkbuster" gif to the re_filterfile
500 * - Enabled filtering WebBugs by providing a pattern
501 * which kills all 1x1 images
503 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
504 * which is selected by the (nonstandard and therefore
505 * capital) letter 'U' in the option string.
506 * It causes the quantifiers to be ungreedy by default.
507 * Appending a ? turns back to greedy (!).
509 * - Added a new interceptor ijb-send-banner, which
510 * sends back the "Junkbuster" gif. Without imagelist or
511 * MSIE detection support, or if tinygif = 1, or the
512 * URL isn't recognized as an imageurl, a lame HTML
513 * explanation is sent instead.
515 * - Added new feature, which permits blocking remote
516 * script redirects and firing back a local redirect
518 * The feature is conditionally compiled, i.e. it
519 * can be disabled with --disable-fast-redirects,
520 * plus it must be activated by a "fast-redirects"
521 * line in the config file, has its own log level
522 * and of course wants to be displayed by show-proxy-args
523 * Note: Boy, all the #ifdefs in 1001 locations and
524 * all the fumbling with configure.in and acconfig.h
525 * were *way* more work than the feature itself :-(
527 * - Because a generic redirect template was needed for
528 * this, tinygif = 3 now uses the same.
530 * - Moved GIFs, and other static HTTP response templates
535 * - Removed some >400 CRs again (Jon, you really worked
538 * Revision 1.3 2001/05/20 01:21:20 jongfoster
539 * Version 2.9.4 checkin.
540 * - Merged popupfile and cookiefile, and added control over PCRS
541 * filtering, in new "actionsfile".
542 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
543 * file error you now get a message box (in the Win32 GUI) rather
544 * than the program exiting with no explanation.
545 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
547 * - Removed tabs from "config"
548 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
549 * - Bumped up version number.
551 * Revision 1.2 2001/05/17 23:01:01 oes
552 * - Cleaned CRLF's from the sources and related files
554 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
555 * Initial import of version 2.9.3 source tree
558 *********************************************************************/
561 /* Declare struct FILE for vars and funcs. */
564 /* Need time_t for file_list */
566 /* Needed for pcre choice */
570 * Include appropriate regular expression libraries.
571 * Note that pcrs and pcre (native) are needed for cgi
572 * and are included anyway.
578 # ifdef PCRE_H_IN_SUBDIR
579 # include <pcre/pcre.h>
592 # include "pcreposix.h"
594 # ifdef PCRE_H_IN_SUBDIR
595 # include <pcre/pcreposix.h>
597 # include <pcreposix.h>
603 #endif /* def AMIGA */
607 * I don't want to have to #include all this just for the declaration
608 * of SOCKET. However, it looks like we have to...
623 typedef SOCKET jb_socket;
625 #define JB_INVALID_SOCKET INVALID_SOCKET
627 #else /* ndef _WIN32 */
630 * The type used by sockets. On UNIX it's an int. Microsoft decided to
631 * make it an unsigned.
633 typedef int jb_socket;
636 * The error value used for variables of type jb_socket. On UNIX this
637 * is -1, however Microsoft decided to make socket handles unsigned, so
638 * they use a different value.
641 #define JB_INVALID_SOCKET (-1)
643 #endif /* ndef _WIN32 */
647 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
652 #define JB_ERR_OK 0 /**< Success, no error */
653 #define JB_ERR_MEMORY 1 /**< Out of memory */
654 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
655 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
656 #define JB_ERR_PARSE 4 /**< Error parsing file */
657 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
658 CGI actions editor. */
659 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
662 * This macro is used to free a pointer that may be NULL.
663 * It also sets the variable to NULL after it's been freed.
664 * The paramater should be a simple variable without side effects.
666 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
670 * Fix a problem with Solaris. There should be no effect on other
673 * Solaris's isspace() is a macro which uses it's argument directly
674 * as an array index. Therefore we need to make sure that high-bit
675 * characters generate +ve values, and ideally we also want to make
676 * the argument match the declared parameter type of "int".
678 * Note: Remember to #include <ctype.h> if you use these macros.
680 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
681 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
682 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
685 * Use for statically allocated buffers if you have no other choice.
686 * Remember to check the length of what you write into the buffer
687 * - we don't want any buffer overflows!
689 #define BUFFER_SIZE 5000
692 * Max length of CGI parameters (arbitrary limit).
694 #define CGI_PARAM_LEN_MAX 500
697 * Buffer size for capturing struct hostent data in the
698 * gethostby(name|addr)_r library calls. Since we don't
699 * loop over gethostbyname_r, the buffer must be sufficient
700 * to accomodate multiple IN A RRs, as used in DNS round robin
701 * load balancing. W3C's wwwlib uses 1K, so that should be
702 * good enough for us, too.
705 * XXX: Temporary doubled, for some configurations
706 * 1K is still too small and we didn't get the
707 * real fix ready for inclusion.
709 #define HOSTENT_BUFFER_SIZE 2048
712 * Do not use. Originally this was so that you can
713 * say "while (FOREVER) { ...do something... }".
714 * However, this gives a warning with some compilers (e.g. VC++).
715 * Instead, use "for (;;) { ...do something... }".
720 * Default IP address to listen on, as a string.
721 * Set to "127.0.0.1".
723 #define HADDR_DEFAULT "127.0.0.1"
726 * Default port to listen on, as a number.
729 #define HADDR_PORT 8118
732 /* Forward def for struct client_state */
733 struct configuration_spec;
737 * Entry in a linked list of strings.
742 * The string pointer. It must point to a dynamically malloc()ed
743 * string or be NULL for the list functions to work. In the latter
744 * case, just be careful next time you iterate through the list in
749 /** Next entry in the linked list, or NULL if no more. */
750 struct list_entry *next;
754 * A header for a linked list of strings.
758 /** First entry in the list, or NULL if the list is empty. */
759 struct list_entry *first;
761 /** Last entry in the list, or NULL if the list is empty. */
762 struct list_entry *last;
767 * An entry in a map. This is a name=value pair.
771 /** The key for the map. */
773 /** The value associated with that key. */
775 /** The next map entry, or NULL if none. */
776 struct map_entry *next;
780 * A map from a string to another string.
781 * This is used for the paramaters passed in a HTTP GET request, and
782 * to store the exports when the CGI interface is filling in a template.
786 /** The first map entry, or NULL if the map is empty. */
787 struct map_entry *first;
788 /** The last map entry, or NULL if the map is empty. */
789 struct map_entry *last;
794 * A HTTP request. This includes the method (GET, POST) and
797 * This is also used whenever we want to match a URL against a
798 * URL pattern. This always contains the URL to match, and never
799 * a URL pattern. (See struct url_spec).
803 char *cmd; /**< Whole command line: method, URL, Version */
804 char *ocmd; /**< Backup of original cmd for CLF logging */
805 char *gpc; /**< HTTP method: GET, POST, ... */
806 char *url; /**< The URL */
807 char *ver; /**< Protocol version */
808 int status; /**< HTTP Status */
810 char *host; /**< Host part of URL */
811 int port; /**< Port of URL or 80 (default) */
812 char *path; /**< Path of URL */
813 char *hostport; /**< host[:port] */
814 int ssl; /**< Flag if protocol is https */
816 char *host_ip_addr_str; /**< String with dotted decimal representation
817 of host's IP. NULL before connect_to() */
819 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
820 char **dvec; /**< List of pointers to the strings in dbuffer. */
821 int dcount; /**< How many parts to this domain? (length of dvec) */
825 * Reasons for generating a http_response instead of delivering
826 * the requested resource. Mostly ordered the way they are checked
829 #define RSP_REASON_UNSUPPORTED 1
830 #define RSP_REASON_BLOCKED 2
831 #define RSP_REASON_UNTRUSTED 3
832 #define RSP_REASON_REDIRECTED 4
833 #define RSP_REASON_CGI_CALL 5
834 #define RSP_REASON_NO_SUCH_DOMAIN 6
835 #define RSP_REASON_FORWARDING_FAILED 7
836 #define RSP_REASON_CONNECT_FAILED 8
837 #define RSP_REASON_OUT_OF_MEMORY 9
838 #define RSP_REASON_INTERNAL_ERROR 10
841 * Response generated by CGI, blocker, or error handler
845 char *status; /**< HTTP status (string). */
846 struct list headers[1]; /**< List of header lines. */
847 char *head; /**< Formatted http response head. */
848 size_t head_length; /**< Length of http response head. */
849 char *body; /**< HTTP document body. */
850 size_t content_length; /**< Length of body, REQUIRED if binary body. */
851 int is_static; /**< Nonzero if the content will never change and
852 should be cached by the browser (e.g. images). */
853 int reason; /**< Why the response was generated in the first place. */
861 /** The string which was parsed to produce this url_spec.
862 Used for debugging or display only. */
865 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
866 char **dvec; /**< List of pointers to the strings in dbuffer. */
867 int dcount; /**< How many parts to this domain? (length of dvec) */
868 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
870 int port; /**< The port number, or 0 to match all ports. */
872 char *path; /**< The source for the regex. */
873 size_t pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
874 regex_t *preg; /**< Regex for matching path part */
878 * If you declare a static url_spec, this is the value to initialize it to zero.
880 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
883 * Constant for host part matching in URLs. If set, indicates that the start of
884 * the pattern must match the start of the URL. E.g. this is not set for the
885 * pattern ".example.com", so that it will match both "example.com" and
886 * "www.example.com". It is set for the pattern "example.com", which makes it
887 * match "example.com" only, not "www.example.com".
889 #define ANCHOR_LEFT 1
892 * Constant for host part matching in URLs. If set, indicates that the end of
893 * the pattern must match the end of the URL. E.g. this is not set for the
894 * pattern "ad.", so that it will match any host called "ad", irrespective
895 * of how many subdomains are in the fully-qualified domain name.
897 #define ANCHOR_RIGHT 2
901 * An I/O buffer. Holds a string which can be appended to, and can have data
902 * removed from the beginning.
906 char *buf; /**< Start of buffer */
907 char *cur; /**< Start of relevant data */
908 char *eod; /**< End of relevant data */
909 size_t size; /**< Size as malloc()ed */
914 * Return the number of bytes in the I/O buffer associated with the passed
915 * client_state pointer.
918 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
922 * Remove any data in the I/O buffer associated with the passed
923 * client_state pointer.
925 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
927 /* Bits for csp->content_type bitmask: */
928 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
929 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
930 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
931 #define CT_JPEG 0x0008U /**< Suitable for JPEG filtering. */
933 /* Although these are not, strictly speaking, content types
934 * (they are content encodings), it is simple to handle them
937 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
938 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
941 * The mask which includes all actions.
943 #define ACTION_MASK_ALL (~0UL)
946 * The most compatible set of actions - i.e. none.
948 #define ACTION_MOST_COMPATIBLE 0x00000000UL
950 /** Action bitmap: Block the request. */
951 #define ACTION_BLOCK 0x00000001UL
952 /** Action bitmap: Deanimate if it's a GIF. */
953 #define ACTION_DEANIMATE 0x00000002UL
954 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
955 #define ACTION_DOWNGRADE 0x00000004UL
956 /** Action bitmap: Fast redirects. */
957 #define ACTION_FAST_REDIRECTS 0x00000008UL
958 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
959 #define ACTION_HIDE_FORWARDED 0x00000010UL
960 /** Action bitmap: Hide "From" header. */
961 #define ACTION_HIDE_FROM 0x00000020UL
962 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
963 #define ACTION_HIDE_REFERER 0x00000040UL
964 /** Action bitmap: Hide "User-Agent" and similar headers. */
965 #define ACTION_HIDE_USER_AGENT 0x00000080UL
966 /** Action bitmap: This is an image. */
967 #define ACTION_IMAGE 0x00000100UL
968 /** Action bitmap: Sets the image blocker. */
969 #define ACTION_IMAGE_BLOCKER 0x00000200UL
970 /** Action bitmap: Prevent compression. */
971 #define ACTION_NO_COMPRESSION 0x00000400UL
972 /** Action bitmap: Change cookies to session only cookies. */
973 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
974 /** Action bitmap: Block rending cookies. */
975 #define ACTION_NO_COOKIE_READ 0x00001000UL
976 /** Action bitmap: Block setting cookies. */
977 #define ACTION_NO_COOKIE_SET 0x00002000UL
978 /** Action bitmap: Filter out popups. */
979 #define ACTION_NO_POPUPS 0x00004000UL
980 /** Action bitmap: Send a vanilla wafer. */
981 #define ACTION_VANILLA_WAFER 0x00008000UL
982 /** Action bitmap: Limit CONNECT requests to safe ports. */
983 #define ACTION_LIMIT_CONNECT 0x00010000UL
984 /** Action bitmap: Inspect if it's a JPEG. */
985 #define ACTION_JPEG_INSPECT 0x00020000UL
986 /** Action bitmap: Crunch or modify "if-modified-since" header. */
987 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
988 /** Action bitmap: Overwrite Content-Type header. */
989 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
990 /** Action bitmap: Crunch specified server header. */
991 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
992 /** Action bitmap: Crunch specified client header */
993 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
994 /** Action bitmap: Enable text mode by force */
995 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
996 /** Action bitmap: Enable text mode by force */
997 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
998 /** Action bitmap: Enable content-dispostion crunching */
999 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1000 /** Action bitmap: Replace or block Last-Modified header */
1001 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1002 /** Action bitmap: Replace or block Accept-Language header */
1003 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1004 /** Action bitmap: Block as empty document */
1005 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
1006 /** Action bitmap: Redirect request. */
1007 #define ACTION_REDIRECT 0x10000000UL
1008 /** Action bitmap: Answer blocked Connects verbosely */
1009 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
1010 /** Action bitmap: Filter server headers with pcre */
1011 #define ACTION_FILTER_SERVER_HEADERS 0x40000000UL
1012 /** Action bitmap: Filter client headers with pcre */
1013 #define ACTION_FILTER_CLIENT_HEADERS 0x80000000UL
1016 /** Action string index: How to deanimate GIFs */
1017 #define ACTION_STRING_DEANIMATE 0
1018 /** Action string index: Replacement for "From:" header */
1019 #define ACTION_STRING_FROM 1
1020 /** Action string index: How to block images */
1021 #define ACTION_STRING_IMAGE_BLOCKER 2
1022 /** Action string index: Replacement for "Referer:" header */
1023 #define ACTION_STRING_REFERER 3
1024 /** Action string index: Replacement for "User-Agent:" header */
1025 #define ACTION_STRING_USER_AGENT 4
1026 /** Action string index: Legal CONNECT ports. */
1027 #define ACTION_STRING_LIMIT_CONNECT 5
1028 /** Action string index: Server headers containing this pattern are crunched*/
1029 #define ACTION_STRING_SERVER_HEADER 6
1030 /** Action string index: Client headers containing this pattern are crunched*/
1031 #define ACTION_STRING_CLIENT_HEADER 7
1032 /** Action string index: Replacement for the "Accept-Language:" header*/
1033 #define ACTION_STRING_LANGUAGE 8
1034 /** Action string index: Replacement for the "Content-Type:" header*/
1035 #define ACTION_STRING_CONTENT_TYPE 9
1036 /** Action string index: Replacement for the "content-dispostion:" header*/
1037 #define ACTION_STRING_CONTENT_DISPOSITION 10
1038 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1039 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1040 /** Action string index: Replacement for the "Last-Modified:" header. */
1041 #define ACTION_STRING_LAST_MODIFIED 12
1042 /** Action string index: Redirect URL */
1043 #define ACTION_STRING_REDIRECT 13
1044 /** Action string index: Decode before redirect? */
1045 #define ACTION_STRING_FAST_REDIRECTS 14
1046 /** Number of string actions. */
1047 #define ACTION_STRING_COUNT 15
1050 /*To make the ugly hack in sed easier to understand*/
1051 #define CHECK_EVERY_HEADER_REMAINING 0
1054 /** Index into current_action_spec::multi[] for headers to add. */
1055 #define ACTION_MULTI_ADD_HEADER 0
1056 /** Index into current_action_spec::multi[] for headers to add. */
1057 #define ACTION_MULTI_WAFER 1
1058 /** Index into current_action_spec::multi[] for filters to apply. */
1059 #define ACTION_MULTI_FILTER 2
1060 /** Number of multi-string actions. */
1061 #define ACTION_MULTI_COUNT 3
1065 * This structure contains a list of actions to apply to a URL.
1066 * It only contains positive instructions - no "-" options.
1067 * It is not used to store the actions list itself, only for
1068 * url_actions() to return the current values.
1070 struct current_action_spec
1072 /** Actions to apply. A bit set to "1" means perform the action. */
1073 unsigned long flags;
1076 * Paramaters for those actions that require them.
1077 * Each entry is valid if & only if the corresponding entry in "flags" is
1080 char * string[ACTION_STRING_COUNT];
1082 /** Lists of strings for multi-string actions. */
1083 struct list multi[ACTION_MULTI_COUNT][1];
1088 * This structure contains a set of changes to actions.
1089 * It can contain both positive and negative instructions.
1090 * It is used to store an entry in the actions list.
1094 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1095 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1098 * Paramaters for those actions that require them.
1099 * Each entry is valid if & only if the corresponding entry in "flags" is
1102 char * string[ACTION_STRING_COUNT];
1104 /** Lists of strings to remove, for multi-string actions. */
1105 struct list multi_remove[ACTION_MULTI_COUNT][1];
1107 /** If nonzero, remove *all* strings from the multi-string action. */
1108 int multi_remove_all[ACTION_MULTI_COUNT];
1110 /** Lists of strings to add, for multi-string actions. */
1111 struct list multi_add[ACTION_MULTI_COUNT][1];
1116 * This structure is used to store the actions list.
1118 * It contains a URL pattern, and the chages to the actions.
1119 * It is a linked list.
1123 struct url_spec url[1]; /**< URL pattern. */
1125 struct action_spec action[1]; /**< Actions. */
1127 struct url_actions * next; /**< Next action in file, or NULL. */
1132 * Flags for use in csp->flags
1136 * Flag for csp->flags: Set if this client is processing data.
1137 * Cleared when the thread associated with this structure dies.
1139 #define CSP_FLAG_ACTIVE 0x01
1142 * Flag for csp->flags: Set if the server's reply is in "chunked"
1145 #define CSP_FLAG_CHUNKED 0x02
1148 * Flag for csp->flags: Set if this request was enforced, although it would
1149 * normally have been blocked.
1151 #define CSP_FLAG_FORCED 0x04
1154 * Flag for csp->flags: Set if any modification to the body was done.
1156 #define CSP_FLAG_MODIFIED 0x08
1159 * Flag for csp->flags: Set if request was blocked.
1161 #define CSP_FLAG_REJECTED 0x10
1164 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1166 #define CSP_FLAG_TOGGLED_ON 0x20
1169 * Flag for csp->flags: Set if adding the 'Connection: close' header
1170 * for the client isn't necessary.
1172 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
1175 * Flag for csp->flags: Set if adding the 'Connection: close' header
1176 * for the server isn't necessary.
1178 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1181 * Flag for csp->flags: Signals header parsers whether they
1182 * are parsing server or client headers.
1184 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1187 * Flag for csp->flags: Set if adding the Host: header
1190 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1194 * Flags for use in return codes of child processes
1198 * Flag for process return code: Set if exiting porcess has been toggled
1199 * during its lifetime.
1201 #define RC_FLAG_TOGGLED 0x10
1204 * Flag for process return code: Set if exiting porcess has blocked its
1207 #define RC_FLAG_BLOCKED 0x20
1210 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1213 #define MAX_AF_FILES 10
1216 * The state of a Privoxy processing thread.
1220 /** The proxy's configuration */
1221 struct configuration_spec * config;
1223 /** The actions to perform on the current request */
1224 struct current_action_spec action[1];
1226 /** socket to talk to client (web browser) */
1229 /** socket to talk to server (web server or proxy) */
1232 /** Multi-purpose flag container, see CSP_FLAG_* above */
1235 /** Client PC's IP address, as reported by the accept() function.
1238 /** Client PC's IP address, as reported by the accept() function.
1242 /** Our IP address. I.e. the IP address that the client used to reach us,
1244 char *my_ip_addr_str;
1246 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1247 used to reach us, as a string. */
1250 /** The URL that was requested */
1251 struct http_request http[1];
1253 /** An I/O buffer used for buffering data read from the network */
1256 /** List of all headers for this request */
1257 struct list headers[1];
1259 /** List of all cookies for this request */
1260 struct list cookie_list[1];
1262 /** MIME-Type key, see CT_* above */
1263 unsigned int content_type;
1265 /** The "X-Forwarded-For:" header sent by the client */
1268 /** Actions files associated with this client */
1269 struct file_list *actions_list[MAX_AF_FILES];
1271 /** pcrs job files. */
1272 struct file_list *rlist[MAX_AF_FILES];
1274 /** Length after content modification. */
1275 size_t content_length;
1277 #ifdef FEATURE_TRUST
1280 struct file_list *tlist;
1282 #endif /* def FEATURE_TRUST */
1285 * Failure reason to embedded in the CGI error page,
1286 * or NULL. Currently only used for socks errors.
1288 char *error_message;
1290 /** Next thread in linked list. Only read or modify from the main thread! */
1291 struct client_state *next;
1296 * A function to add a header
1298 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1301 * A function to process a header
1303 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1307 * List of functions to run on a list of headers
1311 /** The header prefix to match */
1314 /** The length of the prefix to match */
1317 /** The function to apply to this line */
1318 parser_func_ptr parser;
1323 * List of available CGI functions.
1325 struct cgi_dispatcher
1327 /** The URL of the CGI, relative to the CGI root. */
1328 const char * const name;
1330 /** The handler function for the CGI */
1331 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1333 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1334 const char * const description;
1336 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1342 * A data file used by Privoxy. Kept in a linked list.
1347 * This is a pointer to the data structures associated with the file.
1348 * Read-only once the structure has been created.
1353 * The unloader function.
1354 * Normally NULL. When we are finished with file (i.e. when we have
1355 * loaded a new one), set to a pointer to an unloader function.
1356 * Unloader will be called by sweep() (called from main loop) when
1357 * all clients using this file are done. This prevents threading
1360 void (*unloader)(void *);
1363 * Used internally by sweep(). Do not access from elsewhere.
1368 * File last-modified time, so we can check if file has been changed.
1369 * Read-only once the structure has been created.
1371 time_t lastmodified;
1374 * The full filename.
1379 * Pointer to next entry in the linked list of all "file_list"s.
1380 * This linked list is so that sweep() can navigate it.
1381 * Since sweep() can remove items from the list, we must be careful
1382 * to only access this value from main thread (when we know sweep
1383 * won't be running).
1385 struct file_list *next;
1389 #ifdef FEATURE_TRUST
1392 * The format of a trust file when loaded into memory.
1396 struct url_spec url[1]; /**< The URL pattern */
1397 int reject; /**< FIXME: Please document this! */
1398 struct block_spec *next; /**< Next entry in linked list */
1402 * Arbitrary limit for the number of trusted referrers.
1404 #define MAX_TRUSTED_REFERRERS 512
1406 #endif /* def FEATURE_TRUST */
1409 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1410 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1411 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1415 * How to forward a connection to a parent proxy.
1419 /** URL pattern that this forward_spec is for. */
1420 struct url_spec url[1];
1422 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1425 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1428 /** SOCKS server port. */
1431 /** Parent HTTP proxy hostname, or NULL for none. */
1434 /** Parent HTTP proxy port. */
1437 /** Next entry in the linked list. */
1438 struct forward_spec *next;
1443 * Initializer for a static struct forward_spec.
1445 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1449 * This struct represents one filter (one block) from
1450 * the re_filterfile. If there is more than one filter
1451 * in the file, the file will be represented by a
1452 * chained list of re_filterfile specs.
1454 struct re_filterfile_spec
1456 char *name; /**< Name from FILTER: statement in re_filterfile. */
1457 char *description; /**< Description from FILTER: statement in re_filterfile. */
1458 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1459 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1460 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1466 #define ACL_PERMIT 1 /**< Accept connection request */
1467 #define ACL_DENY 2 /**< Reject connection request */
1470 * An IP address pattern. Used to specify networks in the ACL.
1472 struct access_control_addr
1474 unsigned long addr; /**< The IP address as an integer. */
1475 unsigned long mask; /**< The network mask as an integer. */
1476 unsigned long port; /**< The port number. */
1480 * An access control list (ACL) entry.
1482 * This is a linked list.
1484 struct access_control_list
1486 struct access_control_addr src[1]; /**< Client IP address */
1487 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1489 short action; /**< ACL_PERMIT or ACL_DENY */
1490 struct access_control_list *next; /**< The next entry in the ACL. */
1493 #endif /* def FEATURE_ACL */
1496 /** Maximum number of loaders (actions, re_filter, ...) */
1500 /** configuration_spec::feature_flags: CGI actions editor. */
1501 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1503 /** configuration_spec::feature_flags: Web-based toggle. */
1504 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1506 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1507 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1509 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1510 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1512 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1513 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1515 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1516 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32
1520 * Data loaded from the configuration file.
1522 * (Anomaly: toggle is still handled through a global, not this structure)
1524 struct configuration_spec
1529 /** Nonzero to enable multithreading. */
1533 * Bitmask of features that can be enabled/disabled through the config
1534 * file. Currently defined bits:
1536 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1537 * - RUNTIME_FEATURE_CGI_TOGGLE
1538 * - RUNTIME_FEATURE_HTTP_TOGGLE
1539 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1541 unsigned feature_flags;
1543 /** The log file name. */
1544 const char *logfile;
1546 /** The config file directory. */
1547 const char *confdir;
1549 /** The directory for customized CGI templates. */
1550 const char *templdir;
1552 /** The log file directory. */
1555 /** The full paths to the actions files. */
1556 const char *actions_file[MAX_AF_FILES];
1558 /** The short names of the actions files. */
1559 const char *actions_file_short[MAX_AF_FILES];
1561 /** The administrator's email address */
1562 char *admin_address;
1564 /** A URL with info on this proxy */
1565 char *proxy_info_url;
1567 /** URL to the user manual (on our website or local copy) */
1570 /** The file names of the pcre filter files. */
1571 const char *re_filterfile[MAX_AF_FILES];
1573 /** The short names of the pcre filter files. */
1574 const char *re_filterfile_short[MAX_AF_FILES];
1576 #ifdef FEATURE_COOKIE_JAR
1578 /** The file name of the cookie jar file */
1579 const char * jarfile;
1581 /** The handle to the cookie jar file */
1584 #endif /* def FEATURE_COOKIE_JAR */
1586 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1589 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1592 /** Size limit for IOB */
1593 size_t buffer_limit;
1595 #ifdef FEATURE_TRUST
1597 /** The file name of the trust file. */
1598 const char * trustfile;
1600 /** FIXME: DOCME: Document this. */
1601 struct list trust_info[1];
1603 /** FIXME: DOCME: Document this. */
1604 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1606 #endif /* def FEATURE_TRUST */
1610 /** The access control list (ACL). */
1611 struct access_control_list *acl;
1613 #endif /* def FEATURE_ACL */
1615 /** Information about parent proxies (forwarding). */
1616 struct forward_spec *forward;
1618 /** Number of retries in case a forwarded connection attempt fails */
1619 int forwarded_connect_retries;
1621 /** All options from the config file, HTML-formatted. */
1624 /** The configuration file object. */
1625 struct file_list *config_file_list;
1627 /** List of loaders */
1628 int (*loaders[NLOADERS])(struct client_state *);
1630 /** Nonzero if we need to bind() to the new port. */
1634 /** Calculates the number of elements in an array, using sizeof. */
1635 #define SZ(X) (sizeof(X) / sizeof(*X))
1637 #ifdef FEATURE_FORCE_LOAD
1638 /** The force load URL prefix. */
1639 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1640 #endif /* def FEATURE_FORCE_LOAD */
1642 #ifdef FEATURE_NO_GIFS
1643 /** The MIME type for images ("image/png" or "image/gif"). */
1644 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1646 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1647 #endif /* def FEATURE_NO_GIFS */
1654 /** URL for the Privoxy home page. */
1655 #define HOME_PAGE_URL "http://www.privoxy.org/"
1657 /** URL for the Privoxy user manual. */
1658 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1660 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1661 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1663 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1664 #define CONFIG_HELP_PREFIX "config.html#"
1667 * The "hosts" to intercept and display CGI pages.
1668 * First one is a hostname only, second one can specify host and path.
1671 * 1) Do not specify the http: prefix
1672 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1673 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1675 #define CGI_SITE_1_HOST "p.p"
1676 #define CGI_SITE_2_HOST "config.privoxy.org"
1677 #define CGI_SITE_2_PATH ""
1680 * The prefix for CGI pages. Written out in generated HTML.
1681 * INCLUDES the trailing slash.
1683 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1689 #endif /* ndef PROJECT_H_INCLUDED */