Fixed the use of --protect-args (-s) with a daemon.
[rsync.git] / rsync.c
blobc384ed9b8a09f99258c1a10c9ba407b10b6ca7f3
1 /*
2 * Routines common to more than one of the rsync processes.
4 * Copyright (C) 1996 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2003-2008 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.
22 #include "rsync.h"
23 #include "ifuncs.h"
24 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
25 #include <libcharset.h>
26 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
27 #include <langinfo.h>
28 #endif
30 extern int verbose;
31 extern int dry_run;
32 extern int preserve_acls;
33 extern int preserve_xattrs;
34 extern int preserve_perms;
35 extern int preserve_executability;
36 extern int preserve_times;
37 extern int am_root;
38 extern int am_server;
39 extern int am_sender;
40 extern int am_generator;
41 extern int am_starting_up;
42 extern int allow_8bit_chars;
43 extern int protocol_version;
44 extern int uid_ndx;
45 extern int gid_ndx;
46 extern int inc_recurse;
47 extern int inplace;
48 extern int flist_eof;
49 extern int keep_dirlinks;
50 extern int make_backups;
51 extern struct file_list *cur_flist, *first_flist, *dir_flist;
52 extern struct chmod_mode_struct *daemon_chmod_modes;
53 #ifdef ICONV_OPTION
54 extern char *iconv_opt;
55 #endif
57 #ifdef ICONV_CONST
58 iconv_t ic_chck = (iconv_t)-1;
59 # ifdef ICONV_OPTION
60 iconv_t ic_send = (iconv_t)-1, ic_recv = (iconv_t)-1;
61 # endif
63 static const char *default_charset(void)
65 # if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
66 return locale_charset();
67 # elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
68 return nl_langinfo(CODESET);
69 # else
70 return ""; /* Works with (at the very least) gnu iconv... */
71 # endif
74 void setup_iconv(void)
76 const char *defset = default_charset();
77 # ifdef ICONV_OPTION
78 const char *charset;
79 char *cp;
80 # endif
82 if (!am_server && !allow_8bit_chars) {
84 /* It's OK if this fails... */
85 ic_chck = iconv_open(defset, defset);
87 if (verbose > 3) {
88 if (ic_chck == (iconv_t)-1) {
89 rprintf(FINFO,
90 "note: iconv_open(\"%s\", \"%s\") failed (%d)"
91 " -- using isprint() instead of iconv().\n",
92 defset, defset, errno);
93 } else {
94 rprintf(FINFO,
95 "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
96 defset, defset);
101 # ifdef ICONV_OPTION
102 if (!iconv_opt)
103 return;
105 if ((cp = strchr(iconv_opt, ',')) != NULL) {
106 if (am_server) /* A local transfer needs this. */
107 iconv_opt = cp + 1;
108 else
109 *cp = '\0';
112 if (!*iconv_opt || (*iconv_opt == '.' && iconv_opt[1] == '\0'))
113 charset = defset;
114 else
115 charset = iconv_opt;
117 if ((ic_send = iconv_open(UTF8_CHARSET, charset)) == (iconv_t)-1) {
118 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
119 UTF8_CHARSET, charset);
120 exit_cleanup(RERR_UNSUPPORTED);
123 if ((ic_recv = iconv_open(charset, UTF8_CHARSET)) == (iconv_t)-1) {
124 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
125 charset, UTF8_CHARSET);
126 exit_cleanup(RERR_UNSUPPORTED);
129 if (verbose > 1) {
130 rprintf(FINFO, "%s charset: %s\n",
131 am_server ? "server" : "client",
132 *charset ? charset : "[LOCALE]");
134 # endif
137 /* This function converts the characters in the "in" xbuf into characters
138 * in the "out" xbuf. The "len" of the "in" xbuf is used starting from its
139 * "pos". The "size" of the "out" xbuf restricts how many characters can be
140 * stored, starting at its "pos+len" position. Note that the last byte of
141 * the buffer is never used, which reserves space for a terminating '\0'.
142 * We return a 0 on success or a -1 on error. An error also sets errno to
143 * E2BIG, EILSEQ, or EINVAL (see below); otherwise errno will be set to 0.
144 * The "in" xbuf is altered to update "pos" and "len". The "out" xbuf has
145 * data appended, and its "len" incremented. If ICB_EXPAND_OUT is set in
146 * "flags", the "out" xbuf will also be allocated if empty, and expanded if
147 * too small (so E2BIG will not be returned). If ICB_INCLUDE_BAD is set in
148 * "flags", any badly-encoded chars are included verbatim in the "out" xbuf,
149 * so EILSEQ will not be returned. Likewise for ICB_INCLUDE_INCOMPLETE with
150 * respect to an incomplete multi-byte char at the end, which ensures that
151 * EINVAL is not returned. Anytime "in.pos" is 0 we will reset the iconv()
152 * state prior to processing the characters. */
153 int iconvbufs(iconv_t ic, xbuf *in, xbuf *out, int flags)
155 ICONV_CONST char *ibuf;
156 size_t icnt, ocnt;
157 char *obuf;
159 if (!out->size && flags & ICB_EXPAND_OUT)
160 alloc_xbuf(out, 1024);
162 if (!in->pos)
163 iconv(ic, NULL, 0, NULL, 0);
165 ibuf = in->buf + in->pos;
166 icnt = in->len;
168 obuf = out->buf + (out->pos + out->len);
169 ocnt = out->size - (out->pos + out->len) - 1;
171 while (icnt) {
172 while (iconv(ic, &ibuf, &icnt, &obuf, &ocnt) == (size_t)-1) {
173 if (errno == EINTR)
174 continue;
175 if (errno == EINVAL) {
176 if (!(flags & ICB_INCLUDE_INCOMPLETE))
177 goto finish;
178 } else if (errno == EILSEQ) {
179 if (!(flags & ICB_INCLUDE_BAD))
180 goto finish;
181 } else {
182 size_t opos = obuf - out->buf;
183 if (!(flags & ICB_EXPAND_OUT)) {
184 errno = E2BIG;
185 goto finish;
187 realloc_xbuf(out, out->size + 1024);
188 obuf = out->buf + opos;
189 ocnt += 1024;
190 continue;
192 *obuf++ = *ibuf++;
193 ocnt--, icnt--;
197 errno = 0;
199 finish:
200 in->len = icnt;
201 in->pos = ibuf - in->buf;
202 out->len = obuf - out->buf - out->pos;
204 return errno ? -1 : 0;
206 #endif
208 void send_protected_args(int fd, char *args[])
210 #ifdef ICONV_OPTION
211 int i, convert = ic_send != (iconv_t)-1;
212 xbuf outbuf, inbuf;
214 if (convert)
215 alloc_xbuf(&outbuf, 1024);
216 #endif
218 for (i = 0; args[i]; i++) {} /* find first NULL */
219 args[i] = "rsync"; /* set a new arg0 */
220 if (verbose > 1)
221 print_child_argv("protected args:", args + i + 1);
222 do {
223 #ifdef ICONV_OPTION
224 if (convert) {
225 INIT_XBUF_STRLEN(inbuf, args[i]);
226 iconvbufs(ic_send, &inbuf, &outbuf,
227 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
228 outbuf.buf[outbuf.len] = '\0';
229 write_buf(fd, outbuf.buf, outbuf.len + 1);
230 outbuf.len = 0;
231 } else
232 #endif
233 write_buf(fd, args[i], strlen(args[i]) + 1);
234 } while (args[++i]);
235 write_byte(fd, 0);
237 #ifdef ICONV_OPTION
238 if (convert)
239 free(outbuf.buf);
240 #endif
243 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
244 char *buf, int *len_ptr)
246 int len, iflags = 0;
247 struct file_list *flist;
248 uchar fnamecmp_type = FNAMECMP_FNAME;
249 int ndx, save_verbose = verbose;
251 read_loop:
252 while (1) {
253 ndx = read_ndx(f_in);
255 if (ndx >= 0)
256 break;
257 if (ndx == NDX_DONE)
258 return ndx;
259 if (!inc_recurse || am_sender)
260 goto invalid_ndx;
261 if (ndx == NDX_FLIST_EOF) {
262 flist_eof = 1;
263 send_msg(MSG_FLIST_EOF, "", 0, 0);
264 continue;
266 ndx = NDX_FLIST_OFFSET - ndx;
267 if (ndx < 0 || ndx >= dir_flist->used) {
268 ndx = NDX_FLIST_OFFSET - ndx;
269 rprintf(FERROR,
270 "[%s] Invalid dir index: %d (%d - %d)\n",
271 who_am_i(), ndx, NDX_FLIST_OFFSET,
272 NDX_FLIST_OFFSET - dir_flist->used + 1);
273 exit_cleanup(RERR_PROTOCOL);
276 /* Send everything read from f_in to msg_fd_out. */
277 if (verbose > 3) {
278 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
279 who_am_i(), ndx);
281 verbose = 0;
282 send_msg_int(MSG_FLIST, ndx);
283 start_flist_forward(f_in);
284 flist = recv_file_list(f_in);
285 flist->parent_ndx = ndx;
286 stop_flist_forward();
287 verbose = save_verbose;
290 iflags = protocol_version >= 29 ? read_shortint(f_in)
291 : ITEM_TRANSFER | ITEM_MISSING_DATA;
293 /* Honor the old-style keep-alive indicator. */
294 if (protocol_version < 30
295 && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
296 if (am_sender)
297 maybe_send_keepalive();
298 goto read_loop;
301 if (!(flist = flist_for_ndx(ndx))) {
302 int start, used;
303 invalid_ndx:
304 start = first_flist ? first_flist->ndx_start : 0;
305 used = first_flist ? first_flist->used : 0;
306 rprintf(FERROR,
307 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
308 ndx, start - 1, start + used -1, iflags, who_am_i());
309 exit_cleanup(RERR_PROTOCOL);
311 cur_flist = flist;
313 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
314 fnamecmp_type = read_byte(f_in);
315 *type_ptr = fnamecmp_type;
317 if (iflags & ITEM_XNAME_FOLLOWS) {
318 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
319 exit_cleanup(RERR_PROTOCOL);
320 } else {
321 *buf = '\0';
322 len = -1;
324 *len_ptr = len;
326 if (iflags & ITEM_TRANSFER) {
327 int i = ndx - cur_flist->ndx_start;
328 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
329 rprintf(FERROR,
330 "received request to transfer non-regular file: %d [%s]\n",
331 ndx, who_am_i());
332 exit_cleanup(RERR_PROTOCOL);
336 *iflag_ptr = iflags;
337 return ndx;
341 free a sums struct
343 void free_sums(struct sum_struct *s)
345 if (s->sums) free(s->sums);
346 free(s);
349 /* This is only called when we aren't preserving permissions. Figure out what
350 * the permissions should be and return them merged back into the mode. */
351 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
352 int exists)
354 int new_mode;
355 /* If the file already exists, we'll return the local permissions,
356 * possibly tweaked by the --executability option. */
357 if (exists) {
358 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
359 if (preserve_executability && S_ISREG(flist_mode)) {
360 /* If the source file is executable, grant execute
361 * rights to everyone who can read, but ONLY if the
362 * file isn't already executable. */
363 if (!(flist_mode & 0111))
364 new_mode &= ~0111;
365 else if (!(stat_mode & 0111))
366 new_mode |= (new_mode & 0444) >> 2;
368 } else {
369 /* Apply destination default permissions and turn
370 * off special permissions. */
371 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
373 return new_mode;
376 int set_file_attrs(const char *fname, struct file_struct *file, stat_x *sxp,
377 const char *fnamecmp, int flags)
379 int updated = 0;
380 stat_x sx2;
381 int change_uid, change_gid;
382 mode_t new_mode = file->mode;
383 int inherit;
385 if (!sxp) {
386 if (dry_run)
387 return 1;
388 if (link_stat(fname, &sx2.st, 0) < 0) {
389 rsyserr(FERROR_XFER, errno, "stat %s failed",
390 full_fname(fname));
391 return 0;
393 #ifdef SUPPORT_ACLS
394 sx2.acc_acl = sx2.def_acl = NULL;
395 #endif
396 #ifdef SUPPORT_XATTRS
397 sx2.xattr = NULL;
398 #endif
399 sxp = &sx2;
400 inherit = !preserve_perms;
401 } else
402 inherit = !preserve_perms && file->flags & FLAG_DIR_CREATED;
404 if (inherit && S_ISDIR(new_mode) && sxp->st.st_mode & S_ISGID) {
405 /* We just created this directory and its setgid
406 * bit is on, so make sure it stays on. */
407 new_mode |= S_ISGID;
410 if (daemon_chmod_modes && !S_ISLNK(new_mode))
411 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
413 #ifdef SUPPORT_ACLS
414 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
415 get_acl(fname, sxp);
416 #endif
418 #ifdef SUPPORT_XATTRS
419 if (am_root < 0)
420 set_stat_xattr(fname, file, new_mode);
421 if (preserve_xattrs && fnamecmp)
422 set_xattr(fname, file, fnamecmp, sxp);
423 #endif
425 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && preserve_times == 1))
426 flags |= ATTRS_SKIP_MTIME;
427 if (!(flags & ATTRS_SKIP_MTIME)
428 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
429 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
430 if (ret < 0) {
431 rsyserr(FERROR_XFER, errno, "failed to set times on %s",
432 full_fname(fname));
433 goto cleanup;
435 if (ret == 0) /* ret == 1 if symlink could not be set */
436 updated = 1;
437 else
438 file->flags |= FLAG_TIME_FAILED;
441 change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
442 change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
443 && sxp->st.st_gid != (gid_t)F_GROUP(file);
444 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
445 if (S_ISLNK(sxp->st.st_mode)) {
447 } else
448 #endif
449 if (change_uid || change_gid) {
450 if (verbose > 2) {
451 if (change_uid) {
452 rprintf(FINFO,
453 "set uid of %s from %u to %u\n",
454 fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
456 if (change_gid) {
457 rprintf(FINFO,
458 "set gid of %s from %u to %u\n",
459 fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
462 if (am_root >= 0) {
463 if (do_lchown(fname,
464 change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
465 change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid) != 0) {
466 /* We shouldn't have attempted to change uid
467 * or gid unless have the privilege. */
468 rsyserr(FERROR_XFER, errno, "%s %s failed",
469 change_uid ? "chown" : "chgrp",
470 full_fname(fname));
471 goto cleanup;
473 /* A lchown had been done, so we need to re-stat if
474 * the destination had the setuid or setgid bits set
475 * (due to the side effect of the chown call). */
476 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
477 link_stat(fname, &sxp->st,
478 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
481 updated = 1;
484 #ifdef SUPPORT_ACLS
485 /* It's OK to call set_acl() now, even for a dir, as the generator
486 * will enable owner-writability using chmod, if necessary.
488 * If set_acl() changes permission bits in the process of setting
489 * an access ACL, it changes sxp->st.st_mode so we know whether we
490 * need to chmod(). */
491 if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
492 updated = 1;
493 #endif
495 #ifdef HAVE_CHMOD
496 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
497 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
498 if (ret < 0) {
499 rsyserr(FERROR_XFER, errno,
500 "failed to set permissions on %s",
501 full_fname(fname));
502 goto cleanup;
504 if (ret == 0) /* ret == 1 if symlink could not be set */
505 updated = 1;
507 #endif
509 if (verbose > 1 && flags & ATTRS_REPORT) {
510 if (updated)
511 rprintf(FCLIENT, "%s\n", fname);
512 else
513 rprintf(FCLIENT, "%s is uptodate\n", fname);
515 cleanup:
516 if (sxp == &sx2) {
517 #ifdef SUPPORT_ACLS
518 if (preserve_acls)
519 free_acl(&sx2);
520 #endif
521 #ifdef SUPPORT_XATTRS
522 if (preserve_xattrs)
523 free_xattr(&sx2);
524 #endif
526 return updated;
529 RETSIGTYPE sig_int(UNUSED(int val))
531 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
532 * for a password, then our cleanup's sending of a SIGUSR1
533 * signal to all our children may kill ssh before it has a
534 * chance to restore the tty settings (i.e. turn echo back
535 * on). By sleeping for a short time, ssh gets a bigger
536 * chance to do the right thing. If child processes are
537 * not ssh waiting for a password, then this tiny delay
538 * shouldn't hurt anything. */
539 msleep(400);
540 exit_cleanup(RERR_SIGNAL);
543 /* Finish off a file transfer: renaming the file and setting the file's
544 * attributes (e.g. permissions, ownership, etc.). If the robust_rename()
545 * call is forced to copy the temp file and partialptr is both non-NULL and
546 * not an absolute path, we stage the file into the partial-dir and then
547 * rename it into place. This returns 1 on succcess or 0 on failure. */
548 int finish_transfer(const char *fname, const char *fnametmp,
549 const char *fnamecmp, const char *partialptr,
550 struct file_struct *file, int ok_to_set_time,
551 int overwriting_basis)
553 int ret;
554 const char *temp_copy_name = partialptr && *partialptr != '/' ? partialptr : NULL;
556 if (inplace) {
557 if (verbose > 2)
558 rprintf(FINFO, "finishing %s\n", fname);
559 fnametmp = fname;
560 goto do_set_file_attrs;
563 if (make_backups > 0 && overwriting_basis && !make_backup(fname))
564 return 1;
566 /* Change permissions before putting the file into place. */
567 set_file_attrs(fnametmp, file, NULL, fnamecmp,
568 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
570 /* move tmp file over real file */
571 if (verbose > 2)
572 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
573 ret = robust_rename(fnametmp, fname, temp_copy_name,
574 file->mode & INITACCESSPERMS);
575 if (ret < 0) {
576 rsyserr(FERROR_XFER, errno, "%s %s -> \"%s\"",
577 ret == -2 ? "copy" : "rename",
578 full_fname(fnametmp), fname);
579 if (!partialptr || (ret == -2 && temp_copy_name)
580 || robust_rename(fnametmp, partialptr, NULL,
581 file->mode & INITACCESSPERMS) < 0)
582 do_unlink(fnametmp);
583 return 0;
585 if (ret == 0) {
586 /* The file was moved into place (not copied), so it's done. */
587 return 1;
589 /* The file was copied, so tweak the perms of the copied file. If it
590 * was copied to partialptr, move it into its final destination. */
591 fnametmp = temp_copy_name ? temp_copy_name : fname;
593 do_set_file_attrs:
594 set_file_attrs(fnametmp, file, NULL, fnamecmp,
595 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
597 if (temp_copy_name) {
598 if (do_rename(fnametmp, fname) < 0) {
599 rsyserr(FERROR_XFER, errno, "rename %s -> \"%s\"",
600 full_fname(fnametmp), fname);
601 return 0;
603 handle_partial_dir(temp_copy_name, PDIR_DELETE);
605 return 1;
608 struct file_list *flist_for_ndx(int ndx)
610 struct file_list *flist = cur_flist;
612 if (!flist && !(flist = first_flist))
613 return NULL;
615 while (ndx < flist->ndx_start-1) {
616 if (flist == first_flist)
617 return NULL;
618 flist = flist->prev;
620 while (ndx >= flist->ndx_start + flist->used) {
621 if (!(flist = flist->next))
622 return NULL;
624 return flist;
627 const char *who_am_i(void)
629 if (am_starting_up)
630 return am_server ? "server" : "client";
631 return am_sender ? "sender" : am_generator ? "generator" : "receiver";