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