1 const char jcc_rcs[] = "$Id: jcc.c,v 1.122 2007/02/07 11:12:02 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/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-2007 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.122 2007/02/07 11:12:02 fabiankeil
37 * - Move delivery and logging of crunched responses
38 * from chat() into send_crunch_response().
39 * - Display the reason for generating http_responses.
40 * - Log the content length for LOG_LEVEL_CLF correctly
41 * (still incorrect for some fixed responses).
42 * - Reword an incorrect comment about
43 * treat-forbidden-connects-like-blocks violating
45 * - Add some log messages.
47 * Revision 1.121 2007/01/27 10:52:56 fabiankeil
48 * Move mutex initialization into separate
49 * function and exit in case of errors.
51 * Revision 1.120 2007/01/26 14:18:42 fabiankeil
52 * - Start to reduce chat()'s line count and move
53 * parts of it into separate functions.
54 * - Add "HTTP/1.1 100 Continue" hack for BR 756734.
56 * Revision 1.119 2007/01/25 14:02:30 fabiankeil
57 * - Add Proxy-Agent header to HTTP snippets that are
58 * supposed to reach HTTP clients only.
59 * - Made a few CONNECT log messages more descriptive.
60 * - Catch completely empty server responses (as seen
61 * with Tor's fake ".noconnect" top level domain).
62 * - Use shiny new "forwarding-failed" template for socks errors.
64 * Revision 1.118 2007/01/07 07:43:43 joergs
65 * AmigaOS4 support added.
67 * Revision 1.117 2006/12/31 17:56:37 fabiankeil
68 * Added config option accept-intercepted-requests
69 * and disabled it by default.
71 * Revision 1.116 2006/12/29 19:08:22 fabiankeil
72 * Reverted parts of my last commit
73 * to keep error handling working.
75 * Revision 1.115 2006/12/29 17:38:57 fabiankeil
76 * Fixed gcc43 conversion warnings.
78 * Revision 1.114 2006/12/27 18:52:02 fabiankeil
79 * Fix -pedantic ISO C warning about converting
80 * from function pointer to object pointer.
82 * Revision 1.113 2006/12/26 17:38:50 fabiankeil
83 * Silence compiler warning I introduced with my last commit.
85 * Revision 1.112 2006/12/26 17:31:41 fabiankeil
86 * Mutex protect rand() if POSIX threading
87 * is used, warn the user if that's not possible
88 * and stop using it on _WIN32 where it could
91 * Revision 1.111 2006/12/23 16:15:06 fabiankeil
92 * Don't prevent core dumps by catching SIGABRT.
93 * It's rude and makes debugging unreasonable painful.
95 * Revision 1.110 2006/12/13 14:52:53 etresoft
96 * Fix build failure on MacOS X. Global symbols can be either static or extern, but not both.
98 * Revision 1.109 2006/12/06 19:41:40 fabiankeil
99 * Privoxy is now able to run as intercepting
100 * proxy in combination with any packet filter
101 * that does the port redirection. The destination
102 * is extracted from the "Host:" header which
103 * should be available for nearly all requests.
105 * Moved HTTP snipplets into jcc.c.
106 * Added error message for gopher proxy requests.
108 * Revision 1.108 2006/11/28 15:38:51 fabiankeil
109 * Only unlink the pidfile if it's actually used.
111 * Change order of interception checks to make
112 * it possible to block or redirect requests for
115 * Revision 1.107 2006/11/13 19:05:51 fabiankeil
116 * Make pthread mutex locking more generic. Instead of
117 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
118 * and use mutex locking unless there is an _r function
119 * available. Better safe than sorry.
121 * Fixes "./configure --disable-pthread" and should result
122 * in less threading-related problems on pthread-using platforms,
123 * but it still doesn't fix BR#1122404.
125 * Revision 1.106 2006/11/06 19:58:23 fabiankeil
126 * Move pthread.h inclusion from jcc.c to jcc.h.
127 * Fixes build on x86-freebsd1 (FreeBSD 5.4-RELEASE).
129 * Revision 1.105 2006/11/06 14:26:02 fabiankeil
130 * Don't exit after receiving the second SIGHUP on Solaris.
132 * Fixes BR 1052235, but the same problem may exist on other
133 * systems. Once 3.0.6 is out we should use sigset()
134 * where available and see if it breaks anything.
136 * Revision 1.104 2006/09/23 13:26:38 roro
137 * Replace TABs by spaces in source code.
139 * Revision 1.103 2006/09/21 12:54:43 fabiankeil
140 * Fix +redirect{}. Didn't work with -fast-redirects.
142 * Revision 1.102 2006/09/06 13:03:04 fabiankeil
143 * Respond with 400 and a short text message
144 * if the client tries to use Privoxy as FTP proxy.
146 * Revision 1.101 2006/09/06 09:23:37 fabiankeil
147 * Make number of retries in case of forwarded-connect problems
148 * a config file option (forwarded-connect-retries) and use 0 as
151 * Revision 1.100 2006/09/03 19:42:59 fabiankeil
152 * Set random(3) seed.
154 * Revision 1.99 2006/09/02 15:36:42 fabiankeil
155 * Follow the OpenBSD port's lead and protect the resolve
156 * functions on OpenBSD as well.
158 * Revision 1.98 2006/08/24 11:01:34 fabiankeil
159 * --user fix. Only use the user as group if no group is specified.
160 * Solves BR 1492612. Thanks to Spinor S. and David Laight.
162 * Revision 1.97 2006/08/18 15:23:17 david__schmidt
163 * Windows service (re-)integration
167 * --install[:service_name]
168 * --uninstall[:service_name]
171 * They work as follows:
172 * --install will create a service for you and then terminate.
173 * By default the service name will be "privoxy" (without the quotes).
174 * However you can run multiple services if you wish, just by adding
175 * a colon and then a name (no spaces).
177 * --uninstall follows the exact same rules a --install.
179 * --service is used when the program is executed by the service
180 * control manager, and in normal circumstances would never be
181 * used as a command line argument.
183 * Revision 1.96 2006/08/15 20:12:36 david__schmidt
184 * Windows service integration
186 * Revision 1.95 2006/08/03 02:46:41 david__schmidt
187 * Incorporate Fabian Keil's patch work:
188 http://www.fabiankeil.de/sourcecode/privoxy/
190 * Revision 1.94 2006/07/18 14:48:46 david__schmidt
191 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
192 * with what was really the latest development (the v_3_0_branch branch)
194 * Revision 1.92.2.16 2005/04/03 20:10:50 david__schmidt
195 * Thanks to Jindrich Makovicka for a race condition fix for the log
196 * file. The race condition remains for non-pthread implementations.
197 * Reference patch #1175720.
199 * Revision 1.92.2.15 2004/10/03 12:53:32 david__schmidt
200 * Add the ability to check jpeg images for invalid
201 * lengths of comment blocks. Defensive strategy
202 * against the exploit:
203 * Microsoft Security Bulletin MS04-028
204 * Buffer Overrun in JPEG Processing (GDI+) Could
205 * Allow Code Execution (833987)
206 * Enabled with +inspect-jpegs in actions files.
208 * Revision 1.92.2.14 2003/12/12 12:52:53 oes
209 * - Fixed usage info for non-unix platforms
210 * - Fixed small cmdline parsing bug
212 * Revision 1.92.2.13 2003/11/27 19:20:27 oes
213 * Diagnostics: Now preserve the returncode of pthread_create
214 * in errno. Closes BR #775721. Thanks to Geoffrey Hausheer.
216 * Revision 1.92.2.12 2003/07/11 11:34:19 oes
217 * No longer ignore SIGCHLD. Fixes bug #769381
219 * Revision 1.92.2.11 2003/05/14 12:32:02 oes
220 * Close jarfile on graceful exit, remove stray line
222 * Revision 1.92.2.10 2003/05/08 15:13:46 oes
223 * Cosmetics: Killed a warning, a typo and an allocation left at exit
225 * Revision 1.92.2.9 2003/04/03 15:08:42 oes
226 * No longer rely on non-POSIX.1 extensions of getcwd().
229 * Revision 1.92.2.8 2003/03/31 13:12:32 oes
230 * Replaced setenv() by posix-compliant putenv()
231 * Thanks to Neil McCalden (nmcc AT users.sf.net).
233 * Revision 1.92.2.7 2003/03/17 16:48:59 oes
234 * Added chroot ability, thanks to patch by Sviatoslav Sviridov
236 * Revision 1.92.2.6 2003/03/11 11:55:00 oes
237 * Clean-up and extension of improvements for forked mode:
238 * - Child's return code now consists of flags RC_FLAG_*
239 * - Reporting toggle to parent now properly #ifdef'ed
240 * - Children now report blocking to parent. This enables
241 * statistics in forked mode
243 * Revision 1.92.2.5 2003/03/10 23:45:32 oes
244 * Fixed bug #700381: Non-Threaded version now capable of being toggled.
245 * Children now report having been toggled through _exit(17), parents
246 * watch for that code and toggle themselves if found.
248 * Revision 1.92.2.4 2003/03/07 03:41:04 david__schmidt
249 * Wrapping all *_r functions (the non-_r versions of them) with
250 * mutex semaphores for OSX. Hopefully this will take care of all
251 * of those pesky crash reports.
253 * Revision 1.92.2.3 2003/02/28 12:53:06 oes
254 * Fixed two mostly harmless mem leaks
256 * Revision 1.92.2.2 2002/11/20 14:37:47 oes
257 * Fix: Head of global clients list now initialized to NULL
259 * Revision 1.92.2.1 2002/09/25 14:52:24 oes
260 * Added basic support for OPTIONS and TRACE HTTP methods:
261 * - New interceptor direct_response() added in chat().
262 * - sed() moved to earlier in the process, so that the
263 * Host: header is evaluated before actions and forwarding
266 * Revision 1.92 2002/05/08 16:00:46 oes
267 * Chat's buffer handling:
268 * - Fixed bug with unchecked out-of-mem conditions
269 * while reading client request & server headers
270 * - No longer predict if the buffer limit will be exceeded
271 * in the next read -- check add_to_iob's new
272 * return code. If buffer couldn't be extended
273 * (policy or out-of-mem) while
274 * - reading from client: abort
275 * - reading server headers: send error page
276 * - buffering server body for filter: flush,
277 * and if that fails: send error page
279 * Revision 1.91 2002/04/08 20:35:58 swa
282 * Revision 1.90 2002/04/02 14:57:28 oes
283 * Made sending wafers independent of FEATURE_COOKIE_JAR
285 * Revision 1.89 2002/03/31 17:18:59 jongfoster
286 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
288 * Revision 1.88 2002/03/27 14:32:43 david__schmidt
289 * More compiler warning message maintenance
291 * Revision 1.87 2002/03/26 22:29:54 swa
292 * we have a new homepage!
294 * Revision 1.86 2002/03/25 17:04:55 david__schmidt
295 * Workaround for closing the jarfile before load_config() comes around again
297 * Revision 1.85 2002/03/24 15:23:33 jongfoster
300 * Revision 1.84 2002/03/24 13:25:43 swa
301 * name change related issues
303 * Revision 1.83 2002/03/16 23:54:06 jongfoster
304 * Adding graceful termination feature, to help look for memory leaks.
305 * If you enable this (which, by design, has to be done by hand
306 * editing config.h) and then go to http://i.j.b/die, then the program
307 * will exit cleanly after the *next* request. It should free all the
308 * memory that was used.
310 * Revision 1.82 2002/03/13 00:27:05 jongfoster
313 * Revision 1.81 2002/03/12 01:42:50 oes
314 * Introduced modular filters
316 * Revision 1.80 2002/03/11 22:07:05 david__schmidt
317 * OS/2 port maintenance:
318 * - Fixed EMX build - it had decayed a little
319 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
320 * substituted a memset for now.
322 * Revision 1.79 2002/03/09 20:03:52 jongfoster
323 * - Making various functions return int rather than size_t.
324 * (Undoing a recent change). Since size_t is unsigned on
325 * Windows, functions like read_socket that return -1 on
326 * error cannot return a size_t.
328 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
329 * crashes, and also frequently caused JB to jump to 100%
330 * CPU and stay there. (Because it thought it had just
331 * read ((unsigned)-1) == 4Gb of data...)
333 * - The signature of write_socket has changed, it now simply
334 * returns success=0/failure=nonzero.
336 * - Trying to get rid of a few warnings --with-debug on
337 * Windows, I've introduced a new type "jb_socket". This is
338 * used for the socket file descriptors. On Windows, this
339 * is SOCKET (a typedef for unsigned). Everywhere else, it's
340 * an int. The error value can't be -1 any more, so it's
341 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
342 * Windows it maps to the #define INVALID_SOCKET.)
344 * - The signature of bind_port has changed.
346 * Revision 1.78 2002/03/08 21:35:04 oes
347 * Added optional group supplement to --user option. Will now use default group of user if no group given
349 * Revision 1.77 2002/03/07 03:52:06 oes
350 * - Fixed compiler warnings etc
351 * - Improved handling of failed DNS lookups
353 * Revision 1.76 2002/03/06 22:54:35 jongfoster
354 * Automated function-comment nitpicking.
356 * Revision 1.75 2002/03/06 10:02:19 oes
357 * Fixed stupid bug when --user was not given
359 * Revision 1.74 2002/03/06 00:49:31 jongfoster
360 * Fixing warning on Windows
361 * Making #ifdefs that refer to the same variable consistently
362 * use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
364 * Revision 1.73 2002/03/05 23:57:30 hal9
365 * Stray character 's' on line 1618 was breaking build.
367 * Revision 1.72 2002/03/05 21:33:45 david__schmidt
368 * - Re-enable OS/2 building after new parms were added
369 * - Fix false out of memory report when resolving CGI templates when no IP
370 * address is available of failed attempt (a la no such domain)
372 * Revision 1.71 2002/03/05 18:13:56 oes
373 * Added --user option
375 * Revision 1.70 2002/03/05 04:52:42 oes
376 * Deleted non-errlog debugging code
378 * Revision 1.69 2002/03/04 23:50:00 jongfoster
379 * Splitting off bind_port() call into bind_port_helper(), with
382 * Revision 1.68 2002/03/04 20:17:32 oes
385 * Revision 1.67 2002/03/04 18:18:57 oes
386 * - Removed _DEBUG mode
387 * - Cleand up cmdline parsing
388 * - Introduced --no-daemon, --pidfile options
389 * - Cleaned up signal handling:
390 * - Terminate cleanly on INT, TERM and ABRT
391 * - Schedule logfile for re-opening on HUP
392 * - Ignore CHLD and PIPE
393 * - Leave the rest with their default handlers
394 * - Uniform handler registration
395 * - Added usage() function
396 * - Played styleguide police
398 * Revision 1.66 2002/03/03 15:06:55 oes
399 * Re-enabled automatic config reloading
401 * Revision 1.65 2002/03/03 14:49:11 oes
402 * Fixed CLF logging: Now uses client's original HTTP request
404 * Revision 1.64 2002/03/03 09:18:03 joergs
405 * Made jumbjuster work on AmigaOS again.
407 * Revision 1.63 2002/03/02 04:14:50 david__schmidt
408 * Clean up a little CRLF unpleasantness that suddenly appeared
410 * Revision 1.62 2002/02/20 23:17:23 jongfoster
411 * Detecting some out-of memory conditions and exiting with a log message.
413 * Revision 1.61 2002/01/17 21:01:52 jongfoster
414 * Moving all our URL and URL pattern parsing code to urlmatch.c.
416 * Revision 1.60 2001/12/30 14:07:32 steudten
417 * - Add signal handling (unix)
418 * - Add SIGHUP handler (unix)
419 * - Add creation of pidfile (unix)
420 * - Add action 'top' in rc file (RH)
421 * - Add entry 'SIGNALS' to manpage
422 * - Add exit message to logfile (unix)
424 * Revision 1.59 2001/12/13 14:07:18 oes
425 * Fixed Bug: 503 error page now sent OK
427 * Revision 1.58 2001/11/30 23:37:24 jongfoster
428 * Renaming the Win32 config file to config.txt - this is almost the
429 * same as the corresponding UNIX name "config"
431 * Revision 1.57 2001/11/16 00:47:43 jongfoster
432 * Changing the tty-disconnection code to use setsid().
434 * Revision 1.56 2001/11/13 20:20:54 jongfoster
435 * Tabs->spaces, fixing a bug with missing {} around an if()
437 * Revision 1.55 2001/11/13 20:14:53 jongfoster
438 * Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
440 * Revision 1.54 2001/11/07 00:03:14 steudten
441 * Give reliable return value if an error
442 * occurs not just 0 with new daemon mode.
444 * Revision 1.53 2001/11/05 21:41:43 steudten
445 * Add changes to be a real daemon just for unix os.
446 * (change cwd to /, detach from controlling tty, set
447 * process group and session leader to the own process.
449 * Add some fatal-error log message for failed malloc().
450 * Add '-d' if compiled with 'configure --with-debug' to
451 * enable debug output.
453 * Revision 1.52 2001/10/26 20:11:20 jongfoster
454 * Fixing type mismatch
456 * Revision 1.51 2001/10/26 17:38:28 oes
459 * Revision 1.50 2001/10/25 03:40:48 david__schmidt
460 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
461 * threads to call select() simultaneously. So, it's time to do a real, live,
462 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
463 * (native). Both versions will work, but using __OS2__ offers multi-threading.
465 * Revision 1.49 2001/10/23 21:41:35 jongfoster
466 * Added call to initialize the (statically-allocated of course)
467 * "out of memory" CGI response.
469 * Revision 1.48 2001/10/10 19:56:46 jongfoster
470 * Moving some code that wasn't cookie-related out of an #ifdef
473 * Revision 1.47 2001/10/10 16:44:36 oes
474 * Added CONNECT destination port limitation check
476 * Revision 1.46 2001/10/08 15:17:41 oes
477 * Re-enabled SSL forwarding
479 * Revision 1.45 2001/10/07 15:42:11 oes
480 * Replaced 6 boolean members of csp with one bitmap (csp->flags)
482 * Moved downgrading of the HTTP version from parse_http_request to
483 * chat(), since we can't decide if it is necessary before we have
484 * determined the actions for the URL. The HTTP command is now
485 * *always* re-built so the repairs need no longer be special-cased.
487 * filter_popups now gets a csp pointer so it can raise the new
488 * CSP_FLAG_MODIFIED flag.
492 * Added configurable size limit for the IOB. If the IOB grows so
493 * large that the next read would exceed the limit, the header
494 * is generated, and the header & unfiltered buffer are flushed
495 * to the client. Chat then continues in non-buffering,
496 * non-filtering body mode.
498 * Revision 1.44 2001/10/02 18:13:57 oes
501 * Revision 1.43 2001/10/02 15:32:13 oes
502 * Moved generation of hdr
504 * Revision 1.42 2001/09/21 23:02:02 david__schmidt
505 * Cleaning up 2 compiler warnings on OS/2.
507 * Revision 1.41 2001/09/16 17:05:14 jongfoster
508 * Removing unused #include showarg.h
510 * Revision 1.40 2001/09/16 15:41:45 jongfoster
511 * Fixing signed/unsigned comparison warning.
513 * Revision 1.39 2001/09/16 13:21:27 jongfoster
514 * Changes to use new list functions.
516 * Revision 1.38 2001/09/16 13:01:46 jongfoster
517 * Removing redundant function call that zeroed zalloc()'d memory.
519 * Revision 1.37 2001/09/10 11:12:24 oes
520 * Deleted unused variable
522 * Revision 1.36 2001/09/10 10:56:15 oes
523 * Silenced compiler warnings
525 * Revision 1.35 2001/07/31 14:44:22 oes
526 * Deleted unused size parameter from filter_popups()
528 * Revision 1.34 2001/07/30 22:08:36 jongfoster
529 * Tidying up #defines:
530 * - All feature #defines are now of the form FEATURE_xxx
531 * - Permanently turned off WIN_GUI_EDIT
532 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
534 * Revision 1.33 2001/07/29 19:32:00 jongfoster
535 * Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
537 * Revision 1.32 2001/07/29 18:47:05 jongfoster
538 * Adding missing #include "loadcfg.h"
540 * Revision 1.31 2001/07/29 12:17:48 oes
541 * Applied pthread fix by Paul Lieverse
543 * Revision 1.30 2001/07/25 22:57:13 jongfoster
544 * __BEOS__ no longer overrides FEATURE_PTHREAD.
545 * This is because FEATURE_PTHREAD will soon be widely used, so I
546 * want to keep it simple.
548 * Revision 1.29 2001/07/24 12:47:06 oes
549 * Applied BeOS support update by Eugenia
551 * Revision 1.28 2001/07/23 13:26:12 oes
552 * Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
554 * Revision 1.27 2001/07/19 19:09:47 haroon
555 * - Added code to take care of the situation where while processing the first
556 * server response (which includes the server header), after finding the end
557 * of the headers we were not looking past the end of the headers for
558 * content modification. I enabled it for filter_popups.
559 * Someone else should look to see if other similar operations should be
560 * done to the discarded portion of the buffer.
562 * Note 2001/07/20: No, the other content modification mechanisms will process
563 * the whole iob later anyway. --oes
565 * Revision 1.26 2001/07/18 12:31:36 oes
568 * Revision 1.25 2001/07/15 19:43:49 jongfoster
569 * Supports POSIX threads.
570 * Also removed some unused #includes.
572 * Revision 1.24 2001/07/13 14:00:40 oes
573 * - Generic content modification scheme:
574 * Each feature has its own applicability flag that is set
575 * from csp->action->flags.
576 * Replaced the "filtering" int flag , by a function pointer
577 * "content_filter" to the function that will do the content
578 * modification. If it is != NULL, the document will be buffered
579 * and processed through *content_filter, which must set
580 * csp->content_length and return a modified copy of the body
581 * or return NULL (on failiure).
582 * - Changed csp->is_text to the more generic bitmap csp->content_type
583 * which can currently take the valued CT_TEXT or CT_GIF
585 * - Removed all #ifdef PCRS
587 * Revision 1.23 2001/07/02 02:28:25 iwanttokeepanon
588 * Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
589 * the `block_acl' call. This prevents a compilation error when the user
590 * does not wish to use the "ACL" feature.
592 * Revision 1.22 2001/06/29 21:45:41 oes
593 * Indentation, CRLF->LF, Tab-> Space
595 * Revision 1.21 2001/06/29 13:29:36 oes
596 * - Cleaned up, improved comments
597 * - Unified all possible interceptors (CGI,
598 * block, trust, fast_redirect) in one
599 * place, with one (CGI) answer generation
600 * mechansim. Much clearer now.
601 * - Removed the GIF image generation, which
602 * is now done in filters.c:block_url()
603 * - Made error conditions like domain lookup
604 * failiure or (various) problems while talking
605 * to the server use cgi.c:error_response()
606 * instead of generating HTML/HTTP in chat() (yuck!)
607 * - Removed logentry from cancelled commit
609 * Revision 1.20 2001/06/09 10:55:28 jongfoster
610 * Changing BUFSIZ ==> BUFFER_SIZE
612 * Revision 1.19 2001/06/07 23:12:52 jongfoster
613 * Replacing function pointer in struct gateway with a directly
614 * called function forwarded_connect().
615 * Replacing struct gateway with struct forward_spec
617 * Revision 1.18 2001/06/03 19:12:16 oes
618 * introduced new cgi handling
620 * Revision 1.17 2001/06/01 20:07:23 jongfoster
621 * Now uses action +image-blocker{} rather than config->tinygif
623 * Revision 1.16 2001/06/01 18:49:17 jongfoster
624 * Replaced "list_share" with "list" - the tiny memory gain was not
625 * worth the extra complexity.
627 * Revision 1.15 2001/05/31 21:24:47 jongfoster
628 * Changed "permission" to "action" throughout.
629 * Removed DEFAULT_USER_AGENT - it must now be specified manually.
630 * Moved vanilla wafer check into chat(), since we must now
631 * decide whether or not to add it based on the URL.
633 * Revision 1.14 2001/05/29 20:14:01 joergs
634 * AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
637 * Revision 1.13 2001/05/29 09:50:24 jongfoster
638 * Unified blocklist/imagelist/permissionslist.
639 * File format is still under discussion, but the internal changes
642 * Also modified interceptor behaviour:
643 * - We now intercept all URLs beginning with one of the following
644 * prefixes (and *only* these prefixes):
646 * * http://ijbswa.sf.net/config/
647 * * http://ijbswa.sourceforge.net/config/
648 * - New interceptors "home page" - go to http://i.j.b/ to see it.
649 * - Internal changes so that intercepted and fast redirect pages
650 * are not replaced with an image.
651 * - Interceptors now have the option to send a binary page direct
652 * to the client. (i.e. ijb-send-banner uses this)
653 * - Implemented show-url-info interceptor. (Which is why I needed
654 * the above interceptors changes - a typical URL is
655 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
656 * The previous mechanism would not have intercepted that, and
657 * if it had been intercepted then it then it would have replaced
660 * Revision 1.12 2001/05/27 22:17:04 oes
662 * - re_process_buffer no longer writes the modified buffer
663 * to the client, which was very ugly. It now returns the
664 * buffer, which it is then written by chat.
666 * - content_length now adjusts the Content-Length: header
667 * for modified documents rather than crunch()ing it.
668 * (Length info in csp->content_length, which is 0 for
669 * unmodified documents)
671 * - For this to work, sed() is called twice when filtering.
673 * Revision 1.11 2001/05/26 17:27:53 jongfoster
674 * Added support for CLF and fixed LOG_LEVEL_LOG.
675 * Also did CRLF->LF fix of my previous patch.
677 * Revision 1.10 2001/05/26 15:26:15 jongfoster
678 * ACL feature now provides more security by immediately dropping
679 * connections from untrusted hosts.
681 * Revision 1.9 2001/05/26 00:28:36 jongfoster
682 * Automatic reloading of config file.
683 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
684 * Most of the global variables have been moved to a new
685 * struct configuration_spec, accessed through csp->config->globalname
686 * Most of the globals remaining are used by the Win32 GUI.
688 * Revision 1.8 2001/05/25 22:43:18 jongfoster
689 * Fixing minor memory leak and buffer overflow.
691 * Revision 1.7 2001/05/25 22:34:30 jongfoster
694 * Revision 1.6 2001/05/23 00:13:58 joergs
695 * AmigaOS support fixed.
697 * Revision 1.5 2001/05/22 18:46:04 oes
699 * - Enabled filtering banners by size rather than URL
700 * by adding patterns that replace all standard banner
701 * sizes with the "Junkbuster" gif to the re_filterfile
703 * - Enabled filtering WebBugs by providing a pattern
704 * which kills all 1x1 images
706 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
707 * which is selected by the (nonstandard and therefore
708 * capital) letter 'U' in the option string.
709 * It causes the quantifiers to be ungreedy by default.
710 * Appending a ? turns back to greedy (!).
712 * - Added a new interceptor ijb-send-banner, which
713 * sends back the "Junkbuster" gif. Without imagelist or
714 * MSIE detection support, or if tinygif = 1, or the
715 * URL isn't recognized as an imageurl, a lame HTML
716 * explanation is sent instead.
718 * - Added new feature, which permits blocking remote
719 * script redirects and firing back a local redirect
721 * The feature is conditionally compiled, i.e. it
722 * can be disabled with --disable-fast-redirects,
723 * plus it must be activated by a "fast-redirects"
724 * line in the config file, has its own log level
725 * and of course wants to be displayed by show-proxy-args
726 * Note: Boy, all the #ifdefs in 1001 locations and
727 * all the fumbling with configure.in and acconfig.h
728 * were *way* more work than the feature itself :-(
730 * - Because a generic redirect template was needed for
731 * this, tinygif = 3 now uses the same.
733 * - Moved GIFs, and other static HTTP response templates
738 * - Removed some >400 CRs again (Jon, you really worked
741 * Revision 1.4 2001/05/21 19:34:01 jongfoster
742 * Made failure to bind() a fatal error.
744 * Revision 1.3 2001/05/20 01:21:20 jongfoster
745 * Version 2.9.4 checkin.
746 * - Merged popupfile and cookiefile, and added control over PCRS
747 * filtering, in new "permissionsfile".
748 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
749 * file error you now get a message box (in the Win32 GUI) rather
750 * than the program exiting with no explanation.
751 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
753 * - Removed tabs from "config"
754 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
755 * - Bumped up version number.
757 * Revision 1.2 2001/05/17 22:34:44 oes
758 * - Added hint on GIF char array generation to jcc.c
759 * - Cleaned CRLF's from the sources and related files
760 * - Repaired logging for REF and FRC
762 * Revision 1.1.1.1 2001/05/15 13:58:56 oes
763 * Initial import of version 2.9.3 source tree
766 *********************************************************************/
772 #include <sys/types.h>
781 # ifndef FEATURE_PTHREAD
785 # include <windows.h>
786 # include <process.h>
787 # endif /* ndef FEATURE_PTHREAD */
790 # ifndef _WIN_CONSOLE
792 # endif /* ndef _WIN_CONSOLE */
793 # include "w32svrapi.h"
795 #else /* ifndef _WIN32 */
797 # if !defined (__OS2__)
799 # include <sys/wait.h>
800 # endif /* ndef __OS2__ */
801 # include <sys/time.h>
802 # include <sys/stat.h>
803 # include <sys/ioctl.h>
806 #include <sys/termios.h>
817 # include <socket.h> /* BeOS has select() for sockets only. */
818 # include <OS.h> /* declarations for threads and stuff. */
821 # if defined(__EMX__) || defined(__OS2__)
822 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
827 #define bzero(B,N) memset(B,0x00,n)
842 #include "killpopup.h"
843 #include "miscutil.h"
845 #include "jbsockets.h"
850 #include "urlmatch.h"
852 const char jcc_h_rcs[] = JCC_H_VERSION;
853 const char project_h_rcs[] = PROJECT_H_VERSION;
856 struct client_state clients[1];
857 struct file_list files[1];
859 #ifdef FEATURE_STATISTICS
860 int urls_read = 0; /* total nr of urls read inc rejected */
861 int urls_rejected = 0; /* total nr of urls rejected */
862 #endif /* def FEATURE_STATISTICS */
864 #ifdef FEATURE_GRACEFUL_TERMINATION
868 static void listen_loop(void);
869 static void chat(struct client_state *csp);
871 void serve(struct client_state *csp);
872 #else /* ifndef AMIGA */
873 static void serve(struct client_state *csp);
874 #endif /* def AMIGA */
877 static int32 server_thread(void *data);
878 #endif /* def __BEOS__ */
881 #define sleep(N) Sleep(((N) * 1000))
885 #define sleep(N) DosSleep(((N) * 100))
888 #ifdef FEATURE_PTHREAD
889 pthread_mutex_t log_mutex;
890 pthread_mutex_t log_init_mutex;
892 #ifndef HAVE_GMTIME_R
893 pthread_mutex_t gmtime_mutex;
894 #endif /* ndef HAVE_GMTIME_R */
896 #ifndef HAVE_LOCALTIME_R
897 pthread_mutex_t localtime_mutex;
898 #endif /* ndef HAVE_GMTIME_R */
900 #ifndef HAVE_GETHOSTBYADDR_R
901 pthread_mutex_t gethostbyaddr_mutex;
902 #endif /* ndef HAVE_GETHOSTBYADDR_R */
904 #ifndef HAVE_GETHOSTBYNAME_R
905 pthread_mutex_t gethostbyname_mutex;
906 #endif /* ndef HAVE_GETHOSTBYNAME_R */
909 pthread_mutex_t rand_mutex;
910 #endif /* ndef HAVE_RANDOM */
912 #endif /* FEATURE_PTHREAD */
914 #if defined(unix) || defined(__EMX__)
915 const char *basedir = NULL;
916 const char *pidfile = NULL;
917 int received_hup_signal = 0;
918 #endif /* defined unix */
920 /* The vanilla wafer. */
921 static const char VANILLA_WAFER[] =
922 "NOTICE=TO_WHOM_IT_MAY_CONCERN_"
923 "Do_not_send_me_any_copyrighted_information_other_than_the_"
924 "document_that_I_am_requesting_or_any_of_its_necessary_components._"
925 "In_particular_do_not_send_me_any_cookies_that_"
926 "are_subject_to_a_claim_of_copyright_by_anybody._"
927 "Take_notice_that_I_refuse_to_be_bound_by_any_license_condition_"
928 "(copyright_or_otherwise)_applying_to_any_cookie._";
930 /* HTTP snipplets. */
931 const char CSUCCEED[] =
932 "HTTP/1.0 200 Connection established\n"
933 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
935 const char CHEADER[] =
936 "HTTP/1.0 400 Invalid header received from browser\r\n"
937 "Connection: close\r\n\r\n"
938 "Invalid header received from browser.\r\n";
940 const char CFORBIDDEN[] =
941 "HTTP/1.0 403 Connection not allowable\r\n"
942 "Proxy-Agent: Privoxy " VERSION "\r\n"
943 "X-Hint: If you read this message interactively, then you know why this happens ,-)\r\n"
944 "Connection: close\r\n\r\n";
946 const char FTP_RESPONSE[] =
947 "HTTP/1.0 400 Invalid request received from browser\r\n"
948 "Connection: close\r\n\r\n"
949 "Invalid request. Privoxy doesn't support FTP.\r\n";
951 const char GOPHER_RESPONSE[] =
952 "HTTP/1.0 400 Invalid request received from browser\r\n"
953 "Connection: close\r\n\r\n"
954 "Invalid request. Privoxy doesn't support gopher.\r\n";
956 /* XXX: should be a template */
957 const char MISSING_DESTINATION_RESPONSE[] =
958 "HTTP/1.0 400 Bad request received from browser\r\n"
959 "Proxy-Agent: Privoxy " VERSION "\r\n"
960 "Connection: close\r\n\r\n"
961 "Bad request. Privoxy was unable to extract the destination.\r\n";
963 /* XXX: should be a template */
964 const char NO_SERVER_DATA_RESPONSE[] =
965 "HTTP/1.0 502 Server or forwarder response empty\r\n"
966 "Proxy-Agent: Privoxy " VERSION "\r\n"
967 "Connection: close\r\n\r\n"
968 "Empty server or forwarder response.\r\n"
969 "The connection was closed without sending any data.\r\n";
971 /* XXX: should be a template */
972 const char NULL_BYTE_RESPONSE[] =
973 "HTTP/1.0 400 Bad request received from browser\r\n"
974 "Proxy-Agent: Privoxy " VERSION "\r\n"
975 "Connection: close\r\n\r\n"
976 "Bad request. Null byte(s) before end of request.\r\n";
978 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
979 /*********************************************************************
981 * Function : sig_handler
983 * Description : Signal handler for different signals.
984 * Exit gracefully on TERM and INT
985 * or set a flag that will cause the errlog
986 * to be reopened by the main thread on HUP.
989 * 1 : the_signal = the signal cause this function to call
993 *********************************************************************/
994 static void sig_handler(int the_signal)
1000 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
1011 received_hup_signal = 1;
1016 * We shouldn't be here, unless we catch signals
1017 * in main() that we can't handle here!
1019 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
1027 /*********************************************************************
1029 * Function : client_protocol_is_unsupported
1031 * Description : Checks if the client used a known unsupported
1032 * protocol and deals with it by sending an error
1036 * 1 : csp = Current client state (buffers, headers, etc...)
1037 * 2 : req = the first request line send by the client
1039 * Returns : TRUE if an error response has been generated, or
1040 * FALSE if the request doesn't look invalid.
1042 *********************************************************************/
1043 int client_protocol_is_unsupported(const struct client_state *csp, char *req)
1045 char buf[BUFFER_SIZE];
1048 * If it's a FTP or gopher request, we don't support it.
1050 * These checks are better than nothing, but they might
1051 * not work in all configurations and some clients might
1052 * have problems digesting the answer.
1054 * They should, however, never cause more problems than
1055 * Privoxy's old behaviour (returning the misleading HTML
1058 * "Could not resolve http://(ftp|gopher)://example.org").
1060 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
1062 if (!strncmpic(req, "GET ftp://", 10))
1064 strcpy(buf, FTP_RESPONSE);
1065 log_error(LOG_LEVEL_ERROR, "%s tried to use Privoxy as FTP proxy: %s",
1066 csp->ip_addr_str, req);
1070 strcpy(buf, GOPHER_RESPONSE);
1071 log_error(LOG_LEVEL_ERROR, "%s tried to use Privoxy as gopher proxy: %s",
1072 csp->ip_addr_str, req);
1074 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
1076 write_socket(csp->cfd, buf, strlen(buf));
1085 /*********************************************************************
1087 * Function : get_request_destination_elsewhere
1089 * Description : If the client's request was redirected into
1090 * Privoxy without the client's knowledge,
1091 * the request line lacks the destination host.
1093 * This function tries to get it elsewhere,
1094 * provided accept-intercepted-requests is enabled.
1096 * "Elsewhere" currently only means "Host: header",
1097 * but in the future we may ask the redirecting
1098 * packet filter to look the destination up.
1100 * If the destination stays unknown, an error
1101 * response is send to the client and headers
1102 * are freed so that chat() can return directly.
1105 * 1 : csp = Current client state (buffers, headers, etc...)
1106 * 2 : headers = a header list
1108 * Returns : JB_ERR_OK if the destination is now known, or
1109 * JB_ERR_PARSE if it isn't.
1111 *********************************************************************/
1112 jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
1114 char buf[BUFFER_SIZE];
1117 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
1119 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
1120 " Privoxy isn't configured to accept intercepted requests.",
1121 csp->ip_addr_str, csp->http->cmd);
1122 /* XXX: Use correct size */
1123 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1124 csp->ip_addr_str, csp->http->cmd);
1126 strcpy(buf, CHEADER);
1127 write_socket(csp->cfd, buf, strlen(buf));
1128 destroy_list(headers);
1130 return JB_ERR_PARSE;
1132 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
1134 /* Split the domain we just got for pattern matching */
1135 init_domain_components(csp->http);
1141 /* We can't work without destination. Go spread the news.*/
1143 req = list_to_text(headers);
1145 /* XXX: Use correct size */
1146 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1147 csp->ip_addr_str, csp->http->cmd);
1148 log_error(LOG_LEVEL_ERROR,
1149 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
1150 csp->ip_addr_str, csp->http->cmd, req);
1153 strcpy(buf, MISSING_DESTINATION_RESPONSE);
1154 write_socket(csp->cfd, buf, strlen(buf));
1155 destroy_list(headers);
1157 return JB_ERR_PARSE;
1160 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
1161 * to get the destination IP address, use it as host directly
1162 * or do a reverse DNS lookup first.
1167 /*********************************************************************
1169 * Function : get_server_headers
1171 * Description : Parses server headers in iob and fills them
1172 * into csp->headers so that they can later be
1176 * 1 : csp = Current client state (buffers, headers, etc...)
1178 * Returns : JB_ERR_OK if everything went fine, or
1179 * JB_ERR_PARSE if the headers were incomplete.
1181 *********************************************************************/
1182 jb_err get_server_headers(struct client_state *csp)
1184 int continue_hack_in_da_house = 0;
1187 while (((header = get_header(csp)) != NULL) || continue_hack_in_da_house)
1192 * continue hack in da house. Ignore the ending of
1193 * this head and continue enlisting header lines.
1194 * The reason is described below.
1196 enlist(csp->headers, "");
1197 continue_hack_in_da_house = 0;
1200 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
1203 * It's a bodyless continue response, don't
1204 * stop header parsing after reaching it's end.
1206 * As a result Privoxy will concatenate the
1207 * next response's head and parse and deliver
1208 * the headers as if they belonged to one request.
1210 * The client will separate them because of the
1211 * empty line between them.
1213 * XXX: What we're doing here is clearly against
1214 * the intended purpose of the continue header,
1215 * and under some conditions (HTTP/1.0 client request)
1216 * it's a standard violation.
1218 * Anyway, "sort of against the spec" is preferable
1219 * to "always getting confused by Continue responses"
1220 * (Privoxy's behaviour before this hack was added)
1222 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
1223 continue_hack_in_da_house = 1;
1225 else if (*header == '\0')
1228 * If the header is empty, but the Continue hack
1229 * isn't active, we can assume that we reached the
1230 * end of the buffer before we hit the end of the
1233 * Inform the caller an let it decide how to handle it.
1235 return JB_ERR_PARSE;
1239 if (JB_ERR_MEMORY == enlist(csp->headers, header))
1242 * XXX: Should we quit the request and return a
1243 * out of memory error page instead?
1245 log_error(LOG_LEVEL_ERROR,
1246 "Out of memory while enlisting server headers. %s lost.",
1256 /*********************************************************************
1258 * Function : crunch_reason
1260 * Description : Translates the crunch reason code into a string.
1263 * 1 : rsp = a http_response
1265 * Returns : A string with the crunch reason or an error description.
1267 *********************************************************************/
1268 const char *crunch_reason(const struct http_response *rsp)
1270 char * reason = NULL;
1272 assert(rsp != NULL);
1275 return "Internal error while searching for crunch reason";
1278 switch (rsp->reason)
1280 case RSP_REASON_UNSUPPORTED:
1281 reason = "Unsupported HTTP feature";
1283 case RSP_REASON_BLOCKED:
1286 case RSP_REASON_UNTRUSTED:
1287 reason = "Untrusted";
1289 case RSP_REASON_REDIRECTED:
1290 reason = "Redirected";
1292 case RSP_REASON_CGI_CALL:
1293 reason = "CGI Call";
1295 case RSP_REASON_NO_SUCH_DOMAIN:
1296 reason = "DNS failure";
1298 case RSP_REASON_FORWARDING_FAILED:
1299 reason = "Forwarding failed";
1301 case RSP_REASON_CONNECT_FAILED:
1302 reason = "Connection failure";
1304 case RSP_REASON_OUT_OF_MEMORY:
1305 reason = "Out of memory (may mask other reasons)";
1308 reason = "No reason recorded";
1316 /*********************************************************************
1318 * Function : send_crunch_response
1320 * Description : Delivers already prepared response for
1321 * intercepted requests, logs the interception
1322 * and frees the response.
1325 * 1 : csp = Current client state (buffers, headers, etc...)
1326 * 1 : rsp = Fully prepared response. Will be freed on exit.
1328 * Returns : Nothing.
1330 *********************************************************************/
1331 void send_crunch_response(struct client_state *csp, struct http_response *rsp)
1333 const struct http_request *http = csp->http;
1334 char status_code[4];
1336 assert(rsp != NULL);
1337 assert(rsp->head != NULL);
1342 * Not supposed to happen. If it does
1343 * anyway, treat it as an unknown error.
1345 cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
1346 /* return code doesn't matter */
1351 /* If rsp is still NULL, we have serious internal problems. */
1352 log_error(LOG_LEVEL_FATAL,
1353 "NULL response in send_crunch_response and cgi_error_unknown failed as well.");
1357 * Extract the status code from the actual head
1358 * that was send to the client. It is the only
1359 * way to get it right for all requests, including
1360 * the fixed ones for out-of-memory problems.
1362 * A head starts like this: 'HTTP/1.1 200...'
1366 status_code[0] = rsp->head[9];
1367 status_code[1] = rsp->head[10];
1368 status_code[2] = rsp->head[11];
1369 status_code[3] = '\0';
1371 /* Write the answer to the client */
1372 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1373 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1375 /* There is nothing we can do about it. */
1376 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
1379 /* Log that the request was crunched and why. */
1380 log_error(LOG_LEVEL_GPC, "%s%s crunch! (%s)",
1381 http->hostport, http->path, crunch_reason(rsp));
1382 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %d",
1383 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
1385 /* Clean up and return */
1386 if (cgi_error_memory() != rsp)
1388 free_http_response(rsp);
1394 /*********************************************************************
1398 * Description : Once a connection to the client has been accepted,
1399 * this function is called (via serve()) to handle the
1400 * main business of the communication. When this
1401 * function returns, the caller must close the client
1404 * FIXME: chat is nearly thousand lines long.
1408 * 1 : csp = Current client state (buffers, headers, etc...)
1410 * Returns : On success, the number of bytes written are returned (zero
1411 * indicates nothing was written). On error, -1 is returned,
1412 * and errno is set appropriately. If count is zero and the
1413 * file descriptor refers to a regular file, 0 will be
1414 * returned without causing any other effect. For a special
1415 * file, the results are not portable.
1417 *********************************************************************/
1418 static void chat(struct client_state *csp)
1421 * This next lines are a little ugly, but they simplifies the if statements
1422 * below. Basically if TOGGLE, then we want the if to test if the
1423 * CSP_FLAG_TOGGLED_ON flag ist set, else we don't. And if FEATURE_FORCE_LOAD,
1424 * then we want the if to test for CSP_FLAG_FORCED , else we don't
1426 #ifdef FEATURE_TOGGLE
1427 # define IS_TOGGLED_ON_AND (csp->flags & CSP_FLAG_TOGGLED_ON) &&
1428 #else /* ifndef FEATURE_TOGGLE */
1429 # define IS_TOGGLED_ON_AND
1430 #endif /* ndef FEATURE_TOGGLE */
1431 #ifdef FEATURE_FORCE_LOAD
1432 # define IS_NOT_FORCED_AND !(csp->flags & CSP_FLAG_FORCED) &&
1433 #else /* ifndef FEATURE_FORCE_LOAD */
1434 # define IS_NOT_FORCED_AND
1435 #endif /* def FEATURE_FORCE_LOAD */
1437 #define IS_ENABLED_AND IS_TOGGLED_ON_AND IS_NOT_FORCED_AND
1439 char buf[BUFFER_SIZE];
1447 int ms_iis5_hack = 0;
1448 size_t byte_count = 0;
1449 int forwarded_connect_retries = 0;
1450 int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
1451 const struct forward_spec * fwd;
1452 struct http_request *http;
1453 int len; /* for buffer sizes (and negative error codes) */
1454 #ifdef FEATURE_KILL_POPUPS
1455 int block_popups; /* bool, 1==will block popups */
1456 int block_popups_now = 0; /* bool, 1==currently blocking popups */
1457 #endif /* def FEATURE_KILL_POPUPS */
1459 int pcrs_filter; /* bool, 1==will filter through pcrs */
1460 int gif_deanimate; /* bool, 1==will deanimate gifs */
1461 int jpeg_inspect; /* bool, 1==will inspect jpegs */
1463 /* Function that does the content filtering for the current request */
1464 char *(*content_filter)() = NULL;
1466 /* Skeleton for HTTP response, if we should intercept the request */
1467 struct http_response *rsp;
1469 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1470 struct list header_list;
1471 struct list *headers = &header_list;
1475 memset(buf, 0, sizeof(buf));
1478 * Read the client's request. Note that since we're not using select() we
1479 * could get blocked here if a client connected, then didn't say anything!
1484 size_t c_len; /* Request lenght when treated as C string */
1486 len = read_socket(csp->cfd, buf, sizeof(buf)-1);
1488 if (len <= 0) break; /* error! */
1490 /* Naughty NULL bytes inside the request? */
1491 c_len = strlen(buf);
1495 * Yes. Log the request, return an
1496 * error response and hang up.
1498 size_t tmp_len = c_len;
1503 * Replace NULL byte(s) with line break(s)
1504 * so the request can be logged as string.
1507 tmp_len = strlen(buf);
1508 } while (tmp_len < len);
1510 log_error(LOG_LEVEL_ERROR,
1511 "%s\'s request contains NULL byte(s) (length=%d, strlen=%d).\n"
1512 "Complete request with NULL byte(s) turned into line break(s):\n%s",
1513 csp->ip_addr_str, len, c_len, buf);
1515 strcpy(buf, NULL_BYTE_RESPONSE);
1516 write_socket(csp->cfd, buf, strlen(buf));
1518 /* XXX: Log correct size */
1519 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1525 * If there is no memory left for buffering the
1526 * request, there is nothing we can do but hang up
1528 if (add_to_iob(csp, buf, len))
1533 req = get_header(csp);
1537 break; /* no HTTP request! */
1542 continue; /* more to come! */
1545 /* Does the request line look invalid? */
1546 if (client_protocol_is_unsupported(csp, req))
1549 * Yes. The request has already been
1550 * answered with a error response, the buffers
1551 * were freed and we're done with chatting.
1556 #ifdef FEATURE_FORCE_LOAD
1557 /* If this request contains the FORCE_PREFIX,
1558 * better get rid of it now and set the force flag --oes
1561 if (strstr(req, FORCE_PREFIX))
1563 strclean(req, FORCE_PREFIX);
1564 log_error(LOG_LEVEL_FORCE, "Enforcing request \"%s\".\n", req);
1565 csp->flags |= CSP_FLAG_FORCED;
1568 #endif /* def FEATURE_FORCE_LOAD */
1570 switch( parse_http_request(req, http, csp) )
1573 log_error(LOG_LEVEL_ERROR, "Out of memory while parsing request.");
1576 log_error(LOG_LEVEL_ERROR, "Couldn't parse request: %s.", req);
1584 if (http->cmd == NULL)
1586 strcpy(buf, CHEADER);
1587 write_socket(csp->cfd, buf, strlen(buf));
1588 /* XXX: Use correct size */
1589 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 400 0", csp->ip_addr_str);
1590 log_error(LOG_LEVEL_ERROR, "Invalid header received from %s.", csp->ip_addr_str);
1592 free_http_request(http);
1596 /* grab the rest of the client's headers */
1600 if ( ( ( p = get_header(csp) ) != NULL) && ( *p == '\0' ) )
1602 len = read_socket(csp->cfd, buf, sizeof(buf));
1605 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1610 * If there is no memory left for buffering the
1611 * request, there is nothing we can do but hang up
1613 if (add_to_iob(csp, buf, len))
1620 if (p == NULL) break;
1627 if (http->host == NULL)
1630 * If we still don't know the request destination,
1631 * the request is invalid or the client uses
1632 * Privoxy without it's knowledge.
1634 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1637 * Our attempts to get the request destination
1638 * elsewhere failed or Privoxy is configured
1639 * to only accept proxy requests.
1641 * An error response has already been send
1642 * and we're done here.
1648 /* decide how to route the HTTP request */
1650 if ((fwd = forward_url(http, csp)) == NULL)
1652 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1653 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1656 /* build the http request to send to the server
1657 * we have to do one of the following:
1659 * create = use the original HTTP request to create a new
1660 * HTTP request that has either the path component
1661 * without the http://domainspec (w/path) or the
1662 * full orininal URL (w/url)
1663 * Note that the path and/or the HTTP version may
1664 * have been altered by now.
1666 * connect = Open a socket to the host:port of the server
1667 * and short-circuit server and client socket.
1669 * pass = Pass the request unchanged if forwarding a CONNECT
1670 * request to a parent proxy. Note that we'll be sending
1671 * the CFAIL message ourselves if connecting to the parent
1672 * fails, but we won't send a CSUCCEED message if it works,
1673 * since that would result in a double message (ours and the
1674 * parent's). After sending the request to the parent, we simply
1677 * here's the matrix:
1680 * +--------+--------+
1682 * 0 | create | connect|
1684 * Forwarding +--------+--------+
1686 * 1 | create | pass |
1688 * +--------+--------+
1693 * Determine the actions for this URL
1695 #ifdef FEATURE_TOGGLE
1696 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1698 /* Most compatible set of actions (i.e. none) */
1699 init_current_action(csp->action);
1702 #endif /* ndef FEATURE_TOGGLE */
1704 url_actions(http, csp);
1709 * Check if a CONNECT request is allowable:
1710 * In the absence of a +limit-connect action, allow only port 443.
1711 * If there is an action, allow whatever matches the specificaton.
1715 if( ( !(csp->action->flags & ACTION_LIMIT_CONNECT) && csp->http->port != 443)
1716 || (csp->action->flags & ACTION_LIMIT_CONNECT
1717 && !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT], csp->http->port)) )
1719 if (csp->action->flags & ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS)
1722 * The response may confuse some clients,
1723 * but makes unblocking easier.
1725 log_error(LOG_LEVEL_ERROR, "Marking suspicious CONNECT request from %s for blocking.",
1727 csp->action->flags |= ACTION_BLOCK;
1732 strcpy(buf, CFORBIDDEN);
1733 write_socket(csp->cfd, buf, strlen(buf));
1734 log_error(LOG_LEVEL_CONNECT, "Denying suspicious CONNECT request from %s", csp->ip_addr_str);
1735 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 403 0", csp->ip_addr_str);
1743 * Downgrade http version from 1.1 to 1.0 if +downgrade
1746 if ( (http->ssl == 0)
1747 && (!strcmpic(http->ver, "HTTP/1.1"))
1748 && (csp->action->flags & ACTION_DOWNGRADE))
1751 http->ver = strdup("HTTP/1.0");
1753 if (http->ver == NULL)
1755 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
1760 * Save a copy of the original request for logging
1762 http->ocmd = strdup(http->cmd);
1764 if (http->ocmd == NULL)
1766 log_error(LOG_LEVEL_FATAL, "Out of memory copying HTTP request line");
1770 * (Re)build the HTTP request for non-SSL requests.
1771 * If forwarding, use the whole URL, else, use only the path.
1777 http->cmd = strdup(http->gpc);
1778 string_append(&http->cmd, " ");
1780 if (fwd->forward_host)
1782 string_append(&http->cmd, http->url);
1786 string_append(&http->cmd, http->path);
1788 string_append(&http->cmd, " ");
1789 string_append(&http->cmd, http->ver);
1791 if (http->cmd == NULL)
1793 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1795 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", http->cmd);
1797 enlist(csp->headers, http->cmd);
1799 /* Append the previously read headers */
1800 list_append_list_unique(csp->headers, headers);
1801 destroy_list(headers);
1804 * If the user has not supplied any wafers, and the user has not
1805 * told us to suppress the vanilla wafer, then send the vanilla wafer.
1807 if (list_is_empty(csp->action->multi[ACTION_MULTI_WAFER])
1808 && ((csp->action->flags & ACTION_VANILLA_WAFER) != 0))
1810 enlist(csp->action->multi[ACTION_MULTI_WAFER], VANILLA_WAFER);
1814 #ifdef FEATURE_KILL_POPUPS
1815 block_popups = ((csp->action->flags & ACTION_NO_POPUPS) != 0);
1816 #endif /* def FEATURE_KILL_POPUPS */
1818 pcrs_filter = (csp->rlist != NULL) && /* There are expressions to be used */
1819 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER]));
1821 gif_deanimate = ((csp->action->flags & ACTION_DEANIMATE) != 0);
1823 jpeg_inspect = ((csp->action->flags & ACTION_JPEG_INSPECT) != 0);
1826 * We have a request. Now, check to see if we need to
1827 * intercept it, i.e. If ..
1831 /* We may not forward the request by rfc2616 sect 14.31 */
1832 (NULL != (rsp = direct_response(csp)))
1834 /* or we are enabled and... */
1835 || (IS_ENABLED_AND (
1837 /* ..the request was blocked */
1838 ( NULL != (rsp = block_url(csp)))
1840 /* ..or untrusted */
1841 #ifdef FEATURE_TRUST
1842 || ( NULL != (rsp = trust_url(csp)))
1843 #endif /* def FEATURE_TRUST */
1845 /* ..or a redirect kicked in */
1846 || ( NULL != (rsp = redirect_url(csp)))
1850 * .. or a CGI call was detected and answered.
1852 * This check comes last to give the user the power
1853 * to deny acces to some (or all) of the cgi pages.
1855 || (NULL != (rsp = dispatch_cgi(csp)))
1860 * Deliver, log and free the interception
1861 * response. Afterwards we're done here.
1863 send_crunch_response(csp, rsp);
1864 #ifdef FEATURE_STATISTICS
1865 /* Count as a rejected request */
1866 csp->flags |= CSP_FLAG_REJECTED;
1867 #endif /* def FEATURE_STATISTICS */
1872 hdr = sed(client_patterns, add_client_headers, csp);
1875 /* FIXME Should handle error properly */
1876 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1879 list_remove_all(csp->headers);
1881 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1883 if (fwd->forward_host)
1885 log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
1886 fwd->forward_host, fwd->forward_port, http->hostport);
1890 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1893 /* here we connect to the server, gateway, or the forwarder */
1895 while ( (csp->sfd = forwarded_connect(fwd, http, csp))
1896 && (errno == EINVAL) && (forwarded_connect_retries++ < max_forwarded_connect_retries))
1898 log_error(LOG_LEVEL_ERROR, "failed request #%u to connect to %s. Trying again.",
1899 forwarded_connect_retries, http->hostport);
1902 if (csp->sfd == JB_INVALID_SOCKET)
1904 if (fwd->type != SOCKS_NONE)
1907 rsp = error_response(csp, "forwarding-failed", errno);
1909 else if (errno == EINVAL)
1911 rsp = error_response(csp, "no-such-domain", errno);
1915 rsp = error_response(csp, "connect-failed", errno);
1916 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1921 /* Write the answer to the client */
1924 send_crunch_response(csp, rsp);
1931 if (fwd->forward_host || (http->ssl == 0))
1933 /* write the client's (modified) header to the server
1934 * (along with anything else that may be in the buffer)
1937 if (write_socket(csp->sfd, hdr, strlen(hdr))
1938 || (flush_socket(csp->sfd, csp) < 0))
1940 log_error(LOG_LEVEL_CONNECT, "write header to: %s failed: %E",
1943 rsp = error_response(csp, "connect-failed", errno);
1947 send_crunch_response(csp, rsp);
1957 * We're running an SSL tunnel and we're not forwarding,
1958 * so just send the "connect succeeded" message to the
1959 * client, flush the rest, and get out of the way.
1961 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 0",
1962 csp->ip_addr_str, http->ocmd);
1964 if (write_socket(csp->cfd, CSUCCEED, sizeof(CSUCCEED)-1))
1972 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1974 /* we're finished with the client's header */
1977 maxfd = ( csp->cfd > csp->sfd ) ? csp->cfd : csp->sfd;
1979 /* pass data between the client and server
1980 * until one or the other shuts down the connection.
1989 * FD_ZERO here seems to point to an errant macro which crashes.
1990 * So do this by hand for now...
1992 memset(&rfds,0x00,sizeof(fd_set));
1996 FD_SET(csp->cfd, &rfds);
1997 FD_SET(csp->sfd, &rfds);
1999 n = select((int)maxfd+1, &rfds, NULL, NULL, NULL);
2003 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2007 /* this is the body of the browser's request
2008 * just read it and write it.
2011 if (FD_ISSET(csp->cfd, &rfds))
2013 len = read_socket(csp->cfd, buf, sizeof(buf));
2017 break; /* "game over, man" */
2020 if (write_socket(csp->sfd, buf, (size_t)len))
2022 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2029 * The server wants to talk. It could be the header or the body.
2030 * If `hdr' is null, then it's the header otherwise it's the body.
2031 * FIXME: Does `hdr' really mean `host'? No.
2035 if (FD_ISSET(csp->sfd, &rfds))
2038 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
2042 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2044 rsp = error_response(csp, "connect-failed", errno);
2048 send_crunch_response(csp, rsp);
2054 /* Add a trailing zero. This lets filter_popups
2055 * use string operations.
2059 #ifdef FEATURE_KILL_POPUPS
2060 /* Filter the popups on this read. */
2061 if (block_popups_now)
2063 filter_popups(buf, csp);
2065 #endif /* def FEATURE_KILL_POPUPS */
2067 /* Normally, this would indicate that we've read
2068 * as much as the server has sent us and we can
2069 * close the client connection. However, Microsoft
2070 * in its wisdom has released IIS/5 with a bug that
2071 * prevents it from sending the trailing \r\n in
2072 * a 302 redirect header (and possibly other headers).
2073 * To work around this if we've haven't parsed
2074 * a full header we'll append a trailing \r\n
2075 * and see if this now generates a valid one.
2077 * This hack shouldn't have any impacts. If we've
2078 * already transmitted the header or if this is a
2079 * SSL connection, then we won't bother with this
2080 * hack. So we only work on partially received
2081 * headers. If we append a \r\n and this still
2082 * doesn't generate a valid header, then we won't
2083 * transmit anything to the client.
2088 if (server_body || http->ssl)
2091 * If we have been buffering up the document,
2092 * now is the time to apply content modification
2093 * and send the result to the client.
2098 * If the content filter fails, use the original
2099 * buffer and length.
2100 * (see p != NULL ? p : csp->iob->cur below)
2102 if (NULL == (p = (*content_filter)(csp)))
2104 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2107 hdr = sed(server_patterns_light, NULL, csp);
2111 /* FIXME Should handle error properly */
2112 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2115 if (write_socket(csp->cfd, hdr, strlen(hdr))
2116 || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
2118 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2128 break; /* "game over, man" */
2132 * This is NOT the body, so
2133 * Let's pretend the server just sent us a blank line.
2135 snprintf(buf, sizeof(buf), "\r\n");
2136 len = (int)strlen(buf);
2139 * Now, let the normal header parsing algorithm below do its
2140 * job. If it fails, we'll exit instead of continuing.
2147 * If this is an SSL connection or we're in the body
2148 * of the server document, just write it to the client,
2149 * unless we need to buffer the body for later content-filtering
2152 if (server_body || http->ssl)
2157 * If there is no memory left for buffering the content, or the buffer limit
2158 * has been reached, switch to non-filtering mode, i.e. make & write the
2159 * header, flush the iob and buf, and get out of the way.
2161 if (add_to_iob(csp, buf, len))
2166 log_error(LOG_LEVEL_ERROR, "Flushing header and buffers. Stepping back from filtering.");
2168 hdr = sed(server_patterns, add_server_headers, csp);
2172 * Memory is too tight to even generate the header.
2173 * Send our static "Out-of-memory" page.
2175 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2176 rsp = cgi_error_memory();
2177 send_crunch_response(csp, rsp);
2182 hdrlen = strlen(hdr);
2184 if (write_socket(csp->cfd, hdr, hdrlen)
2185 || ((flushed = flush_socket(csp->cfd, csp)) < 0)
2186 || (write_socket(csp->cfd, buf, (size_t)len)))
2188 log_error(LOG_LEVEL_CONNECT, "Flush header and buffers to client failed: %E");
2194 byte_count += hdrlen + (size_t)flushed + (size_t)len;
2196 content_filter = NULL;
2203 if (write_socket(csp->cfd, buf, (size_t)len))
2205 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2209 byte_count += (size_t)len;
2214 /* we're still looking for the end of the
2215 * server's header ... (does that make header
2216 * parsing an "out of body experience" ?
2220 * buffer up the data we just read. If that fails,
2221 * there's little we can do but send our static
2222 * out-of-memory page.
2224 if (add_to_iob(csp, buf, len))
2226 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2227 rsp = cgi_error_memory();
2228 send_crunch_response(csp, rsp);
2233 /* Convert iob into something sed() can digest */
2234 if (JB_ERR_PARSE == get_server_headers(csp))
2238 /* Well, we tried our MS IIS/5
2239 * hack and it didn't work.
2240 * The header is incomplete
2241 * and there isn't anything
2242 * we can do about it.
2248 /* Since we have to wait for
2249 * more from the server before
2250 * we can parse the headers
2251 * we just continue here.
2257 /* Did we actually get anything? */
2258 if (NULL == csp->headers->first)
2260 log_error(LOG_LEVEL_ERROR, "Empty server or forwarder response.");
2261 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2262 strcpy(buf, NO_SERVER_DATA_RESPONSE);
2263 write_socket(csp->cfd, buf, strlen(buf));
2264 free_http_request(http);
2268 /* we have now received the entire header.
2269 * filter it and send the result to the client
2272 hdr = sed(server_patterns, add_server_headers, csp);
2275 /* FIXME Should handle error properly */
2276 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2279 #ifdef FEATURE_KILL_POPUPS
2280 /* Start blocking popups if appropriate. */
2282 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
2283 !http->ssl && /* We talk plaintext */
2284 block_popups) /* Policy allows */
2286 block_popups_now = 1;
2288 * Filter the part of the body that came in the same read
2289 * as the last headers:
2291 filter_popups(csp->iob->cur, csp);
2294 #endif /* def FEATURE_KILL_POPUPS */
2296 /* Buffer and pcrs filter this if appropriate. */
2298 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
2299 !http->ssl && /* We talk plaintext */
2300 pcrs_filter) /* Policy allows */
2302 content_filter = pcrs_filter_response;
2305 /* Buffer and gif_deanimate this if appropriate. */
2307 if ((csp->content_type & CT_GIF) && /* It's an image/gif MIME-Type */
2308 !http->ssl && /* We talk plaintext */
2309 gif_deanimate) /* Policy allows */
2311 content_filter = gif_deanimate_response;
2314 /* Buffer and jpg_inspect this if appropriate. */
2316 if ((csp->content_type & CT_JPEG) && /* It's an image/jpeg MIME-Type */
2317 !http->ssl && /* We talk plaintext */
2318 jpeg_inspect) /* Policy allows */
2320 content_filter = jpeg_inspect_response;
2324 * Only write if we're not buffering for content modification
2326 if (!content_filter)
2328 /* write the server's (modified) header to
2329 * the client (along with anything else that
2330 * may be in the buffer)
2333 if (write_socket(csp->cfd, hdr, strlen(hdr))
2334 || ((len = flush_socket(csp->cfd, csp)) < 0))
2336 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2338 /* the write failed, so don't bother
2339 * mentioning it to the client...
2340 * it probably can't hear us anyway.
2346 byte_count += (size_t)len;
2349 /* we're finished with the server's header */
2354 /* If this was a MS IIS/5 hack then it means
2355 * the server has already closed the
2356 * connection. Nothing more to read. Time
2367 return; /* huh? we should never get here */
2370 if (csp->content_length == 0)
2373 * If Privoxy didn't recalculate the
2374 * Content-Lenght, byte_count is still
2377 csp->content_length = byte_count;
2380 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %d",
2381 csp->ip_addr_str, http->ocmd, csp->content_length);
2385 /*********************************************************************
2389 * Description : This is little more than chat. We only "serve" to
2390 * to close any socket that chat may have opened.
2393 * 1 : csp = Current client state (buffers, headers, etc...)
2397 *********************************************************************/
2399 void serve(struct client_state *csp)
2400 #else /* ifndef AMIGA */
2401 static void serve(struct client_state *csp)
2402 #endif /* def AMIGA */
2405 close_socket(csp->cfd);
2407 if (csp->sfd != JB_INVALID_SOCKET)
2409 close_socket(csp->sfd);
2412 csp->flags &= ~CSP_FLAG_ACTIVE;
2418 /*********************************************************************
2420 * Function : server_thread
2422 * Description : We only exist to call `serve' in a threaded environment.
2425 * 1 : data = Current client state (buffers, headers, etc...)
2427 * Returns : Always 0.
2429 *********************************************************************/
2430 static int32 server_thread(void *data)
2432 serve((struct client_state *) data);
2439 /*********************************************************************
2443 * Description : Print usage info & exit.
2445 * Parameters : Pointer to argv[0] for identifying ourselves
2449 *********************************************************************/
2450 void usage(const char *myname)
2452 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2454 "Usage: %s [--help] [--version] [configfile]\n"
2456 "Usage: %s [--help] [--version] [--no-daemon] [--pidfile pidfile] [--user user[.group]] [configfile]\n"
2458 "Aborting.\n", myname);
2465 /*********************************************************************
2467 * Function : initialize_mutexes
2469 * Description : Prepares mutexes if mutex support is available.
2473 * Returns : Void, exits in case of errors.
2475 *********************************************************************/
2476 void initialize_mutexes()
2480 #ifdef FEATURE_PTHREAD
2482 * Prepare global mutex semaphores
2484 err = pthread_mutex_init(&log_mutex, 0);
2486 if (!err) err = pthread_mutex_init(&log_init_mutex, 0);
2489 * XXX: The assumptions below are a bit naive
2490 * and can cause locks that aren't necessary.
2492 * For example older FreeBSD versions (< 6.x?)
2493 * have no gethostbyname_r, but gethostbyname is
2496 #ifndef HAVE_GMTIME_R
2497 if (!err) err = pthread_mutex_init(&gmtime_mutex, 0);
2498 #endif /* ndef HAVE_GMTIME_R */
2500 #ifndef HAVE_LOCALTIME_R
2501 if (!err) err = pthread_mutex_init(&localtime_mutex, 0);
2502 #endif /* ndef HAVE_GMTIME_R */
2504 #ifndef HAVE_GETHOSTBYADDR_R
2505 if (!err) err = pthread_mutex_init(&gethostbyaddr_mutex, 0);
2506 #endif /* ndef HAVE_GETHOSTBYADDR_R */
2508 #ifndef HAVE_GETHOSTBYNAME_R
2509 if (!err) err = pthread_mutex_init(&gethostbyname_mutex, 0);
2510 #endif /* ndef HAVE_GETHOSTBYNAME_R */
2513 if (!err) err = pthread_mutex_init(&rand_mutex, 0);
2514 #endif /* ndef HAVE_RANDOM */
2515 #endif /* FEATURE_PTHREAD */
2518 * TODO: mutex support for mingw32 would be swell.
2523 printf("Fatal error. Mutex initialization failed: %s.\n",
2532 /*********************************************************************
2536 * Description : Load the config file and start the listen loop.
2537 * This function is a lot more *sane* with the `load_config'
2538 * and `listen_loop' functions; although it stills does
2539 * a *little* too much for my taste.
2542 * 1 : argc = Number of parameters (including $0).
2543 * 2 : argv = Array of (char *)'s to the parameters.
2545 * Returns : 1 if : can't open config file, unrecognized directive,
2546 * stats requested in multi-thread mode, can't open the
2547 * log file, can't open the jar file, listen port is invalid,
2548 * any load fails, and can't bind port.
2550 * Else main never returns, the process must be signaled
2551 * to terminate execution. Or, on Windows, use the
2552 * "File", "Exit" menu option.
2554 *********************************************************************/
2556 int real_main(int argc, const char *argv[])
2558 int main(int argc, const char *argv[])
2562 unsigned int random_seed;
2564 struct passwd *pw = NULL;
2565 struct group *grp = NULL;
2574 #if !defined(_WIN32)
2582 * Parse the command line arguments
2584 while (++argc_pos < argc)
2587 /* Check to see if the service must be installed or uninstalled */
2588 if (strncmp(argv[argc_pos], "--install", 9) == 0)
2590 const char *pName = argv[argc_pos] + 9;
2593 exit( (install_service(pName)) ? 0 : 1 );
2595 else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
2597 const char *pName = argv[argc_pos] + 11;
2600 exit((uninstall_service(pName)) ? 0 : 1);
2602 else if (strcmp(argv[argc_pos], "--service" ) == 0)
2604 bRunAsService = TRUE;
2605 w32_set_service_cwd();
2606 atexit(w32_service_exit_notify);
2609 #endif /* defined(_WIN32) */
2612 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2614 if (strcmp(argv[argc_pos], "--help") == 0)
2619 else if(strcmp(argv[argc_pos], "--version") == 0)
2621 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
2627 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
2632 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
2634 if (++argc_pos == argc) usage(argv[0]);
2635 pidfile = strdup(argv[argc_pos]);
2638 else if (strcmp(argv[argc_pos], "--user" ) == 0)
2640 if (++argc_pos == argc) usage(argv[argc_pos]);
2642 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
2645 if (NULL == (grp = getgrnam(p)))
2647 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
2651 if (NULL == (pw = getpwnam(argv[argc_pos])))
2653 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
2656 if (p != NULL) *--p = '\0';
2659 else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
2664 #endif /* defined(unix) */
2665 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
2667 configfile = argv[argc_pos];
2670 } /* -END- while (more arguments) */
2673 if ( *configfile != '/' )
2675 char *abs_file, cwd[1024];
2677 /* make config-filename absolute here */
2678 if ( !(getcwd(cwd, sizeof(cwd))))
2680 perror("get working dir failed");
2684 if (!(basedir = strdup(cwd))
2685 || (!(abs_file = malloc( strlen( basedir ) + strlen( configfile ) + 5 ))))
2687 perror("malloc failed");
2690 strcpy( abs_file, basedir );
2691 strcat( abs_file, "/" );
2692 strcat( abs_file, configfile );
2693 configfile = abs_file;
2695 #endif /* defined unix */
2699 clients->next = NULL;
2703 #elif defined(_WIN32)
2707 /* Prepare mutexes if supported and necessary. */
2708 initialize_mutexes();
2710 random_seed = (unsigned int)time(NULL);
2712 srandom(random_seed);
2715 #endif /* ifdef HAVE_RANDOM */
2718 * Unix signal handling
2720 * Catch the abort, interrupt and terminate signals for a graceful exit
2721 * Catch the hangup signal so the errlog can be reopened.
2722 * Ignore the broken pipe signals (FIXME: Why?)
2724 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
2727 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
2728 const int ignored_signals[] = { SIGPIPE, 0 };
2730 for (idx = 0; catched_signals[idx] != 0; idx++)
2732 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
2733 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
2735 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
2736 #endif /* ifdef sun */
2738 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
2742 for (idx = 0; ignored_signals[idx] != 0; idx++)
2744 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
2746 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
2751 #else /* ifdef _WIN32 */
2752 # ifdef _WIN_CONSOLE
2754 * We *are* in a windows console app.
2755 * Print a verbose messages about FAQ's and such
2757 printf("%s", win32_blurb);
2758 # endif /* def _WIN_CONSOLE */
2759 #endif /* def _WIN32 */
2762 /* Initialize the CGI subsystem */
2763 cgi_init_error_messages();
2766 * If runnig on unix and without the --nodaemon
2767 * option, become a daemon. I.e. fork, detach
2768 * from tty and get process group leadership
2781 if ( pid < 0 ) /* error */
2786 else if ( pid != 0 ) /* parent */
2791 * must check for errors
2792 * child died due to missing files aso
2795 wpid = waitpid( pid, &status, WNOHANG );
2804 /* Should be more portable, but not as well tested */
2809 #else /* ndef __FreeBSD__ */
2811 #endif /* ndef __FreeBSD__ */
2812 fd = open("/dev/tty", O_RDONLY);
2815 /* no error check here */
2816 ioctl( fd, TIOCNOTTY,0 );
2820 /* FIXME: should close stderr (fd 2) here too, but the test
2822 * and load config file is done in listen_loop() and puts
2823 * some messages on stderr there.
2830 } /* -END- if (!no_daemon) */
2833 * As soon as we have written the PID file, we can switch
2834 * to the user and group ID indicated by the --user option
2840 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
2842 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
2848 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
2850 if (chroot(pw->pw_dir) < 0)
2852 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
2856 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
2859 if (setuid(pw->pw_uid))
2861 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
2865 char putenv_dummy[64];
2867 strcpy(putenv_dummy, "HOME=/");
2868 if (putenv(putenv_dummy) != 0)
2870 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
2873 snprintf(putenv_dummy, 64, "USER=%s", pw->pw_name);
2874 if (putenv(putenv_dummy) != 0)
2876 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
2882 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
2885 #endif /* defined unix */
2888 /* This will be FALSE unless the command line specified --service
2892 /* Yup, so now we must attempt to establish a connection
2893 * with the service dispatcher. This will only work if this
2894 * process was launched by the service control manager to
2895 * actually run as a service. If this isn't the case, i've
2896 * known it take around 30 seconds or so for the call to return.
2899 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
2900 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
2902 /* Service has run, and at this point is now being stopped, so just return */
2907 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
2909 /* An error occurred. Usually it's because --service was wrongly specified
2910 * and we were unable to connect to the Service Control Dispatcher because
2911 * it wasn't expecting us and is therefore not listening.
2913 * For now, just continue below to call the listen_loop function.
2916 #endif /* def _WIN32 */
2926 /*********************************************************************
2928 * Function : bind_port_helper
2930 * Description : Bind the listen port. Handles logging, and aborts
2934 * 1 : config = Privoxy configuration. Specifies port
2937 * Returns : Port that was opened.
2939 *********************************************************************/
2940 static jb_socket bind_port_helper(struct configuration_spec * config)
2945 if ( (config->haddr != NULL)
2946 && (config->haddr[0] == '1')
2947 && (config->haddr[1] == '2')
2948 && (config->haddr[2] == '7')
2949 && (config->haddr[3] == '.') )
2951 log_error(LOG_LEVEL_INFO, "Listening on port %d for local connections only",
2954 else if (config->haddr == NULL)
2956 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
2961 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
2962 config->hport, config->haddr);
2965 result = bind_port(config->haddr, config->hport, &bfd);
2972 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2973 "There may be another Privoxy or some other "
2974 "proxy running on port %d",
2975 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
2976 config->hport, config->hport);
2979 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2980 "The hostname is not resolvable",
2981 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2984 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
2985 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2988 /* shouldn't get here */
2989 return JB_INVALID_SOCKET;
2992 config->need_bind = 0;
2999 /* Without this simple workaround we get this compiler warning from _beginthread
3000 * warning C4028: formal parameter 1 different from declaration
3002 void w32_service_listen_loop(void *p)
3006 #endif /* def _WIN32 */
3009 /*********************************************************************
3011 * Function : listen_loop
3013 * Description : bind the listen port and enter a "FOREVER" listening loop.
3019 *********************************************************************/
3020 static void listen_loop(void)
3022 struct client_state *csp = NULL;
3024 struct configuration_spec * config;
3026 config = load_config();
3028 bfd = bind_port_helper(config);
3030 #ifdef FEATURE_GRACEFUL_TERMINATION
3031 while (!g_terminate)
3036 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3037 while (waitpid(-1, NULL, WNOHANG) > 0)
3039 /* zombie children */
3041 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3044 * Free data that was used by died threads
3050 * Re-open the errlog after HUP signal
3052 if (received_hup_signal)
3054 init_error_log(Argv[0], config->logfile, config->debug);
3055 received_hup_signal = 0;
3060 #ifdef FEATURE_COOKIE_JAR
3062 * Need a workaround here: we have to fclose() the jarfile, or we die because it's
3063 * already open. I think unload_configfile() is not being run, which should do
3064 * this work. Until that can get resolved, we'll use this workaround.
3068 if (csp->config->jar)
3070 fclose(csp->config->jar);
3071 csp->config->jar = NULL;
3073 #endif /* FEATURE_COOKIE_JAR */
3074 #endif /* __OS2__ */
3076 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
3078 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
3082 csp->flags |= CSP_FLAG_ACTIVE;
3083 csp->sfd = JB_INVALID_SOCKET;
3085 csp->config = config = load_config();
3087 if ( config->need_bind )
3090 * Since we were listening to the "old port", we will not see
3091 * a "listen" param change until the next IJB request. So, at
3092 * least 1 more request must be made for us to find the new
3093 * setting. I am simply closing the old socket and binding the
3096 * Which-ever is correct, we will serve 1 more page via the
3097 * old settings. This should probably be a "show-proxy-args"
3098 * request. This should not be a so common of an operation
3099 * that this will hurt people's feelings.
3104 bfd = bind_port_helper(config);
3107 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3109 if (!accept_connection(csp, bfd))
3111 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3124 log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
3127 #ifdef FEATURE_TOGGLE
3128 if (global_toggle_state)
3130 csp->flags |= CSP_FLAG_TOGGLED_ON;
3132 #endif /* def FEATURE_TOGGLE */
3134 if (run_loader(csp))
3136 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3137 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3141 if (block_acl(NULL,csp))
3143 log_error(LOG_LEVEL_CONNECT, "Connection dropped due to ACL");
3144 close_socket(csp->cfd);
3148 #endif /* def FEATURE_ACL */
3150 /* add it to the list of clients */
3151 csp->next = clients->next;
3152 clients->next = csp;
3154 if (config->multi_threaded)
3158 /* this is a switch () statment in the C preprocessor - ugh */
3159 #undef SELECTED_ONE_OPTION
3161 /* Use Pthreads in preference to native code */
3162 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3163 #define SELECTED_ONE_OPTION
3165 pthread_t the_thread;
3166 pthread_attr_t attrs;
3168 pthread_attr_init(&attrs);
3169 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3170 errno = pthread_create(&the_thread, &attrs,
3171 (void * (*)(void *))serve, csp);
3172 child_id = errno ? -1 : 0;
3173 pthread_attr_destroy(&attrs);
3177 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3178 #define SELECTED_ONE_OPTION
3179 child_id = _beginthread(
3180 (void (*)(void *))serve,
3185 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3186 #define SELECTED_ONE_OPTION
3187 child_id = _beginthread(
3188 (void(* _Optlink)(void*))serve,
3194 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3195 #define SELECTED_ONE_OPTION
3197 thread_id tid = spawn_thread
3198 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3200 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3202 child_id = (int) tid;
3211 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3212 #define SELECTED_ONE_OPTION
3213 csp->cfd = ReleaseSocket(csp->cfd, -1);
3216 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3217 NP_Output, Output(),
3218 NP_CloseOutput, FALSE,
3219 NP_Name, (ULONG)"privoxy child",
3223 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3224 NP_Output, Output(),
3225 NP_CloseOutput, FALSE,
3226 NP_Name, (ULONG)"privoxy child",
3227 NP_StackSize, 200*1024,
3233 ((struct Task *)child_id)->tc_UserData = csp;
3234 Signal((struct Task *)child_id, SIGF_SINGLE);
3239 #if !defined(SELECTED_ONE_OPTION)
3242 /* This block is only needed when using fork().
3243 * When using threads, the server thread was
3244 * created and run by the call to _beginthread().
3246 if (child_id == 0) /* child */
3249 #ifdef FEATURE_TOGGLE
3250 int inherited_toggle_state = global_toggle_state;
3251 #endif /* def FEATURE_TOGGLE */
3256 * If we've been toggled or we've blocked the request, tell Mom
3259 #ifdef FEATURE_TOGGLE
3260 if (inherited_toggle_state != global_toggle_state)
3262 rc |= RC_FLAG_TOGGLED;
3264 #endif /* def FEATURE_TOGGLE */
3266 #ifdef FEATURE_STATISTICS
3267 if (csp->flags & CSP_FLAG_REJECTED)
3269 rc |= RC_FLAG_BLOCKED;
3271 #endif /* ndef FEATURE_STATISTICS */
3275 else if (child_id > 0) /* parent */
3277 /* in a fork()'d environment, the parent's
3278 * copy of the client socket and the CSP
3282 #if !defined(_WIN32) && !defined(__CYGWIN__)
3284 wait( &child_status );
3287 * Evaluate child's return code: If the child has
3288 * - been toggled, toggle ourselves
3289 * - blocked its request, bump up the stats counter
3292 #ifdef FEATURE_TOGGLE
3293 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3295 global_toggle_state = !global_toggle_state;
3297 #endif /* def FEATURE_TOGGLE */
3299 #ifdef FEATURE_STATISTICS
3301 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3305 #endif /* def FEATURE_STATISTICS */
3307 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3308 close_socket(csp->cfd);
3309 csp->flags &= ~CSP_FLAG_ACTIVE;
3313 #undef SELECTED_ONE_OPTION
3314 /* end of cpp switch () */
3316 if (child_id < 0) /* failed */
3318 char buf[BUFFER_SIZE];
3320 log_error(LOG_LEVEL_ERROR, "can't fork: %E");
3322 snprintf(buf , sizeof(buf), "Privoxy: can't fork: errno = %d", errno);
3324 write_socket(csp->cfd, buf, strlen(buf));
3325 close_socket(csp->cfd);
3326 csp->flags &= ~CSP_FLAG_ACTIVE;
3337 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3339 /* Clean up. Aim: free all memory (no leaks) */
3340 #ifdef FEATURE_GRACEFUL_TERMINATION
3342 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3344 unload_current_config_file();
3345 unload_current_actions_file();
3346 unload_current_re_filterfile();
3347 #ifdef FEATURE_TRUST
3348 unload_current_trust_file();
3351 if (config->multi_threaded)
3358 } while ((clients->next != NULL) && (--i > 0));
3362 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3373 #ifdef FEATURE_COOKIE_JAR
3374 if (NULL != config->jar)
3376 fclose(config->jar);
3380 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3381 /* Cleanup - remove taskbar icon etc. */
3386 #endif /* FEATURE_GRACEFUL_TERMINATION */