1 const char jcc_rcs[] = "$Id: jcc.c,v 2.0 2002/06/04 14:34:21 jongfoster Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/src/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 2.0 2002/06/04 14:34:21 jongfoster
37 * Moving source files to src/
39 * Revision 1.92 2002/05/08 16:00:46 oes
40 * Chat's buffer handling:
41 * - Fixed bug with unchecked out-of-mem conditions
42 * while reading client request & server headers
43 * - No longer predict if the buffer limit will be exceeded
44 * in the next read -- check add_to_iob's new
45 * return code. If buffer couldn't be extended
46 * (policy or out-of-mem) while
47 * - reading from client: abort
48 * - reading server headers: send error page
49 * - buffering server body for filter: flush,
50 * and if that fails: send error page
52 * Revision 1.91 2002/04/08 20:35:58 swa
55 * Revision 1.90 2002/04/02 14:57:28 oes
56 * Made sending wafers independent of FEATURE_COOKIE_JAR
58 * Revision 1.89 2002/03/31 17:18:59 jongfoster
59 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
61 * Revision 1.88 2002/03/27 14:32:43 david__schmidt
62 * More compiler warning message maintenance
64 * Revision 1.87 2002/03/26 22:29:54 swa
65 * we have a new homepage!
67 * Revision 1.86 2002/03/25 17:04:55 david__schmidt
68 * Workaround for closing the jarfile before load_config() comes around again
70 * Revision 1.85 2002/03/24 15:23:33 jongfoster
73 * Revision 1.84 2002/03/24 13:25:43 swa
74 * name change related issues
76 * Revision 1.83 2002/03/16 23:54:06 jongfoster
77 * Adding graceful termination feature, to help look for memory leaks.
78 * If you enable this (which, by design, has to be done by hand
79 * editing config.h) and then go to http://i.j.b/die, then the program
80 * will exit cleanly after the *next* request. It should free all the
81 * memory that was used.
83 * Revision 1.82 2002/03/13 00:27:05 jongfoster
86 * Revision 1.81 2002/03/12 01:42:50 oes
87 * Introduced modular filters
89 * Revision 1.80 2002/03/11 22:07:05 david__schmidt
90 * OS/2 port maintenance:
91 * - Fixed EMX build - it had decayed a little
92 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
93 * substituted a memset for now.
95 * Revision 1.79 2002/03/09 20:03:52 jongfoster
96 * - Making various functions return int rather than size_t.
97 * (Undoing a recent change). Since size_t is unsigned on
98 * Windows, functions like read_socket that return -1 on
99 * error cannot return a size_t.
101 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
102 * crashes, and also frequently caused JB to jump to 100%
103 * CPU and stay there. (Because it thought it had just
104 * read ((unsigned)-1) == 4Gb of data...)
106 * - The signature of write_socket has changed, it now simply
107 * returns success=0/failure=nonzero.
109 * - Trying to get rid of a few warnings --with-debug on
110 * Windows, I've introduced a new type "jb_socket". This is
111 * used for the socket file descriptors. On Windows, this
112 * is SOCKET (a typedef for unsigned). Everywhere else, it's
113 * an int. The error value can't be -1 any more, so it's
114 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
115 * Windows it maps to the #define INVALID_SOCKET.)
117 * - The signature of bind_port has changed.
119 * Revision 1.78 2002/03/08 21:35:04 oes
120 * Added optional group supplement to --user option. Will now use default group of user if no group given
122 * Revision 1.77 2002/03/07 03:52:06 oes
123 * - Fixed compiler warnings etc
124 * - Improved handling of failed DNS lookups
126 * Revision 1.76 2002/03/06 22:54:35 jongfoster
127 * Automated function-comment nitpicking.
129 * Revision 1.75 2002/03/06 10:02:19 oes
130 * Fixed stupid bug when --user was not given
132 * Revision 1.74 2002/03/06 00:49:31 jongfoster
133 * Fixing warning on Windows
134 * Making #ifdefs that refer to the same variable consistently
135 * use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
137 * Revision 1.73 2002/03/05 23:57:30 hal9
138 * Stray character 's' on line 1618 was breaking build.
140 * Revision 1.72 2002/03/05 21:33:45 david__schmidt
141 * - Re-enable OS/2 building after new parms were added
142 * - Fix false out of memory report when resolving CGI templates when no IP
143 * address is available of failed attempt (a la no such domain)
145 * Revision 1.71 2002/03/05 18:13:56 oes
146 * Added --user option
148 * Revision 1.70 2002/03/05 04:52:42 oes
149 * Deleted non-errlog debugging code
151 * Revision 1.69 2002/03/04 23:50:00 jongfoster
152 * Splitting off bind_port() call into bind_port_helper(), with
155 * Revision 1.68 2002/03/04 20:17:32 oes
158 * Revision 1.67 2002/03/04 18:18:57 oes
159 * - Removed _DEBUG mode
160 * - Cleand up cmdline parsing
161 * - Introduced --no-daemon, --pidfile options
162 * - Cleaned up signal handling:
163 * - Terminate cleanly on INT, TERM and ABRT
164 * - Schedule logfile for re-opening on HUP
165 * - Ignore CHLD and PIPE
166 * - Leave the rest with their default handlers
167 * - Uniform handler registration
168 * - Added usage() function
169 * - Played styleguide police
171 * Revision 1.66 2002/03/03 15:06:55 oes
172 * Re-enabled automatic config reloading
174 * Revision 1.65 2002/03/03 14:49:11 oes
175 * Fixed CLF logging: Now uses client's original HTTP request
177 * Revision 1.64 2002/03/03 09:18:03 joergs
178 * Made jumbjuster work on AmigaOS again.
180 * Revision 1.63 2002/03/02 04:14:50 david__schmidt
181 * Clean up a little CRLF unpleasantness that suddenly appeared
183 * Revision 1.62 2002/02/20 23:17:23 jongfoster
184 * Detecting some out-of memory conditions and exiting with a log message.
186 * Revision 1.61 2002/01/17 21:01:52 jongfoster
187 * Moving all our URL and URL pattern parsing code to urlmatch.c.
189 * Revision 1.60 2001/12/30 14:07:32 steudten
190 * - Add signal handling (unix)
191 * - Add SIGHUP handler (unix)
192 * - Add creation of pidfile (unix)
193 * - Add action 'top' in rc file (RH)
194 * - Add entry 'SIGNALS' to manpage
195 * - Add exit message to logfile (unix)
197 * Revision 1.59 2001/12/13 14:07:18 oes
198 * Fixed Bug: 503 error page now sent OK
200 * Revision 1.58 2001/11/30 23:37:24 jongfoster
201 * Renaming the Win32 config file to config.txt - this is almost the
202 * same as the corresponding UNIX name "config"
204 * Revision 1.57 2001/11/16 00:47:43 jongfoster
205 * Changing the tty-disconnection code to use setsid().
207 * Revision 1.56 2001/11/13 20:20:54 jongfoster
208 * Tabs->spaces, fixing a bug with missing {} around an if()
210 * Revision 1.55 2001/11/13 20:14:53 jongfoster
211 * Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
213 * Revision 1.54 2001/11/07 00:03:14 steudten
214 * Give reliable return value if an error
215 * occurs not just 0 with new daemon mode.
217 * Revision 1.53 2001/11/05 21:41:43 steudten
218 * Add changes to be a real daemon just for unix os.
219 * (change cwd to /, detach from controlling tty, set
220 * process group and session leader to the own process.
222 * Add some fatal-error log message for failed malloc().
223 * Add '-d' if compiled with 'configure --with-debug' to
224 * enable debug output.
226 * Revision 1.52 2001/10/26 20:11:20 jongfoster
227 * Fixing type mismatch
229 * Revision 1.51 2001/10/26 17:38:28 oes
232 * Revision 1.50 2001/10/25 03:40:48 david__schmidt
233 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
234 * threads to call select() simultaneously. So, it's time to do a real, live,
235 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
236 * (native). Both versions will work, but using __OS2__ offers multi-threading.
238 * Revision 1.49 2001/10/23 21:41:35 jongfoster
239 * Added call to initialize the (statically-allocated of course)
240 * "out of memory" CGI response.
242 * Revision 1.48 2001/10/10 19:56:46 jongfoster
243 * Moving some code that wasn't cookie-related out of an #ifdef
246 * Revision 1.47 2001/10/10 16:44:36 oes
247 * Added CONNECT destination port limitation check
249 * Revision 1.46 2001/10/08 15:17:41 oes
250 * Re-enabled SSL forwarding
252 * Revision 1.45 2001/10/07 15:42:11 oes
253 * Replaced 6 boolean members of csp with one bitmap (csp->flags)
255 * Moved downgrading of the HTTP version from parse_http_request to
256 * chat(), since we can't decide if it is necessary before we have
257 * determined the actions for the URL. The HTTP command is now
258 * *always* re-built so the repairs need no longer be special-cased.
260 * filter_popups now gets a csp pointer so it can raise the new
261 * CSP_FLAG_MODIFIED flag.
265 * Added configurable size limit for the IOB. If the IOB grows so
266 * large that the next read would exceed the limit, the header
267 * is generated, and the header & unfiltered buffer are flushed
268 * to the client. Chat then continues in non-buffering,
269 * non-filtering body mode.
271 * Revision 1.44 2001/10/02 18:13:57 oes
274 * Revision 1.43 2001/10/02 15:32:13 oes
275 * Moved generation of hdr
277 * Revision 1.42 2001/09/21 23:02:02 david__schmidt
278 * Cleaning up 2 compiler warnings on OS/2.
280 * Revision 1.41 2001/09/16 17:05:14 jongfoster
281 * Removing unused #include showarg.h
283 * Revision 1.40 2001/09/16 15:41:45 jongfoster
284 * Fixing signed/unsigned comparison warning.
286 * Revision 1.39 2001/09/16 13:21:27 jongfoster
287 * Changes to use new list functions.
289 * Revision 1.38 2001/09/16 13:01:46 jongfoster
290 * Removing redundant function call that zeroed zalloc()'d memory.
292 * Revision 1.37 2001/09/10 11:12:24 oes
293 * Deleted unused variable
295 * Revision 1.36 2001/09/10 10:56:15 oes
296 * Silenced compiler warnings
298 * Revision 1.35 2001/07/31 14:44:22 oes
299 * Deleted unused size parameter from filter_popups()
301 * Revision 1.34 2001/07/30 22:08:36 jongfoster
302 * Tidying up #defines:
303 * - All feature #defines are now of the form FEATURE_xxx
304 * - Permanently turned off WIN_GUI_EDIT
305 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
307 * Revision 1.33 2001/07/29 19:32:00 jongfoster
308 * Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
310 * Revision 1.32 2001/07/29 18:47:05 jongfoster
311 * Adding missing #include "loadcfg.h"
313 * Revision 1.31 2001/07/29 12:17:48 oes
314 * Applied pthread fix by Paul Lieverse
316 * Revision 1.30 2001/07/25 22:57:13 jongfoster
317 * __BEOS__ no longer overrides FEATURE_PTHREAD.
318 * This is because FEATURE_PTHREAD will soon be widely used, so I
319 * want to keep it simple.
321 * Revision 1.29 2001/07/24 12:47:06 oes
322 * Applied BeOS support update by Eugenia
324 * Revision 1.28 2001/07/23 13:26:12 oes
325 * Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
327 * Revision 1.27 2001/07/19 19:09:47 haroon
328 * - Added code to take care of the situation where while processing the first
329 * server response (which includes the server header), after finding the end
330 * of the headers we were not looking past the end of the headers for
331 * content modification. I enabled it for filter_popups.
332 * Someone else should look to see if other similar operations should be
333 * done to the discarded portion of the buffer.
335 * Note 2001/07/20: No, the other content modification mechanisms will process
336 * the whole iob later anyway. --oes
338 * Revision 1.26 2001/07/18 12:31:36 oes
341 * Revision 1.25 2001/07/15 19:43:49 jongfoster
342 * Supports POSIX threads.
343 * Also removed some unused #includes.
345 * Revision 1.24 2001/07/13 14:00:40 oes
346 * - Generic content modification scheme:
347 * Each feature has its own applicability flag that is set
348 * from csp->action->flags.
349 * Replaced the "filtering" int flag , by a function pointer
350 * "content_filter" to the function that will do the content
351 * modification. If it is != NULL, the document will be buffered
352 * and processed through *content_filter, which must set
353 * csp->content_length and return a modified copy of the body
354 * or return NULL (on failiure).
355 * - Changed csp->is_text to the more generic bitmap csp->content_type
356 * which can currently take the valued CT_TEXT or CT_GIF
358 * - Removed all #ifdef PCRS
360 * Revision 1.23 2001/07/02 02:28:25 iwanttokeepanon
361 * Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
362 * the `block_acl' call. This prevents a compilation error when the user
363 * does not wish to use the "ACL" feature.
365 * Revision 1.22 2001/06/29 21:45:41 oes
366 * Indentation, CRLF->LF, Tab-> Space
368 * Revision 1.21 2001/06/29 13:29:36 oes
369 * - Cleaned up, improved comments
370 * - Unified all possible interceptors (CGI,
371 * block, trust, fast_redirect) in one
372 * place, with one (CGI) answer generation
373 * mechansim. Much clearer now.
374 * - Removed the GIF image generation, which
375 * is now done in filters.c:block_url()
376 * - Made error conditions like domain lookup
377 * failiure or (various) problems while talking
378 * to the server use cgi.c:error_response()
379 * instead of generating HTML/HTTP in chat() (yuck!)
380 * - Removed logentry from cancelled commit
382 * Revision 1.20 2001/06/09 10:55:28 jongfoster
383 * Changing BUFSIZ ==> BUFFER_SIZE
385 * Revision 1.19 2001/06/07 23:12:52 jongfoster
386 * Replacing function pointer in struct gateway with a directly
387 * called function forwarded_connect().
388 * Replacing struct gateway with struct forward_spec
390 * Revision 1.18 2001/06/03 19:12:16 oes
391 * introduced new cgi handling
393 * Revision 1.17 2001/06/01 20:07:23 jongfoster
394 * Now uses action +image-blocker{} rather than config->tinygif
396 * Revision 1.16 2001/06/01 18:49:17 jongfoster
397 * Replaced "list_share" with "list" - the tiny memory gain was not
398 * worth the extra complexity.
400 * Revision 1.15 2001/05/31 21:24:47 jongfoster
401 * Changed "permission" to "action" throughout.
402 * Removed DEFAULT_USER_AGENT - it must now be specified manually.
403 * Moved vanilla wafer check into chat(), since we must now
404 * decide whether or not to add it based on the URL.
406 * Revision 1.14 2001/05/29 20:14:01 joergs
407 * AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
410 * Revision 1.13 2001/05/29 09:50:24 jongfoster
411 * Unified blocklist/imagelist/permissionslist.
412 * File format is still under discussion, but the internal changes
415 * Also modified interceptor behaviour:
416 * - We now intercept all URLs beginning with one of the following
417 * prefixes (and *only* these prefixes):
419 * * http://ijbswa.sf.net/config/
420 * * http://ijbswa.sourceforge.net/config/
421 * - New interceptors "home page" - go to http://i.j.b/ to see it.
422 * - Internal changes so that intercepted and fast redirect pages
423 * are not replaced with an image.
424 * - Interceptors now have the option to send a binary page direct
425 * to the client. (i.e. ijb-send-banner uses this)
426 * - Implemented show-url-info interceptor. (Which is why I needed
427 * the above interceptors changes - a typical URL is
428 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
429 * The previous mechanism would not have intercepted that, and
430 * if it had been intercepted then it then it would have replaced
433 * Revision 1.12 2001/05/27 22:17:04 oes
435 * - re_process_buffer no longer writes the modified buffer
436 * to the client, which was very ugly. It now returns the
437 * buffer, which it is then written by chat.
439 * - content_length now adjusts the Content-Length: header
440 * for modified documents rather than crunch()ing it.
441 * (Length info in csp->content_length, which is 0 for
442 * unmodified documents)
444 * - For this to work, sed() is called twice when filtering.
446 * Revision 1.11 2001/05/26 17:27:53 jongfoster
447 * Added support for CLF and fixed LOG_LEVEL_LOG.
448 * Also did CRLF->LF fix of my previous patch.
450 * Revision 1.10 2001/05/26 15:26:15 jongfoster
451 * ACL feature now provides more security by immediately dropping
452 * connections from untrusted hosts.
454 * Revision 1.9 2001/05/26 00:28:36 jongfoster
455 * Automatic reloading of config file.
456 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
457 * Most of the global variables have been moved to a new
458 * struct configuration_spec, accessed through csp->config->globalname
459 * Most of the globals remaining are used by the Win32 GUI.
461 * Revision 1.8 2001/05/25 22:43:18 jongfoster
462 * Fixing minor memory leak and buffer overflow.
464 * Revision 1.7 2001/05/25 22:34:30 jongfoster
467 * Revision 1.6 2001/05/23 00:13:58 joergs
468 * AmigaOS support fixed.
470 * Revision 1.5 2001/05/22 18:46:04 oes
472 * - Enabled filtering banners by size rather than URL
473 * by adding patterns that replace all standard banner
474 * sizes with the "Junkbuster" gif to the re_filterfile
476 * - Enabled filtering WebBugs by providing a pattern
477 * which kills all 1x1 images
479 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
480 * which is selected by the (nonstandard and therefore
481 * capital) letter 'U' in the option string.
482 * It causes the quantifiers to be ungreedy by default.
483 * Appending a ? turns back to greedy (!).
485 * - Added a new interceptor ijb-send-banner, which
486 * sends back the "Junkbuster" gif. Without imagelist or
487 * MSIE detection support, or if tinygif = 1, or the
488 * URL isn't recognized as an imageurl, a lame HTML
489 * explanation is sent instead.
491 * - Added new feature, which permits blocking remote
492 * script redirects and firing back a local redirect
494 * The feature is conditionally compiled, i.e. it
495 * can be disabled with --disable-fast-redirects,
496 * plus it must be activated by a "fast-redirects"
497 * line in the config file, has its own log level
498 * and of course wants to be displayed by show-proxy-args
499 * Note: Boy, all the #ifdefs in 1001 locations and
500 * all the fumbling with configure.in and acconfig.h
501 * were *way* more work than the feature itself :-(
503 * - Because a generic redirect template was needed for
504 * this, tinygif = 3 now uses the same.
506 * - Moved GIFs, and other static HTTP response templates
511 * - Removed some >400 CRs again (Jon, you really worked
514 * Revision 1.4 2001/05/21 19:34:01 jongfoster
515 * Made failure to bind() a fatal error.
517 * Revision 1.3 2001/05/20 01:21:20 jongfoster
518 * Version 2.9.4 checkin.
519 * - Merged popupfile and cookiefile, and added control over PCRS
520 * filtering, in new "permissionsfile".
521 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
522 * file error you now get a message box (in the Win32 GUI) rather
523 * than the program exiting with no explanation.
524 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
526 * - Removed tabs from "config"
527 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
528 * - Bumped up version number.
530 * Revision 1.2 2001/05/17 22:34:44 oes
531 * - Added hint on GIF char array generation to jcc.c
532 * - Cleaned CRLF's from the sources and related files
533 * - Repaired logging for REF and FRC
535 * Revision 1.1.1.1 2001/05/15 13:58:56 oes
536 * Initial import of version 2.9.3 source tree
539 *********************************************************************/
545 #include <sys/types.h>
552 #ifdef FEATURE_PTHREAD
554 #endif /* def FEATURE_PTHREAD */
557 # ifndef FEATURE_PTHREAD
561 # include <windows.h>
562 # include <process.h>
563 # endif /* ndef FEATURE_PTHREAD */
566 # ifndef _WIN_CONSOLE
568 # endif /* ndef _WIN_CONSOLE */
570 #else /* ifndef _WIN32 */
572 # if !defined (__OS2__)
574 # include <sys/wait.h>
575 # endif /* ndef __OS2__ */
576 # include <sys/time.h>
577 # include <sys/stat.h>
578 # include <sys/ioctl.h>
581 #include <sys/termios.h>
592 # include <socket.h> /* BeOS has select() for sockets only. */
593 # include <OS.h> /* declarations for threads and stuff. */
596 # if defined(__EMX__) || defined(__OS2__)
597 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
602 #define bzero(B,N) memset(B,0x00,n)
617 #include "killpopup.h"
618 #include "miscutil.h"
620 #include "jbsockets.h"
625 #include "urlmatch.h"
627 const char jcc_h_rcs[] = JCC_H_VERSION;
628 const char project_h_rcs[] = PROJECT_H_VERSION;
631 struct client_state clients[1];
632 struct file_list files[1];
634 #ifdef FEATURE_STATISTICS
635 int urls_read = 0; /* total nr of urls read inc rejected */
636 int urls_rejected = 0; /* total nr of urls rejected */
637 #endif /* def FEATURE_STATISTICS */
639 #ifdef FEATURE_GRACEFUL_TERMINATION
643 static void listen_loop(void);
644 static void chat(struct client_state *csp);
646 void serve(struct client_state *csp);
647 #else /* ifndef AMIGA */
648 static void serve(struct client_state *csp);
649 #endif /* def AMIGA */
652 static int32 server_thread(void *data);
653 #endif /* def __BEOS__ */
656 #define sleep(N) Sleep(((N) * 1000))
660 #define sleep(N) DosSleep(((N) * 100))
663 #if defined(unix) || defined(__EMX__)
665 const char *pidfile = NULL;
666 int received_hup_signal = 0;
667 #endif /* defined unix */
672 static const char VANILLA_WAFER[] =
673 "NOTICE=TO_WHOM_IT_MAY_CONCERN_"
674 "Do_not_send_me_any_copyrighted_information_other_than_the_"
675 "document_that_I_am_requesting_or_any_of_its_necessary_components._"
676 "In_particular_do_not_send_me_any_cookies_that_"
677 "are_subject_to_a_claim_of_copyright_by_anybody._"
678 "Take_notice_that_I_refuse_to_be_bound_by_any_license_condition_"
679 "(copyright_or_otherwise)_applying_to_any_cookie._";
683 * HTTP header sent when doing HTTPS tunnelling ("CONNECT" method).
685 static const char CSUCCEED[] =
686 "HTTP/1.0 200 Connection established\n"
687 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
691 * HTTP reply sent when the browser sends something unintelligible.
693 static const char CHEADER[] =
694 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
698 * HTTP reply sent when the browser tries to tunnel ("CONNECT") to something
699 * other than a HTTPS port (as defined by +limit-connect).
701 static const char CFORBIDDEN[] =
702 "HTTP/1.0 403 Connection not allowable\r\nX-Hint: If you read this message interactively, then you know why this happens ,-)\r\n\r\n";
705 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
706 /*********************************************************************
708 * Function : sig_handler
710 * Description : Signal handler for different signals.
711 * Exit gracefully on ABRT, TERM and INT
712 * or set a flag that will cause the errlog
713 * to be reopened by the main thread on HUP.
716 * 1 : the_signal = the signal cause this function to call
720 *********************************************************************/
721 static void sig_handler(int the_signal)
728 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
736 received_hup_signal = 1;
741 * We shouldn't be here, unless we catch signals
742 * in main() that we can't handle here!
744 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
752 /*********************************************************************
756 * Description : Once a connection to the client has been accepted,
757 * this function is called (via serve()) to handle the
758 * main business of the communication. When this
759 * function returns, the caller must close the client
763 * 1 : csp = Current client state (buffers, headers, etc...)
765 * Returns : On success, the number of bytes written are returned (zero
766 * indicates nothing was written). On error, -1 is returned,
767 * and errno is set appropriately. If count is zero and the
768 * file descriptor refers to a regular file, 0 will be
769 * returned without causing any other effect. For a special
770 * file, the results are not portable.
772 *********************************************************************/
773 static void chat(struct client_state *csp)
776 * This next lines are a little ugly, but they simplifies the if statements
777 * below. Basically if TOGGLE, then we want the if to test if the
778 * CSP_FLAG_TOGGLED_ON flag ist set, else we don't. And if FEATURE_FORCE_LOAD,
779 * then we want the if to test for CSP_FLAG_FORCED , else we don't
781 #ifdef FEATURE_TOGGLE
782 # define IS_TOGGLED_ON_AND (csp->flags & CSP_FLAG_TOGGLED_ON) &&
783 #else /* ifndef FEATURE_TOGGLE */
784 # define IS_TOGGLED_ON_AND
785 #endif /* ndef FEATURE_TOGGLE */
786 #ifdef FEATURE_FORCE_LOAD
787 # define IS_NOT_FORCED_AND !(csp->flags & CSP_FLAG_FORCED) &&
788 #else /* ifndef FEATURE_FORCE_LOAD */
789 # define IS_NOT_FORCED_AND
790 #endif /* def FEATURE_FORCE_LOAD */
792 #define IS_ENABLED_AND IS_TOGGLED_ON_AND IS_NOT_FORCED_AND
794 char buf[BUFFER_SIZE];
802 int ms_iis5_hack = 0;
804 const struct forward_spec * fwd;
805 struct http_request *http;
806 int len; /* for buffer sizes */
807 #ifdef FEATURE_KILL_POPUPS
808 int block_popups; /* bool, 1==will block popups */
809 int block_popups_now = 0; /* bool, 1==currently blocking popups */
810 #endif /* def FEATURE_KILL_POPUPS */
812 int pcrs_filter; /* bool, 1==will filter through pcrs */
813 int gif_deanimate; /* bool, 1==will deanimate gifs */
815 /* Function that does the content filtering for the current request */
816 char *(*content_filter)() = NULL;
818 /* Skeleton for HTTP response, if we should intercept the request */
819 struct http_response *rsp;
824 * Read the client's request. Note that since we're not using select() we
825 * could get blocked here if a client connected, then didn't say anything!
830 len = read_socket(csp->cfd, buf, sizeof(buf));
832 if (len <= 0) break; /* error! */
835 * If there is no memory left for buffering the
836 * request, there is nothing we can do but hang up
838 if (add_to_iob(csp, buf, len))
843 req = get_header(csp);
847 break; /* no HTTP request! */
852 continue; /* more to come! */
855 #ifdef FEATURE_FORCE_LOAD
856 /* If this request contains the FORCE_PREFIX,
857 * better get rid of it now and set the force flag --oes
860 if (strstr(req, FORCE_PREFIX))
862 strclean(req, FORCE_PREFIX);
863 log_error(LOG_LEVEL_FORCE, "Enforcing request \"%s\".\n", req);
864 csp->flags |= CSP_FLAG_FORCED;
867 #endif /* def FEATURE_FORCE_LOAD */
869 parse_http_request(req, http, csp);
874 if (http->cmd == NULL)
876 strcpy(buf, CHEADER);
877 write_socket(csp->cfd, buf, strlen(buf));
879 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 400 0", csp->ip_addr_str);
884 /* decide how to route the HTTP request */
886 if ((fwd = forward_url(http, csp)) == NULL)
888 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
889 /* Never get here - LOG_LEVEL_FATAL causes program exit */
892 /* build the http request to send to the server
893 * we have to do one of the following:
895 * create = use the original HTTP request to create a new
896 * HTTP request that has either the path component
897 * without the http://domainspec (w/path) or the
898 * full orininal URL (w/url)
899 * Note that the path and/or the HTTP version may
900 * have been altered by now.
902 * connect = Open a socket to the host:port of the server
903 * and short-circuit server and client socket.
905 * pass = Pass the request unchanged if forwarding a CONNECT
906 * request to a parent proxy. Note that we'll be sending
907 * the CFAIL message ourselves if connecting to the parent
908 * fails, but we won't send a CSUCCEED message if it works,
909 * since that would result in a double message (ours and the
910 * parent's). After sending the request to the parent, we simply
916 * +--------+--------+
918 * 0 | create | connect|
920 * Forwarding +--------+--------+
922 * 1 | create | pass |
924 * +--------+--------+
929 * Determine the actions for this URL
931 #ifdef FEATURE_TOGGLE
932 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
934 /* Most compatible set of actions (i.e. none) */
935 init_current_action(csp->action);
938 #endif /* ndef FEATURE_TOGGLE */
940 url_actions(http, csp);
945 * Check if a CONNECT request is allowable:
946 * In the absence of a +limit-connect action, allow only port 443.
947 * If there is an action, allow whatever matches the specificaton.
951 if( ( !(csp->action->flags & ACTION_LIMIT_CONNECT) && csp->http->port != 443)
952 || (csp->action->flags & ACTION_LIMIT_CONNECT
953 && !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT], csp->http->port)) )
955 strcpy(buf, CFORBIDDEN);
956 write_socket(csp->cfd, buf, strlen(buf));
958 log_error(LOG_LEVEL_CONNECT, "Denying suspicious CONNECT request from %s", csp->ip_addr_str);
959 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 403 0", csp->ip_addr_str);
967 * Downgrade http version from 1.1 to 1.0 if +downgrade
970 if ( (http->ssl == 0)
971 && (!strcmpic(http->ver, "HTTP/1.1"))
972 && (csp->action->flags & ACTION_DOWNGRADE))
975 http->ver = strdup("HTTP/1.0");
977 if (http->ver == NULL)
979 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
984 * Save a copy of the original request for logging
986 http->ocmd = strdup(http->cmd);
988 if (http->ocmd == NULL)
990 log_error(LOG_LEVEL_FATAL, "Out of memory copying HTTP request line");
994 * (Re)build the HTTP request for non-SSL requests.
995 * If forwarding, use the whole URL, else, use only the path.
1001 http->cmd = strdup(http->gpc);
1002 string_append(&http->cmd, " ");
1004 if (fwd->forward_host)
1006 string_append(&http->cmd, http->url);
1010 string_append(&http->cmd, http->path);
1013 string_append(&http->cmd, " ");
1014 string_append(&http->cmd, http->ver);
1016 if (http->cmd == NULL)
1018 log_error(LOG_LEVEL_FATAL, "Out of memory rewiting SSL command");
1021 enlist(csp->headers, http->cmd);
1025 * If the user has not supplied any wafers, and the user has not
1026 * told us to suppress the vanilla wafer, then send the vanilla wafer.
1028 if (list_is_empty(csp->action->multi[ACTION_MULTI_WAFER])
1029 && ((csp->action->flags & ACTION_VANILLA_WAFER) != 0))
1031 enlist(csp->action->multi[ACTION_MULTI_WAFER], VANILLA_WAFER);
1035 #ifdef FEATURE_KILL_POPUPS
1036 block_popups = ((csp->action->flags & ACTION_NO_POPUPS) != 0);
1037 #endif /* def FEATURE_KILL_POPUPS */
1039 pcrs_filter = (csp->rlist != NULL) && /* There are expressions to be used */
1040 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER]));
1042 gif_deanimate = ((csp->action->flags & ACTION_DEANIMATE) != 0);
1044 /* grab the rest of the client's headers */
1048 if ( ( ( p = get_header(csp) ) != NULL) && ( *p == '\0' ) )
1050 len = read_socket(csp->cfd, buf, sizeof(buf));
1053 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1058 * If there is no memory left for buffering the
1059 * request, there is nothing we can do but hang up
1061 if (add_to_iob(csp, buf, len))
1068 if (p == NULL) break;
1070 enlist(csp->headers, p);
1074 * We have a request. Now, check to see if we need to
1075 * intercept it, i.e. If ..
1079 /* a CGI call was detected and answered */
1080 (NULL != (rsp = dispatch_cgi(csp)))
1082 /* or we are enabled and... */
1083 || (IS_ENABLED_AND (
1085 /* ..the request was blocked */
1086 ( NULL != (rsp = block_url(csp)))
1088 /* ..or untrusted */
1089 #ifdef FEATURE_TRUST
1090 || ( NULL != (rsp = trust_url(csp)))
1091 #endif /* def FEATURE_TRUST */
1093 /* ..or a fast redirect kicked in */
1094 #ifdef FEATURE_FAST_REDIRECTS
1095 || (((csp->action->flags & ACTION_FAST_REDIRECTS) != 0) &&
1096 (NULL != (rsp = redirect_url(csp))))
1097 #endif /* def FEATURE_FAST_REDIRECTS */
1101 /* Write the answer to the client */
1102 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1103 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1105 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1108 #ifdef FEATURE_STATISTICS
1109 /* Count as a rejected request */
1110 csp->flags |= CSP_FLAG_REJECTED;
1111 #endif /* def FEATURE_STATISTICS */
1113 /* Log (FIXME: All intercept reasons apprear as "crunch" with Status 200) */
1114 log_error(LOG_LEVEL_GPC, "%s%s crunch!", http->hostport, http->path);
1115 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3", csp->ip_addr_str, http->ocmd);
1117 /* Clean up and return */
1118 free_http_response(rsp);
1122 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1124 if (fwd->forward_host)
1126 log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
1127 fwd->forward_host, fwd->forward_port, http->hostport);
1131 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1134 /* here we connect to the server, gateway, or the forwarder */
1136 csp->sfd = forwarded_connect(fwd, http, csp);
1138 if (csp->sfd == JB_INVALID_SOCKET)
1140 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1143 if (errno == EINVAL)
1145 rsp = error_response(csp, "no-such-domain", errno);
1147 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 404 0",
1148 csp->ip_addr_str, http->ocmd);
1152 rsp = error_response(csp, "connect-failed", errno);
1154 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1155 csp->ip_addr_str, http->ocmd);
1159 /* Write the answer to the client */
1162 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1163 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1165 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1169 free_http_response(rsp);
1173 log_error(LOG_LEVEL_CONNECT, "OK");
1175 hdr = sed(client_patterns, add_client_headers, csp);
1178 /* FIXME Should handle error properly */
1179 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1182 list_remove_all(csp->headers);
1184 if (fwd->forward_host || (http->ssl == 0))
1186 /* write the client's (modified) header to the server
1187 * (along with anything else that may be in the buffer)
1190 if (write_socket(csp->sfd, hdr, strlen(hdr))
1191 || (flush_socket(csp->sfd, csp) < 0))
1193 log_error(LOG_LEVEL_CONNECT, "write header to: %s failed: %E",
1196 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1197 csp->ip_addr_str, http->ocmd);
1199 rsp = error_response(csp, "connect-failed", errno);
1203 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1204 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1206 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1210 free_http_response(rsp);
1218 * We're running an SSL tunnel and we're not forwarding,
1219 * so just send the "connect succeeded" message to the
1220 * client, flush the rest, and get out of the way.
1222 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 2\n",
1223 csp->ip_addr_str, http->ocmd);
1225 if (write_socket(csp->cfd, CSUCCEED, sizeof(CSUCCEED)-1))
1233 /* we're finished with the client's header */
1236 maxfd = ( csp->cfd > csp->sfd ) ? csp->cfd : csp->sfd;
1238 /* pass data between the client and server
1239 * until one or the other shuts down the connection.
1248 * FD_ZERO here seems to point to an errant macro which crashes.
1249 * So do this by hand for now...
1251 memset(&rfds,0x00,sizeof(fd_set));
1255 FD_SET(csp->cfd, &rfds);
1256 FD_SET(csp->sfd, &rfds);
1258 n = select((int)maxfd+1, &rfds, NULL, NULL, NULL);
1262 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1266 /* this is the body of the browser's request
1267 * just read it and write it.
1270 if (FD_ISSET(csp->cfd, &rfds))
1272 len = read_socket(csp->cfd, buf, sizeof(buf));
1276 break; /* "game over, man" */
1279 if (write_socket(csp->sfd, buf, (size_t)len))
1281 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1288 * The server wants to talk. It could be the header or the body.
1289 * If `hdr' is null, then it's the header otherwise it's the body.
1290 * FIXME: Does `hdr' really mean `host'? No.
1294 if (FD_ISSET(csp->sfd, &rfds))
1297 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
1301 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
1303 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1304 csp->ip_addr_str, http->ocmd);
1306 rsp = error_response(csp, "connect-failed", errno);
1310 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1311 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1313 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1317 free_http_response(rsp);
1321 /* Add a trailing zero. This lets filter_popups
1322 * use string operations.
1326 #ifdef FEATURE_KILL_POPUPS
1327 /* Filter the popups on this read. */
1328 if (block_popups_now)
1330 filter_popups(buf, csp);
1332 #endif /* def FEATURE_KILL_POPUPS */
1334 /* Normally, this would indicate that we've read
1335 * as much as the server has sent us and we can
1336 * close the client connection. However, Microsoft
1337 * in its wisdom has released IIS/5 with a bug that
1338 * prevents it from sending the trailing \r\n in
1339 * a 302 redirect header (and possibly other headers).
1340 * To work around this if we've haven't parsed
1341 * a full header we'll append a trailing \r\n
1342 * and see if this now generates a valid one.
1344 * This hack shouldn't have any impacts. If we've
1345 * already transmitted the header or if this is a
1346 * SSL connection, then we won't bother with this
1347 * hack. So we only work on partially received
1348 * headers. If we append a \r\n and this still
1349 * doesn't generate a valid header, then we won't
1350 * transmit anything to the client.
1355 if (server_body || http->ssl)
1358 * If we have been buffering up the document,
1359 * now is the time to apply content modification
1360 * and send the result to the client.
1365 * If the content filter fails, use the original
1366 * buffer and length.
1367 * (see p != NULL ? p : csp->iob->cur below)
1369 if (NULL == (p = (*content_filter)(csp)))
1371 csp->content_length = csp->iob->eod - csp->iob->cur;
1374 hdr = sed(server_patterns, add_server_headers, csp);
1377 /* FIXME Should handle error properly */
1378 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1381 if (write_socket(csp->cfd, hdr, strlen(hdr))
1382 || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
1384 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
1394 break; /* "game over, man" */
1398 * This is NOT the body, so
1399 * Let's pretend the server just sent us a blank line.
1401 len = sprintf(buf, "\r\n");
1404 * Now, let the normal header parsing algorithm below do its
1405 * job. If it fails, we'll exit instead of continuing.
1412 * If this is an SSL connection or we're in the body
1413 * of the server document, just write it to the client,
1414 * unless we need to buffer the body for later content-filtering
1417 if (server_body || http->ssl)
1422 * If there is no memory left for buffering the content, or the buffer limit
1423 * has been reached, switch to non-filtering mode, i.e. make & write the
1424 * header, flush the iob and buf, and get out of the way.
1426 if (add_to_iob(csp, buf, len))
1431 log_error(LOG_LEVEL_ERROR, "Flushing header and buffers. Stepping back from filtering.");
1433 hdr = sed(server_patterns, add_server_headers, csp);
1437 * Memory is too tight to even generate the header.
1438 * Send our static "Out-of-memory" page.
1440 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
1441 rsp = cgi_error_memory();
1443 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1444 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1446 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1451 hdrlen = strlen(hdr);
1453 if (write_socket(csp->cfd, hdr, hdrlen)
1454 || ((flushed = flush_socket(csp->cfd, csp)) < 0)
1455 || (write_socket(csp->cfd, buf, len)))
1457 log_error(LOG_LEVEL_CONNECT, "Flush header and buffers to client failed: %E");
1463 byte_count += hdrlen + flushed + len;
1465 content_filter = NULL;
1472 if (write_socket(csp->cfd, buf, (size_t)len))
1474 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
1483 /* we're still looking for the end of the
1484 * server's header ... (does that make header
1485 * parsing an "out of body experience" ?
1489 * buffer up the data we just read. If that fails,
1490 * there's little we can do but send our static
1491 * out-of-memory page.
1493 if (add_to_iob(csp, buf, len))
1495 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
1496 rsp = cgi_error_memory();
1498 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1499 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1501 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1506 /* get header lines from the iob */
1508 while ((p = get_header(csp)) != NULL)
1512 /* see following note */
1515 enlist(csp->headers, p);
1519 /* NOTE: there are no "empty" headers so
1520 * if the pointer `p' is not NULL we must
1521 * assume that we reached the end of the
1522 * buffer before we hit the end of the header.
1529 /* Well, we tried our MS IIS/5
1530 * hack and it didn't work.
1531 * The header is incomplete
1532 * and there isn't anything
1533 * we can do about it.
1539 /* Since we have to wait for
1540 * more from the server before
1541 * we can parse the headers
1542 * we just continue here.
1548 /* we have now received the entire header.
1549 * filter it and send the result to the client
1552 hdr = sed(server_patterns, add_server_headers, csp);
1555 /* FIXME Should handle error properly */
1556 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1559 #ifdef FEATURE_KILL_POPUPS
1560 /* Start blocking popups if appropriate. */
1562 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1563 !http->ssl && /* We talk plaintext */
1564 block_popups) /* Policy allows */
1566 block_popups_now = 1;
1568 * Filter the part of the body that came in the same read
1569 * as the last headers:
1571 filter_popups(csp->iob->cur, csp);
1574 #endif /* def FEATURE_KILL_POPUPS */
1576 /* Buffer and pcrs filter this if appropriate. */
1578 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1579 !http->ssl && /* We talk plaintext */
1580 pcrs_filter) /* Policy allows */
1582 content_filter = pcrs_filter_response;
1585 /* Buffer and gif_deanimate this if appropriate. */
1587 if ((csp->content_type & CT_GIF) && /* It's a image/gif MIME-Type */
1588 !http->ssl && /* We talk plaintext */
1589 gif_deanimate) /* Policy allows */
1591 content_filter = gif_deanimate_response;
1595 * Only write if we're not buffering for content modification
1597 if (!content_filter)
1599 /* write the server's (modified) header to
1600 * the client (along with anything else that
1601 * may be in the buffer)
1604 if (write_socket(csp->cfd, hdr, strlen(hdr))
1605 || ((len = flush_socket(csp->cfd, csp)) < 0))
1607 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
1609 /* the write failed, so don't bother
1610 * mentioning it to the client...
1611 * it probably can't hear us anyway.
1620 /* we're finished with the server's header */
1625 /* If this was a MS IIS/5 hack then it means
1626 * the server has already closed the
1627 * connection. Nothing more to read. Time
1638 return; /* huh? we should never get here */
1641 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %d",
1642 csp->ip_addr_str, http->ocmd, byte_count);
1646 /*********************************************************************
1650 * Description : This is little more than chat. We only "serve" to
1651 * to close any socket that chat may have opened.
1654 * 1 : csp = Current client state (buffers, headers, etc...)
1658 *********************************************************************/
1660 void serve(struct client_state *csp)
1661 #else /* ifndef AMIGA */
1662 static void serve(struct client_state *csp)
1663 #endif /* def AMIGA */
1666 close_socket(csp->cfd);
1668 if (csp->sfd != JB_INVALID_SOCKET)
1670 close_socket(csp->sfd);
1673 csp->flags &= ~CSP_FLAG_ACTIVE;
1679 /*********************************************************************
1681 * Function : server_thread
1683 * Description : We only exist to call `serve' in a threaded environment.
1686 * 1 : data = Current client state (buffers, headers, etc...)
1688 * Returns : Always 0.
1690 *********************************************************************/
1691 static int32 server_thread(void *data)
1693 serve((struct client_state *) data);
1700 /*********************************************************************
1704 * Description : Print usage info & exit.
1706 * Parameters : Pointer to argv[0] for identifying ourselves
1710 *********************************************************************/
1711 void usage(const char *myname)
1713 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
1714 "Usage: %s [--help] [--version] [--no-daemon] [--pidfile pidfile] [--user user[.group]] [configfile]\n"
1715 "Aborting.\n", myname);
1722 /*********************************************************************
1726 * Description : Load the config file and start the listen loop.
1727 * This function is a lot more *sane* with the `load_config'
1728 * and `listen_loop' functions; although it stills does
1729 * a *little* too much for my taste.
1732 * 1 : argc = Number of parameters (including $0).
1733 * 2 : argv = Array of (char *)'s to the parameters.
1735 * Returns : 1 if : can't open config file, unrecognized directive,
1736 * stats requested in multi-thread mode, can't open the
1737 * log file, can't open the jar file, listen port is invalid,
1738 * any load fails, and can't bind port.
1740 * Else main never returns, the process must be signaled
1741 * to terminate execution. Or, on Windows, use the
1742 * "File", "Exit" menu option.
1744 *********************************************************************/
1746 int real_main(int argc, const char *argv[])
1748 int main(int argc, const char *argv[])
1753 struct passwd *pw = NULL;
1754 struct group *grp = NULL;
1762 #if !defined(_WIN32)
1770 * Parse the command line arguments
1772 while (++argc_pos < argc)
1774 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
1776 if (strcmp(argv[argc_pos], "--help") == 0)
1781 else if(strcmp(argv[argc_pos], "--version") == 0)
1783 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
1787 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
1792 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
1794 if (++argc_pos == argc) usage(argv[0]);
1795 pidfile = strdup(argv[argc_pos]);
1798 else if (strcmp(argv[argc_pos], "--user" ) == 0)
1800 if (++argc_pos == argc) usage(argv[argc_pos]);
1802 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
1805 if (NULL == (grp = getgrnam(p)))
1807 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
1811 if (NULL == (pw = getpwnam(argv[argc_pos])))
1813 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
1816 if (p != NULL) *--p = '\0';
1818 #endif /* defined(unix) */
1820 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1822 configfile = argv[argc_pos];
1825 } /* -END- while (more arguments) */
1828 if ( *configfile != '/' )
1832 /* make config-filename absolute here */
1833 if ( !(basedir = getcwd( NULL, 1024 )))
1835 perror("get working dir failed");
1839 if ( !(abs_file = malloc( strlen( basedir ) + strlen( configfile ) + 5 )))
1841 perror("malloc failed");
1844 strcpy( abs_file, basedir );
1845 strcat( abs_file, "/" );
1846 strcat( abs_file, configfile );
1847 configfile = abs_file;
1849 #endif /* defined unix */
1856 #elif defined(_WIN32)
1861 * Unix signal handling
1863 * Catch the abort, interrupt and terminate signals for a graceful exit
1864 * Catch the hangup signal so the errlog can be reopened.
1865 * Ignore the broken pipe and child signals
1866 * FIXME: Isn't ignoring the default for SIGCHLD anyway and why ignore SIGPIPE?
1868 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1871 const int catched_signals[] = { SIGABRT, SIGTERM, SIGINT, SIGHUP, 0 };
1872 const int ignored_signals[] = { SIGPIPE, SIGCHLD, 0 };
1874 for (idx = 0; catched_signals[idx] != 0; idx++)
1876 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
1878 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
1882 for (idx = 0; ignored_signals[idx] != 0; idx++)
1884 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
1886 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
1891 #else /* ifdef _WIN32 */
1892 # ifdef _WIN_CONSOLE
1894 * We *are* in a windows console app.
1895 * Print a verbose messages about FAQ's and such
1897 printf(win32_blurb);
1898 # endif /* def _WIN_CONSOLE */
1899 #endif /* def _WIN32 */
1902 /* Initialize the CGI subsystem */
1903 cgi_init_error_messages();
1906 * If runnig on unix and without the --nodaemon
1907 * option, become a daemon. I.e. fork, detach
1908 * from tty and get process group leadership
1921 if ( pid < 0 ) /* error */
1926 else if ( pid != 0 ) /* parent */
1931 * must check for errors
1932 * child died due to missing files aso
1935 wpid = waitpid( pid, &status, WNOHANG );
1944 /* Should be more portable, but not as well tested */
1949 #else /* ndef __FreeBSD__ */
1951 #endif /* ndef __FreeBSD__ */
1952 fd = open("/dev/tty", O_RDONLY);
1955 /* no error check here */
1956 ioctl( fd, TIOCNOTTY,0 );
1960 /* FIXME: should close stderr (fd 2) here too, but the test
1962 * and load config file is done in listen_loop() and puts
1963 * some messages on stderr there.
1970 } /* -END- if (!no_daemon) */
1973 * As soon as we have written the PID file, we can switch
1974 * to the user and group ID indicated by the --user option
1980 if (((NULL != grp) && setgid(grp->gr_gid)) || (setgid(pw->pw_gid)))
1982 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
1984 if (setuid(pw->pw_uid))
1986 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
1990 #endif /* defined unix */
2000 /*********************************************************************
2002 * Function : bind_port_helper
2004 * Description : Bind the listen port. Handles logging, and aborts
2008 * 1 : config = Privoxy configuration. Specifies port
2011 * Returns : Port that was opened.
2013 *********************************************************************/
2014 static jb_socket bind_port_helper(struct configuration_spec * config)
2019 if ( (config->haddr != NULL)
2020 && (config->haddr[0] == '1')
2021 && (config->haddr[1] == '2')
2022 && (config->haddr[2] == '7')
2023 && (config->haddr[3] == '.') )
2025 log_error(LOG_LEVEL_INFO, "Listening on port %d for local connections only",
2028 else if (config->haddr == NULL)
2030 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
2035 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
2036 config->hport, config->haddr);
2039 result = bind_port(config->haddr, config->hport, &bfd);
2046 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2047 "There may be another Privoxy or some other "
2048 "proxy running on port %d",
2049 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
2050 config->hport, config->hport);
2053 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2054 "The hostname is not resolvable",
2055 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2058 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
2059 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2062 /* shouldn't get here */
2063 return JB_INVALID_SOCKET;
2066 config->need_bind = 0;
2072 /*********************************************************************
2074 * Function : listen_loop
2076 * Description : bind the listen port and enter a "FOREVER" listening loop.
2082 *********************************************************************/
2083 static void listen_loop(void)
2085 struct client_state *csp = NULL;
2087 struct configuration_spec * config;
2089 config = load_config();
2091 bfd = bind_port_helper(config);
2093 #ifdef FEATURE_GRACEFUL_TERMINATION
2094 while (!g_terminate)
2099 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
2100 while (waitpid(-1, NULL, WNOHANG) > 0)
2102 /* zombie children */
2104 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
2107 * Free data that was used by died threads
2113 * Re-open the errlog after HUP signal
2115 if (received_hup_signal)
2117 init_error_log(Argv[0], config->logfile, config->debug);
2118 received_hup_signal = 0;
2123 #ifdef FEATURE_COOKIE_JAR
2125 * Need a workaround here: we have to fclose() the jarfile, or we die because it's
2126 * already open. I think unload_configfile() is not being run, which should do
2127 * this work. Until that can get resolved, we'll use this workaround.
2131 if (csp->config->jar)
2133 fclose(csp->config->jar);
2134 csp->config->jar = NULL;
2136 #endif /* FEATURE_COOKIE_JAR */
2137 #endif /* __OS2__ */
2139 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
2141 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
2145 csp->flags |= CSP_FLAG_ACTIVE;
2146 csp->sfd = JB_INVALID_SOCKET;
2148 csp->config = config = load_config();
2150 if ( config->need_bind )
2153 * Since we were listening to the "old port", we will not see
2154 * a "listen" param change until the next IJB request. So, at
2155 * least 1 more request must be made for us to find the new
2156 * setting. I am simply closing the old socket and binding the
2159 * Which-ever is correct, we will serve 1 more page via the
2160 * old settings. This should probably be a "show-proxy-args"
2161 * request. This should not be a so common of an operation
2162 * that this will hurt people's feelings.
2167 bfd = bind_port_helper(config);
2170 log_error(LOG_LEVEL_CONNECT, "accept connection ... ");
2172 if (!accept_connection(csp, bfd))
2174 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
2187 log_error(LOG_LEVEL_CONNECT, "OK");
2190 #ifdef FEATURE_TOGGLE
2193 csp->flags |= CSP_FLAG_TOGGLED_ON;
2195 #endif /* def FEATURE_TOGGLE */
2197 if (run_loader(csp))
2199 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
2200 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2204 if (block_acl(NULL,csp))
2206 log_error(LOG_LEVEL_CONNECT, "Connection dropped due to ACL");
2207 close_socket(csp->cfd);
2211 #endif /* def FEATURE_ACL */
2213 /* add it to the list of clients */
2214 csp->next = clients->next;
2215 clients->next = csp;
2217 if (config->multi_threaded)
2221 /* this is a switch () statment in the C preprocessor - ugh */
2222 #undef SELECTED_ONE_OPTION
2224 /* Use Pthreads in preference to native code */
2225 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
2226 #define SELECTED_ONE_OPTION
2228 pthread_t the_thread;
2229 pthread_attr_t attrs;
2231 pthread_attr_init(&attrs);
2232 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
2233 child_id = (pthread_create(&the_thread, &attrs,
2234 (void*)serve, csp) ? -1 : 0);
2235 pthread_attr_destroy(&attrs);
2239 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
2240 #define SELECTED_ONE_OPTION
2241 child_id = _beginthread(
2242 (void (*)(void *))serve,
2247 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
2248 #define SELECTED_ONE_OPTION
2249 child_id = _beginthread(
2250 (void(* _Optlink)(void*))serve,
2256 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
2257 #define SELECTED_ONE_OPTION
2259 thread_id tid = spawn_thread
2260 (server_thread, "server", B_NORMAL_PRIORITY, csp);
2262 if ((tid >= 0) && (resume_thread(tid) == B_OK))
2264 child_id = (int) tid;
2273 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
2274 #define SELECTED_ONE_OPTION
2275 csp->cfd = ReleaseSocket(csp->cfd, -1);
2276 if((child_id = (int)CreateNewProcTags(
2277 NP_Entry, (ULONG)server_thread,
2278 NP_Output, Output(),
2279 NP_CloseOutput, FALSE,
2280 NP_Name, (ULONG)"privoxy child",
2281 NP_StackSize, 200*1024,
2285 ((struct Task *)child_id)->tc_UserData = csp;
2286 Signal((struct Task *)child_id, SIGF_SINGLE);
2291 #if !defined(SELECTED_ONE_OPTION)
2294 /* This block is only needed when using fork().
2295 * When using threads, the server thread was
2296 * created and run by the call to _beginthread().
2298 if (child_id == 0) /* child */
2304 else if (child_id > 0) /* parent */
2306 /* in a fork()'d environment, the parent's
2307 * copy of the client socket and the CSP
2311 #if !defined(_WIN32) && defined(__CYGWIN__)
2313 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
2314 close_socket(csp->cfd);
2315 csp->flags &= ~CSP_FLAG_ACTIVE;
2319 #undef SELECTED_ONE_OPTION
2320 /* end of cpp switch () */
2322 if (child_id < 0) /* failed */
2324 char buf[BUFFER_SIZE];
2326 log_error(LOG_LEVEL_ERROR, "can't fork: %E");
2328 sprintf(buf , "Privoxy: can't fork: errno = %d", errno);
2330 write_socket(csp->cfd, buf, strlen(buf));
2331 close_socket(csp->cfd);
2332 csp->flags &= ~CSP_FLAG_ACTIVE;
2343 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
2345 /* Clean up. Aim: free all memory (no leaks) */
2346 #ifdef FEATURE_GRACEFUL_TERMINATION
2348 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
2350 unload_current_config_file();
2351 unload_current_actions_file();
2352 unload_current_re_filterfile();
2353 #ifdef FEATURE_TRUST
2354 unload_current_trust_file();
2357 if (config->multi_threaded)
2364 } while ((clients->next != NULL) && (--i > 0));
2368 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
2377 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
2378 /* Cleanup - remove taskbar icon etc. */
2383 #endif /* FEATURE_GRACEFUL_TERMINATION */