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.
24 * The socket based protocol for setting up a connection with
37 extern int rsync_port
;
38 extern int kluge_around_eof
;
39 extern int daemon_over_rsh
;
40 extern int sanitize_paths
;
41 extern int filesfrom_fd
;
42 extern int remote_protocol
;
43 extern int protocol_version
;
44 extern int io_timeout
;
46 extern int default_af_hint
;
47 extern int log_initialised
;
48 extern mode_t orig_umask
;
49 extern char *bind_address
;
50 extern char *sockopts
;
51 extern char *config_file
;
52 extern char *files_from
;
54 extern struct chmod_mode_struct
*chmod_modes
;
55 extern struct filter_list_struct server_filter_list
;
59 int daemon_log_format_has_i
= 0;
60 int daemon_log_format_has_o_or_i
= 0;
62 struct chmod_mode_struct
*daemon_chmod_modes
;
64 /* Length of lp_path() string when in daemon mode & not chrooted, else 0. */
65 unsigned int module_dirlen
= 0;
68 static struct sigaction sigact
;
72 * Run a client connected to an rsyncd. The alternative to this
73 * function for remote-shell connections is do_cmd().
75 * After negotiating which module to use and reading the server's
76 * motd, this hands over to client_run(). Telling the server the
77 * module will cause it to chroot/setuid/etc.
79 * Instead of doing a transfer, the client may at this stage instead
80 * get a listing of remote modules and exit.
82 * @return -1 for error in startup, or the result of client_run().
83 * Either way, it eventually gets passed to exit_cleanup().
85 int start_socket_client(char *host
, char *path
, int argc
, char *argv
[])
88 char *p
, *user
= NULL
;
90 /* This is redundant with code in start_inband_exchange(), but this
91 * short-circuits a problem in the client before we open a socket,
92 * and the extra check won't hurt. */
95 "ERROR: The remote path must start with a module name not a /\n");
99 if ((p
= strrchr(host
, '@')) != NULL
) {
105 fd
= open_socket_out_wrapped(host
, rsync_port
, bind_address
,
108 exit_cleanup(RERR_SOCKETIO
);
110 set_socket_options(fd
, sockopts
);
112 ret
= start_inband_exchange(user
, path
, fd
, fd
, argc
);
114 return ret
? ret
: client_run(fd
, fd
, -1, argc
, argv
);
117 int start_inband_exchange(char *user
, char *path
, int f_in
, int f_out
,
121 char *sargs
[MAX_ARGS
];
123 char line
[BIGPATHBUFLEN
];
126 if (argc
== 0 && !am_sender
)
131 "ERROR: The remote path must start with a module name\n");
136 user
= getenv("USER");
138 user
= getenv("LOGNAME");
140 io_printf(f_out
, "@RSYNCD: %d\n", protocol_version
);
142 if (!read_line(f_in
, line
, sizeof line
- 1)) {
143 rprintf(FERROR
, "rsync: did not see server greeting\n");
147 if (sscanf(line
,"@RSYNCD: %d", &remote_protocol
) != 1) {
148 /* note that read_line strips of \n or \r */
149 rprintf(FERROR
, "rsync: server sent \"%s\" rather than greeting\n",
153 if (protocol_version
> remote_protocol
)
154 protocol_version
= remote_protocol
;
156 if (list_only
&& protocol_version
>= 29)
159 /* set daemon_over_rsh to false since we need to build the
160 * true set of args passed through the rsh/ssh connection;
161 * this is a no-op for direct-socket-connection mode */
163 server_options(sargs
, &sargc
);
165 sargs
[sargc
++] = ".";
168 sargs
[sargc
++] = path
;
173 print_child_argv(sargs
);
175 p
= strchr(path
,'/');
177 io_printf(f_out
, "%s\n", path
);
180 /* Old servers may just drop the connection here,
181 rather than sending a proper EXIT command. Yuck. */
182 kluge_around_eof
= list_only
&& protocol_version
< 25 ? 1 : 0;
185 if (!read_line(f_in
, line
, sizeof line
- 1)) {
186 rprintf(FERROR
, "rsync: didn't get server startup line\n");
190 if (strncmp(line
,"@RSYNCD: AUTHREQD ",18) == 0) {
191 auth_client(f_out
, user
, line
+18);
195 if (strcmp(line
,"@RSYNCD: OK") == 0)
198 if (strcmp(line
,"@RSYNCD: EXIT") == 0) {
199 /* This is sent by recent versions of the
200 * server to terminate the listing of modules.
201 * We don't want to go on and transfer
202 * anything; just exit. */
206 if (strncmp(line
, "@ERROR", 6) == 0) {
207 rprintf(FERROR
, "%s\n", line
);
208 /* This is always fatal; the server will now
209 * close the socket. */
213 rprintf(FINFO
, "%s\n", line
);
215 kluge_around_eof
= 0;
217 for (i
= 0; i
< sargc
; i
++) {
218 io_printf(f_out
, "%s\n", sargs
[i
]);
220 io_printf(f_out
, "\n");
222 if (protocol_version
< 23) {
223 if (protocol_version
== 22 || !am_sender
)
224 io_start_multiplex_in();
230 static char *finish_pre_exec(pid_t pid
, int fd
, char *request
,
231 int argc
, char *argv
[])
236 write_buf(fd
, request
, strlen(request
)+1);
237 for (j
= 0; j
< argc
; j
++)
238 write_buf(fd
, argv
[j
], strlen(argv
[j
])+1);
245 if (wait_process(pid
, &status
, 0) < 0
246 || !WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
248 if (asprintf(&e
, "pre-xfer exec returned failure (%d)\n", status
) < 0)
249 out_of_memory("finish_pre_exec");
255 static int read_arg_from_pipe(int fd
, char *buf
, int limit
)
257 char *bp
= buf
, *eob
= buf
+ limit
- 1;
260 if (read(fd
, bp
, 1) != 1)
272 static int rsync_module(int f_in
, int f_out
, int i
, char *addr
, char *host
)
277 char line
[BIGPATHBUFLEN
];
278 uid_t uid
= (uid_t
)-2; /* canonically "nobody" */
279 gid_t gid
= (gid_t
)-2;
280 char *p
, *err_msg
= NULL
;
281 char *name
= lp_name(i
);
282 int use_chroot
= lp_use_chroot(i
);
284 int ret
, pre_exec_fd
= -1;
285 pid_t pre_exec_pid
= 0;
286 char *request
= NULL
;
288 if (!allow_access(addr
, host
, lp_hosts_allow(i
), lp_hosts_deny(i
))) {
289 rprintf(FLOG
, "rsync denied on module %s from %s (%s)\n",
292 io_printf(f_out
, "@ERROR: Unknown module '%s'\n", name
);
295 "@ERROR: access denied to %s from %s (%s)\n",
301 if (am_daemon
&& am_server
) {
302 rprintf(FLOG
, "rsync allowed access on module %s from %s (%s)\n",
306 if (!claim_connection(lp_lock_file(i
), lp_max_connections(i
))) {
308 rsyserr(FLOG
, errno
, "failed to open lock file %s",
310 io_printf(f_out
, "@ERROR: failed to open lock file\n");
312 rprintf(FLOG
, "max connections (%d) reached\n",
313 lp_max_connections(i
));
314 io_printf(f_out
, "@ERROR: max connections (%d) reached -- try again later\n",
315 lp_max_connections(i
));
320 auth_user
= auth_server(f_in
, f_out
, i
, host
, addr
, "@RSYNCD: AUTHREQD ");
323 io_printf(f_out
, "@ERROR: auth failed on module %s\n", name
);
332 if (lp_transfer_logging(i
)) {
333 if (log_format_has(lp_log_format(i
), 'i'))
334 daemon_log_format_has_i
= 1;
335 if (daemon_log_format_has_i
336 || log_format_has(lp_log_format(i
), 'o'))
337 daemon_log_format_has_o_or_i
= 1;
340 am_root
= (MY_UID() == 0);
344 if (!name_to_uid(p
, &uid
)) {
345 if (!isdigit(*(unsigned char *)p
)) {
346 rprintf(FLOG
, "Invalid uid %s\n", p
);
347 io_printf(f_out
, "@ERROR: invalid uid %s\n", p
);
354 if (!name_to_gid(p
, &gid
)) {
355 if (!isdigit(*(unsigned char *)p
)) {
356 rprintf(FLOG
, "Invalid gid %s\n", p
);
357 io_printf(f_out
, "@ERROR: invalid gid %s\n", p
);
364 /* TODO: If we're not root, but the configuration requests
365 * that we change to some uid other than the current one, then
368 /* TODO: Perhaps take a list of gids, and make them into the
369 * supplementary groups. */
371 if (use_chroot
|| (module_dirlen
= strlen(lp_path(i
))) == 1) {
373 set_filter_dir("/", 1);
375 set_filter_dir(lp_path(i
), module_dirlen
);
378 parse_rule(&server_filter_list
, p
, MATCHFLG_WORD_SPLIT
,
381 p
= lp_include_from(i
);
382 parse_filter_file(&server_filter_list
, p
, MATCHFLG_INCLUDE
,
383 XFLG_ABS_IF_SLASH
| XFLG_OLD_PREFIXES
| XFLG_FATAL_ERRORS
);
386 parse_rule(&server_filter_list
, p
,
387 MATCHFLG_INCLUDE
| MATCHFLG_WORD_SPLIT
,
388 XFLG_ABS_IF_SLASH
| XFLG_OLD_PREFIXES
);
390 p
= lp_exclude_from(i
);
391 parse_filter_file(&server_filter_list
, p
, 0,
392 XFLG_ABS_IF_SLASH
| XFLG_OLD_PREFIXES
| XFLG_FATAL_ERRORS
);
395 parse_rule(&server_filter_list
, p
, MATCHFLG_WORD_SPLIT
,
396 XFLG_ABS_IF_SLASH
| XFLG_OLD_PREFIXES
);
401 if (*lp_prexfer_exec(i
) || *lp_postxfer_exec(i
)) {
402 char *modname
, *modpath
, *hostaddr
, *hostname
, *username
;
404 if (asprintf(&modname
, "RSYNC_MODULE_NAME=%s", name
) < 0
405 || asprintf(&modpath
, "RSYNC_MODULE_PATH=%s", lp_path(i
)) < 0
406 || asprintf(&hostaddr
, "RSYNC_HOST_ADDR=%s", addr
) < 0
407 || asprintf(&hostname
, "RSYNC_HOST_NAME=%s", host
) < 0
408 || asprintf(&username
, "RSYNC_USER_NAME=%s", auth_user
) < 0)
409 out_of_memory("rsync_module");
416 /* For post-xfer exec, fork a new process to run the rsync
417 * daemon while this process waits for the exit status and
418 * runs the indicated command at that point. */
419 if (*lp_postxfer_exec(i
)) {
422 rsyserr(FLOG
, errno
, "fork failed");
423 io_printf(f_out
, "@ERROR: fork failed\n");
428 if (wait_process(pid
, &status
, 0) < 0)
430 if (asprintf(&ret1
, "RSYNC_RAW_STATUS=%d", status
) > 0)
432 if (WIFEXITED(status
))
433 status
= WEXITSTATUS(status
);
436 if (asprintf(&ret2
, "RSYNC_EXIT_STATUS=%d", status
) > 0)
438 system(lp_postxfer_exec(i
));
442 /* For pre-xfer exec, fork a child process to run the indicated
443 * command, though it first waits for the parent process to
444 * send us the user's request via a pipe. */
445 if (*lp_prexfer_exec(i
)) {
447 if (pipe(fds
) < 0 || (pre_exec_pid
= fork()) < 0) {
448 rsyserr(FLOG
, errno
, "pre-xfer exec preparation failed");
449 io_printf(f_out
, "@ERROR: pre-xfer exec preparation failed\n");
452 if (pre_exec_pid
== 0) {
453 char buf
[BIGPATHBUFLEN
];
456 set_blocking(fds
[0]);
457 len
= read_arg_from_pipe(fds
[0], buf
, BIGPATHBUFLEN
);
460 if (asprintf(&p
, "RSYNC_REQUEST=%s", buf
) < 0)
461 out_of_memory("rsync_module");
464 len
= read_arg_from_pipe(fds
[0], buf
,
471 if (asprintf(&p
, "RSYNC_ARG%d=%s", j
, buf
) < 0)
472 out_of_memory("rsync_module");
477 close(STDOUT_FILENO
);
478 status
= system(lp_prexfer_exec(i
));
479 if (!WIFEXITED(status
))
481 _exit(WEXITSTATUS(status
));
484 set_blocking(fds
[1]);
485 pre_exec_fd
= fds
[1];
493 * XXX: The 'use chroot' flag is a fairly reliable
494 * source of confusion, because it fails under two
495 * important circumstances: running as non-root,
496 * running on Win32 (or possibly others). On the
497 * other hand, if you are running as root, then it
498 * might be better to always use chroot.
500 * So, perhaps if we can't chroot we should just issue
501 * a warning, unless a "require chroot" flag is set,
502 * in which case we fail.
504 if (chroot(lp_path(i
))) {
505 rsyserr(FLOG
, errno
, "chroot %s failed",
507 io_printf(f_out
, "@ERROR: chroot failed\n");
511 if (!push_dir("/")) {
512 rsyserr(FLOG
, errno
, "chdir %s failed\n",
514 io_printf(f_out
, "@ERROR: chdir failed\n");
519 if (!push_dir(lp_path(i
))) {
520 rsyserr(FLOG
, errno
, "chdir %s failed\n",
522 io_printf(f_out
, "@ERROR: chdir failed\n");
529 /* XXXX: You could argue that if the daemon is started
530 * by a non-root user and they explicitly specify a
531 * gid, then we should try to change to that gid --
532 * this could be possible if it's already in their
533 * supplementary groups. */
535 /* TODO: Perhaps we need to document that if rsyncd is
536 * started by somebody other than root it will inherit
537 * all their supplementary groups. */
540 rsyserr(FLOG
, errno
, "setgid %d failed", (int)gid
);
541 io_printf(f_out
, "@ERROR: setgid failed\n");
544 #ifdef HAVE_SETGROUPS
545 /* Get rid of any supplementary groups this process
546 * might have inheristed. */
547 if (setgroups(1, &gid
)) {
548 rsyserr(FLOG
, errno
, "setgroups failed");
549 io_printf(f_out
, "@ERROR: setgroups failed\n");
555 rsyserr(FLOG
, errno
, "setuid %d failed", (int)uid
);
556 io_printf(f_out
, "@ERROR: setuid failed\n");
560 am_root
= (MY_UID() == 0);
563 if (lp_temp_dir(i
) && *lp_temp_dir(i
)) {
564 tmpdir
= lp_temp_dir(i
);
565 if (strlen(tmpdir
) >= MAXPATHLEN
- 10) {
567 "the 'temp dir' value for %s is WAY too long -- ignoring.\n",
573 io_printf(f_out
, "@RSYNCD: OK\n");
576 if (!(argv
= new_array(char *, maxargs
)))
577 out_of_memory("rsync_module");
578 argv
[argc
++] = "rsyncd";
581 if (!read_line(f_in
, line
, sizeof line
- 1))
589 if (argc
== maxargs
) {
591 if (!(argv
= realloc_array(argv
, char *, maxargs
)))
592 out_of_memory("rsync_module");
594 if (!(argv
[argc
] = strdup(p
)))
595 out_of_memory("rsync_module");
597 switch (start_glob
) {
600 if (strcmp(line
, ".") == 0)
605 err_msg
= finish_pre_exec(pre_exec_pid
,
615 glob_expand(name
, &argv
, &argc
, &maxargs
);
621 err_msg
= finish_pre_exec(pre_exec_pid
, pre_exec_fd
, request
,
625 verbose
= 0; /* future verbosity is controlled by client options */
626 ret
= parse_arguments(&argc
, (const char ***) &argv
, 0);
627 quiet
= 0; /* Don't let someone try to be tricky. */
629 if (filesfrom_fd
== 0)
634 rprintf(FLOG
, "rsync %s %s from %s@%s (%s)\n",
635 am_sender
? "on" : "to",
636 request
, auth_user
, host
, addr
);
638 rprintf(FLOG
, "rsync %s %s from %s (%s)\n",
639 am_sender
? "on" : "to",
640 request
, host
, addr
);
646 /* don't allow the logs to be flooded too fast */
647 if (verbose
> lp_max_verbosity(i
))
648 verbose
= lp_max_verbosity(i
);
651 if (protocol_version
< 23
652 && (protocol_version
== 22 || am_sender
))
653 io_start_multiplex_out();
654 else if (!ret
|| err_msg
) {
655 /* We have to get I/O multiplexing started so that we can
656 * get the error back to the client. This means getting
657 * the protocol setup finished first in later versions. */
658 setup_protocol(f_out
, f_in
);
660 /* Since we failed in our option parsing, we may not
661 * have finished parsing that the client sent us a
662 * --files-from option, so look for it manually.
663 * Without this, the socket would be in the wrong
664 * state for the upcoming error message. */
667 for (i
= 0; i
< argc
; i
++) {
668 if (strncmp(argv
[i
], "--files-from", 12) == 0) {
675 write_byte(f_out
, 0);
677 io_start_multiplex_out();
680 if (!ret
|| err_msg
) {
682 rprintf(FERROR
, err_msg
);
686 exit_cleanup(RERR_UNSUPPORTED
);
689 if (lp_timeout(i
) && lp_timeout(i
) > io_timeout
)
690 set_io_timeout(lp_timeout(i
));
692 /* If we have some incoming/outgoing chmod changes, append them to
693 * any user-specified changes (making our changes have priority).
694 * We also get a pointer to just our changes so that a receiver
695 * process can use them separately if --perms wasn't specified. */
697 p
= lp_outgoing_chmod(i
);
699 p
= lp_incoming_chmod(i
);
700 if (*p
&& !(daemon_chmod_modes
= parse_chmod(p
, &chmod_modes
))) {
701 rprintf(FLOG
, "Invalid \"%sing chmod\" directive: %s\n",
702 am_sender
? "outgo" : "incom", p
);
705 start_server(f_in
, f_out
, argc
, argv
);
710 /* send a list of available modules to the client. Don't list those
711 with "list = False". */
712 static void send_listing(int fd
)
714 int n
= lp_numservices();
717 for (i
= 0; i
< n
; i
++) {
719 io_printf(fd
, "%-15s\t%s\n", lp_name(i
), lp_comment(i
));
722 if (protocol_version
>= 25)
723 io_printf(fd
,"@RSYNCD: EXIT\n");
726 /* this is called when a connection is established to a client
727 and we want to start talking. The setup of the system is done from
729 int start_daemon(int f_in
, int f_out
)
733 char *addr
= client_addr(f_in
);
734 char *host
= client_name(f_in
);
737 io_set_sock_fds(f_in
, f_out
);
740 rprintf(FLOG
, "connect from %s (%s)\n", host
, addr
);
742 if (!lp_load(config_file
, 0))
743 exit_cleanup(RERR_SYNTAX
);
745 if (!log_initialised
)
749 set_socket_options(f_in
, "SO_KEEPALIVE");
751 set_socket_options(f_in
, sockopts
);
753 set_socket_options(f_in
, lp_socket_options());
754 set_nonblocking(f_in
);
757 io_printf(f_out
, "@RSYNCD: %d\n", protocol_version
);
759 motd
= lp_motd_file();
761 FILE *f
= fopen(motd
,"r");
762 while (f
&& !feof(f
)) {
763 int len
= fread(line
, 1, sizeof line
- 1, f
);
766 io_printf(f_out
, "%s", line
);
771 io_printf(f_out
, "\n");
774 if (!read_line(f_in
, line
, sizeof line
- 1))
777 if (sscanf(line
,"@RSYNCD: %d", &remote_protocol
) != 1) {
778 io_printf(f_out
, "@ERROR: protocol startup error\n");
781 if (protocol_version
> remote_protocol
)
782 protocol_version
= remote_protocol
;
785 if (!read_line(f_in
, line
, sizeof line
- 1))
788 if (!*line
|| strcmp(line
, "#list") == 0) {
789 rprintf(FLOG
, "module-list request from %s (%s)\n",
796 /* it's some sort of command that I don't understand */
797 io_printf(f_out
, "@ERROR: Unknown command '%s'\n", line
);
801 if ((i
= lp_number(line
)) < 0) {
802 rprintf(FLOG
, "unknown module '%s' tried from %s (%s)\n",
804 io_printf(f_out
, "@ERROR: Unknown module '%s'\n", line
);
808 #ifdef HAVE_SIGACTION
809 sigact
.sa_flags
= SA_NOCLDSTOP
;
811 SIGACTION(SIGCHLD
, remember_children
);
813 return rsync_module(f_in
, f_out
, i
, addr
, host
);
816 int daemon_main(void)
820 if (is_a_socket(STDIN_FILENO
)) {
823 /* we are running via inetd - close off stdout and
824 * stderr so that library functions (and getopt) don't
825 * try to use them. Redirect them to /dev/null */
826 for (i
= 1; i
< 3; i
++) {
828 open("/dev/null", O_RDWR
);
831 return start_daemon(STDIN_FILENO
, STDIN_FILENO
);
837 if (!lp_load(config_file
, 1))
838 exit_cleanup(RERR_SYNTAX
);
840 if (rsync_port
== 0 && (rsync_port
= lp_rsync_port()) == 0)
841 rsync_port
= RSYNC_PORT
;
842 if (bind_address
== NULL
&& *lp_bind_address())
843 bind_address
= lp_bind_address();
847 rprintf(FLOG
, "rsyncd version %s starting, listening on port %d\n",
848 RSYNC_VERSION
, rsync_port
);
849 /* TODO: If listening on a particular address, then show that
850 * address too. In fact, why not just do inet_ntop on the
851 * local address??? */
853 if (((pid_file
= lp_pid_file()) != NULL
) && (*pid_file
!= '\0')) {
856 pid_t pid
= getpid();
857 cleanup_set_pid(pid
);
858 if ((fd
= do_open(lp_pid_file(), O_WRONLY
|O_CREAT
|O_TRUNC
,
859 0666 & ~orig_umask
)) == -1) {
861 rsyserr(FLOG
, errno
, "failed to create pid file %s",
863 exit_cleanup(RERR_FILEIO
);
865 snprintf(pidbuf
, sizeof pidbuf
, "%ld\n", (long)pid
);
866 write(fd
, pidbuf
, strlen(pidbuf
));
870 start_accept_loop(rsync_port
, start_daemon
);