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