Tweaked the externs.
[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_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
76          * this short-circuits a problem before we open a socket, and
77          * the extra check won't hurt */
78         if (*path == '/') {
79                 rprintf(FERROR,"ERROR: The remote path must start with a module name not a /\n");
80                 return -1;
81         }
82
83         p = strchr(host, '@');
84         if (p) {
85                 user = host;
86                 host = p+1;
87                 *p = 0;
88         }
89
90         if (verbose >= 2) {
91                 /* FIXME: If we're going to use a socket program for
92                  * testing, then this message is wrong.  We need to
93                  * say something like "(except really using %s)" */
94                 rprintf(FINFO, "opening tcp connection to %s port %d\n",
95                         host, rsync_port);
96         }
97         fd = open_socket_out_wrapped(host, rsync_port, bind_address,
98                                      default_af_hint);
99         if (fd == -1) {
100                 exit_cleanup(RERR_SOCKETIO);
101         }
102
103         ret = start_inband_exchange(user, path, fd, fd, argc);
104
105         return ret < 0? ret : client_run(fd, fd, -1, argc, argv);
106 }
107
108 int start_inband_exchange(char *user, char *path, int f_in, int f_out, int argc)
109 {
110         int i;
111         char *sargs[MAX_ARGS];
112         int sargc = 0;
113         char line[MAXPATHLEN];
114         char *p;
115
116         if (argc == 0 && !am_sender)
117                 list_only = 1;
118
119         if (*path == '/') {
120                 rprintf(FERROR, "ERROR: The remote path must start with a module name\n");
121                 return -1;
122         }
123
124         if (!user) user = getenv("USER");
125         if (!user) 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) break;
177
178                 if (strcmp(line,"@RSYNCD: EXIT") == 0) {
179                         /* This is sent by recent versions of the
180                          * server to terminate the listing of modules.
181                          * We don't want to go on and transfer
182                          * anything; just exit. */
183                         exit(0);
184                 }
185
186                 if (strncmp(line, "@ERROR", 6) == 0) {
187                         rprintf(FERROR,"%s\n", line);
188                         /* This is always fatal; the server will now
189                          * close the socket. */
190                         return RERR_STARTCLIENT;
191                 } else {
192                         rprintf(FINFO,"%s\n", line);
193                 }
194         }
195         kludge_around_eof = False;
196
197         for (i = 0; i < sargc; i++) {
198                 io_printf(f_out, "%s\n", sargs[i]);
199         }
200         io_printf(f_out, "\n");
201
202         if (protocol_version < 23) {
203                 if (protocol_version == 22 || !am_sender)
204                         io_start_multiplex_in(f_in);
205         }
206
207         return 0;
208 }
209
210
211
212 static int rsync_module(int f_in, int f_out, int i)
213 {
214         int argc=0;
215         char *argv[MAX_ARGS];
216         char **argp;
217         char line[MAXPATHLEN];
218         uid_t uid = (uid_t)-2;  /* canonically "nobody" */
219         gid_t gid = (gid_t)-2;
220         char *p;
221         char *addr = client_addr(f_in);
222         char *host = client_name(f_in);
223         char *name = lp_name(i);
224         int use_chroot = lp_use_chroot(i);
225         int start_glob=0;
226         int ret;
227         char *request=NULL;
228
229         if (!allow_access(addr, host, lp_hosts_allow(i), lp_hosts_deny(i))) {
230                 rprintf(FERROR,"rsync denied on module %s from %s (%s)\n",
231                         name, host, addr);
232                 io_printf(f_out, "@ERROR: access denied to %s from %s (%s)\n",
233                           name, host, addr);
234                 return -1;
235         }
236
237         if (am_daemon && am_server) {
238                 rprintf(FINFO, "rsync allowed access on module %s from %s (%s)\n",
239                         name, host, addr);
240         }
241
242         if (!claim_connection(lp_lock_file(i), lp_max_connections(i))) {
243                 if (errno) {
244                         rprintf(FERROR,"failed to open lock file %s : %s\n",
245                                 lp_lock_file(i), strerror(errno));
246                         io_printf(f_out, "@ERROR: failed to open lock file %s : %s\n",
247                                   lp_lock_file(i), strerror(errno));
248                 } else {
249                         rprintf(FERROR,"max connections (%d) reached\n",
250                                 lp_max_connections(i));
251                         io_printf(f_out, "@ERROR: max connections (%d) reached - try again later\n",
252                                 lp_max_connections(i));
253                 }
254                 return -1;
255         }
256
257
258         auth_user = auth_server(f_in, f_out, i, addr, "@RSYNCD: AUTHREQD ");
259
260         if (!auth_user) {
261                 rprintf(FERROR,"auth failed on module %s from %s (%s)\n",
262                         name, host, addr);
263                 io_printf(f_out, "@ERROR: auth failed on module %s\n", name);
264                 return -1;
265         }
266
267         module_id = i;
268
269         am_root = (getuid() == 0);
270
271         if (am_root) {
272                 p = lp_uid(i);
273                 if (!name_to_uid(p, &uid)) {
274                         if (!isdigit(* (unsigned char *) p)) {
275                                 rprintf(FERROR,"Invalid uid %s\n", p);
276                                 io_printf(f_out, "@ERROR: invalid uid %s\n", p);
277                                 return -1;
278                         }
279                         uid = atoi(p);
280                 }
281
282                 p = lp_gid(i);
283                 if (!name_to_gid(p, &gid)) {
284                         if (!isdigit(* (unsigned char *) p)) {
285                                 rprintf(FERROR,"Invalid gid %s\n", p);
286                                 io_printf(f_out, "@ERROR: invalid gid %s\n", p);
287                                 return -1;
288                         }
289                         gid = atoi(p);
290                 }
291         }
292
293         /* TODO: If we're not root, but the configuration requests
294          * that we change to some uid other than the current one, then
295          * log a warning. */
296
297         /* TODO: Perhaps take a list of gids, and make them into the
298          * supplementary groups. */
299
300         exclude_path_prefix = use_chroot? "" : lp_path(i);
301         if (*exclude_path_prefix == '/' && !exclude_path_prefix[1])
302                 exclude_path_prefix = "";
303
304         p = lp_include_from(i);
305         add_exclude_file(&server_exclude_list, p, MISSING_FATAL, ADD_INCLUDE);
306
307         p = lp_include(i);
308         add_exclude_line(&server_exclude_list, p, ADD_INCLUDE);
309
310         p = lp_exclude_from(i);
311         add_exclude_file(&server_exclude_list, p, MISSING_FATAL, ADD_EXCLUDE);
312
313         p = lp_exclude(i);
314         add_exclude_line(&server_exclude_list, p, ADD_EXCLUDE);
315
316         exclude_path_prefix = NULL;
317
318         log_init();
319
320         if (use_chroot) {
321                 /*
322                  * XXX: The 'use chroot' flag is a fairly reliable
323                  * source of confusion, because it fails under two
324                  * important circumstances: running as non-root,
325                  * running on Win32 (or possibly others).  On the
326                  * other hand, if you are running as root, then it
327                  * might be better to always use chroot.
328                  *
329                  * So, perhaps if we can't chroot we should just issue
330                  * a warning, unless a "require chroot" flag is set,
331                  * in which case we fail.
332                  */
333                 if (chroot(lp_path(i))) {
334                         rsyserr(FERROR, errno, "chroot %s failed", lp_path(i));
335                         io_printf(f_out, "@ERROR: chroot failed\n");
336                         return -1;
337                 }
338
339                 if (!push_dir("/")) {
340                         rsyserr(FERROR, errno, "chdir %s failed\n", lp_path(i));
341                         io_printf(f_out, "@ERROR: chdir failed\n");
342                         return -1;
343                 }
344
345         } else {
346                 if (!push_dir(lp_path(i))) {
347                         rsyserr(FERROR, errno, "chdir %s failed\n", lp_path(i));
348                         io_printf(f_out, "@ERROR: chdir failed\n");
349                         return -1;
350                 }
351                 sanitize_paths = 1;
352         }
353
354         if (am_root) {
355                 /* XXXX: You could argue that if the daemon is started
356                  * by a non-root user and they explicitly specify a
357                  * gid, then we should try to change to that gid --
358                  * this could be possible if it's already in their
359                  * supplementary groups. */
360
361                 /* TODO: Perhaps we need to document that if rsyncd is
362                  * started by somebody other than root it will inherit
363                  * all their supplementary groups. */
364
365                 if (setgid(gid)) {
366                         rsyserr(FERROR, errno, "setgid %d failed", (int) gid);
367                         io_printf(f_out, "@ERROR: setgid failed\n");
368                         return -1;
369                 }
370 #ifdef HAVE_SETGROUPS
371                 /* Get rid of any supplementary groups this process
372                  * might have inheristed. */
373                 if (setgroups(1, &gid)) {
374                         rsyserr(FERROR, errno, "setgroups failed");
375                         io_printf(f_out, "@ERROR: setgroups failed\n");
376                         return -1;
377                 }
378 #endif
379
380                 if (setuid(uid)) {
381                         rsyserr(FERROR, errno, "setuid %d failed", (int) uid);
382                         io_printf(f_out, "@ERROR: setuid failed\n");
383                         return -1;
384                 }
385
386                 am_root = (getuid() == 0);
387         }
388
389         io_printf(f_out, "@RSYNCD: OK\n");
390
391         argv[argc++] = "rsyncd";
392
393         while (1) {
394                 if (!read_line(f_in, line, sizeof(line)-1)) {
395                         return -1;
396                 }
397
398                 if (!*line) break;
399
400                 p = line;
401
402                 argv[argc] = strdup(p);
403                 if (!argv[argc]) {
404                         return -1;
405                 }
406
407                 if (start_glob) {
408                         if (start_glob == 1) {
409                                 request = strdup(p);
410                                 start_glob++;
411                         }
412                         glob_expand(name, argv, &argc, MAX_ARGS);
413                 } else {
414                         argc++;
415                 }
416
417                 if (strcmp(line,".") == 0) {
418                         start_glob = 1;
419                 }
420
421                 if (argc == MAX_ARGS) {
422                         return -1;
423                 }
424         }
425
426         if (sanitize_paths) {
427                 /*
428                  * Note that this is applied to all parameters, whether or not
429                  *    they are filenames, but no other legal parameters contain
430                  *    the forms that need to be sanitized so it doesn't hurt;
431                  *    it is not known at this point which parameters are files
432                  *    and which aren't.
433                  */
434                 for (i = 1; i < argc; i++) {
435                         sanitize_path(argv[i], NULL);
436                 }
437         }
438
439         argp = argv;
440         ret = parse_arguments(&argc, (const char ***) &argp, 0);
441
442         if (filesfrom_fd == 0)
443                 filesfrom_fd = f_in;
444
445         if (request) {
446                 if (*auth_user) {
447                         rprintf(FINFO,"rsync %s %s from %s@%s (%s)\n",
448                                 am_sender?"on":"to",
449                                 request, auth_user, host, addr);
450                 } else {
451                         rprintf(FINFO,"rsync %s %s from %s (%s)\n",
452                                 am_sender?"on":"to",
453                                 request, host, addr);
454                 }
455                 free(request);
456         }
457
458 #ifndef DEBUG
459         /* don't allow the logs to be flooded too fast */
460         if (verbose > 1) verbose = 1;
461 #endif
462
463         if (protocol_version < 23) {
464                 if (protocol_version == 22 || am_sender)
465                         io_start_multiplex_out(f_out);
466         }
467
468         /* For later protocol versions, we don't start multiplexing
469          * until we've configured nonblocking in start_server.  That
470          * means we're in a sticky situation now: there's no way to
471          * convey errors to the client. */
472
473         /* FIXME: Hold off on reporting option processing errors until
474          * we've set up nonblocking and multiplexed IO and can get the
475          * message back to them. */
476         if (!ret) {
477                 option_error();
478                 exit_cleanup(RERR_UNSUPPORTED);
479         }
480
481         if (lp_timeout(i)) {
482                 io_timeout = lp_timeout(i);
483         }
484
485         start_server(f_in, f_out, argc, argp);
486
487         return 0;
488 }
489
490 /* send a list of available modules to the client. Don't list those
491    with "list = False". */
492 static void send_listing(int fd)
493 {
494         int n = lp_numservices();
495         int i;
496
497         for (i=0;i<n;i++)
498                 if (lp_list(i))
499                         io_printf(fd, "%-15s\t%s\n", lp_name(i), lp_comment(i));
500
501         if (protocol_version >= 25)
502                 io_printf(fd,"@RSYNCD: EXIT\n");
503 }
504
505 /* this is called when a connection is established to a client
506    and we want to start talking. The setup of the system is done from
507    here */
508 int start_daemon(int f_in, int f_out)
509 {
510         char line[200];
511         char *motd;
512         int i = -1;
513
514         if (!lp_load(config_file, 0)) {
515                 exit_cleanup(RERR_SYNTAX);
516         }
517
518         log_init();
519
520         if (!am_server) {
521                 set_socket_options(f_in, "SO_KEEPALIVE");
522                 set_socket_options(f_in, lp_socket_options());
523                 set_nonblocking(f_in);
524         }
525
526         io_printf(f_out, "@RSYNCD: %d\n", protocol_version);
527
528         motd = lp_motd_file();
529         if (motd && *motd) {
530                 FILE *f = fopen(motd,"r");
531                 while (f && !feof(f)) {
532                         int len = fread(line, 1, sizeof(line)-1, f);
533                         if (len > 0) {
534                                 line[len] = 0;
535                                 io_printf(f_out, "%s", line);
536                         }
537                 }
538                 if (f) 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
546         if (sscanf(line,"@RSYNCD: %d", &remote_protocol) != 1) {
547                 io_printf(f_out, "@ERROR: protocol startup error\n");
548                 return -1;
549         }
550         if (protocol_version > remote_protocol)
551                 protocol_version = remote_protocol;
552
553         while (i == -1) {
554                 line[0] = 0;
555                 if (!read_line(f_in, line, sizeof(line)-1)) {
556                         return -1;
557                 }
558
559                 if (!*line || strcmp(line,"#list")==0) {
560                         send_listing(f_out);
561                         return -1;
562                 }
563
564                 if (*line == '#') {
565                         /* it's some sort of command that I don't understand */
566                         io_printf(f_out, "@ERROR: Unknown command '%s'\n", line);
567                         return -1;
568                 }
569
570                 i = lp_number(line);
571                 if (i == -1) {
572                         io_printf(f_out, "@ERROR: Unknown module '%s'\n", line);
573                         return -1;
574                 }
575         }
576
577         return rsync_module(f_in, f_out, i);
578 }
579
580
581 int daemon_main(void)
582 {
583         char *pid_file;
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 }