2 * The socket based protocol for setting up a connection with rsyncd.
4 * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2001-2002 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2002-2007 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
26 extern int output_motd;
32 extern int rsync_port;
33 extern int ignore_errors;
34 extern int kluge_around_eof;
35 extern int daemon_over_rsh;
36 extern int sanitize_paths;
37 extern int filesfrom_fd;
38 extern int remote_protocol;
39 extern int protocol_version;
40 extern int io_timeout;
42 extern int default_af_hint;
43 extern int logfile_format_has_i;
44 extern int logfile_format_has_o_or_i;
45 extern mode_t orig_umask;
46 extern char *bind_address;
47 extern char *sockopts;
48 extern char *config_file;
49 extern char *logfile_format;
50 extern char *files_from;
52 extern struct chmod_mode_struct *chmod_modes;
53 extern struct filter_list_struct server_filter_list;
54 extern char curr_dir[];
59 struct chmod_mode_struct *daemon_chmod_modes;
61 /* module_dirlen is the length of the module_dir string when in daemon
62 * mode, not chrooted, and the path is not "/"; otherwise 0. */
63 char *module_dir = NULL;
64 unsigned int module_dirlen = 0;
66 static int rl_nulls = 0;
69 static struct sigaction sigact;
73 * Run a client connected to an rsyncd. The alternative to this
74 * function for remote-shell connections is do_cmd().
76 * After negotiating which module to use and reading the server's
77 * motd, this hands over to client_run(). Telling the server the
78 * module will cause it to chroot/setuid/etc.
80 * Instead of doing a transfer, the client may at this stage instead
81 * get a listing of remote modules and exit.
83 * @return -1 for error in startup, or the result of client_run().
84 * Either way, it eventually gets passed to exit_cleanup().
86 int start_socket_client(char *host, int remote_argc, char *remote_argv[],
87 int argc, char *argv[])
90 char *p, *user = NULL;
92 /* This is redundant with code in start_inband_exchange(), but this
93 * short-circuits a problem in the client before we open a socket,
94 * and the extra check won't hurt. */
95 if (**remote_argv == '/') {
97 "ERROR: The remote path must start with a module name not a /\n");
101 if ((p = strrchr(host, '@')) != NULL) {
107 fd = open_socket_out_wrapped(host, rsync_port, bind_address,
110 exit_cleanup(RERR_SOCKETIO);
112 set_socket_options(fd, sockopts);
114 ret = start_inband_exchange(fd, fd, user, remote_argc, remote_argv);
116 return ret ? ret : client_run(fd, fd, -1, argc, argv);
119 static int exchange_protocols(int f_in, int f_out, char *buf, size_t bufsiz, int am_client)
122 #if SUBPROTOCOL_VERSION != 0
123 int our_sub = protocol_version < PROTOCOL_VERSION ? 0 : SUBPROTOCOL_VERSION;
129 io_printf(f_out, "@RSYNCD: %d.%d\n", protocol_version, our_sub);
132 motd = lp_motd_file();
134 FILE *f = fopen(motd,"r");
135 while (f && !feof(f)) {
136 int len = fread(buf, 1, bufsiz - 1, f);
138 write_buf(f_out, buf, len);
142 write_sbuf(f_out, "\n");
146 /* This strips the \n. */
147 if (!read_line_old(f_in, buf, bufsiz)) {
149 rprintf(FERROR, "rsync: did not see server greeting\n");
153 if (sscanf(buf, "@RSYNCD: %d.%d", &remote_protocol, &remote_sub) < 1) {
155 rprintf(FERROR, "rsync: server sent \"%s\" rather than greeting\n", buf);
157 io_printf(f_out, "@ERROR: protocol startup error\n");
161 if (remote_sub < 0) {
162 if (remote_protocol == 30) {
164 rprintf(FERROR, "rsync: server is speaking an incompatible beta of protocol 30\n");
166 io_printf(f_out, "@ERROR: your client is speaking an incompatible beta of protocol 30\n");
172 if (protocol_version > remote_protocol) {
173 protocol_version = remote_protocol;
176 } else if (protocol_version == remote_protocol) {
177 if (remote_sub != our_sub)
180 #if SUBPROTOCOL_VERSION != 0
181 else if (protocol_version < remote_protocol) {
187 if (protocol_version >= 30)
193 int start_inband_exchange(int f_in, int f_out, const char *user, int argc, char *argv[])
196 char line[BIGPATHBUFLEN];
197 char *sargs[MAX_ARGS];
199 char *p, *path = *argv;
201 if (argc == 0 && !am_sender)
206 "ERROR: The remote path must start with a module name\n");
211 user = getenv("USER");
213 user = getenv("LOGNAME");
215 if (exchange_protocols(f_in, f_out, line, sizeof line, 1) < 0)
218 /* set daemon_over_rsh to false since we need to build the
219 * true set of args passed through the rsh/ssh connection;
220 * this is a no-op for direct-socket-connection mode */
222 server_options(sargs, &sargc);
224 if (sargc >= MAX_ARGS - 2)
227 sargs[sargc++] = ".";
230 if (sargc >= MAX_ARGS - 1) {
232 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
233 exit_cleanup(RERR_SYNTAX);
235 sargs[sargc++] = *argv++;
242 print_child_argv("sending daemon args:", sargs);
244 p = strchr(path, '/');
246 io_printf(f_out, "%s\n", path);
249 /* Old servers may just drop the connection here,
250 rather than sending a proper EXIT command. Yuck. */
251 kluge_around_eof = list_only && protocol_version < 25 ? 1 : 0;
254 if (!read_line_old(f_in, line, sizeof line)) {
255 rprintf(FERROR, "rsync: didn't get server startup line\n");
259 if (strncmp(line,"@RSYNCD: AUTHREQD ",18) == 0) {
260 auth_client(f_out, user, line+18);
264 if (strcmp(line,"@RSYNCD: OK") == 0)
267 if (strcmp(line,"@RSYNCD: EXIT") == 0) {
268 /* This is sent by recent versions of the
269 * server to terminate the listing of modules.
270 * We don't want to go on and transfer
271 * anything; just exit. */
275 if (strncmp(line, "@ERROR", 6) == 0) {
276 rprintf(FERROR, "%s\n", line);
277 /* This is always fatal; the server will now
278 * close the socket. */
282 /* This might be a MOTD line or a module listing, but there is
283 * no way to differentiate it. The manpage mentions this. */
285 rprintf(FINFO, "%s\n", line);
287 kluge_around_eof = 0;
290 for (i = 0; i < sargc; i++) {
291 write_sbuf(f_out, sargs[i]);
292 write_byte(f_out, 0);
294 write_byte(f_out, 0);
296 for (i = 0; i < sargc; i++)
297 io_printf(f_out, "%s\n", sargs[i]);
298 write_sbuf(f_out, "\n");
301 if (protocol_version < 23) {
302 if (protocol_version == 22 || !am_sender)
303 io_start_multiplex_in();
309 static char *finish_pre_exec(pid_t pid, int fd, char *request,
310 int argc, char *argv[])
317 write_buf(fd, request, strlen(request)+1);
318 for (j = 0; j < argc; j++)
319 write_buf(fd, argv[j], strlen(argv[j])+1);
324 if (wait_process(pid, &status, 0) < 0
325 || !WIFEXITED(status) || WEXITSTATUS(status) != 0) {
327 if (asprintf(&e, "pre-xfer exec returned failure (%d)%s%s\n",
328 status, status < 0 ? ": " : "",
329 status < 0 ? strerror(errno) : "") < 0)
330 out_of_memory("finish_pre_exec");
336 static int read_arg_from_pipe(int fd, char *buf, int limit)
338 char *bp = buf, *eob = buf + limit - 1;
341 if (read(fd, bp, 1) != 1)
353 static int rsync_module(int f_in, int f_out, int i, char *addr, char *host)
357 char line[BIGPATHBUFLEN];
358 uid_t uid = (uid_t)-2; /* canonically "nobody" */
359 gid_t gid = (gid_t)-2;
360 char *p, *err_msg = NULL;
361 char *name = lp_name(i);
362 int use_chroot = lp_use_chroot(i);
363 int ret, pre_exec_fd = -1;
364 pid_t pre_exec_pid = 0;
365 char *request = NULL;
367 if (!allow_access(addr, host, lp_hosts_allow(i), lp_hosts_deny(i))) {
368 rprintf(FLOG, "rsync denied on module %s from %s (%s)\n",
371 io_printf(f_out, "@ERROR: Unknown module '%s'\n", name);
374 "@ERROR: access denied to %s from %s (%s)\n",
380 if (am_daemon && am_server) {
381 rprintf(FLOG, "rsync allowed access on module %s from %s (%s)\n",
385 if (!claim_connection(lp_lock_file(i), lp_max_connections(i))) {
387 rsyserr(FLOG, errno, "failed to open lock file %s",
389 io_printf(f_out, "@ERROR: failed to open lock file\n");
391 rprintf(FLOG, "max connections (%d) reached\n",
392 lp_max_connections(i));
393 io_printf(f_out, "@ERROR: max connections (%d) reached -- try again later\n",
394 lp_max_connections(i));
399 auth_user = auth_server(f_in, f_out, i, host, addr, "@RSYNCD: AUTHREQD ");
402 io_printf(f_out, "@ERROR: auth failed on module %s\n", name);
411 if (lp_transfer_logging(i) && !logfile_format)
412 logfile_format = lp_log_format(i);
413 if (log_format_has(logfile_format, 'i'))
414 logfile_format_has_i = 1;
415 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
416 logfile_format_has_o_or_i = 1;
418 am_root = (MY_UID() == 0);
422 if (!name_to_uid(p, &uid)) {
424 rprintf(FLOG, "Invalid uid %s\n", p);
425 io_printf(f_out, "@ERROR: invalid uid %s\n", p);
432 if (!name_to_gid(p, &gid)) {
434 rprintf(FLOG, "Invalid gid %s\n", p);
435 io_printf(f_out, "@ERROR: invalid gid %s\n", p);
442 /* TODO: If we're not root, but the configuration requests
443 * that we change to some uid other than the current one, then
446 /* TODO: Perhaps take a list of gids, and make them into the
447 * supplementary groups. */
449 /* We do a push_dir() without actually calling chdir() in order
450 * to make sure that the module's path is absolute. After this
451 * check, module_dir will be set to an absolute path. */
452 module_dir = lp_path(i);
453 strlcpy(line, curr_dir, sizeof line);
454 if (!push_dir(module_dir, 1))
456 if (strcmp(curr_dir, module_dir) != 0)
457 module_dir = strdup(curr_dir);
458 push_dir(line, 1); /* Restore curr_dir. */
460 if (use_chroot || (module_dirlen = strlen(module_dir)) == 1) {
462 set_filter_dir("/", 1);
464 set_filter_dir(module_dir, module_dirlen);
467 parse_rule(&server_filter_list, p, MATCHFLG_WORD_SPLIT,
470 p = lp_include_from(i);
471 parse_filter_file(&server_filter_list, p, MATCHFLG_INCLUDE,
472 XFLG_ABS_IF_SLASH | XFLG_OLD_PREFIXES | XFLG_FATAL_ERRORS);
475 parse_rule(&server_filter_list, p,
476 MATCHFLG_INCLUDE | MATCHFLG_WORD_SPLIT,
477 XFLG_ABS_IF_SLASH | XFLG_OLD_PREFIXES);
479 p = lp_exclude_from(i);
480 parse_filter_file(&server_filter_list, p, 0,
481 XFLG_ABS_IF_SLASH | XFLG_OLD_PREFIXES | XFLG_FATAL_ERRORS);
484 parse_rule(&server_filter_list, p, MATCHFLG_WORD_SPLIT,
485 XFLG_ABS_IF_SLASH | XFLG_OLD_PREFIXES);
490 if (*lp_prexfer_exec(i) || *lp_postxfer_exec(i)) {
491 char *modname, *modpath, *hostaddr, *hostname, *username;
493 if (asprintf(&modname, "RSYNC_MODULE_NAME=%s", name) < 0
494 || asprintf(&modpath, "RSYNC_MODULE_PATH=%s", module_dir) < 0
495 || asprintf(&hostaddr, "RSYNC_HOST_ADDR=%s", addr) < 0
496 || asprintf(&hostname, "RSYNC_HOST_NAME=%s", host) < 0
497 || asprintf(&username, "RSYNC_USER_NAME=%s", auth_user) < 0)
498 out_of_memory("rsync_module");
505 /* For post-xfer exec, fork a new process to run the rsync
506 * daemon while this process waits for the exit status and
507 * runs the indicated command at that point. */
508 if (*lp_postxfer_exec(i)) {
511 rsyserr(FLOG, errno, "fork failed");
512 io_printf(f_out, "@ERROR: fork failed\n");
516 if (asprintf(&p, "RSYNC_PID=%ld", (long)pid) > 0)
518 if (wait_process(pid, &status, 0) < 0)
520 if (asprintf(&p, "RSYNC_RAW_STATUS=%d", status) > 0)
522 if (WIFEXITED(status))
523 status = WEXITSTATUS(status);
526 if (asprintf(&p, "RSYNC_EXIT_STATUS=%d", status) > 0)
528 system(lp_postxfer_exec(i));
532 /* For pre-xfer exec, fork a child process to run the indicated
533 * command, though it first waits for the parent process to
534 * send us the user's request via a pipe. */
535 if (*lp_prexfer_exec(i)) {
537 if (asprintf(&p, "RSYNC_PID=%ld", (long)getpid()) > 0)
539 if (pipe(fds) < 0 || (pre_exec_pid = fork()) < 0) {
540 rsyserr(FLOG, errno, "pre-xfer exec preparation failed");
541 io_printf(f_out, "@ERROR: pre-xfer exec preparation failed\n");
544 if (pre_exec_pid == 0) {
545 char buf[BIGPATHBUFLEN];
548 set_blocking(fds[0]);
549 len = read_arg_from_pipe(fds[0], buf, BIGPATHBUFLEN);
552 if (asprintf(&p, "RSYNC_REQUEST=%s", buf) > 0)
555 len = read_arg_from_pipe(fds[0], buf,
562 if (asprintf(&p, "RSYNC_ARG%d=%s", j, buf) > 0)
567 close(STDOUT_FILENO);
568 status = system(lp_prexfer_exec(i));
569 if (!WIFEXITED(status))
571 _exit(WEXITSTATUS(status));
574 set_blocking(fds[1]);
575 pre_exec_fd = fds[1];
583 * XXX: The 'use chroot' flag is a fairly reliable
584 * source of confusion, because it fails under two
585 * important circumstances: running as non-root,
586 * running on Win32 (or possibly others). On the
587 * other hand, if you are running as root, then it
588 * might be better to always use chroot.
590 * So, perhaps if we can't chroot we should just issue
591 * a warning, unless a "require chroot" flag is set,
592 * in which case we fail.
594 if (chroot(module_dir)) {
595 rsyserr(FLOG, errno, "chroot %s failed", module_dir);
596 io_printf(f_out, "@ERROR: chroot failed\n");
599 if (!push_dir("/", 0))
602 if (!push_dir(module_dir, 0)) {
604 rsyserr(FLOG, errno, "chdir %s failed\n", module_dir);
605 io_printf(f_out, "@ERROR: chdir failed\n");
612 /* XXXX: You could argue that if the daemon is started
613 * by a non-root user and they explicitly specify a
614 * gid, then we should try to change to that gid --
615 * this could be possible if it's already in their
616 * supplementary groups. */
618 /* TODO: Perhaps we need to document that if rsyncd is
619 * started by somebody other than root it will inherit
620 * all their supplementary groups. */
623 rsyserr(FLOG, errno, "setgid %d failed", (int)gid);
624 io_printf(f_out, "@ERROR: setgid failed\n");
627 #ifdef HAVE_SETGROUPS
628 /* Get rid of any supplementary groups this process
629 * might have inheristed. */
630 if (setgroups(1, &gid)) {
631 rsyserr(FLOG, errno, "setgroups failed");
632 io_printf(f_out, "@ERROR: setgroups failed\n");
638 rsyserr(FLOG, errno, "setuid %d failed", (int)uid);
639 io_printf(f_out, "@ERROR: setuid failed\n");
643 am_root = (MY_UID() == 0);
646 if (lp_temp_dir(i) && *lp_temp_dir(i)) {
647 tmpdir = lp_temp_dir(i);
648 if (strlen(tmpdir) >= MAXPATHLEN - 10) {
650 "the 'temp dir' value for %s is WAY too long -- ignoring.\n",
656 io_printf(f_out, "@RSYNCD: OK\n");
658 opt_cnt = read_args(f_in, name, line, sizeof line, rl_nulls, &argv, &argc, &request);
661 err_msg = finish_pre_exec(pre_exec_pid, pre_exec_fd, request,
665 verbose = 0; /* future verbosity is controlled by client options */
666 ret = parse_arguments(&argc, (const char ***) &argv, 0);
667 am_server = 1; /* Don't let someone try to be tricky. */
668 if (lp_ignore_errors(module_id))
671 if (lp_fake_super(i))
673 else if (am_root < 0) /* Treat --fake-super from client as --super. */
676 if (filesfrom_fd == 0)
681 rprintf(FLOG, "rsync %s %s from %s@%s (%s)\n",
682 am_sender ? "on" : "to",
683 request, auth_user, host, addr);
685 rprintf(FLOG, "rsync %s %s from %s (%s)\n",
686 am_sender ? "on" : "to",
687 request, host, addr);
693 /* don't allow the logs to be flooded too fast */
694 if (verbose > lp_max_verbosity(i))
695 verbose = lp_max_verbosity(i);
698 if (protocol_version < 23
699 && (protocol_version == 22 || am_sender))
700 io_start_multiplex_out();
701 else if (!ret || err_msg) {
702 /* We have to get I/O multiplexing started so that we can
703 * get the error back to the client. This means getting
704 * the protocol setup finished first in later versions. */
705 setup_protocol(f_out, f_in);
707 /* Since we failed in our option parsing, we may not
708 * have finished parsing that the client sent us a
709 * --files-from option, so look for it manually.
710 * Without this, the socket would be in the wrong
711 * state for the upcoming error message. */
714 for (i = 0; i < argc; i++) {
715 if (strncmp(argv[i], "--files-from", 12) == 0) {
722 write_byte(f_out, 0);
724 io_start_multiplex_out();
727 if (!ret || err_msg) {
729 rwrite(FERROR, err_msg, strlen(err_msg), 0);
733 exit_cleanup(RERR_UNSUPPORTED);
736 if (lp_timeout(i) && lp_timeout(i) > io_timeout)
737 set_io_timeout(lp_timeout(i));
739 /* If we have some incoming/outgoing chmod changes, append them to
740 * any user-specified changes (making our changes have priority).
741 * We also get a pointer to just our changes so that a receiver
742 * process can use them separately if --perms wasn't specified. */
744 p = lp_outgoing_chmod(i);
746 p = lp_incoming_chmod(i);
747 if (*p && !(daemon_chmod_modes = parse_chmod(p, &chmod_modes))) {
748 rprintf(FLOG, "Invalid \"%sing chmod\" directive: %s\n",
749 am_sender ? "outgo" : "incom", p);
752 start_server(f_in, f_out, argc, argv);
757 /* send a list of available modules to the client. Don't list those
758 with "list = False". */
759 static void send_listing(int fd)
761 int n = lp_numservices();
764 for (i = 0; i < n; i++) {
766 io_printf(fd, "%-15s\t%s\n", lp_name(i), lp_comment(i));
769 if (protocol_version >= 25)
770 io_printf(fd,"@RSYNCD: EXIT\n");
773 /* this is called when a connection is established to a client
774 and we want to start talking. The setup of the system is done from
776 int start_daemon(int f_in, int f_out)
782 io_set_sock_fds(f_in, f_out);
784 /* We must load the config file before calling any function that
785 * might cause log-file output to occur. This ensures that the
786 * "log file" param gets honored for the 2 non-forked use-cases
787 * (when rsync is run by init and run by a remote shell). */
788 if (!lp_load(config_file, 0))
789 exit_cleanup(RERR_SYNTAX);
791 addr = client_addr(f_in);
792 host = client_name(f_in);
793 rprintf(FLOG, "connect from %s (%s)\n", host, addr);
796 set_socket_options(f_in, "SO_KEEPALIVE");
798 set_socket_options(f_in, sockopts);
800 set_socket_options(f_in, lp_socket_options());
801 set_nonblocking(f_in);
804 if (exchange_protocols(f_in, f_out, line, sizeof line, 0) < 0)
808 if (!read_line_old(f_in, line, sizeof line))
811 if (!*line || strcmp(line, "#list") == 0) {
812 rprintf(FLOG, "module-list request from %s (%s)\n",
819 /* it's some sort of command that I don't understand */
820 io_printf(f_out, "@ERROR: Unknown command '%s'\n", line);
824 if ((i = lp_number(line)) < 0) {
825 rprintf(FLOG, "unknown module '%s' tried from %s (%s)\n",
827 io_printf(f_out, "@ERROR: Unknown module '%s'\n", line);
831 #ifdef HAVE_SIGACTION
832 sigact.sa_flags = SA_NOCLDSTOP;
834 SIGACTION(SIGCHLD, remember_children);
836 return rsync_module(f_in, f_out, i, addr, host);
839 static void create_pid_file(void)
841 char *pid_file = lp_pid_file();
843 pid_t pid = getpid();
846 if (!pid_file || !*pid_file)
849 cleanup_set_pid(pid);
850 if ((fd = do_open(pid_file, O_WRONLY|O_CREAT|O_EXCL, 0666 & ~orig_umask)) == -1) {
852 fprintf(stderr, "failed to create pid file %s: %s\n", pid_file, strerror(errno));
853 rsyserr(FLOG, errno, "failed to create pid file %s", pid_file);
854 exit_cleanup(RERR_FILEIO);
856 snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
857 write(fd, pidbuf, strlen(pidbuf));
861 /* Become a daemon, discarding the controlling terminal. */
862 static void become_daemon(void)
869 fprintf(stderr, "failed to fork: %s\n", strerror(errno));
870 exit_cleanup(RERR_FILEIO);
877 /* detach from the terminal */
880 #elif defined TIOCNOTTY
881 i = open("/dev/tty", O_RDWR);
883 ioctl(i, (int)TIOCNOTTY, (char *)0);
887 /* make sure that stdin, stdout an stderr don't stuff things
888 * up (library functions, for example) */
889 for (i = 0; i < 3; i++) {
891 open("/dev/null", O_RDWR);
895 int daemon_main(void)
898 if (am_server && am_root <= 0)
899 config_file = RSYNCD_USERCONF;
901 config_file = RSYNCD_SYSCONF;
904 if (is_a_socket(STDIN_FILENO)) {
907 /* we are running via inetd - close off stdout and
908 * stderr so that library functions (and getopt) don't
909 * try to use them. Redirect them to /dev/null */
910 for (i = 1; i < 3; i++) {
912 open("/dev/null", O_RDWR);
915 return start_daemon(STDIN_FILENO, STDIN_FILENO);
918 if (!lp_load(config_file, 1)) {
919 fprintf(stderr, "Failed to parse config file: %s\n", config_file);
920 exit_cleanup(RERR_SYNTAX);
928 if (rsync_port == 0 && (rsync_port = lp_rsync_port()) == 0)
929 rsync_port = RSYNC_PORT;
930 if (bind_address == NULL && *lp_bind_address())
931 bind_address = lp_bind_address();
935 rprintf(FLOG, "rsyncd version %s starting, listening on port %d\n",
936 RSYNC_VERSION, rsync_port);
937 /* TODO: If listening on a particular address, then show that
938 * address too. In fact, why not just do inet_ntop on the
939 * local address??? */
941 start_accept_loop(rsync_port, start_daemon);