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