waf: Fix bug #8801 - build s3fs manpages.
[Samba/gebeck_regimport.git] / source3 / lib / sysacls.c
blob31966c6077e9b08cfad5a2894c4e74a252bc6d1b
1 /*
2 Unix SMB/CIFS implementation.
3 Samba system utilities for ACL support.
4 Copyright (C) Jeremy Allison 2000.
5 Copyright (C) Volker Lendecke 2006
6 Copyright (C) Michael Adam 2006,2008
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.
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.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "includes.h"
23 #include "system/passwd.h"
25 #if defined(HAVE_POSIX_ACLS)
26 #include "modules/vfs_posixacl.h"
27 #endif
29 #if defined(HAVE_TRU64_ACLS)
30 #include "modules/vfs_tru64acl.h"
31 #endif
33 #if defined(HAVE_SOLARIS_ACLS) || defined(HAVE_UNIXWARE_ACLS)
34 #include "modules/vfs_solarisacl.h"
35 #endif
37 #if defined(HAVE_HPUX_ACLS)
38 #include "modules/vfs_hpuxacl.h"
39 #endif
41 #if defined(HAVE_IRIX_ACLS)
42 #include "modules/vfs_irixacl.h"
43 #endif
45 #undef DBGC_CLASS
46 #define DBGC_CLASS DBGC_ACLS
49 * Note that while this code implements sufficient functionality
50 * to support the sys_acl_* interfaces it does not provide all
51 * of the semantics of the POSIX ACL interfaces.
53 * In particular, an ACL entry descriptor (SMB_ACL_ENTRY_T) returned
54 * from a call to sys_acl_get_entry() should not be assumed to be
55 * valid after calling any of the following functions, which may
56 * reorder the entries in the ACL.
58 * sys_acl_valid()
59 * sys_acl_set_file()
60 * sys_acl_set_fd()
63 int sys_acl_get_entry(SMB_ACL_T acl_d, int entry_id, SMB_ACL_ENTRY_T *entry_p)
65 if (entry_id != SMB_ACL_FIRST_ENTRY && entry_id != SMB_ACL_NEXT_ENTRY) {
66 errno = EINVAL;
67 return -1;
70 if (entry_p == NULL) {
71 errno = EINVAL;
72 return -1;
75 if (entry_id == SMB_ACL_FIRST_ENTRY) {
76 acl_d->next = 0;
79 if (acl_d->next < 0) {
80 errno = EINVAL;
81 return -1;
84 if (acl_d->next >= acl_d->count) {
85 return 0;
88 *entry_p = &acl_d->acl[acl_d->next++];
90 return 1;
93 int sys_acl_get_tag_type(SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *type_p)
95 *type_p = entry_d->a_type;
97 return 0;
100 int sys_acl_get_permset(SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p)
102 *permset_p = &entry_d->a_perm;
104 return 0;
107 void *sys_acl_get_qualifier(SMB_ACL_ENTRY_T entry_d)
109 if (entry_d->a_type == SMB_ACL_USER) {
110 return &entry_d->uid;
113 if (entry_d->a_type == SMB_ACL_GROUP) {
114 return &entry_d->gid;
117 errno = EINVAL;
118 return NULL;
121 int sys_acl_clear_perms(SMB_ACL_PERMSET_T permset_d)
123 *permset_d = 0;
125 return 0;
128 int sys_acl_add_perm(SMB_ACL_PERMSET_T permset_d, SMB_ACL_PERM_T perm)
130 if (perm != SMB_ACL_READ && perm != SMB_ACL_WRITE
131 && perm != SMB_ACL_EXECUTE) {
132 errno = EINVAL;
133 return -1;
136 if (permset_d == NULL) {
137 errno = EINVAL;
138 return -1;
141 *permset_d |= perm;
143 return 0;
146 int sys_acl_get_perm(SMB_ACL_PERMSET_T permset_d, SMB_ACL_PERM_T perm)
148 return *permset_d & perm;
151 char *sys_acl_to_text(const struct smb_acl_t *acl_d, ssize_t *len_p)
153 int i;
154 int len, maxlen;
155 char *text;
158 * use an initial estimate of 20 bytes per ACL entry
159 * when allocating memory for the text representation
160 * of the ACL
162 len = 0;
163 maxlen = 20 * acl_d->count;
164 if ((text = (char *)SMB_MALLOC(maxlen)) == NULL) {
165 errno = ENOMEM;
166 return NULL;
169 for (i = 0; i < acl_d->count; i++) {
170 struct smb_acl_entry *ap = &acl_d->acl[i];
171 struct group *gr;
172 char tagbuf[12];
173 char idbuf[12];
174 const char *tag;
175 const char *id = "";
176 char perms[4];
177 int nbytes;
179 switch (ap->a_type) {
181 * for debugging purposes it's probably more
182 * useful to dump unknown tag types rather
183 * than just returning an error
185 default:
186 slprintf(tagbuf, sizeof(tagbuf)-1, "0x%x",
187 ap->a_type);
188 tag = tagbuf;
189 break;
191 case SMB_ACL_USER:
192 id = uidtoname(ap->uid);
193 case SMB_ACL_USER_OBJ:
194 tag = "user";
195 break;
197 case SMB_ACL_GROUP:
198 if ((gr = getgrgid(ap->gid)) == NULL) {
199 slprintf(idbuf, sizeof(idbuf)-1, "%ld",
200 (long)ap->gid);
201 id = idbuf;
202 } else {
203 id = gr->gr_name;
205 case SMB_ACL_GROUP_OBJ:
206 tag = "group";
207 break;
209 case SMB_ACL_OTHER:
210 tag = "other";
211 break;
213 case SMB_ACL_MASK:
214 tag = "mask";
215 break;
219 perms[0] = (ap->a_perm & SMB_ACL_READ) ? 'r' : '-';
220 perms[1] = (ap->a_perm & SMB_ACL_WRITE) ? 'w' : '-';
221 perms[2] = (ap->a_perm & SMB_ACL_EXECUTE) ? 'x' : '-';
222 perms[3] = '\0';
224 /* <tag> : <qualifier> : rwx \n \0 */
225 nbytes = strlen(tag) + 1 + strlen(id) + 1 + 3 + 1 + 1;
228 * If this entry would overflow the buffer
229 * allocate enough additional memory for this
230 * entry and an estimate of another 20 bytes
231 * for each entry still to be processed
233 if ((len + nbytes) > maxlen) {
234 maxlen += nbytes + 20 * (acl_d->count - i);
235 if ((text = (char *)SMB_REALLOC(text, maxlen)) == NULL) {
236 errno = ENOMEM;
237 return NULL;
242 slprintf(&text[len], nbytes, "%s:%s:%s\n", tag, id, perms);
243 len += (nbytes - 1);
246 if (len_p)
247 *len_p = len;
249 return text;
252 SMB_ACL_T sys_acl_init(int count)
254 SMB_ACL_T a;
256 if (count < 0) {
257 errno = EINVAL;
258 return NULL;
261 if ((a = talloc(NULL, struct smb_acl_t)) == NULL) {
262 errno = ENOMEM;
263 return NULL;
266 a->size = count + 1;
267 a->count = 0;
268 a->next = -1;
270 a->acl = talloc_array(a, struct smb_acl_entry, count+1);
271 if (!a->acl) {
272 TALLOC_FREE(a);
273 errno = ENOMEM;
274 return NULL;
277 return a;
280 int sys_acl_create_entry(SMB_ACL_T *acl_p, SMB_ACL_ENTRY_T *entry_p)
282 SMB_ACL_T acl_d;
283 SMB_ACL_ENTRY_T entry_d;
285 if (acl_p == NULL || entry_p == NULL || (acl_d = *acl_p) == NULL) {
286 errno = EINVAL;
287 return -1;
290 if (acl_d->count >= acl_d->size) {
291 errno = ENOSPC;
292 return -1;
295 entry_d = &acl_d->acl[acl_d->count++];
296 entry_d->a_type = SMB_ACL_TAG_INVALID;
297 entry_d->uid = -1;
298 entry_d->gid = -1;
299 entry_d->a_perm = 0;
300 *entry_p = entry_d;
302 return 0;
305 int sys_acl_set_tag_type(SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T tag_type)
307 switch (tag_type) {
308 case SMB_ACL_USER:
309 case SMB_ACL_USER_OBJ:
310 case SMB_ACL_GROUP:
311 case SMB_ACL_GROUP_OBJ:
312 case SMB_ACL_OTHER:
313 case SMB_ACL_MASK:
314 entry_d->a_type = tag_type;
315 break;
316 default:
317 errno = EINVAL;
318 return -1;
321 return 0;
324 int sys_acl_set_qualifier(SMB_ACL_ENTRY_T entry_d, void *qual_p)
326 if (entry_d->a_type == SMB_ACL_USER) {
327 entry_d->uid = *((uid_t *)qual_p);
328 return 0;
330 if (entry_d->a_type == SMB_ACL_GROUP) {
331 entry_d->gid = *((gid_t *)qual_p);
332 return 0;
335 errno = EINVAL;
336 return -1;
339 int sys_acl_set_permset(SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T permset_d)
341 if (*permset_d & ~(SMB_ACL_READ|SMB_ACL_WRITE|SMB_ACL_EXECUTE)) {
342 errno = EINVAL;
343 return -1;
346 entry_d->a_perm = *permset_d;
348 return 0;
351 int sys_acl_free_text(char *text)
353 SAFE_FREE(text);
354 return 0;
357 int sys_acl_valid(SMB_ACL_T acl_d)
359 errno = EINVAL;
360 return -1;
364 * acl_get_file, acl_get_fd, acl_set_file, acl_set_fd and
365 * sys_acl_delete_def_file are to be redirected to the default
366 * statically-bound acl vfs module, but they are replacable.
369 #if defined(HAVE_POSIX_ACLS)
371 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
372 const char *path_p, SMB_ACL_TYPE_T type)
374 return posixacl_sys_acl_get_file(handle, path_p, type);
377 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
379 return posixacl_sys_acl_get_fd(handle, fsp);
382 int sys_acl_set_file(vfs_handle_struct *handle,
383 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
385 return posixacl_sys_acl_set_file(handle, name, type, acl_d);
388 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
389 SMB_ACL_T acl_d)
391 return posixacl_sys_acl_set_fd(handle, fsp, acl_d);
394 int sys_acl_delete_def_file(vfs_handle_struct *handle,
395 const char *path)
397 return posixacl_sys_acl_delete_def_file(handle, path);
400 #elif defined(HAVE_AIX_ACLS)
402 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
403 const char *path_p, SMB_ACL_TYPE_T type)
405 return aixacl_sys_acl_get_file(handle, path_p, type);
408 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
410 return aixacl_sys_acl_get_fd(handle, fsp);
413 int sys_acl_set_file(vfs_handle_struct *handle,
414 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
416 return aixacl_sys_acl_set_file(handle, name, type, acl_d);
419 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
420 SMB_ACL_T acl_d)
422 return aixacl_sys_acl_set_fd(handle, fsp, acl_d);
425 int sys_acl_delete_def_file(vfs_handle_struct *handle,
426 const char *path)
428 return aixacl_sys_acl_delete_def_file(handle, path);
431 #elif defined(HAVE_TRU64_ACLS)
433 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
434 const char *path_p, SMB_ACL_TYPE_T type)
436 return tru64acl_sys_acl_get_file(handle, path_p, type);
439 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
441 return tru64acl_sys_acl_get_fd(handle, fsp);
444 int sys_acl_set_file(vfs_handle_struct *handle,
445 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
447 return tru64acl_sys_acl_set_file(handle, name, type, acl_d);
450 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
451 SMB_ACL_T acl_d)
453 return tru64acl_sys_acl_set_fd(handle, fsp, acl_d);
456 int sys_acl_delete_def_file(vfs_handle_struct *handle,
457 const char *path)
459 return tru64acl_sys_acl_delete_def_file(handle, path);
462 #elif defined(HAVE_SOLARIS_ACLS) || defined(HAVE_UNIXWARE_ACLS)
464 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
465 const char *path_p, SMB_ACL_TYPE_T type)
467 return solarisacl_sys_acl_get_file(handle, path_p, type);
470 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
472 return solarisacl_sys_acl_get_fd(handle, fsp);
475 int sys_acl_set_file(vfs_handle_struct *handle,
476 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
478 return solarisacl_sys_acl_set_file(handle, name, type, acl_d);
481 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
482 SMB_ACL_T acl_d)
484 return solarisacl_sys_acl_set_fd(handle, fsp, acl_d);
487 int sys_acl_delete_def_file(vfs_handle_struct *handle,
488 const char *path)
490 return solarisacl_sys_acl_delete_def_file(handle, path);
493 #elif defined(HAVE_HPUX_ACLS)
495 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
496 const char *path_p, SMB_ACL_TYPE_T type)
498 return hpuxacl_sys_acl_get_file(handle, path_p, type);
501 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
503 return hpuxacl_sys_acl_get_fd(handle, fsp);
506 int sys_acl_set_file(vfs_handle_struct *handle,
507 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
509 return hpuxacl_sys_acl_set_file(handle, name, type, acl_d);
512 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
513 SMB_ACL_T acl_d)
515 return hpuxacl_sys_acl_set_fd(handle, fsp, acl_d);
518 int sys_acl_delete_def_file(vfs_handle_struct *handle,
519 const char *path)
521 return hpuxacl_sys_acl_delete_def_file(handle, path);
524 #elif defined(HAVE_IRIX_ACLS)
526 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
527 const char *path_p, SMB_ACL_TYPE_T type)
529 return irixacl_sys_acl_get_file(handle, path_p, type);
532 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
534 return irixacl_sys_acl_get_fd(handle, fsp);
537 int sys_acl_set_file(vfs_handle_struct *handle,
538 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
540 return irixacl_sys_acl_set_file(handle, name, type, acl_d);
543 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
544 SMB_ACL_T acl_d)
546 return irixacl_sys_acl_set_fd(handle, fsp, acl_d);
549 int sys_acl_delete_def_file(vfs_handle_struct *handle,
550 const char *path)
552 return irixacl_sys_acl_delete_def_file(handle, path);
555 #else /* No ACLs. */
557 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
558 const char *path_p, SMB_ACL_TYPE_T type)
560 #ifdef ENOTSUP
561 errno = ENOTSUP;
562 #else
563 errno = ENOSYS;
564 #endif
565 return NULL;
568 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
570 #ifdef ENOTSUP
571 errno = ENOTSUP;
572 #else
573 errno = ENOSYS;
574 #endif
575 return NULL;
578 int sys_acl_set_file(vfs_handle_struct *handle,
579 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
581 #ifdef ENOTSUP
582 errno = ENOTSUP;
583 #else
584 errno = ENOSYS;
585 #endif
586 return -1;
589 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
590 SMB_ACL_T acl_d)
592 #ifdef ENOTSUP
593 errno = ENOTSUP;
594 #else
595 errno = ENOSYS;
596 #endif
597 return -1;
600 int sys_acl_delete_def_file(vfs_handle_struct *handle,
601 const char *path)
603 #ifdef ENOTSUP
604 errno = ENOTSUP;
605 #else
606 errno = ENOSYS;
607 #endif
608 return -1;
611 #endif
613 /************************************************************************
614 Deliberately outside the ACL defines. Return 1 if this is a "no acls"
615 errno, 0 if not.
616 ************************************************************************/
618 int no_acl_syscall_error(int err)
620 #if defined(ENOSYS)
621 if (err == ENOSYS) {
622 return 1;
624 #endif
625 #if defined(ENOTSUP)
626 if (err == ENOTSUP) {
627 return 1;
629 #endif
630 return 0;