tests/server/sockfilt.c

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