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