1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.121 2008/10/09 18:21:41 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.121 2008/10/09 18:21:41 fabiankeil
41 * Flush work-in-progress changes to keep outgoing connections
42 * alive where possible. Incomplete and mostly #ifdef'd out.
44 * Revision 1.120 2008/09/21 13:36:52 fabiankeil
45 * If change-x-forwarded-for{add} is used and the client
46 * sends multiple X-Forwarded-For headers, append the client's
47 * IP address to each one of them. "Traditionally" we would
48 * lose all but the last one.
50 * Revision 1.119 2008/09/20 10:04:33 fabiankeil
51 * Remove hide-forwarded-for-headers action which has
52 * been obsoleted by change-x-forwarded-for{block}.
54 * Revision 1.118 2008/09/19 15:26:29 fabiankeil
55 * Add change-x-forwarded-for{} action to block or add
56 * X-Forwarded-For headers. Mostly based on code removed
59 * Revision 1.117 2008/08/30 12:03:07 fabiankeil
60 * Remove FEATURE_COOKIE_JAR.
62 * Revision 1.116 2008/05/20 16:05:02 fabiankeil
63 * Move parsers structure definition from project.h to parsers.h.
65 * Revision 1.115 2008/05/19 16:57:20 fabiankeil
66 * Declare all members of the parsers structure immutable.
68 * Revision 1.114 2008/04/11 16:35:39 fabiankeil
69 * Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
71 * Revision 1.113 2008/04/10 14:41:04 fabiankeil
72 * Ditch url_spec's path member now that it's no longer used.
74 * Revision 1.112 2008/04/06 15:18:34 fabiankeil
75 * Oh well, rename the --enable-pcre-host-patterns option to
76 * --enable-extended-host-patterns as it's not really PCRE syntax.
78 * Revision 1.111 2008/04/06 14:54:26 fabiankeil
79 * Use PCRE syntax in host patterns when configured
80 * with --enable-pcre-host-patterns.
82 * Revision 1.110 2008/03/29 12:13:46 fabiankeil
83 * Remove send-wafer and send-vanilla-wafer actions.
85 * Revision 1.109 2008/03/28 15:13:41 fabiankeil
86 * Remove inspect-jpegs action.
88 * Revision 1.108 2008/03/27 18:27:36 fabiankeil
89 * Remove kill-popups action.
91 * Revision 1.107 2008/03/26 18:07:08 fabiankeil
92 * Add hostname directive. Closes PR#1918189.
94 * Revision 1.106 2008/03/24 11:21:03 fabiankeil
95 * Share the action settings for multiple patterns in the same
96 * section so we waste less memory for gigantic block lists
97 * (and load them slightly faster). Reported by Franz Schwartau.
99 * Revision 1.105 2008/03/21 11:16:27 fabiankeil
100 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
102 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
103 * Remove the treat-forbidden-connects-like-blocks action. We now
104 * use the "blocked" page for forbidden CONNECT requests by default.
106 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
107 * Let the block action take the reason for the block
108 * as argument and show it on the "blocked" page.
110 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
111 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
113 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
114 * Remove now-obsolete csp member x_forwarded.
116 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
117 * - Allow port lists in url patterns.
118 * - Ditch unused url_spec member pathlen.
120 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
121 * As Hal noticed, checking dispatch_cgi() as the last cruncher
122 * looks like a bug if CGI requests are blocked unintentionally,
123 * so don't do it unless the user enabled the new config option
124 * "allow-cgi-request-crunching".
126 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
127 * Add new csp->content_type flag (CT_DECLARED).
129 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
130 * - Remove some left-overs from the switch to dedicated header filters.
131 * - Adjust "X-Filter: No" to disable dedicated header filters.
132 * - Prepare for forward-override{}
134 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
135 * Ditch the csp member cookie_list[] which isn't used anymore.
137 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
138 * Introduce dynamic pcrs jobs that can resolve variables.
140 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
141 * Introduce tags as alternative way to specify which
142 * actions apply to a request. At the moment tags can be
143 * created based on client and server headers.
145 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
146 * Use dedicated header filter actions instead of abusing "filter".
147 * Replace "filter-client-headers" and "filter-client-headers"
148 * with "server-header-filter" and "client-header-filter".
150 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
151 * New config option: enforce-blocks.
153 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
154 * Add some CSP_FLAGs for the header parsers.
156 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
157 * Add new http_response member to save
158 * the reason why the response was generated.
160 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
161 * Add new config option "templdir" to
162 * change the templates directory.
164 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
165 * Add csp->error_message for failure reasons
166 * that should be embedded into the CGI pages.
168 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
169 * Integrate a modified version of Wil Mahan's
170 * zlib patch (PR #895531).
172 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
173 * Added config option accept-intercepted-requests
174 * and disabled it by default.
176 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
177 * Fix gcc43 compiler warnings and a comment.
179 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
180 * Add config option "split-large-forms"
181 * to work around the browser bug reported
184 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
185 * Moved HTTP snipplets into jcc.c. They aren't
186 * used anywhere else.
188 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
189 * Doubled size of HOSTENT_BUFFER_SIZE to mask
190 * problems with gethostbyname_r and some
191 * /etc/hosts configurations. Only a workaround
192 * until we get the real fix ready.
193 * Thanks FĂ©lix Rauch for reporting.
195 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
197 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
198 * Respond with 400 and a short text message
199 * if the client tries to use Privoxy as FTP proxy.
201 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
202 * Added config option enable-remote-http-toggle
203 * to specify if Privoxy should recognize special
204 * headers (currently only X-Filter) to change its
205 * behaviour. Disabled by default.
207 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
208 * Make number of retries in case of forwarded-connect problems
209 * a config file option (forwarded-connect-retries) and use 0 as
212 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
213 * Work around a buffer overflow that caused Privoxy to
214 * segfault if too many trusted referrers were used. Good
215 * enough for now, but should be replaced with a real
216 * solution after the next release.
218 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
221 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
222 * Split filter-headers{} into filter-client-headers{}
223 * and filter-server-headers{}.
224 * Added parse_header_time() to share some code.
225 * Replaced timegm() with mktime().
227 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
228 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
230 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
231 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
232 * with what was really the latest development (the v_3_0_branch branch)
234 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
235 * Multiple filter file support
237 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
238 * Add the ability to check jpeg images for invalid
239 * lengths of comment blocks. Defensive strategy
240 * against the exploit:
241 * Microsoft Security Bulletin MS04-028
242 * Buffer Overrun in JPEG Processing (GDI+) Could
243 * Allow Code Execution (833987)
244 * Enabled with +inspect-jpegs in actions files.
246 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
247 * Updated the copyright note
249 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
250 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
252 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
253 * Introduced RC_FLAG_* flags for use in child process return code
255 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
256 * Added flag to each cgi_dispatcher that allows or denies
257 * external linking and removed const qualifier from
258 * struct list_entry.str.
260 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
261 * - Include config.h for access to config data
262 * - Include <pcre*.h> depending on where they are
264 * Revision 1.72 2002/05/14 21:35:49 oes
265 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
266 * because of split in user-manual
268 * Revision 1.71 2002/05/12 21:39:36 jongfoster
269 * - Adding Doxygen-style comments to structures and #defines.
271 * Revision 1.70 2002/05/12 16:05:50 jongfoster
272 * Fixing ACTION_MASK_ALL to be unsigned long rather than
273 * just unsigned int. I don't know if anyone is porting
274 * Privoxy to 16-bit platforms, but if so, +limit-connect
275 * wouldn't have worked because of this bug.
277 * Revision 1.69 2002/05/08 16:00:16 oes
278 * Added size member to struct iob, so it can
279 * be alloced larger than needed.
281 * Revision 1.68 2002/04/26 12:56:00 oes
282 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
284 * Revision 1.67 2002/04/24 02:12:43 oes
285 * - Jon's multiple AF patch:
286 * - Make csp->actions_list an array
287 * - #define MAX_AF_FILES
288 * - Moved CGI_PARAM_LEN_MAX (500) here
290 * Revision 1.66 2002/04/15 19:06:43 jongfoster
293 * Revision 1.65 2002/04/04 00:36:36 gliptak
294 * always use pcre for matching
296 * Revision 1.64 2002/04/03 22:28:03 gliptak
297 * Removed references to gnu_regex
299 * Revision 1.63 2002/03/31 17:19:00 jongfoster
300 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
302 * Revision 1.62 2002/03/26 22:48:49 swa
305 * Revision 1.61 2002/03/26 22:29:55 swa
306 * we have a new homepage!
308 * Revision 1.60 2002/03/24 15:52:17 jongfoster
309 * Changing CGI URL prefixes for new name
311 * Revision 1.59 2002/03/24 15:23:33 jongfoster
314 * Revision 1.58 2002/03/24 13:25:43 swa
315 * name change related issues
317 * Revision 1.57 2002/03/16 20:28:34 oes
318 * Added descriptions to the filters so users will know what they select in the cgi editor
320 * Revision 1.56 2002/03/13 20:27:30 oes
321 * Fixing bug with CT_TABOO
323 * Revision 1.55 2002/03/12 01:42:50 oes
324 * Introduced modular filters
326 * Revision 1.54 2002/03/09 20:03:52 jongfoster
327 * - Making various functions return int rather than size_t.
328 * (Undoing a recent change). Since size_t is unsigned on
329 * Windows, functions like read_socket that return -1 on
330 * error cannot return a size_t.
332 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
333 * crashes, and also frequently caused JB to jump to 100%
334 * CPU and stay there. (Because it thought it had just
335 * read ((unsigned)-1) == 4Gb of data...)
337 * - The signature of write_socket has changed, it now simply
338 * returns success=0/failure=nonzero.
340 * - Trying to get rid of a few warnings --with-debug on
341 * Windows, I've introduced a new type "jb_socket". This is
342 * used for the socket file descriptors. On Windows, this
343 * is SOCKET (a typedef for unsigned). Everywhere else, it's
344 * an int. The error value can't be -1 any more, so it's
345 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
346 * Windows it maps to the #define INVALID_SOCKET.)
348 * - The signature of bind_port has changed.
350 * Revision 1.53 2002/03/08 16:48:55 oes
351 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
353 * Revision 1.52 2002/03/07 03:46:17 oes
354 * Fixed compiler warnings
356 * Revision 1.51 2002/03/05 04:52:42 oes
357 * Deleted non-errlog debugging code
359 * Revision 1.50 2002/03/04 19:32:07 oes
360 * Changed default port to 8118
362 * Revision 1.49 2002/03/04 18:28:55 oes
363 * Deleted PID_FILE_NAME
365 * Revision 1.48 2002/03/03 14:50:40 oes
366 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
368 * Revision 1.47 2002/02/20 23:15:13 jongfoster
369 * Parsing functions now handle out-of-memory gracefully by returning
372 * Revision 1.46 2002/01/17 21:06:09 jongfoster
373 * Now #defining the URLs of the config interface
375 * Minor changes to struct http_request and struct url_spec due to
376 * standardizing that struct http_request is used to represent a URL, and
377 * struct url_spec is used to represent a URL pattern. (Before, URLs were
378 * represented as seperate variables and a partially-filled-in url_spec).
380 * Revision 1.45 2002/01/09 14:33:27 oes
381 * Added HOSTENT_BUFFER_SIZE
383 * Revision 1.44 2001/12/30 14:07:32 steudten
384 * - Add signal handling (unix)
385 * - Add SIGHUP handler (unix)
386 * - Add creation of pidfile (unix)
387 * - Add action 'top' in rc file (RH)
388 * - Add entry 'SIGNALS' to manpage
389 * - Add exit message to logfile (unix)
391 * Revision 1.43 2001/11/22 21:57:51 jongfoster
392 * Making action_spec->flags into an unsigned long rather than just an
394 * Adding ACTION_NO_COOKIE_KEEP
396 * Revision 1.42 2001/11/05 21:42:41 steudten
397 * Include DBG() macro.
399 * Revision 1.41 2001/10/28 19:12:06 jongfoster
400 * Adding ijb_toupper()
402 * Revision 1.40 2001/10/26 17:40:47 oes
403 * Moved ijb_isspace and ijb_tolower to project.h
404 * Removed http->user_agent, csp->referrer and csp->accept_types
406 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
407 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
408 * macro when called with a cast; so moving the cast to the macro def'n
409 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
410 * doesn't make macro expansion complain. Hope this works for everyone else
413 * Revision 1.38 2001/10/23 21:19:04 jongfoster
414 * New error-handling support: jb_err type and JB_ERR_xxx constants
415 * CGI functions now return a jb_err, and their parameters map is const.
416 * Support for RUNTIME_FEATUREs to enable/disable config editor
417 * Adding a few comments
419 * Revision 1.37 2001/10/14 22:14:01 jongfoster
420 * Removing name_length field from struct cgi_dispatcher, as this is
421 * now calculated at runtime from the "name" field.
423 * Revision 1.36 2001/10/10 16:45:15 oes
424 * Added LIMIT_CONNECT action and string
425 * Fixed HTTP message line termination
426 * Added CFORBIDDEN HTTP message
428 * Revision 1.35 2001/10/07 18:06:43 oes
429 * Added status member to struct http_request
431 * Revision 1.34 2001/10/07 15:45:25 oes
432 * Added url member to struct http_request and commented all
437 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
439 * Replaced struct client_state members rejected,
440 * force, active and toggled_on with "flags" bitmap.
442 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
444 * Added buffer_limit to struct configuration_spec
446 * Revision 1.33 2001/09/20 13:30:08 steudten
448 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
449 * Last case will set z to NULL in free(z) and thats bad..
451 * Revision 1.32 2001/09/16 23:02:51 jongfoster
454 * Revision 1.31 2001/09/16 13:20:29 jongfoster
455 * Rewrite of list library. Now has seperate header and list_entry
456 * structures. Also added a large sprinking of assert()s to the list
459 * Revision 1.30 2001/09/13 23:52:00 jongfoster
460 * Support for both static and dynamically generated CGI pages
462 * Revision 1.29 2001/09/13 23:29:43 jongfoster
463 * Defining FORWARD_SPEC_INITIALIZER
465 * Revision 1.28 2001/09/13 23:05:50 jongfoster
466 * Changing the string paramater to the header parsers a "const".
468 * Revision 1.27 2001/08/05 16:06:20 jongfoster
469 * Modifiying "struct map" so that there are now separate header and
470 * "map_entry" structures. This means that functions which modify a
471 * map no longer need to return a pointer to the modified map.
472 * Also, it no longer reverses the order of the entries (which may be
473 * important with some advanced template substitutions).
475 * Revision 1.26 2001/07/30 22:08:36 jongfoster
476 * Tidying up #defines:
477 * - All feature #defines are now of the form FEATURE_xxx
478 * - Permanently turned off WIN_GUI_EDIT
479 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
481 * Revision 1.25 2001/07/29 18:43:08 jongfoster
482 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
485 * Revision 1.24 2001/07/25 17:20:27 oes
486 * Introduced http->user_agent
488 * Revision 1.23 2001/07/18 12:32:23 oes
489 * - Added ACTION_STRING_DEANIMATE
490 * - moved #define freez from jcc.h to project.h
492 * Revision 1.22 2001/07/15 17:51:41 jongfoster
493 * Renaming #define STATIC to STATIC_PCRE
495 * Revision 1.21 2001/07/13 14:03:19 oes
496 * - Reorganized regex header inclusion and #defines to
497 * comply to the scheme in configure.in
498 * - Added csp->content_type and its CT_* keys
499 * - Added ACTION_DEANIMATE
500 * - Removed all #ifdef PCRS
502 * Revision 1.20 2001/06/29 21:45:41 oes
503 * Indentation, CRLF->LF, Tab-> Space
505 * Revision 1.19 2001/06/29 13:33:36 oes
506 * - Improved comments
507 * - Introduced http_request.host_ip_addr_str
508 * - Introduced http_response.head_length
509 * - Introduced config.my_ip_addr_str, config.my_hostname,
510 * config.admin_address and config.proxy_info_url
511 * - Removed config.proxy_args_header and config.proxy_args_trailer,
512 * renamed config.proxy_args_invocation to config.proxy_args
513 * - Removed HTML snipplets and GIFs
514 * - Removed logentry from cancelled commit
516 * Revision 1.18 2001/06/09 10:57:39 jongfoster
517 * Adding definition of BUFFER_SIZE.
518 * Changing struct cgi_dispatcher to use "const" strings.
520 * Revision 1.17 2001/06/07 23:15:09 jongfoster
521 * Merging ACL and forward files into config file.
522 * Moving struct gateway members into struct forward_spec
523 * Removing config->proxy_args_gateways
524 * Cosmetic: Adding a few comments
526 * Revision 1.16 2001/06/04 18:31:58 swa
527 * files are now prefixed with either `confdir' or `logdir'.
528 * `make redhat-dist' replaces both entries confdir and logdir
531 * Revision 1.15 2001/06/04 11:28:53 swa
532 * redirect did not work due to missing /
534 * Revision 1.14 2001/06/03 11:03:48 oes
536 * added struct http_response,
537 * changed struct interceptors to struct cgi_dispatcher,
538 * moved HTML stuff to cgi.h
540 * Revision 1.13 2001/06/01 20:05:36 jongfoster
541 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
542 * constant, and removed csp->tinygif.
544 * Revision 1.12 2001/06/01 18:49:17 jongfoster
545 * Replaced "list_share" with "list" - the tiny memory gain was not
546 * worth the extra complexity.
548 * Revision 1.11 2001/06/01 10:32:47 oes
549 * Added constants for anchoring selection bitmap
551 * Revision 1.10 2001/05/31 21:33:53 jongfoster
552 * Changes for new actions file, replacing permissionsfile
553 * and parts of the config file. Also added support for
556 * Revision 1.9 2001/05/31 17:32:31 oes
558 * - Enhanced domain part globbing with infix and prefix asterisk
559 * matching and optional unanchored operation
561 * Revision 1.8 2001/05/29 20:09:15 joergs
562 * HTTP_REDIRECT_TEMPLATE fixed.
564 * Revision 1.7 2001/05/29 09:50:24 jongfoster
565 * Unified blocklist/imagelist/actionslist.
566 * File format is still under discussion, but the internal changes
569 * Also modified interceptor behaviour:
570 * - We now intercept all URLs beginning with one of the following
571 * prefixes (and *only* these prefixes):
573 * * http://ijbswa.sf.net/config/
574 * * http://ijbswa.sourceforge.net/config/
575 * - New interceptors "home page" - go to http://i.j.b/ to see it.
576 * - Internal changes so that intercepted and fast redirect pages
577 * are not replaced with an image.
578 * - Interceptors now have the option to send a binary page direct
579 * to the client. (i.e. ijb-send-banner uses this)
580 * - Implemented show-url-info interceptor. (Which is why I needed
581 * the above interceptors changes - a typical URL is
582 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
583 * The previous mechanism would not have intercepted that, and
584 * if it had been intercepted then it then it would have replaced
587 * Revision 1.6 2001/05/27 22:17:04 oes
589 * - re_process_buffer no longer writes the modified buffer
590 * to the client, which was very ugly. It now returns the
591 * buffer, which it is then written by chat.
593 * - content_length now adjusts the Content-Length: header
594 * for modified documents rather than crunch()ing it.
595 * (Length info in csp->content_length, which is 0 for
596 * unmodified documents)
598 * - For this to work, sed() is called twice when filtering.
600 * Revision 1.5 2001/05/26 00:28:36 jongfoster
601 * Automatic reloading of config file.
602 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
603 * Most of the global variables have been moved to a new
604 * struct configuration_spec, accessed through csp->config->globalname
605 * Most of the globals remaining are used by the Win32 GUI.
607 * Revision 1.4 2001/05/22 18:46:04 oes
609 * - Enabled filtering banners by size rather than URL
610 * by adding patterns that replace all standard banner
611 * sizes with the "Junkbuster" gif to the re_filterfile
613 * - Enabled filtering WebBugs by providing a pattern
614 * which kills all 1x1 images
616 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
617 * which is selected by the (nonstandard and therefore
618 * capital) letter 'U' in the option string.
619 * It causes the quantifiers to be ungreedy by default.
620 * Appending a ? turns back to greedy (!).
622 * - Added a new interceptor ijb-send-banner, which
623 * sends back the "Junkbuster" gif. Without imagelist or
624 * MSIE detection support, or if tinygif = 1, or the
625 * URL isn't recognized as an imageurl, a lame HTML
626 * explanation is sent instead.
628 * - Added new feature, which permits blocking remote
629 * script redirects and firing back a local redirect
631 * The feature is conditionally compiled, i.e. it
632 * can be disabled with --disable-fast-redirects,
633 * plus it must be activated by a "fast-redirects"
634 * line in the config file, has its own log level
635 * and of course wants to be displayed by show-proxy-args
636 * Note: Boy, all the #ifdefs in 1001 locations and
637 * all the fumbling with configure.in and acconfig.h
638 * were *way* more work than the feature itself :-(
640 * - Because a generic redirect template was needed for
641 * this, tinygif = 3 now uses the same.
643 * - Moved GIFs, and other static HTTP response templates
648 * - Removed some >400 CRs again (Jon, you really worked
651 * Revision 1.3 2001/05/20 01:21:20 jongfoster
652 * Version 2.9.4 checkin.
653 * - Merged popupfile and cookiefile, and added control over PCRS
654 * filtering, in new "actionsfile".
655 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
656 * file error you now get a message box (in the Win32 GUI) rather
657 * than the program exiting with no explanation.
658 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
660 * - Removed tabs from "config"
661 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
662 * - Bumped up version number.
664 * Revision 1.2 2001/05/17 23:01:01 oes
665 * - Cleaned CRLF's from the sources and related files
667 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
668 * Initial import of version 2.9.3 source tree
671 *********************************************************************/
674 /* Declare struct FILE for vars and funcs. */
677 /* Need time_t for file_list */
679 /* Needed for pcre choice */
683 * Include appropriate regular expression libraries.
684 * Note that pcrs and pcre (native) are needed for cgi
685 * and are included anyway.
691 # ifdef PCRE_H_IN_SUBDIR
692 # include <pcre/pcre.h>
705 # include "pcreposix.h"
707 # ifdef PCRE_H_IN_SUBDIR
708 # include <pcre/pcreposix.h>
710 # include <pcreposix.h>
716 #endif /* def AMIGA */
720 * I don't want to have to #include all this just for the declaration
721 * of SOCKET. However, it looks like we have to...
736 typedef SOCKET jb_socket;
738 #define JB_INVALID_SOCKET INVALID_SOCKET
740 #else /* ndef _WIN32 */
743 * The type used by sockets. On UNIX it's an int. Microsoft decided to
744 * make it an unsigned.
746 typedef int jb_socket;
749 * The error value used for variables of type jb_socket. On UNIX this
750 * is -1, however Microsoft decided to make socket handles unsigned, so
751 * they use a different value.
754 #define JB_INVALID_SOCKET (-1)
756 #endif /* ndef _WIN32 */
760 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
765 #define JB_ERR_OK 0 /**< Success, no error */
766 #define JB_ERR_MEMORY 1 /**< Out of memory */
767 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
768 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
769 #define JB_ERR_PARSE 4 /**< Error parsing file */
770 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
771 CGI actions editor. */
772 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
775 * This macro is used to free a pointer that may be NULL.
776 * It also sets the variable to NULL after it's been freed.
777 * The paramater should be a simple variable without side effects.
779 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
783 * Fix a problem with Solaris. There should be no effect on other
786 * Solaris's isspace() is a macro which uses it's argument directly
787 * as an array index. Therefore we need to make sure that high-bit
788 * characters generate +ve values, and ideally we also want to make
789 * the argument match the declared parameter type of "int".
791 * Note: Remember to #include <ctype.h> if you use these macros.
793 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
794 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
795 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
798 * Use for statically allocated buffers if you have no other choice.
799 * Remember to check the length of what you write into the buffer
800 * - we don't want any buffer overflows!
802 #define BUFFER_SIZE 5000
805 * Max length of CGI parameters (arbitrary limit).
807 #define CGI_PARAM_LEN_MAX 500
810 * Buffer size for capturing struct hostent data in the
811 * gethostby(name|addr)_r library calls. Since we don't
812 * loop over gethostbyname_r, the buffer must be sufficient
813 * to accomodate multiple IN A RRs, as used in DNS round robin
814 * load balancing. W3C's wwwlib uses 1K, so that should be
815 * good enough for us, too.
818 * XXX: Temporary doubled, for some configurations
819 * 1K is still too small and we didn't get the
820 * real fix ready for inclusion.
822 #define HOSTENT_BUFFER_SIZE 2048
825 * Do not use. Originally this was so that you can
826 * say "while (FOREVER) { ...do something... }".
827 * However, this gives a warning with some compilers (e.g. VC++).
828 * Instead, use "for (;;) { ...do something... }".
833 * Default IP address to listen on, as a string.
834 * Set to "127.0.0.1".
836 #define HADDR_DEFAULT "127.0.0.1"
839 * Default port to listen on, as a number.
842 #define HADDR_PORT 8118
845 /* Forward def for struct client_state */
846 struct configuration_spec;
850 * Entry in a linked list of strings.
855 * The string pointer. It must point to a dynamically malloc()ed
856 * string or be NULL for the list functions to work. In the latter
857 * case, just be careful next time you iterate through the list in
862 /** Next entry in the linked list, or NULL if no more. */
863 struct list_entry *next;
867 * A header for a linked list of strings.
871 /** First entry in the list, or NULL if the list is empty. */
872 struct list_entry *first;
874 /** Last entry in the list, or NULL if the list is empty. */
875 struct list_entry *last;
880 * An entry in a map. This is a name=value pair.
884 /** The key for the map. */
886 /** The value associated with that key. */
888 /** The next map entry, or NULL if none. */
889 struct map_entry *next;
893 * A map from a string to another string.
894 * This is used for the paramaters passed in a HTTP GET request, and
895 * to store the exports when the CGI interface is filling in a template.
899 /** The first map entry, or NULL if the map is empty. */
900 struct map_entry *first;
901 /** The last map entry, or NULL if the map is empty. */
902 struct map_entry *last;
907 * A HTTP request. This includes the method (GET, POST) and
910 * This is also used whenever we want to match a URL against a
911 * URL pattern. This always contains the URL to match, and never
912 * a URL pattern. (See struct url_spec).
916 char *cmd; /**< Whole command line: method, URL, Version */
917 char *ocmd; /**< Backup of original cmd for CLF logging */
918 char *gpc; /**< HTTP method: GET, POST, ... */
919 char *url; /**< The URL */
920 char *ver; /**< Protocol version */
921 int status; /**< HTTP Status */
923 char *host; /**< Host part of URL */
924 int port; /**< Port of URL or 80 (default) */
925 char *path; /**< Path of URL */
926 char *hostport; /**< host[:port] */
927 int ssl; /**< Flag if protocol is https */
929 char *host_ip_addr_str; /**< String with dotted decimal representation
930 of host's IP. NULL before connect_to() */
932 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
933 char **dvec; /**< List of pointers to the strings in dbuffer. */
934 int dcount; /**< How many parts to this domain? (length of dvec) */
938 * Reasons for generating a http_response instead of delivering
939 * the requested resource. Mostly ordered the way they are checked
942 #define RSP_REASON_UNSUPPORTED 1
943 #define RSP_REASON_BLOCKED 2
944 #define RSP_REASON_UNTRUSTED 3
945 #define RSP_REASON_REDIRECTED 4
946 #define RSP_REASON_CGI_CALL 5
947 #define RSP_REASON_NO_SUCH_DOMAIN 6
948 #define RSP_REASON_FORWARDING_FAILED 7
949 #define RSP_REASON_CONNECT_FAILED 8
950 #define RSP_REASON_OUT_OF_MEMORY 9
951 #define RSP_REASON_INTERNAL_ERROR 10
954 * Response generated by CGI, blocker, or error handler
958 char *status; /**< HTTP status (string). */
959 struct list headers[1]; /**< List of header lines. */
960 char *head; /**< Formatted http response head. */
961 size_t head_length; /**< Length of http response head. */
962 char *body; /**< HTTP document body. */
963 size_t content_length; /**< Length of body, REQUIRED if binary body. */
964 int is_static; /**< Nonzero if the content will never change and
965 should be cached by the browser (e.g. images). */
966 int reason; /**< Why the response was generated in the first place. */
970 * A URL or a tag pattern.
974 /** The string which was parsed to produce this url_spec.
975 Used for debugging or display only. */
978 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
979 regex_t *host_regex;/**< Regex for host matching */
981 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
982 char **dvec; /**< List of pointers to the strings in dbuffer. */
983 int dcount; /**< How many parts to this domain? (length of dvec) */
984 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
985 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
987 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
989 regex_t *preg; /**< Regex for matching path part */
990 regex_t *tag_regex; /**< Regex for matching tags */
994 * If you declare a static url_spec, this is the value to initialize it to zero.
996 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
997 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
999 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
1000 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
1003 * Constant for host part matching in URLs. If set, indicates that the start of
1004 * the pattern must match the start of the URL. E.g. this is not set for the
1005 * pattern ".example.com", so that it will match both "example.com" and
1006 * "www.example.com". It is set for the pattern "example.com", which makes it
1007 * match "example.com" only, not "www.example.com".
1009 #define ANCHOR_LEFT 1
1012 * Constant for host part matching in URLs. If set, indicates that the end of
1013 * the pattern must match the end of the URL. E.g. this is not set for the
1014 * pattern "ad.", so that it will match any host called "ad", irrespective
1015 * of how many subdomains are in the fully-qualified domain name.
1017 #define ANCHOR_RIGHT 2
1021 * An I/O buffer. Holds a string which can be appended to, and can have data
1022 * removed from the beginning.
1026 char *buf; /**< Start of buffer */
1027 char *cur; /**< Start of relevant data */
1028 char *eod; /**< End of relevant data */
1029 size_t size; /**< Size as malloc()ed */
1034 * Return the number of bytes in the I/O buffer associated with the passed
1035 * client_state pointer.
1038 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1042 * Remove any data in the I/O buffer associated with the passed
1043 * client_state pointer.
1045 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1047 /* Bits for csp->content_type bitmask: */
1048 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
1049 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
1050 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
1052 /* Although these are not, strictly speaking, content types
1053 * (they are content encodings), it is simple to handle them
1056 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
1057 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1060 * Flag to signal that the server declared the content type,
1061 * so we can differentiate between unknown and undeclared
1064 #define CT_DECLARED 0x0040U
1067 * The mask which includes all actions.
1069 #define ACTION_MASK_ALL (~0UL)
1072 * The most compatible set of actions - i.e. none.
1074 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1076 /** Action bitmap: Block the request. */
1077 #define ACTION_BLOCK 0x00000001UL
1078 /** Action bitmap: Deanimate if it's a GIF. */
1079 #define ACTION_DEANIMATE 0x00000002UL
1080 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1081 #define ACTION_DOWNGRADE 0x00000004UL
1082 /** Action bitmap: Fast redirects. */
1083 #define ACTION_FAST_REDIRECTS 0x00000008UL
1084 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
1085 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
1086 /** Action bitmap: Hide "From" header. */
1087 #define ACTION_HIDE_FROM 0x00000020UL
1088 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1089 #define ACTION_HIDE_REFERER 0x00000040UL
1090 /** Action bitmap: Hide "User-Agent" and similar headers. */
1091 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1092 /** Action bitmap: This is an image. */
1093 #define ACTION_IMAGE 0x00000100UL
1094 /** Action bitmap: Sets the image blocker. */
1095 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1096 /** Action bitmap: Prevent compression. */
1097 #define ACTION_NO_COMPRESSION 0x00000400UL
1098 /** Action bitmap: Change cookies to session only cookies. */
1099 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1100 /** Action bitmap: Block rending cookies. */
1101 #define ACTION_NO_COOKIE_READ 0x00001000UL
1102 /** Action bitmap: Block setting cookies. */
1103 #define ACTION_NO_COOKIE_SET 0x00002000UL
1104 /** Action bitmap: Override the forward settings in the config file */
1105 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
1106 /** Action bitmap: Block as empty document */
1107 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
1108 /** Action bitmap: Limit CONNECT requests to safe ports. */
1109 #define ACTION_LIMIT_CONNECT 0x00010000UL
1110 /** Action bitmap: Redirect request. */
1111 #define ACTION_REDIRECT 0x00020000UL
1112 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1113 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1114 /** Action bitmap: Overwrite Content-Type header. */
1115 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1116 /** Action bitmap: Crunch specified server header. */
1117 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1118 /** Action bitmap: Crunch specified client header */
1119 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1120 /** Action bitmap: Enable text mode by force */
1121 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1122 /** Action bitmap: Enable text mode by force */
1123 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1124 /** Action bitmap: Enable content-dispostion crunching */
1125 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1126 /** Action bitmap: Replace or block Last-Modified header */
1127 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1128 /** Action bitmap: Replace or block Accept-Language header */
1129 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1132 /** Action string index: How to deanimate GIFs */
1133 #define ACTION_STRING_DEANIMATE 0
1134 /** Action string index: Replacement for "From:" header */
1135 #define ACTION_STRING_FROM 1
1136 /** Action string index: How to block images */
1137 #define ACTION_STRING_IMAGE_BLOCKER 2
1138 /** Action string index: Replacement for "Referer:" header */
1139 #define ACTION_STRING_REFERER 3
1140 /** Action string index: Replacement for "User-Agent:" header */
1141 #define ACTION_STRING_USER_AGENT 4
1142 /** Action string index: Legal CONNECT ports. */
1143 #define ACTION_STRING_LIMIT_CONNECT 5
1144 /** Action string index: Server headers containing this pattern are crunched*/
1145 #define ACTION_STRING_SERVER_HEADER 6
1146 /** Action string index: Client headers containing this pattern are crunched*/
1147 #define ACTION_STRING_CLIENT_HEADER 7
1148 /** Action string index: Replacement for the "Accept-Language:" header*/
1149 #define ACTION_STRING_LANGUAGE 8
1150 /** Action string index: Replacement for the "Content-Type:" header*/
1151 #define ACTION_STRING_CONTENT_TYPE 9
1152 /** Action string index: Replacement for the "content-dispostion:" header*/
1153 #define ACTION_STRING_CONTENT_DISPOSITION 10
1154 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1155 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1156 /** Action string index: Replacement for the "Last-Modified:" header. */
1157 #define ACTION_STRING_LAST_MODIFIED 12
1158 /** Action string index: Redirect URL */
1159 #define ACTION_STRING_REDIRECT 13
1160 /** Action string index: Decode before redirect? */
1161 #define ACTION_STRING_FAST_REDIRECTS 14
1162 /** Action string index: Overriding forward rule. */
1163 #define ACTION_STRING_FORWARD_OVERRIDE 15
1164 /** Action string index: Reason for the block. */
1165 #define ACTION_STRING_BLOCK 16
1166 /** Action string index: what to do with the "X-Forwarded-For" header. */
1167 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
1168 /** Number of string actions. */
1169 #define ACTION_STRING_COUNT 18
1172 /* To make the ugly hack in sed easier to understand */
1173 #define CHECK_EVERY_HEADER_REMAINING 0
1176 /** Index into current_action_spec::multi[] for headers to add. */
1177 #define ACTION_MULTI_ADD_HEADER 0
1178 /** Index into current_action_spec::multi[] for content filters to apply. */
1179 #define ACTION_MULTI_FILTER 1
1180 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1181 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
1182 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1183 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
1184 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1185 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
1186 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1187 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
1188 /** Number of multi-string actions. */
1189 #define ACTION_MULTI_COUNT 6
1193 * This structure contains a list of actions to apply to a URL.
1194 * It only contains positive instructions - no "-" options.
1195 * It is not used to store the actions list itself, only for
1196 * url_actions() to return the current values.
1198 struct current_action_spec
1200 /** Actions to apply. A bit set to "1" means perform the action. */
1201 unsigned long flags;
1204 * Paramaters for those actions that require them.
1205 * Each entry is valid if & only if the corresponding entry in "flags" is
1208 char * string[ACTION_STRING_COUNT];
1210 /** Lists of strings for multi-string actions. */
1211 struct list multi[ACTION_MULTI_COUNT][1];
1216 * This structure contains a set of changes to actions.
1217 * It can contain both positive and negative instructions.
1218 * It is used to store an entry in the actions list.
1222 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1223 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1226 * Paramaters for those actions that require them.
1227 * Each entry is valid if & only if the corresponding entry in "flags" is
1230 char * string[ACTION_STRING_COUNT];
1232 /** Lists of strings to remove, for multi-string actions. */
1233 struct list multi_remove[ACTION_MULTI_COUNT][1];
1235 /** If nonzero, remove *all* strings from the multi-string action. */
1236 int multi_remove_all[ACTION_MULTI_COUNT];
1238 /** Lists of strings to add, for multi-string actions. */
1239 struct list multi_add[ACTION_MULTI_COUNT][1];
1244 * This structure is used to store action files.
1246 * It contains an URL or tag pattern, and the changes to
1247 * the actions. It's a linked list and should only be
1248 * free'd through unload_actions_file() unless there's
1249 * only a single entry.
1253 struct url_spec url[1]; /**< The URL or tag pattern. */
1255 struct action_spec *action; /**< Action settings that might be shared with
1256 the list entry before or after the current
1257 one and can't be free'd willy nilly. */
1259 struct url_actions *next; /**< Next action section in file, or NULL. */
1264 * Flags for use in csp->flags
1268 * Flag for csp->flags: Set if this client is processing data.
1269 * Cleared when the thread associated with this structure dies.
1271 #define CSP_FLAG_ACTIVE 0x01U
1274 * Flag for csp->flags: Set if the server's reply is in "chunked"
1277 #define CSP_FLAG_CHUNKED 0x02U
1280 * Flag for csp->flags: Set if this request was enforced, although it would
1281 * normally have been blocked.
1283 #define CSP_FLAG_FORCED 0x04U
1286 * Flag for csp->flags: Set if any modification to the body was done.
1288 #define CSP_FLAG_MODIFIED 0x08U
1291 * Flag for csp->flags: Set if request was blocked.
1293 #define CSP_FLAG_REJECTED 0x10U
1296 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1298 #define CSP_FLAG_TOGGLED_ON 0x20U
1301 * Flag for csp->flags: Set if an acceptable Connection header
1304 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040UL
1307 * Flag for csp->flags: Set if adding the 'Connection: close' header
1308 * for the server isn't necessary.
1310 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1313 * Flag for csp->flags: Signals header parsers whether they
1314 * are parsing server or client headers.
1316 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1319 * Flag for csp->flags: Set if adding the Host: header
1322 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1325 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1326 * XXX: As we now have tags we might as well ditch this.
1328 #define CSP_FLAG_NO_FILTERING 0x00000400UL
1331 * Flag for csp->flags: Set the client IP has appended to
1332 * an already existing X-Forwarded-For header in which case
1333 * no new header has to be generated.
1335 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800UL
1338 * Flag for csp->flags: Set if the server wants to keep
1339 * the connection alive.
1341 * XXX: Incomplete implementation, we currently only
1342 * look for "Connection: keep-alive".
1344 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000UL
1346 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1348 * Flag for csp->flags: Set if the server specified the
1351 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00002000UL
1352 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1355 * Flags for use in return codes of child processes
1359 * Flag for process return code: Set if exiting porcess has been toggled
1360 * during its lifetime.
1362 #define RC_FLAG_TOGGLED 0x10
1365 * Flag for process return code: Set if exiting porcess has blocked its
1368 #define RC_FLAG_BLOCKED 0x20
1371 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1374 #define MAX_AF_FILES 10
1377 * The state of a Privoxy processing thread.
1381 /** The proxy's configuration */
1382 struct configuration_spec * config;
1384 /** The actions to perform on the current request */
1385 struct current_action_spec action[1];
1387 /** socket to talk to client (web browser) */
1390 /** socket to talk to server (web server or proxy) */
1393 /** Multi-purpose flag container, see CSP_FLAG_* above */
1396 /** Client PC's IP address, as reported by the accept() function.
1399 /** Client PC's IP address, as reported by the accept() function.
1403 /** The URL that was requested */
1404 struct http_request http[1];
1407 * The final forwarding settings.
1408 * XXX: Currently this is only used for forward-override,
1409 * so we can free the space in sweep.
1411 struct forward_spec * fwd;
1413 /** An I/O buffer used for buffering data read from the network */
1416 /** List of all headers for this request */
1417 struct list headers[1];
1419 /** List of all tags that apply to this request */
1420 struct list tags[1];
1422 /** MIME-Type key, see CT_* above */
1423 unsigned int content_type;
1425 /** Actions files associated with this client */
1426 struct file_list *actions_list[MAX_AF_FILES];
1428 /** pcrs job files. */
1429 struct file_list *rlist[MAX_AF_FILES];
1431 /** Length after content modification. */
1432 size_t content_length;
1434 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1435 /** Expected length of content after which we
1436 * should stop reading from the server socket.
1438 /* XXX: is this the right location? */
1439 size_t expected_content_length;
1440 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1442 #ifdef FEATURE_TRUST
1445 struct file_list *tlist;
1447 #endif /* def FEATURE_TRUST */
1450 * Failure reason to embedded in the CGI error page,
1451 * or NULL. Currently only used for socks errors.
1453 char *error_message;
1455 /** Next thread in linked list. Only read or modify from the main thread! */
1456 struct client_state *next;
1461 * A function to add a header
1463 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1466 * A function to process a header
1468 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1472 * List of available CGI functions.
1474 struct cgi_dispatcher
1476 /** The URL of the CGI, relative to the CGI root. */
1477 const char * const name;
1479 /** The handler function for the CGI */
1480 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1482 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1483 const char * const description;
1485 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1491 * A data file used by Privoxy. Kept in a linked list.
1496 * This is a pointer to the data structures associated with the file.
1497 * Read-only once the structure has been created.
1502 * The unloader function.
1503 * Normally NULL. When we are finished with file (i.e. when we have
1504 * loaded a new one), set to a pointer to an unloader function.
1505 * Unloader will be called by sweep() (called from main loop) when
1506 * all clients using this file are done. This prevents threading
1509 void (*unloader)(void *);
1512 * Used internally by sweep(). Do not access from elsewhere.
1517 * File last-modified time, so we can check if file has been changed.
1518 * Read-only once the structure has been created.
1520 time_t lastmodified;
1523 * The full filename.
1528 * Pointer to next entry in the linked list of all "file_list"s.
1529 * This linked list is so that sweep() can navigate it.
1530 * Since sweep() can remove items from the list, we must be careful
1531 * to only access this value from main thread (when we know sweep
1532 * won't be running).
1534 struct file_list *next;
1538 #ifdef FEATURE_TRUST
1541 * The format of a trust file when loaded into memory.
1545 struct url_spec url[1]; /**< The URL pattern */
1546 int reject; /**< FIXME: Please document this! */
1547 struct block_spec *next; /**< Next entry in linked list */
1551 * Arbitrary limit for the number of trusted referrers.
1553 #define MAX_TRUSTED_REFERRERS 512
1555 #endif /* def FEATURE_TRUST */
1558 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1559 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1560 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1561 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1565 * How to forward a connection to a parent proxy.
1569 /** URL pattern that this forward_spec is for. */
1570 struct url_spec url[1];
1572 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1575 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1578 /** SOCKS server port. */
1581 /** Parent HTTP proxy hostname, or NULL for none. */
1584 /** Parent HTTP proxy port. */
1587 /** Next entry in the linked list. */
1588 struct forward_spec *next;
1593 * Initializer for a static struct forward_spec.
1595 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1597 /* Supported filter types */
1598 #define FT_CONTENT_FILTER 0
1599 #define FT_CLIENT_HEADER_FILTER 1
1600 #define FT_SERVER_HEADER_FILTER 2
1601 #define FT_CLIENT_HEADER_TAGGER 3
1602 #define FT_SERVER_HEADER_TAGGER 4
1604 #define MAX_FILTER_TYPES 5
1607 * This struct represents one filter (one block) from
1608 * the re_filterfile. If there is more than one filter
1609 * in the file, the file will be represented by a
1610 * chained list of re_filterfile specs.
1612 struct re_filterfile_spec
1614 char *name; /**< Name from FILTER: statement in re_filterfile. */
1615 char *description; /**< Description from FILTER: statement in re_filterfile. */
1616 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1617 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1618 int type; /**< Filter type (content, client-header, server-header). */
1619 int dynamic; /**< Set to one if the pattern might contain variables
1620 and has to be recompiled for every request. */
1621 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1627 #define ACL_PERMIT 1 /**< Accept connection request */
1628 #define ACL_DENY 2 /**< Reject connection request */
1631 * An IP address pattern. Used to specify networks in the ACL.
1633 struct access_control_addr
1635 unsigned long addr; /**< The IP address as an integer. */
1636 unsigned long mask; /**< The network mask as an integer. */
1637 unsigned long port; /**< The port number. */
1641 * An access control list (ACL) entry.
1643 * This is a linked list.
1645 struct access_control_list
1647 struct access_control_addr src[1]; /**< Client IP address */
1648 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1650 short action; /**< ACL_PERMIT or ACL_DENY */
1651 struct access_control_list *next; /**< The next entry in the ACL. */
1654 #endif /* def FEATURE_ACL */
1657 /** Maximum number of loaders (actions, re_filter, ...) */
1661 /** configuration_spec::feature_flags: CGI actions editor. */
1662 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1664 /** configuration_spec::feature_flags: Web-based toggle. */
1665 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1667 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1668 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1670 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1671 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1673 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1674 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1676 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1677 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1679 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1680 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1684 * Data loaded from the configuration file.
1686 * (Anomaly: toggle is still handled through a global, not this structure)
1688 struct configuration_spec
1693 /** Nonzero to enable multithreading. */
1697 * Bitmask of features that can be enabled/disabled through the config
1698 * file. Currently defined bits:
1700 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1701 * - RUNTIME_FEATURE_CGI_TOGGLE
1702 * - RUNTIME_FEATURE_HTTP_TOGGLE
1703 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1705 unsigned feature_flags;
1707 /** The log file name. */
1708 const char *logfile;
1710 /** The config file directory. */
1711 const char *confdir;
1713 /** The directory for customized CGI templates. */
1714 const char *templdir;
1716 /** The log file directory. */
1719 /** The full paths to the actions files. */
1720 const char *actions_file[MAX_AF_FILES];
1722 /** The short names of the actions files. */
1723 const char *actions_file_short[MAX_AF_FILES];
1725 /** The administrator's email address */
1726 char *admin_address;
1728 /** A URL with info on this proxy */
1729 char *proxy_info_url;
1731 /** URL to the user manual (on our website or local copy) */
1734 /** The file names of the pcre filter files. */
1735 const char *re_filterfile[MAX_AF_FILES];
1737 /** The short names of the pcre filter files. */
1738 const char *re_filterfile_short[MAX_AF_FILES];
1740 /** The hostname to show on CGI pages, or NULL to use the real one. */
1741 const char *hostname;
1743 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1746 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1749 /** Size limit for IOB */
1750 size_t buffer_limit;
1752 #ifdef FEATURE_TRUST
1754 /** The file name of the trust file. */
1755 const char * trustfile;
1757 /** FIXME: DOCME: Document this. */
1758 struct list trust_info[1];
1760 /** FIXME: DOCME: Document this. */
1761 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1763 #endif /* def FEATURE_TRUST */
1767 /** The access control list (ACL). */
1768 struct access_control_list *acl;
1770 #endif /* def FEATURE_ACL */
1772 /** Information about parent proxies (forwarding). */
1773 struct forward_spec *forward;
1775 /** Number of retries in case a forwarded connection attempt fails */
1776 int forwarded_connect_retries;
1778 /** All options from the config file, HTML-formatted. */
1781 /** The configuration file object. */
1782 struct file_list *config_file_list;
1784 /** List of loaders */
1785 int (*loaders[NLOADERS])(struct client_state *);
1787 /** Nonzero if we need to bind() to the new port. */
1791 /** Calculates the number of elements in an array, using sizeof. */
1792 #define SZ(X) (sizeof(X) / sizeof(*X))
1794 #ifdef FEATURE_FORCE_LOAD
1795 /** The force load URL prefix. */
1796 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1797 #endif /* def FEATURE_FORCE_LOAD */
1799 #ifdef FEATURE_NO_GIFS
1800 /** The MIME type for images ("image/png" or "image/gif"). */
1801 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1803 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1804 #endif /* def FEATURE_NO_GIFS */
1811 /** URL for the Privoxy home page. */
1812 #define HOME_PAGE_URL "http://www.privoxy.org/"
1814 /** URL for the Privoxy user manual. */
1815 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1817 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1818 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1820 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1821 #define CONFIG_HELP_PREFIX "config.html#"
1824 * The "hosts" to intercept and display CGI pages.
1825 * First one is a hostname only, second one can specify host and path.
1828 * 1) Do not specify the http: prefix
1829 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1830 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1832 #define CGI_SITE_1_HOST "p.p"
1833 #define CGI_SITE_2_HOST "config.privoxy.org"
1834 #define CGI_SITE_2_PATH ""
1837 * The prefix for CGI pages. Written out in generated HTML.
1838 * INCLUDES the trailing slash.
1840 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1846 #endif /* ndef PROJECT_H_INCLUDED */