Add support for Solaris 7..10 ACLs.
[pspp] / lib / set-mode-acl.c
1 /* set-mode-acl.c - set access control list equivalent to a mode
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 /* If DESC is a valid file descriptor use fchmod to change the
27    file's mode to MODE on systems that have fchown. On systems
28    that don't have fchown and if DESC is invalid, use chown on
29    NAME instead.
30    Return 0 if successful.  Return -1 and set errno upon failure.  */
31
32 int
33 chmod_or_fchmod (const char *name, int desc, mode_t mode)
34 {
35   if (HAVE_FCHMOD && desc != -1)
36     return fchmod (desc, mode);
37   else
38     return chmod (name, mode);
39 }
40
41 /* Set the access control lists of a file. If DESC is a valid file
42    descriptor, use file descriptor operations where available, else use
43    filename based operations on NAME.  If access control lists are not
44    available, fchmod the target file to MODE.  Also sets the
45    non-permission bits of the destination file (S_ISUID, S_ISGID, S_ISVTX)
46    to those from MODE if any are set.
47    Return 0 if successful.  Return -1 and set errno upon failure.  */
48
49 int
50 qset_acl (char const *name, int desc, mode_t mode)
51 {
52 #if USE_ACL
53 # if HAVE_ACL_GET_FILE
54   /* POSIX 1003.1e draft 17 (abandoned) specific version.  */
55   /* Linux, FreeBSD, MacOS X, IRIX, Tru64 */
56 #  if MODE_INSIDE_ACL
57   /* Linux, FreeBSD, IRIX, Tru64 */
58
59   /* We must also have acl_from_text and acl_delete_def_file.
60      (acl_delete_def_file could be emulated with acl_init followed
61       by acl_set_file, but acl_set_file with an empty acl is
62       unspecified.)  */
63
64 #   ifndef HAVE_ACL_FROM_TEXT
65 #    error Must have acl_from_text (see POSIX 1003.1e draft 17).
66 #   endif
67 #   ifndef HAVE_ACL_DELETE_DEF_FILE
68 #    error Must have acl_delete_def_file (see POSIX 1003.1e draft 17).
69 #   endif
70
71   acl_t acl;
72   int ret;
73
74   if (HAVE_ACL_FROM_MODE) /* Linux */
75     {
76       acl = acl_from_mode (mode);
77       if (!acl)
78         return -1;
79     }
80   else /* FreeBSD, IRIX, Tru64 */
81     {
82       /* If we were to create the ACL using the functions acl_init(),
83          acl_create_entry(), acl_set_tag_type(), acl_set_qualifier(),
84          acl_get_permset(), acl_clear_perm[s](), acl_add_perm(), we
85          would need to create a qualifier.  I don't know how to do this.
86          So create it using acl_from_text().  */
87
88 #   if HAVE_ACL_FREE_TEXT /* Tru64 */
89       char acl_text[] = "u::---,g::---,o::---,";
90 #   else /* FreeBSD, IRIX */
91       char acl_text[] = "u::---,g::---,o::---";
92 #   endif
93
94       if (mode & S_IRUSR) acl_text[ 3] = 'r';
95       if (mode & S_IWUSR) acl_text[ 4] = 'w';
96       if (mode & S_IXUSR) acl_text[ 5] = 'x';
97       if (mode & S_IRGRP) acl_text[10] = 'r';
98       if (mode & S_IWGRP) acl_text[11] = 'w';
99       if (mode & S_IXGRP) acl_text[12] = 'x';
100       if (mode & S_IROTH) acl_text[17] = 'r';
101       if (mode & S_IWOTH) acl_text[18] = 'w';
102       if (mode & S_IXOTH) acl_text[19] = 'x';
103
104       acl = acl_from_text (acl_text);
105       if (!acl)
106         return -1;
107     }
108   if (HAVE_ACL_SET_FD && desc != -1)
109     ret = acl_set_fd (desc, acl);
110   else
111     ret = acl_set_file (name, ACL_TYPE_ACCESS, acl);
112   if (ret != 0)
113     {
114       int saved_errno = errno;
115       acl_free (acl);
116
117       if (ACL_NOT_WELL_SUPPORTED (errno))
118         return chmod_or_fchmod (name, desc, mode);
119       else
120         {
121           errno = saved_errno;
122           return -1;
123         }
124     }
125   else
126     acl_free (acl);
127
128   if (S_ISDIR (mode) && acl_delete_def_file (name))
129     return -1;
130
131   if (mode & (S_ISUID | S_ISGID | S_ISVTX))
132     {
133       /* We did not call chmod so far, so the special bits have not yet
134          been set.  */
135       return chmod_or_fchmod (name, desc, mode);
136     }
137   return 0;
138
139 #  else /* !MODE_INSIDE_ACL */
140   /* MacOS X */
141
142 #   if !HAVE_ACL_TYPE_EXTENDED
143 #    error Must have ACL_TYPE_EXTENDED
144 #   endif
145
146   /* On MacOS X,  acl_get_file (name, ACL_TYPE_ACCESS)
147      and          acl_get_file (name, ACL_TYPE_DEFAULT)
148      always return NULL / EINVAL.  You have to use
149                   acl_get_file (name, ACL_TYPE_EXTENDED)
150      or           acl_get_fd (open (name, ...))
151      to retrieve an ACL.
152      On the other hand,
153                   acl_set_file (name, ACL_TYPE_ACCESS, acl)
154      and          acl_set_file (name, ACL_TYPE_DEFAULT, acl)
155      have the same effect as
156                   acl_set_file (name, ACL_TYPE_EXTENDED, acl):
157      Each of these calls sets the file's ACL.  */
158
159   acl_t acl;
160   int ret;
161
162   /* Remove the ACL if the file has ACLs.  */
163   if (HAVE_ACL_GET_FD && desc != -1)
164     acl = acl_get_fd (desc);
165   else
166     acl = acl_get_file (name, ACL_TYPE_EXTENDED);
167   if (acl)
168     {
169       acl_free (acl);
170
171       acl = acl_init (0);
172       if (acl)
173         {
174           if (HAVE_ACL_SET_FD && desc != -1)
175             ret = acl_set_fd (desc, acl);
176           else
177             ret = acl_set_file (name, ACL_TYPE_EXTENDED, acl);
178           if (ret != 0)
179             {
180               int saved_errno = errno;
181
182               acl_free (acl);
183
184               if (ACL_NOT_WELL_SUPPORTED (saved_errno))
185                 return chmod_or_fchmod (name, desc, mode);
186               else
187                 {
188                   errno = saved_errno;
189                   return -1;
190                 }
191             }
192           acl_free (acl);
193         }
194     }
195
196   /* Since !MODE_INSIDE_ACL, we have to call chmod explicitly.  */
197   return chmod_or_fchmod (name, desc, mode);
198 #  endif
199
200 # elif HAVE_ACL && defined GETACLCNT /* Solaris, Cygwin, not HP-UX */
201
202 #  if defined ACL_NO_TRIVIAL
203   /* Solaris 10 (newer version), which has additional API declared in
204      <sys/acl.h> (acl_t) and implemented in libsec (acl_set, acl_trivial,
205      acl_fromtext, ...).  */
206
207   acl_t *aclp;
208   char acl_text[] = "user::---,group::---,mask:---,other:---";
209
210   if (mode & S_IRUSR) acl_text[ 6] = 'r';
211   if (mode & S_IWUSR) acl_text[ 7] = 'w';
212   if (mode & S_IXUSR) acl_text[ 8] = 'x';
213   if (mode & S_IRGRP) acl_text[17] = acl_text[26] = 'r';
214   if (mode & S_IWGRP) acl_text[18] = acl_text[27] = 'w';
215   if (mode & S_IXGRP) acl_text[19] = acl_text[28] = 'x';
216   if (mode & S_IROTH) acl_text[36] = 'r';
217   if (mode & S_IWOTH) acl_text[37] = 'w';
218   if (mode & S_IXOTH) acl_text[38] = 'x';
219
220   if (acl_fromtext (acl_text, &aclp) != 0)
221     {
222       errno = ENOMEM;
223       return -1;
224     }
225   else
226     {
227       int ret = (desc < 0 ? acl_set (name, aclp) : facl_set (desc, aclp));
228       int saved_errno = errno;
229       acl_free (aclp);
230       if (ret == 0 || saved_errno != ENOSYS)
231         {
232           errno = saved_errno;
233           return ret;
234         }
235     }
236
237   return chmod_or_fchmod (name, desc, mode);
238
239 #  else /* Solaris, Cygwin, general case */
240
241 #   ifdef ACE_GETACL
242   /* Solaris also has a different variant of ACLs, used in ZFS and NFSv4
243      file systems (whereas the other ones are used in UFS file systems).  */
244   {
245     ace_t entries[3];
246     int ret;
247
248     entries[0].a_type = ALLOW;
249     entries[0].a_flags = ACE_OWNER;
250     entries[0].a_who = 0; /* irrelevant */
251     entries[0].a_access_mask = (mode >> 6) & 7;
252     entries[1].a_type = ALLOW;
253     entries[1].a_flags = ACE_GROUP;
254     entries[1].a_who = 0; /* irrelevant */
255     entries[1].a_access_mask = (mode >> 3) & 7;
256     entries[2].a_type = ALLOW;
257     entries[2].a_flags = ACE_OTHER;
258     entries[2].a_who = 0;
259     entries[2].a_access_mask = mode & 7;
260
261     if (desc != -1)
262       ret = facl (desc, ACE_SETACL, sizeof (entries) / sizeof (aclent_t), entries);
263     else
264       ret = acl (name, ACE_SETACL, sizeof (entries) / sizeof (aclent_t), entries);
265     if (ret < 0 && errno != EINVAL && errno != ENOTSUP)
266       {
267         if (errno == ENOSYS)
268           return chmod_or_fchmod (name, desc, mode);
269         return -1;
270       }
271   }
272 #   endif
273
274   {
275     aclent_t entries[3];
276     int ret;
277
278     entries[0].a_type = USER_OBJ;
279     entries[0].a_id = 0; /* irrelevant */
280     entries[0].a_perm = (mode >> 6) & 7;
281     entries[1].a_type = GROUP_OBJ;
282     entries[1].a_id = 0; /* irrelevant */
283     entries[1].a_perm = (mode >> 3) & 7;
284     entries[2].a_type = OTHER_OBJ;
285     entries[2].a_id = 0;
286     entries[2].a_perm = mode & 7;
287
288     if (desc != -1)
289       ret = facl (desc, SETACL, sizeof (entries) / sizeof (aclent_t), entries);
290     else
291       ret = acl (name, SETACL, sizeof (entries) / sizeof (aclent_t), entries);
292     if (ret < 0)
293       {
294         if (errno == ENOSYS)
295           return chmod_or_fchmod (name, desc, mode);
296         return -1;
297       }
298   }
299   
300   if (mode & (S_ISUID | S_ISGID | S_ISVTX))
301     {
302       /* We did not call chmod so far, so the special bits have not yet
303          been set.  */
304       return chmod_or_fchmod (name, desc, mode);
305     }
306   return 0;
307
308 #  endif
309
310 # else /* Unknown flavor of ACLs */
311   return chmod_or_fchmod (name, desc, mode);
312 # endif
313 #else /* !USE_ACL */
314   return chmod_or_fchmod (name, desc, mode);
315 #endif
316 }
317
318 /* As with qset_acl, but also output a diagnostic on failure.  */
319
320 int
321 set_acl (char const *name, int desc, mode_t mode)
322 {
323   int r = qset_acl (name, desc, mode);
324   if (r != 0)
325     error (0, errno, _("setting permissions for %s"), quote (name));
326   return r;
327 }