2 * Extended Attribute support for rsync.
3 * Written by Jay Fenlason, vaguely based on the ACLs patch.
5 * Copyright (C) 2004 Red Hat, Inc.
6 * Copyright (C) 2006-2022 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.
25 #include "lib/sysxattrs.h"
32 extern int am_generator;
35 extern int preserve_xattrs;
36 extern int preserve_links;
37 extern int preserve_devices;
38 extern int preserve_specials;
39 extern int checksum_seed;
40 extern int saw_xattr_filter;
42 #define RSYNC_XAL_INITIAL 5
43 #define RSYNC_XAL_LIST_INITIAL 100
45 #define MAX_FULL_DATUM 32
47 #define HAS_PREFIX(str, prfx) (*(str) == *(prfx) && strncmp(str, prfx, sizeof (prfx) - 1) == 0)
49 #define XATTR_ABBREV(x) ((size_t)((x).name - (x).datum) < (x).datum_len)
51 #define XSTATE_ABBREV 1
55 #define USER_PREFIX "user."
56 #define UPRE_LEN ((int)sizeof USER_PREFIX - 1)
57 #define SYSTEM_PREFIX "system."
58 #define SPRE_LEN ((int)sizeof SYSTEM_PREFIX - 1)
60 #ifdef HAVE_LINUX_XATTRS
61 #define MIGHT_NEED_RPRE (am_root <= 0)
62 #define RSYNC_PREFIX USER_PREFIX "rsync."
64 #define MIGHT_NEED_RPRE am_root
65 #define RSYNC_PREFIX "rsync."
67 #define RPRE_LEN ((int)sizeof RSYNC_PREFIX - 1)
69 #define XSTAT_SUFFIX "stat"
70 #define XSTAT_ATTR RSYNC_PREFIX "%" XSTAT_SUFFIX
71 #define XACC_ACL_SUFFIX "aacl"
72 #define XACC_ACL_ATTR RSYNC_PREFIX "%" XACC_ACL_SUFFIX
73 #define XDEF_ACL_SUFFIX "dacl"
74 #define XDEF_ACL_ATTR RSYNC_PREFIX "%" XDEF_ACL_SUFFIX
78 size_t datum_len, name_len;
82 struct _rsync_xa_list;
84 typedef struct _rsync_xa_list_ref {
85 struct _rsync_xa_list_ref *next;
89 typedef struct _rsync_xa_list {
95 static size_t namebuf_len = 0;
96 static char *namebuf = NULL;
98 static const rsync_xa_list empty_xa_list = {
99 .xa_items = EMPTY_ITEM_LIST,
101 static const item_list empty_xattr = EMPTY_ITEM_LIST;
102 static item_list rsync_xal_l = EMPTY_ITEM_LIST;
103 static struct hashtable *rsync_xal_h = NULL;
105 static size_t prior_xattr_count = (size_t)-1;
107 /* ------------------------------------------------------------------------- */
109 static void rsync_xal_free(item_list *xalp)
112 rsync_xa *rxas = xalp->items;
117 for (i = 0; i < xalp->count; i++) {
119 /*free(rxas[i].name);*/
124 void free_xattr(stat_x *sxp)
128 rsync_xal_free(sxp->xattr);
133 static int rsync_xal_compare_names(const void *x1, const void *x2)
135 const rsync_xa *xa1 = x1;
136 const rsync_xa *xa2 = x2;
137 return strcmp(xa1->name, xa2->name);
140 static ssize_t get_xattr_names(const char *fname)
147 namebuf = new_array(char, namebuf_len);
151 /* The length returned includes all the '\0' terminators. */
152 list_len = sys_llistxattr(fname, namebuf, namebuf_len);
154 if ((size_t)list_len <= namebuf_len)
156 } else if (errno == ENOTSUP)
158 else if (errno != ERANGE) {
161 rsyserr(FERROR_XFER, errno,
162 "get_xattr_names: llistxattr(%s,%s) failed",
163 full_fname(fname), big_num(arg));
166 list_len = sys_llistxattr(fname, NULL, 0);
173 namebuf_len = list_len + 1024;
174 namebuf = new_array(char, namebuf_len);
180 /* On entry, the *len_ptr parameter contains the size of the extra space we
181 * should allocate when we create a buffer for the data. On exit, it contains
182 * the length of the datum. */
183 static char *get_xattr_data(const char *fname, const char *name, size_t *len_ptr, int no_missing_error)
185 size_t datum_len = sys_lgetxattr(fname, name, NULL, 0);
186 size_t extra_len = *len_ptr;
189 *len_ptr = datum_len;
191 if (datum_len == (size_t)-1) {
192 if (errno == ENOTSUP || no_missing_error)
194 rsyserr(FERROR_XFER, errno,
195 "get_xattr_data: lgetxattr(%s,\"%s\",0) failed",
196 full_fname(fname), name);
200 if (!datum_len && !extra_len)
201 extra_len = 1; /* request non-zero amount of memory */
202 if (SIZE_MAX - datum_len < extra_len)
203 overflow_exit("get_xattr_data");
204 ptr = new_array(char, datum_len + extra_len);
207 size_t len = sys_lgetxattr(fname, name, ptr, datum_len);
208 if (len != datum_len) {
209 if (len == (size_t)-1) {
210 rsyserr(FERROR_XFER, errno,
211 "get_xattr_data: lgetxattr(%s,\"%s\",%ld) failed",
212 full_fname(fname), name, (long)datum_len);
215 "get_xattr_data: lgetxattr(%s,\"%s\",%ld) returned %ld\n",
216 full_fname(fname), name,
217 (long)datum_len, (long)len);
227 static int rsync_xal_get(const char *fname, item_list *xalp)
229 ssize_t list_len, name_len;
230 size_t datum_len, name_offset;
232 #ifdef HAVE_LINUX_XATTRS
233 int user_only = am_sender ? 0 : !am_root;
238 /* This puts the name list into the "namebuf" buffer. */
239 if ((list_len = get_xattr_names(fname)) < 0)
242 for (name = namebuf; list_len > 0; name += name_len) {
243 name_len = strlen(name) + 1;
244 list_len -= name_len;
246 if (saw_xattr_filter) {
247 if (name_is_excluded(name, NAME_IS_XATTR, ALL_FILTERS))
250 #ifdef HAVE_LINUX_XATTRS
251 /* Choose between ignoring the system namespace or (non-root) ignoring any non-user namespace. */
252 else if (user_only ? !HAS_PREFIX(name, USER_PREFIX) : HAS_PREFIX(name, SYSTEM_PREFIX))
256 /* No rsync.%FOO attributes are copied w/o 2 -X options. */
257 if (name_len > RPRE_LEN && name[RPRE_LEN] == '%' && HAS_PREFIX(name, RSYNC_PREFIX)) {
258 if ((am_sender && preserve_xattrs < 2)
260 && (strcmp(name+RPRE_LEN+1, XSTAT_SUFFIX) == 0
261 || strcmp(name+RPRE_LEN+1, XACC_ACL_SUFFIX) == 0
262 || strcmp(name+RPRE_LEN+1, XDEF_ACL_SUFFIX) == 0)))
266 datum_len = name_len; /* Pass extra size to get_xattr_data() */
267 if (!(ptr = get_xattr_data(fname, name, &datum_len, 0)))
270 if (datum_len > MAX_FULL_DATUM) {
271 /* For large datums, we store a flag and a checksum. */
272 name_offset = 1 + MAX_DIGEST_LEN;
273 sum_init(-1, checksum_seed);
274 sum_update(ptr, datum_len);
277 ptr = new_array(char, name_offset + name_len);
278 *ptr = XSTATE_ABBREV;
281 name_offset = datum_len;
283 rxa = EXPAND_ITEM_LIST(xalp, rsync_xa, RSYNC_XAL_INITIAL);
284 rxa->name = ptr + name_offset;
285 memcpy(rxa->name, name, name_len);
287 rxa->name_len = name_len;
288 rxa->datum_len = datum_len;
293 qsort(rxa, count, sizeof (rsync_xa), rsync_xal_compare_names);
294 for (rxa += count-1; count; count--, rxa--)
299 /* Read the xattr(s) for this filename. */
300 int get_xattr(const char *fname, stat_x *sxp)
302 sxp->xattr = new(item_list);
303 *sxp->xattr = empty_xattr;
305 if (S_ISREG(sxp->st.st_mode) || S_ISDIR(sxp->st.st_mode)) {
306 /* Everyone supports this. */
307 } else if (S_ISLNK(sxp->st.st_mode)) {
308 #ifndef NO_SYMLINK_XATTRS
312 } else if (IS_SPECIAL(sxp->st.st_mode)) {
313 #ifndef NO_SPECIAL_XATTRS
314 if (!preserve_specials)
317 } else if (IS_DEVICE(sxp->st.st_mode)) {
318 #ifndef NO_DEVICE_XATTRS
319 if (!preserve_devices)
322 } else if (IS_MISSING_FILE(sxp->st))
325 if (rsync_xal_get(fname, sxp->xattr) < 0) {
332 int copy_xattrs(const char *source, const char *dest)
334 ssize_t list_len, name_len;
337 #ifdef HAVE_LINUX_XATTRS
338 int user_only = am_sender ? 0 : am_root <= 0;
341 /* This puts the name list into the "namebuf" buffer. */
342 if ((list_len = get_xattr_names(source)) < 0)
345 for (name = namebuf; list_len > 0; name += name_len) {
346 name_len = strlen(name) + 1;
347 list_len -= name_len;
349 if (saw_xattr_filter) {
350 if (name_is_excluded(name, NAME_IS_XATTR, ALL_FILTERS))
353 #ifdef HAVE_LINUX_XATTRS
354 /* Choose between ignoring the system namespace or (non-root) ignoring any non-user namespace. */
355 else if (user_only ? !HAS_PREFIX(name, USER_PREFIX) : HAS_PREFIX(name, SYSTEM_PREFIX))
360 if (!(ptr = get_xattr_data(source, name, &datum_len, 0)))
362 if (sys_lsetxattr(dest, name, ptr, datum_len) < 0) {
363 int save_errno = errno ? errno : EINVAL;
364 rsyserr(FERROR_XFER, errno,
365 "copy_xattrs: lsetxattr(%s,\"%s\") failed",
366 full_fname(dest), name);
376 static int64 xattr_lookup_hash(const item_list *xalp)
378 const rsync_xa *rxas = xalp->items;
380 int64 key = hashlittle(&xalp->count, sizeof xalp->count);
382 for (i = 0; i < xalp->count; i++) {
383 key += hashlittle(rxas[i].name, rxas[i].name_len);
384 if (rxas[i].datum_len > MAX_FULL_DATUM)
385 key += hashlittle(rxas[i].datum, MAX_DIGEST_LEN);
387 key += hashlittle(rxas[i].datum, rxas[i].datum_len);
391 /* This is very unlikely, but we should never
392 * return 0 as hashtable_find() doesn't like it. */
399 static int find_matching_xattr(const item_list *xalp)
401 const struct ht_int64_node *node;
402 const rsync_xa_list_ref *ref;
405 if (rsync_xal_h == NULL)
408 key = xattr_lookup_hash(xalp);
410 node = hashtable_find(rsync_xal_h, key, NULL);
414 if (node->data == NULL)
417 for (ref = node->data; ref != NULL; ref = ref->next) {
418 const rsync_xa_list *ptr = rsync_xal_l.items;
419 const rsync_xa *rxas1;
420 const rsync_xa *rxas2 = xalp->items;
424 rxas1 = ptr->xa_items.items;
426 /* Wrong number of elements? */
427 if (ptr->xa_items.count != xalp->count)
429 /* any elements different? */
430 for (j = 0; j < xalp->count; j++) {
431 if (rxas1[j].name_len != rxas2[j].name_len
432 || rxas1[j].datum_len != rxas2[j].datum_len
433 || strcmp(rxas1[j].name, rxas2[j].name))
435 if (rxas1[j].datum_len > MAX_FULL_DATUM) {
436 if (memcmp(rxas1[j].datum + 1,
438 MAX_DIGEST_LEN) != 0)
441 if (memcmp(rxas1[j].datum, rxas2[j].datum,
446 /* no differences found. This is The One! */
447 if (j == xalp->count)
454 /* Store *xalp on the end of rsync_xal_l */
455 static int rsync_xal_store(item_list *xalp)
457 struct ht_int64_node *node;
458 int ndx = rsync_xal_l.count; /* pre-incremented count */
459 rsync_xa_list *new_list = EXPAND_ITEM_LIST(&rsync_xal_l, rsync_xa_list, RSYNC_XAL_LIST_INITIAL);
460 rsync_xa_list_ref *new_ref;
461 /* Since the following call starts a new list, we know it will hold the
462 * entire initial-count, not just enough space for one new item. */
463 *new_list = empty_xa_list;
464 (void)EXPAND_ITEM_LIST(&new_list->xa_items, rsync_xa, xalp->count);
465 memcpy(new_list->xa_items.items, xalp->items, xalp->count * sizeof (rsync_xa));
466 new_list->xa_items.count = xalp->count;
470 new_list->key = xattr_lookup_hash(&new_list->xa_items);
472 if (rsync_xal_h == NULL)
473 rsync_xal_h = hashtable_create(512, HT_KEY64);
474 if (rsync_xal_h == NULL)
475 out_of_memory("rsync_xal_h hashtable_create()");
477 new_ref = new0(rsync_xa_list_ref);
480 node = hashtable_find(rsync_xal_h, new_list->key, new_ref);
481 if (node->data != (void*)new_ref) {
482 rsync_xa_list_ref *ref = node->data;
484 while (ref != NULL) {
485 if (ref->next != NULL) {
498 /* Send the make_xattr()-generated xattr list for this flist entry. */
499 int send_xattr(int f, stat_x *sxp)
501 int ndx = find_matching_xattr(sxp->xattr);
503 /* Send 0 (-1 + 1) to indicate that literal xattr data follows. */
504 write_varint(f, ndx + 1);
508 int count = sxp->xattr->count;
509 write_varint(f, count);
510 for (rxa = sxp->xattr->items; count--; rxa++) {
511 size_t name_len = rxa->name_len;
512 const char *name = rxa->name;
513 /* Strip the rsync prefix from disguised namespaces. */
514 if (name_len > RPRE_LEN
515 #ifdef HAVE_LINUX_XATTRS
518 && name[RPRE_LEN] != '%' && HAS_PREFIX(name, RSYNC_PREFIX)) {
520 name_len -= RPRE_LEN;
522 #ifndef HAVE_LINUX_XATTRS
524 /* Put everything else in the user namespace. */
525 name_len += UPRE_LEN;
528 write_varint(f, name_len);
529 write_varint(f, rxa->datum_len);
530 #ifndef HAVE_LINUX_XATTRS
531 if (name_len > rxa->name_len) {
532 write_buf(f, USER_PREFIX, UPRE_LEN);
533 name_len -= UPRE_LEN;
536 write_buf(f, name, name_len);
537 if (rxa->datum_len > MAX_FULL_DATUM)
538 write_buf(f, rxa->datum + 1, MAX_DIGEST_LEN);
540 write_bigbuf(f, rxa->datum, rxa->datum_len);
542 ndx = rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
548 /* Return a flag indicating if we need to change a file's xattrs. If
549 * "find_all" is specified, also mark any abbreviated xattrs that we
550 * need so that send_xattr_request() can tell the sender about them. */
551 int xattr_diff(struct file_struct *file, stat_x *sxp, int find_all)
553 const rsync_xa_list *glst = rsync_xal_l.items;
554 const item_list *lst;
555 rsync_xa *snd_rxa, *rec_rxa;
556 int snd_cnt, rec_cnt;
557 int cmp, same, xattrs_equal = 1;
559 if (sxp && XATTR_READY(*sxp)) {
560 rec_rxa = sxp->xattr->items;
561 rec_cnt = sxp->xattr->count;
567 if (F_XATTR(file) >= 0) {
568 glst += F_XATTR(file);
569 lst = &glst->xa_items;
573 snd_rxa = lst->items;
574 snd_cnt = lst->count;
576 /* If the count of the sender's xattrs is different from our
577 * (receiver's) xattrs, the lists are not the same. */
578 if (snd_cnt != rec_cnt) {
585 cmp = rec_cnt ? strcmp(snd_rxa->name, rec_rxa->name) : -1;
588 else if (snd_rxa->datum_len > MAX_FULL_DATUM) {
589 same = cmp == 0 && snd_rxa->datum_len == rec_rxa->datum_len
590 && memcmp(snd_rxa->datum + 1, rec_rxa->datum + 1,
591 MAX_DIGEST_LEN) == 0;
592 /* Flag unrequested items that we need. */
593 if (!same && find_all && snd_rxa->datum[0] == XSTATE_ABBREV)
594 snd_rxa->datum[0] = XSTATE_TODO;
596 same = cmp == 0 && snd_rxa->datum_len == rec_rxa->datum_len
597 && memcmp(snd_rxa->datum, rec_rxa->datum,
598 snd_rxa->datum_len) == 0;
619 return !xattrs_equal;
622 /* When called by the generator (with a NULL fname), this tells the sender
623 * all the abbreviated xattr values we need. When called by the sender
624 * (with a non-NULL fname), we send all the extra xattr data it needs.
625 * The generator may also call with f_out < 0 to just change all the
626 * XSTATE_ABBREV states into XSTATE_DONE. */
627 void send_xattr_request(const char *fname, struct file_struct *file, int f_out)
629 const rsync_xa_list *glst = rsync_xal_l.items;
630 const item_list *lst;
631 int cnt, prior_req = 0;
634 glst += F_XATTR(file);
635 lst = &glst->xa_items;
637 for (rxa = lst->items, cnt = lst->count; cnt--; rxa++) {
638 if (rxa->datum_len <= MAX_FULL_DATUM)
640 switch (rxa->datum[0]) {
642 /* Items left abbreviated matched the sender's checksum, so
643 * the receiver will cache the local data for future use. */
645 rxa->datum[0] = XSTATE_DONE;
654 /* Flag that we handled this abbreviated item. */
655 rxa->datum[0] = XSTATE_DONE;
657 write_varint(f_out, rxa->num - prior_req);
658 prior_req = rxa->num;
664 /* Re-read the long datum. */
665 if (!(ptr = get_xattr_data(fname, rxa->name, &len, 0))) {
666 rprintf(FERROR_XFER, "failed to re-read xattr %s for %s\n", rxa->name, fname);
667 write_varint(f_out, 0);
671 write_varint(f_out, len); /* length might have changed! */
672 write_bigbuf(f_out, ptr, len);
678 write_byte(f_out, 0); /* end the list */
681 /* When called by the sender, read the request from the generator and mark
682 * any needed xattrs with a flag that lets us know they need to be sent to
683 * the receiver. When called by the receiver, reads the sent data and
684 * stores it in place of its checksum. */
685 int recv_xattr_request(struct file_struct *file, int f_in)
687 const rsync_xa_list *glst = rsync_xal_l.items;
688 const item_list *lst;
689 char *old_datum, *name;
691 int rel_pos, cnt, num, got_xattr_data = 0;
693 if (F_XATTR(file) < 0) {
694 rprintf(FERROR, "recv_xattr_request: internal data error!\n");
695 exit_cleanup(RERR_PROTOCOL);
697 glst += F_XATTR(file);
698 lst = &glst->xa_items;
703 while ((rel_pos = read_varint(f_in)) != 0) {
706 /* The sender-related num values are only in order on the sender.
707 * We use that order here to scan forward or backward as needed. */
709 while (cnt < (int)lst->count && rxa->num > num) {
714 while (cnt > 1 && rxa->num < num) {
721 /* The receiving side has no known num order, so we just scan
722 * forward (w/wrap) and hope that the next value is near by. */
723 for (j = lst->count; j > 1 && rxa->num != num; j--) {
732 if (!cnt || rxa->num != num) {
733 rprintf(FERROR, "[%s] could not find xattr #%d for %s\n",
734 who_am_i(), num, f_name(file, NULL));
735 exit_cleanup(RERR_PROTOCOL);
737 if (!XATTR_ABBREV(*rxa) || rxa->datum[0] != XSTATE_ABBREV) {
738 rprintf(FERROR, "[%s] internal abbrev error on %s (%s, len=%ld)!\n",
739 who_am_i(), f_name(file, NULL), rxa->name, (long)rxa->datum_len);
740 exit_cleanup(RERR_PROTOCOL);
744 rxa->datum[0] = XSTATE_TODO;
748 old_datum = rxa->datum;
749 rxa->datum_len = read_varint(f_in);
751 if (SIZE_MAX - rxa->name_len < rxa->datum_len)
752 overflow_exit("recv_xattr_request");
753 rxa->datum = new_array(char, rxa->datum_len + rxa->name_len);
754 name = rxa->datum + rxa->datum_len;
755 memcpy(name, rxa->name, rxa->name_len);
758 read_buf(f_in, rxa->datum, rxa->datum_len);
762 return got_xattr_data;
765 /* ------------------------------------------------------------------------- */
767 /* receive and build the rsync_xattr_lists */
768 void receive_xattr(int f, struct file_struct *file)
770 static item_list temp_xattr = EMPTY_ITEM_LIST;
772 #ifdef HAVE_LINUX_XATTRS
777 int ndx = read_varint(f);
779 if (ndx < 0 || (size_t)ndx > rsync_xal_l.count) {
780 rprintf(FERROR, "receive_xattr: xa index %d out of"
781 " range for %s\n", ndx, f_name(file, NULL));
782 exit_cleanup(RERR_STREAMIO);
786 F_XATTR(file) = ndx - 1;
790 if ((count = read_varint(f)) != 0) {
791 (void)EXPAND_ITEM_LIST(&temp_xattr, rsync_xa, count);
792 temp_xattr.count = 0;
795 for (num = 1; num <= count; num++) {
798 size_t name_len = read_varint(f);
799 size_t datum_len = read_varint(f);
800 size_t dget_len = datum_len > MAX_FULL_DATUM ? 1 + MAX_DIGEST_LEN : datum_len;
801 size_t extra_len = MIGHT_NEED_RPRE ? RPRE_LEN : 0;
802 if (SIZE_MAX - dget_len < extra_len || SIZE_MAX - dget_len - extra_len < name_len)
803 overflow_exit("receive_xattr");
804 ptr = new_array(char, dget_len + extra_len + name_len);
805 name = ptr + dget_len + extra_len;
806 read_buf(f, name, name_len);
807 if (name_len < 1 || name[name_len-1] != '\0') {
808 rprintf(FERROR, "Invalid xattr name received (missing trailing \\0).\n");
809 exit_cleanup(RERR_FILEIO);
811 if (dget_len == datum_len)
812 read_buf(f, ptr, dget_len);
814 *ptr = XSTATE_ABBREV;
815 read_buf(f, ptr + 1, MAX_DIGEST_LEN);
818 if (saw_xattr_filter) {
819 if (name_is_excluded(name, NAME_IS_XATTR, ALL_FILTERS)) {
824 #ifdef HAVE_LINUX_XATTRS
825 /* Non-root can only save the user namespace. */
826 if (am_root <= 0 && !HAS_PREFIX(name, USER_PREFIX)) {
827 if (!am_root && !saw_xattr_filter) {
832 name_len += RPRE_LEN;
833 memcpy(name, RSYNC_PREFIX, RPRE_LEN);
837 /* This OS only has a user namespace, so we either
838 * strip the user prefix, or we put a non-user
839 * namespace inside our rsync hierarchy. */
840 if (HAS_PREFIX(name, USER_PREFIX)) {
842 name_len -= UPRE_LEN;
843 } else if (am_root) {
845 name_len += RPRE_LEN;
846 memcpy(name, RSYNC_PREFIX, RPRE_LEN);
852 /* No rsync.%FOO attributes are copied w/o 2 -X options. */
853 if (preserve_xattrs < 2 && name_len > RPRE_LEN
854 && name[RPRE_LEN] == '%' && HAS_PREFIX(name, RSYNC_PREFIX)) {
859 rxa = EXPAND_ITEM_LIST(&temp_xattr, rsync_xa, 1);
862 rxa->name_len = name_len;
863 rxa->datum_len = datum_len;
867 if (need_sort && count > 1)
868 qsort(temp_xattr.items, count, sizeof (rsync_xa), rsync_xal_compare_names);
870 ndx = rsync_xal_store(&temp_xattr); /* adds item to rsync_xal_l */
875 /* Turn the xattr data in stat_x into cached xattr data, setting the index
876 * values in the file struct. */
877 void cache_tmp_xattr(struct file_struct *file, stat_x *sxp)
884 if (prior_xattr_count == (size_t)-1)
885 prior_xattr_count = rsync_xal_l.count;
886 ndx = find_matching_xattr(sxp->xattr);
888 rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
893 void uncache_tmp_xattrs(void)
895 if (prior_xattr_count != (size_t)-1) {
896 rsync_xa_list *xa_list_item = rsync_xal_l.items;
897 rsync_xa_list *xa_list_start = xa_list_item + prior_xattr_count;
898 xa_list_item += rsync_xal_l.count;
899 rsync_xal_l.count = prior_xattr_count;
900 while (xa_list_item-- > xa_list_start) {
901 struct ht_int64_node *node;
902 rsync_xa_list_ref *ref;
904 rsync_xal_free(&xa_list_item->xa_items);
906 if (rsync_xal_h == NULL)
909 node = hashtable_find(rsync_xal_h, xa_list_item->key, NULL);
913 if (node->data == NULL)
917 if (xa_list_item->ndx == ref->ndx) {
918 /* xa_list_item is the first in the list. */
919 node->data = ref->next;
925 rsync_xa_list_ref *next = ref->next;
928 if (xa_list_item->ndx == next->ndx) {
929 ref->next = next->next;
936 prior_xattr_count = (size_t)-1;
940 static int rsync_xal_set(const char *fname, item_list *xalp,
941 const char *fnamecmp, stat_x *sxp)
943 rsync_xa *rxas = xalp->items;
946 char *name, *ptr, sum[MAX_DIGEST_LEN];
947 #ifdef HAVE_LINUX_XATTRS
948 int user_only = am_root <= 0;
953 /* This puts the current name list into the "namebuf" buffer. */
954 if ((list_len = get_xattr_names(fname)) < 0)
957 for (i = 0; i < xalp->count; i++) {
960 if (XATTR_ABBREV(rxas[i])) {
962 /* See if the fnamecmp version is identical. */
963 len = name_len = rxas[i].name_len;
964 if ((ptr = get_xattr_data(fnamecmp, name, &len, 1)) == NULL) {
968 rprintf(FERROR, "Missing abbreviated xattr value, %s, for %s\n",
969 rxas[i].name, full_fname(fname));
973 if (len != rxas[i].datum_len) {
978 sum_init(-1, checksum_seed);
979 sum_update(ptr, len);
980 sum_len = sum_end(sum);
981 if (memcmp(sum, rxas[i].datum + 1, sum_len) != 0) {
986 if (fname == fnamecmp)
987 ; /* Value is already set when identical */
988 else if (sys_lsetxattr(fname, name, ptr, len) < 0) {
989 rsyserr(FERROR_XFER, errno,
990 "rsync_xal_set: lsetxattr(%s,\"%s\") failed",
991 full_fname(fname), name);
993 } else /* make sure caller sets mtime */
994 sxp->st.st_mtime = (time_t)-1;
996 if (am_generator) { /* generator items stay abbreviated */
1001 memcpy(ptr + len, name, name_len);
1002 free(rxas[i].datum);
1004 rxas[i].name = name = ptr + len;
1005 rxas[i].datum = ptr;
1009 if (sys_lsetxattr(fname, name, rxas[i].datum, rxas[i].datum_len) < 0) {
1010 rsyserr(FERROR_XFER, errno,
1011 "rsync_xal_set: lsetxattr(%s,\"%s\") failed",
1012 full_fname(fname), name);
1014 } else /* make sure caller sets mtime */
1015 sxp->st.st_mtime = (time_t)-1;
1018 /* Remove any extraneous names. */
1019 for (name = namebuf; list_len > 0; name += name_len) {
1020 name_len = strlen(name) + 1;
1021 list_len -= name_len;
1023 if (saw_xattr_filter) {
1024 if (name_is_excluded(name, NAME_IS_XATTR, ALL_FILTERS))
1027 #ifdef HAVE_LINUX_XATTRS
1028 /* Choose between ignoring the system namespace or (non-root) ignoring any non-user namespace. */
1029 else if (user_only ? !HAS_PREFIX(name, USER_PREFIX) : HAS_PREFIX(name, SYSTEM_PREFIX))
1032 if (am_root < 0 && name_len > RPRE_LEN && name[RPRE_LEN] == '%' && strcmp(name, XSTAT_ATTR) == 0)
1035 for (i = 0; i < xalp->count; i++) {
1036 if (strcmp(name, rxas[i].name) == 0)
1039 if (i == xalp->count) {
1040 if (sys_lremovexattr(fname, name) < 0) {
1041 rsyserr(FERROR_XFER, errno,
1042 "rsync_xal_set: lremovexattr(%s,\"%s\") failed",
1043 full_fname(fname), name);
1045 } else /* make sure caller sets mtime */
1046 sxp->st.st_mtime = (time_t)-1;
1053 /* Set extended attributes on indicated filename. */
1054 int set_xattr(const char *fname, const struct file_struct *file, const char *fnamecmp, stat_x *sxp)
1056 rsync_xa_list *glst = rsync_xal_l.items;
1058 int ndx, added_write_perm = 0;
1061 return 1; /* FIXME: --dry-run needs to compute this value */
1063 if (read_only || list_only) {
1068 #ifdef NO_SPECIAL_XATTRS
1069 if (IS_SPECIAL(sxp->st.st_mode)) {
1074 #ifdef NO_DEVICE_XATTRS
1075 if (IS_DEVICE(sxp->st.st_mode)) {
1080 #ifdef NO_SYMLINK_XATTRS
1081 if (S_ISLNK(sxp->st.st_mode)) {
1087 /* If the target file lacks write permission, we try to add it
1088 * temporarily so we can change the extended attributes. */
1090 #ifdef SUPPORT_LINKS
1091 && !S_ISLNK(sxp->st.st_mode)
1093 && access(fname, W_OK) < 0
1094 && do_chmod(fname, (sxp->st.st_mode & CHMOD_BITS) | S_IWUSR) == 0)
1095 added_write_perm = 1;
1097 ndx = F_XATTR(file);
1099 lst = &glst->xa_items;
1100 int return_value = rsync_xal_set(fname, lst, fnamecmp, sxp);
1101 if (added_write_perm) /* remove the temporary write permission */
1102 do_chmod(fname, sxp->st.st_mode);
1103 return return_value;
1107 char *get_xattr_acl(const char *fname, int is_access_acl, size_t *len_p)
1109 const char *name = is_access_acl ? XACC_ACL_ATTR : XDEF_ACL_ATTR;
1110 *len_p = 0; /* no extra data alloc needed from get_xattr_data() */
1111 return get_xattr_data(fname, name, len_p, 1);
1114 int set_xattr_acl(const char *fname, int is_access_acl, const char *buf, size_t buf_len)
1116 const char *name = is_access_acl ? XACC_ACL_ATTR : XDEF_ACL_ATTR;
1117 if (sys_lsetxattr(fname, name, buf, buf_len) < 0) {
1118 rsyserr(FERROR_XFER, errno,
1119 "set_xattr_acl: lsetxattr(%s,\"%s\") failed",
1120 full_fname(fname), name);
1126 int del_def_xattr_acl(const char *fname)
1128 return sys_lremovexattr(fname, XDEF_ACL_ATTR);
1132 int get_stat_xattr(const char *fname, int fd, STRUCT_STAT *fst, STRUCT_STAT *xst)
1135 int rdev_major, rdev_minor, uid, gid, len;
1138 if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
1147 len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
1150 len = sys_fgetxattr(fd, XSTAT_ATTR, buf, sizeof buf - 1);
1152 if (len >= (int)sizeof buf) {
1157 if (errno == ENOTSUP || errno == ENOATTR)
1159 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
1164 rsyserr(FERROR_XFER, errno, "failed to read xattr %s for %s",
1165 XSTAT_ATTR, full_fname(fname));
1170 if (sscanf(buf, "%o %d,%d %d:%d",
1171 &mode, &rdev_major, &rdev_minor, &uid, &gid) != 5) {
1172 rprintf(FERROR, "Corrupt %s xattr attached to %s: \"%s\"\n",
1173 XSTAT_ATTR, full_fname(fname), buf);
1174 exit_cleanup(RERR_FILEIO);
1177 xst->st_mode = from_wire_mode(mode);
1178 xst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
1185 int set_stat_xattr(const char *fname, struct file_struct *file, mode_t new_mode)
1187 STRUCT_STAT fst, xst;
1194 if (read_only || list_only) {
1195 rsyserr(FERROR_XFER, EROFS, "failed to write xattr %s for %s",
1196 XSTAT_ATTR, full_fname(fname));
1200 if (x_lstat(fname, &fst, &xst) < 0) {
1201 rsyserr(FERROR_XFER, errno, "failed to re-stat %s",
1206 fst.st_mode &= (_S_IFMT | CHMOD_BITS);
1207 fmode = new_mode & (_S_IFMT | CHMOD_BITS);
1209 if (IS_DEVICE(fmode)) {
1210 uint32 *devp = F_RDEV_P(file);
1211 rdev = MAKEDEV(DEV_MAJOR(devp), DEV_MINOR(devp));
1215 /* Dump the special permissions and enable full owner access. */
1216 mode = (fst.st_mode & _S_IFMT) | (fmode & ACCESSPERMS)
1217 | (S_ISDIR(fst.st_mode) ? 0700 : 0600);
1218 if (fst.st_mode != mode)
1219 do_chmod(fname, mode);
1220 if (!IS_DEVICE(fst.st_mode))
1221 fst.st_rdev = 0; /* just in case */
1223 if (mode == fmode && fst.st_rdev == rdev
1224 && fst.st_uid == F_OWNER(file) && fst.st_gid == F_GROUP(file)) {
1225 /* xst.st_mode will be 0 if there's no current stat xattr */
1226 if (xst.st_mode && sys_lremovexattr(fname, XSTAT_ATTR) < 0) {
1227 rsyserr(FERROR_XFER, errno,
1228 "delete of stat xattr failed for %s",
1235 if (xst.st_mode != fmode || xst.st_rdev != rdev
1236 || xst.st_uid != F_OWNER(file) || xst.st_gid != F_GROUP(file)) {
1238 int len = snprintf(buf, sizeof buf, "%o %u,%u %u:%u",
1239 to_wire_mode(fmode),
1240 (int)major(rdev), (int)minor(rdev),
1241 F_OWNER(file), F_GROUP(file));
1242 if (sys_lsetxattr(fname, XSTAT_ATTR, buf, len) < 0) {
1243 if (errno == EPERM && S_ISLNK(fst.st_mode))
1245 rsyserr(FERROR_XFER, errno,
1246 "failed to write xattr %s for %s",
1247 XSTAT_ATTR, full_fname(fname));
1255 int x_stat(const char *fname, STRUCT_STAT *fst, STRUCT_STAT *xst)
1257 int ret = do_stat(fname, fst);
1258 if ((ret < 0 || get_stat_xattr(fname, -1, fst, xst) < 0) && xst)
1263 int x_lstat(const char *fname, STRUCT_STAT *fst, STRUCT_STAT *xst)
1265 int ret = do_lstat(fname, fst);
1266 if ((ret < 0 || get_stat_xattr(fname, -1, fst, xst) < 0) && xst)
1271 int x_fstat(int fd, STRUCT_STAT *fst, STRUCT_STAT *xst)
1273 int ret = do_fstat(fd, fst);
1274 if ((ret < 0 || get_stat_xattr(NULL, fd, fst, xst) < 0) && xst)
1279 #endif /* SUPPORT_XATTRS */