Samba3-HOWTO: Fix usage of 'net idmap restore'.
[Samba.git] / source / lib / sysacls.c
blob9c1256ed650039d8a4c895f9aa9b4f5a9a6dab60
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"
24 #undef DBGC_CLASS
25 #define DBGC_CLASS DBGC_ACLS
28 * Note that while this code implements sufficient functionality
29 * to support the sys_acl_* interfaces it does not provide all
30 * of the semantics of the POSIX ACL interfaces.
32 * In particular, an ACL entry descriptor (SMB_ACL_ENTRY_T) returned
33 * from a call to sys_acl_get_entry() should not be assumed to be
34 * valid after calling any of the following functions, which may
35 * reorder the entries in the ACL.
37 * sys_acl_valid()
38 * sys_acl_set_file()
39 * sys_acl_set_fd()
42 int sys_acl_get_entry(SMB_ACL_T acl_d, int entry_id, SMB_ACL_ENTRY_T *entry_p)
44 if (entry_id != SMB_ACL_FIRST_ENTRY && entry_id != SMB_ACL_NEXT_ENTRY) {
45 errno = EINVAL;
46 return -1;
49 if (entry_p == NULL) {
50 errno = EINVAL;
51 return -1;
54 if (entry_id == SMB_ACL_FIRST_ENTRY) {
55 acl_d->next = 0;
58 if (acl_d->next < 0) {
59 errno = EINVAL;
60 return -1;
63 if (acl_d->next >= acl_d->count) {
64 return 0;
67 *entry_p = &acl_d->acl[acl_d->next++];
69 return 1;
72 int sys_acl_get_tag_type(SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *type_p)
74 *type_p = entry_d->a_type;
76 return 0;
79 int sys_acl_get_permset(SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p)
81 *permset_p = &entry_d->a_perm;
83 return 0;
86 void *sys_acl_get_qualifier(SMB_ACL_ENTRY_T entry_d)
88 if (entry_d->a_type == SMB_ACL_USER) {
89 return &entry_d->uid;
92 if (entry_d->a_type == SMB_ACL_GROUP) {
93 return &entry_d->gid;
96 errno = EINVAL;
97 return NULL;
100 int sys_acl_clear_perms(SMB_ACL_PERMSET_T permset_d)
102 *permset_d = 0;
104 return 0;
107 int sys_acl_add_perm(SMB_ACL_PERMSET_T permset_d, SMB_ACL_PERM_T perm)
109 if (perm != SMB_ACL_READ && perm != SMB_ACL_WRITE
110 && perm != SMB_ACL_EXECUTE) {
111 errno = EINVAL;
112 return -1;
115 if (permset_d == NULL) {
116 errno = EINVAL;
117 return -1;
120 *permset_d |= perm;
122 return 0;
125 int sys_acl_get_perm(SMB_ACL_PERMSET_T permset_d, SMB_ACL_PERM_T perm)
127 return *permset_d & perm;
130 char *sys_acl_to_text(SMB_ACL_T acl_d, ssize_t *len_p)
132 int i;
133 int len, maxlen;
134 char *text;
137 * use an initial estimate of 20 bytes per ACL entry
138 * when allocating memory for the text representation
139 * of the ACL
141 len = 0;
142 maxlen = 20 * acl_d->count;
143 if ((text = (char *)SMB_MALLOC(maxlen)) == NULL) {
144 errno = ENOMEM;
145 return NULL;
148 for (i = 0; i < acl_d->count; i++) {
149 struct smb_acl_entry *ap = &acl_d->acl[i];
150 struct group *gr;
151 char tagbuf[12];
152 char idbuf[12];
153 const char *tag;
154 const char *id = "";
155 char perms[4];
156 int nbytes;
158 switch (ap->a_type) {
160 * for debugging purposes it's probably more
161 * useful to dump unknown tag types rather
162 * than just returning an error
164 default:
165 slprintf(tagbuf, sizeof(tagbuf)-1, "0x%x",
166 ap->a_type);
167 tag = tagbuf;
168 break;
170 case SMB_ACL_USER:
171 id = uidtoname(ap->uid);
172 case SMB_ACL_USER_OBJ:
173 tag = "user";
174 break;
176 case SMB_ACL_GROUP:
177 if ((gr = getgrgid(ap->gid)) == NULL) {
178 slprintf(idbuf, sizeof(idbuf)-1, "%ld",
179 (long)ap->gid);
180 id = idbuf;
181 } else {
182 id = gr->gr_name;
184 case SMB_ACL_GROUP_OBJ:
185 tag = "group";
186 break;
188 case SMB_ACL_OTHER:
189 tag = "other";
190 break;
192 case SMB_ACL_MASK:
193 tag = "mask";
194 break;
198 perms[0] = (ap->a_perm & SMB_ACL_READ) ? 'r' : '-';
199 perms[1] = (ap->a_perm & SMB_ACL_WRITE) ? 'w' : '-';
200 perms[2] = (ap->a_perm & SMB_ACL_EXECUTE) ? 'x' : '-';
201 perms[3] = '\0';
203 /* <tag> : <qualifier> : rwx \n \0 */
204 nbytes = strlen(tag) + 1 + strlen(id) + 1 + 3 + 1 + 1;
207 * If this entry would overflow the buffer
208 * allocate enough additional memory for this
209 * entry and an estimate of another 20 bytes
210 * for each entry still to be processed
212 if ((len + nbytes) > maxlen) {
213 maxlen += nbytes + 20 * (acl_d->count - i);
214 if ((text = (char *)SMB_REALLOC(text, maxlen)) == NULL) {
215 errno = ENOMEM;
216 return NULL;
220 slprintf(&text[len], nbytes-1, "%s:%s:%s\n", tag, id, perms);
221 len += nbytes - 1;
224 if (len_p)
225 *len_p = len;
227 return text;
230 SMB_ACL_T sys_acl_init(int count)
232 SMB_ACL_T a;
234 if (count < 0) {
235 errno = EINVAL;
236 return NULL;
240 * note that since the definition of the structure pointed
241 * to by the SMB_ACL_T includes the first element of the
242 * acl[] array, this actually allocates an ACL with room
243 * for (count+1) entries
245 if ((a = (struct smb_acl_t *)SMB_MALLOC(
246 sizeof(struct smb_acl_t) +
247 count * sizeof(struct smb_acl_entry))) == NULL) {
248 errno = ENOMEM;
249 return NULL;
252 a->size = count + 1;
253 a->count = 0;
254 a->next = -1;
256 return a;
259 int sys_acl_create_entry(SMB_ACL_T *acl_p, SMB_ACL_ENTRY_T *entry_p)
261 SMB_ACL_T acl_d;
262 SMB_ACL_ENTRY_T entry_d;
264 if (acl_p == NULL || entry_p == NULL || (acl_d = *acl_p) == NULL) {
265 errno = EINVAL;
266 return -1;
269 if (acl_d->count >= acl_d->size) {
270 errno = ENOSPC;
271 return -1;
274 entry_d = &acl_d->acl[acl_d->count++];
275 entry_d->a_type = SMB_ACL_TAG_INVALID;
276 entry_d->uid = -1;
277 entry_d->gid = -1;
278 entry_d->a_perm = 0;
279 *entry_p = entry_d;
281 return 0;
284 int sys_acl_set_tag_type(SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T tag_type)
286 switch (tag_type) {
287 case SMB_ACL_USER:
288 case SMB_ACL_USER_OBJ:
289 case SMB_ACL_GROUP:
290 case SMB_ACL_GROUP_OBJ:
291 case SMB_ACL_OTHER:
292 case SMB_ACL_MASK:
293 entry_d->a_type = tag_type;
294 break;
295 default:
296 errno = EINVAL;
297 return -1;
300 return 0;
303 int sys_acl_set_qualifier(SMB_ACL_ENTRY_T entry_d, void *qual_p)
305 if (entry_d->a_type == SMB_ACL_USER) {
306 entry_d->uid = *((uid_t *)qual_p);
307 return 0;
309 if (entry_d->a_type == SMB_ACL_GROUP) {
310 entry_d->gid = *((gid_t *)qual_p);
311 return 0;
314 errno = EINVAL;
315 return -1;
318 int sys_acl_set_permset(SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T permset_d)
320 if (*permset_d & ~(SMB_ACL_READ|SMB_ACL_WRITE|SMB_ACL_EXECUTE)) {
321 errno = EINVAL;
322 return -1;
325 entry_d->a_perm = *permset_d;
327 return 0;
330 int sys_acl_free_text(char *text)
332 SAFE_FREE(text);
333 return 0;
336 int sys_acl_free_acl(SMB_ACL_T acl_d)
338 SAFE_FREE(acl_d);
339 return 0;
342 int sys_acl_free_qualifier(void *qual, SMB_ACL_TAG_T tagtype)
344 return 0;
347 int sys_acl_valid(SMB_ACL_T acl_d)
349 errno = EINVAL;
350 return -1;
354 * acl_get_file, acl_get_fd, acl_set_file, acl_set_fd and
355 * sys_acl_delete_def_file are to be redirected to the default
356 * statically-bound acl vfs module, but they are replacable.
359 #if defined(HAVE_POSIX_ACLS)
361 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
362 const char *path_p, SMB_ACL_TYPE_T type)
364 return posixacl_sys_acl_get_file(handle, path_p, type);
367 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
369 return posixacl_sys_acl_get_fd(handle, fsp);
372 int sys_acl_set_file(vfs_handle_struct *handle,
373 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
375 return posixacl_sys_acl_set_file(handle, name, type, acl_d);
378 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
379 SMB_ACL_T acl_d)
381 return posixacl_sys_acl_set_fd(handle, fsp, acl_d);
384 int sys_acl_delete_def_file(vfs_handle_struct *handle,
385 const char *path)
387 return posixacl_sys_acl_delete_def_file(handle, path);
390 #elif defined(HAVE_AIX_ACLS)
392 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
393 const char *path_p, SMB_ACL_TYPE_T type)
395 return aixacl_sys_acl_get_file(handle, path_p, type);
398 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
400 return aixacl_sys_acl_get_fd(handle, fsp);
403 int sys_acl_set_file(vfs_handle_struct *handle,
404 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
406 return aixacl_sys_acl_set_file(handle, name, type, acl_d);
409 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
410 SMB_ACL_T acl_d)
412 return aixacl_sys_acl_set_fd(handle, fsp, acl_d);
415 int sys_acl_delete_def_file(vfs_handle_struct *handle,
416 const char *path)
418 return aixacl_sys_acl_delete_def_file(handle, path);
421 #elif defined(HAVE_TRU64_ACLS)
423 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
424 const char *path_p, SMB_ACL_TYPE_T type)
426 return tru64acl_sys_acl_get_file(handle, path_p, type);
429 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
431 return tru64acl_sys_acl_get_fd(handle, fsp);
434 int sys_acl_set_file(vfs_handle_struct *handle,
435 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
437 return tru64acl_sys_acl_set_file(handle, name, type, acl_d);
440 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
441 SMB_ACL_T acl_d)
443 return tru64acl_sys_acl_set_fd(handle, fsp, acl_d);
446 int sys_acl_delete_def_file(vfs_handle_struct *handle,
447 const char *path)
449 return tru64acl_sys_acl_delete_def_file(handle, path);
452 #elif defined(HAVE_SOLARIS_ACLS) || defined(HAVE_UNIXWARE_ACLS)
454 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
455 const char *path_p, SMB_ACL_TYPE_T type)
457 return solarisacl_sys_acl_get_file(handle, path_p, type);
460 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
462 return solarisacl_sys_acl_get_fd(handle, fsp);
465 int sys_acl_set_file(vfs_handle_struct *handle,
466 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
468 return solarisacl_sys_acl_set_file(handle, name, type, acl_d);
471 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
472 SMB_ACL_T acl_d)
474 return solarisacl_sys_acl_set_fd(handle, fsp, acl_d);
477 int sys_acl_delete_def_file(vfs_handle_struct *handle,
478 const char *path)
480 return solarisacl_sys_acl_delete_def_file(handle, path);
483 #elif defined(HAVE_HPUX_ACLS)
485 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
486 const char *path_p, SMB_ACL_TYPE_T type)
488 return hpuxacl_sys_acl_get_file(handle, path_p, type);
491 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
493 return hpuxacl_sys_acl_get_fd(handle, fsp);
496 int sys_acl_set_file(vfs_handle_struct *handle,
497 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
499 return hpuxacl_sys_acl_set_file(handle, name, type, acl_d);
502 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
503 SMB_ACL_T acl_d)
505 return hpuxacl_sys_acl_set_fd(handle, fsp, acl_d);
508 int sys_acl_delete_def_file(vfs_handle_struct *handle,
509 const char *path)
511 return hpuxacl_sys_acl_delete_def_file(handle, path);
514 #elif defined(HAVE_IRIX_ACLS)
516 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
517 const char *path_p, SMB_ACL_TYPE_T type)
519 return irixacl_sys_acl_get_file(handle, path_p, type);
522 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
524 return irixacl_sys_acl_get_fd(handle, fsp);
527 int sys_acl_set_file(vfs_handle_struct *handle,
528 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
530 return irixacl_sys_acl_set_file(handle, name, type, acl_d);
533 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
534 SMB_ACL_T acl_d)
536 return irixacl_sys_acl_set_fd(handle, fsp, acl_d);
539 int sys_acl_delete_def_file(vfs_handle_struct *handle,
540 const char *path)
542 return irixacl_sys_acl_delete_def_file(handle, path);
545 #else /* No ACLs. */
547 SMB_ACL_T sys_acl_get_file(vfs_handle_struct *handle,
548 const char *path_p, SMB_ACL_TYPE_T type)
550 #ifdef ENOTSUP
551 errno = ENOTSUP;
552 #else
553 errno = ENOSYS;
554 #endif
555 return NULL;
558 SMB_ACL_T sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
560 #ifdef ENOTSUP
561 errno = ENOTSUP;
562 #else
563 errno = ENOSYS;
564 #endif
565 return NULL;
568 int sys_acl_set_file(vfs_handle_struct *handle,
569 const char *name, SMB_ACL_TYPE_T type, SMB_ACL_T acl_d)
571 #ifdef ENOTSUP
572 errno = ENOTSUP;
573 #else
574 errno = ENOSYS;
575 #endif
576 return -1;
579 int sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
580 SMB_ACL_T acl_d)
582 #ifdef ENOTSUP
583 errno = ENOTSUP;
584 #else
585 errno = ENOSYS;
586 #endif
587 return -1;
590 int sys_acl_delete_def_file(vfs_handle_struct *handle,
591 const char *path)
593 #ifdef ENOTSUP
594 errno = ENOTSUP;
595 #else
596 errno = ENOSYS;
597 #endif
598 return -1;
601 #endif
603 /************************************************************************
604 Deliberately outside the ACL defines. Return 1 if this is a "no acls"
605 errno, 0 if not.
606 ************************************************************************/
608 int no_acl_syscall_error(int err)
610 #if defined(ENOSYS)
611 if (err == ENOSYS) {
612 return 1;
614 #endif
615 #if defined(ENOTSUP)
616 if (err == ENOTSUP) {
617 return 1;
619 #endif
620 return 0;