1 const char jcc_rcs[] = "$Id: jcc.c,v 1.222 2009/02/08 12:56:51 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-2009 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.222 2009/02/08 12:56:51 fabiankeil
37 * Call initialize_mutexes() before init_log_module() again.
38 * Broken since r220, might be the cause of Lee's #2579448.
40 * Revision 1.221 2009/02/06 18:02:58 fabiankeil
41 * When dropping privileges, also give up membership in supplementary
42 * groups. Thanks to Matthias Drochner for reporting the problem,
43 * providing the initial patch and testing the final version.
45 * Revision 1.220 2009/02/04 18:29:07 fabiankeil
46 * Initialize the log module before parsing arguments.
47 * Thanks to Matthias Drochner for the report.
49 * Revision 1.219 2009/01/31 16:08:21 fabiankeil
50 * Remove redundant error check in receive_client_request().
52 * Revision 1.218 2009/01/31 12:25:54 fabiankeil
53 * Flatten indentation in receive_client_request().
55 * Revision 1.217 2009/01/07 19:50:09 fabiankeil
56 * - If the socket-timeout has been reached and the client
57 * hasn't received any data yet, send an explanation before
58 * closing the connection.
59 * - In get_request_line(), signal timeouts the right way.
61 * Revision 1.216 2008/12/24 22:13:11 ler762
62 * fix GCC 3.4.4 warning
64 * Revision 1.215 2008/12/24 17:06:19 fabiankeil
65 * Keep a thread around to timeout alive connections
66 * even if no new requests are coming in.
68 * Revision 1.214 2008/12/20 14:53:55 fabiankeil
69 * Add config option socket-timeout to control the time
70 * Privoxy waits for data to arrive on a socket. Useful
71 * in case of stale ssh tunnels or when fuzz-testing.
73 * Revision 1.213 2008/12/15 18:45:51 fabiankeil
74 * When logging crunches, log the whole URL, so one can easily
75 * differentiate between vanilla HTTP and CONNECT requests.
77 * Revision 1.212 2008/12/14 15:46:22 fabiankeil
78 * Give crunched requests their own log level.
80 * Revision 1.211 2008/12/06 10:05:03 fabiankeil
81 * Downgrade "Received x bytes while expecting y." message to
82 * LOG_LEVEL_CONNECT as it doesn't necessarily indicate an error.
84 * Revision 1.210 2008/12/02 22:03:18 fabiankeil
85 * Don't miscalculate byte_count if we don't get all the
86 * server headers with one read_socket() call. With keep-alive
87 * support enabled, this caused delays until the server closed
90 * Revision 1.209 2008/11/27 09:44:04 fabiankeil
91 * Cosmetics for the last commit: Don't watch out for
92 * the last chunk if the content isn't chunk-encoded or
93 * if we already determined the content length previously.
95 * Revision 1.208 2008/11/26 18:24:17 fabiankeil
96 * Recognize that the server response is complete if the
97 * last chunk is read together with the server headers.
100 * Revision 1.207 2008/11/25 17:25:16 fabiankeil
101 * Don't convert the client-header list to text until we need to.
103 * Revision 1.206 2008/11/23 17:00:11 fabiankeil
104 * Some more chat() cosmetics.
106 * Revision 1.205 2008/11/16 12:43:49 fabiankeil
107 * Turn keep-alive support into a runtime feature
108 * that is disabled by setting keep-alive-timeout
109 * to a negative value.
111 * Revision 1.204 2008/11/06 19:42:17 fabiankeil
112 * Fix last-chunk detection hack to also apply
113 * if buf[] contains nothing but the last-chunk.
115 * Revision 1.203 2008/11/06 18:34:35 fabiankeil
116 * Factor receive_client_request() and
117 * parse_client_request() out of chat().
119 * Revision 1.202 2008/11/02 18:40:34 fabiankeil
120 * If we received a different amount of data than we expected,
121 * log a warning and make sure the server socket isn't reused.
123 * Revision 1.201 2008/11/02 16:48:20 fabiankeil
124 * Revert revision 1.195 and try again.
126 * Revision 1.200 2008/10/26 16:53:18 fabiankeil
129 * Revision 1.199 2008/10/26 15:36:10 fabiankeil
130 * Remove two debug messages with LOG_LEVEL_INFO.
132 * Revision 1.198 2008/10/22 15:19:55 fabiankeil
133 * Once More, With Feeling: if there is no logfile
134 * because the user didn't specify one, we shouldn't
135 * call init_error_log() after receiving SIGHUP either.
137 * Revision 1.197 2008/10/20 17:02:40 fabiankeil
138 * If SIGHUP is received while we aren't running in daemon
139 * mode, calling init_error_log() would be a mistake.
141 * Revision 1.196 2008/10/16 09:16:41 fabiankeil
142 * - Fix two gcc44 conversion warnings.
143 * - Don't bother logging the last five bytes
146 * Revision 1.195 2008/10/13 16:04:37 fabiankeil
147 * Make sure we don't try to reuse tainted server sockets.
149 * Revision 1.194 2008/10/12 18:35:18 fabiankeil
150 * The last commit was a bit too ambitious, apparently the content
151 * length adjustment is only necessary if we aren't buffering.
153 * Revision 1.193 2008/10/12 15:57:35 fabiankeil
154 * Fix content length calculation if we read headers
155 * and the start of the body at once. Now that we have
156 * FEATURE_CONNECTION_KEEP_ALIVE, it actually matters.
158 * Revision 1.192 2008/10/11 18:19:14 fabiankeil
159 * Even more chat() cosmetics.
161 * Revision 1.191 2008/10/11 18:00:14 fabiankeil
162 * Reformat some comments in chat().
164 * Revision 1.190 2008/10/11 14:58:00 fabiankeil
165 * In case of chunk-encoded content, stop reading if
166 * the buffer looks like it ends with the last chunk.
168 * Revision 1.189 2008/10/11 09:53:00 fabiankeil
169 * Let server_response_is_complete() deal properly with
170 * content that is neither buffered nor read all at once.
172 * Revision 1.188 2008/10/09 18:21:41 fabiankeil
173 * Flush work-in-progress changes to keep outgoing connections
174 * alive where possible. Incomplete and mostly #ifdef'd out.
176 * Revision 1.187 2008/09/07 12:35:05 fabiankeil
177 * Add mutex lock support for _WIN32.
179 * Revision 1.186 2008/09/04 08:13:58 fabiankeil
180 * Prepare for critical sections on Windows by adding a
181 * layer of indirection before the pthread mutex functions.
183 * Revision 1.185 2008/08/30 12:03:07 fabiankeil
184 * Remove FEATURE_COOKIE_JAR.
186 * Revision 1.184 2008/08/22 15:34:45 fabiankeil
187 * - Silence LLVM/Clang complaint.
188 * - Make received_hup_signal static.
189 * - Hide definitions for basedir, pidfile and received_hup_signal
190 * from __EMX__ as they only seem to be used in case of #ifdef unix.
192 * Revision 1.183 2008/08/21 07:09:35 fabiankeil
193 * Accept Shoutcast responses again. Problem reported
194 * and fix suggested by Stefan in #2062860.
196 * Revision 1.182 2008/06/27 11:13:56 fabiankeil
197 * Fix possible NULL-pointer dereference reported
198 * by din_a4 in #2003937. Pointy hat to me.
200 * Revision 1.181 2008/05/21 15:47:15 fabiankeil
201 * Streamline sed()'s prototype and declare
202 * the header parse and add structures static.
204 * Revision 1.180 2008/05/21 15:26:32 fabiankeil
205 * - Mark csp as immutable for send_crunch_response().
206 * - Fix comment spelling.
208 * Revision 1.179 2008/05/20 20:13:32 fabiankeil
209 * Factor update_server_headers() out of sed(), ditch the
210 * first_run hack and make server_patterns_light static.
212 * Revision 1.178 2008/05/10 13:23:38 fabiankeil
213 * Don't provide get_header() with the whole client state
214 * structure when it only needs access to csp->iob.
216 * Revision 1.177 2008/05/10 11:51:12 fabiankeil
217 * Make the "read the rest of the headers" loop a bit more readable.
219 * Revision 1.176 2008/05/10 11:37:57 fabiankeil
220 * - Instead of logging when the IIS5 hack is enabled, log when it fails.
221 * - Remove useless comment.
223 * Revision 1.175 2008/05/09 18:53:59 fabiankeil
224 * Fix comment grammar.
226 * Revision 1.174 2008/05/07 18:05:53 fabiankeil
227 * Remove the pointless buffer in client_protocol_is_unsupported().
229 * Revision 1.173 2008/05/06 15:09:00 fabiankeil
230 * Least-effort fix for bug #1821930 (reported by Lee):
231 * If the response doesn't look like HTTP,
232 * tell the client and log the problem.
234 * Revision 1.172 2008/04/16 16:38:21 fabiankeil
235 * Don't pass the whole csp structure to flush_socket()
236 * when it only needs a file descriptor and a buffer.
238 * Revision 1.171 2008/03/27 18:27:25 fabiankeil
239 * Remove kill-popups action.
241 * Revision 1.170 2008/03/06 16:33:46 fabiankeil
242 * If limit-connect isn't used, don't limit CONNECT requests to port 443.
244 * Revision 1.169 2008/03/04 18:30:39 fabiankeil
245 * Remove the treat-forbidden-connects-like-blocks action. We now
246 * use the "blocked" page for forbidden CONNECT requests by default.
248 * Revision 1.168 2008/03/02 12:25:25 fabiankeil
249 * Also use shiny new connect_port_is_forbidden() in jcc.c.
251 * Revision 1.167 2008/02/23 16:57:12 fabiankeil
252 * Rename url_actions() to get_url_actions() and let it
253 * use the standard parameter ordering.
255 * Revision 1.166 2008/02/23 16:33:43 fabiankeil
256 * Let forward_url() use the standard parameter ordering
257 * and mark its second parameter immutable.
259 * Revision 1.165 2008/02/02 19:36:56 fabiankeil
260 * Remove the "Listening ... for local connections only" log message.
261 * Whether or not remote connections are able to reach Privoxy is up
262 * to the operating system.
264 * Revision 1.164 2007/12/16 18:32:46 fabiankeil
265 * Prevent the log messages for CONNECT requests to unacceptable
266 * ports from printing the limit-connect argument as [null] if
267 * limit-connect hasn't been explicitly enabled.
269 * Revision 1.163 2007/12/13 01:47:11 david__schmidt
270 * Make sure all console-mode apps get a usage() instance
272 * Revision 1.162 2007/12/06 17:54:57 fabiankeil
273 * Reword NO_SERVER_DATA_RESPONSE to make it harder
274 * to misunderstand what the message is all about.
276 * Revision 1.161 2007/12/04 19:44:22 fabiankeil
277 * Unbreak trustfile which previously didn't work without
278 * FEATURE_TOGGLE. Fixes BR#1843585, reported by Lee.
280 * Revision 1.160 2007/11/29 18:00:29 fabiankeil
281 * Plug memory leak. Spotted by Valgrind, triggered by
282 * Privoxy-Regression-Test feeding proxyfuzz.py.
284 * Revision 1.159 2007/11/24 14:34:09 fabiankeil
285 * In the HTTP snipplets, refer to the client as client.
287 * Revision 1.158 2007/11/11 16:44:17 fabiankeil
288 * Emit a log message when activating the MS IIS5 hack.
290 * Revision 1.157 2007/11/03 17:34:49 fabiankeil
291 * Log the "weak randomization factor" warning only
292 * once for mingw32 and provide some more details.
294 * Revision 1.156 2007/11/01 18:20:58 fabiankeil
295 * Initialize log module after initializing mutexes, future
296 * deadlocks in that code should now work cross-platform.
298 * Revision 1.155 2007/10/23 20:12:45 fabiankeil
299 * Fix first CSUCCEED line to end in \r\n as required by RFC1945.
300 * Reported by Bert van Leeuwen in BR#1818808.
302 * Revision 1.154 2007/10/19 17:00:08 fabiankeil
303 * Downgrade "Flushing header and buffers" message to LOG_LEVEL_INFO.
305 * Revision 1.153 2007/10/14 14:12:41 fabiankeil
306 * When in daemon mode, close stderr after the configuration file has been
307 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
309 * Revision 1.152 2007/10/04 18:03:34 fabiankeil
310 * - Fix a crash when parsing invalid requests whose first header
311 * is rejected by get_header(). Regression (re?)introduced
312 * in r1.143 by yours truly.
313 * - Move ACTION_VANILLA_WAFER handling into parsers.c's
314 * client_cookie_adder() to make sure send-vanilla-wafer can be
315 * controlled through tags (and thus regression-tested).
317 * Revision 1.151 2007/09/29 10:21:16 fabiankeil
318 * - Move get_filter_function() from jcc.c to filters.c
319 * so the filter functions can be static.
320 * - Don't bother filtering body-less responses.
322 * Revision 1.150 2007/09/28 16:39:29 fabiankeil
323 * Execute content filters through execute_content_filter().
325 * Revision 1.149 2007/09/04 15:08:48 fabiankeil
326 * Initialize req to NULL to make sure it's defined if the
327 * first read_socket() call fails. Reported by icmp30.
329 * Revision 1.148 2007/08/26 16:47:13 fabiankeil
330 * Add Stephen Gildea's --pre-chroot-nslookup patch [#1276666],
331 * extensive comments moved to user manual.
333 * Revision 1.147 2007/08/25 14:42:40 fabiankeil
334 * Don't crash if a broken header filter wiped out the request line.
336 * Revision 1.146 2007/08/20 17:09:32 fabiankeil
337 * Fix byte_count calculation in case of flushes
338 * and don't parse the server headers a second time.
340 * Revision 1.145 2007/08/19 13:13:31 fabiankeil
341 * - If there's a connection problem after we already forwarded
342 * parts of the original content, just hang up. Fixes BR#1776724.
343 * - Fix warnings about unused code on mingw32.
344 * - In case of flushes, calculate the byte count
345 * less incorrectly (I think).
347 * Revision 1.144 2007/08/11 14:43:22 fabiankeil
348 * Add some more prototypes for static functions.
350 * Revision 1.143 2007/08/05 13:58:19 fabiankeil
351 * Comment out request_contains_null_bytes() until it's used again.
353 * Revision 1.142 2007/08/05 13:50:26 fabiankeil
354 * #1763173 from Stefan Huehner: s@const static@static const@
355 * and declare some more functions static.
357 * Revision 1.141 2007/08/04 09:56:23 fabiankeil
358 * - Log rejected CONNECT requests with LOG_LEVEL_INFO
359 * and explain why they were rejected in the first place.
360 * - Fix the LOG_LEVEL_CLF message for crunches of unallowed
361 * CONNECT requests. The request line was missing.
362 * - Add two more XXX reminders as we don't have enough already.
364 * Revision 1.140 2007/07/21 11:51:36 fabiankeil
365 * As Hal noticed, checking dispatch_cgi() as the last cruncher
366 * looks like a bug if CGI requests are blocked unintentionally,
367 * so don't do it unless the user enabled the new config option
368 * "allow-cgi-request-crunching".
370 * Revision 1.139 2007/07/14 07:46:41 fabiankeil
371 * - Allow to rewrite the request destination behind the client's back.
372 * - Turn the weird-looking unconditional for loop that
373 * reads the client request into a conditional while loop.
374 * Move the stuff that only runs once out of the loop.
375 * - Move parts of chat(), server_content_type() and the
376 * necessary stuff to fix BR#1750917 into get_filter_function().
378 * Revision 1.138 2007/06/03 18:45:18 fabiankeil
379 * Temporary workaround for BR#1730105.
381 * Revision 1.137 2007/06/01 18:16:36 fabiankeil
382 * Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
383 * deadlocks and crashes on OpenBSD and possibly other OS with neither
384 * gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
385 * Thanks to Ralf Horstmann for report and solution.
387 * Revision 1.136 2007/06/01 16:41:11 fabiankeil
388 * Add forward-override{} to change the forwarding settings through
389 * action sections. This is mainly interesting to forward different
390 * clients differently (for example based on User-Agent or request
393 * Revision 1.135 2007/05/24 17:03:50 fabiankeil
394 * - Let usage() mention the --chroot parameter.
395 * - Use read_socket() consistently and always leave
396 * the last buffer byte alone, even in cases where
397 * null termination (currently) doesn't matter.
399 * Revision 1.134 2007/05/16 14:59:46 fabiankeil
400 * - Fix config file loading on Unix if no config file is specified.
401 * Since r1.97 Privoxy would always interpret the last argument as
402 * config file, even if it's a valid command line option.
403 * - Abort in case of unrecognized command line options. Closes #1719696.
404 * - Remove a bunch of unnecessary strcpy() calls (yay for c&p without thinking).
405 * - Replace the remaining strcpy() and strcat() calls with strlcpy() and strcat().
407 * Revision 1.133 2007/05/04 11:23:19 fabiankeil
408 * - Don't rerun crunchers that only depend on the request URL.
409 * - Don't count redirects and CGI requests as "blocked requests".
411 * Revision 1.132 2007/04/25 15:15:17 fabiankeil
412 * Support crunching based on tags created by server-header taggers.
414 * Revision 1.131 2007/04/22 13:24:50 fabiankeil
415 * Make HTTP snippets static (again). Add a Content-Type for those
416 * with content so the browser doesn't guess it based on the URL.
418 * Revision 1.130 2007/04/19 13:47:34 fabiankeil
419 * Move crunching and request line rebuilding out of chat().
421 * Revision 1.129 2007/04/15 16:39:20 fabiankeil
422 * Introduce tags as alternative way to specify which
423 * actions apply to a request. At the moment tags can be
424 * created based on client and server headers.
426 * Revision 1.128 2007/03/25 16:55:54 fabiankeil
427 * Don't CLF-log CONNECT requests twice.
429 * Revision 1.127 2007/03/20 13:53:17 fabiankeil
430 * Log the source address for ACL-related connection drops.
432 * Revision 1.126 2007/03/17 15:20:05 fabiankeil
433 * New config option: enforce-blocks.
435 * Revision 1.125 2007/03/09 14:12:00 fabiankeil
436 * - Move null byte check into separate function.
437 * - Don't confuse the client with error pages
438 * if a CONNECT request was already confirmed.
440 * Revision 1.124 2007/02/23 14:59:54 fabiankeil
441 * Speed up NULL byte escaping and only log the complete
442 * NULL byte requests with header debugging enabled.
444 * Revision 1.123 2007/02/21 18:42:10 fabiankeil
445 * Answer requests that contain NULL bytes with
446 * a custom response instead of waiting for more
447 * data until the client eventually hangs up.
449 * Revision 1.122 2007/02/07 11:12:02 fabiankeil
450 * - Move delivery and logging of crunched responses
451 * from chat() into send_crunch_response().
452 * - Display the reason for generating http_responses.
453 * - Log the content length for LOG_LEVEL_CLF correctly
454 * (still incorrect for some fixed responses).
455 * - Reword an incorrect comment about
456 * treat-forbidden-connects-like-blocks violating
458 * - Add some log messages.
460 * Revision 1.121 2007/01/27 10:52:56 fabiankeil
461 * Move mutex initialization into separate
462 * function and exit in case of errors.
464 * Revision 1.120 2007/01/26 14:18:42 fabiankeil
465 * - Start to reduce chat()'s line count and move
466 * parts of it into separate functions.
467 * - Add "HTTP/1.1 100 Continue" hack for BR 756734.
469 * Revision 1.119 2007/01/25 14:02:30 fabiankeil
470 * - Add Proxy-Agent header to HTTP snippets that are
471 * supposed to reach HTTP clients only.
472 * - Made a few CONNECT log messages more descriptive.
473 * - Catch completely empty server responses (as seen
474 * with Tor's fake ".noconnect" top level domain).
475 * - Use shiny new "forwarding-failed" template for socks errors.
477 * Revision 1.118 2007/01/07 07:43:43 joergs
478 * AmigaOS4 support added.
480 * Revision 1.117 2006/12/31 17:56:37 fabiankeil
481 * Added config option accept-intercepted-requests
482 * and disabled it by default.
484 * Revision 1.116 2006/12/29 19:08:22 fabiankeil
485 * Reverted parts of my last commit
486 * to keep error handling working.
488 * Revision 1.115 2006/12/29 17:38:57 fabiankeil
489 * Fixed gcc43 conversion warnings.
491 * Revision 1.114 2006/12/27 18:52:02 fabiankeil
492 * Fix -pedantic ISO C warning about converting
493 * from function pointer to object pointer.
495 * Revision 1.113 2006/12/26 17:38:50 fabiankeil
496 * Silence compiler warning I introduced with my last commit.
498 * Revision 1.112 2006/12/26 17:31:41 fabiankeil
499 * Mutex protect rand() if POSIX threading
500 * is used, warn the user if that's not possible
501 * and stop using it on _WIN32 where it could
504 * Revision 1.111 2006/12/23 16:15:06 fabiankeil
505 * Don't prevent core dumps by catching SIGABRT.
506 * It's rude and makes debugging unreasonable painful.
508 * Revision 1.110 2006/12/13 14:52:53 etresoft
509 * Fix build failure on MacOS X. Global symbols can be either static or extern, but not both.
511 * Revision 1.109 2006/12/06 19:41:40 fabiankeil
512 * Privoxy is now able to run as intercepting
513 * proxy in combination with any packet filter
514 * that does the port redirection. The destination
515 * is extracted from the "Host:" header which
516 * should be available for nearly all requests.
518 * Moved HTTP snipplets into jcc.c.
519 * Added error message for gopher proxy requests.
521 * Revision 1.108 2006/11/28 15:38:51 fabiankeil
522 * Only unlink the pidfile if it's actually used.
524 * Change order of interception checks to make
525 * it possible to block or redirect requests for
528 * Revision 1.107 2006/11/13 19:05:51 fabiankeil
529 * Make pthread mutex locking more generic. Instead of
530 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
531 * and use mutex locking unless there is an _r function
532 * available. Better safe than sorry.
534 * Fixes "./configure --disable-pthread" and should result
535 * in less threading-related problems on pthread-using platforms,
536 * but it still doesn't fix BR#1122404.
538 * Revision 1.106 2006/11/06 19:58:23 fabiankeil
539 * Move pthread.h inclusion from jcc.c to jcc.h.
540 * Fixes build on x86-freebsd1 (FreeBSD 5.4-RELEASE).
542 * Revision 1.105 2006/11/06 14:26:02 fabiankeil
543 * Don't exit after receiving the second SIGHUP on Solaris.
545 * Fixes BR 1052235, but the same problem may exist on other
546 * systems. Once 3.0.6 is out we should use sigset()
547 * where available and see if it breaks anything.
549 * Revision 1.104 2006/09/23 13:26:38 roro
550 * Replace TABs by spaces in source code.
552 * Revision 1.103 2006/09/21 12:54:43 fabiankeil
553 * Fix +redirect{}. Didn't work with -fast-redirects.
555 * Revision 1.102 2006/09/06 13:03:04 fabiankeil
556 * Respond with 400 and a short text message
557 * if the client tries to use Privoxy as FTP proxy.
559 * Revision 1.101 2006/09/06 09:23:37 fabiankeil
560 * Make number of retries in case of forwarded-connect problems
561 * a config file option (forwarded-connect-retries) and use 0 as
564 * Revision 1.100 2006/09/03 19:42:59 fabiankeil
565 * Set random(3) seed.
567 * Revision 1.99 2006/09/02 15:36:42 fabiankeil
568 * Follow the OpenBSD port's lead and protect the resolve
569 * functions on OpenBSD as well.
571 * Revision 1.98 2006/08/24 11:01:34 fabiankeil
572 * --user fix. Only use the user as group if no group is specified.
573 * Solves BR 1492612. Thanks to Spinor S. and David Laight.
575 * Revision 1.97 2006/08/18 15:23:17 david__schmidt
576 * Windows service (re-)integration
580 * --install[:service_name]
581 * --uninstall[:service_name]
584 * They work as follows:
585 * --install will create a service for you and then terminate.
586 * By default the service name will be "privoxy" (without the quotes).
587 * However you can run multiple services if you wish, just by adding
588 * a colon and then a name (no spaces).
590 * --uninstall follows the exact same rules a --install.
592 * --service is used when the program is executed by the service
593 * control manager, and in normal circumstances would never be
594 * used as a command line argument.
596 * Revision 1.96 2006/08/15 20:12:36 david__schmidt
597 * Windows service integration
599 * Revision 1.95 2006/08/03 02:46:41 david__schmidt
600 * Incorporate Fabian Keil's patch work:
601 http://www.fabiankeil.de/sourcecode/privoxy/
603 * Revision 1.94 2006/07/18 14:48:46 david__schmidt
604 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
605 * with what was really the latest development (the v_3_0_branch branch)
607 * Revision 1.92.2.16 2005/04/03 20:10:50 david__schmidt
608 * Thanks to Jindrich Makovicka for a race condition fix for the log
609 * file. The race condition remains for non-pthread implementations.
610 * Reference patch #1175720.
612 * Revision 1.92.2.15 2004/10/03 12:53:32 david__schmidt
613 * Add the ability to check jpeg images for invalid
614 * lengths of comment blocks. Defensive strategy
615 * against the exploit:
616 * Microsoft Security Bulletin MS04-028
617 * Buffer Overrun in JPEG Processing (GDI+) Could
618 * Allow Code Execution (833987)
619 * Enabled with +inspect-jpegs in actions files.
621 * Revision 1.92.2.14 2003/12/12 12:52:53 oes
622 * - Fixed usage info for non-unix platforms
623 * - Fixed small cmdline parsing bug
625 * Revision 1.92.2.13 2003/11/27 19:20:27 oes
626 * Diagnostics: Now preserve the returncode of pthread_create
627 * in errno. Closes BR #775721. Thanks to Geoffrey Hausheer.
629 * Revision 1.92.2.12 2003/07/11 11:34:19 oes
630 * No longer ignore SIGCHLD. Fixes bug #769381
632 * Revision 1.92.2.11 2003/05/14 12:32:02 oes
633 * Close jarfile on graceful exit, remove stray line
635 * Revision 1.92.2.10 2003/05/08 15:13:46 oes
636 * Cosmetics: Killed a warning, a typo and an allocation left at exit
638 * Revision 1.92.2.9 2003/04/03 15:08:42 oes
639 * No longer rely on non-POSIX.1 extensions of getcwd().
642 * Revision 1.92.2.8 2003/03/31 13:12:32 oes
643 * Replaced setenv() by posix-compliant putenv()
644 * Thanks to Neil McCalden (nmcc AT users.sf.net).
646 * Revision 1.92.2.7 2003/03/17 16:48:59 oes
647 * Added chroot ability, thanks to patch by Sviatoslav Sviridov
649 * Revision 1.92.2.6 2003/03/11 11:55:00 oes
650 * Clean-up and extension of improvements for forked mode:
651 * - Child's return code now consists of flags RC_FLAG_*
652 * - Reporting toggle to parent now properly #ifdef'ed
653 * - Children now report blocking to parent. This enables
654 * statistics in forked mode
656 * Revision 1.92.2.5 2003/03/10 23:45:32 oes
657 * Fixed bug #700381: Non-Threaded version now capable of being toggled.
658 * Children now report having been toggled through _exit(17), parents
659 * watch for that code and toggle themselves if found.
661 * Revision 1.92.2.4 2003/03/07 03:41:04 david__schmidt
662 * Wrapping all *_r functions (the non-_r versions of them) with
663 * mutex semaphores for OSX. Hopefully this will take care of all
664 * of those pesky crash reports.
666 * Revision 1.92.2.3 2003/02/28 12:53:06 oes
667 * Fixed two mostly harmless mem leaks
669 * Revision 1.92.2.2 2002/11/20 14:37:47 oes
670 * Fix: Head of global clients list now initialized to NULL
672 * Revision 1.92.2.1 2002/09/25 14:52:24 oes
673 * Added basic support for OPTIONS and TRACE HTTP methods:
674 * - New interceptor direct_response() added in chat().
675 * - sed() moved to earlier in the process, so that the
676 * Host: header is evaluated before actions and forwarding
679 * Revision 1.92 2002/05/08 16:00:46 oes
680 * Chat's buffer handling:
681 * - Fixed bug with unchecked out-of-mem conditions
682 * while reading client request & server headers
683 * - No longer predict if the buffer limit will be exceeded
684 * in the next read -- check add_to_iob's new
685 * return code. If buffer couldn't be extended
686 * (policy or out-of-mem) while
687 * - reading from client: abort
688 * - reading server headers: send error page
689 * - buffering server body for filter: flush,
690 * and if that fails: send error page
692 * Revision 1.91 2002/04/08 20:35:58 swa
695 * Revision 1.90 2002/04/02 14:57:28 oes
696 * Made sending wafers independent of FEATURE_COOKIE_JAR
698 * Revision 1.89 2002/03/31 17:18:59 jongfoster
699 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
701 * Revision 1.88 2002/03/27 14:32:43 david__schmidt
702 * More compiler warning message maintenance
704 * Revision 1.87 2002/03/26 22:29:54 swa
705 * we have a new homepage!
707 * Revision 1.86 2002/03/25 17:04:55 david__schmidt
708 * Workaround for closing the jarfile before load_config() comes around again
710 * Revision 1.85 2002/03/24 15:23:33 jongfoster
713 * Revision 1.84 2002/03/24 13:25:43 swa
714 * name change related issues
716 * Revision 1.83 2002/03/16 23:54:06 jongfoster
717 * Adding graceful termination feature, to help look for memory leaks.
718 * If you enable this (which, by design, has to be done by hand
719 * editing config.h) and then go to http://i.j.b/die, then the program
720 * will exit cleanly after the *next* request. It should free all the
721 * memory that was used.
723 * Revision 1.82 2002/03/13 00:27:05 jongfoster
726 * Revision 1.81 2002/03/12 01:42:50 oes
727 * Introduced modular filters
729 * Revision 1.80 2002/03/11 22:07:05 david__schmidt
730 * OS/2 port maintenance:
731 * - Fixed EMX build - it had decayed a little
732 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
733 * substituted a memset for now.
735 * Revision 1.79 2002/03/09 20:03:52 jongfoster
736 * - Making various functions return int rather than size_t.
737 * (Undoing a recent change). Since size_t is unsigned on
738 * Windows, functions like read_socket that return -1 on
739 * error cannot return a size_t.
741 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
742 * crashes, and also frequently caused JB to jump to 100%
743 * CPU and stay there. (Because it thought it had just
744 * read ((unsigned)-1) == 4Gb of data...)
746 * - The signature of write_socket has changed, it now simply
747 * returns success=0/failure=nonzero.
749 * - Trying to get rid of a few warnings --with-debug on
750 * Windows, I've introduced a new type "jb_socket". This is
751 * used for the socket file descriptors. On Windows, this
752 * is SOCKET (a typedef for unsigned). Everywhere else, it's
753 * an int. The error value can't be -1 any more, so it's
754 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
755 * Windows it maps to the #define INVALID_SOCKET.)
757 * - The signature of bind_port has changed.
759 * Revision 1.78 2002/03/08 21:35:04 oes
760 * Added optional group supplement to --user option. Will now use default group of user if no group given
762 * Revision 1.77 2002/03/07 03:52:06 oes
763 * - Fixed compiler warnings etc
764 * - Improved handling of failed DNS lookups
766 * Revision 1.76 2002/03/06 22:54:35 jongfoster
767 * Automated function-comment nitpicking.
769 * Revision 1.75 2002/03/06 10:02:19 oes
770 * Fixed stupid bug when --user was not given
772 * Revision 1.74 2002/03/06 00:49:31 jongfoster
773 * Fixing warning on Windows
774 * Making #ifdefs that refer to the same variable consistently
775 * use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
777 * Revision 1.73 2002/03/05 23:57:30 hal9
778 * Stray character 's' on line 1618 was breaking build.
780 * Revision 1.72 2002/03/05 21:33:45 david__schmidt
781 * - Re-enable OS/2 building after new parms were added
782 * - Fix false out of memory report when resolving CGI templates when no IP
783 * address is available of failed attempt (a la no such domain)
785 * Revision 1.71 2002/03/05 18:13:56 oes
786 * Added --user option
788 * Revision 1.70 2002/03/05 04:52:42 oes
789 * Deleted non-errlog debugging code
791 * Revision 1.69 2002/03/04 23:50:00 jongfoster
792 * Splitting off bind_port() call into bind_port_helper(), with
795 * Revision 1.68 2002/03/04 20:17:32 oes
798 * Revision 1.67 2002/03/04 18:18:57 oes
799 * - Removed _DEBUG mode
800 * - Cleand up cmdline parsing
801 * - Introduced --no-daemon, --pidfile options
802 * - Cleaned up signal handling:
803 * - Terminate cleanly on INT, TERM and ABRT
804 * - Schedule logfile for re-opening on HUP
805 * - Ignore CHLD and PIPE
806 * - Leave the rest with their default handlers
807 * - Uniform handler registration
808 * - Added usage() function
809 * - Played styleguide police
811 * Revision 1.66 2002/03/03 15:06:55 oes
812 * Re-enabled automatic config reloading
814 * Revision 1.65 2002/03/03 14:49:11 oes
815 * Fixed CLF logging: Now uses client's original HTTP request
817 * Revision 1.64 2002/03/03 09:18:03 joergs
818 * Made jumbjuster work on AmigaOS again.
820 * Revision 1.63 2002/03/02 04:14:50 david__schmidt
821 * Clean up a little CRLF unpleasantness that suddenly appeared
823 * Revision 1.62 2002/02/20 23:17:23 jongfoster
824 * Detecting some out-of memory conditions and exiting with a log message.
826 * Revision 1.61 2002/01/17 21:01:52 jongfoster
827 * Moving all our URL and URL pattern parsing code to urlmatch.c.
829 * Revision 1.60 2001/12/30 14:07:32 steudten
830 * - Add signal handling (unix)
831 * - Add SIGHUP handler (unix)
832 * - Add creation of pidfile (unix)
833 * - Add action 'top' in rc file (RH)
834 * - Add entry 'SIGNALS' to manpage
835 * - Add exit message to logfile (unix)
837 * Revision 1.59 2001/12/13 14:07:18 oes
838 * Fixed Bug: 503 error page now sent OK
840 * Revision 1.58 2001/11/30 23:37:24 jongfoster
841 * Renaming the Win32 config file to config.txt - this is almost the
842 * same as the corresponding UNIX name "config"
844 * Revision 1.57 2001/11/16 00:47:43 jongfoster
845 * Changing the tty-disconnection code to use setsid().
847 * Revision 1.56 2001/11/13 20:20:54 jongfoster
848 * Tabs->spaces, fixing a bug with missing {} around an if()
850 * Revision 1.55 2001/11/13 20:14:53 jongfoster
851 * Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
853 * Revision 1.54 2001/11/07 00:03:14 steudten
854 * Give reliable return value if an error
855 * occurs not just 0 with new daemon mode.
857 * Revision 1.53 2001/11/05 21:41:43 steudten
858 * Add changes to be a real daemon just for unix os.
859 * (change cwd to /, detach from controlling tty, set
860 * process group and session leader to the own process.
862 * Add some fatal-error log message for failed malloc().
863 * Add '-d' if compiled with 'configure --with-debug' to
864 * enable debug output.
866 * Revision 1.52 2001/10/26 20:11:20 jongfoster
867 * Fixing type mismatch
869 * Revision 1.51 2001/10/26 17:38:28 oes
872 * Revision 1.50 2001/10/25 03:40:48 david__schmidt
873 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
874 * threads to call select() simultaneously. So, it's time to do a real, live,
875 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
876 * (native). Both versions will work, but using __OS2__ offers multi-threading.
878 * Revision 1.49 2001/10/23 21:41:35 jongfoster
879 * Added call to initialize the (statically-allocated of course)
880 * "out of memory" CGI response.
882 * Revision 1.48 2001/10/10 19:56:46 jongfoster
883 * Moving some code that wasn't cookie-related out of an #ifdef
886 * Revision 1.47 2001/10/10 16:44:36 oes
887 * Added CONNECT destination port limitation check
889 * Revision 1.46 2001/10/08 15:17:41 oes
890 * Re-enabled SSL forwarding
892 * Revision 1.45 2001/10/07 15:42:11 oes
893 * Replaced 6 boolean members of csp with one bitmap (csp->flags)
895 * Moved downgrading of the HTTP version from parse_http_request to
896 * chat(), since we can't decide if it is necessary before we have
897 * determined the actions for the URL. The HTTP command is now
898 * *always* re-built so the repairs need no longer be special-cased.
900 * filter_popups now gets a csp pointer so it can raise the new
901 * CSP_FLAG_MODIFIED flag.
905 * Added configurable size limit for the IOB. If the IOB grows so
906 * large that the next read would exceed the limit, the header
907 * is generated, and the header & unfiltered buffer are flushed
908 * to the client. Chat then continues in non-buffering,
909 * non-filtering body mode.
911 * Revision 1.44 2001/10/02 18:13:57 oes
914 * Revision 1.43 2001/10/02 15:32:13 oes
915 * Moved generation of hdr
917 * Revision 1.42 2001/09/21 23:02:02 david__schmidt
918 * Cleaning up 2 compiler warnings on OS/2.
920 * Revision 1.41 2001/09/16 17:05:14 jongfoster
921 * Removing unused #include showarg.h
923 * Revision 1.40 2001/09/16 15:41:45 jongfoster
924 * Fixing signed/unsigned comparison warning.
926 * Revision 1.39 2001/09/16 13:21:27 jongfoster
927 * Changes to use new list functions.
929 * Revision 1.38 2001/09/16 13:01:46 jongfoster
930 * Removing redundant function call that zeroed zalloc()'d memory.
932 * Revision 1.37 2001/09/10 11:12:24 oes
933 * Deleted unused variable
935 * Revision 1.36 2001/09/10 10:56:15 oes
936 * Silenced compiler warnings
938 * Revision 1.35 2001/07/31 14:44:22 oes
939 * Deleted unused size parameter from filter_popups()
941 * Revision 1.34 2001/07/30 22:08:36 jongfoster
942 * Tidying up #defines:
943 * - All feature #defines are now of the form FEATURE_xxx
944 * - Permanently turned off WIN_GUI_EDIT
945 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
947 * Revision 1.33 2001/07/29 19:32:00 jongfoster
948 * Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
950 * Revision 1.32 2001/07/29 18:47:05 jongfoster
951 * Adding missing #include "loadcfg.h"
953 * Revision 1.31 2001/07/29 12:17:48 oes
954 * Applied pthread fix by Paul Lieverse
956 * Revision 1.30 2001/07/25 22:57:13 jongfoster
957 * __BEOS__ no longer overrides FEATURE_PTHREAD.
958 * This is because FEATURE_PTHREAD will soon be widely used, so I
959 * want to keep it simple.
961 * Revision 1.29 2001/07/24 12:47:06 oes
962 * Applied BeOS support update by Eugenia
964 * Revision 1.28 2001/07/23 13:26:12 oes
965 * Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
967 * Revision 1.27 2001/07/19 19:09:47 haroon
968 * - Added code to take care of the situation where while processing the first
969 * server response (which includes the server header), after finding the end
970 * of the headers we were not looking past the end of the headers for
971 * content modification. I enabled it for filter_popups.
972 * Someone else should look to see if other similar operations should be
973 * done to the discarded portion of the buffer.
975 * Note 2001/07/20: No, the other content modification mechanisms will process
976 * the whole iob later anyway. --oes
978 * Revision 1.26 2001/07/18 12:31:36 oes
981 * Revision 1.25 2001/07/15 19:43:49 jongfoster
982 * Supports POSIX threads.
983 * Also removed some unused #includes.
985 * Revision 1.24 2001/07/13 14:00:40 oes
986 * - Generic content modification scheme:
987 * Each feature has its own applicability flag that is set
988 * from csp->action->flags.
989 * Replaced the "filtering" int flag , by a function pointer
990 * "content_filter" to the function that will do the content
991 * modification. If it is != NULL, the document will be buffered
992 * and processed through *content_filter, which must set
993 * csp->content_length and return a modified copy of the body
994 * or return NULL (on failiure).
995 * - Changed csp->is_text to the more generic bitmap csp->content_type
996 * which can currently take the valued CT_TEXT or CT_GIF
998 * - Removed all #ifdef PCRS
1000 * Revision 1.23 2001/07/02 02:28:25 iwanttokeepanon
1001 * Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
1002 * the `block_acl' call. This prevents a compilation error when the user
1003 * does not wish to use the "ACL" feature.
1005 * Revision 1.22 2001/06/29 21:45:41 oes
1006 * Indentation, CRLF->LF, Tab-> Space
1008 * Revision 1.21 2001/06/29 13:29:36 oes
1009 * - Cleaned up, improved comments
1010 * - Unified all possible interceptors (CGI,
1011 * block, trust, fast_redirect) in one
1012 * place, with one (CGI) answer generation
1013 * mechansim. Much clearer now.
1014 * - Removed the GIF image generation, which
1015 * is now done in filters.c:block_url()
1016 * - Made error conditions like domain lookup
1017 * failiure or (various) problems while talking
1018 * to the server use cgi.c:error_response()
1019 * instead of generating HTML/HTTP in chat() (yuck!)
1020 * - Removed logentry from cancelled commit
1022 * Revision 1.20 2001/06/09 10:55:28 jongfoster
1023 * Changing BUFSIZ ==> BUFFER_SIZE
1025 * Revision 1.19 2001/06/07 23:12:52 jongfoster
1026 * Replacing function pointer in struct gateway with a directly
1027 * called function forwarded_connect().
1028 * Replacing struct gateway with struct forward_spec
1030 * Revision 1.18 2001/06/03 19:12:16 oes
1031 * introduced new cgi handling
1033 * Revision 1.17 2001/06/01 20:07:23 jongfoster
1034 * Now uses action +image-blocker{} rather than config->tinygif
1036 * Revision 1.16 2001/06/01 18:49:17 jongfoster
1037 * Replaced "list_share" with "list" - the tiny memory gain was not
1038 * worth the extra complexity.
1040 * Revision 1.15 2001/05/31 21:24:47 jongfoster
1041 * Changed "permission" to "action" throughout.
1042 * Removed DEFAULT_USER_AGENT - it must now be specified manually.
1043 * Moved vanilla wafer check into chat(), since we must now
1044 * decide whether or not to add it based on the URL.
1046 * Revision 1.14 2001/05/29 20:14:01 joergs
1047 * AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
1050 * Revision 1.13 2001/05/29 09:50:24 jongfoster
1051 * Unified blocklist/imagelist/permissionslist.
1052 * File format is still under discussion, but the internal changes
1053 * are (mostly) done.
1055 * Also modified interceptor behaviour:
1056 * - We now intercept all URLs beginning with one of the following
1057 * prefixes (and *only* these prefixes):
1059 * * http://ijbswa.sf.net/config/
1060 * * http://ijbswa.sourceforge.net/config/
1061 * - New interceptors "home page" - go to http://i.j.b/ to see it.
1062 * - Internal changes so that intercepted and fast redirect pages
1063 * are not replaced with an image.
1064 * - Interceptors now have the option to send a binary page direct
1065 * to the client. (i.e. ijb-send-banner uses this)
1066 * - Implemented show-url-info interceptor. (Which is why I needed
1067 * the above interceptors changes - a typical URL is
1068 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
1069 * The previous mechanism would not have intercepted that, and
1070 * if it had been intercepted then it then it would have replaced
1071 * it with an image.)
1073 * Revision 1.12 2001/05/27 22:17:04 oes
1075 * - re_process_buffer no longer writes the modified buffer
1076 * to the client, which was very ugly. It now returns the
1077 * buffer, which it is then written by chat.
1079 * - content_length now adjusts the Content-Length: header
1080 * for modified documents rather than crunch()ing it.
1081 * (Length info in csp->content_length, which is 0 for
1082 * unmodified documents)
1084 * - For this to work, sed() is called twice when filtering.
1086 * Revision 1.11 2001/05/26 17:27:53 jongfoster
1087 * Added support for CLF and fixed LOG_LEVEL_LOG.
1088 * Also did CRLF->LF fix of my previous patch.
1090 * Revision 1.10 2001/05/26 15:26:15 jongfoster
1091 * ACL feature now provides more security by immediately dropping
1092 * connections from untrusted hosts.
1094 * Revision 1.9 2001/05/26 00:28:36 jongfoster
1095 * Automatic reloading of config file.
1096 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
1097 * Most of the global variables have been moved to a new
1098 * struct configuration_spec, accessed through csp->config->globalname
1099 * Most of the globals remaining are used by the Win32 GUI.
1101 * Revision 1.8 2001/05/25 22:43:18 jongfoster
1102 * Fixing minor memory leak and buffer overflow.
1104 * Revision 1.7 2001/05/25 22:34:30 jongfoster
1107 * Revision 1.6 2001/05/23 00:13:58 joergs
1108 * AmigaOS support fixed.
1110 * Revision 1.5 2001/05/22 18:46:04 oes
1112 * - Enabled filtering banners by size rather than URL
1113 * by adding patterns that replace all standard banner
1114 * sizes with the "Junkbuster" gif to the re_filterfile
1116 * - Enabled filtering WebBugs by providing a pattern
1117 * which kills all 1x1 images
1119 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
1120 * which is selected by the (nonstandard and therefore
1121 * capital) letter 'U' in the option string.
1122 * It causes the quantifiers to be ungreedy by default.
1123 * Appending a ? turns back to greedy (!).
1125 * - Added a new interceptor ijb-send-banner, which
1126 * sends back the "Junkbuster" gif. Without imagelist or
1127 * MSIE detection support, or if tinygif = 1, or the
1128 * URL isn't recognized as an imageurl, a lame HTML
1129 * explanation is sent instead.
1131 * - Added new feature, which permits blocking remote
1132 * script redirects and firing back a local redirect
1134 * The feature is conditionally compiled, i.e. it
1135 * can be disabled with --disable-fast-redirects,
1136 * plus it must be activated by a "fast-redirects"
1137 * line in the config file, has its own log level
1138 * and of course wants to be displayed by show-proxy-args
1139 * Note: Boy, all the #ifdefs in 1001 locations and
1140 * all the fumbling with configure.in and acconfig.h
1141 * were *way* more work than the feature itself :-(
1143 * - Because a generic redirect template was needed for
1144 * this, tinygif = 3 now uses the same.
1146 * - Moved GIFs, and other static HTTP response templates
1149 * - Some minor fixes
1151 * - Removed some >400 CRs again (Jon, you really worked
1154 * Revision 1.4 2001/05/21 19:34:01 jongfoster
1155 * Made failure to bind() a fatal error.
1157 * Revision 1.3 2001/05/20 01:21:20 jongfoster
1158 * Version 2.9.4 checkin.
1159 * - Merged popupfile and cookiefile, and added control over PCRS
1160 * filtering, in new "permissionsfile".
1161 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
1162 * file error you now get a message box (in the Win32 GUI) rather
1163 * than the program exiting with no explanation.
1164 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
1166 * - Removed tabs from "config"
1167 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
1168 * - Bumped up version number.
1170 * Revision 1.2 2001/05/17 22:34:44 oes
1171 * - Added hint on GIF char array generation to jcc.c
1172 * - Cleaned CRLF's from the sources and related files
1173 * - Repaired logging for REF and FRC
1175 * Revision 1.1.1.1 2001/05/15 13:58:56 oes
1176 * Initial import of version 2.9.3 source tree
1179 *********************************************************************/
1185 #include <sys/types.h>
1194 # ifndef FEATURE_PTHREAD
1198 # include <windows.h>
1199 # include <process.h>
1200 # endif /* ndef FEATURE_PTHREAD */
1203 # ifndef _WIN_CONSOLE
1204 # include "w32log.h"
1205 # endif /* ndef _WIN_CONSOLE */
1206 # include "w32svrapi.h"
1208 #else /* ifndef _WIN32 */
1210 # if !defined (__OS2__)
1211 # include <unistd.h>
1212 # include <sys/wait.h>
1213 # endif /* ndef __OS2__ */
1214 # include <sys/time.h>
1215 # include <sys/stat.h>
1216 # include <sys/ioctl.h>
1219 #include <sys/termios.h>
1227 # include <signal.h>
1230 # include <socket.h> /* BeOS has select() for sockets only. */
1231 # include <OS.h> /* declarations for threads and stuff. */
1234 # if defined(__EMX__) || defined(__OS2__)
1235 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
1240 #define bzero(B,N) memset(B,0x00,n)
1244 # include <select.h>
1249 #include "project.h"
1252 #include "filters.h"
1253 #include "loaders.h"
1254 #include "parsers.h"
1255 #include "miscutil.h"
1257 #include "jbsockets.h"
1258 #include "gateway.h"
1259 #include "actions.h"
1261 #include "loadcfg.h"
1262 #include "urlmatch.h"
1264 const char jcc_h_rcs[] = JCC_H_VERSION;
1265 const char project_h_rcs[] = PROJECT_H_VERSION;
1268 struct client_state clients[1];
1269 struct file_list files[1];
1271 #ifdef FEATURE_STATISTICS
1272 int urls_read = 0; /* total nr of urls read inc rejected */
1273 int urls_rejected = 0; /* total nr of urls rejected */
1274 #endif /* def FEATURE_STATISTICS */
1276 #ifdef FEATURE_GRACEFUL_TERMINATION
1277 int g_terminate = 0;
1280 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1281 static void sig_handler(int the_signal);
1283 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
1284 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
1285 static jb_err get_server_headers(struct client_state *csp);
1286 static const char *crunch_reason(const struct http_response *rsp);
1287 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp);
1288 static char *get_request_line(struct client_state *csp);
1289 static jb_err receive_client_request(struct client_state *csp);
1290 static jb_err parse_client_request(struct client_state *csp);
1291 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
1292 static jb_err change_request_destination(struct client_state *csp);
1293 static void chat(struct client_state *csp);
1294 static void serve(struct client_state *csp);
1295 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
1296 static void usage(const char *myname);
1298 static void initialize_mutexes(void);
1299 static jb_socket bind_port_helper(struct configuration_spec *config);
1300 static void listen_loop(void);
1303 void serve(struct client_state *csp);
1304 #else /* ifndef AMIGA */
1305 static void serve(struct client_state *csp);
1306 #endif /* def AMIGA */
1309 static int32 server_thread(void *data);
1310 #endif /* def __BEOS__ */
1313 #define sleep(N) Sleep(((N) * 1000))
1317 #define sleep(N) DosSleep(((N) * 100))
1320 #ifdef MUTEX_LOCKS_AVAILABLE
1322 * XXX: Does the locking stuff really belong in this file?
1324 privoxy_mutex_t log_mutex;
1325 privoxy_mutex_t log_init_mutex;
1326 privoxy_mutex_t connection_reuse_mutex;
1328 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
1329 privoxy_mutex_t resolver_mutex;
1330 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
1332 #ifndef HAVE_GMTIME_R
1333 privoxy_mutex_t gmtime_mutex;
1334 #endif /* ndef HAVE_GMTIME_R */
1336 #ifndef HAVE_LOCALTIME_R
1337 privoxy_mutex_t localtime_mutex;
1338 #endif /* ndef HAVE_GMTIME_R */
1341 privoxy_mutex_t rand_mutex;
1342 #endif /* ndef HAVE_RANDOM */
1344 #endif /* def MUTEX_LOCKS_AVAILABLE */
1347 const char *basedir = NULL;
1348 const char *pidfile = NULL;
1349 static int received_hup_signal = 0;
1350 #endif /* defined unix */
1352 /* HTTP snipplets. */
1353 static const char CSUCCEED[] =
1354 "HTTP/1.0 200 Connection established\r\n"
1355 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1357 static const char CHEADER[] =
1358 "HTTP/1.0 400 Invalid header received from client\r\n"
1359 "Proxy-Agent: Privoxy " VERSION "\r\n"
1360 "Content-Type: text/plain\r\n"
1361 "Connection: close\r\n\r\n"
1362 "Invalid header received from client.\r\n";
1364 static const char FTP_RESPONSE[] =
1365 "HTTP/1.0 400 Invalid request received from client\r\n"
1366 "Content-Type: text/plain\r\n"
1367 "Connection: close\r\n\r\n"
1368 "Invalid request. Privoxy doesn't support FTP.\r\n";
1370 static const char GOPHER_RESPONSE[] =
1371 "HTTP/1.0 400 Invalid request received from client\r\n"
1372 "Content-Type: text/plain\r\n"
1373 "Connection: close\r\n\r\n"
1374 "Invalid request. Privoxy doesn't support gopher.\r\n";
1376 /* XXX: should be a template */
1377 static const char MISSING_DESTINATION_RESPONSE[] =
1378 "HTTP/1.0 400 Bad request received from client\r\n"
1379 "Proxy-Agent: Privoxy " VERSION "\r\n"
1380 "Content-Type: text/plain\r\n"
1381 "Connection: close\r\n\r\n"
1382 "Bad request. Privoxy was unable to extract the destination.\r\n";
1384 /* XXX: should be a template */
1385 static const char NO_SERVER_DATA_RESPONSE[] =
1386 "HTTP/1.0 502 Server or forwarder response empty\r\n"
1387 "Proxy-Agent: Privoxy " VERSION "\r\n"
1388 "Content-Type: text/plain\r\n"
1389 "Connection: close\r\n\r\n"
1390 "Empty server or forwarder response.\r\n"
1391 "The connection has been closed but Privoxy didn't receive any data.\r\n";
1393 /* XXX: should be a template */
1394 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
1395 "HTTP/1.0 502 Server or forwarder response invalid\r\n"
1396 "Proxy-Agent: Privoxy " VERSION "\r\n"
1397 "Content-Type: text/plain\r\n"
1398 "Connection: close\r\n\r\n"
1399 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
1402 /* XXX: should be a template */
1403 static const char NULL_BYTE_RESPONSE[] =
1404 "HTTP/1.0 400 Bad request received from client\r\n"
1405 "Proxy-Agent: Privoxy " VERSION "\r\n"
1406 "Content-Type: text/plain\r\n"
1407 "Connection: close\r\n\r\n"
1408 "Bad request. Null byte(s) before end of request.\r\n";
1411 /* XXX: should be a template */
1412 static const char MESSED_UP_REQUEST_RESPONSE[] =
1413 "HTTP/1.0 400 Malformed request after rewriting\r\n"
1414 "Proxy-Agent: Privoxy " VERSION "\r\n"
1415 "Content-Type: text/plain\r\n"
1416 "Connection: close\r\n\r\n"
1417 "Bad request. Messed up with header filters.\r\n";
1419 /* XXX: should be a template */
1420 static const char CONNECTION_TIMEOUT_RESPONSE[] =
1421 "HTTP/1.0 502 Connection timeout\r\n"
1422 "Proxy-Agent: Privoxy " VERSION "\r\n"
1423 "Content-Type: text/plain\r\n"
1424 "Connection: close\r\n\r\n"
1425 "The connection timed out.\r\n";
1427 /* A function to crunch a response */
1428 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
1430 /* Crunch function flags */
1431 #define CF_NO_FLAGS 0
1432 /* Cruncher applies to forced requests as well */
1433 #define CF_IGNORE_FORCE 1
1434 /* Crunched requests are counted for the block statistics */
1435 #define CF_COUNT_AS_REJECT 2
1437 /* A crunch function and its flags */
1440 const crunch_func_ptr cruncher;
1444 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
1446 /* Complete list of cruncher functions */
1447 static const struct cruncher crunchers_all[] = {
1448 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
1449 { block_url, CF_COUNT_AS_REJECT },
1450 #ifdef FEATURE_TRUST
1451 { trust_url, CF_COUNT_AS_REJECT },
1452 #endif /* def FEATURE_TRUST */
1453 { redirect_url, CF_NO_FLAGS },
1454 { dispatch_cgi, CF_IGNORE_FORCE},
1458 /* Light version, used after tags are applied */
1459 static const struct cruncher crunchers_light[] = {
1460 { block_url, CF_COUNT_AS_REJECT },
1461 { redirect_url, CF_NO_FLAGS },
1467 * XXX: Don't we really mean
1473 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1474 /*********************************************************************
1476 * Function : sig_handler
1478 * Description : Signal handler for different signals.
1479 * Exit gracefully on TERM and INT
1480 * or set a flag that will cause the errlog
1481 * to be reopened by the main thread on HUP.
1484 * 1 : the_signal = the signal cause this function to call
1488 *********************************************************************/
1489 static void sig_handler(int the_signal)
1495 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
1507 received_hup_signal = 1;
1513 * We shouldn't be here, unless we catch signals
1514 * in main() that we can't handle here!
1516 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
1524 /*********************************************************************
1526 * Function : client_protocol_is_unsupported
1528 * Description : Checks if the client used a known unsupported
1529 * protocol and deals with it by sending an error
1533 * 1 : csp = Current client state (buffers, headers, etc...)
1534 * 2 : req = the first request line send by the client
1536 * Returns : TRUE if an error response has been generated, or
1537 * FALSE if the request doesn't look invalid.
1539 *********************************************************************/
1540 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
1543 * If it's a FTP or gopher request, we don't support it.
1545 * These checks are better than nothing, but they might
1546 * not work in all configurations and some clients might
1547 * have problems digesting the answer.
1549 * They should, however, never cause more problems than
1550 * Privoxy's old behaviour (returning the misleading HTML
1553 * "Could not resolve http://(ftp|gopher)://example.org").
1555 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
1557 const char *response = NULL;
1558 const char *protocol = NULL;
1560 if (!strncmpic(req, "GET ftp://", 10))
1562 response = FTP_RESPONSE;
1567 response = GOPHER_RESPONSE;
1568 protocol = "GOPHER";
1570 log_error(LOG_LEVEL_ERROR,
1571 "%s tried to use Privoxy as %s proxy: %s",
1572 csp->ip_addr_str, protocol, req);
1573 log_error(LOG_LEVEL_CLF,
1574 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
1576 write_socket(csp->cfd, response, strlen(response));
1585 /*********************************************************************
1587 * Function : get_request_destination_elsewhere
1589 * Description : If the client's request was redirected into
1590 * Privoxy without the client's knowledge,
1591 * the request line lacks the destination host.
1593 * This function tries to get it elsewhere,
1594 * provided accept-intercepted-requests is enabled.
1596 * "Elsewhere" currently only means "Host: header",
1597 * but in the future we may ask the redirecting
1598 * packet filter to look the destination up.
1600 * If the destination stays unknown, an error
1601 * response is send to the client and headers
1602 * are freed so that chat() can return directly.
1605 * 1 : csp = Current client state (buffers, headers, etc...)
1606 * 2 : headers = a header list
1608 * Returns : JB_ERR_OK if the destination is now known, or
1609 * JB_ERR_PARSE if it isn't.
1611 *********************************************************************/
1612 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
1616 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
1618 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
1619 " Privoxy isn't configured to accept intercepted requests.",
1620 csp->ip_addr_str, csp->http->cmd);
1621 /* XXX: Use correct size */
1622 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1623 csp->ip_addr_str, csp->http->cmd);
1625 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1626 destroy_list(headers);
1628 return JB_ERR_PARSE;
1630 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
1632 /* Split the domain we just got for pattern matching */
1633 init_domain_components(csp->http);
1639 /* We can't work without destination. Go spread the news.*/
1641 req = list_to_text(headers);
1643 /* XXX: Use correct size */
1644 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1645 csp->ip_addr_str, csp->http->cmd);
1646 log_error(LOG_LEVEL_ERROR,
1647 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
1648 csp->ip_addr_str, csp->http->cmd, req);
1651 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
1652 destroy_list(headers);
1654 return JB_ERR_PARSE;
1657 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
1658 * to get the destination IP address, use it as host directly
1659 * or do a reverse DNS lookup first.
1664 /*********************************************************************
1666 * Function : get_server_headers
1668 * Description : Parses server headers in iob and fills them
1669 * into csp->headers so that they can later be
1673 * 1 : csp = Current client state (buffers, headers, etc...)
1675 * Returns : JB_ERR_OK if everything went fine, or
1676 * JB_ERR_PARSE if the headers were incomplete.
1678 *********************************************************************/
1679 static jb_err get_server_headers(struct client_state *csp)
1681 int continue_hack_in_da_house = 0;
1684 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
1689 * continue hack in da house. Ignore the ending of
1690 * this head and continue enlisting header lines.
1691 * The reason is described below.
1693 enlist(csp->headers, "");
1694 continue_hack_in_da_house = 0;
1697 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
1700 * It's a bodyless continue response, don't
1701 * stop header parsing after reaching its end.
1703 * As a result Privoxy will concatenate the
1704 * next response's head and parse and deliver
1705 * the headers as if they belonged to one request.
1707 * The client will separate them because of the
1708 * empty line between them.
1710 * XXX: What we're doing here is clearly against
1711 * the intended purpose of the continue header,
1712 * and under some conditions (HTTP/1.0 client request)
1713 * it's a standard violation.
1715 * Anyway, "sort of against the spec" is preferable
1716 * to "always getting confused by Continue responses"
1717 * (Privoxy's behaviour before this hack was added)
1719 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
1720 continue_hack_in_da_house = 1;
1722 else if (*header == '\0')
1725 * If the header is empty, but the Continue hack
1726 * isn't active, we can assume that we reached the
1727 * end of the buffer before we hit the end of the
1730 * Inform the caller an let it decide how to handle it.
1732 return JB_ERR_PARSE;
1735 if (JB_ERR_MEMORY == enlist(csp->headers, header))
1738 * XXX: Should we quit the request and return a
1739 * out of memory error page instead?
1741 log_error(LOG_LEVEL_ERROR,
1742 "Out of memory while enlisting server headers. %s lost.",
1752 /*********************************************************************
1754 * Function : crunch_reason
1756 * Description : Translates the crunch reason code into a string.
1759 * 1 : rsp = a http_response
1761 * Returns : A string with the crunch reason or an error description.
1763 *********************************************************************/
1764 static const char *crunch_reason(const struct http_response *rsp)
1766 char * reason = NULL;
1768 assert(rsp != NULL);
1771 return "Internal error while searching for crunch reason";
1774 switch (rsp->reason)
1776 case RSP_REASON_UNSUPPORTED:
1777 reason = "Unsupported HTTP feature";
1779 case RSP_REASON_BLOCKED:
1782 case RSP_REASON_UNTRUSTED:
1783 reason = "Untrusted";
1785 case RSP_REASON_REDIRECTED:
1786 reason = "Redirected";
1788 case RSP_REASON_CGI_CALL:
1789 reason = "CGI Call";
1791 case RSP_REASON_NO_SUCH_DOMAIN:
1792 reason = "DNS failure";
1794 case RSP_REASON_FORWARDING_FAILED:
1795 reason = "Forwarding failed";
1797 case RSP_REASON_CONNECT_FAILED:
1798 reason = "Connection failure";
1800 case RSP_REASON_OUT_OF_MEMORY:
1801 reason = "Out of memory (may mask other reasons)";
1804 reason = "No reason recorded";
1812 /*********************************************************************
1814 * Function : send_crunch_response
1816 * Description : Delivers already prepared response for
1817 * intercepted requests, logs the interception
1818 * and frees the response.
1821 * 1 : csp = Current client state (buffers, headers, etc...)
1822 * 1 : rsp = Fully prepared response. Will be freed on exit.
1824 * Returns : Nothing.
1826 *********************************************************************/
1827 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
1829 const struct http_request *http = csp->http;
1830 char status_code[4];
1832 assert(rsp != NULL);
1833 assert(rsp->head != NULL);
1838 * Not supposed to happen. If it does
1839 * anyway, treat it as an unknown error.
1841 cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
1842 /* return code doesn't matter */
1847 /* If rsp is still NULL, we have serious internal problems. */
1848 log_error(LOG_LEVEL_FATAL,
1849 "NULL response in send_crunch_response and cgi_error_unknown failed as well.");
1853 * Extract the status code from the actual head
1854 * that was send to the client. It is the only
1855 * way to get it right for all requests, including
1856 * the fixed ones for out-of-memory problems.
1858 * A head starts like this: 'HTTP/1.1 200...'
1862 status_code[0] = rsp->head[9];
1863 status_code[1] = rsp->head[10];
1864 status_code[2] = rsp->head[11];
1865 status_code[3] = '\0';
1867 /* Write the answer to the client */
1868 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1869 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1871 /* There is nothing we can do about it. */
1872 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
1875 /* Log that the request was crunched and why. */
1876 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
1877 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %d",
1878 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
1880 /* Clean up and return */
1881 if (cgi_error_memory() != rsp)
1883 free_http_response(rsp);
1890 /*********************************************************************
1892 * Function : request_contains_null_bytes
1894 * Description : Checks for NULL bytes in the request and sends
1895 * an error message to the client if any were found.
1897 * XXX: currently not used, see comment in chat().
1900 * 1 : csp = Current client state (buffers, headers, etc...)
1901 * 2 : buf = Data from the client's request to check.
1902 * 3 : len = The data length.
1904 * Returns : TRUE if the request contained one or more NULL bytes, or
1907 *********************************************************************/
1908 static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len)
1910 size_t c_len; /* Request lenght when treated as C string */
1912 c_len = strlen(buf);
1917 * Null byte(s) found. Log the request,
1918 * return an error response and hang up.
1920 size_t tmp_len = c_len;
1925 * Replace NULL byte(s) with '°' characters
1926 * so the request can be logged as string.
1927 * XXX: Is there a better replacement character?
1930 tmp_len += strlen(buf+tmp_len);
1931 } while (tmp_len < len);
1933 log_error(LOG_LEVEL_ERROR, "%s\'s request contains at least one NULL byte "
1934 "(length=%d, strlen=%d).", csp->ip_addr_str, len, c_len);
1935 log_error(LOG_LEVEL_HEADER,
1936 "Offending request data with NULL bytes turned into \'°\' characters: %s", buf);
1938 write_socket(csp->cfd, NULL_BYTE_RESPONSE, strlen(NULL_BYTE_RESPONSE));
1940 /* XXX: Log correct size */
1941 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1951 /*********************************************************************
1953 * Function : crunch_response_triggered
1955 * Description : Checks if the request has to be crunched,
1956 * and delivers the crunch response if necessary.
1959 * 1 : csp = Current client state (buffers, headers, etc...)
1960 * 2 : crunchers = list of cruncher functions to run
1962 * Returns : TRUE if the request was answered with a crunch response
1965 *********************************************************************/
1966 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
1968 struct http_response *rsp = NULL;
1969 const struct cruncher *c;
1972 * If CGI request crunching is disabled,
1973 * check the CGI dispatcher out of order to
1974 * prevent unintentional blocks or redirects.
1976 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
1977 && (NULL != (rsp = dispatch_cgi(csp))))
1979 /* Deliver, log and free the interception response. */
1980 send_crunch_response(csp, rsp);
1984 for (c = crunchers; c->cruncher != NULL; c++)
1987 * Check the cruncher if either Privoxy is toggled
1988 * on and the request isn't forced, or if the cruncher
1989 * applies to forced requests as well.
1991 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
1992 !(csp->flags & CSP_FLAG_FORCED)) ||
1993 (c->flags & CF_IGNORE_FORCE))
1995 rsp = c->cruncher(csp);
1998 /* Deliver, log and free the interception response. */
1999 send_crunch_response(csp, rsp);
2000 #ifdef FEATURE_STATISTICS
2001 if (c->flags & CF_COUNT_AS_REJECT)
2003 csp->flags |= CSP_FLAG_REJECTED;
2005 #endif /* def FEATURE_STATISTICS */
2016 /*********************************************************************
2018 * Function : build_request_line
2020 * Description : Builds the HTTP request line.
2022 * If a HTTP forwarder is used it expects the whole URL,
2023 * web servers only get the path.
2026 * 1 : csp = Current client state (buffers, headers, etc...)
2027 * 2 : fwd = The forwarding spec used for the request
2028 * XXX: Should use http->fwd instead.
2029 * 3 : request_line = The old request line which will be replaced.
2031 * Returns : Nothing. Terminates in case of memory problems.
2033 *********************************************************************/
2034 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
2036 struct http_request *http = csp->http;
2038 assert(http->ssl == 0);
2041 * Downgrade http version from 1.1 to 1.0
2042 * if +downgrade action applies.
2044 if ( (csp->action->flags & ACTION_DOWNGRADE)
2045 && (!strcmpic(http->ver, "HTTP/1.1")))
2048 http->ver = strdup("HTTP/1.0");
2050 if (http->ver == NULL)
2052 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
2057 * Rebuild the request line.
2059 freez(*request_line);
2060 *request_line = strdup(http->gpc);
2061 string_append(request_line, " ");
2063 if (fwd->forward_host)
2065 string_append(request_line, http->url);
2069 string_append(request_line, http->path);
2071 string_append(request_line, " ");
2072 string_append(request_line, http->ver);
2074 if (*request_line == NULL)
2076 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
2078 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
2082 /*********************************************************************
2084 * Function : change_request_destination
2086 * Description : Parse a (rewritten) request line and regenerate
2087 * the http request data.
2090 * 1 : csp = Current client state (buffers, headers, etc...)
2092 * Returns : Forwards the parse_http_request() return code.
2093 * Terminates in case of memory problems.
2095 *********************************************************************/
2096 static jb_err change_request_destination(struct client_state *csp)
2098 struct http_request *http = csp->http;
2101 log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
2102 free_http_request(http);
2103 err = parse_http_request(csp->headers->first->str, http, csp);
2104 if (JB_ERR_OK != err)
2106 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
2107 jb_err_to_string(err));
2111 /* XXX: ocmd is a misleading name */
2112 http->ocmd = strdup(http->cmd);
2113 if (http->ocmd == NULL)
2115 log_error(LOG_LEVEL_FATAL,
2116 "Out of memory copying rewritten HTTP request line");
2124 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2125 /*********************************************************************
2127 * Function : server_response_is_complete
2129 * Description : Determines whether we should stop reading
2130 * from the server socket.
2133 * 1 : csp = Current client state (buffers, headers, etc...)
2134 * 2 : content_length = Length of content received so far.
2136 * Returns : TRUE if the response is complete,
2139 *********************************************************************/
2140 static int server_response_is_complete(struct client_state *csp, size_t content_length)
2142 int content_length_known = (csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
2144 if (!strcmpic(csp->http->gpc, "HEAD"))
2147 * "HEAD" implies no body, we are thus expecting
2148 * no content. XXX: incomplete "list" of methods?
2150 csp->expected_content_length = 0;
2151 content_length_known = TRUE;
2154 if (csp->http->status == 304)
2157 * Expect no body. XXX: incomplete "list" of status codes?
2159 csp->expected_content_length = 0;
2160 content_length_known = TRUE;
2163 return (content_length_known && ((0 == csp->expected_content_length)
2164 || (csp->expected_content_length <= content_length)));
2166 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2168 /*********************************************************************
2170 * Function : mark_server_socket_tainted
2172 * Description : Makes sure we don't reuse a server socket
2173 * (if we didn't read everything the server sent
2174 * us reusing the socket would lead to garbage).
2177 * 1 : csp = Current client state (buffers, headers, etc...)
2181 *********************************************************************/
2182 static void mark_server_socket_tainted(struct client_state *csp)
2184 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
2186 log_error(LOG_LEVEL_CONNECT, "Unsetting keep-alive flag.");
2187 csp->flags &= ~CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
2191 /*********************************************************************
2193 * Function : get_request_line
2195 * Description : Read the client request line.
2198 * 1 : csp = Current client state (buffers, headers, etc...)
2200 * Returns : Pointer to request line or NULL in case of errors.
2202 *********************************************************************/
2203 static char *get_request_line(struct client_state *csp)
2205 char buf[BUFFER_SIZE];
2206 char *request_line = NULL;
2209 memset(buf, 0, sizeof(buf));
2213 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
2215 log_error(LOG_LEVEL_ERROR,
2216 "Stopped waiting for the request line.");
2217 write_socket(csp->cfd, CONNECTION_TIMEOUT_RESPONSE,
2218 strlen(CONNECTION_TIMEOUT_RESPONSE));
2222 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2224 if (len <= 0) return NULL;
2227 * If there is no memory left for buffering the
2228 * request, there is nothing we can do but hang up
2230 if (add_to_iob(csp, buf, len))
2235 request_line = get_header(csp->iob);
2237 } while ((NULL != request_line) && ('\0' == *request_line));
2239 return request_line;
2244 /*********************************************************************
2246 * Function : receive_client_request
2248 * Description : Read the client's request (more precisely the
2249 * client headers) and answer it if necessary.
2251 * Note that since we're not using select() we could get
2252 * blocked here if a client connected, then didn't say
2256 * 1 : csp = Current client state (buffers, headers, etc...)
2258 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
2260 *********************************************************************/
2261 static jb_err receive_client_request(struct client_state *csp)
2263 char buf[BUFFER_SIZE];
2266 struct http_request *http;
2270 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
2271 struct list header_list;
2272 struct list *headers = &header_list;
2276 memset(buf, 0, sizeof(buf));
2278 req = get_request_line(csp);
2281 return JB_ERR_PARSE;
2283 assert(*req != '\0');
2285 if (client_protocol_is_unsupported(csp, req))
2287 return JB_ERR_PARSE;
2290 #ifdef FEATURE_FORCE_LOAD
2292 * If this request contains the FORCE_PREFIX and blocks
2293 * aren't enforced, get rid of it and set the force flag.
2295 if (strstr(req, FORCE_PREFIX))
2297 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
2299 log_error(LOG_LEVEL_FORCE,
2300 "Ignored force prefix in request: \"%s\".", req);
2304 strclean(req, FORCE_PREFIX);
2305 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
2306 csp->flags |= CSP_FLAG_FORCED;
2309 #endif /* def FEATURE_FORCE_LOAD */
2311 err = parse_http_request(req, http, csp);
2313 if (JB_ERR_OK != err)
2315 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
2316 /* XXX: Use correct size */
2317 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2318 log_error(LOG_LEVEL_ERROR,
2319 "Couldn't parse request line received from %s: %s",
2320 csp->ip_addr_str, jb_err_to_string(err));
2322 free_http_request(http);
2323 return JB_ERR_PARSE;
2326 /* grab the rest of the client's headers */
2330 p = get_header(csp->iob);
2334 /* There are no additional headers to read. */
2341 * We didn't receive a complete header
2342 * line yet, get the rest of it.
2344 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
2346 log_error(LOG_LEVEL_ERROR,
2347 "Stopped grabbing the client headers.");
2348 return JB_ERR_PARSE;
2351 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2354 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
2355 destroy_list(headers);
2356 return JB_ERR_PARSE;
2359 if (add_to_iob(csp, buf, len))
2362 * If there is no memory left for buffering the
2363 * request, there is nothing we can do but hang up
2365 destroy_list(headers);
2366 return JB_ERR_MEMORY;
2372 * We were able to read a complete
2373 * header and can finaly enlist it.
2380 if (http->host == NULL)
2383 * If we still don't know the request destination,
2384 * the request is invalid or the client uses
2385 * Privoxy without its knowledge.
2387 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
2390 * Our attempts to get the request destination
2391 * elsewhere failed or Privoxy is configured
2392 * to only accept proxy requests.
2394 * An error response has already been send
2395 * and we're done here.
2397 return JB_ERR_PARSE;
2402 * Determine the actions for this URL
2404 #ifdef FEATURE_TOGGLE
2405 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
2407 /* Most compatible set of actions (i.e. none) */
2408 init_current_action(csp->action);
2411 #endif /* ndef FEATURE_TOGGLE */
2413 get_url_actions(csp, http);
2417 * Save a copy of the original request for logging
2419 http->ocmd = strdup(http->cmd);
2420 if (http->ocmd == NULL)
2422 log_error(LOG_LEVEL_FATAL,
2423 "Out of memory copying HTTP request line");
2425 enlist(csp->headers, http->cmd);
2427 /* Append the previously read headers */
2428 list_append_list_unique(csp->headers, headers);
2429 destroy_list(headers);
2436 /*********************************************************************
2438 * Function : parse_client_request
2440 * Description : Parses the client's request and decides what to do
2443 * Note that since we're not using select() we could get
2444 * blocked here if a client connected, then didn't say
2448 * 1 : csp = Current client state (buffers, headers, etc...)
2450 * Returns : JB_ERR_OK or JB_ERR_PARSE
2452 *********************************************************************/
2453 static jb_err parse_client_request(struct client_state *csp)
2455 struct http_request *http = csp->http;
2458 err = sed(csp, FILTER_CLIENT_HEADERS);
2459 if (JB_ERR_OK != err)
2461 /* XXX: Should be handled in sed(). */
2462 assert(err == JB_ERR_PARSE);
2463 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
2465 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
2467 /* Check request line for rewrites. */
2468 if ((NULL == csp->headers->first->str)
2469 || (strcmp(http->cmd, csp->headers->first->str) &&
2470 (JB_ERR_OK != change_request_destination(csp))))
2473 * A header filter broke the request line - bail out.
2475 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
2476 /* XXX: Use correct size */
2477 log_error(LOG_LEVEL_CLF,
2478 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
2479 log_error(LOG_LEVEL_ERROR,
2480 "Invalid request line after applying header filters.");
2481 free_http_request(http);
2483 return JB_ERR_PARSE;
2491 /*********************************************************************
2495 * Description : Once a connection to the client has been accepted,
2496 * this function is called (via serve()) to handle the
2497 * main business of the communication. When this
2498 * function returns, the caller must close the client
2501 * FIXME: chat is nearly thousand lines long.
2505 * 1 : csp = Current client state (buffers, headers, etc...)
2507 * Returns : Nothing.
2509 *********************************************************************/
2510 static void chat(struct client_state *csp)
2512 char buf[BUFFER_SIZE];
2519 int ms_iis5_hack = 0;
2520 size_t byte_count = 0;
2521 int forwarded_connect_retries = 0;
2522 int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
2523 const struct forward_spec *fwd;
2524 struct http_request *http;
2525 int len = 0; /* for buffer sizes (and negative error codes) */
2527 /* Function that does the content filtering for the current request */
2528 filter_function_ptr content_filter = NULL;
2530 /* Skeleton for HTTP response, if we should intercept the request */
2531 struct http_response *rsp;
2532 struct timeval timeout;
2534 memset(buf, 0, sizeof(buf));
2535 memset(&timeout, 0, sizeof(timeout));
2536 timeout.tv_sec = csp->config->socket_timeout;
2540 if (receive_client_request(csp) != JB_ERR_OK)
2544 if (parse_client_request(csp) != JB_ERR_OK)
2549 /* decide how to route the HTTP request */
2550 fwd = forward_url(csp, http);
2553 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
2554 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2558 * build the http request to send to the server
2559 * we have to do one of the following:
2561 * create = use the original HTTP request to create a new
2562 * HTTP request that has either the path component
2563 * without the http://domainspec (w/path) or the
2564 * full orininal URL (w/url)
2565 * Note that the path and/or the HTTP version may
2566 * have been altered by now.
2568 * connect = Open a socket to the host:port of the server
2569 * and short-circuit server and client socket.
2571 * pass = Pass the request unchanged if forwarding a CONNECT
2572 * request to a parent proxy. Note that we'll be sending
2573 * the CFAIL message ourselves if connecting to the parent
2574 * fails, but we won't send a CSUCCEED message if it works,
2575 * since that would result in a double message (ours and the
2576 * parent's). After sending the request to the parent, we simply
2579 * here's the matrix:
2582 * +--------+--------+
2584 * 0 | create | connect|
2586 * Forwarding +--------+--------+
2588 * 1 | create | pass |
2590 * +--------+--------+
2594 if (http->ssl && connect_port_is_forbidden(csp))
2596 const char *acceptable_connect_ports =
2597 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
2598 assert(NULL != acceptable_connect_ports);
2599 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
2600 "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
2601 csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
2602 csp->action->flags |= ACTION_BLOCK;
2608 freez(csp->headers->first->str);
2609 build_request_line(csp, fwd, &csp->headers->first->str);
2613 * We have a request. Check if one of the crunchers wants it.
2615 if (crunch_response_triggered(csp, crunchers_all))
2618 * Yes. The client got the crunch response
2619 * and we are done here after cleaning up.
2621 /* XXX: why list_remove_all()? */
2622 list_remove_all(csp->headers);
2627 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
2629 if (fwd->forward_host)
2631 log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
2632 fwd->forward_host, fwd->forward_port, http->hostport);
2636 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
2639 /* here we connect to the server, gateway, or the forwarder */
2641 while ((csp->sfd = forwarded_connect(fwd, http, csp))
2642 && (errno == EINVAL)
2643 && (forwarded_connect_retries++ < max_forwarded_connect_retries))
2645 log_error(LOG_LEVEL_ERROR,
2646 "failed request #%u to connect to %s. Trying again.",
2647 forwarded_connect_retries, http->hostport);
2650 if (csp->sfd == JB_INVALID_SOCKET)
2652 if (fwd->type != SOCKS_NONE)
2655 rsp = error_response(csp, "forwarding-failed", errno);
2657 else if (errno == EINVAL)
2659 rsp = error_response(csp, "no-such-domain", errno);
2663 rsp = error_response(csp, "connect-failed", errno);
2664 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
2668 /* Write the answer to the client */
2671 send_crunch_response(csp, rsp);
2677 hdr = list_to_text(csp->headers);
2680 /* FIXME Should handle error properly */
2681 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2683 list_remove_all(csp->headers);
2685 if (fwd->forward_host || (http->ssl == 0))
2688 * Write the client's (modified) header to the server
2689 * (along with anything else that may be in the buffer)
2691 if (write_socket(csp->sfd, hdr, strlen(hdr))
2692 || (flush_socket(csp->sfd, csp->iob) < 0))
2694 log_error(LOG_LEVEL_CONNECT,
2695 "write header to: %s failed: %E", http->hostport);
2697 rsp = error_response(csp, "connect-failed", errno);
2700 send_crunch_response(csp, rsp);
2710 * We're running an SSL tunnel and we're not forwarding,
2711 * so just send the "connect succeeded" message to the
2712 * client, flush the rest, and get out of the way.
2714 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
2722 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
2724 /* we're finished with the client's header */
2727 maxfd = (csp->cfd > csp->sfd) ? csp->cfd : csp->sfd;
2729 /* pass data between the client and server
2730 * until one or the other shuts down the connection.
2739 * FD_ZERO here seems to point to an errant macro which crashes.
2740 * So do this by hand for now...
2742 memset(&rfds,0x00,sizeof(fd_set));
2746 FD_SET(csp->cfd, &rfds);
2747 FD_SET(csp->sfd, &rfds);
2749 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2750 if ((csp->flags & CSP_FLAG_CHUNKED)
2751 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2752 && ((csp->iob->eod - csp->iob->cur) >= 5)
2753 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2755 log_error(LOG_LEVEL_CONNECT,
2756 "Looks like we read the last chunk together with "
2757 "the server headers. We better stop reading.");
2758 byte_count = (size_t)(csp->iob->eod - csp->iob->cur);
2759 csp->expected_content_length = byte_count;
2760 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2762 if (server_body && server_response_is_complete(csp, byte_count))
2764 log_error(LOG_LEVEL_CONNECT,
2765 "Done reading from server. Expected content length: %d. "
2766 "Actual content length: %d. Most recently received: %d.",
2767 csp->expected_content_length, byte_count, len);
2770 * XXX: should not jump around,
2771 * chat() is complicated enough already.
2775 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2777 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
2781 log_error(LOG_LEVEL_ERROR, "Didn't receive data in time.");
2782 if ((byte_count == 0) && (http->ssl == 0))
2784 write_socket(csp->cfd, CONNECTION_TIMEOUT_RESPONSE,
2785 strlen(CONNECTION_TIMEOUT_RESPONSE));
2787 mark_server_socket_tainted(csp);
2792 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2793 mark_server_socket_tainted(csp);
2798 * This is the body of the browser's request,
2799 * just read and write it.
2801 if (FD_ISSET(csp->cfd, &rfds))
2803 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2807 /* XXX: not sure if this is necessary. */
2808 mark_server_socket_tainted(csp);
2809 break; /* "game over, man" */
2812 if (write_socket(csp->sfd, buf, (size_t)len))
2814 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2815 mark_server_socket_tainted(csp);
2822 * The server wants to talk. It could be the header or the body.
2823 * If `hdr' is null, then it's the header otherwise it's the body.
2824 * FIXME: Does `hdr' really mean `host'? No.
2826 if (FD_ISSET(csp->sfd, &rfds))
2829 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
2833 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2835 if (http->ssl && (fwd->forward_host == NULL))
2838 * Just hang up. We already confirmed the client's CONNECT
2839 * request with status code 200 and unencrypted content is
2840 * no longer welcome.
2842 log_error(LOG_LEVEL_ERROR,
2843 "CONNECT already confirmed. Unable to tell the client about the problem.");
2846 else if (byte_count)
2849 * Just hang up. We already transmitted the original headers
2850 * and parts of the original content and therefore missed the
2851 * chance to send an error message (without risking data corruption).
2853 * XXX: we could retry with a fancy range request here.
2855 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2856 "Unable to tell the client about the problem.");
2857 mark_server_socket_tainted(csp);
2861 rsp = error_response(csp, "connect-failed", errno);
2864 send_crunch_response(csp, rsp);
2870 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2871 if (csp->flags & CSP_FLAG_CHUNKED)
2873 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2875 /* XXX: this is a temporary hack */
2876 log_error(LOG_LEVEL_CONNECT,
2877 "Looks like we reached the end of the last chunk. "
2878 "We better stop reading.");
2879 csp->expected_content_length = byte_count + (size_t)len;
2880 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2884 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2887 * Add a trailing zero to let be able to use string operations.
2888 * XXX: do we still need this with filter_popups gone?
2893 * Normally, this would indicate that we've read
2894 * as much as the server has sent us and we can
2895 * close the client connection. However, Microsoft
2896 * in its wisdom has released IIS/5 with a bug that
2897 * prevents it from sending the trailing \r\n in
2898 * a 302 redirect header (and possibly other headers).
2899 * To work around this if we've haven't parsed
2900 * a full header we'll append a trailing \r\n
2901 * and see if this now generates a valid one.
2903 * This hack shouldn't have any impacts. If we've
2904 * already transmitted the header or if this is a
2905 * SSL connection, then we won't bother with this
2906 * hack. So we only work on partially received
2907 * headers. If we append a \r\n and this still
2908 * doesn't generate a valid header, then we won't
2909 * transmit anything to the client.
2914 if (server_body || http->ssl)
2917 * If we have been buffering up the document,
2918 * now is the time to apply content modification
2919 * and send the result to the client.
2923 p = execute_content_filter(csp, content_filter);
2925 * If the content filter fails, use the original
2926 * buffer and length.
2927 * (see p != NULL ? p : csp->iob->cur below)
2931 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2934 if (JB_ERR_OK != update_server_headers(csp))
2936 log_error(LOG_LEVEL_FATAL,
2937 "Failed to update server headers. after filtering.");
2940 hdr = list_to_text(csp->headers);
2943 /* FIXME Should handle error properly */
2944 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2947 if (write_socket(csp->cfd, hdr, strlen(hdr))
2948 || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
2950 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2953 mark_server_socket_tainted(csp);
2961 break; /* "game over, man" */
2965 * This is NOT the body, so
2966 * Let's pretend the server just sent us a blank line.
2968 snprintf(buf, sizeof(buf), "\r\n");
2969 len = (int)strlen(buf);
2972 * Now, let the normal header parsing algorithm below do its
2973 * job. If it fails, we'll exit instead of continuing.
2980 * If this is an SSL connection or we're in the body
2981 * of the server document, just write it to the client,
2982 * unless we need to buffer the body for later content-filtering
2984 if (server_body || http->ssl)
2989 * If there is no memory left for buffering the content, or the buffer limit
2990 * has been reached, switch to non-filtering mode, i.e. make & write the
2991 * header, flush the iob and buf, and get out of the way.
2993 if (add_to_iob(csp, buf, len))
2998 log_error(LOG_LEVEL_INFO,
2999 "Flushing header and buffers. Stepping back from filtering.");
3001 hdr = list_to_text(csp->headers);
3005 * Memory is too tight to even generate the header.
3006 * Send our static "Out-of-memory" page.
3008 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3009 rsp = cgi_error_memory();
3010 send_crunch_response(csp, rsp);
3011 mark_server_socket_tainted(csp);
3014 hdrlen = strlen(hdr);
3016 if (write_socket(csp->cfd, hdr, hdrlen)
3017 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
3018 || (write_socket(csp->cfd, buf, (size_t)len)))
3020 log_error(LOG_LEVEL_CONNECT,
3021 "Flush header and buffers to client failed: %E");
3023 mark_server_socket_tainted(csp);
3028 * Reset the byte_count to the amount of bytes
3029 * we just flushed. len will be added a few lines below,
3030 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3032 byte_count = (size_t)flushed;
3034 content_filter = NULL;
3040 if (write_socket(csp->cfd, buf, (size_t)len))
3042 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3043 mark_server_socket_tainted(csp);
3047 byte_count += (size_t)len;
3052 const char *header_start;
3054 * We're still looking for the end of the server's header.
3055 * Buffer up the data we just read. If that fails, there's
3056 * little we can do but send our static out-of-memory page.
3058 if (add_to_iob(csp, buf, len))
3060 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3061 rsp = cgi_error_memory();
3062 send_crunch_response(csp, rsp);
3063 mark_server_socket_tainted(csp);
3067 header_start = csp->iob->cur;
3069 /* Convert iob into something sed() can digest */
3070 if (JB_ERR_PARSE == get_server_headers(csp))
3075 * Well, we tried our MS IIS/5 hack and it didn't work.
3076 * The header is incomplete and there isn't anything
3077 * we can do about it.
3079 log_error(LOG_LEVEL_INFO,
3080 "MS IIS5 hack didn't produce valid headers.");
3086 * Since we have to wait for more from the server before
3087 * we can parse the headers we just continue here.
3089 int header_offset = csp->iob->cur - header_start;
3090 assert(csp->iob->cur >= header_start);
3091 byte_count += (size_t)(len - header_offset);
3092 log_error(LOG_LEVEL_CONNECT, "Continuing buffering headers. "
3093 "byte_count: %d. header_offset: %d. len: %d.",
3094 byte_count, header_offset, len);
3099 /* Did we actually get anything? */
3100 if (NULL == csp->headers->first)
3102 log_error(LOG_LEVEL_ERROR, "Empty server or forwarder response.");
3103 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3104 write_socket(csp->cfd, NO_SERVER_DATA_RESPONSE, strlen(NO_SERVER_DATA_RESPONSE));
3105 free_http_request(http);
3106 mark_server_socket_tainted(csp);
3110 assert(csp->headers->first->str);
3112 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3113 strncmpic(csp->headers->first->str, "ICY", 3))
3116 * It doesn't look like a HTTP (or Shoutcast) response:
3117 * tell the client and log the problem.
3119 if (strlen(csp->headers->first->str) > 30)
3121 csp->headers->first->str[30] = '\0';
3123 log_error(LOG_LEVEL_ERROR,
3124 "Invalid server or forwarder response. Starts with: %s",
3125 csp->headers->first->str);
3126 log_error(LOG_LEVEL_CLF,
3127 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3128 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3129 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3130 free_http_request(http);
3131 mark_server_socket_tainted(csp);
3136 * We have now received the entire server header,
3137 * filter it and send the result to the client
3139 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3141 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
3143 hdr = list_to_text(csp->headers);
3146 /* FIXME Should handle error properly */
3147 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3150 if (crunch_response_triggered(csp, crunchers_light))
3153 * One of the tags created by a server-header
3154 * tagger triggered a crunch. We already
3155 * delivered the crunch response to the client
3156 * and are done here after cleaning up.
3159 mark_server_socket_tainted(csp);
3162 /* Buffer and pcrs filter this if appropriate. */
3164 if (!http->ssl) /* We talk plaintext */
3166 content_filter = get_filter_function(csp);
3169 * Only write if we're not buffering for content modification
3171 if (!content_filter)
3174 * Write the server's (modified) header to
3175 * the client (along with anything else that
3176 * may be in the buffer)
3179 if (write_socket(csp->cfd, hdr, strlen(hdr))
3180 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
3182 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
3185 * The write failed, so don't bother mentioning it
3186 * to the client... it probably can't hear us anyway.
3189 mark_server_socket_tainted(csp);
3193 byte_count += (size_t)len;
3198 * XXX: the header lenght should probably
3199 * be calculated by get_server_headers().
3201 int header_length = csp->iob->cur - header_start;
3202 assert(csp->iob->cur > header_start);
3203 byte_count += (size_t)(len - header_length);
3206 /* we're finished with the server's header */
3212 * If this was a MS IIS/5 hack then it means the server
3213 * has already closed the connection. Nothing more to read.
3218 log_error(LOG_LEVEL_INFO,
3219 "Closed server connection detected with MS IIS5 hack enabled.");
3225 mark_server_socket_tainted(csp);
3226 return; /* huh? we should never get here */
3229 if (csp->content_length == 0)
3232 * If Privoxy didn't recalculate the Content-Lenght,
3233 * byte_count is still correct.
3235 csp->content_length = byte_count;
3238 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3239 && (csp->expected_content_length != byte_count))
3241 log_error(LOG_LEVEL_CONNECT,
3242 "Received %d bytes while expecting %d.",
3243 byte_count, csp->expected_content_length);
3244 mark_server_socket_tainted(csp);
3247 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %d",
3248 csp->ip_addr_str, http->ocmd, csp->content_length);
3252 /*********************************************************************
3254 * Function : wait_for_alive_connections
3256 * Description : Waits for alive connections to timeout.
3262 *********************************************************************/
3263 static void wait_for_alive_connections()
3265 int connections_alive = close_unusable_connections();
3267 while (0 < connections_alive)
3269 log_error(LOG_LEVEL_CONNECT,
3270 "Waiting for %d connections to timeout.",
3273 connections_alive = close_unusable_connections();
3276 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
3280 /*********************************************************************
3284 * Description : This is little more than chat. We only "serve" to
3285 * to close any socket that chat may have opened.
3288 * 1 : csp = Current client state (buffers, headers, etc...)
3292 *********************************************************************/
3294 void serve(struct client_state *csp)
3295 #else /* ifndef AMIGA */
3296 static void serve(struct client_state *csp)
3297 #endif /* def AMIGA */
3300 close_socket(csp->cfd);
3302 if (csp->sfd != JB_INVALID_SOCKET)
3304 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3305 static int monitor_thread_running = 0;
3307 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3308 && (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
3310 remember_connection(csp->sfd, csp->http, forward_url(csp, csp->http));
3311 privoxy_mutex_lock(&connection_reuse_mutex);
3312 if (!monitor_thread_running)
3314 monitor_thread_running = 1;
3315 privoxy_mutex_unlock(&connection_reuse_mutex);
3316 wait_for_alive_connections();
3317 privoxy_mutex_lock(&connection_reuse_mutex);
3318 monitor_thread_running = 0;
3320 privoxy_mutex_unlock(&connection_reuse_mutex);
3324 forget_connection(csp->sfd);
3325 close_socket(csp->sfd);
3328 close_socket(csp->sfd);
3329 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3332 csp->flags &= ~CSP_FLAG_ACTIVE;
3338 /*********************************************************************
3340 * Function : server_thread
3342 * Description : We only exist to call `serve' in a threaded environment.
3345 * 1 : data = Current client state (buffers, headers, etc...)
3347 * Returns : Always 0.
3349 *********************************************************************/
3350 static int32 server_thread(void *data)
3352 serve((struct client_state *) data);
3359 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3360 /*********************************************************************
3364 * Description : Print usage info & exit.
3366 * Parameters : Pointer to argv[0] for identifying ourselves
3370 *********************************************************************/
3371 static void usage(const char *myname)
3373 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
3377 #endif /* defined(unix) */
3380 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
3381 #endif /* defined(unix) */
3382 "[--version] [configfile]\n"
3383 "Aborting\n", myname);
3388 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
3391 #ifdef MUTEX_LOCKS_AVAILABLE
3392 /*********************************************************************
3394 * Function : privoxy_mutex_lock
3396 * Description : Locks a mutex.
3399 * 1 : mutex = The mutex to lock.
3401 * Returns : Void. May exit in case of errors.
3403 *********************************************************************/
3404 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
3406 #ifdef FEATURE_PTHREAD
3407 int err = pthread_mutex_lock(mutex);
3410 if (mutex != &log_mutex)
3412 log_error(LOG_LEVEL_FATAL,
3413 "Mutex locking failed: %s.\n", strerror(err));
3418 EnterCriticalSection(mutex);
3419 #endif /* def FEATURE_PTHREAD */
3423 /*********************************************************************
3425 * Function : privoxy_mutex_unlock
3427 * Description : Unlocks a mutex.
3430 * 1 : mutex = The mutex to unlock.
3432 * Returns : Void. May exit in case of errors.
3434 *********************************************************************/
3435 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
3437 #ifdef FEATURE_PTHREAD
3438 int err = pthread_mutex_unlock(mutex);
3441 if (mutex != &log_mutex)
3443 log_error(LOG_LEVEL_FATAL,
3444 "Mutex unlocking failed: %s.\n", strerror(err));
3449 LeaveCriticalSection(mutex);
3450 #endif /* def FEATURE_PTHREAD */
3454 /*********************************************************************
3456 * Function : privoxy_mutex_init
3458 * Description : Prepares a mutex.
3461 * 1 : mutex = The mutex to initialize.
3463 * Returns : Void. May exit in case of errors.
3465 *********************************************************************/
3466 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
3468 #ifdef FEATURE_PTHREAD
3469 int err = pthread_mutex_init(mutex, 0);
3472 printf("Fatal error. Mutex initialization failed: %s.\n",
3477 InitializeCriticalSection(mutex);
3478 #endif /* def FEATURE_PTHREAD */
3480 #endif /* def MUTEX_LOCKS_AVAILABLE */
3482 /*********************************************************************
3484 * Function : initialize_mutexes
3486 * Description : Prepares mutexes if mutex support is available.
3490 * Returns : Void, exits in case of errors.
3492 *********************************************************************/
3493 static void initialize_mutexes(void)
3495 #ifdef MUTEX_LOCKS_AVAILABLE
3497 * Prepare global mutex semaphores
3499 privoxy_mutex_init(&log_mutex);
3500 privoxy_mutex_init(&log_init_mutex);
3501 privoxy_mutex_init(&connection_reuse_mutex);
3504 * XXX: The assumptions below are a bit naive
3505 * and can cause locks that aren't necessary.
3507 * For example older FreeBSD versions (< 6.x?)
3508 * have no gethostbyname_r, but gethostbyname is
3511 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
3512 privoxy_mutex_init(&resolver_mutex);
3513 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
3515 * XXX: should we use a single mutex for
3516 * localtime() and gmtime() as well?
3518 #ifndef HAVE_GMTIME_R
3519 privoxy_mutex_init(&gmtime_mutex);
3520 #endif /* ndef HAVE_GMTIME_R */
3522 #ifndef HAVE_LOCALTIME_R
3523 privoxy_mutex_init(&localtime_mutex);
3524 #endif /* ndef HAVE_GMTIME_R */
3527 privoxy_mutex_init(&rand_mutex);
3528 #endif /* ndef HAVE_RANDOM */
3529 #endif /* def MUTEX_LOCKS_AVAILABLE */
3533 /*********************************************************************
3537 * Description : Load the config file and start the listen loop.
3538 * This function is a lot more *sane* with the `load_config'
3539 * and `listen_loop' functions; although it stills does
3540 * a *little* too much for my taste.
3543 * 1 : argc = Number of parameters (including $0).
3544 * 2 : argv = Array of (char *)'s to the parameters.
3546 * Returns : 1 if : can't open config file, unrecognized directive,
3547 * stats requested in multi-thread mode, can't open the
3548 * log file, can't open the jar file, listen port is invalid,
3549 * any load fails, and can't bind port.
3551 * Else main never returns, the process must be signaled
3552 * to terminate execution. Or, on Windows, use the
3553 * "File", "Exit" menu option.
3555 *********************************************************************/
3557 int real_main(int argc, const char *argv[])
3559 int main(int argc, const char *argv[])
3563 unsigned int random_seed;
3565 struct passwd *pw = NULL;
3566 struct group *grp = NULL;
3569 char *pre_chroot_nslookup_to_load_resolver = NULL;
3576 #if !defined(_WIN32)
3583 /* Prepare mutexes if supported and necessary. */
3584 initialize_mutexes();
3586 /* Enable logging until further notice. */
3590 * Parse the command line arguments
3592 * XXX: simply printing usage information in case of
3593 * invalid arguments isn't particularly user friendly.
3595 while (++argc_pos < argc)
3598 /* Check to see if the service must be installed or uninstalled */
3599 if (strncmp(argv[argc_pos], "--install", 9) == 0)
3601 const char *pName = argv[argc_pos] + 9;
3604 exit( (install_service(pName)) ? 0 : 1 );
3606 else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
3608 const char *pName = argv[argc_pos] + 11;
3611 exit((uninstall_service(pName)) ? 0 : 1);
3613 else if (strcmp(argv[argc_pos], "--service" ) == 0)
3615 bRunAsService = TRUE;
3616 w32_set_service_cwd();
3617 atexit(w32_service_exit_notify);
3620 #endif /* defined(_WIN32) */
3623 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3625 if (strcmp(argv[argc_pos], "--help") == 0)
3630 else if(strcmp(argv[argc_pos], "--version") == 0)
3632 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3638 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
3643 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
3645 if (++argc_pos == argc) usage(argv[0]);
3646 pidfile = strdup(argv[argc_pos]);
3649 else if (strcmp(argv[argc_pos], "--user" ) == 0)
3651 if (++argc_pos == argc) usage(argv[argc_pos]);
3653 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
3656 if (NULL == (grp = getgrnam(p)))
3658 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
3662 if (NULL == (pw = getpwnam(argv[argc_pos])))
3664 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
3667 if (p != NULL) *--p = '\0';
3670 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
3672 if (++argc_pos == argc) usage(argv[0]);
3673 pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
3676 else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
3680 #endif /* defined(unix) */
3682 else if (argc_pos + 1 != argc)
3685 * This is neither the last command line
3686 * option, nor was it recognized before,
3687 * therefore it must be invalid.
3693 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3695 configfile = argv[argc_pos];
3698 } /* -END- while (more arguments) */
3700 show_version(Argv[0]);
3703 if ( *configfile != '/' )
3705 char cwd[BUFFER_SIZE];
3707 size_t abs_file_size;
3709 /* make config-filename absolute here */
3710 if (NULL == getcwd(cwd, sizeof(cwd)))
3712 perror("failed to get current working directory");
3717 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3718 basedir = strdup(cwd);
3720 if (NULL == basedir ||
3721 NULL == (abs_file = malloc(abs_file_size)))
3723 perror("malloc failed");
3726 strlcpy(abs_file, basedir, abs_file_size);
3727 strlcat(abs_file, "/", abs_file_size );
3728 strlcat(abs_file, configfile, abs_file_size);
3729 configfile = abs_file;
3731 #endif /* defined unix */
3735 clients->next = NULL;
3737 /* XXX: factor out initialising after the next stable release. */
3740 #elif defined(_WIN32)
3744 random_seed = (unsigned int)time(NULL);
3746 srandom(random_seed);
3749 #endif /* ifdef HAVE_RANDOM */
3752 * Unix signal handling
3754 * Catch the abort, interrupt and terminate signals for a graceful exit
3755 * Catch the hangup signal so the errlog can be reopened.
3756 * Ignore the broken pipe signals (FIXME: Why?)
3758 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3761 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
3762 const int ignored_signals[] = { SIGPIPE, 0 };
3764 for (idx = 0; catched_signals[idx] != 0; idx++)
3766 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3767 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3769 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3770 #endif /* ifdef sun */
3772 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3776 for (idx = 0; ignored_signals[idx] != 0; idx++)
3778 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
3780 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
3785 #else /* ifdef _WIN32 */
3786 # ifdef _WIN_CONSOLE
3788 * We *are* in a windows console app.
3789 * Print a verbose messages about FAQ's and such
3791 printf("%s", win32_blurb);
3792 # endif /* def _WIN_CONSOLE */
3793 #endif /* def _WIN32 */
3796 /* Initialize the CGI subsystem */
3797 cgi_init_error_messages();
3800 * If runnig on unix and without the --nodaemon
3801 * option, become a daemon. I.e. fork, detach
3802 * from tty and get process group leadership
3815 if ( pid < 0 ) /* error */
3820 else if ( pid != 0 ) /* parent */
3825 * must check for errors
3826 * child died due to missing files aso
3829 wpid = waitpid( pid, &status, WNOHANG );
3838 /* Should be more portable, but not as well tested */
3843 #else /* ndef __FreeBSD__ */
3845 #endif /* ndef __FreeBSD__ */
3846 fd = open("/dev/tty", O_RDONLY);
3849 /* no error check here */
3850 ioctl( fd, TIOCNOTTY,0 );
3855 * stderr (fd 2) will be closed later on, when the
3856 * log file has been parsed.
3863 } /* -END- if (!no_daemon) */
3866 * As soon as we have written the PID file, we can switch
3867 * to the user and group ID indicated by the --user option
3873 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3875 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3879 if (setgroups(1, &grp->gr_gid))
3881 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3884 else if (initgroups(pw->pw_name, pw->pw_gid))
3886 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3892 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3894 /* Read the time zone file from /etc before doing chroot. */
3896 if (NULL != pre_chroot_nslookup_to_load_resolver
3897 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3899 /* Initialize resolver library. */
3900 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3902 if (chroot(pw->pw_dir) < 0)
3904 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3908 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3911 if (setuid(pw->pw_uid))
3913 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3917 char putenv_dummy[64];
3919 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3920 if (putenv(putenv_dummy) != 0)
3922 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3925 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3926 if (putenv(putenv_dummy) != 0)
3928 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3934 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3937 #endif /* defined unix */
3940 /* This will be FALSE unless the command line specified --service
3944 /* Yup, so now we must attempt to establish a connection
3945 * with the service dispatcher. This will only work if this
3946 * process was launched by the service control manager to
3947 * actually run as a service. If this isn't the case, i've
3948 * known it take around 30 seconds or so for the call to return.
3951 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3952 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3954 /* Service has run, and at this point is now being stopped, so just return */
3959 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3961 /* An error occurred. Usually it's because --service was wrongly specified
3962 * and we were unable to connect to the Service Control Dispatcher because
3963 * it wasn't expecting us and is therefore not listening.
3965 * For now, just continue below to call the listen_loop function.
3968 #endif /* def _WIN32 */
3978 /*********************************************************************
3980 * Function : bind_port_helper
3982 * Description : Bind the listen port. Handles logging, and aborts
3986 * 1 : config = Privoxy configuration. Specifies port
3989 * Returns : Port that was opened.
3991 *********************************************************************/
3992 static jb_socket bind_port_helper(struct configuration_spec * config)
3997 if (config->haddr == NULL)
3999 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
4004 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
4005 config->hport, config->haddr);
4008 result = bind_port(config->haddr, config->hport, &bfd);
4015 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
4016 "There may be another Privoxy or some other "
4017 "proxy running on port %d",
4018 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
4019 config->hport, config->hport);
4022 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
4023 "The hostname is not resolvable",
4024 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
4027 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
4028 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
4031 /* shouldn't get here */
4032 return JB_INVALID_SOCKET;
4035 config->need_bind = 0;
4042 /* Without this simple workaround we get this compiler warning from _beginthread
4043 * warning C4028: formal parameter 1 different from declaration
4045 void w32_service_listen_loop(void *p)
4049 #endif /* def _WIN32 */
4052 /*********************************************************************
4054 * Function : listen_loop
4056 * Description : bind the listen port and enter a "FOREVER" listening loop.
4062 *********************************************************************/
4063 static void listen_loop(void)
4065 struct client_state *csp = NULL;
4067 struct configuration_spec * config;
4069 config = load_config();
4071 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4073 * XXX: Should be relocated once it no
4074 * longer needs to emit log messages.
4076 initialize_reusable_connections();
4077 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4079 bfd = bind_port_helper(config);
4081 #ifdef FEATURE_GRACEFUL_TERMINATION
4082 while (!g_terminate)
4087 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
4088 while (waitpid(-1, NULL, WNOHANG) > 0)
4090 /* zombie children */
4092 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
4095 * Free data that was used by died threads
4101 * Re-open the errlog after HUP signal
4103 if (received_hup_signal)
4105 if (NULL != config->logfile)
4107 init_error_log(Argv[0], config->logfile);
4109 received_hup_signal = 0;
4113 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
4115 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
4119 csp->flags |= CSP_FLAG_ACTIVE;
4120 csp->sfd = JB_INVALID_SOCKET;
4122 csp->config = config = load_config();
4124 if ( config->need_bind )
4127 * Since we were listening to the "old port", we will not see
4128 * a "listen" param change until the next IJB request. So, at
4129 * least 1 more request must be made for us to find the new
4130 * setting. I am simply closing the old socket and binding the
4133 * Which-ever is correct, we will serve 1 more page via the
4134 * old settings. This should probably be a "show-proxy-args"
4135 * request. This should not be a so common of an operation
4136 * that this will hurt people's feelings.
4141 bfd = bind_port_helper(config);
4144 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
4146 if (!accept_connection(csp, bfd))
4148 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
4161 log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
4164 #ifdef FEATURE_TOGGLE
4165 if (global_toggle_state)
4166 #endif /* def FEATURE_TOGGLE */
4168 csp->flags |= CSP_FLAG_TOGGLED_ON;
4171 if (run_loader(csp))
4173 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
4174 /* Never get here - LOG_LEVEL_FATAL causes program exit */
4178 if (block_acl(NULL,csp))
4180 log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
4181 close_socket(csp->cfd);
4185 #endif /* def FEATURE_ACL */
4187 /* add it to the list of clients */
4188 csp->next = clients->next;
4189 clients->next = csp;
4191 if (config->multi_threaded)
4195 /* this is a switch () statment in the C preprocessor - ugh */
4196 #undef SELECTED_ONE_OPTION
4198 /* Use Pthreads in preference to native code */
4199 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
4200 #define SELECTED_ONE_OPTION
4202 pthread_t the_thread;
4203 pthread_attr_t attrs;
4205 pthread_attr_init(&attrs);
4206 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
4207 errno = pthread_create(&the_thread, &attrs,
4208 (void * (*)(void *))serve, csp);
4209 child_id = errno ? -1 : 0;
4210 pthread_attr_destroy(&attrs);
4214 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
4215 #define SELECTED_ONE_OPTION
4216 child_id = _beginthread(
4217 (void (*)(void *))serve,
4222 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
4223 #define SELECTED_ONE_OPTION
4224 child_id = _beginthread(
4225 (void(* _Optlink)(void*))serve,
4231 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
4232 #define SELECTED_ONE_OPTION
4234 thread_id tid = spawn_thread
4235 (server_thread, "server", B_NORMAL_PRIORITY, csp);
4237 if ((tid >= 0) && (resume_thread(tid) == B_OK))
4239 child_id = (int) tid;
4248 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
4249 #define SELECTED_ONE_OPTION
4250 csp->cfd = ReleaseSocket(csp->cfd, -1);
4253 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4254 NP_Output, Output(),
4255 NP_CloseOutput, FALSE,
4256 NP_Name, (ULONG)"privoxy child",
4260 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4261 NP_Output, Output(),
4262 NP_CloseOutput, FALSE,
4263 NP_Name, (ULONG)"privoxy child",
4264 NP_StackSize, 200*1024,
4270 ((struct Task *)child_id)->tc_UserData = csp;
4271 Signal((struct Task *)child_id, SIGF_SINGLE);
4276 #if !defined(SELECTED_ONE_OPTION)
4279 /* This block is only needed when using fork().
4280 * When using threads, the server thread was
4281 * created and run by the call to _beginthread().
4283 if (child_id == 0) /* child */
4286 #ifdef FEATURE_TOGGLE
4287 int inherited_toggle_state = global_toggle_state;
4288 #endif /* def FEATURE_TOGGLE */
4293 * If we've been toggled or we've blocked the request, tell Mom
4296 #ifdef FEATURE_TOGGLE
4297 if (inherited_toggle_state != global_toggle_state)
4299 rc |= RC_FLAG_TOGGLED;
4301 #endif /* def FEATURE_TOGGLE */
4303 #ifdef FEATURE_STATISTICS
4304 if (csp->flags & CSP_FLAG_REJECTED)
4306 rc |= RC_FLAG_BLOCKED;
4308 #endif /* ndef FEATURE_STATISTICS */
4312 else if (child_id > 0) /* parent */
4314 /* in a fork()'d environment, the parent's
4315 * copy of the client socket and the CSP
4319 #if !defined(_WIN32) && !defined(__CYGWIN__)
4321 wait( &child_status );
4324 * Evaluate child's return code: If the child has
4325 * - been toggled, toggle ourselves
4326 * - blocked its request, bump up the stats counter
4329 #ifdef FEATURE_TOGGLE
4330 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
4332 global_toggle_state = !global_toggle_state;
4334 #endif /* def FEATURE_TOGGLE */
4336 #ifdef FEATURE_STATISTICS
4338 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
4342 #endif /* def FEATURE_STATISTICS */
4344 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
4345 close_socket(csp->cfd);
4346 csp->flags &= ~CSP_FLAG_ACTIVE;
4350 #undef SELECTED_ONE_OPTION
4351 /* end of cpp switch () */
4353 if (child_id < 0) /* failed */
4355 char buf[BUFFER_SIZE];
4357 log_error(LOG_LEVEL_ERROR, "can't fork: %E");
4359 snprintf(buf , sizeof(buf), "Privoxy: can't fork: errno = %d", errno);
4361 write_socket(csp->cfd, buf, strlen(buf));
4362 close_socket(csp->cfd);
4363 csp->flags &= ~CSP_FLAG_ACTIVE;
4374 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
4376 /* Clean up. Aim: free all memory (no leaks) */
4377 #ifdef FEATURE_GRACEFUL_TERMINATION
4379 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
4381 unload_current_config_file();
4382 unload_current_actions_file();
4383 unload_current_re_filterfile();
4384 #ifdef FEATURE_TRUST
4385 unload_current_trust_file();
4388 if (config->multi_threaded)
4395 } while ((clients->next != NULL) && (--i > 0));
4399 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
4410 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
4411 /* Cleanup - remove taskbar icon etc. */
4416 #endif /* FEATURE_GRACEFUL_TERMINATION */