If binding to a low-numbered port fails with EACCES, then the error
[rsync/rsync.git] / socket.c
1 /* -*- c-file-style: "linux" -*-
2    
3    Copyright (C) 1998-2001 by Andrew Tridgell 
4    
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2 of the License, or
8    (at your option) any later version.
9    
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14    
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 /*
21   socket functions used in rsync 
22
23   */
24
25 #include "rsync.h"
26
27
28 /* Establish a proxy connection on an open socket to a web roxy by
29  * using the CONNECT method. */
30 static int establish_proxy_connection(int fd, char *host, int port)
31 {
32         char buffer[1024];
33         char *cp;
34
35         snprintf(buffer, sizeof(buffer), "CONNECT %s:%d HTTP/1.0\r\n\r\n", host, port);
36         if (write(fd, buffer, strlen(buffer)) != strlen(buffer)) {
37                 rprintf(FERROR, "failed to write to proxy: %s\n",
38                         strerror(errno));
39                 return -1;
40         }
41
42         for (cp = buffer; cp < &buffer[sizeof(buffer) - 1]; cp++) {
43                 if (read(fd, cp, 1) != 1) {
44                         rprintf(FERROR, "failed to read from proxy: %s\n",
45                                 strerror(errno));
46                         return -1;
47                 }
48                 if (*cp == '\n')
49                         break;
50         }
51
52         if (*cp != '\n')
53                 cp++;
54         *cp-- = '\0';
55         if (*cp == '\r')
56                 *cp = '\0';
57         if (strncmp(buffer, "HTTP/", 5) != 0) {
58                 rprintf(FERROR, "bad response from proxy - %s\n",
59                         buffer);
60                 return -1;
61         }
62         for (cp = &buffer[5]; isdigit(*cp) || (*cp == '.'); cp++)
63                 ;
64         while (*cp == ' ')
65                 cp++;
66         if (*cp != '2') {
67                 rprintf(FERROR, "bad response from proxy - %s\n",
68                         buffer);
69                 return -1;
70         }
71         /* throw away the rest of the HTTP header */
72         while (1) {
73                 for (cp = buffer; cp < &buffer[sizeof(buffer) - 1];
74                      cp++) {
75                         if (read(fd, cp, 1) != 1) {
76                                 rprintf(FERROR, "failed to read from proxy: %s\n",
77                                         strerror(errno));
78                                 return -1;
79                         }
80                         if (*cp == '\n')
81                                 break;
82                 }
83                 if ((cp > buffer) && (*cp == '\n'))
84                         cp--;
85                 if ((cp == buffer) && ((*cp == '\n') || (*cp == '\r')))
86                         break;
87         }
88         return 0;
89 }
90
91
92 /* open a socket to a tcp remote host with the specified port 
93    based on code from Warren
94    proxy support by Stephen Rothwell */
95 int open_socket_out(char *host, int port, struct in_addr *address)
96 {
97         int type = SOCK_STREAM;
98         struct sockaddr_in sock_out;
99         struct sockaddr_in sock;
100         int res;
101         struct hostent *hp;
102         char *h;
103         unsigned p;
104         int proxied = 0;
105         char buffer[1024];
106         char *cp;
107
108         /* if we have a RSYNC_PROXY env variable then redirect our
109          * connetcion via a web proxy at the given address. The format
110          * is hostname:port */
111         h = getenv("RSYNC_PROXY");
112         proxied = (h != NULL) && (*h != '\0');
113
114         if (proxied) {
115                 strlcpy(buffer, h, sizeof(buffer));
116                 cp = strchr(buffer, ':');
117                 if (cp == NULL) {
118                         rprintf(FERROR,
119                                 "invalid proxy specification: should be HOST:PORT\n");
120                         return -1;
121                 }
122                 *cp++ = '\0';
123                 p = atoi(cp);
124                 h = buffer;
125         } else {
126                 h = host;
127                 p = port;
128         }
129
130         res = socket(PF_INET, type, 0);
131         if (res == -1) {
132                 return -1;
133         }
134
135         hp = gethostbyname(h);
136         if (!hp) {
137                 rprintf(FERROR,"unknown host: %s\n", h);
138                 close(res);
139                 return -1;
140         }
141
142         memcpy(&sock_out.sin_addr, hp->h_addr, hp->h_length);
143         sock_out.sin_port = htons(p);
144         sock_out.sin_family = PF_INET;
145
146         if (address) {
147                 sock.sin_addr = *address;
148                 sock.sin_port = 0;
149                 sock.sin_family = hp->h_addrtype;
150                 bind(res, (struct sockaddr * ) &sock,sizeof(sock));
151         }
152
153         if (connect(res,(struct sockaddr *)&sock_out,sizeof(sock_out))) {
154                 rprintf(FERROR,"failed to connect to %s - %s\n", h, strerror(errno));
155                 close(res);
156                 return -1;
157         }
158
159         if (proxied && establish_proxy_connection(res, host, port) != 0) {
160                 close(res);
161                 return -1;
162         }
163
164         return res;
165 }
166
167
168 /****************************************************************************
169 open a socket of the specified type, port and address for incoming data
170 ****************************************************************************/
171 static int open_socket_in(int type, int port, struct in_addr *address)
172 {
173         struct hostent *hp;
174         struct sockaddr_in sock;
175         char host_name[MAXHOSTNAMELEN];
176         int res;
177         int one=1;
178
179         /* get my host name */
180         if (gethostname(host_name, sizeof(host_name)) == -1) { 
181                 rprintf(FERROR,"gethostname failed\n"); 
182                 return -1; 
183         } 
184
185         /* get host info */
186         if ((hp = gethostbyname(host_name)) == 0) {
187                 rprintf(FERROR,"gethostbyname: Unknown host %s\n",host_name);
188                 return -1;
189         }
190   
191         memset((char *)&sock,0,sizeof(sock));
192         memcpy((char *)&sock.sin_addr,(char *)hp->h_addr, hp->h_length);
193         sock.sin_port = htons(port);
194         sock.sin_family = hp->h_addrtype;
195         if (address) {
196                 sock.sin_addr = *address;
197         } else {
198                 sock.sin_addr.s_addr = INADDR_ANY;
199         }
200         res = socket(hp->h_addrtype, type, 0);
201         if (res == -1) { 
202                 rprintf(FERROR,"socket failed: %s\n",
203                         strerror(errno)); 
204                 return -1; 
205         }
206
207         setsockopt(res,SOL_SOCKET,SO_REUSEADDR,(char *)&one,sizeof(one));
208
209         /* now we've got a socket - we need to bind it */
210         if (bind(res, (struct sockaddr * ) &sock,sizeof(sock)) == -1) { 
211                 rprintf(FERROR,"bind failed on port %d: %s\n", port,
212                         strerror(errno));
213                 if (errno == EACCES && port < 1024) {
214                         rprintf(FERROR, "Note: you must be root to bind "
215                                 "to low-numbered ports");
216                 }
217                 close(res); 
218                 return -1;
219         }
220
221         return res;
222 }
223
224
225 /*
226  * Determine if a file descriptor is in fact a socket
227  */
228 int is_a_socket(int fd)
229 {
230         int v, l;
231         l = sizeof(int);
232
233         /* Parameters to getsockopt, setsockopt etc are very
234          * unstandardized across platforms, so don't be surprised if
235          * there are compiler warnings on e.g. SCO OpenSwerver.  It
236          * seems they all eventually get the right idea.
237          *
238          * Debian says: ``The fifth argument of getsockopt and
239          * setsockopt is in reality an int [*] (and this is what BSD
240          * 4.* and libc4 and libc5 have).  Some POSIX confusion
241          * resulted in the present socklen_t.  The draft standard has
242          * not been adopted yet, but glibc2 already follows it and
243          * also has socklen_t [*]. See also accept(2).''
244          *
245          * We now return to your regularly scheduled programming.  */
246         return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
247 }
248
249
250 void start_accept_loop(int port, int (*fn)(int ))
251 {
252         int s;
253         extern struct in_addr socket_address;
254
255         /* open an incoming socket */
256         s = open_socket_in(SOCK_STREAM, port, &socket_address);
257         if (s == -1)
258                 exit_cleanup(RERR_SOCKETIO);
259
260         /* ready to listen */
261         if (listen(s, 5) == -1) {
262                 close(s);
263                 exit_cleanup(RERR_SOCKETIO);
264         }
265
266
267         /* now accept incoming connections - forking a new process
268            for each incoming connection */
269         while (1) {
270                 fd_set fds;
271                 int fd;
272                 struct sockaddr addr;
273                 int in_addrlen = sizeof(addr);
274
275                 /* close log file before the potentially very long select so
276                    file can be trimmed by another process instead of growing
277                    forever */
278                 log_close();
279
280                 FD_ZERO(&fds);
281                 FD_SET(s, &fds);
282
283                 if (select(s+1, &fds, NULL, NULL, NULL) != 1) {
284                         continue;
285                 }
286
287                 if(!FD_ISSET(s, &fds)) continue;
288
289                 /* See note above prototypes. */
290                 fd = accept(s,&addr,&in_addrlen);
291
292                 if (fd == -1) continue;
293
294                 signal(SIGCHLD, SIG_IGN);
295
296                 /* we shouldn't have any children left hanging around
297                    but I have had reports that on Digital Unix zombies
298                    are produced, so this ensures that they are reaped */
299 #ifdef WNOHANG
300                 while (waitpid(-1, NULL, WNOHANG) > 0);
301 #endif
302
303                 if (fork()==0) {
304                         close(s);
305
306                         /* open log file in child before possibly giving
307                            up privileges  */
308                         log_open();
309
310                         _exit(fn(fd));
311                 }
312
313                 close(fd);
314         }
315 }
316
317
318 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
319
320 struct
321 {
322   char *name;
323   int level;
324   int option;
325   int value;
326   int opttype;
327 } socket_options[] = {
328   {"SO_KEEPALIVE",      SOL_SOCKET,    SO_KEEPALIVE,    0,                 OPT_BOOL},
329   {"SO_REUSEADDR",      SOL_SOCKET,    SO_REUSEADDR,    0,                 OPT_BOOL},
330   {"SO_BROADCAST",      SOL_SOCKET,    SO_BROADCAST,    0,                 OPT_BOOL},
331 #ifdef TCP_NODELAY
332   {"TCP_NODELAY",       IPPROTO_TCP,   TCP_NODELAY,     0,                 OPT_BOOL},
333 #endif
334 #ifdef IPTOS_LOWDELAY
335   {"IPTOS_LOWDELAY",    IPPROTO_IP,    IP_TOS,          IPTOS_LOWDELAY,    OPT_ON},
336 #endif
337 #ifdef IPTOS_THROUGHPUT
338   {"IPTOS_THROUGHPUT",  IPPROTO_IP,    IP_TOS,          IPTOS_THROUGHPUT,  OPT_ON},
339 #endif
340 #ifdef SO_SNDBUF
341   {"SO_SNDBUF",         SOL_SOCKET,    SO_SNDBUF,       0,                 OPT_INT},
342 #endif
343 #ifdef SO_RCVBUF
344   {"SO_RCVBUF",         SOL_SOCKET,    SO_RCVBUF,       0,                 OPT_INT},
345 #endif
346 #ifdef SO_SNDLOWAT
347   {"SO_SNDLOWAT",       SOL_SOCKET,    SO_SNDLOWAT,     0,                 OPT_INT},
348 #endif
349 #ifdef SO_RCVLOWAT
350   {"SO_RCVLOWAT",       SOL_SOCKET,    SO_RCVLOWAT,     0,                 OPT_INT},
351 #endif
352 #ifdef SO_SNDTIMEO
353   {"SO_SNDTIMEO",       SOL_SOCKET,    SO_SNDTIMEO,     0,                 OPT_INT},
354 #endif
355 #ifdef SO_RCVTIMEO
356   {"SO_RCVTIMEO",       SOL_SOCKET,    SO_RCVTIMEO,     0,                 OPT_INT},
357 #endif
358   {NULL,0,0,0,0}};
359
360         
361
362 /****************************************************************************
363 set user socket options
364 ****************************************************************************/
365 void set_socket_options(int fd, char *options)
366 {
367         char *tok;
368         if (!options || !*options) return;
369
370         options = strdup(options);
371         
372         if (!options) out_of_memory("set_socket_options");
373
374         for (tok=strtok(options, " \t,"); tok; tok=strtok(NULL," \t,")) {
375                 int ret=0,i;
376                 int value = 1;
377                 char *p;
378                 int got_value = 0;
379
380                 if ((p = strchr(tok,'='))) {
381                         *p = 0;
382                         value = atoi(p+1);
383                         got_value = 1;
384                 }
385
386                 for (i=0;socket_options[i].name;i++)
387                         if (strcmp(socket_options[i].name,tok)==0)
388                                 break;
389
390                 if (!socket_options[i].name) {
391                         rprintf(FERROR,"Unknown socket option %s\n",tok);
392                         continue;
393                 }
394
395                 switch (socket_options[i].opttype) {
396                 case OPT_BOOL:
397                 case OPT_INT:
398                         ret = setsockopt(fd,socket_options[i].level,
399                                          socket_options[i].option,(char *)&value,sizeof(int));
400                         break;
401                         
402                 case OPT_ON:
403                         if (got_value)
404                                 rprintf(FERROR,"syntax error - %s does not take a value\n",tok);
405
406                         {
407                                 int on = socket_options[i].value;
408                                 ret = setsockopt(fd,socket_options[i].level,
409                                                  socket_options[i].option,(char *)&on,sizeof(int));
410                         }
411                         break;    
412                 }
413                 
414                 if (ret != 0)
415                         rprintf(FERROR, "failed to set socket option %s: %s\n", tok,
416                                 strerror(errno));
417         }
418
419         free(options);
420 }
421
422 /****************************************************************************
423 become a daemon, discarding the controlling terminal
424 ****************************************************************************/
425 void become_daemon(void)
426 {
427         int i;
428
429         if (fork()) {
430                 _exit(0);
431         }
432
433         /* detach from the terminal */
434 #ifdef HAVE_SETSID
435         setsid();
436 #else
437 #ifdef TIOCNOTTY
438         i = open("/dev/tty", O_RDWR);
439         if (i >= 0) {
440                 ioctl(i, (int) TIOCNOTTY, (char *)0);      
441                 close(i);
442         }
443 #endif /* TIOCNOTTY */
444 #endif
445         /* make sure that stdin, stdout an stderr don't stuff things
446            up (library functions, for example) */
447         for (i=0;i<3;i++) {
448                 close(i); 
449                 open("/dev/null", O_RDWR);
450         }
451 }
452
453 /*******************************************************************
454  return the IP addr of the client as a string 
455  ******************************************************************/
456 char *client_addr(int fd)
457 {
458         struct sockaddr sa;
459         struct sockaddr_in *sockin = (struct sockaddr_in *) (&sa);
460         int     length = sizeof(sa);
461         static char addr_buf[100];
462         static int initialised;
463
464         if (initialised) return addr_buf;
465
466         initialised = 1;
467
468         if (getpeername(fd, &sa, &length)) {
469                 exit_cleanup(RERR_SOCKETIO);
470         }
471         
472         strlcpy(addr_buf,(char *)inet_ntoa(sockin->sin_addr), sizeof(addr_buf));
473         return addr_buf;
474 }
475
476
477 /*******************************************************************
478  return the DNS name of the client 
479  ******************************************************************/
480 char *client_name(int fd)
481 {
482         struct sockaddr sa;
483         struct sockaddr_in *sockin = (struct sockaddr_in *) (&sa);
484         int     length = sizeof(sa);
485         static char name_buf[100];
486         struct hostent *hp;
487         char **p;
488         char *def = "UNKNOWN";
489         static int initialised;
490
491         if (initialised) return name_buf;
492
493         initialised = 1;
494
495         strcpy(name_buf,def);
496
497         if (getpeername(fd, &sa, &length)) {
498                 exit_cleanup(RERR_SOCKETIO);
499         }
500
501         /* Look up the remote host name. */
502         if ((hp = gethostbyaddr((char *) &sockin->sin_addr,
503                                 sizeof(sockin->sin_addr),
504                                 AF_INET))) {
505                 strlcpy(name_buf,(char *)hp->h_name,sizeof(name_buf));
506         }
507
508
509         /* do a forward lookup as well to prevent spoofing */
510         hp = gethostbyname(name_buf);
511         if (!hp) {
512                 strcpy(name_buf,def);
513                 rprintf(FERROR,"reverse name lookup failed\n");
514         } else {
515                 for (p=hp->h_addr_list;*p;p++) {
516                         if (memcmp(*p, &sockin->sin_addr, hp->h_length) == 0) {
517                                 break;
518                         }
519                 }
520                 if (!*p) {
521                         strcpy(name_buf,def);
522                         rprintf(FERROR,"reverse name lookup mismatch - spoofed address?\n");
523                 } 
524         }
525
526         return name_buf;
527 }
528
529 /*******************************************************************
530 convert a string to an IP address. The string can be a name or
531 dotted decimal number
532   ******************************************************************/
533 struct in_addr *ip_address(const char *str)
534 {
535         static struct in_addr ret;
536         struct hostent *hp;
537
538         /* try as an IP address */
539         if (inet_aton(str, &ret) != 0) {
540                 return &ret;
541         }
542
543         /* otherwise assume it's a network name of some sort and use 
544            gethostbyname */
545         if ((hp = gethostbyname(str)) == 0) {
546                 rprintf(FERROR, "gethostbyname: Unknown host. %s\n",str);
547                 return NULL;
548         }
549
550         if (hp->h_addr == NULL) {
551                 rprintf(FERROR, "gethostbyname: host address is invalid for host %s\n",str);
552                 return NULL;
553         }
554
555         if (hp->h_length > sizeof(ret)) {
556                 rprintf(FERROR, "gethostbyname: host address is too large\n");
557                 return NULL;
558         }
559
560         memcpy(&ret.s_addr, hp->h_addr, hp->h_length);
561
562         return(&ret);
563 }