1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
22 #include "server_setup.h"
26 * 1. Accept a TCP connection on a custom port (ipv4 or ipv6), or connect
27 * to a given (localhost) port.
29 * 2. Get commands on STDIN. Pass data on to the TCP stream.
30 * Get data from TCP stream and pass on to STDOUT.
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:
37 * o We want the perl code to work with rather old perl installations, thus
38 * we cannot use recent perl modules or features.
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.
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.
47 * (Source originally based on sws.c)
51 * Signal handling notes for sockfilt
52 * ----------------------------------
54 * This program is a single-threaded process.
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.
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.
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.
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.
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!
86 #ifdef HAVE_NETINET_IN_H
87 #include <netinet/in.h>
89 #ifdef HAVE_ARPA_INET_H
90 #include <arpa/inet.h>
96 #define ENABLE_CURLX_PRINTF
97 /* make the curlx header define all printf() functions to use the curlx_*
99 #include "curlx.h" /* from the private lib dir */
101 #include "inet_pton.h"
103 #include "server_sockaddr.h"
104 #include "warnless.h"
106 /* include memdebug.h last */
107 #include "memdebug.h"
111 #define EINTR 4 /* errno.h value */
113 #define EAGAIN 11 /* errno.h value */
115 #define ENOMEM 12 /* errno.h value */
117 #define EINVAL 22 /* errno.h value */
120 #define DEFAULT_PORT 8999
122 #ifndef DEFAULT_LOGFILE
123 #define DEFAULT_LOGFILE "log/sockfilt.log"
126 const char *serverlogfile = DEFAULT_LOGFILE;
128 static bool verbose = FALSE;
129 static bool bind_only = FALSE;
131 static bool use_ipv6 = FALSE;
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 */
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 */
144 /* do-nothing macro replacement for systems which lack siginterrupt() */
146 #ifndef HAVE_SIGINTERRUPT
147 #define siginterrupt(x,y) do {} while(0)
150 /* vars used to keep around previous signal handlers */
152 typedef RETSIGTYPE (*SIGHANDLER_T)(int);
155 static SIGHANDLER_T old_sighup_handler = SIG_ERR;
159 static SIGHANDLER_T old_sigpipe_handler = SIG_ERR;
163 static SIGHANDLER_T old_sigalrm_handler = SIG_ERR;
167 static SIGHANDLER_T old_sigint_handler = SIG_ERR;
171 static SIGHANDLER_T old_sigterm_handler = SIG_ERR;
174 #if defined(SIGBREAK) && defined(WIN32)
175 static SIGHANDLER_T old_sigbreak_handler = SIG_ERR;
178 /* var which if set indicates that the program should finish execution */
180 SIG_ATOMIC_T got_exit_signal = 0;
182 /* if next is set indicates the first signal handled in exit_signal_handler */
184 static volatile int exit_signal = 0;
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. */
191 static RETSIGTYPE exit_signal_handler(int signum)
193 int old_errno = errno;
194 if(got_exit_signal == 0) {
196 exit_signal = signum;
198 (void)signal(signum, exit_signal_handler);
202 static void install_signal_handlers(void)
205 /* ignore SIGHUP signal */
206 if((old_sighup_handler = signal(SIGHUP, SIG_IGN)) == SIG_ERR)
207 logmsg("cannot install SIGHUP handler: %s", strerror(errno));
210 /* ignore SIGPIPE signal */
211 if((old_sigpipe_handler = signal(SIGPIPE, SIG_IGN)) == SIG_ERR)
212 logmsg("cannot install SIGPIPE handler: %s", strerror(errno));
215 /* ignore SIGALRM signal */
216 if((old_sigalrm_handler = signal(SIGALRM, SIG_IGN)) == SIG_ERR)
217 logmsg("cannot install SIGALRM handler: %s", strerror(errno));
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));
224 siginterrupt(SIGINT, 1);
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));
231 siginterrupt(SIGTERM, 1);
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));
238 siginterrupt(SIGBREAK, 1);
242 static void restore_signal_handlers(void)
245 if(SIG_ERR != old_sighup_handler)
246 (void)signal(SIGHUP, old_sighup_handler);
249 if(SIG_ERR != old_sigpipe_handler)
250 (void)signal(SIGPIPE, old_sigpipe_handler);
253 if(SIG_ERR != old_sigalrm_handler)
254 (void)signal(SIGALRM, old_sigalrm_handler);
257 if(SIG_ERR != old_sigint_handler)
258 (void)signal(SIGINT, old_sigint_handler);
261 if(SIG_ERR != old_sigterm_handler)
262 (void)signal(SIGTERM, old_sigterm_handler);
264 #if defined(SIGBREAK) && defined(WIN32)
265 if(SIG_ERR != old_sigbreak_handler)
266 (void)signal(SIGBREAK, old_sigbreak_handler);
272 * read-wrapper to support reading from stdin on Windows.
274 static ssize_t read_wincon(int fd, void *buf, size_t count)
276 HANDLE handle = NULL;
277 DWORD mode, rcount = 0;
280 if(fd == fileno(stdin)) {
281 handle = GetStdHandle(STD_INPUT_HANDLE);
284 return read(fd, buf, count);
287 if(GetConsoleMode(handle, &mode)) {
288 success = ReadConsole(handle, buf, count, &rcount, NULL);
291 success = ReadFile(handle, buf, count, &rcount, NULL);
297 errno = GetLastError();
301 #define read(a,b,c) read_wincon(a,b,c)
304 * write-wrapper to support writing to stdout and stderr on Windows.
306 static ssize_t write_wincon(int fd, const void *buf, size_t count)
308 HANDLE handle = NULL;
309 DWORD mode, wcount = 0;
312 if(fd == fileno(stdout)) {
313 handle = GetStdHandle(STD_OUTPUT_HANDLE);
315 else if(fd == fileno(stderr)) {
316 handle = GetStdHandle(STD_ERROR_HANDLE);
319 return write(fd, buf, count);
322 if(GetConsoleMode(handle, &mode)) {
323 success = WriteConsole(handle, buf, count, &wcount, NULL);
326 success = WriteFile(handle, buf, count, &wcount, NULL);
332 errno = GetLastError();
336 #define write(a,b,c) write_wincon(a,b,c)
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.
346 static ssize_t fullread(int filedes, void *buffer, size_t nbytes)
353 rc = read(filedes, (unsigned char *)buffer + nread, nbytes - nread);
355 if(got_exit_signal) {
356 logmsg("signalled to die");
362 if((error == EINTR) || (error == EAGAIN))
364 logmsg("reading from file descriptor: %d,", filedes);
365 logmsg("unrecoverable read() failure: (%d) %s",
366 error, strerror(error));
371 logmsg("got 0 reading from stdin");
377 } while((size_t)nread < nbytes);
380 logmsg("read %zd bytes", nread);
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.
392 static ssize_t fullwrite(int filedes, const void *buffer, size_t nbytes)
399 wc = write(filedes, (unsigned char *)buffer + nwrite, nbytes - nwrite);
401 if(got_exit_signal) {
402 logmsg("signalled to die");
408 if((error == EINTR) || (error == EAGAIN))
410 logmsg("writing to file descriptor: %d,", filedes);
411 logmsg("unrecoverable write() failure: (%d) %s",
412 error, strerror(error));
417 logmsg("put 0 writing to stdout");
423 } while((size_t)nwrite < nbytes);
426 logmsg("wrote %zd bytes", nwrite);
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.
438 static bool read_stdin(void *buffer, size_t nbytes)
440 ssize_t nread = fullread(fileno(stdin), buffer, nbytes);
441 if(nread != (ssize_t)nbytes) {
442 logmsg("exiting...");
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.
455 static bool write_stdout(const void *buffer, size_t nbytes)
457 ssize_t nwrite = fullwrite(fileno(stdout), buffer, nbytes);
458 if(nwrite != (ssize_t)nbytes) {
459 logmsg("exiting...");
465 static void lograw(unsigned char *buffer, ssize_t len)
469 unsigned char *ptr = buffer;
473 for(i=0; i<len; i++) {
476 sprintf(optr, "\\n");
481 sprintf(optr, "\\r");
486 sprintf(optr, "%c", (ISGRAPH(ptr[i]) || ptr[i]==0x20) ?ptr[i]:'.');
493 logmsg("'%s'", data);
499 logmsg("'%s'", data);
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.
508 * select() function with support for WINSOCK2 sockets and all
509 * other handle types supported by WaitForMultipleObjectsEx().
511 * TODO: Differentiate between read/write/except for non-SOCKET handles.
513 * http://msdn.microsoft.com/en-us/library/windows/desktop/ms687028.aspx
514 * http://msdn.microsoft.com/en-us/library/windows/desktop/ms741572.aspx
516 static DWORD WINAPI select_ws_stdin_wait_thread(LPVOID lpParameter)
518 HANDLE handle, handles[2];
519 INPUT_RECORD inputrecord;
520 LARGE_INTEGER size, pos;
523 handle = GetStdHandle(STD_INPUT_HANDLE);
524 handles[0] = (HANDLE) lpParameter;
526 type = GetFileType(handle);
530 while(WaitForMultipleObjectsEx(2, handles, FALSE, INFINITE, FALSE)
531 == WAIT_OBJECT_0 + 1) {
533 if(GetFileSizeEx(handle, &size)) {
535 if(SetFilePointerEx(handle, pos, &pos, FILE_CURRENT)) {
536 if(size.QuadPart == pos.QuadPart)
550 while(WaitForMultipleObjectsEx(2, handles, FALSE, INFINITE, FALSE)
551 == WAIT_OBJECT_0 + 1) {
552 if(GetConsoleMode(handle, &length)) {
554 if(PeekConsoleInput(handle, &inputrecord, 1, &length)) {
555 if(length == 1 && inputrecord.EventType != KEY_EVENT)
556 ReadConsoleInput(handle, &inputrecord, 1, &length);
569 while(WaitForMultipleObjectsEx(2, handles, FALSE, INFINITE, FALSE)
570 == WAIT_OBJECT_0 + 1) {
571 if(PeekNamedPipe(handle, NULL, 0, NULL, &length, NULL)) {
578 if(GetLastError() == ERROR_BROKEN_PIPE)
587 WaitForMultipleObjectsEx(2, handles, FALSE, INFINITE, FALSE);
593 static int select_ws(int nfds, fd_set *readfds, fd_set *writefds,
594 fd_set *exceptfds, struct timeval *timeout)
596 DWORD milliseconds, wait, idx;
597 WSAEVENT wsaevent, *wsaevents;
598 WSANETWORKEVENTS wsanetevents;
599 HANDLE handle, *handles;
600 curl_socket_t sock, *fdarr, *wsasocks;
603 HANDLE threadevent = NULL, threadhandle = NULL;
604 DWORD nfd = 0, wsa = 0;
607 /* check if the input value is valid */
613 /* check if we got descriptors, sleep in case we got none */
615 Sleep((timeout->tv_sec * 1000) + (timeout->tv_usec / 1000));
619 /* allocate internal array for the original input handles */
620 fdarr = malloc(nfds * sizeof(curl_socket_t));
626 /* allocate internal array for the internal event handles */
627 handles = malloc(nfds * sizeof(HANDLE));
628 if(handles == NULL) {
634 /* allocate internal array for the internal socket handles */
635 wsasocks = malloc(nfds * sizeof(curl_socket_t));
636 if(wsasocks == NULL) {
643 /* allocate internal array for the internal WINSOCK2 events */
644 wsaevents = malloc(nfds * sizeof(WSAEVENT));
645 if(wsaevents == NULL) {
653 /* loop over the handles in the input descriptor sets */
654 for(fds = 0; fds < nfds; fds++) {
658 if(FD_ISSET(fds, readfds))
659 networkevents |= FD_READ|FD_ACCEPT|FD_CLOSE;
661 if(FD_ISSET(fds, writefds))
662 networkevents |= FD_WRITE|FD_CONNECT;
664 if(FD_ISSET(fds, exceptfds))
665 networkevents |= FD_OOB|FD_CLOSE;
667 /* only wait for events for which we actually care */
669 fdarr[nfd] = curlx_sitosk(fds);
670 if(fds == fileno(stdin)) {
671 threadevent = CreateEvent(NULL, TRUE, FALSE, NULL);
672 threadhandle = CreateThread(NULL, 0,
673 &select_ws_stdin_wait_thread,
674 threadevent, 0, NULL);
675 handles[nfd] = threadhandle;
677 else if(fds == fileno(stdout)) {
678 handles[nfd] = GetStdHandle(STD_OUTPUT_HANDLE);
680 else if(fds == fileno(stderr)) {
681 handles[nfd] = GetStdHandle(STD_ERROR_HANDLE);
684 wsaevent = WSACreateEvent();
685 if(wsaevent != WSA_INVALID_EVENT) {
686 error = WSAEventSelect(fds, wsaevent, networkevents);
687 if(error != SOCKET_ERROR) {
688 handles[nfd] = wsaevent;
689 wsasocks[wsa] = curlx_sitosk(fds);
690 wsaevents[wsa] = wsaevent;
694 handles[nfd] = (HANDLE) curlx_sitosk(fds);
695 WSACloseEvent(wsaevent);
703 /* convert struct timeval to milliseconds */
705 milliseconds = ((timeout->tv_sec * 1000) + (timeout->tv_usec / 1000));
708 milliseconds = INFINITE;
711 /* wait for one of the internal handles to trigger */
712 wait = WaitForMultipleObjectsEx(nfd, handles, FALSE, milliseconds, FALSE);
714 /* signal the event handle for the waiting thread */
716 SetEvent(threadevent);
719 /* loop over the internal handles returned in the descriptors */
720 for(idx = 0; idx < nfd; idx++) {
721 handle = handles[idx];
723 fds = curlx_sktosi(sock);
725 /* check if the current internal handle was triggered */
726 if(wait != WAIT_FAILED && (wait - WAIT_OBJECT_0) <= idx &&
727 WaitForSingleObjectEx(handle, 0, FALSE) == WAIT_OBJECT_0) {
728 /* first handle stdin, stdout and stderr */
729 if(fds == fileno(stdin)) {
730 /* stdin is never ready for write or exceptional */
731 FD_CLR(sock, writefds);
732 FD_CLR(sock, exceptfds);
734 else if(fds == fileno(stdout) || fds == fileno(stderr)) {
735 /* stdout and stderr are never ready for read or exceptional */
736 FD_CLR(sock, readfds);
737 FD_CLR(sock, exceptfds);
740 /* try to handle the event with the WINSOCK2 functions */
741 wsanetevents.lNetworkEvents = 0;
742 error = WSAEnumNetworkEvents(fds, handle, &wsanetevents);
743 if(error != SOCKET_ERROR) {
744 /* remove from descriptor set if not ready for read/accept/close */
745 if(!(wsanetevents.lNetworkEvents & (FD_READ|FD_ACCEPT|FD_CLOSE)))
746 FD_CLR(sock, readfds);
748 /* remove from descriptor set if not ready for write/connect */
749 if(!(wsanetevents.lNetworkEvents & (FD_WRITE|FD_CONNECT)))
750 FD_CLR(sock, writefds);
753 * use exceptfds together with readfds to signal
754 * that the connection was closed by the client.
756 * Reason: FD_CLOSE is only signaled once, sometimes
757 * at the same time as FD_READ with data being available.
758 * This means that recv/sread is not reliable to detect
759 * that the connection is closed.
761 /* remove from descriptor set if not exceptional */
762 if(!(wsanetevents.lNetworkEvents & (FD_OOB|FD_CLOSE)))
763 FD_CLR(sock, exceptfds);
767 /* check if the event has not been filtered using specific tests */
768 if(FD_ISSET(sock, readfds) || FD_ISSET(sock, writefds) ||
769 FD_ISSET(sock, exceptfds)) {
774 /* remove from all descriptor sets since this handle did not trigger */
775 FD_CLR(sock, readfds);
776 FD_CLR(sock, writefds);
777 FD_CLR(sock, exceptfds);
781 for(idx = 0; idx < wsa; idx++) {
782 WSAEventSelect(wsasocks[idx], NULL, 0);
783 WSACloseEvent(wsaevents[idx]);
787 WaitForSingleObject(threadhandle, INFINITE);
788 CloseHandle(threadhandle);
791 CloseHandle(threadevent);
801 #define select(a,b,c,d,e) select_ws(a,b,c,d,e)
802 #endif /* USE_WINSOCK */
805 sockfdp is a pointer to an established stream or CURL_SOCKET_BAD
807 if sockfd is CURL_SOCKET_BAD, listendfd is a listening socket we must
810 static bool juggle(curl_socket_t *sockfdp,
811 curl_socket_t listenfd,
814 struct timeval timeout;
818 curl_socket_t sockfd = CURL_SOCKET_BAD;
821 ssize_t nread_socket;
822 ssize_t bytes_written;
826 /* 'buffer' is this excessively large only to be able to support things like
827 test 1003 which tests exceedingly large server response lines */
828 unsigned char buffer[17010];
831 if(got_exit_signal) {
832 logmsg("signalled to die, exiting...");
837 /* As a last resort, quit if sockfilt process becomes orphan. Just in case
838 parent ftpserver process has died without killing its sockfilt children */
840 logmsg("process becomes orphan, exiting");
845 timeout.tv_sec = 120;
852 FD_SET((curl_socket_t)fileno(stdin), &fds_read);
860 /* there's always a socket to wait for */
861 FD_SET(sockfd, &fds_read);
865 case PASSIVE_CONNECT:
868 if(CURL_SOCKET_BAD == sockfd) {
869 /* eeek, we are supposedly connected and then this cannot be -1 ! */
870 logmsg("socket is -1! on %s:%d", __FILE__, __LINE__);
871 maxfd = 0; /* stdin */
874 /* there's always a socket to wait for */
875 FD_SET(sockfd, &fds_read);
877 FD_SET(sockfd, &fds_err);
886 /* sockfd turns CURL_SOCKET_BAD when our connection has been closed */
887 if(CURL_SOCKET_BAD != sockfd) {
888 FD_SET(sockfd, &fds_read);
890 FD_SET(sockfd, &fds_err);
895 logmsg("No socket to read on");
900 case ACTIVE_DISCONNECT:
902 logmsg("disconnected, no socket to read on");
904 sockfd = CURL_SOCKET_BAD;
907 } /* switch(*mode) */
912 /* select() blocking behavior call on blocking descriptors please */
914 rc = select(maxfd + 1, &fds_read, &fds_write, &fds_err, &timeout);
916 if(got_exit_signal) {
917 logmsg("signalled to die, exiting...");
921 } while((rc == -1) && ((error = errno) == EINTR));
924 logmsg("select() failed with error: (%d) %s",
925 error, strerror(error));
934 if(FD_ISSET(fileno(stdin), &fds_read)) {
935 /* read from stdin, commands/data to be dealt with and possibly passed on
940 4 letter command + LF [mandatory]
942 4-digit hexadecimal data length + LF [if the command takes data]
943 data [the data being as long as set above]
947 DATA - plain pass-thru data
950 if(!read_stdin(buffer, 5))
953 logmsg("Received %c%c%c%c (on stdin)",
954 buffer[0], buffer[1], buffer[2], buffer[3] );
956 if(!memcmp("PING", buffer, 4)) {
957 /* send reply on stdout, just proving we are alive */
958 if(!write_stdout("PONG\n", 5))
962 else if(!memcmp("PORT", buffer, 4)) {
963 /* Question asking us what PORT number we are listening to.
964 Replies to PORT with "IPv[num]/[port]" */
965 sprintf((char *)buffer, "%s/%hu\n", ipv_inuse, port);
966 buffer_len = (ssize_t)strlen((char *)buffer);
967 snprintf(data, sizeof(data), "PORT\n%04zx\n", buffer_len);
968 if(!write_stdout(data, 10))
970 if(!write_stdout(buffer, buffer_len))
973 else if(!memcmp("QUIT", buffer, 4)) {
978 else if(!memcmp("DATA", buffer, 4)) {
979 /* data IN => data OUT */
981 if(!read_stdin(buffer, 5))
986 buffer_len = (ssize_t)strtol((char *)buffer, NULL, 16);
987 if (buffer_len > (ssize_t)sizeof(buffer)) {
988 logmsg("ERROR: Buffer size (%zu bytes) too small for data size "
989 "(%zd bytes)", sizeof(buffer), buffer_len);
992 logmsg("> %zd bytes data, server => client", buffer_len);
994 if(!read_stdin(buffer, buffer_len))
997 lograw(buffer, buffer_len);
999 if(*mode == PASSIVE_LISTEN) {
1000 logmsg("*** We are disconnected!");
1001 if(!write_stdout("DISC\n", 5))
1005 /* send away on the socket */
1006 bytes_written = swrite(sockfd, buffer, buffer_len);
1007 if(bytes_written != buffer_len) {
1008 logmsg("Not all data was sent. Bytes to send: %zd sent: %zd",
1009 buffer_len, bytes_written);
1013 else if(!memcmp("DISC", buffer, 4)) {
1015 if(!write_stdout("DISC\n", 5))
1017 if(sockfd != CURL_SOCKET_BAD) {
1018 logmsg("====> Client forcibly disconnected");
1020 *sockfdp = CURL_SOCKET_BAD;
1021 if(*mode == PASSIVE_CONNECT)
1022 *mode = PASSIVE_LISTEN;
1024 *mode = ACTIVE_DISCONNECT;
1027 logmsg("attempt to close already dead connection");
1033 if((sockfd != CURL_SOCKET_BAD) && (FD_ISSET(sockfd, &fds_read)) ) {
1035 curl_socket_t newfd = CURL_SOCKET_BAD; /* newly accepted socket */
1037 if(*mode == PASSIVE_LISTEN) {
1038 /* there's no stream set up yet, this is an indication that there's a
1039 client connecting. */
1040 newfd = accept(sockfd, NULL, NULL);
1041 if(CURL_SOCKET_BAD == newfd) {
1043 logmsg("accept(%d, NULL, NULL) failed with error: (%d) %s",
1044 sockfd, error, strerror(error));
1047 logmsg("====> Client connect");
1048 if(!write_stdout("CNCT\n", 5))
1050 *sockfdp = newfd; /* store the new socket */
1051 *mode = PASSIVE_CONNECT; /* we have connected */
1056 /* read from socket, pass on data to stdout */
1057 nread_socket = sread(sockfd, buffer, sizeof(buffer));
1059 if(nread_socket > 0) {
1060 snprintf(data, sizeof(data), "DATA\n%04zx\n", nread_socket);
1061 if(!write_stdout(data, 10))
1063 if(!write_stdout(buffer, nread_socket))
1066 logmsg("< %zd bytes data, client => server", nread_socket);
1067 lograw(buffer, nread_socket);
1070 if(nread_socket <= 0
1072 || FD_ISSET(sockfd, &fds_err)
1075 logmsg("====> Client disconnect");
1076 if(!write_stdout("DISC\n", 5))
1079 *sockfdp = CURL_SOCKET_BAD;
1080 if(*mode == PASSIVE_CONNECT)
1081 *mode = PASSIVE_LISTEN;
1083 *mode = ACTIVE_DISCONNECT;
1091 static curl_socket_t sockdaemon(curl_socket_t sock,
1092 unsigned short *listenport)
1094 /* passive daemon style */
1095 srvr_sockaddr_union_t listener;
1107 rc = setsockopt(sock, SOL_SOCKET, SO_REUSEADDR,
1108 (void *)&flag, sizeof(flag));
1111 logmsg("setsockopt(SO_REUSEADDR) failed with error: (%d) %s",
1112 error, strerror(error));
1114 rc = wait_ms(delay);
1116 /* should not happen */
1118 logmsg("wait_ms() failed with error: (%d) %s",
1119 error, strerror(error));
1121 return CURL_SOCKET_BAD;
1123 if(got_exit_signal) {
1124 logmsg("signalled to die, exiting...");
1126 return CURL_SOCKET_BAD;
1129 delay *= 2; /* double the sleep for next attempt */
1132 } while(rc && maxretr--);
1135 logmsg("setsockopt(SO_REUSEADDR) failed %d times in %d ms. Error: (%d) %s",
1136 attempt, totdelay, error, strerror(error));
1137 logmsg("Continuing anyway...");
1140 /* When the specified listener port is zero, it is actually a
1141 request to let the system choose a non-zero available port. */
1146 memset(&listener.sa4, 0, sizeof(listener.sa4));
1147 listener.sa4.sin_family = AF_INET;
1148 listener.sa4.sin_addr.s_addr = INADDR_ANY;
1149 listener.sa4.sin_port = htons(*listenport);
1150 rc = bind(sock, &listener.sa, sizeof(listener.sa4));
1154 memset(&listener.sa6, 0, sizeof(listener.sa6));
1155 listener.sa6.sin6_family = AF_INET6;
1156 listener.sa6.sin6_addr = in6addr_any;
1157 listener.sa6.sin6_port = htons(*listenport);
1158 rc = bind(sock, &listener.sa, sizeof(listener.sa6));
1160 #endif /* ENABLE_IPV6 */
1163 logmsg("Error binding socket on port %hu: (%d) %s",
1164 *listenport, error, strerror(error));
1166 return CURL_SOCKET_BAD;
1170 /* The system was supposed to choose a port number, figure out which
1171 port we actually got and update the listener port value with it. */
1172 curl_socklen_t la_size;
1173 srvr_sockaddr_union_t localaddr;
1177 la_size = sizeof(localaddr.sa4);
1180 la_size = sizeof(localaddr.sa6);
1182 memset(&localaddr.sa, 0, (size_t)la_size);
1183 if(getsockname(sock, &localaddr.sa, &la_size) < 0) {
1185 logmsg("getsockname() failed with error: (%d) %s",
1186 error, strerror(error));
1188 return CURL_SOCKET_BAD;
1190 switch (localaddr.sa.sa_family) {
1192 *listenport = ntohs(localaddr.sa4.sin_port);
1196 *listenport = ntohs(localaddr.sa6.sin6_port);
1203 /* Real failure, listener port shall not be zero beyond this point. */
1204 logmsg("Apparently getsockname() succeeded, with listener port zero.");
1205 logmsg("A valid reason for this failure is a binary built without");
1206 logmsg("proper network library linkage. This might not be the only");
1207 logmsg("reason, but double check it before anything else.");
1209 return CURL_SOCKET_BAD;
1213 /* bindonly option forces no listening */
1215 logmsg("instructed to bind port without listening");
1219 /* start accepting connections */
1220 rc = listen(sock, 5);
1223 logmsg("listen(%d, 5) failed with error: (%d) %s",
1224 sock, error, strerror(error));
1226 return CURL_SOCKET_BAD;
1233 int main(int argc, char *argv[])
1235 srvr_sockaddr_union_t me;
1236 curl_socket_t sock = CURL_SOCKET_BAD;
1237 curl_socket_t msgsock = CURL_SOCKET_BAD;
1238 int wrotepidfile = 0;
1239 char *pidname= (char *)".sockfilt.pid";
1244 enum sockmode mode = PASSIVE_LISTEN; /* default */
1245 const char *addr = NULL;
1248 if(!strcmp("--version", argv[arg])) {
1249 printf("sockfilt IPv4%s\n",
1258 else if(!strcmp("--verbose", argv[arg])) {
1262 else if(!strcmp("--pidfile", argv[arg])) {
1265 pidname = argv[arg++];
1267 else if(!strcmp("--logfile", argv[arg])) {
1270 serverlogfile = argv[arg++];
1272 else if(!strcmp("--ipv6", argv[arg])) {
1279 else if(!strcmp("--ipv4", argv[arg])) {
1280 /* for completeness, we support this option as well */
1287 else if(!strcmp("--bindonly", argv[arg])) {
1291 else if(!strcmp("--port", argv[arg])) {
1295 unsigned long ulnum = strtoul(argv[arg], &endptr, 10);
1296 if((endptr != argv[arg] + strlen(argv[arg])) ||
1297 ((ulnum != 0UL) && ((ulnum < 1025UL) || (ulnum > 65535UL)))) {
1298 fprintf(stderr, "sockfilt: invalid --port argument (%s)\n",
1302 port = curlx_ultous(ulnum);
1306 else if(!strcmp("--connect", argv[arg])) {
1307 /* Asked to actively connect to the specified local port instead of
1308 doing a passive server-style listening. */
1312 unsigned long ulnum = strtoul(argv[arg], &endptr, 10);
1313 if((endptr != argv[arg] + strlen(argv[arg])) ||
1314 (ulnum < 1025UL) || (ulnum > 65535UL)) {
1315 fprintf(stderr, "sockfilt: invalid --connect argument (%s)\n",
1319 connectport = curlx_ultous(ulnum);
1323 else if(!strcmp("--addr", argv[arg])) {
1324 /* Set an IP address to use with --connect; otherwise use localhost */
1332 puts("Usage: sockfilt [option]\n"
1335 " --logfile [file]\n"
1336 " --pidfile [file]\n"
1341 " --connect [port]\n"
1342 " --addr [address]");
1349 atexit(win32_cleanup);
1351 setmode(fileno(stdin), O_BINARY);
1352 setmode(fileno(stdout), O_BINARY);
1353 setmode(fileno(stderr), O_BINARY);
1356 install_signal_handlers();
1361 sock = socket(AF_INET, SOCK_STREAM, 0);
1364 sock = socket(AF_INET6, SOCK_STREAM, 0);
1367 if(CURL_SOCKET_BAD == sock) {
1369 logmsg("Error creating socket: (%d) %s",
1370 error, strerror(error));
1371 write_stdout("FAIL\n", 5);
1372 goto sockfilt_cleanup;
1376 /* Active mode, we should connect to the given port number */
1381 memset(&me.sa4, 0, sizeof(me.sa4));
1382 me.sa4.sin_family = AF_INET;
1383 me.sa4.sin_port = htons(connectport);
1384 me.sa4.sin_addr.s_addr = INADDR_ANY;
1387 Curl_inet_pton(AF_INET, addr, &me.sa4.sin_addr);
1389 rc = connect(sock, &me.sa, sizeof(me.sa4));
1393 memset(&me.sa6, 0, sizeof(me.sa6));
1394 me.sa6.sin6_family = AF_INET6;
1395 me.sa6.sin6_port = htons(connectport);
1398 Curl_inet_pton(AF_INET6, addr, &me.sa6.sin6_addr);
1400 rc = connect(sock, &me.sa, sizeof(me.sa6));
1402 #endif /* ENABLE_IPV6 */
1405 logmsg("Error connecting to port %hu: (%d) %s",
1406 connectport, error, strerror(error));
1407 write_stdout("FAIL\n", 5);
1408 goto sockfilt_cleanup;
1410 logmsg("====> Client connect");
1411 msgsock = sock; /* use this as stream */
1414 /* passive daemon style */
1415 sock = sockdaemon(sock, &port);
1416 if(CURL_SOCKET_BAD == sock) {
1417 write_stdout("FAIL\n", 5);
1418 goto sockfilt_cleanup;
1420 msgsock = CURL_SOCKET_BAD; /* no stream socket yet */
1423 logmsg("Running %s version", ipv_inuse);
1426 logmsg("Connected to port %hu", connectport);
1428 logmsg("Bound without listening on port %hu", port);
1430 logmsg("Listening on port %hu", port);
1432 wrotepidfile = write_pidfile(pidname);
1434 write_stdout("FAIL\n", 5);
1435 goto sockfilt_cleanup;
1439 juggle_again = juggle(&msgsock, sock, &mode);
1440 } while(juggle_again);
1444 if((msgsock != sock) && (msgsock != CURL_SOCKET_BAD))
1447 if(sock != CURL_SOCKET_BAD)
1453 restore_signal_handlers();
1455 if(got_exit_signal) {
1456 logmsg("============> sockfilt exits with signal (%d)", exit_signal);
1458 * To properly set the return status of the process we
1459 * must raise the same signal SIGINT or SIGTERM that we
1460 * caught and let the old handler take care of it.
1465 logmsg("============> sockfilt quits");