Clumped some option-sending together that only happens on the sending side.
[rsync/rsync.git] / xattrs.c
CommitLineData
16edf865
WD
1/*
2 * Extended Attribute support for rsync.
3 * Written by Jay Fenlason, vaguely based on the ACLs patch.
4 *
5 * Copyright (C) 2004 Red Hat, Inc.
6 * Copyright (C) 2006, 2007 Wayne Davison
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
20 */
21
22#include "rsync.h"
23#include "lib/sysxattrs.h"
24
25#ifdef SUPPORT_XATTRS
26
27extern int dry_run;
28extern int am_root;
29extern int am_sender;
30extern int am_generator;
31extern int read_only;
32extern int list_only;
33extern int checksum_seed;
34
35#define RSYNC_XAL_INITIAL 5
36#define RSYNC_XAL_LIST_INITIAL 100
37
38#define MAX_FULL_DATUM 32
39
40#define HAS_PREFIX(str, prfx) (*(str) == *(prfx) \
41 && strncmp(str, prfx, sizeof (prfx) - 1) == 0)
42
43#define XATTR_ABBREV(x) ((size_t)((x).name - (x).datum) < (x).datum_len)
44
45#define XSTATE_ABBREV 0
46#define XSTATE_DONE 1
47#define XSTATE_TODO 2
48#define XSTATE_LOCAL 3
49
50#define USER_PREFIX "user."
51#define UPRE_LEN ((int)sizeof USER_PREFIX - 1)
52#define SYSTEM_PREFIX "system."
53#define SPRE_LEN ((int)sizeof SYSTEM_PREFIX - 1)
54
55#ifdef HAVE_LINUX_XATTRS
9439c0cb
WD
56#define MIGHT_NEED_RPRE (am_root < 0)
57#define RSYNC_PREFIX USER_PREFIX "rsync."
16edf865 58#else
9439c0cb 59#define MIGHT_NEED_RPRE am_root
16edf865 60#define RSYNC_PREFIX "rsync."
16edf865 61#endif
9439c0cb
WD
62#define RPRE_LEN ((int)sizeof RSYNC_PREFIX - 1)
63
64#define XSTAT_ATTR RSYNC_PREFIX "%stat"
65#define XSTAT_LEN ((int)sizeof XSTAT_ATTR - 1)
16edf865
WD
66
67typedef struct {
68 char *datum, *name;
69 size_t datum_len, name_len;
70} rsync_xa;
71
72static size_t namebuf_len = 0;
73static char *namebuf = NULL;
74
75static item_list empty_xattr = EMPTY_ITEM_LIST;
76static item_list rsync_xal_l = EMPTY_ITEM_LIST;
77
78/* ------------------------------------------------------------------------- */
79
80static void rsync_xal_free(item_list *xalp)
81{
82 size_t i;
83 rsync_xa *rxas = xalp->items;
84
85 for (i = 0; i < xalp->count; i++) {
86 free(rxas[i].datum);
87 /*free(rxas[i].name);*/
88 }
89 xalp->count = 0;
90}
91
92void free_xattr(statx *sxp)
93{
94 if (!sxp->xattr)
95 return;
96 rsync_xal_free(sxp->xattr);
97 free(sxp->xattr);
98 sxp->xattr = NULL;
99}
100
101static int rsync_xal_compare_names(const void *x1, const void *x2)
102{
103 const rsync_xa *xa1 = x1;
104 const rsync_xa *xa2 = x2;
105 return strcmp(xa1->name, xa2->name);
106}
107
108static ssize_t get_xattr_names(const char *fname)
109{
110 ssize_t list_len;
111
112 if (!namebuf) {
113 namebuf_len = 1024;
114 namebuf = new_array(char, namebuf_len);
115 if (!namebuf)
116 out_of_memory("get_xattr_names");
117 }
118
119 /* The length returned includes all the '\0' terminators. */
120 list_len = sys_llistxattr(fname, namebuf, namebuf_len);
121 if (list_len > (ssize_t)namebuf_len) {
122 list_len = -1;
123 errno = ERANGE;
124 }
125 if (list_len >= 0)
126 return list_len;
127 if (errno == ENOTSUP)
128 return 0;
129 if (errno == ERANGE) {
130 list_len = sys_llistxattr(fname, NULL, 0);
131 if (list_len < 0) {
132 rsyserr(FERROR, errno,
133 "get_xattr_names: llistxattr(\"%s\",0) failed",
134 fname);
135 return -1;
136 }
137 if (namebuf_len)
138 free(namebuf);
139 namebuf_len = list_len + 1024;
140 namebuf = new_array(char, namebuf_len);
141 if (!namebuf)
142 out_of_memory("get_xattr_names");
143 list_len = sys_llistxattr(fname, namebuf, namebuf_len);
144 if (list_len >= 0)
145 return list_len;
146 }
147
148 rsyserr(FERROR, errno,
149 "get_xattr_names: llistxattr(\"%s\",%ld) failed",
150 fname, (long)namebuf_len);
151 return -1;
152}
153
154/* On entry, the *len_ptr parameter contains the size of the extra space we
155 * should allocate when we create a buffer for the data. On exit, it contains
156 * the length of the datum. */
157static char *get_xattr_data(const char *fname, const char *name, size_t *len_ptr,
158 int no_missing_error)
159{
160 size_t datum_len = sys_lgetxattr(fname, name, NULL, 0);
161 char *ptr;
162
163 if (datum_len == (size_t)-1) {
164 if (errno == ENOTSUP || no_missing_error)
165 return NULL;
166 rsyserr(FERROR, errno,
167 "get_xattr_data: lgetxattr(\"%s\",\"%s\",0) failed",
168 fname, name);
169 return NULL;
170 }
171
172 if (datum_len + *len_ptr < datum_len /* checks for overflow */
173 || !(ptr = new_array(char, datum_len + *len_ptr)))
174 out_of_memory("get_xattr_data");
175
176 *len_ptr = datum_len;
177
178 if (datum_len) {
179 size_t len = sys_lgetxattr(fname, name, ptr, datum_len);
180 if (len != datum_len) {
181 if (len == (size_t)-1) {
182 rsyserr(FERROR, errno,
183 "get_xattr_data: lgetxattr(\"%s\",\"%s\",%ld)"
184 " failed", fname, name, (long)datum_len);
185 } else {
186 rprintf(FERROR,
187 "get_xattr_data: lgetxattr(\"%s\",\"%s\",%ld)"
188 " returned %ld\n", fname, name,
189 (long)datum_len, (long)len);
190 }
191 free(ptr);
192 return NULL;
193 }
194 }
195
196 return ptr;
197}
198
199static int rsync_xal_get(const char *fname, item_list *xalp)
200{
201 ssize_t list_len, name_len;
202 size_t datum_len, name_offset;
203 char *name, *ptr;
204#ifdef HAVE_LINUX_XATTRS
205 int user_only = am_sender ? 0 : !am_root;
206#endif
207
208 /* This puts the name list into the "namebuf" buffer. */
209 if ((list_len = get_xattr_names(fname)) < 0)
210 return -1;
211
212 for (name = namebuf; list_len > 0; name += name_len) {
213 rsync_xa *rxas;
214
215 name_len = strlen(name) + 1;
216 list_len -= name_len;
217
218#ifdef HAVE_LINUX_XATTRS
219 /* We always ignore the system namespace, and non-root
220 * ignores everything but the user namespace. */
221 if (user_only ? !HAS_PREFIX(name, USER_PREFIX)
222 : HAS_PREFIX(name, SYSTEM_PREFIX))
223 continue;
224#endif
225
9439c0cb
WD
226 if (am_root < 0 && name_len == XSTAT_LEN + 1
227 && name[RPRE_LEN] == '%' && strcmp(name, XSTAT_ATTR) == 0)
228 continue;
229
16edf865
WD
230 datum_len = name_len; /* Pass extra size to get_xattr_data() */
231 if (!(ptr = get_xattr_data(fname, name, &datum_len, 0)))
232 return -1;
233
234 if (datum_len > MAX_FULL_DATUM) {
235 /* For large datums, we store a flag and a checksum. */
236 name_offset = 1 + MAX_DIGEST_LEN;
237 sum_init(checksum_seed);
238 sum_update(ptr, datum_len);
239 free(ptr);
240
241 if (!(ptr = new_array(char, name_offset + name_len)))
242 out_of_memory("rsync_xal_get");
243 *ptr = XSTATE_ABBREV;
244 sum_end(ptr + 1);
245 } else
246 name_offset = datum_len;
247
9439c0cb
WD
248#ifdef HAVE_LINUX_XATTRS
249 if (am_root < 0 && name_len > RPRE_LEN
250 && HAS_PREFIX(name, RSYNC_PREFIX)) {
251 name += RPRE_LEN;
252 name_len -= RPRE_LEN;
253 }
254#endif
255
16edf865
WD
256 rxas = EXPAND_ITEM_LIST(xalp, rsync_xa, RSYNC_XAL_INITIAL);
257 rxas->name = ptr + name_offset;
258 memcpy(rxas->name, name, name_len);
259 rxas->datum = ptr;
260 rxas->name_len = name_len;
261 rxas->datum_len = datum_len;
262 }
263 if (xalp->count > 1)
264 qsort(xalp->items, xalp->count, sizeof (rsync_xa), rsync_xal_compare_names);
265 return 0;
266}
267
268/* Read the xattr(s) for this filename. */
269int get_xattr(const char *fname, statx *sxp)
270{
271 sxp->xattr = new(item_list);
272 *sxp->xattr = empty_xattr;
273 if (rsync_xal_get(fname, sxp->xattr) < 0) {
274 free_xattr(sxp);
275 return -1;
276 }
277 return 0;
278}
279
280static int find_matching_xattr(item_list *xalp)
281{
282 size_t i, j;
283 item_list *lst = rsync_xal_l.items;
284
285 for (i = 0; i < rsync_xal_l.count; i++) {
286 rsync_xa *rxas1 = lst[i].items;
287 rsync_xa *rxas2 = xalp->items;
288
289 /* Wrong number of elements? */
290 if (lst[i].count != xalp->count)
291 continue;
292 /* any elements different? */
293 for (j = 0; j < xalp->count; j++) {
294 if (rxas1[j].name_len != rxas2[j].name_len
295 || rxas1[j].datum_len != rxas2[j].datum_len
296 || strcmp(rxas1[j].name, rxas2[j].name))
297 break;
298 if (rxas1[j].datum_len > MAX_FULL_DATUM) {
299 if (memcmp(rxas1[j].datum + 1,
300 rxas2[j].datum + 1,
301 MAX_DIGEST_LEN) != 0)
302 break;
303 } else {
304 if (memcmp(rxas1[j].datum, rxas2[j].datum,
305 rxas2[j].datum_len))
306 break;
307 }
308 }
309 /* no differences found. This is The One! */
310 if (j == xalp->count)
311 return i;
312 }
313
314 return -1;
315}
316
317/* Store *xalp on the end of rsync_xal_l */
318static void rsync_xal_store(item_list *xalp)
319{
320 item_list *new_lst = EXPAND_ITEM_LIST(&rsync_xal_l, item_list, RSYNC_XAL_LIST_INITIAL);
321 /* Since the following call starts a new list, we know it will hold the
322 * entire initial-count, not just enough space for one new item. */
323 *new_lst = empty_xattr;
324 (void)EXPAND_ITEM_LIST(new_lst, rsync_xa, xalp->count);
325 memcpy(new_lst->items, xalp->items, xalp->count * sizeof (rsync_xa));
326 new_lst->count = xalp->count;
327 xalp->count = 0;
328}
329
330/* Send the make_xattr()-generated xattr list for this flist entry. */
331int send_xattr(statx *sxp, int f)
332{
333 int ndx = find_matching_xattr(sxp->xattr);
334
335 /* Send 0 (-1 + 1) to indicate that literal xattr data follows. */
f31514ad 336 write_varint(f, ndx + 1);
16edf865
WD
337
338 if (ndx < 0) {
339 rsync_xa *rxa;
340 int count = sxp->xattr->count;
f31514ad 341 write_varint(f, count);
16edf865
WD
342 for (rxa = sxp->xattr->items; count--; rxa++) {
343#ifdef HAVE_LINUX_XATTRS
f31514ad
WD
344 write_varint(f, rxa->name_len);
345 write_varint(f, rxa->datum_len);
16edf865
WD
346 write_buf(f, rxa->name, rxa->name_len);
347#else
348 /* We strip the rsync prefix from disguised namespaces
349 * and put everything else in the user namespace. */
350 if (HAS_PREFIX(rxa->name, RSYNC_PREFIX)
351 && rxa->name[RPRE_LEN] != '%') {
f31514ad
WD
352 write_varint(f, rxa->name_len - RPRE_LEN);
353 write_varint(f, rxa->datum_len);
16edf865
WD
354 write_buf(f, rxa->name + RPRE_LEN, rxa->name_len - RPRE_LEN);
355 } else {
f31514ad
WD
356 write_varint(f, rxa->name_len + UPRE_LEN);
357 write_varint(f, rxa->datum_len);
16edf865
WD
358 write_buf(f, USER_PREFIX, UPRE_LEN);
359 write_buf(f, rxa->name, rxa->name_len);
360 }
361#endif
362 if (rxa->datum_len > MAX_FULL_DATUM)
363 write_buf(f, rxa->datum + 1, MAX_DIGEST_LEN);
364 else
365 write_buf(f, rxa->datum, rxa->datum_len);
366 }
367 ndx = rsync_xal_l.count; /* pre-incremented count */
368 rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
369 }
370
371 return ndx;
372}
373
374/* Return a flag indicating if we need to change a file's xattrs. If
375 * "find_all" is specified, also mark any abbreviated xattrs that we
376 * need so that send_xattr_request() can tell the sender about them. */
377int xattr_diff(struct file_struct *file, statx *sxp, int find_all)
378{
379 item_list *lst = rsync_xal_l.items;
380 rsync_xa *snd_rxa, *rec_rxa;
381 int snd_cnt, rec_cnt;
382 int cmp, same, xattrs_equal = 1;
383
384 if (sxp && XATTR_READY(*sxp)) {
385 rec_rxa = sxp->xattr->items;
386 rec_cnt = sxp->xattr->count;
387 } else {
388 rec_rxa = NULL;
389 rec_cnt = 0;
390 }
391
392 if (F_XATTR(file) >= 0)
393 lst += F_XATTR(file);
394 else
395 lst = &empty_xattr;
396
397 snd_rxa = lst->items;
398 snd_cnt = lst->count;
399
400 /* If the count of the sender's xattrs is different from our
401 * (receiver's) xattrs, the lists are not the same. */
402 if (snd_cnt != rec_cnt) {
403 if (!find_all)
404 return 1;
405 xattrs_equal = 0;
406 }
407
408 while (snd_cnt) {
409 cmp = rec_cnt ? strcmp(snd_rxa->name, rec_rxa->name) : -1;
410 if (cmp > 0)
411 same = 0;
412 else if (snd_rxa->datum_len > MAX_FULL_DATUM) {
413 same = cmp == 0 && snd_rxa->datum_len == rec_rxa->datum_len
414 && memcmp(snd_rxa->datum + 1, rec_rxa->datum + 1,
415 MAX_DIGEST_LEN) == 0;
416 /* Flag unrequested items that we need. */
417 if (!same && find_all && snd_rxa->datum[0] == XSTATE_ABBREV)
418 snd_rxa->datum[0] = XSTATE_TODO;
419 } else {
420 same = cmp == 0 && snd_rxa->datum_len == rec_rxa->datum_len
421 && memcmp(snd_rxa->datum, rec_rxa->datum,
422 snd_rxa->datum_len) == 0;
423 }
424 if (!same) {
425 if (!find_all)
426 return 1;
427 xattrs_equal = 0;
428 }
429
430 if (cmp <= 0) {
431 snd_rxa++;
432 snd_cnt--;
433 }
434 if (cmp >= 0) {
435 rec_rxa++;
436 rec_cnt--;
437 }
438 }
439
440 if (rec_cnt)
441 xattrs_equal = 0;
442
443 return !xattrs_equal;
444}
445
446/* When called by the generator with a NULL fname, this tells the sender
447 * which abbreviated xattr values we need. When called by the sender
448 * (with a non-NULL fname), we send all the extra xattr data it needs. */
449void send_xattr_request(const char *fname, struct file_struct *file, int f_out)
450{
451 item_list *lst = rsync_xal_l.items;
452 int j, cnt, prior_req = -1;
453 rsync_xa *rxa;
454
455 lst += F_XATTR(file);
456 cnt = lst->count;
457 for (rxa = lst->items, j = 0; j < cnt; rxa++, j++) {
458 if (rxa->datum_len <= MAX_FULL_DATUM)
459 continue;
460 switch (rxa->datum[0]) {
461 case XSTATE_LOCAL:
462 /* Items set locally will get cached by receiver. */
463 rxa->datum[0] = XSTATE_DONE;
464 continue;
465 case XSTATE_TODO:
466 break;
467 default:
468 continue;
469 }
470
471 /* Flag that we handled this abbreviated item. */
472 rxa->datum[0] = XSTATE_DONE;
473
f31514ad 474 write_varint(f_out, j - prior_req);
16edf865
WD
475 prior_req = j;
476
477 if (fname) {
478 size_t len = 0;
479 char *ptr;
480
481 /* Re-read the long datum. */
482 if (!(ptr = get_xattr_data(fname, rxa->name, &len, 0)))
483 continue;
484
f31514ad 485 write_varint(f_out, len); /* length might have changed! */
16edf865
WD
486 write_buf(f_out, ptr, len);
487 free(ptr);
488 }
489 }
490
491 write_byte(f_out, 0); /* end the list */
492}
493
494/* Any items set locally by the generator that the receiver doesn't
495 * get told about get changed back to XSTATE_ABBREV. */
496void xattr_clear_locals(struct file_struct *file)
497{
498 item_list *lst = rsync_xal_l.items;
499 rsync_xa *rxa;
500 int cnt;
501
502 if (F_XATTR(file) < 0)
503 return;
504
505 lst += F_XATTR(file);
506 cnt = lst->count;
507 for (rxa = lst->items; cnt--; rxa++) {
508 if (rxa->datum_len <= MAX_FULL_DATUM)
509 continue;
510 if (rxa->datum[0] == XSTATE_LOCAL)
511 rxa->datum[0] = XSTATE_ABBREV;
512 }
513}
514
515/* When called by the sender, read the request from the generator and mark
516 * any needed xattrs with a flag that lets us know they need to be sent to
517 * the receiver. When called by the receiver, reads the sent data and
518 * stores it in place of its checksum. */
519void recv_xattr_request(struct file_struct *file, int f_in)
520{
521 item_list *lst = rsync_xal_l.items;
522 char *old_datum, *name;
523 rsync_xa *rxa;
524 int rel_pos, cnt;
525
526 if (F_XATTR(file) < 0) {
527 rprintf(FERROR, "recv_xattr_request: internal data error!\n");
528 exit_cleanup(RERR_STREAMIO);
529 }
530 lst += F_XATTR(file);
531
532 cnt = lst->count;
533 rxa = lst->items;
534 rxa -= 1;
f31514ad 535 while ((rel_pos = read_varint(f_in)) != 0) {
16edf865
WD
536 rxa += rel_pos;
537 cnt -= rel_pos;
538 if (cnt < 0 || rxa->datum_len <= MAX_FULL_DATUM
539 || rxa->datum[0] != XSTATE_ABBREV) {
540 rprintf(FERROR, "recv_xattr_request: internal abbrev error!\n");
541 exit_cleanup(RERR_STREAMIO);
542 }
543
544 if (am_sender) {
545 rxa->datum[0] = XSTATE_TODO;
546 continue;
547 }
548
549 old_datum = rxa->datum;
f31514ad 550 rxa->datum_len = read_varint(f_in);
16edf865
WD
551
552 if (rxa->name_len + rxa->datum_len < rxa->name_len)
553 out_of_memory("recv_xattr_request"); /* overflow */
554 rxa->datum = new_array(char, rxa->datum_len + rxa->name_len);
555 if (!rxa->datum)
556 out_of_memory("recv_xattr_request");
557 name = rxa->datum + rxa->datum_len;
558 memcpy(name, rxa->name, rxa->name_len);
559 rxa->name = name;
560 free(old_datum);
561 read_buf(f_in, rxa->datum, rxa->datum_len);
562 }
563}
564
565/* ------------------------------------------------------------------------- */
566
567/* receive and build the rsync_xattr_lists */
568void receive_xattr(struct file_struct *file, int f)
569{
570 static item_list temp_xattr = EMPTY_ITEM_LIST;
571 int count;
f31514ad 572 int ndx = read_varint(f);
16edf865
WD
573
574 if (ndx < 0 || (size_t)ndx > rsync_xal_l.count) {
575 rprintf(FERROR, "receive_xattr: xa index %d out of"
576 " range for %s\n", ndx, f_name(file, NULL));
577 exit_cleanup(RERR_STREAMIO);
578 }
579
580 if (ndx != 0) {
581 F_XATTR(file) = ndx - 1;
582 return;
583 }
584
f31514ad 585 if ((count = read_varint(f)) != 0) {
16edf865
WD
586 (void)EXPAND_ITEM_LIST(&temp_xattr, rsync_xa, count);
587 temp_xattr.count = 0;
588 }
589
590 while (count--) {
591 char *ptr, *name;
592 rsync_xa *rxa;
f31514ad
WD
593 size_t name_len = read_varint(f);
594 size_t datum_len = read_varint(f);
16edf865 595 size_t dget_len = datum_len > MAX_FULL_DATUM ? 1 + MAX_DIGEST_LEN : datum_len;
9439c0cb 596 size_t extra_len = MIGHT_NEED_RPRE ? RPRE_LEN : 0;
16edf865
WD
597 if (dget_len + extra_len < dget_len)
598 out_of_memory("receive_xattr"); /* overflow */
16edf865
WD
599 if (dget_len + extra_len + name_len < dget_len)
600 out_of_memory("receive_xattr"); /* overflow */
601 ptr = new_array(char, dget_len + extra_len + name_len);
602 if (!ptr)
603 out_of_memory("receive_xattr");
604 name = ptr + dget_len + extra_len;
605 read_buf(f, name, name_len);
606 if (dget_len == datum_len)
607 read_buf(f, ptr, dget_len);
608 else {
609 *ptr = XSTATE_ABBREV;
610 read_buf(f, ptr + 1, MAX_DIGEST_LEN);
611 }
612#ifdef HAVE_LINUX_XATTRS
613 /* Non-root can only save the user namespace. */
9439c0cb
WD
614 if (am_root <= 0 && !HAS_PREFIX(name, USER_PREFIX)) {
615 if (!am_root) {
616 free(ptr);
617 continue;
618 }
619 name -= RPRE_LEN;
620 name_len += RPRE_LEN;
621 memcpy(name, RSYNC_PREFIX, RPRE_LEN);
16edf865
WD
622 }
623#else
624 /* This OS only has a user namespace, so we either
625 * strip the user prefix, or we put a non-user
626 * namespace inside our rsync hierarchy. */
627 if (HAS_PREFIX(name, USER_PREFIX)) {
628 name += UPRE_LEN;
629 name_len -= UPRE_LEN;
630 } else if (am_root) {
631 name -= RPRE_LEN;
632 name_len += RPRE_LEN;
633 memcpy(name, RSYNC_PREFIX, RPRE_LEN);
634 } else {
635 free(ptr);
636 continue;
637 }
638#endif
9439c0cb
WD
639 if (am_root < 0 && name_len == XSTAT_LEN + 1
640 && name[RPRE_LEN] == '%' && strcmp(name, XSTAT_ATTR) == 0) {
641 free(ptr);
642 continue;
643 }
16edf865
WD
644 rxa = EXPAND_ITEM_LIST(&temp_xattr, rsync_xa, 1);
645 rxa->name = name;
646 rxa->datum = ptr;
647 rxa->name_len = name_len;
648 rxa->datum_len = datum_len;
649 }
650
651 ndx = rsync_xal_l.count; /* pre-incremented count */
652 rsync_xal_store(&temp_xattr); /* adds item to rsync_xal_l */
653
654 F_XATTR(file) = ndx;
655}
656
657/* Turn the xattr data in statx into cached xattr data, setting the index
658 * values in the file struct. */
659void cache_xattr(struct file_struct *file, statx *sxp)
660{
661 int ndx;
662
663 if (!sxp->xattr)
664 return;
665
666 ndx = find_matching_xattr(sxp->xattr);
667 if (ndx < 0)
668 rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
669
670 F_XATTR(file) = ndx;
671}
672
673static int rsync_xal_set(const char *fname, item_list *xalp,
674 const char *fnamecmp, statx *sxp)
675{
676 rsync_xa *rxas = xalp->items;
677 ssize_t list_len;
678 size_t i, len;
679 char *name, *ptr, sum[MAX_DIGEST_LEN];
680 int name_len, ret = 0;
681
682 /* This puts the current name list into the "namebuf" buffer. */
683 if ((list_len = get_xattr_names(fname)) < 0)
684 return -1;
685
686 for (i = 0; i < xalp->count; i++) {
687 name = rxas[i].name;
688
689 if (XATTR_ABBREV(rxas[i])) {
690 /* See if the fnamecmp version is identical. */
691 len = name_len = rxas[i].name_len;
692 if ((ptr = get_xattr_data(fnamecmp, name, &len, 1)) == NULL) {
693 still_abbrev:
694 if (am_generator)
695 continue;
696 rprintf(FERROR, "Missing abbreviated xattr value, %s, for %s\n",
697 rxas[i].name, full_fname(fname));
698 ret = -1;
699 continue;
700 }
701 if (len != rxas[i].datum_len) {
702 free(ptr);
703 goto still_abbrev;
704 }
705
706 sum_init(checksum_seed);
707 sum_update(ptr, len);
708 sum_end(sum);
709 if (memcmp(sum, rxas[i].datum + 1, MAX_DIGEST_LEN) != 0) {
710 free(ptr);
711 goto still_abbrev;
712 }
713
714 if (fname == fnamecmp)
715 ; /* Value is already set when identical */
716 else if (sys_lsetxattr(fname, name, ptr, len) < 0) {
717 rsyserr(FERROR, errno,
718 "rsync_xal_set: lsetxattr(\"%s\",\"%s\") failed",
719 fname, name);
720 ret = -1;
721 } else /* make sure caller sets mtime */
722 sxp->st.st_mtime = (time_t)-1;
723
724 if (am_generator) { /* generator items stay abbreviated */
725 if (rxas[i].datum[0] == XSTATE_ABBREV)
726 rxas[i].datum[0] = XSTATE_LOCAL;
727 free(ptr);
728 continue;
729 }
730
731 memcpy(ptr + len, name, name_len);
732 free(rxas[i].datum);
733
734 rxas[i].name = name = ptr + len;
735 rxas[i].datum = ptr;
736 continue;
737 }
738
739 if (sys_lsetxattr(fname, name, rxas[i].datum, rxas[i].datum_len) < 0) {
740 rsyserr(FERROR, errno,
741 "rsync_xal_set: lsetxattr(\"%s\",\"%s\") failed",
742 fname, name);
743 ret = -1;
744 } else /* make sure caller sets mtime */
745 sxp->st.st_mtime = (time_t)-1;
746 }
747
748 /* Remove any extraneous names. */
749 for (name = namebuf; list_len > 0; name += name_len) {
750 name_len = strlen(name) + 1;
751 list_len -= name_len;
752
753#ifdef HAVE_LINUX_XATTRS
754 /* We always ignore the system namespace, and non-root
755 * ignores everything but the user namespace. */
756 if (am_root ? HAS_PREFIX(name, SYSTEM_PREFIX)
757 : !HAS_PREFIX(name, USER_PREFIX))
758 continue;
759#endif
760
761 for (i = 0; i < xalp->count; i++) {
762 if (strcmp(name, rxas[i].name) == 0)
763 break;
764 }
765 if (i == xalp->count) {
766 if (sys_lremovexattr(fname, name) < 0) {
767 rsyserr(FERROR, errno,
768 "rsync_xal_clear: lremovexattr(\"%s\",\"%s\") failed",
769 fname, name);
770 ret = -1;
771 } else /* make sure caller sets mtime */
772 sxp->st.st_mtime = (time_t)-1;
773 }
774 }
775
776 return ret;
777}
778
779/* Set extended attributes on indicated filename. */
780int set_xattr(const char *fname, const struct file_struct *file,
781 const char *fnamecmp, statx *sxp)
782{
783 int ndx;
784 item_list *lst = rsync_xal_l.items;
785
786 if (dry_run)
787 return 1; /* FIXME: --dry-run needs to compute this value */
788
789 if (read_only || list_only) {
790 errno = EROFS;
791 return -1;
792 }
793
794 ndx = F_XATTR(file);
795 return rsync_xal_set(fname, lst + ndx, fnamecmp, sxp);
796}
797
9439c0cb
WD
798int get_stat_xattr(const char *fname, int fd, STRUCT_STAT *fst, STRUCT_STAT *xst)
799{
800 int mode, rdev_major, rdev_minor, uid, gid, len;
801 char buf[256];
802
803 if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
804 return -1;
805
806 if (xst)
807 *xst = *fst;
808 else
809 xst = fst;
810 if (fname) {
811 fd = -1;
812 len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
813 } else {
814 fname = "fd";
815 len = sys_fgetxattr(fd, XSTAT_ATTR, buf, sizeof buf - 1);
816 }
817 if (len >= (int)sizeof buf) {
818 len = -1;
819 errno = ERANGE;
820 }
821 if (len < 0) {
822 if (errno == ENOTSUP || errno == ENOATTR)
823 return -1;
824 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
825 xst->st_uid = 0;
826 xst->st_gid = 0;
827 return 0;
828 }
829 rsyserr(FERROR, errno, "failed to read xattr %s for %s",
830 XSTAT_ATTR, full_fname(fname));
831 return -1;
832 }
833 buf[len] = '\0';
834
835 if (sscanf(buf, "%o %d,%d %d:%d",
836 &mode, &rdev_major, &rdev_minor, &uid, &gid) != 5) {
837 rprintf(FERROR, "Corrupt %s xattr attached to %s: \"%s\"\n",
838 XSTAT_ATTR, full_fname(fname), buf);
839 exit_cleanup(RERR_FILEIO);
840 }
841
842 xst->st_mode = from_wire_mode(mode);
843 xst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
844 xst->st_uid = uid;
845 xst->st_gid = gid;
846
847 return 0;
848}
849
850int set_stat_xattr(const char *fname, struct file_struct *file)
851{
852 STRUCT_STAT fst, xst;
853 dev_t rdev;
854 mode_t mode, fmode;
855
856 if (dry_run)
857 return 0;
858
859 if (read_only || list_only) {
860 rsyserr(FERROR, EROFS, "failed to write xattr %s for %s",
861 XSTAT_ATTR, full_fname(fname));
862 return -1;
863 }
864
865 if (x_lstat(fname, &fst, &xst) < 0) {
866 rsyserr(FERROR, errno, "failed to re-stat %s",
867 full_fname(fname));
868 return -1;
869 }
870
871 fst.st_mode &= (_S_IFMT | CHMOD_BITS);
872 fmode = file->mode & (_S_IFMT | CHMOD_BITS);
873
874 if (IS_DEVICE(fmode) || IS_SPECIAL(fmode)) {
875 uint32 *devp = F_RDEV_P(file);
876 rdev = MAKEDEV(DEV_MAJOR(devp), DEV_MINOR(devp));
877 } else
878 rdev = 0;
879
880 /* Dump the special permissions and enable full owner access. */
881 mode = (fst.st_mode & _S_IFMT) | (fmode & ACCESSPERMS)
882 | (S_ISDIR(fst.st_mode) ? 0700 : 0600);
883 if (fst.st_mode != mode)
884 do_chmod(fname, mode);
885 if (!IS_DEVICE(fst.st_mode) && !IS_SPECIAL(fst.st_mode))
886 fst.st_rdev = 0; /* just in case */
887
888 if (mode == fmode && fst.st_rdev == rdev
889 && fst.st_uid == F_UID(file) && fst.st_gid == F_GID(file)) {
890 /* xst.st_mode will be 0 if there's no current stat xattr */
891 if (xst.st_mode && sys_lremovexattr(fname, XSTAT_ATTR) < 0) {
892 rsyserr(FERROR, errno,
893 "delete of stat xattr failed for %s",
894 full_fname(fname));
895 return -1;
896 }
897 return 0;
898 }
899
900 if (xst.st_mode != fmode || xst.st_rdev != rdev
901 || xst.st_uid != F_UID(file) || xst.st_gid != F_GID(file)) {
902 char buf[256];
903 int len = snprintf(buf, sizeof buf, "%o %u,%u %u:%u",
904 to_wire_mode(fmode),
905 (int)major(rdev), (int)minor(rdev),
906 (int)F_UID(file), (int)F_GID(file));
907 if (sys_lsetxattr(fname, XSTAT_ATTR, buf, len) < 0) {
908 if (errno == EPERM && S_ISLNK(fst.st_mode))
909 return 0;
910 rsyserr(FERROR, errno,
911 "failed to write xattr %s for %s",
912 XSTAT_ATTR, full_fname(fname));
913 return -1;
914 }
915 }
916
917 return 0;
918}
919
920int x_stat(const char *fname, STRUCT_STAT *fst, STRUCT_STAT *xst)
921{
922 int ret = do_stat(fname, fst);
923 if ((ret < 0 || get_stat_xattr(fname, -1, fst, xst) < 0) && xst)
924 xst->st_mode = 0;
925 return ret;
926}
927
928int x_lstat(const char *fname, STRUCT_STAT *fst, STRUCT_STAT *xst)
929{
930 int ret = do_lstat(fname, fst);
931 if ((ret < 0 || get_stat_xattr(fname, -1, fst, xst) < 0) && xst)
932 xst->st_mode = 0;
933 return ret;
934}
935
936int x_fstat(int fd, STRUCT_STAT *fst, STRUCT_STAT *xst)
937{
938 int ret = do_fstat(fd, fst);
939 if ((ret < 0 || get_stat_xattr(NULL, fd, fst, xst) < 0) && xst)
940 xst->st_mode = 0;
941 return ret;
942}
943
16edf865 944#endif /* SUPPORT_XATTRS */