1 const char jcc_rcs[] = "$Id: jcc.c,v 1.92.2.10 2003/05/08 15:13:46 oes Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/Attic/jcc.c,v $
6 * Purpose : Main file. Contains main() method, main loop, and
7 * the main connection-handling function.
9 * Copyright : Written by and Copyright (C) 2001 the SourceForge
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
36 * Revision 1.92.2.10 2003/05/08 15:13:46 oes
37 * Cosmetics: Killed a warning, a typo and an allocation left at exit
39 * Revision 1.92.2.9 2003/04/03 15:08:42 oes
40 * No longer rely on non-POSIX.1 extensions of getcwd().
43 * Revision 1.92.2.8 2003/03/31 13:12:32 oes
44 * Replaced setenv() by posix-compliant putenv()
45 * Thanks to Neil McCalden (nmcc AT users.sf.net).
47 * Revision 1.92.2.7 2003/03/17 16:48:59 oes
48 * Added chroot ability, thanks to patch by Sviatoslav Sviridov
50 * Revision 1.92.2.6 2003/03/11 11:55:00 oes
51 * Clean-up and extension of improvements for forked mode:
52 * - Child's return code now consists of flags RC_FLAG_*
53 * - Reporting toggle to parent now properly #ifdef'ed
54 * - Children now report blocking to parent. This enables
55 * statistics in forked mode
57 * Revision 1.92.2.5 2003/03/10 23:45:32 oes
58 * Fixed bug #700381: Non-Threaded version now capable of being toggled.
59 * Children now report having been toggled through _exit(17), parents
60 * watch for that code and toggle themselves if found.
62 * Revision 1.92.2.4 2003/03/07 03:41:04 david__schmidt
63 * Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX. Hopefully this will take care of all of those pesky crash reports.
65 * Revision 1.92.2.3 2003/02/28 12:53:06 oes
66 * Fixed two mostly harmless mem leaks
68 * Revision 1.92.2.2 2002/11/20 14:37:47 oes
69 * Fix: Head of global clients list now initialized to NULL
71 * Revision 1.92.2.1 2002/09/25 14:52:24 oes
72 * Added basic support for OPTIONS and TRACE HTTP methods:
73 * - New interceptor direct_response() added in chat().
74 * - sed() moved to earlier in the process, so that the
75 * Host: header is evaluated before actions and forwarding
78 * Revision 1.92 2002/05/08 16:00:46 oes
79 * Chat's buffer handling:
80 * - Fixed bug with unchecked out-of-mem conditions
81 * while reading client request & server headers
82 * - No longer predict if the buffer limit will be exceeded
83 * in the next read -- check add_to_iob's new
84 * return code. If buffer couldn't be extended
85 * (policy or out-of-mem) while
86 * - reading from client: abort
87 * - reading server headers: send error page
88 * - buffering server body for filter: flush,
89 * and if that fails: send error page
91 * Revision 1.91 2002/04/08 20:35:58 swa
94 * Revision 1.90 2002/04/02 14:57:28 oes
95 * Made sending wafers independent of FEATURE_COOKIE_JAR
97 * Revision 1.89 2002/03/31 17:18:59 jongfoster
98 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
100 * Revision 1.88 2002/03/27 14:32:43 david__schmidt
101 * More compiler warning message maintenance
103 * Revision 1.87 2002/03/26 22:29:54 swa
104 * we have a new homepage!
106 * Revision 1.86 2002/03/25 17:04:55 david__schmidt
107 * Workaround for closing the jarfile before load_config() comes around again
109 * Revision 1.85 2002/03/24 15:23:33 jongfoster
112 * Revision 1.84 2002/03/24 13:25:43 swa
113 * name change related issues
115 * Revision 1.83 2002/03/16 23:54:06 jongfoster
116 * Adding graceful termination feature, to help look for memory leaks.
117 * If you enable this (which, by design, has to be done by hand
118 * editing config.h) and then go to http://i.j.b/die, then the program
119 * will exit cleanly after the *next* request. It should free all the
120 * memory that was used.
122 * Revision 1.82 2002/03/13 00:27:05 jongfoster
125 * Revision 1.81 2002/03/12 01:42:50 oes
126 * Introduced modular filters
128 * Revision 1.80 2002/03/11 22:07:05 david__schmidt
129 * OS/2 port maintenance:
130 * - Fixed EMX build - it had decayed a little
131 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
132 * substituted a memset for now.
134 * Revision 1.79 2002/03/09 20:03:52 jongfoster
135 * - Making various functions return int rather than size_t.
136 * (Undoing a recent change). Since size_t is unsigned on
137 * Windows, functions like read_socket that return -1 on
138 * error cannot return a size_t.
140 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
141 * crashes, and also frequently caused JB to jump to 100%
142 * CPU and stay there. (Because it thought it had just
143 * read ((unsigned)-1) == 4Gb of data...)
145 * - The signature of write_socket has changed, it now simply
146 * returns success=0/failure=nonzero.
148 * - Trying to get rid of a few warnings --with-debug on
149 * Windows, I've introduced a new type "jb_socket". This is
150 * used for the socket file descriptors. On Windows, this
151 * is SOCKET (a typedef for unsigned). Everywhere else, it's
152 * an int. The error value can't be -1 any more, so it's
153 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
154 * Windows it maps to the #define INVALID_SOCKET.)
156 * - The signature of bind_port has changed.
158 * Revision 1.78 2002/03/08 21:35:04 oes
159 * Added optional group supplement to --user option. Will now use default group of user if no group given
161 * Revision 1.77 2002/03/07 03:52:06 oes
162 * - Fixed compiler warnings etc
163 * - Improved handling of failed DNS lookups
165 * Revision 1.76 2002/03/06 22:54:35 jongfoster
166 * Automated function-comment nitpicking.
168 * Revision 1.75 2002/03/06 10:02:19 oes
169 * Fixed stupid bug when --user was not given
171 * Revision 1.74 2002/03/06 00:49:31 jongfoster
172 * Fixing warning on Windows
173 * Making #ifdefs that refer to the same variable consistently
174 * use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
176 * Revision 1.73 2002/03/05 23:57:30 hal9
177 * Stray character 's' on line 1618 was breaking build.
179 * Revision 1.72 2002/03/05 21:33:45 david__schmidt
180 * - Re-enable OS/2 building after new parms were added
181 * - Fix false out of memory report when resolving CGI templates when no IP
182 * address is available of failed attempt (a la no such domain)
184 * Revision 1.71 2002/03/05 18:13:56 oes
185 * Added --user option
187 * Revision 1.70 2002/03/05 04:52:42 oes
188 * Deleted non-errlog debugging code
190 * Revision 1.69 2002/03/04 23:50:00 jongfoster
191 * Splitting off bind_port() call into bind_port_helper(), with
194 * Revision 1.68 2002/03/04 20:17:32 oes
197 * Revision 1.67 2002/03/04 18:18:57 oes
198 * - Removed _DEBUG mode
199 * - Cleand up cmdline parsing
200 * - Introduced --no-daemon, --pidfile options
201 * - Cleaned up signal handling:
202 * - Terminate cleanly on INT, TERM and ABRT
203 * - Schedule logfile for re-opening on HUP
204 * - Ignore CHLD and PIPE
205 * - Leave the rest with their default handlers
206 * - Uniform handler registration
207 * - Added usage() function
208 * - Played styleguide police
210 * Revision 1.66 2002/03/03 15:06:55 oes
211 * Re-enabled automatic config reloading
213 * Revision 1.65 2002/03/03 14:49:11 oes
214 * Fixed CLF logging: Now uses client's original HTTP request
216 * Revision 1.64 2002/03/03 09:18:03 joergs
217 * Made jumbjuster work on AmigaOS again.
219 * Revision 1.63 2002/03/02 04:14:50 david__schmidt
220 * Clean up a little CRLF unpleasantness that suddenly appeared
222 * Revision 1.62 2002/02/20 23:17:23 jongfoster
223 * Detecting some out-of memory conditions and exiting with a log message.
225 * Revision 1.61 2002/01/17 21:01:52 jongfoster
226 * Moving all our URL and URL pattern parsing code to urlmatch.c.
228 * Revision 1.60 2001/12/30 14:07:32 steudten
229 * - Add signal handling (unix)
230 * - Add SIGHUP handler (unix)
231 * - Add creation of pidfile (unix)
232 * - Add action 'top' in rc file (RH)
233 * - Add entry 'SIGNALS' to manpage
234 * - Add exit message to logfile (unix)
236 * Revision 1.59 2001/12/13 14:07:18 oes
237 * Fixed Bug: 503 error page now sent OK
239 * Revision 1.58 2001/11/30 23:37:24 jongfoster
240 * Renaming the Win32 config file to config.txt - this is almost the
241 * same as the corresponding UNIX name "config"
243 * Revision 1.57 2001/11/16 00:47:43 jongfoster
244 * Changing the tty-disconnection code to use setsid().
246 * Revision 1.56 2001/11/13 20:20:54 jongfoster
247 * Tabs->spaces, fixing a bug with missing {} around an if()
249 * Revision 1.55 2001/11/13 20:14:53 jongfoster
250 * Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
252 * Revision 1.54 2001/11/07 00:03:14 steudten
253 * Give reliable return value if an error
254 * occurs not just 0 with new daemon mode.
256 * Revision 1.53 2001/11/05 21:41:43 steudten
257 * Add changes to be a real daemon just for unix os.
258 * (change cwd to /, detach from controlling tty, set
259 * process group and session leader to the own process.
261 * Add some fatal-error log message for failed malloc().
262 * Add '-d' if compiled with 'configure --with-debug' to
263 * enable debug output.
265 * Revision 1.52 2001/10/26 20:11:20 jongfoster
266 * Fixing type mismatch
268 * Revision 1.51 2001/10/26 17:38:28 oes
271 * Revision 1.50 2001/10/25 03:40:48 david__schmidt
272 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
273 * threads to call select() simultaneously. So, it's time to do a real, live,
274 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
275 * (native). Both versions will work, but using __OS2__ offers multi-threading.
277 * Revision 1.49 2001/10/23 21:41:35 jongfoster
278 * Added call to initialize the (statically-allocated of course)
279 * "out of memory" CGI response.
281 * Revision 1.48 2001/10/10 19:56:46 jongfoster
282 * Moving some code that wasn't cookie-related out of an #ifdef
285 * Revision 1.47 2001/10/10 16:44:36 oes
286 * Added CONNECT destination port limitation check
288 * Revision 1.46 2001/10/08 15:17:41 oes
289 * Re-enabled SSL forwarding
291 * Revision 1.45 2001/10/07 15:42:11 oes
292 * Replaced 6 boolean members of csp with one bitmap (csp->flags)
294 * Moved downgrading of the HTTP version from parse_http_request to
295 * chat(), since we can't decide if it is necessary before we have
296 * determined the actions for the URL. The HTTP command is now
297 * *always* re-built so the repairs need no longer be special-cased.
299 * filter_popups now gets a csp pointer so it can raise the new
300 * CSP_FLAG_MODIFIED flag.
304 * Added configurable size limit for the IOB. If the IOB grows so
305 * large that the next read would exceed the limit, the header
306 * is generated, and the header & unfiltered buffer are flushed
307 * to the client. Chat then continues in non-buffering,
308 * non-filtering body mode.
310 * Revision 1.44 2001/10/02 18:13:57 oes
313 * Revision 1.43 2001/10/02 15:32:13 oes
314 * Moved generation of hdr
316 * Revision 1.42 2001/09/21 23:02:02 david__schmidt
317 * Cleaning up 2 compiler warnings on OS/2.
319 * Revision 1.41 2001/09/16 17:05:14 jongfoster
320 * Removing unused #include showarg.h
322 * Revision 1.40 2001/09/16 15:41:45 jongfoster
323 * Fixing signed/unsigned comparison warning.
325 * Revision 1.39 2001/09/16 13:21:27 jongfoster
326 * Changes to use new list functions.
328 * Revision 1.38 2001/09/16 13:01:46 jongfoster
329 * Removing redundant function call that zeroed zalloc()'d memory.
331 * Revision 1.37 2001/09/10 11:12:24 oes
332 * Deleted unused variable
334 * Revision 1.36 2001/09/10 10:56:15 oes
335 * Silenced compiler warnings
337 * Revision 1.35 2001/07/31 14:44:22 oes
338 * Deleted unused size parameter from filter_popups()
340 * Revision 1.34 2001/07/30 22:08:36 jongfoster
341 * Tidying up #defines:
342 * - All feature #defines are now of the form FEATURE_xxx
343 * - Permanently turned off WIN_GUI_EDIT
344 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
346 * Revision 1.33 2001/07/29 19:32:00 jongfoster
347 * Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
349 * Revision 1.32 2001/07/29 18:47:05 jongfoster
350 * Adding missing #include "loadcfg.h"
352 * Revision 1.31 2001/07/29 12:17:48 oes
353 * Applied pthread fix by Paul Lieverse
355 * Revision 1.30 2001/07/25 22:57:13 jongfoster
356 * __BEOS__ no longer overrides FEATURE_PTHREAD.
357 * This is because FEATURE_PTHREAD will soon be widely used, so I
358 * want to keep it simple.
360 * Revision 1.29 2001/07/24 12:47:06 oes
361 * Applied BeOS support update by Eugenia
363 * Revision 1.28 2001/07/23 13:26:12 oes
364 * Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
366 * Revision 1.27 2001/07/19 19:09:47 haroon
367 * - Added code to take care of the situation where while processing the first
368 * server response (which includes the server header), after finding the end
369 * of the headers we were not looking past the end of the headers for
370 * content modification. I enabled it for filter_popups.
371 * Someone else should look to see if other similar operations should be
372 * done to the discarded portion of the buffer.
374 * Note 2001/07/20: No, the other content modification mechanisms will process
375 * the whole iob later anyway. --oes
377 * Revision 1.26 2001/07/18 12:31:36 oes
380 * Revision 1.25 2001/07/15 19:43:49 jongfoster
381 * Supports POSIX threads.
382 * Also removed some unused #includes.
384 * Revision 1.24 2001/07/13 14:00:40 oes
385 * - Generic content modification scheme:
386 * Each feature has its own applicability flag that is set
387 * from csp->action->flags.
388 * Replaced the "filtering" int flag , by a function pointer
389 * "content_filter" to the function that will do the content
390 * modification. If it is != NULL, the document will be buffered
391 * and processed through *content_filter, which must set
392 * csp->content_length and return a modified copy of the body
393 * or return NULL (on failiure).
394 * - Changed csp->is_text to the more generic bitmap csp->content_type
395 * which can currently take the valued CT_TEXT or CT_GIF
397 * - Removed all #ifdef PCRS
399 * Revision 1.23 2001/07/02 02:28:25 iwanttokeepanon
400 * Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
401 * the `block_acl' call. This prevents a compilation error when the user
402 * does not wish to use the "ACL" feature.
404 * Revision 1.22 2001/06/29 21:45:41 oes
405 * Indentation, CRLF->LF, Tab-> Space
407 * Revision 1.21 2001/06/29 13:29:36 oes
408 * - Cleaned up, improved comments
409 * - Unified all possible interceptors (CGI,
410 * block, trust, fast_redirect) in one
411 * place, with one (CGI) answer generation
412 * mechansim. Much clearer now.
413 * - Removed the GIF image generation, which
414 * is now done in filters.c:block_url()
415 * - Made error conditions like domain lookup
416 * failiure or (various) problems while talking
417 * to the server use cgi.c:error_response()
418 * instead of generating HTML/HTTP in chat() (yuck!)
419 * - Removed logentry from cancelled commit
421 * Revision 1.20 2001/06/09 10:55:28 jongfoster
422 * Changing BUFSIZ ==> BUFFER_SIZE
424 * Revision 1.19 2001/06/07 23:12:52 jongfoster
425 * Replacing function pointer in struct gateway with a directly
426 * called function forwarded_connect().
427 * Replacing struct gateway with struct forward_spec
429 * Revision 1.18 2001/06/03 19:12:16 oes
430 * introduced new cgi handling
432 * Revision 1.17 2001/06/01 20:07:23 jongfoster
433 * Now uses action +image-blocker{} rather than config->tinygif
435 * Revision 1.16 2001/06/01 18:49:17 jongfoster
436 * Replaced "list_share" with "list" - the tiny memory gain was not
437 * worth the extra complexity.
439 * Revision 1.15 2001/05/31 21:24:47 jongfoster
440 * Changed "permission" to "action" throughout.
441 * Removed DEFAULT_USER_AGENT - it must now be specified manually.
442 * Moved vanilla wafer check into chat(), since we must now
443 * decide whether or not to add it based on the URL.
445 * Revision 1.14 2001/05/29 20:14:01 joergs
446 * AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
449 * Revision 1.13 2001/05/29 09:50:24 jongfoster
450 * Unified blocklist/imagelist/permissionslist.
451 * File format is still under discussion, but the internal changes
454 * Also modified interceptor behaviour:
455 * - We now intercept all URLs beginning with one of the following
456 * prefixes (and *only* these prefixes):
458 * * http://ijbswa.sf.net/config/
459 * * http://ijbswa.sourceforge.net/config/
460 * - New interceptors "home page" - go to http://i.j.b/ to see it.
461 * - Internal changes so that intercepted and fast redirect pages
462 * are not replaced with an image.
463 * - Interceptors now have the option to send a binary page direct
464 * to the client. (i.e. ijb-send-banner uses this)
465 * - Implemented show-url-info interceptor. (Which is why I needed
466 * the above interceptors changes - a typical URL is
467 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
468 * The previous mechanism would not have intercepted that, and
469 * if it had been intercepted then it then it would have replaced
472 * Revision 1.12 2001/05/27 22:17:04 oes
474 * - re_process_buffer no longer writes the modified buffer
475 * to the client, which was very ugly. It now returns the
476 * buffer, which it is then written by chat.
478 * - content_length now adjusts the Content-Length: header
479 * for modified documents rather than crunch()ing it.
480 * (Length info in csp->content_length, which is 0 for
481 * unmodified documents)
483 * - For this to work, sed() is called twice when filtering.
485 * Revision 1.11 2001/05/26 17:27:53 jongfoster
486 * Added support for CLF and fixed LOG_LEVEL_LOG.
487 * Also did CRLF->LF fix of my previous patch.
489 * Revision 1.10 2001/05/26 15:26:15 jongfoster
490 * ACL feature now provides more security by immediately dropping
491 * connections from untrusted hosts.
493 * Revision 1.9 2001/05/26 00:28:36 jongfoster
494 * Automatic reloading of config file.
495 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
496 * Most of the global variables have been moved to a new
497 * struct configuration_spec, accessed through csp->config->globalname
498 * Most of the globals remaining are used by the Win32 GUI.
500 * Revision 1.8 2001/05/25 22:43:18 jongfoster
501 * Fixing minor memory leak and buffer overflow.
503 * Revision 1.7 2001/05/25 22:34:30 jongfoster
506 * Revision 1.6 2001/05/23 00:13:58 joergs
507 * AmigaOS support fixed.
509 * Revision 1.5 2001/05/22 18:46:04 oes
511 * - Enabled filtering banners by size rather than URL
512 * by adding patterns that replace all standard banner
513 * sizes with the "Junkbuster" gif to the re_filterfile
515 * - Enabled filtering WebBugs by providing a pattern
516 * which kills all 1x1 images
518 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
519 * which is selected by the (nonstandard and therefore
520 * capital) letter 'U' in the option string.
521 * It causes the quantifiers to be ungreedy by default.
522 * Appending a ? turns back to greedy (!).
524 * - Added a new interceptor ijb-send-banner, which
525 * sends back the "Junkbuster" gif. Without imagelist or
526 * MSIE detection support, or if tinygif = 1, or the
527 * URL isn't recognized as an imageurl, a lame HTML
528 * explanation is sent instead.
530 * - Added new feature, which permits blocking remote
531 * script redirects and firing back a local redirect
533 * The feature is conditionally compiled, i.e. it
534 * can be disabled with --disable-fast-redirects,
535 * plus it must be activated by a "fast-redirects"
536 * line in the config file, has its own log level
537 * and of course wants to be displayed by show-proxy-args
538 * Note: Boy, all the #ifdefs in 1001 locations and
539 * all the fumbling with configure.in and acconfig.h
540 * were *way* more work than the feature itself :-(
542 * - Because a generic redirect template was needed for
543 * this, tinygif = 3 now uses the same.
545 * - Moved GIFs, and other static HTTP response templates
550 * - Removed some >400 CRs again (Jon, you really worked
553 * Revision 1.4 2001/05/21 19:34:01 jongfoster
554 * Made failure to bind() a fatal error.
556 * Revision 1.3 2001/05/20 01:21:20 jongfoster
557 * Version 2.9.4 checkin.
558 * - Merged popupfile and cookiefile, and added control over PCRS
559 * filtering, in new "permissionsfile".
560 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
561 * file error you now get a message box (in the Win32 GUI) rather
562 * than the program exiting with no explanation.
563 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
565 * - Removed tabs from "config"
566 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
567 * - Bumped up version number.
569 * Revision 1.2 2001/05/17 22:34:44 oes
570 * - Added hint on GIF char array generation to jcc.c
571 * - Cleaned CRLF's from the sources and related files
572 * - Repaired logging for REF and FRC
574 * Revision 1.1.1.1 2001/05/15 13:58:56 oes
575 * Initial import of version 2.9.3 source tree
578 *********************************************************************/
584 #include <sys/types.h>
591 #ifdef FEATURE_PTHREAD
593 #endif /* def FEATURE_PTHREAD */
596 # ifndef FEATURE_PTHREAD
600 # include <windows.h>
601 # include <process.h>
602 # endif /* ndef FEATURE_PTHREAD */
605 # ifndef _WIN_CONSOLE
607 # endif /* ndef _WIN_CONSOLE */
609 #else /* ifndef _WIN32 */
611 # if !defined (__OS2__)
613 # include <sys/wait.h>
614 # endif /* ndef __OS2__ */
615 # include <sys/time.h>
616 # include <sys/stat.h>
617 # include <sys/ioctl.h>
620 #include <sys/termios.h>
631 # include <socket.h> /* BeOS has select() for sockets only. */
632 # include <OS.h> /* declarations for threads and stuff. */
635 # if defined(__EMX__) || defined(__OS2__)
636 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
641 #define bzero(B,N) memset(B,0x00,n)
656 #include "killpopup.h"
657 #include "miscutil.h"
659 #include "jbsockets.h"
664 #include "urlmatch.h"
666 const char jcc_h_rcs[] = JCC_H_VERSION;
667 const char project_h_rcs[] = PROJECT_H_VERSION;
670 struct client_state clients[1];
671 struct file_list files[1];
673 #ifdef FEATURE_STATISTICS
674 int urls_read = 0; /* total nr of urls read inc rejected */
675 int urls_rejected = 0; /* total nr of urls rejected */
676 #endif /* def FEATURE_STATISTICS */
678 #ifdef FEATURE_GRACEFUL_TERMINATION
682 static void listen_loop(void);
683 static void chat(struct client_state *csp);
685 void serve(struct client_state *csp);
686 #else /* ifndef AMIGA */
687 static void serve(struct client_state *csp);
688 #endif /* def AMIGA */
691 static int32 server_thread(void *data);
692 #endif /* def __BEOS__ */
695 #define sleep(N) Sleep(((N) * 1000))
699 #define sleep(N) DosSleep(((N) * 100))
704 * Hit OSX over the head with a hammer. Protect all *_r functions.
706 pthread_mutex_t gmtime_mutex;
707 pthread_mutex_t localtime_mutex;
708 pthread_mutex_t gethostbyaddr_mutex;
709 pthread_mutex_t gethostbyname_mutex;
710 #endif /* def OSX_DARWIN */
712 #if defined(unix) || defined(__EMX__)
713 const char *basedir = NULL;
714 const char *pidfile = NULL;
715 int received_hup_signal = 0;
716 #endif /* defined unix */
718 /* The vanilla wafer. */
719 static const char VANILLA_WAFER[] =
720 "NOTICE=TO_WHOM_IT_MAY_CONCERN_"
721 "Do_not_send_me_any_copyrighted_information_other_than_the_"
722 "document_that_I_am_requesting_or_any_of_its_necessary_components._"
723 "In_particular_do_not_send_me_any_cookies_that_"
724 "are_subject_to_a_claim_of_copyright_by_anybody._"
725 "Take_notice_that_I_refuse_to_be_bound_by_any_license_condition_"
726 "(copyright_or_otherwise)_applying_to_any_cookie._";
729 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
730 /*********************************************************************
732 * Function : sig_handler
734 * Description : Signal handler for different signals.
735 * Exit gracefully on ABRT, TERM and INT
736 * or set a flag that will cause the errlog
737 * to be reopened by the main thread on HUP.
740 * 1 : the_signal = the signal cause this function to call
744 *********************************************************************/
745 static void sig_handler(int the_signal)
752 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
760 received_hup_signal = 1;
765 * We shouldn't be here, unless we catch signals
766 * in main() that we can't handle here!
768 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
776 /*********************************************************************
780 * Description : Once a connection to the client has been accepted,
781 * this function is called (via serve()) to handle the
782 * main business of the communication. When this
783 * function returns, the caller must close the client
787 * 1 : csp = Current client state (buffers, headers, etc...)
789 * Returns : On success, the number of bytes written are returned (zero
790 * indicates nothing was written). On error, -1 is returned,
791 * and errno is set appropriately. If count is zero and the
792 * file descriptor refers to a regular file, 0 will be
793 * returned without causing any other effect. For a special
794 * file, the results are not portable.
796 *********************************************************************/
797 static void chat(struct client_state *csp)
800 * This next lines are a little ugly, but they simplifies the if statements
801 * below. Basically if TOGGLE, then we want the if to test if the
802 * CSP_FLAG_TOGGLED_ON flag ist set, else we don't. And if FEATURE_FORCE_LOAD,
803 * then we want the if to test for CSP_FLAG_FORCED , else we don't
805 #ifdef FEATURE_TOGGLE
806 # define IS_TOGGLED_ON_AND (csp->flags & CSP_FLAG_TOGGLED_ON) &&
807 #else /* ifndef FEATURE_TOGGLE */
808 # define IS_TOGGLED_ON_AND
809 #endif /* ndef FEATURE_TOGGLE */
810 #ifdef FEATURE_FORCE_LOAD
811 # define IS_NOT_FORCED_AND !(csp->flags & CSP_FLAG_FORCED) &&
812 #else /* ifndef FEATURE_FORCE_LOAD */
813 # define IS_NOT_FORCED_AND
814 #endif /* def FEATURE_FORCE_LOAD */
816 #define IS_ENABLED_AND IS_TOGGLED_ON_AND IS_NOT_FORCED_AND
818 char buf[BUFFER_SIZE];
826 int ms_iis5_hack = 0;
828 const struct forward_spec * fwd;
829 struct http_request *http;
830 int len; /* for buffer sizes */
831 #ifdef FEATURE_KILL_POPUPS
832 int block_popups; /* bool, 1==will block popups */
833 int block_popups_now = 0; /* bool, 1==currently blocking popups */
834 #endif /* def FEATURE_KILL_POPUPS */
836 int pcrs_filter; /* bool, 1==will filter through pcrs */
837 int gif_deanimate; /* bool, 1==will deanimate gifs */
839 /* Function that does the content filtering for the current request */
840 char *(*content_filter)() = NULL;
842 /* Skeleton for HTTP response, if we should intercept the request */
843 struct http_response *rsp;
848 * Read the client's request. Note that since we're not using select() we
849 * could get blocked here if a client connected, then didn't say anything!
854 len = read_socket(csp->cfd, buf, sizeof(buf));
856 if (len <= 0) break; /* error! */
859 * If there is no memory left for buffering the
860 * request, there is nothing we can do but hang up
862 if (add_to_iob(csp, buf, len))
867 req = get_header(csp);
871 break; /* no HTTP request! */
876 continue; /* more to come! */
879 #ifdef FEATURE_FORCE_LOAD
880 /* If this request contains the FORCE_PREFIX,
881 * better get rid of it now and set the force flag --oes
884 if (strstr(req, FORCE_PREFIX))
886 strclean(req, FORCE_PREFIX);
887 log_error(LOG_LEVEL_FORCE, "Enforcing request \"%s\".\n", req);
888 csp->flags |= CSP_FLAG_FORCED;
891 #endif /* def FEATURE_FORCE_LOAD */
893 parse_http_request(req, http, csp);
898 if (http->cmd == NULL)
900 strcpy(buf, CHEADER);
901 write_socket(csp->cfd, buf, strlen(buf));
903 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 400 0", csp->ip_addr_str);
905 free_http_request(http);
909 /* decide how to route the HTTP request */
911 if ((fwd = forward_url(http, csp)) == NULL)
913 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
914 /* Never get here - LOG_LEVEL_FATAL causes program exit */
917 /* build the http request to send to the server
918 * we have to do one of the following:
920 * create = use the original HTTP request to create a new
921 * HTTP request that has either the path component
922 * without the http://domainspec (w/path) or the
923 * full orininal URL (w/url)
924 * Note that the path and/or the HTTP version may
925 * have been altered by now.
927 * connect = Open a socket to the host:port of the server
928 * and short-circuit server and client socket.
930 * pass = Pass the request unchanged if forwarding a CONNECT
931 * request to a parent proxy. Note that we'll be sending
932 * the CFAIL message ourselves if connecting to the parent
933 * fails, but we won't send a CSUCCEED message if it works,
934 * since that would result in a double message (ours and the
935 * parent's). After sending the request to the parent, we simply
941 * +--------+--------+
943 * 0 | create | connect|
945 * Forwarding +--------+--------+
947 * 1 | create | pass |
949 * +--------+--------+
954 * Determine the actions for this URL
956 #ifdef FEATURE_TOGGLE
957 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
959 /* Most compatible set of actions (i.e. none) */
960 init_current_action(csp->action);
963 #endif /* ndef FEATURE_TOGGLE */
965 url_actions(http, csp);
970 * Check if a CONNECT request is allowable:
971 * In the absence of a +limit-connect action, allow only port 443.
972 * If there is an action, allow whatever matches the specificaton.
976 if( ( !(csp->action->flags & ACTION_LIMIT_CONNECT) && csp->http->port != 443)
977 || (csp->action->flags & ACTION_LIMIT_CONNECT
978 && !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT], csp->http->port)) )
980 strcpy(buf, CFORBIDDEN);
981 write_socket(csp->cfd, buf, strlen(buf));
983 log_error(LOG_LEVEL_CONNECT, "Denying suspicious CONNECT request from %s", csp->ip_addr_str);
984 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 403 0", csp->ip_addr_str);
992 * Downgrade http version from 1.1 to 1.0 if +downgrade
995 if ( (http->ssl == 0)
996 && (!strcmpic(http->ver, "HTTP/1.1"))
997 && (csp->action->flags & ACTION_DOWNGRADE))
1000 http->ver = strdup("HTTP/1.0");
1002 if (http->ver == NULL)
1004 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
1009 * Save a copy of the original request for logging
1011 http->ocmd = strdup(http->cmd);
1013 if (http->ocmd == NULL)
1015 log_error(LOG_LEVEL_FATAL, "Out of memory copying HTTP request line");
1019 * (Re)build the HTTP request for non-SSL requests.
1020 * If forwarding, use the whole URL, else, use only the path.
1026 http->cmd = strdup(http->gpc);
1027 string_append(&http->cmd, " ");
1029 if (fwd->forward_host)
1031 string_append(&http->cmd, http->url);
1035 string_append(&http->cmd, http->path);
1037 string_append(&http->cmd, " ");
1038 string_append(&http->cmd, http->ver);
1040 if (http->cmd == NULL)
1042 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1044 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", http->cmd);
1046 enlist(csp->headers, http->cmd);
1050 * If the user has not supplied any wafers, and the user has not
1051 * told us to suppress the vanilla wafer, then send the vanilla wafer.
1053 if (list_is_empty(csp->action->multi[ACTION_MULTI_WAFER])
1054 && ((csp->action->flags & ACTION_VANILLA_WAFER) != 0))
1056 enlist(csp->action->multi[ACTION_MULTI_WAFER], VANILLA_WAFER);
1060 #ifdef FEATURE_KILL_POPUPS
1061 block_popups = ((csp->action->flags & ACTION_NO_POPUPS) != 0);
1062 #endif /* def FEATURE_KILL_POPUPS */
1064 pcrs_filter = (csp->rlist != NULL) && /* There are expressions to be used */
1065 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER]));
1067 gif_deanimate = ((csp->action->flags & ACTION_DEANIMATE) != 0);
1069 /* grab the rest of the client's headers */
1073 if ( ( ( p = get_header(csp) ) != NULL) && ( *p == '\0' ) )
1075 len = read_socket(csp->cfd, buf, sizeof(buf));
1078 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1083 * If there is no memory left for buffering the
1084 * request, there is nothing we can do but hang up
1086 if (add_to_iob(csp, buf, len))
1093 if (p == NULL) break;
1095 enlist(csp->headers, p);
1100 * We have a request. Now, check to see if we need to
1101 * intercept it, i.e. If ..
1105 /* We may not forward the request by rfc2616 sect 14.31 */
1106 (NULL != (rsp = direct_response(csp)))
1108 /* or a CGI call was detected and answered */
1109 || (NULL != (rsp = dispatch_cgi(csp)))
1111 /* or we are enabled and... */
1112 || (IS_ENABLED_AND (
1114 /* ..the request was blocked */
1115 ( NULL != (rsp = block_url(csp)))
1117 /* ..or untrusted */
1118 #ifdef FEATURE_TRUST
1119 || ( NULL != (rsp = trust_url(csp)))
1120 #endif /* def FEATURE_TRUST */
1122 /* ..or a fast redirect kicked in */
1123 #ifdef FEATURE_FAST_REDIRECTS
1124 || (((csp->action->flags & ACTION_FAST_REDIRECTS) != 0) &&
1125 (NULL != (rsp = redirect_url(csp))))
1126 #endif /* def FEATURE_FAST_REDIRECTS */
1130 /* Write the answer to the client */
1131 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1132 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1134 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1137 #ifdef FEATURE_STATISTICS
1138 /* Count as a rejected request */
1139 csp->flags |= CSP_FLAG_REJECTED;
1140 #endif /* def FEATURE_STATISTICS */
1142 /* Log (FIXME: All intercept reasons apprear as "crunch" with Status 200) */
1143 log_error(LOG_LEVEL_GPC, "%s%s crunch!", http->hostport, http->path);
1144 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3", csp->ip_addr_str, http->ocmd);
1146 /* Clean up and return */
1147 free_http_response(rsp);
1151 hdr = sed(client_patterns, add_client_headers, csp);
1154 /* FIXME Should handle error properly */
1155 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1158 list_remove_all(csp->headers);
1160 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1162 if (fwd->forward_host)
1164 log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
1165 fwd->forward_host, fwd->forward_port, http->hostport);
1169 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1172 /* here we connect to the server, gateway, or the forwarder */
1174 csp->sfd = forwarded_connect(fwd, http, csp);
1176 if (csp->sfd == JB_INVALID_SOCKET)
1178 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1181 if (errno == EINVAL)
1183 rsp = error_response(csp, "no-such-domain", errno);
1185 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 404 0",
1186 csp->ip_addr_str, http->ocmd);
1190 rsp = error_response(csp, "connect-failed", errno);
1192 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1193 csp->ip_addr_str, http->ocmd);
1197 /* Write the answer to the client */
1200 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1201 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1203 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1207 free_http_response(rsp);
1212 log_error(LOG_LEVEL_CONNECT, "OK");
1214 if (fwd->forward_host || (http->ssl == 0))
1216 /* write the client's (modified) header to the server
1217 * (along with anything else that may be in the buffer)
1220 if (write_socket(csp->sfd, hdr, strlen(hdr))
1221 || (flush_socket(csp->sfd, csp) < 0))
1223 log_error(LOG_LEVEL_CONNECT, "write header to: %s failed: %E",
1226 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1227 csp->ip_addr_str, http->ocmd);
1229 rsp = error_response(csp, "connect-failed", errno);
1233 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1234 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1236 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1240 free_http_response(rsp);
1248 * We're running an SSL tunnel and we're not forwarding,
1249 * so just send the "connect succeeded" message to the
1250 * client, flush the rest, and get out of the way.
1252 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 2\n",
1253 csp->ip_addr_str, http->ocmd);
1255 if (write_socket(csp->cfd, CSUCCEED, sizeof(CSUCCEED)-1))
1263 /* we're finished with the client's header */
1266 maxfd = ( csp->cfd > csp->sfd ) ? csp->cfd : csp->sfd;
1268 /* pass data between the client and server
1269 * until one or the other shuts down the connection.
1278 * FD_ZERO here seems to point to an errant macro which crashes.
1279 * So do this by hand for now...
1281 memset(&rfds,0x00,sizeof(fd_set));
1285 FD_SET(csp->cfd, &rfds);
1286 FD_SET(csp->sfd, &rfds);
1288 n = select((int)maxfd+1, &rfds, NULL, NULL, NULL);
1292 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1296 /* this is the body of the browser's request
1297 * just read it and write it.
1300 if (FD_ISSET(csp->cfd, &rfds))
1302 len = read_socket(csp->cfd, buf, sizeof(buf));
1306 break; /* "game over, man" */
1309 if (write_socket(csp->sfd, buf, (size_t)len))
1311 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1318 * The server wants to talk. It could be the header or the body.
1319 * If `hdr' is null, then it's the header otherwise it's the body.
1320 * FIXME: Does `hdr' really mean `host'? No.
1324 if (FD_ISSET(csp->sfd, &rfds))
1327 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
1331 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
1333 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1334 csp->ip_addr_str, http->ocmd);
1336 rsp = error_response(csp, "connect-failed", errno);
1340 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1341 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1343 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1347 free_http_response(rsp);
1351 /* Add a trailing zero. This lets filter_popups
1352 * use string operations.
1356 #ifdef FEATURE_KILL_POPUPS
1357 /* Filter the popups on this read. */
1358 if (block_popups_now)
1360 filter_popups(buf, csp);
1362 #endif /* def FEATURE_KILL_POPUPS */
1364 /* Normally, this would indicate that we've read
1365 * as much as the server has sent us and we can
1366 * close the client connection. However, Microsoft
1367 * in its wisdom has released IIS/5 with a bug that
1368 * prevents it from sending the trailing \r\n in
1369 * a 302 redirect header (and possibly other headers).
1370 * To work around this if we've haven't parsed
1371 * a full header we'll append a trailing \r\n
1372 * and see if this now generates a valid one.
1374 * This hack shouldn't have any impacts. If we've
1375 * already transmitted the header or if this is a
1376 * SSL connection, then we won't bother with this
1377 * hack. So we only work on partially received
1378 * headers. If we append a \r\n and this still
1379 * doesn't generate a valid header, then we won't
1380 * transmit anything to the client.
1385 if (server_body || http->ssl)
1388 * If we have been buffering up the document,
1389 * now is the time to apply content modification
1390 * and send the result to the client.
1395 * If the content filter fails, use the original
1396 * buffer and length.
1397 * (see p != NULL ? p : csp->iob->cur below)
1399 if (NULL == (p = (*content_filter)(csp)))
1401 csp->content_length = csp->iob->eod - csp->iob->cur;
1404 hdr = sed(server_patterns, add_server_headers, csp);
1407 /* FIXME Should handle error properly */
1408 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1411 if (write_socket(csp->cfd, hdr, strlen(hdr))
1412 || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
1414 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
1424 break; /* "game over, man" */
1428 * This is NOT the body, so
1429 * Let's pretend the server just sent us a blank line.
1431 len = sprintf(buf, "\r\n");
1434 * Now, let the normal header parsing algorithm below do its
1435 * job. If it fails, we'll exit instead of continuing.
1442 * If this is an SSL connection or we're in the body
1443 * of the server document, just write it to the client,
1444 * unless we need to buffer the body for later content-filtering
1447 if (server_body || http->ssl)
1452 * If there is no memory left for buffering the content, or the buffer limit
1453 * has been reached, switch to non-filtering mode, i.e. make & write the
1454 * header, flush the iob and buf, and get out of the way.
1456 if (add_to_iob(csp, buf, len))
1461 log_error(LOG_LEVEL_ERROR, "Flushing header and buffers. Stepping back from filtering.");
1463 hdr = sed(server_patterns, add_server_headers, csp);
1467 * Memory is too tight to even generate the header.
1468 * Send our static "Out-of-memory" page.
1470 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
1471 rsp = cgi_error_memory();
1473 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1474 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1476 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1481 hdrlen = strlen(hdr);
1483 if (write_socket(csp->cfd, hdr, hdrlen)
1484 || ((flushed = flush_socket(csp->cfd, csp)) < 0)
1485 || (write_socket(csp->cfd, buf, (size_t) len)))
1487 log_error(LOG_LEVEL_CONNECT, "Flush header and buffers to client failed: %E");
1493 byte_count += hdrlen + flushed + len;
1495 content_filter = NULL;
1502 if (write_socket(csp->cfd, buf, (size_t)len))
1504 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
1513 /* we're still looking for the end of the
1514 * server's header ... (does that make header
1515 * parsing an "out of body experience" ?
1519 * buffer up the data we just read. If that fails,
1520 * there's little we can do but send our static
1521 * out-of-memory page.
1523 if (add_to_iob(csp, buf, len))
1525 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
1526 rsp = cgi_error_memory();
1528 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1529 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1531 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1536 /* get header lines from the iob */
1538 while ((p = get_header(csp)) != NULL)
1542 /* see following note */
1545 enlist(csp->headers, p);
1549 /* NOTE: there are no "empty" headers so
1550 * if the pointer `p' is not NULL we must
1551 * assume that we reached the end of the
1552 * buffer before we hit the end of the header.
1559 /* Well, we tried our MS IIS/5
1560 * hack and it didn't work.
1561 * The header is incomplete
1562 * and there isn't anything
1563 * we can do about it.
1569 /* Since we have to wait for
1570 * more from the server before
1571 * we can parse the headers
1572 * we just continue here.
1578 /* we have now received the entire header.
1579 * filter it and send the result to the client
1582 hdr = sed(server_patterns, add_server_headers, csp);
1585 /* FIXME Should handle error properly */
1586 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1589 #ifdef FEATURE_KILL_POPUPS
1590 /* Start blocking popups if appropriate. */
1592 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1593 !http->ssl && /* We talk plaintext */
1594 block_popups) /* Policy allows */
1596 block_popups_now = 1;
1598 * Filter the part of the body that came in the same read
1599 * as the last headers:
1601 filter_popups(csp->iob->cur, csp);
1604 #endif /* def FEATURE_KILL_POPUPS */
1606 /* Buffer and pcrs filter this if appropriate. */
1608 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1609 !http->ssl && /* We talk plaintext */
1610 pcrs_filter) /* Policy allows */
1612 content_filter = pcrs_filter_response;
1615 /* Buffer and gif_deanimate this if appropriate. */
1617 if ((csp->content_type & CT_GIF) && /* It's a image/gif MIME-Type */
1618 !http->ssl && /* We talk plaintext */
1619 gif_deanimate) /* Policy allows */
1621 content_filter = gif_deanimate_response;
1625 * Only write if we're not buffering for content modification
1627 if (!content_filter)
1629 /* write the server's (modified) header to
1630 * the client (along with anything else that
1631 * may be in the buffer)
1634 if (write_socket(csp->cfd, hdr, strlen(hdr))
1635 || ((len = flush_socket(csp->cfd, csp)) < 0))
1637 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
1639 /* the write failed, so don't bother
1640 * mentioning it to the client...
1641 * it probably can't hear us anyway.
1650 /* we're finished with the server's header */
1655 /* If this was a MS IIS/5 hack then it means
1656 * the server has already closed the
1657 * connection. Nothing more to read. Time
1668 return; /* huh? we should never get here */
1671 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %d",
1672 csp->ip_addr_str, http->ocmd, byte_count);
1676 /*********************************************************************
1680 * Description : This is little more than chat. We only "serve" to
1681 * to close any socket that chat may have opened.
1684 * 1 : csp = Current client state (buffers, headers, etc...)
1688 *********************************************************************/
1690 void serve(struct client_state *csp)
1691 #else /* ifndef AMIGA */
1692 static void serve(struct client_state *csp)
1693 #endif /* def AMIGA */
1696 close_socket(csp->cfd);
1698 if (csp->sfd != JB_INVALID_SOCKET)
1700 close_socket(csp->sfd);
1703 csp->flags &= ~CSP_FLAG_ACTIVE;
1709 /*********************************************************************
1711 * Function : server_thread
1713 * Description : We only exist to call `serve' in a threaded environment.
1716 * 1 : data = Current client state (buffers, headers, etc...)
1718 * Returns : Always 0.
1720 *********************************************************************/
1721 static int32 server_thread(void *data)
1723 serve((struct client_state *) data);
1730 /*********************************************************************
1734 * Description : Print usage info & exit.
1736 * Parameters : Pointer to argv[0] for identifying ourselves
1740 *********************************************************************/
1741 void usage(const char *myname)
1743 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
1744 "Usage: %s [--help] [--version] [--no-daemon] [--pidfile pidfile] [--user user[.group]] [configfile]\n"
1745 "Aborting.\n", myname);
1752 /*********************************************************************
1756 * Description : Load the config file and start the listen loop.
1757 * This function is a lot more *sane* with the `load_config'
1758 * and `listen_loop' functions; although it stills does
1759 * a *little* too much for my taste.
1762 * 1 : argc = Number of parameters (including $0).
1763 * 2 : argv = Array of (char *)'s to the parameters.
1765 * Returns : 1 if : can't open config file, unrecognized directive,
1766 * stats requested in multi-thread mode, can't open the
1767 * log file, can't open the jar file, listen port is invalid,
1768 * any load fails, and can't bind port.
1770 * Else main never returns, the process must be signaled
1771 * to terminate execution. Or, on Windows, use the
1772 * "File", "Exit" menu option.
1774 *********************************************************************/
1776 int real_main(int argc, const char *argv[])
1778 int main(int argc, const char *argv[])
1783 struct passwd *pw = NULL;
1784 struct group *grp = NULL;
1793 #if !defined(_WIN32)
1801 * Parse the command line arguments
1803 while (++argc_pos < argc)
1805 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
1807 if (strcmp(argv[argc_pos], "--help") == 0)
1812 else if(strcmp(argv[argc_pos], "--version") == 0)
1814 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
1818 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
1823 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
1825 if (++argc_pos == argc) usage(argv[0]);
1826 pidfile = strdup(argv[argc_pos]);
1829 else if (strcmp(argv[argc_pos], "--user" ) == 0)
1831 if (++argc_pos == argc) usage(argv[argc_pos]);
1833 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
1836 if (NULL == (grp = getgrnam(p)))
1838 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
1842 if (NULL == (pw = getpwnam(argv[argc_pos])))
1844 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
1847 if (p != NULL) *--p = '\0';
1850 else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
1854 #endif /* defined(unix) */
1856 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1858 configfile = argv[argc_pos];
1861 } /* -END- while (more arguments) */
1864 if ( *configfile != '/' )
1866 char *abs_file, cwd[1024];
1868 /* make config-filename absolute here */
1869 if ( !(getcwd(cwd, sizeof(cwd))))
1871 perror("get working dir failed");
1875 if (!(basedir = strdup(cwd))
1876 || (!(abs_file = malloc( strlen( basedir ) + strlen( configfile ) + 5 ))))
1878 perror("malloc failed");
1881 strcpy( abs_file, basedir );
1882 strcat( abs_file, "/" );
1883 strcat( abs_file, configfile );
1884 configfile = abs_file;
1886 #endif /* defined unix */
1890 clients->next = NULL;
1894 #elif defined(_WIN32)
1900 * Prepare global mutex semaphores
1902 pthread_mutex_init(&gmtime_mutex,0);
1903 pthread_mutex_init(&localtime_mutex,0);
1904 pthread_mutex_init(&gethostbyaddr_mutex,0);
1905 pthread_mutex_init(&gethostbyname_mutex,0);
1906 #endif /* def OSX_DARWIN */
1909 * Unix signal handling
1911 * Catch the abort, interrupt and terminate signals for a graceful exit
1912 * Catch the hangup signal so the errlog can be reopened.
1913 * Ignore the broken pipe and child signals
1914 * FIXME: Isn't ignoring the default for SIGCHLD anyway and why ignore SIGPIPE?
1916 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1919 const int catched_signals[] = { SIGABRT, SIGTERM, SIGINT, SIGHUP, 0 };
1920 const int ignored_signals[] = { SIGPIPE, SIGCHLD, 0 };
1922 for (idx = 0; catched_signals[idx] != 0; idx++)
1924 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
1926 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
1930 for (idx = 0; ignored_signals[idx] != 0; idx++)
1932 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
1934 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
1939 #else /* ifdef _WIN32 */
1940 # ifdef _WIN_CONSOLE
1942 * We *are* in a windows console app.
1943 * Print a verbose messages about FAQ's and such
1945 printf(win32_blurb);
1946 # endif /* def _WIN_CONSOLE */
1947 #endif /* def _WIN32 */
1950 /* Initialize the CGI subsystem */
1951 cgi_init_error_messages();
1954 * If runnig on unix and without the --nodaemon
1955 * option, become a daemon. I.e. fork, detach
1956 * from tty and get process group leadership
1969 if ( pid < 0 ) /* error */
1974 else if ( pid != 0 ) /* parent */
1979 * must check for errors
1980 * child died due to missing files aso
1983 wpid = waitpid( pid, &status, WNOHANG );
1992 /* Should be more portable, but not as well tested */
1997 #else /* ndef __FreeBSD__ */
1999 #endif /* ndef __FreeBSD__ */
2000 fd = open("/dev/tty", O_RDONLY);
2003 /* no error check here */
2004 ioctl( fd, TIOCNOTTY,0 );
2008 /* FIXME: should close stderr (fd 2) here too, but the test
2010 * and load config file is done in listen_loop() and puts
2011 * some messages on stderr there.
2018 } /* -END- if (!no_daemon) */
2021 * As soon as we have written the PID file, we can switch
2022 * to the user and group ID indicated by the --user option
2028 if (((NULL != grp) && setgid(grp->gr_gid)) || (setgid(pw->pw_gid)))
2030 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
2036 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
2038 if (chroot(pw->pw_dir) < 0)
2040 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
2044 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
2047 if (setuid(pw->pw_uid))
2049 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
2053 char putenv_dummy[64];
2055 strcpy(putenv_dummy, "HOME=/");
2056 if (putenv(putenv_dummy) != 0)
2058 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
2061 snprintf(putenv_dummy, 64, "USER=%s", pw->pw_name);
2062 if (putenv(putenv_dummy) != 0)
2064 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
2070 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
2073 #endif /* defined unix */
2083 /*********************************************************************
2085 * Function : bind_port_helper
2087 * Description : Bind the listen port. Handles logging, and aborts
2091 * 1 : config = Privoxy configuration. Specifies port
2094 * Returns : Port that was opened.
2096 *********************************************************************/
2097 static jb_socket bind_port_helper(struct configuration_spec * config)
2102 if ( (config->haddr != NULL)
2103 && (config->haddr[0] == '1')
2104 && (config->haddr[1] == '2')
2105 && (config->haddr[2] == '7')
2106 && (config->haddr[3] == '.') )
2108 log_error(LOG_LEVEL_INFO, "Listening on port %d for local connections only",
2111 else if (config->haddr == NULL)
2113 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
2118 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
2119 config->hport, config->haddr);
2122 result = bind_port(config->haddr, config->hport, &bfd);
2129 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2130 "There may be another Privoxy or some other "
2131 "proxy running on port %d",
2132 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
2133 config->hport, config->hport);
2136 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2137 "The hostname is not resolvable",
2138 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2141 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
2142 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2145 /* shouldn't get here */
2146 return JB_INVALID_SOCKET;
2149 config->need_bind = 0;
2155 /*********************************************************************
2157 * Function : listen_loop
2159 * Description : bind the listen port and enter a "FOREVER" listening loop.
2165 *********************************************************************/
2166 static void listen_loop(void)
2168 struct client_state *csp = NULL;
2170 struct configuration_spec * config;
2172 config = load_config();
2174 bfd = bind_port_helper(config);
2176 #ifdef FEATURE_GRACEFUL_TERMINATION
2177 while (!g_terminate)
2182 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
2183 while (waitpid(-1, NULL, WNOHANG) > 0)
2185 /* zombie children */
2187 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
2190 * Free data that was used by died threads
2196 * Re-open the errlog after HUP signal
2198 if (received_hup_signal)
2200 init_error_log(Argv[0], config->logfile, config->debug);
2201 received_hup_signal = 0;
2206 #ifdef FEATURE_COOKIE_JAR
2208 * Need a workaround here: we have to fclose() the jarfile, or we die because it's
2209 * already open. I think unload_configfile() is not being run, which should do
2210 * this work. Until that can get resolved, we'll use this workaround.
2214 if (csp->config->jar)
2216 fclose(csp->config->jar);
2217 csp->config->jar = NULL;
2219 #endif /* FEATURE_COOKIE_JAR */
2220 #endif /* __OS2__ */
2222 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
2224 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
2228 csp->flags |= CSP_FLAG_ACTIVE;
2229 csp->sfd = JB_INVALID_SOCKET;
2231 csp->config = config = load_config();
2233 if ( config->need_bind )
2236 * Since we were listening to the "old port", we will not see
2237 * a "listen" param change until the next IJB request. So, at
2238 * least 1 more request must be made for us to find the new
2239 * setting. I am simply closing the old socket and binding the
2242 * Which-ever is correct, we will serve 1 more page via the
2243 * old settings. This should probably be a "show-proxy-args"
2244 * request. This should not be a so common of an operation
2245 * that this will hurt people's feelings.
2250 bfd = bind_port_helper(config);
2253 log_error(LOG_LEVEL_CONNECT, "accept connection ... ");
2255 if (!accept_connection(csp, bfd))
2257 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
2270 log_error(LOG_LEVEL_CONNECT, "OK");
2273 #ifdef FEATURE_TOGGLE
2274 if (global_toggle_state)
2276 csp->flags |= CSP_FLAG_TOGGLED_ON;
2278 #endif /* def FEATURE_TOGGLE */
2280 if (run_loader(csp))
2282 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
2283 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2287 if (block_acl(NULL,csp))
2289 log_error(LOG_LEVEL_CONNECT, "Connection dropped due to ACL");
2290 close_socket(csp->cfd);
2294 #endif /* def FEATURE_ACL */
2296 /* add it to the list of clients */
2297 csp->next = clients->next;
2298 clients->next = csp;
2300 if (config->multi_threaded)
2304 /* this is a switch () statment in the C preprocessor - ugh */
2305 #undef SELECTED_ONE_OPTION
2307 /* Use Pthreads in preference to native code */
2308 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
2309 #define SELECTED_ONE_OPTION
2311 pthread_t the_thread;
2312 pthread_attr_t attrs;
2314 pthread_attr_init(&attrs);
2315 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
2316 child_id = (pthread_create(&the_thread, &attrs,
2317 (void*)serve, csp) ? -1 : 0);
2318 pthread_attr_destroy(&attrs);
2322 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
2323 #define SELECTED_ONE_OPTION
2324 child_id = _beginthread(
2325 (void (*)(void *))serve,
2330 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
2331 #define SELECTED_ONE_OPTION
2332 child_id = _beginthread(
2333 (void(* _Optlink)(void*))serve,
2339 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
2340 #define SELECTED_ONE_OPTION
2342 thread_id tid = spawn_thread
2343 (server_thread, "server", B_NORMAL_PRIORITY, csp);
2345 if ((tid >= 0) && (resume_thread(tid) == B_OK))
2347 child_id = (int) tid;
2356 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
2357 #define SELECTED_ONE_OPTION
2358 csp->cfd = ReleaseSocket(csp->cfd, -1);
2360 if((child_id = (int)CreateNewProcTags(
2361 NP_Entry, (ULONG)server_thread,
2362 NP_Output, Output(),
2363 NP_CloseOutput, FALSE,
2364 NP_Name, (ULONG)"privoxy child",
2365 NP_StackSize, 200*1024,
2369 ((struct Task *)child_id)->tc_UserData = csp;
2370 Signal((struct Task *)child_id, SIGF_SINGLE);
2375 #if !defined(SELECTED_ONE_OPTION)
2378 /* This block is only needed when using fork().
2379 * When using threads, the server thread was
2380 * created and run by the call to _beginthread().
2382 if (child_id == 0) /* child */
2385 #ifdef FEATURE_TOGGLE
2386 int inherited_toggle_state = global_toggle_state;
2387 #endif /* def FEATURE_TOGGLE */
2392 * If we've been toggled or we've blocked the request, tell Mom
2395 #ifdef FEATURE_TOGGLE
2396 if (inherited_toggle_state != global_toggle_state)
2398 rc |= RC_FLAG_TOGGLED;
2400 #endif /* def FEATURE_TOGGLE */
2402 #ifdef FEATURE_STATISTICS
2403 if (csp->flags & CSP_FLAG_REJECTED)
2405 rc |= RC_FLAG_BLOCKED;
2407 #endif /* ndef FEATURE_STATISTICS */
2411 else if (child_id > 0) /* parent */
2413 /* in a fork()'d environment, the parent's
2414 * copy of the client socket and the CSP
2418 #if !defined(_WIN32) && !defined(__CYGWIN__)
2420 wait( &child_status );
2423 * Evaluate child's return code: If the child has
2424 * - been toggled, toggle ourselves
2425 * - blocked its request, bump up the stats counter
2428 #ifdef FEATURE_TOGGLE
2429 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
2431 global_toggle_state = !global_toggle_state;
2433 #endif /* def FEATURE_TOGGLE */
2435 #ifdef FEATURE_STATISTICS
2437 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
2441 #endif /* def FEATURE_STATISTICS */
2443 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
2444 close_socket(csp->cfd);
2445 csp->flags &= ~CSP_FLAG_ACTIVE;
2449 #undef SELECTED_ONE_OPTION
2450 /* end of cpp switch () */
2452 if (child_id < 0) /* failed */
2454 char buf[BUFFER_SIZE];
2456 log_error(LOG_LEVEL_ERROR, "can't fork: %E");
2458 sprintf(buf , "Privoxy: can't fork: errno = %d", errno);
2460 write_socket(csp->cfd, buf, strlen(buf));
2461 close_socket(csp->cfd);
2462 csp->flags &= ~CSP_FLAG_ACTIVE;
2473 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
2475 /* Clean up. Aim: free all memory (no leaks) */
2476 #ifdef FEATURE_GRACEFUL_TERMINATION
2478 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
2480 unload_current_config_file();
2481 unload_current_actions_file();
2482 unload_current_re_filterfile();
2483 #ifdef FEATURE_TRUST
2484 unload_current_trust_file();
2487 if (config->multi_threaded)
2494 } while ((clients->next != NULL) && (--i > 0));
2498 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
2509 #ifdef FEATURE_COOKIE_JAR
2510 if (NULL != config->jar)
2512 fclose(config->jar);
2516 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
2517 /* Cleanup - remove taskbar icon etc. */
2522 #endif /* FEATURE_GRACEFUL_TERMINATION */