2 * Socket functions used in rsync.
4 * Copyright (C) 1992-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2003-2020 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
22 /* This file is now converted to use the new-style getaddrinfo()
23 * interface, which supports IPv6 but is also supported on recent
24 * IPv4-only machines. On systems that don't have that interface, we
25 * emulate it using the KAME implementation. */
29 #ifdef HAVE_NETINET_IN_SYSTM_H
30 #include <netinet/in_systm.h>
32 #ifdef HAVE_NETINET_IP_H
33 #include <netinet/ip.h>
35 #include <netinet/tcp.h>
37 extern char *bind_address
;
38 extern char *sockopts
;
39 extern int default_af_hint
;
40 extern int connect_timeout
;
41 extern int pid_file_fd
;
44 static struct sigaction sigact
;
47 static int sock_exec(const char *prog
);
49 /* Establish a proxy connection on an open socket to a web proxy by using the
50 * CONNECT method. If proxy_user and proxy_pass are not NULL, they are used to
51 * authenticate to the proxy using the "Basic" proxy-authorization protocol. */
52 static int establish_proxy_connection(int fd
, char *host
, int port
, char *proxy_user
, char *proxy_pass
)
54 char *cp
, buffer
[1024];
55 char *authhdr
, authbuf
[1024];
58 if (proxy_user
&& proxy_pass
) {
59 stringjoin(buffer
, sizeof buffer
,
60 proxy_user
, ":", proxy_pass
, NULL
);
63 if ((len
*8 + 5) / 6 >= (int)sizeof authbuf
- 3) {
65 "authentication information is too long\n");
69 base64_encode(buffer
, len
, authbuf
, 1);
70 authhdr
= "\r\nProxy-Authorization: Basic ";
76 len
= snprintf(buffer
, sizeof buffer
, "CONNECT %s:%d HTTP/1.0%s%s\r\n\r\n", host
, port
, authhdr
, authbuf
);
77 assert(len
> 0 && len
< (int)sizeof buffer
);
78 if (write(fd
, buffer
, len
) != len
) {
79 rsyserr(FERROR
, errno
, "failed to write to proxy");
83 for (cp
= buffer
; cp
< &buffer
[sizeof buffer
- 1]; cp
++) {
84 if (read(fd
, cp
, 1) != 1) {
85 rsyserr(FERROR
, errno
, "failed to read from proxy");
97 if (strncmp(buffer
, "HTTP/", 5) != 0) {
98 rprintf(FERROR
, "bad response from proxy -- %s\n",
102 for (cp
= &buffer
[5]; isDigit(cp
) || *cp
== '.'; cp
++) {}
106 rprintf(FERROR
, "bad response from proxy -- %s\n",
110 /* throw away the rest of the HTTP header */
112 for (cp
= buffer
; cp
< &buffer
[sizeof buffer
- 1]; cp
++) {
113 if (read(fd
, cp
, 1) != 1) {
114 rsyserr(FERROR
, errno
,
115 "failed to read from proxy");
121 if (cp
> buffer
&& *cp
== '\n')
123 if (cp
== buffer
&& (*cp
== '\n' || *cp
== '\r'))
130 /* Try to set the local address for a newly-created socket.
131 * Return -1 if this fails. */
132 int try_bind_local(int s
, int ai_family
, int ai_socktype
,
133 const char *bind_addr
)
136 struct addrinfo bhints
, *bres_all
, *r
;
138 memset(&bhints
, 0, sizeof bhints
);
139 bhints
.ai_family
= ai_family
;
140 bhints
.ai_socktype
= ai_socktype
;
141 bhints
.ai_flags
= AI_PASSIVE
;
142 if ((error
= getaddrinfo(bind_addr
, NULL
, &bhints
, &bres_all
))) {
143 rprintf(FERROR
, RSYNC_NAME
": getaddrinfo %s: %s\n",
144 bind_addr
, gai_strerror(error
));
148 for (r
= bres_all
; r
; r
= r
->ai_next
) {
149 if (bind(s
, r
->ai_addr
, r
->ai_addrlen
) == -1)
151 freeaddrinfo(bres_all
);
155 /* no error message; there might be some problem that allows
156 * creation of the socket but not binding, perhaps if the
157 * machine has no ipv6 address of this name. */
158 freeaddrinfo(bres_all
);
162 /* connect() timeout handler based on alarm() */
163 static void contimeout_handler(UNUSED(int val
))
165 connect_timeout
= -1;
168 /* Open a socket to a tcp remote host with the specified port.
170 * Based on code from Warren. Proxy support by Stephen Rothwell.
171 * getaddrinfo() rewrite contributed by KAME.net.
173 * Now that we support IPv6 we need to look up the remote machine's address
174 * first, using af_hint to set a preference for the type of address. Then
175 * depending on whether it has v4 or v6 addresses we try to open a connection.
177 * The loop allows for machines with some addresses which may not be reachable,
178 * perhaps because we can't e.g. route ipv6 to that network but we can get ip4
181 * bind_addr: local address to use. Normally NULL to bind the wildcard address.
183 * af_hint: address family, e.g. AF_INET or AF_INET6. */
184 int open_socket_out(char *host
, int port
, const char *bind_addr
, int af_hint
)
186 int type
= SOCK_STREAM
;
187 int error
, s
, j
, addr_cnt
, *errnos
;
188 struct addrinfo hints
, *res0
, *res
;
193 char *proxy_user
= NULL
, *proxy_pass
= NULL
;
195 /* if we have a RSYNC_PROXY env variable then redirect our
196 * connection via a web proxy at the given address. */
197 h
= getenv("RSYNC_PROXY");
198 proxied
= h
!= NULL
&& *h
!= '\0';
201 strlcpy(buffer
, h
, sizeof buffer
);
203 /* Is the USER:PASS@ prefix present? */
204 if ((cp
= strrchr(buffer
, '@')) != NULL
) {
206 /* The remainder is the HOST:PORT part. */
209 if ((cp
= strchr(buffer
, ':')) == NULL
) {
211 "invalid proxy specification: should be USER:PASS@HOST:PORT\n");
219 /* The whole buffer is the HOST:PORT part. */
223 if ((cp
= strchr(h
, ':')) == NULL
) {
225 "invalid proxy specification: should be HOST:PORT\n");
229 strlcpy(portbuf
, cp
, sizeof portbuf
);
230 if (DEBUG_GTE(CONNECT
, 1)) {
231 rprintf(FINFO
, "connection via http proxy %s port %s\n",
235 snprintf(portbuf
, sizeof portbuf
, "%d", port
);
239 memset(&hints
, 0, sizeof hints
);
240 hints
.ai_family
= af_hint
;
241 hints
.ai_socktype
= type
;
242 error
= getaddrinfo(h
, portbuf
, &hints
, &res0
);
244 rprintf(FERROR
, RSYNC_NAME
": getaddrinfo: %s %s: %s\n",
245 h
, portbuf
, gai_strerror(error
));
249 for (res
= res0
, addr_cnt
= 0; res
; res
= res
->ai_next
, addr_cnt
++) {}
250 errnos
= new_array0(int, addr_cnt
);
252 out_of_memory("open_socket_out");
255 /* Try to connect to all addresses for this machine until we get
256 * through. It might e.g. be multi-homed, or have both IPv4 and IPv6
257 * addresses. We need to create a socket for each record, since the
258 * address record tells us what protocol to use to try to connect. */
259 for (res
= res0
, j
= 0; res
; res
= res
->ai_next
, j
++) {
260 s
= socket(res
->ai_family
, res
->ai_socktype
, res
->ai_protocol
);
265 && try_bind_local(s
, res
->ai_family
, type
,
271 if (connect_timeout
> 0) {
272 SIGACTION(SIGALRM
, contimeout_handler
);
273 alarm(connect_timeout
);
276 set_socket_options(s
, sockopts
);
277 while (connect(s
, res
->ai_addr
, res
->ai_addrlen
) < 0) {
278 if (connect_timeout
< 0)
279 exit_cleanup(RERR_CONTIMEOUT
);
287 if (connect_timeout
> 0)
295 if (proxied
&& establish_proxy_connection(s
, host
, port
, proxy_user
, proxy_pass
) != 0) {
300 if (DEBUG_GTE(CONNECT
, 2)) {
302 if ((error
= getnameinfo(res
->ai_addr
, res
->ai_addrlen
, buf
, sizeof buf
, NULL
, 0, NI_NUMERICHOST
)) != 0)
303 snprintf(buf
, sizeof buf
, "*getnameinfo failure: %s*", gai_strerror(error
));
304 rprintf(FINFO
, "Connected to %s (%s)\n", h
, buf
);
309 if (s
< 0 || DEBUG_GTE(CONNECT
, 2)) {
311 for (res
= res0
, j
= 0; res
; res
= res
->ai_next
, j
++) {
314 if ((error
= getnameinfo(res
->ai_addr
, res
->ai_addrlen
, buf
, sizeof buf
, NULL
, 0, NI_NUMERICHOST
)) != 0)
315 snprintf(buf
, sizeof buf
, "*getnameinfo failure: %s*", gai_strerror(error
));
316 rsyserr(FERROR
, errnos
[j
], "failed to connect to %s (%s)", h
, buf
);
329 /* Open an outgoing socket, but allow for it to be intercepted by
330 * $RSYNC_CONNECT_PROG, which will execute a program across a TCP
331 * socketpair rather than really opening a socket.
333 * We use this primarily in testing to detect TCP flow bugs, but not
334 * cause security problems by really opening remote connections.
336 * This is based on the Samba LIBSMB_PROG feature.
338 * bind_addr: local address to use. Normally NULL to get the stack default. */
339 int open_socket_out_wrapped(char *host
, int port
, const char *bind_addr
, int af_hint
)
341 char *prog
= getenv("RSYNC_CONNECT_PROG");
343 if (prog
&& strchr(prog
, '%')) {
344 int hlen
= strlen(host
);
345 int len
= strlen(prog
) + 1;
347 for (f
= prog
; *f
; f
++) {
350 /* Compute more than enough room. */
357 if (!(prog
= new_array(char, len
)))
358 out_of_memory("open_socket_out_wrapped");
359 for (t
= prog
; *f
; f
++) {
363 /* Just skips the extra '%'. */
366 memcpy(t
, host
, hlen
);
370 f
--; /* pass % through */
379 if (DEBUG_GTE(CONNECT
, 1)) {
380 rprintf(FINFO
, "%sopening tcp connection to %s port %d\n",
381 prog
? "Using RSYNC_CONNECT_PROG instead of " : "",
385 return sock_exec(prog
);
386 return open_socket_out(host
, port
, bind_addr
, af_hint
);
390 /* Open one or more sockets for incoming data using the specified type,
393 * The getaddrinfo() call may return several address results, e.g. for
394 * the machine's IPv4 and IPv6 name.
396 * We return an array of file-descriptors to the sockets, with a trailing
397 * -1 value to indicate the end of the list.
399 * bind_addr: local address to bind, or NULL to allow it to default. */
400 static int *open_socket_in(int type
, int port
, const char *bind_addr
,
404 int s
, *socks
, maxs
, i
, ecnt
;
405 struct addrinfo hints
, *all_ai
, *resp
;
406 char portbuf
[10], **errmsgs
;
409 memset(&hints
, 0, sizeof hints
);
410 hints
.ai_family
= af_hint
;
411 hints
.ai_socktype
= type
;
412 hints
.ai_flags
= AI_PASSIVE
;
413 snprintf(portbuf
, sizeof portbuf
, "%d", port
);
414 error
= getaddrinfo(bind_addr
, portbuf
, &hints
, &all_ai
);
416 rprintf(FERROR
, RSYNC_NAME
": getaddrinfo: bind address %s: %s\n",
417 bind_addr
, gai_strerror(error
));
421 /* Count max number of sockets we might open. */
422 for (maxs
= 0, resp
= all_ai
; resp
; resp
= resp
->ai_next
, maxs
++) {}
424 socks
= new_array(int, maxs
+ 1);
425 errmsgs
= new_array(char *, maxs
);
426 if (!socks
|| !errmsgs
)
427 out_of_memory("open_socket_in");
429 /* We may not be able to create the socket, if for example the
430 * machine knows about IPv6 in the C library, but not in the
432 for (resp
= all_ai
, i
= ecnt
= 0; resp
; resp
= resp
->ai_next
) {
433 s
= socket(resp
->ai_family
, resp
->ai_socktype
,
437 int r
= asprintf(&errmsgs
[ecnt
++],
438 "socket(%d,%d,%d) failed: %s\n",
439 (int)resp
->ai_family
, (int)resp
->ai_socktype
,
440 (int)resp
->ai_protocol
, strerror(errno
));
442 out_of_memory("open_socket_in");
443 /* See if there's another address that will work... */
447 setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
,
448 (char *)&one
, sizeof one
);
450 set_socket_options(s
, sockopts
);
452 set_socket_options(s
, lp_socket_options());
455 if (resp
->ai_family
== AF_INET6
) {
456 if (setsockopt(s
, IPPROTO_IPV6
, IPV6_V6ONLY
, (char *)&one
, sizeof one
) < 0
457 && default_af_hint
!= AF_INET6
) {
464 /* Now we've got a socket - we need to bind it. */
465 if (bind(s
, resp
->ai_addr
, resp
->ai_addrlen
) < 0) {
466 /* Nope, try another */
467 int r
= asprintf(&errmsgs
[ecnt
++],
468 "bind() failed: %s (address-family %d)\n",
469 strerror(errno
), (int)resp
->ai_family
);
471 out_of_memory("open_socket_in");
481 freeaddrinfo(all_ai
);
483 /* Only output the socket()/bind() messages if we were totally
484 * unsuccessful, or if the daemon is being run with -vv. */
485 for (s
= 0; s
< ecnt
; s
++) {
486 if (!i
|| DEBUG_GTE(BIND
, 1))
487 rwrite(FLOG
, errmsgs
[s
], strlen(errmsgs
[s
]), 0);
494 "unable to bind any inbound sockets on port %d\n",
503 /* Determine if a file descriptor is in fact a socket. */
504 int is_a_socket(int fd
)
507 socklen_t l
= sizeof (int);
509 /* Parameters to getsockopt, setsockopt etc are very
510 * unstandardized across platforms, so don't be surprised if
511 * there are compiler warnings on e.g. SCO OpenSwerver or AIX.
512 * It seems they all eventually get the right idea.
514 * Debian says: ``The fifth argument of getsockopt and
515 * setsockopt is in reality an int [*] (and this is what BSD
516 * 4.* and libc4 and libc5 have). Some POSIX confusion
517 * resulted in the present socklen_t. The draft standard has
518 * not been adopted yet, but glibc2 already follows it and
519 * also has socklen_t [*]. See also accept(2).''
521 * We now return to your regularly scheduled programming. */
522 return getsockopt(fd
, SOL_SOCKET
, SO_TYPE
, (char *)&v
, &l
) == 0;
526 static void sigchld_handler(UNUSED(int val
))
529 while (waitpid(-1, NULL
, WNOHANG
) > 0) {}
531 #ifndef HAVE_SIGACTION
532 signal(SIGCHLD
, sigchld_handler
);
537 void start_accept_loop(int port
, int (*fn
)(int, int))
542 #ifdef HAVE_SIGACTION
543 sigact
.sa_flags
= SA_NOCLDSTOP
;
546 /* open an incoming socket */
547 sp
= open_socket_in(SOCK_STREAM
, port
, bind_address
, default_af_hint
);
549 exit_cleanup(RERR_SOCKETIO
);
551 /* ready to listen */
553 for (i
= 0, maxfd
= -1; sp
[i
] >= 0; i
++) {
554 if (listen(sp
[i
], lp_listen_backlog()) < 0) {
555 rsyserr(FERROR
, errno
, "listen() on socket failed");
557 if (errno
== EADDRINUSE
&& i
> 0) {
558 rprintf(FINFO
, "Try using --ipv4 or --ipv6 to avoid this listen() error.\n");
561 exit_cleanup(RERR_SOCKETIO
);
563 FD_SET(sp
[i
], &deffds
);
568 /* now accept incoming connections - forking a new process
569 * for each incoming connection */
574 struct sockaddr_storage addr
;
575 socklen_t addrlen
= sizeof addr
;
577 /* close log file before the potentially very long select so
578 * file can be trimmed by another process instead of growing
583 FD_COPY(&deffds
, &fds
);
588 if (select(maxfd
+ 1, &fds
, NULL
, NULL
, NULL
) < 1)
591 for (i
= 0, fd
= -1; sp
[i
] >= 0; i
++) {
592 if (FD_ISSET(sp
[i
], &fds
)) {
593 fd
= accept(sp
[i
], (struct sockaddr
*)&addr
, &addrlen
);
601 SIGACTION(SIGCHLD
, sigchld_handler
);
603 if ((pid
= fork()) == 0) {
605 if (pid_file_fd
>= 0)
607 for (i
= 0; sp
[i
] >= 0; i
++)
609 /* Re-open log file in child before possibly giving
610 * up privileges (see logfile_close() above). */
615 } else if (pid
< 0) {
616 rsyserr(FERROR
, errno
,
617 "could not create child server process");
619 /* This might have happened because we're
620 * overloaded. Sleep briefly before trying to
624 /* Parent doesn't need this fd anymore. */
631 enum SOCK_OPT_TYPES
{OPT_BOOL
,OPT_INT
,OPT_ON
};
640 } socket_options
[] = {
641 {"SO_KEEPALIVE", SOL_SOCKET
, SO_KEEPALIVE
, 0, OPT_BOOL
},
642 {"SO_REUSEADDR", SOL_SOCKET
, SO_REUSEADDR
, 0, OPT_BOOL
},
644 {"SO_BROADCAST", SOL_SOCKET
, SO_BROADCAST
, 0, OPT_BOOL
},
647 {"TCP_NODELAY", IPPROTO_TCP
, TCP_NODELAY
, 0, OPT_BOOL
},
649 #ifdef IPTOS_LOWDELAY
650 {"IPTOS_LOWDELAY", IPPROTO_IP
, IP_TOS
, IPTOS_LOWDELAY
, OPT_ON
},
652 #ifdef IPTOS_THROUGHPUT
653 {"IPTOS_THROUGHPUT", IPPROTO_IP
, IP_TOS
, IPTOS_THROUGHPUT
, OPT_ON
},
656 {"SO_SNDBUF", SOL_SOCKET
, SO_SNDBUF
, 0, OPT_INT
},
659 {"SO_RCVBUF", SOL_SOCKET
, SO_RCVBUF
, 0, OPT_INT
},
662 {"SO_SNDLOWAT", SOL_SOCKET
, SO_SNDLOWAT
, 0, OPT_INT
},
665 {"SO_RCVLOWAT", SOL_SOCKET
, SO_RCVLOWAT
, 0, OPT_INT
},
668 {"SO_SNDTIMEO", SOL_SOCKET
, SO_SNDTIMEO
, 0, OPT_INT
},
671 {"SO_RCVTIMEO", SOL_SOCKET
, SO_RCVTIMEO
, 0, OPT_INT
},
677 /* Set user socket options. */
678 void set_socket_options(int fd
, char *options
)
682 if (!options
|| !*options
)
685 options
= strdup(options
);
688 out_of_memory("set_socket_options");
690 for (tok
= strtok(options
, " \t,"); tok
; tok
= strtok(NULL
," \t,")) {
696 if ((p
= strchr(tok
,'='))) {
702 for (i
= 0; socket_options
[i
].name
; i
++) {
703 if (strcmp(socket_options
[i
].name
,tok
)==0)
707 if (!socket_options
[i
].name
) {
708 rprintf(FERROR
,"Unknown socket option %s\n",tok
);
712 switch (socket_options
[i
].opttype
) {
715 ret
= setsockopt(fd
,socket_options
[i
].level
,
716 socket_options
[i
].option
,
717 (char *)&value
, sizeof (int));
722 rprintf(FERROR
,"syntax error -- %s does not take a value\n",tok
);
725 int on
= socket_options
[i
].value
;
726 ret
= setsockopt(fd
,socket_options
[i
].level
,
727 socket_options
[i
].option
,
728 (char *)&on
, sizeof (int));
734 rsyserr(FERROR
, errno
,
735 "failed to set socket option %s", tok
);
743 /* This is like socketpair but uses tcp. The function guarantees that nobody
744 * else can attach to the socket, or if they do that this function fails and
745 * the socket gets closed. Returns 0 on success, -1 on failure. The resulting
746 * file descriptors are symmetrical. Currently only for RSYNC_CONNECT_PROG. */
747 static int socketpair_tcp(int fd
[2])
750 struct sockaddr_in sock
;
751 struct sockaddr_in sock2
;
752 socklen_t socklen
= sizeof sock
;
753 int connect_done
= 0;
755 fd
[0] = fd
[1] = listener
= -1;
757 memset(&sock
, 0, sizeof sock
);
759 if ((listener
= socket(PF_INET
, SOCK_STREAM
, 0)) == -1)
762 memset(&sock2
, 0, sizeof sock2
);
763 #ifdef HAVE_SOCKADDR_IN_LEN
764 sock2
.sin_len
= sizeof sock2
;
766 sock2
.sin_family
= PF_INET
;
767 sock2
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
769 if (bind(listener
, (struct sockaddr
*)&sock2
, sizeof sock2
) != 0
770 || listen(listener
, 1) != 0
771 || getsockname(listener
, (struct sockaddr
*)&sock
, &socklen
) != 0
772 || (fd
[1] = socket(PF_INET
, SOCK_STREAM
, 0)) == -1)
775 set_nonblocking(fd
[1]);
777 sock
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
779 if (connect(fd
[1], (struct sockaddr
*)&sock
, sizeof sock
) == -1) {
780 if (errno
!= EINPROGRESS
)
785 if ((fd
[0] = accept(listener
, (struct sockaddr
*)&sock2
, &socklen
)) == -1)
793 if (connect_done
== 0) {
794 if (connect(fd
[1], (struct sockaddr
*)&sock
, sizeof sock
) != 0 && errno
!= EISCONN
)
812 /* Run a program on a local tcp socket, so that we can talk to it's stdin and
813 * stdout. This is used to fake a connection to a daemon for testing -- not
814 * for the normal case of running SSH.
816 * Returns a socket which is attached to a subprocess running "prog". stdin and
817 * stdout are attached. stderr is left attached to the original stderr. */
818 static int sock_exec(const char *prog
)
823 if (socketpair_tcp(fd
) != 0) {
824 rsyserr(FERROR
, errno
, "socketpair_tcp failed");
827 if (DEBUG_GTE(CMD
, 1))
828 rprintf(FINFO
, "Running socket program: \"%s\"\n", prog
);
832 rsyserr(FERROR
, errno
, "fork");
833 exit_cleanup(RERR_IPC
);
838 if (dup2(fd
[1], STDIN_FILENO
) < 0
839 || dup2(fd
[1], STDOUT_FILENO
) < 0) {
840 fprintf(stderr
, "Failed to run \"%s\"\n", prog
);
843 exit(shell_exec(prog
));