1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.131 2009/04/17 11:34:35 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.131 2009/04/17 11:34:35 fabiankeil
41 * Style cosmetics for the IPv6 code.
43 * Revision 1.130 2009/04/17 11:27:49 fabiankeil
44 * Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
46 * Revision 1.129 2009/03/08 14:12:51 fabiankeil
47 * All the CSP_FLAG_FOO bit masks should be unsigned ints.
49 * Revision 1.128 2009/03/07 13:09:17 fabiankeil
50 * Change csp->expected_content and_csp->expected_content_length from
51 * size_t to unsigned long long to reduce the likelihood of integer
52 * overflows that would let us close the connection prematurely.
53 * Bug found while investigating #2669131, reported by cyberpatrol.
55 * Revision 1.127 2008/12/20 14:53:55 fabiankeil
56 * Add config option socket-timeout to control the time
57 * Privoxy waits for data to arrive on a socket. Useful
58 * in case of stale ssh tunnels or when fuzz-testing.
60 * Revision 1.126 2008/12/14 17:02:54 fabiankeil
61 * Fix a cparser warning.
63 * Revision 1.125 2008/11/20 08:22:28 fabiankeil
64 * Remove an obsolete comment.
66 * Revision 1.124 2008/11/16 12:43:49 fabiankeil
67 * Turn keep-alive support into a runtime feature
68 * that is disabled by setting keep-alive-timeout
69 * to a negative value.
71 * Revision 1.123 2008/11/10 16:55:59 fabiankeil
72 * Fix a gcc44 warning (in filters.c).
74 * Revision 1.122 2008/10/16 07:11:34 fabiankeil
75 * Fix a bunch of gcc44 conversion warnings.
77 * Revision 1.121 2008/10/09 18:21:41 fabiankeil
78 * Flush work-in-progress changes to keep outgoing connections
79 * alive where possible. Incomplete and mostly #ifdef'd out.
81 * Revision 1.120 2008/09/21 13:36:52 fabiankeil
82 * If change-x-forwarded-for{add} is used and the client
83 * sends multiple X-Forwarded-For headers, append the client's
84 * IP address to each one of them. "Traditionally" we would
85 * lose all but the last one.
87 * Revision 1.119 2008/09/20 10:04:33 fabiankeil
88 * Remove hide-forwarded-for-headers action which has
89 * been obsoleted by change-x-forwarded-for{block}.
91 * Revision 1.118 2008/09/19 15:26:29 fabiankeil
92 * Add change-x-forwarded-for{} action to block or add
93 * X-Forwarded-For headers. Mostly based on code removed
96 * Revision 1.117 2008/08/30 12:03:07 fabiankeil
97 * Remove FEATURE_COOKIE_JAR.
99 * Revision 1.116 2008/05/20 16:05:02 fabiankeil
100 * Move parsers structure definition from project.h to parsers.h.
102 * Revision 1.115 2008/05/19 16:57:20 fabiankeil
103 * Declare all members of the parsers structure immutable.
105 * Revision 1.114 2008/04/11 16:35:39 fabiankeil
106 * Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
108 * Revision 1.113 2008/04/10 14:41:04 fabiankeil
109 * Ditch url_spec's path member now that it's no longer used.
111 * Revision 1.112 2008/04/06 15:18:34 fabiankeil
112 * Oh well, rename the --enable-pcre-host-patterns option to
113 * --enable-extended-host-patterns as it's not really PCRE syntax.
115 * Revision 1.111 2008/04/06 14:54:26 fabiankeil
116 * Use PCRE syntax in host patterns when configured
117 * with --enable-pcre-host-patterns.
119 * Revision 1.110 2008/03/29 12:13:46 fabiankeil
120 * Remove send-wafer and send-vanilla-wafer actions.
122 * Revision 1.109 2008/03/28 15:13:41 fabiankeil
123 * Remove inspect-jpegs action.
125 * Revision 1.108 2008/03/27 18:27:36 fabiankeil
126 * Remove kill-popups action.
128 * Revision 1.107 2008/03/26 18:07:08 fabiankeil
129 * Add hostname directive. Closes PR#1918189.
131 * Revision 1.106 2008/03/24 11:21:03 fabiankeil
132 * Share the action settings for multiple patterns in the same
133 * section so we waste less memory for gigantic block lists
134 * (and load them slightly faster). Reported by Franz Schwartau.
136 * Revision 1.105 2008/03/21 11:16:27 fabiankeil
137 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
139 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
140 * Remove the treat-forbidden-connects-like-blocks action. We now
141 * use the "blocked" page for forbidden CONNECT requests by default.
143 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
144 * Let the block action take the reason for the block
145 * as argument and show it on the "blocked" page.
147 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
148 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
150 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
151 * Remove now-obsolete csp member x_forwarded.
153 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
154 * - Allow port lists in url patterns.
155 * - Ditch unused url_spec member pathlen.
157 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
158 * As Hal noticed, checking dispatch_cgi() as the last cruncher
159 * looks like a bug if CGI requests are blocked unintentionally,
160 * so don't do it unless the user enabled the new config option
161 * "allow-cgi-request-crunching".
163 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
164 * Add new csp->content_type flag (CT_DECLARED).
166 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
167 * - Remove some left-overs from the switch to dedicated header filters.
168 * - Adjust "X-Filter: No" to disable dedicated header filters.
169 * - Prepare for forward-override{}
171 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
172 * Ditch the csp member cookie_list[] which isn't used anymore.
174 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
175 * Introduce dynamic pcrs jobs that can resolve variables.
177 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
178 * Introduce tags as alternative way to specify which
179 * actions apply to a request. At the moment tags can be
180 * created based on client and server headers.
182 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
183 * Use dedicated header filter actions instead of abusing "filter".
184 * Replace "filter-client-headers" and "filter-client-headers"
185 * with "server-header-filter" and "client-header-filter".
187 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
188 * New config option: enforce-blocks.
190 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
191 * Add some CSP_FLAGs for the header parsers.
193 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
194 * Add new http_response member to save
195 * the reason why the response was generated.
197 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
198 * Add new config option "templdir" to
199 * change the templates directory.
201 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
202 * Add csp->error_message for failure reasons
203 * that should be embedded into the CGI pages.
205 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
206 * Integrate a modified version of Wil Mahan's
207 * zlib patch (PR #895531).
209 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
210 * Added config option accept-intercepted-requests
211 * and disabled it by default.
213 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
214 * Fix gcc43 compiler warnings and a comment.
216 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
217 * Add config option "split-large-forms"
218 * to work around the browser bug reported
221 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
222 * Moved HTTP snipplets into jcc.c. They aren't
223 * used anywhere else.
225 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
226 * Doubled size of HOSTENT_BUFFER_SIZE to mask
227 * problems with gethostbyname_r and some
228 * /etc/hosts configurations. Only a workaround
229 * until we get the real fix ready.
230 * Thanks Félix Rauch for reporting.
232 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
234 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
235 * Respond with 400 and a short text message
236 * if the client tries to use Privoxy as FTP proxy.
238 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
239 * Added config option enable-remote-http-toggle
240 * to specify if Privoxy should recognize special
241 * headers (currently only X-Filter) to change its
242 * behaviour. Disabled by default.
244 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
245 * Make number of retries in case of forwarded-connect problems
246 * a config file option (forwarded-connect-retries) and use 0 as
249 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
250 * Work around a buffer overflow that caused Privoxy to
251 * segfault if too many trusted referrers were used. Good
252 * enough for now, but should be replaced with a real
253 * solution after the next release.
255 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
258 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
259 * Split filter-headers{} into filter-client-headers{}
260 * and filter-server-headers{}.
261 * Added parse_header_time() to share some code.
262 * Replaced timegm() with mktime().
264 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
265 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
267 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
268 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
269 * with what was really the latest development (the v_3_0_branch branch)
271 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
272 * Multiple filter file support
274 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
275 * Add the ability to check jpeg images for invalid
276 * lengths of comment blocks. Defensive strategy
277 * against the exploit:
278 * Microsoft Security Bulletin MS04-028
279 * Buffer Overrun in JPEG Processing (GDI+) Could
280 * Allow Code Execution (833987)
281 * Enabled with +inspect-jpegs in actions files.
283 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
284 * Updated the copyright note
286 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
287 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
289 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
290 * Introduced RC_FLAG_* flags for use in child process return code
292 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
293 * Added flag to each cgi_dispatcher that allows or denies
294 * external linking and removed const qualifier from
295 * struct list_entry.str.
297 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
298 * - Include config.h for access to config data
299 * - Include <pcre*.h> depending on where they are
301 * Revision 1.72 2002/05/14 21:35:49 oes
302 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
303 * because of split in user-manual
305 * Revision 1.71 2002/05/12 21:39:36 jongfoster
306 * - Adding Doxygen-style comments to structures and #defines.
308 * Revision 1.70 2002/05/12 16:05:50 jongfoster
309 * Fixing ACTION_MASK_ALL to be unsigned long rather than
310 * just unsigned int. I don't know if anyone is porting
311 * Privoxy to 16-bit platforms, but if so, +limit-connect
312 * wouldn't have worked because of this bug.
314 * Revision 1.69 2002/05/08 16:00:16 oes
315 * Added size member to struct iob, so it can
316 * be alloced larger than needed.
318 * Revision 1.68 2002/04/26 12:56:00 oes
319 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
321 * Revision 1.67 2002/04/24 02:12:43 oes
322 * - Jon's multiple AF patch:
323 * - Make csp->actions_list an array
324 * - #define MAX_AF_FILES
325 * - Moved CGI_PARAM_LEN_MAX (500) here
327 * Revision 1.66 2002/04/15 19:06:43 jongfoster
330 * Revision 1.65 2002/04/04 00:36:36 gliptak
331 * always use pcre for matching
333 * Revision 1.64 2002/04/03 22:28:03 gliptak
334 * Removed references to gnu_regex
336 * Revision 1.63 2002/03/31 17:19:00 jongfoster
337 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
339 * Revision 1.62 2002/03/26 22:48:49 swa
342 * Revision 1.61 2002/03/26 22:29:55 swa
343 * we have a new homepage!
345 * Revision 1.60 2002/03/24 15:52:17 jongfoster
346 * Changing CGI URL prefixes for new name
348 * Revision 1.59 2002/03/24 15:23:33 jongfoster
351 * Revision 1.58 2002/03/24 13:25:43 swa
352 * name change related issues
354 * Revision 1.57 2002/03/16 20:28:34 oes
355 * Added descriptions to the filters so users will know what they select in the cgi editor
357 * Revision 1.56 2002/03/13 20:27:30 oes
358 * Fixing bug with CT_TABOO
360 * Revision 1.55 2002/03/12 01:42:50 oes
361 * Introduced modular filters
363 * Revision 1.54 2002/03/09 20:03:52 jongfoster
364 * - Making various functions return int rather than size_t.
365 * (Undoing a recent change). Since size_t is unsigned on
366 * Windows, functions like read_socket that return -1 on
367 * error cannot return a size_t.
369 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
370 * crashes, and also frequently caused JB to jump to 100%
371 * CPU and stay there. (Because it thought it had just
372 * read ((unsigned)-1) == 4Gb of data...)
374 * - The signature of write_socket has changed, it now simply
375 * returns success=0/failure=nonzero.
377 * - Trying to get rid of a few warnings --with-debug on
378 * Windows, I've introduced a new type "jb_socket". This is
379 * used for the socket file descriptors. On Windows, this
380 * is SOCKET (a typedef for unsigned). Everywhere else, it's
381 * an int. The error value can't be -1 any more, so it's
382 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
383 * Windows it maps to the #define INVALID_SOCKET.)
385 * - The signature of bind_port has changed.
387 * Revision 1.53 2002/03/08 16:48:55 oes
388 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
390 * Revision 1.52 2002/03/07 03:46:17 oes
391 * Fixed compiler warnings
393 * Revision 1.51 2002/03/05 04:52:42 oes
394 * Deleted non-errlog debugging code
396 * Revision 1.50 2002/03/04 19:32:07 oes
397 * Changed default port to 8118
399 * Revision 1.49 2002/03/04 18:28:55 oes
400 * Deleted PID_FILE_NAME
402 * Revision 1.48 2002/03/03 14:50:40 oes
403 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
405 * Revision 1.47 2002/02/20 23:15:13 jongfoster
406 * Parsing functions now handle out-of-memory gracefully by returning
409 * Revision 1.46 2002/01/17 21:06:09 jongfoster
410 * Now #defining the URLs of the config interface
412 * Minor changes to struct http_request and struct url_spec due to
413 * standardizing that struct http_request is used to represent a URL, and
414 * struct url_spec is used to represent a URL pattern. (Before, URLs were
415 * represented as seperate variables and a partially-filled-in url_spec).
417 * Revision 1.45 2002/01/09 14:33:27 oes
418 * Added HOSTENT_BUFFER_SIZE
420 * Revision 1.44 2001/12/30 14:07:32 steudten
421 * - Add signal handling (unix)
422 * - Add SIGHUP handler (unix)
423 * - Add creation of pidfile (unix)
424 * - Add action 'top' in rc file (RH)
425 * - Add entry 'SIGNALS' to manpage
426 * - Add exit message to logfile (unix)
428 * Revision 1.43 2001/11/22 21:57:51 jongfoster
429 * Making action_spec->flags into an unsigned long rather than just an
431 * Adding ACTION_NO_COOKIE_KEEP
433 * Revision 1.42 2001/11/05 21:42:41 steudten
434 * Include DBG() macro.
436 * Revision 1.41 2001/10/28 19:12:06 jongfoster
437 * Adding ijb_toupper()
439 * Revision 1.40 2001/10/26 17:40:47 oes
440 * Moved ijb_isspace and ijb_tolower to project.h
441 * Removed http->user_agent, csp->referrer and csp->accept_types
443 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
444 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
445 * macro when called with a cast; so moving the cast to the macro def'n
446 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
447 * doesn't make macro expansion complain. Hope this works for everyone else
450 * Revision 1.38 2001/10/23 21:19:04 jongfoster
451 * New error-handling support: jb_err type and JB_ERR_xxx constants
452 * CGI functions now return a jb_err, and their parameters map is const.
453 * Support for RUNTIME_FEATUREs to enable/disable config editor
454 * Adding a few comments
456 * Revision 1.37 2001/10/14 22:14:01 jongfoster
457 * Removing name_length field from struct cgi_dispatcher, as this is
458 * now calculated at runtime from the "name" field.
460 * Revision 1.36 2001/10/10 16:45:15 oes
461 * Added LIMIT_CONNECT action and string
462 * Fixed HTTP message line termination
463 * Added CFORBIDDEN HTTP message
465 * Revision 1.35 2001/10/07 18:06:43 oes
466 * Added status member to struct http_request
468 * Revision 1.34 2001/10/07 15:45:25 oes
469 * Added url member to struct http_request and commented all
474 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
476 * Replaced struct client_state members rejected,
477 * force, active and toggled_on with "flags" bitmap.
479 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
481 * Added buffer_limit to struct configuration_spec
483 * Revision 1.33 2001/09/20 13:30:08 steudten
485 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
486 * Last case will set z to NULL in free(z) and thats bad..
488 * Revision 1.32 2001/09/16 23:02:51 jongfoster
491 * Revision 1.31 2001/09/16 13:20:29 jongfoster
492 * Rewrite of list library. Now has seperate header and list_entry
493 * structures. Also added a large sprinking of assert()s to the list
496 * Revision 1.30 2001/09/13 23:52:00 jongfoster
497 * Support for both static and dynamically generated CGI pages
499 * Revision 1.29 2001/09/13 23:29:43 jongfoster
500 * Defining FORWARD_SPEC_INITIALIZER
502 * Revision 1.28 2001/09/13 23:05:50 jongfoster
503 * Changing the string paramater to the header parsers a "const".
505 * Revision 1.27 2001/08/05 16:06:20 jongfoster
506 * Modifiying "struct map" so that there are now separate header and
507 * "map_entry" structures. This means that functions which modify a
508 * map no longer need to return a pointer to the modified map.
509 * Also, it no longer reverses the order of the entries (which may be
510 * important with some advanced template substitutions).
512 * Revision 1.26 2001/07/30 22:08:36 jongfoster
513 * Tidying up #defines:
514 * - All feature #defines are now of the form FEATURE_xxx
515 * - Permanently turned off WIN_GUI_EDIT
516 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
518 * Revision 1.25 2001/07/29 18:43:08 jongfoster
519 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
522 * Revision 1.24 2001/07/25 17:20:27 oes
523 * Introduced http->user_agent
525 * Revision 1.23 2001/07/18 12:32:23 oes
526 * - Added ACTION_STRING_DEANIMATE
527 * - moved #define freez from jcc.h to project.h
529 * Revision 1.22 2001/07/15 17:51:41 jongfoster
530 * Renaming #define STATIC to STATIC_PCRE
532 * Revision 1.21 2001/07/13 14:03:19 oes
533 * - Reorganized regex header inclusion and #defines to
534 * comply to the scheme in configure.in
535 * - Added csp->content_type and its CT_* keys
536 * - Added ACTION_DEANIMATE
537 * - Removed all #ifdef PCRS
539 * Revision 1.20 2001/06/29 21:45:41 oes
540 * Indentation, CRLF->LF, Tab-> Space
542 * Revision 1.19 2001/06/29 13:33:36 oes
543 * - Improved comments
544 * - Introduced http_request.host_ip_addr_str
545 * - Introduced http_response.head_length
546 * - Introduced config.my_ip_addr_str, config.my_hostname,
547 * config.admin_address and config.proxy_info_url
548 * - Removed config.proxy_args_header and config.proxy_args_trailer,
549 * renamed config.proxy_args_invocation to config.proxy_args
550 * - Removed HTML snipplets and GIFs
551 * - Removed logentry from cancelled commit
553 * Revision 1.18 2001/06/09 10:57:39 jongfoster
554 * Adding definition of BUFFER_SIZE.
555 * Changing struct cgi_dispatcher to use "const" strings.
557 * Revision 1.17 2001/06/07 23:15:09 jongfoster
558 * Merging ACL and forward files into config file.
559 * Moving struct gateway members into struct forward_spec
560 * Removing config->proxy_args_gateways
561 * Cosmetic: Adding a few comments
563 * Revision 1.16 2001/06/04 18:31:58 swa
564 * files are now prefixed with either `confdir' or `logdir'.
565 * `make redhat-dist' replaces both entries confdir and logdir
568 * Revision 1.15 2001/06/04 11:28:53 swa
569 * redirect did not work due to missing /
571 * Revision 1.14 2001/06/03 11:03:48 oes
573 * added struct http_response,
574 * changed struct interceptors to struct cgi_dispatcher,
575 * moved HTML stuff to cgi.h
577 * Revision 1.13 2001/06/01 20:05:36 jongfoster
578 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
579 * constant, and removed csp->tinygif.
581 * Revision 1.12 2001/06/01 18:49:17 jongfoster
582 * Replaced "list_share" with "list" - the tiny memory gain was not
583 * worth the extra complexity.
585 * Revision 1.11 2001/06/01 10:32:47 oes
586 * Added constants for anchoring selection bitmap
588 * Revision 1.10 2001/05/31 21:33:53 jongfoster
589 * Changes for new actions file, replacing permissionsfile
590 * and parts of the config file. Also added support for
593 * Revision 1.9 2001/05/31 17:32:31 oes
595 * - Enhanced domain part globbing with infix and prefix asterisk
596 * matching and optional unanchored operation
598 * Revision 1.8 2001/05/29 20:09:15 joergs
599 * HTTP_REDIRECT_TEMPLATE fixed.
601 * Revision 1.7 2001/05/29 09:50:24 jongfoster
602 * Unified blocklist/imagelist/actionslist.
603 * File format is still under discussion, but the internal changes
606 * Also modified interceptor behaviour:
607 * - We now intercept all URLs beginning with one of the following
608 * prefixes (and *only* these prefixes):
610 * * http://ijbswa.sf.net/config/
611 * * http://ijbswa.sourceforge.net/config/
612 * - New interceptors "home page" - go to http://i.j.b/ to see it.
613 * - Internal changes so that intercepted and fast redirect pages
614 * are not replaced with an image.
615 * - Interceptors now have the option to send a binary page direct
616 * to the client. (i.e. ijb-send-banner uses this)
617 * - Implemented show-url-info interceptor. (Which is why I needed
618 * the above interceptors changes - a typical URL is
619 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
620 * The previous mechanism would not have intercepted that, and
621 * if it had been intercepted then it then it would have replaced
624 * Revision 1.6 2001/05/27 22:17:04 oes
626 * - re_process_buffer no longer writes the modified buffer
627 * to the client, which was very ugly. It now returns the
628 * buffer, which it is then written by chat.
630 * - content_length now adjusts the Content-Length: header
631 * for modified documents rather than crunch()ing it.
632 * (Length info in csp->content_length, which is 0 for
633 * unmodified documents)
635 * - For this to work, sed() is called twice when filtering.
637 * Revision 1.5 2001/05/26 00:28:36 jongfoster
638 * Automatic reloading of config file.
639 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
640 * Most of the global variables have been moved to a new
641 * struct configuration_spec, accessed through csp->config->globalname
642 * Most of the globals remaining are used by the Win32 GUI.
644 * Revision 1.4 2001/05/22 18:46:04 oes
646 * - Enabled filtering banners by size rather than URL
647 * by adding patterns that replace all standard banner
648 * sizes with the "Junkbuster" gif to the re_filterfile
650 * - Enabled filtering WebBugs by providing a pattern
651 * which kills all 1x1 images
653 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
654 * which is selected by the (nonstandard and therefore
655 * capital) letter 'U' in the option string.
656 * It causes the quantifiers to be ungreedy by default.
657 * Appending a ? turns back to greedy (!).
659 * - Added a new interceptor ijb-send-banner, which
660 * sends back the "Junkbuster" gif. Without imagelist or
661 * MSIE detection support, or if tinygif = 1, or the
662 * URL isn't recognized as an imageurl, a lame HTML
663 * explanation is sent instead.
665 * - Added new feature, which permits blocking remote
666 * script redirects and firing back a local redirect
668 * The feature is conditionally compiled, i.e. it
669 * can be disabled with --disable-fast-redirects,
670 * plus it must be activated by a "fast-redirects"
671 * line in the config file, has its own log level
672 * and of course wants to be displayed by show-proxy-args
673 * Note: Boy, all the #ifdefs in 1001 locations and
674 * all the fumbling with configure.in and acconfig.h
675 * were *way* more work than the feature itself :-(
677 * - Because a generic redirect template was needed for
678 * this, tinygif = 3 now uses the same.
680 * - Moved GIFs, and other static HTTP response templates
685 * - Removed some >400 CRs again (Jon, you really worked
688 * Revision 1.3 2001/05/20 01:21:20 jongfoster
689 * Version 2.9.4 checkin.
690 * - Merged popupfile and cookiefile, and added control over PCRS
691 * filtering, in new "actionsfile".
692 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
693 * file error you now get a message box (in the Win32 GUI) rather
694 * than the program exiting with no explanation.
695 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
697 * - Removed tabs from "config"
698 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
699 * - Bumped up version number.
701 * Revision 1.2 2001/05/17 23:01:01 oes
702 * - Cleaned CRLF's from the sources and related files
704 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
705 * Initial import of version 2.9.3 source tree
708 *********************************************************************/
711 /* Declare struct FILE for vars and funcs. */
714 /* Need time_t for file_list */
716 /* Needed for pcre choice */
720 /* Need for struct sockaddr_storage */
721 #include <sys/socket.h>
726 * Include appropriate regular expression libraries.
727 * Note that pcrs and pcre (native) are needed for cgi
728 * and are included anyway.
734 # ifdef PCRE_H_IN_SUBDIR
735 # include <pcre/pcre.h>
748 # include "pcreposix.h"
750 # ifdef PCRE_H_IN_SUBDIR
751 # include <pcre/pcreposix.h>
753 # include <pcreposix.h>
759 #endif /* def AMIGA */
763 * I don't want to have to #include all this just for the declaration
764 * of SOCKET. However, it looks like we have to...
779 typedef SOCKET jb_socket;
781 #define JB_INVALID_SOCKET INVALID_SOCKET
783 #else /* ndef _WIN32 */
786 * The type used by sockets. On UNIX it's an int. Microsoft decided to
787 * make it an unsigned.
789 typedef int jb_socket;
792 * The error value used for variables of type jb_socket. On UNIX this
793 * is -1, however Microsoft decided to make socket handles unsigned, so
794 * they use a different value.
797 #define JB_INVALID_SOCKET (-1)
799 #endif /* ndef _WIN32 */
803 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
808 #define JB_ERR_OK 0 /**< Success, no error */
809 #define JB_ERR_MEMORY 1 /**< Out of memory */
810 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
811 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
812 #define JB_ERR_PARSE 4 /**< Error parsing file */
813 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
814 CGI actions editor. */
815 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
818 * This macro is used to free a pointer that may be NULL.
819 * It also sets the variable to NULL after it's been freed.
820 * The paramater should be a simple variable without side effects.
822 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
826 * Fix a problem with Solaris. There should be no effect on other
829 * Solaris's isspace() is a macro which uses it's argument directly
830 * as an array index. Therefore we need to make sure that high-bit
831 * characters generate +ve values, and ideally we also want to make
832 * the argument match the declared parameter type of "int".
834 * Note: Remember to #include <ctype.h> if you use these macros.
836 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
837 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
838 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
841 * Use for statically allocated buffers if you have no other choice.
842 * Remember to check the length of what you write into the buffer
843 * - we don't want any buffer overflows!
845 #define BUFFER_SIZE 5000
848 * Max length of CGI parameters (arbitrary limit).
850 #define CGI_PARAM_LEN_MAX 500U
853 * Buffer size for capturing struct hostent data in the
854 * gethostby(name|addr)_r library calls. Since we don't
855 * loop over gethostbyname_r, the buffer must be sufficient
856 * to accomodate multiple IN A RRs, as used in DNS round robin
857 * load balancing. W3C's wwwlib uses 1K, so that should be
858 * good enough for us, too.
861 * XXX: Temporary doubled, for some configurations
862 * 1K is still too small and we didn't get the
863 * real fix ready for inclusion.
865 #define HOSTENT_BUFFER_SIZE 2048
868 * Do not use. Originally this was so that you can
869 * say "while (FOREVER) { ...do something... }".
870 * However, this gives a warning with some compilers (e.g. VC++).
871 * Instead, use "for (;;) { ...do something... }".
876 * Default TCP/IP address to listen on, as a string.
877 * Set to "127.0.0.1:8118".
879 #define HADDR_DEFAULT "127.0.0.1:8118"
882 /* Forward def for struct client_state */
883 struct configuration_spec;
887 * Entry in a linked list of strings.
892 * The string pointer. It must point to a dynamically malloc()ed
893 * string or be NULL for the list functions to work. In the latter
894 * case, just be careful next time you iterate through the list in
899 /** Next entry in the linked list, or NULL if no more. */
900 struct list_entry *next;
904 * A header for a linked list of strings.
908 /** First entry in the list, or NULL if the list is empty. */
909 struct list_entry *first;
911 /** Last entry in the list, or NULL if the list is empty. */
912 struct list_entry *last;
917 * An entry in a map. This is a name=value pair.
921 /** The key for the map. */
923 /** The value associated with that key. */
925 /** The next map entry, or NULL if none. */
926 struct map_entry *next;
930 * A map from a string to another string.
931 * This is used for the paramaters passed in a HTTP GET request, and
932 * to store the exports when the CGI interface is filling in a template.
936 /** The first map entry, or NULL if the map is empty. */
937 struct map_entry *first;
938 /** The last map entry, or NULL if the map is empty. */
939 struct map_entry *last;
944 * A HTTP request. This includes the method (GET, POST) and
947 * This is also used whenever we want to match a URL against a
948 * URL pattern. This always contains the URL to match, and never
949 * a URL pattern. (See struct url_spec).
953 char *cmd; /**< Whole command line: method, URL, Version */
954 char *ocmd; /**< Backup of original cmd for CLF logging */
955 char *gpc; /**< HTTP method: GET, POST, ... */
956 char *url; /**< The URL */
957 char *ver; /**< Protocol version */
958 int status; /**< HTTP Status */
960 char *host; /**< Host part of URL */
961 int port; /**< Port of URL or 80 (default) */
962 char *path; /**< Path of URL */
963 char *hostport; /**< host[:port] */
964 int ssl; /**< Flag if protocol is https */
966 char *host_ip_addr_str; /**< String with dotted decimal representation
967 of host's IP. NULL before connect_to() */
969 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
970 char **dvec; /**< List of pointers to the strings in dbuffer. */
971 int dcount; /**< How many parts to this domain? (length of dvec) */
975 * Reasons for generating a http_response instead of delivering
976 * the requested resource. Mostly ordered the way they are checked
979 #define RSP_REASON_UNSUPPORTED 1
980 #define RSP_REASON_BLOCKED 2
981 #define RSP_REASON_UNTRUSTED 3
982 #define RSP_REASON_REDIRECTED 4
983 #define RSP_REASON_CGI_CALL 5
984 #define RSP_REASON_NO_SUCH_DOMAIN 6
985 #define RSP_REASON_FORWARDING_FAILED 7
986 #define RSP_REASON_CONNECT_FAILED 8
987 #define RSP_REASON_OUT_OF_MEMORY 9
988 #define RSP_REASON_INTERNAL_ERROR 10
991 * Response generated by CGI, blocker, or error handler
995 char *status; /**< HTTP status (string). */
996 struct list headers[1]; /**< List of header lines. */
997 char *head; /**< Formatted http response head. */
998 size_t head_length; /**< Length of http response head. */
999 char *body; /**< HTTP document body. */
1000 size_t content_length; /**< Length of body, REQUIRED if binary body. */
1001 int is_static; /**< Nonzero if the content will never change and
1002 should be cached by the browser (e.g. images). */
1003 int reason; /**< Why the response was generated in the first place. */
1007 * A URL or a tag pattern.
1011 /** The string which was parsed to produce this url_spec.
1012 Used for debugging or display only. */
1015 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
1016 regex_t *host_regex;/**< Regex for host matching */
1018 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
1019 char **dvec; /**< List of pointers to the strings in dbuffer. */
1020 int dcount; /**< How many parts to this domain? (length of dvec) */
1021 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
1022 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
1024 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
1026 regex_t *preg; /**< Regex for matching path part */
1027 regex_t *tag_regex; /**< Regex for matching tags */
1031 * If you declare a static url_spec, this is the value to initialize it to zero.
1033 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
1034 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
1036 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
1037 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
1040 * Constant for host part matching in URLs. If set, indicates that the start of
1041 * the pattern must match the start of the URL. E.g. this is not set for the
1042 * pattern ".example.com", so that it will match both "example.com" and
1043 * "www.example.com". It is set for the pattern "example.com", which makes it
1044 * match "example.com" only, not "www.example.com".
1046 #define ANCHOR_LEFT 1
1049 * Constant for host part matching in URLs. If set, indicates that the end of
1050 * the pattern must match the end of the URL. E.g. this is not set for the
1051 * pattern "ad.", so that it will match any host called "ad", irrespective
1052 * of how many subdomains are in the fully-qualified domain name.
1054 #define ANCHOR_RIGHT 2
1058 * An I/O buffer. Holds a string which can be appended to, and can have data
1059 * removed from the beginning.
1063 char *buf; /**< Start of buffer */
1064 char *cur; /**< Start of relevant data */
1065 char *eod; /**< End of relevant data */
1066 size_t size; /**< Size as malloc()ed */
1071 * Return the number of bytes in the I/O buffer associated with the passed
1072 * client_state pointer.
1075 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1079 * Remove any data in the I/O buffer associated with the passed
1080 * client_state pointer.
1082 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1084 /* Bits for csp->content_type bitmask: */
1085 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
1086 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
1087 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
1089 /* Although these are not, strictly speaking, content types
1090 * (they are content encodings), it is simple to handle them
1093 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
1094 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1097 * Flag to signal that the server declared the content type,
1098 * so we can differentiate between unknown and undeclared
1101 #define CT_DECLARED 0x0040U
1104 * The mask which includes all actions.
1106 #define ACTION_MASK_ALL (~0UL)
1109 * The most compatible set of actions - i.e. none.
1111 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1113 /** Action bitmap: Block the request. */
1114 #define ACTION_BLOCK 0x00000001UL
1115 /** Action bitmap: Deanimate if it's a GIF. */
1116 #define ACTION_DEANIMATE 0x00000002UL
1117 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1118 #define ACTION_DOWNGRADE 0x00000004UL
1119 /** Action bitmap: Fast redirects. */
1120 #define ACTION_FAST_REDIRECTS 0x00000008UL
1121 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
1122 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
1123 /** Action bitmap: Hide "From" header. */
1124 #define ACTION_HIDE_FROM 0x00000020UL
1125 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1126 #define ACTION_HIDE_REFERER 0x00000040UL
1127 /** Action bitmap: Hide "User-Agent" and similar headers. */
1128 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1129 /** Action bitmap: This is an image. */
1130 #define ACTION_IMAGE 0x00000100UL
1131 /** Action bitmap: Sets the image blocker. */
1132 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1133 /** Action bitmap: Prevent compression. */
1134 #define ACTION_NO_COMPRESSION 0x00000400UL
1135 /** Action bitmap: Change cookies to session only cookies. */
1136 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1137 /** Action bitmap: Block rending cookies. */
1138 #define ACTION_NO_COOKIE_READ 0x00001000UL
1139 /** Action bitmap: Block setting cookies. */
1140 #define ACTION_NO_COOKIE_SET 0x00002000UL
1141 /** Action bitmap: Override the forward settings in the config file */
1142 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
1143 /** Action bitmap: Block as empty document */
1144 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
1145 /** Action bitmap: Limit CONNECT requests to safe ports. */
1146 #define ACTION_LIMIT_CONNECT 0x00010000UL
1147 /** Action bitmap: Redirect request. */
1148 #define ACTION_REDIRECT 0x00020000UL
1149 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1150 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1151 /** Action bitmap: Overwrite Content-Type header. */
1152 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1153 /** Action bitmap: Crunch specified server header. */
1154 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1155 /** Action bitmap: Crunch specified client header */
1156 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1157 /** Action bitmap: Enable text mode by force */
1158 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1159 /** Action bitmap: Enable text mode by force */
1160 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1161 /** Action bitmap: Enable content-dispostion crunching */
1162 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1163 /** Action bitmap: Replace or block Last-Modified header */
1164 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1165 /** Action bitmap: Replace or block Accept-Language header */
1166 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1169 /** Action string index: How to deanimate GIFs */
1170 #define ACTION_STRING_DEANIMATE 0
1171 /** Action string index: Replacement for "From:" header */
1172 #define ACTION_STRING_FROM 1
1173 /** Action string index: How to block images */
1174 #define ACTION_STRING_IMAGE_BLOCKER 2
1175 /** Action string index: Replacement for "Referer:" header */
1176 #define ACTION_STRING_REFERER 3
1177 /** Action string index: Replacement for "User-Agent:" header */
1178 #define ACTION_STRING_USER_AGENT 4
1179 /** Action string index: Legal CONNECT ports. */
1180 #define ACTION_STRING_LIMIT_CONNECT 5
1181 /** Action string index: Server headers containing this pattern are crunched*/
1182 #define ACTION_STRING_SERVER_HEADER 6
1183 /** Action string index: Client headers containing this pattern are crunched*/
1184 #define ACTION_STRING_CLIENT_HEADER 7
1185 /** Action string index: Replacement for the "Accept-Language:" header*/
1186 #define ACTION_STRING_LANGUAGE 8
1187 /** Action string index: Replacement for the "Content-Type:" header*/
1188 #define ACTION_STRING_CONTENT_TYPE 9
1189 /** Action string index: Replacement for the "content-dispostion:" header*/
1190 #define ACTION_STRING_CONTENT_DISPOSITION 10
1191 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1192 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1193 /** Action string index: Replacement for the "Last-Modified:" header. */
1194 #define ACTION_STRING_LAST_MODIFIED 12
1195 /** Action string index: Redirect URL */
1196 #define ACTION_STRING_REDIRECT 13
1197 /** Action string index: Decode before redirect? */
1198 #define ACTION_STRING_FAST_REDIRECTS 14
1199 /** Action string index: Overriding forward rule. */
1200 #define ACTION_STRING_FORWARD_OVERRIDE 15
1201 /** Action string index: Reason for the block. */
1202 #define ACTION_STRING_BLOCK 16
1203 /** Action string index: what to do with the "X-Forwarded-For" header. */
1204 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
1205 /** Number of string actions. */
1206 #define ACTION_STRING_COUNT 18
1209 /* To make the ugly hack in sed easier to understand */
1210 #define CHECK_EVERY_HEADER_REMAINING 0
1213 /** Index into current_action_spec::multi[] for headers to add. */
1214 #define ACTION_MULTI_ADD_HEADER 0
1215 /** Index into current_action_spec::multi[] for content filters to apply. */
1216 #define ACTION_MULTI_FILTER 1
1217 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1218 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
1219 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1220 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
1221 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1222 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
1223 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1224 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
1225 /** Number of multi-string actions. */
1226 #define ACTION_MULTI_COUNT 6
1230 * This structure contains a list of actions to apply to a URL.
1231 * It only contains positive instructions - no "-" options.
1232 * It is not used to store the actions list itself, only for
1233 * url_actions() to return the current values.
1235 struct current_action_spec
1237 /** Actions to apply. A bit set to "1" means perform the action. */
1238 unsigned long flags;
1241 * Paramaters for those actions that require them.
1242 * Each entry is valid if & only if the corresponding entry in "flags" is
1245 char * string[ACTION_STRING_COUNT];
1247 /** Lists of strings for multi-string actions. */
1248 struct list multi[ACTION_MULTI_COUNT][1];
1253 * This structure contains a set of changes to actions.
1254 * It can contain both positive and negative instructions.
1255 * It is used to store an entry in the actions list.
1259 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1260 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1263 * Paramaters for those actions that require them.
1264 * Each entry is valid if & only if the corresponding entry in "flags" is
1267 char * string[ACTION_STRING_COUNT];
1269 /** Lists of strings to remove, for multi-string actions. */
1270 struct list multi_remove[ACTION_MULTI_COUNT][1];
1272 /** If nonzero, remove *all* strings from the multi-string action. */
1273 int multi_remove_all[ACTION_MULTI_COUNT];
1275 /** Lists of strings to add, for multi-string actions. */
1276 struct list multi_add[ACTION_MULTI_COUNT][1];
1281 * This structure is used to store action files.
1283 * It contains an URL or tag pattern, and the changes to
1284 * the actions. It's a linked list and should only be
1285 * free'd through unload_actions_file() unless there's
1286 * only a single entry.
1290 struct url_spec url[1]; /**< The URL or tag pattern. */
1292 struct action_spec *action; /**< Action settings that might be shared with
1293 the list entry before or after the current
1294 one and can't be free'd willy nilly. */
1296 struct url_actions *next; /**< Next action section in file, or NULL. */
1301 * Flags for use in csp->flags
1305 * Flag for csp->flags: Set if this client is processing data.
1306 * Cleared when the thread associated with this structure dies.
1308 #define CSP_FLAG_ACTIVE 0x01U
1311 * Flag for csp->flags: Set if the server's reply is in "chunked"
1314 #define CSP_FLAG_CHUNKED 0x02U
1317 * Flag for csp->flags: Set if this request was enforced, although it would
1318 * normally have been blocked.
1320 #define CSP_FLAG_FORCED 0x04U
1323 * Flag for csp->flags: Set if any modification to the body was done.
1325 #define CSP_FLAG_MODIFIED 0x08U
1328 * Flag for csp->flags: Set if request was blocked.
1330 #define CSP_FLAG_REJECTED 0x10U
1333 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1335 #define CSP_FLAG_TOGGLED_ON 0x20U
1338 * Flag for csp->flags: Set if an acceptable Connection header
1341 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
1344 * Flag for csp->flags: Set if adding the 'Connection: close' header
1345 * for the server isn't necessary.
1347 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080U
1350 * Flag for csp->flags: Signals header parsers whether they
1351 * are parsing server or client headers.
1353 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
1356 * Flag for csp->flags: Set if adding the Host: header
1359 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
1362 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1363 * XXX: As we now have tags we might as well ditch this.
1365 #define CSP_FLAG_NO_FILTERING 0x00000400U
1368 * Flag for csp->flags: Set the client IP has appended to
1369 * an already existing X-Forwarded-For header in which case
1370 * no new header has to be generated.
1372 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
1375 * Flag for csp->flags: Set if the server wants to keep
1376 * the connection alive.
1378 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
1380 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1382 * Flag for csp->flags: Set if the server specified the
1385 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00002000U
1386 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1389 * Flags for use in return codes of child processes
1393 * Flag for process return code: Set if exiting porcess has been toggled
1394 * during its lifetime.
1396 #define RC_FLAG_TOGGLED 0x10
1399 * Flag for process return code: Set if exiting porcess has blocked its
1402 #define RC_FLAG_BLOCKED 0x20
1405 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1408 #define MAX_AF_FILES 10
1411 * The state of a Privoxy processing thread.
1415 /** The proxy's configuration */
1416 struct configuration_spec * config;
1418 /** The actions to perform on the current request */
1419 struct current_action_spec action[1];
1421 /** socket to talk to client (web browser) */
1424 /** socket to talk to server (web server or proxy) */
1427 /** Multi-purpose flag container, see CSP_FLAG_* above */
1430 /** Client PC's IP address, as reported by the accept() function.
1434 /** Client PC's TCP address, as reported by the accept() function.
1436 struct sockaddr_storage tcp_addr;
1438 /** Client PC's IP address, as reported by the accept() function.
1440 unsigned long ip_addr_long;
1441 #endif /* def HAVE_RFC2553 */
1443 /** The URL that was requested */
1444 struct http_request http[1];
1447 * The final forwarding settings.
1448 * XXX: Currently this is only used for forward-override,
1449 * so we can free the space in sweep.
1451 struct forward_spec * fwd;
1453 /** An I/O buffer used for buffering data read from the network */
1456 /** List of all headers for this request */
1457 struct list headers[1];
1459 /** List of all tags that apply to this request */
1460 struct list tags[1];
1462 /** MIME-Type key, see CT_* above */
1463 unsigned int content_type;
1465 /** Actions files associated with this client */
1466 struct file_list *actions_list[MAX_AF_FILES];
1468 /** pcrs job files. */
1469 struct file_list *rlist[MAX_AF_FILES];
1471 /** Length after content modification. */
1472 unsigned long long content_length;
1474 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1475 /** Expected length of content after which we
1476 * should stop reading from the server socket.
1478 /* XXX: is this the right location? */
1479 unsigned long long expected_content_length;
1480 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1482 #ifdef FEATURE_TRUST
1485 struct file_list *tlist;
1487 #endif /* def FEATURE_TRUST */
1490 * Failure reason to embedded in the CGI error page,
1491 * or NULL. Currently only used for socks errors.
1493 char *error_message;
1495 /** Next thread in linked list. Only read or modify from the main thread! */
1496 struct client_state *next;
1501 * A function to add a header
1503 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1506 * A function to process a header
1508 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1512 * List of available CGI functions.
1514 struct cgi_dispatcher
1516 /** The URL of the CGI, relative to the CGI root. */
1517 const char * const name;
1519 /** The handler function for the CGI */
1520 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1522 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1523 const char * const description;
1525 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1531 * A data file used by Privoxy. Kept in a linked list.
1536 * This is a pointer to the data structures associated with the file.
1537 * Read-only once the structure has been created.
1542 * The unloader function.
1543 * Normally NULL. When we are finished with file (i.e. when we have
1544 * loaded a new one), set to a pointer to an unloader function.
1545 * Unloader will be called by sweep() (called from main loop) when
1546 * all clients using this file are done. This prevents threading
1549 void (*unloader)(void *);
1552 * Used internally by sweep(). Do not access from elsewhere.
1557 * File last-modified time, so we can check if file has been changed.
1558 * Read-only once the structure has been created.
1560 time_t lastmodified;
1563 * The full filename.
1568 * Pointer to next entry in the linked list of all "file_list"s.
1569 * This linked list is so that sweep() can navigate it.
1570 * Since sweep() can remove items from the list, we must be careful
1571 * to only access this value from main thread (when we know sweep
1572 * won't be running).
1574 struct file_list *next;
1578 #ifdef FEATURE_TRUST
1581 * The format of a trust file when loaded into memory.
1585 struct url_spec url[1]; /**< The URL pattern */
1586 int reject; /**< FIXME: Please document this! */
1587 struct block_spec *next; /**< Next entry in linked list */
1591 * Arbitrary limit for the number of trusted referrers.
1593 #define MAX_TRUSTED_REFERRERS 512
1595 #endif /* def FEATURE_TRUST */
1598 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1599 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1600 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1601 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1605 * How to forward a connection to a parent proxy.
1609 /** URL pattern that this forward_spec is for. */
1610 struct url_spec url[1];
1612 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1615 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1618 /** SOCKS server port. */
1621 /** Parent HTTP proxy hostname, or NULL for none. */
1624 /** Parent HTTP proxy port. */
1627 /** Next entry in the linked list. */
1628 struct forward_spec *next;
1633 * Initializer for a static struct forward_spec.
1635 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1637 /* Supported filter types */
1638 #define FT_CONTENT_FILTER 0
1639 #define FT_CLIENT_HEADER_FILTER 1
1640 #define FT_SERVER_HEADER_FILTER 2
1641 #define FT_CLIENT_HEADER_TAGGER 3
1642 #define FT_SERVER_HEADER_TAGGER 4
1644 #define MAX_FILTER_TYPES 5
1647 * This struct represents one filter (one block) from
1648 * the re_filterfile. If there is more than one filter
1649 * in the file, the file will be represented by a
1650 * chained list of re_filterfile specs.
1652 struct re_filterfile_spec
1654 char *name; /**< Name from FILTER: statement in re_filterfile. */
1655 char *description; /**< Description from FILTER: statement in re_filterfile. */
1656 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1657 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1658 int type; /**< Filter type (content, client-header, server-header). */
1659 int dynamic; /**< Set to one if the pattern might contain variables
1660 and has to be recompiled for every request. */
1661 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1667 #define ACL_PERMIT 1 /**< Accept connection request */
1668 #define ACL_DENY 2 /**< Reject connection request */
1671 * An IP address pattern. Used to specify networks in the ACL.
1673 struct access_control_addr
1676 struct sockaddr_storage addr; /* <The TCP address in network order. */
1677 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1679 unsigned long addr; /**< The IP address as an integer. */
1680 unsigned long mask; /**< The network mask as an integer. */
1681 unsigned long port; /**< The port number. */
1682 #endif /* HAVE_RFC2553 */
1686 * An access control list (ACL) entry.
1688 * This is a linked list.
1690 struct access_control_list
1692 struct access_control_addr src[1]; /**< Client IP address */
1693 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1695 int wildcard_dst; /** < dst address is wildcard */
1698 short action; /**< ACL_PERMIT or ACL_DENY */
1699 struct access_control_list *next; /**< The next entry in the ACL. */
1702 #endif /* def FEATURE_ACL */
1705 /** Maximum number of loaders (actions, re_filter, ...) */
1709 /** configuration_spec::feature_flags: CGI actions editor. */
1710 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1712 /** configuration_spec::feature_flags: Web-based toggle. */
1713 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1715 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1716 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1718 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1719 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1721 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1722 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1724 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1725 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1727 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1728 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1730 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1731 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1734 * Data loaded from the configuration file.
1736 * (Anomaly: toggle is still handled through a global, not this structure)
1738 struct configuration_spec
1743 /** Nonzero to enable multithreading. */
1747 * Bitmask of features that can be enabled/disabled through the config
1748 * file. Currently defined bits:
1750 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1751 * - RUNTIME_FEATURE_CGI_TOGGLE
1752 * - RUNTIME_FEATURE_HTTP_TOGGLE
1753 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1755 unsigned feature_flags;
1757 /** The log file name. */
1758 const char *logfile;
1760 /** The config file directory. */
1761 const char *confdir;
1763 /** The directory for customized CGI templates. */
1764 const char *templdir;
1766 /** The log file directory. */
1769 /** The full paths to the actions files. */
1770 const char *actions_file[MAX_AF_FILES];
1772 /** The short names of the actions files. */
1773 const char *actions_file_short[MAX_AF_FILES];
1775 /** The administrator's email address */
1776 char *admin_address;
1778 /** A URL with info on this proxy */
1779 char *proxy_info_url;
1781 /** URL to the user manual (on our website or local copy) */
1784 /** The file names of the pcre filter files. */
1785 const char *re_filterfile[MAX_AF_FILES];
1787 /** The short names of the pcre filter files. */
1788 const char *re_filterfile_short[MAX_AF_FILES];
1790 /** The hostname to show on CGI pages, or NULL to use the real one. */
1791 const char *hostname;
1793 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1796 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1799 /** Size limit for IOB */
1800 size_t buffer_limit;
1802 #ifdef FEATURE_TRUST
1804 /** The file name of the trust file. */
1805 const char * trustfile;
1807 /** FIXME: DOCME: Document this. */
1808 struct list trust_info[1];
1810 /** FIXME: DOCME: Document this. */
1811 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1813 #endif /* def FEATURE_TRUST */
1817 /** The access control list (ACL). */
1818 struct access_control_list *acl;
1820 #endif /* def FEATURE_ACL */
1822 /** Information about parent proxies (forwarding). */
1823 struct forward_spec *forward;
1825 /** Number of retries in case a forwarded connection attempt fails */
1826 int forwarded_connect_retries;
1828 /* Timeout when waiting on sockets for data to become available. */
1831 /** All options from the config file, HTML-formatted. */
1834 /** The configuration file object. */
1835 struct file_list *config_file_list;
1837 /** List of loaders */
1838 int (*loaders[NLOADERS])(struct client_state *);
1840 /** Nonzero if we need to bind() to the new port. */
1844 /** Calculates the number of elements in an array, using sizeof. */
1845 #define SZ(X) (sizeof(X) / sizeof(*X))
1847 #ifdef FEATURE_FORCE_LOAD
1848 /** The force load URL prefix. */
1849 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1850 #endif /* def FEATURE_FORCE_LOAD */
1852 #ifdef FEATURE_NO_GIFS
1853 /** The MIME type for images ("image/png" or "image/gif"). */
1854 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1856 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1857 #endif /* def FEATURE_NO_GIFS */
1864 /** URL for the Privoxy home page. */
1865 #define HOME_PAGE_URL "http://www.privoxy.org/"
1867 /** URL for the Privoxy user manual. */
1868 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1870 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1871 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1873 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1874 #define CONFIG_HELP_PREFIX "config.html#"
1877 * The "hosts" to intercept and display CGI pages.
1878 * First one is a hostname only, second one can specify host and path.
1881 * 1) Do not specify the http: prefix
1882 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1883 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1885 #define CGI_SITE_1_HOST "p.p"
1886 #define CGI_SITE_2_HOST "config.privoxy.org"
1887 #define CGI_SITE_2_PATH ""
1890 * The prefix for CGI pages. Written out in generated HTML.
1891 * INCLUDES the trailing slash.
1893 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1899 #endif /* ndef PROJECT_H_INCLUDED */