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
;
43 static struct sigaction sigact
;
46 static int sock_exec(const char *prog
);
48 /* Establish a proxy connection on an open socket to a web proxy by using the
49 * CONNECT method. If proxy_user and proxy_pass are not NULL, they are used to
50 * authenticate to the proxy using the "Basic" proxy-authorization protocol. */
51 static int establish_proxy_connection(int fd
, char *host
, int port
,
52 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 snprintf(buffer
, sizeof buffer
, "CONNECT %s:%d HTTP/1.0%s%s\r\n\r\n",
77 host
, port
, authhdr
, authbuf
);
79 if (write(fd
, buffer
, len
) != len
) {
80 rsyserr(FERROR
, errno
, "failed to write to proxy");
84 for (cp
= buffer
; cp
< &buffer
[sizeof buffer
- 1]; cp
++) {
85 if (read(fd
, cp
, 1) != 1) {
86 rsyserr(FERROR
, errno
, "failed to read from proxy");
98 if (strncmp(buffer
, "HTTP/", 5) != 0) {
99 rprintf(FERROR
, "bad response from proxy -- %s\n",
103 for (cp
= &buffer
[5]; isDigit(cp
) || *cp
== '.'; cp
++) {}
107 rprintf(FERROR
, "bad response from proxy -- %s\n",
111 /* throw away the rest of the HTTP header */
113 for (cp
= buffer
; cp
< &buffer
[sizeof buffer
- 1]; cp
++) {
114 if (read(fd
, cp
, 1) != 1) {
115 rsyserr(FERROR
, errno
,
116 "failed to read from proxy");
122 if (cp
> buffer
&& *cp
== '\n')
124 if (cp
== buffer
&& (*cp
== '\n' || *cp
== '\r'))
131 /* Try to set the local address for a newly-created socket.
132 * Return -1 if this fails. */
133 int try_bind_local(int s
, int ai_family
, int ai_socktype
,
134 const char *bind_addr
)
137 struct addrinfo bhints
, *bres_all
, *r
;
139 memset(&bhints
, 0, sizeof bhints
);
140 bhints
.ai_family
= ai_family
;
141 bhints
.ai_socktype
= ai_socktype
;
142 bhints
.ai_flags
= AI_PASSIVE
;
143 if ((error
= getaddrinfo(bind_addr
, NULL
, &bhints
, &bres_all
))) {
144 rprintf(FERROR
, RSYNC_NAME
": getaddrinfo %s: %s\n",
145 bind_addr
, gai_strerror(error
));
149 for (r
= bres_all
; r
; r
= r
->ai_next
) {
150 if (bind(s
, r
->ai_addr
, r
->ai_addrlen
) == -1)
152 freeaddrinfo(bres_all
);
156 /* no error message; there might be some problem that allows
157 * creation of the socket but not binding, perhaps if the
158 * machine has no ipv6 address of this name. */
159 freeaddrinfo(bres_all
);
163 /* connect() timeout handler based on alarm() */
164 static void contimeout_handler(UNUSED(int val
))
166 connect_timeout
= -1;
169 /* Open a socket to a tcp remote host with the specified port.
171 * Based on code from Warren. Proxy support by Stephen Rothwell.
172 * getaddrinfo() rewrite contributed by KAME.net.
174 * Now that we support IPv6 we need to look up the remote machine's address
175 * first, using af_hint to set a preference for the type of address. Then
176 * depending on whether it has v4 or v6 addresses we try to open a connection.
178 * The loop allows for machines with some addresses which may not be reachable,
179 * perhaps because we can't e.g. route ipv6 to that network but we can get ip4
182 * bind_addr: local address to use. Normally NULL to bind the wildcard address.
184 * af_hint: address family, e.g. AF_INET or AF_INET6. */
185 int open_socket_out(char *host
, int port
, const char *bind_addr
,
188 int type
= SOCK_STREAM
;
189 int error
, s
, j
, addr_cnt
, *errnos
;
190 struct addrinfo hints
, *res0
, *res
;
195 char *proxy_user
= NULL
, *proxy_pass
= NULL
;
197 /* if we have a RSYNC_PROXY env variable then redirect our
198 * connection via a web proxy at the given address. */
199 h
= getenv("RSYNC_PROXY");
200 proxied
= h
!= NULL
&& *h
!= '\0';
203 strlcpy(buffer
, h
, sizeof buffer
);
205 /* Is the USER:PASS@ prefix present? */
206 if ((cp
= strrchr(buffer
, '@')) != NULL
) {
208 /* The remainder is the HOST:PORT part. */
211 if ((cp
= strchr(buffer
, ':')) == NULL
) {
213 "invalid proxy specification: should be USER:PASS@HOST:PORT\n");
221 /* The whole buffer is the HOST:PORT part. */
225 if ((cp
= strchr(h
, ':')) == NULL
) {
227 "invalid proxy specification: should be HOST:PORT\n");
231 strlcpy(portbuf
, cp
, sizeof portbuf
);
232 if (DEBUG_GTE(CONNECT
, 1)) {
233 rprintf(FINFO
, "connection via http proxy %s port %s\n",
237 snprintf(portbuf
, sizeof portbuf
, "%d", port
);
241 memset(&hints
, 0, sizeof hints
);
242 hints
.ai_family
= af_hint
;
243 hints
.ai_socktype
= type
;
244 error
= getaddrinfo(h
, portbuf
, &hints
, &res0
);
246 rprintf(FERROR
, RSYNC_NAME
": getaddrinfo: %s %s: %s\n",
247 h
, portbuf
, gai_strerror(error
));
251 for (res
= res0
, addr_cnt
= 0; res
; res
= res
->ai_next
, addr_cnt
++) {}
252 errnos
= new_array0(int, addr_cnt
);
254 out_of_memory("open_socket_out");
257 /* Try to connect to all addresses for this machine until we get
258 * through. It might e.g. be multi-homed, or have both IPv4 and IPv6
259 * addresses. We need to create a socket for each record, since the
260 * address record tells us what protocol to use to try to connect. */
261 for (res
= res0
, j
= 0; res
; res
= res
->ai_next
, j
++) {
262 s
= socket(res
->ai_family
, res
->ai_socktype
, res
->ai_protocol
);
267 && try_bind_local(s
, res
->ai_family
, type
,
273 if (connect_timeout
> 0) {
274 SIGACTION(SIGALRM
, contimeout_handler
);
275 alarm(connect_timeout
);
278 set_socket_options(s
, sockopts
);
279 while (connect(s
, res
->ai_addr
, res
->ai_addrlen
) < 0) {
280 if (connect_timeout
< 0)
281 exit_cleanup(RERR_CONTIMEOUT
);
289 if (connect_timeout
> 0)
298 && establish_proxy_connection(s
, host
, port
,
299 proxy_user
, proxy_pass
) != 0) {
304 if (DEBUG_GTE(CONNECT
, 2)) {
306 if ((error
= getnameinfo(res
->ai_addr
, res
->ai_addrlen
, buf
, sizeof buf
, NULL
, 0, NI_NUMERICHOST
)) != 0)
307 snprintf(buf
, sizeof buf
, "*getnameinfo failure: %s*", gai_strerror(error
));
308 rprintf(FINFO
, "Connected to %s (%s)\n", h
, buf
);
313 if (s
< 0 || DEBUG_GTE(CONNECT
, 2)) {
315 for (res
= res0
, j
= 0; res
; res
= res
->ai_next
, j
++) {
318 if ((error
= getnameinfo(res
->ai_addr
, res
->ai_addrlen
, buf
, sizeof buf
, NULL
, 0, NI_NUMERICHOST
)) != 0)
319 snprintf(buf
, sizeof buf
, "*getnameinfo failure: %s*", gai_strerror(error
));
320 rsyserr(FERROR
, errnos
[j
], "failed to connect to %s (%s)", h
, buf
);
333 /* Open an outgoing socket, but allow for it to be intercepted by
334 * $RSYNC_CONNECT_PROG, which will execute a program across a TCP
335 * socketpair rather than really opening a socket.
337 * We use this primarily in testing to detect TCP flow bugs, but not
338 * cause security problems by really opening remote connections.
340 * This is based on the Samba LIBSMB_PROG feature.
342 * bind_addr: local address to use. Normally NULL to get the stack default. */
343 int open_socket_out_wrapped(char *host
, int port
, const char *bind_addr
,
346 char *prog
= getenv("RSYNC_CONNECT_PROG");
348 if (prog
&& strchr(prog
, '%')) {
349 int hlen
= strlen(host
);
350 int len
= strlen(prog
) + 1;
352 for (f
= prog
; *f
; f
++) {
355 /* Compute more than enough room. */
362 if (!(prog
= new_array(char, len
)))
363 out_of_memory("open_socket_out_wrapped");
364 for (t
= prog
; *f
; f
++) {
368 /* Just skips the extra '%'. */
371 memcpy(t
, host
, hlen
);
375 f
--; /* pass % through */
384 if (DEBUG_GTE(CONNECT
, 1)) {
385 rprintf(FINFO
, "%sopening tcp connection to %s port %d\n",
386 prog
? "Using RSYNC_CONNECT_PROG instead of " : "",
390 return sock_exec(prog
);
391 return open_socket_out(host
, port
, bind_addr
, af_hint
);
395 /* Open one or more sockets for incoming data using the specified type,
398 * The getaddrinfo() call may return several address results, e.g. for
399 * the machine's IPv4 and IPv6 name.
401 * We return an array of file-descriptors to the sockets, with a trailing
402 * -1 value to indicate the end of the list.
404 * bind_addr: local address to bind, or NULL to allow it to default. */
405 static int *open_socket_in(int type
, int port
, const char *bind_addr
,
409 int s
, *socks
, maxs
, i
, ecnt
;
410 struct addrinfo hints
, *all_ai
, *resp
;
411 char portbuf
[10], **errmsgs
;
414 memset(&hints
, 0, sizeof hints
);
415 hints
.ai_family
= af_hint
;
416 hints
.ai_socktype
= type
;
417 hints
.ai_flags
= AI_PASSIVE
;
418 snprintf(portbuf
, sizeof portbuf
, "%d", port
);
419 error
= getaddrinfo(bind_addr
, portbuf
, &hints
, &all_ai
);
421 rprintf(FERROR
, RSYNC_NAME
": getaddrinfo: bind address %s: %s\n",
422 bind_addr
, gai_strerror(error
));
426 /* Count max number of sockets we might open. */
427 for (maxs
= 0, resp
= all_ai
; resp
; resp
= resp
->ai_next
, maxs
++) {}
429 socks
= new_array(int, maxs
+ 1);
430 errmsgs
= new_array(char *, maxs
);
431 if (!socks
|| !errmsgs
)
432 out_of_memory("open_socket_in");
434 /* We may not be able to create the socket, if for example the
435 * machine knows about IPv6 in the C library, but not in the
437 for (resp
= all_ai
, i
= ecnt
= 0; resp
; resp
= resp
->ai_next
) {
438 s
= socket(resp
->ai_family
, resp
->ai_socktype
,
442 int r
= asprintf(&errmsgs
[ecnt
++],
443 "socket(%d,%d,%d) failed: %s\n",
444 (int)resp
->ai_family
, (int)resp
->ai_socktype
,
445 (int)resp
->ai_protocol
, strerror(errno
));
447 out_of_memory("open_socket_in");
448 /* See if there's another address that will work... */
452 setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
,
453 (char *)&one
, sizeof one
);
455 set_socket_options(s
, sockopts
);
457 set_socket_options(s
, lp_socket_options());
460 if (resp
->ai_family
== AF_INET6
) {
461 if (setsockopt(s
, IPPROTO_IPV6
, IPV6_V6ONLY
,
462 (char *)&one
, sizeof one
) < 0
463 && default_af_hint
!= AF_INET6
) {
470 /* Now we've got a socket - we need to bind it. */
471 if (bind(s
, resp
->ai_addr
, resp
->ai_addrlen
) < 0) {
472 /* Nope, try another */
473 int r
= asprintf(&errmsgs
[ecnt
++],
474 "bind() failed: %s (address-family %d)\n",
475 strerror(errno
), (int)resp
->ai_family
);
477 out_of_memory("open_socket_in");
487 freeaddrinfo(all_ai
);
489 /* Only output the socket()/bind() messages if we were totally
490 * unsuccessful, or if the daemon is being run with -vv. */
491 for (s
= 0; s
< ecnt
; s
++) {
492 if (!i
|| DEBUG_GTE(BIND
, 1))
493 rwrite(FLOG
, errmsgs
[s
], strlen(errmsgs
[s
]), 0);
500 "unable to bind any inbound sockets on port %d\n",
509 /* Determine if a file descriptor is in fact a socket. */
510 int is_a_socket(int fd
)
513 socklen_t l
= sizeof (int);
515 /* Parameters to getsockopt, setsockopt etc are very
516 * unstandardized across platforms, so don't be surprised if
517 * there are compiler warnings on e.g. SCO OpenSwerver or AIX.
518 * It seems they all eventually get the right idea.
520 * Debian says: ``The fifth argument of getsockopt and
521 * setsockopt is in reality an int [*] (and this is what BSD
522 * 4.* and libc4 and libc5 have). Some POSIX confusion
523 * resulted in the present socklen_t. The draft standard has
524 * not been adopted yet, but glibc2 already follows it and
525 * also has socklen_t [*]. See also accept(2).''
527 * We now return to your regularly scheduled programming. */
528 return getsockopt(fd
, SOL_SOCKET
, SO_TYPE
, (char *)&v
, &l
) == 0;
532 static void sigchld_handler(UNUSED(int val
))
535 while (waitpid(-1, NULL
, WNOHANG
) > 0) {}
537 #ifndef HAVE_SIGACTION
538 signal(SIGCHLD
, sigchld_handler
);
543 void start_accept_loop(int port
, int (*fn
)(int, int))
548 #ifdef HAVE_SIGACTION
549 sigact
.sa_flags
= SA_NOCLDSTOP
;
552 /* open an incoming socket */
553 sp
= open_socket_in(SOCK_STREAM
, port
, bind_address
, default_af_hint
);
555 exit_cleanup(RERR_SOCKETIO
);
557 /* ready to listen */
559 for (i
= 0, maxfd
= -1; sp
[i
] >= 0; i
++) {
560 if (listen(sp
[i
], lp_listen_backlog()) < 0) {
561 rsyserr(FERROR
, errno
, "listen() on socket failed");
563 if (errno
== EADDRINUSE
&& i
> 0) {
565 "Try using --ipv4 or --ipv6 to avoid this listen() error.\n");
568 exit_cleanup(RERR_SOCKETIO
);
570 FD_SET(sp
[i
], &deffds
);
575 /* now accept incoming connections - forking a new process
576 * for each incoming connection */
581 struct sockaddr_storage addr
;
582 socklen_t addrlen
= sizeof addr
;
584 /* close log file before the potentially very long select so
585 * file can be trimmed by another process instead of growing
590 FD_COPY(&deffds
, &fds
);
595 if (select(maxfd
+ 1, &fds
, NULL
, NULL
, NULL
) < 1)
598 for (i
= 0, fd
= -1; sp
[i
] >= 0; i
++) {
599 if (FD_ISSET(sp
[i
], &fds
)) {
600 fd
= accept(sp
[i
], (struct sockaddr
*)&addr
,
609 SIGACTION(SIGCHLD
, sigchld_handler
);
611 if ((pid
= fork()) == 0) {
613 for (i
= 0; sp
[i
] >= 0; i
++)
615 /* Re-open log file in child before possibly giving
616 * up privileges (see logfile_close() above). */
621 } else if (pid
< 0) {
622 rsyserr(FERROR
, errno
,
623 "could not create child server process");
625 /* This might have happened because we're
626 * overloaded. Sleep briefly before trying to
630 /* Parent doesn't need this fd anymore. */
637 enum SOCK_OPT_TYPES
{OPT_BOOL
,OPT_INT
,OPT_ON
};
646 } socket_options
[] = {
647 {"SO_KEEPALIVE", SOL_SOCKET
, SO_KEEPALIVE
, 0, OPT_BOOL
},
648 {"SO_REUSEADDR", SOL_SOCKET
, SO_REUSEADDR
, 0, OPT_BOOL
},
650 {"SO_BROADCAST", SOL_SOCKET
, SO_BROADCAST
, 0, OPT_BOOL
},
653 {"TCP_NODELAY", IPPROTO_TCP
, TCP_NODELAY
, 0, OPT_BOOL
},
655 #ifdef IPTOS_LOWDELAY
656 {"IPTOS_LOWDELAY", IPPROTO_IP
, IP_TOS
, IPTOS_LOWDELAY
, OPT_ON
},
658 #ifdef IPTOS_THROUGHPUT
659 {"IPTOS_THROUGHPUT", IPPROTO_IP
, IP_TOS
, IPTOS_THROUGHPUT
, OPT_ON
},
662 {"SO_SNDBUF", SOL_SOCKET
, SO_SNDBUF
, 0, OPT_INT
},
665 {"SO_RCVBUF", SOL_SOCKET
, SO_RCVBUF
, 0, OPT_INT
},
668 {"SO_SNDLOWAT", SOL_SOCKET
, SO_SNDLOWAT
, 0, OPT_INT
},
671 {"SO_RCVLOWAT", SOL_SOCKET
, SO_RCVLOWAT
, 0, OPT_INT
},
674 {"SO_SNDTIMEO", SOL_SOCKET
, SO_SNDTIMEO
, 0, OPT_INT
},
677 {"SO_RCVTIMEO", SOL_SOCKET
, SO_RCVTIMEO
, 0, OPT_INT
},
683 /* Set user socket options. */
684 void set_socket_options(int fd
, char *options
)
688 if (!options
|| !*options
)
691 options
= strdup(options
);
694 out_of_memory("set_socket_options");
696 for (tok
= strtok(options
, " \t,"); tok
; tok
= strtok(NULL
," \t,")) {
702 if ((p
= strchr(tok
,'='))) {
708 for (i
= 0; socket_options
[i
].name
; i
++) {
709 if (strcmp(socket_options
[i
].name
,tok
)==0)
713 if (!socket_options
[i
].name
) {
714 rprintf(FERROR
,"Unknown socket option %s\n",tok
);
718 switch (socket_options
[i
].opttype
) {
721 ret
= setsockopt(fd
,socket_options
[i
].level
,
722 socket_options
[i
].option
,
723 (char *)&value
, sizeof (int));
728 rprintf(FERROR
,"syntax error -- %s does not take a value\n",tok
);
731 int on
= socket_options
[i
].value
;
732 ret
= setsockopt(fd
,socket_options
[i
].level
,
733 socket_options
[i
].option
,
734 (char *)&on
, sizeof (int));
740 rsyserr(FERROR
, errno
,
741 "failed to set socket option %s", tok
);
749 /* This is like socketpair but uses tcp. The function guarantees that nobody
750 * else can attach to the socket, or if they do that this function fails and
751 * the socket gets closed. Returns 0 on success, -1 on failure. The resulting
752 * file descriptors are symmetrical. Currently only for RSYNC_CONNECT_PROG. */
753 static int socketpair_tcp(int fd
[2])
756 struct sockaddr_in sock
;
757 struct sockaddr_in sock2
;
758 socklen_t socklen
= sizeof sock
;
759 int connect_done
= 0;
761 fd
[0] = fd
[1] = listener
= -1;
763 memset(&sock
, 0, sizeof sock
);
765 if ((listener
= socket(PF_INET
, SOCK_STREAM
, 0)) == -1)
768 memset(&sock2
, 0, sizeof sock2
);
769 #ifdef HAVE_SOCKADDR_IN_LEN
770 sock2
.sin_len
= sizeof sock2
;
772 sock2
.sin_family
= PF_INET
;
773 sock2
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
775 if (bind(listener
, (struct sockaddr
*)&sock2
, sizeof sock2
) != 0
776 || listen(listener
, 1) != 0
777 || getsockname(listener
, (struct sockaddr
*)&sock
, &socklen
) != 0
778 || (fd
[1] = socket(PF_INET
, SOCK_STREAM
, 0)) == -1)
781 set_nonblocking(fd
[1]);
783 sock
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
785 if (connect(fd
[1], (struct sockaddr
*)&sock
, sizeof sock
) == -1) {
786 if (errno
!= EINPROGRESS
)
791 if ((fd
[0] = accept(listener
, (struct sockaddr
*)&sock2
, &socklen
)) == -1)
799 if (connect_done
== 0) {
800 if (connect(fd
[1], (struct sockaddr
*)&sock
, sizeof sock
) != 0
819 /* Run a program on a local tcp socket, so that we can talk to it's stdin and
820 * stdout. This is used to fake a connection to a daemon for testing -- not
821 * for the normal case of running SSH.
823 * Returns a socket which is attached to a subprocess running "prog". stdin and
824 * stdout are attached. stderr is left attached to the original stderr. */
825 static int sock_exec(const char *prog
)
830 if (socketpair_tcp(fd
) != 0) {
831 rsyserr(FERROR
, errno
, "socketpair_tcp failed");
834 if (DEBUG_GTE(CMD
, 1))
835 rprintf(FINFO
, "Running socket program: \"%s\"\n", prog
);
839 rsyserr(FERROR
, errno
, "fork");
840 exit_cleanup(RERR_IPC
);
845 if (dup2(fd
[1], STDIN_FILENO
) < 0
846 || dup2(fd
[1], STDOUT_FILENO
) < 0) {
847 fprintf(stderr
, "Failed to run \"%s\"\n", prog
);
850 exit(shell_exec(prog
));