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