1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.134 2009/05/10 10:12:30 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-2009 the
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.134 2009/05/10 10:12:30 fabiankeil
41 * Initial keep-alive support for the client socket.
42 * Temporarily disable the server-side-only keep-alive code.
44 * Revision 1.133 2009/04/24 15:29:43 fabiankeil
45 * Allow to limit the number of of client connections.
47 * Revision 1.132 2009/04/17 11:45:19 fabiankeil
48 * Replace HAVE_GETADDRINFO and HAVE_GETNAMEINFO macros
49 * with HAVE_RFC2553 macro. Original patch by Petr Pisar.
51 * Revision 1.131 2009/04/17 11:34:35 fabiankeil
52 * Style cosmetics for the IPv6 code.
54 * Revision 1.130 2009/04/17 11:27:49 fabiankeil
55 * Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
57 * Revision 1.129 2009/03/08 14:12:51 fabiankeil
58 * All the CSP_FLAG_FOO bit masks should be unsigned ints.
60 * Revision 1.128 2009/03/07 13:09:17 fabiankeil
61 * Change csp->expected_content and_csp->expected_content_length from
62 * size_t to unsigned long long to reduce the likelihood of integer
63 * overflows that would let us close the connection prematurely.
64 * Bug found while investigating #2669131, reported by cyberpatrol.
66 * Revision 1.127 2008/12/20 14:53:55 fabiankeil
67 * Add config option socket-timeout to control the time
68 * Privoxy waits for data to arrive on a socket. Useful
69 * in case of stale ssh tunnels or when fuzz-testing.
71 * Revision 1.126 2008/12/14 17:02:54 fabiankeil
72 * Fix a cparser warning.
74 * Revision 1.125 2008/11/20 08:22:28 fabiankeil
75 * Remove an obsolete comment.
77 * Revision 1.124 2008/11/16 12:43:49 fabiankeil
78 * Turn keep-alive support into a runtime feature
79 * that is disabled by setting keep-alive-timeout
80 * to a negative value.
82 * Revision 1.123 2008/11/10 16:55:59 fabiankeil
83 * Fix a gcc44 warning (in filters.c).
85 * Revision 1.122 2008/10/16 07:11:34 fabiankeil
86 * Fix a bunch of gcc44 conversion warnings.
88 * Revision 1.121 2008/10/09 18:21:41 fabiankeil
89 * Flush work-in-progress changes to keep outgoing connections
90 * alive where possible. Incomplete and mostly #ifdef'd out.
92 * Revision 1.120 2008/09/21 13:36:52 fabiankeil
93 * If change-x-forwarded-for{add} is used and the client
94 * sends multiple X-Forwarded-For headers, append the client's
95 * IP address to each one of them. "Traditionally" we would
96 * lose all but the last one.
98 * Revision 1.119 2008/09/20 10:04:33 fabiankeil
99 * Remove hide-forwarded-for-headers action which has
100 * been obsoleted by change-x-forwarded-for{block}.
102 * Revision 1.118 2008/09/19 15:26:29 fabiankeil
103 * Add change-x-forwarded-for{} action to block or add
104 * X-Forwarded-For headers. Mostly based on code removed
107 * Revision 1.117 2008/08/30 12:03:07 fabiankeil
108 * Remove FEATURE_COOKIE_JAR.
110 * Revision 1.116 2008/05/20 16:05:02 fabiankeil
111 * Move parsers structure definition from project.h to parsers.h.
113 * Revision 1.115 2008/05/19 16:57:20 fabiankeil
114 * Declare all members of the parsers structure immutable.
116 * Revision 1.114 2008/04/11 16:35:39 fabiankeil
117 * Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
119 * Revision 1.113 2008/04/10 14:41:04 fabiankeil
120 * Ditch url_spec's path member now that it's no longer used.
122 * Revision 1.112 2008/04/06 15:18:34 fabiankeil
123 * Oh well, rename the --enable-pcre-host-patterns option to
124 * --enable-extended-host-patterns as it's not really PCRE syntax.
126 * Revision 1.111 2008/04/06 14:54:26 fabiankeil
127 * Use PCRE syntax in host patterns when configured
128 * with --enable-pcre-host-patterns.
130 * Revision 1.110 2008/03/29 12:13:46 fabiankeil
131 * Remove send-wafer and send-vanilla-wafer actions.
133 * Revision 1.109 2008/03/28 15:13:41 fabiankeil
134 * Remove inspect-jpegs action.
136 * Revision 1.108 2008/03/27 18:27:36 fabiankeil
137 * Remove kill-popups action.
139 * Revision 1.107 2008/03/26 18:07:08 fabiankeil
140 * Add hostname directive. Closes PR#1918189.
142 * Revision 1.106 2008/03/24 11:21:03 fabiankeil
143 * Share the action settings for multiple patterns in the same
144 * section so we waste less memory for gigantic block lists
145 * (and load them slightly faster). Reported by Franz Schwartau.
147 * Revision 1.105 2008/03/21 11:16:27 fabiankeil
148 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
150 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
151 * Remove the treat-forbidden-connects-like-blocks action. We now
152 * use the "blocked" page for forbidden CONNECT requests by default.
154 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
155 * Let the block action take the reason for the block
156 * as argument and show it on the "blocked" page.
158 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
159 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
161 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
162 * Remove now-obsolete csp member x_forwarded.
164 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
165 * - Allow port lists in url patterns.
166 * - Ditch unused url_spec member pathlen.
168 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
169 * As Hal noticed, checking dispatch_cgi() as the last cruncher
170 * looks like a bug if CGI requests are blocked unintentionally,
171 * so don't do it unless the user enabled the new config option
172 * "allow-cgi-request-crunching".
174 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
175 * Add new csp->content_type flag (CT_DECLARED).
177 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
178 * - Remove some left-overs from the switch to dedicated header filters.
179 * - Adjust "X-Filter: No" to disable dedicated header filters.
180 * - Prepare for forward-override{}
182 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
183 * Ditch the csp member cookie_list[] which isn't used anymore.
185 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
186 * Introduce dynamic pcrs jobs that can resolve variables.
188 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
189 * Introduce tags as alternative way to specify which
190 * actions apply to a request. At the moment tags can be
191 * created based on client and server headers.
193 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
194 * Use dedicated header filter actions instead of abusing "filter".
195 * Replace "filter-client-headers" and "filter-client-headers"
196 * with "server-header-filter" and "client-header-filter".
198 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
199 * New config option: enforce-blocks.
201 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
202 * Add some CSP_FLAGs for the header parsers.
204 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
205 * Add new http_response member to save
206 * the reason why the response was generated.
208 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
209 * Add new config option "templdir" to
210 * change the templates directory.
212 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
213 * Add csp->error_message for failure reasons
214 * that should be embedded into the CGI pages.
216 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
217 * Integrate a modified version of Wil Mahan's
218 * zlib patch (PR #895531).
220 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
221 * Added config option accept-intercepted-requests
222 * and disabled it by default.
224 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
225 * Fix gcc43 compiler warnings and a comment.
227 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
228 * Add config option "split-large-forms"
229 * to work around the browser bug reported
232 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
233 * Moved HTTP snipplets into jcc.c. They aren't
234 * used anywhere else.
236 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
237 * Doubled size of HOSTENT_BUFFER_SIZE to mask
238 * problems with gethostbyname_r and some
239 * /etc/hosts configurations. Only a workaround
240 * until we get the real fix ready.
241 * Thanks Félix Rauch for reporting.
243 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
245 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
246 * Respond with 400 and a short text message
247 * if the client tries to use Privoxy as FTP proxy.
249 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
250 * Added config option enable-remote-http-toggle
251 * to specify if Privoxy should recognize special
252 * headers (currently only X-Filter) to change its
253 * behaviour. Disabled by default.
255 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
256 * Make number of retries in case of forwarded-connect problems
257 * a config file option (forwarded-connect-retries) and use 0 as
260 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
261 * Work around a buffer overflow that caused Privoxy to
262 * segfault if too many trusted referrers were used. Good
263 * enough for now, but should be replaced with a real
264 * solution after the next release.
266 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
269 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
270 * Split filter-headers{} into filter-client-headers{}
271 * and filter-server-headers{}.
272 * Added parse_header_time() to share some code.
273 * Replaced timegm() with mktime().
275 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
276 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
278 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
279 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
280 * with what was really the latest development (the v_3_0_branch branch)
282 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
283 * Multiple filter file support
285 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
286 * Add the ability to check jpeg images for invalid
287 * lengths of comment blocks. Defensive strategy
288 * against the exploit:
289 * Microsoft Security Bulletin MS04-028
290 * Buffer Overrun in JPEG Processing (GDI+) Could
291 * Allow Code Execution (833987)
292 * Enabled with +inspect-jpegs in actions files.
294 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
295 * Updated the copyright note
297 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
298 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
300 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
301 * Introduced RC_FLAG_* flags for use in child process return code
303 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
304 * Added flag to each cgi_dispatcher that allows or denies
305 * external linking and removed const qualifier from
306 * struct list_entry.str.
308 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
309 * - Include config.h for access to config data
310 * - Include <pcre*.h> depending on where they are
312 * Revision 1.72 2002/05/14 21:35:49 oes
313 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
314 * because of split in user-manual
316 * Revision 1.71 2002/05/12 21:39:36 jongfoster
317 * - Adding Doxygen-style comments to structures and #defines.
319 * Revision 1.70 2002/05/12 16:05:50 jongfoster
320 * Fixing ACTION_MASK_ALL to be unsigned long rather than
321 * just unsigned int. I don't know if anyone is porting
322 * Privoxy to 16-bit platforms, but if so, +limit-connect
323 * wouldn't have worked because of this bug.
325 * Revision 1.69 2002/05/08 16:00:16 oes
326 * Added size member to struct iob, so it can
327 * be alloced larger than needed.
329 * Revision 1.68 2002/04/26 12:56:00 oes
330 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
332 * Revision 1.67 2002/04/24 02:12:43 oes
333 * - Jon's multiple AF patch:
334 * - Make csp->actions_list an array
335 * - #define MAX_AF_FILES
336 * - Moved CGI_PARAM_LEN_MAX (500) here
338 * Revision 1.66 2002/04/15 19:06:43 jongfoster
341 * Revision 1.65 2002/04/04 00:36:36 gliptak
342 * always use pcre for matching
344 * Revision 1.64 2002/04/03 22:28:03 gliptak
345 * Removed references to gnu_regex
347 * Revision 1.63 2002/03/31 17:19:00 jongfoster
348 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
350 * Revision 1.62 2002/03/26 22:48:49 swa
353 * Revision 1.61 2002/03/26 22:29:55 swa
354 * we have a new homepage!
356 * Revision 1.60 2002/03/24 15:52:17 jongfoster
357 * Changing CGI URL prefixes for new name
359 * Revision 1.59 2002/03/24 15:23:33 jongfoster
362 * Revision 1.58 2002/03/24 13:25:43 swa
363 * name change related issues
365 * Revision 1.57 2002/03/16 20:28:34 oes
366 * Added descriptions to the filters so users will know what they select in the cgi editor
368 * Revision 1.56 2002/03/13 20:27:30 oes
369 * Fixing bug with CT_TABOO
371 * Revision 1.55 2002/03/12 01:42:50 oes
372 * Introduced modular filters
374 * Revision 1.54 2002/03/09 20:03:52 jongfoster
375 * - Making various functions return int rather than size_t.
376 * (Undoing a recent change). Since size_t is unsigned on
377 * Windows, functions like read_socket that return -1 on
378 * error cannot return a size_t.
380 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
381 * crashes, and also frequently caused JB to jump to 100%
382 * CPU and stay there. (Because it thought it had just
383 * read ((unsigned)-1) == 4Gb of data...)
385 * - The signature of write_socket has changed, it now simply
386 * returns success=0/failure=nonzero.
388 * - Trying to get rid of a few warnings --with-debug on
389 * Windows, I've introduced a new type "jb_socket". This is
390 * used for the socket file descriptors. On Windows, this
391 * is SOCKET (a typedef for unsigned). Everywhere else, it's
392 * an int. The error value can't be -1 any more, so it's
393 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
394 * Windows it maps to the #define INVALID_SOCKET.)
396 * - The signature of bind_port has changed.
398 * Revision 1.53 2002/03/08 16:48:55 oes
399 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
401 * Revision 1.52 2002/03/07 03:46:17 oes
402 * Fixed compiler warnings
404 * Revision 1.51 2002/03/05 04:52:42 oes
405 * Deleted non-errlog debugging code
407 * Revision 1.50 2002/03/04 19:32:07 oes
408 * Changed default port to 8118
410 * Revision 1.49 2002/03/04 18:28:55 oes
411 * Deleted PID_FILE_NAME
413 * Revision 1.48 2002/03/03 14:50:40 oes
414 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
416 * Revision 1.47 2002/02/20 23:15:13 jongfoster
417 * Parsing functions now handle out-of-memory gracefully by returning
420 * Revision 1.46 2002/01/17 21:06:09 jongfoster
421 * Now #defining the URLs of the config interface
423 * Minor changes to struct http_request and struct url_spec due to
424 * standardizing that struct http_request is used to represent a URL, and
425 * struct url_spec is used to represent a URL pattern. (Before, URLs were
426 * represented as seperate variables and a partially-filled-in url_spec).
428 * Revision 1.45 2002/01/09 14:33:27 oes
429 * Added HOSTENT_BUFFER_SIZE
431 * Revision 1.44 2001/12/30 14:07:32 steudten
432 * - Add signal handling (unix)
433 * - Add SIGHUP handler (unix)
434 * - Add creation of pidfile (unix)
435 * - Add action 'top' in rc file (RH)
436 * - Add entry 'SIGNALS' to manpage
437 * - Add exit message to logfile (unix)
439 * Revision 1.43 2001/11/22 21:57:51 jongfoster
440 * Making action_spec->flags into an unsigned long rather than just an
442 * Adding ACTION_NO_COOKIE_KEEP
444 * Revision 1.42 2001/11/05 21:42:41 steudten
445 * Include DBG() macro.
447 * Revision 1.41 2001/10/28 19:12:06 jongfoster
448 * Adding ijb_toupper()
450 * Revision 1.40 2001/10/26 17:40:47 oes
451 * Moved ijb_isspace and ijb_tolower to project.h
452 * Removed http->user_agent, csp->referrer and csp->accept_types
454 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
455 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
456 * macro when called with a cast; so moving the cast to the macro def'n
457 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
458 * doesn't make macro expansion complain. Hope this works for everyone else
461 * Revision 1.38 2001/10/23 21:19:04 jongfoster
462 * New error-handling support: jb_err type and JB_ERR_xxx constants
463 * CGI functions now return a jb_err, and their parameters map is const.
464 * Support for RUNTIME_FEATUREs to enable/disable config editor
465 * Adding a few comments
467 * Revision 1.37 2001/10/14 22:14:01 jongfoster
468 * Removing name_length field from struct cgi_dispatcher, as this is
469 * now calculated at runtime from the "name" field.
471 * Revision 1.36 2001/10/10 16:45:15 oes
472 * Added LIMIT_CONNECT action and string
473 * Fixed HTTP message line termination
474 * Added CFORBIDDEN HTTP message
476 * Revision 1.35 2001/10/07 18:06:43 oes
477 * Added status member to struct http_request
479 * Revision 1.34 2001/10/07 15:45:25 oes
480 * Added url member to struct http_request and commented all
485 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
487 * Replaced struct client_state members rejected,
488 * force, active and toggled_on with "flags" bitmap.
490 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
492 * Added buffer_limit to struct configuration_spec
494 * Revision 1.33 2001/09/20 13:30:08 steudten
496 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
497 * Last case will set z to NULL in free(z) and thats bad..
499 * Revision 1.32 2001/09/16 23:02:51 jongfoster
502 * Revision 1.31 2001/09/16 13:20:29 jongfoster
503 * Rewrite of list library. Now has seperate header and list_entry
504 * structures. Also added a large sprinking of assert()s to the list
507 * Revision 1.30 2001/09/13 23:52:00 jongfoster
508 * Support for both static and dynamically generated CGI pages
510 * Revision 1.29 2001/09/13 23:29:43 jongfoster
511 * Defining FORWARD_SPEC_INITIALIZER
513 * Revision 1.28 2001/09/13 23:05:50 jongfoster
514 * Changing the string paramater to the header parsers a "const".
516 * Revision 1.27 2001/08/05 16:06:20 jongfoster
517 * Modifiying "struct map" so that there are now separate header and
518 * "map_entry" structures. This means that functions which modify a
519 * map no longer need to return a pointer to the modified map.
520 * Also, it no longer reverses the order of the entries (which may be
521 * important with some advanced template substitutions).
523 * Revision 1.26 2001/07/30 22:08:36 jongfoster
524 * Tidying up #defines:
525 * - All feature #defines are now of the form FEATURE_xxx
526 * - Permanently turned off WIN_GUI_EDIT
527 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
529 * Revision 1.25 2001/07/29 18:43:08 jongfoster
530 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
533 * Revision 1.24 2001/07/25 17:20:27 oes
534 * Introduced http->user_agent
536 * Revision 1.23 2001/07/18 12:32:23 oes
537 * - Added ACTION_STRING_DEANIMATE
538 * - moved #define freez from jcc.h to project.h
540 * Revision 1.22 2001/07/15 17:51:41 jongfoster
541 * Renaming #define STATIC to STATIC_PCRE
543 * Revision 1.21 2001/07/13 14:03:19 oes
544 * - Reorganized regex header inclusion and #defines to
545 * comply to the scheme in configure.in
546 * - Added csp->content_type and its CT_* keys
547 * - Added ACTION_DEANIMATE
548 * - Removed all #ifdef PCRS
550 * Revision 1.20 2001/06/29 21:45:41 oes
551 * Indentation, CRLF->LF, Tab-> Space
553 * Revision 1.19 2001/06/29 13:33:36 oes
554 * - Improved comments
555 * - Introduced http_request.host_ip_addr_str
556 * - Introduced http_response.head_length
557 * - Introduced config.my_ip_addr_str, config.my_hostname,
558 * config.admin_address and config.proxy_info_url
559 * - Removed config.proxy_args_header and config.proxy_args_trailer,
560 * renamed config.proxy_args_invocation to config.proxy_args
561 * - Removed HTML snipplets and GIFs
562 * - Removed logentry from cancelled commit
564 * Revision 1.18 2001/06/09 10:57:39 jongfoster
565 * Adding definition of BUFFER_SIZE.
566 * Changing struct cgi_dispatcher to use "const" strings.
568 * Revision 1.17 2001/06/07 23:15:09 jongfoster
569 * Merging ACL and forward files into config file.
570 * Moving struct gateway members into struct forward_spec
571 * Removing config->proxy_args_gateways
572 * Cosmetic: Adding a few comments
574 * Revision 1.16 2001/06/04 18:31:58 swa
575 * files are now prefixed with either `confdir' or `logdir'.
576 * `make redhat-dist' replaces both entries confdir and logdir
579 * Revision 1.15 2001/06/04 11:28:53 swa
580 * redirect did not work due to missing /
582 * Revision 1.14 2001/06/03 11:03:48 oes
584 * added struct http_response,
585 * changed struct interceptors to struct cgi_dispatcher,
586 * moved HTML stuff to cgi.h
588 * Revision 1.13 2001/06/01 20:05:36 jongfoster
589 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
590 * constant, and removed csp->tinygif.
592 * Revision 1.12 2001/06/01 18:49:17 jongfoster
593 * Replaced "list_share" with "list" - the tiny memory gain was not
594 * worth the extra complexity.
596 * Revision 1.11 2001/06/01 10:32:47 oes
597 * Added constants for anchoring selection bitmap
599 * Revision 1.10 2001/05/31 21:33:53 jongfoster
600 * Changes for new actions file, replacing permissionsfile
601 * and parts of the config file. Also added support for
604 * Revision 1.9 2001/05/31 17:32:31 oes
606 * - Enhanced domain part globbing with infix and prefix asterisk
607 * matching and optional unanchored operation
609 * Revision 1.8 2001/05/29 20:09:15 joergs
610 * HTTP_REDIRECT_TEMPLATE fixed.
612 * Revision 1.7 2001/05/29 09:50:24 jongfoster
613 * Unified blocklist/imagelist/actionslist.
614 * File format is still under discussion, but the internal changes
617 * Also modified interceptor behaviour:
618 * - We now intercept all URLs beginning with one of the following
619 * prefixes (and *only* these prefixes):
621 * * http://ijbswa.sf.net/config/
622 * * http://ijbswa.sourceforge.net/config/
623 * - New interceptors "home page" - go to http://i.j.b/ to see it.
624 * - Internal changes so that intercepted and fast redirect pages
625 * are not replaced with an image.
626 * - Interceptors now have the option to send a binary page direct
627 * to the client. (i.e. ijb-send-banner uses this)
628 * - Implemented show-url-info interceptor. (Which is why I needed
629 * the above interceptors changes - a typical URL is
630 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
631 * The previous mechanism would not have intercepted that, and
632 * if it had been intercepted then it then it would have replaced
635 * Revision 1.6 2001/05/27 22:17:04 oes
637 * - re_process_buffer no longer writes the modified buffer
638 * to the client, which was very ugly. It now returns the
639 * buffer, which it is then written by chat.
641 * - content_length now adjusts the Content-Length: header
642 * for modified documents rather than crunch()ing it.
643 * (Length info in csp->content_length, which is 0 for
644 * unmodified documents)
646 * - For this to work, sed() is called twice when filtering.
648 * Revision 1.5 2001/05/26 00:28:36 jongfoster
649 * Automatic reloading of config file.
650 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
651 * Most of the global variables have been moved to a new
652 * struct configuration_spec, accessed through csp->config->globalname
653 * Most of the globals remaining are used by the Win32 GUI.
655 * Revision 1.4 2001/05/22 18:46:04 oes
657 * - Enabled filtering banners by size rather than URL
658 * by adding patterns that replace all standard banner
659 * sizes with the "Junkbuster" gif to the re_filterfile
661 * - Enabled filtering WebBugs by providing a pattern
662 * which kills all 1x1 images
664 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
665 * which is selected by the (nonstandard and therefore
666 * capital) letter 'U' in the option string.
667 * It causes the quantifiers to be ungreedy by default.
668 * Appending a ? turns back to greedy (!).
670 * - Added a new interceptor ijb-send-banner, which
671 * sends back the "Junkbuster" gif. Without imagelist or
672 * MSIE detection support, or if tinygif = 1, or the
673 * URL isn't recognized as an imageurl, a lame HTML
674 * explanation is sent instead.
676 * - Added new feature, which permits blocking remote
677 * script redirects and firing back a local redirect
679 * The feature is conditionally compiled, i.e. it
680 * can be disabled with --disable-fast-redirects,
681 * plus it must be activated by a "fast-redirects"
682 * line in the config file, has its own log level
683 * and of course wants to be displayed by show-proxy-args
684 * Note: Boy, all the #ifdefs in 1001 locations and
685 * all the fumbling with configure.in and acconfig.h
686 * were *way* more work than the feature itself :-(
688 * - Because a generic redirect template was needed for
689 * this, tinygif = 3 now uses the same.
691 * - Moved GIFs, and other static HTTP response templates
696 * - Removed some >400 CRs again (Jon, you really worked
699 * Revision 1.3 2001/05/20 01:21:20 jongfoster
700 * Version 2.9.4 checkin.
701 * - Merged popupfile and cookiefile, and added control over PCRS
702 * filtering, in new "actionsfile".
703 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
704 * file error you now get a message box (in the Win32 GUI) rather
705 * than the program exiting with no explanation.
706 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
708 * - Removed tabs from "config"
709 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
710 * - Bumped up version number.
712 * Revision 1.2 2001/05/17 23:01:01 oes
713 * - Cleaned CRLF's from the sources and related files
715 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
716 * Initial import of version 2.9.3 source tree
719 *********************************************************************/
722 /* Declare struct FILE for vars and funcs. */
725 /* Need time_t for file_list */
727 /* Needed for pcre choice */
731 /* Need for struct sockaddr_storage */
732 #include <sys/socket.h>
737 * Include appropriate regular expression libraries.
738 * Note that pcrs and pcre (native) are needed for cgi
739 * and are included anyway.
745 # ifdef PCRE_H_IN_SUBDIR
746 # include <pcre/pcre.h>
759 # include "pcreposix.h"
761 # ifdef PCRE_H_IN_SUBDIR
762 # include <pcre/pcreposix.h>
764 # include <pcreposix.h>
770 #endif /* def AMIGA */
774 * I don't want to have to #include all this just for the declaration
775 * of SOCKET. However, it looks like we have to...
790 typedef SOCKET jb_socket;
792 #define JB_INVALID_SOCKET INVALID_SOCKET
794 #else /* ndef _WIN32 */
797 * The type used by sockets. On UNIX it's an int. Microsoft decided to
798 * make it an unsigned.
800 typedef int jb_socket;
803 * The error value used for variables of type jb_socket. On UNIX this
804 * is -1, however Microsoft decided to make socket handles unsigned, so
805 * they use a different value.
808 #define JB_INVALID_SOCKET (-1)
810 #endif /* ndef _WIN32 */
814 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
819 #define JB_ERR_OK 0 /**< Success, no error */
820 #define JB_ERR_MEMORY 1 /**< Out of memory */
821 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
822 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
823 #define JB_ERR_PARSE 4 /**< Error parsing file */
824 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
825 CGI actions editor. */
826 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
829 * This macro is used to free a pointer that may be NULL.
830 * It also sets the variable to NULL after it's been freed.
831 * The paramater should be a simple variable without side effects.
833 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
837 * Fix a problem with Solaris. There should be no effect on other
840 * Solaris's isspace() is a macro which uses it's argument directly
841 * as an array index. Therefore we need to make sure that high-bit
842 * characters generate +ve values, and ideally we also want to make
843 * the argument match the declared parameter type of "int".
845 * Note: Remember to #include <ctype.h> if you use these macros.
847 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
848 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
849 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
852 * Use for statically allocated buffers if you have no other choice.
853 * Remember to check the length of what you write into the buffer
854 * - we don't want any buffer overflows!
856 #define BUFFER_SIZE 5000
859 * Max length of CGI parameters (arbitrary limit).
861 #define CGI_PARAM_LEN_MAX 500U
864 * Buffer size for capturing struct hostent data in the
865 * gethostby(name|addr)_r library calls. Since we don't
866 * loop over gethostbyname_r, the buffer must be sufficient
867 * to accomodate multiple IN A RRs, as used in DNS round robin
868 * load balancing. W3C's wwwlib uses 1K, so that should be
869 * good enough for us, too.
872 * XXX: Temporary doubled, for some configurations
873 * 1K is still too small and we didn't get the
874 * real fix ready for inclusion.
876 #define HOSTENT_BUFFER_SIZE 2048
879 * Do not use. Originally this was so that you can
880 * say "while (FOREVER) { ...do something... }".
881 * However, this gives a warning with some compilers (e.g. VC++).
882 * Instead, use "for (;;) { ...do something... }".
887 * Default TCP/IP address to listen on, as a string.
888 * Set to "127.0.0.1:8118".
890 #define HADDR_DEFAULT "127.0.0.1:8118"
893 /* Forward def for struct client_state */
894 struct configuration_spec;
898 * Entry in a linked list of strings.
903 * The string pointer. It must point to a dynamically malloc()ed
904 * string or be NULL for the list functions to work. In the latter
905 * case, just be careful next time you iterate through the list in
910 /** Next entry in the linked list, or NULL if no more. */
911 struct list_entry *next;
915 * A header for a linked list of strings.
919 /** First entry in the list, or NULL if the list is empty. */
920 struct list_entry *first;
922 /** Last entry in the list, or NULL if the list is empty. */
923 struct list_entry *last;
928 * An entry in a map. This is a name=value pair.
932 /** The key for the map. */
934 /** The value associated with that key. */
936 /** The next map entry, or NULL if none. */
937 struct map_entry *next;
941 * A map from a string to another string.
942 * This is used for the paramaters passed in a HTTP GET request, and
943 * to store the exports when the CGI interface is filling in a template.
947 /** The first map entry, or NULL if the map is empty. */
948 struct map_entry *first;
949 /** The last map entry, or NULL if the map is empty. */
950 struct map_entry *last;
955 * A HTTP request. This includes the method (GET, POST) and
958 * This is also used whenever we want to match a URL against a
959 * URL pattern. This always contains the URL to match, and never
960 * a URL pattern. (See struct url_spec).
964 char *cmd; /**< Whole command line: method, URL, Version */
965 char *ocmd; /**< Backup of original cmd for CLF logging */
966 char *gpc; /**< HTTP method: GET, POST, ... */
967 char *url; /**< The URL */
968 char *ver; /**< Protocol version */
969 int status; /**< HTTP Status */
971 char *host; /**< Host part of URL */
972 int port; /**< Port of URL or 80 (default) */
973 char *path; /**< Path of URL */
974 char *hostport; /**< host[:port] */
975 int ssl; /**< Flag if protocol is https */
977 char *host_ip_addr_str; /**< String with dotted decimal representation
978 of host's IP. NULL before connect_to() */
980 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
981 char **dvec; /**< List of pointers to the strings in dbuffer. */
982 int dcount; /**< How many parts to this domain? (length of dvec) */
986 * Reasons for generating a http_response instead of delivering
987 * the requested resource. Mostly ordered the way they are checked
990 #define RSP_REASON_UNSUPPORTED 1
991 #define RSP_REASON_BLOCKED 2
992 #define RSP_REASON_UNTRUSTED 3
993 #define RSP_REASON_REDIRECTED 4
994 #define RSP_REASON_CGI_CALL 5
995 #define RSP_REASON_NO_SUCH_DOMAIN 6
996 #define RSP_REASON_FORWARDING_FAILED 7
997 #define RSP_REASON_CONNECT_FAILED 8
998 #define RSP_REASON_OUT_OF_MEMORY 9
999 #define RSP_REASON_INTERNAL_ERROR 10
1002 * Response generated by CGI, blocker, or error handler
1004 struct http_response
1006 char *status; /**< HTTP status (string). */
1007 struct list headers[1]; /**< List of header lines. */
1008 char *head; /**< Formatted http response head. */
1009 size_t head_length; /**< Length of http response head. */
1010 char *body; /**< HTTP document body. */
1011 size_t content_length; /**< Length of body, REQUIRED if binary body. */
1012 int is_static; /**< Nonzero if the content will never change and
1013 should be cached by the browser (e.g. images). */
1014 int reason; /**< Why the response was generated in the first place. */
1018 * A URL or a tag pattern.
1022 /** The string which was parsed to produce this url_spec.
1023 Used for debugging or display only. */
1026 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
1027 regex_t *host_regex;/**< Regex for host matching */
1029 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
1030 char **dvec; /**< List of pointers to the strings in dbuffer. */
1031 int dcount; /**< How many parts to this domain? (length of dvec) */
1032 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
1033 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
1035 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
1037 regex_t *preg; /**< Regex for matching path part */
1038 regex_t *tag_regex; /**< Regex for matching tags */
1042 * If you declare a static url_spec, this is the value to initialize it to zero.
1044 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
1045 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
1047 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
1048 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
1051 * Constant for host part matching in URLs. If set, indicates that the start of
1052 * the pattern must match the start of the URL. E.g. this is not set for the
1053 * pattern ".example.com", so that it will match both "example.com" and
1054 * "www.example.com". It is set for the pattern "example.com", which makes it
1055 * match "example.com" only, not "www.example.com".
1057 #define ANCHOR_LEFT 1
1060 * Constant for host part matching in URLs. If set, indicates that the end of
1061 * the pattern must match the end of the URL. E.g. this is not set for the
1062 * pattern "ad.", so that it will match any host called "ad", irrespective
1063 * of how many subdomains are in the fully-qualified domain name.
1065 #define ANCHOR_RIGHT 2
1069 * An I/O buffer. Holds a string which can be appended to, and can have data
1070 * removed from the beginning.
1074 char *buf; /**< Start of buffer */
1075 char *cur; /**< Start of relevant data */
1076 char *eod; /**< End of relevant data */
1077 size_t size; /**< Size as malloc()ed */
1082 * Return the number of bytes in the I/O buffer associated with the passed
1083 * client_state pointer.
1086 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1090 * Remove any data in the I/O buffer associated with the passed
1091 * client_state pointer.
1093 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1095 /* Bits for csp->content_type bitmask: */
1096 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
1097 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
1098 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
1100 /* Although these are not, strictly speaking, content types
1101 * (they are content encodings), it is simple to handle them
1104 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
1105 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1108 * Flag to signal that the server declared the content type,
1109 * so we can differentiate between unknown and undeclared
1112 #define CT_DECLARED 0x0040U
1115 * The mask which includes all actions.
1117 #define ACTION_MASK_ALL (~0UL)
1120 * The most compatible set of actions - i.e. none.
1122 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1124 /** Action bitmap: Block the request. */
1125 #define ACTION_BLOCK 0x00000001UL
1126 /** Action bitmap: Deanimate if it's a GIF. */
1127 #define ACTION_DEANIMATE 0x00000002UL
1128 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1129 #define ACTION_DOWNGRADE 0x00000004UL
1130 /** Action bitmap: Fast redirects. */
1131 #define ACTION_FAST_REDIRECTS 0x00000008UL
1132 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
1133 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
1134 /** Action bitmap: Hide "From" header. */
1135 #define ACTION_HIDE_FROM 0x00000020UL
1136 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1137 #define ACTION_HIDE_REFERER 0x00000040UL
1138 /** Action bitmap: Hide "User-Agent" and similar headers. */
1139 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1140 /** Action bitmap: This is an image. */
1141 #define ACTION_IMAGE 0x00000100UL
1142 /** Action bitmap: Sets the image blocker. */
1143 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1144 /** Action bitmap: Prevent compression. */
1145 #define ACTION_NO_COMPRESSION 0x00000400UL
1146 /** Action bitmap: Change cookies to session only cookies. */
1147 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1148 /** Action bitmap: Block rending cookies. */
1149 #define ACTION_NO_COOKIE_READ 0x00001000UL
1150 /** Action bitmap: Block setting cookies. */
1151 #define ACTION_NO_COOKIE_SET 0x00002000UL
1152 /** Action bitmap: Override the forward settings in the config file */
1153 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
1154 /** Action bitmap: Block as empty document */
1155 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
1156 /** Action bitmap: Limit CONNECT requests to safe ports. */
1157 #define ACTION_LIMIT_CONNECT 0x00010000UL
1158 /** Action bitmap: Redirect request. */
1159 #define ACTION_REDIRECT 0x00020000UL
1160 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1161 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1162 /** Action bitmap: Overwrite Content-Type header. */
1163 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1164 /** Action bitmap: Crunch specified server header. */
1165 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1166 /** Action bitmap: Crunch specified client header */
1167 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1168 /** Action bitmap: Enable text mode by force */
1169 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1170 /** Action bitmap: Enable text mode by force */
1171 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1172 /** Action bitmap: Enable content-dispostion crunching */
1173 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1174 /** Action bitmap: Replace or block Last-Modified header */
1175 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1176 /** Action bitmap: Replace or block Accept-Language header */
1177 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1180 /** Action string index: How to deanimate GIFs */
1181 #define ACTION_STRING_DEANIMATE 0
1182 /** Action string index: Replacement for "From:" header */
1183 #define ACTION_STRING_FROM 1
1184 /** Action string index: How to block images */
1185 #define ACTION_STRING_IMAGE_BLOCKER 2
1186 /** Action string index: Replacement for "Referer:" header */
1187 #define ACTION_STRING_REFERER 3
1188 /** Action string index: Replacement for "User-Agent:" header */
1189 #define ACTION_STRING_USER_AGENT 4
1190 /** Action string index: Legal CONNECT ports. */
1191 #define ACTION_STRING_LIMIT_CONNECT 5
1192 /** Action string index: Server headers containing this pattern are crunched*/
1193 #define ACTION_STRING_SERVER_HEADER 6
1194 /** Action string index: Client headers containing this pattern are crunched*/
1195 #define ACTION_STRING_CLIENT_HEADER 7
1196 /** Action string index: Replacement for the "Accept-Language:" header*/
1197 #define ACTION_STRING_LANGUAGE 8
1198 /** Action string index: Replacement for the "Content-Type:" header*/
1199 #define ACTION_STRING_CONTENT_TYPE 9
1200 /** Action string index: Replacement for the "content-dispostion:" header*/
1201 #define ACTION_STRING_CONTENT_DISPOSITION 10
1202 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1203 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1204 /** Action string index: Replacement for the "Last-Modified:" header. */
1205 #define ACTION_STRING_LAST_MODIFIED 12
1206 /** Action string index: Redirect URL */
1207 #define ACTION_STRING_REDIRECT 13
1208 /** Action string index: Decode before redirect? */
1209 #define ACTION_STRING_FAST_REDIRECTS 14
1210 /** Action string index: Overriding forward rule. */
1211 #define ACTION_STRING_FORWARD_OVERRIDE 15
1212 /** Action string index: Reason for the block. */
1213 #define ACTION_STRING_BLOCK 16
1214 /** Action string index: what to do with the "X-Forwarded-For" header. */
1215 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
1216 /** Number of string actions. */
1217 #define ACTION_STRING_COUNT 18
1220 /* To make the ugly hack in sed easier to understand */
1221 #define CHECK_EVERY_HEADER_REMAINING 0
1224 /** Index into current_action_spec::multi[] for headers to add. */
1225 #define ACTION_MULTI_ADD_HEADER 0
1226 /** Index into current_action_spec::multi[] for content filters to apply. */
1227 #define ACTION_MULTI_FILTER 1
1228 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1229 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
1230 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1231 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
1232 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1233 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
1234 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1235 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
1236 /** Number of multi-string actions. */
1237 #define ACTION_MULTI_COUNT 6
1241 * This structure contains a list of actions to apply to a URL.
1242 * It only contains positive instructions - no "-" options.
1243 * It is not used to store the actions list itself, only for
1244 * url_actions() to return the current values.
1246 struct current_action_spec
1248 /** Actions to apply. A bit set to "1" means perform the action. */
1249 unsigned long flags;
1252 * Paramaters for those actions that require them.
1253 * Each entry is valid if & only if the corresponding entry in "flags" is
1256 char * string[ACTION_STRING_COUNT];
1258 /** Lists of strings for multi-string actions. */
1259 struct list multi[ACTION_MULTI_COUNT][1];
1264 * This structure contains a set of changes to actions.
1265 * It can contain both positive and negative instructions.
1266 * It is used to store an entry in the actions list.
1270 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1271 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1274 * Paramaters for those actions that require them.
1275 * Each entry is valid if & only if the corresponding entry in "flags" is
1278 char * string[ACTION_STRING_COUNT];
1280 /** Lists of strings to remove, for multi-string actions. */
1281 struct list multi_remove[ACTION_MULTI_COUNT][1];
1283 /** If nonzero, remove *all* strings from the multi-string action. */
1284 int multi_remove_all[ACTION_MULTI_COUNT];
1286 /** Lists of strings to add, for multi-string actions. */
1287 struct list multi_add[ACTION_MULTI_COUNT][1];
1292 * This structure is used to store action files.
1294 * It contains an URL or tag pattern, and the changes to
1295 * the actions. It's a linked list and should only be
1296 * free'd through unload_actions_file() unless there's
1297 * only a single entry.
1301 struct url_spec url[1]; /**< The URL or tag pattern. */
1303 struct action_spec *action; /**< Action settings that might be shared with
1304 the list entry before or after the current
1305 one and can't be free'd willy nilly. */
1307 struct url_actions *next; /**< Next action section in file, or NULL. */
1312 * Structure to make sure we only reuse the server socket
1313 * if the host and forwarding settings are the same.
1315 struct reusable_connection
1332 * Flags for use in csp->flags
1336 * Flag for csp->flags: Set if this client is processing data.
1337 * Cleared when the thread associated with this structure dies.
1339 #define CSP_FLAG_ACTIVE 0x01U
1342 * Flag for csp->flags: Set if the server's reply is in "chunked"
1345 #define CSP_FLAG_CHUNKED 0x02U
1348 * Flag for csp->flags: Set if this request was enforced, although it would
1349 * normally have been blocked.
1351 #define CSP_FLAG_FORCED 0x04U
1354 * Flag for csp->flags: Set if any modification to the body was done.
1356 #define CSP_FLAG_MODIFIED 0x08U
1359 * Flag for csp->flags: Set if request was blocked.
1361 #define CSP_FLAG_REJECTED 0x10U
1364 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1366 #define CSP_FLAG_TOGGLED_ON 0x20U
1369 * Flag for csp->flags: Set if an acceptable Connection header
1370 * has already been set by the client.
1372 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
1375 * Flag for csp->flags: Set if an acceptable Connection header
1376 * has already been set by the server.
1378 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
1381 * Flag for csp->flags: Signals header parsers whether they
1382 * are parsing server or client headers.
1384 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
1387 * Flag for csp->flags: Set if adding the Host: header
1390 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
1393 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1394 * XXX: As we now have tags we might as well ditch this.
1396 #define CSP_FLAG_NO_FILTERING 0x00000400U
1399 * Flag for csp->flags: Set the client IP has appended to
1400 * an already existing X-Forwarded-For header in which case
1401 * no new header has to be generated.
1403 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
1406 * Flag for csp->flags: Set if the server wants to keep
1407 * the connection alive.
1409 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
1411 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1413 * Flag for csp->flags: Set if the server specified the
1416 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00002000U
1419 * Flag for csp->flags: Set if the client wants to keep
1420 * the connection alive.
1422 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00004000U
1423 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1426 * Flags for use in return codes of child processes
1430 * Flag for process return code: Set if exiting porcess has been toggled
1431 * during its lifetime.
1433 #define RC_FLAG_TOGGLED 0x10
1436 * Flag for process return code: Set if exiting porcess has blocked its
1439 #define RC_FLAG_BLOCKED 0x20
1442 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1445 #define MAX_AF_FILES 10
1448 * The state of a Privoxy processing thread.
1452 /** The proxy's configuration */
1453 struct configuration_spec * config;
1455 /** The actions to perform on the current request */
1456 struct current_action_spec action[1];
1458 /** socket to talk to client (web browser) */
1461 /** socket to talk to server (web server or proxy) */
1464 /** current connection to the server (may go through a proxy) */
1465 struct reusable_connection server_connection;
1467 /** Multi-purpose flag container, see CSP_FLAG_* above */
1470 /** Client PC's IP address, as reported by the accept() function.
1474 /** Client PC's TCP address, as reported by the accept() function.
1476 struct sockaddr_storage tcp_addr;
1478 /** Client PC's IP address, as reported by the accept() function.
1480 unsigned long ip_addr_long;
1481 #endif /* def HAVE_RFC2553 */
1483 /** The URL that was requested */
1484 struct http_request http[1];
1487 * The final forwarding settings.
1488 * XXX: Currently this is only used for forward-override,
1489 * so we can free the space in sweep.
1491 struct forward_spec * fwd;
1493 /** An I/O buffer used for buffering data read from the network */
1496 /** List of all headers for this request */
1497 struct list headers[1];
1499 /** List of all tags that apply to this request */
1500 struct list tags[1];
1502 /** MIME-Type key, see CT_* above */
1503 unsigned int content_type;
1505 /** Actions files associated with this client */
1506 struct file_list *actions_list[MAX_AF_FILES];
1508 /** pcrs job files. */
1509 struct file_list *rlist[MAX_AF_FILES];
1511 /** Length after content modification. */
1512 unsigned long long content_length;
1514 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1515 /** Expected length of content after which we
1516 * should stop reading from the server socket.
1518 /* XXX: is this the right location? */
1519 unsigned long long expected_content_length;
1520 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1522 #ifdef FEATURE_TRUST
1525 struct file_list *tlist;
1527 #endif /* def FEATURE_TRUST */
1530 * Failure reason to embedded in the CGI error page,
1531 * or NULL. Currently only used for socks errors.
1533 char *error_message;
1535 /** Next thread in linked list. Only read or modify from the main thread! */
1536 struct client_state *next;
1541 * A function to add a header
1543 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1546 * A function to process a header
1548 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1552 * List of available CGI functions.
1554 struct cgi_dispatcher
1556 /** The URL of the CGI, relative to the CGI root. */
1557 const char * const name;
1559 /** The handler function for the CGI */
1560 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1562 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1563 const char * const description;
1565 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1571 * A data file used by Privoxy. Kept in a linked list.
1576 * This is a pointer to the data structures associated with the file.
1577 * Read-only once the structure has been created.
1582 * The unloader function.
1583 * Normally NULL. When we are finished with file (i.e. when we have
1584 * loaded a new one), set to a pointer to an unloader function.
1585 * Unloader will be called by sweep() (called from main loop) when
1586 * all clients using this file are done. This prevents threading
1589 void (*unloader)(void *);
1592 * Used internally by sweep(). Do not access from elsewhere.
1597 * File last-modified time, so we can check if file has been changed.
1598 * Read-only once the structure has been created.
1600 time_t lastmodified;
1603 * The full filename.
1608 * Pointer to next entry in the linked list of all "file_list"s.
1609 * This linked list is so that sweep() can navigate it.
1610 * Since sweep() can remove items from the list, we must be careful
1611 * to only access this value from main thread (when we know sweep
1612 * won't be running).
1614 struct file_list *next;
1618 #ifdef FEATURE_TRUST
1621 * The format of a trust file when loaded into memory.
1625 struct url_spec url[1]; /**< The URL pattern */
1626 int reject; /**< FIXME: Please document this! */
1627 struct block_spec *next; /**< Next entry in linked list */
1631 * Arbitrary limit for the number of trusted referrers.
1633 #define MAX_TRUSTED_REFERRERS 512
1635 #endif /* def FEATURE_TRUST */
1638 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1639 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1640 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1641 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1645 * How to forward a connection to a parent proxy.
1649 /** URL pattern that this forward_spec is for. */
1650 struct url_spec url[1];
1652 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1655 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1658 /** SOCKS server port. */
1661 /** Parent HTTP proxy hostname, or NULL for none. */
1664 /** Parent HTTP proxy port. */
1667 /** Next entry in the linked list. */
1668 struct forward_spec *next;
1673 * Initializer for a static struct forward_spec.
1675 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1677 /* Supported filter types */
1678 #define FT_CONTENT_FILTER 0
1679 #define FT_CLIENT_HEADER_FILTER 1
1680 #define FT_SERVER_HEADER_FILTER 2
1681 #define FT_CLIENT_HEADER_TAGGER 3
1682 #define FT_SERVER_HEADER_TAGGER 4
1684 #define MAX_FILTER_TYPES 5
1687 * This struct represents one filter (one block) from
1688 * the re_filterfile. If there is more than one filter
1689 * in the file, the file will be represented by a
1690 * chained list of re_filterfile specs.
1692 struct re_filterfile_spec
1694 char *name; /**< Name from FILTER: statement in re_filterfile. */
1695 char *description; /**< Description from FILTER: statement in re_filterfile. */
1696 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1697 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1698 int type; /**< Filter type (content, client-header, server-header). */
1699 int dynamic; /**< Set to one if the pattern might contain variables
1700 and has to be recompiled for every request. */
1701 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1707 #define ACL_PERMIT 1 /**< Accept connection request */
1708 #define ACL_DENY 2 /**< Reject connection request */
1711 * An IP address pattern. Used to specify networks in the ACL.
1713 struct access_control_addr
1716 struct sockaddr_storage addr; /* <The TCP address in network order. */
1717 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1719 unsigned long addr; /**< The IP address as an integer. */
1720 unsigned long mask; /**< The network mask as an integer. */
1721 unsigned long port; /**< The port number. */
1722 #endif /* HAVE_RFC2553 */
1726 * An access control list (ACL) entry.
1728 * This is a linked list.
1730 struct access_control_list
1732 struct access_control_addr src[1]; /**< Client IP address */
1733 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1735 int wildcard_dst; /** < dst address is wildcard */
1738 short action; /**< ACL_PERMIT or ACL_DENY */
1739 struct access_control_list *next; /**< The next entry in the ACL. */
1742 #endif /* def FEATURE_ACL */
1745 /** Maximum number of loaders (actions, re_filter, ...) */
1749 /** configuration_spec::feature_flags: CGI actions editor. */
1750 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1752 /** configuration_spec::feature_flags: Web-based toggle. */
1753 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1755 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1756 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1758 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1759 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1761 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1762 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1764 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1765 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1767 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1768 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1770 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1771 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1773 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1774 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1777 * Data loaded from the configuration file.
1779 * (Anomaly: toggle is still handled through a global, not this structure)
1781 struct configuration_spec
1786 /** Nonzero to enable multithreading. */
1790 * Bitmask of features that can be enabled/disabled through the config
1791 * file. Currently defined bits:
1793 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1794 * - RUNTIME_FEATURE_CGI_TOGGLE
1795 * - RUNTIME_FEATURE_HTTP_TOGGLE
1796 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1798 unsigned feature_flags;
1800 /** The log file name. */
1801 const char *logfile;
1803 /** The config file directory. */
1804 const char *confdir;
1806 /** The directory for customized CGI templates. */
1807 const char *templdir;
1809 /** The log file directory. */
1812 /** The full paths to the actions files. */
1813 const char *actions_file[MAX_AF_FILES];
1815 /** The short names of the actions files. */
1816 const char *actions_file_short[MAX_AF_FILES];
1818 /** The administrator's email address */
1819 char *admin_address;
1821 /** A URL with info on this proxy */
1822 char *proxy_info_url;
1824 /** URL to the user manual (on our website or local copy) */
1827 /** The file names of the pcre filter files. */
1828 const char *re_filterfile[MAX_AF_FILES];
1830 /** The short names of the pcre filter files. */
1831 const char *re_filterfile_short[MAX_AF_FILES];
1833 /** The hostname to show on CGI pages, or NULL to use the real one. */
1834 const char *hostname;
1836 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1839 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1842 /** Size limit for IOB */
1843 size_t buffer_limit;
1845 #ifdef FEATURE_TRUST
1847 /** The file name of the trust file. */
1848 const char * trustfile;
1850 /** FIXME: DOCME: Document this. */
1851 struct list trust_info[1];
1853 /** FIXME: DOCME: Document this. */
1854 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1856 #endif /* def FEATURE_TRUST */
1860 /** The access control list (ACL). */
1861 struct access_control_list *acl;
1863 #endif /* def FEATURE_ACL */
1865 /** Information about parent proxies (forwarding). */
1866 struct forward_spec *forward;
1868 /** Number of retries in case a forwarded connection attempt fails */
1869 int forwarded_connect_retries;
1871 /** Maximum number of client connections. */
1872 int max_client_connections;
1874 /* Timeout when waiting on sockets for data to become available. */
1877 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1878 /* Number of seconds after which an open connection will no longer be reused. */
1879 int keep_alive_timeout;
1882 /** All options from the config file, HTML-formatted. */
1885 /** The configuration file object. */
1886 struct file_list *config_file_list;
1888 /** List of loaders */
1889 int (*loaders[NLOADERS])(struct client_state *);
1891 /** Nonzero if we need to bind() to the new port. */
1895 /** Calculates the number of elements in an array, using sizeof. */
1896 #define SZ(X) (sizeof(X) / sizeof(*X))
1898 #ifdef FEATURE_FORCE_LOAD
1899 /** The force load URL prefix. */
1900 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1901 #endif /* def FEATURE_FORCE_LOAD */
1903 #ifdef FEATURE_NO_GIFS
1904 /** The MIME type for images ("image/png" or "image/gif"). */
1905 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1907 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1908 #endif /* def FEATURE_NO_GIFS */
1915 /** URL for the Privoxy home page. */
1916 #define HOME_PAGE_URL "http://www.privoxy.org/"
1918 /** URL for the Privoxy user manual. */
1919 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1921 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1922 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1924 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1925 #define CONFIG_HELP_PREFIX "config.html#"
1928 * The "hosts" to intercept and display CGI pages.
1929 * First one is a hostname only, second one can specify host and path.
1932 * 1) Do not specify the http: prefix
1933 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1934 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1936 #define CGI_SITE_1_HOST "p.p"
1937 #define CGI_SITE_2_HOST "config.privoxy.org"
1938 #define CGI_SITE_2_PATH ""
1941 * The prefix for CGI pages. Written out in generated HTML.
1942 * INCLUDES the trailing slash.
1944 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1950 #endif /* ndef PROJECT_H_INCLUDED */