Tweak a define.
[rsync.git] / acls.c
blob3cf12eeb07c42238b81236850618bd8c2b1b23ba
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-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.
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 *racl = empty_rsync_acl;
173 return racl;
176 static BOOL ida_entries_equal(const ida_entries *ial1, const ida_entries *ial2)
178 id_access *ida1, *ida2;
179 int count = ial1->count;
180 if (count != ial2->count)
181 return False;
182 ida1 = ial1->idas;
183 ida2 = ial2->idas;
184 for (; count--; ida1++, ida2++) {
185 if (ida1->access != ida2->access || ida1->id != ida2->id)
186 return False;
188 return True;
191 static BOOL rsync_acl_equal(const rsync_acl *racl1, const rsync_acl *racl2)
193 return racl1->user_obj == racl2->user_obj
194 && racl1->group_obj == racl2->group_obj
195 && racl1->mask_obj == racl2->mask_obj
196 && racl1->other_obj == racl2->other_obj
197 && ida_entries_equal(&racl1->names, &racl2->names);
200 /* Are the extended (non-permission-bit) entries equal? If so, the rest of
201 * the ACL will be handled by the normal mode-preservation code. This is
202 * only meaningful for access ACLs! Note: the 1st arg is a fully-populated
203 * rsync_acl, but the 2nd parameter can be a condensed rsync_acl, which means
204 * that it might have several of its permission objects set to NO_ENTRY. */
205 static BOOL rsync_acl_equal_enough(const rsync_acl *racl1,
206 const rsync_acl *racl2, mode_t m)
208 if ((racl1->mask_obj ^ racl2->mask_obj) & NO_ENTRY)
209 return False; /* One has a mask and the other doesn't */
211 /* When there's a mask, the group_obj becomes an extended entry. */
212 if (racl1->mask_obj != NO_ENTRY) {
213 /* A condensed rsync_acl with a mask can only have no
214 * group_obj when it was identical to the mask. This
215 * means that it was also identical to the group attrs
216 * from the mode. */
217 if (racl2->group_obj == NO_ENTRY) {
218 if (racl1->group_obj != ((m >> 3) & 7))
219 return False;
220 } else if (racl1->group_obj != racl2->group_obj)
221 return False;
223 return ida_entries_equal(&racl1->names, &racl2->names);
226 static void rsync_acl_free(rsync_acl *racl)
228 if (racl->names.idas)
229 free(racl->names.idas);
230 *racl = empty_rsync_acl;
233 void free_acl(stat_x *sxp)
235 if (sxp->acc_acl) {
236 rsync_acl_free(sxp->acc_acl);
237 free(sxp->acc_acl);
238 sxp->acc_acl = NULL;
240 if (sxp->def_acl) {
241 rsync_acl_free(sxp->def_acl);
242 free(sxp->def_acl);
243 sxp->def_acl = NULL;
247 #ifdef SMB_ACL_NEED_SORT
248 static int id_access_sorter(const void *r1, const void *r2)
250 id_access *ida1 = (id_access *)r1;
251 id_access *ida2 = (id_access *)r2;
252 id_t rid1 = ida1->id, rid2 = ida2->id;
253 if ((ida1->access ^ ida2->access) & NAME_IS_USER)
254 return ida1->access & NAME_IS_USER ? -1 : 1;
255 return rid1 == rid2 ? 0 : rid1 < rid2 ? -1 : 1;
257 #endif
259 /* === System ACLs === */
261 /* Unpack system ACL -> rsync ACL verbatim. Return whether we succeeded. */
262 static BOOL unpack_smb_acl(SMB_ACL_T sacl, rsync_acl *racl)
264 static item_list temp_ida_list = EMPTY_ITEM_LIST;
265 SMB_ACL_ENTRY_T entry;
266 const char *errfun;
267 int rc;
269 errfun = "sys_acl_get_entry";
270 for (rc = sys_acl_get_entry(sacl, SMB_ACL_FIRST_ENTRY, &entry);
271 rc == 1;
272 rc = sys_acl_get_entry(sacl, SMB_ACL_NEXT_ENTRY, &entry)) {
273 SMB_ACL_TAG_T tag_type;
274 uint32 access;
275 id_t g_u_id;
276 id_access *ida;
277 if ((rc = sys_acl_get_info(entry, &tag_type, &access, &g_u_id)) != 0) {
278 errfun = "sys_acl_get_info";
279 break;
281 /* continue == done with entry; break == store in temporary ida list */
282 switch (tag_type) {
283 #ifndef HAVE_OSX_ACLS
284 case SMB_ACL_USER_OBJ:
285 if (racl->user_obj == NO_ENTRY)
286 racl->user_obj = access;
287 else
288 rprintf(FINFO, "unpack_smb_acl: warning: duplicate USER_OBJ entry ignored\n");
289 continue;
290 case SMB_ACL_GROUP_OBJ:
291 if (racl->group_obj == NO_ENTRY)
292 racl->group_obj = access;
293 else
294 rprintf(FINFO, "unpack_smb_acl: warning: duplicate GROUP_OBJ entry ignored\n");
295 continue;
296 case SMB_ACL_MASK:
297 if (racl->mask_obj == NO_ENTRY)
298 racl->mask_obj = access;
299 else
300 rprintf(FINFO, "unpack_smb_acl: warning: duplicate MASK entry ignored\n");
301 continue;
302 case SMB_ACL_OTHER:
303 if (racl->other_obj == NO_ENTRY)
304 racl->other_obj = access;
305 else
306 rprintf(FINFO, "unpack_smb_acl: warning: duplicate OTHER entry ignored\n");
307 continue;
308 #endif
309 case SMB_ACL_USER:
310 access |= NAME_IS_USER;
311 break;
312 case SMB_ACL_GROUP:
313 break;
314 default:
315 rprintf(FINFO, "unpack_smb_acl: warning: entry with unrecognized tag type ignored\n");
316 continue;
318 ida = EXPAND_ITEM_LIST(&temp_ida_list, id_access, -10);
319 ida->id = g_u_id;
320 ida->access = access;
322 if (rc) {
323 rsyserr(FERROR_XFER, errno, "unpack_smb_acl: %s()", errfun);
324 rsync_acl_free(racl);
325 return False;
328 /* Transfer the count id_access items out of the temp_ida_list
329 * into the names ida_entries list in racl. */
330 if (temp_ida_list.count) {
331 #ifdef SMB_ACL_NEED_SORT
332 if (temp_ida_list.count > 1) {
333 qsort(temp_ida_list.items, temp_ida_list.count, sizeof (id_access), id_access_sorter);
335 #endif
336 racl->names.idas = new_array(id_access, temp_ida_list.count);
337 memcpy(racl->names.idas, temp_ida_list.items, temp_ida_list.count * sizeof (id_access));
338 } else
339 racl->names.idas = NULL;
341 racl->names.count = temp_ida_list.count;
343 /* Truncate the temporary list now that its idas have been saved. */
344 temp_ida_list.count = 0;
346 return True;
349 /* Synactic sugar for system calls */
351 #define CALL_OR_ERROR(func,args,str) \
352 do { \
353 if (func args) { \
354 errfun = str; \
355 goto error_exit; \
357 } while (0)
359 #define COE(func,args) CALL_OR_ERROR(func,args,#func)
360 #define COE2(func,args) CALL_OR_ERROR(func,args,NULL)
362 #ifndef HAVE_OSX_ACLS
363 /* Store the permissions in the system ACL entry. */
364 static int store_access_in_entry(uint32 access, SMB_ACL_ENTRY_T entry)
366 if (sys_acl_set_access_bits(entry, access)) {
367 rsyserr(FERROR_XFER, errno, "store_access_in_entry sys_acl_set_access_bits()");
368 return -1;
370 return 0;
372 #endif
374 /* Pack rsync ACL -> system ACL verbatim. Return whether we succeeded. */
375 static BOOL pack_smb_acl(SMB_ACL_T *smb_acl, const rsync_acl *racl)
377 #ifdef ACLS_NEED_MASK
378 uchar mask_bits;
379 #endif
380 size_t count;
381 id_access *ida;
382 const char *errfun = NULL;
383 SMB_ACL_ENTRY_T entry;
385 if (!(*smb_acl = sys_acl_init(calc_sacl_entries(racl)))) {
386 rsyserr(FERROR_XFER, errno, "pack_smb_acl: sys_acl_init()");
387 return False;
390 #ifndef HAVE_OSX_ACLS
391 COE( sys_acl_create_entry,(smb_acl, &entry) );
392 COE( sys_acl_set_info,(entry, SMB_ACL_USER_OBJ, racl->user_obj & ~NO_ENTRY, 0) );
393 #endif
395 for (ida = racl->names.idas, count = racl->names.count; count; ida++, count--) {
396 #ifdef SMB_ACL_NEED_SORT
397 if (!(ida->access & NAME_IS_USER))
398 break;
399 #endif
400 COE( sys_acl_create_entry,(smb_acl, &entry) );
401 COE( sys_acl_set_info,
402 (entry,
403 ida->access & NAME_IS_USER ? SMB_ACL_USER : SMB_ACL_GROUP,
404 ida->access & ~NAME_IS_USER, ida->id) );
407 #ifndef HAVE_OSX_ACLS
408 COE( sys_acl_create_entry,(smb_acl, &entry) );
409 COE( sys_acl_set_info,(entry, SMB_ACL_GROUP_OBJ, racl->group_obj & ~NO_ENTRY, 0) );
411 #ifdef SMB_ACL_NEED_SORT
412 for ( ; count; ida++, count--) {
413 COE( sys_acl_create_entry,(smb_acl, &entry) );
414 COE( sys_acl_set_info,(entry, SMB_ACL_GROUP, ida->access, ida->id) );
416 #endif
418 #ifdef ACLS_NEED_MASK
419 mask_bits = racl->mask_obj == NO_ENTRY ? racl->group_obj & ~NO_ENTRY : racl->mask_obj;
420 COE( sys_acl_create_entry,(smb_acl, &entry) );
421 COE( sys_acl_set_info,(entry, SMB_ACL_MASK, mask_bits, 0) );
422 #else
423 if (racl->mask_obj != NO_ENTRY) {
424 COE( sys_acl_create_entry,(smb_acl, &entry) );
425 COE( sys_acl_set_info,(entry, SMB_ACL_MASK, racl->mask_obj, 0) );
427 #endif
429 COE( sys_acl_create_entry,(smb_acl, &entry) );
430 COE( sys_acl_set_info,(entry, SMB_ACL_OTHER, racl->other_obj & ~NO_ENTRY, 0) );
431 #endif
433 #ifdef DEBUG
434 if (sys_acl_valid(*smb_acl) < 0)
435 rprintf(FERROR_XFER, "pack_smb_acl: warning: system says the ACL I packed is invalid\n");
436 #endif
438 return True;
440 error_exit:
441 if (errfun) {
442 rsyserr(FERROR_XFER, errno, "pack_smb_acl %s()", errfun);
444 sys_acl_free_acl(*smb_acl);
445 return False;
448 static int find_matching_rsync_acl(const rsync_acl *racl, SMB_ACL_TYPE_T type,
449 const item_list *racl_list)
451 static int access_match = -1, default_match = -1;
452 int *match = type == SMB_ACL_TYPE_ACCESS ? &access_match : &default_match;
453 size_t count = racl_list->count;
455 /* If this is the first time through or we didn't match the last
456 * time, then start at the end of the list, which should be the
457 * best place to start hunting. */
458 if (*match == -1)
459 *match = racl_list->count - 1;
460 while (count--) {
461 rsync_acl *base = racl_list->items;
462 if (rsync_acl_equal(base + *match, racl))
463 return *match;
464 if (!(*match)--)
465 *match = racl_list->count - 1;
468 *match = -1;
469 return *match;
472 static int get_rsync_acl(const char *fname, rsync_acl *racl,
473 SMB_ACL_TYPE_T type, mode_t mode)
475 SMB_ACL_T sacl;
477 #ifdef SUPPORT_XATTRS
478 /* --fake-super support: load ACLs from an xattr. */
479 if (am_root < 0) {
480 char *buf;
481 size_t len;
482 int cnt;
484 if ((buf = get_xattr_acl(fname, type == SMB_ACL_TYPE_ACCESS, &len)) == NULL)
485 return 0;
486 cnt = (len - 4*4) / (4+4);
487 if (len < 4*4 || len != (size_t)cnt*(4+4) + 4*4) {
488 free(buf);
489 return -1;
492 racl->user_obj = IVAL(buf, 0);
493 if (racl->user_obj == NO_ENTRY)
494 racl->user_obj = (mode >> 6) & 7;
495 racl->group_obj = IVAL(buf, 4);
496 if (racl->group_obj == NO_ENTRY)
497 racl->group_obj = (mode >> 3) & 7;
498 racl->mask_obj = IVAL(buf, 8);
499 racl->other_obj = IVAL(buf, 12);
500 if (racl->other_obj == NO_ENTRY)
501 racl->other_obj = mode & 7;
503 if (cnt) {
504 char *bp = buf + 4*4;
505 id_access *ida = racl->names.idas = new_array(id_access, cnt);
506 racl->names.count = cnt;
507 for ( ; cnt--; ida++, bp += 4+4) {
508 ida->id = IVAL(bp, 0);
509 ida->access = IVAL(bp, 4);
512 free(buf);
513 return 0;
515 #endif
517 if ((sacl = sys_acl_get_file(fname, type)) != 0) {
518 BOOL ok = unpack_smb_acl(sacl, racl);
520 sys_acl_free_acl(sacl);
521 if (!ok) {
522 rsyserr(FERROR_XFER, errno, "get_acl: unpack_smb_acl(%s)", fname);
523 return -1;
525 } else if (no_acl_syscall_error(errno)) {
526 /* ACLs are not supported, so pretend we have a basic ACL. */
527 if (type == SMB_ACL_TYPE_ACCESS)
528 rsync_acl_fake_perms(racl, mode);
529 } else {
530 rsyserr(FERROR_XFER, errno, "get_acl: sys_acl_get_file(%s, %s)",
531 fname, str_acl_type(type));
532 return -1;
535 return 0;
538 /* Return the Access Control List for the given filename. */
539 int get_acl(const char *fname, stat_x *sxp)
541 sxp->acc_acl = create_racl();
543 if (S_ISREG(sxp->st.st_mode) || S_ISDIR(sxp->st.st_mode)) {
544 /* Everyone supports this. */
545 } else if (S_ISLNK(sxp->st.st_mode)) {
546 return 0;
547 } else if (IS_SPECIAL(sxp->st.st_mode)) {
548 #ifndef NO_SPECIAL_ACLS
549 if (!preserve_specials)
550 #endif
551 return 0;
552 } else if (IS_DEVICE(sxp->st.st_mode)) {
553 #ifndef NO_DEVICE_ACLS
554 if (!preserve_devices)
555 #endif
556 return 0;
557 } else if (IS_MISSING_FILE(sxp->st))
558 return 0;
560 if (get_rsync_acl(fname, sxp->acc_acl, SMB_ACL_TYPE_ACCESS,
561 sxp->st.st_mode) < 0) {
562 free_acl(sxp);
563 return -1;
566 if (S_ISDIR(sxp->st.st_mode)) {
567 sxp->def_acl = create_racl();
568 if (get_rsync_acl(fname, sxp->def_acl, SMB_ACL_TYPE_DEFAULT,
569 sxp->st.st_mode) < 0) {
570 free_acl(sxp);
571 return -1;
575 return 0;
578 /* === Send functions === */
580 /* Send the ida list over the file descriptor. */
581 static void send_ida_entries(int f, const ida_entries *idal)
583 id_access *ida;
584 size_t count = idal->count;
586 write_varint(f, idal->count);
588 for (ida = idal->idas; count--; ida++) {
589 uint32 xbits = ida->access << 2;
590 const char *name;
591 if (ida->access & NAME_IS_USER) {
592 xbits |= XFLAG_NAME_IS_USER;
593 name = numeric_ids ? NULL : add_uid(ida->id);
594 } else
595 name = numeric_ids ? NULL : add_gid(ida->id);
596 write_varint(f, ida->id);
597 if (inc_recurse && name) {
598 int len = strlen(name);
599 write_varint(f, xbits | XFLAG_NAME_FOLLOWS);
600 write_byte(f, len);
601 write_buf(f, name, len);
602 } else
603 write_varint(f, xbits);
607 static void send_rsync_acl(int f, rsync_acl *racl, SMB_ACL_TYPE_T type,
608 item_list *racl_list)
610 int ndx = find_matching_rsync_acl(racl, type, racl_list);
612 /* Send 0 (-1 + 1) to indicate that literal ACL data follows. */
613 write_varint(f, ndx + 1);
615 if (ndx < 0) {
616 rsync_acl *new_racl = EXPAND_ITEM_LIST(racl_list, rsync_acl, 1000);
617 uchar flags = 0;
619 if (racl->user_obj != NO_ENTRY)
620 flags |= XMIT_USER_OBJ;
621 if (racl->group_obj != NO_ENTRY)
622 flags |= XMIT_GROUP_OBJ;
623 if (racl->mask_obj != NO_ENTRY)
624 flags |= XMIT_MASK_OBJ;
625 if (racl->other_obj != NO_ENTRY)
626 flags |= XMIT_OTHER_OBJ;
627 if (racl->names.count)
628 flags |= XMIT_NAME_LIST;
630 write_byte(f, flags);
632 if (flags & XMIT_USER_OBJ)
633 write_varint(f, racl->user_obj);
634 if (flags & XMIT_GROUP_OBJ)
635 write_varint(f, racl->group_obj);
636 if (flags & XMIT_MASK_OBJ)
637 write_varint(f, racl->mask_obj);
638 if (flags & XMIT_OTHER_OBJ)
639 write_varint(f, racl->other_obj);
640 if (flags & XMIT_NAME_LIST)
641 send_ida_entries(f, &racl->names);
643 /* Give the allocated data to the new list object. */
644 *new_racl = *racl;
645 *racl = empty_rsync_acl;
649 /* Send the ACL from the stat_x structure down the indicated file descriptor.
650 * This also frees the ACL data. */
651 void send_acl(int f, stat_x *sxp)
653 if (!sxp->acc_acl) {
654 sxp->acc_acl = create_racl();
655 rsync_acl_fake_perms(sxp->acc_acl, sxp->st.st_mode);
657 /* Avoid sending values that can be inferred from other data. */
658 rsync_acl_strip_perms(sxp);
660 send_rsync_acl(f, sxp->acc_acl, SMB_ACL_TYPE_ACCESS, &access_acl_list);
662 if (S_ISDIR(sxp->st.st_mode)) {
663 if (!sxp->def_acl)
664 sxp->def_acl = create_racl();
666 send_rsync_acl(f, sxp->def_acl, SMB_ACL_TYPE_DEFAULT, &default_acl_list);
670 /* === Receive functions === */
672 static uint32 recv_acl_access(int f, uchar *name_follows_ptr)
674 uint32 access = read_varint(f);
676 if (name_follows_ptr) {
677 int flags = access & 3;
678 access >>= 2;
679 if (am_root >= 0 && access & ~SMB_ACL_VALID_NAME_BITS)
680 goto value_error;
681 if (flags & XFLAG_NAME_FOLLOWS)
682 *name_follows_ptr = 1;
683 else
684 *name_follows_ptr = 0;
685 if (flags & XFLAG_NAME_IS_USER)
686 access |= NAME_IS_USER;
687 } else if (am_root >= 0 && access & ~SMB_ACL_VALID_OBJ_BITS) {
688 value_error:
689 rprintf(FERROR_XFER, "recv_acl_access: value out of range: %x\n",
690 access);
691 exit_cleanup(RERR_STREAMIO);
694 return access;
697 static uchar recv_ida_entries(int f, ida_entries *ent)
699 uchar computed_mask_bits = 0;
700 int i, count = read_varint(f);
702 ent->idas = count ? new_array(id_access, count) : NULL;
703 ent->count = count;
705 for (i = 0; i < count; i++) {
706 uchar has_name;
707 id_t id = read_varint(f);
708 uint32 access = recv_acl_access(f, &has_name);
710 if (has_name) {
711 if (access & NAME_IS_USER)
712 id = recv_user_name(f, id);
713 else
714 id = recv_group_name(f, id, NULL);
715 } else if (access & NAME_IS_USER) {
716 if (inc_recurse && am_root && !numeric_ids)
717 id = match_uid(id);
718 } else {
719 if (inc_recurse && (!am_root || !numeric_ids))
720 id = match_gid(id, NULL);
723 ent->idas[i].id = id;
724 ent->idas[i].access = access;
725 computed_mask_bits |= access;
728 return computed_mask_bits & ~NO_ENTRY;
731 static int recv_rsync_acl(int f, item_list *racl_list, SMB_ACL_TYPE_T type, mode_t mode)
733 uchar computed_mask_bits = 0;
734 acl_duo *duo_item;
735 uchar flags;
736 int ndx = read_varint(f);
738 if (ndx < 0 || (size_t)ndx > racl_list->count) {
739 rprintf(FERROR_XFER, "recv_acl_index: %s ACL index %d > %d\n",
740 str_acl_type(type), ndx, (int)racl_list->count);
741 exit_cleanup(RERR_STREAMIO);
744 if (ndx != 0)
745 return ndx - 1;
747 ndx = racl_list->count;
748 duo_item = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
749 duo_item->racl = empty_rsync_acl;
751 flags = read_byte(f);
753 if (flags & XMIT_USER_OBJ)
754 duo_item->racl.user_obj = recv_acl_access(f, NULL);
755 if (flags & XMIT_GROUP_OBJ)
756 duo_item->racl.group_obj = recv_acl_access(f, NULL);
757 if (flags & XMIT_MASK_OBJ)
758 duo_item->racl.mask_obj = recv_acl_access(f, NULL);
759 if (flags & XMIT_OTHER_OBJ)
760 duo_item->racl.other_obj = recv_acl_access(f, NULL);
761 if (flags & XMIT_NAME_LIST)
762 computed_mask_bits |= recv_ida_entries(f, &duo_item->racl.names);
764 #ifdef HAVE_OSX_ACLS
765 /* If we received a superfluous mask, throw it away. */
766 duo_item->racl.mask_obj = NO_ENTRY;
767 (void)mode;
768 #else
769 if (duo_item->racl.names.count && duo_item->racl.mask_obj == NO_ENTRY) {
770 /* Mask must be non-empty with lists. */
771 if (type == SMB_ACL_TYPE_ACCESS)
772 computed_mask_bits = (mode >> 3) & 7;
773 else
774 computed_mask_bits |= duo_item->racl.group_obj & ~NO_ENTRY;
775 duo_item->racl.mask_obj = computed_mask_bits;
777 #endif
779 duo_item->sacl = NULL;
781 return ndx;
784 /* Receive the ACL info the sender has included for this file-list entry. */
785 void receive_acl(int f, struct file_struct *file)
787 F_ACL(file) = recv_rsync_acl(f, &access_acl_list, SMB_ACL_TYPE_ACCESS, file->mode);
789 if (S_ISDIR(file->mode))
790 F_DIR_DEFACL(file) = recv_rsync_acl(f, &default_acl_list, SMB_ACL_TYPE_DEFAULT, 0);
793 static int cache_rsync_acl(rsync_acl *racl, SMB_ACL_TYPE_T type, item_list *racl_list)
795 int ndx;
797 if (!racl)
798 ndx = -1;
799 else if ((ndx = find_matching_rsync_acl(racl, type, racl_list)) == -1) {
800 acl_duo *new_duo;
801 ndx = racl_list->count;
802 new_duo = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
803 new_duo->racl = *racl;
804 new_duo->sacl = NULL;
805 *racl = empty_rsync_acl;
808 return ndx;
811 /* Turn the ACL data in stat_x into cached ACL data, setting the index
812 * values in the file struct. */
813 void cache_tmp_acl(struct file_struct *file, stat_x *sxp)
815 if (prior_access_count == (size_t)-1)
816 prior_access_count = access_acl_list.count;
818 F_ACL(file) = cache_rsync_acl(sxp->acc_acl, SMB_ACL_TYPE_ACCESS, &access_acl_list);
820 if (S_ISDIR(sxp->st.st_mode)) {
821 if (prior_default_count == (size_t)-1)
822 prior_default_count = default_acl_list.count;
823 F_DIR_DEFACL(file) = cache_rsync_acl(sxp->def_acl, SMB_ACL_TYPE_DEFAULT, &default_acl_list);
827 static void uncache_duo_acls(item_list *duo_list, size_t start)
829 acl_duo *duo_item = duo_list->items;
830 acl_duo *duo_start = duo_item + start;
832 duo_item += duo_list->count;
833 duo_list->count = start;
835 while (duo_item-- > duo_start) {
836 rsync_acl_free(&duo_item->racl);
837 if (duo_item->sacl)
838 sys_acl_free_acl(duo_item->sacl);
842 void uncache_tmp_acls(void)
844 if (prior_access_count != (size_t)-1) {
845 uncache_duo_acls(&access_acl_list, prior_access_count);
846 prior_access_count = (size_t)-1;
849 if (prior_default_count != (size_t)-1) {
850 uncache_duo_acls(&default_acl_list, prior_default_count);
851 prior_default_count = (size_t)-1;
855 #ifndef HAVE_OSX_ACLS
856 static mode_t change_sacl_perms(SMB_ACL_T sacl, rsync_acl *racl, mode_t old_mode, mode_t mode)
858 SMB_ACL_ENTRY_T entry;
859 const char *errfun;
860 int rc;
862 if (S_ISDIR(mode)) {
863 /* If the sticky bit is going on, it's not safe to allow all
864 * the new ACL to go into effect before it gets set. */
865 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
866 if (mode & S_ISVTX)
867 mode &= ~0077;
868 #else
869 if (mode & S_ISVTX && !(old_mode & S_ISVTX))
870 mode &= ~0077;
871 } else {
872 /* If setuid or setgid is going off, it's not safe to allow all
873 * the new ACL to go into effect before they get cleared. */
874 if ((old_mode & S_ISUID && !(mode & S_ISUID))
875 || (old_mode & S_ISGID && !(mode & S_ISGID)))
876 mode &= ~0077;
877 #endif
880 errfun = "sys_acl_get_entry";
881 for (rc = sys_acl_get_entry(sacl, SMB_ACL_FIRST_ENTRY, &entry);
882 rc == 1;
883 rc = sys_acl_get_entry(sacl, SMB_ACL_NEXT_ENTRY, &entry)) {
884 SMB_ACL_TAG_T tag_type;
885 if ((rc = sys_acl_get_tag_type(entry, &tag_type)) != 0) {
886 errfun = "sys_acl_get_tag_type";
887 break;
889 switch (tag_type) {
890 case SMB_ACL_USER_OBJ:
891 COE2( store_access_in_entry,((mode >> 6) & 7, entry) );
892 break;
893 case SMB_ACL_GROUP_OBJ:
894 /* group is only empty when identical to group perms. */
895 if (racl->group_obj != NO_ENTRY)
896 break;
897 COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
898 break;
899 case SMB_ACL_MASK:
900 #ifndef HAVE_SOLARIS_ACLS
901 #ifndef ACLS_NEED_MASK
902 /* mask is only empty when we don't need it. */
903 if (racl->mask_obj == NO_ENTRY)
904 break;
905 #endif
906 COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
907 #endif
908 break;
909 case SMB_ACL_OTHER:
910 COE2( store_access_in_entry,(mode & 7, entry) );
911 break;
914 if (rc) {
915 error_exit:
916 if (errfun) {
917 rsyserr(FERROR_XFER, errno, "change_sacl_perms: %s()",
918 errfun);
920 return (mode_t)-1;
923 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
924 /* Ensure that chmod() will be called to restore any lost setid bits. */
925 if (old_mode & (S_ISUID | S_ISGID | S_ISVTX)
926 && BITS_EQUAL(old_mode, mode, CHMOD_BITS))
927 old_mode &= ~(S_ISUID | S_ISGID | S_ISVTX);
928 #endif
930 /* Return the mode of the file on disk, as we will set them. */
931 return (old_mode & ~ACCESSPERMS) | (mode & ACCESSPERMS);
933 #endif
935 static int set_rsync_acl(const char *fname, acl_duo *duo_item,
936 SMB_ACL_TYPE_T type, stat_x *sxp, mode_t mode)
938 if (type == SMB_ACL_TYPE_DEFAULT
939 && duo_item->racl.user_obj == NO_ENTRY) {
940 int rc;
941 #ifdef SUPPORT_XATTRS
942 /* --fake-super support: delete default ACL from xattrs. */
943 if (am_root < 0)
944 rc = del_def_xattr_acl(fname);
945 else
946 #endif
947 rc = sys_acl_delete_def_file(fname);
948 if (rc < 0) {
949 rsyserr(FERROR_XFER, errno, "set_acl: sys_acl_delete_def_file(%s)",
950 fname);
951 return -1;
953 #ifdef SUPPORT_XATTRS
954 } else if (am_root < 0) {
955 /* --fake-super support: store ACLs in an xattr. */
956 int cnt = duo_item->racl.names.count;
957 size_t len = 4*4 + cnt * (4+4);
958 char *buf = new_array(char, len);
959 int rc;
961 SIVAL(buf, 0, duo_item->racl.user_obj);
962 SIVAL(buf, 4, duo_item->racl.group_obj);
963 SIVAL(buf, 8, duo_item->racl.mask_obj);
964 SIVAL(buf, 12, duo_item->racl.other_obj);
966 if (cnt) {
967 char *bp = buf + 4*4;
968 id_access *ida = duo_item->racl.names.idas;
969 for ( ; cnt--; ida++, bp += 4+4) {
970 SIVAL(bp, 0, ida->id);
971 SIVAL(bp, 4, ida->access);
974 rc = set_xattr_acl(fname, type == SMB_ACL_TYPE_ACCESS, buf, len);
975 free(buf);
976 return rc;
977 #endif
978 } else {
979 mode_t cur_mode = sxp->st.st_mode;
980 if (!duo_item->sacl
981 && !pack_smb_acl(&duo_item->sacl, &duo_item->racl))
982 return -1;
983 #ifdef HAVE_OSX_ACLS
984 mode = 0; /* eliminate compiler warning */
985 #else
986 if (type == SMB_ACL_TYPE_ACCESS) {
987 cur_mode = change_sacl_perms(duo_item->sacl, &duo_item->racl, cur_mode, mode);
988 if (cur_mode == (mode_t)-1)
989 return 0;
991 #endif
992 if (sys_acl_set_file(fname, type, duo_item->sacl) < 0) {
993 rsyserr(FERROR_XFER, errno, "set_acl: sys_acl_set_file(%s, %s)",
994 fname, str_acl_type(type));
995 return -1;
997 if (type == SMB_ACL_TYPE_ACCESS)
998 sxp->st.st_mode = cur_mode;
1001 return 0;
1004 /* Given a fname, this sets extended access ACL entries, the default ACL (for a
1005 * dir), and the regular mode bits on the file. Call this with fname set to
1006 * NULL to just check if the ACL is different.
1008 * If the ACL operation has a side-effect of changing the file's mode, the
1009 * sxp->st.st_mode value will be changed to match.
1011 * Returns 0 for an unchanged ACL, 1 for changed, -1 for failed. */
1012 int set_acl(const char *fname, const struct file_struct *file, stat_x *sxp, mode_t new_mode)
1014 int changed = 0;
1015 int32 ndx;
1016 BOOL eq;
1018 if (!dry_run && (read_only || list_only)) {
1019 errno = EROFS;
1020 return -1;
1023 ndx = F_ACL(file);
1024 if (ndx >= 0 && (size_t)ndx < access_acl_list.count) {
1025 acl_duo *duo_item = access_acl_list.items;
1026 duo_item += ndx;
1027 eq = sxp->acc_acl
1028 && rsync_acl_equal_enough(sxp->acc_acl, &duo_item->racl, new_mode);
1029 if (!eq) {
1030 changed = 1;
1031 if (!dry_run && fname
1032 && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_ACCESS,
1033 sxp, new_mode) < 0)
1034 return -1;
1038 if (!S_ISDIR(new_mode))
1039 return changed;
1041 ndx = F_DIR_DEFACL(file);
1042 if (ndx >= 0 && (size_t)ndx < default_acl_list.count) {
1043 acl_duo *duo_item = default_acl_list.items;
1044 duo_item += ndx;
1045 eq = sxp->def_acl && rsync_acl_equal(sxp->def_acl, &duo_item->racl);
1046 if (!eq) {
1047 changed = 1;
1048 if (!dry_run && fname
1049 && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_DEFAULT,
1050 sxp, new_mode) < 0)
1051 return -1;
1055 return changed;
1058 /* Non-incremental recursion needs to convert all the received IDs.
1059 * This is done in a single pass after receiving the whole file-list. */
1060 static void match_racl_ids(const item_list *racl_list)
1062 int list_cnt, name_cnt;
1063 acl_duo *duo_item = racl_list->items;
1064 for (list_cnt = racl_list->count; list_cnt--; duo_item++) {
1065 ida_entries *idal = &duo_item->racl.names;
1066 id_access *ida = idal->idas;
1067 for (name_cnt = idal->count; name_cnt--; ida++) {
1068 if (ida->access & NAME_IS_USER)
1069 ida->id = match_uid(ida->id);
1070 else
1071 ida->id = match_gid(ida->id, NULL);
1076 void match_acl_ids(void)
1078 match_racl_ids(&access_acl_list);
1079 match_racl_ids(&default_acl_list);
1082 /* This is used by dest_mode(). */
1083 int default_perms_for_dir(const char *dir)
1085 rsync_acl racl;
1086 SMB_ACL_T sacl;
1087 BOOL ok;
1088 int perms;
1090 if (dir == NULL)
1091 dir = ".";
1092 perms = ACCESSPERMS & ~orig_umask;
1093 /* Read the directory's default ACL. If it has none, this will successfully return an empty ACL. */
1094 sacl = sys_acl_get_file(dir, SMB_ACL_TYPE_DEFAULT);
1095 if (sacl == NULL) {
1096 /* Couldn't get an ACL. Darn. */
1097 switch (errno) {
1098 case EINVAL:
1099 /* If SMB_ACL_TYPE_DEFAULT isn't valid, then the ACLs must be non-POSIX. */
1100 break;
1101 #ifdef ENOTSUP
1102 case ENOTSUP:
1103 #endif
1104 case ENOSYS:
1105 /* No ACLs are available. */
1106 break;
1107 default:
1108 if (dry_run && errno == ENOENT) {
1109 /* We're doing a dry run, so the containing directory
1110 * wasn't actually created. Don't worry about it. */
1111 break;
1113 rprintf(FWARNING,
1114 "default_perms_for_dir: sys_acl_get_file(%s, %s): %s, falling back on umask\n",
1115 dir, str_acl_type(SMB_ACL_TYPE_DEFAULT), strerror(errno));
1117 return perms;
1120 /* Convert it. */
1121 racl = empty_rsync_acl;
1122 ok = unpack_smb_acl(sacl, &racl);
1123 sys_acl_free_acl(sacl);
1124 if (!ok) {
1125 rprintf(FWARNING, "default_perms_for_dir: unpack_smb_acl failed, falling back on umask\n");
1126 return perms;
1129 /* Apply the permission-bit entries of the default ACL, if any. */
1130 if (racl.user_obj != NO_ENTRY) {
1131 perms = rsync_acl_get_perms(&racl);
1132 if (DEBUG_GTE(ACL, 1))
1133 rprintf(FINFO, "got ACL-based default perms %o for directory %s\n", perms, dir);
1136 rsync_acl_free(&racl);
1137 return perms;
1140 #endif /* SUPPORT_ACLS */