lib/file-has-acl.c

   1 /* Test whether a file has a nontrivial access control list.
   2
   3    Copyright (C) 2002-2003, 2005-2008 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18    Written by Paul Eggert and Andreas Gruenbacher.  */
  19
  20 #include <config.h>
  21
  22 #include "acl.h"
  23
  24 #include "acl-internal.h"
  25
  26
  27 #if USE_ACL && HAVE_ACL_GET_FILE
  28
  29 # if HAVE_ACL_TYPE_EXTENDED /* MacOS X */
  30
  31 /* ACL is an ACL, from a file, stored as type ACL_TYPE_EXTENDED.
  32    Return 1 if the given ACL is non-trivial.
  33    Return 0 if it is trivial.  */
  34 int
  35 acl_extended_nontrivial (acl_t acl)
  36 {
  37   /* acl is non-trivial if it is non-empty.  */
  38   return (acl_entries (acl) > 0);
  39 }
  40
  41 # else /* Linux, FreeBSD, IRIX, Tru64 */
  42
  43 /* ACL is an ACL, from a file, stored as type ACL_TYPE_ACCESS.
  44    Return 1 if the given ACL is non-trivial.
  45    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.
  46    Return -1 and set errno upon failure to determine it.  */
  47 int
  48 acl_access_nontrivial (acl_t acl)
  49 {
  50   /* acl is non-trivial if it has some entries other than for "user::",
  51      "group::", and "other::".  Normally these three should be present
  52      at least, allowing us to write
  53         return (3 < acl_entries (acl));
  54      but the following code is more robust.  */
  55 #  if HAVE_ACL_FIRST_ENTRY /* Linux, FreeBSD */
  56
  57   acl_entry_t ace;
  58   int at_end;
  59
  60   for (at_end = acl_get_entry (acl, ACL_FIRST_ENTRY, &ace);
  61        !at_end;
  62        at_end = acl_get_entry (acl, ACL_NEXT_ENTRY, &ace))
  63     {
  64       acl_tag_t tag;
  65       if (acl_get_tag_type (ace, &tag) < 0)
  66         return -1;
  67       if (!(tag == ACL_USER_OBJ || tag == ACL_GROUP_OBJ || tag == ACL_OTHER))
  68         return 1;
  69     }
  70   return 0;
  71
  72 #  else /* IRIX, Tru64 */
  73 #   if HAVE_ACL_TO_SHORT_TEXT /* IRIX */
  74   /* Don't use acl_get_entry: it is undocumented.  */
  75
  76   int count = acl->acl_cnt;
  77   int i;
  78
  79   for (i = 0; i < count; i++)
  80     {
  81       acl_entry_t ace = &acl->acl_entry[i];
  82       acl_tag_t tag = ace->ae_tag;
  83
  84       if (!(tag == ACL_USER_OBJ || tag == ACL_GROUP_OBJ
  85             || tag == ACL_OTHER_OBJ))
  86         return 1;
  87     }
  88   return 0;
  89
  90 #   endif
  91 #   if HAVE_ACL_FREE_TEXT /* Tru64 */
  92   /* Don't use acl_get_entry: it takes only one argument and does not work.  */
  93
  94   int count = acl->acl_num;
  95   acl_entry_t ace;
  96
  97   for (ace = acl->acl_first; count > 0; ace = ace->next, count--)
  98     {
  99       acl_tag_t tag;
 100       acl_perm_t perm;
 101
 102       tag = ace->entry->acl_type;
 103       if (!(tag == ACL_USER_OBJ || tag == ACL_GROUP_OBJ || tag == ACL_OTHER))
 104         return 1;
 105
 106       perm = ace->entry->acl_perm;
 107       /* On Tru64, perm can also contain non-standard bits such as
 108          PERM_INSERT, PERM_DELETE, PERM_MODIFY, PERM_LOOKUP, ... */
 109       if ((perm & ~(ACL_READ | ACL_WRITE | ACL_EXECUTE)) != 0)
 110         return 1;
 111     }
 112   return 0;
 113
 114 #   endif
 115 #  endif
 116 }
 117
 118 # endif
 119
 120
 121 #elif USE_ACL && HAVE_ACL && defined GETACL /* Solaris, Cygwin, not HP-UX */
 122
 123 /* Test an ACL retrieved with GETACL.
 124    Return 1 if the given ACL, consisting of COUNT entries, is non-trivial.
 125    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 126 int
 127 acl_nontrivial (int count, aclent_t *entries)
 128 {
 129   int i;
 130
 131   for (i = 0; i < count; i++)
 132     {
 133       aclent_t *ace = &entries[i];
 134
 135       /* Note: If ace->a_type = USER_OBJ, ace->a_id is the st_uid from stat().
 136          If ace->a_type = GROUP_OBJ, ace->a_id is the st_gid from stat().
 137          We don't need to check ace->a_id in these cases.  */
 138       if (!(ace->a_type == USER_OBJ
 139             || ace->a_type == GROUP_OBJ
 140             || ace->a_type == OTHER_OBJ
 141             /* Note: Cygwin does not return a CLASS_OBJ ("mask:") entry
 142                sometimes.  */
 143             || ace->a_type == CLASS_OBJ))
 144         return 1;
 145     }
 146   return 0;
 147 }
 148
 149 # ifdef ACE_GETACL
 150
 151 /* Test an ACL retrieved with ACE_GETACL.
 152    Return 1 if the given ACL, consisting of COUNT entries, is non-trivial.
 153    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 154 int
 155 acl_ace_nontrivial (int count, ace_t *entries)
 156 {
 157   int i;
 158
 159   for (i = 0; i < count; i++)
 160     {
 161       ace_t *ace = &entries[i];
 162
 163       /* Note: If ace->a_flags = ACE_OWNER, ace->a_who is the st_uid from
 164          stat().  If ace->a_flags = ACE_GROUP, ace->a_who is the st_gid from
 165          stat().  We don't need to check ace->a_who in these cases.  */
 166       if (!(ace->a_type == ALLOW
 167             && (ace->a_flags == ACE_OWNER
 168                 || ace->a_flags == ACE_GROUP
 169                 || ace->a_flags == ACE_OTHER)))
 170         return 1;
 171     }
 172   return 0;
 173 }
 174
 175 # endif
 176
 177 #endif
 178
 179
 180 /* Return 1 if NAME has a nontrivial access control list, 0 if NAME
 181    only has no or a base access control list, and -1 (setting errno)
 182    on error.  SB must be set to the stat buffer of FILE.  */
 183
 184 int
 185 file_has_acl (char const *name, struct stat const *sb)
 186 {
 187 #if USE_ACL
 188   if (! S_ISLNK (sb->st_mode))
 189     {
 190 # if HAVE_ACL_GET_FILE
 191
 192       /* POSIX 1003.1e (draft 17 -- abandoned) specific version.  */
 193       /* Linux, FreeBSD, MacOS X, IRIX, Tru64 */
 194       int ret;
 195
 196       if (HAVE_ACL_EXTENDED_FILE) /* Linux */
 197         {
 198           /* On Linux, acl_extended_file is an optimized function: It only
 199              makes two calls to getxattr(), one for ACL_TYPE_ACCESS, one for
 200              ACL_TYPE_DEFAULT.  */
 201           ret = acl_extended_file (name);
 202         }
 203       else /* FreeBSD, MacOS X, IRIX, Tru64 */
 204         {
 205 #  if HAVE_ACL_TYPE_EXTENDED /* MacOS X */
 206           /* On MacOS X, acl_get_file (name, ACL_TYPE_ACCESS)
 207              and acl_get_file (name, ACL_TYPE_DEFAULT)
 208              always return NULL / EINVAL.  There is no point in making
 209              these two useless calls.  The real ACL is retrieved through
 210              acl_get_file (name, ACL_TYPE_EXTENDED).  */
 211           acl_t acl = acl_get_file (name, ACL_TYPE_EXTENDED);
 212           if (acl)
 213             {
 214               ret = acl_extended_nontrivial (acl);
 215               acl_free (acl);
 216             }
 217           else
 218             ret = -1;
 219 #  else /* FreeBSD, IRIX, Tru64 */
 220           acl_t acl = acl_get_file (name, ACL_TYPE_ACCESS);
 221           if (acl)
 222             {
 223               int saved_errno;
 224
 225               ret = acl_access_nontrivial (acl);
 226               saved_errno = errno;
 227               acl_free (acl);
 228               errno = saved_errno;
 229 #   if HAVE_ACL_FREE_TEXT /* Tru64 */
 230               /* On OSF/1, acl_get_file (name, ACL_TYPE_DEFAULT) always
 231                  returns NULL with errno not set.  There is no point in
 232                  making this call.  */
 233 #   else /* FreeBSD, IRIX */
 234               /* On Linux, FreeBSD, IRIX, acl_get_file (name, ACL_TYPE_ACCESS)
 235                  and acl_get_file (name, ACL_TYPE_DEFAULT) on a directory
 236                  either both succeed or both fail; it depends on the
 237                  filesystem.  Therefore there is no point in making the second
 238                  call if the first one already failed.  */
 239               if (ret == 0 && S_ISDIR (sb->st_mode))
 240                 {
 241                   acl = acl_get_file (name, ACL_TYPE_DEFAULT);
 242                   if (acl)
 243                     {
 244                       ret = (0 < acl_entries (acl));
 245                       acl_free (acl);
 246                     }
 247                   else
 248                     ret = -1;
 249                 }
 250 #   endif
 251             }
 252           else
 253             ret = -1;
 254 #  endif
 255         }
 256       if (ret < 0)
 257         return ACL_NOT_WELL_SUPPORTED (errno) ? 0 : -1;
 258       return ret;
 259
 260 # elif HAVE_ACL && defined GETACLCNT /* Solaris, Cygwin, not HP-UX */
 261
 262 #  if HAVE_ACL_TRIVIAL
 263
 264       /* Solaris 10 (newer version), which has additional API declared in
 265          <sys/acl.h> (acl_t) and implemented in libsec (acl_set, acl_trivial,
 266          acl_fromtext, ...).  */
 267       return acl_trivial (name);
 268
 269 #  else /* Solaris, Cygwin, general case */
 270
 271       /* Solaris 2.5 through Solaris 10, Cygwin, and contemporaneous versions
 272          of Unixware.  The acl() call returns the access and default ACL both
 273          at once.  */
 274       int count;
 275       {
 276         aclent_t *entries;
 277
 278         for (;;)
 279           {
 280             count = acl (name, GETACLCNT, 0, NULL);
 281
 282             if (count < 0)
 283               {
 284                 if (errno == ENOSYS || errno == ENOTSUP)
 285                   break;
 286                 else
 287                   return -1;
 288               }
 289
 290             if (count == 0)
 291               break;
 292
 293             /* Don't use MIN_ACL_ENTRIES:  It's set to 4 on Cygwin, but Cygwin
 294                returns only 3 entries for files with no ACL.  But this is safe:
 295                If there are more than 4 entries, there cannot be only the
 296                "user::", "group::", "other:", and "mask:" entries.  */
 297             if (count > 4)
 298               return 1;
 299
 300             entries = (aclent_t *) malloc (count * sizeof (aclent_t));
 301             if (entries == NULL)
 302               {
 303                 errno = ENOMEM;
 304                 return -1;
 305               }
 306             if (acl (name, GETACL, count, entries) == count)
 307               {
 308                 if (acl_nontrivial (count, entries))
 309                   {
 310                     free (entries);
 311                     return 1;
 312                   }
 313                 free (entries);
 314                 break;
 315               }
 316             /* Huh? The number of ACL entries changed since the last call.
 317                Repeat.  */
 318             free (entries);
 319           }
 320       }
 321
 322 #   ifdef ACE_GETACL
 323       /* Solaris also has a different variant of ACLs, used in ZFS and NFSv4
 324          file systems (whereas the other ones are used in UFS file systems).  */
 325       {
 326         ace_t *entries;
 327
 328         for (;;)
 329           {
 330             count = acl (name, ACE_GETACLCNT, 0, NULL);
 331
 332             if (count < 0)
 333               {
 334                 if (errno == ENOSYS || errno == EINVAL)
 335                   break;
 336                 else
 337                   return -1;
 338               }
 339
 340             if (count == 0)
 341               break;
 342
 343             /* If there are more than 3 entries, there cannot be only the
 344                ACE_OWNER, ACE_GROUP, ACE_OTHER entries.  */
 345             if (count > 3)
 346               return 1;
 347
 348             entries = (ace_t *) malloc (count * sizeof (ace_t));
 349             if (entries == NULL)
 350               {
 351                 errno = ENOMEM;
 352                 return -1;
 353               }
 354             if (acl (name, ACE_GETACL, count, entries) == count)
 355               {
 356                 if (acl_ace_nontrivial (count, entries))
 357                   {
 358                     free (entries);
 359                     return 1;
 360                   }
 361                 free (entries);
 362                 break;
 363               }
 364             /* Huh? The number of ACL entries changed since the last call.
 365                Repeat.  */
 366             free (entries);
 367           }
 368       }
 369 #   endif
 370
 371       return 0;
 372 #  endif
 373
 374 # endif
 375     }
 376 #endif
 377
 378   /* FIXME: Add support for AIX.  Please see Samba's
 379      source/lib/sysacls.c file for fix-related ideas.  */
 380
 381   return 0;
 382 }