Silence gcc7.1 warnings about snprintf().
[rsync.git] / acls.c
blob02bfe366172dc9727810d690b80392adb1bee7e3
1 /*
2 * Handle passing Access Control Lists between systems.
4 * Copyright (C) 1996 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2006-2020 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 "lib/sysacls.h"
25 #ifdef SUPPORT_ACLS
27 extern int dry_run;
28 extern int am_root;
29 extern int read_only;
30 extern int list_only;
31 extern int orig_umask;
32 extern int numeric_ids;
33 extern int inc_recurse;
34 extern int preserve_devices;
35 extern int preserve_specials;
37 /* Flags used to indicate what items are being transmitted for an entry. */
38 #define XMIT_USER_OBJ (1<<0)
39 #define XMIT_GROUP_OBJ (1<<1)
40 #define XMIT_MASK_OBJ (1<<2)
41 #define XMIT_OTHER_OBJ (1<<3)
42 #define XMIT_NAME_LIST (1<<4)
44 #define NO_ENTRY ((uchar)0x80) /* Default value of a NON-name-list entry. */
46 #define NAME_IS_USER (1u<<31) /* Bit used only on a name-list entry. */
48 /* When we send the access bits over the wire, we shift them 2 bits to the
49 * left and use the lower 2 bits as flags (relevant only to a name entry).
50 * This makes the protocol more efficient than sending a value that would
51 * be likely to have its highest bits set. */
52 #define XFLAG_NAME_FOLLOWS 0x0001u
53 #define XFLAG_NAME_IS_USER 0x0002u
55 /* === ACL structures === */
57 typedef struct {
58 id_t id;
59 uint32 access;
60 } id_access;
62 typedef struct {
63 id_access *idas;
64 int count;
65 } ida_entries;
67 typedef struct {
68 char *name;
69 uchar len;
70 } idname;
72 typedef struct rsync_acl {
73 ida_entries names;
74 /* These will be NO_ENTRY if there's no such entry. */
75 uchar user_obj;
76 uchar group_obj;
77 uchar mask_obj;
78 uchar other_obj;
79 } rsync_acl;
81 typedef struct {
82 rsync_acl racl;
83 SMB_ACL_T sacl;
84 } acl_duo;
86 static const rsync_acl empty_rsync_acl = {
87 {NULL, 0}, NO_ENTRY, NO_ENTRY, NO_ENTRY, NO_ENTRY
90 static item_list access_acl_list = EMPTY_ITEM_LIST;
91 static item_list default_acl_list = EMPTY_ITEM_LIST;
93 static size_t prior_access_count = (size_t)-1;
94 static size_t prior_default_count = (size_t)-1;
96 /* === Calculations on ACL types === */
98 static const char *str_acl_type(SMB_ACL_TYPE_T type)
100 switch (type) {
101 case SMB_ACL_TYPE_ACCESS:
102 #ifdef HAVE_OSX_ACLS
103 return "ACL_TYPE_EXTENDED";
104 #else
105 return "ACL_TYPE_ACCESS";
106 #endif
107 case SMB_ACL_TYPE_DEFAULT:
108 return "ACL_TYPE_DEFAULT";
109 default:
110 break;
112 return "unknown ACL type!";
115 static int calc_sacl_entries(const rsync_acl *racl)
117 /* A System ACL always gets user/group/other permission entries. */
118 return racl->names.count
119 #ifdef ACLS_NEED_MASK
121 #else
122 + (racl->mask_obj != NO_ENTRY)
123 #endif
124 + 3;
127 /* Extracts and returns the permission bits from the ACL. This cannot be
128 * called on an rsync_acl that has NO_ENTRY in any spot but the mask. */
129 static int rsync_acl_get_perms(const rsync_acl *racl)
131 return (racl->user_obj << 6)
132 + ((racl->mask_obj != NO_ENTRY ? racl->mask_obj : racl->group_obj) << 3)
133 + racl->other_obj;
136 /* Removes the permission-bit entries from the ACL because these
137 * can be reconstructed from the file's mode. */
138 static void rsync_acl_strip_perms(stat_x *sxp)
140 rsync_acl *racl = sxp->acc_acl;
142 racl->user_obj = NO_ENTRY;
143 if (racl->mask_obj == NO_ENTRY)
144 racl->group_obj = NO_ENTRY;
145 else {
146 int group_perms = (sxp->st.st_mode >> 3) & 7;
147 if (racl->group_obj == group_perms)
148 racl->group_obj = NO_ENTRY;
149 #ifndef HAVE_SOLARIS_ACLS
150 if (racl->names.count != 0 && racl->mask_obj == group_perms)
151 racl->mask_obj = NO_ENTRY;
152 #endif
154 racl->other_obj = NO_ENTRY;
157 /* Given an empty rsync_acl, fake up the permission bits. */
158 static void rsync_acl_fake_perms(rsync_acl *racl, mode_t mode)
160 racl->user_obj = (mode >> 6) & 7;
161 racl->group_obj = (mode >> 3) & 7;
162 racl->other_obj = mode & 7;
165 /* === Rsync ACL functions === */
167 static rsync_acl *create_racl(void)
169 rsync_acl *racl = new(rsync_acl);
171 if (!racl)
172 out_of_memory("create_racl");
173 *racl = empty_rsync_acl;
175 return racl;
178 static BOOL ida_entries_equal(const ida_entries *ial1, const ida_entries *ial2)
180 id_access *ida1, *ida2;
181 int count = ial1->count;
182 if (count != ial2->count)
183 return False;
184 ida1 = ial1->idas;
185 ida2 = ial2->idas;
186 for (; count--; ida1++, ida2++) {
187 if (ida1->access != ida2->access || ida1->id != ida2->id)
188 return False;
190 return True;
193 static BOOL rsync_acl_equal(const rsync_acl *racl1, const rsync_acl *racl2)
195 return racl1->user_obj == racl2->user_obj
196 && racl1->group_obj == racl2->group_obj
197 && racl1->mask_obj == racl2->mask_obj
198 && racl1->other_obj == racl2->other_obj
199 && ida_entries_equal(&racl1->names, &racl2->names);
202 /* Are the extended (non-permission-bit) entries equal? If so, the rest of
203 * the ACL will be handled by the normal mode-preservation code. This is
204 * only meaningful for access ACLs! Note: the 1st arg is a fully-populated
205 * rsync_acl, but the 2nd parameter can be a condensed rsync_acl, which means
206 * that it might have several of its permission objects set to NO_ENTRY. */
207 static BOOL rsync_acl_equal_enough(const rsync_acl *racl1,
208 const rsync_acl *racl2, mode_t m)
210 if ((racl1->mask_obj ^ racl2->mask_obj) & NO_ENTRY)
211 return False; /* One has a mask and the other doesn't */
213 /* When there's a mask, the group_obj becomes an extended entry. */
214 if (racl1->mask_obj != NO_ENTRY) {
215 /* A condensed rsync_acl with a mask can only have no
216 * group_obj when it was identical to the mask. This
217 * means that it was also identical to the group attrs
218 * from the mode. */
219 if (racl2->group_obj == NO_ENTRY) {
220 if (racl1->group_obj != ((m >> 3) & 7))
221 return False;
222 } else if (racl1->group_obj != racl2->group_obj)
223 return False;
225 return ida_entries_equal(&racl1->names, &racl2->names);
228 static void rsync_acl_free(rsync_acl *racl)
230 if (racl->names.idas)
231 free(racl->names.idas);
232 *racl = empty_rsync_acl;
235 void free_acl(stat_x *sxp)
237 if (sxp->acc_acl) {
238 rsync_acl_free(sxp->acc_acl);
239 free(sxp->acc_acl);
240 sxp->acc_acl = NULL;
242 if (sxp->def_acl) {
243 rsync_acl_free(sxp->def_acl);
244 free(sxp->def_acl);
245 sxp->def_acl = NULL;
249 #ifdef SMB_ACL_NEED_SORT
250 static int id_access_sorter(const void *r1, const void *r2)
252 id_access *ida1 = (id_access *)r1;
253 id_access *ida2 = (id_access *)r2;
254 id_t rid1 = ida1->id, rid2 = ida2->id;
255 if ((ida1->access ^ ida2->access) & NAME_IS_USER)
256 return ida1->access & NAME_IS_USER ? -1 : 1;
257 return rid1 == rid2 ? 0 : rid1 < rid2 ? -1 : 1;
259 #endif
261 /* === System ACLs === */
263 /* Unpack system ACL -> rsync ACL verbatim. Return whether we succeeded. */
264 static BOOL unpack_smb_acl(SMB_ACL_T sacl, rsync_acl *racl)
266 static item_list temp_ida_list = EMPTY_ITEM_LIST;
267 SMB_ACL_ENTRY_T entry;
268 const char *errfun;
269 int rc;
271 errfun = "sys_acl_get_entry";
272 for (rc = sys_acl_get_entry(sacl, SMB_ACL_FIRST_ENTRY, &entry);
273 rc == 1;
274 rc = sys_acl_get_entry(sacl, SMB_ACL_NEXT_ENTRY, &entry)) {
275 SMB_ACL_TAG_T tag_type;
276 uint32 access;
277 id_t g_u_id;
278 id_access *ida;
279 if ((rc = sys_acl_get_info(entry, &tag_type, &access, &g_u_id)) != 0) {
280 errfun = "sys_acl_get_info";
281 break;
283 /* continue == done with entry; break == store in temporary ida list */
284 switch (tag_type) {
285 #ifndef HAVE_OSX_ACLS
286 case SMB_ACL_USER_OBJ:
287 if (racl->user_obj == NO_ENTRY)
288 racl->user_obj = access;
289 else
290 rprintf(FINFO, "unpack_smb_acl: warning: duplicate USER_OBJ entry ignored\n");
291 continue;
292 case SMB_ACL_GROUP_OBJ:
293 if (racl->group_obj == NO_ENTRY)
294 racl->group_obj = access;
295 else
296 rprintf(FINFO, "unpack_smb_acl: warning: duplicate GROUP_OBJ entry ignored\n");
297 continue;
298 case SMB_ACL_MASK:
299 if (racl->mask_obj == NO_ENTRY)
300 racl->mask_obj = access;
301 else
302 rprintf(FINFO, "unpack_smb_acl: warning: duplicate MASK entry ignored\n");
303 continue;
304 case SMB_ACL_OTHER:
305 if (racl->other_obj == NO_ENTRY)
306 racl->other_obj = access;
307 else
308 rprintf(FINFO, "unpack_smb_acl: warning: duplicate OTHER entry ignored\n");
309 continue;
310 #endif
311 case SMB_ACL_USER:
312 access |= NAME_IS_USER;
313 break;
314 case SMB_ACL_GROUP:
315 break;
316 default:
317 rprintf(FINFO, "unpack_smb_acl: warning: entry with unrecognized tag type ignored\n");
318 continue;
320 ida = EXPAND_ITEM_LIST(&temp_ida_list, id_access, -10);
321 ida->id = g_u_id;
322 ida->access = access;
324 if (rc) {
325 rsyserr(FERROR_XFER, errno, "unpack_smb_acl: %s()", errfun);
326 rsync_acl_free(racl);
327 return False;
330 /* Transfer the count id_access items out of the temp_ida_list
331 * into the names ida_entries list in racl. */
332 if (temp_ida_list.count) {
333 #ifdef SMB_ACL_NEED_SORT
334 if (temp_ida_list.count > 1) {
335 qsort(temp_ida_list.items, temp_ida_list.count,
336 sizeof (id_access), id_access_sorter);
338 #endif
339 if (!(racl->names.idas = new_array(id_access, temp_ida_list.count)))
340 out_of_memory("unpack_smb_acl");
341 memcpy(racl->names.idas, temp_ida_list.items,
342 temp_ida_list.count * sizeof (id_access));
343 } else
344 racl->names.idas = NULL;
346 racl->names.count = temp_ida_list.count;
348 /* Truncate the temporary list now that its idas have been saved. */
349 temp_ida_list.count = 0;
351 return True;
354 /* Synactic sugar for system calls */
356 #define CALL_OR_ERROR(func,args,str) \
357 do { \
358 if (func args) { \
359 errfun = str; \
360 goto error_exit; \
362 } while (0)
364 #define COE(func,args) CALL_OR_ERROR(func,args,#func)
365 #define COE2(func,args) CALL_OR_ERROR(func,args,NULL)
367 #ifndef HAVE_OSX_ACLS
368 /* Store the permissions in the system ACL entry. */
369 static int store_access_in_entry(uint32 access, SMB_ACL_ENTRY_T entry)
371 if (sys_acl_set_access_bits(entry, access)) {
372 rsyserr(FERROR_XFER, errno, "store_access_in_entry sys_acl_set_access_bits()");
373 return -1;
375 return 0;
377 #endif
379 /* Pack rsync ACL -> system ACL verbatim. Return whether we succeeded. */
380 static BOOL pack_smb_acl(SMB_ACL_T *smb_acl, const rsync_acl *racl)
382 #ifdef ACLS_NEED_MASK
383 uchar mask_bits;
384 #endif
385 size_t count;
386 id_access *ida;
387 const char *errfun = NULL;
388 SMB_ACL_ENTRY_T entry;
390 if (!(*smb_acl = sys_acl_init(calc_sacl_entries(racl)))) {
391 rsyserr(FERROR_XFER, errno, "pack_smb_acl: sys_acl_init()");
392 return False;
395 #ifndef HAVE_OSX_ACLS
396 COE( sys_acl_create_entry,(smb_acl, &entry) );
397 COE( sys_acl_set_info,(entry, SMB_ACL_USER_OBJ, racl->user_obj & ~NO_ENTRY, 0) );
398 #endif
400 for (ida = racl->names.idas, count = racl->names.count; count; ida++, count--) {
401 #ifdef SMB_ACL_NEED_SORT
402 if (!(ida->access & NAME_IS_USER))
403 break;
404 #endif
405 COE( sys_acl_create_entry,(smb_acl, &entry) );
406 COE( sys_acl_set_info,
407 (entry,
408 ida->access & NAME_IS_USER ? SMB_ACL_USER : SMB_ACL_GROUP,
409 ida->access & ~NAME_IS_USER, ida->id) );
412 #ifndef HAVE_OSX_ACLS
413 COE( sys_acl_create_entry,(smb_acl, &entry) );
414 COE( sys_acl_set_info,(entry, SMB_ACL_GROUP_OBJ, racl->group_obj & ~NO_ENTRY, 0) );
416 #ifdef SMB_ACL_NEED_SORT
417 for ( ; count; ida++, count--) {
418 COE( sys_acl_create_entry,(smb_acl, &entry) );
419 COE( sys_acl_set_info,(entry, SMB_ACL_GROUP, ida->access, ida->id) );
421 #endif
423 #ifdef ACLS_NEED_MASK
424 mask_bits = racl->mask_obj == NO_ENTRY ? racl->group_obj & ~NO_ENTRY : racl->mask_obj;
425 COE( sys_acl_create_entry,(smb_acl, &entry) );
426 COE( sys_acl_set_info,(entry, SMB_ACL_MASK, mask_bits, 0) );
427 #else
428 if (racl->mask_obj != NO_ENTRY) {
429 COE( sys_acl_create_entry,(smb_acl, &entry) );
430 COE( sys_acl_set_info,(entry, SMB_ACL_MASK, racl->mask_obj, 0) );
432 #endif
434 COE( sys_acl_create_entry,(smb_acl, &entry) );
435 COE( sys_acl_set_info,(entry, SMB_ACL_OTHER, racl->other_obj & ~NO_ENTRY, 0) );
436 #endif
438 #ifdef DEBUG
439 if (sys_acl_valid(*smb_acl) < 0)
440 rprintf(FERROR_XFER, "pack_smb_acl: warning: system says the ACL I packed is invalid\n");
441 #endif
443 return True;
445 error_exit:
446 if (errfun) {
447 rsyserr(FERROR_XFER, errno, "pack_smb_acl %s()", errfun);
449 sys_acl_free_acl(*smb_acl);
450 return False;
453 static int find_matching_rsync_acl(const rsync_acl *racl, SMB_ACL_TYPE_T type,
454 const item_list *racl_list)
456 static int access_match = -1, default_match = -1;
457 int *match = type == SMB_ACL_TYPE_ACCESS ? &access_match : &default_match;
458 size_t count = racl_list->count;
460 /* If this is the first time through or we didn't match the last
461 * time, then start at the end of the list, which should be the
462 * best place to start hunting. */
463 if (*match == -1)
464 *match = racl_list->count - 1;
465 while (count--) {
466 rsync_acl *base = racl_list->items;
467 if (rsync_acl_equal(base + *match, racl))
468 return *match;
469 if (!(*match)--)
470 *match = racl_list->count - 1;
473 *match = -1;
474 return *match;
477 static int get_rsync_acl(const char *fname, rsync_acl *racl,
478 SMB_ACL_TYPE_T type, mode_t mode)
480 SMB_ACL_T sacl;
482 #ifdef SUPPORT_XATTRS
483 /* --fake-super support: load ACLs from an xattr. */
484 if (am_root < 0) {
485 char *buf;
486 size_t len;
487 int cnt;
489 if ((buf = get_xattr_acl(fname, type == SMB_ACL_TYPE_ACCESS, &len)) == NULL)
490 return 0;
491 cnt = (len - 4*4) / (4+4);
492 if (len < 4*4 || len != (size_t)cnt*(4+4) + 4*4) {
493 free(buf);
494 return -1;
497 racl->user_obj = IVAL(buf, 0);
498 if (racl->user_obj == NO_ENTRY)
499 racl->user_obj = (mode >> 6) & 7;
500 racl->group_obj = IVAL(buf, 4);
501 if (racl->group_obj == NO_ENTRY)
502 racl->group_obj = (mode >> 3) & 7;
503 racl->mask_obj = IVAL(buf, 8);
504 racl->other_obj = IVAL(buf, 12);
505 if (racl->other_obj == NO_ENTRY)
506 racl->other_obj = mode & 7;
508 if (cnt) {
509 char *bp = buf + 4*4;
510 id_access *ida;
511 if (!(ida = racl->names.idas = new_array(id_access, cnt)))
512 out_of_memory("get_rsync_acl");
513 racl->names.count = cnt;
514 for ( ; cnt--; ida++, bp += 4+4) {
515 ida->id = IVAL(bp, 0);
516 ida->access = IVAL(bp, 4);
519 free(buf);
520 return 0;
522 #endif
524 if ((sacl = sys_acl_get_file(fname, type)) != 0) {
525 BOOL ok = unpack_smb_acl(sacl, racl);
527 sys_acl_free_acl(sacl);
528 if (!ok) {
529 return -1;
531 } else if (no_acl_syscall_error(errno)) {
532 /* ACLs are not supported, so pretend we have a basic ACL. */
533 if (type == SMB_ACL_TYPE_ACCESS)
534 rsync_acl_fake_perms(racl, mode);
535 } else {
536 rsyserr(FERROR_XFER, errno, "get_acl: sys_acl_get_file(%s, %s)",
537 fname, str_acl_type(type));
538 return -1;
541 return 0;
544 /* Return the Access Control List for the given filename. */
545 int get_acl(const char *fname, stat_x *sxp)
547 sxp->acc_acl = create_racl();
549 if (S_ISREG(sxp->st.st_mode) || S_ISDIR(sxp->st.st_mode)) {
550 /* Everyone supports this. */
551 } else if (S_ISLNK(sxp->st.st_mode)) {
552 return 0;
553 } else if (IS_SPECIAL(sxp->st.st_mode)) {
554 #ifndef NO_SPECIAL_ACLS
555 if (!preserve_specials)
556 #endif
557 return 0;
558 } else if (IS_DEVICE(sxp->st.st_mode)) {
559 #ifndef NO_DEVICE_ACLS
560 if (!preserve_devices)
561 #endif
562 return 0;
563 } else if (IS_MISSING_FILE(sxp->st))
564 return 0;
566 if (get_rsync_acl(fname, sxp->acc_acl, SMB_ACL_TYPE_ACCESS,
567 sxp->st.st_mode) < 0) {
568 free_acl(sxp);
569 return -1;
572 if (S_ISDIR(sxp->st.st_mode)) {
573 sxp->def_acl = create_racl();
574 if (get_rsync_acl(fname, sxp->def_acl, SMB_ACL_TYPE_DEFAULT,
575 sxp->st.st_mode) < 0) {
576 free_acl(sxp);
577 return -1;
581 return 0;
584 /* === Send functions === */
586 /* Send the ida list over the file descriptor. */
587 static void send_ida_entries(int f, const ida_entries *idal)
589 id_access *ida;
590 size_t count = idal->count;
592 write_varint(f, idal->count);
594 for (ida = idal->idas; count--; ida++) {
595 uint32 xbits = ida->access << 2;
596 const char *name;
597 if (ida->access & NAME_IS_USER) {
598 xbits |= XFLAG_NAME_IS_USER;
599 name = numeric_ids ? NULL : add_uid(ida->id);
600 } else
601 name = numeric_ids ? NULL : add_gid(ida->id);
602 write_varint(f, ida->id);
603 if (inc_recurse && name) {
604 int len = strlen(name);
605 write_varint(f, xbits | XFLAG_NAME_FOLLOWS);
606 write_byte(f, len);
607 write_buf(f, name, len);
608 } else
609 write_varint(f, xbits);
613 static void send_rsync_acl(int f, rsync_acl *racl, SMB_ACL_TYPE_T type,
614 item_list *racl_list)
616 int ndx = find_matching_rsync_acl(racl, type, racl_list);
618 /* Send 0 (-1 + 1) to indicate that literal ACL data follows. */
619 write_varint(f, ndx + 1);
621 if (ndx < 0) {
622 rsync_acl *new_racl = EXPAND_ITEM_LIST(racl_list, rsync_acl, 1000);
623 uchar flags = 0;
625 if (racl->user_obj != NO_ENTRY)
626 flags |= XMIT_USER_OBJ;
627 if (racl->group_obj != NO_ENTRY)
628 flags |= XMIT_GROUP_OBJ;
629 if (racl->mask_obj != NO_ENTRY)
630 flags |= XMIT_MASK_OBJ;
631 if (racl->other_obj != NO_ENTRY)
632 flags |= XMIT_OTHER_OBJ;
633 if (racl->names.count)
634 flags |= XMIT_NAME_LIST;
636 write_byte(f, flags);
638 if (flags & XMIT_USER_OBJ)
639 write_varint(f, racl->user_obj);
640 if (flags & XMIT_GROUP_OBJ)
641 write_varint(f, racl->group_obj);
642 if (flags & XMIT_MASK_OBJ)
643 write_varint(f, racl->mask_obj);
644 if (flags & XMIT_OTHER_OBJ)
645 write_varint(f, racl->other_obj);
646 if (flags & XMIT_NAME_LIST)
647 send_ida_entries(f, &racl->names);
649 /* Give the allocated data to the new list object. */
650 *new_racl = *racl;
651 *racl = empty_rsync_acl;
655 /* Send the ACL from the stat_x structure down the indicated file descriptor.
656 * This also frees the ACL data. */
657 void send_acl(int f, stat_x *sxp)
659 if (!sxp->acc_acl) {
660 sxp->acc_acl = create_racl();
661 rsync_acl_fake_perms(sxp->acc_acl, sxp->st.st_mode);
663 /* Avoid sending values that can be inferred from other data. */
664 rsync_acl_strip_perms(sxp);
666 send_rsync_acl(f, sxp->acc_acl, SMB_ACL_TYPE_ACCESS, &access_acl_list);
668 if (S_ISDIR(sxp->st.st_mode)) {
669 if (!sxp->def_acl)
670 sxp->def_acl = create_racl();
672 send_rsync_acl(f, sxp->def_acl, SMB_ACL_TYPE_DEFAULT, &default_acl_list);
676 /* === Receive functions === */
678 static uint32 recv_acl_access(int f, uchar *name_follows_ptr)
680 uint32 access = read_varint(f);
682 if (name_follows_ptr) {
683 int flags = access & 3;
684 access >>= 2;
685 if (am_root >= 0 && access & ~SMB_ACL_VALID_NAME_BITS)
686 goto value_error;
687 if (flags & XFLAG_NAME_FOLLOWS)
688 *name_follows_ptr = 1;
689 else
690 *name_follows_ptr = 0;
691 if (flags & XFLAG_NAME_IS_USER)
692 access |= NAME_IS_USER;
693 } else if (am_root >= 0 && access & ~SMB_ACL_VALID_OBJ_BITS) {
694 value_error:
695 rprintf(FERROR_XFER, "recv_acl_access: value out of range: %x\n",
696 access);
697 exit_cleanup(RERR_STREAMIO);
700 return access;
703 static uchar recv_ida_entries(int f, ida_entries *ent)
705 uchar computed_mask_bits = 0;
706 int i, count = read_varint(f);
708 if (count) {
709 if (!(ent->idas = new_array(id_access, count)))
710 out_of_memory("recv_ida_entries");
711 } else
712 ent->idas = NULL;
714 ent->count = count;
716 for (i = 0; i < count; i++) {
717 uchar has_name;
718 id_t id = read_varint(f);
719 uint32 access = recv_acl_access(f, &has_name);
721 if (has_name) {
722 if (access & NAME_IS_USER)
723 id = recv_user_name(f, id);
724 else
725 id = recv_group_name(f, id, NULL);
726 } else if (access & NAME_IS_USER) {
727 if (inc_recurse && am_root && !numeric_ids)
728 id = match_uid(id);
729 } else {
730 if (inc_recurse && (!am_root || !numeric_ids))
731 id = match_gid(id, NULL);
734 ent->idas[i].id = id;
735 ent->idas[i].access = access;
736 computed_mask_bits |= access;
739 return computed_mask_bits & ~NO_ENTRY;
742 static int recv_rsync_acl(int f, item_list *racl_list, SMB_ACL_TYPE_T type, mode_t mode)
744 uchar computed_mask_bits = 0;
745 acl_duo *duo_item;
746 uchar flags;
747 int ndx = read_varint(f);
749 if (ndx < 0 || (size_t)ndx > racl_list->count) {
750 rprintf(FERROR_XFER, "recv_acl_index: %s ACL index %d > %d\n",
751 str_acl_type(type), ndx, (int)racl_list->count);
752 exit_cleanup(RERR_STREAMIO);
755 if (ndx != 0)
756 return ndx - 1;
758 ndx = racl_list->count;
759 duo_item = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
760 duo_item->racl = empty_rsync_acl;
762 flags = read_byte(f);
764 if (flags & XMIT_USER_OBJ)
765 duo_item->racl.user_obj = recv_acl_access(f, NULL);
766 if (flags & XMIT_GROUP_OBJ)
767 duo_item->racl.group_obj = recv_acl_access(f, NULL);
768 if (flags & XMIT_MASK_OBJ)
769 duo_item->racl.mask_obj = recv_acl_access(f, NULL);
770 if (flags & XMIT_OTHER_OBJ)
771 duo_item->racl.other_obj = recv_acl_access(f, NULL);
772 if (flags & XMIT_NAME_LIST)
773 computed_mask_bits |= recv_ida_entries(f, &duo_item->racl.names);
775 #ifdef HAVE_OSX_ACLS
776 /* If we received a superfluous mask, throw it away. */
777 duo_item->racl.mask_obj = NO_ENTRY;
778 #else
779 if (duo_item->racl.names.count && duo_item->racl.mask_obj == NO_ENTRY) {
780 /* Mask must be non-empty with lists. */
781 if (type == SMB_ACL_TYPE_ACCESS)
782 computed_mask_bits = (mode >> 3) & 7;
783 else
784 computed_mask_bits |= duo_item->racl.group_obj & ~NO_ENTRY;
785 duo_item->racl.mask_obj = computed_mask_bits;
787 #endif
789 duo_item->sacl = NULL;
791 return ndx;
794 /* Receive the ACL info the sender has included for this file-list entry. */
795 void receive_acl(int f, struct file_struct *file)
797 F_ACL(file) = recv_rsync_acl(f, &access_acl_list, SMB_ACL_TYPE_ACCESS, file->mode);
799 if (S_ISDIR(file->mode))
800 F_DIR_DEFACL(file) = recv_rsync_acl(f, &default_acl_list, SMB_ACL_TYPE_DEFAULT, 0);
803 static int cache_rsync_acl(rsync_acl *racl, SMB_ACL_TYPE_T type, item_list *racl_list)
805 int ndx;
807 if (!racl)
808 ndx = -1;
809 else if ((ndx = find_matching_rsync_acl(racl, type, racl_list)) == -1) {
810 acl_duo *new_duo;
811 ndx = racl_list->count;
812 new_duo = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
813 new_duo->racl = *racl;
814 new_duo->sacl = NULL;
815 *racl = empty_rsync_acl;
818 return ndx;
821 /* Turn the ACL data in stat_x into cached ACL data, setting the index
822 * values in the file struct. */
823 void cache_tmp_acl(struct file_struct *file, stat_x *sxp)
825 if (prior_access_count == (size_t)-1)
826 prior_access_count = access_acl_list.count;
828 F_ACL(file) = cache_rsync_acl(sxp->acc_acl,
829 SMB_ACL_TYPE_ACCESS, &access_acl_list);
831 if (S_ISDIR(sxp->st.st_mode)) {
832 if (prior_default_count == (size_t)-1)
833 prior_default_count = default_acl_list.count;
834 F_DIR_DEFACL(file) = cache_rsync_acl(sxp->def_acl,
835 SMB_ACL_TYPE_DEFAULT, &default_acl_list);
839 static void uncache_duo_acls(item_list *duo_list, size_t start)
841 acl_duo *duo_item = duo_list->items;
842 acl_duo *duo_start = duo_item + start;
844 duo_item += duo_list->count;
845 duo_list->count = start;
847 while (duo_item-- > duo_start) {
848 rsync_acl_free(&duo_item->racl);
849 if (duo_item->sacl)
850 sys_acl_free_acl(duo_item->sacl);
854 void uncache_tmp_acls(void)
856 if (prior_access_count != (size_t)-1) {
857 uncache_duo_acls(&access_acl_list, prior_access_count);
858 prior_access_count = (size_t)-1;
861 if (prior_default_count != (size_t)-1) {
862 uncache_duo_acls(&default_acl_list, prior_default_count);
863 prior_default_count = (size_t)-1;
867 #ifndef HAVE_OSX_ACLS
868 static mode_t change_sacl_perms(SMB_ACL_T sacl, rsync_acl *racl, mode_t old_mode, mode_t mode)
870 SMB_ACL_ENTRY_T entry;
871 const char *errfun;
872 int rc;
874 if (S_ISDIR(mode)) {
875 /* If the sticky bit is going on, it's not safe to allow all
876 * the new ACL to go into effect before it gets set. */
877 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
878 if (mode & S_ISVTX)
879 mode &= ~0077;
880 #else
881 if (mode & S_ISVTX && !(old_mode & S_ISVTX))
882 mode &= ~0077;
883 } else {
884 /* If setuid or setgid is going off, it's not safe to allow all
885 * the new ACL to go into effect before they get cleared. */
886 if ((old_mode & S_ISUID && !(mode & S_ISUID))
887 || (old_mode & S_ISGID && !(mode & S_ISGID)))
888 mode &= ~0077;
889 #endif
892 errfun = "sys_acl_get_entry";
893 for (rc = sys_acl_get_entry(sacl, SMB_ACL_FIRST_ENTRY, &entry);
894 rc == 1;
895 rc = sys_acl_get_entry(sacl, SMB_ACL_NEXT_ENTRY, &entry)) {
896 SMB_ACL_TAG_T tag_type;
897 if ((rc = sys_acl_get_tag_type(entry, &tag_type)) != 0) {
898 errfun = "sys_acl_get_tag_type";
899 break;
901 switch (tag_type) {
902 case SMB_ACL_USER_OBJ:
903 COE2( store_access_in_entry,((mode >> 6) & 7, entry) );
904 break;
905 case SMB_ACL_GROUP_OBJ:
906 /* group is only empty when identical to group perms. */
907 if (racl->group_obj != NO_ENTRY)
908 break;
909 COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
910 break;
911 case SMB_ACL_MASK:
912 #ifndef HAVE_SOLARIS_ACLS
913 #ifndef ACLS_NEED_MASK
914 /* mask is only empty when we don't need it. */
915 if (racl->mask_obj == NO_ENTRY)
916 break;
917 #endif
918 COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
919 #endif
920 break;
921 case SMB_ACL_OTHER:
922 COE2( store_access_in_entry,(mode & 7, entry) );
923 break;
926 if (rc) {
927 error_exit:
928 if (errfun) {
929 rsyserr(FERROR_XFER, errno, "change_sacl_perms: %s()",
930 errfun);
932 return (mode_t)-1;
935 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
936 /* Ensure that chmod() will be called to restore any lost setid bits. */
937 if (old_mode & (S_ISUID | S_ISGID | S_ISVTX)
938 && BITS_EQUAL(old_mode, mode, CHMOD_BITS))
939 old_mode &= ~(S_ISUID | S_ISGID | S_ISVTX);
940 #endif
942 /* Return the mode of the file on disk, as we will set them. */
943 return (old_mode & ~ACCESSPERMS) | (mode & ACCESSPERMS);
945 #endif
947 static int set_rsync_acl(const char *fname, acl_duo *duo_item,
948 SMB_ACL_TYPE_T type, stat_x *sxp, mode_t mode)
950 if (type == SMB_ACL_TYPE_DEFAULT
951 && duo_item->racl.user_obj == NO_ENTRY) {
952 int rc;
953 #ifdef SUPPORT_XATTRS
954 /* --fake-super support: delete default ACL from xattrs. */
955 if (am_root < 0)
956 rc = del_def_xattr_acl(fname);
957 else
958 #endif
959 rc = sys_acl_delete_def_file(fname);
960 if (rc < 0) {
961 rsyserr(FERROR_XFER, errno, "set_acl: sys_acl_delete_def_file(%s)",
962 fname);
963 return -1;
965 #ifdef SUPPORT_XATTRS
966 } else if (am_root < 0) {
967 /* --fake-super support: store ACLs in an xattr. */
968 int cnt = duo_item->racl.names.count;
969 size_t len = 4*4 + cnt * (4+4);
970 char *buf = new_array(char, len);
971 int rc;
973 SIVAL(buf, 0, duo_item->racl.user_obj);
974 SIVAL(buf, 4, duo_item->racl.group_obj);
975 SIVAL(buf, 8, duo_item->racl.mask_obj);
976 SIVAL(buf, 12, duo_item->racl.other_obj);
978 if (cnt) {
979 char *bp = buf + 4*4;
980 id_access *ida = duo_item->racl.names.idas;
981 for ( ; cnt--; ida++, bp += 4+4) {
982 SIVAL(bp, 0, ida->id);
983 SIVAL(bp, 4, ida->access);
986 rc = set_xattr_acl(fname, type == SMB_ACL_TYPE_ACCESS, buf, len);
987 free(buf);
988 return rc;
989 #endif
990 } else {
991 mode_t cur_mode = sxp->st.st_mode;
992 if (!duo_item->sacl
993 && !pack_smb_acl(&duo_item->sacl, &duo_item->racl))
994 return -1;
995 #ifdef HAVE_OSX_ACLS
996 mode = 0; /* eliminate compiler warning */
997 #else
998 if (type == SMB_ACL_TYPE_ACCESS) {
999 cur_mode = change_sacl_perms(duo_item->sacl, &duo_item->racl,
1000 cur_mode, mode);
1001 if (cur_mode == (mode_t)-1)
1002 return 0;
1004 #endif
1005 if (sys_acl_set_file(fname, type, duo_item->sacl) < 0) {
1006 rsyserr(FERROR_XFER, errno, "set_acl: sys_acl_set_file(%s, %s)",
1007 fname, str_acl_type(type));
1008 return -1;
1010 if (type == SMB_ACL_TYPE_ACCESS)
1011 sxp->st.st_mode = cur_mode;
1014 return 0;
1017 /* Given a fname, this sets extended access ACL entries, the default ACL (for a
1018 * dir), and the regular mode bits on the file. Call this with fname set to
1019 * NULL to just check if the ACL is different.
1021 * If the ACL operation has a side-effect of changing the file's mode, the
1022 * sxp->st.st_mode value will be changed to match.
1024 * Returns 0 for an unchanged ACL, 1 for changed, -1 for failed. */
1025 int set_acl(const char *fname, const struct file_struct *file, stat_x *sxp, mode_t new_mode)
1027 int changed = 0;
1028 int32 ndx;
1029 BOOL eq;
1031 if (!dry_run && (read_only || list_only)) {
1032 errno = EROFS;
1033 return -1;
1036 ndx = F_ACL(file);
1037 if (ndx >= 0 && (size_t)ndx < access_acl_list.count) {
1038 acl_duo *duo_item = access_acl_list.items;
1039 duo_item += ndx;
1040 eq = sxp->acc_acl
1041 && rsync_acl_equal_enough(sxp->acc_acl, &duo_item->racl, new_mode);
1042 if (!eq) {
1043 changed = 1;
1044 if (!dry_run && fname
1045 && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_ACCESS,
1046 sxp, new_mode) < 0)
1047 return -1;
1051 if (!S_ISDIR(new_mode))
1052 return changed;
1054 ndx = F_DIR_DEFACL(file);
1055 if (ndx >= 0 && (size_t)ndx < default_acl_list.count) {
1056 acl_duo *duo_item = default_acl_list.items;
1057 duo_item += ndx;
1058 eq = sxp->def_acl && rsync_acl_equal(sxp->def_acl, &duo_item->racl);
1059 if (!eq) {
1060 changed = 1;
1061 if (!dry_run && fname
1062 && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_DEFAULT,
1063 sxp, new_mode) < 0)
1064 return -1;
1068 return changed;
1071 /* Non-incremental recursion needs to convert all the received IDs.
1072 * This is done in a single pass after receiving the whole file-list. */
1073 static void match_racl_ids(const item_list *racl_list)
1075 int list_cnt, name_cnt;
1076 acl_duo *duo_item = racl_list->items;
1077 for (list_cnt = racl_list->count; list_cnt--; duo_item++) {
1078 ida_entries *idal = &duo_item->racl.names;
1079 id_access *ida = idal->idas;
1080 for (name_cnt = idal->count; name_cnt--; ida++) {
1081 if (ida->access & NAME_IS_USER)
1082 ida->id = match_uid(ida->id);
1083 else
1084 ida->id = match_gid(ida->id, NULL);
1089 void match_acl_ids(void)
1091 match_racl_ids(&access_acl_list);
1092 match_racl_ids(&default_acl_list);
1095 /* This is used by dest_mode(). */
1096 int default_perms_for_dir(const char *dir)
1098 rsync_acl racl;
1099 SMB_ACL_T sacl;
1100 BOOL ok;
1101 int perms;
1103 if (dir == NULL)
1104 dir = ".";
1105 perms = ACCESSPERMS & ~orig_umask;
1106 /* Read the directory's default ACL. If it has none, this will successfully return an empty ACL. */
1107 sacl = sys_acl_get_file(dir, SMB_ACL_TYPE_DEFAULT);
1108 if (sacl == NULL) {
1109 /* Couldn't get an ACL. Darn. */
1110 switch (errno) {
1111 case EINVAL:
1112 /* If SMB_ACL_TYPE_DEFAULT isn't valid, then the ACLs must be non-POSIX. */
1113 break;
1114 #ifdef ENOTSUP
1115 case ENOTSUP:
1116 #endif
1117 case ENOSYS:
1118 /* No ACLs are available. */
1119 break;
1120 default:
1121 if (dry_run && errno == ENOENT) {
1122 /* We're doing a dry run, so the containing directory
1123 * wasn't actually created. Don't worry about it. */
1124 break;
1126 rprintf(FWARNING,
1127 "default_perms_for_dir: sys_acl_get_file(%s, %s): %s, falling back on umask\n",
1128 dir, str_acl_type(SMB_ACL_TYPE_DEFAULT), strerror(errno));
1130 return perms;
1133 /* Convert it. */
1134 racl = empty_rsync_acl;
1135 ok = unpack_smb_acl(sacl, &racl);
1136 sys_acl_free_acl(sacl);
1137 if (!ok) {
1138 rprintf(FWARNING, "default_perms_for_dir: unpack_smb_acl failed, falling back on umask\n");
1139 return perms;
1142 /* Apply the permission-bit entries of the default ACL, if any. */
1143 if (racl.user_obj != NO_ENTRY) {
1144 perms = rsync_acl_get_perms(&racl);
1145 if (DEBUG_GTE(ACL, 1))
1146 rprintf(FINFO, "got ACL-based default perms %o for directory %s\n", perms, dir);
1149 rsync_acl_free(&racl);
1150 return perms;
1153 #endif /* SUPPORT_ACLS */