1 const char jcc_rcs[] = "$Id: jcc.c,v 1.227 2009/03/02 19:18:11 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.227 2009/03/02 19:18:11 fabiankeil
37 * Streamline parse_http_request()'s prototype. As
38 * cparser pointed out it doesn't actually use csp.
40 * Revision 1.226 2009/03/01 18:28:24 fabiankeil
41 * Help clang understand that we aren't dereferencing
44 * Revision 1.225 2009/02/19 18:09:32 fabiankeil
45 * Unbreak build without FEATURE_CONNECTION_KEEP_ALIVE.
48 * Revision 1.224 2009/02/14 15:32:04 fabiankeil
49 * Add the request URL to the timeout message in chat().
52 * Revision 1.223 2009/02/09 21:21:16 fabiankeil
53 * Now that init_log_module() is called earlier, call show_version()
54 * later on from main() directly so it doesn't get called for --help
57 * Revision 1.222 2009/02/08 12:56:51 fabiankeil
58 * Call initialize_mutexes() before init_log_module() again.
59 * Broken since r220, might be the cause of Lee's #2579448.
61 * Revision 1.221 2009/02/06 18:02:58 fabiankeil
62 * When dropping privileges, also give up membership in supplementary
63 * groups. Thanks to Matthias Drochner for reporting the problem,
64 * providing the initial patch and testing the final version.
66 * Revision 1.220 2009/02/04 18:29:07 fabiankeil
67 * Initialize the log module before parsing arguments.
68 * Thanks to Matthias Drochner for the report.
70 * Revision 1.219 2009/01/31 16:08:21 fabiankeil
71 * Remove redundant error check in receive_client_request().
73 * Revision 1.218 2009/01/31 12:25:54 fabiankeil
74 * Flatten indentation in receive_client_request().
76 * Revision 1.217 2009/01/07 19:50:09 fabiankeil
77 * - If the socket-timeout has been reached and the client
78 * hasn't received any data yet, send an explanation before
79 * closing the connection.
80 * - In get_request_line(), signal timeouts the right way.
82 * Revision 1.216 2008/12/24 22:13:11 ler762
83 * fix GCC 3.4.4 warning
85 * Revision 1.215 2008/12/24 17:06:19 fabiankeil
86 * Keep a thread around to timeout alive connections
87 * even if no new requests are coming in.
89 * Revision 1.214 2008/12/20 14:53:55 fabiankeil
90 * Add config option socket-timeout to control the time
91 * Privoxy waits for data to arrive on a socket. Useful
92 * in case of stale ssh tunnels or when fuzz-testing.
94 * Revision 1.213 2008/12/15 18:45:51 fabiankeil
95 * When logging crunches, log the whole URL, so one can easily
96 * differentiate between vanilla HTTP and CONNECT requests.
98 * Revision 1.212 2008/12/14 15:46:22 fabiankeil
99 * Give crunched requests their own log level.
101 * Revision 1.211 2008/12/06 10:05:03 fabiankeil
102 * Downgrade "Received x bytes while expecting y." message to
103 * LOG_LEVEL_CONNECT as it doesn't necessarily indicate an error.
105 * Revision 1.210 2008/12/02 22:03:18 fabiankeil
106 * Don't miscalculate byte_count if we don't get all the
107 * server headers with one read_socket() call. With keep-alive
108 * support enabled, this caused delays until the server closed
111 * Revision 1.209 2008/11/27 09:44:04 fabiankeil
112 * Cosmetics for the last commit: Don't watch out for
113 * the last chunk if the content isn't chunk-encoded or
114 * if we already determined the content length previously.
116 * Revision 1.208 2008/11/26 18:24:17 fabiankeil
117 * Recognize that the server response is complete if the
118 * last chunk is read together with the server headers.
121 * Revision 1.207 2008/11/25 17:25:16 fabiankeil
122 * Don't convert the client-header list to text until we need to.
124 * Revision 1.206 2008/11/23 17:00:11 fabiankeil
125 * Some more chat() cosmetics.
127 * Revision 1.205 2008/11/16 12:43:49 fabiankeil
128 * Turn keep-alive support into a runtime feature
129 * that is disabled by setting keep-alive-timeout
130 * to a negative value.
132 * Revision 1.204 2008/11/06 19:42:17 fabiankeil
133 * Fix last-chunk detection hack to also apply
134 * if buf[] contains nothing but the last-chunk.
136 * Revision 1.203 2008/11/06 18:34:35 fabiankeil
137 * Factor receive_client_request() and
138 * parse_client_request() out of chat().
140 * Revision 1.202 2008/11/02 18:40:34 fabiankeil
141 * If we received a different amount of data than we expected,
142 * log a warning and make sure the server socket isn't reused.
144 * Revision 1.201 2008/11/02 16:48:20 fabiankeil
145 * Revert revision 1.195 and try again.
147 * Revision 1.200 2008/10/26 16:53:18 fabiankeil
150 * Revision 1.199 2008/10/26 15:36:10 fabiankeil
151 * Remove two debug messages with LOG_LEVEL_INFO.
153 * Revision 1.198 2008/10/22 15:19:55 fabiankeil
154 * Once More, With Feeling: if there is no logfile
155 * because the user didn't specify one, we shouldn't
156 * call init_error_log() after receiving SIGHUP either.
158 * Revision 1.197 2008/10/20 17:02:40 fabiankeil
159 * If SIGHUP is received while we aren't running in daemon
160 * mode, calling init_error_log() would be a mistake.
162 * Revision 1.196 2008/10/16 09:16:41 fabiankeil
163 * - Fix two gcc44 conversion warnings.
164 * - Don't bother logging the last five bytes
167 * Revision 1.195 2008/10/13 16:04:37 fabiankeil
168 * Make sure we don't try to reuse tainted server sockets.
170 * Revision 1.194 2008/10/12 18:35:18 fabiankeil
171 * The last commit was a bit too ambitious, apparently the content
172 * length adjustment is only necessary if we aren't buffering.
174 * Revision 1.193 2008/10/12 15:57:35 fabiankeil
175 * Fix content length calculation if we read headers
176 * and the start of the body at once. Now that we have
177 * FEATURE_CONNECTION_KEEP_ALIVE, it actually matters.
179 * Revision 1.192 2008/10/11 18:19:14 fabiankeil
180 * Even more chat() cosmetics.
182 * Revision 1.191 2008/10/11 18:00:14 fabiankeil
183 * Reformat some comments in chat().
185 * Revision 1.190 2008/10/11 14:58:00 fabiankeil
186 * In case of chunk-encoded content, stop reading if
187 * the buffer looks like it ends with the last chunk.
189 * Revision 1.189 2008/10/11 09:53:00 fabiankeil
190 * Let server_response_is_complete() deal properly with
191 * content that is neither buffered nor read all at once.
193 * Revision 1.188 2008/10/09 18:21:41 fabiankeil
194 * Flush work-in-progress changes to keep outgoing connections
195 * alive where possible. Incomplete and mostly #ifdef'd out.
197 * Revision 1.187 2008/09/07 12:35:05 fabiankeil
198 * Add mutex lock support for _WIN32.
200 * Revision 1.186 2008/09/04 08:13:58 fabiankeil
201 * Prepare for critical sections on Windows by adding a
202 * layer of indirection before the pthread mutex functions.
204 * Revision 1.185 2008/08/30 12:03:07 fabiankeil
205 * Remove FEATURE_COOKIE_JAR.
207 * Revision 1.184 2008/08/22 15:34:45 fabiankeil
208 * - Silence LLVM/Clang complaint.
209 * - Make received_hup_signal static.
210 * - Hide definitions for basedir, pidfile and received_hup_signal
211 * from __EMX__ as they only seem to be used in case of #ifdef unix.
213 * Revision 1.183 2008/08/21 07:09:35 fabiankeil
214 * Accept Shoutcast responses again. Problem reported
215 * and fix suggested by Stefan in #2062860.
217 * Revision 1.182 2008/06/27 11:13:56 fabiankeil
218 * Fix possible NULL-pointer dereference reported
219 * by din_a4 in #2003937. Pointy hat to me.
221 * Revision 1.181 2008/05/21 15:47:15 fabiankeil
222 * Streamline sed()'s prototype and declare
223 * the header parse and add structures static.
225 * Revision 1.180 2008/05/21 15:26:32 fabiankeil
226 * - Mark csp as immutable for send_crunch_response().
227 * - Fix comment spelling.
229 * Revision 1.179 2008/05/20 20:13:32 fabiankeil
230 * Factor update_server_headers() out of sed(), ditch the
231 * first_run hack and make server_patterns_light static.
233 * Revision 1.178 2008/05/10 13:23:38 fabiankeil
234 * Don't provide get_header() with the whole client state
235 * structure when it only needs access to csp->iob.
237 * Revision 1.177 2008/05/10 11:51:12 fabiankeil
238 * Make the "read the rest of the headers" loop a bit more readable.
240 * Revision 1.176 2008/05/10 11:37:57 fabiankeil
241 * - Instead of logging when the IIS5 hack is enabled, log when it fails.
242 * - Remove useless comment.
244 * Revision 1.175 2008/05/09 18:53:59 fabiankeil
245 * Fix comment grammar.
247 * Revision 1.174 2008/05/07 18:05:53 fabiankeil
248 * Remove the pointless buffer in client_protocol_is_unsupported().
250 * Revision 1.173 2008/05/06 15:09:00 fabiankeil
251 * Least-effort fix for bug #1821930 (reported by Lee):
252 * If the response doesn't look like HTTP,
253 * tell the client and log the problem.
255 * Revision 1.172 2008/04/16 16:38:21 fabiankeil
256 * Don't pass the whole csp structure to flush_socket()
257 * when it only needs a file descriptor and a buffer.
259 * Revision 1.171 2008/03/27 18:27:25 fabiankeil
260 * Remove kill-popups action.
262 * Revision 1.170 2008/03/06 16:33:46 fabiankeil
263 * If limit-connect isn't used, don't limit CONNECT requests to port 443.
265 * Revision 1.169 2008/03/04 18:30:39 fabiankeil
266 * Remove the treat-forbidden-connects-like-blocks action. We now
267 * use the "blocked" page for forbidden CONNECT requests by default.
269 * Revision 1.168 2008/03/02 12:25:25 fabiankeil
270 * Also use shiny new connect_port_is_forbidden() in jcc.c.
272 * Revision 1.167 2008/02/23 16:57:12 fabiankeil
273 * Rename url_actions() to get_url_actions() and let it
274 * use the standard parameter ordering.
276 * Revision 1.166 2008/02/23 16:33:43 fabiankeil
277 * Let forward_url() use the standard parameter ordering
278 * and mark its second parameter immutable.
280 * Revision 1.165 2008/02/02 19:36:56 fabiankeil
281 * Remove the "Listening ... for local connections only" log message.
282 * Whether or not remote connections are able to reach Privoxy is up
283 * to the operating system.
285 * Revision 1.164 2007/12/16 18:32:46 fabiankeil
286 * Prevent the log messages for CONNECT requests to unacceptable
287 * ports from printing the limit-connect argument as [null] if
288 * limit-connect hasn't been explicitly enabled.
290 * Revision 1.163 2007/12/13 01:47:11 david__schmidt
291 * Make sure all console-mode apps get a usage() instance
293 * Revision 1.162 2007/12/06 17:54:57 fabiankeil
294 * Reword NO_SERVER_DATA_RESPONSE to make it harder
295 * to misunderstand what the message is all about.
297 * Revision 1.161 2007/12/04 19:44:22 fabiankeil
298 * Unbreak trustfile which previously didn't work without
299 * FEATURE_TOGGLE. Fixes BR#1843585, reported by Lee.
301 * Revision 1.160 2007/11/29 18:00:29 fabiankeil
302 * Plug memory leak. Spotted by Valgrind, triggered by
303 * Privoxy-Regression-Test feeding proxyfuzz.py.
305 * Revision 1.159 2007/11/24 14:34:09 fabiankeil
306 * In the HTTP snipplets, refer to the client as client.
308 * Revision 1.158 2007/11/11 16:44:17 fabiankeil
309 * Emit a log message when activating the MS IIS5 hack.
311 * Revision 1.157 2007/11/03 17:34:49 fabiankeil
312 * Log the "weak randomization factor" warning only
313 * once for mingw32 and provide some more details.
315 * Revision 1.156 2007/11/01 18:20:58 fabiankeil
316 * Initialize log module after initializing mutexes, future
317 * deadlocks in that code should now work cross-platform.
319 * Revision 1.155 2007/10/23 20:12:45 fabiankeil
320 * Fix first CSUCCEED line to end in \r\n as required by RFC1945.
321 * Reported by Bert van Leeuwen in BR#1818808.
323 * Revision 1.154 2007/10/19 17:00:08 fabiankeil
324 * Downgrade "Flushing header and buffers" message to LOG_LEVEL_INFO.
326 * Revision 1.153 2007/10/14 14:12:41 fabiankeil
327 * When in daemon mode, close stderr after the configuration file has been
328 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
330 * Revision 1.152 2007/10/04 18:03:34 fabiankeil
331 * - Fix a crash when parsing invalid requests whose first header
332 * is rejected by get_header(). Regression (re?)introduced
333 * in r1.143 by yours truly.
334 * - Move ACTION_VANILLA_WAFER handling into parsers.c's
335 * client_cookie_adder() to make sure send-vanilla-wafer can be
336 * controlled through tags (and thus regression-tested).
338 * Revision 1.151 2007/09/29 10:21:16 fabiankeil
339 * - Move get_filter_function() from jcc.c to filters.c
340 * so the filter functions can be static.
341 * - Don't bother filtering body-less responses.
343 * Revision 1.150 2007/09/28 16:39:29 fabiankeil
344 * Execute content filters through execute_content_filter().
346 * Revision 1.149 2007/09/04 15:08:48 fabiankeil
347 * Initialize req to NULL to make sure it's defined if the
348 * first read_socket() call fails. Reported by icmp30.
350 * Revision 1.148 2007/08/26 16:47:13 fabiankeil
351 * Add Stephen Gildea's --pre-chroot-nslookup patch [#1276666],
352 * extensive comments moved to user manual.
354 * Revision 1.147 2007/08/25 14:42:40 fabiankeil
355 * Don't crash if a broken header filter wiped out the request line.
357 * Revision 1.146 2007/08/20 17:09:32 fabiankeil
358 * Fix byte_count calculation in case of flushes
359 * and don't parse the server headers a second time.
361 * Revision 1.145 2007/08/19 13:13:31 fabiankeil
362 * - If there's a connection problem after we already forwarded
363 * parts of the original content, just hang up. Fixes BR#1776724.
364 * - Fix warnings about unused code on mingw32.
365 * - In case of flushes, calculate the byte count
366 * less incorrectly (I think).
368 * Revision 1.144 2007/08/11 14:43:22 fabiankeil
369 * Add some more prototypes for static functions.
371 * Revision 1.143 2007/08/05 13:58:19 fabiankeil
372 * Comment out request_contains_null_bytes() until it's used again.
374 * Revision 1.142 2007/08/05 13:50:26 fabiankeil
375 * #1763173 from Stefan Huehner: s@const static@static const@
376 * and declare some more functions static.
378 * Revision 1.141 2007/08/04 09:56:23 fabiankeil
379 * - Log rejected CONNECT requests with LOG_LEVEL_INFO
380 * and explain why they were rejected in the first place.
381 * - Fix the LOG_LEVEL_CLF message for crunches of unallowed
382 * CONNECT requests. The request line was missing.
383 * - Add two more XXX reminders as we don't have enough already.
385 * Revision 1.140 2007/07/21 11:51:36 fabiankeil
386 * As Hal noticed, checking dispatch_cgi() as the last cruncher
387 * looks like a bug if CGI requests are blocked unintentionally,
388 * so don't do it unless the user enabled the new config option
389 * "allow-cgi-request-crunching".
391 * Revision 1.139 2007/07/14 07:46:41 fabiankeil
392 * - Allow to rewrite the request destination behind the client's back.
393 * - Turn the weird-looking unconditional for loop that
394 * reads the client request into a conditional while loop.
395 * Move the stuff that only runs once out of the loop.
396 * - Move parts of chat(), server_content_type() and the
397 * necessary stuff to fix BR#1750917 into get_filter_function().
399 * Revision 1.138 2007/06/03 18:45:18 fabiankeil
400 * Temporary workaround for BR#1730105.
402 * Revision 1.137 2007/06/01 18:16:36 fabiankeil
403 * Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
404 * deadlocks and crashes on OpenBSD and possibly other OS with neither
405 * gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
406 * Thanks to Ralf Horstmann for report and solution.
408 * Revision 1.136 2007/06/01 16:41:11 fabiankeil
409 * Add forward-override{} to change the forwarding settings through
410 * action sections. This is mainly interesting to forward different
411 * clients differently (for example based on User-Agent or request
414 * Revision 1.135 2007/05/24 17:03:50 fabiankeil
415 * - Let usage() mention the --chroot parameter.
416 * - Use read_socket() consistently and always leave
417 * the last buffer byte alone, even in cases where
418 * null termination (currently) doesn't matter.
420 * Revision 1.134 2007/05/16 14:59:46 fabiankeil
421 * - Fix config file loading on Unix if no config file is specified.
422 * Since r1.97 Privoxy would always interpret the last argument as
423 * config file, even if it's a valid command line option.
424 * - Abort in case of unrecognized command line options. Closes #1719696.
425 * - Remove a bunch of unnecessary strcpy() calls (yay for c&p without thinking).
426 * - Replace the remaining strcpy() and strcat() calls with strlcpy() and strcat().
428 * Revision 1.133 2007/05/04 11:23:19 fabiankeil
429 * - Don't rerun crunchers that only depend on the request URL.
430 * - Don't count redirects and CGI requests as "blocked requests".
432 * Revision 1.132 2007/04/25 15:15:17 fabiankeil
433 * Support crunching based on tags created by server-header taggers.
435 * Revision 1.131 2007/04/22 13:24:50 fabiankeil
436 * Make HTTP snippets static (again). Add a Content-Type for those
437 * with content so the browser doesn't guess it based on the URL.
439 * Revision 1.130 2007/04/19 13:47:34 fabiankeil
440 * Move crunching and request line rebuilding out of chat().
442 * Revision 1.129 2007/04/15 16:39:20 fabiankeil
443 * Introduce tags as alternative way to specify which
444 * actions apply to a request. At the moment tags can be
445 * created based on client and server headers.
447 * Revision 1.128 2007/03/25 16:55:54 fabiankeil
448 * Don't CLF-log CONNECT requests twice.
450 * Revision 1.127 2007/03/20 13:53:17 fabiankeil
451 * Log the source address for ACL-related connection drops.
453 * Revision 1.126 2007/03/17 15:20:05 fabiankeil
454 * New config option: enforce-blocks.
456 * Revision 1.125 2007/03/09 14:12:00 fabiankeil
457 * - Move null byte check into separate function.
458 * - Don't confuse the client with error pages
459 * if a CONNECT request was already confirmed.
461 * Revision 1.124 2007/02/23 14:59:54 fabiankeil
462 * Speed up NULL byte escaping and only log the complete
463 * NULL byte requests with header debugging enabled.
465 * Revision 1.123 2007/02/21 18:42:10 fabiankeil
466 * Answer requests that contain NULL bytes with
467 * a custom response instead of waiting for more
468 * data until the client eventually hangs up.
470 * Revision 1.122 2007/02/07 11:12:02 fabiankeil
471 * - Move delivery and logging of crunched responses
472 * from chat() into send_crunch_response().
473 * - Display the reason for generating http_responses.
474 * - Log the content length for LOG_LEVEL_CLF correctly
475 * (still incorrect for some fixed responses).
476 * - Reword an incorrect comment about
477 * treat-forbidden-connects-like-blocks violating
479 * - Add some log messages.
481 * Revision 1.121 2007/01/27 10:52:56 fabiankeil
482 * Move mutex initialization into separate
483 * function and exit in case of errors.
485 * Revision 1.120 2007/01/26 14:18:42 fabiankeil
486 * - Start to reduce chat()'s line count and move
487 * parts of it into separate functions.
488 * - Add "HTTP/1.1 100 Continue" hack for BR 756734.
490 * Revision 1.119 2007/01/25 14:02:30 fabiankeil
491 * - Add Proxy-Agent header to HTTP snippets that are
492 * supposed to reach HTTP clients only.
493 * - Made a few CONNECT log messages more descriptive.
494 * - Catch completely empty server responses (as seen
495 * with Tor's fake ".noconnect" top level domain).
496 * - Use shiny new "forwarding-failed" template for socks errors.
498 * Revision 1.118 2007/01/07 07:43:43 joergs
499 * AmigaOS4 support added.
501 * Revision 1.117 2006/12/31 17:56:37 fabiankeil
502 * Added config option accept-intercepted-requests
503 * and disabled it by default.
505 * Revision 1.116 2006/12/29 19:08:22 fabiankeil
506 * Reverted parts of my last commit
507 * to keep error handling working.
509 * Revision 1.115 2006/12/29 17:38:57 fabiankeil
510 * Fixed gcc43 conversion warnings.
512 * Revision 1.114 2006/12/27 18:52:02 fabiankeil
513 * Fix -pedantic ISO C warning about converting
514 * from function pointer to object pointer.
516 * Revision 1.113 2006/12/26 17:38:50 fabiankeil
517 * Silence compiler warning I introduced with my last commit.
519 * Revision 1.112 2006/12/26 17:31:41 fabiankeil
520 * Mutex protect rand() if POSIX threading
521 * is used, warn the user if that's not possible
522 * and stop using it on _WIN32 where it could
525 * Revision 1.111 2006/12/23 16:15:06 fabiankeil
526 * Don't prevent core dumps by catching SIGABRT.
527 * It's rude and makes debugging unreasonable painful.
529 * Revision 1.110 2006/12/13 14:52:53 etresoft
530 * Fix build failure on MacOS X. Global symbols can be either static or extern, but not both.
532 * Revision 1.109 2006/12/06 19:41:40 fabiankeil
533 * Privoxy is now able to run as intercepting
534 * proxy in combination with any packet filter
535 * that does the port redirection. The destination
536 * is extracted from the "Host:" header which
537 * should be available for nearly all requests.
539 * Moved HTTP snipplets into jcc.c.
540 * Added error message for gopher proxy requests.
542 * Revision 1.108 2006/11/28 15:38:51 fabiankeil
543 * Only unlink the pidfile if it's actually used.
545 * Change order of interception checks to make
546 * it possible to block or redirect requests for
549 * Revision 1.107 2006/11/13 19:05:51 fabiankeil
550 * Make pthread mutex locking more generic. Instead of
551 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
552 * and use mutex locking unless there is an _r function
553 * available. Better safe than sorry.
555 * Fixes "./configure --disable-pthread" and should result
556 * in less threading-related problems on pthread-using platforms,
557 * but it still doesn't fix BR#1122404.
559 * Revision 1.106 2006/11/06 19:58:23 fabiankeil
560 * Move pthread.h inclusion from jcc.c to jcc.h.
561 * Fixes build on x86-freebsd1 (FreeBSD 5.4-RELEASE).
563 * Revision 1.105 2006/11/06 14:26:02 fabiankeil
564 * Don't exit after receiving the second SIGHUP on Solaris.
566 * Fixes BR 1052235, but the same problem may exist on other
567 * systems. Once 3.0.6 is out we should use sigset()
568 * where available and see if it breaks anything.
570 * Revision 1.104 2006/09/23 13:26:38 roro
571 * Replace TABs by spaces in source code.
573 * Revision 1.103 2006/09/21 12:54:43 fabiankeil
574 * Fix +redirect{}. Didn't work with -fast-redirects.
576 * Revision 1.102 2006/09/06 13:03:04 fabiankeil
577 * Respond with 400 and a short text message
578 * if the client tries to use Privoxy as FTP proxy.
580 * Revision 1.101 2006/09/06 09:23:37 fabiankeil
581 * Make number of retries in case of forwarded-connect problems
582 * a config file option (forwarded-connect-retries) and use 0 as
585 * Revision 1.100 2006/09/03 19:42:59 fabiankeil
586 * Set random(3) seed.
588 * Revision 1.99 2006/09/02 15:36:42 fabiankeil
589 * Follow the OpenBSD port's lead and protect the resolve
590 * functions on OpenBSD as well.
592 * Revision 1.98 2006/08/24 11:01:34 fabiankeil
593 * --user fix. Only use the user as group if no group is specified.
594 * Solves BR 1492612. Thanks to Spinor S. and David Laight.
596 * Revision 1.97 2006/08/18 15:23:17 david__schmidt
597 * Windows service (re-)integration
601 * --install[:service_name]
602 * --uninstall[:service_name]
605 * They work as follows:
606 * --install will create a service for you and then terminate.
607 * By default the service name will be "privoxy" (without the quotes).
608 * However you can run multiple services if you wish, just by adding
609 * a colon and then a name (no spaces).
611 * --uninstall follows the exact same rules a --install.
613 * --service is used when the program is executed by the service
614 * control manager, and in normal circumstances would never be
615 * used as a command line argument.
617 * Revision 1.96 2006/08/15 20:12:36 david__schmidt
618 * Windows service integration
620 * Revision 1.95 2006/08/03 02:46:41 david__schmidt
621 * Incorporate Fabian Keil's patch work:
622 http://www.fabiankeil.de/sourcecode/privoxy/
624 * Revision 1.94 2006/07/18 14:48:46 david__schmidt
625 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
626 * with what was really the latest development (the v_3_0_branch branch)
628 * Revision 1.92.2.16 2005/04/03 20:10:50 david__schmidt
629 * Thanks to Jindrich Makovicka for a race condition fix for the log
630 * file. The race condition remains for non-pthread implementations.
631 * Reference patch #1175720.
633 * Revision 1.92.2.15 2004/10/03 12:53:32 david__schmidt
634 * Add the ability to check jpeg images for invalid
635 * lengths of comment blocks. Defensive strategy
636 * against the exploit:
637 * Microsoft Security Bulletin MS04-028
638 * Buffer Overrun in JPEG Processing (GDI+) Could
639 * Allow Code Execution (833987)
640 * Enabled with +inspect-jpegs in actions files.
642 * Revision 1.92.2.14 2003/12/12 12:52:53 oes
643 * - Fixed usage info for non-unix platforms
644 * - Fixed small cmdline parsing bug
646 * Revision 1.92.2.13 2003/11/27 19:20:27 oes
647 * Diagnostics: Now preserve the returncode of pthread_create
648 * in errno. Closes BR #775721. Thanks to Geoffrey Hausheer.
650 * Revision 1.92.2.12 2003/07/11 11:34:19 oes
651 * No longer ignore SIGCHLD. Fixes bug #769381
653 * Revision 1.92.2.11 2003/05/14 12:32:02 oes
654 * Close jarfile on graceful exit, remove stray line
656 * Revision 1.92.2.10 2003/05/08 15:13:46 oes
657 * Cosmetics: Killed a warning, a typo and an allocation left at exit
659 * Revision 1.92.2.9 2003/04/03 15:08:42 oes
660 * No longer rely on non-POSIX.1 extensions of getcwd().
663 * Revision 1.92.2.8 2003/03/31 13:12:32 oes
664 * Replaced setenv() by posix-compliant putenv()
665 * Thanks to Neil McCalden (nmcc AT users.sf.net).
667 * Revision 1.92.2.7 2003/03/17 16:48:59 oes
668 * Added chroot ability, thanks to patch by Sviatoslav Sviridov
670 * Revision 1.92.2.6 2003/03/11 11:55:00 oes
671 * Clean-up and extension of improvements for forked mode:
672 * - Child's return code now consists of flags RC_FLAG_*
673 * - Reporting toggle to parent now properly #ifdef'ed
674 * - Children now report blocking to parent. This enables
675 * statistics in forked mode
677 * Revision 1.92.2.5 2003/03/10 23:45:32 oes
678 * Fixed bug #700381: Non-Threaded version now capable of being toggled.
679 * Children now report having been toggled through _exit(17), parents
680 * watch for that code and toggle themselves if found.
682 * Revision 1.92.2.4 2003/03/07 03:41:04 david__schmidt
683 * Wrapping all *_r functions (the non-_r versions of them) with
684 * mutex semaphores for OSX. Hopefully this will take care of all
685 * of those pesky crash reports.
687 * Revision 1.92.2.3 2003/02/28 12:53:06 oes
688 * Fixed two mostly harmless mem leaks
690 * Revision 1.92.2.2 2002/11/20 14:37:47 oes
691 * Fix: Head of global clients list now initialized to NULL
693 * Revision 1.92.2.1 2002/09/25 14:52:24 oes
694 * Added basic support for OPTIONS and TRACE HTTP methods:
695 * - New interceptor direct_response() added in chat().
696 * - sed() moved to earlier in the process, so that the
697 * Host: header is evaluated before actions and forwarding
700 * Revision 1.92 2002/05/08 16:00:46 oes
701 * Chat's buffer handling:
702 * - Fixed bug with unchecked out-of-mem conditions
703 * while reading client request & server headers
704 * - No longer predict if the buffer limit will be exceeded
705 * in the next read -- check add_to_iob's new
706 * return code. If buffer couldn't be extended
707 * (policy or out-of-mem) while
708 * - reading from client: abort
709 * - reading server headers: send error page
710 * - buffering server body for filter: flush,
711 * and if that fails: send error page
713 * Revision 1.91 2002/04/08 20:35:58 swa
716 * Revision 1.90 2002/04/02 14:57:28 oes
717 * Made sending wafers independent of FEATURE_COOKIE_JAR
719 * Revision 1.89 2002/03/31 17:18:59 jongfoster
720 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
722 * Revision 1.88 2002/03/27 14:32:43 david__schmidt
723 * More compiler warning message maintenance
725 * Revision 1.87 2002/03/26 22:29:54 swa
726 * we have a new homepage!
728 * Revision 1.86 2002/03/25 17:04:55 david__schmidt
729 * Workaround for closing the jarfile before load_config() comes around again
731 * Revision 1.85 2002/03/24 15:23:33 jongfoster
734 * Revision 1.84 2002/03/24 13:25:43 swa
735 * name change related issues
737 * Revision 1.83 2002/03/16 23:54:06 jongfoster
738 * Adding graceful termination feature, to help look for memory leaks.
739 * If you enable this (which, by design, has to be done by hand
740 * editing config.h) and then go to http://i.j.b/die, then the program
741 * will exit cleanly after the *next* request. It should free all the
742 * memory that was used.
744 * Revision 1.82 2002/03/13 00:27:05 jongfoster
747 * Revision 1.81 2002/03/12 01:42:50 oes
748 * Introduced modular filters
750 * Revision 1.80 2002/03/11 22:07:05 david__schmidt
751 * OS/2 port maintenance:
752 * - Fixed EMX build - it had decayed a little
753 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
754 * substituted a memset for now.
756 * Revision 1.79 2002/03/09 20:03:52 jongfoster
757 * - Making various functions return int rather than size_t.
758 * (Undoing a recent change). Since size_t is unsigned on
759 * Windows, functions like read_socket that return -1 on
760 * error cannot return a size_t.
762 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
763 * crashes, and also frequently caused JB to jump to 100%
764 * CPU and stay there. (Because it thought it had just
765 * read ((unsigned)-1) == 4Gb of data...)
767 * - The signature of write_socket has changed, it now simply
768 * returns success=0/failure=nonzero.
770 * - Trying to get rid of a few warnings --with-debug on
771 * Windows, I've introduced a new type "jb_socket". This is
772 * used for the socket file descriptors. On Windows, this
773 * is SOCKET (a typedef for unsigned). Everywhere else, it's
774 * an int. The error value can't be -1 any more, so it's
775 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
776 * Windows it maps to the #define INVALID_SOCKET.)
778 * - The signature of bind_port has changed.
780 * Revision 1.78 2002/03/08 21:35:04 oes
781 * Added optional group supplement to --user option. Will now use default group of user if no group given
783 * Revision 1.77 2002/03/07 03:52:06 oes
784 * - Fixed compiler warnings etc
785 * - Improved handling of failed DNS lookups
787 * Revision 1.76 2002/03/06 22:54:35 jongfoster
788 * Automated function-comment nitpicking.
790 * Revision 1.75 2002/03/06 10:02:19 oes
791 * Fixed stupid bug when --user was not given
793 * Revision 1.74 2002/03/06 00:49:31 jongfoster
794 * Fixing warning on Windows
795 * Making #ifdefs that refer to the same variable consistently
796 * use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
798 * Revision 1.73 2002/03/05 23:57:30 hal9
799 * Stray character 's' on line 1618 was breaking build.
801 * Revision 1.72 2002/03/05 21:33:45 david__schmidt
802 * - Re-enable OS/2 building after new parms were added
803 * - Fix false out of memory report when resolving CGI templates when no IP
804 * address is available of failed attempt (a la no such domain)
806 * Revision 1.71 2002/03/05 18:13:56 oes
807 * Added --user option
809 * Revision 1.70 2002/03/05 04:52:42 oes
810 * Deleted non-errlog debugging code
812 * Revision 1.69 2002/03/04 23:50:00 jongfoster
813 * Splitting off bind_port() call into bind_port_helper(), with
816 * Revision 1.68 2002/03/04 20:17:32 oes
819 * Revision 1.67 2002/03/04 18:18:57 oes
820 * - Removed _DEBUG mode
821 * - Cleand up cmdline parsing
822 * - Introduced --no-daemon, --pidfile options
823 * - Cleaned up signal handling:
824 * - Terminate cleanly on INT, TERM and ABRT
825 * - Schedule logfile for re-opening on HUP
826 * - Ignore CHLD and PIPE
827 * - Leave the rest with their default handlers
828 * - Uniform handler registration
829 * - Added usage() function
830 * - Played styleguide police
832 * Revision 1.66 2002/03/03 15:06:55 oes
833 * Re-enabled automatic config reloading
835 * Revision 1.65 2002/03/03 14:49:11 oes
836 * Fixed CLF logging: Now uses client's original HTTP request
838 * Revision 1.64 2002/03/03 09:18:03 joergs
839 * Made jumbjuster work on AmigaOS again.
841 * Revision 1.63 2002/03/02 04:14:50 david__schmidt
842 * Clean up a little CRLF unpleasantness that suddenly appeared
844 * Revision 1.62 2002/02/20 23:17:23 jongfoster
845 * Detecting some out-of memory conditions and exiting with a log message.
847 * Revision 1.61 2002/01/17 21:01:52 jongfoster
848 * Moving all our URL and URL pattern parsing code to urlmatch.c.
850 * Revision 1.60 2001/12/30 14:07:32 steudten
851 * - Add signal handling (unix)
852 * - Add SIGHUP handler (unix)
853 * - Add creation of pidfile (unix)
854 * - Add action 'top' in rc file (RH)
855 * - Add entry 'SIGNALS' to manpage
856 * - Add exit message to logfile (unix)
858 * Revision 1.59 2001/12/13 14:07:18 oes
859 * Fixed Bug: 503 error page now sent OK
861 * Revision 1.58 2001/11/30 23:37:24 jongfoster
862 * Renaming the Win32 config file to config.txt - this is almost the
863 * same as the corresponding UNIX name "config"
865 * Revision 1.57 2001/11/16 00:47:43 jongfoster
866 * Changing the tty-disconnection code to use setsid().
868 * Revision 1.56 2001/11/13 20:20:54 jongfoster
869 * Tabs->spaces, fixing a bug with missing {} around an if()
871 * Revision 1.55 2001/11/13 20:14:53 jongfoster
872 * Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
874 * Revision 1.54 2001/11/07 00:03:14 steudten
875 * Give reliable return value if an error
876 * occurs not just 0 with new daemon mode.
878 * Revision 1.53 2001/11/05 21:41:43 steudten
879 * Add changes to be a real daemon just for unix os.
880 * (change cwd to /, detach from controlling tty, set
881 * process group and session leader to the own process.
883 * Add some fatal-error log message for failed malloc().
884 * Add '-d' if compiled with 'configure --with-debug' to
885 * enable debug output.
887 * Revision 1.52 2001/10/26 20:11:20 jongfoster
888 * Fixing type mismatch
890 * Revision 1.51 2001/10/26 17:38:28 oes
893 * Revision 1.50 2001/10/25 03:40:48 david__schmidt
894 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
895 * threads to call select() simultaneously. So, it's time to do a real, live,
896 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
897 * (native). Both versions will work, but using __OS2__ offers multi-threading.
899 * Revision 1.49 2001/10/23 21:41:35 jongfoster
900 * Added call to initialize the (statically-allocated of course)
901 * "out of memory" CGI response.
903 * Revision 1.48 2001/10/10 19:56:46 jongfoster
904 * Moving some code that wasn't cookie-related out of an #ifdef
907 * Revision 1.47 2001/10/10 16:44:36 oes
908 * Added CONNECT destination port limitation check
910 * Revision 1.46 2001/10/08 15:17:41 oes
911 * Re-enabled SSL forwarding
913 * Revision 1.45 2001/10/07 15:42:11 oes
914 * Replaced 6 boolean members of csp with one bitmap (csp->flags)
916 * Moved downgrading of the HTTP version from parse_http_request to
917 * chat(), since we can't decide if it is necessary before we have
918 * determined the actions for the URL. The HTTP command is now
919 * *always* re-built so the repairs need no longer be special-cased.
921 * filter_popups now gets a csp pointer so it can raise the new
922 * CSP_FLAG_MODIFIED flag.
926 * Added configurable size limit for the IOB. If the IOB grows so
927 * large that the next read would exceed the limit, the header
928 * is generated, and the header & unfiltered buffer are flushed
929 * to the client. Chat then continues in non-buffering,
930 * non-filtering body mode.
932 * Revision 1.44 2001/10/02 18:13:57 oes
935 * Revision 1.43 2001/10/02 15:32:13 oes
936 * Moved generation of hdr
938 * Revision 1.42 2001/09/21 23:02:02 david__schmidt
939 * Cleaning up 2 compiler warnings on OS/2.
941 * Revision 1.41 2001/09/16 17:05:14 jongfoster
942 * Removing unused #include showarg.h
944 * Revision 1.40 2001/09/16 15:41:45 jongfoster
945 * Fixing signed/unsigned comparison warning.
947 * Revision 1.39 2001/09/16 13:21:27 jongfoster
948 * Changes to use new list functions.
950 * Revision 1.38 2001/09/16 13:01:46 jongfoster
951 * Removing redundant function call that zeroed zalloc()'d memory.
953 * Revision 1.37 2001/09/10 11:12:24 oes
954 * Deleted unused variable
956 * Revision 1.36 2001/09/10 10:56:15 oes
957 * Silenced compiler warnings
959 * Revision 1.35 2001/07/31 14:44:22 oes
960 * Deleted unused size parameter from filter_popups()
962 * Revision 1.34 2001/07/30 22:08:36 jongfoster
963 * Tidying up #defines:
964 * - All feature #defines are now of the form FEATURE_xxx
965 * - Permanently turned off WIN_GUI_EDIT
966 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
968 * Revision 1.33 2001/07/29 19:32:00 jongfoster
969 * Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
971 * Revision 1.32 2001/07/29 18:47:05 jongfoster
972 * Adding missing #include "loadcfg.h"
974 * Revision 1.31 2001/07/29 12:17:48 oes
975 * Applied pthread fix by Paul Lieverse
977 * Revision 1.30 2001/07/25 22:57:13 jongfoster
978 * __BEOS__ no longer overrides FEATURE_PTHREAD.
979 * This is because FEATURE_PTHREAD will soon be widely used, so I
980 * want to keep it simple.
982 * Revision 1.29 2001/07/24 12:47:06 oes
983 * Applied BeOS support update by Eugenia
985 * Revision 1.28 2001/07/23 13:26:12 oes
986 * Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
988 * Revision 1.27 2001/07/19 19:09:47 haroon
989 * - Added code to take care of the situation where while processing the first
990 * server response (which includes the server header), after finding the end
991 * of the headers we were not looking past the end of the headers for
992 * content modification. I enabled it for filter_popups.
993 * Someone else should look to see if other similar operations should be
994 * done to the discarded portion of the buffer.
996 * Note 2001/07/20: No, the other content modification mechanisms will process
997 * the whole iob later anyway. --oes
999 * Revision 1.26 2001/07/18 12:31:36 oes
1002 * Revision 1.25 2001/07/15 19:43:49 jongfoster
1003 * Supports POSIX threads.
1004 * Also removed some unused #includes.
1006 * Revision 1.24 2001/07/13 14:00:40 oes
1007 * - Generic content modification scheme:
1008 * Each feature has its own applicability flag that is set
1009 * from csp->action->flags.
1010 * Replaced the "filtering" int flag , by a function pointer
1011 * "content_filter" to the function that will do the content
1012 * modification. If it is != NULL, the document will be buffered
1013 * and processed through *content_filter, which must set
1014 * csp->content_length and return a modified copy of the body
1015 * or return NULL (on failiure).
1016 * - Changed csp->is_text to the more generic bitmap csp->content_type
1017 * which can currently take the valued CT_TEXT or CT_GIF
1018 * - Reformatting etc
1019 * - Removed all #ifdef PCRS
1021 * Revision 1.23 2001/07/02 02:28:25 iwanttokeepanon
1022 * Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
1023 * the `block_acl' call. This prevents a compilation error when the user
1024 * does not wish to use the "ACL" feature.
1026 * Revision 1.22 2001/06/29 21:45:41 oes
1027 * Indentation, CRLF->LF, Tab-> Space
1029 * Revision 1.21 2001/06/29 13:29:36 oes
1030 * - Cleaned up, improved comments
1031 * - Unified all possible interceptors (CGI,
1032 * block, trust, fast_redirect) in one
1033 * place, with one (CGI) answer generation
1034 * mechansim. Much clearer now.
1035 * - Removed the GIF image generation, which
1036 * is now done in filters.c:block_url()
1037 * - Made error conditions like domain lookup
1038 * failiure or (various) problems while talking
1039 * to the server use cgi.c:error_response()
1040 * instead of generating HTML/HTTP in chat() (yuck!)
1041 * - Removed logentry from cancelled commit
1043 * Revision 1.20 2001/06/09 10:55:28 jongfoster
1044 * Changing BUFSIZ ==> BUFFER_SIZE
1046 * Revision 1.19 2001/06/07 23:12:52 jongfoster
1047 * Replacing function pointer in struct gateway with a directly
1048 * called function forwarded_connect().
1049 * Replacing struct gateway with struct forward_spec
1051 * Revision 1.18 2001/06/03 19:12:16 oes
1052 * introduced new cgi handling
1054 * Revision 1.17 2001/06/01 20:07:23 jongfoster
1055 * Now uses action +image-blocker{} rather than config->tinygif
1057 * Revision 1.16 2001/06/01 18:49:17 jongfoster
1058 * Replaced "list_share" with "list" - the tiny memory gain was not
1059 * worth the extra complexity.
1061 * Revision 1.15 2001/05/31 21:24:47 jongfoster
1062 * Changed "permission" to "action" throughout.
1063 * Removed DEFAULT_USER_AGENT - it must now be specified manually.
1064 * Moved vanilla wafer check into chat(), since we must now
1065 * decide whether or not to add it based on the URL.
1067 * Revision 1.14 2001/05/29 20:14:01 joergs
1068 * AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
1071 * Revision 1.13 2001/05/29 09:50:24 jongfoster
1072 * Unified blocklist/imagelist/permissionslist.
1073 * File format is still under discussion, but the internal changes
1074 * are (mostly) done.
1076 * Also modified interceptor behaviour:
1077 * - We now intercept all URLs beginning with one of the following
1078 * prefixes (and *only* these prefixes):
1080 * * http://ijbswa.sf.net/config/
1081 * * http://ijbswa.sourceforge.net/config/
1082 * - New interceptors "home page" - go to http://i.j.b/ to see it.
1083 * - Internal changes so that intercepted and fast redirect pages
1084 * are not replaced with an image.
1085 * - Interceptors now have the option to send a binary page direct
1086 * to the client. (i.e. ijb-send-banner uses this)
1087 * - Implemented show-url-info interceptor. (Which is why I needed
1088 * the above interceptors changes - a typical URL is
1089 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
1090 * The previous mechanism would not have intercepted that, and
1091 * if it had been intercepted then it then it would have replaced
1092 * it with an image.)
1094 * Revision 1.12 2001/05/27 22:17:04 oes
1096 * - re_process_buffer no longer writes the modified buffer
1097 * to the client, which was very ugly. It now returns the
1098 * buffer, which it is then written by chat.
1100 * - content_length now adjusts the Content-Length: header
1101 * for modified documents rather than crunch()ing it.
1102 * (Length info in csp->content_length, which is 0 for
1103 * unmodified documents)
1105 * - For this to work, sed() is called twice when filtering.
1107 * Revision 1.11 2001/05/26 17:27:53 jongfoster
1108 * Added support for CLF and fixed LOG_LEVEL_LOG.
1109 * Also did CRLF->LF fix of my previous patch.
1111 * Revision 1.10 2001/05/26 15:26:15 jongfoster
1112 * ACL feature now provides more security by immediately dropping
1113 * connections from untrusted hosts.
1115 * Revision 1.9 2001/05/26 00:28:36 jongfoster
1116 * Automatic reloading of config file.
1117 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
1118 * Most of the global variables have been moved to a new
1119 * struct configuration_spec, accessed through csp->config->globalname
1120 * Most of the globals remaining are used by the Win32 GUI.
1122 * Revision 1.8 2001/05/25 22:43:18 jongfoster
1123 * Fixing minor memory leak and buffer overflow.
1125 * Revision 1.7 2001/05/25 22:34:30 jongfoster
1128 * Revision 1.6 2001/05/23 00:13:58 joergs
1129 * AmigaOS support fixed.
1131 * Revision 1.5 2001/05/22 18:46:04 oes
1133 * - Enabled filtering banners by size rather than URL
1134 * by adding patterns that replace all standard banner
1135 * sizes with the "Junkbuster" gif to the re_filterfile
1137 * - Enabled filtering WebBugs by providing a pattern
1138 * which kills all 1x1 images
1140 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
1141 * which is selected by the (nonstandard and therefore
1142 * capital) letter 'U' in the option string.
1143 * It causes the quantifiers to be ungreedy by default.
1144 * Appending a ? turns back to greedy (!).
1146 * - Added a new interceptor ijb-send-banner, which
1147 * sends back the "Junkbuster" gif. Without imagelist or
1148 * MSIE detection support, or if tinygif = 1, or the
1149 * URL isn't recognized as an imageurl, a lame HTML
1150 * explanation is sent instead.
1152 * - Added new feature, which permits blocking remote
1153 * script redirects and firing back a local redirect
1155 * The feature is conditionally compiled, i.e. it
1156 * can be disabled with --disable-fast-redirects,
1157 * plus it must be activated by a "fast-redirects"
1158 * line in the config file, has its own log level
1159 * and of course wants to be displayed by show-proxy-args
1160 * Note: Boy, all the #ifdefs in 1001 locations and
1161 * all the fumbling with configure.in and acconfig.h
1162 * were *way* more work than the feature itself :-(
1164 * - Because a generic redirect template was needed for
1165 * this, tinygif = 3 now uses the same.
1167 * - Moved GIFs, and other static HTTP response templates
1170 * - Some minor fixes
1172 * - Removed some >400 CRs again (Jon, you really worked
1175 * Revision 1.4 2001/05/21 19:34:01 jongfoster
1176 * Made failure to bind() a fatal error.
1178 * Revision 1.3 2001/05/20 01:21:20 jongfoster
1179 * Version 2.9.4 checkin.
1180 * - Merged popupfile and cookiefile, and added control over PCRS
1181 * filtering, in new "permissionsfile".
1182 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
1183 * file error you now get a message box (in the Win32 GUI) rather
1184 * than the program exiting with no explanation.
1185 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
1187 * - Removed tabs from "config"
1188 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
1189 * - Bumped up version number.
1191 * Revision 1.2 2001/05/17 22:34:44 oes
1192 * - Added hint on GIF char array generation to jcc.c
1193 * - Cleaned CRLF's from the sources and related files
1194 * - Repaired logging for REF and FRC
1196 * Revision 1.1.1.1 2001/05/15 13:58:56 oes
1197 * Initial import of version 2.9.3 source tree
1200 *********************************************************************/
1206 #include <sys/types.h>
1215 # ifndef FEATURE_PTHREAD
1219 # include <windows.h>
1220 # include <process.h>
1221 # endif /* ndef FEATURE_PTHREAD */
1224 # ifndef _WIN_CONSOLE
1225 # include "w32log.h"
1226 # endif /* ndef _WIN_CONSOLE */
1227 # include "w32svrapi.h"
1229 #else /* ifndef _WIN32 */
1231 # if !defined (__OS2__)
1232 # include <unistd.h>
1233 # include <sys/wait.h>
1234 # endif /* ndef __OS2__ */
1235 # include <sys/time.h>
1236 # include <sys/stat.h>
1237 # include <sys/ioctl.h>
1240 #include <sys/termios.h>
1248 # include <signal.h>
1251 # include <socket.h> /* BeOS has select() for sockets only. */
1252 # include <OS.h> /* declarations for threads and stuff. */
1255 # if defined(__EMX__) || defined(__OS2__)
1256 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
1261 #define bzero(B,N) memset(B,0x00,n)
1265 # include <select.h>
1270 #include "project.h"
1273 #include "filters.h"
1274 #include "loaders.h"
1275 #include "parsers.h"
1276 #include "miscutil.h"
1278 #include "jbsockets.h"
1279 #include "gateway.h"
1280 #include "actions.h"
1282 #include "loadcfg.h"
1283 #include "urlmatch.h"
1285 const char jcc_h_rcs[] = JCC_H_VERSION;
1286 const char project_h_rcs[] = PROJECT_H_VERSION;
1289 struct client_state clients[1];
1290 struct file_list files[1];
1292 #ifdef FEATURE_STATISTICS
1293 int urls_read = 0; /* total nr of urls read inc rejected */
1294 int urls_rejected = 0; /* total nr of urls rejected */
1295 #endif /* def FEATURE_STATISTICS */
1297 #ifdef FEATURE_GRACEFUL_TERMINATION
1298 int g_terminate = 0;
1301 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1302 static void sig_handler(int the_signal);
1304 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
1305 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
1306 static jb_err get_server_headers(struct client_state *csp);
1307 static const char *crunch_reason(const struct http_response *rsp);
1308 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp);
1309 static char *get_request_line(struct client_state *csp);
1310 static jb_err receive_client_request(struct client_state *csp);
1311 static jb_err parse_client_request(struct client_state *csp);
1312 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
1313 static jb_err change_request_destination(struct client_state *csp);
1314 static void chat(struct client_state *csp);
1315 static void serve(struct client_state *csp);
1316 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
1317 static void usage(const char *myname);
1319 static void initialize_mutexes(void);
1320 static jb_socket bind_port_helper(struct configuration_spec *config);
1321 static void listen_loop(void);
1324 void serve(struct client_state *csp);
1325 #else /* ifndef AMIGA */
1326 static void serve(struct client_state *csp);
1327 #endif /* def AMIGA */
1330 static int32 server_thread(void *data);
1331 #endif /* def __BEOS__ */
1334 #define sleep(N) Sleep(((N) * 1000))
1338 #define sleep(N) DosSleep(((N) * 100))
1341 #ifdef MUTEX_LOCKS_AVAILABLE
1343 * XXX: Does the locking stuff really belong in this file?
1345 privoxy_mutex_t log_mutex;
1346 privoxy_mutex_t log_init_mutex;
1347 privoxy_mutex_t connection_reuse_mutex;
1349 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
1350 privoxy_mutex_t resolver_mutex;
1351 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
1353 #ifndef HAVE_GMTIME_R
1354 privoxy_mutex_t gmtime_mutex;
1355 #endif /* ndef HAVE_GMTIME_R */
1357 #ifndef HAVE_LOCALTIME_R
1358 privoxy_mutex_t localtime_mutex;
1359 #endif /* ndef HAVE_GMTIME_R */
1362 privoxy_mutex_t rand_mutex;
1363 #endif /* ndef HAVE_RANDOM */
1365 #endif /* def MUTEX_LOCKS_AVAILABLE */
1368 const char *basedir = NULL;
1369 const char *pidfile = NULL;
1370 static int received_hup_signal = 0;
1371 #endif /* defined unix */
1373 /* HTTP snipplets. */
1374 static const char CSUCCEED[] =
1375 "HTTP/1.0 200 Connection established\r\n"
1376 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1378 static const char CHEADER[] =
1379 "HTTP/1.0 400 Invalid header received from client\r\n"
1380 "Proxy-Agent: Privoxy " VERSION "\r\n"
1381 "Content-Type: text/plain\r\n"
1382 "Connection: close\r\n\r\n"
1383 "Invalid header received from client.\r\n";
1385 static const char FTP_RESPONSE[] =
1386 "HTTP/1.0 400 Invalid request received from client\r\n"
1387 "Content-Type: text/plain\r\n"
1388 "Connection: close\r\n\r\n"
1389 "Invalid request. Privoxy doesn't support FTP.\r\n";
1391 static const char GOPHER_RESPONSE[] =
1392 "HTTP/1.0 400 Invalid request received from client\r\n"
1393 "Content-Type: text/plain\r\n"
1394 "Connection: close\r\n\r\n"
1395 "Invalid request. Privoxy doesn't support gopher.\r\n";
1397 /* XXX: should be a template */
1398 static const char MISSING_DESTINATION_RESPONSE[] =
1399 "HTTP/1.0 400 Bad request received from client\r\n"
1400 "Proxy-Agent: Privoxy " VERSION "\r\n"
1401 "Content-Type: text/plain\r\n"
1402 "Connection: close\r\n\r\n"
1403 "Bad request. Privoxy was unable to extract the destination.\r\n";
1405 /* XXX: should be a template */
1406 static const char NO_SERVER_DATA_RESPONSE[] =
1407 "HTTP/1.0 502 Server or forwarder response empty\r\n"
1408 "Proxy-Agent: Privoxy " VERSION "\r\n"
1409 "Content-Type: text/plain\r\n"
1410 "Connection: close\r\n\r\n"
1411 "Empty server or forwarder response.\r\n"
1412 "The connection has been closed but Privoxy didn't receive any data.\r\n";
1414 /* XXX: should be a template */
1415 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
1416 "HTTP/1.0 502 Server or forwarder response invalid\r\n"
1417 "Proxy-Agent: Privoxy " VERSION "\r\n"
1418 "Content-Type: text/plain\r\n"
1419 "Connection: close\r\n\r\n"
1420 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
1423 /* XXX: should be a template */
1424 static const char NULL_BYTE_RESPONSE[] =
1425 "HTTP/1.0 400 Bad request received from client\r\n"
1426 "Proxy-Agent: Privoxy " VERSION "\r\n"
1427 "Content-Type: text/plain\r\n"
1428 "Connection: close\r\n\r\n"
1429 "Bad request. Null byte(s) before end of request.\r\n";
1432 /* XXX: should be a template */
1433 static const char MESSED_UP_REQUEST_RESPONSE[] =
1434 "HTTP/1.0 400 Malformed request after rewriting\r\n"
1435 "Proxy-Agent: Privoxy " VERSION "\r\n"
1436 "Content-Type: text/plain\r\n"
1437 "Connection: close\r\n\r\n"
1438 "Bad request. Messed up with header filters.\r\n";
1440 /* XXX: should be a template */
1441 static const char CONNECTION_TIMEOUT_RESPONSE[] =
1442 "HTTP/1.0 502 Connection timeout\r\n"
1443 "Proxy-Agent: Privoxy " VERSION "\r\n"
1444 "Content-Type: text/plain\r\n"
1445 "Connection: close\r\n\r\n"
1446 "The connection timed out.\r\n";
1448 /* A function to crunch a response */
1449 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
1451 /* Crunch function flags */
1452 #define CF_NO_FLAGS 0
1453 /* Cruncher applies to forced requests as well */
1454 #define CF_IGNORE_FORCE 1
1455 /* Crunched requests are counted for the block statistics */
1456 #define CF_COUNT_AS_REJECT 2
1458 /* A crunch function and its flags */
1461 const crunch_func_ptr cruncher;
1465 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
1467 /* Complete list of cruncher functions */
1468 static const struct cruncher crunchers_all[] = {
1469 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
1470 { block_url, CF_COUNT_AS_REJECT },
1471 #ifdef FEATURE_TRUST
1472 { trust_url, CF_COUNT_AS_REJECT },
1473 #endif /* def FEATURE_TRUST */
1474 { redirect_url, CF_NO_FLAGS },
1475 { dispatch_cgi, CF_IGNORE_FORCE},
1479 /* Light version, used after tags are applied */
1480 static const struct cruncher crunchers_light[] = {
1481 { block_url, CF_COUNT_AS_REJECT },
1482 { redirect_url, CF_NO_FLAGS },
1488 * XXX: Don't we really mean
1494 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1495 /*********************************************************************
1497 * Function : sig_handler
1499 * Description : Signal handler for different signals.
1500 * Exit gracefully on TERM and INT
1501 * or set a flag that will cause the errlog
1502 * to be reopened by the main thread on HUP.
1505 * 1 : the_signal = the signal cause this function to call
1509 *********************************************************************/
1510 static void sig_handler(int the_signal)
1516 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
1528 received_hup_signal = 1;
1534 * We shouldn't be here, unless we catch signals
1535 * in main() that we can't handle here!
1537 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
1545 /*********************************************************************
1547 * Function : client_protocol_is_unsupported
1549 * Description : Checks if the client used a known unsupported
1550 * protocol and deals with it by sending an error
1554 * 1 : csp = Current client state (buffers, headers, etc...)
1555 * 2 : req = the first request line send by the client
1557 * Returns : TRUE if an error response has been generated, or
1558 * FALSE if the request doesn't look invalid.
1560 *********************************************************************/
1561 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
1564 * If it's a FTP or gopher request, we don't support it.
1566 * These checks are better than nothing, but they might
1567 * not work in all configurations and some clients might
1568 * have problems digesting the answer.
1570 * They should, however, never cause more problems than
1571 * Privoxy's old behaviour (returning the misleading HTML
1574 * "Could not resolve http://(ftp|gopher)://example.org").
1576 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
1578 const char *response = NULL;
1579 const char *protocol = NULL;
1581 if (!strncmpic(req, "GET ftp://", 10))
1583 response = FTP_RESPONSE;
1588 response = GOPHER_RESPONSE;
1589 protocol = "GOPHER";
1591 log_error(LOG_LEVEL_ERROR,
1592 "%s tried to use Privoxy as %s proxy: %s",
1593 csp->ip_addr_str, protocol, req);
1594 log_error(LOG_LEVEL_CLF,
1595 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
1597 write_socket(csp->cfd, response, strlen(response));
1606 /*********************************************************************
1608 * Function : get_request_destination_elsewhere
1610 * Description : If the client's request was redirected into
1611 * Privoxy without the client's knowledge,
1612 * the request line lacks the destination host.
1614 * This function tries to get it elsewhere,
1615 * provided accept-intercepted-requests is enabled.
1617 * "Elsewhere" currently only means "Host: header",
1618 * but in the future we may ask the redirecting
1619 * packet filter to look the destination up.
1621 * If the destination stays unknown, an error
1622 * response is send to the client and headers
1623 * are freed so that chat() can return directly.
1626 * 1 : csp = Current client state (buffers, headers, etc...)
1627 * 2 : headers = a header list
1629 * Returns : JB_ERR_OK if the destination is now known, or
1630 * JB_ERR_PARSE if it isn't.
1632 *********************************************************************/
1633 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
1637 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
1639 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
1640 " Privoxy isn't configured to accept intercepted requests.",
1641 csp->ip_addr_str, csp->http->cmd);
1642 /* XXX: Use correct size */
1643 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1644 csp->ip_addr_str, csp->http->cmd);
1646 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1647 destroy_list(headers);
1649 return JB_ERR_PARSE;
1651 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
1653 /* Split the domain we just got for pattern matching */
1654 init_domain_components(csp->http);
1660 /* We can't work without destination. Go spread the news.*/
1662 req = list_to_text(headers);
1664 /* XXX: Use correct size */
1665 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1666 csp->ip_addr_str, csp->http->cmd);
1667 log_error(LOG_LEVEL_ERROR,
1668 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
1669 csp->ip_addr_str, csp->http->cmd, req);
1672 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
1673 destroy_list(headers);
1675 return JB_ERR_PARSE;
1678 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
1679 * to get the destination IP address, use it as host directly
1680 * or do a reverse DNS lookup first.
1685 /*********************************************************************
1687 * Function : get_server_headers
1689 * Description : Parses server headers in iob and fills them
1690 * into csp->headers so that they can later be
1694 * 1 : csp = Current client state (buffers, headers, etc...)
1696 * Returns : JB_ERR_OK if everything went fine, or
1697 * JB_ERR_PARSE if the headers were incomplete.
1699 *********************************************************************/
1700 static jb_err get_server_headers(struct client_state *csp)
1702 int continue_hack_in_da_house = 0;
1705 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
1710 * continue hack in da house. Ignore the ending of
1711 * this head and continue enlisting header lines.
1712 * The reason is described below.
1714 enlist(csp->headers, "");
1715 continue_hack_in_da_house = 0;
1718 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
1721 * It's a bodyless continue response, don't
1722 * stop header parsing after reaching its end.
1724 * As a result Privoxy will concatenate the
1725 * next response's head and parse and deliver
1726 * the headers as if they belonged to one request.
1728 * The client will separate them because of the
1729 * empty line between them.
1731 * XXX: What we're doing here is clearly against
1732 * the intended purpose of the continue header,
1733 * and under some conditions (HTTP/1.0 client request)
1734 * it's a standard violation.
1736 * Anyway, "sort of against the spec" is preferable
1737 * to "always getting confused by Continue responses"
1738 * (Privoxy's behaviour before this hack was added)
1740 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
1741 continue_hack_in_da_house = 1;
1743 else if (*header == '\0')
1746 * If the header is empty, but the Continue hack
1747 * isn't active, we can assume that we reached the
1748 * end of the buffer before we hit the end of the
1751 * Inform the caller an let it decide how to handle it.
1753 return JB_ERR_PARSE;
1756 if (JB_ERR_MEMORY == enlist(csp->headers, header))
1759 * XXX: Should we quit the request and return a
1760 * out of memory error page instead?
1762 log_error(LOG_LEVEL_ERROR,
1763 "Out of memory while enlisting server headers. %s lost.",
1773 /*********************************************************************
1775 * Function : crunch_reason
1777 * Description : Translates the crunch reason code into a string.
1780 * 1 : rsp = a http_response
1782 * Returns : A string with the crunch reason or an error description.
1784 *********************************************************************/
1785 static const char *crunch_reason(const struct http_response *rsp)
1787 char * reason = NULL;
1789 assert(rsp != NULL);
1792 return "Internal error while searching for crunch reason";
1795 switch (rsp->reason)
1797 case RSP_REASON_UNSUPPORTED:
1798 reason = "Unsupported HTTP feature";
1800 case RSP_REASON_BLOCKED:
1803 case RSP_REASON_UNTRUSTED:
1804 reason = "Untrusted";
1806 case RSP_REASON_REDIRECTED:
1807 reason = "Redirected";
1809 case RSP_REASON_CGI_CALL:
1810 reason = "CGI Call";
1812 case RSP_REASON_NO_SUCH_DOMAIN:
1813 reason = "DNS failure";
1815 case RSP_REASON_FORWARDING_FAILED:
1816 reason = "Forwarding failed";
1818 case RSP_REASON_CONNECT_FAILED:
1819 reason = "Connection failure";
1821 case RSP_REASON_OUT_OF_MEMORY:
1822 reason = "Out of memory (may mask other reasons)";
1825 reason = "No reason recorded";
1833 /*********************************************************************
1835 * Function : send_crunch_response
1837 * Description : Delivers already prepared response for
1838 * intercepted requests, logs the interception
1839 * and frees the response.
1842 * 1 : csp = Current client state (buffers, headers, etc...)
1843 * 1 : rsp = Fully prepared response. Will be freed on exit.
1845 * Returns : Nothing.
1847 *********************************************************************/
1848 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
1850 const struct http_request *http = csp->http;
1851 char status_code[4];
1853 assert(rsp != NULL);
1854 assert(rsp->head != NULL);
1859 * Not supposed to happen. If it does
1860 * anyway, treat it as an unknown error.
1862 cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
1863 /* return code doesn't matter */
1868 /* If rsp is still NULL, we have serious internal problems. */
1869 log_error(LOG_LEVEL_FATAL,
1870 "NULL response in send_crunch_response and cgi_error_unknown failed as well.");
1874 * Extract the status code from the actual head
1875 * that was send to the client. It is the only
1876 * way to get it right for all requests, including
1877 * the fixed ones for out-of-memory problems.
1879 * A head starts like this: 'HTTP/1.1 200...'
1883 status_code[0] = rsp->head[9];
1884 status_code[1] = rsp->head[10];
1885 status_code[2] = rsp->head[11];
1886 status_code[3] = '\0';
1888 /* Write the answer to the client */
1889 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1890 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1892 /* There is nothing we can do about it. */
1893 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
1896 /* Log that the request was crunched and why. */
1897 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
1898 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
1899 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
1901 /* Clean up and return */
1902 if (cgi_error_memory() != rsp)
1904 free_http_response(rsp);
1911 /*********************************************************************
1913 * Function : request_contains_null_bytes
1915 * Description : Checks for NULL bytes in the request and sends
1916 * an error message to the client if any were found.
1918 * XXX: currently not used, see comment in chat().
1921 * 1 : csp = Current client state (buffers, headers, etc...)
1922 * 2 : buf = Data from the client's request to check.
1923 * 3 : len = The data length.
1925 * Returns : TRUE if the request contained one or more NULL bytes, or
1928 *********************************************************************/
1929 static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len)
1931 size_t c_len; /* Request lenght when treated as C string */
1933 c_len = strlen(buf);
1938 * Null byte(s) found. Log the request,
1939 * return an error response and hang up.
1941 size_t tmp_len = c_len;
1946 * Replace NULL byte(s) with '°' characters
1947 * so the request can be logged as string.
1948 * XXX: Is there a better replacement character?
1951 tmp_len += strlen(buf+tmp_len);
1952 } while (tmp_len < len);
1954 log_error(LOG_LEVEL_ERROR, "%s\'s request contains at least one NULL byte "
1955 "(length=%d, strlen=%u).", csp->ip_addr_str, len, c_len);
1956 log_error(LOG_LEVEL_HEADER,
1957 "Offending request data with NULL bytes turned into \'°\' characters: %s", buf);
1959 write_socket(csp->cfd, NULL_BYTE_RESPONSE, strlen(NULL_BYTE_RESPONSE));
1961 /* XXX: Log correct size */
1962 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1972 /*********************************************************************
1974 * Function : crunch_response_triggered
1976 * Description : Checks if the request has to be crunched,
1977 * and delivers the crunch response if necessary.
1980 * 1 : csp = Current client state (buffers, headers, etc...)
1981 * 2 : crunchers = list of cruncher functions to run
1983 * Returns : TRUE if the request was answered with a crunch response
1986 *********************************************************************/
1987 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
1989 struct http_response *rsp = NULL;
1990 const struct cruncher *c;
1993 * If CGI request crunching is disabled,
1994 * check the CGI dispatcher out of order to
1995 * prevent unintentional blocks or redirects.
1997 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
1998 && (NULL != (rsp = dispatch_cgi(csp))))
2000 /* Deliver, log and free the interception response. */
2001 send_crunch_response(csp, rsp);
2005 for (c = crunchers; c->cruncher != NULL; c++)
2008 * Check the cruncher if either Privoxy is toggled
2009 * on and the request isn't forced, or if the cruncher
2010 * applies to forced requests as well.
2012 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
2013 !(csp->flags & CSP_FLAG_FORCED)) ||
2014 (c->flags & CF_IGNORE_FORCE))
2016 rsp = c->cruncher(csp);
2019 /* Deliver, log and free the interception response. */
2020 send_crunch_response(csp, rsp);
2021 #ifdef FEATURE_STATISTICS
2022 if (c->flags & CF_COUNT_AS_REJECT)
2024 csp->flags |= CSP_FLAG_REJECTED;
2026 #endif /* def FEATURE_STATISTICS */
2037 /*********************************************************************
2039 * Function : build_request_line
2041 * Description : Builds the HTTP request line.
2043 * If a HTTP forwarder is used it expects the whole URL,
2044 * web servers only get the path.
2047 * 1 : csp = Current client state (buffers, headers, etc...)
2048 * 2 : fwd = The forwarding spec used for the request
2049 * XXX: Should use http->fwd instead.
2050 * 3 : request_line = The old request line which will be replaced.
2052 * Returns : Nothing. Terminates in case of memory problems.
2054 *********************************************************************/
2055 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
2057 struct http_request *http = csp->http;
2059 assert(http->ssl == 0);
2062 * Downgrade http version from 1.1 to 1.0
2063 * if +downgrade action applies.
2065 if ( (csp->action->flags & ACTION_DOWNGRADE)
2066 && (!strcmpic(http->ver, "HTTP/1.1")))
2069 http->ver = strdup("HTTP/1.0");
2071 if (http->ver == NULL)
2073 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
2078 * Rebuild the request line.
2080 freez(*request_line);
2081 *request_line = strdup(http->gpc);
2082 string_append(request_line, " ");
2084 if (fwd->forward_host)
2086 string_append(request_line, http->url);
2090 string_append(request_line, http->path);
2092 string_append(request_line, " ");
2093 string_append(request_line, http->ver);
2095 if (*request_line == NULL)
2097 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
2099 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
2103 /*********************************************************************
2105 * Function : change_request_destination
2107 * Description : Parse a (rewritten) request line and regenerate
2108 * the http request data.
2111 * 1 : csp = Current client state (buffers, headers, etc...)
2113 * Returns : Forwards the parse_http_request() return code.
2114 * Terminates in case of memory problems.
2116 *********************************************************************/
2117 static jb_err change_request_destination(struct client_state *csp)
2119 struct http_request *http = csp->http;
2122 log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
2123 free_http_request(http);
2124 err = parse_http_request(csp->headers->first->str, http);
2125 if (JB_ERR_OK != err)
2127 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
2128 jb_err_to_string(err));
2132 /* XXX: ocmd is a misleading name */
2133 http->ocmd = strdup(http->cmd);
2134 if (http->ocmd == NULL)
2136 log_error(LOG_LEVEL_FATAL,
2137 "Out of memory copying rewritten HTTP request line");
2145 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2146 /*********************************************************************
2148 * Function : server_response_is_complete
2150 * Description : Determines whether we should stop reading
2151 * from the server socket.
2154 * 1 : csp = Current client state (buffers, headers, etc...)
2155 * 2 : content_length = Length of content received so far.
2157 * Returns : TRUE if the response is complete,
2160 *********************************************************************/
2161 static int server_response_is_complete(struct client_state *csp, size_t content_length)
2163 int content_length_known = (csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
2165 if (!strcmpic(csp->http->gpc, "HEAD"))
2168 * "HEAD" implies no body, we are thus expecting
2169 * no content. XXX: incomplete "list" of methods?
2171 csp->expected_content_length = 0;
2172 content_length_known = TRUE;
2175 if (csp->http->status == 304)
2178 * Expect no body. XXX: incomplete "list" of status codes?
2180 csp->expected_content_length = 0;
2181 content_length_known = TRUE;
2184 return (content_length_known && ((0 == csp->expected_content_length)
2185 || (csp->expected_content_length <= content_length)));
2189 /*********************************************************************
2191 * Function : wait_for_alive_connections
2193 * Description : Waits for alive connections to timeout.
2199 *********************************************************************/
2200 static void wait_for_alive_connections()
2202 int connections_alive = close_unusable_connections();
2204 while (0 < connections_alive)
2206 log_error(LOG_LEVEL_CONNECT,
2207 "Waiting for %d connections to timeout.",
2210 connections_alive = close_unusable_connections();
2213 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
2216 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2219 /*********************************************************************
2221 * Function : mark_server_socket_tainted
2223 * Description : Makes sure we don't reuse a server socket
2224 * (if we didn't read everything the server sent
2225 * us reusing the socket would lead to garbage).
2228 * 1 : csp = Current client state (buffers, headers, etc...)
2232 *********************************************************************/
2233 static void mark_server_socket_tainted(struct client_state *csp)
2235 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
2237 log_error(LOG_LEVEL_CONNECT, "Unsetting keep-alive flag.");
2238 csp->flags &= ~CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
2242 /*********************************************************************
2244 * Function : get_request_line
2246 * Description : Read the client request line.
2249 * 1 : csp = Current client state (buffers, headers, etc...)
2251 * Returns : Pointer to request line or NULL in case of errors.
2253 *********************************************************************/
2254 static char *get_request_line(struct client_state *csp)
2256 char buf[BUFFER_SIZE];
2257 char *request_line = NULL;
2260 memset(buf, 0, sizeof(buf));
2264 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
2266 log_error(LOG_LEVEL_ERROR,
2267 "Stopped waiting for the request line.");
2268 write_socket(csp->cfd, CONNECTION_TIMEOUT_RESPONSE,
2269 strlen(CONNECTION_TIMEOUT_RESPONSE));
2273 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2275 if (len <= 0) return NULL;
2278 * If there is no memory left for buffering the
2279 * request, there is nothing we can do but hang up
2281 if (add_to_iob(csp, buf, len))
2286 request_line = get_header(csp->iob);
2288 } while ((NULL != request_line) && ('\0' == *request_line));
2290 return request_line;
2295 /*********************************************************************
2297 * Function : receive_client_request
2299 * Description : Read the client's request (more precisely the
2300 * client headers) and answer it if necessary.
2302 * Note that since we're not using select() we could get
2303 * blocked here if a client connected, then didn't say
2307 * 1 : csp = Current client state (buffers, headers, etc...)
2309 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
2311 *********************************************************************/
2312 static jb_err receive_client_request(struct client_state *csp)
2314 char buf[BUFFER_SIZE];
2317 struct http_request *http;
2321 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
2322 struct list header_list;
2323 struct list *headers = &header_list;
2327 memset(buf, 0, sizeof(buf));
2329 req = get_request_line(csp);
2332 return JB_ERR_PARSE;
2334 assert(*req != '\0');
2336 if (client_protocol_is_unsupported(csp, req))
2338 return JB_ERR_PARSE;
2341 #ifdef FEATURE_FORCE_LOAD
2343 * If this request contains the FORCE_PREFIX and blocks
2344 * aren't enforced, get rid of it and set the force flag.
2346 if (strstr(req, FORCE_PREFIX))
2348 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
2350 log_error(LOG_LEVEL_FORCE,
2351 "Ignored force prefix in request: \"%s\".", req);
2355 strclean(req, FORCE_PREFIX);
2356 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
2357 csp->flags |= CSP_FLAG_FORCED;
2360 #endif /* def FEATURE_FORCE_LOAD */
2362 err = parse_http_request(req, http);
2364 if (JB_ERR_OK != err)
2366 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
2367 /* XXX: Use correct size */
2368 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2369 log_error(LOG_LEVEL_ERROR,
2370 "Couldn't parse request line received from %s: %s",
2371 csp->ip_addr_str, jb_err_to_string(err));
2373 free_http_request(http);
2374 return JB_ERR_PARSE;
2377 /* grab the rest of the client's headers */
2381 p = get_header(csp->iob);
2385 /* There are no additional headers to read. */
2392 * We didn't receive a complete header
2393 * line yet, get the rest of it.
2395 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
2397 log_error(LOG_LEVEL_ERROR,
2398 "Stopped grabbing the client headers.");
2399 return JB_ERR_PARSE;
2402 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2405 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
2406 destroy_list(headers);
2407 return JB_ERR_PARSE;
2410 if (add_to_iob(csp, buf, len))
2413 * If there is no memory left for buffering the
2414 * request, there is nothing we can do but hang up
2416 destroy_list(headers);
2417 return JB_ERR_MEMORY;
2423 * We were able to read a complete
2424 * header and can finaly enlist it.
2431 if (http->host == NULL)
2434 * If we still don't know the request destination,
2435 * the request is invalid or the client uses
2436 * Privoxy without its knowledge.
2438 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
2441 * Our attempts to get the request destination
2442 * elsewhere failed or Privoxy is configured
2443 * to only accept proxy requests.
2445 * An error response has already been send
2446 * and we're done here.
2448 return JB_ERR_PARSE;
2453 * Determine the actions for this URL
2455 #ifdef FEATURE_TOGGLE
2456 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
2458 /* Most compatible set of actions (i.e. none) */
2459 init_current_action(csp->action);
2462 #endif /* ndef FEATURE_TOGGLE */
2464 get_url_actions(csp, http);
2468 * Save a copy of the original request for logging
2470 http->ocmd = strdup(http->cmd);
2471 if (http->ocmd == NULL)
2473 log_error(LOG_LEVEL_FATAL,
2474 "Out of memory copying HTTP request line");
2476 enlist(csp->headers, http->cmd);
2478 /* Append the previously read headers */
2479 list_append_list_unique(csp->headers, headers);
2480 destroy_list(headers);
2487 /*********************************************************************
2489 * Function : parse_client_request
2491 * Description : Parses the client's request and decides what to do
2494 * Note that since we're not using select() we could get
2495 * blocked here if a client connected, then didn't say
2499 * 1 : csp = Current client state (buffers, headers, etc...)
2501 * Returns : JB_ERR_OK or JB_ERR_PARSE
2503 *********************************************************************/
2504 static jb_err parse_client_request(struct client_state *csp)
2506 struct http_request *http = csp->http;
2509 err = sed(csp, FILTER_CLIENT_HEADERS);
2510 if (JB_ERR_OK != err)
2512 /* XXX: Should be handled in sed(). */
2513 assert(err == JB_ERR_PARSE);
2514 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
2516 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
2518 /* Check request line for rewrites. */
2519 if ((NULL == csp->headers->first->str)
2520 || (strcmp(http->cmd, csp->headers->first->str) &&
2521 (JB_ERR_OK != change_request_destination(csp))))
2524 * A header filter broke the request line - bail out.
2526 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
2527 /* XXX: Use correct size */
2528 log_error(LOG_LEVEL_CLF,
2529 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
2530 log_error(LOG_LEVEL_ERROR,
2531 "Invalid request line after applying header filters.");
2532 free_http_request(http);
2534 return JB_ERR_PARSE;
2542 /*********************************************************************
2546 * Description : Once a connection to the client has been accepted,
2547 * this function is called (via serve()) to handle the
2548 * main business of the communication. When this
2549 * function returns, the caller must close the client
2552 * FIXME: chat is nearly thousand lines long.
2556 * 1 : csp = Current client state (buffers, headers, etc...)
2558 * Returns : Nothing.
2560 *********************************************************************/
2561 static void chat(struct client_state *csp)
2563 char buf[BUFFER_SIZE];
2570 int ms_iis5_hack = 0;
2571 size_t byte_count = 0;
2572 int forwarded_connect_retries = 0;
2573 int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
2574 const struct forward_spec *fwd;
2575 struct http_request *http;
2576 int len = 0; /* for buffer sizes (and negative error codes) */
2578 /* Function that does the content filtering for the current request */
2579 filter_function_ptr content_filter = NULL;
2581 /* Skeleton for HTTP response, if we should intercept the request */
2582 struct http_response *rsp;
2583 struct timeval timeout;
2585 memset(buf, 0, sizeof(buf));
2586 memset(&timeout, 0, sizeof(timeout));
2587 timeout.tv_sec = csp->config->socket_timeout;
2591 if (receive_client_request(csp) != JB_ERR_OK)
2595 if (parse_client_request(csp) != JB_ERR_OK)
2600 /* decide how to route the HTTP request */
2601 fwd = forward_url(csp, http);
2604 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
2605 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2610 * build the http request to send to the server
2611 * we have to do one of the following:
2613 * create = use the original HTTP request to create a new
2614 * HTTP request that has either the path component
2615 * without the http://domainspec (w/path) or the
2616 * full orininal URL (w/url)
2617 * Note that the path and/or the HTTP version may
2618 * have been altered by now.
2620 * connect = Open a socket to the host:port of the server
2621 * and short-circuit server and client socket.
2623 * pass = Pass the request unchanged if forwarding a CONNECT
2624 * request to a parent proxy. Note that we'll be sending
2625 * the CFAIL message ourselves if connecting to the parent
2626 * fails, but we won't send a CSUCCEED message if it works,
2627 * since that would result in a double message (ours and the
2628 * parent's). After sending the request to the parent, we simply
2631 * here's the matrix:
2634 * +--------+--------+
2636 * 0 | create | connect|
2638 * Forwarding +--------+--------+
2640 * 1 | create | pass |
2642 * +--------+--------+
2646 if (http->ssl && connect_port_is_forbidden(csp))
2648 const char *acceptable_connect_ports =
2649 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
2650 assert(NULL != acceptable_connect_ports);
2651 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
2652 "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
2653 csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
2654 csp->action->flags |= ACTION_BLOCK;
2660 freez(csp->headers->first->str);
2661 build_request_line(csp, fwd, &csp->headers->first->str);
2665 * We have a request. Check if one of the crunchers wants it.
2667 if (crunch_response_triggered(csp, crunchers_all))
2670 * Yes. The client got the crunch response
2671 * and we are done here after cleaning up.
2673 /* XXX: why list_remove_all()? */
2674 list_remove_all(csp->headers);
2679 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
2681 if (fwd->forward_host)
2683 log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
2684 fwd->forward_host, fwd->forward_port, http->hostport);
2688 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
2691 /* here we connect to the server, gateway, or the forwarder */
2693 while ((csp->sfd = forwarded_connect(fwd, http, csp))
2694 && (errno == EINVAL)
2695 && (forwarded_connect_retries++ < max_forwarded_connect_retries))
2697 log_error(LOG_LEVEL_ERROR,
2698 "failed request #%u to connect to %s. Trying again.",
2699 forwarded_connect_retries, http->hostport);
2702 if (csp->sfd == JB_INVALID_SOCKET)
2704 if (fwd->type != SOCKS_NONE)
2707 rsp = error_response(csp, "forwarding-failed", errno);
2709 else if (errno == EINVAL)
2711 rsp = error_response(csp, "no-such-domain", errno);
2715 rsp = error_response(csp, "connect-failed", errno);
2716 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
2720 /* Write the answer to the client */
2723 send_crunch_response(csp, rsp);
2729 hdr = list_to_text(csp->headers);
2732 /* FIXME Should handle error properly */
2733 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2735 list_remove_all(csp->headers);
2737 if (fwd->forward_host || (http->ssl == 0))
2740 * Write the client's (modified) header to the server
2741 * (along with anything else that may be in the buffer)
2743 if (write_socket(csp->sfd, hdr, strlen(hdr))
2744 || (flush_socket(csp->sfd, csp->iob) < 0))
2746 log_error(LOG_LEVEL_CONNECT,
2747 "write header to: %s failed: %E", http->hostport);
2749 rsp = error_response(csp, "connect-failed", errno);
2752 send_crunch_response(csp, rsp);
2762 * We're running an SSL tunnel and we're not forwarding,
2763 * so just send the "connect succeeded" message to the
2764 * client, flush the rest, and get out of the way.
2766 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
2774 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
2776 /* we're finished with the client's header */
2779 maxfd = (csp->cfd > csp->sfd) ? csp->cfd : csp->sfd;
2781 /* pass data between the client and server
2782 * until one or the other shuts down the connection.
2791 * FD_ZERO here seems to point to an errant macro which crashes.
2792 * So do this by hand for now...
2794 memset(&rfds,0x00,sizeof(fd_set));
2798 FD_SET(csp->cfd, &rfds);
2799 FD_SET(csp->sfd, &rfds);
2801 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2802 if ((csp->flags & CSP_FLAG_CHUNKED)
2803 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2804 && ((csp->iob->eod - csp->iob->cur) >= 5)
2805 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2807 log_error(LOG_LEVEL_CONNECT,
2808 "Looks like we read the last chunk together with "
2809 "the server headers. We better stop reading.");
2810 byte_count = (size_t)(csp->iob->eod - csp->iob->cur);
2811 csp->expected_content_length = byte_count;
2812 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2814 if (server_body && server_response_is_complete(csp, byte_count))
2816 log_error(LOG_LEVEL_CONNECT,
2817 "Done reading from server. Expected content length: %u. "
2818 "Actual content length: %u. Most recently received: %d.",
2819 csp->expected_content_length, byte_count, len);
2822 * XXX: should not jump around,
2823 * chat() is complicated enough already.
2827 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2829 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
2833 log_error(LOG_LEVEL_ERROR,
2834 "Didn't receive data in time: %s", http->url);
2835 if ((byte_count == 0) && (http->ssl == 0))
2837 write_socket(csp->cfd, CONNECTION_TIMEOUT_RESPONSE,
2838 strlen(CONNECTION_TIMEOUT_RESPONSE));
2840 mark_server_socket_tainted(csp);
2845 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2846 mark_server_socket_tainted(csp);
2851 * This is the body of the browser's request,
2852 * just read and write it.
2854 if (FD_ISSET(csp->cfd, &rfds))
2856 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2860 /* XXX: not sure if this is necessary. */
2861 mark_server_socket_tainted(csp);
2862 break; /* "game over, man" */
2865 if (write_socket(csp->sfd, buf, (size_t)len))
2867 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2868 mark_server_socket_tainted(csp);
2875 * The server wants to talk. It could be the header or the body.
2876 * If `hdr' is null, then it's the header otherwise it's the body.
2877 * FIXME: Does `hdr' really mean `host'? No.
2879 if (FD_ISSET(csp->sfd, &rfds))
2882 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
2886 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2888 if (http->ssl && (fwd->forward_host == NULL))
2891 * Just hang up. We already confirmed the client's CONNECT
2892 * request with status code 200 and unencrypted content is
2893 * no longer welcome.
2895 log_error(LOG_LEVEL_ERROR,
2896 "CONNECT already confirmed. Unable to tell the client about the problem.");
2899 else if (byte_count)
2902 * Just hang up. We already transmitted the original headers
2903 * and parts of the original content and therefore missed the
2904 * chance to send an error message (without risking data corruption).
2906 * XXX: we could retry with a fancy range request here.
2908 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2909 "Unable to tell the client about the problem.");
2910 mark_server_socket_tainted(csp);
2914 rsp = error_response(csp, "connect-failed", errno);
2917 send_crunch_response(csp, rsp);
2923 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2924 if (csp->flags & CSP_FLAG_CHUNKED)
2926 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2928 /* XXX: this is a temporary hack */
2929 log_error(LOG_LEVEL_CONNECT,
2930 "Looks like we reached the end of the last chunk. "
2931 "We better stop reading.");
2932 csp->expected_content_length = byte_count + (size_t)len;
2933 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2937 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2940 * Add a trailing zero to let be able to use string operations.
2941 * XXX: do we still need this with filter_popups gone?
2946 * Normally, this would indicate that we've read
2947 * as much as the server has sent us and we can
2948 * close the client connection. However, Microsoft
2949 * in its wisdom has released IIS/5 with a bug that
2950 * prevents it from sending the trailing \r\n in
2951 * a 302 redirect header (and possibly other headers).
2952 * To work around this if we've haven't parsed
2953 * a full header we'll append a trailing \r\n
2954 * and see if this now generates a valid one.
2956 * This hack shouldn't have any impacts. If we've
2957 * already transmitted the header or if this is a
2958 * SSL connection, then we won't bother with this
2959 * hack. So we only work on partially received
2960 * headers. If we append a \r\n and this still
2961 * doesn't generate a valid header, then we won't
2962 * transmit anything to the client.
2967 if (server_body || http->ssl)
2970 * If we have been buffering up the document,
2971 * now is the time to apply content modification
2972 * and send the result to the client.
2976 p = execute_content_filter(csp, content_filter);
2978 * If the content filter fails, use the original
2979 * buffer and length.
2980 * (see p != NULL ? p : csp->iob->cur below)
2984 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2987 if (JB_ERR_OK != update_server_headers(csp))
2989 log_error(LOG_LEVEL_FATAL,
2990 "Failed to update server headers. after filtering.");
2993 hdr = list_to_text(csp->headers);
2996 /* FIXME Should handle error properly */
2997 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3000 if (write_socket(csp->cfd, hdr, strlen(hdr))
3001 || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
3003 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
3006 mark_server_socket_tainted(csp);
3014 break; /* "game over, man" */
3018 * This is NOT the body, so
3019 * Let's pretend the server just sent us a blank line.
3021 snprintf(buf, sizeof(buf), "\r\n");
3022 len = (int)strlen(buf);
3025 * Now, let the normal header parsing algorithm below do its
3026 * job. If it fails, we'll exit instead of continuing.
3033 * If this is an SSL connection or we're in the body
3034 * of the server document, just write it to the client,
3035 * unless we need to buffer the body for later content-filtering
3037 if (server_body || http->ssl)
3042 * If there is no memory left for buffering the content, or the buffer limit
3043 * has been reached, switch to non-filtering mode, i.e. make & write the
3044 * header, flush the iob and buf, and get out of the way.
3046 if (add_to_iob(csp, buf, len))
3051 log_error(LOG_LEVEL_INFO,
3052 "Flushing header and buffers. Stepping back from filtering.");
3054 hdr = list_to_text(csp->headers);
3058 * Memory is too tight to even generate the header.
3059 * Send our static "Out-of-memory" page.
3061 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3062 rsp = cgi_error_memory();
3063 send_crunch_response(csp, rsp);
3064 mark_server_socket_tainted(csp);
3067 hdrlen = strlen(hdr);
3069 if (write_socket(csp->cfd, hdr, hdrlen)
3070 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
3071 || (write_socket(csp->cfd, buf, (size_t)len)))
3073 log_error(LOG_LEVEL_CONNECT,
3074 "Flush header and buffers to client failed: %E");
3076 mark_server_socket_tainted(csp);
3081 * Reset the byte_count to the amount of bytes
3082 * we just flushed. len will be added a few lines below,
3083 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3085 byte_count = (size_t)flushed;
3087 content_filter = NULL;
3093 if (write_socket(csp->cfd, buf, (size_t)len))
3095 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3096 mark_server_socket_tainted(csp);
3100 byte_count += (size_t)len;
3105 const char *header_start;
3107 * We're still looking for the end of the server's header.
3108 * Buffer up the data we just read. If that fails, there's
3109 * little we can do but send our static out-of-memory page.
3111 if (add_to_iob(csp, buf, len))
3113 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3114 rsp = cgi_error_memory();
3115 send_crunch_response(csp, rsp);
3116 mark_server_socket_tainted(csp);
3120 header_start = csp->iob->cur;
3122 /* Convert iob into something sed() can digest */
3123 if (JB_ERR_PARSE == get_server_headers(csp))
3128 * Well, we tried our MS IIS/5 hack and it didn't work.
3129 * The header is incomplete and there isn't anything
3130 * we can do about it.
3132 log_error(LOG_LEVEL_INFO,
3133 "MS IIS5 hack didn't produce valid headers.");
3139 * Since we have to wait for more from the server before
3140 * we can parse the headers we just continue here.
3142 int header_offset = csp->iob->cur - header_start;
3143 assert(csp->iob->cur >= header_start);
3144 byte_count += (size_t)(len - header_offset);
3145 log_error(LOG_LEVEL_CONNECT, "Continuing buffering headers. "
3146 "byte_count: %u. header_offset: %d. len: %d.",
3147 byte_count, header_offset, len);
3152 /* Did we actually get anything? */
3153 if (NULL == csp->headers->first)
3155 log_error(LOG_LEVEL_ERROR, "Empty server or forwarder response.");
3156 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3157 write_socket(csp->cfd, NO_SERVER_DATA_RESPONSE, strlen(NO_SERVER_DATA_RESPONSE));
3158 free_http_request(http);
3159 mark_server_socket_tainted(csp);
3163 assert(csp->headers->first->str);
3165 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3166 strncmpic(csp->headers->first->str, "ICY", 3))
3169 * It doesn't look like a HTTP (or Shoutcast) response:
3170 * tell the client and log the problem.
3172 if (strlen(csp->headers->first->str) > 30)
3174 csp->headers->first->str[30] = '\0';
3176 log_error(LOG_LEVEL_ERROR,
3177 "Invalid server or forwarder response. Starts with: %s",
3178 csp->headers->first->str);
3179 log_error(LOG_LEVEL_CLF,
3180 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3181 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3182 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3183 free_http_request(http);
3184 mark_server_socket_tainted(csp);
3189 * We have now received the entire server header,
3190 * filter it and send the result to the client
3192 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3194 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
3196 hdr = list_to_text(csp->headers);
3199 /* FIXME Should handle error properly */
3200 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3203 if (crunch_response_triggered(csp, crunchers_light))
3206 * One of the tags created by a server-header
3207 * tagger triggered a crunch. We already
3208 * delivered the crunch response to the client
3209 * and are done here after cleaning up.
3212 mark_server_socket_tainted(csp);
3215 /* Buffer and pcrs filter this if appropriate. */
3217 if (!http->ssl) /* We talk plaintext */
3219 content_filter = get_filter_function(csp);
3222 * Only write if we're not buffering for content modification
3224 if (!content_filter)
3227 * Write the server's (modified) header to
3228 * the client (along with anything else that
3229 * may be in the buffer)
3232 if (write_socket(csp->cfd, hdr, strlen(hdr))
3233 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
3235 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
3238 * The write failed, so don't bother mentioning it
3239 * to the client... it probably can't hear us anyway.
3242 mark_server_socket_tainted(csp);
3246 byte_count += (size_t)len;
3251 * XXX: the header lenght should probably
3252 * be calculated by get_server_headers().
3254 int header_length = csp->iob->cur - header_start;
3255 assert(csp->iob->cur > header_start);
3256 byte_count += (size_t)(len - header_length);
3259 /* we're finished with the server's header */
3265 * If this was a MS IIS/5 hack then it means the server
3266 * has already closed the connection. Nothing more to read.
3271 log_error(LOG_LEVEL_INFO,
3272 "Closed server connection detected with MS IIS5 hack enabled.");
3278 mark_server_socket_tainted(csp);
3279 return; /* huh? we should never get here */
3282 if (csp->content_length == 0)
3285 * If Privoxy didn't recalculate the Content-Lenght,
3286 * byte_count is still correct.
3288 csp->content_length = byte_count;
3291 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3292 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3293 && (csp->expected_content_length != byte_count))
3295 log_error(LOG_LEVEL_CONNECT,
3296 "Received %u bytes while expecting %u.",
3297 byte_count, csp->expected_content_length);
3298 mark_server_socket_tainted(csp);
3302 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %u",
3303 csp->ip_addr_str, http->ocmd, csp->content_length);
3307 /*********************************************************************
3311 * Description : This is little more than chat. We only "serve" to
3312 * to close any socket that chat may have opened.
3315 * 1 : csp = Current client state (buffers, headers, etc...)
3319 *********************************************************************/
3321 void serve(struct client_state *csp)
3322 #else /* ifndef AMIGA */
3323 static void serve(struct client_state *csp)
3324 #endif /* def AMIGA */
3327 close_socket(csp->cfd);
3329 if (csp->sfd != JB_INVALID_SOCKET)
3331 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3332 static int monitor_thread_running = 0;
3334 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3335 && (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
3337 remember_connection(csp->sfd, csp->http, forward_url(csp, csp->http));
3338 privoxy_mutex_lock(&connection_reuse_mutex);
3339 if (!monitor_thread_running)
3341 monitor_thread_running = 1;
3342 privoxy_mutex_unlock(&connection_reuse_mutex);
3343 wait_for_alive_connections();
3344 privoxy_mutex_lock(&connection_reuse_mutex);
3345 monitor_thread_running = 0;
3347 privoxy_mutex_unlock(&connection_reuse_mutex);
3351 forget_connection(csp->sfd);
3352 close_socket(csp->sfd);
3355 close_socket(csp->sfd);
3356 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3359 csp->flags &= ~CSP_FLAG_ACTIVE;
3365 /*********************************************************************
3367 * Function : server_thread
3369 * Description : We only exist to call `serve' in a threaded environment.
3372 * 1 : data = Current client state (buffers, headers, etc...)
3374 * Returns : Always 0.
3376 *********************************************************************/
3377 static int32 server_thread(void *data)
3379 serve((struct client_state *) data);
3386 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3387 /*********************************************************************
3391 * Description : Print usage info & exit.
3393 * Parameters : Pointer to argv[0] for identifying ourselves
3397 *********************************************************************/
3398 static void usage(const char *myname)
3400 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
3404 #endif /* defined(unix) */
3407 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
3408 #endif /* defined(unix) */
3409 "[--version] [configfile]\n"
3410 "Aborting\n", myname);
3415 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
3418 #ifdef MUTEX_LOCKS_AVAILABLE
3419 /*********************************************************************
3421 * Function : privoxy_mutex_lock
3423 * Description : Locks a mutex.
3426 * 1 : mutex = The mutex to lock.
3428 * Returns : Void. May exit in case of errors.
3430 *********************************************************************/
3431 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
3433 #ifdef FEATURE_PTHREAD
3434 int err = pthread_mutex_lock(mutex);
3437 if (mutex != &log_mutex)
3439 log_error(LOG_LEVEL_FATAL,
3440 "Mutex locking failed: %s.\n", strerror(err));
3445 EnterCriticalSection(mutex);
3446 #endif /* def FEATURE_PTHREAD */
3450 /*********************************************************************
3452 * Function : privoxy_mutex_unlock
3454 * Description : Unlocks a mutex.
3457 * 1 : mutex = The mutex to unlock.
3459 * Returns : Void. May exit in case of errors.
3461 *********************************************************************/
3462 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
3464 #ifdef FEATURE_PTHREAD
3465 int err = pthread_mutex_unlock(mutex);
3468 if (mutex != &log_mutex)
3470 log_error(LOG_LEVEL_FATAL,
3471 "Mutex unlocking failed: %s.\n", strerror(err));
3476 LeaveCriticalSection(mutex);
3477 #endif /* def FEATURE_PTHREAD */
3481 /*********************************************************************
3483 * Function : privoxy_mutex_init
3485 * Description : Prepares a mutex.
3488 * 1 : mutex = The mutex to initialize.
3490 * Returns : Void. May exit in case of errors.
3492 *********************************************************************/
3493 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
3495 #ifdef FEATURE_PTHREAD
3496 int err = pthread_mutex_init(mutex, 0);
3499 printf("Fatal error. Mutex initialization failed: %s.\n",
3504 InitializeCriticalSection(mutex);
3505 #endif /* def FEATURE_PTHREAD */
3507 #endif /* def MUTEX_LOCKS_AVAILABLE */
3509 /*********************************************************************
3511 * Function : initialize_mutexes
3513 * Description : Prepares mutexes if mutex support is available.
3517 * Returns : Void, exits in case of errors.
3519 *********************************************************************/
3520 static void initialize_mutexes(void)
3522 #ifdef MUTEX_LOCKS_AVAILABLE
3524 * Prepare global mutex semaphores
3526 privoxy_mutex_init(&log_mutex);
3527 privoxy_mutex_init(&log_init_mutex);
3528 privoxy_mutex_init(&connection_reuse_mutex);
3531 * XXX: The assumptions below are a bit naive
3532 * and can cause locks that aren't necessary.
3534 * For example older FreeBSD versions (< 6.x?)
3535 * have no gethostbyname_r, but gethostbyname is
3538 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
3539 privoxy_mutex_init(&resolver_mutex);
3540 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
3542 * XXX: should we use a single mutex for
3543 * localtime() and gmtime() as well?
3545 #ifndef HAVE_GMTIME_R
3546 privoxy_mutex_init(&gmtime_mutex);
3547 #endif /* ndef HAVE_GMTIME_R */
3549 #ifndef HAVE_LOCALTIME_R
3550 privoxy_mutex_init(&localtime_mutex);
3551 #endif /* ndef HAVE_GMTIME_R */
3554 privoxy_mutex_init(&rand_mutex);
3555 #endif /* ndef HAVE_RANDOM */
3556 #endif /* def MUTEX_LOCKS_AVAILABLE */
3560 /*********************************************************************
3564 * Description : Load the config file and start the listen loop.
3565 * This function is a lot more *sane* with the `load_config'
3566 * and `listen_loop' functions; although it stills does
3567 * a *little* too much for my taste.
3570 * 1 : argc = Number of parameters (including $0).
3571 * 2 : argv = Array of (char *)'s to the parameters.
3573 * Returns : 1 if : can't open config file, unrecognized directive,
3574 * stats requested in multi-thread mode, can't open the
3575 * log file, can't open the jar file, listen port is invalid,
3576 * any load fails, and can't bind port.
3578 * Else main never returns, the process must be signaled
3579 * to terminate execution. Or, on Windows, use the
3580 * "File", "Exit" menu option.
3582 *********************************************************************/
3584 int real_main(int argc, const char *argv[])
3586 int main(int argc, const char *argv[])
3590 unsigned int random_seed;
3592 struct passwd *pw = NULL;
3593 struct group *grp = NULL;
3596 char *pre_chroot_nslookup_to_load_resolver = NULL;
3603 #if !defined(_WIN32)
3610 /* Prepare mutexes if supported and necessary. */
3611 initialize_mutexes();
3613 /* Enable logging until further notice. */
3617 * Parse the command line arguments
3619 * XXX: simply printing usage information in case of
3620 * invalid arguments isn't particularly user friendly.
3622 while (++argc_pos < argc)
3625 /* Check to see if the service must be installed or uninstalled */
3626 if (strncmp(argv[argc_pos], "--install", 9) == 0)
3628 const char *pName = argv[argc_pos] + 9;
3631 exit( (install_service(pName)) ? 0 : 1 );
3633 else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
3635 const char *pName = argv[argc_pos] + 11;
3638 exit((uninstall_service(pName)) ? 0 : 1);
3640 else if (strcmp(argv[argc_pos], "--service" ) == 0)
3642 bRunAsService = TRUE;
3643 w32_set_service_cwd();
3644 atexit(w32_service_exit_notify);
3647 #endif /* defined(_WIN32) */
3650 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3652 if (strcmp(argv[argc_pos], "--help") == 0)
3657 else if(strcmp(argv[argc_pos], "--version") == 0)
3659 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3665 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
3670 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
3672 if (++argc_pos == argc) usage(argv[0]);
3673 pidfile = strdup(argv[argc_pos]);
3676 else if (strcmp(argv[argc_pos], "--user" ) == 0)
3678 if (++argc_pos == argc) usage(argv[argc_pos]);
3680 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
3683 if (NULL == (grp = getgrnam(p)))
3685 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
3689 if (NULL == (pw = getpwnam(argv[argc_pos])))
3691 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
3694 if (p != NULL) *--p = '\0';
3697 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
3699 if (++argc_pos == argc) usage(argv[0]);
3700 pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
3703 else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
3707 #endif /* defined(unix) */
3709 else if (argc_pos + 1 != argc)
3712 * This is neither the last command line
3713 * option, nor was it recognized before,
3714 * therefore it must be invalid.
3720 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3722 configfile = argv[argc_pos];
3725 } /* -END- while (more arguments) */
3727 show_version(Argv[0]);
3730 if ( *configfile != '/' )
3732 char cwd[BUFFER_SIZE];
3734 size_t abs_file_size;
3736 /* make config-filename absolute here */
3737 if (NULL == getcwd(cwd, sizeof(cwd)))
3739 perror("failed to get current working directory");
3744 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3745 basedir = strdup(cwd);
3747 if (NULL == basedir ||
3748 NULL == (abs_file = malloc(abs_file_size)))
3750 perror("malloc failed");
3753 strlcpy(abs_file, basedir, abs_file_size);
3754 strlcat(abs_file, "/", abs_file_size );
3755 strlcat(abs_file, configfile, abs_file_size);
3756 configfile = abs_file;
3758 #endif /* defined unix */
3762 clients->next = NULL;
3764 /* XXX: factor out initialising after the next stable release. */
3767 #elif defined(_WIN32)
3771 random_seed = (unsigned int)time(NULL);
3773 srandom(random_seed);
3776 #endif /* ifdef HAVE_RANDOM */
3779 * Unix signal handling
3781 * Catch the abort, interrupt and terminate signals for a graceful exit
3782 * Catch the hangup signal so the errlog can be reopened.
3783 * Ignore the broken pipe signals (FIXME: Why?)
3785 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3788 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
3789 const int ignored_signals[] = { SIGPIPE, 0 };
3791 for (idx = 0; catched_signals[idx] != 0; idx++)
3793 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3794 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3796 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3797 #endif /* ifdef sun */
3799 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3803 for (idx = 0; ignored_signals[idx] != 0; idx++)
3805 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
3807 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
3812 #else /* ifdef _WIN32 */
3813 # ifdef _WIN_CONSOLE
3815 * We *are* in a windows console app.
3816 * Print a verbose messages about FAQ's and such
3818 printf("%s", win32_blurb);
3819 # endif /* def _WIN_CONSOLE */
3820 #endif /* def _WIN32 */
3823 /* Initialize the CGI subsystem */
3824 cgi_init_error_messages();
3827 * If runnig on unix and without the --nodaemon
3828 * option, become a daemon. I.e. fork, detach
3829 * from tty and get process group leadership
3842 if ( pid < 0 ) /* error */
3847 else if ( pid != 0 ) /* parent */
3852 * must check for errors
3853 * child died due to missing files aso
3856 wpid = waitpid( pid, &status, WNOHANG );
3865 /* Should be more portable, but not as well tested */
3870 #else /* ndef __FreeBSD__ */
3872 #endif /* ndef __FreeBSD__ */
3873 fd = open("/dev/tty", O_RDONLY);
3876 /* no error check here */
3877 ioctl( fd, TIOCNOTTY,0 );
3882 * stderr (fd 2) will be closed later on, when the
3883 * log file has been parsed.
3890 } /* -END- if (!no_daemon) */
3893 * As soon as we have written the PID file, we can switch
3894 * to the user and group ID indicated by the --user option
3900 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3902 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3906 if (setgroups(1, &grp->gr_gid))
3908 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3911 else if (initgroups(pw->pw_name, pw->pw_gid))
3913 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3919 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3921 /* Read the time zone file from /etc before doing chroot. */
3923 if (NULL != pre_chroot_nslookup_to_load_resolver
3924 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3926 /* Initialize resolver library. */
3927 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3929 if (chroot(pw->pw_dir) < 0)
3931 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3935 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3938 if (setuid(pw->pw_uid))
3940 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3944 char putenv_dummy[64];
3946 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3947 if (putenv(putenv_dummy) != 0)
3949 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3952 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3953 if (putenv(putenv_dummy) != 0)
3955 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3961 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3964 #endif /* defined unix */
3967 /* This will be FALSE unless the command line specified --service
3971 /* Yup, so now we must attempt to establish a connection
3972 * with the service dispatcher. This will only work if this
3973 * process was launched by the service control manager to
3974 * actually run as a service. If this isn't the case, i've
3975 * known it take around 30 seconds or so for the call to return.
3978 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3979 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3981 /* Service has run, and at this point is now being stopped, so just return */
3986 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3988 /* An error occurred. Usually it's because --service was wrongly specified
3989 * and we were unable to connect to the Service Control Dispatcher because
3990 * it wasn't expecting us and is therefore not listening.
3992 * For now, just continue below to call the listen_loop function.
3995 #endif /* def _WIN32 */
4005 /*********************************************************************
4007 * Function : bind_port_helper
4009 * Description : Bind the listen port. Handles logging, and aborts
4013 * 1 : config = Privoxy configuration. Specifies port
4016 * Returns : Port that was opened.
4018 *********************************************************************/
4019 static jb_socket bind_port_helper(struct configuration_spec * config)
4024 if (config->haddr == NULL)
4026 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
4031 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
4032 config->hport, config->haddr);
4035 result = bind_port(config->haddr, config->hport, &bfd);
4042 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
4043 "There may be another Privoxy or some other "
4044 "proxy running on port %d",
4045 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
4046 config->hport, config->hport);
4049 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
4050 "The hostname is not resolvable",
4051 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
4054 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
4055 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
4058 /* shouldn't get here */
4059 return JB_INVALID_SOCKET;
4062 config->need_bind = 0;
4069 /* Without this simple workaround we get this compiler warning from _beginthread
4070 * warning C4028: formal parameter 1 different from declaration
4072 void w32_service_listen_loop(void *p)
4076 #endif /* def _WIN32 */
4079 /*********************************************************************
4081 * Function : listen_loop
4083 * Description : bind the listen port and enter a "FOREVER" listening loop.
4089 *********************************************************************/
4090 static void listen_loop(void)
4092 struct client_state *csp = NULL;
4094 struct configuration_spec * config;
4096 config = load_config();
4098 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4100 * XXX: Should be relocated once it no
4101 * longer needs to emit log messages.
4103 initialize_reusable_connections();
4104 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4106 bfd = bind_port_helper(config);
4108 #ifdef FEATURE_GRACEFUL_TERMINATION
4109 while (!g_terminate)
4114 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
4115 while (waitpid(-1, NULL, WNOHANG) > 0)
4117 /* zombie children */
4119 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
4122 * Free data that was used by died threads
4128 * Re-open the errlog after HUP signal
4130 if (received_hup_signal)
4132 if (NULL != config->logfile)
4134 init_error_log(Argv[0], config->logfile);
4136 received_hup_signal = 0;
4140 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
4142 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
4146 csp->flags |= CSP_FLAG_ACTIVE;
4147 csp->sfd = JB_INVALID_SOCKET;
4149 csp->config = config = load_config();
4151 if ( config->need_bind )
4154 * Since we were listening to the "old port", we will not see
4155 * a "listen" param change until the next IJB request. So, at
4156 * least 1 more request must be made for us to find the new
4157 * setting. I am simply closing the old socket and binding the
4160 * Which-ever is correct, we will serve 1 more page via the
4161 * old settings. This should probably be a "show-proxy-args"
4162 * request. This should not be a so common of an operation
4163 * that this will hurt people's feelings.
4168 bfd = bind_port_helper(config);
4171 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
4173 if (!accept_connection(csp, bfd))
4175 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
4188 log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
4191 #ifdef FEATURE_TOGGLE
4192 if (global_toggle_state)
4193 #endif /* def FEATURE_TOGGLE */
4195 csp->flags |= CSP_FLAG_TOGGLED_ON;
4198 if (run_loader(csp))
4200 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
4201 /* Never get here - LOG_LEVEL_FATAL causes program exit */
4205 if (block_acl(NULL,csp))
4207 log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
4208 close_socket(csp->cfd);
4212 #endif /* def FEATURE_ACL */
4214 /* add it to the list of clients */
4215 csp->next = clients->next;
4216 clients->next = csp;
4218 if (config->multi_threaded)
4222 /* this is a switch () statment in the C preprocessor - ugh */
4223 #undef SELECTED_ONE_OPTION
4225 /* Use Pthreads in preference to native code */
4226 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
4227 #define SELECTED_ONE_OPTION
4229 pthread_t the_thread;
4230 pthread_attr_t attrs;
4232 pthread_attr_init(&attrs);
4233 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
4234 errno = pthread_create(&the_thread, &attrs,
4235 (void * (*)(void *))serve, csp);
4236 child_id = errno ? -1 : 0;
4237 pthread_attr_destroy(&attrs);
4241 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
4242 #define SELECTED_ONE_OPTION
4243 child_id = _beginthread(
4244 (void (*)(void *))serve,
4249 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
4250 #define SELECTED_ONE_OPTION
4251 child_id = _beginthread(
4252 (void(* _Optlink)(void*))serve,
4258 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
4259 #define SELECTED_ONE_OPTION
4261 thread_id tid = spawn_thread
4262 (server_thread, "server", B_NORMAL_PRIORITY, csp);
4264 if ((tid >= 0) && (resume_thread(tid) == B_OK))
4266 child_id = (int) tid;
4275 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
4276 #define SELECTED_ONE_OPTION
4277 csp->cfd = ReleaseSocket(csp->cfd, -1);
4280 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4281 NP_Output, Output(),
4282 NP_CloseOutput, FALSE,
4283 NP_Name, (ULONG)"privoxy child",
4287 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4288 NP_Output, Output(),
4289 NP_CloseOutput, FALSE,
4290 NP_Name, (ULONG)"privoxy child",
4291 NP_StackSize, 200*1024,
4297 ((struct Task *)child_id)->tc_UserData = csp;
4298 Signal((struct Task *)child_id, SIGF_SINGLE);
4303 #if !defined(SELECTED_ONE_OPTION)
4306 /* This block is only needed when using fork().
4307 * When using threads, the server thread was
4308 * created and run by the call to _beginthread().
4310 if (child_id == 0) /* child */
4313 #ifdef FEATURE_TOGGLE
4314 int inherited_toggle_state = global_toggle_state;
4315 #endif /* def FEATURE_TOGGLE */
4320 * If we've been toggled or we've blocked the request, tell Mom
4323 #ifdef FEATURE_TOGGLE
4324 if (inherited_toggle_state != global_toggle_state)
4326 rc |= RC_FLAG_TOGGLED;
4328 #endif /* def FEATURE_TOGGLE */
4330 #ifdef FEATURE_STATISTICS
4331 if (csp->flags & CSP_FLAG_REJECTED)
4333 rc |= RC_FLAG_BLOCKED;
4335 #endif /* ndef FEATURE_STATISTICS */
4339 else if (child_id > 0) /* parent */
4341 /* in a fork()'d environment, the parent's
4342 * copy of the client socket and the CSP
4346 #if !defined(_WIN32) && !defined(__CYGWIN__)
4348 wait( &child_status );
4351 * Evaluate child's return code: If the child has
4352 * - been toggled, toggle ourselves
4353 * - blocked its request, bump up the stats counter
4356 #ifdef FEATURE_TOGGLE
4357 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
4359 global_toggle_state = !global_toggle_state;
4361 #endif /* def FEATURE_TOGGLE */
4363 #ifdef FEATURE_STATISTICS
4365 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
4369 #endif /* def FEATURE_STATISTICS */
4371 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
4372 close_socket(csp->cfd);
4373 csp->flags &= ~CSP_FLAG_ACTIVE;
4377 #undef SELECTED_ONE_OPTION
4378 /* end of cpp switch () */
4380 if (child_id < 0) /* failed */
4382 char buf[BUFFER_SIZE];
4384 log_error(LOG_LEVEL_ERROR, "can't fork: %E");
4386 snprintf(buf , sizeof(buf), "Privoxy: can't fork: errno = %d", errno);
4388 write_socket(csp->cfd, buf, strlen(buf));
4389 close_socket(csp->cfd);
4390 csp->flags &= ~CSP_FLAG_ACTIVE;
4401 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
4403 /* Clean up. Aim: free all memory (no leaks) */
4404 #ifdef FEATURE_GRACEFUL_TERMINATION
4406 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
4408 unload_current_config_file();
4409 unload_current_actions_file();
4410 unload_current_re_filterfile();
4411 #ifdef FEATURE_TRUST
4412 unload_current_trust_file();
4415 if (config->multi_threaded)
4422 } while ((clients->next != NULL) && (--i > 0));
4426 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
4437 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
4438 /* Cleanup - remove taskbar icon etc. */
4443 #endif /* FEATURE_GRACEFUL_TERMINATION */