lib/acl-internal.h

   1 /* Internal implementation of access control lists.
   2
   3    Copyright (C) 2002-2003, 2005-2012 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, Andreas Grünbacher, and Bruno Haible.  */
  19
  20 #include "acl.h"
  21
  22 #include <stdbool.h>
  23 #include <stdlib.h>
  24
  25 /* All systems define the ACL related API in <sys/acl.h>.  */
  26 #if HAVE_SYS_ACL_H
  27 # include <sys/acl.h>
  28 #endif
  29 #if defined HAVE_FACL && ! defined GETACLCNT && defined ACL_CNT
  30 # define GETACLCNT ACL_CNT
  31 #endif
  32
  33 /* On Linux, additional ACL related API is available in <acl/libacl.h>.  */
  34 #ifdef HAVE_ACL_LIBACL_H
  35 # include <acl/libacl.h>
  36 #endif
  37
  38 /* On HP-UX >= 11.11, additional ACL API is available in <aclv.h>.  */
  39 #if HAVE_ACLV_H
  40 # include <sys/types.h>
  41 # include <aclv.h>
  42 /* HP-UX 11.11 lacks these declarations.  */
  43 extern int acl (char *, int, int, struct acl *);
  44 extern int aclsort (int, int, struct acl *);
  45 #endif
  46
  47 #include "error.h"
  48 #include "quote.h"
  49
  50 #include <errno.h>
  51 #ifndef ENOSYS
  52 # define ENOSYS (-1)
  53 #endif
  54 #ifndef ENOTSUP
  55 # define ENOTSUP (-1)
  56 #endif
  57
  58 #include <limits.h>
  59 #ifndef MIN
  60 # define MIN(a,b) ((a) < (b) ? (a) : (b))
  61 #endif
  62
  63 #ifndef SIZE_MAX
  64 # define SIZE_MAX ((size_t) -1)
  65 #endif
  66
  67 #ifndef HAVE_FCHMOD
  68 # define HAVE_FCHMOD false
  69 # define fchmod(fd, mode) (-1)
  70 #endif
  71
  72 /* Recognize some common errors such as from an NFS mount that does
  73    not support ACLs, even when local drives do.  */
  74 #if defined __APPLE__ && defined __MACH__ /* Mac OS X */
  75 # define ACL_NOT_WELL_SUPPORTED(Err) \
  76      ((Err) == ENOTSUP || (Err) == ENOSYS || (Err) == EINVAL || (Err) == EBUSY || (Err) == ENOENT)
  77 #elif defined EOPNOTSUPP /* Tru64 NFS */
  78 # define ACL_NOT_WELL_SUPPORTED(Err) \
  79      ((Err) == ENOTSUP || (Err) == ENOSYS || (Err) == EINVAL || (Err) == EBUSY || (Err) == EOPNOTSUPP)
  80 #else
  81 # define ACL_NOT_WELL_SUPPORTED(Err) \
  82      ((Err) == ENOTSUP || (Err) == ENOSYS || (Err) == EINVAL || (Err) == EBUSY)
  83 #endif
  84
  85 #if USE_ACL
  86
  87 # if HAVE_ACL_GET_FILE
  88 /* POSIX 1003.1e (draft 17 -- abandoned) specific version.  */
  89 /* Linux, FreeBSD, Mac OS X, IRIX, Tru64 */
  90
  91 #  ifndef MIN_ACL_ENTRIES
  92 #   define MIN_ACL_ENTRIES 4
  93 #  endif
  94
  95 /* POSIX 1003.1e (draft 17) */
  96 #  ifdef HAVE_ACL_GET_FD
  97 /* Most platforms have a 1-argument acl_get_fd, only OSF/1 has a 2-argument
  98    macro(!).  */
  99 #   if HAVE_ACL_FREE_TEXT /* OSF/1 */
 100 static inline acl_t
 101 rpl_acl_get_fd (int fd)
 102 {
 103   return acl_get_fd (fd, ACL_TYPE_ACCESS);
 104 }
 105 #    undef acl_get_fd
 106 #    define acl_get_fd rpl_acl_get_fd
 107 #   endif
 108 #  else
 109 #   define HAVE_ACL_GET_FD false
 110 #   undef acl_get_fd
 111 #   define acl_get_fd(fd) (NULL)
 112 #  endif
 113
 114 /* POSIX 1003.1e (draft 17) */
 115 #  ifdef HAVE_ACL_SET_FD
 116 /* Most platforms have a 2-argument acl_set_fd, only OSF/1 has a 3-argument
 117    macro(!).  */
 118 #   if HAVE_ACL_FREE_TEXT /* OSF/1 */
 119 static inline int
 120 rpl_acl_set_fd (int fd, acl_t acl)
 121 {
 122   return acl_set_fd (fd, ACL_TYPE_ACCESS, acl);
 123 }
 124 #    undef acl_set_fd
 125 #    define acl_set_fd rpl_acl_set_fd
 126 #   endif
 127 #  else
 128 #   define HAVE_ACL_SET_FD false
 129 #   undef acl_set_fd
 130 #   define acl_set_fd(fd, acl) (-1)
 131 #  endif
 132
 133 /* POSIX 1003.1e (draft 13) */
 134 #  if ! HAVE_ACL_FREE_TEXT
 135 #   define acl_free_text(buf) acl_free (buf)
 136 #  endif
 137
 138 /* Linux-specific */
 139 #  ifndef HAVE_ACL_EXTENDED_FILE
 140 #   define HAVE_ACL_EXTENDED_FILE false
 141 #   define acl_extended_file(name) (-1)
 142 #  endif
 143
 144 /* Linux-specific */
 145 #  ifndef HAVE_ACL_FROM_MODE
 146 #   define HAVE_ACL_FROM_MODE false
 147 #   define acl_from_mode(mode) (NULL)
 148 #  endif
 149
 150 /* Set to 1 if a file's mode is implicit by the ACL.
 151    Set to 0 if a file's mode is stored independently from the ACL.  */
 152 #  if (HAVE_ACL_COPY_EXT_NATIVE && HAVE_ACL_CREATE_ENTRY_NP) || defined __sgi /* Mac OS X, IRIX */
 153 #   define MODE_INSIDE_ACL 0
 154 #  else
 155 #   define MODE_INSIDE_ACL 1
 156 #  endif
 157
 158 /* Return the number of entries in ACL.
 159    Return -1 and set errno upon failure to determine it.  */
 160 /* Define a replacement for acl_entries if needed. (Only Linux has it.)  */
 161 #  if !HAVE_ACL_ENTRIES
 162 #   define acl_entries rpl_acl_entries
 163 extern int acl_entries (acl_t);
 164 #  endif
 165
 166 #  if HAVE_ACL_TYPE_EXTENDED /* Mac OS X */
 167 /* ACL is an ACL, from a file, stored as type ACL_TYPE_EXTENDED.
 168    Return 1 if the given ACL is non-trivial.
 169    Return 0 if it is trivial.  */
 170 extern int acl_extended_nontrivial (acl_t);
 171 #  else
 172 /* ACL is an ACL, from a file, stored as type ACL_TYPE_ACCESS.
 173    Return 1 if the given ACL is non-trivial.
 174    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.
 175    Return -1 and set errno upon failure to determine it.  */
 176 extern int acl_access_nontrivial (acl_t);
 177 #  endif
 178
 179 # elif HAVE_FACL && defined GETACL /* Solaris, Cygwin, not HP-UX */
 180
 181 /* Set to 1 if a file's mode is implicit by the ACL.
 182    Set to 0 if a file's mode is stored independently from the ACL.  */
 183 #  if defined __CYGWIN__ /* Cygwin */
 184 #   define MODE_INSIDE_ACL 0
 185 #  else /* Solaris */
 186 #   define MODE_INSIDE_ACL 1
 187 #  endif
 188
 189 /* Return 1 if the given ACL is non-trivial.
 190    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 191 extern int acl_nontrivial (int count, aclent_t *entries);
 192
 193 #  ifdef ACE_GETACL /* Solaris 10 */
 194
 195 /* Test an ACL retrieved with ACE_GETACL.
 196    Return 1 if the given ACL, consisting of COUNT entries, is non-trivial.
 197    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 198 extern int acl_ace_nontrivial (int count, ace_t *entries);
 199
 200 /* Definitions for when the built executable is executed on Solaris 10
 201    (newer version) or Solaris 11.  */
 202 /* For a_type.  */
 203 #   define OLD_ALLOW 0
 204 #   define OLD_DENY  1
 205 #   define NEW_ACE_ACCESS_ALLOWED_ACE_TYPE 0 /* replaces ALLOW */
 206 #   define NEW_ACE_ACCESS_DENIED_ACE_TYPE  1 /* replaces DENY */
 207 /* For a_flags.  */
 208 #   define OLD_ACE_OWNER            0x0100
 209 #   define OLD_ACE_GROUP            0x0200
 210 #   define OLD_ACE_OTHER            0x0400
 211 #   define NEW_ACE_OWNER            0x1000
 212 #   define NEW_ACE_GROUP            0x2000
 213 #   define NEW_ACE_IDENTIFIER_GROUP 0x0040
 214 #   define NEW_ACE_EVERYONE         0x4000
 215 /* For a_access_mask.  */
 216 #   define NEW_ACE_READ_DATA         0x001 /* corresponds to 'r' */
 217 #   define NEW_ACE_WRITE_DATA        0x002 /* corresponds to 'w' */
 218 #   define NEW_ACE_APPEND_DATA       0x004
 219 #   define NEW_ACE_READ_NAMED_ATTRS  0x008
 220 #   define NEW_ACE_WRITE_NAMED_ATTRS 0x010
 221 #   define NEW_ACE_EXECUTE           0x020
 222 #   define NEW_ACE_DELETE_CHILD      0x040
 223 #   define NEW_ACE_READ_ATTRIBUTES   0x080
 224 #   define NEW_ACE_WRITE_ATTRIBUTES  0x100
 225 #   define NEW_ACE_DELETE          0x10000
 226 #   define NEW_ACE_READ_ACL        0x20000
 227 #   define NEW_ACE_WRITE_ACL       0x40000
 228 #   define NEW_ACE_WRITE_OWNER     0x80000
 229 #   define NEW_ACE_SYNCHRONIZE    0x100000
 230
 231 #  endif
 232
 233 # elif HAVE_GETACL /* HP-UX */
 234
 235 /* Return 1 if the given ACL is non-trivial.
 236    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 237 extern int acl_nontrivial (int count, struct acl_entry *entries, struct stat *sb);
 238
 239 #  if HAVE_ACLV_H /* HP-UX >= 11.11 */
 240
 241 /* Return 1 if the given ACL is non-trivial.
 242    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 243 extern int aclv_nontrivial (int count, struct acl *entries);
 244
 245 #  endif
 246
 247 # elif HAVE_ACLX_GET && 0 /* AIX */
 248
 249 /* TODO */
 250
 251 # elif HAVE_STATACL /* older AIX */
 252
 253 /* Return 1 if the given ACL is non-trivial.
 254    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 255 extern int acl_nontrivial (struct acl *a);
 256
 257 # elif HAVE_ACLSORT /* NonStop Kernel */
 258
 259 /* Return 1 if the given ACL is non-trivial.
 260    Return 0 if it is trivial, i.e. equivalent to a simple stat() mode.  */
 261 extern int acl_nontrivial (int count, struct acl *entries);
 262
 263 # endif
 264
 265 #endif