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