Tweaked a variable name.
[rsync/rsync.git] / acls.c
1 /*
2  * Handle passing Access Control Lists between systems.
3  *
4  * Copyright (C) 1996 Andrew Tridgell
5  * Copyright (C) 1996 Paul Mackerras
6  * Copyright (C) 2006 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 as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
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.
17  *
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.
20  */
21
22 #include "rsync.h"
23 #include "lib/sysacls.h"
24
25 #ifdef SUPPORT_ACLS
26
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
35 /* Flags used to indicate what items are being transmitted for an entry. */
36 #define XMIT_USER_OBJ (1<<0)
37 #define XMIT_GROUP_OBJ (1<<1)
38 #define XMIT_MASK_OBJ (1<<2)
39 #define XMIT_OTHER_OBJ (1<<3)
40 #define XMIT_NAME_LIST (1<<4)
41
42 #define NO_ENTRY ((uchar)0x80) /* Default value of a NON-name-list entry. */
43
44 #define NAME_IS_USER (1u<<31) /* Bit used only on a name-list entry. */
45
46 /* When we send the access bits over the wire, we shift them 2 bits to the
47  * left and use the lower 2 bits as flags (relevant only to a name entry).
48  * This makes the protocol more efficient than sending a value that would
49  * be likely to have its hightest bits set. */
50 #define XFLAG_NAME_FOLLOWS 0x0001u
51 #define XFLAG_NAME_IS_USER 0x0002u
52
53 /* === ACL structures === */
54
55 typedef struct {
56         id_t id;
57         uint32 access;
58 } id_access;
59
60 typedef struct {
61         id_access *idas;
62         int count;
63 } ida_entries;
64
65 typedef struct {
66         char *name;
67         uchar len;
68 } idname;
69
70 typedef struct rsync_acl {
71         ida_entries names;
72         /* These will be NO_ENTRY if there's no such entry. */
73         uchar user_obj;
74         uchar group_obj;
75         uchar mask_obj;
76         uchar other_obj;
77 } rsync_acl;
78
79 typedef struct {
80         rsync_acl racl;
81         SMB_ACL_T sacl;
82 } acl_duo;
83
84 static const rsync_acl empty_rsync_acl = {
85         {NULL, 0}, NO_ENTRY, NO_ENTRY, NO_ENTRY, NO_ENTRY
86 };
87
88 static item_list access_acl_list = EMPTY_ITEM_LIST;
89 static item_list default_acl_list = EMPTY_ITEM_LIST;
90
91 /* === Calculations on ACL types === */
92
93 static const char *str_acl_type(SMB_ACL_TYPE_T type)
94 {
95         return type == SMB_ACL_TYPE_ACCESS ? "SMB_ACL_TYPE_ACCESS"
96              : type == SMB_ACL_TYPE_DEFAULT ? "SMB_ACL_TYPE_DEFAULT"
97              : "unknown SMB_ACL_TYPE_T";
98 }
99
100 static int calc_sacl_entries(const rsync_acl *racl)
101 {
102         /* A System ACL always gets user/group/other permission entries. */
103         return racl->names.count
104 #ifdef ACLS_NEED_MASK
105              + 4;
106 #else
107              + (racl->mask_obj != NO_ENTRY) + 3;
108 #endif
109 }
110
111 /* Extracts and returns the permission bits from the ACL.  This cannot be
112  * called on an rsync_acl that has NO_ENTRY in any spot but the mask. */
113 static int rsync_acl_get_perms(const rsync_acl *racl)
114 {
115         return (racl->user_obj << 6)
116              + ((racl->mask_obj != NO_ENTRY ? racl->mask_obj : racl->group_obj) << 3)
117              + racl->other_obj;
118 }
119
120 /* Removes the permission-bit entries from the ACL because these
121  * can be reconstructed from the file's mode. */
122 static void rsync_acl_strip_perms(rsync_acl *racl)
123 {
124         racl->user_obj = NO_ENTRY;
125         if (racl->mask_obj == NO_ENTRY)
126                 racl->group_obj = NO_ENTRY;
127         else {
128                 if (racl->group_obj == racl->mask_obj)
129                         racl->group_obj = NO_ENTRY;
130                 racl->mask_obj = NO_ENTRY;
131         }
132         racl->other_obj = NO_ENTRY;
133 }
134
135 /* Given an empty rsync_acl, fake up the permission bits. */
136 static void rsync_acl_fake_perms(rsync_acl *racl, mode_t mode)
137 {
138         racl->user_obj = (mode >> 6) & 7;
139         racl->group_obj = (mode >> 3) & 7;
140         racl->other_obj = mode & 7;
141 }
142
143 /* === Rsync ACL functions === */
144
145 static rsync_acl *create_racl(void)
146 {
147         rsync_acl *racl = new(rsync_acl);
148
149         if (!racl)
150                 out_of_memory("create_racl");
151         *racl = empty_rsync_acl;
152
153         return racl;
154 }
155
156 static BOOL ida_entries_equal(const ida_entries *ial1, const ida_entries *ial2)
157 {
158         id_access *ida1, *ida2;
159         int count = ial1->count;
160         if (count != ial2->count)
161                 return False;
162         ida1 = ial1->idas;
163         ida2 = ial2->idas;
164         for (; count--; ida1++, ida2++) {
165                 if (ida1->access != ida2->access || ida1->id != ida2->id)
166                         return False;
167         }
168         return True;
169 }
170
171 static BOOL rsync_acl_equal(const rsync_acl *racl1, const rsync_acl *racl2)
172 {
173         return racl1->user_obj == racl2->user_obj
174             && racl1->group_obj == racl2->group_obj
175             && racl1->mask_obj == racl2->mask_obj
176             && racl1->other_obj == racl2->other_obj
177             && ida_entries_equal(&racl1->names, &racl2->names);
178 }
179
180 /* Are the extended (non-permission-bit) entries equal?  If so, the rest of
181  * the ACL will be handled by the normal mode-preservation code.  This is
182  * only meaningful for access ACLs!  Note: the 1st arg is a fully-populated
183  * rsync_acl, but the 2nd parameter can be a condensed rsync_acl, which means
184  * that it might have several of its permission objects set to NO_ENTRY. */
185 static BOOL rsync_acl_equal_enough(const rsync_acl *racl1,
186                                    const rsync_acl *racl2, mode_t m)
187 {
188         if ((racl1->mask_obj ^ racl2->mask_obj) & NO_ENTRY)
189                 return False; /* One has a mask and the other doesn't */
190
191         /* When there's a mask, the group_obj becomes an extended entry. */
192         if (racl1->mask_obj != NO_ENTRY) {
193                 /* A condensed rsync_acl with a mask can only have no
194                  * group_obj when it was identical to the mask.  This
195                  * means that it was also identical to the group attrs
196                  * from the mode. */
197                 if (racl2->group_obj == NO_ENTRY) {
198                         if (racl1->group_obj != ((m >> 3) & 7))
199                                 return False;
200                 } else if (racl1->group_obj != racl2->group_obj)
201                         return False;
202         }
203         return ida_entries_equal(&racl1->names, &racl2->names);
204 }
205
206 static void rsync_acl_free(rsync_acl *racl)
207 {
208         if (racl->names.idas)
209                 free(racl->names.idas);
210         *racl = empty_rsync_acl;
211 }
212
213 void free_acl(stat_x *sxp)
214 {
215         if (sxp->acc_acl) {
216                 rsync_acl_free(sxp->acc_acl);
217                 free(sxp->acc_acl);
218                 sxp->acc_acl = NULL;
219         }
220         if (sxp->def_acl) {
221                 rsync_acl_free(sxp->def_acl);
222                 free(sxp->def_acl);
223                 sxp->def_acl = NULL;
224         }
225 }
226
227 #ifdef SMB_ACL_NEED_SORT
228 static int id_access_sorter(const void *r1, const void *r2)
229 {
230         id_access *ida1 = (id_access *)r1;
231         id_access *ida2 = (id_access *)r2;
232         id_t rid1 = ida1->id, rid2 = ida2->id;
233         if ((ida1->access ^ ida2->access) & NAME_IS_USER)
234                 return ida1->access & NAME_IS_USER ? -1 : 1;
235         return rid1 == rid2 ? 0 : rid1 < rid2 ? -1 : 1;
236 }
237 #endif
238
239 /* === System ACLs === */
240
241 /* Unpack system ACL -> rsync ACL verbatim.  Return whether we succeeded. */
242 static BOOL unpack_smb_acl(SMB_ACL_T sacl, rsync_acl *racl)
243 {
244         static item_list temp_ida_list = EMPTY_ITEM_LIST;
245         SMB_ACL_ENTRY_T entry;
246         const char *errfun;
247         int rc;
248
249         errfun = "sys_acl_get_entry";
250         for (rc = sys_acl_get_entry(sacl, SMB_ACL_FIRST_ENTRY, &entry);
251              rc == 1;
252              rc = sys_acl_get_entry(sacl, SMB_ACL_NEXT_ENTRY, &entry)) {
253                 SMB_ACL_TAG_T tag_type;
254                 uint32 access;
255                 id_t g_u_id;
256                 id_access *ida;
257                 if ((rc = sys_acl_get_info(entry, &tag_type, &access, &g_u_id)) != 0) {
258                         errfun = "sys_acl_get_info";
259                         break;
260                 }
261                 /* continue == done with entry; break == store in temporary ida list */
262                 switch (tag_type) {
263 #ifndef HAVE_OSX_ACLS
264                 case SMB_ACL_USER_OBJ:
265                         if (racl->user_obj == NO_ENTRY)
266                                 racl->user_obj = access;
267                         else
268                                 rprintf(FINFO, "unpack_smb_acl: warning: duplicate USER_OBJ entry ignored\n");
269                         continue;
270                 case SMB_ACL_GROUP_OBJ:
271                         if (racl->group_obj == NO_ENTRY)
272                                 racl->group_obj = access;
273                         else
274                                 rprintf(FINFO, "unpack_smb_acl: warning: duplicate GROUP_OBJ entry ignored\n");
275                         continue;
276                 case SMB_ACL_MASK:
277                         if (racl->mask_obj == NO_ENTRY)
278                                 racl->mask_obj = access;
279                         else
280                                 rprintf(FINFO, "unpack_smb_acl: warning: duplicate MASK entry ignored\n");
281                         continue;
282                 case SMB_ACL_OTHER:
283                         if (racl->other_obj == NO_ENTRY)
284                                 racl->other_obj = access;
285                         else
286                                 rprintf(FINFO, "unpack_smb_acl: warning: duplicate OTHER entry ignored\n");
287                         continue;
288 #endif
289                 case SMB_ACL_USER:
290                         access |= NAME_IS_USER;
291                         break;
292                 case SMB_ACL_GROUP:
293                         break;
294                 default:
295                         rprintf(FINFO, "unpack_smb_acl: warning: entry with unrecognized tag type ignored\n");
296                         continue;
297                 }
298                 ida = EXPAND_ITEM_LIST(&temp_ida_list, id_access, -10);
299                 ida->id = g_u_id;
300                 ida->access = access;
301         }
302         if (rc) {
303                 rsyserr(FERROR, errno, "unpack_smb_acl: %s()", errfun);
304                 rsync_acl_free(racl);
305                 return False;
306         }
307
308         /* Transfer the count id_access items out of the temp_ida_list
309          * into the names ida_entries list in racl. */
310         if (temp_ida_list.count) {
311 #ifdef SMB_ACL_NEED_SORT
312                 if (temp_ida_list.count > 1) {
313                         qsort(temp_ida_list.items, temp_ida_list.count,
314                               sizeof (id_access), id_access_sorter);
315                 }
316 #endif
317                 if (!(racl->names.idas = new_array(id_access, temp_ida_list.count)))
318                         out_of_memory("unpack_smb_acl");
319                 memcpy(racl->names.idas, temp_ida_list.items,
320                        temp_ida_list.count * sizeof (id_access));
321         } else
322                 racl->names.idas = NULL;
323
324         racl->names.count = temp_ida_list.count;
325
326         /* Truncate the temporary list now that its idas have been saved. */
327         temp_ida_list.count = 0;
328
329 #ifdef ACLS_NEED_MASK
330         if (!racl->names.count && racl->mask_obj != NO_ENTRY) {
331                 /* Throw away a superfluous mask, but mask off the
332                  * group perms with it first. */
333                 racl->group_obj &= racl->mask_obj;
334                 racl->mask_obj = NO_ENTRY;
335         }
336 #endif
337
338         return True;
339 }
340
341 /* Synactic sugar for system calls */
342
343 #define CALL_OR_ERROR(func,args,str) \
344         do { \
345                 if (func args) { \
346                         errfun = str; \
347                         goto error_exit; \
348                 } \
349         } while (0)
350
351 #define COE(func,args) CALL_OR_ERROR(func,args,#func)
352 #define COE2(func,args) CALL_OR_ERROR(func,args,NULL)
353
354 #ifndef HAVE_OSX_ACLS
355 /* Store the permissions in the system ACL entry. */
356 static int store_access_in_entry(uint32 access, SMB_ACL_ENTRY_T entry)
357 {
358         if (sys_acl_set_access_bits(entry, access)) {
359                 rsyserr(FERROR, errno, "store_access_in_entry sys_acl_set_access_bits()");
360                 return -1;
361         }
362         return 0;
363 }
364 #endif
365
366 /* Pack rsync ACL -> system ACL verbatim.  Return whether we succeeded. */
367 static BOOL pack_smb_acl(SMB_ACL_T *smb_acl, const rsync_acl *racl)
368 {
369 #ifdef ACLS_NEED_MASK
370         uchar mask_bits;
371 #endif
372         size_t count;
373         id_access *ida;
374         const char *errfun = NULL;
375         SMB_ACL_ENTRY_T entry;
376
377         if (!(*smb_acl = sys_acl_init(calc_sacl_entries(racl)))) {
378                 rsyserr(FERROR, errno, "pack_smb_acl: sys_acl_init()");
379                 return False;
380         }
381
382 #ifndef HAVE_OSX_ACLS
383         COE( sys_acl_create_entry,(smb_acl, &entry) );
384         COE( sys_acl_set_info,(entry, SMB_ACL_USER_OBJ, racl->user_obj & ~NO_ENTRY, 0) );
385 #endif
386
387         for (ida = racl->names.idas, count = racl->names.count; count; ida++, count--) {
388 #ifdef SMB_ACL_NEED_SORT
389                 if (!(ida->access & NAME_IS_USER))
390                         break;
391 #endif
392                 COE( sys_acl_create_entry,(smb_acl, &entry) );
393                 COE( sys_acl_set_info,(entry,
394 #ifdef SMB_ACL_NEED_SORT
395                                        SMB_ACL_USER,
396 #else
397                                        ida->access & NAME_IS_USER ? SMB_ACL_USER : SMB_ACL_GROUP,
398 #endif
399                                        ida->access & ~NAME_IS_USER, ida->id) );
400         }
401
402 #ifndef HAVE_OSX_ACLS
403         COE( sys_acl_create_entry,(smb_acl, &entry) );
404         COE( sys_acl_set_info,(entry, SMB_ACL_GROUP_OBJ, racl->group_obj & ~NO_ENTRY, 0) );
405
406 #ifdef SMB_ACL_NEED_SORT
407         for ( ; count; ida++, count--) {
408                 COE( sys_acl_create_entry,(smb_acl, &entry) );
409                 COE( sys_acl_set_info,(entry, SMB_ACL_GROUP, ida->access, ida->id) );
410         }
411 #endif
412
413 #ifdef ACLS_NEED_MASK
414         mask_bits = racl->mask_obj == NO_ENTRY ? racl->group_obj & ~NO_ENTRY : racl->mask_obj;
415         COE( sys_acl_create_entry,(smb_acl, &entry) );
416         COE( sys_acl_set_info,(entry, SMB_ACL_MASK, mask_bits, NULL) );
417 #else
418         if (racl->mask_obj != NO_ENTRY) {
419                 COE( sys_acl_create_entry,(smb_acl, &entry) );
420                 COE( sys_acl_set_info,(entry, SMB_ACL_MASK, racl->mask_obj, 0) );
421         }
422 #endif
423
424         COE( sys_acl_create_entry,(smb_acl, &entry) );
425         COE( sys_acl_set_info,(entry, SMB_ACL_OTHER, racl->other_obj & ~NO_ENTRY, 0) );
426 #endif
427
428 #ifdef DEBUG
429         if (sys_acl_valid(*smb_acl) < 0)
430                 rprintf(FERROR, "pack_smb_acl: warning: system says the ACL I packed is invalid\n");
431 #endif
432
433         return True;
434
435   error_exit:
436         if (errfun) {
437                 rsyserr(FERROR, errno, "pack_smb_acl %s()", errfun);
438         }
439         sys_acl_free_acl(*smb_acl);
440         return False;
441 }
442
443 static int find_matching_rsync_acl(const rsync_acl *racl, SMB_ACL_TYPE_T type,
444                                    const item_list *racl_list)
445 {
446         static int access_match = -1, default_match = -1;
447         int *match = type == SMB_ACL_TYPE_ACCESS ? &access_match : &default_match;
448         size_t count = racl_list->count;
449
450         /* If this is the first time through or we didn't match the last
451          * time, then start at the end of the list, which should be the
452          * best place to start hunting. */
453         if (*match == -1)
454                 *match = racl_list->count - 1;
455         while (count--) {
456                 rsync_acl *base = racl_list->items;
457                 if (rsync_acl_equal(base + *match, racl))
458                         return *match;
459                 if (!(*match)--)
460                         *match = racl_list->count - 1;
461         }
462
463         *match = -1;
464         return *match;
465 }
466
467 static int get_rsync_acl(const char *fname, rsync_acl *racl,
468                          SMB_ACL_TYPE_T type, mode_t mode)
469 {
470         SMB_ACL_T sacl = sys_acl_get_file(fname, type);
471
472         if (sacl) {
473                 BOOL ok = unpack_smb_acl(sacl, racl);
474
475                 sys_acl_free_acl(sacl);
476                 if (!ok) {
477                         return -1;
478                 }
479         } else if (no_acl_syscall_error(errno)) {
480                 /* ACLs are not supported, so pretend we have a basic ACL. */
481                 if (type == SMB_ACL_TYPE_ACCESS)
482                         rsync_acl_fake_perms(racl, mode);
483         } else {
484                 rsyserr(FERROR, errno, "get_acl: sys_acl_get_file(%s, %s)",
485                         fname, str_acl_type(type));
486                 return -1;
487         }
488
489         return 0;
490 }
491
492 /* Return the Access Control List for the given filename. */
493 int get_acl(const char *fname, stat_x *sxp)
494 {
495         sxp->acc_acl = create_racl();
496         if (get_rsync_acl(fname, sxp->acc_acl, SMB_ACL_TYPE_ACCESS,
497                           sxp->st.st_mode) < 0) {
498                 free_acl(sxp);
499                 return -1;
500         }
501
502         if (S_ISDIR(sxp->st.st_mode)) {
503                 sxp->def_acl = create_racl();
504                 if (get_rsync_acl(fname, sxp->def_acl, SMB_ACL_TYPE_DEFAULT,
505                                   sxp->st.st_mode) < 0) {
506                         free_acl(sxp);
507                         return -1;
508                 }
509         }
510
511         return 0;
512 }
513
514 /* === Send functions === */
515
516 /* Send the ida list over the file descriptor. */
517 static void send_ida_entries(const ida_entries *idal, int f)
518 {
519         id_access *ida;
520         size_t count = idal->count;
521
522         write_varint(f, idal->count);
523
524         for (ida = idal->idas; count--; ida++) {
525                 uint32 xbits = ida->access << 2;
526                 char *name;
527                 if (ida->access & NAME_IS_USER) {
528                         xbits |= XFLAG_NAME_IS_USER;
529                         name = add_uid(ida->id);
530                 } else
531                         name = add_gid(ida->id);
532                 write_varint(f, ida->id);
533                 if (inc_recurse && name) {
534                         int len = strlen(name);
535                         write_varint(f, xbits | XFLAG_NAME_FOLLOWS);
536                         write_byte(f, len);
537                         write_buf(f, name, len);
538                 } else
539                         write_varint(f, xbits);
540         }
541 }
542
543 static void send_rsync_acl(rsync_acl *racl, SMB_ACL_TYPE_T type,
544                            item_list *racl_list, int f)
545 {
546         int ndx = find_matching_rsync_acl(racl, type, racl_list);
547
548         /* Send 0 (-1 + 1) to indicate that literal ACL data follows. */
549         write_varint(f, ndx + 1);
550
551         if (ndx < 0) {
552                 rsync_acl *new_racl = EXPAND_ITEM_LIST(racl_list, rsync_acl, 1000);
553                 uchar flags = 0;
554
555                 if (racl->user_obj != NO_ENTRY)
556                         flags |= XMIT_USER_OBJ;
557                 if (racl->group_obj != NO_ENTRY)
558                         flags |= XMIT_GROUP_OBJ;
559                 if (racl->mask_obj != NO_ENTRY)
560                         flags |= XMIT_MASK_OBJ;
561                 if (racl->other_obj != NO_ENTRY)
562                         flags |= XMIT_OTHER_OBJ;
563                 if (racl->names.count)
564                         flags |= XMIT_NAME_LIST;
565
566                 write_byte(f, flags);
567
568                 if (flags & XMIT_USER_OBJ)
569                         write_varint(f, racl->user_obj);
570                 if (flags & XMIT_GROUP_OBJ)
571                         write_varint(f, racl->group_obj);
572                 if (flags & XMIT_MASK_OBJ)
573                         write_varint(f, racl->mask_obj);
574                 if (flags & XMIT_OTHER_OBJ)
575                         write_varint(f, racl->other_obj);
576                 if (flags & XMIT_NAME_LIST)
577                         send_ida_entries(&racl->names, f);
578
579                 /* Give the allocated data to the new list object. */
580                 *new_racl = *racl;
581                 *racl = empty_rsync_acl;
582         }
583 }
584
585 /* Send the ACL from the stat_x structure down the indicated file descriptor.
586  * This also frees the ACL data. */
587 void send_acl(stat_x *sxp, int f)
588 {
589         if (!sxp->acc_acl) {
590                 sxp->acc_acl = create_racl();
591                 rsync_acl_fake_perms(sxp->acc_acl, sxp->st.st_mode);
592         }
593         /* Avoid sending values that can be inferred from other data. */
594         rsync_acl_strip_perms(sxp->acc_acl);
595
596         send_rsync_acl(sxp->acc_acl, SMB_ACL_TYPE_ACCESS, &access_acl_list, f);
597
598         if (S_ISDIR(sxp->st.st_mode)) {
599                 if (!sxp->def_acl)
600                         sxp->def_acl = create_racl();
601
602                 send_rsync_acl(sxp->def_acl, SMB_ACL_TYPE_DEFAULT, &default_acl_list, f);
603         }
604 }
605
606 /* === Receive functions === */
607
608 static uint32 recv_acl_access(uchar *name_follows_ptr, int f)
609 {
610         uint32 access = read_varint(f);
611
612         if (name_follows_ptr) {
613                 int flags = access & 3;
614                 access >>= 2;
615                 if (access & ~SMB_ACL_VALID_NAME_BITS)
616                         goto value_error;
617                 if (flags & XFLAG_NAME_FOLLOWS)
618                         *name_follows_ptr = 1;
619                 else
620                         *name_follows_ptr = 0;
621                 if (flags & XFLAG_NAME_IS_USER)
622                         access |= NAME_IS_USER;
623         } else if (access & ~SMB_ACL_VALID_OBJ_BITS) {
624           value_error:
625                 rprintf(FERROR, "recv_acl_access: value out of range: %x\n",
626                         access);
627                 exit_cleanup(RERR_STREAMIO);
628         }
629
630         return access;
631 }
632
633 static uchar recv_ida_entries(ida_entries *ent, int f)
634 {
635         uchar computed_mask_bits = 0;
636         int i, count = read_varint(f);
637
638         if (count) {
639                 if (!(ent->idas = new_array(id_access, count)))
640                         out_of_memory("recv_ida_entries");
641         } else
642                 ent->idas = NULL;
643
644         ent->count = count;
645
646         for (i = 0; i < count; i++) {
647                 uchar has_name;
648                 id_t id = read_varint(f);
649                 uint32 access = recv_acl_access(&has_name, f);
650
651                 if (has_name) {
652                         if (access & NAME_IS_USER)
653                                 id = recv_user_name(f, id);
654                         else
655                                 id = recv_group_name(f, id, NULL);
656                 } else if (access & NAME_IS_USER) {
657                         if (inc_recurse && am_root && !numeric_ids)
658                                 id = match_uid(id);
659                 } else {
660                         if (inc_recurse && (!am_root || !numeric_ids))
661                                 id = match_gid(id, NULL);
662                 }
663
664                 ent->idas[i].id = id;
665                 ent->idas[i].access = access;
666                 computed_mask_bits |= access;
667         }
668
669         return computed_mask_bits & ~NO_ENTRY;
670 }
671
672 static int recv_rsync_acl(item_list *racl_list, SMB_ACL_TYPE_T type, int f)
673 {
674         uchar computed_mask_bits = 0;
675         acl_duo *duo_item;
676         uchar flags;
677         int ndx = read_varint(f);
678
679         if (ndx < 0 || (size_t)ndx > racl_list->count) {
680                 rprintf(FERROR, "recv_acl_index: %s ACL index %d > %d\n",
681                         str_acl_type(type), ndx, (int)racl_list->count);
682                 exit_cleanup(RERR_STREAMIO);
683         }
684
685         if (ndx != 0)
686                 return ndx - 1;
687         
688         ndx = racl_list->count;
689         duo_item = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
690         duo_item->racl = empty_rsync_acl;
691
692         flags = read_byte(f);
693
694         if (flags & XMIT_USER_OBJ)
695                 duo_item->racl.user_obj = recv_acl_access(NULL, f);
696         if (flags & XMIT_GROUP_OBJ)
697                 duo_item->racl.group_obj = recv_acl_access(NULL, f);
698         if (flags & XMIT_MASK_OBJ)
699                 duo_item->racl.mask_obj = recv_acl_access(NULL, f);
700         if (flags & XMIT_OTHER_OBJ)
701                 duo_item->racl.other_obj = recv_acl_access(NULL, f);
702         if (flags & XMIT_NAME_LIST)
703                 computed_mask_bits |= recv_ida_entries(&duo_item->racl.names, f);
704
705         if (!duo_item->racl.names.count) {
706                 /* If we received a superfluous mask, throw it away. */
707                 if (duo_item->racl.mask_obj != NO_ENTRY) {
708                         /* Mask off the group perms with it first. */
709                         duo_item->racl.group_obj &= duo_item->racl.mask_obj | NO_ENTRY;
710                         duo_item->racl.mask_obj = NO_ENTRY;
711                 }
712         }
713 #ifndef HAVE_OSX_ACLS
714         else if (duo_item->racl.mask_obj == NO_ENTRY) /* Must be non-empty with lists. */
715                 duo_item->racl.mask_obj = (computed_mask_bits | duo_item->racl.group_obj) & ~NO_ENTRY;
716 #endif
717
718         duo_item->sacl = NULL;
719
720         return ndx;
721 }
722
723 /* Receive the ACL info the sender has included for this file-list entry. */
724 void receive_acl(struct file_struct *file, int f)
725 {
726         F_ACL(file) = recv_rsync_acl(&access_acl_list, SMB_ACL_TYPE_ACCESS, f);
727
728         if (S_ISDIR(file->mode))
729                 F_DIR_DEFACL(file) = recv_rsync_acl(&default_acl_list, SMB_ACL_TYPE_DEFAULT, f);
730 }
731
732 static int cache_rsync_acl(rsync_acl *racl, SMB_ACL_TYPE_T type, item_list *racl_list)
733 {
734         int ndx;
735
736         if (!racl)
737                 ndx = -1;
738         else if ((ndx = find_matching_rsync_acl(racl, type, racl_list)) == -1) {
739                 acl_duo *new_duo;
740                 ndx = racl_list->count;
741                 new_duo = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
742                 new_duo->racl = *racl;
743                 new_duo->sacl = NULL;
744                 *racl = empty_rsync_acl;
745         }
746
747         return ndx;
748 }
749
750 /* Turn the ACL data in stat_x into cached ACL data, setting the index
751  * values in the file struct. */
752 void cache_acl(struct file_struct *file, stat_x *sxp)
753 {
754         F_ACL(file) = cache_rsync_acl(sxp->acc_acl,
755                                       SMB_ACL_TYPE_ACCESS, &access_acl_list);
756
757         if (S_ISDIR(sxp->st.st_mode)) {
758                 F_DIR_DEFACL(file) = cache_rsync_acl(sxp->def_acl,
759                                       SMB_ACL_TYPE_DEFAULT, &default_acl_list);
760         }
761 }
762
763 #ifndef HAVE_OSX_ACLS
764 static mode_t change_sacl_perms(SMB_ACL_T sacl, rsync_acl *racl, mode_t old_mode, mode_t mode)
765 {
766         SMB_ACL_ENTRY_T entry;
767         const char *errfun;
768         int rc;
769
770         if (S_ISDIR(mode)) {
771                 /* If the sticky bit is going on, it's not safe to allow all
772                  * the new ACL to go into effect before it gets set. */
773 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
774                 if (mode & S_ISVTX)
775                         mode &= ~0077;
776 #else
777                 if (mode & S_ISVTX && !(old_mode & S_ISVTX))
778                         mode &= ~0077;
779         } else {
780                 /* If setuid or setgid is going off, it's not safe to allow all
781                  * the new ACL to go into effect before they get cleared. */
782                 if ((old_mode & S_ISUID && !(mode & S_ISUID))
783                  || (old_mode & S_ISGID && !(mode & S_ISGID)))
784                         mode &= ~0077;
785 #endif
786         }
787
788         errfun = "sys_acl_get_entry";
789         for (rc = sys_acl_get_entry(sacl, SMB_ACL_FIRST_ENTRY, &entry);
790              rc == 1;
791              rc = sys_acl_get_entry(sacl, SMB_ACL_NEXT_ENTRY, &entry)) {
792                 SMB_ACL_TAG_T tag_type;
793                 if ((rc = sys_acl_get_tag_type(entry, &tag_type)) != 0) {
794                         errfun = "sys_acl_get_tag_type";
795                         break;
796                 }
797                 switch (tag_type) {
798                 case SMB_ACL_USER_OBJ:
799                         COE2( store_access_in_entry,((mode >> 6) & 7, entry) );
800                         break;
801                 case SMB_ACL_GROUP_OBJ:
802                         /* group is only empty when identical to group perms. */
803                         if (racl->group_obj != NO_ENTRY)
804                                 break;
805                         COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
806                         break;
807                 case SMB_ACL_MASK:
808 #ifndef ACLS_NEED_MASK
809                         /* mask is only empty when we don't need it. */
810                         if (racl->mask_obj == NO_ENTRY)
811                                 break;
812 #endif
813                         COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
814                         break;
815                 case SMB_ACL_OTHER:
816                         COE2( store_access_in_entry,(mode & 7, entry) );
817                         break;
818                 }
819         }
820         if (rc) {
821           error_exit:
822                 if (errfun) {
823                         rsyserr(FERROR, errno, "change_sacl_perms: %s()",
824                                 errfun);
825                 }
826                 return (mode_t)~0;
827         }
828
829 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
830         /* Ensure that chmod() will be called to restore any lost setid bits. */
831         if (old_mode & (S_ISUID | S_ISGID | S_ISVTX)
832          && BITS_EQUAL(old_mode, mode, CHMOD_BITS))
833                 old_mode &= ~(S_ISUID | S_ISGID | S_ISVTX);
834 #endif
835
836         /* Return the mode of the file on disk, as we will set them. */
837         return (old_mode & ~ACCESSPERMS) | (mode & ACCESSPERMS);
838 }
839 #endif
840
841 static int set_rsync_acl(const char *fname, acl_duo *duo_item,
842                          SMB_ACL_TYPE_T type, stat_x *sxp, mode_t mode)
843 {
844         if (type == SMB_ACL_TYPE_DEFAULT
845          && duo_item->racl.user_obj == NO_ENTRY) {
846                 if (sys_acl_delete_def_file(fname) < 0) {
847                         rsyserr(FERROR, errno, "set_acl: sys_acl_delete_def_file(%s)",
848                                 fname);
849                         return -1;
850                 }
851         } else {
852                 mode_t cur_mode = sxp->st.st_mode;
853                 if (!duo_item->sacl
854                  && !pack_smb_acl(&duo_item->sacl, &duo_item->racl))
855                         return -1;
856 #ifdef HAVE_OSX_ACLS
857                 mode = 0; /* eliminate compiler warning */
858 #else
859                 if (type == SMB_ACL_TYPE_ACCESS) {
860                         cur_mode = change_sacl_perms(duo_item->sacl, &duo_item->racl,
861                                                      cur_mode, mode);
862                         if (cur_mode == (mode_t)~0)
863                                 return 0;
864                 }
865 #endif
866                 if (sys_acl_set_file(fname, type, duo_item->sacl) < 0) {
867                         rsyserr(FERROR, errno, "set_acl: sys_acl_set_file(%s, %s)",
868                         fname, str_acl_type(type));
869                         return -1;
870                 }
871                 if (type == SMB_ACL_TYPE_ACCESS)
872                         sxp->st.st_mode = cur_mode;
873         }
874
875         return 0;
876 }
877
878 /* Set ACL on indicated filename.
879  *
880  * This sets extended access ACL entries and default ACL.  If convenient,
881  * it sets permission bits along with the access ACL and signals having
882  * done so by modifying sxp->st.st_mode.
883  *
884  * Returns 1 for unchanged, 0 for changed, -1 for failed.  Call this
885  * with fname set to NULL to just check if the ACL is unchanged. */
886 int set_acl(const char *fname, const struct file_struct *file, stat_x *sxp)
887 {
888         int unchanged = 1;
889         int32 ndx;
890         BOOL eq;
891
892         if (!dry_run && (read_only || list_only)) {
893                 errno = EROFS;
894                 return -1;
895         }
896
897         ndx = F_ACL(file);
898         if (ndx >= 0 && (size_t)ndx < access_acl_list.count) {
899                 acl_duo *duo_item = access_acl_list.items;
900                 duo_item += ndx;
901                 eq = sxp->acc_acl
902                   && rsync_acl_equal_enough(sxp->acc_acl, &duo_item->racl, file->mode);
903                 if (!eq) {
904                         unchanged = 0;
905                         if (!dry_run && fname
906                          && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_ACCESS,
907                                           sxp, file->mode) < 0)
908                                 unchanged = -1;
909                 }
910         }
911
912         if (!S_ISDIR(sxp->st.st_mode))
913                 return unchanged;
914
915         ndx = F_DIR_DEFACL(file);
916         if (ndx >= 0 && (size_t)ndx < default_acl_list.count) {
917                 acl_duo *duo_item = default_acl_list.items;
918                 duo_item += ndx;
919                 eq = sxp->def_acl && rsync_acl_equal(sxp->def_acl, &duo_item->racl);
920                 if (!eq) {
921                         if (unchanged > 0)
922                                 unchanged = 0;
923                         if (!dry_run && fname
924                          && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_DEFAULT,
925                                           sxp, file->mode) < 0)
926                                 unchanged = -1;
927                 }
928         }
929
930         return unchanged;
931 }
932
933 /* Non-incremental recursion needs to convert all the received IDs.
934  * This is done in a single pass after receiving the whole file-list. */
935 static void match_racl_ids(const item_list *racl_list)
936 {
937         int list_cnt, name_cnt;
938         acl_duo *duo_item = racl_list->items;
939         for (list_cnt = racl_list->count; list_cnt--; duo_item++) {
940                 ida_entries *idal = &duo_item->racl.names;
941                 id_access *ida = idal->idas;
942                 for (name_cnt = idal->count; name_cnt--; ida++) {
943                         if (ida->access & NAME_IS_USER)
944                                 ida->id = match_uid(ida->id);
945                         else
946                                 ida->id = match_gid(ida->id, NULL);
947                 }
948         }
949 }
950
951 void match_acl_ids(void)
952 {
953         match_racl_ids(&access_acl_list);
954         match_racl_ids(&default_acl_list);
955 }
956
957 /* This is used by dest_mode(). */
958 int default_perms_for_dir(const char *dir)
959 {
960         rsync_acl racl;
961         SMB_ACL_T sacl;
962         BOOL ok;
963         int perms;
964
965         if (dir == NULL)
966                 dir = ".";
967         perms = ACCESSPERMS & ~orig_umask;
968         /* Read the directory's default ACL.  If it has none, this will successfully return an empty ACL. */
969         sacl = sys_acl_get_file(dir, SMB_ACL_TYPE_DEFAULT);
970         if (sacl == NULL) {
971                 /* Couldn't get an ACL.  Darn. */
972                 switch (errno) {
973 #ifdef ENOTSUP
974                 case ENOTSUP:
975 #endif
976                 case ENOSYS:
977                         /* No ACLs are available. */
978                         break;
979                 case ENOENT:
980                         if (dry_run) {
981                                 /* We're doing a dry run, so the containing directory
982                                  * wasn't actually created.  Don't worry about it. */
983                                 break;
984                         }
985                         /* Otherwise fall through. */
986                 default:
987                         rprintf(FERROR, "default_perms_for_dir: sys_acl_get_file(%s, %s): %s, falling back on umask\n",
988                                 dir, str_acl_type(SMB_ACL_TYPE_DEFAULT), strerror(errno));
989                 }
990                 return perms;
991         }
992
993         /* Convert it. */
994         racl = empty_rsync_acl;
995         ok = unpack_smb_acl(sacl, &racl);
996         sys_acl_free_acl(sacl);
997         if (!ok) {
998                 rprintf(FERROR, "default_perms_for_dir: unpack_smb_acl failed, falling back on umask\n");
999                 return perms;
1000         }
1001
1002         /* Apply the permission-bit entries of the default ACL, if any. */
1003         if (racl.user_obj != NO_ENTRY) {
1004                 perms = rsync_acl_get_perms(&racl);
1005                 if (verbose > 2)
1006                         rprintf(FINFO, "got ACL-based default perms %o for directory %s\n", perms, dir);
1007         }
1008
1009         rsync_acl_free(&racl);
1010         return perms;
1011 }
1012
1013 #endif /* SUPPORT_ACLS */