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