1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.119 2008/09/20 10:04:33 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-2008 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.119 2008/09/20 10:04:33 fabiankeil
41 * Remove hide-forwarded-for-headers action which has
42 * been obsoleted by change-x-forwarded-for{block}.
44 * Revision 1.118 2008/09/19 15:26:29 fabiankeil
45 * Add change-x-forwarded-for{} action to block or add
46 * X-Forwarded-For headers. Mostly based on code removed
49 * Revision 1.117 2008/08/30 12:03:07 fabiankeil
50 * Remove FEATURE_COOKIE_JAR.
52 * Revision 1.116 2008/05/20 16:05:02 fabiankeil
53 * Move parsers structure definition from project.h to parsers.h.
55 * Revision 1.115 2008/05/19 16:57:20 fabiankeil
56 * Declare all members of the parsers structure immutable.
58 * Revision 1.114 2008/04/11 16:35:39 fabiankeil
59 * Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
61 * Revision 1.113 2008/04/10 14:41:04 fabiankeil
62 * Ditch url_spec's path member now that it's no longer used.
64 * Revision 1.112 2008/04/06 15:18:34 fabiankeil
65 * Oh well, rename the --enable-pcre-host-patterns option to
66 * --enable-extended-host-patterns as it's not really PCRE syntax.
68 * Revision 1.111 2008/04/06 14:54:26 fabiankeil
69 * Use PCRE syntax in host patterns when configured
70 * with --enable-pcre-host-patterns.
72 * Revision 1.110 2008/03/29 12:13:46 fabiankeil
73 * Remove send-wafer and send-vanilla-wafer actions.
75 * Revision 1.109 2008/03/28 15:13:41 fabiankeil
76 * Remove inspect-jpegs action.
78 * Revision 1.108 2008/03/27 18:27:36 fabiankeil
79 * Remove kill-popups action.
81 * Revision 1.107 2008/03/26 18:07:08 fabiankeil
82 * Add hostname directive. Closes PR#1918189.
84 * Revision 1.106 2008/03/24 11:21:03 fabiankeil
85 * Share the action settings for multiple patterns in the same
86 * section so we waste less memory for gigantic block lists
87 * (and load them slightly faster). Reported by Franz Schwartau.
89 * Revision 1.105 2008/03/21 11:16:27 fabiankeil
90 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
92 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
93 * Remove the treat-forbidden-connects-like-blocks action. We now
94 * use the "blocked" page for forbidden CONNECT requests by default.
96 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
97 * Let the block action take the reason for the block
98 * as argument and show it on the "blocked" page.
100 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
101 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
103 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
104 * Remove now-obsolete csp member x_forwarded.
106 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
107 * - Allow port lists in url patterns.
108 * - Ditch unused url_spec member pathlen.
110 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
111 * As Hal noticed, checking dispatch_cgi() as the last cruncher
112 * looks like a bug if CGI requests are blocked unintentionally,
113 * so don't do it unless the user enabled the new config option
114 * "allow-cgi-request-crunching".
116 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
117 * Add new csp->content_type flag (CT_DECLARED).
119 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
120 * - Remove some left-overs from the switch to dedicated header filters.
121 * - Adjust "X-Filter: No" to disable dedicated header filters.
122 * - Prepare for forward-override{}
124 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
125 * Ditch the csp member cookie_list[] which isn't used anymore.
127 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
128 * Introduce dynamic pcrs jobs that can resolve variables.
130 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
131 * Introduce tags as alternative way to specify which
132 * actions apply to a request. At the moment tags can be
133 * created based on client and server headers.
135 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
136 * Use dedicated header filter actions instead of abusing "filter".
137 * Replace "filter-client-headers" and "filter-client-headers"
138 * with "server-header-filter" and "client-header-filter".
140 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
141 * New config option: enforce-blocks.
143 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
144 * Add some CSP_FLAGs for the header parsers.
146 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
147 * Add new http_response member to save
148 * the reason why the response was generated.
150 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
151 * Add new config option "templdir" to
152 * change the templates directory.
154 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
155 * Add csp->error_message for failure reasons
156 * that should be embedded into the CGI pages.
158 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
159 * Integrate a modified version of Wil Mahan's
160 * zlib patch (PR #895531).
162 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
163 * Added config option accept-intercepted-requests
164 * and disabled it by default.
166 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
167 * Fix gcc43 compiler warnings and a comment.
169 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
170 * Add config option "split-large-forms"
171 * to work around the browser bug reported
174 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
175 * Moved HTTP snipplets into jcc.c. They aren't
176 * used anywhere else.
178 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
179 * Doubled size of HOSTENT_BUFFER_SIZE to mask
180 * problems with gethostbyname_r and some
181 * /etc/hosts configurations. Only a workaround
182 * until we get the real fix ready.
183 * Thanks FĂ©lix Rauch for reporting.
185 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
187 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
188 * Respond with 400 and a short text message
189 * if the client tries to use Privoxy as FTP proxy.
191 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
192 * Added config option enable-remote-http-toggle
193 * to specify if Privoxy should recognize special
194 * headers (currently only X-Filter) to change its
195 * behaviour. Disabled by default.
197 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
198 * Make number of retries in case of forwarded-connect problems
199 * a config file option (forwarded-connect-retries) and use 0 as
202 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
203 * Work around a buffer overflow that caused Privoxy to
204 * segfault if too many trusted referrers were used. Good
205 * enough for now, but should be replaced with a real
206 * solution after the next release.
208 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
211 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
212 * Split filter-headers{} into filter-client-headers{}
213 * and filter-server-headers{}.
214 * Added parse_header_time() to share some code.
215 * Replaced timegm() with mktime().
217 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
218 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
220 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
221 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
222 * with what was really the latest development (the v_3_0_branch branch)
224 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
225 * Multiple filter file support
227 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
228 * Add the ability to check jpeg images for invalid
229 * lengths of comment blocks. Defensive strategy
230 * against the exploit:
231 * Microsoft Security Bulletin MS04-028
232 * Buffer Overrun in JPEG Processing (GDI+) Could
233 * Allow Code Execution (833987)
234 * Enabled with +inspect-jpegs in actions files.
236 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
237 * Updated the copyright note
239 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
240 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
242 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
243 * Introduced RC_FLAG_* flags for use in child process return code
245 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
246 * Added flag to each cgi_dispatcher that allows or denies
247 * external linking and removed const qualifier from
248 * struct list_entry.str.
250 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
251 * - Include config.h for access to config data
252 * - Include <pcre*.h> depending on where they are
254 * Revision 1.72 2002/05/14 21:35:49 oes
255 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
256 * because of split in user-manual
258 * Revision 1.71 2002/05/12 21:39:36 jongfoster
259 * - Adding Doxygen-style comments to structures and #defines.
261 * Revision 1.70 2002/05/12 16:05:50 jongfoster
262 * Fixing ACTION_MASK_ALL to be unsigned long rather than
263 * just unsigned int. I don't know if anyone is porting
264 * Privoxy to 16-bit platforms, but if so, +limit-connect
265 * wouldn't have worked because of this bug.
267 * Revision 1.69 2002/05/08 16:00:16 oes
268 * Added size member to struct iob, so it can
269 * be alloced larger than needed.
271 * Revision 1.68 2002/04/26 12:56:00 oes
272 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
274 * Revision 1.67 2002/04/24 02:12:43 oes
275 * - Jon's multiple AF patch:
276 * - Make csp->actions_list an array
277 * - #define MAX_AF_FILES
278 * - Moved CGI_PARAM_LEN_MAX (500) here
280 * Revision 1.66 2002/04/15 19:06:43 jongfoster
283 * Revision 1.65 2002/04/04 00:36:36 gliptak
284 * always use pcre for matching
286 * Revision 1.64 2002/04/03 22:28:03 gliptak
287 * Removed references to gnu_regex
289 * Revision 1.63 2002/03/31 17:19:00 jongfoster
290 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
292 * Revision 1.62 2002/03/26 22:48:49 swa
295 * Revision 1.61 2002/03/26 22:29:55 swa
296 * we have a new homepage!
298 * Revision 1.60 2002/03/24 15:52:17 jongfoster
299 * Changing CGI URL prefixes for new name
301 * Revision 1.59 2002/03/24 15:23:33 jongfoster
304 * Revision 1.58 2002/03/24 13:25:43 swa
305 * name change related issues
307 * Revision 1.57 2002/03/16 20:28:34 oes
308 * Added descriptions to the filters so users will know what they select in the cgi editor
310 * Revision 1.56 2002/03/13 20:27:30 oes
311 * Fixing bug with CT_TABOO
313 * Revision 1.55 2002/03/12 01:42:50 oes
314 * Introduced modular filters
316 * Revision 1.54 2002/03/09 20:03:52 jongfoster
317 * - Making various functions return int rather than size_t.
318 * (Undoing a recent change). Since size_t is unsigned on
319 * Windows, functions like read_socket that return -1 on
320 * error cannot return a size_t.
322 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
323 * crashes, and also frequently caused JB to jump to 100%
324 * CPU and stay there. (Because it thought it had just
325 * read ((unsigned)-1) == 4Gb of data...)
327 * - The signature of write_socket has changed, it now simply
328 * returns success=0/failure=nonzero.
330 * - Trying to get rid of a few warnings --with-debug on
331 * Windows, I've introduced a new type "jb_socket". This is
332 * used for the socket file descriptors. On Windows, this
333 * is SOCKET (a typedef for unsigned). Everywhere else, it's
334 * an int. The error value can't be -1 any more, so it's
335 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
336 * Windows it maps to the #define INVALID_SOCKET.)
338 * - The signature of bind_port has changed.
340 * Revision 1.53 2002/03/08 16:48:55 oes
341 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
343 * Revision 1.52 2002/03/07 03:46:17 oes
344 * Fixed compiler warnings
346 * Revision 1.51 2002/03/05 04:52:42 oes
347 * Deleted non-errlog debugging code
349 * Revision 1.50 2002/03/04 19:32:07 oes
350 * Changed default port to 8118
352 * Revision 1.49 2002/03/04 18:28:55 oes
353 * Deleted PID_FILE_NAME
355 * Revision 1.48 2002/03/03 14:50:40 oes
356 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
358 * Revision 1.47 2002/02/20 23:15:13 jongfoster
359 * Parsing functions now handle out-of-memory gracefully by returning
362 * Revision 1.46 2002/01/17 21:06:09 jongfoster
363 * Now #defining the URLs of the config interface
365 * Minor changes to struct http_request and struct url_spec due to
366 * standardizing that struct http_request is used to represent a URL, and
367 * struct url_spec is used to represent a URL pattern. (Before, URLs were
368 * represented as seperate variables and a partially-filled-in url_spec).
370 * Revision 1.45 2002/01/09 14:33:27 oes
371 * Added HOSTENT_BUFFER_SIZE
373 * Revision 1.44 2001/12/30 14:07:32 steudten
374 * - Add signal handling (unix)
375 * - Add SIGHUP handler (unix)
376 * - Add creation of pidfile (unix)
377 * - Add action 'top' in rc file (RH)
378 * - Add entry 'SIGNALS' to manpage
379 * - Add exit message to logfile (unix)
381 * Revision 1.43 2001/11/22 21:57:51 jongfoster
382 * Making action_spec->flags into an unsigned long rather than just an
384 * Adding ACTION_NO_COOKIE_KEEP
386 * Revision 1.42 2001/11/05 21:42:41 steudten
387 * Include DBG() macro.
389 * Revision 1.41 2001/10/28 19:12:06 jongfoster
390 * Adding ijb_toupper()
392 * Revision 1.40 2001/10/26 17:40:47 oes
393 * Moved ijb_isspace and ijb_tolower to project.h
394 * Removed http->user_agent, csp->referrer and csp->accept_types
396 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
397 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
398 * macro when called with a cast; so moving the cast to the macro def'n
399 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
400 * doesn't make macro expansion complain. Hope this works for everyone else
403 * Revision 1.38 2001/10/23 21:19:04 jongfoster
404 * New error-handling support: jb_err type and JB_ERR_xxx constants
405 * CGI functions now return a jb_err, and their parameters map is const.
406 * Support for RUNTIME_FEATUREs to enable/disable config editor
407 * Adding a few comments
409 * Revision 1.37 2001/10/14 22:14:01 jongfoster
410 * Removing name_length field from struct cgi_dispatcher, as this is
411 * now calculated at runtime from the "name" field.
413 * Revision 1.36 2001/10/10 16:45:15 oes
414 * Added LIMIT_CONNECT action and string
415 * Fixed HTTP message line termination
416 * Added CFORBIDDEN HTTP message
418 * Revision 1.35 2001/10/07 18:06:43 oes
419 * Added status member to struct http_request
421 * Revision 1.34 2001/10/07 15:45:25 oes
422 * Added url member to struct http_request and commented all
427 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
429 * Replaced struct client_state members rejected,
430 * force, active and toggled_on with "flags" bitmap.
432 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
434 * Added buffer_limit to struct configuration_spec
436 * Revision 1.33 2001/09/20 13:30:08 steudten
438 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
439 * Last case will set z to NULL in free(z) and thats bad..
441 * Revision 1.32 2001/09/16 23:02:51 jongfoster
444 * Revision 1.31 2001/09/16 13:20:29 jongfoster
445 * Rewrite of list library. Now has seperate header and list_entry
446 * structures. Also added a large sprinking of assert()s to the list
449 * Revision 1.30 2001/09/13 23:52:00 jongfoster
450 * Support for both static and dynamically generated CGI pages
452 * Revision 1.29 2001/09/13 23:29:43 jongfoster
453 * Defining FORWARD_SPEC_INITIALIZER
455 * Revision 1.28 2001/09/13 23:05:50 jongfoster
456 * Changing the string paramater to the header parsers a "const".
458 * Revision 1.27 2001/08/05 16:06:20 jongfoster
459 * Modifiying "struct map" so that there are now separate header and
460 * "map_entry" structures. This means that functions which modify a
461 * map no longer need to return a pointer to the modified map.
462 * Also, it no longer reverses the order of the entries (which may be
463 * important with some advanced template substitutions).
465 * Revision 1.26 2001/07/30 22:08:36 jongfoster
466 * Tidying up #defines:
467 * - All feature #defines are now of the form FEATURE_xxx
468 * - Permanently turned off WIN_GUI_EDIT
469 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
471 * Revision 1.25 2001/07/29 18:43:08 jongfoster
472 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
475 * Revision 1.24 2001/07/25 17:20:27 oes
476 * Introduced http->user_agent
478 * Revision 1.23 2001/07/18 12:32:23 oes
479 * - Added ACTION_STRING_DEANIMATE
480 * - moved #define freez from jcc.h to project.h
482 * Revision 1.22 2001/07/15 17:51:41 jongfoster
483 * Renaming #define STATIC to STATIC_PCRE
485 * Revision 1.21 2001/07/13 14:03:19 oes
486 * - Reorganized regex header inclusion and #defines to
487 * comply to the scheme in configure.in
488 * - Added csp->content_type and its CT_* keys
489 * - Added ACTION_DEANIMATE
490 * - Removed all #ifdef PCRS
492 * Revision 1.20 2001/06/29 21:45:41 oes
493 * Indentation, CRLF->LF, Tab-> Space
495 * Revision 1.19 2001/06/29 13:33:36 oes
496 * - Improved comments
497 * - Introduced http_request.host_ip_addr_str
498 * - Introduced http_response.head_length
499 * - Introduced config.my_ip_addr_str, config.my_hostname,
500 * config.admin_address and config.proxy_info_url
501 * - Removed config.proxy_args_header and config.proxy_args_trailer,
502 * renamed config.proxy_args_invocation to config.proxy_args
503 * - Removed HTML snipplets and GIFs
504 * - Removed logentry from cancelled commit
506 * Revision 1.18 2001/06/09 10:57:39 jongfoster
507 * Adding definition of BUFFER_SIZE.
508 * Changing struct cgi_dispatcher to use "const" strings.
510 * Revision 1.17 2001/06/07 23:15:09 jongfoster
511 * Merging ACL and forward files into config file.
512 * Moving struct gateway members into struct forward_spec
513 * Removing config->proxy_args_gateways
514 * Cosmetic: Adding a few comments
516 * Revision 1.16 2001/06/04 18:31:58 swa
517 * files are now prefixed with either `confdir' or `logdir'.
518 * `make redhat-dist' replaces both entries confdir and logdir
521 * Revision 1.15 2001/06/04 11:28:53 swa
522 * redirect did not work due to missing /
524 * Revision 1.14 2001/06/03 11:03:48 oes
526 * added struct http_response,
527 * changed struct interceptors to struct cgi_dispatcher,
528 * moved HTML stuff to cgi.h
530 * Revision 1.13 2001/06/01 20:05:36 jongfoster
531 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
532 * constant, and removed csp->tinygif.
534 * Revision 1.12 2001/06/01 18:49:17 jongfoster
535 * Replaced "list_share" with "list" - the tiny memory gain was not
536 * worth the extra complexity.
538 * Revision 1.11 2001/06/01 10:32:47 oes
539 * Added constants for anchoring selection bitmap
541 * Revision 1.10 2001/05/31 21:33:53 jongfoster
542 * Changes for new actions file, replacing permissionsfile
543 * and parts of the config file. Also added support for
546 * Revision 1.9 2001/05/31 17:32:31 oes
548 * - Enhanced domain part globbing with infix and prefix asterisk
549 * matching and optional unanchored operation
551 * Revision 1.8 2001/05/29 20:09:15 joergs
552 * HTTP_REDIRECT_TEMPLATE fixed.
554 * Revision 1.7 2001/05/29 09:50:24 jongfoster
555 * Unified blocklist/imagelist/actionslist.
556 * File format is still under discussion, but the internal changes
559 * Also modified interceptor behaviour:
560 * - We now intercept all URLs beginning with one of the following
561 * prefixes (and *only* these prefixes):
563 * * http://ijbswa.sf.net/config/
564 * * http://ijbswa.sourceforge.net/config/
565 * - New interceptors "home page" - go to http://i.j.b/ to see it.
566 * - Internal changes so that intercepted and fast redirect pages
567 * are not replaced with an image.
568 * - Interceptors now have the option to send a binary page direct
569 * to the client. (i.e. ijb-send-banner uses this)
570 * - Implemented show-url-info interceptor. (Which is why I needed
571 * the above interceptors changes - a typical URL is
572 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
573 * The previous mechanism would not have intercepted that, and
574 * if it had been intercepted then it then it would have replaced
577 * Revision 1.6 2001/05/27 22:17:04 oes
579 * - re_process_buffer no longer writes the modified buffer
580 * to the client, which was very ugly. It now returns the
581 * buffer, which it is then written by chat.
583 * - content_length now adjusts the Content-Length: header
584 * for modified documents rather than crunch()ing it.
585 * (Length info in csp->content_length, which is 0 for
586 * unmodified documents)
588 * - For this to work, sed() is called twice when filtering.
590 * Revision 1.5 2001/05/26 00:28:36 jongfoster
591 * Automatic reloading of config file.
592 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
593 * Most of the global variables have been moved to a new
594 * struct configuration_spec, accessed through csp->config->globalname
595 * Most of the globals remaining are used by the Win32 GUI.
597 * Revision 1.4 2001/05/22 18:46:04 oes
599 * - Enabled filtering banners by size rather than URL
600 * by adding patterns that replace all standard banner
601 * sizes with the "Junkbuster" gif to the re_filterfile
603 * - Enabled filtering WebBugs by providing a pattern
604 * which kills all 1x1 images
606 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
607 * which is selected by the (nonstandard and therefore
608 * capital) letter 'U' in the option string.
609 * It causes the quantifiers to be ungreedy by default.
610 * Appending a ? turns back to greedy (!).
612 * - Added a new interceptor ijb-send-banner, which
613 * sends back the "Junkbuster" gif. Without imagelist or
614 * MSIE detection support, or if tinygif = 1, or the
615 * URL isn't recognized as an imageurl, a lame HTML
616 * explanation is sent instead.
618 * - Added new feature, which permits blocking remote
619 * script redirects and firing back a local redirect
621 * The feature is conditionally compiled, i.e. it
622 * can be disabled with --disable-fast-redirects,
623 * plus it must be activated by a "fast-redirects"
624 * line in the config file, has its own log level
625 * and of course wants to be displayed by show-proxy-args
626 * Note: Boy, all the #ifdefs in 1001 locations and
627 * all the fumbling with configure.in and acconfig.h
628 * were *way* more work than the feature itself :-(
630 * - Because a generic redirect template was needed for
631 * this, tinygif = 3 now uses the same.
633 * - Moved GIFs, and other static HTTP response templates
638 * - Removed some >400 CRs again (Jon, you really worked
641 * Revision 1.3 2001/05/20 01:21:20 jongfoster
642 * Version 2.9.4 checkin.
643 * - Merged popupfile and cookiefile, and added control over PCRS
644 * filtering, in new "actionsfile".
645 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
646 * file error you now get a message box (in the Win32 GUI) rather
647 * than the program exiting with no explanation.
648 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
650 * - Removed tabs from "config"
651 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
652 * - Bumped up version number.
654 * Revision 1.2 2001/05/17 23:01:01 oes
655 * - Cleaned CRLF's from the sources and related files
657 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
658 * Initial import of version 2.9.3 source tree
661 *********************************************************************/
664 /* Declare struct FILE for vars and funcs. */
667 /* Need time_t for file_list */
669 /* Needed for pcre choice */
673 * Include appropriate regular expression libraries.
674 * Note that pcrs and pcre (native) are needed for cgi
675 * and are included anyway.
681 # ifdef PCRE_H_IN_SUBDIR
682 # include <pcre/pcre.h>
695 # include "pcreposix.h"
697 # ifdef PCRE_H_IN_SUBDIR
698 # include <pcre/pcreposix.h>
700 # include <pcreposix.h>
706 #endif /* def AMIGA */
710 * I don't want to have to #include all this just for the declaration
711 * of SOCKET. However, it looks like we have to...
726 typedef SOCKET jb_socket;
728 #define JB_INVALID_SOCKET INVALID_SOCKET
730 #else /* ndef _WIN32 */
733 * The type used by sockets. On UNIX it's an int. Microsoft decided to
734 * make it an unsigned.
736 typedef int jb_socket;
739 * The error value used for variables of type jb_socket. On UNIX this
740 * is -1, however Microsoft decided to make socket handles unsigned, so
741 * they use a different value.
744 #define JB_INVALID_SOCKET (-1)
746 #endif /* ndef _WIN32 */
750 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
755 #define JB_ERR_OK 0 /**< Success, no error */
756 #define JB_ERR_MEMORY 1 /**< Out of memory */
757 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
758 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
759 #define JB_ERR_PARSE 4 /**< Error parsing file */
760 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
761 CGI actions editor. */
762 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
765 * This macro is used to free a pointer that may be NULL.
766 * It also sets the variable to NULL after it's been freed.
767 * The paramater should be a simple variable without side effects.
769 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
773 * Fix a problem with Solaris. There should be no effect on other
776 * Solaris's isspace() is a macro which uses it's argument directly
777 * as an array index. Therefore we need to make sure that high-bit
778 * characters generate +ve values, and ideally we also want to make
779 * the argument match the declared parameter type of "int".
781 * Note: Remember to #include <ctype.h> if you use these macros.
783 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
784 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
785 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
788 * Use for statically allocated buffers if you have no other choice.
789 * Remember to check the length of what you write into the buffer
790 * - we don't want any buffer overflows!
792 #define BUFFER_SIZE 5000
795 * Max length of CGI parameters (arbitrary limit).
797 #define CGI_PARAM_LEN_MAX 500
800 * Buffer size for capturing struct hostent data in the
801 * gethostby(name|addr)_r library calls. Since we don't
802 * loop over gethostbyname_r, the buffer must be sufficient
803 * to accomodate multiple IN A RRs, as used in DNS round robin
804 * load balancing. W3C's wwwlib uses 1K, so that should be
805 * good enough for us, too.
808 * XXX: Temporary doubled, for some configurations
809 * 1K is still too small and we didn't get the
810 * real fix ready for inclusion.
812 #define HOSTENT_BUFFER_SIZE 2048
815 * Do not use. Originally this was so that you can
816 * say "while (FOREVER) { ...do something... }".
817 * However, this gives a warning with some compilers (e.g. VC++).
818 * Instead, use "for (;;) { ...do something... }".
823 * Default IP address to listen on, as a string.
824 * Set to "127.0.0.1".
826 #define HADDR_DEFAULT "127.0.0.1"
829 * Default port to listen on, as a number.
832 #define HADDR_PORT 8118
835 /* Forward def for struct client_state */
836 struct configuration_spec;
840 * Entry in a linked list of strings.
845 * The string pointer. It must point to a dynamically malloc()ed
846 * string or be NULL for the list functions to work. In the latter
847 * case, just be careful next time you iterate through the list in
852 /** Next entry in the linked list, or NULL if no more. */
853 struct list_entry *next;
857 * A header for a linked list of strings.
861 /** First entry in the list, or NULL if the list is empty. */
862 struct list_entry *first;
864 /** Last entry in the list, or NULL if the list is empty. */
865 struct list_entry *last;
870 * An entry in a map. This is a name=value pair.
874 /** The key for the map. */
876 /** The value associated with that key. */
878 /** The next map entry, or NULL if none. */
879 struct map_entry *next;
883 * A map from a string to another string.
884 * This is used for the paramaters passed in a HTTP GET request, and
885 * to store the exports when the CGI interface is filling in a template.
889 /** The first map entry, or NULL if the map is empty. */
890 struct map_entry *first;
891 /** The last map entry, or NULL if the map is empty. */
892 struct map_entry *last;
897 * A HTTP request. This includes the method (GET, POST) and
900 * This is also used whenever we want to match a URL against a
901 * URL pattern. This always contains the URL to match, and never
902 * a URL pattern. (See struct url_spec).
906 char *cmd; /**< Whole command line: method, URL, Version */
907 char *ocmd; /**< Backup of original cmd for CLF logging */
908 char *gpc; /**< HTTP method: GET, POST, ... */
909 char *url; /**< The URL */
910 char *ver; /**< Protocol version */
911 int status; /**< HTTP Status */
913 char *host; /**< Host part of URL */
914 int port; /**< Port of URL or 80 (default) */
915 char *path; /**< Path of URL */
916 char *hostport; /**< host[:port] */
917 int ssl; /**< Flag if protocol is https */
919 char *host_ip_addr_str; /**< String with dotted decimal representation
920 of host's IP. NULL before connect_to() */
922 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
923 char **dvec; /**< List of pointers to the strings in dbuffer. */
924 int dcount; /**< How many parts to this domain? (length of dvec) */
928 * Reasons for generating a http_response instead of delivering
929 * the requested resource. Mostly ordered the way they are checked
932 #define RSP_REASON_UNSUPPORTED 1
933 #define RSP_REASON_BLOCKED 2
934 #define RSP_REASON_UNTRUSTED 3
935 #define RSP_REASON_REDIRECTED 4
936 #define RSP_REASON_CGI_CALL 5
937 #define RSP_REASON_NO_SUCH_DOMAIN 6
938 #define RSP_REASON_FORWARDING_FAILED 7
939 #define RSP_REASON_CONNECT_FAILED 8
940 #define RSP_REASON_OUT_OF_MEMORY 9
941 #define RSP_REASON_INTERNAL_ERROR 10
944 * Response generated by CGI, blocker, or error handler
948 char *status; /**< HTTP status (string). */
949 struct list headers[1]; /**< List of header lines. */
950 char *head; /**< Formatted http response head. */
951 size_t head_length; /**< Length of http response head. */
952 char *body; /**< HTTP document body. */
953 size_t content_length; /**< Length of body, REQUIRED if binary body. */
954 int is_static; /**< Nonzero if the content will never change and
955 should be cached by the browser (e.g. images). */
956 int reason; /**< Why the response was generated in the first place. */
960 * A URL or a tag pattern.
964 /** The string which was parsed to produce this url_spec.
965 Used for debugging or display only. */
968 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
969 regex_t *host_regex;/**< Regex for host matching */
971 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
972 char **dvec; /**< List of pointers to the strings in dbuffer. */
973 int dcount; /**< How many parts to this domain? (length of dvec) */
974 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
975 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
977 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
979 regex_t *preg; /**< Regex for matching path part */
980 regex_t *tag_regex; /**< Regex for matching tags */
984 * If you declare a static url_spec, this is the value to initialize it to zero.
986 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
987 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
989 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
990 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
993 * Constant for host part matching in URLs. If set, indicates that the start of
994 * the pattern must match the start of the URL. E.g. this is not set for the
995 * pattern ".example.com", so that it will match both "example.com" and
996 * "www.example.com". It is set for the pattern "example.com", which makes it
997 * match "example.com" only, not "www.example.com".
999 #define ANCHOR_LEFT 1
1002 * Constant for host part matching in URLs. If set, indicates that the end of
1003 * the pattern must match the end of the URL. E.g. this is not set for the
1004 * pattern "ad.", so that it will match any host called "ad", irrespective
1005 * of how many subdomains are in the fully-qualified domain name.
1007 #define ANCHOR_RIGHT 2
1011 * An I/O buffer. Holds a string which can be appended to, and can have data
1012 * removed from the beginning.
1016 char *buf; /**< Start of buffer */
1017 char *cur; /**< Start of relevant data */
1018 char *eod; /**< End of relevant data */
1019 size_t size; /**< Size as malloc()ed */
1024 * Return the number of bytes in the I/O buffer associated with the passed
1025 * client_state pointer.
1028 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1032 * Remove any data in the I/O buffer associated with the passed
1033 * client_state pointer.
1035 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1037 /* Bits for csp->content_type bitmask: */
1038 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
1039 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
1040 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
1042 /* Although these are not, strictly speaking, content types
1043 * (they are content encodings), it is simple to handle them
1046 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
1047 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1050 * Flag to signal that the server declared the content type,
1051 * so we can differentiate between unknown and undeclared
1054 #define CT_DECLARED 0x0040U
1057 * The mask which includes all actions.
1059 #define ACTION_MASK_ALL (~0UL)
1062 * The most compatible set of actions - i.e. none.
1064 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1066 /** Action bitmap: Block the request. */
1067 #define ACTION_BLOCK 0x00000001UL
1068 /** Action bitmap: Deanimate if it's a GIF. */
1069 #define ACTION_DEANIMATE 0x00000002UL
1070 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1071 #define ACTION_DOWNGRADE 0x00000004UL
1072 /** Action bitmap: Fast redirects. */
1073 #define ACTION_FAST_REDIRECTS 0x00000008UL
1074 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
1075 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
1076 /** Action bitmap: Hide "From" header. */
1077 #define ACTION_HIDE_FROM 0x00000020UL
1078 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1079 #define ACTION_HIDE_REFERER 0x00000040UL
1080 /** Action bitmap: Hide "User-Agent" and similar headers. */
1081 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1082 /** Action bitmap: This is an image. */
1083 #define ACTION_IMAGE 0x00000100UL
1084 /** Action bitmap: Sets the image blocker. */
1085 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1086 /** Action bitmap: Prevent compression. */
1087 #define ACTION_NO_COMPRESSION 0x00000400UL
1088 /** Action bitmap: Change cookies to session only cookies. */
1089 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1090 /** Action bitmap: Block rending cookies. */
1091 #define ACTION_NO_COOKIE_READ 0x00001000UL
1092 /** Action bitmap: Block setting cookies. */
1093 #define ACTION_NO_COOKIE_SET 0x00002000UL
1094 /** Action bitmap: Override the forward settings in the config file */
1095 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
1096 /** Action bitmap: Block as empty document */
1097 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
1098 /** Action bitmap: Limit CONNECT requests to safe ports. */
1099 #define ACTION_LIMIT_CONNECT 0x00010000UL
1100 /** Action bitmap: Redirect request. */
1101 #define ACTION_REDIRECT 0x00020000UL
1102 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1103 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1104 /** Action bitmap: Overwrite Content-Type header. */
1105 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1106 /** Action bitmap: Crunch specified server header. */
1107 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1108 /** Action bitmap: Crunch specified client header */
1109 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1110 /** Action bitmap: Enable text mode by force */
1111 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1112 /** Action bitmap: Enable text mode by force */
1113 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1114 /** Action bitmap: Enable content-dispostion crunching */
1115 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1116 /** Action bitmap: Replace or block Last-Modified header */
1117 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1118 /** Action bitmap: Replace or block Accept-Language header */
1119 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1122 /** Action string index: How to deanimate GIFs */
1123 #define ACTION_STRING_DEANIMATE 0
1124 /** Action string index: Replacement for "From:" header */
1125 #define ACTION_STRING_FROM 1
1126 /** Action string index: How to block images */
1127 #define ACTION_STRING_IMAGE_BLOCKER 2
1128 /** Action string index: Replacement for "Referer:" header */
1129 #define ACTION_STRING_REFERER 3
1130 /** Action string index: Replacement for "User-Agent:" header */
1131 #define ACTION_STRING_USER_AGENT 4
1132 /** Action string index: Legal CONNECT ports. */
1133 #define ACTION_STRING_LIMIT_CONNECT 5
1134 /** Action string index: Server headers containing this pattern are crunched*/
1135 #define ACTION_STRING_SERVER_HEADER 6
1136 /** Action string index: Client headers containing this pattern are crunched*/
1137 #define ACTION_STRING_CLIENT_HEADER 7
1138 /** Action string index: Replacement for the "Accept-Language:" header*/
1139 #define ACTION_STRING_LANGUAGE 8
1140 /** Action string index: Replacement for the "Content-Type:" header*/
1141 #define ACTION_STRING_CONTENT_TYPE 9
1142 /** Action string index: Replacement for the "content-dispostion:" header*/
1143 #define ACTION_STRING_CONTENT_DISPOSITION 10
1144 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1145 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1146 /** Action string index: Replacement for the "Last-Modified:" header. */
1147 #define ACTION_STRING_LAST_MODIFIED 12
1148 /** Action string index: Redirect URL */
1149 #define ACTION_STRING_REDIRECT 13
1150 /** Action string index: Decode before redirect? */
1151 #define ACTION_STRING_FAST_REDIRECTS 14
1152 /** Action string index: Overriding forward rule. */
1153 #define ACTION_STRING_FORWARD_OVERRIDE 15
1154 /** Action string index: Reason for the block. */
1155 #define ACTION_STRING_BLOCK 16
1156 /** Action string index: what to do with the "X-Forwarded-For" header. */
1157 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
1158 /** Number of string actions. */
1159 #define ACTION_STRING_COUNT 18
1162 /* To make the ugly hack in sed easier to understand */
1163 #define CHECK_EVERY_HEADER_REMAINING 0
1166 /** Index into current_action_spec::multi[] for headers to add. */
1167 #define ACTION_MULTI_ADD_HEADER 0
1168 /** Index into current_action_spec::multi[] for content filters to apply. */
1169 #define ACTION_MULTI_FILTER 1
1170 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1171 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
1172 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1173 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
1174 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1175 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
1176 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1177 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
1178 /** Number of multi-string actions. */
1179 #define ACTION_MULTI_COUNT 6
1183 * This structure contains a list of actions to apply to a URL.
1184 * It only contains positive instructions - no "-" options.
1185 * It is not used to store the actions list itself, only for
1186 * url_actions() to return the current values.
1188 struct current_action_spec
1190 /** Actions to apply. A bit set to "1" means perform the action. */
1191 unsigned long flags;
1194 * Paramaters for those actions that require them.
1195 * Each entry is valid if & only if the corresponding entry in "flags" is
1198 char * string[ACTION_STRING_COUNT];
1200 /** Lists of strings for multi-string actions. */
1201 struct list multi[ACTION_MULTI_COUNT][1];
1206 * This structure contains a set of changes to actions.
1207 * It can contain both positive and negative instructions.
1208 * It is used to store an entry in the actions list.
1212 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1213 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1216 * Paramaters for those actions that require them.
1217 * Each entry is valid if & only if the corresponding entry in "flags" is
1220 char * string[ACTION_STRING_COUNT];
1222 /** Lists of strings to remove, for multi-string actions. */
1223 struct list multi_remove[ACTION_MULTI_COUNT][1];
1225 /** If nonzero, remove *all* strings from the multi-string action. */
1226 int multi_remove_all[ACTION_MULTI_COUNT];
1228 /** Lists of strings to add, for multi-string actions. */
1229 struct list multi_add[ACTION_MULTI_COUNT][1];
1234 * This structure is used to store action files.
1236 * It contains an URL or tag pattern, and the changes to
1237 * the actions. It's a linked list and should only be
1238 * free'd through unload_actions_file() unless there's
1239 * only a single entry.
1243 struct url_spec url[1]; /**< The URL or tag pattern. */
1245 struct action_spec *action; /**< Action settings that might be shared with
1246 the list entry before or after the current
1247 one and can't be free'd willy nilly. */
1249 struct url_actions *next; /**< Next action section in file, or NULL. */
1254 * Flags for use in csp->flags
1258 * Flag for csp->flags: Set if this client is processing data.
1259 * Cleared when the thread associated with this structure dies.
1261 #define CSP_FLAG_ACTIVE 0x01
1264 * Flag for csp->flags: Set if the server's reply is in "chunked"
1267 #define CSP_FLAG_CHUNKED 0x02
1270 * Flag for csp->flags: Set if this request was enforced, although it would
1271 * normally have been blocked.
1273 #define CSP_FLAG_FORCED 0x04
1276 * Flag for csp->flags: Set if any modification to the body was done.
1278 #define CSP_FLAG_MODIFIED 0x08
1281 * Flag for csp->flags: Set if request was blocked.
1283 #define CSP_FLAG_REJECTED 0x10
1286 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1288 #define CSP_FLAG_TOGGLED_ON 0x20
1291 * Flag for csp->flags: Set if adding the 'Connection: close' header
1292 * for the client isn't necessary.
1294 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
1297 * Flag for csp->flags: Set if adding the 'Connection: close' header
1298 * for the server isn't necessary.
1300 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1303 * Flag for csp->flags: Signals header parsers whether they
1304 * are parsing server or client headers.
1306 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1309 * Flag for csp->flags: Set if adding the Host: header
1312 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1315 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1316 * XXX: As we now have tags we might as well ditch this.
1318 #define CSP_FLAG_NO_FILTERING 0x00000400UL
1321 * Flag for csp->flags: Set the client IP has appended to
1322 * an already existing X-Forwarded-For header in which case
1323 * no new header has to be generated.
1325 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800UL
1328 * Flags for use in return codes of child processes
1332 * Flag for process return code: Set if exiting porcess has been toggled
1333 * during its lifetime.
1335 #define RC_FLAG_TOGGLED 0x10
1338 * Flag for process return code: Set if exiting porcess has blocked its
1341 #define RC_FLAG_BLOCKED 0x20
1344 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1347 #define MAX_AF_FILES 10
1350 * The state of a Privoxy processing thread.
1354 /** The proxy's configuration */
1355 struct configuration_spec * config;
1357 /** The actions to perform on the current request */
1358 struct current_action_spec action[1];
1360 /** socket to talk to client (web browser) */
1363 /** socket to talk to server (web server or proxy) */
1366 /** Multi-purpose flag container, see CSP_FLAG_* above */
1369 /** Client PC's IP address, as reported by the accept() function.
1372 /** Client PC's IP address, as reported by the accept() function.
1376 /** The URL that was requested */
1377 struct http_request http[1];
1380 * The final forwarding settings.
1381 * XXX: Currently this is only used for forward-override,
1382 * so we can free the space in sweep.
1384 struct forward_spec * fwd;
1386 /** An I/O buffer used for buffering data read from the network */
1389 /** List of all headers for this request */
1390 struct list headers[1];
1392 /** List of all tags that apply to this request */
1393 struct list tags[1];
1395 /** MIME-Type key, see CT_* above */
1396 unsigned int content_type;
1398 /** Actions files associated with this client */
1399 struct file_list *actions_list[MAX_AF_FILES];
1401 /** pcrs job files. */
1402 struct file_list *rlist[MAX_AF_FILES];
1404 /** Length after content modification. */
1405 size_t content_length;
1407 #ifdef FEATURE_TRUST
1410 struct file_list *tlist;
1412 #endif /* def FEATURE_TRUST */
1415 * Failure reason to embedded in the CGI error page,
1416 * or NULL. Currently only used for socks errors.
1418 char *error_message;
1420 /** Next thread in linked list. Only read or modify from the main thread! */
1421 struct client_state *next;
1426 * A function to add a header
1428 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1431 * A function to process a header
1433 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1437 * List of available CGI functions.
1439 struct cgi_dispatcher
1441 /** The URL of the CGI, relative to the CGI root. */
1442 const char * const name;
1444 /** The handler function for the CGI */
1445 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1447 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1448 const char * const description;
1450 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1456 * A data file used by Privoxy. Kept in a linked list.
1461 * This is a pointer to the data structures associated with the file.
1462 * Read-only once the structure has been created.
1467 * The unloader function.
1468 * Normally NULL. When we are finished with file (i.e. when we have
1469 * loaded a new one), set to a pointer to an unloader function.
1470 * Unloader will be called by sweep() (called from main loop) when
1471 * all clients using this file are done. This prevents threading
1474 void (*unloader)(void *);
1477 * Used internally by sweep(). Do not access from elsewhere.
1482 * File last-modified time, so we can check if file has been changed.
1483 * Read-only once the structure has been created.
1485 time_t lastmodified;
1488 * The full filename.
1493 * Pointer to next entry in the linked list of all "file_list"s.
1494 * This linked list is so that sweep() can navigate it.
1495 * Since sweep() can remove items from the list, we must be careful
1496 * to only access this value from main thread (when we know sweep
1497 * won't be running).
1499 struct file_list *next;
1503 #ifdef FEATURE_TRUST
1506 * The format of a trust file when loaded into memory.
1510 struct url_spec url[1]; /**< The URL pattern */
1511 int reject; /**< FIXME: Please document this! */
1512 struct block_spec *next; /**< Next entry in linked list */
1516 * Arbitrary limit for the number of trusted referrers.
1518 #define MAX_TRUSTED_REFERRERS 512
1520 #endif /* def FEATURE_TRUST */
1523 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1524 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1525 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1526 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1530 * How to forward a connection to a parent proxy.
1534 /** URL pattern that this forward_spec is for. */
1535 struct url_spec url[1];
1537 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1540 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1543 /** SOCKS server port. */
1546 /** Parent HTTP proxy hostname, or NULL for none. */
1549 /** Parent HTTP proxy port. */
1552 /** Next entry in the linked list. */
1553 struct forward_spec *next;
1558 * Initializer for a static struct forward_spec.
1560 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1562 /* Supported filter types */
1563 #define FT_CONTENT_FILTER 0
1564 #define FT_CLIENT_HEADER_FILTER 1
1565 #define FT_SERVER_HEADER_FILTER 2
1566 #define FT_CLIENT_HEADER_TAGGER 3
1567 #define FT_SERVER_HEADER_TAGGER 4
1569 #define MAX_FILTER_TYPES 5
1572 * This struct represents one filter (one block) from
1573 * the re_filterfile. If there is more than one filter
1574 * in the file, the file will be represented by a
1575 * chained list of re_filterfile specs.
1577 struct re_filterfile_spec
1579 char *name; /**< Name from FILTER: statement in re_filterfile. */
1580 char *description; /**< Description from FILTER: statement in re_filterfile. */
1581 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1582 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1583 int type; /**< Filter type (content, client-header, server-header). */
1584 int dynamic; /**< Set to one if the pattern might contain variables
1585 and has to be recompiled for every request. */
1586 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1592 #define ACL_PERMIT 1 /**< Accept connection request */
1593 #define ACL_DENY 2 /**< Reject connection request */
1596 * An IP address pattern. Used to specify networks in the ACL.
1598 struct access_control_addr
1600 unsigned long addr; /**< The IP address as an integer. */
1601 unsigned long mask; /**< The network mask as an integer. */
1602 unsigned long port; /**< The port number. */
1606 * An access control list (ACL) entry.
1608 * This is a linked list.
1610 struct access_control_list
1612 struct access_control_addr src[1]; /**< Client IP address */
1613 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1615 short action; /**< ACL_PERMIT or ACL_DENY */
1616 struct access_control_list *next; /**< The next entry in the ACL. */
1619 #endif /* def FEATURE_ACL */
1622 /** Maximum number of loaders (actions, re_filter, ...) */
1626 /** configuration_spec::feature_flags: CGI actions editor. */
1627 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1629 /** configuration_spec::feature_flags: Web-based toggle. */
1630 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1632 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1633 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1635 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1636 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1638 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1639 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1641 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1642 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32
1644 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1645 #define RUNTIME_FEATURE_CGI_CRUNCHING 64
1649 * Data loaded from the configuration file.
1651 * (Anomaly: toggle is still handled through a global, not this structure)
1653 struct configuration_spec
1658 /** Nonzero to enable multithreading. */
1662 * Bitmask of features that can be enabled/disabled through the config
1663 * file. Currently defined bits:
1665 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1666 * - RUNTIME_FEATURE_CGI_TOGGLE
1667 * - RUNTIME_FEATURE_HTTP_TOGGLE
1668 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1670 unsigned feature_flags;
1672 /** The log file name. */
1673 const char *logfile;
1675 /** The config file directory. */
1676 const char *confdir;
1678 /** The directory for customized CGI templates. */
1679 const char *templdir;
1681 /** The log file directory. */
1684 /** The full paths to the actions files. */
1685 const char *actions_file[MAX_AF_FILES];
1687 /** The short names of the actions files. */
1688 const char *actions_file_short[MAX_AF_FILES];
1690 /** The administrator's email address */
1691 char *admin_address;
1693 /** A URL with info on this proxy */
1694 char *proxy_info_url;
1696 /** URL to the user manual (on our website or local copy) */
1699 /** The file names of the pcre filter files. */
1700 const char *re_filterfile[MAX_AF_FILES];
1702 /** The short names of the pcre filter files. */
1703 const char *re_filterfile_short[MAX_AF_FILES];
1705 /** The hostname to show on CGI pages, or NULL to use the real one. */
1706 const char *hostname;
1708 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1711 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1714 /** Size limit for IOB */
1715 size_t buffer_limit;
1717 #ifdef FEATURE_TRUST
1719 /** The file name of the trust file. */
1720 const char * trustfile;
1722 /** FIXME: DOCME: Document this. */
1723 struct list trust_info[1];
1725 /** FIXME: DOCME: Document this. */
1726 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1728 #endif /* def FEATURE_TRUST */
1732 /** The access control list (ACL). */
1733 struct access_control_list *acl;
1735 #endif /* def FEATURE_ACL */
1737 /** Information about parent proxies (forwarding). */
1738 struct forward_spec *forward;
1740 /** Number of retries in case a forwarded connection attempt fails */
1741 int forwarded_connect_retries;
1743 /** All options from the config file, HTML-formatted. */
1746 /** The configuration file object. */
1747 struct file_list *config_file_list;
1749 /** List of loaders */
1750 int (*loaders[NLOADERS])(struct client_state *);
1752 /** Nonzero if we need to bind() to the new port. */
1756 /** Calculates the number of elements in an array, using sizeof. */
1757 #define SZ(X) (sizeof(X) / sizeof(*X))
1759 #ifdef FEATURE_FORCE_LOAD
1760 /** The force load URL prefix. */
1761 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1762 #endif /* def FEATURE_FORCE_LOAD */
1764 #ifdef FEATURE_NO_GIFS
1765 /** The MIME type for images ("image/png" or "image/gif"). */
1766 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1768 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1769 #endif /* def FEATURE_NO_GIFS */
1776 /** URL for the Privoxy home page. */
1777 #define HOME_PAGE_URL "http://www.privoxy.org/"
1779 /** URL for the Privoxy user manual. */
1780 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1782 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1783 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1785 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1786 #define CONFIG_HELP_PREFIX "config.html#"
1789 * The "hosts" to intercept and display CGI pages.
1790 * First one is a hostname only, second one can specify host and path.
1793 * 1) Do not specify the http: prefix
1794 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1795 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1797 #define CGI_SITE_1_HOST "p.p"
1798 #define CGI_SITE_2_HOST "config.privoxy.org"
1799 #define CGI_SITE_2_PATH ""
1802 * The prefix for CGI pages. Written out in generated HTML.
1803 * INCLUDES the trailing slash.
1805 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1811 #endif /* ndef PROJECT_H_INCLUDED */