1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.99 2007/07/21 11:51:36 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.99 2007/07/21 11:51:36 fabiankeil
41 * As Hal noticed, checking dispatch_cgi() as the last cruncher
42 * looks like a bug if CGI requests are blocked unintentionally,
43 * so don't do it unless the user enabled the new config option
44 * "allow-cgi-request-crunching".
46 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
47 * Add new csp->content_type flag (CT_DECLARED).
49 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
50 * - Remove some left-overs from the switch to dedicated header filters.
51 * - Adjust "X-Filter: No" to disable dedicated header filters.
52 * - Prepare for forward-override{}
54 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
55 * Ditch the csp member cookie_list[] which isn't used anymore.
57 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
58 * Introduce dynamic pcrs jobs that can resolve variables.
60 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
61 * Introduce tags as alternative way to specify which
62 * actions apply to a request. At the moment tags can be
63 * created based on client and server headers.
65 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
66 * Use dedicated header filter actions instead of abusing "filter".
67 * Replace "filter-client-headers" and "filter-client-headers"
68 * with "server-header-filter" and "client-header-filter".
70 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
71 * New config option: enforce-blocks.
73 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
74 * Add some CSP_FLAGs for the header parsers.
76 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
77 * Add new http_response member to save
78 * the reason why the response was generated.
80 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
81 * Add new config option "templdir" to
82 * change the templates directory.
84 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
85 * Add csp->error_message for failure reasons
86 * that should be embedded into the CGI pages.
88 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
89 * Integrate a modified version of Wil Mahan's
90 * zlib patch (PR #895531).
92 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
93 * Added config option accept-intercepted-requests
94 * and disabled it by default.
96 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
97 * Fix gcc43 compiler warnings and a comment.
99 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
100 * Add config option "split-large-forms"
101 * to work around the browser bug reported
104 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
105 * Moved HTTP snipplets into jcc.c. They aren't
106 * used anywhere else.
108 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
109 * Doubled size of HOSTENT_BUFFER_SIZE to mask
110 * problems with gethostbyname_r and some
111 * /etc/hosts configurations. Only a workaround
112 * until we get the real fix ready.
113 * Thanks FĂ©lix Rauch for reporting.
115 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
117 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
118 * Respond with 400 and a short text message
119 * if the client tries to use Privoxy as FTP proxy.
121 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
122 * Added config option enable-remote-http-toggle
123 * to specify if Privoxy should recognize special
124 * headers (currently only X-Filter) to change its
125 * behaviour. Disabled by default.
127 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
128 * Make number of retries in case of forwarded-connect problems
129 * a config file option (forwarded-connect-retries) and use 0 as
132 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
133 * Work around a buffer overflow that caused Privoxy to
134 * segfault if too many trusted referrers were used. Good
135 * enough for now, but should be replaced with a real
136 * solution after the next release.
138 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
141 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
142 * Split filter-headers{} into filter-client-headers{}
143 * and filter-server-headers{}.
144 * Added parse_header_time() to share some code.
145 * Replaced timegm() with mktime().
147 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
148 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
150 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
151 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
152 * with what was really the latest development (the v_3_0_branch branch)
154 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
155 * Multiple filter file support
157 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
158 * Add the ability to check jpeg images for invalid
159 * lengths of comment blocks. Defensive strategy
160 * against the exploit:
161 * Microsoft Security Bulletin MS04-028
162 * Buffer Overrun in JPEG Processing (GDI+) Could
163 * Allow Code Execution (833987)
164 * Enabled with +inspect-jpegs in actions files.
166 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
167 * Updated the copyright note
169 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
170 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
172 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
173 * Introduced RC_FLAG_* flags for use in child process return code
175 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
176 * Added flag to each cgi_dispatcher that allows or denies
177 * external linking and removed const qualifier from
178 * struct list_entry.str.
180 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
181 * - Include config.h for access to config data
182 * - Include <pcre*.h> depending on where they are
184 * Revision 1.72 2002/05/14 21:35:49 oes
185 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
186 * because of split in user-manual
188 * Revision 1.71 2002/05/12 21:39:36 jongfoster
189 * - Adding Doxygen-style comments to structures and #defines.
191 * Revision 1.70 2002/05/12 16:05:50 jongfoster
192 * Fixing ACTION_MASK_ALL to be unsigned long rather than
193 * just unsigned int. I don't know if anyone is porting
194 * Privoxy to 16-bit platforms, but if so, +limit-connect
195 * wouldn't have worked because of this bug.
197 * Revision 1.69 2002/05/08 16:00:16 oes
198 * Added size member to struct iob, so it can
199 * be alloced larger than needed.
201 * Revision 1.68 2002/04/26 12:56:00 oes
202 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
204 * Revision 1.67 2002/04/24 02:12:43 oes
205 * - Jon's multiple AF patch:
206 * - Make csp->actions_list an array
207 * - #define MAX_AF_FILES
208 * - Moved CGI_PARAM_LEN_MAX (500) here
210 * Revision 1.66 2002/04/15 19:06:43 jongfoster
213 * Revision 1.65 2002/04/04 00:36:36 gliptak
214 * always use pcre for matching
216 * Revision 1.64 2002/04/03 22:28:03 gliptak
217 * Removed references to gnu_regex
219 * Revision 1.63 2002/03/31 17:19:00 jongfoster
220 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
222 * Revision 1.62 2002/03/26 22:48:49 swa
225 * Revision 1.61 2002/03/26 22:29:55 swa
226 * we have a new homepage!
228 * Revision 1.60 2002/03/24 15:52:17 jongfoster
229 * Changing CGI URL prefixes for new name
231 * Revision 1.59 2002/03/24 15:23:33 jongfoster
234 * Revision 1.58 2002/03/24 13:25:43 swa
235 * name change related issues
237 * Revision 1.57 2002/03/16 20:28:34 oes
238 * Added descriptions to the filters so users will know what they select in the cgi editor
240 * Revision 1.56 2002/03/13 20:27:30 oes
241 * Fixing bug with CT_TABOO
243 * Revision 1.55 2002/03/12 01:42:50 oes
244 * Introduced modular filters
246 * Revision 1.54 2002/03/09 20:03:52 jongfoster
247 * - Making various functions return int rather than size_t.
248 * (Undoing a recent change). Since size_t is unsigned on
249 * Windows, functions like read_socket that return -1 on
250 * error cannot return a size_t.
252 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
253 * crashes, and also frequently caused JB to jump to 100%
254 * CPU and stay there. (Because it thought it had just
255 * read ((unsigned)-1) == 4Gb of data...)
257 * - The signature of write_socket has changed, it now simply
258 * returns success=0/failure=nonzero.
260 * - Trying to get rid of a few warnings --with-debug on
261 * Windows, I've introduced a new type "jb_socket". This is
262 * used for the socket file descriptors. On Windows, this
263 * is SOCKET (a typedef for unsigned). Everywhere else, it's
264 * an int. The error value can't be -1 any more, so it's
265 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
266 * Windows it maps to the #define INVALID_SOCKET.)
268 * - The signature of bind_port has changed.
270 * Revision 1.53 2002/03/08 16:48:55 oes
271 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
273 * Revision 1.52 2002/03/07 03:46:17 oes
274 * Fixed compiler warnings
276 * Revision 1.51 2002/03/05 04:52:42 oes
277 * Deleted non-errlog debugging code
279 * Revision 1.50 2002/03/04 19:32:07 oes
280 * Changed default port to 8118
282 * Revision 1.49 2002/03/04 18:28:55 oes
283 * Deleted PID_FILE_NAME
285 * Revision 1.48 2002/03/03 14:50:40 oes
286 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
288 * Revision 1.47 2002/02/20 23:15:13 jongfoster
289 * Parsing functions now handle out-of-memory gracefully by returning
292 * Revision 1.46 2002/01/17 21:06:09 jongfoster
293 * Now #defining the URLs of the config interface
295 * Minor changes to struct http_request and struct url_spec due to
296 * standardizing that struct http_request is used to represent a URL, and
297 * struct url_spec is used to represent a URL pattern. (Before, URLs were
298 * represented as seperate variables and a partially-filled-in url_spec).
300 * Revision 1.45 2002/01/09 14:33:27 oes
301 * Added HOSTENT_BUFFER_SIZE
303 * Revision 1.44 2001/12/30 14:07:32 steudten
304 * - Add signal handling (unix)
305 * - Add SIGHUP handler (unix)
306 * - Add creation of pidfile (unix)
307 * - Add action 'top' in rc file (RH)
308 * - Add entry 'SIGNALS' to manpage
309 * - Add exit message to logfile (unix)
311 * Revision 1.43 2001/11/22 21:57:51 jongfoster
312 * Making action_spec->flags into an unsigned long rather than just an
314 * Adding ACTION_NO_COOKIE_KEEP
316 * Revision 1.42 2001/11/05 21:42:41 steudten
317 * Include DBG() macro.
319 * Revision 1.41 2001/10/28 19:12:06 jongfoster
320 * Adding ijb_toupper()
322 * Revision 1.40 2001/10/26 17:40:47 oes
323 * Moved ijb_isspace and ijb_tolower to project.h
324 * Removed http->user_agent, csp->referrer and csp->accept_types
326 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
327 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
328 * macro when called with a cast; so moving the cast to the macro def'n
329 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
330 * doesn't make macro expansion complain. Hope this works for everyone else
333 * Revision 1.38 2001/10/23 21:19:04 jongfoster
334 * New error-handling support: jb_err type and JB_ERR_xxx constants
335 * CGI functions now return a jb_err, and their parameters map is const.
336 * Support for RUNTIME_FEATUREs to enable/disable config editor
337 * Adding a few comments
339 * Revision 1.37 2001/10/14 22:14:01 jongfoster
340 * Removing name_length field from struct cgi_dispatcher, as this is
341 * now calculated at runtime from the "name" field.
343 * Revision 1.36 2001/10/10 16:45:15 oes
344 * Added LIMIT_CONNECT action and string
345 * Fixed HTTP message line termination
346 * Added CFORBIDDEN HTTP message
348 * Revision 1.35 2001/10/07 18:06:43 oes
349 * Added status member to struct http_request
351 * Revision 1.34 2001/10/07 15:45:25 oes
352 * Added url member to struct http_request and commented all
357 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
359 * Replaced struct client_state members rejected,
360 * force, active and toggled_on with "flags" bitmap.
362 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
364 * Added buffer_limit to struct configuration_spec
366 * Revision 1.33 2001/09/20 13:30:08 steudten
368 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
369 * Last case will set z to NULL in free(z) and thats bad..
371 * Revision 1.32 2001/09/16 23:02:51 jongfoster
374 * Revision 1.31 2001/09/16 13:20:29 jongfoster
375 * Rewrite of list library. Now has seperate header and list_entry
376 * structures. Also added a large sprinking of assert()s to the list
379 * Revision 1.30 2001/09/13 23:52:00 jongfoster
380 * Support for both static and dynamically generated CGI pages
382 * Revision 1.29 2001/09/13 23:29:43 jongfoster
383 * Defining FORWARD_SPEC_INITIALIZER
385 * Revision 1.28 2001/09/13 23:05:50 jongfoster
386 * Changing the string paramater to the header parsers a "const".
388 * Revision 1.27 2001/08/05 16:06:20 jongfoster
389 * Modifiying "struct map" so that there are now separate header and
390 * "map_entry" structures. This means that functions which modify a
391 * map no longer need to return a pointer to the modified map.
392 * Also, it no longer reverses the order of the entries (which may be
393 * important with some advanced template substitutions).
395 * Revision 1.26 2001/07/30 22:08:36 jongfoster
396 * Tidying up #defines:
397 * - All feature #defines are now of the form FEATURE_xxx
398 * - Permanently turned off WIN_GUI_EDIT
399 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
401 * Revision 1.25 2001/07/29 18:43:08 jongfoster
402 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
405 * Revision 1.24 2001/07/25 17:20:27 oes
406 * Introduced http->user_agent
408 * Revision 1.23 2001/07/18 12:32:23 oes
409 * - Added ACTION_STRING_DEANIMATE
410 * - moved #define freez from jcc.h to project.h
412 * Revision 1.22 2001/07/15 17:51:41 jongfoster
413 * Renaming #define STATIC to STATIC_PCRE
415 * Revision 1.21 2001/07/13 14:03:19 oes
416 * - Reorganized regex header inclusion and #defines to
417 * comply to the scheme in configure.in
418 * - Added csp->content_type and its CT_* keys
419 * - Added ACTION_DEANIMATE
420 * - Removed all #ifdef PCRS
422 * Revision 1.20 2001/06/29 21:45:41 oes
423 * Indentation, CRLF->LF, Tab-> Space
425 * Revision 1.19 2001/06/29 13:33:36 oes
426 * - Improved comments
427 * - Introduced http_request.host_ip_addr_str
428 * - Introduced http_response.head_length
429 * - Introduced config.my_ip_addr_str, config.my_hostname,
430 * config.admin_address and config.proxy_info_url
431 * - Removed config.proxy_args_header and config.proxy_args_trailer,
432 * renamed config.proxy_args_invocation to config.proxy_args
433 * - Removed HTML snipplets and GIFs
434 * - Removed logentry from cancelled commit
436 * Revision 1.18 2001/06/09 10:57:39 jongfoster
437 * Adding definition of BUFFER_SIZE.
438 * Changing struct cgi_dispatcher to use "const" strings.
440 * Revision 1.17 2001/06/07 23:15:09 jongfoster
441 * Merging ACL and forward files into config file.
442 * Moving struct gateway members into struct forward_spec
443 * Removing config->proxy_args_gateways
444 * Cosmetic: Adding a few comments
446 * Revision 1.16 2001/06/04 18:31:58 swa
447 * files are now prefixed with either `confdir' or `logdir'.
448 * `make redhat-dist' replaces both entries confdir and logdir
451 * Revision 1.15 2001/06/04 11:28:53 swa
452 * redirect did not work due to missing /
454 * Revision 1.14 2001/06/03 11:03:48 oes
456 * added struct http_response,
457 * changed struct interceptors to struct cgi_dispatcher,
458 * moved HTML stuff to cgi.h
460 * Revision 1.13 2001/06/01 20:05:36 jongfoster
461 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
462 * constant, and removed csp->tinygif.
464 * Revision 1.12 2001/06/01 18:49:17 jongfoster
465 * Replaced "list_share" with "list" - the tiny memory gain was not
466 * worth the extra complexity.
468 * Revision 1.11 2001/06/01 10:32:47 oes
469 * Added constants for anchoring selection bitmap
471 * Revision 1.10 2001/05/31 21:33:53 jongfoster
472 * Changes for new actions file, replacing permissionsfile
473 * and parts of the config file. Also added support for
476 * Revision 1.9 2001/05/31 17:32:31 oes
478 * - Enhanced domain part globbing with infix and prefix asterisk
479 * matching and optional unanchored operation
481 * Revision 1.8 2001/05/29 20:09:15 joergs
482 * HTTP_REDIRECT_TEMPLATE fixed.
484 * Revision 1.7 2001/05/29 09:50:24 jongfoster
485 * Unified blocklist/imagelist/actionslist.
486 * File format is still under discussion, but the internal changes
489 * Also modified interceptor behaviour:
490 * - We now intercept all URLs beginning with one of the following
491 * prefixes (and *only* these prefixes):
493 * * http://ijbswa.sf.net/config/
494 * * http://ijbswa.sourceforge.net/config/
495 * - New interceptors "home page" - go to http://i.j.b/ to see it.
496 * - Internal changes so that intercepted and fast redirect pages
497 * are not replaced with an image.
498 * - Interceptors now have the option to send a binary page direct
499 * to the client. (i.e. ijb-send-banner uses this)
500 * - Implemented show-url-info interceptor. (Which is why I needed
501 * the above interceptors changes - a typical URL is
502 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
503 * The previous mechanism would not have intercepted that, and
504 * if it had been intercepted then it then it would have replaced
507 * Revision 1.6 2001/05/27 22:17:04 oes
509 * - re_process_buffer no longer writes the modified buffer
510 * to the client, which was very ugly. It now returns the
511 * buffer, which it is then written by chat.
513 * - content_length now adjusts the Content-Length: header
514 * for modified documents rather than crunch()ing it.
515 * (Length info in csp->content_length, which is 0 for
516 * unmodified documents)
518 * - For this to work, sed() is called twice when filtering.
520 * Revision 1.5 2001/05/26 00:28:36 jongfoster
521 * Automatic reloading of config file.
522 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
523 * Most of the global variables have been moved to a new
524 * struct configuration_spec, accessed through csp->config->globalname
525 * Most of the globals remaining are used by the Win32 GUI.
527 * Revision 1.4 2001/05/22 18:46:04 oes
529 * - Enabled filtering banners by size rather than URL
530 * by adding patterns that replace all standard banner
531 * sizes with the "Junkbuster" gif to the re_filterfile
533 * - Enabled filtering WebBugs by providing a pattern
534 * which kills all 1x1 images
536 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
537 * which is selected by the (nonstandard and therefore
538 * capital) letter 'U' in the option string.
539 * It causes the quantifiers to be ungreedy by default.
540 * Appending a ? turns back to greedy (!).
542 * - Added a new interceptor ijb-send-banner, which
543 * sends back the "Junkbuster" gif. Without imagelist or
544 * MSIE detection support, or if tinygif = 1, or the
545 * URL isn't recognized as an imageurl, a lame HTML
546 * explanation is sent instead.
548 * - Added new feature, which permits blocking remote
549 * script redirects and firing back a local redirect
551 * The feature is conditionally compiled, i.e. it
552 * can be disabled with --disable-fast-redirects,
553 * plus it must be activated by a "fast-redirects"
554 * line in the config file, has its own log level
555 * and of course wants to be displayed by show-proxy-args
556 * Note: Boy, all the #ifdefs in 1001 locations and
557 * all the fumbling with configure.in and acconfig.h
558 * were *way* more work than the feature itself :-(
560 * - Because a generic redirect template was needed for
561 * this, tinygif = 3 now uses the same.
563 * - Moved GIFs, and other static HTTP response templates
568 * - Removed some >400 CRs again (Jon, you really worked
571 * Revision 1.3 2001/05/20 01:21:20 jongfoster
572 * Version 2.9.4 checkin.
573 * - Merged popupfile and cookiefile, and added control over PCRS
574 * filtering, in new "actionsfile".
575 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
576 * file error you now get a message box (in the Win32 GUI) rather
577 * than the program exiting with no explanation.
578 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
580 * - Removed tabs from "config"
581 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
582 * - Bumped up version number.
584 * Revision 1.2 2001/05/17 23:01:01 oes
585 * - Cleaned CRLF's from the sources and related files
587 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
588 * Initial import of version 2.9.3 source tree
591 *********************************************************************/
594 /* Declare struct FILE for vars and funcs. */
597 /* Need time_t for file_list */
599 /* Needed for pcre choice */
603 * Include appropriate regular expression libraries.
604 * Note that pcrs and pcre (native) are needed for cgi
605 * and are included anyway.
611 # ifdef PCRE_H_IN_SUBDIR
612 # include <pcre/pcre.h>
625 # include "pcreposix.h"
627 # ifdef PCRE_H_IN_SUBDIR
628 # include <pcre/pcreposix.h>
630 # include <pcreposix.h>
636 #endif /* def AMIGA */
640 * I don't want to have to #include all this just for the declaration
641 * of SOCKET. However, it looks like we have to...
656 typedef SOCKET jb_socket;
658 #define JB_INVALID_SOCKET INVALID_SOCKET
660 #else /* ndef _WIN32 */
663 * The type used by sockets. On UNIX it's an int. Microsoft decided to
664 * make it an unsigned.
666 typedef int jb_socket;
669 * The error value used for variables of type jb_socket. On UNIX this
670 * is -1, however Microsoft decided to make socket handles unsigned, so
671 * they use a different value.
674 #define JB_INVALID_SOCKET (-1)
676 #endif /* ndef _WIN32 */
680 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
685 #define JB_ERR_OK 0 /**< Success, no error */
686 #define JB_ERR_MEMORY 1 /**< Out of memory */
687 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
688 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
689 #define JB_ERR_PARSE 4 /**< Error parsing file */
690 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
691 CGI actions editor. */
692 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
695 * This macro is used to free a pointer that may be NULL.
696 * It also sets the variable to NULL after it's been freed.
697 * The paramater should be a simple variable without side effects.
699 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
703 * Fix a problem with Solaris. There should be no effect on other
706 * Solaris's isspace() is a macro which uses it's argument directly
707 * as an array index. Therefore we need to make sure that high-bit
708 * characters generate +ve values, and ideally we also want to make
709 * the argument match the declared parameter type of "int".
711 * Note: Remember to #include <ctype.h> if you use these macros.
713 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
714 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
715 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
718 * Use for statically allocated buffers if you have no other choice.
719 * Remember to check the length of what you write into the buffer
720 * - we don't want any buffer overflows!
722 #define BUFFER_SIZE 5000
725 * Max length of CGI parameters (arbitrary limit).
727 #define CGI_PARAM_LEN_MAX 500
730 * Buffer size for capturing struct hostent data in the
731 * gethostby(name|addr)_r library calls. Since we don't
732 * loop over gethostbyname_r, the buffer must be sufficient
733 * to accomodate multiple IN A RRs, as used in DNS round robin
734 * load balancing. W3C's wwwlib uses 1K, so that should be
735 * good enough for us, too.
738 * XXX: Temporary doubled, for some configurations
739 * 1K is still too small and we didn't get the
740 * real fix ready for inclusion.
742 #define HOSTENT_BUFFER_SIZE 2048
745 * Do not use. Originally this was so that you can
746 * say "while (FOREVER) { ...do something... }".
747 * However, this gives a warning with some compilers (e.g. VC++).
748 * Instead, use "for (;;) { ...do something... }".
753 * Default IP address to listen on, as a string.
754 * Set to "127.0.0.1".
756 #define HADDR_DEFAULT "127.0.0.1"
759 * Default port to listen on, as a number.
762 #define HADDR_PORT 8118
765 /* Forward def for struct client_state */
766 struct configuration_spec;
770 * Entry in a linked list of strings.
775 * The string pointer. It must point to a dynamically malloc()ed
776 * string or be NULL for the list functions to work. In the latter
777 * case, just be careful next time you iterate through the list in
782 /** Next entry in the linked list, or NULL if no more. */
783 struct list_entry *next;
787 * A header for a linked list of strings.
791 /** First entry in the list, or NULL if the list is empty. */
792 struct list_entry *first;
794 /** Last entry in the list, or NULL if the list is empty. */
795 struct list_entry *last;
800 * An entry in a map. This is a name=value pair.
804 /** The key for the map. */
806 /** The value associated with that key. */
808 /** The next map entry, or NULL if none. */
809 struct map_entry *next;
813 * A map from a string to another string.
814 * This is used for the paramaters passed in a HTTP GET request, and
815 * to store the exports when the CGI interface is filling in a template.
819 /** The first map entry, or NULL if the map is empty. */
820 struct map_entry *first;
821 /** The last map entry, or NULL if the map is empty. */
822 struct map_entry *last;
827 * A HTTP request. This includes the method (GET, POST) and
830 * This is also used whenever we want to match a URL against a
831 * URL pattern. This always contains the URL to match, and never
832 * a URL pattern. (See struct url_spec).
836 char *cmd; /**< Whole command line: method, URL, Version */
837 char *ocmd; /**< Backup of original cmd for CLF logging */
838 char *gpc; /**< HTTP method: GET, POST, ... */
839 char *url; /**< The URL */
840 char *ver; /**< Protocol version */
841 int status; /**< HTTP Status */
843 char *host; /**< Host part of URL */
844 int port; /**< Port of URL or 80 (default) */
845 char *path; /**< Path of URL */
846 char *hostport; /**< host[:port] */
847 int ssl; /**< Flag if protocol is https */
849 char *host_ip_addr_str; /**< String with dotted decimal representation
850 of host's IP. NULL before connect_to() */
852 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
853 char **dvec; /**< List of pointers to the strings in dbuffer. */
854 int dcount; /**< How many parts to this domain? (length of dvec) */
858 * Reasons for generating a http_response instead of delivering
859 * the requested resource. Mostly ordered the way they are checked
862 #define RSP_REASON_UNSUPPORTED 1
863 #define RSP_REASON_BLOCKED 2
864 #define RSP_REASON_UNTRUSTED 3
865 #define RSP_REASON_REDIRECTED 4
866 #define RSP_REASON_CGI_CALL 5
867 #define RSP_REASON_NO_SUCH_DOMAIN 6
868 #define RSP_REASON_FORWARDING_FAILED 7
869 #define RSP_REASON_CONNECT_FAILED 8
870 #define RSP_REASON_OUT_OF_MEMORY 9
871 #define RSP_REASON_INTERNAL_ERROR 10
874 * Response generated by CGI, blocker, or error handler
878 char *status; /**< HTTP status (string). */
879 struct list headers[1]; /**< List of header lines. */
880 char *head; /**< Formatted http response head. */
881 size_t head_length; /**< Length of http response head. */
882 char *body; /**< HTTP document body. */
883 size_t content_length; /**< Length of body, REQUIRED if binary body. */
884 int is_static; /**< Nonzero if the content will never change and
885 should be cached by the browser (e.g. images). */
886 int reason; /**< Why the response was generated in the first place. */
890 * A URL or a tag pattern.
894 /** The string which was parsed to produce this url_spec.
895 Used for debugging or display only. */
898 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
899 char **dvec; /**< List of pointers to the strings in dbuffer. */
900 int dcount; /**< How many parts to this domain? (length of dvec) */
901 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
903 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
905 char *path; /**< The source for the regex. */
906 regex_t *preg; /**< Regex for matching path part */
907 regex_t *tag_regex; /**< Regex for matching tags */
911 * If you declare a static url_spec, this is the value to initialize it to zero.
913 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL, NULL }
916 * Constant for host part matching in URLs. If set, indicates that the start of
917 * the pattern must match the start of the URL. E.g. this is not set for the
918 * pattern ".example.com", so that it will match both "example.com" and
919 * "www.example.com". It is set for the pattern "example.com", which makes it
920 * match "example.com" only, not "www.example.com".
922 #define ANCHOR_LEFT 1
925 * Constant for host part matching in URLs. If set, indicates that the end of
926 * the pattern must match the end of the URL. E.g. this is not set for the
927 * pattern "ad.", so that it will match any host called "ad", irrespective
928 * of how many subdomains are in the fully-qualified domain name.
930 #define ANCHOR_RIGHT 2
934 * An I/O buffer. Holds a string which can be appended to, and can have data
935 * removed from the beginning.
939 char *buf; /**< Start of buffer */
940 char *cur; /**< Start of relevant data */
941 char *eod; /**< End of relevant data */
942 size_t size; /**< Size as malloc()ed */
947 * Return the number of bytes in the I/O buffer associated with the passed
948 * client_state pointer.
951 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
955 * Remove any data in the I/O buffer associated with the passed
956 * client_state pointer.
958 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
960 /* Bits for csp->content_type bitmask: */
961 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
962 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
963 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
964 #define CT_JPEG 0x0008U /**< Suitable for JPEG filtering. */
966 /* Although these are not, strictly speaking, content types
967 * (they are content encodings), it is simple to handle them
970 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
971 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
974 * Flag to signal that the server declared the content type,
975 * so we can differentiate between unknown and undeclared
978 #define CT_DECLARED 0x0040U
981 * The mask which includes all actions.
983 #define ACTION_MASK_ALL (~0UL)
986 * The most compatible set of actions - i.e. none.
988 #define ACTION_MOST_COMPATIBLE 0x00000000UL
990 /** Action bitmap: Block the request. */
991 #define ACTION_BLOCK 0x00000001UL
992 /** Action bitmap: Deanimate if it's a GIF. */
993 #define ACTION_DEANIMATE 0x00000002UL
994 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
995 #define ACTION_DOWNGRADE 0x00000004UL
996 /** Action bitmap: Fast redirects. */
997 #define ACTION_FAST_REDIRECTS 0x00000008UL
998 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
999 #define ACTION_HIDE_FORWARDED 0x00000010UL
1000 /** Action bitmap: Hide "From" header. */
1001 #define ACTION_HIDE_FROM 0x00000020UL
1002 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1003 #define ACTION_HIDE_REFERER 0x00000040UL
1004 /** Action bitmap: Hide "User-Agent" and similar headers. */
1005 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1006 /** Action bitmap: This is an image. */
1007 #define ACTION_IMAGE 0x00000100UL
1008 /** Action bitmap: Sets the image blocker. */
1009 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1010 /** Action bitmap: Prevent compression. */
1011 #define ACTION_NO_COMPRESSION 0x00000400UL
1012 /** Action bitmap: Change cookies to session only cookies. */
1013 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1014 /** Action bitmap: Block rending cookies. */
1015 #define ACTION_NO_COOKIE_READ 0x00001000UL
1016 /** Action bitmap: Block setting cookies. */
1017 #define ACTION_NO_COOKIE_SET 0x00002000UL
1018 /** Action bitmap: Filter out popups. */
1019 #define ACTION_NO_POPUPS 0x00004000UL
1020 /** Action bitmap: Send a vanilla wafer. */
1021 #define ACTION_VANILLA_WAFER 0x00008000UL
1022 /** Action bitmap: Limit CONNECT requests to safe ports. */
1023 #define ACTION_LIMIT_CONNECT 0x00010000UL
1024 /** Action bitmap: Inspect if it's a JPEG. */
1025 #define ACTION_JPEG_INSPECT 0x00020000UL
1026 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1027 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1028 /** Action bitmap: Overwrite Content-Type header. */
1029 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1030 /** Action bitmap: Crunch specified server header. */
1031 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1032 /** Action bitmap: Crunch specified client header */
1033 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1034 /** Action bitmap: Enable text mode by force */
1035 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1036 /** Action bitmap: Enable text mode by force */
1037 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1038 /** Action bitmap: Enable content-dispostion crunching */
1039 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1040 /** Action bitmap: Replace or block Last-Modified header */
1041 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1042 /** Action bitmap: Replace or block Accept-Language header */
1043 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1044 /** Action bitmap: Block as empty document */
1045 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
1046 /** Action bitmap: Redirect request. */
1047 #define ACTION_REDIRECT 0x10000000UL
1048 /** Action bitmap: Answer blocked Connects verbosely */
1049 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
1050 /** Action bitmap: Override the forward settings in the config file */
1051 #define ACTION_FORWARD_OVERRIDE 0x40000000UL
1054 /** Action string index: How to deanimate GIFs */
1055 #define ACTION_STRING_DEANIMATE 0
1056 /** Action string index: Replacement for "From:" header */
1057 #define ACTION_STRING_FROM 1
1058 /** Action string index: How to block images */
1059 #define ACTION_STRING_IMAGE_BLOCKER 2
1060 /** Action string index: Replacement for "Referer:" header */
1061 #define ACTION_STRING_REFERER 3
1062 /** Action string index: Replacement for "User-Agent:" header */
1063 #define ACTION_STRING_USER_AGENT 4
1064 /** Action string index: Legal CONNECT ports. */
1065 #define ACTION_STRING_LIMIT_CONNECT 5
1066 /** Action string index: Server headers containing this pattern are crunched*/
1067 #define ACTION_STRING_SERVER_HEADER 6
1068 /** Action string index: Client headers containing this pattern are crunched*/
1069 #define ACTION_STRING_CLIENT_HEADER 7
1070 /** Action string index: Replacement for the "Accept-Language:" header*/
1071 #define ACTION_STRING_LANGUAGE 8
1072 /** Action string index: Replacement for the "Content-Type:" header*/
1073 #define ACTION_STRING_CONTENT_TYPE 9
1074 /** Action string index: Replacement for the "content-dispostion:" header*/
1075 #define ACTION_STRING_CONTENT_DISPOSITION 10
1076 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1077 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1078 /** Action string index: Replacement for the "Last-Modified:" header. */
1079 #define ACTION_STRING_LAST_MODIFIED 12
1080 /** Action string index: Redirect URL */
1081 #define ACTION_STRING_REDIRECT 13
1082 /** Action string index: Decode before redirect? */
1083 #define ACTION_STRING_FAST_REDIRECTS 14
1084 /** Action string index: Overriding forward rule. */
1085 #define ACTION_STRING_FORWARD_OVERRIDE 15
1086 /** Number of string actions. */
1087 #define ACTION_STRING_COUNT 16
1090 /* To make the ugly hack in sed easier to understand */
1091 #define CHECK_EVERY_HEADER_REMAINING 0
1094 /** Index into current_action_spec::multi[] for headers to add. */
1095 #define ACTION_MULTI_ADD_HEADER 0
1096 /** Index into current_action_spec::multi[] for headers to add. */
1097 #define ACTION_MULTI_WAFER 1
1098 /** Index into current_action_spec::multi[] for content filters to apply. */
1099 #define ACTION_MULTI_FILTER 2
1100 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1101 #define ACTION_MULTI_SERVER_HEADER_FILTER 3
1102 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1103 #define ACTION_MULTI_CLIENT_HEADER_FILTER 4
1104 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1105 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 5
1106 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1107 #define ACTION_MULTI_SERVER_HEADER_TAGGER 6
1108 /** Number of multi-string actions. */
1109 #define ACTION_MULTI_COUNT 7
1113 * This structure contains a list of actions to apply to a URL.
1114 * It only contains positive instructions - no "-" options.
1115 * It is not used to store the actions list itself, only for
1116 * url_actions() to return the current values.
1118 struct current_action_spec
1120 /** Actions to apply. A bit set to "1" means perform the action. */
1121 unsigned long flags;
1124 * Paramaters for those actions that require them.
1125 * Each entry is valid if & only if the corresponding entry in "flags" is
1128 char * string[ACTION_STRING_COUNT];
1130 /** Lists of strings for multi-string actions. */
1131 struct list multi[ACTION_MULTI_COUNT][1];
1136 * This structure contains a set of changes to actions.
1137 * It can contain both positive and negative instructions.
1138 * It is used to store an entry in the actions list.
1142 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1143 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1146 * Paramaters for those actions that require them.
1147 * Each entry is valid if & only if the corresponding entry in "flags" is
1150 char * string[ACTION_STRING_COUNT];
1152 /** Lists of strings to remove, for multi-string actions. */
1153 struct list multi_remove[ACTION_MULTI_COUNT][1];
1155 /** If nonzero, remove *all* strings from the multi-string action. */
1156 int multi_remove_all[ACTION_MULTI_COUNT];
1158 /** Lists of strings to add, for multi-string actions. */
1159 struct list multi_add[ACTION_MULTI_COUNT][1];
1164 * This structure is used to store the actions list.
1166 * It contains a URL pattern, and the chages to the actions.
1167 * It is a linked list.
1171 struct url_spec url[1]; /**< URL pattern. */
1173 struct action_spec action[1]; /**< Actions. */
1175 struct url_actions * next; /**< Next action in file, or NULL. */
1180 * Flags for use in csp->flags
1184 * Flag for csp->flags: Set if this client is processing data.
1185 * Cleared when the thread associated with this structure dies.
1187 #define CSP_FLAG_ACTIVE 0x01
1190 * Flag for csp->flags: Set if the server's reply is in "chunked"
1193 #define CSP_FLAG_CHUNKED 0x02
1196 * Flag for csp->flags: Set if this request was enforced, although it would
1197 * normally have been blocked.
1199 #define CSP_FLAG_FORCED 0x04
1202 * Flag for csp->flags: Set if any modification to the body was done.
1204 #define CSP_FLAG_MODIFIED 0x08
1207 * Flag for csp->flags: Set if request was blocked.
1209 #define CSP_FLAG_REJECTED 0x10
1212 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1214 #define CSP_FLAG_TOGGLED_ON 0x20
1217 * Flag for csp->flags: Set if adding the 'Connection: close' header
1218 * for the client isn't necessary.
1220 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
1223 * Flag for csp->flags: Set if adding the 'Connection: close' header
1224 * for the server isn't necessary.
1226 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1229 * Flag for csp->flags: Signals header parsers whether they
1230 * are parsing server or client headers.
1232 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1235 * Flag for csp->flags: Set if adding the Host: header
1238 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1241 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1242 * XXX: As we now have tags we might as well ditch this.
1244 #define CSP_FLAG_NO_FILTERING 0x00000400UL
1248 * Flags for use in return codes of child processes
1252 * Flag for process return code: Set if exiting porcess has been toggled
1253 * during its lifetime.
1255 #define RC_FLAG_TOGGLED 0x10
1258 * Flag for process return code: Set if exiting porcess has blocked its
1261 #define RC_FLAG_BLOCKED 0x20
1264 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1267 #define MAX_AF_FILES 10
1270 * The state of a Privoxy processing thread.
1274 /** The proxy's configuration */
1275 struct configuration_spec * config;
1277 /** The actions to perform on the current request */
1278 struct current_action_spec action[1];
1280 /** socket to talk to client (web browser) */
1283 /** socket to talk to server (web server or proxy) */
1286 /** Multi-purpose flag container, see CSP_FLAG_* above */
1289 /** Client PC's IP address, as reported by the accept() function.
1292 /** Client PC's IP address, as reported by the accept() function.
1296 /** Our IP address. I.e. the IP address that the client used to reach us,
1298 char *my_ip_addr_str;
1300 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1301 used to reach us, as a string. */
1304 /** The URL that was requested */
1305 struct http_request http[1];
1308 * The final forwarding settings.
1309 * XXX: Currently this is only used for forward-override,
1310 * so we can free the space in sweep.
1312 struct forward_spec * fwd;
1314 /** An I/O buffer used for buffering data read from the network */
1317 /** List of all headers for this request */
1318 struct list headers[1];
1320 /** List of all tags that apply to this request */
1321 struct list tags[1];
1323 /** MIME-Type key, see CT_* above */
1324 unsigned int content_type;
1326 /** The "X-Forwarded-For:" header sent by the client */
1329 /** Actions files associated with this client */
1330 struct file_list *actions_list[MAX_AF_FILES];
1332 /** pcrs job files. */
1333 struct file_list *rlist[MAX_AF_FILES];
1335 /** Length after content modification. */
1336 size_t content_length;
1338 #ifdef FEATURE_TRUST
1341 struct file_list *tlist;
1343 #endif /* def FEATURE_TRUST */
1346 * Failure reason to embedded in the CGI error page,
1347 * or NULL. Currently only used for socks errors.
1349 char *error_message;
1351 /** Next thread in linked list. Only read or modify from the main thread! */
1352 struct client_state *next;
1357 * A function to add a header
1359 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1362 * A function to process a header
1364 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1368 * List of functions to run on a list of headers
1372 /** The header prefix to match */
1375 /** The length of the prefix to match */
1378 /** The function to apply to this line */
1379 parser_func_ptr parser;
1384 * List of available CGI functions.
1386 struct cgi_dispatcher
1388 /** The URL of the CGI, relative to the CGI root. */
1389 const char * const name;
1391 /** The handler function for the CGI */
1392 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1394 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1395 const char * const description;
1397 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1403 * A data file used by Privoxy. Kept in a linked list.
1408 * This is a pointer to the data structures associated with the file.
1409 * Read-only once the structure has been created.
1414 * The unloader function.
1415 * Normally NULL. When we are finished with file (i.e. when we have
1416 * loaded a new one), set to a pointer to an unloader function.
1417 * Unloader will be called by sweep() (called from main loop) when
1418 * all clients using this file are done. This prevents threading
1421 void (*unloader)(void *);
1424 * Used internally by sweep(). Do not access from elsewhere.
1429 * File last-modified time, so we can check if file has been changed.
1430 * Read-only once the structure has been created.
1432 time_t lastmodified;
1435 * The full filename.
1440 * Pointer to next entry in the linked list of all "file_list"s.
1441 * This linked list is so that sweep() can navigate it.
1442 * Since sweep() can remove items from the list, we must be careful
1443 * to only access this value from main thread (when we know sweep
1444 * won't be running).
1446 struct file_list *next;
1450 #ifdef FEATURE_TRUST
1453 * The format of a trust file when loaded into memory.
1457 struct url_spec url[1]; /**< The URL pattern */
1458 int reject; /**< FIXME: Please document this! */
1459 struct block_spec *next; /**< Next entry in linked list */
1463 * Arbitrary limit for the number of trusted referrers.
1465 #define MAX_TRUSTED_REFERRERS 512
1467 #endif /* def FEATURE_TRUST */
1470 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1471 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1472 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1476 * How to forward a connection to a parent proxy.
1480 /** URL pattern that this forward_spec is for. */
1481 struct url_spec url[1];
1483 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1486 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1489 /** SOCKS server port. */
1492 /** Parent HTTP proxy hostname, or NULL for none. */
1495 /** Parent HTTP proxy port. */
1498 /** Next entry in the linked list. */
1499 struct forward_spec *next;
1504 * Initializer for a static struct forward_spec.
1506 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1508 /* Supported filter types */
1509 #define FT_CONTENT_FILTER 0
1510 #define FT_CLIENT_HEADER_FILTER 1
1511 #define FT_SERVER_HEADER_FILTER 2
1512 #define FT_CLIENT_HEADER_TAGGER 3
1513 #define FT_SERVER_HEADER_TAGGER 4
1515 #define MAX_FILTER_TYPES 5
1518 * This struct represents one filter (one block) from
1519 * the re_filterfile. If there is more than one filter
1520 * in the file, the file will be represented by a
1521 * chained list of re_filterfile specs.
1523 struct re_filterfile_spec
1525 char *name; /**< Name from FILTER: statement in re_filterfile. */
1526 char *description; /**< Description from FILTER: statement in re_filterfile. */
1527 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1528 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1529 int type; /**< Filter type (content, client-header, server-header). */
1530 int dynamic; /**< Set to one if the pattern might contain variables
1531 and has to be recompiled for every request. */
1532 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1538 #define ACL_PERMIT 1 /**< Accept connection request */
1539 #define ACL_DENY 2 /**< Reject connection request */
1542 * An IP address pattern. Used to specify networks in the ACL.
1544 struct access_control_addr
1546 unsigned long addr; /**< The IP address as an integer. */
1547 unsigned long mask; /**< The network mask as an integer. */
1548 unsigned long port; /**< The port number. */
1552 * An access control list (ACL) entry.
1554 * This is a linked list.
1556 struct access_control_list
1558 struct access_control_addr src[1]; /**< Client IP address */
1559 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1561 short action; /**< ACL_PERMIT or ACL_DENY */
1562 struct access_control_list *next; /**< The next entry in the ACL. */
1565 #endif /* def FEATURE_ACL */
1568 /** Maximum number of loaders (actions, re_filter, ...) */
1572 /** configuration_spec::feature_flags: CGI actions editor. */
1573 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1575 /** configuration_spec::feature_flags: Web-based toggle. */
1576 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1578 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1579 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1581 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1582 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1584 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1585 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1587 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1588 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32
1590 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1591 #define RUNTIME_FEATURE_CGI_CRUNCHING 64
1595 * Data loaded from the configuration file.
1597 * (Anomaly: toggle is still handled through a global, not this structure)
1599 struct configuration_spec
1604 /** Nonzero to enable multithreading. */
1608 * Bitmask of features that can be enabled/disabled through the config
1609 * file. Currently defined bits:
1611 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1612 * - RUNTIME_FEATURE_CGI_TOGGLE
1613 * - RUNTIME_FEATURE_HTTP_TOGGLE
1614 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1616 unsigned feature_flags;
1618 /** The log file name. */
1619 const char *logfile;
1621 /** The config file directory. */
1622 const char *confdir;
1624 /** The directory for customized CGI templates. */
1625 const char *templdir;
1627 /** The log file directory. */
1630 /** The full paths to the actions files. */
1631 const char *actions_file[MAX_AF_FILES];
1633 /** The short names of the actions files. */
1634 const char *actions_file_short[MAX_AF_FILES];
1636 /** The administrator's email address */
1637 char *admin_address;
1639 /** A URL with info on this proxy */
1640 char *proxy_info_url;
1642 /** URL to the user manual (on our website or local copy) */
1645 /** The file names of the pcre filter files. */
1646 const char *re_filterfile[MAX_AF_FILES];
1648 /** The short names of the pcre filter files. */
1649 const char *re_filterfile_short[MAX_AF_FILES];
1651 #ifdef FEATURE_COOKIE_JAR
1653 /** The file name of the cookie jar file */
1654 const char * jarfile;
1656 /** The handle to the cookie jar file */
1659 #endif /* def FEATURE_COOKIE_JAR */
1661 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1664 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1667 /** Size limit for IOB */
1668 size_t buffer_limit;
1670 #ifdef FEATURE_TRUST
1672 /** The file name of the trust file. */
1673 const char * trustfile;
1675 /** FIXME: DOCME: Document this. */
1676 struct list trust_info[1];
1678 /** FIXME: DOCME: Document this. */
1679 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1681 #endif /* def FEATURE_TRUST */
1685 /** The access control list (ACL). */
1686 struct access_control_list *acl;
1688 #endif /* def FEATURE_ACL */
1690 /** Information about parent proxies (forwarding). */
1691 struct forward_spec *forward;
1693 /** Number of retries in case a forwarded connection attempt fails */
1694 int forwarded_connect_retries;
1696 /** All options from the config file, HTML-formatted. */
1699 /** The configuration file object. */
1700 struct file_list *config_file_list;
1702 /** List of loaders */
1703 int (*loaders[NLOADERS])(struct client_state *);
1705 /** Nonzero if we need to bind() to the new port. */
1709 /** Calculates the number of elements in an array, using sizeof. */
1710 #define SZ(X) (sizeof(X) / sizeof(*X))
1712 #ifdef FEATURE_FORCE_LOAD
1713 /** The force load URL prefix. */
1714 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1715 #endif /* def FEATURE_FORCE_LOAD */
1717 #ifdef FEATURE_NO_GIFS
1718 /** The MIME type for images ("image/png" or "image/gif"). */
1719 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1721 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1722 #endif /* def FEATURE_NO_GIFS */
1729 /** URL for the Privoxy home page. */
1730 #define HOME_PAGE_URL "http://www.privoxy.org/"
1732 /** URL for the Privoxy user manual. */
1733 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1735 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1736 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1738 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1739 #define CONFIG_HELP_PREFIX "config.html#"
1742 * The "hosts" to intercept and display CGI pages.
1743 * First one is a hostname only, second one can specify host and path.
1746 * 1) Do not specify the http: prefix
1747 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1748 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1750 #define CGI_SITE_1_HOST "p.p"
1751 #define CGI_SITE_2_HOST "config.privoxy.org"
1752 #define CGI_SITE_2_PATH ""
1755 * The prefix for CGI pages. Written out in generated HTML.
1756 * INCLUDES the trailing slash.
1758 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1764 #endif /* ndef PROJECT_H_INCLUDED */