1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.136 2009/05/13 18:20:54 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.136 2009/05/13 18:20:54 fabiankeil
41 * There's no reason for keep_alive_timeout to be signed.
43 * Revision 1.135 2009/05/10 10:19:23 fabiankeil
44 * Reenable server-side-only keep-alive support, but only share
45 * outgoing connections if the connection-sharing option is set.
47 * Revision 1.134 2009/05/10 10:12:30 fabiankeil
48 * Initial keep-alive support for the client socket.
49 * Temporarily disable the server-side-only keep-alive code.
51 * Revision 1.133 2009/04/24 15:29:43 fabiankeil
52 * Allow to limit the number of of client connections.
54 * Revision 1.132 2009/04/17 11:45:19 fabiankeil
55 * Replace HAVE_GETADDRINFO and HAVE_GETNAMEINFO macros
56 * with HAVE_RFC2553 macro. Original patch by Petr Pisar.
58 * Revision 1.131 2009/04/17 11:34:35 fabiankeil
59 * Style cosmetics for the IPv6 code.
61 * Revision 1.130 2009/04/17 11:27:49 fabiankeil
62 * Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
64 * Revision 1.129 2009/03/08 14:12:51 fabiankeil
65 * All the CSP_FLAG_FOO bit masks should be unsigned ints.
67 * Revision 1.128 2009/03/07 13:09:17 fabiankeil
68 * Change csp->expected_content and_csp->expected_content_length from
69 * size_t to unsigned long long to reduce the likelihood of integer
70 * overflows that would let us close the connection prematurely.
71 * Bug found while investigating #2669131, reported by cyberpatrol.
73 * Revision 1.127 2008/12/20 14:53:55 fabiankeil
74 * Add config option socket-timeout to control the time
75 * Privoxy waits for data to arrive on a socket. Useful
76 * in case of stale ssh tunnels or when fuzz-testing.
78 * Revision 1.126 2008/12/14 17:02:54 fabiankeil
79 * Fix a cparser warning.
81 * Revision 1.125 2008/11/20 08:22:28 fabiankeil
82 * Remove an obsolete comment.
84 * Revision 1.124 2008/11/16 12:43:49 fabiankeil
85 * Turn keep-alive support into a runtime feature
86 * that is disabled by setting keep-alive-timeout
87 * to a negative value.
89 * Revision 1.123 2008/11/10 16:55:59 fabiankeil
90 * Fix a gcc44 warning (in filters.c).
92 * Revision 1.122 2008/10/16 07:11:34 fabiankeil
93 * Fix a bunch of gcc44 conversion warnings.
95 * Revision 1.121 2008/10/09 18:21:41 fabiankeil
96 * Flush work-in-progress changes to keep outgoing connections
97 * alive where possible. Incomplete and mostly #ifdef'd out.
99 * Revision 1.120 2008/09/21 13:36:52 fabiankeil
100 * If change-x-forwarded-for{add} is used and the client
101 * sends multiple X-Forwarded-For headers, append the client's
102 * IP address to each one of them. "Traditionally" we would
103 * lose all but the last one.
105 * Revision 1.119 2008/09/20 10:04:33 fabiankeil
106 * Remove hide-forwarded-for-headers action which has
107 * been obsoleted by change-x-forwarded-for{block}.
109 * Revision 1.118 2008/09/19 15:26:29 fabiankeil
110 * Add change-x-forwarded-for{} action to block or add
111 * X-Forwarded-For headers. Mostly based on code removed
114 * Revision 1.117 2008/08/30 12:03:07 fabiankeil
115 * Remove FEATURE_COOKIE_JAR.
117 * Revision 1.116 2008/05/20 16:05:02 fabiankeil
118 * Move parsers structure definition from project.h to parsers.h.
120 * Revision 1.115 2008/05/19 16:57:20 fabiankeil
121 * Declare all members of the parsers structure immutable.
123 * Revision 1.114 2008/04/11 16:35:39 fabiankeil
124 * Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
126 * Revision 1.113 2008/04/10 14:41:04 fabiankeil
127 * Ditch url_spec's path member now that it's no longer used.
129 * Revision 1.112 2008/04/06 15:18:34 fabiankeil
130 * Oh well, rename the --enable-pcre-host-patterns option to
131 * --enable-extended-host-patterns as it's not really PCRE syntax.
133 * Revision 1.111 2008/04/06 14:54:26 fabiankeil
134 * Use PCRE syntax in host patterns when configured
135 * with --enable-pcre-host-patterns.
137 * Revision 1.110 2008/03/29 12:13:46 fabiankeil
138 * Remove send-wafer and send-vanilla-wafer actions.
140 * Revision 1.109 2008/03/28 15:13:41 fabiankeil
141 * Remove inspect-jpegs action.
143 * Revision 1.108 2008/03/27 18:27:36 fabiankeil
144 * Remove kill-popups action.
146 * Revision 1.107 2008/03/26 18:07:08 fabiankeil
147 * Add hostname directive. Closes PR#1918189.
149 * Revision 1.106 2008/03/24 11:21:03 fabiankeil
150 * Share the action settings for multiple patterns in the same
151 * section so we waste less memory for gigantic block lists
152 * (and load them slightly faster). Reported by Franz Schwartau.
154 * Revision 1.105 2008/03/21 11:16:27 fabiankeil
155 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
157 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
158 * Remove the treat-forbidden-connects-like-blocks action. We now
159 * use the "blocked" page for forbidden CONNECT requests by default.
161 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
162 * Let the block action take the reason for the block
163 * as argument and show it on the "blocked" page.
165 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
166 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
168 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
169 * Remove now-obsolete csp member x_forwarded.
171 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
172 * - Allow port lists in url patterns.
173 * - Ditch unused url_spec member pathlen.
175 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
176 * As Hal noticed, checking dispatch_cgi() as the last cruncher
177 * looks like a bug if CGI requests are blocked unintentionally,
178 * so don't do it unless the user enabled the new config option
179 * "allow-cgi-request-crunching".
181 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
182 * Add new csp->content_type flag (CT_DECLARED).
184 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
185 * - Remove some left-overs from the switch to dedicated header filters.
186 * - Adjust "X-Filter: No" to disable dedicated header filters.
187 * - Prepare for forward-override{}
189 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
190 * Ditch the csp member cookie_list[] which isn't used anymore.
192 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
193 * Introduce dynamic pcrs jobs that can resolve variables.
195 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
196 * Introduce tags as alternative way to specify which
197 * actions apply to a request. At the moment tags can be
198 * created based on client and server headers.
200 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
201 * Use dedicated header filter actions instead of abusing "filter".
202 * Replace "filter-client-headers" and "filter-client-headers"
203 * with "server-header-filter" and "client-header-filter".
205 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
206 * New config option: enforce-blocks.
208 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
209 * Add some CSP_FLAGs for the header parsers.
211 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
212 * Add new http_response member to save
213 * the reason why the response was generated.
215 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
216 * Add new config option "templdir" to
217 * change the templates directory.
219 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
220 * Add csp->error_message for failure reasons
221 * that should be embedded into the CGI pages.
223 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
224 * Integrate a modified version of Wil Mahan's
225 * zlib patch (PR #895531).
227 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
228 * Added config option accept-intercepted-requests
229 * and disabled it by default.
231 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
232 * Fix gcc43 compiler warnings and a comment.
234 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
235 * Add config option "split-large-forms"
236 * to work around the browser bug reported
239 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
240 * Moved HTTP snipplets into jcc.c. They aren't
241 * used anywhere else.
243 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
244 * Doubled size of HOSTENT_BUFFER_SIZE to mask
245 * problems with gethostbyname_r and some
246 * /etc/hosts configurations. Only a workaround
247 * until we get the real fix ready.
248 * Thanks Félix Rauch for reporting.
250 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
252 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
253 * Respond with 400 and a short text message
254 * if the client tries to use Privoxy as FTP proxy.
256 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
257 * Added config option enable-remote-http-toggle
258 * to specify if Privoxy should recognize special
259 * headers (currently only X-Filter) to change its
260 * behaviour. Disabled by default.
262 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
263 * Make number of retries in case of forwarded-connect problems
264 * a config file option (forwarded-connect-retries) and use 0 as
267 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
268 * Work around a buffer overflow that caused Privoxy to
269 * segfault if too many trusted referrers were used. Good
270 * enough for now, but should be replaced with a real
271 * solution after the next release.
273 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
276 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
277 * Split filter-headers{} into filter-client-headers{}
278 * and filter-server-headers{}.
279 * Added parse_header_time() to share some code.
280 * Replaced timegm() with mktime().
282 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
283 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
285 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
286 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
287 * with what was really the latest development (the v_3_0_branch branch)
289 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
290 * Multiple filter file support
292 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
293 * Add the ability to check jpeg images for invalid
294 * lengths of comment blocks. Defensive strategy
295 * against the exploit:
296 * Microsoft Security Bulletin MS04-028
297 * Buffer Overrun in JPEG Processing (GDI+) Could
298 * Allow Code Execution (833987)
299 * Enabled with +inspect-jpegs in actions files.
301 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
302 * Updated the copyright note
304 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
305 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
307 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
308 * Introduced RC_FLAG_* flags for use in child process return code
310 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
311 * Added flag to each cgi_dispatcher that allows or denies
312 * external linking and removed const qualifier from
313 * struct list_entry.str.
315 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
316 * - Include config.h for access to config data
317 * - Include <pcre*.h> depending on where they are
319 * Revision 1.72 2002/05/14 21:35:49 oes
320 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
321 * because of split in user-manual
323 * Revision 1.71 2002/05/12 21:39:36 jongfoster
324 * - Adding Doxygen-style comments to structures and #defines.
326 * Revision 1.70 2002/05/12 16:05:50 jongfoster
327 * Fixing ACTION_MASK_ALL to be unsigned long rather than
328 * just unsigned int. I don't know if anyone is porting
329 * Privoxy to 16-bit platforms, but if so, +limit-connect
330 * wouldn't have worked because of this bug.
332 * Revision 1.69 2002/05/08 16:00:16 oes
333 * Added size member to struct iob, so it can
334 * be alloced larger than needed.
336 * Revision 1.68 2002/04/26 12:56:00 oes
337 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
339 * Revision 1.67 2002/04/24 02:12:43 oes
340 * - Jon's multiple AF patch:
341 * - Make csp->actions_list an array
342 * - #define MAX_AF_FILES
343 * - Moved CGI_PARAM_LEN_MAX (500) here
345 * Revision 1.66 2002/04/15 19:06:43 jongfoster
348 * Revision 1.65 2002/04/04 00:36:36 gliptak
349 * always use pcre for matching
351 * Revision 1.64 2002/04/03 22:28:03 gliptak
352 * Removed references to gnu_regex
354 * Revision 1.63 2002/03/31 17:19:00 jongfoster
355 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
357 * Revision 1.62 2002/03/26 22:48:49 swa
360 * Revision 1.61 2002/03/26 22:29:55 swa
361 * we have a new homepage!
363 * Revision 1.60 2002/03/24 15:52:17 jongfoster
364 * Changing CGI URL prefixes for new name
366 * Revision 1.59 2002/03/24 15:23:33 jongfoster
369 * Revision 1.58 2002/03/24 13:25:43 swa
370 * name change related issues
372 * Revision 1.57 2002/03/16 20:28:34 oes
373 * Added descriptions to the filters so users will know what they select in the cgi editor
375 * Revision 1.56 2002/03/13 20:27:30 oes
376 * Fixing bug with CT_TABOO
378 * Revision 1.55 2002/03/12 01:42:50 oes
379 * Introduced modular filters
381 * Revision 1.54 2002/03/09 20:03:52 jongfoster
382 * - Making various functions return int rather than size_t.
383 * (Undoing a recent change). Since size_t is unsigned on
384 * Windows, functions like read_socket that return -1 on
385 * error cannot return a size_t.
387 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
388 * crashes, and also frequently caused JB to jump to 100%
389 * CPU and stay there. (Because it thought it had just
390 * read ((unsigned)-1) == 4Gb of data...)
392 * - The signature of write_socket has changed, it now simply
393 * returns success=0/failure=nonzero.
395 * - Trying to get rid of a few warnings --with-debug on
396 * Windows, I've introduced a new type "jb_socket". This is
397 * used for the socket file descriptors. On Windows, this
398 * is SOCKET (a typedef for unsigned). Everywhere else, it's
399 * an int. The error value can't be -1 any more, so it's
400 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
401 * Windows it maps to the #define INVALID_SOCKET.)
403 * - The signature of bind_port has changed.
405 * Revision 1.53 2002/03/08 16:48:55 oes
406 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
408 * Revision 1.52 2002/03/07 03:46:17 oes
409 * Fixed compiler warnings
411 * Revision 1.51 2002/03/05 04:52:42 oes
412 * Deleted non-errlog debugging code
414 * Revision 1.50 2002/03/04 19:32:07 oes
415 * Changed default port to 8118
417 * Revision 1.49 2002/03/04 18:28:55 oes
418 * Deleted PID_FILE_NAME
420 * Revision 1.48 2002/03/03 14:50:40 oes
421 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
423 * Revision 1.47 2002/02/20 23:15:13 jongfoster
424 * Parsing functions now handle out-of-memory gracefully by returning
427 * Revision 1.46 2002/01/17 21:06:09 jongfoster
428 * Now #defining the URLs of the config interface
430 * Minor changes to struct http_request and struct url_spec due to
431 * standardizing that struct http_request is used to represent a URL, and
432 * struct url_spec is used to represent a URL pattern. (Before, URLs were
433 * represented as seperate variables and a partially-filled-in url_spec).
435 * Revision 1.45 2002/01/09 14:33:27 oes
436 * Added HOSTENT_BUFFER_SIZE
438 * Revision 1.44 2001/12/30 14:07:32 steudten
439 * - Add signal handling (unix)
440 * - Add SIGHUP handler (unix)
441 * - Add creation of pidfile (unix)
442 * - Add action 'top' in rc file (RH)
443 * - Add entry 'SIGNALS' to manpage
444 * - Add exit message to logfile (unix)
446 * Revision 1.43 2001/11/22 21:57:51 jongfoster
447 * Making action_spec->flags into an unsigned long rather than just an
449 * Adding ACTION_NO_COOKIE_KEEP
451 * Revision 1.42 2001/11/05 21:42:41 steudten
452 * Include DBG() macro.
454 * Revision 1.41 2001/10/28 19:12:06 jongfoster
455 * Adding ijb_toupper()
457 * Revision 1.40 2001/10/26 17:40:47 oes
458 * Moved ijb_isspace and ijb_tolower to project.h
459 * Removed http->user_agent, csp->referrer and csp->accept_types
461 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
462 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
463 * macro when called with a cast; so moving the cast to the macro def'n
464 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
465 * doesn't make macro expansion complain. Hope this works for everyone else
468 * Revision 1.38 2001/10/23 21:19:04 jongfoster
469 * New error-handling support: jb_err type and JB_ERR_xxx constants
470 * CGI functions now return a jb_err, and their parameters map is const.
471 * Support for RUNTIME_FEATUREs to enable/disable config editor
472 * Adding a few comments
474 * Revision 1.37 2001/10/14 22:14:01 jongfoster
475 * Removing name_length field from struct cgi_dispatcher, as this is
476 * now calculated at runtime from the "name" field.
478 * Revision 1.36 2001/10/10 16:45:15 oes
479 * Added LIMIT_CONNECT action and string
480 * Fixed HTTP message line termination
481 * Added CFORBIDDEN HTTP message
483 * Revision 1.35 2001/10/07 18:06:43 oes
484 * Added status member to struct http_request
486 * Revision 1.34 2001/10/07 15:45:25 oes
487 * Added url member to struct http_request and commented all
492 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
494 * Replaced struct client_state members rejected,
495 * force, active and toggled_on with "flags" bitmap.
497 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
499 * Added buffer_limit to struct configuration_spec
501 * Revision 1.33 2001/09/20 13:30:08 steudten
503 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
504 * Last case will set z to NULL in free(z) and thats bad..
506 * Revision 1.32 2001/09/16 23:02:51 jongfoster
509 * Revision 1.31 2001/09/16 13:20:29 jongfoster
510 * Rewrite of list library. Now has seperate header and list_entry
511 * structures. Also added a large sprinking of assert()s to the list
514 * Revision 1.30 2001/09/13 23:52:00 jongfoster
515 * Support for both static and dynamically generated CGI pages
517 * Revision 1.29 2001/09/13 23:29:43 jongfoster
518 * Defining FORWARD_SPEC_INITIALIZER
520 * Revision 1.28 2001/09/13 23:05:50 jongfoster
521 * Changing the string paramater to the header parsers a "const".
523 * Revision 1.27 2001/08/05 16:06:20 jongfoster
524 * Modifiying "struct map" so that there are now separate header and
525 * "map_entry" structures. This means that functions which modify a
526 * map no longer need to return a pointer to the modified map.
527 * Also, it no longer reverses the order of the entries (which may be
528 * important with some advanced template substitutions).
530 * Revision 1.26 2001/07/30 22:08:36 jongfoster
531 * Tidying up #defines:
532 * - All feature #defines are now of the form FEATURE_xxx
533 * - Permanently turned off WIN_GUI_EDIT
534 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
536 * Revision 1.25 2001/07/29 18:43:08 jongfoster
537 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
540 * Revision 1.24 2001/07/25 17:20:27 oes
541 * Introduced http->user_agent
543 * Revision 1.23 2001/07/18 12:32:23 oes
544 * - Added ACTION_STRING_DEANIMATE
545 * - moved #define freez from jcc.h to project.h
547 * Revision 1.22 2001/07/15 17:51:41 jongfoster
548 * Renaming #define STATIC to STATIC_PCRE
550 * Revision 1.21 2001/07/13 14:03:19 oes
551 * - Reorganized regex header inclusion and #defines to
552 * comply to the scheme in configure.in
553 * - Added csp->content_type and its CT_* keys
554 * - Added ACTION_DEANIMATE
555 * - Removed all #ifdef PCRS
557 * Revision 1.20 2001/06/29 21:45:41 oes
558 * Indentation, CRLF->LF, Tab-> Space
560 * Revision 1.19 2001/06/29 13:33:36 oes
561 * - Improved comments
562 * - Introduced http_request.host_ip_addr_str
563 * - Introduced http_response.head_length
564 * - Introduced config.my_ip_addr_str, config.my_hostname,
565 * config.admin_address and config.proxy_info_url
566 * - Removed config.proxy_args_header and config.proxy_args_trailer,
567 * renamed config.proxy_args_invocation to config.proxy_args
568 * - Removed HTML snipplets and GIFs
569 * - Removed logentry from cancelled commit
571 * Revision 1.18 2001/06/09 10:57:39 jongfoster
572 * Adding definition of BUFFER_SIZE.
573 * Changing struct cgi_dispatcher to use "const" strings.
575 * Revision 1.17 2001/06/07 23:15:09 jongfoster
576 * Merging ACL and forward files into config file.
577 * Moving struct gateway members into struct forward_spec
578 * Removing config->proxy_args_gateways
579 * Cosmetic: Adding a few comments
581 * Revision 1.16 2001/06/04 18:31:58 swa
582 * files are now prefixed with either `confdir' or `logdir'.
583 * `make redhat-dist' replaces both entries confdir and logdir
586 * Revision 1.15 2001/06/04 11:28:53 swa
587 * redirect did not work due to missing /
589 * Revision 1.14 2001/06/03 11:03:48 oes
591 * added struct http_response,
592 * changed struct interceptors to struct cgi_dispatcher,
593 * moved HTML stuff to cgi.h
595 * Revision 1.13 2001/06/01 20:05:36 jongfoster
596 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
597 * constant, and removed csp->tinygif.
599 * Revision 1.12 2001/06/01 18:49:17 jongfoster
600 * Replaced "list_share" with "list" - the tiny memory gain was not
601 * worth the extra complexity.
603 * Revision 1.11 2001/06/01 10:32:47 oes
604 * Added constants for anchoring selection bitmap
606 * Revision 1.10 2001/05/31 21:33:53 jongfoster
607 * Changes for new actions file, replacing permissionsfile
608 * and parts of the config file. Also added support for
611 * Revision 1.9 2001/05/31 17:32:31 oes
613 * - Enhanced domain part globbing with infix and prefix asterisk
614 * matching and optional unanchored operation
616 * Revision 1.8 2001/05/29 20:09:15 joergs
617 * HTTP_REDIRECT_TEMPLATE fixed.
619 * Revision 1.7 2001/05/29 09:50:24 jongfoster
620 * Unified blocklist/imagelist/actionslist.
621 * File format is still under discussion, but the internal changes
624 * Also modified interceptor behaviour:
625 * - We now intercept all URLs beginning with one of the following
626 * prefixes (and *only* these prefixes):
628 * * http://ijbswa.sf.net/config/
629 * * http://ijbswa.sourceforge.net/config/
630 * - New interceptors "home page" - go to http://i.j.b/ to see it.
631 * - Internal changes so that intercepted and fast redirect pages
632 * are not replaced with an image.
633 * - Interceptors now have the option to send a binary page direct
634 * to the client. (i.e. ijb-send-banner uses this)
635 * - Implemented show-url-info interceptor. (Which is why I needed
636 * the above interceptors changes - a typical URL is
637 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
638 * The previous mechanism would not have intercepted that, and
639 * if it had been intercepted then it then it would have replaced
642 * Revision 1.6 2001/05/27 22:17:04 oes
644 * - re_process_buffer no longer writes the modified buffer
645 * to the client, which was very ugly. It now returns the
646 * buffer, which it is then written by chat.
648 * - content_length now adjusts the Content-Length: header
649 * for modified documents rather than crunch()ing it.
650 * (Length info in csp->content_length, which is 0 for
651 * unmodified documents)
653 * - For this to work, sed() is called twice when filtering.
655 * Revision 1.5 2001/05/26 00:28:36 jongfoster
656 * Automatic reloading of config file.
657 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
658 * Most of the global variables have been moved to a new
659 * struct configuration_spec, accessed through csp->config->globalname
660 * Most of the globals remaining are used by the Win32 GUI.
662 * Revision 1.4 2001/05/22 18:46:04 oes
664 * - Enabled filtering banners by size rather than URL
665 * by adding patterns that replace all standard banner
666 * sizes with the "Junkbuster" gif to the re_filterfile
668 * - Enabled filtering WebBugs by providing a pattern
669 * which kills all 1x1 images
671 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
672 * which is selected by the (nonstandard and therefore
673 * capital) letter 'U' in the option string.
674 * It causes the quantifiers to be ungreedy by default.
675 * Appending a ? turns back to greedy (!).
677 * - Added a new interceptor ijb-send-banner, which
678 * sends back the "Junkbuster" gif. Without imagelist or
679 * MSIE detection support, or if tinygif = 1, or the
680 * URL isn't recognized as an imageurl, a lame HTML
681 * explanation is sent instead.
683 * - Added new feature, which permits blocking remote
684 * script redirects and firing back a local redirect
686 * The feature is conditionally compiled, i.e. it
687 * can be disabled with --disable-fast-redirects,
688 * plus it must be activated by a "fast-redirects"
689 * line in the config file, has its own log level
690 * and of course wants to be displayed by show-proxy-args
691 * Note: Boy, all the #ifdefs in 1001 locations and
692 * all the fumbling with configure.in and acconfig.h
693 * were *way* more work than the feature itself :-(
695 * - Because a generic redirect template was needed for
696 * this, tinygif = 3 now uses the same.
698 * - Moved GIFs, and other static HTTP response templates
703 * - Removed some >400 CRs again (Jon, you really worked
706 * Revision 1.3 2001/05/20 01:21:20 jongfoster
707 * Version 2.9.4 checkin.
708 * - Merged popupfile and cookiefile, and added control over PCRS
709 * filtering, in new "actionsfile".
710 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
711 * file error you now get a message box (in the Win32 GUI) rather
712 * than the program exiting with no explanation.
713 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
715 * - Removed tabs from "config"
716 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
717 * - Bumped up version number.
719 * Revision 1.2 2001/05/17 23:01:01 oes
720 * - Cleaned CRLF's from the sources and related files
722 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
723 * Initial import of version 2.9.3 source tree
726 *********************************************************************/
729 /* Declare struct FILE for vars and funcs. */
732 /* Need time_t for file_list */
734 /* Needed for pcre choice */
738 /* Need for struct sockaddr_storage */
739 #include <sys/socket.h>
744 * Include appropriate regular expression libraries.
745 * Note that pcrs and pcre (native) are needed for cgi
746 * and are included anyway.
752 # ifdef PCRE_H_IN_SUBDIR
753 # include <pcre/pcre.h>
766 # include "pcreposix.h"
768 # ifdef PCRE_H_IN_SUBDIR
769 # include <pcre/pcreposix.h>
771 # include <pcreposix.h>
777 #endif /* def AMIGA */
781 * I don't want to have to #include all this just for the declaration
782 * of SOCKET. However, it looks like we have to...
797 typedef SOCKET jb_socket;
799 #define JB_INVALID_SOCKET INVALID_SOCKET
801 #else /* ndef _WIN32 */
804 * The type used by sockets. On UNIX it's an int. Microsoft decided to
805 * make it an unsigned.
807 typedef int jb_socket;
810 * The error value used for variables of type jb_socket. On UNIX this
811 * is -1, however Microsoft decided to make socket handles unsigned, so
812 * they use a different value.
815 #define JB_INVALID_SOCKET (-1)
817 #endif /* ndef _WIN32 */
821 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
826 #define JB_ERR_OK 0 /**< Success, no error */
827 #define JB_ERR_MEMORY 1 /**< Out of memory */
828 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
829 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
830 #define JB_ERR_PARSE 4 /**< Error parsing file */
831 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
832 CGI actions editor. */
833 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
836 * This macro is used to free a pointer that may be NULL.
837 * It also sets the variable to NULL after it's been freed.
838 * The paramater should be a simple variable without side effects.
840 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
844 * Fix a problem with Solaris. There should be no effect on other
847 * Solaris's isspace() is a macro which uses it's argument directly
848 * as an array index. Therefore we need to make sure that high-bit
849 * characters generate +ve values, and ideally we also want to make
850 * the argument match the declared parameter type of "int".
852 * Note: Remember to #include <ctype.h> if you use these macros.
854 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
855 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
856 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
859 * Use for statically allocated buffers if you have no other choice.
860 * Remember to check the length of what you write into the buffer
861 * - we don't want any buffer overflows!
863 #define BUFFER_SIZE 5000
866 * Max length of CGI parameters (arbitrary limit).
868 #define CGI_PARAM_LEN_MAX 500U
871 * Buffer size for capturing struct hostent data in the
872 * gethostby(name|addr)_r library calls. Since we don't
873 * loop over gethostbyname_r, the buffer must be sufficient
874 * to accomodate multiple IN A RRs, as used in DNS round robin
875 * load balancing. W3C's wwwlib uses 1K, so that should be
876 * good enough for us, too.
879 * XXX: Temporary doubled, for some configurations
880 * 1K is still too small and we didn't get the
881 * real fix ready for inclusion.
883 #define HOSTENT_BUFFER_SIZE 2048
886 * Do not use. Originally this was so that you can
887 * say "while (FOREVER) { ...do something... }".
888 * However, this gives a warning with some compilers (e.g. VC++).
889 * Instead, use "for (;;) { ...do something... }".
894 * Default TCP/IP address to listen on, as a string.
895 * Set to "127.0.0.1:8118".
897 #define HADDR_DEFAULT "127.0.0.1:8118"
900 /* Forward def for struct client_state */
901 struct configuration_spec;
905 * Entry in a linked list of strings.
910 * The string pointer. It must point to a dynamically malloc()ed
911 * string or be NULL for the list functions to work. In the latter
912 * case, just be careful next time you iterate through the list in
917 /** Next entry in the linked list, or NULL if no more. */
918 struct list_entry *next;
922 * A header for a linked list of strings.
926 /** First entry in the list, or NULL if the list is empty. */
927 struct list_entry *first;
929 /** Last entry in the list, or NULL if the list is empty. */
930 struct list_entry *last;
935 * An entry in a map. This is a name=value pair.
939 /** The key for the map. */
941 /** The value associated with that key. */
943 /** The next map entry, or NULL if none. */
944 struct map_entry *next;
948 * A map from a string to another string.
949 * This is used for the paramaters passed in a HTTP GET request, and
950 * to store the exports when the CGI interface is filling in a template.
954 /** The first map entry, or NULL if the map is empty. */
955 struct map_entry *first;
956 /** The last map entry, or NULL if the map is empty. */
957 struct map_entry *last;
962 * A HTTP request. This includes the method (GET, POST) and
965 * This is also used whenever we want to match a URL against a
966 * URL pattern. This always contains the URL to match, and never
967 * a URL pattern. (See struct url_spec).
971 char *cmd; /**< Whole command line: method, URL, Version */
972 char *ocmd; /**< Backup of original cmd for CLF logging */
973 char *gpc; /**< HTTP method: GET, POST, ... */
974 char *url; /**< The URL */
975 char *ver; /**< Protocol version */
976 int status; /**< HTTP Status */
978 char *host; /**< Host part of URL */
979 int port; /**< Port of URL or 80 (default) */
980 char *path; /**< Path of URL */
981 char *hostport; /**< host[:port] */
982 int ssl; /**< Flag if protocol is https */
984 char *host_ip_addr_str; /**< String with dotted decimal representation
985 of host's IP. NULL before connect_to() */
987 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
988 char **dvec; /**< List of pointers to the strings in dbuffer. */
989 int dcount; /**< How many parts to this domain? (length of dvec) */
993 * Reasons for generating a http_response instead of delivering
994 * the requested resource. Mostly ordered the way they are checked
997 #define RSP_REASON_UNSUPPORTED 1
998 #define RSP_REASON_BLOCKED 2
999 #define RSP_REASON_UNTRUSTED 3
1000 #define RSP_REASON_REDIRECTED 4
1001 #define RSP_REASON_CGI_CALL 5
1002 #define RSP_REASON_NO_SUCH_DOMAIN 6
1003 #define RSP_REASON_FORWARDING_FAILED 7
1004 #define RSP_REASON_CONNECT_FAILED 8
1005 #define RSP_REASON_OUT_OF_MEMORY 9
1006 #define RSP_REASON_INTERNAL_ERROR 10
1009 * Response generated by CGI, blocker, or error handler
1011 struct http_response
1013 char *status; /**< HTTP status (string). */
1014 struct list headers[1]; /**< List of header lines. */
1015 char *head; /**< Formatted http response head. */
1016 size_t head_length; /**< Length of http response head. */
1017 char *body; /**< HTTP document body. */
1018 size_t content_length; /**< Length of body, REQUIRED if binary body. */
1019 int is_static; /**< Nonzero if the content will never change and
1020 should be cached by the browser (e.g. images). */
1021 int reason; /**< Why the response was generated in the first place. */
1025 * A URL or a tag pattern.
1029 /** The string which was parsed to produce this url_spec.
1030 Used for debugging or display only. */
1033 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
1034 regex_t *host_regex;/**< Regex for host matching */
1036 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
1037 char **dvec; /**< List of pointers to the strings in dbuffer. */
1038 int dcount; /**< How many parts to this domain? (length of dvec) */
1039 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
1040 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
1042 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
1044 regex_t *preg; /**< Regex for matching path part */
1045 regex_t *tag_regex; /**< Regex for matching tags */
1049 * If you declare a static url_spec, this is the value to initialize it to zero.
1051 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
1052 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
1054 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
1055 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
1058 * Constant for host part matching in URLs. If set, indicates that the start of
1059 * the pattern must match the start of the URL. E.g. this is not set for the
1060 * pattern ".example.com", so that it will match both "example.com" and
1061 * "www.example.com". It is set for the pattern "example.com", which makes it
1062 * match "example.com" only, not "www.example.com".
1064 #define ANCHOR_LEFT 1
1067 * Constant for host part matching in URLs. If set, indicates that the end of
1068 * the pattern must match the end of the URL. E.g. this is not set for the
1069 * pattern "ad.", so that it will match any host called "ad", irrespective
1070 * of how many subdomains are in the fully-qualified domain name.
1072 #define ANCHOR_RIGHT 2
1076 * An I/O buffer. Holds a string which can be appended to, and can have data
1077 * removed from the beginning.
1081 char *buf; /**< Start of buffer */
1082 char *cur; /**< Start of relevant data */
1083 char *eod; /**< End of relevant data */
1084 size_t size; /**< Size as malloc()ed */
1089 * Return the number of bytes in the I/O buffer associated with the passed
1090 * client_state pointer.
1093 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1097 * Remove any data in the I/O buffer associated with the passed
1098 * client_state pointer.
1100 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1102 /* Bits for csp->content_type bitmask: */
1103 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
1104 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
1105 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
1107 /* Although these are not, strictly speaking, content types
1108 * (they are content encodings), it is simple to handle them
1111 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
1112 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1115 * Flag to signal that the server declared the content type,
1116 * so we can differentiate between unknown and undeclared
1119 #define CT_DECLARED 0x0040U
1122 * The mask which includes all actions.
1124 #define ACTION_MASK_ALL (~0UL)
1127 * The most compatible set of actions - i.e. none.
1129 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1131 /** Action bitmap: Block the request. */
1132 #define ACTION_BLOCK 0x00000001UL
1133 /** Action bitmap: Deanimate if it's a GIF. */
1134 #define ACTION_DEANIMATE 0x00000002UL
1135 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1136 #define ACTION_DOWNGRADE 0x00000004UL
1137 /** Action bitmap: Fast redirects. */
1138 #define ACTION_FAST_REDIRECTS 0x00000008UL
1139 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
1140 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
1141 /** Action bitmap: Hide "From" header. */
1142 #define ACTION_HIDE_FROM 0x00000020UL
1143 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1144 #define ACTION_HIDE_REFERER 0x00000040UL
1145 /** Action bitmap: Hide "User-Agent" and similar headers. */
1146 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1147 /** Action bitmap: This is an image. */
1148 #define ACTION_IMAGE 0x00000100UL
1149 /** Action bitmap: Sets the image blocker. */
1150 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1151 /** Action bitmap: Prevent compression. */
1152 #define ACTION_NO_COMPRESSION 0x00000400UL
1153 /** Action bitmap: Change cookies to session only cookies. */
1154 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1155 /** Action bitmap: Block rending cookies. */
1156 #define ACTION_NO_COOKIE_READ 0x00001000UL
1157 /** Action bitmap: Block setting cookies. */
1158 #define ACTION_NO_COOKIE_SET 0x00002000UL
1159 /** Action bitmap: Override the forward settings in the config file */
1160 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
1161 /** Action bitmap: Block as empty document */
1162 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
1163 /** Action bitmap: Limit CONNECT requests to safe ports. */
1164 #define ACTION_LIMIT_CONNECT 0x00010000UL
1165 /** Action bitmap: Redirect request. */
1166 #define ACTION_REDIRECT 0x00020000UL
1167 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1168 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1169 /** Action bitmap: Overwrite Content-Type header. */
1170 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1171 /** Action bitmap: Crunch specified server header. */
1172 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1173 /** Action bitmap: Crunch specified client header */
1174 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1175 /** Action bitmap: Enable text mode by force */
1176 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1177 /** Action bitmap: Enable text mode by force */
1178 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1179 /** Action bitmap: Enable content-dispostion crunching */
1180 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1181 /** Action bitmap: Replace or block Last-Modified header */
1182 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1183 /** Action bitmap: Replace or block Accept-Language header */
1184 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1187 /** Action string index: How to deanimate GIFs */
1188 #define ACTION_STRING_DEANIMATE 0
1189 /** Action string index: Replacement for "From:" header */
1190 #define ACTION_STRING_FROM 1
1191 /** Action string index: How to block images */
1192 #define ACTION_STRING_IMAGE_BLOCKER 2
1193 /** Action string index: Replacement for "Referer:" header */
1194 #define ACTION_STRING_REFERER 3
1195 /** Action string index: Replacement for "User-Agent:" header */
1196 #define ACTION_STRING_USER_AGENT 4
1197 /** Action string index: Legal CONNECT ports. */
1198 #define ACTION_STRING_LIMIT_CONNECT 5
1199 /** Action string index: Server headers containing this pattern are crunched*/
1200 #define ACTION_STRING_SERVER_HEADER 6
1201 /** Action string index: Client headers containing this pattern are crunched*/
1202 #define ACTION_STRING_CLIENT_HEADER 7
1203 /** Action string index: Replacement for the "Accept-Language:" header*/
1204 #define ACTION_STRING_LANGUAGE 8
1205 /** Action string index: Replacement for the "Content-Type:" header*/
1206 #define ACTION_STRING_CONTENT_TYPE 9
1207 /** Action string index: Replacement for the "content-dispostion:" header*/
1208 #define ACTION_STRING_CONTENT_DISPOSITION 10
1209 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1210 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1211 /** Action string index: Replacement for the "Last-Modified:" header. */
1212 #define ACTION_STRING_LAST_MODIFIED 12
1213 /** Action string index: Redirect URL */
1214 #define ACTION_STRING_REDIRECT 13
1215 /** Action string index: Decode before redirect? */
1216 #define ACTION_STRING_FAST_REDIRECTS 14
1217 /** Action string index: Overriding forward rule. */
1218 #define ACTION_STRING_FORWARD_OVERRIDE 15
1219 /** Action string index: Reason for the block. */
1220 #define ACTION_STRING_BLOCK 16
1221 /** Action string index: what to do with the "X-Forwarded-For" header. */
1222 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
1223 /** Number of string actions. */
1224 #define ACTION_STRING_COUNT 18
1227 /* To make the ugly hack in sed easier to understand */
1228 #define CHECK_EVERY_HEADER_REMAINING 0
1231 /** Index into current_action_spec::multi[] for headers to add. */
1232 #define ACTION_MULTI_ADD_HEADER 0
1233 /** Index into current_action_spec::multi[] for content filters to apply. */
1234 #define ACTION_MULTI_FILTER 1
1235 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1236 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
1237 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1238 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
1239 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1240 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
1241 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1242 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
1243 /** Number of multi-string actions. */
1244 #define ACTION_MULTI_COUNT 6
1248 * This structure contains a list of actions to apply to a URL.
1249 * It only contains positive instructions - no "-" options.
1250 * It is not used to store the actions list itself, only for
1251 * url_actions() to return the current values.
1253 struct current_action_spec
1255 /** Actions to apply. A bit set to "1" means perform the action. */
1256 unsigned long flags;
1259 * Paramaters for those actions that require them.
1260 * Each entry is valid if & only if the corresponding entry in "flags" is
1263 char * string[ACTION_STRING_COUNT];
1265 /** Lists of strings for multi-string actions. */
1266 struct list multi[ACTION_MULTI_COUNT][1];
1271 * This structure contains a set of changes to actions.
1272 * It can contain both positive and negative instructions.
1273 * It is used to store an entry in the actions list.
1277 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1278 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1281 * Paramaters for those actions that require them.
1282 * Each entry is valid if & only if the corresponding entry in "flags" is
1285 char * string[ACTION_STRING_COUNT];
1287 /** Lists of strings to remove, for multi-string actions. */
1288 struct list multi_remove[ACTION_MULTI_COUNT][1];
1290 /** If nonzero, remove *all* strings from the multi-string action. */
1291 int multi_remove_all[ACTION_MULTI_COUNT];
1293 /** Lists of strings to add, for multi-string actions. */
1294 struct list multi_add[ACTION_MULTI_COUNT][1];
1299 * This structure is used to store action files.
1301 * It contains an URL or tag pattern, and the changes to
1302 * the actions. It's a linked list and should only be
1303 * free'd through unload_actions_file() unless there's
1304 * only a single entry.
1308 struct url_spec url[1]; /**< The URL or tag pattern. */
1310 struct action_spec *action; /**< Action settings that might be shared with
1311 the list entry before or after the current
1312 one and can't be free'd willy nilly. */
1314 struct url_actions *next; /**< Next action section in file, or NULL. */
1319 * Structure to make sure we only reuse the server socket
1320 * if the host and forwarding settings are the same.
1322 struct reusable_connection
1328 * Number of seconds after which this
1329 * connection will no longer be reused.
1331 unsigned int keep_alive_timeout;
1344 * Flags for use in csp->flags
1348 * Flag for csp->flags: Set if this client is processing data.
1349 * Cleared when the thread associated with this structure dies.
1351 #define CSP_FLAG_ACTIVE 0x01U
1354 * Flag for csp->flags: Set if the server's reply is in "chunked"
1357 #define CSP_FLAG_CHUNKED 0x02U
1360 * Flag for csp->flags: Set if this request was enforced, although it would
1361 * normally have been blocked.
1363 #define CSP_FLAG_FORCED 0x04U
1366 * Flag for csp->flags: Set if any modification to the body was done.
1368 #define CSP_FLAG_MODIFIED 0x08U
1371 * Flag for csp->flags: Set if request was blocked.
1373 #define CSP_FLAG_REJECTED 0x10U
1376 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1378 #define CSP_FLAG_TOGGLED_ON 0x20U
1381 * Flag for csp->flags: Set if an acceptable Connection header
1382 * has already been set by the client.
1384 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
1387 * Flag for csp->flags: Set if an acceptable Connection header
1388 * has already been set by the server.
1390 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
1393 * Flag for csp->flags: Signals header parsers whether they
1394 * are parsing server or client headers.
1396 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
1399 * Flag for csp->flags: Set if adding the Host: header
1402 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
1405 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1406 * XXX: As we now have tags we might as well ditch this.
1408 #define CSP_FLAG_NO_FILTERING 0x00000400U
1411 * Flag for csp->flags: Set the client IP has appended to
1412 * an already existing X-Forwarded-For header in which case
1413 * no new header has to be generated.
1415 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
1418 * Flag for csp->flags: Set if the server wants to keep
1419 * the connection alive.
1421 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
1423 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1425 * Flag for csp->flags: Set if the server specified the
1428 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00002000U
1431 * Flag for csp->flags: Set if the client wants to keep
1432 * the connection alive.
1434 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00004000U
1435 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1438 * Flags for use in return codes of child processes
1442 * Flag for process return code: Set if exiting porcess has been toggled
1443 * during its lifetime.
1445 #define RC_FLAG_TOGGLED 0x10
1448 * Flag for process return code: Set if exiting porcess has blocked its
1451 #define RC_FLAG_BLOCKED 0x20
1454 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1457 #define MAX_AF_FILES 10
1460 * The state of a Privoxy processing thread.
1464 /** The proxy's configuration */
1465 struct configuration_spec * config;
1467 /** The actions to perform on the current request */
1468 struct current_action_spec action[1];
1470 /** socket to talk to client (web browser) */
1473 /** socket to talk to server (web server or proxy) */
1476 /** current connection to the server (may go through a proxy) */
1477 struct reusable_connection server_connection;
1479 /** Multi-purpose flag container, see CSP_FLAG_* above */
1482 /** Client PC's IP address, as reported by the accept() function.
1486 /** Client PC's TCP address, as reported by the accept() function.
1488 struct sockaddr_storage tcp_addr;
1490 /** Client PC's IP address, as reported by the accept() function.
1492 unsigned long ip_addr_long;
1493 #endif /* def HAVE_RFC2553 */
1495 /** The URL that was requested */
1496 struct http_request http[1];
1499 * The final forwarding settings.
1500 * XXX: Currently this is only used for forward-override,
1501 * so we can free the space in sweep.
1503 struct forward_spec * fwd;
1505 /** An I/O buffer used for buffering data read from the network */
1508 /** List of all headers for this request */
1509 struct list headers[1];
1511 /** List of all tags that apply to this request */
1512 struct list tags[1];
1514 /** MIME-Type key, see CT_* above */
1515 unsigned int content_type;
1517 /** Actions files associated with this client */
1518 struct file_list *actions_list[MAX_AF_FILES];
1520 /** pcrs job files. */
1521 struct file_list *rlist[MAX_AF_FILES];
1523 /** Length after content modification. */
1524 unsigned long long content_length;
1526 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1527 /** Expected length of content after which we
1528 * should stop reading from the server socket.
1530 /* XXX: is this the right location? */
1531 unsigned long long expected_content_length;
1532 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1534 #ifdef FEATURE_TRUST
1537 struct file_list *tlist;
1539 #endif /* def FEATURE_TRUST */
1542 * Failure reason to embedded in the CGI error page,
1543 * or NULL. Currently only used for socks errors.
1545 char *error_message;
1547 /** Next thread in linked list. Only read or modify from the main thread! */
1548 struct client_state *next;
1553 * A function to add a header
1555 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1558 * A function to process a header
1560 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1564 * List of available CGI functions.
1566 struct cgi_dispatcher
1568 /** The URL of the CGI, relative to the CGI root. */
1569 const char * const name;
1571 /** The handler function for the CGI */
1572 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1574 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1575 const char * const description;
1577 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1583 * A data file used by Privoxy. Kept in a linked list.
1588 * This is a pointer to the data structures associated with the file.
1589 * Read-only once the structure has been created.
1594 * The unloader function.
1595 * Normally NULL. When we are finished with file (i.e. when we have
1596 * loaded a new one), set to a pointer to an unloader function.
1597 * Unloader will be called by sweep() (called from main loop) when
1598 * all clients using this file are done. This prevents threading
1601 void (*unloader)(void *);
1604 * Used internally by sweep(). Do not access from elsewhere.
1609 * File last-modified time, so we can check if file has been changed.
1610 * Read-only once the structure has been created.
1612 time_t lastmodified;
1615 * The full filename.
1620 * Pointer to next entry in the linked list of all "file_list"s.
1621 * This linked list is so that sweep() can navigate it.
1622 * Since sweep() can remove items from the list, we must be careful
1623 * to only access this value from main thread (when we know sweep
1624 * won't be running).
1626 struct file_list *next;
1630 #ifdef FEATURE_TRUST
1633 * The format of a trust file when loaded into memory.
1637 struct url_spec url[1]; /**< The URL pattern */
1638 int reject; /**< FIXME: Please document this! */
1639 struct block_spec *next; /**< Next entry in linked list */
1643 * Arbitrary limit for the number of trusted referrers.
1645 #define MAX_TRUSTED_REFERRERS 512
1647 #endif /* def FEATURE_TRUST */
1650 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1651 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1652 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1653 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1657 * How to forward a connection to a parent proxy.
1661 /** URL pattern that this forward_spec is for. */
1662 struct url_spec url[1];
1664 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1667 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1670 /** SOCKS server port. */
1673 /** Parent HTTP proxy hostname, or NULL for none. */
1676 /** Parent HTTP proxy port. */
1679 /** Next entry in the linked list. */
1680 struct forward_spec *next;
1685 * Initializer for a static struct forward_spec.
1687 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1689 /* Supported filter types */
1690 #define FT_CONTENT_FILTER 0
1691 #define FT_CLIENT_HEADER_FILTER 1
1692 #define FT_SERVER_HEADER_FILTER 2
1693 #define FT_CLIENT_HEADER_TAGGER 3
1694 #define FT_SERVER_HEADER_TAGGER 4
1696 #define MAX_FILTER_TYPES 5
1699 * This struct represents one filter (one block) from
1700 * the re_filterfile. If there is more than one filter
1701 * in the file, the file will be represented by a
1702 * chained list of re_filterfile specs.
1704 struct re_filterfile_spec
1706 char *name; /**< Name from FILTER: statement in re_filterfile. */
1707 char *description; /**< Description from FILTER: statement in re_filterfile. */
1708 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1709 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1710 int type; /**< Filter type (content, client-header, server-header). */
1711 int dynamic; /**< Set to one if the pattern might contain variables
1712 and has to be recompiled for every request. */
1713 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1719 #define ACL_PERMIT 1 /**< Accept connection request */
1720 #define ACL_DENY 2 /**< Reject connection request */
1723 * An IP address pattern. Used to specify networks in the ACL.
1725 struct access_control_addr
1728 struct sockaddr_storage addr; /* <The TCP address in network order. */
1729 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1731 unsigned long addr; /**< The IP address as an integer. */
1732 unsigned long mask; /**< The network mask as an integer. */
1733 unsigned long port; /**< The port number. */
1734 #endif /* HAVE_RFC2553 */
1738 * An access control list (ACL) entry.
1740 * This is a linked list.
1742 struct access_control_list
1744 struct access_control_addr src[1]; /**< Client IP address */
1745 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1747 int wildcard_dst; /** < dst address is wildcard */
1750 short action; /**< ACL_PERMIT or ACL_DENY */
1751 struct access_control_list *next; /**< The next entry in the ACL. */
1754 #endif /* def FEATURE_ACL */
1757 /** Maximum number of loaders (actions, re_filter, ...) */
1761 /** configuration_spec::feature_flags: CGI actions editor. */
1762 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1764 /** configuration_spec::feature_flags: Web-based toggle. */
1765 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1767 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1768 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1770 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1771 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1773 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1774 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1776 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1777 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1779 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1780 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1782 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1783 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1785 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1786 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1789 * Data loaded from the configuration file.
1791 * (Anomaly: toggle is still handled through a global, not this structure)
1793 struct configuration_spec
1798 /** Nonzero to enable multithreading. */
1802 * Bitmask of features that can be enabled/disabled through the config
1803 * file. Currently defined bits:
1805 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1806 * - RUNTIME_FEATURE_CGI_TOGGLE
1807 * - RUNTIME_FEATURE_HTTP_TOGGLE
1808 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1810 unsigned feature_flags;
1812 /** The log file name. */
1813 const char *logfile;
1815 /** The config file directory. */
1816 const char *confdir;
1818 /** The directory for customized CGI templates. */
1819 const char *templdir;
1821 /** The log file directory. */
1824 /** The full paths to the actions files. */
1825 const char *actions_file[MAX_AF_FILES];
1827 /** The short names of the actions files. */
1828 const char *actions_file_short[MAX_AF_FILES];
1830 /** The administrator's email address */
1831 char *admin_address;
1833 /** A URL with info on this proxy */
1834 char *proxy_info_url;
1836 /** URL to the user manual (on our website or local copy) */
1839 /** The file names of the pcre filter files. */
1840 const char *re_filterfile[MAX_AF_FILES];
1842 /** The short names of the pcre filter files. */
1843 const char *re_filterfile_short[MAX_AF_FILES];
1845 /** The hostname to show on CGI pages, or NULL to use the real one. */
1846 const char *hostname;
1848 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1851 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1854 /** Size limit for IOB */
1855 size_t buffer_limit;
1857 #ifdef FEATURE_TRUST
1859 /** The file name of the trust file. */
1860 const char * trustfile;
1862 /** FIXME: DOCME: Document this. */
1863 struct list trust_info[1];
1865 /** FIXME: DOCME: Document this. */
1866 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1868 #endif /* def FEATURE_TRUST */
1872 /** The access control list (ACL). */
1873 struct access_control_list *acl;
1875 #endif /* def FEATURE_ACL */
1877 /** Information about parent proxies (forwarding). */
1878 struct forward_spec *forward;
1880 /** Number of retries in case a forwarded connection attempt fails */
1881 int forwarded_connect_retries;
1883 /** Maximum number of client connections. */
1884 int max_client_connections;
1886 /* Timeout when waiting on sockets for data to become available. */
1889 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1890 /* Maximum number of seconds after which an open connection will no longer be reused. */
1891 unsigned int keep_alive_timeout;
1894 /** All options from the config file, HTML-formatted. */
1897 /** The configuration file object. */
1898 struct file_list *config_file_list;
1900 /** List of loaders */
1901 int (*loaders[NLOADERS])(struct client_state *);
1903 /** Nonzero if we need to bind() to the new port. */
1907 /** Calculates the number of elements in an array, using sizeof. */
1908 #define SZ(X) (sizeof(X) / sizeof(*X))
1910 #ifdef FEATURE_FORCE_LOAD
1911 /** The force load URL prefix. */
1912 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1913 #endif /* def FEATURE_FORCE_LOAD */
1915 #ifdef FEATURE_NO_GIFS
1916 /** The MIME type for images ("image/png" or "image/gif"). */
1917 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1919 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1920 #endif /* def FEATURE_NO_GIFS */
1927 /** URL for the Privoxy home page. */
1928 #define HOME_PAGE_URL "http://www.privoxy.org/"
1930 /** URL for the Privoxy user manual. */
1931 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1933 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1934 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1936 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1937 #define CONFIG_HELP_PREFIX "config.html#"
1940 * The "hosts" to intercept and display CGI pages.
1941 * First one is a hostname only, second one can specify host and path.
1944 * 1) Do not specify the http: prefix
1945 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1946 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1948 #define CGI_SITE_1_HOST "p.p"
1949 #define CGI_SITE_2_HOST "config.privoxy.org"
1950 #define CGI_SITE_2_PATH ""
1953 * The prefix for CGI pages. Written out in generated HTML.
1954 * INCLUDES the trailing slash.
1956 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1962 #endif /* ndef PROJECT_H_INCLUDED */