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