1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.105 2008/03/21 11:16:27 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.105 2008/03/21 11:16:27 fabiankeil
41 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
43 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
44 * Remove the treat-forbidden-connects-like-blocks action. We now
45 * use the "blocked" page for forbidden CONNECT requests by default.
47 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
48 * Let the block action take the reason for the block
49 * as argument and show it on the "blocked" page.
51 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
52 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
54 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
55 * Remove now-obsolete csp member x_forwarded.
57 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
58 * - Allow port lists in url patterns.
59 * - Ditch unused url_spec member pathlen.
61 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
62 * As Hal noticed, checking dispatch_cgi() as the last cruncher
63 * looks like a bug if CGI requests are blocked unintentionally,
64 * so don't do it unless the user enabled the new config option
65 * "allow-cgi-request-crunching".
67 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
68 * Add new csp->content_type flag (CT_DECLARED).
70 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
71 * - Remove some left-overs from the switch to dedicated header filters.
72 * - Adjust "X-Filter: No" to disable dedicated header filters.
73 * - Prepare for forward-override{}
75 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
76 * Ditch the csp member cookie_list[] which isn't used anymore.
78 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
79 * Introduce dynamic pcrs jobs that can resolve variables.
81 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
82 * Introduce tags as alternative way to specify which
83 * actions apply to a request. At the moment tags can be
84 * created based on client and server headers.
86 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
87 * Use dedicated header filter actions instead of abusing "filter".
88 * Replace "filter-client-headers" and "filter-client-headers"
89 * with "server-header-filter" and "client-header-filter".
91 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
92 * New config option: enforce-blocks.
94 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
95 * Add some CSP_FLAGs for the header parsers.
97 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
98 * Add new http_response member to save
99 * the reason why the response was generated.
101 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
102 * Add new config option "templdir" to
103 * change the templates directory.
105 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
106 * Add csp->error_message for failure reasons
107 * that should be embedded into the CGI pages.
109 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
110 * Integrate a modified version of Wil Mahan's
111 * zlib patch (PR #895531).
113 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
114 * Added config option accept-intercepted-requests
115 * and disabled it by default.
117 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
118 * Fix gcc43 compiler warnings and a comment.
120 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
121 * Add config option "split-large-forms"
122 * to work around the browser bug reported
125 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
126 * Moved HTTP snipplets into jcc.c. They aren't
127 * used anywhere else.
129 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
130 * Doubled size of HOSTENT_BUFFER_SIZE to mask
131 * problems with gethostbyname_r and some
132 * /etc/hosts configurations. Only a workaround
133 * until we get the real fix ready.
134 * Thanks FĂ©lix Rauch for reporting.
136 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
138 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
139 * Respond with 400 and a short text message
140 * if the client tries to use Privoxy as FTP proxy.
142 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
143 * Added config option enable-remote-http-toggle
144 * to specify if Privoxy should recognize special
145 * headers (currently only X-Filter) to change its
146 * behaviour. Disabled by default.
148 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
149 * Make number of retries in case of forwarded-connect problems
150 * a config file option (forwarded-connect-retries) and use 0 as
153 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
154 * Work around a buffer overflow that caused Privoxy to
155 * segfault if too many trusted referrers were used. Good
156 * enough for now, but should be replaced with a real
157 * solution after the next release.
159 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
162 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
163 * Split filter-headers{} into filter-client-headers{}
164 * and filter-server-headers{}.
165 * Added parse_header_time() to share some code.
166 * Replaced timegm() with mktime().
168 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
169 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
171 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
172 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
173 * with what was really the latest development (the v_3_0_branch branch)
175 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
176 * Multiple filter file support
178 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
179 * Add the ability to check jpeg images for invalid
180 * lengths of comment blocks. Defensive strategy
181 * against the exploit:
182 * Microsoft Security Bulletin MS04-028
183 * Buffer Overrun in JPEG Processing (GDI+) Could
184 * Allow Code Execution (833987)
185 * Enabled with +inspect-jpegs in actions files.
187 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
188 * Updated the copyright note
190 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
191 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
193 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
194 * Introduced RC_FLAG_* flags for use in child process return code
196 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
197 * Added flag to each cgi_dispatcher that allows or denies
198 * external linking and removed const qualifier from
199 * struct list_entry.str.
201 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
202 * - Include config.h for access to config data
203 * - Include <pcre*.h> depending on where they are
205 * Revision 1.72 2002/05/14 21:35:49 oes
206 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
207 * because of split in user-manual
209 * Revision 1.71 2002/05/12 21:39:36 jongfoster
210 * - Adding Doxygen-style comments to structures and #defines.
212 * Revision 1.70 2002/05/12 16:05:50 jongfoster
213 * Fixing ACTION_MASK_ALL to be unsigned long rather than
214 * just unsigned int. I don't know if anyone is porting
215 * Privoxy to 16-bit platforms, but if so, +limit-connect
216 * wouldn't have worked because of this bug.
218 * Revision 1.69 2002/05/08 16:00:16 oes
219 * Added size member to struct iob, so it can
220 * be alloced larger than needed.
222 * Revision 1.68 2002/04/26 12:56:00 oes
223 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
225 * Revision 1.67 2002/04/24 02:12:43 oes
226 * - Jon's multiple AF patch:
227 * - Make csp->actions_list an array
228 * - #define MAX_AF_FILES
229 * - Moved CGI_PARAM_LEN_MAX (500) here
231 * Revision 1.66 2002/04/15 19:06:43 jongfoster
234 * Revision 1.65 2002/04/04 00:36:36 gliptak
235 * always use pcre for matching
237 * Revision 1.64 2002/04/03 22:28:03 gliptak
238 * Removed references to gnu_regex
240 * Revision 1.63 2002/03/31 17:19:00 jongfoster
241 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
243 * Revision 1.62 2002/03/26 22:48:49 swa
246 * Revision 1.61 2002/03/26 22:29:55 swa
247 * we have a new homepage!
249 * Revision 1.60 2002/03/24 15:52:17 jongfoster
250 * Changing CGI URL prefixes for new name
252 * Revision 1.59 2002/03/24 15:23:33 jongfoster
255 * Revision 1.58 2002/03/24 13:25:43 swa
256 * name change related issues
258 * Revision 1.57 2002/03/16 20:28:34 oes
259 * Added descriptions to the filters so users will know what they select in the cgi editor
261 * Revision 1.56 2002/03/13 20:27:30 oes
262 * Fixing bug with CT_TABOO
264 * Revision 1.55 2002/03/12 01:42:50 oes
265 * Introduced modular filters
267 * Revision 1.54 2002/03/09 20:03:52 jongfoster
268 * - Making various functions return int rather than size_t.
269 * (Undoing a recent change). Since size_t is unsigned on
270 * Windows, functions like read_socket that return -1 on
271 * error cannot return a size_t.
273 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
274 * crashes, and also frequently caused JB to jump to 100%
275 * CPU and stay there. (Because it thought it had just
276 * read ((unsigned)-1) == 4Gb of data...)
278 * - The signature of write_socket has changed, it now simply
279 * returns success=0/failure=nonzero.
281 * - Trying to get rid of a few warnings --with-debug on
282 * Windows, I've introduced a new type "jb_socket". This is
283 * used for the socket file descriptors. On Windows, this
284 * is SOCKET (a typedef for unsigned). Everywhere else, it's
285 * an int. The error value can't be -1 any more, so it's
286 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
287 * Windows it maps to the #define INVALID_SOCKET.)
289 * - The signature of bind_port has changed.
291 * Revision 1.53 2002/03/08 16:48:55 oes
292 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
294 * Revision 1.52 2002/03/07 03:46:17 oes
295 * Fixed compiler warnings
297 * Revision 1.51 2002/03/05 04:52:42 oes
298 * Deleted non-errlog debugging code
300 * Revision 1.50 2002/03/04 19:32:07 oes
301 * Changed default port to 8118
303 * Revision 1.49 2002/03/04 18:28:55 oes
304 * Deleted PID_FILE_NAME
306 * Revision 1.48 2002/03/03 14:50:40 oes
307 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
309 * Revision 1.47 2002/02/20 23:15:13 jongfoster
310 * Parsing functions now handle out-of-memory gracefully by returning
313 * Revision 1.46 2002/01/17 21:06:09 jongfoster
314 * Now #defining the URLs of the config interface
316 * Minor changes to struct http_request and struct url_spec due to
317 * standardizing that struct http_request is used to represent a URL, and
318 * struct url_spec is used to represent a URL pattern. (Before, URLs were
319 * represented as seperate variables and a partially-filled-in url_spec).
321 * Revision 1.45 2002/01/09 14:33:27 oes
322 * Added HOSTENT_BUFFER_SIZE
324 * Revision 1.44 2001/12/30 14:07:32 steudten
325 * - Add signal handling (unix)
326 * - Add SIGHUP handler (unix)
327 * - Add creation of pidfile (unix)
328 * - Add action 'top' in rc file (RH)
329 * - Add entry 'SIGNALS' to manpage
330 * - Add exit message to logfile (unix)
332 * Revision 1.43 2001/11/22 21:57:51 jongfoster
333 * Making action_spec->flags into an unsigned long rather than just an
335 * Adding ACTION_NO_COOKIE_KEEP
337 * Revision 1.42 2001/11/05 21:42:41 steudten
338 * Include DBG() macro.
340 * Revision 1.41 2001/10/28 19:12:06 jongfoster
341 * Adding ijb_toupper()
343 * Revision 1.40 2001/10/26 17:40:47 oes
344 * Moved ijb_isspace and ijb_tolower to project.h
345 * Removed http->user_agent, csp->referrer and csp->accept_types
347 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
348 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
349 * macro when called with a cast; so moving the cast to the macro def'n
350 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
351 * doesn't make macro expansion complain. Hope this works for everyone else
354 * Revision 1.38 2001/10/23 21:19:04 jongfoster
355 * New error-handling support: jb_err type and JB_ERR_xxx constants
356 * CGI functions now return a jb_err, and their parameters map is const.
357 * Support for RUNTIME_FEATUREs to enable/disable config editor
358 * Adding a few comments
360 * Revision 1.37 2001/10/14 22:14:01 jongfoster
361 * Removing name_length field from struct cgi_dispatcher, as this is
362 * now calculated at runtime from the "name" field.
364 * Revision 1.36 2001/10/10 16:45:15 oes
365 * Added LIMIT_CONNECT action and string
366 * Fixed HTTP message line termination
367 * Added CFORBIDDEN HTTP message
369 * Revision 1.35 2001/10/07 18:06:43 oes
370 * Added status member to struct http_request
372 * Revision 1.34 2001/10/07 15:45:25 oes
373 * Added url member to struct http_request and commented all
378 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
380 * Replaced struct client_state members rejected,
381 * force, active and toggled_on with "flags" bitmap.
383 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
385 * Added buffer_limit to struct configuration_spec
387 * Revision 1.33 2001/09/20 13:30:08 steudten
389 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
390 * Last case will set z to NULL in free(z) and thats bad..
392 * Revision 1.32 2001/09/16 23:02:51 jongfoster
395 * Revision 1.31 2001/09/16 13:20:29 jongfoster
396 * Rewrite of list library. Now has seperate header and list_entry
397 * structures. Also added a large sprinking of assert()s to the list
400 * Revision 1.30 2001/09/13 23:52:00 jongfoster
401 * Support for both static and dynamically generated CGI pages
403 * Revision 1.29 2001/09/13 23:29:43 jongfoster
404 * Defining FORWARD_SPEC_INITIALIZER
406 * Revision 1.28 2001/09/13 23:05:50 jongfoster
407 * Changing the string paramater to the header parsers a "const".
409 * Revision 1.27 2001/08/05 16:06:20 jongfoster
410 * Modifiying "struct map" so that there are now separate header and
411 * "map_entry" structures. This means that functions which modify a
412 * map no longer need to return a pointer to the modified map.
413 * Also, it no longer reverses the order of the entries (which may be
414 * important with some advanced template substitutions).
416 * Revision 1.26 2001/07/30 22:08:36 jongfoster
417 * Tidying up #defines:
418 * - All feature #defines are now of the form FEATURE_xxx
419 * - Permanently turned off WIN_GUI_EDIT
420 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
422 * Revision 1.25 2001/07/29 18:43:08 jongfoster
423 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
426 * Revision 1.24 2001/07/25 17:20:27 oes
427 * Introduced http->user_agent
429 * Revision 1.23 2001/07/18 12:32:23 oes
430 * - Added ACTION_STRING_DEANIMATE
431 * - moved #define freez from jcc.h to project.h
433 * Revision 1.22 2001/07/15 17:51:41 jongfoster
434 * Renaming #define STATIC to STATIC_PCRE
436 * Revision 1.21 2001/07/13 14:03:19 oes
437 * - Reorganized regex header inclusion and #defines to
438 * comply to the scheme in configure.in
439 * - Added csp->content_type and its CT_* keys
440 * - Added ACTION_DEANIMATE
441 * - Removed all #ifdef PCRS
443 * Revision 1.20 2001/06/29 21:45:41 oes
444 * Indentation, CRLF->LF, Tab-> Space
446 * Revision 1.19 2001/06/29 13:33:36 oes
447 * - Improved comments
448 * - Introduced http_request.host_ip_addr_str
449 * - Introduced http_response.head_length
450 * - Introduced config.my_ip_addr_str, config.my_hostname,
451 * config.admin_address and config.proxy_info_url
452 * - Removed config.proxy_args_header and config.proxy_args_trailer,
453 * renamed config.proxy_args_invocation to config.proxy_args
454 * - Removed HTML snipplets and GIFs
455 * - Removed logentry from cancelled commit
457 * Revision 1.18 2001/06/09 10:57:39 jongfoster
458 * Adding definition of BUFFER_SIZE.
459 * Changing struct cgi_dispatcher to use "const" strings.
461 * Revision 1.17 2001/06/07 23:15:09 jongfoster
462 * Merging ACL and forward files into config file.
463 * Moving struct gateway members into struct forward_spec
464 * Removing config->proxy_args_gateways
465 * Cosmetic: Adding a few comments
467 * Revision 1.16 2001/06/04 18:31:58 swa
468 * files are now prefixed with either `confdir' or `logdir'.
469 * `make redhat-dist' replaces both entries confdir and logdir
472 * Revision 1.15 2001/06/04 11:28:53 swa
473 * redirect did not work due to missing /
475 * Revision 1.14 2001/06/03 11:03:48 oes
477 * added struct http_response,
478 * changed struct interceptors to struct cgi_dispatcher,
479 * moved HTML stuff to cgi.h
481 * Revision 1.13 2001/06/01 20:05:36 jongfoster
482 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
483 * constant, and removed csp->tinygif.
485 * Revision 1.12 2001/06/01 18:49:17 jongfoster
486 * Replaced "list_share" with "list" - the tiny memory gain was not
487 * worth the extra complexity.
489 * Revision 1.11 2001/06/01 10:32:47 oes
490 * Added constants for anchoring selection bitmap
492 * Revision 1.10 2001/05/31 21:33:53 jongfoster
493 * Changes for new actions file, replacing permissionsfile
494 * and parts of the config file. Also added support for
497 * Revision 1.9 2001/05/31 17:32:31 oes
499 * - Enhanced domain part globbing with infix and prefix asterisk
500 * matching and optional unanchored operation
502 * Revision 1.8 2001/05/29 20:09:15 joergs
503 * HTTP_REDIRECT_TEMPLATE fixed.
505 * Revision 1.7 2001/05/29 09:50:24 jongfoster
506 * Unified blocklist/imagelist/actionslist.
507 * File format is still under discussion, but the internal changes
510 * Also modified interceptor behaviour:
511 * - We now intercept all URLs beginning with one of the following
512 * prefixes (and *only* these prefixes):
514 * * http://ijbswa.sf.net/config/
515 * * http://ijbswa.sourceforge.net/config/
516 * - New interceptors "home page" - go to http://i.j.b/ to see it.
517 * - Internal changes so that intercepted and fast redirect pages
518 * are not replaced with an image.
519 * - Interceptors now have the option to send a binary page direct
520 * to the client. (i.e. ijb-send-banner uses this)
521 * - Implemented show-url-info interceptor. (Which is why I needed
522 * the above interceptors changes - a typical URL is
523 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
524 * The previous mechanism would not have intercepted that, and
525 * if it had been intercepted then it then it would have replaced
528 * Revision 1.6 2001/05/27 22:17:04 oes
530 * - re_process_buffer no longer writes the modified buffer
531 * to the client, which was very ugly. It now returns the
532 * buffer, which it is then written by chat.
534 * - content_length now adjusts the Content-Length: header
535 * for modified documents rather than crunch()ing it.
536 * (Length info in csp->content_length, which is 0 for
537 * unmodified documents)
539 * - For this to work, sed() is called twice when filtering.
541 * Revision 1.5 2001/05/26 00:28:36 jongfoster
542 * Automatic reloading of config file.
543 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
544 * Most of the global variables have been moved to a new
545 * struct configuration_spec, accessed through csp->config->globalname
546 * Most of the globals remaining are used by the Win32 GUI.
548 * Revision 1.4 2001/05/22 18:46:04 oes
550 * - Enabled filtering banners by size rather than URL
551 * by adding patterns that replace all standard banner
552 * sizes with the "Junkbuster" gif to the re_filterfile
554 * - Enabled filtering WebBugs by providing a pattern
555 * which kills all 1x1 images
557 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
558 * which is selected by the (nonstandard and therefore
559 * capital) letter 'U' in the option string.
560 * It causes the quantifiers to be ungreedy by default.
561 * Appending a ? turns back to greedy (!).
563 * - Added a new interceptor ijb-send-banner, which
564 * sends back the "Junkbuster" gif. Without imagelist or
565 * MSIE detection support, or if tinygif = 1, or the
566 * URL isn't recognized as an imageurl, a lame HTML
567 * explanation is sent instead.
569 * - Added new feature, which permits blocking remote
570 * script redirects and firing back a local redirect
572 * The feature is conditionally compiled, i.e. it
573 * can be disabled with --disable-fast-redirects,
574 * plus it must be activated by a "fast-redirects"
575 * line in the config file, has its own log level
576 * and of course wants to be displayed by show-proxy-args
577 * Note: Boy, all the #ifdefs in 1001 locations and
578 * all the fumbling with configure.in and acconfig.h
579 * were *way* more work than the feature itself :-(
581 * - Because a generic redirect template was needed for
582 * this, tinygif = 3 now uses the same.
584 * - Moved GIFs, and other static HTTP response templates
589 * - Removed some >400 CRs again (Jon, you really worked
592 * Revision 1.3 2001/05/20 01:21:20 jongfoster
593 * Version 2.9.4 checkin.
594 * - Merged popupfile and cookiefile, and added control over PCRS
595 * filtering, in new "actionsfile".
596 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
597 * file error you now get a message box (in the Win32 GUI) rather
598 * than the program exiting with no explanation.
599 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
601 * - Removed tabs from "config"
602 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
603 * - Bumped up version number.
605 * Revision 1.2 2001/05/17 23:01:01 oes
606 * - Cleaned CRLF's from the sources and related files
608 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
609 * Initial import of version 2.9.3 source tree
612 *********************************************************************/
615 /* Declare struct FILE for vars and funcs. */
618 /* Need time_t for file_list */
620 /* Needed for pcre choice */
624 * Include appropriate regular expression libraries.
625 * Note that pcrs and pcre (native) are needed for cgi
626 * and are included anyway.
632 # ifdef PCRE_H_IN_SUBDIR
633 # include <pcre/pcre.h>
646 # include "pcreposix.h"
648 # ifdef PCRE_H_IN_SUBDIR
649 # include <pcre/pcreposix.h>
651 # include <pcreposix.h>
657 #endif /* def AMIGA */
661 * I don't want to have to #include all this just for the declaration
662 * of SOCKET. However, it looks like we have to...
677 typedef SOCKET jb_socket;
679 #define JB_INVALID_SOCKET INVALID_SOCKET
681 #else /* ndef _WIN32 */
684 * The type used by sockets. On UNIX it's an int. Microsoft decided to
685 * make it an unsigned.
687 typedef int jb_socket;
690 * The error value used for variables of type jb_socket. On UNIX this
691 * is -1, however Microsoft decided to make socket handles unsigned, so
692 * they use a different value.
695 #define JB_INVALID_SOCKET (-1)
697 #endif /* ndef _WIN32 */
701 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
706 #define JB_ERR_OK 0 /**< Success, no error */
707 #define JB_ERR_MEMORY 1 /**< Out of memory */
708 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
709 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
710 #define JB_ERR_PARSE 4 /**< Error parsing file */
711 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
712 CGI actions editor. */
713 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
716 * This macro is used to free a pointer that may be NULL.
717 * It also sets the variable to NULL after it's been freed.
718 * The paramater should be a simple variable without side effects.
720 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
724 * Fix a problem with Solaris. There should be no effect on other
727 * Solaris's isspace() is a macro which uses it's argument directly
728 * as an array index. Therefore we need to make sure that high-bit
729 * characters generate +ve values, and ideally we also want to make
730 * the argument match the declared parameter type of "int".
732 * Note: Remember to #include <ctype.h> if you use these macros.
734 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
735 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
736 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
739 * Use for statically allocated buffers if you have no other choice.
740 * Remember to check the length of what you write into the buffer
741 * - we don't want any buffer overflows!
743 #define BUFFER_SIZE 5000
746 * Max length of CGI parameters (arbitrary limit).
748 #define CGI_PARAM_LEN_MAX 500
751 * Buffer size for capturing struct hostent data in the
752 * gethostby(name|addr)_r library calls. Since we don't
753 * loop over gethostbyname_r, the buffer must be sufficient
754 * to accomodate multiple IN A RRs, as used in DNS round robin
755 * load balancing. W3C's wwwlib uses 1K, so that should be
756 * good enough for us, too.
759 * XXX: Temporary doubled, for some configurations
760 * 1K is still too small and we didn't get the
761 * real fix ready for inclusion.
763 #define HOSTENT_BUFFER_SIZE 2048
766 * Do not use. Originally this was so that you can
767 * say "while (FOREVER) { ...do something... }".
768 * However, this gives a warning with some compilers (e.g. VC++).
769 * Instead, use "for (;;) { ...do something... }".
774 * Default IP address to listen on, as a string.
775 * Set to "127.0.0.1".
777 #define HADDR_DEFAULT "127.0.0.1"
780 * Default port to listen on, as a number.
783 #define HADDR_PORT 8118
786 /* Forward def for struct client_state */
787 struct configuration_spec;
791 * Entry in a linked list of strings.
796 * The string pointer. It must point to a dynamically malloc()ed
797 * string or be NULL for the list functions to work. In the latter
798 * case, just be careful next time you iterate through the list in
803 /** Next entry in the linked list, or NULL if no more. */
804 struct list_entry *next;
808 * A header for a linked list of strings.
812 /** First entry in the list, or NULL if the list is empty. */
813 struct list_entry *first;
815 /** Last entry in the list, or NULL if the list is empty. */
816 struct list_entry *last;
821 * An entry in a map. This is a name=value pair.
825 /** The key for the map. */
827 /** The value associated with that key. */
829 /** The next map entry, or NULL if none. */
830 struct map_entry *next;
834 * A map from a string to another string.
835 * This is used for the paramaters passed in a HTTP GET request, and
836 * to store the exports when the CGI interface is filling in a template.
840 /** The first map entry, or NULL if the map is empty. */
841 struct map_entry *first;
842 /** The last map entry, or NULL if the map is empty. */
843 struct map_entry *last;
848 * A HTTP request. This includes the method (GET, POST) and
851 * This is also used whenever we want to match a URL against a
852 * URL pattern. This always contains the URL to match, and never
853 * a URL pattern. (See struct url_spec).
857 char *cmd; /**< Whole command line: method, URL, Version */
858 char *ocmd; /**< Backup of original cmd for CLF logging */
859 char *gpc; /**< HTTP method: GET, POST, ... */
860 char *url; /**< The URL */
861 char *ver; /**< Protocol version */
862 int status; /**< HTTP Status */
864 char *host; /**< Host part of URL */
865 int port; /**< Port of URL or 80 (default) */
866 char *path; /**< Path of URL */
867 char *hostport; /**< host[:port] */
868 int ssl; /**< Flag if protocol is https */
870 char *host_ip_addr_str; /**< String with dotted decimal representation
871 of host's IP. NULL before connect_to() */
873 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
874 char **dvec; /**< List of pointers to the strings in dbuffer. */
875 int dcount; /**< How many parts to this domain? (length of dvec) */
879 * Reasons for generating a http_response instead of delivering
880 * the requested resource. Mostly ordered the way they are checked
883 #define RSP_REASON_UNSUPPORTED 1
884 #define RSP_REASON_BLOCKED 2
885 #define RSP_REASON_UNTRUSTED 3
886 #define RSP_REASON_REDIRECTED 4
887 #define RSP_REASON_CGI_CALL 5
888 #define RSP_REASON_NO_SUCH_DOMAIN 6
889 #define RSP_REASON_FORWARDING_FAILED 7
890 #define RSP_REASON_CONNECT_FAILED 8
891 #define RSP_REASON_OUT_OF_MEMORY 9
892 #define RSP_REASON_INTERNAL_ERROR 10
895 * Response generated by CGI, blocker, or error handler
899 char *status; /**< HTTP status (string). */
900 struct list headers[1]; /**< List of header lines. */
901 char *head; /**< Formatted http response head. */
902 size_t head_length; /**< Length of http response head. */
903 char *body; /**< HTTP document body. */
904 size_t content_length; /**< Length of body, REQUIRED if binary body. */
905 int is_static; /**< Nonzero if the content will never change and
906 should be cached by the browser (e.g. images). */
907 int reason; /**< Why the response was generated in the first place. */
911 * A URL or a tag pattern.
915 /** The string which was parsed to produce this url_spec.
916 Used for debugging or display only. */
919 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
920 char **dvec; /**< List of pointers to the strings in dbuffer. */
921 int dcount; /**< How many parts to this domain? (length of dvec) */
922 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
924 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
926 char *path; /**< The source for the regex. */
927 regex_t *preg; /**< Regex for matching path part */
928 regex_t *tag_regex; /**< Regex for matching tags */
932 * If you declare a static url_spec, this is the value to initialize it to zero.
934 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL, NULL }
937 * Constant for host part matching in URLs. If set, indicates that the start of
938 * the pattern must match the start of the URL. E.g. this is not set for the
939 * pattern ".example.com", so that it will match both "example.com" and
940 * "www.example.com". It is set for the pattern "example.com", which makes it
941 * match "example.com" only, not "www.example.com".
943 #define ANCHOR_LEFT 1
946 * Constant for host part matching in URLs. If set, indicates that the end of
947 * the pattern must match the end of the URL. E.g. this is not set for the
948 * pattern "ad.", so that it will match any host called "ad", irrespective
949 * of how many subdomains are in the fully-qualified domain name.
951 #define ANCHOR_RIGHT 2
955 * An I/O buffer. Holds a string which can be appended to, and can have data
956 * removed from the beginning.
960 char *buf; /**< Start of buffer */
961 char *cur; /**< Start of relevant data */
962 char *eod; /**< End of relevant data */
963 size_t size; /**< Size as malloc()ed */
968 * Return the number of bytes in the I/O buffer associated with the passed
969 * client_state pointer.
972 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
976 * Remove any data in the I/O buffer associated with the passed
977 * client_state pointer.
979 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
981 /* Bits for csp->content_type bitmask: */
982 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
983 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
984 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
985 #define CT_JPEG 0x0008U /**< Suitable for JPEG filtering. */
987 /* Although these are not, strictly speaking, content types
988 * (they are content encodings), it is simple to handle them
991 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
992 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
995 * Flag to signal that the server declared the content type,
996 * so we can differentiate between unknown and undeclared
999 #define CT_DECLARED 0x0040U
1002 * The mask which includes all actions.
1004 #define ACTION_MASK_ALL (~0UL)
1007 * The most compatible set of actions - i.e. none.
1009 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1011 /** Action bitmap: Block the request. */
1012 #define ACTION_BLOCK 0x00000001UL
1013 /** Action bitmap: Deanimate if it's a GIF. */
1014 #define ACTION_DEANIMATE 0x00000002UL
1015 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1016 #define ACTION_DOWNGRADE 0x00000004UL
1017 /** Action bitmap: Fast redirects. */
1018 #define ACTION_FAST_REDIRECTS 0x00000008UL
1019 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
1020 #define ACTION_HIDE_FORWARDED 0x00000010UL
1021 /** Action bitmap: Hide "From" header. */
1022 #define ACTION_HIDE_FROM 0x00000020UL
1023 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1024 #define ACTION_HIDE_REFERER 0x00000040UL
1025 /** Action bitmap: Hide "User-Agent" and similar headers. */
1026 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1027 /** Action bitmap: This is an image. */
1028 #define ACTION_IMAGE 0x00000100UL
1029 /** Action bitmap: Sets the image blocker. */
1030 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1031 /** Action bitmap: Prevent compression. */
1032 #define ACTION_NO_COMPRESSION 0x00000400UL
1033 /** Action bitmap: Change cookies to session only cookies. */
1034 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1035 /** Action bitmap: Block rending cookies. */
1036 #define ACTION_NO_COOKIE_READ 0x00001000UL
1037 /** Action bitmap: Block setting cookies. */
1038 #define ACTION_NO_COOKIE_SET 0x00002000UL
1039 /** Action bitmap: Filter out popups. */
1040 #define ACTION_NO_POPUPS 0x00004000UL
1041 /** Action bitmap: Send a vanilla wafer. */
1042 #define ACTION_VANILLA_WAFER 0x00008000UL
1043 /** Action bitmap: Limit CONNECT requests to safe ports. */
1044 #define ACTION_LIMIT_CONNECT 0x00010000UL
1045 /** Action bitmap: Inspect if it's a JPEG. */
1046 #define ACTION_JPEG_INSPECT 0x00020000UL
1047 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1048 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1049 /** Action bitmap: Overwrite Content-Type header. */
1050 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1051 /** Action bitmap: Crunch specified server header. */
1052 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1053 /** Action bitmap: Crunch specified client header */
1054 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1055 /** Action bitmap: Enable text mode by force */
1056 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1057 /** Action bitmap: Enable text mode by force */
1058 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1059 /** Action bitmap: Enable content-dispostion crunching */
1060 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1061 /** Action bitmap: Replace or block Last-Modified header */
1062 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1063 /** Action bitmap: Replace or block Accept-Language header */
1064 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1065 /** Action bitmap: Block as empty document */
1066 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
1067 /** Action bitmap: Redirect request. */
1068 #define ACTION_REDIRECT 0x10000000UL
1069 /** Action bitmap: Override the forward settings in the config file */
1070 #define ACTION_FORWARD_OVERRIDE 0x20000000UL
1073 /** Action string index: How to deanimate GIFs */
1074 #define ACTION_STRING_DEANIMATE 0
1075 /** Action string index: Replacement for "From:" header */
1076 #define ACTION_STRING_FROM 1
1077 /** Action string index: How to block images */
1078 #define ACTION_STRING_IMAGE_BLOCKER 2
1079 /** Action string index: Replacement for "Referer:" header */
1080 #define ACTION_STRING_REFERER 3
1081 /** Action string index: Replacement for "User-Agent:" header */
1082 #define ACTION_STRING_USER_AGENT 4
1083 /** Action string index: Legal CONNECT ports. */
1084 #define ACTION_STRING_LIMIT_CONNECT 5
1085 /** Action string index: Server headers containing this pattern are crunched*/
1086 #define ACTION_STRING_SERVER_HEADER 6
1087 /** Action string index: Client headers containing this pattern are crunched*/
1088 #define ACTION_STRING_CLIENT_HEADER 7
1089 /** Action string index: Replacement for the "Accept-Language:" header*/
1090 #define ACTION_STRING_LANGUAGE 8
1091 /** Action string index: Replacement for the "Content-Type:" header*/
1092 #define ACTION_STRING_CONTENT_TYPE 9
1093 /** Action string index: Replacement for the "content-dispostion:" header*/
1094 #define ACTION_STRING_CONTENT_DISPOSITION 10
1095 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1096 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1097 /** Action string index: Replacement for the "Last-Modified:" header. */
1098 #define ACTION_STRING_LAST_MODIFIED 12
1099 /** Action string index: Redirect URL */
1100 #define ACTION_STRING_REDIRECT 13
1101 /** Action string index: Decode before redirect? */
1102 #define ACTION_STRING_FAST_REDIRECTS 14
1103 /** Action string index: Overriding forward rule. */
1104 #define ACTION_STRING_FORWARD_OVERRIDE 15
1105 /** Action string index: Reason for the block. */
1106 #define ACTION_STRING_BLOCK 16
1107 /** Number of string actions. */
1108 #define ACTION_STRING_COUNT 17
1111 /* To make the ugly hack in sed easier to understand */
1112 #define CHECK_EVERY_HEADER_REMAINING 0
1115 /** Index into current_action_spec::multi[] for headers to add. */
1116 #define ACTION_MULTI_ADD_HEADER 0
1117 /** Index into current_action_spec::multi[] for headers to add. */
1118 #define ACTION_MULTI_WAFER 1
1119 /** Index into current_action_spec::multi[] for content filters to apply. */
1120 #define ACTION_MULTI_FILTER 2
1121 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1122 #define ACTION_MULTI_SERVER_HEADER_FILTER 3
1123 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1124 #define ACTION_MULTI_CLIENT_HEADER_FILTER 4
1125 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1126 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 5
1127 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1128 #define ACTION_MULTI_SERVER_HEADER_TAGGER 6
1129 /** Number of multi-string actions. */
1130 #define ACTION_MULTI_COUNT 7
1134 * This structure contains a list of actions to apply to a URL.
1135 * It only contains positive instructions - no "-" options.
1136 * It is not used to store the actions list itself, only for
1137 * url_actions() to return the current values.
1139 struct current_action_spec
1141 /** Actions to apply. A bit set to "1" means perform the action. */
1142 unsigned long flags;
1145 * Paramaters for those actions that require them.
1146 * Each entry is valid if & only if the corresponding entry in "flags" is
1149 char * string[ACTION_STRING_COUNT];
1151 /** Lists of strings for multi-string actions. */
1152 struct list multi[ACTION_MULTI_COUNT][1];
1157 * This structure contains a set of changes to actions.
1158 * It can contain both positive and negative instructions.
1159 * It is used to store an entry in the actions list.
1163 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1164 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1167 * Paramaters for those actions that require them.
1168 * Each entry is valid if & only if the corresponding entry in "flags" is
1171 char * string[ACTION_STRING_COUNT];
1173 /** Lists of strings to remove, for multi-string actions. */
1174 struct list multi_remove[ACTION_MULTI_COUNT][1];
1176 /** If nonzero, remove *all* strings from the multi-string action. */
1177 int multi_remove_all[ACTION_MULTI_COUNT];
1179 /** Lists of strings to add, for multi-string actions. */
1180 struct list multi_add[ACTION_MULTI_COUNT][1];
1185 * This structure is used to store action files.
1187 * It contains an URL or tag pattern, and the changes to
1188 * the actions. It's a linked list and should only be
1189 * free'd through unload_actions_file() unless there's
1190 * only a single entry.
1194 struct url_spec url[1]; /**< The URL or tag pattern. */
1196 struct action_spec *action; /**< Action settings that might be shared with
1197 the list entry before or after the current
1198 one and can't be free'd willy nilly. */
1200 struct url_actions *next; /**< Next action section in file, or NULL. */
1205 * Flags for use in csp->flags
1209 * Flag for csp->flags: Set if this client is processing data.
1210 * Cleared when the thread associated with this structure dies.
1212 #define CSP_FLAG_ACTIVE 0x01
1215 * Flag for csp->flags: Set if the server's reply is in "chunked"
1218 #define CSP_FLAG_CHUNKED 0x02
1221 * Flag for csp->flags: Set if this request was enforced, although it would
1222 * normally have been blocked.
1224 #define CSP_FLAG_FORCED 0x04
1227 * Flag for csp->flags: Set if any modification to the body was done.
1229 #define CSP_FLAG_MODIFIED 0x08
1232 * Flag for csp->flags: Set if request was blocked.
1234 #define CSP_FLAG_REJECTED 0x10
1237 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1239 #define CSP_FLAG_TOGGLED_ON 0x20
1242 * Flag for csp->flags: Set if adding the 'Connection: close' header
1243 * for the client isn't necessary.
1245 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
1248 * Flag for csp->flags: Set if adding the 'Connection: close' header
1249 * for the server isn't necessary.
1251 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1254 * Flag for csp->flags: Signals header parsers whether they
1255 * are parsing server or client headers.
1257 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1260 * Flag for csp->flags: Set if adding the Host: header
1263 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1266 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1267 * XXX: As we now have tags we might as well ditch this.
1269 #define CSP_FLAG_NO_FILTERING 0x00000400UL
1273 * Flags for use in return codes of child processes
1277 * Flag for process return code: Set if exiting porcess has been toggled
1278 * during its lifetime.
1280 #define RC_FLAG_TOGGLED 0x10
1283 * Flag for process return code: Set if exiting porcess has blocked its
1286 #define RC_FLAG_BLOCKED 0x20
1289 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1292 #define MAX_AF_FILES 10
1295 * The state of a Privoxy processing thread.
1299 /** The proxy's configuration */
1300 struct configuration_spec * config;
1302 /** The actions to perform on the current request */
1303 struct current_action_spec action[1];
1305 /** socket to talk to client (web browser) */
1308 /** socket to talk to server (web server or proxy) */
1311 /** Multi-purpose flag container, see CSP_FLAG_* above */
1314 /** Client PC's IP address, as reported by the accept() function.
1317 /** Client PC's IP address, as reported by the accept() function.
1321 /** The URL that was requested */
1322 struct http_request http[1];
1325 * The final forwarding settings.
1326 * XXX: Currently this is only used for forward-override,
1327 * so we can free the space in sweep.
1329 struct forward_spec * fwd;
1331 /** An I/O buffer used for buffering data read from the network */
1334 /** List of all headers for this request */
1335 struct list headers[1];
1337 /** List of all tags that apply to this request */
1338 struct list tags[1];
1340 /** MIME-Type key, see CT_* above */
1341 unsigned int content_type;
1343 /** Actions files associated with this client */
1344 struct file_list *actions_list[MAX_AF_FILES];
1346 /** pcrs job files. */
1347 struct file_list *rlist[MAX_AF_FILES];
1349 /** Length after content modification. */
1350 size_t content_length;
1352 #ifdef FEATURE_TRUST
1355 struct file_list *tlist;
1357 #endif /* def FEATURE_TRUST */
1360 * Failure reason to embedded in the CGI error page,
1361 * or NULL. Currently only used for socks errors.
1363 char *error_message;
1365 /** Next thread in linked list. Only read or modify from the main thread! */
1366 struct client_state *next;
1371 * A function to add a header
1373 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1376 * A function to process a header
1378 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1382 * List of functions to run on a list of headers
1386 /** The header prefix to match */
1389 /** The length of the prefix to match */
1392 /** The function to apply to this line */
1393 parser_func_ptr parser;
1398 * List of available CGI functions.
1400 struct cgi_dispatcher
1402 /** The URL of the CGI, relative to the CGI root. */
1403 const char * const name;
1405 /** The handler function for the CGI */
1406 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1408 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1409 const char * const description;
1411 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1417 * A data file used by Privoxy. Kept in a linked list.
1422 * This is a pointer to the data structures associated with the file.
1423 * Read-only once the structure has been created.
1428 * The unloader function.
1429 * Normally NULL. When we are finished with file (i.e. when we have
1430 * loaded a new one), set to a pointer to an unloader function.
1431 * Unloader will be called by sweep() (called from main loop) when
1432 * all clients using this file are done. This prevents threading
1435 void (*unloader)(void *);
1438 * Used internally by sweep(). Do not access from elsewhere.
1443 * File last-modified time, so we can check if file has been changed.
1444 * Read-only once the structure has been created.
1446 time_t lastmodified;
1449 * The full filename.
1454 * Pointer to next entry in the linked list of all "file_list"s.
1455 * This linked list is so that sweep() can navigate it.
1456 * Since sweep() can remove items from the list, we must be careful
1457 * to only access this value from main thread (when we know sweep
1458 * won't be running).
1460 struct file_list *next;
1464 #ifdef FEATURE_TRUST
1467 * The format of a trust file when loaded into memory.
1471 struct url_spec url[1]; /**< The URL pattern */
1472 int reject; /**< FIXME: Please document this! */
1473 struct block_spec *next; /**< Next entry in linked list */
1477 * Arbitrary limit for the number of trusted referrers.
1479 #define MAX_TRUSTED_REFERRERS 512
1481 #endif /* def FEATURE_TRUST */
1484 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1485 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1486 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1487 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1491 * How to forward a connection to a parent proxy.
1495 /** URL pattern that this forward_spec is for. */
1496 struct url_spec url[1];
1498 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1501 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1504 /** SOCKS server port. */
1507 /** Parent HTTP proxy hostname, or NULL for none. */
1510 /** Parent HTTP proxy port. */
1513 /** Next entry in the linked list. */
1514 struct forward_spec *next;
1519 * Initializer for a static struct forward_spec.
1521 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1523 /* Supported filter types */
1524 #define FT_CONTENT_FILTER 0
1525 #define FT_CLIENT_HEADER_FILTER 1
1526 #define FT_SERVER_HEADER_FILTER 2
1527 #define FT_CLIENT_HEADER_TAGGER 3
1528 #define FT_SERVER_HEADER_TAGGER 4
1530 #define MAX_FILTER_TYPES 5
1533 * This struct represents one filter (one block) from
1534 * the re_filterfile. If there is more than one filter
1535 * in the file, the file will be represented by a
1536 * chained list of re_filterfile specs.
1538 struct re_filterfile_spec
1540 char *name; /**< Name from FILTER: statement in re_filterfile. */
1541 char *description; /**< Description from FILTER: statement in re_filterfile. */
1542 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1543 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1544 int type; /**< Filter type (content, client-header, server-header). */
1545 int dynamic; /**< Set to one if the pattern might contain variables
1546 and has to be recompiled for every request. */
1547 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1553 #define ACL_PERMIT 1 /**< Accept connection request */
1554 #define ACL_DENY 2 /**< Reject connection request */
1557 * An IP address pattern. Used to specify networks in the ACL.
1559 struct access_control_addr
1561 unsigned long addr; /**< The IP address as an integer. */
1562 unsigned long mask; /**< The network mask as an integer. */
1563 unsigned long port; /**< The port number. */
1567 * An access control list (ACL) entry.
1569 * This is a linked list.
1571 struct access_control_list
1573 struct access_control_addr src[1]; /**< Client IP address */
1574 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1576 short action; /**< ACL_PERMIT or ACL_DENY */
1577 struct access_control_list *next; /**< The next entry in the ACL. */
1580 #endif /* def FEATURE_ACL */
1583 /** Maximum number of loaders (actions, re_filter, ...) */
1587 /** configuration_spec::feature_flags: CGI actions editor. */
1588 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1590 /** configuration_spec::feature_flags: Web-based toggle. */
1591 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1593 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1594 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1596 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1597 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1599 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1600 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1602 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1603 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32
1605 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1606 #define RUNTIME_FEATURE_CGI_CRUNCHING 64
1610 * Data loaded from the configuration file.
1612 * (Anomaly: toggle is still handled through a global, not this structure)
1614 struct configuration_spec
1619 /** Nonzero to enable multithreading. */
1623 * Bitmask of features that can be enabled/disabled through the config
1624 * file. Currently defined bits:
1626 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1627 * - RUNTIME_FEATURE_CGI_TOGGLE
1628 * - RUNTIME_FEATURE_HTTP_TOGGLE
1629 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1631 unsigned feature_flags;
1633 /** The log file name. */
1634 const char *logfile;
1636 /** The config file directory. */
1637 const char *confdir;
1639 /** The directory for customized CGI templates. */
1640 const char *templdir;
1642 /** The log file directory. */
1645 /** The full paths to the actions files. */
1646 const char *actions_file[MAX_AF_FILES];
1648 /** The short names of the actions files. */
1649 const char *actions_file_short[MAX_AF_FILES];
1651 /** The administrator's email address */
1652 char *admin_address;
1654 /** A URL with info on this proxy */
1655 char *proxy_info_url;
1657 /** URL to the user manual (on our website or local copy) */
1660 /** The file names of the pcre filter files. */
1661 const char *re_filterfile[MAX_AF_FILES];
1663 /** The short names of the pcre filter files. */
1664 const char *re_filterfile_short[MAX_AF_FILES];
1666 #ifdef FEATURE_COOKIE_JAR
1668 /** The file name of the cookie jar file */
1669 const char * jarfile;
1671 /** The handle to the cookie jar file */
1674 #endif /* def FEATURE_COOKIE_JAR */
1676 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1679 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1682 /** Size limit for IOB */
1683 size_t buffer_limit;
1685 #ifdef FEATURE_TRUST
1687 /** The file name of the trust file. */
1688 const char * trustfile;
1690 /** FIXME: DOCME: Document this. */
1691 struct list trust_info[1];
1693 /** FIXME: DOCME: Document this. */
1694 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1696 #endif /* def FEATURE_TRUST */
1700 /** The access control list (ACL). */
1701 struct access_control_list *acl;
1703 #endif /* def FEATURE_ACL */
1705 /** Information about parent proxies (forwarding). */
1706 struct forward_spec *forward;
1708 /** Number of retries in case a forwarded connection attempt fails */
1709 int forwarded_connect_retries;
1711 /** All options from the config file, HTML-formatted. */
1714 /** The configuration file object. */
1715 struct file_list *config_file_list;
1717 /** List of loaders */
1718 int (*loaders[NLOADERS])(struct client_state *);
1720 /** Nonzero if we need to bind() to the new port. */
1724 /** Calculates the number of elements in an array, using sizeof. */
1725 #define SZ(X) (sizeof(X) / sizeof(*X))
1727 #ifdef FEATURE_FORCE_LOAD
1728 /** The force load URL prefix. */
1729 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1730 #endif /* def FEATURE_FORCE_LOAD */
1732 #ifdef FEATURE_NO_GIFS
1733 /** The MIME type for images ("image/png" or "image/gif"). */
1734 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1736 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1737 #endif /* def FEATURE_NO_GIFS */
1744 /** URL for the Privoxy home page. */
1745 #define HOME_PAGE_URL "http://www.privoxy.org/"
1747 /** URL for the Privoxy user manual. */
1748 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1750 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1751 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1753 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1754 #define CONFIG_HELP_PREFIX "config.html#"
1757 * The "hosts" to intercept and display CGI pages.
1758 * First one is a hostname only, second one can specify host and path.
1761 * 1) Do not specify the http: prefix
1762 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1763 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1765 #define CGI_SITE_1_HOST "p.p"
1766 #define CGI_SITE_2_HOST "config.privoxy.org"
1767 #define CGI_SITE_2_PATH ""
1770 * The prefix for CGI pages. Written out in generated HTML.
1771 * INCLUDES the trailing slash.
1773 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1779 #endif /* ndef PROJECT_H_INCLUDED */