1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.113 2008/04/10 14:41:04 fabiankeil Exp $"
5 /*********************************************************************
7 * File : $Source: /cvsroot/ijbswa/current/project.h,v $
9 * Purpose : Defines data structures which are widely used in the
10 * project. Does not define any variables or functions
11 * (though it does declare some macros).
13 * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge
14 * Privoxy team. http://www.privoxy.org/
16 * Based on the Internet Junkbuster originally written
17 * by and Copyright (C) 1997 Anonymous Coders and
18 * Junkbusters Corporation. http://www.junkbusters.com
20 * This program is free software; you can redistribute it
21 * and/or modify it under the terms of the GNU General
22 * Public License as published by the Free Software
23 * Foundation; either version 2 of the License, or (at
24 * your option) any later version.
26 * This program is distributed in the hope that it will
27 * be useful, but WITHOUT ANY WARRANTY; without even the
28 * implied warranty of MERCHANTABILITY or FITNESS FOR A
29 * PARTICULAR PURPOSE. See the GNU General Public
30 * License for more details.
32 * The GNU General Public License should be included with
33 * this file. If not, you can view it at
34 * http://www.gnu.org/copyleft/gpl.html
35 * or write to the Free Software Foundation, Inc., 59
36 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
40 * Revision 1.113 2008/04/10 14:41:04 fabiankeil
41 * Ditch url_spec's path member now that it's no longer used.
43 * Revision 1.112 2008/04/06 15:18:34 fabiankeil
44 * Oh well, rename the --enable-pcre-host-patterns option to
45 * --enable-extended-host-patterns as it's not really PCRE syntax.
47 * Revision 1.111 2008/04/06 14:54:26 fabiankeil
48 * Use PCRE syntax in host patterns when configured
49 * with --enable-pcre-host-patterns.
51 * Revision 1.110 2008/03/29 12:13:46 fabiankeil
52 * Remove send-wafer and send-vanilla-wafer actions.
54 * Revision 1.109 2008/03/28 15:13:41 fabiankeil
55 * Remove inspect-jpegs action.
57 * Revision 1.108 2008/03/27 18:27:36 fabiankeil
58 * Remove kill-popups action.
60 * Revision 1.107 2008/03/26 18:07:08 fabiankeil
61 * Add hostname directive. Closes PR#1918189.
63 * Revision 1.106 2008/03/24 11:21:03 fabiankeil
64 * Share the action settings for multiple patterns in the same
65 * section so we waste less memory for gigantic block lists
66 * (and load them slightly faster). Reported by Franz Schwartau.
68 * Revision 1.105 2008/03/21 11:16:27 fabiankeil
69 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
71 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
72 * Remove the treat-forbidden-connects-like-blocks action. We now
73 * use the "blocked" page for forbidden CONNECT requests by default.
75 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
76 * Let the block action take the reason for the block
77 * as argument and show it on the "blocked" page.
79 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
80 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
82 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
83 * Remove now-obsolete csp member x_forwarded.
85 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
86 * - Allow port lists in url patterns.
87 * - Ditch unused url_spec member pathlen.
89 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
90 * As Hal noticed, checking dispatch_cgi() as the last cruncher
91 * looks like a bug if CGI requests are blocked unintentionally,
92 * so don't do it unless the user enabled the new config option
93 * "allow-cgi-request-crunching".
95 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
96 * Add new csp->content_type flag (CT_DECLARED).
98 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
99 * - Remove some left-overs from the switch to dedicated header filters.
100 * - Adjust "X-Filter: No" to disable dedicated header filters.
101 * - Prepare for forward-override{}
103 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
104 * Ditch the csp member cookie_list[] which isn't used anymore.
106 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
107 * Introduce dynamic pcrs jobs that can resolve variables.
109 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
110 * Introduce tags as alternative way to specify which
111 * actions apply to a request. At the moment tags can be
112 * created based on client and server headers.
114 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
115 * Use dedicated header filter actions instead of abusing "filter".
116 * Replace "filter-client-headers" and "filter-client-headers"
117 * with "server-header-filter" and "client-header-filter".
119 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
120 * New config option: enforce-blocks.
122 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
123 * Add some CSP_FLAGs for the header parsers.
125 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
126 * Add new http_response member to save
127 * the reason why the response was generated.
129 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
130 * Add new config option "templdir" to
131 * change the templates directory.
133 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
134 * Add csp->error_message for failure reasons
135 * that should be embedded into the CGI pages.
137 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
138 * Integrate a modified version of Wil Mahan's
139 * zlib patch (PR #895531).
141 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
142 * Added config option accept-intercepted-requests
143 * and disabled it by default.
145 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
146 * Fix gcc43 compiler warnings and a comment.
148 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
149 * Add config option "split-large-forms"
150 * to work around the browser bug reported
153 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
154 * Moved HTTP snipplets into jcc.c. They aren't
155 * used anywhere else.
157 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
158 * Doubled size of HOSTENT_BUFFER_SIZE to mask
159 * problems with gethostbyname_r and some
160 * /etc/hosts configurations. Only a workaround
161 * until we get the real fix ready.
162 * Thanks FĂ©lix Rauch for reporting.
164 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
166 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
167 * Respond with 400 and a short text message
168 * if the client tries to use Privoxy as FTP proxy.
170 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
171 * Added config option enable-remote-http-toggle
172 * to specify if Privoxy should recognize special
173 * headers (currently only X-Filter) to change its
174 * behaviour. Disabled by default.
176 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
177 * Make number of retries in case of forwarded-connect problems
178 * a config file option (forwarded-connect-retries) and use 0 as
181 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
182 * Work around a buffer overflow that caused Privoxy to
183 * segfault if too many trusted referrers were used. Good
184 * enough for now, but should be replaced with a real
185 * solution after the next release.
187 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
190 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
191 * Split filter-headers{} into filter-client-headers{}
192 * and filter-server-headers{}.
193 * Added parse_header_time() to share some code.
194 * Replaced timegm() with mktime().
196 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
197 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
199 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
200 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
201 * with what was really the latest development (the v_3_0_branch branch)
203 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
204 * Multiple filter file support
206 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
207 * Add the ability to check jpeg images for invalid
208 * lengths of comment blocks. Defensive strategy
209 * against the exploit:
210 * Microsoft Security Bulletin MS04-028
211 * Buffer Overrun in JPEG Processing (GDI+) Could
212 * Allow Code Execution (833987)
213 * Enabled with +inspect-jpegs in actions files.
215 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
216 * Updated the copyright note
218 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
219 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
221 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
222 * Introduced RC_FLAG_* flags for use in child process return code
224 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
225 * Added flag to each cgi_dispatcher that allows or denies
226 * external linking and removed const qualifier from
227 * struct list_entry.str.
229 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
230 * - Include config.h for access to config data
231 * - Include <pcre*.h> depending on where they are
233 * Revision 1.72 2002/05/14 21:35:49 oes
234 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
235 * because of split in user-manual
237 * Revision 1.71 2002/05/12 21:39:36 jongfoster
238 * - Adding Doxygen-style comments to structures and #defines.
240 * Revision 1.70 2002/05/12 16:05:50 jongfoster
241 * Fixing ACTION_MASK_ALL to be unsigned long rather than
242 * just unsigned int. I don't know if anyone is porting
243 * Privoxy to 16-bit platforms, but if so, +limit-connect
244 * wouldn't have worked because of this bug.
246 * Revision 1.69 2002/05/08 16:00:16 oes
247 * Added size member to struct iob, so it can
248 * be alloced larger than needed.
250 * Revision 1.68 2002/04/26 12:56:00 oes
251 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
253 * Revision 1.67 2002/04/24 02:12:43 oes
254 * - Jon's multiple AF patch:
255 * - Make csp->actions_list an array
256 * - #define MAX_AF_FILES
257 * - Moved CGI_PARAM_LEN_MAX (500) here
259 * Revision 1.66 2002/04/15 19:06:43 jongfoster
262 * Revision 1.65 2002/04/04 00:36:36 gliptak
263 * always use pcre for matching
265 * Revision 1.64 2002/04/03 22:28:03 gliptak
266 * Removed references to gnu_regex
268 * Revision 1.63 2002/03/31 17:19:00 jongfoster
269 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
271 * Revision 1.62 2002/03/26 22:48:49 swa
274 * Revision 1.61 2002/03/26 22:29:55 swa
275 * we have a new homepage!
277 * Revision 1.60 2002/03/24 15:52:17 jongfoster
278 * Changing CGI URL prefixes for new name
280 * Revision 1.59 2002/03/24 15:23:33 jongfoster
283 * Revision 1.58 2002/03/24 13:25:43 swa
284 * name change related issues
286 * Revision 1.57 2002/03/16 20:28:34 oes
287 * Added descriptions to the filters so users will know what they select in the cgi editor
289 * Revision 1.56 2002/03/13 20:27:30 oes
290 * Fixing bug with CT_TABOO
292 * Revision 1.55 2002/03/12 01:42:50 oes
293 * Introduced modular filters
295 * Revision 1.54 2002/03/09 20:03:52 jongfoster
296 * - Making various functions return int rather than size_t.
297 * (Undoing a recent change). Since size_t is unsigned on
298 * Windows, functions like read_socket that return -1 on
299 * error cannot return a size_t.
301 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
302 * crashes, and also frequently caused JB to jump to 100%
303 * CPU and stay there. (Because it thought it had just
304 * read ((unsigned)-1) == 4Gb of data...)
306 * - The signature of write_socket has changed, it now simply
307 * returns success=0/failure=nonzero.
309 * - Trying to get rid of a few warnings --with-debug on
310 * Windows, I've introduced a new type "jb_socket". This is
311 * used for the socket file descriptors. On Windows, this
312 * is SOCKET (a typedef for unsigned). Everywhere else, it's
313 * an int. The error value can't be -1 any more, so it's
314 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
315 * Windows it maps to the #define INVALID_SOCKET.)
317 * - The signature of bind_port has changed.
319 * Revision 1.53 2002/03/08 16:48:55 oes
320 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
322 * Revision 1.52 2002/03/07 03:46:17 oes
323 * Fixed compiler warnings
325 * Revision 1.51 2002/03/05 04:52:42 oes
326 * Deleted non-errlog debugging code
328 * Revision 1.50 2002/03/04 19:32:07 oes
329 * Changed default port to 8118
331 * Revision 1.49 2002/03/04 18:28:55 oes
332 * Deleted PID_FILE_NAME
334 * Revision 1.48 2002/03/03 14:50:40 oes
335 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
337 * Revision 1.47 2002/02/20 23:15:13 jongfoster
338 * Parsing functions now handle out-of-memory gracefully by returning
341 * Revision 1.46 2002/01/17 21:06:09 jongfoster
342 * Now #defining the URLs of the config interface
344 * Minor changes to struct http_request and struct url_spec due to
345 * standardizing that struct http_request is used to represent a URL, and
346 * struct url_spec is used to represent a URL pattern. (Before, URLs were
347 * represented as seperate variables and a partially-filled-in url_spec).
349 * Revision 1.45 2002/01/09 14:33:27 oes
350 * Added HOSTENT_BUFFER_SIZE
352 * Revision 1.44 2001/12/30 14:07:32 steudten
353 * - Add signal handling (unix)
354 * - Add SIGHUP handler (unix)
355 * - Add creation of pidfile (unix)
356 * - Add action 'top' in rc file (RH)
357 * - Add entry 'SIGNALS' to manpage
358 * - Add exit message to logfile (unix)
360 * Revision 1.43 2001/11/22 21:57:51 jongfoster
361 * Making action_spec->flags into an unsigned long rather than just an
363 * Adding ACTION_NO_COOKIE_KEEP
365 * Revision 1.42 2001/11/05 21:42:41 steudten
366 * Include DBG() macro.
368 * Revision 1.41 2001/10/28 19:12:06 jongfoster
369 * Adding ijb_toupper()
371 * Revision 1.40 2001/10/26 17:40:47 oes
372 * Moved ijb_isspace and ijb_tolower to project.h
373 * Removed http->user_agent, csp->referrer and csp->accept_types
375 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
376 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
377 * macro when called with a cast; so moving the cast to the macro def'n
378 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
379 * doesn't make macro expansion complain. Hope this works for everyone else
382 * Revision 1.38 2001/10/23 21:19:04 jongfoster
383 * New error-handling support: jb_err type and JB_ERR_xxx constants
384 * CGI functions now return a jb_err, and their parameters map is const.
385 * Support for RUNTIME_FEATUREs to enable/disable config editor
386 * Adding a few comments
388 * Revision 1.37 2001/10/14 22:14:01 jongfoster
389 * Removing name_length field from struct cgi_dispatcher, as this is
390 * now calculated at runtime from the "name" field.
392 * Revision 1.36 2001/10/10 16:45:15 oes
393 * Added LIMIT_CONNECT action and string
394 * Fixed HTTP message line termination
395 * Added CFORBIDDEN HTTP message
397 * Revision 1.35 2001/10/07 18:06:43 oes
398 * Added status member to struct http_request
400 * Revision 1.34 2001/10/07 15:45:25 oes
401 * Added url member to struct http_request and commented all
406 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
408 * Replaced struct client_state members rejected,
409 * force, active and toggled_on with "flags" bitmap.
411 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
413 * Added buffer_limit to struct configuration_spec
415 * Revision 1.33 2001/09/20 13:30:08 steudten
417 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
418 * Last case will set z to NULL in free(z) and thats bad..
420 * Revision 1.32 2001/09/16 23:02:51 jongfoster
423 * Revision 1.31 2001/09/16 13:20:29 jongfoster
424 * Rewrite of list library. Now has seperate header and list_entry
425 * structures. Also added a large sprinking of assert()s to the list
428 * Revision 1.30 2001/09/13 23:52:00 jongfoster
429 * Support for both static and dynamically generated CGI pages
431 * Revision 1.29 2001/09/13 23:29:43 jongfoster
432 * Defining FORWARD_SPEC_INITIALIZER
434 * Revision 1.28 2001/09/13 23:05:50 jongfoster
435 * Changing the string paramater to the header parsers a "const".
437 * Revision 1.27 2001/08/05 16:06:20 jongfoster
438 * Modifiying "struct map" so that there are now separate header and
439 * "map_entry" structures. This means that functions which modify a
440 * map no longer need to return a pointer to the modified map.
441 * Also, it no longer reverses the order of the entries (which may be
442 * important with some advanced template substitutions).
444 * Revision 1.26 2001/07/30 22:08:36 jongfoster
445 * Tidying up #defines:
446 * - All feature #defines are now of the form FEATURE_xxx
447 * - Permanently turned off WIN_GUI_EDIT
448 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
450 * Revision 1.25 2001/07/29 18:43:08 jongfoster
451 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
454 * Revision 1.24 2001/07/25 17:20:27 oes
455 * Introduced http->user_agent
457 * Revision 1.23 2001/07/18 12:32:23 oes
458 * - Added ACTION_STRING_DEANIMATE
459 * - moved #define freez from jcc.h to project.h
461 * Revision 1.22 2001/07/15 17:51:41 jongfoster
462 * Renaming #define STATIC to STATIC_PCRE
464 * Revision 1.21 2001/07/13 14:03:19 oes
465 * - Reorganized regex header inclusion and #defines to
466 * comply to the scheme in configure.in
467 * - Added csp->content_type and its CT_* keys
468 * - Added ACTION_DEANIMATE
469 * - Removed all #ifdef PCRS
471 * Revision 1.20 2001/06/29 21:45:41 oes
472 * Indentation, CRLF->LF, Tab-> Space
474 * Revision 1.19 2001/06/29 13:33:36 oes
475 * - Improved comments
476 * - Introduced http_request.host_ip_addr_str
477 * - Introduced http_response.head_length
478 * - Introduced config.my_ip_addr_str, config.my_hostname,
479 * config.admin_address and config.proxy_info_url
480 * - Removed config.proxy_args_header and config.proxy_args_trailer,
481 * renamed config.proxy_args_invocation to config.proxy_args
482 * - Removed HTML snipplets and GIFs
483 * - Removed logentry from cancelled commit
485 * Revision 1.18 2001/06/09 10:57:39 jongfoster
486 * Adding definition of BUFFER_SIZE.
487 * Changing struct cgi_dispatcher to use "const" strings.
489 * Revision 1.17 2001/06/07 23:15:09 jongfoster
490 * Merging ACL and forward files into config file.
491 * Moving struct gateway members into struct forward_spec
492 * Removing config->proxy_args_gateways
493 * Cosmetic: Adding a few comments
495 * Revision 1.16 2001/06/04 18:31:58 swa
496 * files are now prefixed with either `confdir' or `logdir'.
497 * `make redhat-dist' replaces both entries confdir and logdir
500 * Revision 1.15 2001/06/04 11:28:53 swa
501 * redirect did not work due to missing /
503 * Revision 1.14 2001/06/03 11:03:48 oes
505 * added struct http_response,
506 * changed struct interceptors to struct cgi_dispatcher,
507 * moved HTML stuff to cgi.h
509 * Revision 1.13 2001/06/01 20:05:36 jongfoster
510 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
511 * constant, and removed csp->tinygif.
513 * Revision 1.12 2001/06/01 18:49:17 jongfoster
514 * Replaced "list_share" with "list" - the tiny memory gain was not
515 * worth the extra complexity.
517 * Revision 1.11 2001/06/01 10:32:47 oes
518 * Added constants for anchoring selection bitmap
520 * Revision 1.10 2001/05/31 21:33:53 jongfoster
521 * Changes for new actions file, replacing permissionsfile
522 * and parts of the config file. Also added support for
525 * Revision 1.9 2001/05/31 17:32:31 oes
527 * - Enhanced domain part globbing with infix and prefix asterisk
528 * matching and optional unanchored operation
530 * Revision 1.8 2001/05/29 20:09:15 joergs
531 * HTTP_REDIRECT_TEMPLATE fixed.
533 * Revision 1.7 2001/05/29 09:50:24 jongfoster
534 * Unified blocklist/imagelist/actionslist.
535 * File format is still under discussion, but the internal changes
538 * Also modified interceptor behaviour:
539 * - We now intercept all URLs beginning with one of the following
540 * prefixes (and *only* these prefixes):
542 * * http://ijbswa.sf.net/config/
543 * * http://ijbswa.sourceforge.net/config/
544 * - New interceptors "home page" - go to http://i.j.b/ to see it.
545 * - Internal changes so that intercepted and fast redirect pages
546 * are not replaced with an image.
547 * - Interceptors now have the option to send a binary page direct
548 * to the client. (i.e. ijb-send-banner uses this)
549 * - Implemented show-url-info interceptor. (Which is why I needed
550 * the above interceptors changes - a typical URL is
551 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
552 * The previous mechanism would not have intercepted that, and
553 * if it had been intercepted then it then it would have replaced
556 * Revision 1.6 2001/05/27 22:17:04 oes
558 * - re_process_buffer no longer writes the modified buffer
559 * to the client, which was very ugly. It now returns the
560 * buffer, which it is then written by chat.
562 * - content_length now adjusts the Content-Length: header
563 * for modified documents rather than crunch()ing it.
564 * (Length info in csp->content_length, which is 0 for
565 * unmodified documents)
567 * - For this to work, sed() is called twice when filtering.
569 * Revision 1.5 2001/05/26 00:28:36 jongfoster
570 * Automatic reloading of config file.
571 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
572 * Most of the global variables have been moved to a new
573 * struct configuration_spec, accessed through csp->config->globalname
574 * Most of the globals remaining are used by the Win32 GUI.
576 * Revision 1.4 2001/05/22 18:46:04 oes
578 * - Enabled filtering banners by size rather than URL
579 * by adding patterns that replace all standard banner
580 * sizes with the "Junkbuster" gif to the re_filterfile
582 * - Enabled filtering WebBugs by providing a pattern
583 * which kills all 1x1 images
585 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
586 * which is selected by the (nonstandard and therefore
587 * capital) letter 'U' in the option string.
588 * It causes the quantifiers to be ungreedy by default.
589 * Appending a ? turns back to greedy (!).
591 * - Added a new interceptor ijb-send-banner, which
592 * sends back the "Junkbuster" gif. Without imagelist or
593 * MSIE detection support, or if tinygif = 1, or the
594 * URL isn't recognized as an imageurl, a lame HTML
595 * explanation is sent instead.
597 * - Added new feature, which permits blocking remote
598 * script redirects and firing back a local redirect
600 * The feature is conditionally compiled, i.e. it
601 * can be disabled with --disable-fast-redirects,
602 * plus it must be activated by a "fast-redirects"
603 * line in the config file, has its own log level
604 * and of course wants to be displayed by show-proxy-args
605 * Note: Boy, all the #ifdefs in 1001 locations and
606 * all the fumbling with configure.in and acconfig.h
607 * were *way* more work than the feature itself :-(
609 * - Because a generic redirect template was needed for
610 * this, tinygif = 3 now uses the same.
612 * - Moved GIFs, and other static HTTP response templates
617 * - Removed some >400 CRs again (Jon, you really worked
620 * Revision 1.3 2001/05/20 01:21:20 jongfoster
621 * Version 2.9.4 checkin.
622 * - Merged popupfile and cookiefile, and added control over PCRS
623 * filtering, in new "actionsfile".
624 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
625 * file error you now get a message box (in the Win32 GUI) rather
626 * than the program exiting with no explanation.
627 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
629 * - Removed tabs from "config"
630 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
631 * - Bumped up version number.
633 * Revision 1.2 2001/05/17 23:01:01 oes
634 * - Cleaned CRLF's from the sources and related files
636 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
637 * Initial import of version 2.9.3 source tree
640 *********************************************************************/
643 /* Declare struct FILE for vars and funcs. */
646 /* Need time_t for file_list */
648 /* Needed for pcre choice */
652 * Include appropriate regular expression libraries.
653 * Note that pcrs and pcre (native) are needed for cgi
654 * and are included anyway.
660 # ifdef PCRE_H_IN_SUBDIR
661 # include <pcre/pcre.h>
674 # include "pcreposix.h"
676 # ifdef PCRE_H_IN_SUBDIR
677 # include <pcre/pcreposix.h>
679 # include <pcreposix.h>
685 #endif /* def AMIGA */
689 * I don't want to have to #include all this just for the declaration
690 * of SOCKET. However, it looks like we have to...
705 typedef SOCKET jb_socket;
707 #define JB_INVALID_SOCKET INVALID_SOCKET
709 #else /* ndef _WIN32 */
712 * The type used by sockets. On UNIX it's an int. Microsoft decided to
713 * make it an unsigned.
715 typedef int jb_socket;
718 * The error value used for variables of type jb_socket. On UNIX this
719 * is -1, however Microsoft decided to make socket handles unsigned, so
720 * they use a different value.
723 #define JB_INVALID_SOCKET (-1)
725 #endif /* ndef _WIN32 */
729 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
734 #define JB_ERR_OK 0 /**< Success, no error */
735 #define JB_ERR_MEMORY 1 /**< Out of memory */
736 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
737 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
738 #define JB_ERR_PARSE 4 /**< Error parsing file */
739 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
740 CGI actions editor. */
741 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
744 * This macro is used to free a pointer that may be NULL.
745 * It also sets the variable to NULL after it's been freed.
746 * The paramater should be a simple variable without side effects.
748 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
752 * Fix a problem with Solaris. There should be no effect on other
755 * Solaris's isspace() is a macro which uses it's argument directly
756 * as an array index. Therefore we need to make sure that high-bit
757 * characters generate +ve values, and ideally we also want to make
758 * the argument match the declared parameter type of "int".
760 * Note: Remember to #include <ctype.h> if you use these macros.
762 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
763 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
764 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
767 * Use for statically allocated buffers if you have no other choice.
768 * Remember to check the length of what you write into the buffer
769 * - we don't want any buffer overflows!
771 #define BUFFER_SIZE 5000
774 * Max length of CGI parameters (arbitrary limit).
776 #define CGI_PARAM_LEN_MAX 500
779 * Buffer size for capturing struct hostent data in the
780 * gethostby(name|addr)_r library calls. Since we don't
781 * loop over gethostbyname_r, the buffer must be sufficient
782 * to accomodate multiple IN A RRs, as used in DNS round robin
783 * load balancing. W3C's wwwlib uses 1K, so that should be
784 * good enough for us, too.
787 * XXX: Temporary doubled, for some configurations
788 * 1K is still too small and we didn't get the
789 * real fix ready for inclusion.
791 #define HOSTENT_BUFFER_SIZE 2048
794 * Do not use. Originally this was so that you can
795 * say "while (FOREVER) { ...do something... }".
796 * However, this gives a warning with some compilers (e.g. VC++).
797 * Instead, use "for (;;) { ...do something... }".
802 * Default IP address to listen on, as a string.
803 * Set to "127.0.0.1".
805 #define HADDR_DEFAULT "127.0.0.1"
808 * Default port to listen on, as a number.
811 #define HADDR_PORT 8118
814 /* Forward def for struct client_state */
815 struct configuration_spec;
819 * Entry in a linked list of strings.
824 * The string pointer. It must point to a dynamically malloc()ed
825 * string or be NULL for the list functions to work. In the latter
826 * case, just be careful next time you iterate through the list in
831 /** Next entry in the linked list, or NULL if no more. */
832 struct list_entry *next;
836 * A header for a linked list of strings.
840 /** First entry in the list, or NULL if the list is empty. */
841 struct list_entry *first;
843 /** Last entry in the list, or NULL if the list is empty. */
844 struct list_entry *last;
849 * An entry in a map. This is a name=value pair.
853 /** The key for the map. */
855 /** The value associated with that key. */
857 /** The next map entry, or NULL if none. */
858 struct map_entry *next;
862 * A map from a string to another string.
863 * This is used for the paramaters passed in a HTTP GET request, and
864 * to store the exports when the CGI interface is filling in a template.
868 /** The first map entry, or NULL if the map is empty. */
869 struct map_entry *first;
870 /** The last map entry, or NULL if the map is empty. */
871 struct map_entry *last;
876 * A HTTP request. This includes the method (GET, POST) and
879 * This is also used whenever we want to match a URL against a
880 * URL pattern. This always contains the URL to match, and never
881 * a URL pattern. (See struct url_spec).
885 char *cmd; /**< Whole command line: method, URL, Version */
886 char *ocmd; /**< Backup of original cmd for CLF logging */
887 char *gpc; /**< HTTP method: GET, POST, ... */
888 char *url; /**< The URL */
889 char *ver; /**< Protocol version */
890 int status; /**< HTTP Status */
892 char *host; /**< Host part of URL */
893 int port; /**< Port of URL or 80 (default) */
894 char *path; /**< Path of URL */
895 char *hostport; /**< host[:port] */
896 int ssl; /**< Flag if protocol is https */
898 char *host_ip_addr_str; /**< String with dotted decimal representation
899 of host's IP. NULL before connect_to() */
901 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
902 char **dvec; /**< List of pointers to the strings in dbuffer. */
903 int dcount; /**< How many parts to this domain? (length of dvec) */
907 * Reasons for generating a http_response instead of delivering
908 * the requested resource. Mostly ordered the way they are checked
911 #define RSP_REASON_UNSUPPORTED 1
912 #define RSP_REASON_BLOCKED 2
913 #define RSP_REASON_UNTRUSTED 3
914 #define RSP_REASON_REDIRECTED 4
915 #define RSP_REASON_CGI_CALL 5
916 #define RSP_REASON_NO_SUCH_DOMAIN 6
917 #define RSP_REASON_FORWARDING_FAILED 7
918 #define RSP_REASON_CONNECT_FAILED 8
919 #define RSP_REASON_OUT_OF_MEMORY 9
920 #define RSP_REASON_INTERNAL_ERROR 10
923 * Response generated by CGI, blocker, or error handler
927 char *status; /**< HTTP status (string). */
928 struct list headers[1]; /**< List of header lines. */
929 char *head; /**< Formatted http response head. */
930 size_t head_length; /**< Length of http response head. */
931 char *body; /**< HTTP document body. */
932 size_t content_length; /**< Length of body, REQUIRED if binary body. */
933 int is_static; /**< Nonzero if the content will never change and
934 should be cached by the browser (e.g. images). */
935 int reason; /**< Why the response was generated in the first place. */
939 * A URL or a tag pattern.
943 /** The string which was parsed to produce this url_spec.
944 Used for debugging or display only. */
947 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
948 regex_t *host_regex;/**< Regex for host matching */
950 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
951 char **dvec; /**< List of pointers to the strings in dbuffer. */
952 int dcount; /**< How many parts to this domain? (length of dvec) */
953 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
954 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
956 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
958 regex_t *preg; /**< Regex for matching path part */
959 regex_t *tag_regex; /**< Regex for matching tags */
963 * If you declare a static url_spec, this is the value to initialize it to zero.
965 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
966 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
968 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
969 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
972 * Constant for host part matching in URLs. If set, indicates that the start of
973 * the pattern must match the start of the URL. E.g. this is not set for the
974 * pattern ".example.com", so that it will match both "example.com" and
975 * "www.example.com". It is set for the pattern "example.com", which makes it
976 * match "example.com" only, not "www.example.com".
978 #define ANCHOR_LEFT 1
981 * Constant for host part matching in URLs. If set, indicates that the end of
982 * the pattern must match the end of the URL. E.g. this is not set for the
983 * pattern "ad.", so that it will match any host called "ad", irrespective
984 * of how many subdomains are in the fully-qualified domain name.
986 #define ANCHOR_RIGHT 2
990 * An I/O buffer. Holds a string which can be appended to, and can have data
991 * removed from the beginning.
995 char *buf; /**< Start of buffer */
996 char *cur; /**< Start of relevant data */
997 char *eod; /**< End of relevant data */
998 size_t size; /**< Size as malloc()ed */
1003 * Return the number of bytes in the I/O buffer associated with the passed
1004 * client_state pointer.
1007 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1011 * Remove any data in the I/O buffer associated with the passed
1012 * client_state pointer.
1014 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1016 /* Bits for csp->content_type bitmask: */
1017 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
1018 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
1019 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
1021 /* Although these are not, strictly speaking, content types
1022 * (they are content encodings), it is simple to handle them
1025 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
1026 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1029 * Flag to signal that the server declared the content type,
1030 * so we can differentiate between unknown and undeclared
1033 #define CT_DECLARED 0x0040U
1036 * The mask which includes all actions.
1038 #define ACTION_MASK_ALL (~0UL)
1041 * The most compatible set of actions - i.e. none.
1043 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1045 /** Action bitmap: Block the request. */
1046 #define ACTION_BLOCK 0x00000001UL
1047 /** Action bitmap: Deanimate if it's a GIF. */
1048 #define ACTION_DEANIMATE 0x00000002UL
1049 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1050 #define ACTION_DOWNGRADE 0x00000004UL
1051 /** Action bitmap: Fast redirects. */
1052 #define ACTION_FAST_REDIRECTS 0x00000008UL
1053 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
1054 #define ACTION_HIDE_FORWARDED 0x00000010UL
1055 /** Action bitmap: Hide "From" header. */
1056 #define ACTION_HIDE_FROM 0x00000020UL
1057 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1058 #define ACTION_HIDE_REFERER 0x00000040UL
1059 /** Action bitmap: Hide "User-Agent" and similar headers. */
1060 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1061 /** Action bitmap: This is an image. */
1062 #define ACTION_IMAGE 0x00000100UL
1063 /** Action bitmap: Sets the image blocker. */
1064 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1065 /** Action bitmap: Prevent compression. */
1066 #define ACTION_NO_COMPRESSION 0x00000400UL
1067 /** Action bitmap: Change cookies to session only cookies. */
1068 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1069 /** Action bitmap: Block rending cookies. */
1070 #define ACTION_NO_COOKIE_READ 0x00001000UL
1071 /** Action bitmap: Block setting cookies. */
1072 #define ACTION_NO_COOKIE_SET 0x00002000UL
1073 /** Action bitmap: Override the forward settings in the config file */
1074 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
1075 /** Action bitmap: Block as empty document */
1076 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
1077 /** Action bitmap: Limit CONNECT requests to safe ports. */
1078 #define ACTION_LIMIT_CONNECT 0x00010000UL
1079 /** Action bitmap: Redirect request. */
1080 #define ACTION_REDIRECT 0x00020000UL
1081 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1082 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1083 /** Action bitmap: Overwrite Content-Type header. */
1084 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1085 /** Action bitmap: Crunch specified server header. */
1086 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1087 /** Action bitmap: Crunch specified client header */
1088 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1089 /** Action bitmap: Enable text mode by force */
1090 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1091 /** Action bitmap: Enable text mode by force */
1092 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1093 /** Action bitmap: Enable content-dispostion crunching */
1094 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1095 /** Action bitmap: Replace or block Last-Modified header */
1096 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1097 /** Action bitmap: Replace or block Accept-Language header */
1098 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1101 /** Action string index: How to deanimate GIFs */
1102 #define ACTION_STRING_DEANIMATE 0
1103 /** Action string index: Replacement for "From:" header */
1104 #define ACTION_STRING_FROM 1
1105 /** Action string index: How to block images */
1106 #define ACTION_STRING_IMAGE_BLOCKER 2
1107 /** Action string index: Replacement for "Referer:" header */
1108 #define ACTION_STRING_REFERER 3
1109 /** Action string index: Replacement for "User-Agent:" header */
1110 #define ACTION_STRING_USER_AGENT 4
1111 /** Action string index: Legal CONNECT ports. */
1112 #define ACTION_STRING_LIMIT_CONNECT 5
1113 /** Action string index: Server headers containing this pattern are crunched*/
1114 #define ACTION_STRING_SERVER_HEADER 6
1115 /** Action string index: Client headers containing this pattern are crunched*/
1116 #define ACTION_STRING_CLIENT_HEADER 7
1117 /** Action string index: Replacement for the "Accept-Language:" header*/
1118 #define ACTION_STRING_LANGUAGE 8
1119 /** Action string index: Replacement for the "Content-Type:" header*/
1120 #define ACTION_STRING_CONTENT_TYPE 9
1121 /** Action string index: Replacement for the "content-dispostion:" header*/
1122 #define ACTION_STRING_CONTENT_DISPOSITION 10
1123 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1124 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1125 /** Action string index: Replacement for the "Last-Modified:" header. */
1126 #define ACTION_STRING_LAST_MODIFIED 12
1127 /** Action string index: Redirect URL */
1128 #define ACTION_STRING_REDIRECT 13
1129 /** Action string index: Decode before redirect? */
1130 #define ACTION_STRING_FAST_REDIRECTS 14
1131 /** Action string index: Overriding forward rule. */
1132 #define ACTION_STRING_FORWARD_OVERRIDE 15
1133 /** Action string index: Reason for the block. */
1134 #define ACTION_STRING_BLOCK 16
1135 /** Number of string actions. */
1136 #define ACTION_STRING_COUNT 17
1139 /* To make the ugly hack in sed easier to understand */
1140 #define CHECK_EVERY_HEADER_REMAINING 0
1143 /** Index into current_action_spec::multi[] for headers to add. */
1144 #define ACTION_MULTI_ADD_HEADER 0
1145 /** Index into current_action_spec::multi[] for content filters to apply. */
1146 #define ACTION_MULTI_FILTER 1
1147 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1148 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
1149 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1150 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
1151 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1152 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
1153 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1154 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
1155 /** Number of multi-string actions. */
1156 #define ACTION_MULTI_COUNT 6
1160 * This structure contains a list of actions to apply to a URL.
1161 * It only contains positive instructions - no "-" options.
1162 * It is not used to store the actions list itself, only for
1163 * url_actions() to return the current values.
1165 struct current_action_spec
1167 /** Actions to apply. A bit set to "1" means perform the action. */
1168 unsigned long flags;
1171 * Paramaters for those actions that require them.
1172 * Each entry is valid if & only if the corresponding entry in "flags" is
1175 char * string[ACTION_STRING_COUNT];
1177 /** Lists of strings for multi-string actions. */
1178 struct list multi[ACTION_MULTI_COUNT][1];
1183 * This structure contains a set of changes to actions.
1184 * It can contain both positive and negative instructions.
1185 * It is used to store an entry in the actions list.
1189 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1190 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1193 * Paramaters for those actions that require them.
1194 * Each entry is valid if & only if the corresponding entry in "flags" is
1197 char * string[ACTION_STRING_COUNT];
1199 /** Lists of strings to remove, for multi-string actions. */
1200 struct list multi_remove[ACTION_MULTI_COUNT][1];
1202 /** If nonzero, remove *all* strings from the multi-string action. */
1203 int multi_remove_all[ACTION_MULTI_COUNT];
1205 /** Lists of strings to add, for multi-string actions. */
1206 struct list multi_add[ACTION_MULTI_COUNT][1];
1211 * This structure is used to store action files.
1213 * It contains an URL or tag pattern, and the changes to
1214 * the actions. It's a linked list and should only be
1215 * free'd through unload_actions_file() unless there's
1216 * only a single entry.
1220 struct url_spec url[1]; /**< The URL or tag pattern. */
1222 struct action_spec *action; /**< Action settings that might be shared with
1223 the list entry before or after the current
1224 one and can't be free'd willy nilly. */
1226 struct url_actions *next; /**< Next action section in file, or NULL. */
1231 * Flags for use in csp->flags
1235 * Flag for csp->flags: Set if this client is processing data.
1236 * Cleared when the thread associated with this structure dies.
1238 #define CSP_FLAG_ACTIVE 0x01
1241 * Flag for csp->flags: Set if the server's reply is in "chunked"
1244 #define CSP_FLAG_CHUNKED 0x02
1247 * Flag for csp->flags: Set if this request was enforced, although it would
1248 * normally have been blocked.
1250 #define CSP_FLAG_FORCED 0x04
1253 * Flag for csp->flags: Set if any modification to the body was done.
1255 #define CSP_FLAG_MODIFIED 0x08
1258 * Flag for csp->flags: Set if request was blocked.
1260 #define CSP_FLAG_REJECTED 0x10
1263 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1265 #define CSP_FLAG_TOGGLED_ON 0x20
1268 * Flag for csp->flags: Set if adding the 'Connection: close' header
1269 * for the client isn't necessary.
1271 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
1274 * Flag for csp->flags: Set if adding the 'Connection: close' header
1275 * for the server isn't necessary.
1277 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1280 * Flag for csp->flags: Signals header parsers whether they
1281 * are parsing server or client headers.
1283 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1286 * Flag for csp->flags: Set if adding the Host: header
1289 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1292 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1293 * XXX: As we now have tags we might as well ditch this.
1295 #define CSP_FLAG_NO_FILTERING 0x00000400UL
1299 * Flags for use in return codes of child processes
1303 * Flag for process return code: Set if exiting porcess has been toggled
1304 * during its lifetime.
1306 #define RC_FLAG_TOGGLED 0x10
1309 * Flag for process return code: Set if exiting porcess has blocked its
1312 #define RC_FLAG_BLOCKED 0x20
1315 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1318 #define MAX_AF_FILES 10
1321 * The state of a Privoxy processing thread.
1325 /** The proxy's configuration */
1326 struct configuration_spec * config;
1328 /** The actions to perform on the current request */
1329 struct current_action_spec action[1];
1331 /** socket to talk to client (web browser) */
1334 /** socket to talk to server (web server or proxy) */
1337 /** Multi-purpose flag container, see CSP_FLAG_* above */
1340 /** Client PC's IP address, as reported by the accept() function.
1343 /** Client PC's IP address, as reported by the accept() function.
1347 /** The URL that was requested */
1348 struct http_request http[1];
1351 * The final forwarding settings.
1352 * XXX: Currently this is only used for forward-override,
1353 * so we can free the space in sweep.
1355 struct forward_spec * fwd;
1357 /** An I/O buffer used for buffering data read from the network */
1360 /** List of all headers for this request */
1361 struct list headers[1];
1363 /** List of all tags that apply to this request */
1364 struct list tags[1];
1366 /** MIME-Type key, see CT_* above */
1367 unsigned int content_type;
1369 /** Actions files associated with this client */
1370 struct file_list *actions_list[MAX_AF_FILES];
1372 /** pcrs job files. */
1373 struct file_list *rlist[MAX_AF_FILES];
1375 /** Length after content modification. */
1376 size_t content_length;
1378 #ifdef FEATURE_TRUST
1381 struct file_list *tlist;
1383 #endif /* def FEATURE_TRUST */
1386 * Failure reason to embedded in the CGI error page,
1387 * or NULL. Currently only used for socks errors.
1389 char *error_message;
1391 /** Next thread in linked list. Only read or modify from the main thread! */
1392 struct client_state *next;
1397 * A function to add a header
1399 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1402 * A function to process a header
1404 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1408 * List of functions to run on a list of headers
1412 /** The header prefix to match */
1415 /** The length of the prefix to match */
1418 /** The function to apply to this line */
1419 parser_func_ptr parser;
1424 * List of available CGI functions.
1426 struct cgi_dispatcher
1428 /** The URL of the CGI, relative to the CGI root. */
1429 const char * const name;
1431 /** The handler function for the CGI */
1432 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1434 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1435 const char * const description;
1437 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1443 * A data file used by Privoxy. Kept in a linked list.
1448 * This is a pointer to the data structures associated with the file.
1449 * Read-only once the structure has been created.
1454 * The unloader function.
1455 * Normally NULL. When we are finished with file (i.e. when we have
1456 * loaded a new one), set to a pointer to an unloader function.
1457 * Unloader will be called by sweep() (called from main loop) when
1458 * all clients using this file are done. This prevents threading
1461 void (*unloader)(void *);
1464 * Used internally by sweep(). Do not access from elsewhere.
1469 * File last-modified time, so we can check if file has been changed.
1470 * Read-only once the structure has been created.
1472 time_t lastmodified;
1475 * The full filename.
1480 * Pointer to next entry in the linked list of all "file_list"s.
1481 * This linked list is so that sweep() can navigate it.
1482 * Since sweep() can remove items from the list, we must be careful
1483 * to only access this value from main thread (when we know sweep
1484 * won't be running).
1486 struct file_list *next;
1490 #ifdef FEATURE_TRUST
1493 * The format of a trust file when loaded into memory.
1497 struct url_spec url[1]; /**< The URL pattern */
1498 int reject; /**< FIXME: Please document this! */
1499 struct block_spec *next; /**< Next entry in linked list */
1503 * Arbitrary limit for the number of trusted referrers.
1505 #define MAX_TRUSTED_REFERRERS 512
1507 #endif /* def FEATURE_TRUST */
1510 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1511 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1512 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1513 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1517 * How to forward a connection to a parent proxy.
1521 /** URL pattern that this forward_spec is for. */
1522 struct url_spec url[1];
1524 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1527 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1530 /** SOCKS server port. */
1533 /** Parent HTTP proxy hostname, or NULL for none. */
1536 /** Parent HTTP proxy port. */
1539 /** Next entry in the linked list. */
1540 struct forward_spec *next;
1545 * Initializer for a static struct forward_spec.
1547 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1549 /* Supported filter types */
1550 #define FT_CONTENT_FILTER 0
1551 #define FT_CLIENT_HEADER_FILTER 1
1552 #define FT_SERVER_HEADER_FILTER 2
1553 #define FT_CLIENT_HEADER_TAGGER 3
1554 #define FT_SERVER_HEADER_TAGGER 4
1556 #define MAX_FILTER_TYPES 5
1559 * This struct represents one filter (one block) from
1560 * the re_filterfile. If there is more than one filter
1561 * in the file, the file will be represented by a
1562 * chained list of re_filterfile specs.
1564 struct re_filterfile_spec
1566 char *name; /**< Name from FILTER: statement in re_filterfile. */
1567 char *description; /**< Description from FILTER: statement in re_filterfile. */
1568 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1569 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1570 int type; /**< Filter type (content, client-header, server-header). */
1571 int dynamic; /**< Set to one if the pattern might contain variables
1572 and has to be recompiled for every request. */
1573 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1579 #define ACL_PERMIT 1 /**< Accept connection request */
1580 #define ACL_DENY 2 /**< Reject connection request */
1583 * An IP address pattern. Used to specify networks in the ACL.
1585 struct access_control_addr
1587 unsigned long addr; /**< The IP address as an integer. */
1588 unsigned long mask; /**< The network mask as an integer. */
1589 unsigned long port; /**< The port number. */
1593 * An access control list (ACL) entry.
1595 * This is a linked list.
1597 struct access_control_list
1599 struct access_control_addr src[1]; /**< Client IP address */
1600 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1602 short action; /**< ACL_PERMIT or ACL_DENY */
1603 struct access_control_list *next; /**< The next entry in the ACL. */
1606 #endif /* def FEATURE_ACL */
1609 /** Maximum number of loaders (actions, re_filter, ...) */
1613 /** configuration_spec::feature_flags: CGI actions editor. */
1614 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1616 /** configuration_spec::feature_flags: Web-based toggle. */
1617 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1619 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1620 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1622 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1623 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1625 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1626 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1628 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1629 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32
1631 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1632 #define RUNTIME_FEATURE_CGI_CRUNCHING 64
1636 * Data loaded from the configuration file.
1638 * (Anomaly: toggle is still handled through a global, not this structure)
1640 struct configuration_spec
1645 /** Nonzero to enable multithreading. */
1649 * Bitmask of features that can be enabled/disabled through the config
1650 * file. Currently defined bits:
1652 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1653 * - RUNTIME_FEATURE_CGI_TOGGLE
1654 * - RUNTIME_FEATURE_HTTP_TOGGLE
1655 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1657 unsigned feature_flags;
1659 /** The log file name. */
1660 const char *logfile;
1662 /** The config file directory. */
1663 const char *confdir;
1665 /** The directory for customized CGI templates. */
1666 const char *templdir;
1668 /** The log file directory. */
1671 /** The full paths to the actions files. */
1672 const char *actions_file[MAX_AF_FILES];
1674 /** The short names of the actions files. */
1675 const char *actions_file_short[MAX_AF_FILES];
1677 /** The administrator's email address */
1678 char *admin_address;
1680 /** A URL with info on this proxy */
1681 char *proxy_info_url;
1683 /** URL to the user manual (on our website or local copy) */
1686 /** The file names of the pcre filter files. */
1687 const char *re_filterfile[MAX_AF_FILES];
1689 /** The short names of the pcre filter files. */
1690 const char *re_filterfile_short[MAX_AF_FILES];
1692 /** The hostname to show on CGI pages, or NULL to use the real one. */
1693 const char *hostname;
1695 #ifdef FEATURE_COOKIE_JAR
1697 /** The file name of the cookie jar file */
1698 const char * jarfile;
1700 /** The handle to the cookie jar file */
1703 #endif /* def FEATURE_COOKIE_JAR */
1705 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1708 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1711 /** Size limit for IOB */
1712 size_t buffer_limit;
1714 #ifdef FEATURE_TRUST
1716 /** The file name of the trust file. */
1717 const char * trustfile;
1719 /** FIXME: DOCME: Document this. */
1720 struct list trust_info[1];
1722 /** FIXME: DOCME: Document this. */
1723 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1725 #endif /* def FEATURE_TRUST */
1729 /** The access control list (ACL). */
1730 struct access_control_list *acl;
1732 #endif /* def FEATURE_ACL */
1734 /** Information about parent proxies (forwarding). */
1735 struct forward_spec *forward;
1737 /** Number of retries in case a forwarded connection attempt fails */
1738 int forwarded_connect_retries;
1740 /** All options from the config file, HTML-formatted. */
1743 /** The configuration file object. */
1744 struct file_list *config_file_list;
1746 /** List of loaders */
1747 int (*loaders[NLOADERS])(struct client_state *);
1749 /** Nonzero if we need to bind() to the new port. */
1753 /** Calculates the number of elements in an array, using sizeof. */
1754 #define SZ(X) (sizeof(X) / sizeof(*X))
1756 #ifdef FEATURE_FORCE_LOAD
1757 /** The force load URL prefix. */
1758 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1759 #endif /* def FEATURE_FORCE_LOAD */
1761 #ifdef FEATURE_NO_GIFS
1762 /** The MIME type for images ("image/png" or "image/gif"). */
1763 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1765 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1766 #endif /* def FEATURE_NO_GIFS */
1773 /** URL for the Privoxy home page. */
1774 #define HOME_PAGE_URL "http://www.privoxy.org/"
1776 /** URL for the Privoxy user manual. */
1777 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1779 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1780 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1782 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1783 #define CONFIG_HELP_PREFIX "config.html#"
1786 * The "hosts" to intercept and display CGI pages.
1787 * First one is a hostname only, second one can specify host and path.
1790 * 1) Do not specify the http: prefix
1791 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1792 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1794 #define CGI_SITE_1_HOST "p.p"
1795 #define CGI_SITE_2_HOST "config.privoxy.org"
1796 #define CGI_SITE_2_PATH ""
1799 * The prefix for CGI pages. Written out in generated HTML.
1800 * INCLUDES the trailing slash.
1802 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1808 #endif /* ndef PROJECT_H_INCLUDED */