Remove FEATURE_COOKIE_JAR.
[privoxy.git] / project.h
1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 /** Version string. */
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.116 2008/05/20 16:05:02 fabiankeil Exp $"
5 /*********************************************************************
6  *
7  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
8  *
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).
12  *
13  * Copyright   :  Written by and Copyright (C) 2001-2008 the SourceForge
14  *                Privoxy team. http://www.privoxy.org/
15  *
16  *                Based on the Internet Junkbuster originally written
17  *                by and Copyright (C) 1997 Anonymous Coders and
18  *                Junkbusters Corporation.  http://www.junkbusters.com
19  *
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.
25  *
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.
31  *
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.
37  *
38  * Revisions   :
39  *    $Log: project.h,v $
40  *    Revision 1.116  2008/05/20 16:05:02  fabiankeil
41  *    Move parsers structure definition from project.h to parsers.h.
42  *
43  *    Revision 1.115  2008/05/19 16:57:20  fabiankeil
44  *    Declare all members of the parsers structure immutable.
45  *
46  *    Revision 1.114  2008/04/11 16:35:39  fabiankeil
47  *    Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
48  *
49  *    Revision 1.113  2008/04/10 14:41:04  fabiankeil
50  *    Ditch url_spec's path member now that it's no longer used.
51  *
52  *    Revision 1.112  2008/04/06 15:18:34  fabiankeil
53  *    Oh well, rename the --enable-pcre-host-patterns option to
54  *    --enable-extended-host-patterns as it's not really PCRE syntax.
55  *
56  *    Revision 1.111  2008/04/06 14:54:26  fabiankeil
57  *    Use PCRE syntax in host patterns when configured
58  *    with --enable-pcre-host-patterns.
59  *
60  *    Revision 1.110  2008/03/29 12:13:46  fabiankeil
61  *    Remove send-wafer and send-vanilla-wafer actions.
62  *
63  *    Revision 1.109  2008/03/28 15:13:41  fabiankeil
64  *    Remove inspect-jpegs action.
65  *
66  *    Revision 1.108  2008/03/27 18:27:36  fabiankeil
67  *    Remove kill-popups action.
68  *
69  *    Revision 1.107  2008/03/26 18:07:08  fabiankeil
70  *    Add hostname directive. Closes PR#1918189.
71  *
72  *    Revision 1.106  2008/03/24 11:21:03  fabiankeil
73  *    Share the action settings for multiple patterns in the same
74  *    section so we waste less memory for gigantic block lists
75  *    (and load them slightly faster). Reported by Franz Schwartau.
76  *
77  *    Revision 1.105  2008/03/21 11:16:27  fabiankeil
78  *    Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
79  *
80  *    Revision 1.104  2008/03/04 18:30:40  fabiankeil
81  *    Remove the treat-forbidden-connects-like-blocks action. We now
82  *    use the "blocked" page for forbidden CONNECT requests by default.
83  *
84  *    Revision 1.103  2008/03/01 14:00:45  fabiankeil
85  *    Let the block action take the reason for the block
86  *    as argument and show it on the "blocked" page.
87  *
88  *    Revision 1.102  2008/02/03 13:46:14  fabiankeil
89  *    Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
90  *
91  *    Revision 1.101  2007/12/07 18:29:23  fabiankeil
92  *    Remove now-obsolete csp member x_forwarded.
93  *
94  *    Revision 1.100  2007/09/02 13:42:11  fabiankeil
95  *    - Allow port lists in url patterns.
96  *    - Ditch unused url_spec member pathlen.
97  *
98  *    Revision 1.99  2007/07/21 11:51:36  fabiankeil
99  *    As Hal noticed, checking dispatch_cgi() as the last cruncher
100  *    looks like a bug if CGI requests are blocked unintentionally,
101  *    so don't do it unless the user enabled the new config option
102  *    "allow-cgi-request-crunching".
103  *
104  *    Revision 1.98  2007/07/14 07:31:26  fabiankeil
105  *    Add new csp->content_type flag (CT_DECLARED).
106  *
107  *    Revision 1.97  2007/05/27 12:38:08  fabiankeil
108  *    - Remove some left-overs from the switch to dedicated header filters.
109  *    - Adjust "X-Filter: No" to disable dedicated header filters.
110  *    - Prepare for forward-override{}
111  *
112  *    Revision 1.96  2007/05/14 10:41:15  fabiankeil
113  *    Ditch the csp member cookie_list[] which isn't used anymore.
114  *
115  *    Revision 1.95  2007/04/30 15:02:19  fabiankeil
116  *    Introduce dynamic pcrs jobs that can resolve variables.
117  *
118  *    Revision 1.94  2007/04/15 16:39:21  fabiankeil
119  *    Introduce tags as alternative way to specify which
120  *    actions apply to a request. At the moment tags can be
121  *    created based on client and server headers.
122  *
123  *    Revision 1.93  2007/03/20 15:16:34  fabiankeil
124  *    Use dedicated header filter actions instead of abusing "filter".
125  *    Replace "filter-client-headers" and "filter-client-headers"
126  *    with "server-header-filter" and "client-header-filter".
127  *
128  *    Revision 1.92  2007/03/17 15:20:05  fabiankeil
129  *    New config option: enforce-blocks.
130  *
131  *    Revision 1.91  2007/03/05 13:28:03  fabiankeil
132  *    Add some CSP_FLAGs for the header parsers.
133  *
134  *    Revision 1.90  2007/02/07 10:36:16  fabiankeil
135  *    Add new http_response member to save
136  *    the reason why the response was generated.
137  *
138  *    Revision 1.89  2007/01/27 13:09:16  fabiankeil
139  *    Add new config option "templdir" to
140  *    change the templates directory.
141  *
142  *    Revision 1.88  2007/01/25 13:36:59  fabiankeil
143  *    Add csp->error_message for failure reasons
144  *    that should be embedded into the CGI pages.
145  *
146  *    Revision 1.87  2007/01/01 19:36:37  fabiankeil
147  *    Integrate a modified version of Wil Mahan's
148  *    zlib patch (PR #895531).
149  *
150  *    Revision 1.86  2006/12/31 17:56:37  fabiankeil
151  *    Added config option accept-intercepted-requests
152  *    and disabled it by default.
153  *
154  *    Revision 1.85  2006/12/31 15:03:31  fabiankeil
155  *    Fix gcc43 compiler warnings and a comment.
156  *
157  *    Revision 1.84  2006/12/21 12:57:48  fabiankeil
158  *    Add config option "split-large-forms"
159  *    to work around the browser bug reported
160  *    in BR #1570678.
161  *
162  *    Revision 1.83  2006/12/06 19:26:29  fabiankeil
163  *    Moved HTTP snipplets into jcc.c. They aren't
164  *    used anywhere else.
165  *
166  *    Revision 1.82  2006/09/20 15:50:31  fabiankeil
167  *    Doubled size of HOSTENT_BUFFER_SIZE to mask
168  *    problems with gethostbyname_r and some
169  *    /etc/hosts configurations. Only a workaround
170  *    until we get the real fix ready.
171  *    Thanks FĂ©lix Rauch for reporting.
172  *
173  *    Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
174  *
175  *    Revision 1.81  2006/09/06 13:03:04  fabiankeil
176  *    Respond with 400 and a short text message
177  *    if the client tries to use Privoxy as FTP proxy.
178  *
179  *    Revision 1.80  2006/09/06 10:43:32  fabiankeil
180  *    Added config option enable-remote-http-toggle
181  *    to specify if Privoxy should recognize special
182  *    headers (currently only X-Filter) to change its
183  *    behaviour. Disabled by default.
184  *
185  *    Revision 1.79  2006/09/06 09:23:37  fabiankeil
186  *    Make number of retries in case of forwarded-connect problems
187  *    a config file option (forwarded-connect-retries) and use 0 as
188  *    default.
189  *
190  *    Revision 1.78  2006/08/31 16:25:06  fabiankeil
191  *    Work around a buffer overflow that caused Privoxy to
192  *    segfault if too many trusted referrers were used. Good
193  *    enough for now, but should be replaced with a real
194  *    solution after the next release.
195  *
196  *    Revision 1.77  2006/08/21 12:50:51  david__schmidt
197  *    Formatting cleanup
198  *
199  *    Revision 1.76  2006/08/14 08:25:19  fabiankeil
200  *    Split filter-headers{} into filter-client-headers{}
201  *    and filter-server-headers{}.
202  *    Added parse_header_time() to share some code.
203  *    Replaced timegm() with mktime().
204  *
205  *    Revision 1.75  2006/08/03 02:46:41  david__schmidt
206  *    Incorporate Fabian Keil's patch work:\r *    http://www.fabiankeil.de/sourcecode/privoxy/
207  *
208  *    Revision 1.74  2006/07/18 14:48:47  david__schmidt
209  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
210  *    with what was really the latest development (the v_3_0_branch branch)
211  *
212  *    Revision 1.72.2.7  2006/01/29 23:10:56  david__schmidt
213  *    Multiple filter file support
214  *
215  *    Revision 1.72.2.6  2004/10/03 12:53:46  david__schmidt
216  *    Add the ability to check jpeg images for invalid
217  *    lengths of comment blocks.  Defensive strategy
218  *    against the exploit:
219  *       Microsoft Security Bulletin MS04-028
220  *       Buffer Overrun in JPEG Processing (GDI+) Could
221  *       Allow Code Execution (833987)
222  *    Enabled with +inspect-jpegs in actions files.
223  *
224  *    Revision 1.72.2.5  2004/01/30 15:29:29  oes
225  *    Updated the copyright note
226  *
227  *    Revision 1.72.2.4  2004/01/13 16:12:14  oes
228  *    Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
229  *
230  *    Revision 1.72.2.3  2003/03/11 11:54:37  oes
231  *    Introduced RC_FLAG_* flags for use in child process return code
232  *
233  *    Revision 1.72.2.2  2002/11/28 18:15:44  oes
234  *    Added flag to each cgi_dispatcher that allows or denies
235  *    external linking and removed const qualifier from
236  *    struct list_entry.str.
237  *
238  *    Revision 1.72.2.1  2002/08/10 11:25:18  oes
239  *    - Include config.h for access to config data
240  *    - Include <pcre*.h> depending on where they are
241  *
242  *    Revision 1.72  2002/05/14 21:35:49  oes
243  *    Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
244  *    because of split in user-manual
245  *
246  *    Revision 1.71  2002/05/12 21:39:36  jongfoster
247  *    - Adding Doxygen-style comments to structures and #defines.
248  *
249  *    Revision 1.70  2002/05/12 16:05:50  jongfoster
250  *    Fixing ACTION_MASK_ALL to be unsigned long rather than
251  *    just unsigned int.  I don't know if anyone is porting
252  *    Privoxy to 16-bit platforms, but if so, +limit-connect
253  *    wouldn't have worked because of this bug.
254  *
255  *    Revision 1.69  2002/05/08 16:00:16  oes
256  *    Added size member to struct iob, so it can
257  *    be alloced larger than needed.
258  *
259  *    Revision 1.68  2002/04/26 12:56:00  oes
260  *    Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
261  *
262  *    Revision 1.67  2002/04/24 02:12:43  oes
263  *     - Jon's multiple AF patch:
264  *       - Make csp->actions_list an array
265  *       - #define MAX_AF_FILES
266  *     - Moved CGI_PARAM_LEN_MAX (500) here
267  *
268  *    Revision 1.66  2002/04/15 19:06:43  jongfoster
269  *    Typos
270  *
271  *    Revision 1.65  2002/04/04 00:36:36  gliptak
272  *    always use pcre for matching
273  *
274  *    Revision 1.64  2002/04/03 22:28:03  gliptak
275  *    Removed references to gnu_regex
276  *
277  *    Revision 1.63  2002/03/31 17:19:00  jongfoster
278  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
279  *
280  *    Revision 1.62  2002/03/26 22:48:49  swa
281  *    new homepage url
282  *
283  *    Revision 1.61  2002/03/26 22:29:55  swa
284  *    we have a new homepage!
285  *
286  *    Revision 1.60  2002/03/24 15:52:17  jongfoster
287  *    Changing CGI URL prefixes for new name
288  *
289  *    Revision 1.59  2002/03/24 15:23:33  jongfoster
290  *    Name changes
291  *
292  *    Revision 1.58  2002/03/24 13:25:43  swa
293  *    name change related issues
294  *
295  *    Revision 1.57  2002/03/16 20:28:34  oes
296  *    Added descriptions to the filters so users will know what they select in the cgi editor
297  *
298  *    Revision 1.56  2002/03/13 20:27:30  oes
299  *    Fixing bug with CT_TABOO
300  *
301  *    Revision 1.55  2002/03/12 01:42:50  oes
302  *    Introduced modular filters
303  *
304  *    Revision 1.54  2002/03/09 20:03:52  jongfoster
305  *    - Making various functions return int rather than size_t.
306  *      (Undoing a recent change).  Since size_t is unsigned on
307  *      Windows, functions like read_socket that return -1 on
308  *      error cannot return a size_t.
309  *
310  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
311  *      crashes, and also frequently caused JB to jump to 100%
312  *      CPU and stay there.  (Because it thought it had just
313  *      read ((unsigned)-1) == 4Gb of data...)
314  *
315  *    - The signature of write_socket has changed, it now simply
316  *      returns success=0/failure=nonzero.
317  *
318  *    - Trying to get rid of a few warnings --with-debug on
319  *      Windows, I've introduced a new type "jb_socket".  This is
320  *      used for the socket file descriptors.  On Windows, this
321  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
322  *      an int.  The error value can't be -1 any more, so it's
323  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
324  *      Windows it maps to the #define INVALID_SOCKET.)
325  *
326  *    - The signature of bind_port has changed.
327  *
328  *    Revision 1.53  2002/03/08 16:48:55  oes
329  *    Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
330  *
331  *    Revision 1.52  2002/03/07 03:46:17  oes
332  *    Fixed compiler warnings
333  *
334  *    Revision 1.51  2002/03/05 04:52:42  oes
335  *    Deleted non-errlog debugging code
336  *
337  *    Revision 1.50  2002/03/04 19:32:07  oes
338  *    Changed default port to 8118
339  *
340  *    Revision 1.49  2002/03/04 18:28:55  oes
341  *    Deleted PID_FILE_NAME
342  *
343  *    Revision 1.48  2002/03/03 14:50:40  oes
344  *    Fixed CLF logging: Added ocmd member for client's request to struct http_request
345  *
346  *    Revision 1.47  2002/02/20 23:15:13  jongfoster
347  *    Parsing functions now handle out-of-memory gracefully by returning
348  *    an error code.
349  *
350  *    Revision 1.46  2002/01/17 21:06:09  jongfoster
351  *    Now #defining the URLs of the config interface
352  *
353  *    Minor changes to struct http_request and struct url_spec due to
354  *    standardizing that struct http_request is used to represent a URL, and
355  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
356  *    represented as seperate variables and a partially-filled-in url_spec).
357  *
358  *    Revision 1.45  2002/01/09 14:33:27  oes
359  *    Added HOSTENT_BUFFER_SIZE
360  *
361  *    Revision 1.44  2001/12/30 14:07:32  steudten
362  *    - Add signal handling (unix)
363  *    - Add SIGHUP handler (unix)
364  *    - Add creation of pidfile (unix)
365  *    - Add action 'top' in rc file (RH)
366  *    - Add entry 'SIGNALS' to manpage
367  *    - Add exit message to logfile (unix)
368  *
369  *    Revision 1.43  2001/11/22 21:57:51  jongfoster
370  *    Making action_spec->flags into an unsigned long rather than just an
371  *    unsigned int.
372  *    Adding ACTION_NO_COOKIE_KEEP
373  *
374  *    Revision 1.42  2001/11/05 21:42:41  steudten
375  *    Include DBG() macro.
376  *
377  *    Revision 1.41  2001/10/28 19:12:06  jongfoster
378  *    Adding ijb_toupper()
379  *
380  *    Revision 1.40  2001/10/26 17:40:47  oes
381  *    Moved ijb_isspace and ijb_tolower to project.h
382  *    Removed http->user_agent, csp->referrer and csp->accept_types
383  *
384  *    Revision 1.39  2001/10/25 03:45:02  david__schmidt
385  *    Adding a (void*) cast to freez() because Visual Age C++ won't expand the
386  *    macro when called with a cast; so moving the cast to the macro def'n
387  *    seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
388  *    doesn't make macro expansion complain.  Hope this works for everyone else
389  *    too...
390  *
391  *    Revision 1.38  2001/10/23 21:19:04  jongfoster
392  *    New error-handling support: jb_err type and JB_ERR_xxx constants
393  *    CGI functions now return a jb_err, and their parameters map is const.
394  *    Support for RUNTIME_FEATUREs to enable/disable config editor
395  *    Adding a few comments
396  *
397  *    Revision 1.37  2001/10/14 22:14:01  jongfoster
398  *    Removing name_length field from struct cgi_dispatcher, as this is
399  *    now calculated at runtime from the "name" field.
400  *
401  *    Revision 1.36  2001/10/10 16:45:15  oes
402  *    Added LIMIT_CONNECT action and string
403  *    Fixed HTTP message line termination
404  *    Added CFORBIDDEN HTTP message
405  *
406  *    Revision 1.35  2001/10/07 18:06:43  oes
407  *    Added status member to struct http_request
408  *
409  *    Revision 1.34  2001/10/07 15:45:25  oes
410  *    Added url member to struct http_request and commented all
411  *      members
412  *
413  *    Added CT_TABOO
414  *
415  *    Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
416  *
417  *    Replaced struct client_state members rejected,
418  *      force, active and toggled_on with "flags" bitmap.
419  *
420  *    Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
421  *
422  *    Added buffer_limit to struct configuration_spec
423  *
424  *    Revision 1.33  2001/09/20 13:30:08  steudten
425  *
426  *    Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
427  *    Last case will set z to NULL in free(z) and thats bad..
428  *
429  *    Revision 1.32  2001/09/16 23:02:51  jongfoster
430  *    Fixing warning
431  *
432  *    Revision 1.31  2001/09/16 13:20:29  jongfoster
433  *    Rewrite of list library.  Now has seperate header and list_entry
434  *    structures.  Also added a large sprinking of assert()s to the list
435  *    code.
436  *
437  *    Revision 1.30  2001/09/13 23:52:00  jongfoster
438  *    Support for both static and dynamically generated CGI pages
439  *
440  *    Revision 1.29  2001/09/13 23:29:43  jongfoster
441  *    Defining FORWARD_SPEC_INITIALIZER
442  *
443  *    Revision 1.28  2001/09/13 23:05:50  jongfoster
444  *    Changing the string paramater to the header parsers a "const".
445  *
446  *    Revision 1.27  2001/08/05 16:06:20  jongfoster
447  *    Modifiying "struct map" so that there are now separate header and
448  *    "map_entry" structures.  This means that functions which modify a
449  *    map no longer need to return a pointer to the modified map.
450  *    Also, it no longer reverses the order of the entries (which may be
451  *    important with some advanced template substitutions).
452  *
453  *    Revision 1.26  2001/07/30 22:08:36  jongfoster
454  *    Tidying up #defines:
455  *    - All feature #defines are now of the form FEATURE_xxx
456  *    - Permanently turned off WIN_GUI_EDIT
457  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
458  *
459  *    Revision 1.25  2001/07/29 18:43:08  jongfoster
460  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
461  *    ANSI C rules.
462  *
463  *    Revision 1.24  2001/07/25 17:20:27  oes
464  *    Introduced http->user_agent
465  *
466  *    Revision 1.23  2001/07/18 12:32:23  oes
467  *    - Added ACTION_STRING_DEANIMATE
468  *    - moved #define freez from jcc.h to project.h
469  *
470  *    Revision 1.22  2001/07/15 17:51:41  jongfoster
471  *    Renaming #define STATIC to STATIC_PCRE
472  *
473  *    Revision 1.21  2001/07/13 14:03:19  oes
474  *     - Reorganized regex header inclusion and #defines to
475  *       comply to the scheme in configure.in
476  *     - Added csp->content_type and its CT_* keys
477  *     - Added ACTION_DEANIMATE
478  *     - Removed all #ifdef PCRS
479  *
480  *    Revision 1.20  2001/06/29 21:45:41  oes
481  *    Indentation, CRLF->LF, Tab-> Space
482  *
483  *    Revision 1.19  2001/06/29 13:33:36  oes
484  *    - Improved comments
485  *    - Introduced http_request.host_ip_addr_str
486  *    - Introduced http_response.head_length
487  *    - Introduced config.my_ip_addr_str, config.my_hostname,
488  *      config.admin_address and config.proxy_info_url
489  *    - Removed config.proxy_args_header and config.proxy_args_trailer,
490  *      renamed config.proxy_args_invocation to config.proxy_args
491  *    - Removed HTML snipplets and GIFs
492  *    - Removed logentry from cancelled commit
493  *
494  *    Revision 1.18  2001/06/09 10:57:39  jongfoster
495  *    Adding definition of BUFFER_SIZE.
496  *    Changing struct cgi_dispatcher to use "const" strings.
497  *
498  *    Revision 1.17  2001/06/07 23:15:09  jongfoster
499  *    Merging ACL and forward files into config file.
500  *    Moving struct gateway members into struct forward_spec
501  *    Removing config->proxy_args_gateways
502  *    Cosmetic: Adding a few comments
503  *
504  *    Revision 1.16  2001/06/04 18:31:58  swa
505  *    files are now prefixed with either `confdir' or `logdir'.
506  *    `make redhat-dist' replaces both entries confdir and logdir
507  *    with redhat values
508  *
509  *    Revision 1.15  2001/06/04 11:28:53  swa
510  *    redirect did not work due to missing /
511  *
512  *    Revision 1.14  2001/06/03 11:03:48  oes
513  *    Added struct map,
514  *    added struct http_response,
515  *    changed struct interceptors to struct cgi_dispatcher,
516  *    moved HTML stuff to cgi.h
517  *
518  *    Revision 1.13  2001/06/01 20:05:36  jongfoster
519  *    Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
520  *    constant, and removed csp->tinygif.
521  *
522  *    Revision 1.12  2001/06/01 18:49:17  jongfoster
523  *    Replaced "list_share" with "list" - the tiny memory gain was not
524  *    worth the extra complexity.
525  *
526  *    Revision 1.11  2001/06/01 10:32:47  oes
527  *    Added constants for anchoring selection bitmap
528  *
529  *    Revision 1.10  2001/05/31 21:33:53  jongfoster
530  *    Changes for new actions file, replacing permissionsfile
531  *    and parts of the config file.  Also added support for
532  *    list_shared.
533  *
534  *    Revision 1.9  2001/05/31 17:32:31  oes
535  *
536  *     - Enhanced domain part globbing with infix and prefix asterisk
537  *       matching and optional unanchored operation
538  *
539  *    Revision 1.8  2001/05/29 20:09:15  joergs
540  *    HTTP_REDIRECT_TEMPLATE fixed.
541  *
542  *    Revision 1.7  2001/05/29 09:50:24  jongfoster
543  *    Unified blocklist/imagelist/actionslist.
544  *    File format is still under discussion, but the internal changes
545  *    are (mostly) done.
546  *
547  *    Also modified interceptor behaviour:
548  *    - We now intercept all URLs beginning with one of the following
549  *      prefixes (and *only* these prefixes):
550  *        * http://i.j.b/
551  *        * http://ijbswa.sf.net/config/
552  *        * http://ijbswa.sourceforge.net/config/
553  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
554  *    - Internal changes so that intercepted and fast redirect pages
555  *      are not replaced with an image.
556  *    - Interceptors now have the option to send a binary page direct
557  *      to the client. (i.e. ijb-send-banner uses this)
558  *    - Implemented show-url-info interceptor.  (Which is why I needed
559  *      the above interceptors changes - a typical URL is
560  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
561  *      The previous mechanism would not have intercepted that, and
562  *      if it had been intercepted then it then it would have replaced
563  *      it with an image.)
564  *
565  *    Revision 1.6  2001/05/27 22:17:04  oes
566  *
567  *    - re_process_buffer no longer writes the modified buffer
568  *      to the client, which was very ugly. It now returns the
569  *      buffer, which it is then written by chat.
570  *
571  *    - content_length now adjusts the Content-Length: header
572  *      for modified documents rather than crunch()ing it.
573  *      (Length info in csp->content_length, which is 0 for
574  *      unmodified documents)
575  *
576  *    - For this to work, sed() is called twice when filtering.
577  *
578  *    Revision 1.5  2001/05/26 00:28:36  jongfoster
579  *    Automatic reloading of config file.
580  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
581  *    Most of the global variables have been moved to a new
582  *    struct configuration_spec, accessed through csp->config->globalname
583  *    Most of the globals remaining are used by the Win32 GUI.
584  *
585  *    Revision 1.4  2001/05/22 18:46:04  oes
586  *
587  *    - Enabled filtering banners by size rather than URL
588  *      by adding patterns that replace all standard banner
589  *      sizes with the "Junkbuster" gif to the re_filterfile
590  *
591  *    - Enabled filtering WebBugs by providing a pattern
592  *      which kills all 1x1 images
593  *
594  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
595  *      which is selected by the (nonstandard and therefore
596  *      capital) letter 'U' in the option string.
597  *      It causes the quantifiers to be ungreedy by default.
598  *      Appending a ? turns back to greedy (!).
599  *
600  *    - Added a new interceptor ijb-send-banner, which
601  *      sends back the "Junkbuster" gif. Without imagelist or
602  *      MSIE detection support, or if tinygif = 1, or the
603  *      URL isn't recognized as an imageurl, a lame HTML
604  *      explanation is sent instead.
605  *
606  *    - Added new feature, which permits blocking remote
607  *      script redirects and firing back a local redirect
608  *      to the browser.
609  *      The feature is conditionally compiled, i.e. it
610  *      can be disabled with --disable-fast-redirects,
611  *      plus it must be activated by a "fast-redirects"
612  *      line in the config file, has its own log level
613  *      and of course wants to be displayed by show-proxy-args
614  *      Note: Boy, all the #ifdefs in 1001 locations and
615  *      all the fumbling with configure.in and acconfig.h
616  *      were *way* more work than the feature itself :-(
617  *
618  *    - Because a generic redirect template was needed for
619  *      this, tinygif = 3 now uses the same.
620  *
621  *    - Moved GIFs, and other static HTTP response templates
622  *      to project.h
623  *
624  *    - Some minor fixes
625  *
626  *    - Removed some >400 CRs again (Jon, you really worked
627  *      a lot! ;-)
628  *
629  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
630  *    Version 2.9.4 checkin.
631  *    - Merged popupfile and cookiefile, and added control over PCRS
632  *      filtering, in new "actionsfile".
633  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
634  *      file error you now get a message box (in the Win32 GUI) rather
635  *      than the program exiting with no explanation.
636  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
637  *      skipping.
638  *    - Removed tabs from "config"
639  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
640  *    - Bumped up version number.
641  *
642  *    Revision 1.2  2001/05/17 23:01:01  oes
643  *     - Cleaned CRLF's from the sources and related files
644  *
645  *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
646  *    Initial import of version 2.9.3 source tree
647  *
648  *
649  *********************************************************************/
650 \f
651
652 /* Declare struct FILE for vars and funcs. */
653 #include <stdio.h>
654
655 /* Need time_t for file_list */
656 #include <time.h>
657 /* Needed for pcre choice */
658 #include "config.h"
659
660 /*
661  * Include appropriate regular expression libraries.
662  * Note that pcrs and pcre (native) are needed for cgi
663  * and are included anyway.
664  */
665
666 #ifdef STATIC_PCRE
667 #  include "pcre.h"
668 #else
669 #  ifdef PCRE_H_IN_SUBDIR
670 #    include <pcre/pcre.h>
671 #  else
672 #    include <pcre.h>
673 #  endif
674 #endif
675
676 #ifdef STATIC_PCRS
677 #  include "pcrs.h"
678 #else
679 #  include <pcrs.h>
680 #endif
681
682 #ifdef STATIC_PCRE
683 #  include "pcreposix.h"
684 #else
685 #  ifdef PCRE_H_IN_SUBDIR
686 #    include <pcre/pcreposix.h>
687 #  else
688 #    include <pcreposix.h>
689 #  endif
690 #endif
691
692 #ifdef AMIGA
693 #include "amiga.h"
694 #endif /* def AMIGA */
695
696 #ifdef _WIN32
697 /*
698  * I don't want to have to #include all this just for the declaration
699  * of SOCKET.  However, it looks like we have to...
700  */
701 #ifndef STRICT
702 #define STRICT
703 #endif
704 #include <windows.h>
705 #endif
706
707
708 #ifdef __cplusplus
709 extern "C" {
710 #endif
711
712 #ifdef _WIN32
713
714 typedef SOCKET jb_socket;
715
716 #define JB_INVALID_SOCKET INVALID_SOCKET
717
718 #else /* ndef _WIN32 */
719
720 /**
721  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
722  * make it an unsigned.
723  */
724 typedef int jb_socket;
725
726 /**
727  * The error value used for variables of type jb_socket.  On UNIX this
728  * is -1, however Microsoft decided to make socket handles unsigned, so
729  * they use a different value.
730  */
731
732 #define JB_INVALID_SOCKET (-1)
733
734 #endif /* ndef _WIN32 */
735
736
737 /**
738  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
739  * series of errors.
740  */
741 typedef int jb_err;
742
743 #define JB_ERR_OK         0 /**< Success, no error                        */
744 #define JB_ERR_MEMORY     1 /**< Out of memory                            */
745 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters        */
746 #define JB_ERR_FILE       3 /**< Error opening, reading or writing a file */
747 #define JB_ERR_PARSE      4 /**< Error parsing file                       */
748 #define JB_ERR_MODIFIED   5 /**< File has been modified outside of the  
749                                  CGI actions editor.                      */
750 #define JB_ERR_COMPRESS   6 /**< Error on decompression                   */
751
752 /**
753  * This macro is used to free a pointer that may be NULL.
754  * It also sets the variable to NULL after it's been freed.
755  * The paramater should be a simple variable without side effects.
756  */
757 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
758
759
760 /**
761  * Fix a problem with Solaris.  There should be no effect on other
762  * platforms.
763  *
764  * Solaris's isspace() is a macro which uses it's argument directly
765  * as an array index.  Therefore we need to make sure that high-bit
766  * characters generate +ve values, and ideally we also want to make
767  * the argument match the declared parameter type of "int".
768  *
769  * Note: Remember to #include <ctype.h> if you use these macros.
770  */
771 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
772 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
773 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))  
774
775 /**
776  * Use for statically allocated buffers if you have no other choice.
777  * Remember to check the length of what you write into the buffer
778  * - we don't want any buffer overflows!
779  */
780 #define BUFFER_SIZE 5000
781
782 /**
783  * Max length of CGI parameters (arbitrary limit).
784  */
785 #define CGI_PARAM_LEN_MAX 500
786
787 /**
788  * Buffer size for capturing struct hostent data in the
789  * gethostby(name|addr)_r library calls. Since we don't
790  * loop over gethostbyname_r, the buffer must be sufficient
791  * to accomodate multiple IN A RRs, as used in DNS round robin
792  * load balancing. W3C's wwwlib uses 1K, so that should be
793  * good enough for us, too.
794  */
795 /**
796  * XXX: Temporary doubled, for some configurations
797  * 1K is still too small and we didn't get the
798  * real fix ready for inclusion.
799  */
800 #define HOSTENT_BUFFER_SIZE 2048
801
802 /**
803  * Do not use.  Originally this was so that you can
804  * say "while (FOREVER) { ...do something... }".
805  * However, this gives a warning with some compilers (e.g. VC++).
806  * Instead, use "for (;;) { ...do something... }".
807  */
808 #define FOREVER 1
809
810 /**
811  * Default IP address to listen on, as a string.
812  * Set to "127.0.0.1".
813  */
814 #define HADDR_DEFAULT   "127.0.0.1"
815
816 /**
817  * Default port to listen on, as a number.
818  * Set to 8118.
819  */
820 #define HADDR_PORT      8118
821
822
823 /* Forward def for struct client_state */
824 struct configuration_spec;
825
826
827 /**
828  * Entry in a linked list of strings.
829  */
830 struct list_entry
831 {
832    /**
833     * The string pointer. It must point to a dynamically malloc()ed
834     * string or be NULL for the list functions to work. In the latter
835     * case, just be careful next time you iterate through the list in
836     * your own code.
837     */
838    char *str;
839    
840    /** Next entry in the linked list, or NULL if no more. */
841    struct list_entry *next;
842 };
843
844 /**
845  * A header for a linked list of strings.
846  */
847 struct list
848 {
849    /** First entry in the list, or NULL if the list is empty. */
850    struct list_entry *first;
851
852    /** Last entry in the list, or NULL if the list is empty. */
853    struct list_entry *last;
854 };
855
856
857 /**
858  * An entry in a map.  This is a name=value pair.
859  */
860 struct map_entry
861 {
862    /** The key for the map. */
863    const char *name;
864    /** The value associated with that key. */
865    const char *value;
866    /** The next map entry, or NULL if none. */
867    struct map_entry *next;
868 };
869
870 /**
871  * A map from a string to another string.
872  * This is used for the paramaters passed in a HTTP GET request, and
873  * to store the exports when the CGI interface is filling in a template.
874  */
875 struct map
876 {
877    /** The first map entry, or NULL if the map is empty. */
878    struct map_entry *first;
879    /** The last map entry, or NULL if the map is empty. */
880    struct map_entry *last;
881 };
882
883
884 /**
885  * A HTTP request.  This includes the method (GET, POST) and
886  * the parsed URL.
887  *
888  * This is also used whenever we want to match a URL against a
889  * URL pattern.  This always contains the URL to match, and never
890  * a URL pattern.  (See struct url_spec).
891  */
892 struct http_request
893 {
894    char *cmd;      /**< Whole command line: method, URL, Version */
895    char *ocmd;     /**< Backup of original cmd for CLF logging */
896    char *gpc;      /**< HTTP method: GET, POST, ... */
897    char *url;      /**< The URL */
898    char *ver;      /**< Protocol version */
899    int status;     /**< HTTP Status */
900
901    char *host;     /**< Host part of URL */
902    int   port;     /**< Port of URL or 80 (default) */
903    char *path;     /**< Path of URL */
904    char *hostport; /**< host[:port] */
905    int   ssl;      /**< Flag if protocol is https */
906
907    char *host_ip_addr_str; /**< String with dotted decimal representation
908                                 of host's IP. NULL before connect_to() */
909
910    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
911    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
912    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
913 };
914
915 /**
916  * Reasons for generating a http_response instead of delivering
917  * the requested resource. Mostly ordered the way they are checked
918  * for in chat().
919  */
920 #define RSP_REASON_UNSUPPORTED        1
921 #define RSP_REASON_BLOCKED            2
922 #define RSP_REASON_UNTRUSTED          3
923 #define RSP_REASON_REDIRECTED         4
924 #define RSP_REASON_CGI_CALL           5
925 #define RSP_REASON_NO_SUCH_DOMAIN     6
926 #define RSP_REASON_FORWARDING_FAILED  7
927 #define RSP_REASON_CONNECT_FAILED     8
928 #define RSP_REASON_OUT_OF_MEMORY      9
929 #define RSP_REASON_INTERNAL_ERROR     10
930
931 /**
932  * Response generated by CGI, blocker, or error handler
933  */
934 struct http_response
935 {
936   char  *status;          /**< HTTP status (string). */
937   struct list headers[1]; /**< List of header lines. */
938   char  *head;            /**< Formatted http response head. */
939   size_t head_length;     /**< Length of http response head. */
940   char  *body;            /**< HTTP document body. */
941   size_t content_length;  /**< Length of body, REQUIRED if binary body. */
942   int    is_static;       /**< Nonzero if the content will never change and
943                                should be cached by the browser (e.g. images). */
944   int reason;             /**< Why the response was generated in the first place. */
945 };
946
947 /**
948  * A URL or a tag pattern.
949  */
950 struct url_spec
951 {
952    /** The string which was parsed to produce this url_spec.
953        Used for debugging or display only.  */
954    char  *spec;
955
956 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
957    regex_t *host_regex;/**< Regex for host matching                          */
958 #else
959    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
960    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
961    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
962    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
963 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
964
965    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
966
967    regex_t *preg;      /**< Regex for matching path part                      */
968    regex_t *tag_regex; /**< Regex for matching tags                           */
969 };
970
971 /**
972  * If you declare a static url_spec, this is the value to initialize it to zero.
973  */
974 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
975 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
976 #else
977 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
978 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
979
980 /**
981  * Constant for host part matching in URLs.  If set, indicates that the start of
982  * the pattern must match the start of the URL.  E.g. this is not set for the
983  * pattern ".example.com", so that it will match both "example.com" and
984  * "www.example.com".  It is set for the pattern "example.com", which makes it
985  * match "example.com" only, not "www.example.com".
986  */
987 #define ANCHOR_LEFT  1
988
989 /**
990  * Constant for host part matching in URLs.  If set, indicates that the end of
991  * the pattern must match the end of the URL.  E.g. this is not set for the
992  * pattern "ad.", so that it will match any host called "ad", irrespective
993  * of how many subdomains are in the fully-qualified domain name.
994  */
995 #define ANCHOR_RIGHT 2
996
997
998 /**
999  * An I/O buffer.  Holds a string which can be appended to, and can have data
1000  * removed from the beginning.
1001  */
1002 struct iob
1003 {
1004    char *buf;    /**< Start of buffer        */
1005    char *cur;    /**< Start of relevant data */
1006    char *eod;    /**< End of relevant data   */
1007    size_t size;  /**< Size as malloc()ed     */
1008 };
1009
1010
1011 /**
1012  * Return the number of bytes in the I/O buffer associated with the passed
1013  * client_state pointer.
1014  * May be zero.
1015  */
1016 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1017
1018
1019 /**
1020  * Remove any data in the I/O buffer associated with the passed
1021  * client_state pointer.
1022  */
1023 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1024
1025 /* Bits for csp->content_type bitmask: */
1026 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
1027 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
1028 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
1029
1030 /* Although these are not, strictly speaking, content types
1031  * (they are content encodings), it is simple to handle them
1032  * as such.
1033  */
1034 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
1035 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1036
1037 /**
1038  * Flag to signal that the server declared the content type,
1039  * so we can differentiate between unknown and undeclared
1040  * content types.
1041  */
1042 #define CT_DECLARED 0x0040U
1043
1044 /**
1045  * The mask which includes all actions.
1046  */
1047 #define ACTION_MASK_ALL        (~0UL)
1048
1049 /**
1050  * The most compatible set of actions - i.e. none.
1051  */
1052 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
1053
1054 /** Action bitmap: Block the request. */
1055 #define ACTION_BLOCK                                 0x00000001UL
1056 /** Action bitmap: Deanimate if it's a GIF. */
1057 #define ACTION_DEANIMATE                             0x00000002UL
1058 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1059 #define ACTION_DOWNGRADE                             0x00000004UL
1060 /** Action bitmap: Fast redirects. */
1061 #define ACTION_FAST_REDIRECTS                        0x00000008UL
1062 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
1063 #define ACTION_HIDE_FORWARDED                        0x00000010UL
1064 /** Action bitmap: Hide "From" header. */
1065 #define ACTION_HIDE_FROM                             0x00000020UL
1066 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
1067 #define ACTION_HIDE_REFERER                          0x00000040UL
1068 /** Action bitmap: Hide "User-Agent" and similar headers. */
1069 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
1070 /** Action bitmap: This is an image. */
1071 #define ACTION_IMAGE                                 0x00000100UL
1072 /** Action bitmap: Sets the image blocker. */
1073 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
1074 /** Action bitmap: Prevent compression. */
1075 #define ACTION_NO_COMPRESSION                        0x00000400UL
1076 /** Action bitmap: Change cookies to session only cookies. */
1077 #define ACTION_NO_COOKIE_KEEP                        0x00000800UL
1078 /** Action bitmap: Block rending cookies. */
1079 #define ACTION_NO_COOKIE_READ                        0x00001000UL
1080 /** Action bitmap: Block setting cookies. */
1081 #define ACTION_NO_COOKIE_SET                         0x00002000UL
1082 /** Action bitmap: Override the forward settings in the config file */
1083 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
1084 /** Action bitmap: Block as empty document */
1085 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
1086 /** Action bitmap: Limit CONNECT requests to safe ports. */
1087 #define ACTION_LIMIT_CONNECT                         0x00010000UL
1088 /** Action bitmap: Redirect request. */
1089 #define  ACTION_REDIRECT                             0x00020000UL
1090 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1091 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
1092 /** Action bitmap: Overwrite Content-Type header. */
1093 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
1094 /** Action bitmap: Crunch specified server header. */
1095 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
1096 /** Action bitmap: Crunch specified client header */
1097 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
1098 /** Action bitmap: Enable text mode by force */
1099 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
1100 /** Action bitmap: Enable text mode by force */
1101 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
1102 /** Action bitmap: Enable content-dispostion crunching */
1103 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
1104 /** Action bitmap: Replace or block Last-Modified header */
1105 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
1106 /** Action bitmap: Replace or block Accept-Language header */
1107 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
1108
1109
1110 /** Action string index: How to deanimate GIFs */
1111 #define ACTION_STRING_DEANIMATE             0
1112 /** Action string index: Replacement for "From:" header */
1113 #define ACTION_STRING_FROM                  1
1114 /** Action string index: How to block images */
1115 #define ACTION_STRING_IMAGE_BLOCKER         2
1116 /** Action string index: Replacement for "Referer:" header */
1117 #define ACTION_STRING_REFERER               3
1118 /** Action string index: Replacement for "User-Agent:" header */
1119 #define ACTION_STRING_USER_AGENT            4
1120 /** Action string index: Legal CONNECT ports. */
1121 #define ACTION_STRING_LIMIT_CONNECT         5
1122 /** Action string index: Server headers containing this pattern are crunched*/
1123 #define ACTION_STRING_SERVER_HEADER         6
1124 /** Action string index: Client headers containing this pattern are crunched*/
1125 #define ACTION_STRING_CLIENT_HEADER         7
1126 /** Action string index: Replacement for the "Accept-Language:" header*/
1127 #define ACTION_STRING_LANGUAGE              8
1128 /** Action string index: Replacement for the "Content-Type:" header*/
1129 #define ACTION_STRING_CONTENT_TYPE          9
1130 /** Action string index: Replacement for the "content-dispostion:" header*/
1131 #define ACTION_STRING_CONTENT_DISPOSITION  10
1132 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1133 #define ACTION_STRING_IF_MODIFIED_SINCE    11
1134 /** Action string index: Replacement for the "Last-Modified:" header. */
1135 #define ACTION_STRING_LAST_MODIFIED        12
1136 /** Action string index: Redirect URL */
1137 #define ACTION_STRING_REDIRECT             13
1138 /** Action string index: Decode before redirect? */
1139 #define ACTION_STRING_FAST_REDIRECTS       14
1140 /** Action string index: Overriding forward rule. */
1141 #define ACTION_STRING_FORWARD_OVERRIDE     15
1142 /** Action string index: Reason for the block. */
1143 #define ACTION_STRING_BLOCK                16
1144 /** Number of string actions. */
1145 #define ACTION_STRING_COUNT                17
1146
1147
1148 /* To make the ugly hack in sed easier to understand */
1149 #define CHECK_EVERY_HEADER_REMAINING 0
1150
1151
1152 /** Index into current_action_spec::multi[] for headers to add. */
1153 #define ACTION_MULTI_ADD_HEADER              0
1154 /** Index into current_action_spec::multi[] for content filters to apply. */
1155 #define ACTION_MULTI_FILTER                  1
1156 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1157 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
1158 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1159 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
1160 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1161 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
1162 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1163 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
1164 /** Number of multi-string actions. */
1165 #define ACTION_MULTI_COUNT                   6
1166
1167
1168 /**
1169  * This structure contains a list of actions to apply to a URL.
1170  * It only contains positive instructions - no "-" options.
1171  * It is not used to store the actions list itself, only for
1172  * url_actions() to return the current values.
1173  */
1174 struct current_action_spec
1175 {
1176    /** Actions to apply.  A bit set to "1" means perform the action. */
1177    unsigned long flags;
1178
1179    /**
1180     * Paramaters for those actions that require them.
1181     * Each entry is valid if & only if the corresponding entry in "flags" is
1182     * set.
1183     */
1184    char * string[ACTION_STRING_COUNT];
1185
1186    /** Lists of strings for multi-string actions. */
1187    struct list multi[ACTION_MULTI_COUNT][1];
1188 };
1189
1190
1191 /**
1192  * This structure contains a set of changes to actions.
1193  * It can contain both positive and negative instructions.
1194  * It is used to store an entry in the actions list.
1195  */
1196 struct action_spec
1197 {
1198    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1199    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
1200
1201    /**
1202     * Paramaters for those actions that require them.
1203     * Each entry is valid if & only if the corresponding entry in "flags" is
1204     * set.
1205     */
1206    char * string[ACTION_STRING_COUNT];
1207
1208    /** Lists of strings to remove, for multi-string actions. */
1209    struct list multi_remove[ACTION_MULTI_COUNT][1];
1210
1211    /** If nonzero, remove *all* strings from the multi-string action. */
1212    int         multi_remove_all[ACTION_MULTI_COUNT];
1213
1214    /** Lists of strings to add, for multi-string actions. */
1215    struct list multi_add[ACTION_MULTI_COUNT][1];
1216 };
1217
1218
1219 /**
1220  * This structure is used to store action files.
1221  *
1222  * It contains an URL or tag pattern, and the changes to
1223  * the actions. It's a linked list and should only be
1224  * free'd through unload_actions_file() unless there's
1225  * only a single entry.
1226  */
1227 struct url_actions
1228 {
1229    struct url_spec url[1];     /**< The URL or tag pattern. */
1230
1231    struct action_spec *action; /**< Action settings that might be shared with
1232                                     the list entry before or after the current
1233                                     one and can't be free'd willy nilly. */
1234
1235    struct url_actions *next;   /**< Next action section in file, or NULL. */
1236 };
1237
1238
1239 /*
1240  * Flags for use in csp->flags
1241  */
1242  
1243 /**
1244  * Flag for csp->flags: Set if this client is processing data.
1245  * Cleared when the thread associated with this structure dies.
1246  */
1247 #define CSP_FLAG_ACTIVE     0x01
1248
1249 /**
1250  * Flag for csp->flags: Set if the server's reply is in "chunked"
1251  * transfer encoding
1252  */
1253 #define CSP_FLAG_CHUNKED    0x02
1254
1255 /**
1256  * Flag for csp->flags: Set if this request was enforced, although it would
1257  * normally have been blocked.
1258  */
1259 #define CSP_FLAG_FORCED     0x04
1260
1261 /**
1262  * Flag for csp->flags: Set if any modification to the body was done.
1263  */
1264 #define CSP_FLAG_MODIFIED   0x08
1265
1266 /**
1267  * Flag for csp->flags: Set if request was blocked.
1268  */
1269 #define CSP_FLAG_REJECTED   0x10
1270
1271 /**
1272  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1273  */
1274 #define CSP_FLAG_TOGGLED_ON 0x20
1275
1276 /**
1277  * Flag for csp->flags: Set if adding the 'Connection: close' header
1278  * for the client isn't necessary.
1279  */
1280 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET   0x00000040UL
1281
1282 /**
1283  * Flag for csp->flags: Set if adding the 'Connection: close' header
1284  * for the server isn't necessary.
1285  */
1286 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET   0x00000080UL
1287
1288 /**
1289  * Flag for csp->flags: Signals header parsers whether they
1290  * are parsing server or client headers.
1291  */
1292 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100UL
1293
1294 /**
1295  * Flag for csp->flags: Set if adding the Host: header
1296  * isn't necessary.
1297  */
1298 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200UL
1299
1300 /**
1301  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1302  * XXX: As we now have tags we might as well ditch this.
1303  */
1304 #define CSP_FLAG_NO_FILTERING                  0x00000400UL
1305
1306
1307 /*
1308  * Flags for use in return codes of child processes
1309  */
1310
1311 /**
1312  * Flag for process return code: Set if exiting porcess has been toggled
1313  * during its lifetime.
1314  */
1315 #define RC_FLAG_TOGGLED   0x10
1316
1317 /**
1318  * Flag for process return code: Set if exiting porcess has blocked its
1319  * request.
1320  */
1321 #define RC_FLAG_BLOCKED   0x20
1322
1323 /**
1324  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
1325  * to size an array.
1326  */
1327 #define MAX_AF_FILES 10
1328
1329 /**
1330  * The state of a Privoxy processing thread.
1331  */
1332 struct client_state
1333 {
1334    /** The proxy's configuration */
1335    struct configuration_spec * config;
1336
1337    /** The actions to perform on the current request */
1338    struct current_action_spec  action[1];
1339
1340    /** socket to talk to client (web browser) */
1341    jb_socket cfd;
1342
1343    /** socket to talk to server (web server or proxy) */
1344    jb_socket sfd;
1345
1346    /** Multi-purpose flag container, see CSP_FLAG_* above */
1347    unsigned int flags;
1348
1349    /** Client PC's IP address, as reported by the accept() function.
1350        As a string. */
1351    char *ip_addr_str;
1352    /** Client PC's IP address, as reported by the accept() function.
1353        As a number. */
1354    long  ip_addr_long;
1355
1356    /** The URL that was requested */
1357    struct http_request http[1];
1358
1359    /*
1360     * The final forwarding settings.
1361     * XXX: Currently this is only used for forward-override,
1362     * so we can free the space in sweep.
1363     */
1364    struct forward_spec * fwd;
1365
1366    /** An I/O buffer used for buffering data read from the network */
1367    struct iob iob[1];
1368
1369    /** List of all headers for this request */
1370    struct list headers[1];
1371
1372    /** List of all tags that apply to this request */
1373    struct list tags[1];
1374
1375    /** MIME-Type key, see CT_* above */
1376    unsigned int content_type;
1377
1378    /** Actions files associated with this client */
1379    struct file_list *actions_list[MAX_AF_FILES];
1380
1381    /** pcrs job files. */
1382    struct file_list *rlist[MAX_AF_FILES];
1383
1384    /** Length after content modification. */
1385    size_t content_length;
1386
1387 #ifdef FEATURE_TRUST
1388
1389    /** Trust file. */
1390    struct file_list *tlist;
1391
1392 #endif /* def FEATURE_TRUST */
1393
1394    /**
1395     * Failure reason to embedded in the CGI error page,
1396     * or NULL. Currently only used for socks errors.
1397     */
1398    char *error_message;
1399
1400    /** Next thread in linked list. Only read or modify from the main thread! */
1401    struct client_state *next;
1402 };
1403
1404
1405 /**
1406  * A function to add a header
1407  */
1408 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1409
1410 /**
1411  * A function to process a header
1412  */
1413 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
1414
1415
1416 /**
1417  * List of available CGI functions.
1418  */
1419 struct cgi_dispatcher
1420 {
1421    /** The URL of the CGI, relative to the CGI root. */
1422    const char * const name;
1423
1424    /** The handler function for the CGI */
1425    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1426
1427    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1428    const char * const description;
1429
1430    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1431    int harmless;
1432 };
1433
1434
1435 /**
1436  * A data file used by Privoxy.  Kept in a linked list.
1437  */
1438 struct file_list
1439 {
1440    /**
1441     * This is a pointer to the data structures associated with the file.
1442     * Read-only once the structure has been created.
1443     */
1444    void *f;
1445
1446    /**
1447     * The unloader function.
1448     * Normally NULL.  When we are finished with file (i.e. when we have
1449     * loaded a new one), set to a pointer to an unloader function.
1450     * Unloader will be called by sweep() (called from main loop) when
1451     * all clients using this file are done.  This prevents threading
1452     * problems.
1453     */
1454    void (*unloader)(void *);
1455
1456    /**
1457     * Used internally by sweep().  Do not access from elsewhere.
1458     */
1459    int active;
1460
1461    /**
1462     * File last-modified time, so we can check if file has been changed.
1463     * Read-only once the structure has been created.
1464     */
1465    time_t lastmodified;
1466    
1467    /**
1468     * The full filename.
1469     */
1470    char * filename;
1471
1472    /**
1473     * Pointer to next entry in the linked list of all "file_list"s.
1474     * This linked list is so that sweep() can navigate it.
1475     * Since sweep() can remove items from the list, we must be careful
1476     * to only access this value from main thread (when we know sweep
1477     * won't be running).
1478     */
1479    struct file_list *next;
1480 };
1481
1482
1483 #ifdef FEATURE_TRUST
1484
1485 /**
1486  * The format of a trust file when loaded into memory.
1487  */
1488 struct block_spec
1489 {
1490    struct url_spec url[1];   /**< The URL pattern              */
1491    int    reject;            /**< FIXME: Please document this! */
1492    struct block_spec *next;  /**< Next entry in linked list    */
1493 };
1494
1495 /**
1496  * Arbitrary limit for the number of trusted referrers.
1497  */
1498 #define MAX_TRUSTED_REFERRERS 512
1499
1500 #endif /* def FEATURE_TRUST */
1501
1502
1503 #define SOCKS_NONE    0    /**< Don't use a SOCKS server               */
1504 #define SOCKS_4      40    /**< original SOCKS 4 protocol              */
1505 #define SOCKS_4A     41    /**< as modified for hosts w/o external DNS */
1506 #define SOCKS_5      50    /**< as modified for hosts w/o external DNS */
1507
1508
1509 /**
1510  * How to forward a connection to a parent proxy.
1511  */
1512 struct forward_spec
1513 {
1514    /** URL pattern that this forward_spec is for. */
1515    struct url_spec url[1];
1516
1517    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1518    int   type;
1519
1520    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1521    char *gateway_host;
1522
1523    /** SOCKS server port. */
1524    int   gateway_port;
1525
1526    /** Parent HTTP proxy hostname, or NULL for none. */
1527    char *forward_host;
1528
1529    /** Parent HTTP proxy port. */
1530    int   forward_port;
1531
1532    /** Next entry in the linked list. */
1533    struct forward_spec *next;
1534 };
1535
1536
1537 /**
1538  * Initializer for a static struct forward_spec.
1539  */
1540 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1541
1542 /* Supported filter types */
1543 #define FT_CONTENT_FILTER       0
1544 #define FT_CLIENT_HEADER_FILTER 1
1545 #define FT_SERVER_HEADER_FILTER 2
1546 #define FT_CLIENT_HEADER_TAGGER 3
1547 #define FT_SERVER_HEADER_TAGGER 4
1548
1549 #define MAX_FILTER_TYPES        5
1550
1551 /**
1552  * This struct represents one filter (one block) from
1553  * the re_filterfile. If there is more than one filter
1554  * in the file, the file will be represented by a
1555  * chained list of re_filterfile specs.
1556  */
1557 struct re_filterfile_spec
1558 {
1559    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1560    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1561    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1562    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1563    int type;                        /**< Filter type (content, client-header, server-header). */
1564    int dynamic;                     /**< Set to one if the pattern might contain variables
1565                                          and has to be recompiled for every request. */
1566    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1567 };
1568
1569
1570 #ifdef FEATURE_ACL
1571
1572 #define ACL_PERMIT   1  /**< Accept connection request */
1573 #define ACL_DENY     2  /**< Reject connection request */
1574
1575 /**
1576  * An IP address pattern.  Used to specify networks in the ACL.
1577  */
1578 struct access_control_addr
1579 {
1580    unsigned long addr;  /**< The IP address as an integer. */
1581    unsigned long mask;  /**< The network mask as an integer. */
1582    unsigned long port;  /**< The port number. */
1583 };
1584
1585 /**
1586  * An access control list (ACL) entry.
1587  *
1588  * This is a linked list.
1589  */
1590 struct access_control_list
1591 {
1592    struct access_control_addr src[1];  /**< Client IP address */
1593    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1594
1595    short action;                       /**< ACL_PERMIT or ACL_DENY */
1596    struct access_control_list *next;   /**< The next entry in the ACL. */
1597 };
1598
1599 #endif /* def FEATURE_ACL */
1600
1601
1602 /** Maximum number of loaders (actions, re_filter, ...) */
1603 #define NLOADERS 8
1604
1605
1606 /** configuration_spec::feature_flags: CGI actions editor. */
1607 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS             1
1608
1609 /** configuration_spec::feature_flags: Web-based toggle. */
1610 #define RUNTIME_FEATURE_CGI_TOGGLE                   2
1611
1612 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1613 #define RUNTIME_FEATURE_HTTP_TOGGLE                  4
1614
1615 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1616 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS            8
1617
1618 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1619 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1620
1621 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1622 #define RUNTIME_FEATURE_ENFORCE_BLOCKS              32
1623
1624 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1625 #define RUNTIME_FEATURE_CGI_CRUNCHING               64
1626
1627
1628 /**
1629  * Data loaded from the configuration file.
1630  *
1631  * (Anomaly: toggle is still handled through a global, not this structure)
1632  */
1633 struct configuration_spec
1634 {
1635    /** What to log */
1636    int debug;
1637    
1638    /** Nonzero to enable multithreading. */
1639    int multi_threaded;
1640
1641    /**
1642     * Bitmask of features that can be enabled/disabled through the config
1643     * file.  Currently defined bits:
1644     *
1645     * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1646     * - RUNTIME_FEATURE_CGI_TOGGLE
1647     * - RUNTIME_FEATURE_HTTP_TOGGLE
1648     * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1649     */
1650    unsigned feature_flags;
1651
1652    /** The log file name. */
1653    const char *logfile;
1654
1655    /** The config file directory. */
1656    const char *confdir;
1657
1658    /** The directory for customized CGI templates. */
1659    const char *templdir;
1660
1661    /** The log file directory. */
1662    const char *logdir;
1663
1664    /** The full paths to the actions files. */
1665    const char *actions_file[MAX_AF_FILES];
1666
1667    /** The short names of the actions files. */
1668    const char *actions_file_short[MAX_AF_FILES];
1669
1670    /** The administrator's email address */
1671    char *admin_address;
1672
1673    /** A URL with info on this proxy */
1674    char *proxy_info_url;
1675
1676    /** URL to the user manual (on our website or local copy) */
1677    char *usermanual;
1678
1679    /** The file names of the pcre filter files. */
1680    const char *re_filterfile[MAX_AF_FILES];
1681
1682    /** The short names of the pcre filter files. */
1683    const char *re_filterfile_short[MAX_AF_FILES];
1684
1685    /** The hostname to show on CGI pages, or NULL to use the real one. */
1686    const char *hostname;
1687
1688    /** IP address to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1689    const char *haddr;
1690
1691    /** Port to bind to.  Defaults to HADDR_PORT == 8118. */
1692    int         hport;
1693
1694    /** Size limit for IOB */
1695    size_t buffer_limit;
1696
1697 #ifdef FEATURE_TRUST
1698
1699    /** The file name of the trust file. */
1700    const char * trustfile;
1701
1702    /** FIXME: DOCME: Document this. */
1703    struct list trust_info[1];
1704
1705    /** FIXME: DOCME: Document this. */
1706    struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1707
1708 #endif /* def FEATURE_TRUST */
1709
1710 #ifdef FEATURE_ACL
1711
1712    /** The access control list (ACL). */
1713    struct access_control_list *acl;
1714
1715 #endif /* def FEATURE_ACL */
1716
1717    /** Information about parent proxies (forwarding). */
1718    struct forward_spec *forward;
1719
1720    /** Number of retries in case a forwarded connection attempt fails */
1721    int         forwarded_connect_retries;
1722
1723    /** All options from the config file, HTML-formatted. */
1724    char *proxy_args;
1725
1726    /** The configuration file object. */
1727    struct file_list *config_file_list;
1728
1729    /** List of loaders */
1730    int (*loaders[NLOADERS])(struct client_state *);
1731
1732    /** Nonzero if we need to bind() to the new port. */
1733    int need_bind;
1734 };
1735
1736 /** Calculates the number of elements in an array, using sizeof. */
1737 #define SZ(X)  (sizeof(X) / sizeof(*X))
1738
1739 #ifdef FEATURE_FORCE_LOAD
1740 /** The force load URL prefix. */
1741 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1742 #endif /* def FEATURE_FORCE_LOAD */
1743
1744 #ifdef FEATURE_NO_GIFS
1745 /** The MIME type for images ("image/png" or "image/gif"). */
1746 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1747 #else
1748 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1749 #endif /* def FEATURE_NO_GIFS */
1750
1751
1752 /* 
1753  * Hardwired URLs
1754  */
1755
1756 /** URL for the Privoxy home page. */
1757 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1758
1759 /** URL for the Privoxy user manual. */
1760 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1761
1762 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1763 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1764
1765 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1766 #define CONFIG_HELP_PREFIX  "config.html#"
1767
1768 /*
1769  * The "hosts" to intercept and display CGI pages.
1770  * First one is a hostname only, second one can specify host and path.
1771  *
1772  * Notes:
1773  * 1) Do not specify the http: prefix
1774  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1775  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1776  */
1777 #define CGI_SITE_1_HOST "p.p"
1778 #define CGI_SITE_2_HOST "config.privoxy.org"
1779 #define CGI_SITE_2_PATH ""
1780
1781 /**
1782  * The prefix for CGI pages.  Written out in generated HTML.
1783  * INCLUDES the trailing slash.
1784  */
1785 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1786
1787 #ifdef __cplusplus
1788 } /* extern "C" */
1789 #endif
1790
1791 #endif /* ndef PROJECT_H_INCLUDED */
1792
1793 /*
1794   Local Variables:
1795   tab-width: 3
1796   end:
1797 */