s4: add blackbox test for the demote function
[Samba/gebeck_regimport.git] / source3 / modules / vfs_hpuxacl.c
blob0f5af9d318d23400269158f2b7bbf551790bb758
1 /*
2 * Unix SMB/Netbios implementation.
3 * VFS module to get and set HP-UX ACLs
4 * Copyright (C) Michael Adam 2006,2008
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.
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.
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/>.
21 * This module supports JFS (POSIX) ACLs on VxFS (Veritas * Filesystem).
22 * These are available on HP-UX 11.00 if JFS 3.3 is installed.
23 * On HP-UX 11i (11.11 and above) these ACLs are supported out of
24 * the box.
26 * There is another form of ACLs on HFS. These ACLs have a
27 * completely different API and their own set of userland tools.
28 * Since HFS seems to be considered deprecated, HFS acls
29 * are not supported. (They could be supported through a separate
30 * vfs-module if there is demand.)
33 /* =================================================================
34 * NOTE:
36 * The original hpux-acl code in lib/sysacls.c was based upon the
37 * solaris acl code in the same file. Now for the new modularized
38 * acl implementation, I have taken the code from vfs_solarisacls.c
39 * and did similar adaptations as were done before, essentially
40 * reusing the original internal aclsort functions.
41 * The check for the presence of the acl() call has been adopted, and
42 * a check for the presence of the aclsort() call has been added.
44 * Michael Adam <obnox@samba.org>
46 * ================================================================= */
49 #include "includes.h"
50 #include "system/filesys.h"
51 #include "smbd/smbd.h"
52 #include "modules/vfs_hpuxacl.h"
55 /*
56 * including standard header <sys/aclv.h>
58 * included here as a quick hack for the special HP-UX-situation:
60 * The problem is that, on HP-UX, jfs/posix acls are
61 * defined in <sys/aclv.h>, while the deprecated hfs acls
62 * are defined inside <sys/acl.h>.
65 /* GROUP is defined somewhere else so undef it here... */
66 #undef GROUP
67 #include <sys/aclv.h>
68 /* dl.h: needed to check for acl call via shl_findsym */
69 #include <dl.h>
71 typedef struct acl HPUX_ACE_T;
72 typedef struct acl *HPUX_ACL_T;
73 typedef int HPUX_ACL_TAG_T; /* the type of an ACL entry */
74 typedef ushort HPUX_PERM_T;
76 /* Structure to capture the count for each type of ACE.
77 * (for hpux_internal_aclsort */
78 struct hpux_acl_types {
79 int n_user;
80 int n_def_user;
81 int n_user_obj;
82 int n_def_user_obj;
84 int n_group;
85 int n_def_group;
86 int n_group_obj;
87 int n_def_group_obj;
89 int n_other;
90 int n_other_obj;
91 int n_def_other_obj;
93 int n_class_obj;
94 int n_def_class_obj;
96 int n_illegal_obj;
99 /* for convenience: check if hpux acl entry is a default entry? */
100 #define _IS_DEFAULT(ace) ((ace).a_type & ACL_DEFAULT)
101 #define _IS_OF_TYPE(ace, type) ( \
102 (((type) == SMB_ACL_TYPE_ACCESS) && !_IS_DEFAULT(ace)) \
103 || \
104 (((type) == SMB_ACL_TYPE_DEFAULT) && _IS_DEFAULT(ace)) \
108 /* prototypes for private functions */
110 static HPUX_ACL_T hpux_acl_init(int count);
111 static bool smb_acl_to_hpux_acl(SMB_ACL_T smb_acl,
112 HPUX_ACL_T *solariacl, int *count,
113 SMB_ACL_TYPE_T type);
114 static SMB_ACL_T hpux_acl_to_smb_acl(HPUX_ACL_T hpuxacl, int count,
115 SMB_ACL_TYPE_T type);
116 static HPUX_ACL_TAG_T smb_tag_to_hpux_tag(SMB_ACL_TAG_T smb_tag);
117 static SMB_ACL_TAG_T hpux_tag_to_smb_tag(HPUX_ACL_TAG_T hpux_tag);
118 static bool hpux_add_to_acl(HPUX_ACL_T *hpux_acl, int *count,
119 HPUX_ACL_T add_acl, int add_count, SMB_ACL_TYPE_T type);
120 static bool hpux_acl_get_file(const char *name, HPUX_ACL_T *hpuxacl,
121 int *count);
122 static SMB_ACL_PERM_T hpux_perm_to_smb_perm(const HPUX_PERM_T perm);
123 static HPUX_PERM_T smb_perm_to_hpux_perm(const SMB_ACL_PERM_T perm);
124 #if 0
125 static bool hpux_acl_check(HPUX_ACL_T hpux_acl, int count);
126 #endif
127 /* aclsort (internal) and helpers: */
128 static bool hpux_acl_sort(HPUX_ACL_T acl, int count);
129 static int hpux_internal_aclsort(int acl_count, int calclass, HPUX_ACL_T aclp);
130 static void hpux_count_obj(int acl_count, HPUX_ACL_T aclp,
131 struct hpux_acl_types *acl_type_count);
132 static void hpux_swap_acl_entries(HPUX_ACE_T *aclp0, HPUX_ACE_T *aclp1);
133 static bool hpux_prohibited_duplicate_type(int acl_type);
135 static bool hpux_acl_call_present(void);
136 static bool hpux_aclsort_call_present(void);
139 /* public functions - the api */
141 SMB_ACL_T hpuxacl_sys_acl_get_file(vfs_handle_struct *handle,
142 const char *path_p,
143 SMB_ACL_TYPE_T type)
145 SMB_ACL_T result = NULL;
146 int count;
147 HPUX_ACL_T hpux_acl = NULL;
149 DEBUG(10, ("hpuxacl_sys_acl_get_file called for file '%s'.\n",
150 path_p));
152 if(hpux_acl_call_present() == False) {
153 /* Looks like we don't have the acl() system call on HPUX.
154 * May be the system doesn't have the latest version of JFS.
156 goto done;
159 if (type != SMB_ACL_TYPE_ACCESS && type != SMB_ACL_TYPE_DEFAULT) {
160 DEBUG(10, ("invalid SMB_ACL_TYPE given (%d)\n", type));
161 errno = EINVAL;
162 goto done;
165 DEBUGADD(10, ("getting %s acl\n",
166 ((type == SMB_ACL_TYPE_ACCESS) ? "access" : "default")));
168 if (!hpux_acl_get_file(path_p, &hpux_acl, &count)) {
169 goto done;
171 result = hpux_acl_to_smb_acl(hpux_acl, count, type);
172 if (result == NULL) {
173 DEBUG(10, ("conversion hpux_acl -> smb_acl failed (%s).\n",
174 strerror(errno)));
177 done:
178 DEBUG(10, ("hpuxacl_sys_acl_get_file %s.\n",
179 ((result == NULL) ? "failed" : "succeeded" )));
180 SAFE_FREE(hpux_acl);
181 return result;
186 * get the access ACL of a file referred to by a fd
188 SMB_ACL_T hpuxacl_sys_acl_get_fd(vfs_handle_struct *handle,
189 files_struct *fsp)
192 * HPUX doesn't have the facl call. Fake it using the path.... JRA.
194 /* For all I see, the info should already be in the fsp
195 * parameter, but get it again to be safe --- necessary? */
196 files_struct *file_struct_p = file_find_fd(fsp->conn->sconn,
197 fsp->fh->fd);
198 if (file_struct_p == NULL) {
199 errno = EBADF;
200 return NULL;
203 * We know we're in the same conn context. So we
204 * can use the relative path.
206 DEBUG(10, ("redirecting call of hpuxacl_sys_acl_get_fd to "
207 "hpuxacl_sys_acl_get_file (no facl syscall on HPUX).\n"));
209 return hpuxacl_sys_acl_get_file(handle,
210 file_struct_p->fsp_name->base_name,
211 SMB_ACL_TYPE_ACCESS);
215 int hpuxacl_sys_acl_set_file(vfs_handle_struct *handle,
216 const char *name,
217 SMB_ACL_TYPE_T type,
218 SMB_ACL_T theacl)
220 int ret = -1;
221 HPUX_ACL_T hpux_acl = NULL;
222 int count;
223 struct smb_filename *smb_fname = NULL;
224 NTSTATUS status;
226 DEBUG(10, ("hpuxacl_sys_acl_set_file called for file '%s'\n",
227 name));
229 status = create_synthetic_smb_fname(talloc_tos(), name, NULL, NULL,
230 &smb_fname);
231 if (!NT_STATUS_IS_OK(status)) {
232 goto done;
235 if(hpux_acl_call_present() == False) {
236 /* Looks like we don't have the acl() system call on HPUX.
237 * May be the system doesn't have the latest version of JFS.
239 goto done;
242 if ((type != SMB_ACL_TYPE_ACCESS) && (type != SMB_ACL_TYPE_DEFAULT)) {
243 errno = EINVAL;
244 DEBUG(10, ("invalid smb acl type given (%d).\n", type));
245 goto done;
247 DEBUGADD(10, ("setting %s acl\n",
248 ((type == SMB_ACL_TYPE_ACCESS) ? "access" : "default")));
250 if(!smb_acl_to_hpux_acl(theacl, &hpux_acl, &count, type)) {
251 DEBUG(10, ("conversion smb_acl -> hpux_acl failed (%s).\n",
252 strerror(errno)));
253 goto done;
257 * if the file is a directory, there is extra work to do:
258 * since the hpux acl call stores both the access acl and
259 * the default acl as provided, we have to get the acl part
260 * that has _not_ been specified in "type" from the file first
261 * and concatenate it with the acl provided.
263 if (lp_posix_pathnames()) {
264 ret = SMB_VFS_LSTAT(handle->conn, smb_fname);
265 } else {
266 ret = SMB_VFS_STAT(handle->conn, smb_fname);
268 if (ret != 0) {
269 DEBUG(10, ("Error in stat call: %s\n", strerror(errno)));
270 goto done;
272 if (S_ISDIR(smb_fname->st.st_ex_mode)) {
273 HPUX_ACL_T other_acl;
274 int other_count;
275 SMB_ACL_TYPE_T other_type;
277 other_type = (type == SMB_ACL_TYPE_ACCESS)
278 ? SMB_ACL_TYPE_DEFAULT
279 : SMB_ACL_TYPE_ACCESS;
280 DEBUGADD(10, ("getting acl from filesystem\n"));
281 if (!hpux_acl_get_file(smb_fname->base_name, &other_acl,
282 &other_count)) {
283 DEBUG(10, ("error getting acl from directory\n"));
284 goto done;
286 DEBUG(10, ("adding %s part of fs acl to given acl\n",
287 ((other_type == SMB_ACL_TYPE_ACCESS)
288 ? "access"
289 : "default")));
290 if (!hpux_add_to_acl(&hpux_acl, &count, other_acl,
291 other_count, other_type))
293 DEBUG(10, ("error adding other acl.\n"));
294 SAFE_FREE(other_acl);
295 goto done;
297 SAFE_FREE(other_acl);
299 else if (type != SMB_ACL_TYPE_ACCESS) {
300 errno = EINVAL;
301 goto done;
304 if (!hpux_acl_sort(hpux_acl, count)) {
305 DEBUG(10, ("resulting acl is not valid!\n"));
306 goto done;
308 DEBUG(10, ("resulting acl is valid.\n"));
310 ret = acl(discard_const_p(char, smb_fname->base_name), ACL_SET, count,
311 hpux_acl);
312 if (ret != 0) {
313 DEBUG(0, ("ERROR calling acl: %s\n", strerror(errno)));
316 done:
317 DEBUG(10, ("hpuxacl_sys_acl_set_file %s.\n",
318 ((ret != 0) ? "failed" : "succeeded")));
319 TALLOC_FREE(smb_fname);
320 SAFE_FREE(hpux_acl);
321 return ret;
325 * set the access ACL on the file referred to by a fd
327 int hpuxacl_sys_acl_set_fd(vfs_handle_struct *handle,
328 files_struct *fsp,
329 SMB_ACL_T theacl)
332 * HPUX doesn't have the facl call. Fake it using the path.... JRA.
334 /* For all I see, the info should already be in the fsp
335 * parameter, but get it again to be safe --- necessary? */
336 files_struct *file_struct_p = file_find_fd(fsp->conn->sconn,
337 fsp->fh->fd);
338 if (file_struct_p == NULL) {
339 errno = EBADF;
340 return -1;
343 * We know we're in the same conn context. So we
344 * can use the relative path.
346 DEBUG(10, ("redirecting call of hpuxacl_sys_acl_set_fd to "
347 "hpuxacl_sys_acl_set_file (no facl syscall on HPUX)\n"));
349 return hpuxacl_sys_acl_set_file(handle,
350 file_struct_p->fsp_name->base_name,
351 SMB_ACL_TYPE_ACCESS, theacl);
356 * delete the default ACL of a directory
358 * This is achieved by fetching the access ACL and rewriting it
359 * directly, via the hpux system call: the ACL_SET call on
360 * directories writes both the access and the default ACL as provided.
362 * XXX: posix acl_delete_def_file returns an error if
363 * the file referred to by path is not a directory.
364 * this function does not complain but the actions
365 * have no effect on a file other than a directory.
366 * But sys_acl_delete_default_file is only called in
367 * smbd/posixacls.c after having checked that the file
368 * is a directory, anyways. So implementing the extra
369 * check is considered unnecessary. --- Agreed? XXX
371 int hpuxacl_sys_acl_delete_def_file(vfs_handle_struct *handle,
372 const char *path)
374 SMB_ACL_T smb_acl;
375 int ret = -1;
376 HPUX_ACL_T hpux_acl;
377 int count;
379 DEBUG(10, ("entering hpuxacl_sys_acl_delete_def_file.\n"));
381 smb_acl = hpuxacl_sys_acl_get_file(handle, path,
382 SMB_ACL_TYPE_ACCESS);
383 if (smb_acl == NULL) {
384 DEBUG(10, ("getting file acl failed!\n"));
385 goto done;
387 if (!smb_acl_to_hpux_acl(smb_acl, &hpux_acl, &count,
388 SMB_ACL_TYPE_ACCESS))
390 DEBUG(10, ("conversion smb_acl -> hpux_acl failed.\n"));
391 goto done;
393 if (!hpux_acl_sort(hpux_acl, count)) {
394 DEBUG(10, ("resulting acl is not valid!\n"));
395 goto done;
397 ret = acl(discard_const_p(char, path), ACL_SET, count, hpux_acl);
398 if (ret != 0) {
399 DEBUG(10, ("settinge file acl failed!\n"));
402 done:
403 DEBUG(10, ("hpuxacl_sys_acl_delete_def_file %s.\n",
404 ((ret != 0) ? "failed" : "succeeded" )));
405 SAFE_FREE(smb_acl);
406 return ret;
411 * private functions
414 static HPUX_ACL_T hpux_acl_init(int count)
416 HPUX_ACL_T hpux_acl =
417 (HPUX_ACL_T)SMB_MALLOC(sizeof(HPUX_ACE_T) * count);
418 if (hpux_acl == NULL) {
419 errno = ENOMEM;
421 return hpux_acl;
425 * Convert the SMB acl to the ACCESS or DEFAULT part of a
426 * hpux ACL, as desired.
428 static bool smb_acl_to_hpux_acl(SMB_ACL_T smb_acl,
429 HPUX_ACL_T *hpux_acl, int *count,
430 SMB_ACL_TYPE_T type)
432 bool ret = False;
433 int i;
434 int check_which, check_rc;
436 DEBUG(10, ("entering smb_acl_to_hpux_acl\n"));
438 *hpux_acl = NULL;
439 *count = 0;
441 for (i = 0; i < smb_acl->count; i++) {
442 const struct smb_acl_entry *smb_entry = &(smb_acl->acl[i]);
443 HPUX_ACE_T hpux_entry;
445 ZERO_STRUCT(hpux_entry);
447 hpux_entry.a_type = smb_tag_to_hpux_tag(smb_entry->a_type);
448 if (hpux_entry.a_type == 0) {
449 DEBUG(10, ("smb_tag to hpux_tag failed\n"));
450 goto fail;
452 switch(hpux_entry.a_type) {
453 case USER:
454 DEBUG(10, ("got tag type USER with uid %d\n",
455 smb_entry->uid));
456 hpux_entry.a_id = (uid_t)smb_entry->uid;
457 break;
458 case GROUP:
459 DEBUG(10, ("got tag type GROUP with gid %d\n",
460 smb_entry->gid));
461 hpux_entry.a_id = (uid_t)smb_entry->gid;
462 break;
463 default:
464 break;
466 if (type == SMB_ACL_TYPE_DEFAULT) {
467 DEBUG(10, ("adding default bit to hpux ace\n"));
468 hpux_entry.a_type |= ACL_DEFAULT;
471 hpux_entry.a_perm =
472 smb_perm_to_hpux_perm(smb_entry->a_perm);
473 DEBUG(10, ("assembled the following hpux ace:\n"));
474 DEBUGADD(10, (" - type: 0x%04x\n", hpux_entry.a_type));
475 DEBUGADD(10, (" - id: %d\n", hpux_entry.a_id));
476 DEBUGADD(10, (" - perm: o%o\n", hpux_entry.a_perm));
477 if (!hpux_add_to_acl(hpux_acl, count, &hpux_entry,
478 1, type))
480 DEBUG(10, ("error adding acl entry\n"));
481 goto fail;
483 DEBUG(10, ("count after adding: %d (i: %d)\n", *count, i));
484 DEBUG(10, ("test, if entry has been copied into acl:\n"));
485 DEBUGADD(10, (" - type: 0x%04x\n",
486 (*hpux_acl)[(*count)-1].a_type));
487 DEBUGADD(10, (" - id: %d\n",
488 (*hpux_acl)[(*count)-1].a_id));
489 DEBUGADD(10, (" - perm: o%o\n",
490 (*hpux_acl)[(*count)-1].a_perm));
493 ret = True;
494 goto done;
496 fail:
497 SAFE_FREE(*hpux_acl);
498 done:
499 DEBUG(10, ("smb_acl_to_hpux_acl %s\n",
500 ((ret == True) ? "succeeded" : "failed")));
501 return ret;
505 * convert either the access or the default part of a
506 * soaris acl to the SMB_ACL format.
508 static SMB_ACL_T hpux_acl_to_smb_acl(HPUX_ACL_T hpux_acl, int count,
509 SMB_ACL_TYPE_T type)
511 SMB_ACL_T result;
512 int i;
514 if ((result = sys_acl_init(0)) == NULL) {
515 DEBUG(10, ("error allocating memory for SMB_ACL\n"));
516 goto fail;
518 for (i = 0; i < count; i++) {
519 SMB_ACL_ENTRY_T smb_entry;
520 SMB_ACL_PERM_T smb_perm;
522 if (!_IS_OF_TYPE(hpux_acl[i], type)) {
523 continue;
525 result = SMB_REALLOC(result,
526 sizeof(struct smb_acl_t) +
527 (sizeof(struct smb_acl_entry) *
528 (result->count + 1)));
529 if (result == NULL) {
530 DEBUG(10, ("error reallocating memory for SMB_ACL\n"));
531 goto fail;
533 smb_entry = &result->acl[result->count];
534 if (sys_acl_set_tag_type(smb_entry,
535 hpux_tag_to_smb_tag(hpux_acl[i].a_type)) != 0)
537 DEBUG(10, ("invalid tag type given: 0x%04x\n",
538 hpux_acl[i].a_type));
539 goto fail;
541 /* intentionally not checking return code here: */
542 sys_acl_set_qualifier(smb_entry, (void *)&hpux_acl[i].a_id);
543 smb_perm = hpux_perm_to_smb_perm(hpux_acl[i].a_perm);
544 if (sys_acl_set_permset(smb_entry, &smb_perm) != 0) {
545 DEBUG(10, ("invalid permset given: %d\n",
546 hpux_acl[i].a_perm));
547 goto fail;
549 result->count += 1;
551 goto done;
552 fail:
553 SAFE_FREE(result);
554 done:
555 DEBUG(10, ("hpux_acl_to_smb_acl %s\n",
556 ((result == NULL) ? "failed" : "succeeded")));
557 return result;
562 static HPUX_ACL_TAG_T smb_tag_to_hpux_tag(SMB_ACL_TAG_T smb_tag)
564 HPUX_ACL_TAG_T hpux_tag = 0;
566 DEBUG(10, ("smb_tag_to_hpux_tag\n"));
567 DEBUGADD(10, (" --> got smb tag 0x%04x\n", smb_tag));
569 switch (smb_tag) {
570 case SMB_ACL_USER:
571 hpux_tag = USER;
572 break;
573 case SMB_ACL_USER_OBJ:
574 hpux_tag = USER_OBJ;
575 break;
576 case SMB_ACL_GROUP:
577 hpux_tag = GROUP;
578 break;
579 case SMB_ACL_GROUP_OBJ:
580 hpux_tag = GROUP_OBJ;
581 break;
582 case SMB_ACL_OTHER:
583 hpux_tag = OTHER_OBJ;
584 break;
585 case SMB_ACL_MASK:
586 hpux_tag = CLASS_OBJ;
587 break;
588 default:
589 DEBUGADD(10, (" !!! unknown smb tag type 0x%04x\n", smb_tag));
590 break;
593 DEBUGADD(10, (" --> determined hpux tag 0x%04x\n", hpux_tag));
595 return hpux_tag;
598 static SMB_ACL_TAG_T hpux_tag_to_smb_tag(HPUX_ACL_TAG_T hpux_tag)
600 SMB_ACL_TAG_T smb_tag = 0;
602 DEBUG(10, ("hpux_tag_to_smb_tag:\n"));
603 DEBUGADD(10, (" --> got hpux tag 0x%04x\n", hpux_tag));
605 hpux_tag &= ~ACL_DEFAULT;
607 switch (hpux_tag) {
608 case USER:
609 smb_tag = SMB_ACL_USER;
610 break;
611 case USER_OBJ:
612 smb_tag = SMB_ACL_USER_OBJ;
613 break;
614 case GROUP:
615 smb_tag = SMB_ACL_GROUP;
616 break;
617 case GROUP_OBJ:
618 smb_tag = SMB_ACL_GROUP_OBJ;
619 break;
620 case OTHER_OBJ:
621 smb_tag = SMB_ACL_OTHER;
622 break;
623 case CLASS_OBJ:
624 smb_tag = SMB_ACL_MASK;
625 break;
626 default:
627 DEBUGADD(10, (" !!! unknown hpux tag type: 0x%04x\n",
628 hpux_tag));
629 break;
632 DEBUGADD(10, (" --> determined smb tag 0x%04x\n", smb_tag));
634 return smb_tag;
639 * The permission bits used in the following two permission conversion
640 * functions are same, but the functions make us independent of the concrete
641 * permission data types.
643 static SMB_ACL_PERM_T hpux_perm_to_smb_perm(const HPUX_PERM_T perm)
645 SMB_ACL_PERM_T smb_perm = 0;
646 smb_perm |= ((perm & SMB_ACL_READ) ? SMB_ACL_READ : 0);
647 smb_perm |= ((perm & SMB_ACL_WRITE) ? SMB_ACL_WRITE : 0);
648 smb_perm |= ((perm & SMB_ACL_EXECUTE) ? SMB_ACL_EXECUTE : 0);
649 return smb_perm;
653 static HPUX_PERM_T smb_perm_to_hpux_perm(const SMB_ACL_PERM_T perm)
655 HPUX_PERM_T hpux_perm = 0;
656 hpux_perm |= ((perm & SMB_ACL_READ) ? SMB_ACL_READ : 0);
657 hpux_perm |= ((perm & SMB_ACL_WRITE) ? SMB_ACL_WRITE : 0);
658 hpux_perm |= ((perm & SMB_ACL_EXECUTE) ? SMB_ACL_EXECUTE : 0);
659 return hpux_perm;
663 static bool hpux_acl_get_file(const char *name, HPUX_ACL_T *hpux_acl,
664 int *count)
666 bool result = False;
667 static HPUX_ACE_T dummy_ace;
669 DEBUG(10, ("hpux_acl_get_file called for file '%s'\n", name));
672 * The original code tries some INITIAL_ACL_SIZE
673 * and only did the ACL_CNT call upon failure
674 * (for performance reasons).
675 * For the sake of simplicity, I skip this for now.
677 * NOTE: There is a catch here on HP-UX: acl with cmd parameter
678 * ACL_CNT fails with errno EINVAL when called with a NULL
679 * pointer as last argument. So we need to use a dummy acl
680 * struct here (we make it static so it does not need to be
681 * instantiated or malloced each time this function is
682 * called). Btw: the count parameter does not seem to matter...
684 *count = acl(discard_const_p(char, name), ACL_CNT, 0, &dummy_ace);
685 if (*count < 0) {
686 DEBUG(10, ("acl ACL_CNT failed: %s\n", strerror(errno)));
687 goto done;
689 *hpux_acl = hpux_acl_init(*count);
690 if (*hpux_acl == NULL) {
691 DEBUG(10, ("error allocating memory for hpux acl...\n"));
692 goto done;
694 *count = acl(discard_const_p(char, name), ACL_GET, *count, *hpux_acl);
695 if (*count < 0) {
696 DEBUG(10, ("acl ACL_GET failed: %s\n", strerror(errno)));
697 goto done;
699 result = True;
701 done:
702 DEBUG(10, ("hpux_acl_get_file %s.\n",
703 ((result == True) ? "succeeded" : "failed" )));
704 return result;
711 * Add entries to a hpux ACL.
713 * Entries are directly added to the hpuxacl parameter.
714 * if memory allocation fails, this may result in hpuxacl
715 * being NULL. if the resulting acl is to be checked and is
716 * not valid, it is kept in hpuxacl but False is returned.
718 * The type of ACEs (access/default) to be added to the ACL can
719 * be selected via the type parameter.
720 * I use the SMB_ACL_TYPE_T type here. Since SMB_ACL_TYPE_ACCESS
721 * is defined as "0", this means that one can only add either
722 * access or default ACEs from the given ACL, not both at the same
723 * time. If it should become necessary to add all of an ACL, one
724 * would have to replace this parameter by another type.
726 static bool hpux_add_to_acl(HPUX_ACL_T *hpux_acl, int *count,
727 HPUX_ACL_T add_acl, int add_count,
728 SMB_ACL_TYPE_T type)
730 int i;
732 if ((type != SMB_ACL_TYPE_ACCESS) && (type != SMB_ACL_TYPE_DEFAULT))
734 DEBUG(10, ("invalid acl type given: %d\n", type));
735 errno = EINVAL;
736 return False;
738 for (i = 0; i < add_count; i++) {
739 if (!_IS_OF_TYPE(add_acl[i], type)) {
740 continue;
742 ADD_TO_ARRAY(NULL, HPUX_ACE_T, add_acl[i],
743 hpux_acl, count);
744 if (hpux_acl == NULL) {
745 DEBUG(10, ("error enlarging acl.\n"));
746 errno = ENOMEM;
747 return False;
750 return True;
755 * sort the ACL and check it for validity
757 * [original comment from lib/sysacls.c:]
759 * if it's a minimal ACL with only 4 entries then we
760 * need to recalculate the mask permissions to make
761 * sure that they are the same as the GROUP_OBJ
762 * permissions as required by the UnixWare acl() system call.
764 * (note: since POSIX allows minimal ACLs which only contain
765 * 3 entries - ie there is no mask entry - we should, in theory,
766 * check for this and add a mask entry if necessary - however
767 * we "know" that the caller of this interface always specifies
768 * a mask, so in practice "this never happens" (tm) - if it *does*
769 * happen aclsort() will fail and return an error and someone will
770 * have to fix it...)
772 static bool hpux_acl_sort(HPUX_ACL_T hpux_acl, int count)
774 int fixmask = (count <= 4);
776 if (hpux_internal_aclsort(count, fixmask, hpux_acl) != 0) {
777 errno = EINVAL;
778 return False;
780 return True;
785 * Helpers for hpux_internal_aclsort:
786 * - hpux_count_obj
787 * - hpux_swap_acl_entries
788 * - hpux_prohibited_duplicate_type
789 * - hpux_get_needed_class_perm
792 /* hpux_count_obj:
793 * Counts the different number of objects in a given array of ACL
794 * structures.
795 * Inputs:
797 * acl_count - Count of ACLs in the array of ACL strucutres.
798 * aclp - Array of ACL structures.
799 * acl_type_count - Pointer to acl_types structure. Should already be
800 * allocated.
801 * Output:
803 * acl_type_count - This structure is filled up with counts of various
804 * acl types.
807 static void hpux_count_obj(int acl_count, HPUX_ACL_T aclp, struct hpux_acl_types *acl_type_count)
809 int i;
811 memset(acl_type_count, 0, sizeof(struct hpux_acl_types));
813 for(i=0;i<acl_count;i++) {
814 switch(aclp[i].a_type) {
815 case USER:
816 acl_type_count->n_user++;
817 break;
818 case USER_OBJ:
819 acl_type_count->n_user_obj++;
820 break;
821 case DEF_USER_OBJ:
822 acl_type_count->n_def_user_obj++;
823 break;
824 case GROUP:
825 acl_type_count->n_group++;
826 break;
827 case GROUP_OBJ:
828 acl_type_count->n_group_obj++;
829 break;
830 case DEF_GROUP_OBJ:
831 acl_type_count->n_def_group_obj++;
832 break;
833 case OTHER_OBJ:
834 acl_type_count->n_other_obj++;
835 break;
836 case DEF_OTHER_OBJ:
837 acl_type_count->n_def_other_obj++;
838 break;
839 case CLASS_OBJ:
840 acl_type_count->n_class_obj++;
841 break;
842 case DEF_CLASS_OBJ:
843 acl_type_count->n_def_class_obj++;
844 break;
845 case DEF_USER:
846 acl_type_count->n_def_user++;
847 break;
848 case DEF_GROUP:
849 acl_type_count->n_def_group++;
850 break;
851 default:
852 acl_type_count->n_illegal_obj++;
853 break;
858 /* hpux_swap_acl_entries: Swaps two ACL entries.
860 * Inputs: aclp0, aclp1 - ACL entries to be swapped.
863 static void hpux_swap_acl_entries(HPUX_ACE_T *aclp0, HPUX_ACE_T *aclp1)
865 HPUX_ACE_T temp_acl;
867 temp_acl.a_type = aclp0->a_type;
868 temp_acl.a_id = aclp0->a_id;
869 temp_acl.a_perm = aclp0->a_perm;
871 aclp0->a_type = aclp1->a_type;
872 aclp0->a_id = aclp1->a_id;
873 aclp0->a_perm = aclp1->a_perm;
875 aclp1->a_type = temp_acl.a_type;
876 aclp1->a_id = temp_acl.a_id;
877 aclp1->a_perm = temp_acl.a_perm;
880 /* hpux_prohibited_duplicate_type
881 * Identifies if given ACL type can have duplicate entries or
882 * not.
884 * Inputs: acl_type - ACL Type.
886 * Outputs:
888 * Return..
890 * True - If the ACL type matches any of the prohibited types.
891 * False - If the ACL type doesn't match any of the prohibited types.
894 static bool hpux_prohibited_duplicate_type(int acl_type)
896 switch(acl_type) {
897 case USER:
898 case GROUP:
899 case DEF_USER:
900 case DEF_GROUP:
901 return True;
902 default:
903 return False;
907 /* hpux_get_needed_class_perm
908 * Returns the permissions of a ACL structure only if the ACL
909 * type matches one of the pre-determined types for computing
910 * CLASS_OBJ permissions.
912 * Inputs: aclp - Pointer to ACL structure.
915 static int hpux_get_needed_class_perm(struct acl *aclp)
917 switch(aclp->a_type) {
918 case USER:
919 case GROUP_OBJ:
920 case GROUP:
921 case DEF_USER_OBJ:
922 case DEF_USER:
923 case DEF_GROUP_OBJ:
924 case DEF_GROUP:
925 case DEF_CLASS_OBJ:
926 case DEF_OTHER_OBJ:
927 return aclp->a_perm;
928 default:
929 return 0;
933 /* hpux_internal_aclsort: aclsort for HPUX.
935 * -> The aclsort() system call is availabe on the latest HPUX General
936 * -> Patch Bundles. So for HPUX, we developed our version of aclsort
937 * -> function. Because, we don't want to update to a new
938 * -> HPUX GR bundle just for aclsort() call.
940 * aclsort sorts the array of ACL structures as per the description in
941 * aclsort man page. Refer to aclsort man page for more details
943 * Inputs:
945 * acl_count - Count of ACLs in the array of ACL structures.
946 * calclass - If this is not zero, then we compute the CLASS_OBJ
947 * permissions.
948 * aclp - Array of ACL structures.
950 * Outputs:
952 * aclp - Sorted array of ACL structures.
954 * Outputs:
956 * Returns 0 for success -1 for failure. Prints a message to the Samba
957 * debug log in case of failure.
960 static int hpux_internal_aclsort(int acl_count, int calclass, HPUX_ACL_T aclp)
962 struct hpux_acl_types acl_obj_count;
963 int n_class_obj_perm = 0;
964 int i, j;
966 DEBUG(10,("Entering hpux_internal_aclsort. (calclass = %d)\n", calclass));
968 if (hpux_aclsort_call_present()) {
969 DEBUG(10, ("calling hpux aclsort\n"));
970 return aclsort(acl_count, calclass, aclp);
973 DEBUG(10, ("using internal aclsort\n"));
975 if(!acl_count) {
976 DEBUG(10,("Zero acl count passed. Returning Success\n"));
977 return 0;
980 if(aclp == NULL) {
981 DEBUG(0,("Null ACL pointer in hpux_acl_sort. Returning Failure. \n"));
982 return -1;
985 /* Count different types of ACLs in the ACLs array */
987 hpux_count_obj(acl_count, aclp, &acl_obj_count);
989 /* There should be only one entry each of type USER_OBJ, GROUP_OBJ,
990 * CLASS_OBJ and OTHER_OBJ
993 if ( (acl_obj_count.n_user_obj != 1) ||
994 (acl_obj_count.n_group_obj != 1) ||
995 (acl_obj_count.n_class_obj != 1) ||
996 (acl_obj_count.n_other_obj != 1) )
998 DEBUG(0,("hpux_internal_aclsort: More than one entry or no entries for \
999 USER OBJ or GROUP_OBJ or OTHER_OBJ or CLASS_OBJ\n"));
1000 return -1;
1003 /* If any of the default objects are present, there should be only
1004 * one of them each.
1007 if ( (acl_obj_count.n_def_user_obj > 1) ||
1008 (acl_obj_count.n_def_group_obj > 1) ||
1009 (acl_obj_count.n_def_other_obj > 1) ||
1010 (acl_obj_count.n_def_class_obj > 1) )
1012 DEBUG(0,("hpux_internal_aclsort: More than one entry for DEF_CLASS_OBJ \
1013 or DEF_USER_OBJ or DEF_GROUP_OBJ or DEF_OTHER_OBJ\n"));
1014 return -1;
1017 /* We now have proper number of OBJ and DEF_OBJ entries. Now sort the acl
1018 * structures.
1020 * Sorting crieteria - First sort by ACL type. If there are multiple entries of
1021 * same ACL type, sort by ACL id.
1023 * I am using the trival kind of sorting method here because, performance isn't
1024 * really effected by the ACLs feature. More over there aren't going to be more
1025 * than 17 entries on HPUX.
1028 for(i=0; i<acl_count;i++) {
1029 for (j=i+1; j<acl_count; j++) {
1030 if( aclp[i].a_type > aclp[j].a_type ) {
1031 /* ACL entries out of order, swap them */
1032 hpux_swap_acl_entries((aclp+i), (aclp+j));
1033 } else if ( aclp[i].a_type == aclp[j].a_type ) {
1034 /* ACL entries of same type, sort by id */
1035 if(aclp[i].a_id > aclp[j].a_id) {
1036 hpux_swap_acl_entries((aclp+i), (aclp+j));
1037 } else if (aclp[i].a_id == aclp[j].a_id) {
1038 /* We have a duplicate entry. */
1039 if(hpux_prohibited_duplicate_type(aclp[i].a_type)) {
1040 DEBUG(0, ("hpux_internal_aclsort: Duplicate entry: Type(hex): %x Id: %d\n",
1041 aclp[i].a_type, aclp[i].a_id));
1042 return -1;
1049 /* set the class obj permissions to the computed one. */
1050 if(calclass) {
1051 int n_class_obj_index = -1;
1053 for(i=0;i<acl_count;i++) {
1054 n_class_obj_perm |= hpux_get_needed_class_perm((aclp+i));
1056 if(aclp[i].a_type == CLASS_OBJ)
1057 n_class_obj_index = i;
1059 aclp[n_class_obj_index].a_perm = n_class_obj_perm;
1062 return 0;
1067 * hpux_acl_call_present:
1069 * This checks if the POSIX ACL system call is defined
1070 * which basically corresponds to whether JFS 3.3 or
1071 * higher is installed. If acl() was called when it
1072 * isn't defined, it causes the process to core dump
1073 * so it is important to check this and avoid acl()
1074 * calls if it isn't there.
1077 static bool hpux_acl_call_present(void)
1080 shl_t handle = NULL;
1081 void *value;
1082 int ret_val=0;
1083 static bool already_checked = False;
1085 if(already_checked)
1086 return True;
1088 errno = 0;
1090 ret_val = shl_findsym(&handle, "acl", TYPE_PROCEDURE, &value);
1092 if(ret_val != 0) {
1093 DEBUG(5, ("hpux_acl_call_present: shl_findsym() returned %d, errno = %d, error %s\n",
1094 ret_val, errno, strerror(errno)));
1095 DEBUG(5,("hpux_acl_call_present: acl() system call is not present. Check if you have JFS 3.3 and above?\n"));
1096 errno = ENOSYS;
1097 return False;
1100 DEBUG(10,("hpux_acl_call_present: acl() system call is present. We have JFS 3.3 or above \n"));
1102 already_checked = True;
1103 return True;
1107 * runtime check for presence of aclsort library call.
1108 * same code as for acl call. if there are more of these,
1109 * a dispatcher function could be handy...
1112 static bool hpux_aclsort_call_present(void)
1114 shl_t handle = NULL;
1115 void *value;
1116 int ret_val = 0;
1117 static bool already_checked = False;
1119 if (already_checked) {
1120 return True;
1123 errno = 0;
1124 ret_val = shl_findsym(&handle, "aclsort", TYPE_PROCEDURE, &value);
1125 if (ret_val != 0) {
1126 DEBUG(5, ("hpux_aclsort_call_present: shl_findsym "
1127 "returned %d, errno = %d, error %s",
1128 ret_val, errno, strerror(errno)));
1129 DEBUG(5, ("hpux_aclsort_call_present: "
1130 "aclsort() function not available.\n"));
1131 return False;
1133 DEBUG(10,("hpux_aclsort_call_present: aclsort() function present.\n"));
1134 already_checked = True;
1135 return True;
1138 #if 0
1140 * acl check function:
1141 * unused at the moment but could be used to get more
1142 * concrete error messages for debugging...
1143 * (acl sort just says that the acl is invalid...)
1145 static bool hpux_acl_check(HPUX_ACL_T hpux_acl, int count)
1147 int check_rc;
1148 int check_which;
1150 check_rc = aclcheck(hpux_acl, count, &check_which);
1151 if (check_rc != 0) {
1152 DEBUG(10, ("acl is not valid:\n"));
1153 DEBUGADD(10, (" - return code: %d\n", check_rc));
1154 DEBUGADD(10, (" - which: %d\n", check_which));
1155 if (check_which != -1) {
1156 DEBUGADD(10, (" - invalid entry:\n"));
1157 DEBUGADD(10, (" * type: %d:\n",
1158 hpux_acl[check_which].a_type));
1159 DEBUGADD(10, (" * id: %d\n",
1160 hpux_acl[check_which].a_id));
1161 DEBUGADD(10, (" * perm: 0o%o\n",
1162 hpux_acl[check_which].a_perm));
1164 return False;
1166 return True;
1168 #endif
1170 /* VFS operations structure */
1172 static struct vfs_fn_pointers hpuxacl_fns = {
1173 .sys_acl_get_file = hpuxacl_sys_acl_get_file,
1174 .sys_acl_get_fd = hpuxacl_sys_acl_get_fd,
1175 .sys_acl_set_file = hpuxacl_sys_acl_set_file,
1176 .sys_acl_set_fd = hpuxacl_sys_acl_set_fd,
1177 .sys_acl_delete_def_file = hpuxacl_sys_acl_delete_def_file,
1180 NTSTATUS vfs_hpuxacl_init(void)
1182 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "hpuxacl",
1183 &hpuxacl_fns);
1186 /* ENTE */