- Added set_io_timeout(), which sets all the timeout-dependent
[rsync.git] / clientserver.c
1 /* -*- c-file-style: "linux"; -*-
2  *
3  * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4  * Copyright (C) 2001-2002 by Martin Pool <mbp@samba.org>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  */
20
21 /**
22  * @file
23  *
24  * The socket based protocol for setting up a connection with
25  * rsyncd.
26  **/
27
28 #include "rsync.h"
29
30 extern int verbose;
31 extern int list_only;
32 extern int am_sender;
33 extern int am_server;
34 extern int am_daemon;
35 extern int am_root;
36 extern int rsync_port;
37 extern int kluge_around_eof;
38 extern int daemon_over_rsh;
39 extern int sanitize_paths;
40 extern int filesfrom_fd;
41 extern int remote_protocol;
42 extern int protocol_version;
43 extern int io_timeout;
44 extern int select_timeout;
45 extern int orig_umask;
46 extern int no_detach;
47 extern int default_af_hint;
48 extern char *bind_address;
49 extern struct filter_list_struct server_filter_list;
50 extern char *config_file;
51 extern char *files_from;
52
53 char *auth_user;
54 int read_only = 0;
55 int daemon_log_format_has_i = 0;
56 int daemon_log_format_has_o_or_i = 0;
57 int module_id = -1;
58
59 /* Length of lp_path() string when in daemon mode & not chrooted, else 0. */
60 unsigned int module_dirlen = 0;
61
62 /**
63  * Run a client connected to an rsyncd.  The alternative to this
64  * function for remote-shell connections is do_cmd().
65  *
66  * After negotiating which module to use and reading the server's
67  * motd, this hands over to client_run().  Telling the server the
68  * module will cause it to chroot/setuid/etc.
69  *
70  * Instead of doing a transfer, the client may at this stage instead
71  * get a listing of remote modules and exit.
72  *
73  * @return -1 for error in startup, or the result of client_run().
74  * Either way, it eventually gets passed to exit_cleanup().
75  **/
76 int start_socket_client(char *host, char *path, int argc, char *argv[])
77 {
78         int fd, ret;
79         char *p, *user = NULL;
80
81         /* This is redundant with code in start_inband_exchange(), but this
82          * short-circuits a problem in the client before we open a socket,
83          * and the extra check won't hurt. */
84         if (*path == '/') {
85                 rprintf(FERROR,
86                         "ERROR: The remote path must start with a module name not a /\n");
87                 return -1;
88         }
89
90         if ((p = strrchr(host, '@')) != NULL) {
91                 user = host;
92                 host = p+1;
93                 *p = '\0';
94         }
95
96         fd = open_socket_out_wrapped(host, rsync_port, bind_address,
97                                      default_af_hint);
98         if (fd == -1)
99                 exit_cleanup(RERR_SOCKETIO);
100
101         ret = start_inband_exchange(user, path, fd, fd, argc);
102
103         return ret ? ret : client_run(fd, fd, -1, argc, argv);
104 }
105
106 int start_inband_exchange(char *user, char *path, int f_in, int f_out, 
107                           int argc)
108 {
109         int i;
110         char *sargs[MAX_ARGS];
111         int sargc = 0;
112         char line[MAXPATHLEN];
113         char *p;
114
115         if (argc == 0 && !am_sender)
116                 list_only |= 1;
117
118         if (*path == '/') {
119                 rprintf(FERROR,
120                         "ERROR: The remote path must start with a module name\n");
121                 return -1;
122         }
123
124         if (!user)
125                 user = getenv("USER");
126         if (!user)
127                 user = getenv("LOGNAME");
128
129         io_printf(f_out, "@RSYNCD: %d\n", protocol_version);
130
131         if (!read_line(f_in, line, sizeof line - 1)) {
132                 rprintf(FERROR, "rsync: did not see server greeting\n");
133                 return -1;
134         }
135
136         if (sscanf(line,"@RSYNCD: %d", &remote_protocol) != 1) {
137                 /* note that read_line strips of \n or \r */
138                 rprintf(FERROR, "rsync: server sent \"%s\" rather than greeting\n",
139                         line);
140                 return -1;
141         }
142         if (protocol_version > remote_protocol)
143                 protocol_version = remote_protocol;
144
145         if (list_only && protocol_version >= 29)
146                 list_only |= 2;
147
148         /* set daemon_over_rsh to false since we need to build the
149          * true set of args passed through the rsh/ssh connection;
150          * this is a no-op for direct-socket-connection mode */
151         daemon_over_rsh = 0;
152         server_options(sargs, &sargc);
153
154         sargs[sargc++] = ".";
155
156         if (path && *path)
157                 sargs[sargc++] = path;
158
159         sargs[sargc] = NULL;
160
161         if (verbose > 1)
162                 print_child_argv(sargs);
163
164         p = strchr(path,'/');
165         if (p) *p = 0;
166         io_printf(f_out, "%s\n", path);
167         if (p) *p = '/';
168
169         /* Old servers may just drop the connection here,
170          rather than sending a proper EXIT command.  Yuck. */
171         kluge_around_eof = list_only && protocol_version < 25 ? 1 : 0;
172
173         while (1) {
174                 if (!read_line(f_in, line, sizeof line - 1)) {
175                         rprintf(FERROR, "rsync: didn't get server startup line\n");
176                         return -1;
177                 }
178
179                 if (strncmp(line,"@RSYNCD: AUTHREQD ",18) == 0) {
180                         auth_client(f_out, user, line+18);
181                         continue;
182                 }
183
184                 if (strcmp(line,"@RSYNCD: OK") == 0)
185                         break;
186
187                 if (strcmp(line,"@RSYNCD: EXIT") == 0) {
188                         /* This is sent by recent versions of the
189                          * server to terminate the listing of modules.
190                          * We don't want to go on and transfer
191                          * anything; just exit. */
192                         exit(0);
193                 }
194
195                 if (strncmp(line, "@ERROR", 6) == 0) {
196                         rprintf(FERROR, "%s\n", line);
197                         /* This is always fatal; the server will now
198                          * close the socket. */
199                         return -1;
200                 }
201
202                 rprintf(FINFO, "%s\n", line);
203         }
204         kluge_around_eof = 0;
205
206         for (i = 0; i < sargc; i++) {
207                 io_printf(f_out, "%s\n", sargs[i]);
208         }
209         io_printf(f_out, "\n");
210
211         if (protocol_version < 23) {
212                 if (protocol_version == 22 || !am_sender)
213                         io_start_multiplex_in();
214         }
215
216         return 0;
217 }
218
219
220
221 static int rsync_module(int f_in, int f_out, int i)
222 {
223         int argc = 0;
224         int maxargs;
225         char **argv;
226         char **argp;
227         char line[MAXPATHLEN];
228         uid_t uid = (uid_t)-2;  /* canonically "nobody" */
229         gid_t gid = (gid_t)-2;
230         char *p;
231         char *addr = client_addr(f_in);
232         char *host = client_name(f_in);
233         char *name = lp_name(i);
234         int use_chroot = lp_use_chroot(i);
235         int start_glob = 0;
236         int ret;
237         char *request = NULL;
238
239         if (!allow_access(addr, host, lp_hosts_allow(i), lp_hosts_deny(i))) {
240                 rprintf(FLOG, "rsync denied on module %s from %s (%s)\n",
241                         name, host, addr);
242                 if (!lp_list(i))
243                         io_printf(f_out, "@ERROR: Unknown module '%s'\n", name);
244                 else {
245                         io_printf(f_out,
246                                   "@ERROR: access denied to %s from %s (%s)\n",
247                                   name, host, addr);
248                 }
249                 return -1;
250         }
251
252         if (am_daemon && am_server) {
253                 rprintf(FLOG, "rsync allowed access on module %s from %s (%s)\n",
254                         name, host, addr);
255         }
256
257         if (!claim_connection(lp_lock_file(i), lp_max_connections(i))) {
258                 if (errno) {
259                         rsyserr(FLOG, errno, "failed to open lock file %s",
260                                 safe_fname(lp_lock_file(i)));
261                         io_printf(f_out, "@ERROR: failed to open lock file\n");
262                 } else {
263                         rprintf(FLOG, "max connections (%d) reached\n",
264                                 lp_max_connections(i));
265                         io_printf(f_out, "@ERROR: max connections (%d) reached -- try again later\n",
266                                 lp_max_connections(i));
267                 }
268                 return -1;
269         }
270
271         auth_user = auth_server(f_in, f_out, i, host, addr, "@RSYNCD: AUTHREQD ");
272
273         if (!auth_user) {
274                 io_printf(f_out, "@ERROR: auth failed on module %s\n", name);
275                 return -1;
276         }
277
278         module_id = i;
279
280         if (lp_read_only(i))
281                 read_only = 1;
282
283         if (lp_transfer_logging(i)) {
284                 if (log_format_has(lp_log_format(i), 'i'))
285                         daemon_log_format_has_i = 1;
286                 if (daemon_log_format_has_i
287                     || log_format_has(lp_log_format(i), 'o'))
288                         daemon_log_format_has_o_or_i = 1;
289         }
290
291         am_root = (MY_UID() == 0);
292
293         if (am_root) {
294                 p = lp_uid(i);
295                 if (!name_to_uid(p, &uid)) {
296                         if (!isdigit(*(unsigned char *)p)) {
297                                 rprintf(FLOG, "Invalid uid %s\n", p);
298                                 io_printf(f_out, "@ERROR: invalid uid %s\n", p);
299                                 return -1;
300                         }
301                         uid = atoi(p);
302                 }
303
304                 p = lp_gid(i);
305                 if (!name_to_gid(p, &gid)) {
306                         if (!isdigit(*(unsigned char *)p)) {
307                                 rprintf(FLOG, "Invalid gid %s\n", p);
308                                 io_printf(f_out, "@ERROR: invalid gid %s\n", p);
309                                 return -1;
310                         }
311                         gid = atoi(p);
312                 }
313         }
314
315         /* TODO: If we're not root, but the configuration requests
316          * that we change to some uid other than the current one, then
317          * log a warning. */
318
319         /* TODO: Perhaps take a list of gids, and make them into the
320          * supplementary groups. */
321
322         if (use_chroot || (module_dirlen = strlen(lp_path(i))) == 1) {
323                 module_dirlen = 0;
324                 set_filter_dir("/", 1);
325         } else
326                 set_filter_dir(lp_path(i), module_dirlen);
327
328         p = lp_filter(i);
329         parse_rule(&server_filter_list, p, MATCHFLG_WORD_SPLIT,
330                    XFLG_ANCHORED2ABS);
331
332         p = lp_include_from(i);
333         parse_filter_file(&server_filter_list, p, MATCHFLG_INCLUDE,
334             XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES | XFLG_FATAL_ERRORS);
335
336         p = lp_include(i);
337         parse_rule(&server_filter_list, p,
338                    MATCHFLG_INCLUDE | MATCHFLG_WORD_SPLIT,
339                    XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES);
340
341         p = lp_exclude_from(i);
342         parse_filter_file(&server_filter_list, p, 0,
343             XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES | XFLG_FATAL_ERRORS);
344
345         p = lp_exclude(i);
346         parse_rule(&server_filter_list, p, MATCHFLG_WORD_SPLIT,
347                    XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES);
348
349         log_init();
350
351         if (use_chroot) {
352                 /*
353                  * XXX: The 'use chroot' flag is a fairly reliable
354                  * source of confusion, because it fails under two
355                  * important circumstances: running as non-root,
356                  * running on Win32 (or possibly others).  On the
357                  * other hand, if you are running as root, then it
358                  * might be better to always use chroot.
359                  *
360                  * So, perhaps if we can't chroot we should just issue
361                  * a warning, unless a "require chroot" flag is set,
362                  * in which case we fail.
363                  */
364                 if (chroot(lp_path(i))) {
365                         rsyserr(FLOG, errno, "chroot %s failed",
366                                 safe_fname(lp_path(i)));
367                         io_printf(f_out, "@ERROR: chroot failed\n");
368                         return -1;
369                 }
370
371                 if (!push_dir("/")) {
372                         rsyserr(FLOG, errno, "chdir %s failed\n",
373                                 safe_fname(lp_path(i)));
374                         io_printf(f_out, "@ERROR: chdir failed\n");
375                         return -1;
376                 }
377
378         } else {
379                 if (!push_dir(lp_path(i))) {
380                         rsyserr(FLOG, errno, "chdir %s failed\n",
381                                 safe_fname(lp_path(i)));
382                         io_printf(f_out, "@ERROR: chdir failed\n");
383                         return -1;
384                 }
385                 sanitize_paths = 1;
386         }
387
388         if (am_root) {
389                 /* XXXX: You could argue that if the daemon is started
390                  * by a non-root user and they explicitly specify a
391                  * gid, then we should try to change to that gid --
392                  * this could be possible if it's already in their
393                  * supplementary groups. */
394
395                 /* TODO: Perhaps we need to document that if rsyncd is
396                  * started by somebody other than root it will inherit
397                  * all their supplementary groups. */
398
399                 if (setgid(gid)) {
400                         rsyserr(FLOG, errno, "setgid %d failed", (int)gid);
401                         io_printf(f_out, "@ERROR: setgid failed\n");
402                         return -1;
403                 }
404 #ifdef HAVE_SETGROUPS
405                 /* Get rid of any supplementary groups this process
406                  * might have inheristed. */
407                 if (setgroups(1, &gid)) {
408                         rsyserr(FLOG, errno, "setgroups failed");
409                         io_printf(f_out, "@ERROR: setgroups failed\n");
410                         return -1;
411                 }
412 #endif
413
414                 if (setuid(uid)) {
415                         rsyserr(FLOG, errno, "setuid %d failed", (int)uid);
416                         io_printf(f_out, "@ERROR: setuid failed\n");
417                         return -1;
418                 }
419
420                 am_root = (MY_UID() == 0);
421         }
422
423         io_printf(f_out, "@RSYNCD: OK\n");
424
425         maxargs = MAX_ARGS;
426         if (!(argv = new_array(char *, maxargs)))
427                 out_of_memory("rsync_module");
428         argv[argc++] = "rsyncd";
429
430         while (1) {
431                 if (!read_line(f_in, line, sizeof line - 1))
432                         return -1;
433
434                 if (!*line)
435                         break;
436
437                 p = line;
438
439                 if (argc == maxargs) {
440                         maxargs += MAX_ARGS;
441                         if (!(argv = realloc_array(argv, char *, maxargs)))
442                                 out_of_memory("rsync_module");
443                 }
444                 if (!(argv[argc] = strdup(p)))
445                         out_of_memory("rsync_module");
446
447                 if (start_glob) {
448                         if (start_glob == 1) {
449                                 request = strdup(p);
450                                 start_glob++;
451                         }
452                         glob_expand(name, &argv, &argc, &maxargs);
453                 } else
454                         argc++;
455
456                 if (strcmp(line, ".") == 0)
457                         start_glob = 1;
458         }
459
460         verbose = 0; /* future verbosity is controlled by client options */
461         argp = argv;
462         ret = parse_arguments(&argc, (const char ***) &argp, 0);
463
464         if (filesfrom_fd == 0)
465                 filesfrom_fd = f_in;
466
467         if (request) {
468                 if (*auth_user) {
469                         rprintf(FLOG, "rsync %s %s from %s@%s (%s)\n",
470                                 am_sender ? "on" : "to",
471                                 request, auth_user, host, addr);
472                 } else {
473                         rprintf(FLOG, "rsync %s %s from %s (%s)\n",
474                                 am_sender ? "on" : "to",
475                                 request, host, addr);
476                 }
477                 free(request);
478         }
479
480 #ifndef DEBUG
481         /* don't allow the logs to be flooded too fast */
482         if (verbose > lp_max_verbosity())
483                 verbose = lp_max_verbosity();
484 #endif
485
486         if (protocol_version < 23
487             && (protocol_version == 22 || am_sender))
488                 io_start_multiplex_out();
489         else if (!ret) {
490                 /* We have to get I/O multiplexing started so that we can
491                  * get the error back to the client.  This means getting
492                  * the protocol setup finished first in later versions. */
493                 setup_protocol(f_out, f_in);
494                 if (!am_sender) {
495                         /* Since we failed in our option parsing, we may not
496                          * have finished parsing that the client sent us a
497                          * --files-from option, so look for it manually.
498                          * Without this, the socket would be in the wrong
499                          * state for the upcoming error message. */
500                         if (!files_from) {
501                                 int i;
502                                 for (i = 0; i < argc; i++) {
503                                         if (strncmp(argv[i], "--files-from", 12) == 0) {
504                                                 files_from = "";
505                                                 break;
506                                         }
507                                 }
508                         }
509                         if (files_from)
510                                 write_byte(f_out, 0);
511                 }
512                 io_start_multiplex_out();
513         }
514
515         if (!ret) {
516                 option_error();
517                 msleep(400);
518                 exit_cleanup(RERR_UNSUPPORTED);
519         }
520
521         if (lp_timeout(i)) {
522                 io_timeout = lp_timeout(i);
523                 if (io_timeout < select_timeout)
524                         select_timeout = io_timeout;
525         }
526
527         start_server(f_in, f_out, argc, argp);
528
529         return 0;
530 }
531
532 /* send a list of available modules to the client. Don't list those
533    with "list = False". */
534 static void send_listing(int fd)
535 {
536         int n = lp_numservices();
537         int i;
538
539         for (i = 0; i < n; i++) {
540                 if (lp_list(i))
541                         io_printf(fd, "%-15s\t%s\n", lp_name(i), lp_comment(i));
542         }
543
544         if (protocol_version >= 25)
545                 io_printf(fd,"@RSYNCD: EXIT\n");
546 }
547
548 /* this is called when a connection is established to a client
549    and we want to start talking. The setup of the system is done from
550    here */
551 int start_daemon(int f_in, int f_out)
552 {
553         char line[200];
554         char *motd;
555         int i;
556
557         io_set_sock_fds(f_in, f_out);
558
559         if (!lp_load(config_file, 0))
560                 exit_cleanup(RERR_SYNTAX);
561
562         log_init();
563
564         if (!am_server) {
565                 set_socket_options(f_in, "SO_KEEPALIVE");
566                 set_socket_options(f_in, lp_socket_options());
567                 set_nonblocking(f_in);
568         }
569
570         io_printf(f_out, "@RSYNCD: %d\n", protocol_version);
571
572         motd = lp_motd_file();
573         if (motd && *motd) {
574                 FILE *f = fopen(motd,"r");
575                 while (f && !feof(f)) {
576                         int len = fread(line, 1, sizeof line - 1, f);
577                         if (len > 0) {
578                                 line[len] = 0;
579                                 io_printf(f_out, "%s", line);
580                         }
581                 }
582                 if (f)
583                         fclose(f);
584                 io_printf(f_out, "\n");
585         }
586
587         if (!read_line(f_in, line, sizeof line - 1))
588                 return -1;
589
590         if (sscanf(line,"@RSYNCD: %d", &remote_protocol) != 1) {
591                 io_printf(f_out, "@ERROR: protocol startup error\n");
592                 return -1;
593         }
594         if (protocol_version > remote_protocol)
595                 protocol_version = remote_protocol;
596
597         line[0] = 0;
598         if (!read_line(f_in, line, sizeof line - 1))
599                 return -1;
600
601         if (!*line || strcmp(line, "#list") == 0) {
602                 send_listing(f_out);
603                 return -1;
604         }
605
606         if (*line == '#') {
607                 /* it's some sort of command that I don't understand */
608                 io_printf(f_out, "@ERROR: Unknown command '%s'\n", line);
609                 return -1;
610         }
611
612         if ((i = lp_number(line)) < 0) {
613                 char *addr = client_addr(f_in);
614                 char *host = client_name(f_in);
615                 rprintf(FLOG, "unknown module '%s' tried from %s (%s)\n",
616                         line, host, addr);
617                 io_printf(f_out, "@ERROR: Unknown module '%s'\n", line);
618                 return -1;
619         }
620
621         return rsync_module(f_in, f_out, i);
622 }
623
624
625 int daemon_main(void)
626 {
627         char *pid_file;
628
629         if (is_a_socket(STDIN_FILENO)) {
630                 int i;
631
632                 /* we are running via inetd - close off stdout and
633                  * stderr so that library functions (and getopt) don't
634                  * try to use them. Redirect them to /dev/null */
635                 for (i = 1; i < 3; i++) {
636                         close(i);
637                         open("/dev/null", O_RDWR);
638                 }
639
640                 return start_daemon(STDIN_FILENO, STDIN_FILENO);
641         }
642
643         if (!no_detach)
644                 become_daemon();
645
646         if (!lp_load(config_file, 1))
647                 exit_cleanup(RERR_SYNTAX);
648
649         if (rsync_port == 0 && (rsync_port = lp_rsync_port()) == 0)
650                 rsync_port = RSYNC_PORT;
651         if (bind_address == NULL && *lp_bind_address())
652                 bind_address = lp_bind_address();
653
654         log_init();
655
656         rprintf(FLOG, "rsyncd version %s starting, listening on port %d\n",
657                 RSYNC_VERSION, rsync_port);
658         /* TODO: If listening on a particular address, then show that
659          * address too.  In fact, why not just do inet_ntop on the
660          * local address??? */
661
662         if (((pid_file = lp_pid_file()) != NULL) && (*pid_file != '\0')) {
663                 char pidbuf[16];
664                 int fd;
665                 pid_t pid = getpid();
666                 cleanup_set_pid(pid);
667                 if ((fd = do_open(lp_pid_file(), O_WRONLY|O_CREAT|O_TRUNC,
668                                         0666 & ~orig_umask)) == -1) {
669                         cleanup_set_pid(0);
670                         rsyserr(FLOG, errno, "failed to create pid file %s",
671                                 safe_fname(pid_file));
672                         exit_cleanup(RERR_FILEIO);
673                 }
674                 snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
675                 write(fd, pidbuf, strlen(pidbuf));
676                 close(fd);
677         }
678
679         start_accept_loop(rsync_port, start_daemon);
680         return -1;
681 }