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