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