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