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