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