Make sure that "- !" or "+ !" aren't interpreted as a list-clearing
[rsync.git] / clientserver.c
blobd354ef74db8b670e794b50e493e07341946de2b9
1 /* -*- c-file-style: "linux"; -*-
3 * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 * Copyright (C) 2001-2002 by Martin Pool <mbp@samba.org>
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.
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.
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.
21 /**
22 * @file
24 * The socket based protocol for setting up a connection with
25 * rsyncd.
26 **/
28 #include "rsync.h"
30 extern int verbose;
31 extern int list_only;
32 extern int am_sender;
33 extern int am_server;
34 extern int am_daemon;
35 extern int am_root;
36 extern int rsync_port;
37 extern int kluge_around_eof;
38 extern int daemon_over_rsh;
39 extern int sanitize_paths;
40 extern int filesfrom_fd;
41 extern int remote_protocol;
42 extern int protocol_version;
43 extern int io_timeout;
44 extern int select_timeout;
45 extern int orig_umask;
46 extern int no_detach;
47 extern int default_af_hint;
48 extern char *bind_address;
49 extern struct filter_list_struct server_filter_list;
50 extern char *config_file;
51 extern char *files_from;
53 char *auth_user;
54 int read_only = 0;
55 int daemon_log_format_has_i = 0;
56 int daemon_log_format_has_o_or_i = 0;
57 int module_id = -1;
59 /* Length of lp_path() string when in daemon mode & not chrooted, else 0. */
60 unsigned int module_dirlen = 0;
62 /**
63 * Run a client connected to an rsyncd. The alternative to this
64 * function for remote-shell connections is do_cmd().
66 * After negotiating which module to use and reading the server's
67 * motd, this hands over to client_run(). Telling the server the
68 * module will cause it to chroot/setuid/etc.
70 * Instead of doing a transfer, the client may at this stage instead
71 * get a listing of remote modules and exit.
73 * @return -1 for error in startup, or the result of client_run().
74 * Either way, it eventually gets passed to exit_cleanup().
75 **/
76 int start_socket_client(char *host, char *path, int argc, char *argv[])
78 int fd, ret;
79 char *p, *user = NULL;
81 /* This is redundant with code in start_inband_exchange(), but this
82 * short-circuits a problem in the client before we open a socket,
83 * and the extra check won't hurt. */
84 if (*path == '/') {
85 rprintf(FERROR,
86 "ERROR: The remote path must start with a module name not a /\n");
87 return -1;
90 if ((p = strrchr(host, '@')) != NULL) {
91 user = host;
92 host = p+1;
93 *p = '\0';
96 fd = open_socket_out_wrapped(host, rsync_port, bind_address,
97 default_af_hint);
98 if (fd == -1)
99 exit_cleanup(RERR_SOCKETIO);
101 ret = start_inband_exchange(user, path, fd, fd, argc);
103 return ret < 0? ret : client_run(fd, fd, -1, argc, argv);
106 int start_inband_exchange(char *user, char *path, int f_in, int f_out,
107 int argc)
109 int i;
110 char *sargs[MAX_ARGS];
111 int sargc = 0;
112 char line[MAXPATHLEN];
113 char *p;
115 if (argc == 0 && !am_sender)
116 list_only |= 1;
118 if (*path == '/') {
119 rprintf(FERROR,
120 "ERROR: The remote path must start with a module name\n");
121 return -1;
124 if (!user)
125 user = getenv("USER");
126 if (!user)
127 user = getenv("LOGNAME");
129 io_printf(f_out, "@RSYNCD: %d\n", protocol_version);
131 if (!read_line(f_in, line, sizeof line - 1)) {
132 rprintf(FERROR, "rsync: did not see server greeting\n");
133 return -1;
136 if (sscanf(line,"@RSYNCD: %d", &remote_protocol) != 1) {
137 /* note that read_line strips of \n or \r */
138 rprintf(FERROR, "rsync: server sent \"%s\" rather than greeting\n",
139 line);
140 return -1;
142 if (protocol_version > remote_protocol)
143 protocol_version = remote_protocol;
145 if (list_only && protocol_version >= 29)
146 list_only |= 2;
148 /* set daemon_over_rsh to false since we need to build the
149 * true set of args passed through the rsh/ssh connection;
150 * this is a no-op for direct-socket-connection mode */
151 daemon_over_rsh = 0;
152 server_options(sargs, &sargc);
154 sargs[sargc++] = ".";
156 if (path && *path)
157 sargs[sargc++] = path;
159 sargs[sargc] = NULL;
161 if (verbose > 1)
162 print_child_argv(sargs);
164 p = strchr(path,'/');
165 if (p) *p = 0;
166 io_printf(f_out, "%s\n", path);
167 if (p) *p = '/';
169 /* Old servers may just drop the connection here,
170 rather than sending a proper EXIT command. Yuck. */
171 kluge_around_eof = list_only && protocol_version < 25 ? 1 : 0;
173 while (1) {
174 if (!read_line(f_in, line, sizeof line - 1)) {
175 rprintf(FERROR, "rsync: didn't get server startup line\n");
176 return -1;
179 if (strncmp(line,"@RSYNCD: AUTHREQD ",18) == 0) {
180 auth_client(f_out, user, line+18);
181 continue;
184 if (strcmp(line,"@RSYNCD: OK") == 0)
185 break;
187 if (strcmp(line,"@RSYNCD: EXIT") == 0) {
188 /* This is sent by recent versions of the
189 * server to terminate the listing of modules.
190 * We don't want to go on and transfer
191 * anything; just exit. */
192 exit(0);
195 if (strncmp(line, "@ERROR", 6) == 0) {
196 rprintf(FERROR, "%s\n", line);
197 /* This is always fatal; the server will now
198 * close the socket. */
199 return RERR_STARTCLIENT;
200 } else {
201 rprintf(FINFO,"%s\n", line);
204 kluge_around_eof = 0;
206 for (i = 0; i < sargc; i++) {
207 io_printf(f_out, "%s\n", sargs[i]);
209 io_printf(f_out, "\n");
211 if (protocol_version < 23) {
212 if (protocol_version == 22 || !am_sender)
213 io_start_multiplex_in();
216 return 0;
221 static int rsync_module(int f_in, int f_out, int i)
223 int argc = 0;
224 int maxargs;
225 char **argv;
226 char **argp;
227 char line[MAXPATHLEN];
228 uid_t uid = (uid_t)-2; /* canonically "nobody" */
229 gid_t gid = (gid_t)-2;
230 char *p;
231 char *addr = client_addr(f_in);
232 char *host = client_name(f_in);
233 char *name = lp_name(i);
234 int use_chroot = lp_use_chroot(i);
235 int start_glob = 0;
236 int ret;
237 char *request = NULL;
239 if (!allow_access(addr, host, lp_hosts_allow(i), lp_hosts_deny(i))) {
240 rprintf(FLOG, "rsync denied on module %s from %s (%s)\n",
241 name, host, addr);
242 if (!lp_list(i))
243 io_printf(f_out, "@ERROR: Unknown module '%s'\n", name);
244 else {
245 io_printf(f_out,
246 "@ERROR: access denied to %s from %s (%s)\n",
247 name, host, addr);
249 return -1;
252 if (am_daemon && am_server) {
253 rprintf(FLOG, "rsync allowed access on module %s from %s (%s)\n",
254 name, host, addr);
257 if (!claim_connection(lp_lock_file(i), lp_max_connections(i))) {
258 if (errno) {
259 rsyserr(FLOG, errno, "failed to open lock file %s",
260 safe_fname(lp_lock_file(i)));
261 io_printf(f_out, "@ERROR: failed to open lock file\n");
262 } else {
263 rprintf(FLOG, "max connections (%d) reached\n",
264 lp_max_connections(i));
265 io_printf(f_out, "@ERROR: max connections (%d) reached -- try again later\n",
266 lp_max_connections(i));
268 return -1;
271 auth_user = auth_server(f_in, f_out, i, addr, "@RSYNCD: AUTHREQD ");
273 if (!auth_user) {
274 rprintf(FLOG, "auth failed on module %s from %s (%s)\n",
275 name, host, addr);
276 io_printf(f_out, "@ERROR: auth failed on module %s\n", name);
277 return -1;
280 module_id = i;
282 if (lp_read_only(i))
283 read_only = 1;
285 if (lp_transfer_logging(i)) {
286 if (log_format_has(lp_log_format(i), 'i'))
287 daemon_log_format_has_i = 1;
288 if (daemon_log_format_has_i
289 || log_format_has(lp_log_format(i), 'o'))
290 daemon_log_format_has_o_or_i = 1;
293 am_root = (MY_UID() == 0);
295 if (am_root) {
296 p = lp_uid(i);
297 if (!name_to_uid(p, &uid)) {
298 if (!isdigit(*(unsigned char *)p)) {
299 rprintf(FLOG, "Invalid uid %s\n", p);
300 io_printf(f_out, "@ERROR: invalid uid %s\n", p);
301 return -1;
303 uid = atoi(p);
306 p = lp_gid(i);
307 if (!name_to_gid(p, &gid)) {
308 if (!isdigit(*(unsigned char *)p)) {
309 rprintf(FLOG, "Invalid gid %s\n", p);
310 io_printf(f_out, "@ERROR: invalid gid %s\n", p);
311 return -1;
313 gid = atoi(p);
317 /* TODO: If we're not root, but the configuration requests
318 * that we change to some uid other than the current one, then
319 * log a warning. */
321 /* TODO: Perhaps take a list of gids, and make them into the
322 * supplementary groups. */
324 if (use_chroot || (module_dirlen = strlen(lp_path(i))) == 1) {
325 module_dirlen = 0;
326 set_filter_dir("/", 1);
327 } else
328 set_filter_dir(lp_path(i), module_dirlen);
330 p = lp_filter(i);
331 parse_rule(&server_filter_list, p, MATCHFLG_WORD_SPLIT,
332 XFLG_ANCHORED2ABS);
334 p = lp_include_from(i);
335 parse_filter_file(&server_filter_list, p, MATCHFLG_INCLUDE,
336 XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES | XFLG_FATAL_ERRORS);
338 p = lp_include(i);
339 parse_rule(&server_filter_list, p,
340 MATCHFLG_INCLUDE | MATCHFLG_WORD_SPLIT,
341 XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES);
343 p = lp_exclude_from(i);
344 parse_filter_file(&server_filter_list, p, 0,
345 XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES | XFLG_FATAL_ERRORS);
347 p = lp_exclude(i);
348 parse_rule(&server_filter_list, p, MATCHFLG_WORD_SPLIT,
349 XFLG_ANCHORED2ABS | XFLG_OLD_PREFIXES);
351 log_init();
353 if (use_chroot) {
355 * XXX: The 'use chroot' flag is a fairly reliable
356 * source of confusion, because it fails under two
357 * important circumstances: running as non-root,
358 * running on Win32 (or possibly others). On the
359 * other hand, if you are running as root, then it
360 * might be better to always use chroot.
362 * So, perhaps if we can't chroot we should just issue
363 * a warning, unless a "require chroot" flag is set,
364 * in which case we fail.
366 if (chroot(lp_path(i))) {
367 rsyserr(FLOG, errno, "chroot %s failed",
368 safe_fname(lp_path(i)));
369 io_printf(f_out, "@ERROR: chroot failed\n");
370 return -1;
373 if (!push_dir("/")) {
374 rsyserr(FLOG, errno, "chdir %s failed\n",
375 safe_fname(lp_path(i)));
376 io_printf(f_out, "@ERROR: chdir failed\n");
377 return -1;
380 } else {
381 if (!push_dir(lp_path(i))) {
382 rsyserr(FLOG, errno, "chdir %s failed\n",
383 safe_fname(lp_path(i)));
384 io_printf(f_out, "@ERROR: chdir failed\n");
385 return -1;
387 sanitize_paths = 1;
390 if (am_root) {
391 /* XXXX: You could argue that if the daemon is started
392 * by a non-root user and they explicitly specify a
393 * gid, then we should try to change to that gid --
394 * this could be possible if it's already in their
395 * supplementary groups. */
397 /* TODO: Perhaps we need to document that if rsyncd is
398 * started by somebody other than root it will inherit
399 * all their supplementary groups. */
401 if (setgid(gid)) {
402 rsyserr(FLOG, errno, "setgid %d failed", (int)gid);
403 io_printf(f_out, "@ERROR: setgid failed\n");
404 return -1;
406 #ifdef HAVE_SETGROUPS
407 /* Get rid of any supplementary groups this process
408 * might have inheristed. */
409 if (setgroups(1, &gid)) {
410 rsyserr(FLOG, errno, "setgroups failed");
411 io_printf(f_out, "@ERROR: setgroups failed\n");
412 return -1;
414 #endif
416 if (setuid(uid)) {
417 rsyserr(FLOG, errno, "setuid %d failed", (int)uid);
418 io_printf(f_out, "@ERROR: setuid failed\n");
419 return -1;
422 am_root = (MY_UID() == 0);
425 io_printf(f_out, "@RSYNCD: OK\n");
427 maxargs = MAX_ARGS;
428 if (!(argv = new_array(char *, maxargs)))
429 out_of_memory("rsync_module");
430 argv[argc++] = "rsyncd";
432 while (1) {
433 if (!read_line(f_in, line, sizeof line - 1))
434 return -1;
436 if (!*line)
437 break;
439 p = line;
441 if (argc == maxargs) {
442 maxargs += MAX_ARGS;
443 if (!(argv = realloc_array(argv, char *, maxargs)))
444 out_of_memory("rsync_module");
446 if (!(argv[argc] = strdup(p)))
447 out_of_memory("rsync_module");
449 if (start_glob) {
450 if (start_glob == 1) {
451 request = strdup(p);
452 start_glob++;
454 glob_expand(name, &argv, &argc, &maxargs);
455 } else
456 argc++;
458 if (strcmp(line, ".") == 0)
459 start_glob = 1;
462 verbose = 0; /* future verbosity is controlled by client options */
463 argp = argv;
464 ret = parse_arguments(&argc, (const char ***) &argp, 0);
466 if (filesfrom_fd == 0)
467 filesfrom_fd = f_in;
469 if (request) {
470 if (*auth_user) {
471 rprintf(FLOG, "rsync %s %s from %s@%s (%s)\n",
472 am_sender ? "on" : "to",
473 request, auth_user, host, addr);
474 } else {
475 rprintf(FLOG, "rsync %s %s from %s (%s)\n",
476 am_sender ? "on" : "to",
477 request, host, addr);
479 free(request);
482 #ifndef DEBUG
483 /* don't allow the logs to be flooded too fast */
484 if (verbose > lp_max_verbosity())
485 verbose = lp_max_verbosity();
486 #endif
488 if (protocol_version < 23
489 && (protocol_version == 22 || am_sender))
490 io_start_multiplex_out();
491 else if (!ret) {
492 /* We have to get I/O multiplexing started so that we can
493 * get the error back to the client. This means getting
494 * the protocol setup finished first in later versions. */
495 setup_protocol(f_out, f_in);
496 if (!am_sender) {
497 /* Since we failed in our option parsing, we may not
498 * have finished parsing that the client sent us a
499 * --files-from option, so look for it manually.
500 * Without this, the socket would be in the wrong
501 * state for the upcoming error message. */
502 if (!files_from) {
503 int i;
504 for (i = 0; i < argc; i++) {
505 if (strncmp(argv[i], "--files-from", 12) == 0) {
506 files_from = "";
507 break;
511 if (files_from)
512 write_byte(f_out, 0);
514 io_start_multiplex_out();
517 if (!ret) {
518 option_error();
519 msleep(400);
520 exit_cleanup(RERR_UNSUPPORTED);
523 if (lp_timeout(i)) {
524 io_timeout = lp_timeout(i);
525 if (io_timeout < select_timeout)
526 select_timeout = io_timeout;
529 start_server(f_in, f_out, argc, argp);
531 return 0;
534 /* send a list of available modules to the client. Don't list those
535 with "list = False". */
536 static void send_listing(int fd)
538 int n = lp_numservices();
539 int i;
541 for (i = 0; i < n; i++) {
542 if (lp_list(i))
543 io_printf(fd, "%-15s\t%s\n", lp_name(i), lp_comment(i));
546 if (protocol_version >= 25)
547 io_printf(fd,"@RSYNCD: EXIT\n");
550 /* this is called when a connection is established to a client
551 and we want to start talking. The setup of the system is done from
552 here */
553 int start_daemon(int f_in, int f_out)
555 char line[200];
556 char *motd;
557 int i;
559 io_set_sock_fds(f_in, f_out);
561 if (!lp_load(config_file, 0))
562 exit_cleanup(RERR_SYNTAX);
564 log_init();
566 if (!am_server) {
567 set_socket_options(f_in, "SO_KEEPALIVE");
568 set_socket_options(f_in, lp_socket_options());
569 set_nonblocking(f_in);
572 io_printf(f_out, "@RSYNCD: %d\n", protocol_version);
574 motd = lp_motd_file();
575 if (motd && *motd) {
576 FILE *f = fopen(motd,"r");
577 while (f && !feof(f)) {
578 int len = fread(line, 1, sizeof line - 1, f);
579 if (len > 0) {
580 line[len] = 0;
581 io_printf(f_out, "%s", line);
584 if (f)
585 fclose(f);
586 io_printf(f_out, "\n");
589 if (!read_line(f_in, line, sizeof line - 1))
590 return -1;
592 if (sscanf(line,"@RSYNCD: %d", &remote_protocol) != 1) {
593 io_printf(f_out, "@ERROR: protocol startup error\n");
594 return -1;
596 if (protocol_version > remote_protocol)
597 protocol_version = remote_protocol;
599 line[0] = 0;
600 if (!read_line(f_in, line, sizeof line - 1))
601 return -1;
603 if (!*line || strcmp(line, "#list") == 0) {
604 send_listing(f_out);
605 return -1;
608 if (*line == '#') {
609 /* it's some sort of command that I don't understand */
610 io_printf(f_out, "@ERROR: Unknown command '%s'\n", line);
611 return -1;
614 if ((i = lp_number(line)) < 0) {
615 char *addr = client_addr(f_in);
616 char *host = client_name(f_in);
617 rprintf(FLOG, "unknown module '%s' tried from %s (%s)\n",
618 line, host, addr);
619 io_printf(f_out, "@ERROR: Unknown module '%s'\n", line);
620 return -1;
623 return rsync_module(f_in, f_out, i);
627 int daemon_main(void)
629 char *pid_file;
631 if (is_a_socket(STDIN_FILENO)) {
632 int i;
634 /* we are running via inetd - close off stdout and
635 * stderr so that library functions (and getopt) don't
636 * try to use them. Redirect them to /dev/null */
637 for (i = 1; i < 3; i++) {
638 close(i);
639 open("/dev/null", O_RDWR);
642 return start_daemon(STDIN_FILENO, STDIN_FILENO);
645 if (!no_detach)
646 become_daemon();
648 if (!lp_load(config_file, 1))
649 exit_cleanup(RERR_SYNTAX);
651 if (rsync_port == 0 && (rsync_port = lp_rsync_port()) == 0)
652 rsync_port = RSYNC_PORT;
653 if (bind_address == NULL && *lp_bind_address())
654 bind_address = lp_bind_address();
656 log_init();
658 rprintf(FLOG, "rsyncd version %s starting, listening on port %d\n",
659 RSYNC_VERSION, rsync_port);
660 /* TODO: If listening on a particular address, then show that
661 * address too. In fact, why not just do inet_ntop on the
662 * local address??? */
664 if (((pid_file = lp_pid_file()) != NULL) && (*pid_file != '\0')) {
665 char pidbuf[16];
666 int fd;
667 pid_t pid = getpid();
668 cleanup_set_pid(pid);
669 if ((fd = do_open(lp_pid_file(), O_WRONLY|O_CREAT|O_TRUNC,
670 0666 & ~orig_umask)) == -1) {
671 cleanup_set_pid(0);
672 rsyserr(FLOG, errno, "failed to create pid file %s",
673 safe_fname(pid_file));
674 exit_cleanup(RERR_FILEIO);
676 snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
677 write(fd, pidbuf, strlen(pidbuf));
678 close(fd);
681 start_accept_loop(rsync_port, start_daemon);
682 return -1;