sockfilt.c: Added wrapper functions to fix Windows console issues
[platform/upstream/curl.git] / tests / server / sockfilt.c
1 /***************************************************************************
2  *                                  _   _ ____  _
3  *  Project                     ___| | | |  _ \| |
4  *                             / __| | | | |_) | |
5  *                            | (__| |_| |  _ <| |___
6  *                             \___|\___/|_| \_\_____|
7  *
8  * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
9  *
10  * This software is licensed as described in the file COPYING, which
11  * you should have received as part of this distribution. The terms
12  * are also available at http://curl.haxx.se/docs/copyright.html.
13  *
14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15  * copies of the Software, and permit persons to whom the Software is
16  * furnished to do so, under the terms of the COPYING file.
17  *
18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19  * KIND, either express or implied.
20  *
21  ***************************************************************************/
22 #include "server_setup.h"
23
24 /* Purpose
25  *
26  * 1. Accept a TCP connection on a custom port (ipv4 or ipv6), or connect
27  *    to a given (localhost) port.
28  *
29  * 2. Get commands on STDIN. Pass data on to the TCP stream.
30  *    Get data from TCP stream and pass on to STDOUT.
31  *
32  * This program is made to perform all the socket/stream/connection stuff for
33  * the test suite's (perl) FTP server. Previously the perl code did all of
34  * this by its own, but I decided to let this program do the socket layer
35  * because of several things:
36  *
37  * o We want the perl code to work with rather old perl installations, thus
38  *   we cannot use recent perl modules or features.
39  *
40  * o We want IPv6 support for systems that provide it, and doing optional IPv6
41  *   support in perl seems if not impossible so at least awkward.
42  *
43  * o We want FTP-SSL support, which means that a connection that starts with
44  *   plain sockets needs to be able to "go SSL" in the midst. This would also
45  *   require some nasty perl stuff I'd rather avoid.
46  *
47  * (Source originally based on sws.c)
48  */
49
50 /*
51  * Signal handling notes for sockfilt
52  * ----------------------------------
53  *
54  * This program is a single-threaded process.
55  *
56  * This program is intended to be highly portable and as such it must be kept as
57  * simple as possible, due to this the only signal handling mechanisms used will
58  * be those of ANSI C, and used only in the most basic form which is good enough
59  * for the purpose of this program.
60  *
61  * For the above reason and the specific needs of this program signals SIGHUP,
62  * SIGPIPE and SIGALRM will be simply ignored on systems where this can be done.
63  * If possible, signals SIGINT and SIGTERM will be handled by this program as an
64  * indication to cleanup and finish execution as soon as possible.  This will be
65  * achieved with a single signal handler 'exit_signal_handler' for both signals.
66  *
67  * The 'exit_signal_handler' upon the first SIGINT or SIGTERM received signal
68  * will just set to one the global var 'got_exit_signal' storing in global var
69  * 'exit_signal' the signal that triggered this change.
70  *
71  * Nothing fancy that could introduce problems is used, the program at certain
72  * points in its normal flow checks if var 'got_exit_signal' is set and in case
73  * this is true it just makes its way out of loops and functions in structured
74  * and well behaved manner to achieve proper program cleanup and termination.
75  *
76  * Even with the above mechanism implemented it is worthwile to note that other
77  * signals might still be received, or that there might be systems on which it
78  * is not possible to trap and ignore some of the above signals.  This implies
79  * that for increased portability and reliability the program must be coded as
80  * if no signal was being ignored or handled at all.  Enjoy it!
81  */
82
83 #ifdef HAVE_SIGNAL_H
84 #include <signal.h>
85 #endif
86 #ifdef HAVE_NETINET_IN_H
87 #include <netinet/in.h>
88 #endif
89 #ifdef HAVE_ARPA_INET_H
90 #include <arpa/inet.h>
91 #endif
92 #ifdef HAVE_NETDB_H
93 #include <netdb.h>
94 #endif
95 #ifdef USE_WINSOCK
96 #include <conio.h>  /* for _kbhit() used in select_ws() */
97 #endif
98
99 #define ENABLE_CURLX_PRINTF
100 /* make the curlx header define all printf() functions to use the curlx_*
101    versions instead */
102 #include "curlx.h" /* from the private lib dir */
103 #include "getpart.h"
104 #include "inet_pton.h"
105 #include "util.h"
106 #include "server_sockaddr.h"
107 #include "warnless.h"
108
109 /* include memdebug.h last */
110 #include "memdebug.h"
111
112 #ifdef USE_WINSOCK
113 #undef  EINTR
114 #define EINTR    4 /* errno.h value */
115 #undef  EAGAIN
116 #define EAGAIN  11 /* errno.h value */
117 #undef  ENOMEM
118 #define ENOMEM  12 /* errno.h value */
119 #undef  EINVAL
120 #define EINVAL  22 /* errno.h value */
121 #endif
122
123 #define DEFAULT_PORT 8999
124
125 #ifndef DEFAULT_LOGFILE
126 #define DEFAULT_LOGFILE "log/sockfilt.log"
127 #endif
128
129 const char *serverlogfile = DEFAULT_LOGFILE;
130
131 static bool verbose = FALSE;
132 static bool bind_only = FALSE;
133 #ifdef ENABLE_IPV6
134 static bool use_ipv6 = FALSE;
135 #endif
136 static const char *ipv_inuse = "IPv4";
137 static unsigned short port = DEFAULT_PORT;
138 static unsigned short connectport = 0; /* if non-zero, we activate this mode */
139
140 enum sockmode {
141   PASSIVE_LISTEN,    /* as a server waiting for connections */
142   PASSIVE_CONNECT,   /* as a server, connected to a client */
143   ACTIVE,            /* as a client, connected to a server */
144   ACTIVE_DISCONNECT  /* as a client, disconnected from server */
145 };
146
147 /* do-nothing macro replacement for systems which lack siginterrupt() */
148
149 #ifndef HAVE_SIGINTERRUPT
150 #define siginterrupt(x,y) do {} while(0)
151 #endif
152
153 /* vars used to keep around previous signal handlers */
154
155 typedef RETSIGTYPE (*SIGHANDLER_T)(int);
156
157 #ifdef SIGHUP
158 static SIGHANDLER_T old_sighup_handler  = SIG_ERR;
159 #endif
160
161 #ifdef SIGPIPE
162 static SIGHANDLER_T old_sigpipe_handler = SIG_ERR;
163 #endif
164
165 #ifdef SIGALRM
166 static SIGHANDLER_T old_sigalrm_handler = SIG_ERR;
167 #endif
168
169 #ifdef SIGINT
170 static SIGHANDLER_T old_sigint_handler  = SIG_ERR;
171 #endif
172
173 #ifdef SIGTERM
174 static SIGHANDLER_T old_sigterm_handler = SIG_ERR;
175 #endif
176
177 #if defined(SIGBREAK) && defined(WIN32)
178 static SIGHANDLER_T old_sigbreak_handler = SIG_ERR;
179 #endif
180
181 /* var which if set indicates that the program should finish execution */
182
183 SIG_ATOMIC_T got_exit_signal = 0;
184
185 /* if next is set indicates the first signal handled in exit_signal_handler */
186
187 static volatile int exit_signal = 0;
188
189 /* signal handler that will be triggered to indicate that the program
190   should finish its execution in a controlled manner as soon as possible.
191   The first time this is called it will set got_exit_signal to one and
192   store in exit_signal the signal that triggered its execution. */
193
194 static RETSIGTYPE exit_signal_handler(int signum)
195 {
196   int old_errno = errno;
197   if(got_exit_signal == 0) {
198     got_exit_signal = 1;
199     exit_signal = signum;
200   }
201   (void)signal(signum, exit_signal_handler);
202   errno = old_errno;
203 }
204
205 static void install_signal_handlers(void)
206 {
207 #ifdef SIGHUP
208   /* ignore SIGHUP signal */
209   if((old_sighup_handler = signal(SIGHUP, SIG_IGN)) == SIG_ERR)
210     logmsg("cannot install SIGHUP handler: %s", strerror(errno));
211 #endif
212 #ifdef SIGPIPE
213   /* ignore SIGPIPE signal */
214   if((old_sigpipe_handler = signal(SIGPIPE, SIG_IGN)) == SIG_ERR)
215     logmsg("cannot install SIGPIPE handler: %s", strerror(errno));
216 #endif
217 #ifdef SIGALRM
218   /* ignore SIGALRM signal */
219   if((old_sigalrm_handler = signal(SIGALRM, SIG_IGN)) == SIG_ERR)
220     logmsg("cannot install SIGALRM handler: %s", strerror(errno));
221 #endif
222 #ifdef SIGINT
223   /* handle SIGINT signal with our exit_signal_handler */
224   if((old_sigint_handler = signal(SIGINT, exit_signal_handler)) == SIG_ERR)
225     logmsg("cannot install SIGINT handler: %s", strerror(errno));
226   else
227     siginterrupt(SIGINT, 1);
228 #endif
229 #ifdef SIGTERM
230   /* handle SIGTERM signal with our exit_signal_handler */
231   if((old_sigterm_handler = signal(SIGTERM, exit_signal_handler)) == SIG_ERR)
232     logmsg("cannot install SIGTERM handler: %s", strerror(errno));
233   else
234     siginterrupt(SIGTERM, 1);
235 #endif
236 #if defined(SIGBREAK) && defined(WIN32)
237   /* handle SIGBREAK signal with our exit_signal_handler */
238   if((old_sigbreak_handler = signal(SIGBREAK, exit_signal_handler)) == SIG_ERR)
239     logmsg("cannot install SIGBREAK handler: %s", strerror(errno));
240   else
241     siginterrupt(SIGBREAK, 1);
242 #endif
243 }
244
245 static void restore_signal_handlers(void)
246 {
247 #ifdef SIGHUP
248   if(SIG_ERR != old_sighup_handler)
249     (void)signal(SIGHUP, old_sighup_handler);
250 #endif
251 #ifdef SIGPIPE
252   if(SIG_ERR != old_sigpipe_handler)
253     (void)signal(SIGPIPE, old_sigpipe_handler);
254 #endif
255 #ifdef SIGALRM
256   if(SIG_ERR != old_sigalrm_handler)
257     (void)signal(SIGALRM, old_sigalrm_handler);
258 #endif
259 #ifdef SIGINT
260   if(SIG_ERR != old_sigint_handler)
261     (void)signal(SIGINT, old_sigint_handler);
262 #endif
263 #ifdef SIGTERM
264   if(SIG_ERR != old_sigterm_handler)
265     (void)signal(SIGTERM, old_sigterm_handler);
266 #endif
267 #if defined(SIGBREAK) && defined(WIN32)
268   if(SIG_ERR != old_sigbreak_handler)
269     (void)signal(SIGBREAK, old_sigbreak_handler);
270 #endif
271 }
272
273 #ifdef WIN32
274 /*
275  * read-wrapper to support reading from stdin on Windows.
276  */
277 static ssize_t read_wincon(int fd, void *buf, size_t count)
278 {
279   HANDLE handle = NULL;
280   DWORD mode, rcount = 0;
281   BOOL success;
282
283   if(fd == fileno(stdin)) {
284     handle = GetStdHandle(STD_INPUT_HANDLE);
285   }
286   else {
287     return read(fd, buf, count);
288   }
289
290   if(GetConsoleMode(handle, &mode)) {
291     success = ReadConsole(handle, buf, count, &rcount, NULL);
292   }
293   else {
294     success = ReadFile(handle, buf, count, &rcount, NULL);
295   }
296   if(success) {
297     return rcount;
298   }
299
300   errno = GetLastError();
301   return -1;
302 }
303 #define read(a,b,c) read_wincon(a,b,c)
304
305 /*
306  * write-wrapper to support writing to stdout and stderr on Windows.
307  */
308 static ssize_t write_wincon(int fd, const void *buf, size_t count)
309 {
310   HANDLE handle = NULL;
311   DWORD mode, wcount = 0;
312   BOOL success;
313
314   if(fd == fileno(stdout)) {
315     handle = GetStdHandle(STD_OUTPUT_HANDLE);
316   }
317   else if(fd == fileno(stderr)) {
318     handle = GetStdHandle(STD_ERROR_HANDLE);
319   }
320   else {
321     return write(fd, buf, count);
322   }
323
324   if(GetConsoleMode(handle, &mode)) {
325     success = WriteConsole(handle, buf, count, &wcount, NULL);
326   }
327   else {
328     success = WriteFile(handle, buf, count, &wcount, NULL);
329   }
330   if(success) {
331     return wcount;
332   }
333
334   errno = GetLastError();
335   return -1;
336 }
337 #define write(a,b,c) write_wincon(a,b,c)
338 #endif
339
340 /*
341  * fullread is a wrapper around the read() function. This will repeat the call
342  * to read() until it actually has read the complete number of bytes indicated
343  * in nbytes or it fails with a condition that cannot be handled with a simple
344  * retry of the read call.
345  */
346
347 static ssize_t fullread(int filedes, void *buffer, size_t nbytes)
348 {
349   int error;
350   ssize_t rc;
351   ssize_t nread = 0;
352
353   do {
354     rc = read(filedes, (unsigned char *)buffer + nread, nbytes - nread);
355
356     if(got_exit_signal) {
357       logmsg("signalled to die");
358       return -1;
359     }
360
361     if(rc < 0) {
362       error = errno;
363       if((error == EINTR) || (error == EAGAIN))
364         continue;
365       logmsg("reading from file descriptor: %d,", filedes);
366       logmsg("unrecoverable read() failure: (%d) %s",
367              error, strerror(error));
368       return -1;
369     }
370
371     if(rc == 0) {
372       logmsg("got 0 reading from stdin");
373       return 0;
374     }
375
376     nread += rc;
377
378   } while((size_t)nread < nbytes);
379
380   if(verbose)
381     logmsg("read %zd bytes", nread);
382
383   return nread;
384 }
385
386 /*
387  * fullwrite is a wrapper around the write() function. This will repeat the
388  * call to write() until it actually has written the complete number of bytes
389  * indicated in nbytes or it fails with a condition that cannot be handled
390  * with a simple retry of the write call.
391  */
392
393 static ssize_t fullwrite(int filedes, const void *buffer, size_t nbytes)
394 {
395   int error;
396   ssize_t wc;
397   ssize_t nwrite = 0;
398
399   do {
400     wc = write(filedes, (unsigned char *)buffer + nwrite, nbytes - nwrite);
401
402     if(got_exit_signal) {
403       logmsg("signalled to die");
404       return -1;
405     }
406
407     if(wc < 0) {
408       error = errno;
409       if((error == EINTR) || (error == EAGAIN))
410         continue;
411       logmsg("writing to file descriptor: %d,", filedes);
412       logmsg("unrecoverable write() failure: (%d) %s",
413              error, strerror(error));
414       return -1;
415     }
416
417     if(wc == 0) {
418       logmsg("put 0 writing to stdout");
419       return 0;
420     }
421
422     nwrite += wc;
423
424   } while((size_t)nwrite < nbytes);
425
426   if(verbose)
427     logmsg("wrote %zd bytes", nwrite);
428
429   return nwrite;
430 }
431
432 /*
433  * read_stdin tries to read from stdin nbytes into the given buffer. This is a
434  * blocking function that will only return TRUE when nbytes have actually been
435  * read or FALSE when an unrecoverable error has been detected. Failure of this
436  * function is an indication that the sockfilt process should terminate.
437  */
438
439 static bool read_stdin(void *buffer, size_t nbytes)
440 {
441   ssize_t nread = fullread(fileno(stdin), buffer, nbytes);
442   if(nread != (ssize_t)nbytes) {
443     logmsg("exiting...");
444     return FALSE;
445   }
446   return TRUE;
447 }
448
449 /*
450  * write_stdout tries to write to stdio nbytes from the given buffer. This is a
451  * blocking function that will only return TRUE when nbytes have actually been
452  * written or FALSE when an unrecoverable error has been detected. Failure of
453  * this function is an indication that the sockfilt process should terminate.
454  */
455
456 static bool write_stdout(const void *buffer, size_t nbytes)
457 {
458   ssize_t nwrite = fullwrite(fileno(stdout), buffer, nbytes);
459   if(nwrite != (ssize_t)nbytes) {
460     logmsg("exiting...");
461     return FALSE;
462   }
463   return TRUE;
464 }
465
466 static void lograw(unsigned char *buffer, ssize_t len)
467 {
468   char data[120];
469   ssize_t i;
470   unsigned char *ptr = buffer;
471   char *optr = data;
472   ssize_t width=0;
473
474   for(i=0; i<len; i++) {
475     switch(ptr[i]) {
476     case '\n':
477       sprintf(optr, "\\n");
478       width += 2;
479       optr += 2;
480       break;
481     case '\r':
482       sprintf(optr, "\\r");
483       width += 2;
484       optr += 2;
485       break;
486     default:
487       sprintf(optr, "%c", (ISGRAPH(ptr[i]) || ptr[i]==0x20) ?ptr[i]:'.');
488       width++;
489       optr++;
490       break;
491     }
492
493     if(width>60) {
494       logmsg("'%s'", data);
495       width = 0;
496       optr = data;
497     }
498   }
499   if(width)
500     logmsg("'%s'", data);
501 }
502
503 #ifdef USE_WINSOCK
504 /*
505  * WinSock select() does not support standard file descriptors,
506  * it can only check SOCKETs. The following function is an attempt
507  * to re-create a select() function with support for other handle types.
508  *
509  * select() function with support for WINSOCK2 sockets and all
510  * other handle types supported by WaitForMultipleObjectsEx().
511  *
512  * TODO: Differentiate between read/write/except for non-SOCKET handles.
513  *
514  * http://msdn.microsoft.com/en-us/library/windows/desktop/ms687028.aspx
515  * http://msdn.microsoft.com/en-us/library/windows/desktop/ms741572.aspx
516  */
517 static int select_ws(int nfds, fd_set *readfds, fd_set *writefds,
518                      fd_set *exceptfds, struct timeval *timeout)
519 {
520   long networkevents;
521   DWORD milliseconds, wait, idx, mode, avail, events, inputs;
522   WSAEVENT wsaevent, *wsaevents;
523   WSANETWORKEVENTS wsanetevents;
524   INPUT_RECORD *inputrecords;
525   HANDLE handle, *handles;
526   curl_socket_t sock, *fdarr, *wsasocks;
527   int error, fds;
528   DWORD nfd = 0, wsa = 0;
529   int ret = 0;
530
531   /* check if the input value is valid */
532   if(nfds < 0) {
533     errno = EINVAL;
534     return -1;
535   }
536
537   /* check if we got descriptors, sleep in case we got none */
538   if(!nfds) {
539     Sleep((timeout->tv_sec * 1000) + (timeout->tv_usec / 1000));
540     return 0;
541   }
542
543   /* allocate internal array for the original input handles */
544   fdarr = malloc(nfds * sizeof(curl_socket_t));
545   if(fdarr == NULL) {
546     errno = ENOMEM;
547     return -1;
548   }
549
550   /* allocate internal array for the internal event handles */
551   handles = malloc(nfds * sizeof(HANDLE));
552   if(handles == NULL) {
553     errno = ENOMEM;
554     return -1;
555   }
556
557   /* allocate internal array for the internal socket handles */
558   wsasocks = malloc(nfds * sizeof(curl_socket_t));
559   if(wsasocks == NULL) {
560     errno = ENOMEM;
561     return -1;
562   }
563
564   /* allocate internal array for the internal WINSOCK2 events */
565   wsaevents = malloc(nfds * sizeof(WSAEVENT));
566   if(wsaevents == NULL) {
567     errno = ENOMEM;
568     return -1;
569   }
570
571   /* loop over the handles in the input descriptor sets */
572   for(fds = 0; fds < nfds; fds++) {
573     networkevents = 0;
574     handles[nfd] = 0;
575
576     if(FD_ISSET(fds, readfds))
577       networkevents |= FD_READ|FD_ACCEPT|FD_CLOSE;
578
579     if(FD_ISSET(fds, writefds))
580       networkevents |= FD_WRITE|FD_CONNECT;
581
582     if(FD_ISSET(fds, exceptfds))
583       networkevents |= FD_OOB;
584
585     /* only wait for events for which we actually care */
586     if(networkevents) {
587       fdarr[nfd] = curlx_sitosk(fds);
588       if(fds == fileno(stdin)) {
589         handles[nfd] = GetStdHandle(STD_INPUT_HANDLE);
590       }
591       else if(fds == fileno(stdout)) {
592         handles[nfd] = GetStdHandle(STD_OUTPUT_HANDLE);
593       }
594       else if(fds == fileno(stderr)) {
595         handles[nfd] = GetStdHandle(STD_ERROR_HANDLE);
596       }
597       else {
598         wsaevent = WSACreateEvent();
599         if(wsaevent != WSA_INVALID_EVENT) {
600           error = WSAEventSelect(fds, wsaevent, networkevents);
601           if(error != SOCKET_ERROR) {
602             handles[nfd] = wsaevent;
603             wsasocks[wsa] = curlx_sitosk(fds);
604             wsaevents[wsa] = wsaevent;
605             wsa++;
606           }
607           else {
608             handles[nfd] = (HANDLE) curlx_sitosk(fds);
609             WSACloseEvent(wsaevent);
610           }
611         }
612       }
613       nfd++;
614     }
615   }
616
617   /* convert struct timeval to milliseconds */
618   if(timeout) {
619     milliseconds = ((timeout->tv_sec * 1000) + (timeout->tv_usec / 1000));
620   }
621   else {
622     milliseconds = INFINITE;
623   }
624
625   /* wait for one of the internal handles to trigger */
626   wait = WaitForMultipleObjectsEx(nfd, handles, FALSE, milliseconds, FALSE);
627
628   /* loop over the internal handles returned in the descriptors */
629   for(idx = 0; idx < nfd; idx++) {
630     handle = handles[idx];
631     sock = fdarr[idx];
632     fds = curlx_sktosi(sock);
633
634     /* check if the current internal handle was triggered */
635     if(wait != WAIT_FAILED && (wait - WAIT_OBJECT_0) >= idx &&
636        WaitForSingleObjectEx(handle, 0, FALSE) == WAIT_OBJECT_0) {
637       /* try to handle the event with STD* handle functions */
638       if(fds == fileno(stdin)) {
639         /* check if there is no data in the input buffer */
640         if(!stdin->_cnt) {
641           /* check if we are getting data from a PIPE */
642           if(!GetConsoleMode(handle, &mode)) {
643             /* check if there is no data from PIPE input */
644             if(!PeekNamedPipe(handle, NULL, 0, NULL, &avail, NULL))
645               avail = 0;
646             if(!avail)
647               FD_CLR(sock, readfds);
648           } /* check if there is no data from keyboard input */
649           else if (!_kbhit()) {
650             /* check if there are INPUT_RECORDs in the input buffer */
651             if(GetNumberOfConsoleInputEvents(handle, &events)) {
652               if(events > 0) {
653                 /* remove INPUT_RECORDs from the input buffer */
654                 inputrecords = (INPUT_RECORD*)malloc(events *
655                                                      sizeof(INPUT_RECORD));
656                 if(inputrecords) {
657                   if(!ReadConsoleInput(handle, inputrecords,
658                                        events, &inputs))
659                     inputs = 0;
660                   free(inputrecords);
661                 }
662
663                 /* check if we got all inputs, otherwise clear buffer */
664                 if(events != inputs)
665                   FlushConsoleInputBuffer(handle);
666               }
667             }
668
669             /* remove from descriptor set since there is no real data */
670             FD_CLR(sock, readfds);
671           }
672         }
673
674         /* stdin is never ready for write or exceptional */
675         FD_CLR(sock, writefds);
676         FD_CLR(sock, exceptfds);
677       }
678       else if(fds == fileno(stdout) || fds == fileno(stderr)) {
679         /* stdout and stderr are never ready for read or exceptional */
680         FD_CLR(sock, readfds);
681         FD_CLR(sock, exceptfds);
682       }
683       else {
684         /* try to handle the event with the WINSOCK2 functions */
685         error = WSAEnumNetworkEvents(fds, NULL, &wsanetevents);
686         if(error != SOCKET_ERROR) {
687           /* remove from descriptor set if not ready for read/accept/close */
688           if(!(wsanetevents.lNetworkEvents & (FD_READ|FD_ACCEPT|FD_CLOSE)))
689             FD_CLR(sock, readfds);
690
691           /* remove from descriptor set if not ready for write/connect */
692           if(!(wsanetevents.lNetworkEvents & (FD_WRITE|FD_CONNECT)))
693             FD_CLR(sock, writefds);
694
695           /* remove from descriptor set if not exceptional */
696           if(!(wsanetevents.lNetworkEvents & FD_OOB))
697             FD_CLR(sock, exceptfds);
698         }
699       }
700
701       /* check if the event has not been filtered using specific tests */
702       if(FD_ISSET(sock, readfds) || FD_ISSET(sock, writefds) ||
703          FD_ISSET(sock, exceptfds)) {
704         ret++;
705       }
706     }
707     else {
708       /* remove from all descriptor sets since this handle did not trigger */
709       FD_CLR(sock, readfds);
710       FD_CLR(sock, writefds);
711       FD_CLR(sock, exceptfds);
712     }
713   }
714
715   for(idx = 0; idx < wsa; idx++) {
716     WSAEventSelect(wsasocks[idx], NULL, 0);
717     WSACloseEvent(wsaevents[idx]);
718   }
719
720   free(wsaevents);
721   free(wsasocks);
722   free(handles);
723   free(fdarr);
724
725   return ret;
726 }
727 #define select(a,b,c,d,e) select_ws(a,b,c,d,e)
728 #endif  /* USE_WINSOCK */
729
730 /*
731   sockfdp is a pointer to an established stream or CURL_SOCKET_BAD
732
733   if sockfd is CURL_SOCKET_BAD, listendfd is a listening socket we must
734   accept()
735 */
736 static bool juggle(curl_socket_t *sockfdp,
737                    curl_socket_t listenfd,
738                    enum sockmode *mode)
739 {
740   struct timeval timeout;
741   fd_set fds_read;
742   fd_set fds_write;
743   fd_set fds_err;
744   curl_socket_t sockfd = CURL_SOCKET_BAD;
745   int maxfd = -99;
746   ssize_t rc;
747   ssize_t nread_socket;
748   ssize_t bytes_written;
749   ssize_t buffer_len;
750   int error = 0;
751
752  /* 'buffer' is this excessively large only to be able to support things like
753     test 1003 which tests exceedingly large server response lines */
754   unsigned char buffer[17010];
755   char data[16];
756
757   if(got_exit_signal) {
758     logmsg("signalled to die, exiting...");
759     return FALSE;
760   }
761
762 #ifdef HAVE_GETPPID
763   /* As a last resort, quit if sockfilt process becomes orphan. Just in case
764      parent ftpserver process has died without killing its sockfilt children */
765   if(getppid() <= 1) {
766     logmsg("process becomes orphan, exiting");
767     return FALSE;
768   }
769 #endif
770
771   timeout.tv_sec = 120;
772   timeout.tv_usec = 0;
773
774   FD_ZERO(&fds_read);
775   FD_ZERO(&fds_write);
776   FD_ZERO(&fds_err);
777
778   FD_SET((curl_socket_t)fileno(stdin), &fds_read);
779
780   switch(*mode) {
781
782   case PASSIVE_LISTEN:
783
784     /* server mode */
785     sockfd = listenfd;
786     /* there's always a socket to wait for */
787     FD_SET(sockfd, &fds_read);
788     maxfd = (int)sockfd;
789     break;
790
791   case PASSIVE_CONNECT:
792
793     sockfd = *sockfdp;
794     if(CURL_SOCKET_BAD == sockfd) {
795       /* eeek, we are supposedly connected and then this cannot be -1 ! */
796       logmsg("socket is -1! on %s:%d", __FILE__, __LINE__);
797       maxfd = 0; /* stdin */
798     }
799     else {
800       /* there's always a socket to wait for */
801       FD_SET(sockfd, &fds_read);
802       maxfd = (int)sockfd;
803     }
804     break;
805
806   case ACTIVE:
807
808     sockfd = *sockfdp;
809     /* sockfd turns CURL_SOCKET_BAD when our connection has been closed */
810     if(CURL_SOCKET_BAD != sockfd) {
811       FD_SET(sockfd, &fds_read);
812       maxfd = (int)sockfd;
813     }
814     else {
815       logmsg("No socket to read on");
816       maxfd = 0;
817     }
818     break;
819
820   case ACTIVE_DISCONNECT:
821
822     logmsg("disconnected, no socket to read on");
823     maxfd = 0;
824     sockfd = CURL_SOCKET_BAD;
825     break;
826
827   } /* switch(*mode) */
828
829
830   do {
831
832     /* select() blocking behavior call on blocking descriptors please */
833
834     rc = select(maxfd + 1, &fds_read, &fds_write, &fds_err, &timeout);
835
836     if(got_exit_signal) {
837       logmsg("signalled to die, exiting...");
838       return FALSE;
839     }
840
841   } while((rc == -1) && ((error = errno) == EINTR));
842
843   if(rc < 0) {
844     logmsg("select() failed with error: (%d) %s",
845            error, strerror(error));
846     return FALSE;
847   }
848
849   if(rc == 0)
850     /* timeout */
851     return TRUE;
852
853
854   if(FD_ISSET(fileno(stdin), &fds_read)) {
855     /* read from stdin, commands/data to be dealt with and possibly passed on
856        to the socket
857
858        protocol:
859
860        4 letter command + LF [mandatory]
861
862        4-digit hexadecimal data length + LF [if the command takes data]
863        data                       [the data being as long as set above]
864
865        Commands:
866
867        DATA - plain pass-thru data
868     */
869
870     if(!read_stdin(buffer, 5))
871       return FALSE;
872
873     logmsg("Received %c%c%c%c (on stdin)",
874            buffer[0], buffer[1], buffer[2], buffer[3] );
875
876     if(!memcmp("PING", buffer, 4)) {
877       /* send reply on stdout, just proving we are alive */
878       if(!write_stdout("PONG\n", 5))
879         return FALSE;
880     }
881
882     else if(!memcmp("PORT", buffer, 4)) {
883       /* Question asking us what PORT number we are listening to.
884          Replies to PORT with "IPv[num]/[port]" */
885       sprintf((char *)buffer, "%s/%hu\n", ipv_inuse, port);
886       buffer_len = (ssize_t)strlen((char *)buffer);
887       snprintf(data, sizeof(data), "PORT\n%04zx\n", buffer_len);
888       if(!write_stdout(data, 10))
889         return FALSE;
890       if(!write_stdout(buffer, buffer_len))
891         return FALSE;
892     }
893     else if(!memcmp("QUIT", buffer, 4)) {
894       /* just die */
895       logmsg("quits");
896       return FALSE;
897     }
898     else if(!memcmp("DATA", buffer, 4)) {
899       /* data IN => data OUT */
900
901       if(!read_stdin(buffer, 5))
902         return FALSE;
903
904       buffer[5] = '\0';
905
906       buffer_len = (ssize_t)strtol((char *)buffer, NULL, 16);
907       if (buffer_len > (ssize_t)sizeof(buffer)) {
908         logmsg("ERROR: Buffer size (%zu bytes) too small for data size "
909                "(%zd bytes)", sizeof(buffer), buffer_len);
910         return FALSE;
911       }
912       logmsg("> %zd bytes data, server => client", buffer_len);
913
914       if(!read_stdin(buffer, buffer_len))
915         return FALSE;
916
917       lograw(buffer, buffer_len);
918
919       if(*mode == PASSIVE_LISTEN) {
920         logmsg("*** We are disconnected!");
921         if(!write_stdout("DISC\n", 5))
922           return FALSE;
923       }
924       else {
925         /* send away on the socket */
926         bytes_written = swrite(sockfd, buffer, buffer_len);
927         if(bytes_written != buffer_len) {
928           logmsg("Not all data was sent. Bytes to send: %zd sent: %zd",
929                  buffer_len, bytes_written);
930         }
931       }
932     }
933     else if(!memcmp("DISC", buffer, 4)) {
934       /* disconnect! */
935       if(!write_stdout("DISC\n", 5))
936         return FALSE;
937       if(sockfd != CURL_SOCKET_BAD) {
938         logmsg("====> Client forcibly disconnected");
939         sclose(sockfd);
940         *sockfdp = CURL_SOCKET_BAD;
941         if(*mode == PASSIVE_CONNECT)
942           *mode = PASSIVE_LISTEN;
943         else
944           *mode = ACTIVE_DISCONNECT;
945       }
946       else
947         logmsg("attempt to close already dead connection");
948       return TRUE;
949     }
950   }
951
952
953   if((sockfd != CURL_SOCKET_BAD) && (FD_ISSET(sockfd, &fds_read)) ) {
954
955     curl_socket_t newfd = CURL_SOCKET_BAD; /* newly accepted socket */
956
957     if(*mode == PASSIVE_LISTEN) {
958       /* there's no stream set up yet, this is an indication that there's a
959          client connecting. */
960       newfd = accept(sockfd, NULL, NULL);
961       if(CURL_SOCKET_BAD == newfd) {
962         error = SOCKERRNO;
963         logmsg("accept(%d, NULL, NULL) failed with error: (%d) %s",
964                sockfd, error, strerror(error));
965       }
966       else {
967         logmsg("====> Client connect");
968         if(!write_stdout("CNCT\n", 5))
969           return FALSE;
970         *sockfdp = newfd; /* store the new socket */
971         *mode = PASSIVE_CONNECT; /* we have connected */
972       }
973       return TRUE;
974     }
975
976     /* read from socket, pass on data to stdout */
977     nread_socket = sread(sockfd, buffer, sizeof(buffer));
978
979     if(nread_socket <= 0) {
980       logmsg("====> Client disconnect");
981       if(!write_stdout("DISC\n", 5))
982         return FALSE;
983       sclose(sockfd);
984       *sockfdp = CURL_SOCKET_BAD;
985       if(*mode == PASSIVE_CONNECT)
986         *mode = PASSIVE_LISTEN;
987       else
988         *mode = ACTIVE_DISCONNECT;
989       return TRUE;
990     }
991
992     snprintf(data, sizeof(data), "DATA\n%04zx\n", nread_socket);
993     if(!write_stdout(data, 10))
994       return FALSE;
995     if(!write_stdout(buffer, nread_socket))
996       return FALSE;
997
998     logmsg("< %zd bytes data, client => server", nread_socket);
999     lograw(buffer, nread_socket);
1000   }
1001
1002   return TRUE;
1003 }
1004
1005 static curl_socket_t sockdaemon(curl_socket_t sock,
1006                                 unsigned short *listenport)
1007 {
1008   /* passive daemon style */
1009   srvr_sockaddr_union_t listener;
1010   int flag;
1011   int rc;
1012   int totdelay = 0;
1013   int maxretr = 10;
1014   int delay= 20;
1015   int attempt = 0;
1016   int error = 0;
1017
1018   do {
1019     attempt++;
1020     flag = 1;
1021     rc = setsockopt(sock, SOL_SOCKET, SO_REUSEADDR,
1022          (void *)&flag, sizeof(flag));
1023     if(rc) {
1024       error = SOCKERRNO;
1025       logmsg("setsockopt(SO_REUSEADDR) failed with error: (%d) %s",
1026              error, strerror(error));
1027       if(maxretr) {
1028         rc = wait_ms(delay);
1029         if(rc) {
1030           /* should not happen */
1031           error = errno;
1032           logmsg("wait_ms() failed with error: (%d) %s",
1033                  error, strerror(error));
1034           sclose(sock);
1035           return CURL_SOCKET_BAD;
1036         }
1037         if(got_exit_signal) {
1038           logmsg("signalled to die, exiting...");
1039           sclose(sock);
1040           return CURL_SOCKET_BAD;
1041         }
1042         totdelay += delay;
1043         delay *= 2; /* double the sleep for next attempt */
1044       }
1045     }
1046   } while(rc && maxretr--);
1047
1048   if(rc) {
1049     logmsg("setsockopt(SO_REUSEADDR) failed %d times in %d ms. Error: (%d) %s",
1050            attempt, totdelay, error, strerror(error));
1051     logmsg("Continuing anyway...");
1052   }
1053
1054   /* When the specified listener port is zero, it is actually a
1055      request to let the system choose a non-zero available port. */
1056
1057 #ifdef ENABLE_IPV6
1058   if(!use_ipv6) {
1059 #endif
1060     memset(&listener.sa4, 0, sizeof(listener.sa4));
1061     listener.sa4.sin_family = AF_INET;
1062     listener.sa4.sin_addr.s_addr = INADDR_ANY;
1063     listener.sa4.sin_port = htons(*listenport);
1064     rc = bind(sock, &listener.sa, sizeof(listener.sa4));
1065 #ifdef ENABLE_IPV6
1066   }
1067   else {
1068     memset(&listener.sa6, 0, sizeof(listener.sa6));
1069     listener.sa6.sin6_family = AF_INET6;
1070     listener.sa6.sin6_addr = in6addr_any;
1071     listener.sa6.sin6_port = htons(*listenport);
1072     rc = bind(sock, &listener.sa, sizeof(listener.sa6));
1073   }
1074 #endif /* ENABLE_IPV6 */
1075   if(rc) {
1076     error = SOCKERRNO;
1077     logmsg("Error binding socket on port %hu: (%d) %s",
1078            *listenport, error, strerror(error));
1079     sclose(sock);
1080     return CURL_SOCKET_BAD;
1081   }
1082
1083   if(!*listenport) {
1084     /* The system was supposed to choose a port number, figure out which
1085        port we actually got and update the listener port value with it. */
1086     curl_socklen_t la_size;
1087     srvr_sockaddr_union_t localaddr;
1088 #ifdef ENABLE_IPV6
1089     if(!use_ipv6)
1090 #endif
1091       la_size = sizeof(localaddr.sa4);
1092 #ifdef ENABLE_IPV6
1093     else
1094       la_size = sizeof(localaddr.sa6);
1095 #endif
1096     memset(&localaddr.sa, 0, (size_t)la_size);
1097     if(getsockname(sock, &localaddr.sa, &la_size) < 0) {
1098       error = SOCKERRNO;
1099       logmsg("getsockname() failed with error: (%d) %s",
1100              error, strerror(error));
1101       sclose(sock);
1102       return CURL_SOCKET_BAD;
1103     }
1104     switch (localaddr.sa.sa_family) {
1105     case AF_INET:
1106       *listenport = ntohs(localaddr.sa4.sin_port);
1107       break;
1108 #ifdef ENABLE_IPV6
1109     case AF_INET6:
1110       *listenport = ntohs(localaddr.sa6.sin6_port);
1111       break;
1112 #endif
1113     default:
1114       break;
1115     }
1116     if(!*listenport) {
1117       /* Real failure, listener port shall not be zero beyond this point. */
1118       logmsg("Apparently getsockname() succeeded, with listener port zero.");
1119       logmsg("A valid reason for this failure is a binary built without");
1120       logmsg("proper network library linkage. This might not be the only");
1121       logmsg("reason, but double check it before anything else.");
1122       sclose(sock);
1123       return CURL_SOCKET_BAD;
1124     }
1125   }
1126
1127   /* bindonly option forces no listening */
1128   if(bind_only) {
1129     logmsg("instructed to bind port without listening");
1130     return sock;
1131   }
1132
1133   /* start accepting connections */
1134   rc = listen(sock, 5);
1135   if(0 != rc) {
1136     error = SOCKERRNO;
1137     logmsg("listen(%d, 5) failed with error: (%d) %s",
1138            sock, error, strerror(error));
1139     sclose(sock);
1140     return CURL_SOCKET_BAD;
1141   }
1142
1143   return sock;
1144 }
1145
1146
1147 int main(int argc, char *argv[])
1148 {
1149   srvr_sockaddr_union_t me;
1150   curl_socket_t sock = CURL_SOCKET_BAD;
1151   curl_socket_t msgsock = CURL_SOCKET_BAD;
1152   int wrotepidfile = 0;
1153   char *pidname= (char *)".sockfilt.pid";
1154   bool juggle_again;
1155   int rc;
1156   int error;
1157   int arg=1;
1158   enum sockmode mode = PASSIVE_LISTEN; /* default */
1159   const char *addr = NULL;
1160
1161   while(argc>arg) {
1162     if(!strcmp("--version", argv[arg])) {
1163       printf("sockfilt IPv4%s\n",
1164 #ifdef ENABLE_IPV6
1165              "/IPv6"
1166 #else
1167              ""
1168 #endif
1169              );
1170       return 0;
1171     }
1172     else if(!strcmp("--verbose", argv[arg])) {
1173       verbose = TRUE;
1174       arg++;
1175     }
1176     else if(!strcmp("--pidfile", argv[arg])) {
1177       arg++;
1178       if(argc>arg)
1179         pidname = argv[arg++];
1180     }
1181     else if(!strcmp("--logfile", argv[arg])) {
1182       arg++;
1183       if(argc>arg)
1184         serverlogfile = argv[arg++];
1185     }
1186     else if(!strcmp("--ipv6", argv[arg])) {
1187 #ifdef ENABLE_IPV6
1188       ipv_inuse = "IPv6";
1189       use_ipv6 = TRUE;
1190 #endif
1191       arg++;
1192     }
1193     else if(!strcmp("--ipv4", argv[arg])) {
1194       /* for completeness, we support this option as well */
1195 #ifdef ENABLE_IPV6
1196       ipv_inuse = "IPv4";
1197       use_ipv6 = FALSE;
1198 #endif
1199       arg++;
1200     }
1201     else if(!strcmp("--bindonly", argv[arg])) {
1202       bind_only = TRUE;
1203       arg++;
1204     }
1205     else if(!strcmp("--port", argv[arg])) {
1206       arg++;
1207       if(argc>arg) {
1208         char *endptr;
1209         unsigned long ulnum = strtoul(argv[arg], &endptr, 10);
1210         if((endptr != argv[arg] + strlen(argv[arg])) ||
1211            ((ulnum != 0UL) && ((ulnum < 1025UL) || (ulnum > 65535UL)))) {
1212           fprintf(stderr, "sockfilt: invalid --port argument (%s)\n",
1213                   argv[arg]);
1214           return 0;
1215         }
1216         port = curlx_ultous(ulnum);
1217         arg++;
1218       }
1219     }
1220     else if(!strcmp("--connect", argv[arg])) {
1221       /* Asked to actively connect to the specified local port instead of
1222          doing a passive server-style listening. */
1223       arg++;
1224       if(argc>arg) {
1225         char *endptr;
1226         unsigned long ulnum = strtoul(argv[arg], &endptr, 10);
1227         if((endptr != argv[arg] + strlen(argv[arg])) ||
1228            (ulnum < 1025UL) || (ulnum > 65535UL)) {
1229           fprintf(stderr, "sockfilt: invalid --connect argument (%s)\n",
1230                   argv[arg]);
1231           return 0;
1232         }
1233         connectport = curlx_ultous(ulnum);
1234         arg++;
1235       }
1236     }
1237     else if(!strcmp("--addr", argv[arg])) {
1238       /* Set an IP address to use with --connect; otherwise use localhost */
1239       arg++;
1240       if(argc>arg) {
1241         addr = argv[arg];
1242         arg++;
1243       }
1244     }
1245     else {
1246       puts("Usage: sockfilt [option]\n"
1247            " --version\n"
1248            " --verbose\n"
1249            " --logfile [file]\n"
1250            " --pidfile [file]\n"
1251            " --ipv4\n"
1252            " --ipv6\n"
1253            " --bindonly\n"
1254            " --port [port]\n"
1255            " --connect [port]\n"
1256            " --addr [address]");
1257       return 0;
1258     }
1259   }
1260
1261 #ifdef WIN32
1262   win32_init();
1263   atexit(win32_cleanup);
1264
1265   setmode(fileno(stdin), O_BINARY);
1266   setmode(fileno(stdout), O_BINARY);
1267   setmode(fileno(stderr), O_BINARY);
1268 #endif
1269
1270   install_signal_handlers();
1271
1272 #ifdef ENABLE_IPV6
1273   if(!use_ipv6)
1274 #endif
1275     sock = socket(AF_INET, SOCK_STREAM, 0);
1276 #ifdef ENABLE_IPV6
1277   else
1278     sock = socket(AF_INET6, SOCK_STREAM, 0);
1279 #endif
1280
1281   if(CURL_SOCKET_BAD == sock) {
1282     error = SOCKERRNO;
1283     logmsg("Error creating socket: (%d) %s",
1284            error, strerror(error));
1285     write_stdout("FAIL\n", 5);
1286     goto sockfilt_cleanup;
1287   }
1288
1289   if(connectport) {
1290     /* Active mode, we should connect to the given port number */
1291     mode = ACTIVE;
1292 #ifdef ENABLE_IPV6
1293     if(!use_ipv6) {
1294 #endif
1295       memset(&me.sa4, 0, sizeof(me.sa4));
1296       me.sa4.sin_family = AF_INET;
1297       me.sa4.sin_port = htons(connectport);
1298       me.sa4.sin_addr.s_addr = INADDR_ANY;
1299       if (!addr)
1300         addr = "127.0.0.1";
1301       Curl_inet_pton(AF_INET, addr, &me.sa4.sin_addr);
1302
1303       rc = connect(sock, &me.sa, sizeof(me.sa4));
1304 #ifdef ENABLE_IPV6
1305     }
1306     else {
1307       memset(&me.sa6, 0, sizeof(me.sa6));
1308       me.sa6.sin6_family = AF_INET6;
1309       me.sa6.sin6_port = htons(connectport);
1310       if (!addr)
1311         addr = "::1";
1312       Curl_inet_pton(AF_INET6, addr, &me.sa6.sin6_addr);
1313
1314       rc = connect(sock, &me.sa, sizeof(me.sa6));
1315     }
1316 #endif /* ENABLE_IPV6 */
1317     if(rc) {
1318       error = SOCKERRNO;
1319       logmsg("Error connecting to port %hu: (%d) %s",
1320              connectport, error, strerror(error));
1321       write_stdout("FAIL\n", 5);
1322       goto sockfilt_cleanup;
1323     }
1324     logmsg("====> Client connect");
1325     msgsock = sock; /* use this as stream */
1326   }
1327   else {
1328     /* passive daemon style */
1329     sock = sockdaemon(sock, &port);
1330     if(CURL_SOCKET_BAD == sock) {
1331       write_stdout("FAIL\n", 5);
1332       goto sockfilt_cleanup;
1333     }
1334     msgsock = CURL_SOCKET_BAD; /* no stream socket yet */
1335   }
1336
1337   logmsg("Running %s version", ipv_inuse);
1338
1339   if(connectport)
1340     logmsg("Connected to port %hu", connectport);
1341   else if(bind_only)
1342     logmsg("Bound without listening on port %hu", port);
1343   else
1344     logmsg("Listening on port %hu", port);
1345
1346   wrotepidfile = write_pidfile(pidname);
1347   if(!wrotepidfile) {
1348     write_stdout("FAIL\n", 5);
1349     goto sockfilt_cleanup;
1350   }
1351
1352   do {
1353     juggle_again = juggle(&msgsock, sock, &mode);
1354   } while(juggle_again);
1355
1356 sockfilt_cleanup:
1357
1358   if((msgsock != sock) && (msgsock != CURL_SOCKET_BAD))
1359     sclose(msgsock);
1360
1361   if(sock != CURL_SOCKET_BAD)
1362     sclose(sock);
1363
1364   if(wrotepidfile)
1365     unlink(pidname);
1366
1367   restore_signal_handlers();
1368
1369   if(got_exit_signal) {
1370     logmsg("============> sockfilt exits with signal (%d)", exit_signal);
1371     /*
1372      * To properly set the return status of the process we
1373      * must raise the same signal SIGINT or SIGTERM that we
1374      * caught and let the old handler take care of it.
1375      */
1376     raise(exit_signal);
1377   }
1378
1379   logmsg("============> sockfilt quits");
1380   return 0;
1381 }
1382