s3: smbd: Remove all references to utility and backend functions supporting sys_acl_d...
[samba.git] / source3 / modules / vfs_posixacl.c
1 /*
2    Unix SMB/Netbios implementation.
3    VFS module to get and set posix acls
4    Copyright (C) Volker Lendecke 2006
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "includes.h"
21 #include "system/filesys.h"
22 #include "smbd/smbd.h"
23 #include "modules/vfs_posixacl.h"
24
25 /* prototypes for static functions first - for clarity */
26
27 static bool smb_ace_to_internal(acl_entry_t posix_ace,
28                                 struct smb_acl_entry *ace);
29 static struct smb_acl_t *smb_acl_to_internal(acl_t acl, TALLOC_CTX *mem_ctx);
30 static int smb_acl_set_mode(acl_entry_t entry, SMB_ACL_PERM_T perm);
31 static acl_t smb_acl_to_posix(const struct smb_acl_t *acl);
32
33
34 /* public functions - the api */
35
36 SMB_ACL_T posixacl_sys_acl_get_file(vfs_handle_struct *handle,
37                                 const struct smb_filename *smb_fname,
38                                 SMB_ACL_TYPE_T type,
39                                 TALLOC_CTX *mem_ctx)
40 {
41         struct smb_acl_t *result;
42         acl_type_t acl_type;
43         acl_t acl;
44
45         switch(type) {
46         case SMB_ACL_TYPE_ACCESS:
47                 acl_type = ACL_TYPE_ACCESS;
48                 break;
49         case SMB_ACL_TYPE_DEFAULT:
50                 acl_type = ACL_TYPE_DEFAULT;
51                 break;
52         default:
53                 errno = EINVAL;
54                 return NULL;
55         }
56
57         acl = acl_get_file(smb_fname->base_name, acl_type);
58
59         if (acl == NULL) {
60                 return NULL;
61         }
62
63         result = smb_acl_to_internal(acl, mem_ctx);
64         acl_free(acl);
65         return result;
66 }
67
68 SMB_ACL_T posixacl_sys_acl_get_fd(vfs_handle_struct *handle,
69                                   files_struct *fsp, TALLOC_CTX *mem_ctx)
70 {
71         struct smb_acl_t *result;
72         acl_t acl = NULL;
73
74         if (!fsp->fsp_flags.is_pathref) {
75                 acl = acl_get_fd(fsp_get_io_fd(fsp));
76         } else if (fsp->fsp_flags.have_proc_fds) {
77                 int fd = fsp_get_pathref_fd(fsp);
78                 const char *proc_fd_path = NULL;
79                 char buf[PATH_MAX];
80
81                 proc_fd_path = sys_proc_fd_path(fd, buf, sizeof(buf));
82                 if (proc_fd_path == NULL) {
83                         return NULL;
84                 }
85
86                 acl = acl_get_file(proc_fd_path, ACL_TYPE_ACCESS);
87         } else {
88                 /*
89                  * This is no longer a handle based call.
90                  */
91                 acl = acl_get_file(fsp->fsp_name->base_name, ACL_TYPE_ACCESS);
92         }
93         if (acl == NULL) {
94                 return NULL;
95         }
96
97         result = smb_acl_to_internal(acl, mem_ctx);
98         acl_free(acl);
99         return result;
100 }
101
102 int posixacl_sys_acl_set_file(vfs_handle_struct *handle,
103                               const struct smb_filename *smb_fname,
104                               SMB_ACL_TYPE_T type,
105                               SMB_ACL_T theacl)
106 {
107         int res;
108         acl_type_t acl_type;
109         acl_t acl;
110
111         DEBUG(10, ("Calling acl_set_file: %s, %d\n",
112                         smb_fname->base_name,
113                         type));
114
115         switch(type) {
116         case SMB_ACL_TYPE_ACCESS:
117                 acl_type = ACL_TYPE_ACCESS;
118                 break;
119         case SMB_ACL_TYPE_DEFAULT:
120                 acl_type = ACL_TYPE_DEFAULT;
121                 break;
122         default:
123                 errno = EINVAL;
124                 return -1;
125         }
126
127         if ((acl = smb_acl_to_posix(theacl)) == NULL) {
128                 return -1;
129         }
130         res = acl_set_file(smb_fname->base_name, acl_type, acl);
131         if (res != 0) {
132                 DEBUG(10, ("acl_set_file failed: %s\n", strerror(errno)));
133         }
134         acl_free(acl);
135         return res;
136 }
137
138 int posixacl_sys_acl_set_fd(vfs_handle_struct *handle,
139                             files_struct *fsp,
140                             SMB_ACL_TYPE_T type,
141                             SMB_ACL_T theacl)
142 {
143         int res;
144         acl_t acl = smb_acl_to_posix(theacl);
145         int fd = fsp_get_pathref_fd(fsp);
146
147         if (acl == NULL) {
148                 return -1;
149         }
150
151         if (!fsp->fsp_flags.is_pathref && type == SMB_ACL_TYPE_ACCESS) {
152                 res = acl_set_fd(fd, acl);
153         } else if (fsp->fsp_flags.have_proc_fds) {
154                 const char *proc_fd_path = NULL;
155                 char buf[PATH_MAX];
156
157                 proc_fd_path = sys_proc_fd_path(fd, buf, sizeof(buf));
158                 if (proc_fd_path == NULL) {
159                         return -1;
160                 }
161                 res = acl_set_file(proc_fd_path, type, acl);
162         } else {
163                 /*
164                  * This is no longer a handle based call.
165                  */
166                 res = acl_set_file(fsp->fsp_name->base_name,
167                                    type,
168                                    acl);
169         }
170
171         acl_free(acl);
172         return res;
173 }
174
175 int posixacl_sys_acl_delete_def_fd(vfs_handle_struct *handle,
176                                 files_struct *fsp)
177 {
178         if (fsp->fsp_flags.have_proc_fds) {
179                 int fd = fsp_get_pathref_fd(fsp);
180                 const char *proc_fd_path = NULL;
181                 char buf[PATH_MAX];
182
183                 proc_fd_path = sys_proc_fd_path(fd, buf, sizeof(buf));
184                 if (proc_fd_path == NULL) {
185                         return -1;
186                 }
187                 return acl_delete_def_file(proc_fd_path);
188         }
189
190         /*
191          * This is no longer a handle based call.
192          */
193         return acl_delete_def_file(fsp->fsp_name->base_name);
194 }
195
196 /* private functions */
197
198 static bool smb_ace_to_internal(acl_entry_t posix_ace,
199                                 struct smb_acl_entry *ace)
200 {
201         acl_tag_t tag;
202         acl_permset_t permset;
203
204         if (acl_get_tag_type(posix_ace, &tag) != 0) {
205                 DEBUG(0, ("smb_acl_get_tag_type failed\n"));
206                 return False;
207         }
208
209         switch(tag) {
210         case ACL_USER:
211                 ace->a_type = SMB_ACL_USER;
212                 break;
213         case ACL_USER_OBJ:
214                 ace->a_type = SMB_ACL_USER_OBJ;
215                 break;
216         case ACL_GROUP:
217                 ace->a_type = SMB_ACL_GROUP;
218                 break;
219         case ACL_GROUP_OBJ:
220                 ace->a_type = SMB_ACL_GROUP_OBJ;
221                 break;
222         case ACL_OTHER:
223                 ace->a_type = SMB_ACL_OTHER;
224                 break;
225         case ACL_MASK:
226                 ace->a_type = SMB_ACL_MASK;
227                 break;
228 #ifdef HAVE_ACL_EVERYONE
229         case ACL_EVERYONE:
230                 DEBUG(1, ("ACL tag type ACL_EVERYONE. FreeBSD with ZFS? Use 'vfs objects = zfsacl'\n"));
231                 return false;
232 #endif
233         default:
234                 DEBUG(0, ("unknown tag type %d\n", (unsigned int)tag));
235                 return False;
236         }
237         switch(ace->a_type) {
238         case SMB_ACL_USER: {
239                 uid_t *puid = (uid_t *)acl_get_qualifier(posix_ace);
240                 if (puid == NULL) {
241                         DEBUG(0, ("smb_acl_get_qualifier failed\n"));
242                         return False;
243                 }
244                 ace->info.user.uid = *puid;
245                 acl_free(puid);
246                 break;
247         }
248
249         case SMB_ACL_GROUP: {
250                 gid_t *pgid = (uid_t *)acl_get_qualifier(posix_ace);
251                 if (pgid == NULL) {
252                         DEBUG(0, ("smb_acl_get_qualifier failed\n"));
253                         return False;
254                 }
255                 ace->info.group.gid = *pgid;
256                 acl_free(pgid);
257                 break;
258         }
259         default:
260                 break;
261         }
262         if (acl_get_permset(posix_ace, &permset) != 0) {
263                 DEBUG(0, ("smb_acl_get_mode failed\n"));
264                 return False;
265         }
266         ace->a_perm = 0;
267 #ifdef HAVE_ACL_GET_PERM_NP
268         ace->a_perm |= (acl_get_perm_np(permset, ACL_READ) ? SMB_ACL_READ : 0);
269         ace->a_perm |= (acl_get_perm_np(permset, ACL_WRITE) ? SMB_ACL_WRITE : 0);
270         ace->a_perm |= (acl_get_perm_np(permset, ACL_EXECUTE) ? SMB_ACL_EXECUTE : 0);
271 #else
272         ace->a_perm |= (acl_get_perm(permset, ACL_READ) ? SMB_ACL_READ : 0);
273         ace->a_perm |= (acl_get_perm(permset, ACL_WRITE) ? SMB_ACL_WRITE : 0);
274         ace->a_perm |= (acl_get_perm(permset, ACL_EXECUTE) ? SMB_ACL_EXECUTE : 0);
275 #endif
276         return True;
277 }
278
279 static struct smb_acl_t *smb_acl_to_internal(acl_t acl, TALLOC_CTX *mem_ctx)
280 {
281         struct smb_acl_t *result = sys_acl_init(mem_ctx);
282         int entry_id = ACL_FIRST_ENTRY;
283         acl_entry_t e;
284         if (result == NULL) {
285                 return NULL;
286         }
287         while (acl_get_entry(acl, entry_id, &e) == 1) {
288
289                 entry_id = ACL_NEXT_ENTRY;
290
291                 result->acl = talloc_realloc(result, result->acl,
292                                              struct smb_acl_entry, result->count+1);
293                 if (result->acl == NULL) {
294                         TALLOC_FREE(result);
295                         DEBUG(0, ("talloc_realloc failed\n"));
296                         errno = ENOMEM;
297                         return NULL;
298                 }
299
300                 if (!smb_ace_to_internal(e, &result->acl[result->count])) {
301                         TALLOC_FREE(result);
302                         return NULL;
303                 }
304
305                 result->count += 1;
306         }
307         return result;
308 }
309
310 static int smb_acl_set_mode(acl_entry_t entry, SMB_ACL_PERM_T perm)
311 {
312         int ret;
313         acl_permset_t permset;
314
315         if ((ret = acl_get_permset(entry, &permset)) != 0) {
316                 return ret;
317         }
318         if ((ret = acl_clear_perms(permset)) != 0) {
319                 return ret;
320         }
321         if ((perm & SMB_ACL_READ) &&
322             ((ret = acl_add_perm(permset, ACL_READ)) != 0)) {
323                 return ret;
324         }
325         if ((perm & SMB_ACL_WRITE) &&
326             ((ret = acl_add_perm(permset, ACL_WRITE)) != 0)) {
327                 return ret;
328         }
329         if ((perm & SMB_ACL_EXECUTE) &&
330             ((ret = acl_add_perm(permset, ACL_EXECUTE)) != 0)) {
331                 return ret;
332         }
333
334         return 0;
335 }
336
337 static acl_t smb_acl_to_posix(const struct smb_acl_t *acl)
338 {
339         acl_t result;
340         int i;
341
342         result = acl_init(acl->count);
343         if (result == NULL) {
344                 DEBUG(10, ("acl_init failed\n"));
345                 return NULL;
346         }
347
348         for (i=0; i<acl->count; i++) {
349                 const struct smb_acl_entry *entry = &acl->acl[i];
350                 acl_entry_t e;
351                 acl_tag_t tag;
352
353                 if (acl_create_entry(&result, &e) != 0) {
354                         DEBUG(1, ("acl_create_entry failed: %s\n",
355                                   strerror(errno)));
356                         goto fail;
357                 }
358
359                 switch (entry->a_type) {
360                 case SMB_ACL_USER:
361                         tag = ACL_USER;
362                         break;
363                 case SMB_ACL_USER_OBJ:
364                         tag = ACL_USER_OBJ;
365                         break;
366                 case SMB_ACL_GROUP:
367                         tag = ACL_GROUP;
368                         break;
369                 case SMB_ACL_GROUP_OBJ:
370                         tag = ACL_GROUP_OBJ;
371                         break;
372                 case SMB_ACL_OTHER:
373                         tag = ACL_OTHER;
374                         break;
375                 case SMB_ACL_MASK:
376                         tag = ACL_MASK;
377                         break;
378                 default:
379                         DEBUG(1, ("Unknown tag value %d\n", entry->a_type));
380                         goto fail;
381                 }
382
383                 if (acl_set_tag_type(e, tag) != 0) {
384                         DEBUG(10, ("acl_set_tag_type(%d) failed: %s\n",
385                                    tag, strerror(errno)));
386                         goto fail;
387                 }
388
389                 switch (entry->a_type) {
390                 case SMB_ACL_USER:
391                         if (acl_set_qualifier(e, &entry->info.user.uid) != 0) {
392                                 DEBUG(1, ("acl_set_qualifiier failed: %s\n",
393                                           strerror(errno)));
394                                 goto fail;
395                         }
396                         break;
397                 case SMB_ACL_GROUP:
398                         if (acl_set_qualifier(e, &entry->info.group.gid) != 0) {
399                                 DEBUG(1, ("acl_set_qualifiier failed: %s\n",
400                                           strerror(errno)));
401                                 goto fail;
402                         }
403                         break;
404                 default:        /* Shut up, compiler! :-) */
405                         break;
406                 }
407
408                 if (smb_acl_set_mode(e, entry->a_perm) != 0) {
409                         goto fail;
410                 }
411         }
412
413         if (acl_valid(result) != 0) {
414                 char *acl_string = sys_acl_to_text(acl, NULL);
415                 DEBUG(0, ("smb_acl_to_posix: ACL %s is invalid for set (%s)\n",
416                           acl_string, strerror(errno)));
417                 SAFE_FREE(acl_string);
418                 goto fail;
419         }
420
421         return result;
422
423  fail:
424         if (result != NULL) {
425                 acl_free(result);
426         }
427         return NULL;
428 }
429
430 /* VFS operations structure */
431
432 static struct vfs_fn_pointers posixacl_fns = {
433         .sys_acl_get_file_fn = posixacl_sys_acl_get_file,
434         .sys_acl_get_fd_fn = posixacl_sys_acl_get_fd,
435         .sys_acl_blob_get_file_fn = posix_sys_acl_blob_get_file,
436         .sys_acl_blob_get_fd_fn = posix_sys_acl_blob_get_fd,
437         .sys_acl_set_fd_fn = posixacl_sys_acl_set_fd,
438         .sys_acl_delete_def_fd_fn = posixacl_sys_acl_delete_def_fd,
439 };
440
441 static_decl_vfs;
442 NTSTATUS vfs_posixacl_init(TALLOC_CTX *ctx)
443 {
444         return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "posixacl",
445                                 &posixacl_fns);
446 }