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;
 471
 472 #ifdef SUPPORT_XATTRS
 473         /* --fake-super support: load ACLs from an xattr. */
 474         if (am_root < 0) {
 475                 char *buf;
 476                 size_t len;
 477                 int cnt;
 478
 479                 if ((buf = get_xattr_acl(fname, type == SMB_ACL_TYPE_ACCESS, &len)) == NULL)
 480                         return 0;
 481                 cnt = (len - 4*4) / (4+4);
 482                 if (len < 4*4 || len != (size_t)cnt*(4+4) + 4*4)
 483                         return -1;
 484
 485                 racl->user_obj = IVAL(buf, 0);
 486                 racl->group_obj = IVAL(buf, 4);
 487                 racl->mask_obj = IVAL(buf, 8);
 488                 racl->other_obj = IVAL(buf, 12);
 489
 490                 if (cnt) {
 491                         char *bp = buf + 4*4;
 492                         id_access *ida;
 493                         if (!(ida = racl->names.idas = new_array(id_access, cnt)))
 494                                 out_of_memory("get_rsync_acl");
 495                         racl->names.count = cnt;
 496                         for ( ; cnt--; ida++, bp += 4+4) {
 497                                 ida->id = IVAL(bp, 0);
 498                                 ida->access = IVAL(bp, 4);
 499                         }
 500                 }
 501                 free(buf);
 502                 return 0;
 503         }
 504 #endif
 505
 506         if ((sacl = sys_acl_get_file(fname, type)) != 0) {
 507                 BOOL ok = unpack_smb_acl(sacl, racl);
 508
 509                 sys_acl_free_acl(sacl);
 510                 if (!ok) {
 511                         return -1;
 512                 }
 513         } else if (no_acl_syscall_error(errno)) {
 514                 /* ACLs are not supported, so pretend we have a basic ACL. */
 515                 if (type == SMB_ACL_TYPE_ACCESS)
 516                         rsync_acl_fake_perms(racl, mode);
 517         } else {
 518                 rsyserr(FERROR, errno, "get_acl: sys_acl_get_file(%s, %s)",
 519                         fname, str_acl_type(type));
 520                 return -1;
 521         }
 522
 523         return 0;
 524 }
 525
 526 /* Return the Access Control List for the given filename. */
 527 int get_acl(const char *fname, stat_x *sxp)
 528 {
 529         sxp->acc_acl = create_racl();
 530         if (get_rsync_acl(fname, sxp->acc_acl, SMB_ACL_TYPE_ACCESS,
 531                           sxp->st.st_mode) < 0) {
 532                 free_acl(sxp);
 533                 return -1;
 534         }
 535
 536         if (S_ISDIR(sxp->st.st_mode)) {
 537                 sxp->def_acl = create_racl();
 538                 if (get_rsync_acl(fname, sxp->def_acl, SMB_ACL_TYPE_DEFAULT,
 539                                   sxp->st.st_mode) < 0) {
 540                         free_acl(sxp);
 541                         return -1;
 542                 }
 543         }
 544
 545         return 0;
 546 }
 547
 548 /* === Send functions === */
 549
 550 /* Send the ida list over the file descriptor. */
 551 static void send_ida_entries(const ida_entries *idal, int f)
 552 {
 553         id_access *ida;
 554         size_t count = idal->count;
 555
 556         write_varint(f, idal->count);
 557
 558         for (ida = idal->idas; count--; ida++) {
 559                 uint32 xbits = ida->access << 2;
 560                 char *name;
 561                 if (ida->access & NAME_IS_USER) {
 562                         xbits |= XFLAG_NAME_IS_USER;
 563                         name = add_uid(ida->id);
 564                 } else
 565                         name = add_gid(ida->id);
 566                 write_varint(f, ida->id);
 567                 if (inc_recurse && name) {
 568                         int len = strlen(name);
 569                         write_varint(f, xbits | XFLAG_NAME_FOLLOWS);
 570                         write_byte(f, len);
 571                         write_buf(f, name, len);
 572                 } else
 573                         write_varint(f, xbits);
 574         }
 575 }
 576
 577 static void send_rsync_acl(rsync_acl *racl, SMB_ACL_TYPE_T type,
 578                            item_list *racl_list, int f)
 579 {
 580         int ndx = find_matching_rsync_acl(racl, type, racl_list);
 581
 582         /* Send 0 (-1 + 1) to indicate that literal ACL data follows. */
 583         write_varint(f, ndx + 1);
 584
 585         if (ndx < 0) {
 586                 rsync_acl *new_racl = EXPAND_ITEM_LIST(racl_list, rsync_acl, 1000);
 587                 uchar flags = 0;
 588
 589                 if (racl->user_obj != NO_ENTRY)
 590                         flags |= XMIT_USER_OBJ;
 591                 if (racl->group_obj != NO_ENTRY)
 592                         flags |= XMIT_GROUP_OBJ;
 593                 if (racl->mask_obj != NO_ENTRY)
 594                         flags |= XMIT_MASK_OBJ;
 595                 if (racl->other_obj != NO_ENTRY)
 596                         flags |= XMIT_OTHER_OBJ;
 597                 if (racl->names.count)
 598                         flags |= XMIT_NAME_LIST;
 599
 600                 write_byte(f, flags);
 601
 602                 if (flags & XMIT_USER_OBJ)
 603                         write_varint(f, racl->user_obj);
 604                 if (flags & XMIT_GROUP_OBJ)
 605                         write_varint(f, racl->group_obj);
 606                 if (flags & XMIT_MASK_OBJ)
 607                         write_varint(f, racl->mask_obj);
 608                 if (flags & XMIT_OTHER_OBJ)
 609                         write_varint(f, racl->other_obj);
 610                 if (flags & XMIT_NAME_LIST)
 611                         send_ida_entries(&racl->names, f);
 612
 613                 /* Give the allocated data to the new list object. */
 614                 *new_racl = *racl;
 615                 *racl = empty_rsync_acl;
 616         }
 617 }
 618
 619 /* Send the ACL from the stat_x structure down the indicated file descriptor.
 620  * This also frees the ACL data. */
 621 void send_acl(stat_x *sxp, int f)
 622 {
 623         if (!sxp->acc_acl) {
 624                 sxp->acc_acl = create_racl();
 625                 rsync_acl_fake_perms(sxp->acc_acl, sxp->st.st_mode);
 626         }
 627         /* Avoid sending values that can be inferred from other data. */
 628         rsync_acl_strip_perms(sxp->acc_acl);
 629
 630         send_rsync_acl(sxp->acc_acl, SMB_ACL_TYPE_ACCESS, &access_acl_list, f);
 631
 632         if (S_ISDIR(sxp->st.st_mode)) {
 633                 if (!sxp->def_acl)
 634                         sxp->def_acl = create_racl();
 635
 636                 send_rsync_acl(sxp->def_acl, SMB_ACL_TYPE_DEFAULT, &default_acl_list, f);
 637         }
 638 }
 639
 640 /* === Receive functions === */
 641
 642 static uint32 recv_acl_access(uchar *name_follows_ptr, int f)
 643 {
 644         uint32 access = read_varint(f);
 645
 646         if (name_follows_ptr) {
 647                 int flags = access & 3;
 648                 access >>= 2;
 649                 if (am_root >= 0 && access & ~SMB_ACL_VALID_NAME_BITS)
 650                         goto value_error;
 651                 if (flags & XFLAG_NAME_FOLLOWS)
 652                         *name_follows_ptr = 1;
 653                 else
 654                         *name_follows_ptr = 0;
 655                 if (flags & XFLAG_NAME_IS_USER)
 656                         access |= NAME_IS_USER;
 657         } else if (am_root >= 0 && access & ~SMB_ACL_VALID_OBJ_BITS) {
 658           value_error:
 659                 rprintf(FERROR, "recv_acl_access: value out of range: %x\n",
 660                         access);
 661                 exit_cleanup(RERR_STREAMIO);
 662         }
 663
 664         return access;
 665 }
 666
 667 static uchar recv_ida_entries(ida_entries *ent, int f)
 668 {
 669         uchar computed_mask_bits = 0;
 670         int i, count = read_varint(f);
 671
 672         if (count) {
 673                 if (!(ent->idas = new_array(id_access, count)))
 674                         out_of_memory("recv_ida_entries");
 675         } else
 676                 ent->idas = NULL;
 677
 678         ent->count = count;
 679
 680         for (i = 0; i < count; i++) {
 681                 uchar has_name;
 682                 id_t id = read_varint(f);
 683                 uint32 access = recv_acl_access(&has_name, f);
 684
 685                 if (has_name) {
 686                         if (access & NAME_IS_USER)
 687                                 id = recv_user_name(f, id);
 688                         else
 689                                 id = recv_group_name(f, id, NULL);
 690                 } else if (access & NAME_IS_USER) {
 691                         if (inc_recurse && am_root && !numeric_ids)
 692                                 id = match_uid(id);
 693                 } else {
 694                         if (inc_recurse && (!am_root || !numeric_ids))
 695                                 id = match_gid(id, NULL);
 696                 }
 697
 698                 ent->idas[i].id = id;
 699                 ent->idas[i].access = access;
 700                 computed_mask_bits |= access;
 701         }
 702
 703         return computed_mask_bits & ~NO_ENTRY;
 704 }
 705
 706 static int recv_rsync_acl(item_list *racl_list, SMB_ACL_TYPE_T type, int f)
 707 {
 708         uchar computed_mask_bits = 0;
 709         acl_duo *duo_item;
 710         uchar flags;
 711         int ndx = read_varint(f);
 712
 713         if (ndx < 0 || (size_t)ndx > racl_list->count) {
 714                 rprintf(FERROR, "recv_acl_index: %s ACL index %d > %d\n",
 715                         str_acl_type(type), ndx, (int)racl_list->count);
 716                 exit_cleanup(RERR_STREAMIO);
 717         }
 718
 719         if (ndx != 0)
 720                 return ndx - 1;
 721
 722         ndx = racl_list->count;
 723         duo_item = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
 724         duo_item->racl = empty_rsync_acl;
 725
 726         flags = read_byte(f);
 727
 728         if (flags & XMIT_USER_OBJ)
 729                 duo_item->racl.user_obj = recv_acl_access(NULL, f);
 730         if (flags & XMIT_GROUP_OBJ)
 731                 duo_item->racl.group_obj = recv_acl_access(NULL, f);
 732         if (flags & XMIT_MASK_OBJ)
 733                 duo_item->racl.mask_obj = recv_acl_access(NULL, f);
 734         if (flags & XMIT_OTHER_OBJ)
 735                 duo_item->racl.other_obj = recv_acl_access(NULL, f);
 736         if (flags & XMIT_NAME_LIST)
 737                 computed_mask_bits |= recv_ida_entries(&duo_item->racl.names, f);
 738
 739 #ifdef HAVE_OSX_ACLS
 740         /* If we received a superfluous mask, throw it away. */
 741         duo_item->racl.mask_obj = NO_ENTRY;
 742 #else
 743         if (!duo_item->racl.names.count) {
 744                 /* If we received a superfluous mask, throw it away. */
 745                 if (duo_item->racl.mask_obj != NO_ENTRY) {
 746                         /* Mask off the group perms with it first. */
 747                         duo_item->racl.group_obj &= duo_item->racl.mask_obj | NO_ENTRY;
 748                         duo_item->racl.mask_obj = NO_ENTRY;
 749                 }
 750         } else if (duo_item->racl.mask_obj == NO_ENTRY) /* Must be non-empty with lists. */
 751                 duo_item->racl.mask_obj = (computed_mask_bits | duo_item->racl.group_obj) & ~NO_ENTRY;
 752 #endif
 753
 754         duo_item->sacl = NULL;
 755
 756         return ndx;
 757 }
 758
 759 /* Receive the ACL info the sender has included for this file-list entry. */
 760 void receive_acl(struct file_struct *file, int f)
 761 {
 762         F_ACL(file) = recv_rsync_acl(&access_acl_list, SMB_ACL_TYPE_ACCESS, f);
 763
 764         if (S_ISDIR(file->mode))
 765                 F_DIR_DEFACL(file) = recv_rsync_acl(&default_acl_list, SMB_ACL_TYPE_DEFAULT, f);
 766 }
 767
 768 static int cache_rsync_acl(rsync_acl *racl, SMB_ACL_TYPE_T type, item_list *racl_list)
 769 {
 770         int ndx;
 771
 772         if (!racl)
 773                 ndx = -1;
 774         else if ((ndx = find_matching_rsync_acl(racl, type, racl_list)) == -1) {
 775                 acl_duo *new_duo;
 776                 ndx = racl_list->count;
 777                 new_duo = EXPAND_ITEM_LIST(racl_list, acl_duo, 1000);
 778                 new_duo->racl = *racl;
 779                 new_duo->sacl = NULL;
 780                 *racl = empty_rsync_acl;
 781         }
 782
 783         return ndx;
 784 }
 785
 786 /* Turn the ACL data in stat_x into cached ACL data, setting the index
 787  * values in the file struct. */
 788 void cache_acl(struct file_struct *file, stat_x *sxp)
 789 {
 790         F_ACL(file) = cache_rsync_acl(sxp->acc_acl,
 791                                       SMB_ACL_TYPE_ACCESS, &access_acl_list);
 792
 793         if (S_ISDIR(sxp->st.st_mode)) {
 794                 F_DIR_DEFACL(file) = cache_rsync_acl(sxp->def_acl,
 795                                       SMB_ACL_TYPE_DEFAULT, &default_acl_list);
 796         }
 797 }
 798
 799 #ifndef HAVE_OSX_ACLS
 800 static mode_t change_sacl_perms(SMB_ACL_T sacl, rsync_acl *racl, mode_t old_mode, mode_t mode)
 801 {
 802         SMB_ACL_ENTRY_T entry;
 803         const char *errfun;
 804         int rc;
 805
 806         if (S_ISDIR(mode)) {
 807                 /* If the sticky bit is going on, it's not safe to allow all
 808                  * the new ACL to go into effect before it gets set. */
 809 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
 810                 if (mode & S_ISVTX)
 811                         mode &= ~0077;
 812 #else
 813                 if (mode & S_ISVTX && !(old_mode & S_ISVTX))
 814                         mode &= ~0077;
 815         } else {
 816                 /* If setuid or setgid is going off, it's not safe to allow all
 817                  * the new ACL to go into effect before they get cleared. */
 818                 if ((old_mode & S_ISUID && !(mode & S_ISUID))
 819                  || (old_mode & S_ISGID && !(mode & S_ISGID)))
 820                         mode &= ~0077;
 821 #endif
 822         }
 823
 824         errfun = "sys_acl_get_entry";
 825         for (rc = sys_acl_get_entry(sacl, SMB_ACL_FIRST_ENTRY, &entry);
 826              rc == 1;
 827              rc = sys_acl_get_entry(sacl, SMB_ACL_NEXT_ENTRY, &entry)) {
 828                 SMB_ACL_TAG_T tag_type;
 829                 if ((rc = sys_acl_get_tag_type(entry, &tag_type)) != 0) {
 830                         errfun = "sys_acl_get_tag_type";
 831                         break;
 832                 }
 833                 switch (tag_type) {
 834                 case SMB_ACL_USER_OBJ:
 835                         COE2( store_access_in_entry,((mode >> 6) & 7, entry) );
 836                         break;
 837                 case SMB_ACL_GROUP_OBJ:
 838                         /* group is only empty when identical to group perms. */
 839                         if (racl->group_obj != NO_ENTRY)
 840                                 break;
 841                         COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
 842                         break;
 843                 case SMB_ACL_MASK:
 844 #ifndef ACLS_NEED_MASK
 845                         /* mask is only empty when we don't need it. */
 846                         if (racl->mask_obj == NO_ENTRY)
 847                                 break;
 848 #endif
 849                         COE2( store_access_in_entry,((mode >> 3) & 7, entry) );
 850                         break;
 851                 case SMB_ACL_OTHER:
 852                         COE2( store_access_in_entry,(mode & 7, entry) );
 853                         break;
 854                 }
 855         }
 856         if (rc) {
 857           error_exit:
 858                 if (errfun) {
 859                         rsyserr(FERROR, errno, "change_sacl_perms: %s()",
 860                                 errfun);
 861                 }
 862                 return (mode_t)~0;
 863         }
 864
 865 #ifdef SMB_ACL_LOSES_SPECIAL_MODE_BITS
 866         /* Ensure that chmod() will be called to restore any lost setid bits. */
 867         if (old_mode & (S_ISUID | S_ISGID | S_ISVTX)
 868          && BITS_EQUAL(old_mode, mode, CHMOD_BITS))
 869                 old_mode &= ~(S_ISUID | S_ISGID | S_ISVTX);
 870 #endif
 871
 872         /* Return the mode of the file on disk, as we will set them. */
 873         return (old_mode & ~ACCESSPERMS) | (mode & ACCESSPERMS);
 874 }
 875 #endif
 876
 877 static int set_rsync_acl(const char *fname, acl_duo *duo_item,
 878                          SMB_ACL_TYPE_T type, stat_x *sxp, mode_t mode)
 879 {
 880         if (type == SMB_ACL_TYPE_DEFAULT
 881          && duo_item->racl.user_obj == NO_ENTRY) {
 882                 int rc;
 883 #ifdef SUPPORT_XATTRS
 884                 /* --fake-super support: delete default ACL from xattrs. */
 885                 if (am_root < 0)
 886                         rc = del_def_xattr_acl(fname);
 887                 else
 888 #endif
 889                         rc = sys_acl_delete_def_file(fname);
 890                 if (rc < 0) {
 891                         rsyserr(FERROR, errno, "set_acl: sys_acl_delete_def_file(%s)",
 892                                 fname);
 893                         return -1;
 894                 }
 895 #ifdef SUPPORT_XATTRS
 896         } else if (am_root < 0) {
 897                 /* --fake-super support: store ACLs in an xattr. */
 898                 int cnt = duo_item->racl.names.count;
 899                 size_t len = 4*4 + cnt * (4+4);
 900                 char *buf = new_array(char, len);
 901                 int rc;
 902
 903                 SIVAL(buf, 0, duo_item->racl.user_obj);
 904                 SIVAL(buf, 4, duo_item->racl.group_obj);
 905                 SIVAL(buf, 8, duo_item->racl.mask_obj);
 906                 SIVAL(buf, 12, duo_item->racl.other_obj);
 907
 908                 if (cnt) {
 909                         char *bp = buf + 4*4;
 910                         id_access *ida = duo_item->racl.names.idas;
 911                         for ( ; cnt--; ida++, bp += 4+4) {
 912                                 SIVAL(bp, 0, ida->id);
 913                                 SIVAL(bp, 4, ida->access);
 914                         }
 915                 }
 916                 rc = set_xattr_acl(fname, type == SMB_ACL_TYPE_ACCESS, buf, len);
 917                 free(buf);
 918                 return rc;
 919 #endif
 920         } else {
 921                 mode_t cur_mode = sxp->st.st_mode;
 922                 if (!duo_item->sacl
 923                  && !pack_smb_acl(&duo_item->sacl, &duo_item->racl))
 924                         return -1;
 925 #ifdef HAVE_OSX_ACLS
 926                 mode = 0; /* eliminate compiler warning */
 927 #else
 928                 if (type == SMB_ACL_TYPE_ACCESS) {
 929                         cur_mode = change_sacl_perms(duo_item->sacl, &duo_item->racl,
 930                                                      cur_mode, mode);
 931                         if (cur_mode == (mode_t)~0)
 932                                 return 0;
 933                 }
 934 #endif
 935                 if (sys_acl_set_file(fname, type, duo_item->sacl) < 0) {
 936                         rsyserr(FERROR, errno, "set_acl: sys_acl_set_file(%s, %s)",
 937                         fname, str_acl_type(type));
 938                         return -1;
 939                 }
 940                 if (type == SMB_ACL_TYPE_ACCESS)
 941                         sxp->st.st_mode = cur_mode;
 942         }
 943
 944         return 0;
 945 }
 946
 947 /* Set ACL on indicated filename.
 948  *
 949  * This sets extended access ACL entries and default ACL.  If convenient,
 950  * it sets permission bits along with the access ACL and signals having
 951  * done so by modifying sxp->st.st_mode.
 952  *
 953  * Returns 1 for unchanged, 0 for changed, -1 for failed.  Call this
 954  * with fname set to NULL to just check if the ACL is unchanged. */
 955 int set_acl(const char *fname, const struct file_struct *file, stat_x *sxp)
 956 {
 957         int unchanged = 1;
 958         int32 ndx;
 959         BOOL eq;
 960
 961         if (!dry_run && (read_only || list_only)) {
 962                 errno = EROFS;
 963                 return -1;
 964         }
 965
 966         ndx = F_ACL(file);
 967         if (ndx >= 0 && (size_t)ndx < access_acl_list.count) {
 968                 acl_duo *duo_item = access_acl_list.items;
 969                 duo_item += ndx;
 970                 eq = sxp->acc_acl
 971                   && rsync_acl_equal_enough(sxp->acc_acl, &duo_item->racl, file->mode);
 972                 if (!eq) {
 973                         unchanged = 0;
 974                         if (!dry_run && fname
 975                          && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_ACCESS,
 976                                           sxp, file->mode) < 0)
 977                                 unchanged = -1;
 978                 }
 979         }
 980
 981         if (!S_ISDIR(sxp->st.st_mode))
 982                 return unchanged;
 983
 984         ndx = F_DIR_DEFACL(file);
 985         if (ndx >= 0 && (size_t)ndx < default_acl_list.count) {
 986                 acl_duo *duo_item = default_acl_list.items;
 987                 duo_item += ndx;
 988                 eq = sxp->def_acl && rsync_acl_equal(sxp->def_acl, &duo_item->racl);
 989                 if (!eq) {
 990                         if (unchanged > 0)
 991                                 unchanged = 0;
 992                         if (!dry_run && fname
 993                          && set_rsync_acl(fname, duo_item, SMB_ACL_TYPE_DEFAULT,
 994                                           sxp, file->mode) < 0)
 995                                 unchanged = -1;
 996                 }
 997         }
 998
 999         return unchanged;
1000 }
1001
1002 /* Non-incremental recursion needs to convert all the received IDs.
1003  * This is done in a single pass after receiving the whole file-list. */
1004 static void match_racl_ids(const item_list *racl_list)
1005 {
1006         int list_cnt, name_cnt;
1007         acl_duo *duo_item = racl_list->items;
1008         for (list_cnt = racl_list->count; list_cnt--; duo_item++) {
1009                 ida_entries *idal = &duo_item->racl.names;
1010                 id_access *ida = idal->idas;
1011                 for (name_cnt = idal->count; name_cnt--; ida++) {
1012                         if (ida->access & NAME_IS_USER)
1013                                 ida->id = match_uid(ida->id);
1014                         else
1015                                 ida->id = match_gid(ida->id, NULL);
1016                 }
1017         }
1018 }
1019
1020 void match_acl_ids(void)
1021 {
1022         match_racl_ids(&access_acl_list);
1023         match_racl_ids(&default_acl_list);
1024 }
1025
1026 /* This is used by dest_mode(). */
1027 int default_perms_for_dir(const char *dir)
1028 {
1029         rsync_acl racl;
1030         SMB_ACL_T sacl;
1031         BOOL ok;
1032         int perms;
1033
1034         if (dir == NULL)
1035                 dir = ".";
1036         perms = ACCESSPERMS & ~orig_umask;
1037         /* Read the directory's default ACL.  If it has none, this will successfully return an empty ACL. */
1038         sacl = sys_acl_get_file(dir, SMB_ACL_TYPE_DEFAULT);
1039         if (sacl == NULL) {
1040                 /* Couldn't get an ACL.  Darn. */
1041                 switch (errno) {
1042 #ifdef ENOTSUP
1043                 case ENOTSUP:
1044 #endif
1045                 case ENOSYS:
1046                         /* No ACLs are available. */
1047                         break;
1048                 case ENOENT:
1049                         if (dry_run) {
1050                                 /* We're doing a dry run, so the containing directory
1051                                  * wasn't actually created.  Don't worry about it. */
1052                                 break;
1053                         }
1054                         /* Otherwise fall through. */
1055                 default:
1056                         rprintf(FERROR, "default_perms_for_dir: sys_acl_get_file(%s, %s): %s, falling back on umask\n",
1057                                 dir, str_acl_type(SMB_ACL_TYPE_DEFAULT), strerror(errno));
1058                 }
1059                 return perms;
1060         }
1061
1062         /* Convert it. */
1063         racl = empty_rsync_acl;
1064         ok = unpack_smb_acl(sacl, &racl);
1065         sys_acl_free_acl(sacl);
1066         if (!ok) {
1067                 rprintf(FERROR, "default_perms_for_dir: unpack_smb_acl failed, falling back on umask\n");
1068                 return perms;
1069         }
1070
1071         /* Apply the permission-bit entries of the default ACL, if any. */
1072         if (racl.user_obj != NO_ENTRY) {
1073                 perms = rsync_acl_get_perms(&racl);
1074                 if (verbose > 2)
1075                         rprintf(FINFO, "got ACL-based default perms %o for directory %s\n", perms, dir);
1076         }
1077
1078         rsync_acl_free(&racl);
1079         return perms;
1080 }
1081
1082 #endif /* SUPPORT_ACLS */