2 * Copyright (c) 2008-2010 Edward Tomasz NapieraĆa <trasz@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * ACL support routines specific to NFSv4 access control lists. These are
29 * utility routines for code common across file systems implementing NFSv4
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
40 #include <sys/systm.h>
41 #include <sys/mount.h>
43 #include <sys/vnode.h>
44 #include <sys/errno.h>
46 #include <sys/sysctl.h>
53 #define KASSERT(a, b) assert(a)
60 static void acl_nfs4_trivial_from_mode(struct acl *aclp, mode_t mode);
62 static int acl_nfs4_old_semantics = 0;
64 SYSCTL_INT(_vfs, OID_AUTO, acl_nfs4_old_semantics, CTLFLAG_RW,
65 &acl_nfs4_old_semantics, 0, "Use pre-PSARC/2010/029 NFSv4 ACL semantics");
70 } accmode2mask[] = {{VREAD, ACL_READ_DATA},
71 {VWRITE, ACL_WRITE_DATA},
72 {VAPPEND, ACL_APPEND_DATA},
74 {VREAD_NAMED_ATTRS, ACL_READ_NAMED_ATTRS},
75 {VWRITE_NAMED_ATTRS, ACL_WRITE_NAMED_ATTRS},
76 {VDELETE_CHILD, ACL_DELETE_CHILD},
77 {VREAD_ATTRIBUTES, ACL_READ_ATTRIBUTES},
78 {VWRITE_ATTRIBUTES, ACL_WRITE_ATTRIBUTES},
79 {VDELETE, ACL_DELETE},
80 {VREAD_ACL, ACL_READ_ACL},
81 {VWRITE_ACL, ACL_WRITE_ACL},
82 {VWRITE_OWNER, ACL_WRITE_OWNER},
83 {VSYNCHRONIZE, ACL_SYNCHRONIZE},
87 _access_mask_from_accmode(accmode_t accmode)
89 int access_mask = 0, i;
91 for (i = 0; accmode2mask[i].accmode != 0; i++) {
92 if (accmode & accmode2mask[i].accmode)
93 access_mask |= accmode2mask[i].mask;
97 * VAPPEND is just a modifier for VWRITE; if the caller asked
98 * for 'VAPPEND | VWRITE', we want to check for ACL_APPEND_DATA only.
100 if (access_mask & ACL_APPEND_DATA)
101 access_mask &= ~ACL_WRITE_DATA;
103 return (access_mask);
107 * Return 0, iff access is allowed, 1 otherwise.
110 _acl_denies(const struct acl *aclp, int access_mask, struct ucred *cred,
111 int file_uid, int file_gid, int *denied_explicitly)
114 const struct acl_entry *entry;
116 if (denied_explicitly != NULL)
117 *denied_explicitly = 0;
119 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
120 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
122 for (i = 0; i < aclp->acl_cnt; i++) {
123 entry = &(aclp->acl_entry[i]);
125 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
126 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
128 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
130 switch (entry->ae_tag) {
132 if (file_uid != cred->cr_uid)
136 if (entry->ae_id != cred->cr_uid)
140 if (!groupmember(file_gid, cred))
144 if (!groupmember(entry->ae_id, cred))
148 KASSERT(entry->ae_tag == ACL_EVERYONE,
149 ("entry->ae_tag == ACL_EVERYONE"));
152 if (entry->ae_entry_type == ACL_ENTRY_TYPE_DENY) {
153 if (entry->ae_perm & access_mask) {
154 if (denied_explicitly != NULL)
155 *denied_explicitly = 1;
160 access_mask &= ~(entry->ae_perm);
161 if (access_mask == 0)
165 if (access_mask == 0)
172 vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid,
173 struct acl *aclp, accmode_t accmode, struct ucred *cred, int *privused)
175 accmode_t priv_granted = 0;
176 int denied, explicitly_denied, access_mask, is_directory,
178 mode_t file_mode = 0;
180 KASSERT((accmode & ~(VEXEC | VWRITE | VREAD | VADMIN | VAPPEND |
181 VEXPLICIT_DENY | VREAD_NAMED_ATTRS | VWRITE_NAMED_ATTRS |
182 VDELETE_CHILD | VREAD_ATTRIBUTES | VWRITE_ATTRIBUTES | VDELETE |
183 VREAD_ACL | VWRITE_ACL | VWRITE_OWNER | VSYNCHRONIZE)) == 0,
184 ("invalid bit in accmode"));
185 KASSERT((accmode & VAPPEND) == 0 || (accmode & VWRITE),
186 ("VAPPEND without VWRITE"));
188 if (privused != NULL)
191 if (accmode & VADMIN)
195 * Ignore VSYNCHRONIZE permission.
197 accmode &= ~VSYNCHRONIZE;
199 access_mask = _access_mask_from_accmode(accmode);
207 * File owner is always allowed to read and write the ACL
208 * and basic attributes. This is to prevent a situation
209 * where user would change ACL in a way that prevents him
210 * from undoing the change.
212 if (file_uid == cred->cr_uid)
213 access_mask &= ~(ACL_READ_ACL | ACL_WRITE_ACL |
214 ACL_READ_ATTRIBUTES | ACL_WRITE_ATTRIBUTES);
217 * Ignore append permission for regular files; use write
218 * permission instead.
220 if (!is_directory && (access_mask & ACL_APPEND_DATA)) {
221 access_mask &= ~ACL_APPEND_DATA;
222 access_mask |= ACL_WRITE_DATA;
225 denied = _acl_denies(aclp, access_mask, cred, file_uid, file_gid,
229 if (file_uid != cred->cr_uid)
234 * For VEXEC, ensure that at least one execute bit is set for
235 * non-directories. We have to check the mode here to stay
236 * consistent with execve(2). See the test in
237 * exec_check_permissions().
239 acl_nfs4_sync_mode_from_acl(&file_mode, aclp);
240 if (!denied && !is_directory && (accmode & VEXEC) &&
241 (file_mode & (S_IXUSR | S_IXGRP | S_IXOTH)) == 0)
248 * Access failed. Iff it was not denied explicitly and
249 * VEXPLICIT_DENY flag was specified, allow access.
251 if ((accmode & VEXPLICIT_DENY) && explicitly_denied == 0)
254 accmode &= ~VEXPLICIT_DENY;
257 * No match. Try to use privileges, if there are any.
260 if ((accmode & VEXEC) && !priv_check_cred(cred,
262 priv_granted |= VEXEC;
265 * Ensure that at least one execute bit is on. Otherwise,
266 * a privileged user will always succeed, and we don't want
267 * this to happen unless the file really is executable.
269 if ((accmode & VEXEC) && (file_mode &
270 (S_IXUSR | S_IXGRP | S_IXOTH)) != 0 &&
271 !priv_check_cred(cred, PRIV_VFS_EXEC, 0))
272 priv_granted |= VEXEC;
275 if ((accmode & VREAD) && !priv_check_cred(cred, PRIV_VFS_READ, 0))
276 priv_granted |= VREAD;
278 if ((accmode & (VWRITE | VAPPEND | VDELETE_CHILD)) &&
279 !priv_check_cred(cred, PRIV_VFS_WRITE, 0))
280 priv_granted |= (VWRITE | VAPPEND | VDELETE_CHILD);
282 if ((accmode & VADMIN_PERMS) &&
283 !priv_check_cred(cred, PRIV_VFS_ADMIN, 0))
284 priv_granted |= VADMIN_PERMS;
286 if ((accmode & VSTAT_PERMS) &&
287 !priv_check_cred(cred, PRIV_VFS_STAT, 0))
288 priv_granted |= VSTAT_PERMS;
290 if ((accmode & priv_granted) == accmode) {
291 if (privused != NULL)
297 if (accmode & (VADMIN_PERMS | VDELETE_CHILD | VDELETE))
307 _acl_entry_matches(struct acl_entry *entry, acl_tag_t tag, acl_perm_t perm,
308 acl_entry_type_t entry_type)
310 if (entry->ae_tag != tag)
313 if (entry->ae_id != ACL_UNDEFINED_ID)
316 if (entry->ae_perm != perm)
319 if (entry->ae_entry_type != entry_type)
322 if (entry->ae_flags != 0)
328 static struct acl_entry *
329 _acl_append(struct acl *aclp, acl_tag_t tag, acl_perm_t perm,
330 acl_entry_type_t entry_type)
332 struct acl_entry *entry;
334 KASSERT(aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
335 ("aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
337 entry = &(aclp->acl_entry[aclp->acl_cnt]);
341 entry->ae_id = ACL_UNDEFINED_ID;
342 entry->ae_perm = perm;
343 entry->ae_entry_type = entry_type;
349 static struct acl_entry *
350 _acl_duplicate_entry(struct acl *aclp, int entry_index)
354 KASSERT(aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
355 ("aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
357 for (i = aclp->acl_cnt; i > entry_index; i--)
358 aclp->acl_entry[i] = aclp->acl_entry[i - 1];
362 return (&(aclp->acl_entry[entry_index + 1]));
366 acl_nfs4_sync_acl_from_mode_draft(struct acl *aclp, mode_t mode,
369 int i, meets, must_append;
370 struct acl_entry *entry, *copy, *previous,
371 *a1, *a2, *a3, *a4, *a5, *a6;
374 const int WRITE = 02;
377 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
378 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
381 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
383 * 3.16.6.3. Applying a Mode to an Existing ACL
389 for (i = 0; i < aclp->acl_cnt; i++) {
390 entry = &(aclp->acl_entry[i]);
393 * 1.1. If the type is neither ALLOW or DENY - skip.
395 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
396 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
400 * 1.2. If ACL_ENTRY_INHERIT_ONLY is set - skip.
402 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
406 * 1.3. If ACL_ENTRY_FILE_INHERIT or ACL_ENTRY_DIRECTORY_INHERIT
409 if (entry->ae_flags &
410 (ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT)) {
412 * 1.3.1. A copy of the current ACE is made, and placed
413 * in the ACL immediately following the current
416 copy = _acl_duplicate_entry(aclp, i);
419 * 1.3.2. In the first ACE, the flag
420 * ACL_ENTRY_INHERIT_ONLY is set.
422 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
425 * 1.3.3. In the second ACE, the following flags
427 * ACL_ENTRY_FILE_INHERIT,
428 * ACL_ENTRY_DIRECTORY_INHERIT,
429 * ACL_ENTRY_NO_PROPAGATE_INHERIT.
431 copy->ae_flags &= ~(ACL_ENTRY_FILE_INHERIT |
432 ACL_ENTRY_DIRECTORY_INHERIT |
433 ACL_ENTRY_NO_PROPAGATE_INHERIT);
436 * The algorithm continues on with the second ACE.
443 * 1.4. If it's owner@, group@ or everyone@ entry, clear
444 * ACL_READ_DATA, ACL_WRITE_DATA, ACL_APPEND_DATA
445 * and ACL_EXECUTE. Continue to the next entry.
447 if (entry->ae_tag == ACL_USER_OBJ ||
448 entry->ae_tag == ACL_GROUP_OBJ ||
449 entry->ae_tag == ACL_EVERYONE) {
450 entry->ae_perm &= ~(ACL_READ_DATA | ACL_WRITE_DATA |
451 ACL_APPEND_DATA | ACL_EXECUTE);
456 * 1.5. Otherwise, if the "who" field did not match one
457 * of OWNER@, GROUP@, EVERYONE@:
459 * 1.5.1. If the type is ALLOW, check the preceding ACE.
460 * If it does not meet all of the following criteria:
462 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW)
468 previous = &(aclp->acl_entry[i - 1]);
471 * 1.5.1.1. The type field is DENY,
473 if (previous->ae_entry_type != ACL_ENTRY_TYPE_DENY)
477 * 1.5.1.2. The "who" field is the same as the current
480 * 1.5.1.3. The flag bit ACE4_IDENTIFIER_GROUP
481 * is the same as it is in the current ACE,
482 * and no other flag bits are set,
484 if (previous->ae_id != entry->ae_id ||
485 previous->ae_tag != entry->ae_tag)
488 if (previous->ae_flags)
492 * 1.5.1.4. The mask bits are a subset of the mask bits
493 * of the current ACE, and are also subset of
494 * the following: ACL_READ_DATA,
495 * ACL_WRITE_DATA, ACL_APPEND_DATA, ACL_EXECUTE
497 if (previous->ae_perm & ~(entry->ae_perm))
500 if (previous->ae_perm & ~(ACL_READ_DATA |
501 ACL_WRITE_DATA | ACL_APPEND_DATA | ACL_EXECUTE))
507 * Then the ACE of type DENY, with a who equal
508 * to the current ACE, flag bits equal to
509 * (<current ACE flags> & <ACE_IDENTIFIER_GROUP>)
510 * and no mask bits, is prepended.
513 entry = _acl_duplicate_entry(aclp, i);
515 /* Adjust counter, as we've just added an entry. */
518 previous->ae_tag = entry->ae_tag;
519 previous->ae_id = entry->ae_id;
520 previous->ae_flags = entry->ae_flags;
521 previous->ae_perm = 0;
522 previous->ae_entry_type = ACL_ENTRY_TYPE_DENY;
526 * 1.5.2. The following modifications are made to the prepended
527 * ACE. The intent is to mask the following ACE
528 * to disallow ACL_READ_DATA, ACL_WRITE_DATA,
529 * ACL_APPEND_DATA, or ACL_EXECUTE, based upon the group
530 * permissions of the new mode. As a special case,
531 * if the ACE matches the current owner of the file,
532 * the owner bits are used, rather than the group bits.
533 * This is reflected in the algorithm below.
538 * If ACE4_IDENTIFIER_GROUP is not set, and the "who" field
539 * in ACE matches the owner of the file, we shift amode three
540 * more bits, in order to have the owner permission bits
541 * placed in the three low order bits of amode.
543 if (entry->ae_tag == ACL_USER && entry->ae_id == file_owner_id)
546 if (entry->ae_perm & ACL_READ_DATA) {
548 previous->ae_perm &= ~ACL_READ_DATA;
550 previous->ae_perm |= ACL_READ_DATA;
553 if (entry->ae_perm & ACL_WRITE_DATA) {
555 previous->ae_perm &= ~ACL_WRITE_DATA;
557 previous->ae_perm |= ACL_WRITE_DATA;
560 if (entry->ae_perm & ACL_APPEND_DATA) {
562 previous->ae_perm &= ~ACL_APPEND_DATA;
564 previous->ae_perm |= ACL_APPEND_DATA;
567 if (entry->ae_perm & ACL_EXECUTE) {
569 previous->ae_perm &= ~ACL_EXECUTE;
571 previous->ae_perm |= ACL_EXECUTE;
575 * 1.5.3. If ACE4_IDENTIFIER_GROUP is set in the flags
578 * XXX: This point is not there in the Falkner's draft.
580 if (entry->ae_tag == ACL_GROUP &&
581 entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW) {
582 mode_t extramode, ownermode;
583 extramode = (mode >> 3) & 07;
584 ownermode = mode >> 6;
585 extramode &= ~ownermode;
588 if (extramode & READ) {
589 entry->ae_perm &= ~ACL_READ_DATA;
590 previous->ae_perm &= ~ACL_READ_DATA;
593 if (extramode & WRITE) {
595 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
597 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
600 if (extramode & EXEC) {
601 entry->ae_perm &= ~ACL_EXECUTE;
602 previous->ae_perm &= ~ACL_EXECUTE;
609 * 2. If there at least six ACEs, the final six ACEs are examined.
610 * If they are not equal to what we want, append six ACEs.
613 if (aclp->acl_cnt < 6) {
616 a6 = &(aclp->acl_entry[aclp->acl_cnt - 1]);
617 a5 = &(aclp->acl_entry[aclp->acl_cnt - 2]);
618 a4 = &(aclp->acl_entry[aclp->acl_cnt - 3]);
619 a3 = &(aclp->acl_entry[aclp->acl_cnt - 4]);
620 a2 = &(aclp->acl_entry[aclp->acl_cnt - 5]);
621 a1 = &(aclp->acl_entry[aclp->acl_cnt - 6]);
623 if (!_acl_entry_matches(a1, ACL_USER_OBJ, 0,
624 ACL_ENTRY_TYPE_DENY))
626 if (!_acl_entry_matches(a2, ACL_USER_OBJ, ACL_WRITE_ACL |
627 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
628 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_ALLOW))
630 if (!_acl_entry_matches(a3, ACL_GROUP_OBJ, 0,
631 ACL_ENTRY_TYPE_DENY))
633 if (!_acl_entry_matches(a4, ACL_GROUP_OBJ, 0,
634 ACL_ENTRY_TYPE_ALLOW))
636 if (!_acl_entry_matches(a5, ACL_EVERYONE, ACL_WRITE_ACL |
637 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
638 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_DENY))
640 if (!_acl_entry_matches(a6, ACL_EVERYONE, ACL_READ_ACL |
641 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS |
642 ACL_SYNCHRONIZE, ACL_ENTRY_TYPE_ALLOW))
647 KASSERT(aclp->acl_cnt + 6 <= ACL_MAX_ENTRIES,
648 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
650 a1 = _acl_append(aclp, ACL_USER_OBJ, 0, ACL_ENTRY_TYPE_DENY);
651 a2 = _acl_append(aclp, ACL_USER_OBJ, ACL_WRITE_ACL |
652 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
653 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_ALLOW);
654 a3 = _acl_append(aclp, ACL_GROUP_OBJ, 0, ACL_ENTRY_TYPE_DENY);
655 a4 = _acl_append(aclp, ACL_GROUP_OBJ, 0, ACL_ENTRY_TYPE_ALLOW);
656 a5 = _acl_append(aclp, ACL_EVERYONE, ACL_WRITE_ACL |
657 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
658 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_DENY);
659 a6 = _acl_append(aclp, ACL_EVERYONE, ACL_READ_ACL |
660 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS |
661 ACL_SYNCHRONIZE, ACL_ENTRY_TYPE_ALLOW);
663 KASSERT(a1 != NULL && a2 != NULL && a3 != NULL && a4 != NULL &&
664 a5 != NULL && a6 != NULL, ("couldn't append to ACL."));
668 * 3. The final six ACEs are adjusted according to the incoming mode.
671 a2->ae_perm |= ACL_READ_DATA;
673 a1->ae_perm |= ACL_READ_DATA;
675 a2->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
677 a1->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
679 a2->ae_perm |= ACL_EXECUTE;
681 a1->ae_perm |= ACL_EXECUTE;
684 a4->ae_perm |= ACL_READ_DATA;
686 a3->ae_perm |= ACL_READ_DATA;
688 a4->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
690 a3->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
692 a4->ae_perm |= ACL_EXECUTE;
694 a3->ae_perm |= ACL_EXECUTE;
697 a6->ae_perm |= ACL_READ_DATA;
699 a5->ae_perm |= ACL_READ_DATA;
701 a6->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
703 a5->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
705 a6->ae_perm |= ACL_EXECUTE;
707 a5->ae_perm |= ACL_EXECUTE;
712 acl_nfs4_sync_acl_from_mode(struct acl *aclp, mode_t mode,
716 if (acl_nfs4_old_semantics)
717 acl_nfs4_sync_acl_from_mode_draft(aclp, mode, file_owner_id);
719 acl_nfs4_trivial_from_mode(aclp, mode);
724 acl_nfs4_sync_mode_from_acl(mode_t *_mode, const struct acl *aclp)
727 mode_t old_mode = *_mode, mode = 0, seen = 0;
728 const struct acl_entry *entry;
730 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
731 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
734 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
736 * 3.16.6.1. Recomputing mode upon SETATTR of ACL
739 for (i = 0; i < aclp->acl_cnt; i++) {
740 entry = &(aclp->acl_entry[i]);
742 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
743 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
746 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
749 if (entry->ae_tag == ACL_USER_OBJ) {
750 if ((entry->ae_perm & ACL_READ_DATA) &&
751 ((seen & S_IRUSR) == 0)) {
753 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
756 if ((entry->ae_perm & ACL_WRITE_DATA) &&
757 ((seen & S_IWUSR) == 0)) {
759 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
762 if ((entry->ae_perm & ACL_EXECUTE) &&
763 ((seen & S_IXUSR) == 0)) {
765 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
768 } else if (entry->ae_tag == ACL_GROUP_OBJ) {
769 if ((entry->ae_perm & ACL_READ_DATA) &&
770 ((seen & S_IRGRP) == 0)) {
772 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
775 if ((entry->ae_perm & ACL_WRITE_DATA) &&
776 ((seen & S_IWGRP) == 0)) {
778 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
781 if ((entry->ae_perm & ACL_EXECUTE) &&
782 ((seen & S_IXGRP) == 0)) {
784 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
787 } else if (entry->ae_tag == ACL_EVERYONE) {
788 if (entry->ae_perm & ACL_READ_DATA) {
789 if ((seen & S_IRUSR) == 0) {
791 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
794 if ((seen & S_IRGRP) == 0) {
796 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
799 if ((seen & S_IROTH) == 0) {
801 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
805 if (entry->ae_perm & ACL_WRITE_DATA) {
806 if ((seen & S_IWUSR) == 0) {
808 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
811 if ((seen & S_IWGRP) == 0) {
813 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
816 if ((seen & S_IWOTH) == 0) {
818 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
822 if (entry->ae_perm & ACL_EXECUTE) {
823 if ((seen & S_IXUSR) == 0) {
825 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
828 if ((seen & S_IXGRP) == 0) {
830 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
833 if ((seen & S_IXOTH) == 0) {
835 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
842 *_mode = mode | (old_mode & ACL_PRESERVE_MASK);
847 * Calculate inherited ACL in a manner compatible with NFSv4 Minor Version 1,
848 * draft-ietf-nfsv4-minorversion1-03.txt.
851 acl_nfs4_compute_inherited_acl_draft(const struct acl *parent_aclp,
852 struct acl *child_aclp, mode_t mode, int file_owner_id,
856 const struct acl_entry *parent_entry;
857 struct acl_entry *entry, *copy;
859 KASSERT(child_aclp->acl_cnt == 0, ("child_aclp->acl_cnt == 0"));
860 KASSERT(parent_aclp->acl_cnt <= ACL_MAX_ENTRIES,
861 ("parent_aclp->acl_cnt <= ACL_MAX_ENTRIES"));
864 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
866 * 3.16.6.2. Applying the mode given to CREATE or OPEN
867 * to an inherited ACL
871 * 1. Form an ACL that is the concatenation of all inheritable ACEs.
873 for (i = 0; i < parent_aclp->acl_cnt; i++) {
874 parent_entry = &(parent_aclp->acl_entry[i]);
875 flags = parent_entry->ae_flags;
878 * Entry is not inheritable at all.
880 if ((flags & (ACL_ENTRY_DIRECTORY_INHERIT |
881 ACL_ENTRY_FILE_INHERIT)) == 0)
885 * We're creating a file, but entry is not inheritable
888 if (!is_directory && (flags & ACL_ENTRY_FILE_INHERIT) == 0)
892 * Entry is inheritable only by files, but has NO_PROPAGATE
893 * flag set, and we're creating a directory, so it wouldn't
894 * propagate to any file in that directory anyway.
897 (flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0 &&
898 (flags & ACL_ENTRY_NO_PROPAGATE_INHERIT))
901 KASSERT(child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
902 ("child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
903 child_aclp->acl_entry[child_aclp->acl_cnt] = *parent_entry;
904 child_aclp->acl_cnt++;
908 * 2. For each entry in the new ACL, adjust its flags, possibly
909 * creating two entries in place of one.
911 for (i = 0; i < child_aclp->acl_cnt; i++) {
912 entry = &(child_aclp->acl_entry[i]);
915 * This is not in the specification, but SunOS
916 * apparently does that.
918 if (((entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT) ||
920 entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
921 entry->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER);
924 * 2.A. If the ACL_ENTRY_NO_PROPAGATE_INHERIT is set, or if the object
925 * being created is not a directory, then clear the
926 * following flags: ACL_ENTRY_NO_PROPAGATE_INHERIT,
927 * ACL_ENTRY_FILE_INHERIT, ACL_ENTRY_DIRECTORY_INHERIT,
928 * ACL_ENTRY_INHERIT_ONLY.
930 if (entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT ||
932 entry->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
933 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
934 ACL_ENTRY_INHERIT_ONLY);
937 * Continue on to the next ACE.
943 * 2.B. If the object is a directory and ACL_ENTRY_FILE_INHERIT
944 * is set, but ACL_ENTRY_NO_PROPAGATE_INHERIT is not set, ensure
945 * that ACL_ENTRY_INHERIT_ONLY is set. Continue to the
946 * next ACE. Otherwise...
949 * XXX: Read it again and make sure what does the "otherwise"
953 (entry->ae_flags & ACL_ENTRY_FILE_INHERIT) &&
954 ((entry->ae_flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0)) {
955 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
960 * 2.C. If the type of the ACE is neither ALLOW nor deny,
963 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
964 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
968 * 2.D. Copy the original ACE into a second, adjacent ACE.
970 copy = _acl_duplicate_entry(child_aclp, i);
973 * 2.E. On the first ACE, ensure that ACL_ENTRY_INHERIT_ONLY
976 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
979 * 2.F. On the second ACE, clear the following flags:
980 * ACL_ENTRY_NO_PROPAGATE_INHERIT, ACL_ENTRY_FILE_INHERIT,
981 * ACL_ENTRY_DIRECTORY_INHERIT, ACL_ENTRY_INHERIT_ONLY.
983 copy->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
984 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
985 ACL_ENTRY_INHERIT_ONLY);
988 * 2.G. On the second ACE, if the type is ALLOW,
989 * an implementation MAY clear the following
990 * mask bits: ACL_WRITE_ACL, ACL_WRITE_OWNER.
992 if (copy->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
993 copy->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER);
996 * Increment the counter to skip the copied entry.
1002 * 3. To ensure that the mode is honored, apply the algorithm describe
1003 * in Section 2.16.6.3, using the mode that is to be used for file
1006 acl_nfs4_sync_acl_from_mode(child_aclp, mode, file_owner_id);
1008 #endif /* _KERNEL */
1011 * Populate the ACL with entries inherited from parent_aclp.
1014 acl_nfs4_inherit_entries(const struct acl *parent_aclp,
1015 struct acl *child_aclp, mode_t mode, int file_owner_id,
1019 const struct acl_entry *parent_entry;
1020 struct acl_entry *entry;
1022 KASSERT(parent_aclp->acl_cnt <= ACL_MAX_ENTRIES,
1023 ("parent_aclp->acl_cnt <= ACL_MAX_ENTRIES"));
1025 for (i = 0; i < parent_aclp->acl_cnt; i++) {
1026 parent_entry = &(parent_aclp->acl_entry[i]);
1027 flags = parent_entry->ae_flags;
1028 tag = parent_entry->ae_tag;
1031 * Don't inherit owner@, group@, or everyone@ entries.
1033 if (tag == ACL_USER_OBJ || tag == ACL_GROUP_OBJ ||
1034 tag == ACL_EVERYONE)
1038 * Entry is not inheritable at all.
1040 if ((flags & (ACL_ENTRY_DIRECTORY_INHERIT |
1041 ACL_ENTRY_FILE_INHERIT)) == 0)
1045 * We're creating a file, but entry is not inheritable
1048 if (!is_directory && (flags & ACL_ENTRY_FILE_INHERIT) == 0)
1052 * Entry is inheritable only by files, but has NO_PROPAGATE
1053 * flag set, and we're creating a directory, so it wouldn't
1054 * propagate to any file in that directory anyway.
1057 (flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0 &&
1058 (flags & ACL_ENTRY_NO_PROPAGATE_INHERIT))
1062 * Entry qualifies for being inherited.
1064 KASSERT(child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
1065 ("child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
1066 entry = &(child_aclp->acl_entry[child_aclp->acl_cnt]);
1067 *entry = *parent_entry;
1068 child_aclp->acl_cnt++;
1070 entry->ae_flags &= ~ACL_ENTRY_INHERIT_ONLY;
1071 entry->ae_flags |= ACL_ENTRY_INHERITED;
1074 * If the type of the ACE is neither ALLOW nor DENY,
1075 * then leave it as it is and proceed to the next one.
1077 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
1078 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
1082 * If the ACL_ENTRY_NO_PROPAGATE_INHERIT is set, or if
1083 * the object being created is not a directory, then clear
1084 * the following flags: ACL_ENTRY_NO_PROPAGATE_INHERIT,
1085 * ACL_ENTRY_FILE_INHERIT, ACL_ENTRY_DIRECTORY_INHERIT,
1086 * ACL_ENTRY_INHERIT_ONLY.
1088 if (entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT ||
1090 entry->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
1091 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
1092 ACL_ENTRY_INHERIT_ONLY);
1096 * If the object is a directory and ACL_ENTRY_FILE_INHERIT
1097 * is set, but ACL_ENTRY_DIRECTORY_INHERIT is not set, ensure
1098 * that ACL_ENTRY_INHERIT_ONLY is set.
1101 (entry->ae_flags & ACL_ENTRY_FILE_INHERIT) &&
1102 ((entry->ae_flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0)) {
1103 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
1106 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW &&
1107 (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY) == 0) {
1109 * Some permissions must never be inherited.
1111 entry->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER |
1112 ACL_WRITE_NAMED_ATTRS | ACL_WRITE_ATTRIBUTES);
1115 * Others must be masked according to the file mode.
1117 if ((mode & S_IRGRP) == 0)
1118 entry->ae_perm &= ~ACL_READ_DATA;
1119 if ((mode & S_IWGRP) == 0)
1121 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
1122 if ((mode & S_IXGRP) == 0)
1123 entry->ae_perm &= ~ACL_EXECUTE;
1129 * Calculate inherited ACL in a manner compatible with PSARC/2010/029.
1130 * It's also being used to calculate a trivial ACL, by inheriting from
1134 acl_nfs4_compute_inherited_acl_psarc(const struct acl *parent_aclp,
1135 struct acl *aclp, mode_t mode, int file_owner_id, int is_directory)
1137 acl_perm_t user_allow_first = 0, user_deny = 0, group_deny = 0;
1138 acl_perm_t user_allow, group_allow, everyone_allow;
1140 KASSERT(aclp->acl_cnt == 0, ("aclp->acl_cnt == 0"));
1142 user_allow = group_allow = everyone_allow = ACL_READ_ACL |
1143 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS | ACL_SYNCHRONIZE;
1144 user_allow |= ACL_WRITE_ACL | ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
1145 ACL_WRITE_NAMED_ATTRS;
1148 user_allow |= ACL_READ_DATA;
1150 user_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1152 user_allow |= ACL_EXECUTE;
1155 group_allow |= ACL_READ_DATA;
1157 group_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1159 group_allow |= ACL_EXECUTE;
1162 everyone_allow |= ACL_READ_DATA;
1164 everyone_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1166 everyone_allow |= ACL_EXECUTE;
1168 user_deny = ((group_allow | everyone_allow) & ~user_allow);
1169 group_deny = everyone_allow & ~group_allow;
1170 user_allow_first = group_deny & ~user_deny;
1172 if (user_allow_first != 0)
1173 _acl_append(aclp, ACL_USER_OBJ, user_allow_first,
1174 ACL_ENTRY_TYPE_ALLOW);
1176 _acl_append(aclp, ACL_USER_OBJ, user_deny,
1177 ACL_ENTRY_TYPE_DENY);
1178 if (group_deny != 0)
1179 _acl_append(aclp, ACL_GROUP_OBJ, group_deny,
1180 ACL_ENTRY_TYPE_DENY);
1182 if (parent_aclp != NULL)
1183 acl_nfs4_inherit_entries(parent_aclp, aclp, mode,
1184 file_owner_id, is_directory);
1186 _acl_append(aclp, ACL_USER_OBJ, user_allow, ACL_ENTRY_TYPE_ALLOW);
1187 _acl_append(aclp, ACL_GROUP_OBJ, group_allow, ACL_ENTRY_TYPE_ALLOW);
1188 _acl_append(aclp, ACL_EVERYONE, everyone_allow, ACL_ENTRY_TYPE_ALLOW);
1193 acl_nfs4_compute_inherited_acl(const struct acl *parent_aclp,
1194 struct acl *child_aclp, mode_t mode, int file_owner_id,
1198 if (acl_nfs4_old_semantics)
1199 acl_nfs4_compute_inherited_acl_draft(parent_aclp, child_aclp,
1200 mode, file_owner_id, is_directory);
1202 acl_nfs4_compute_inherited_acl_psarc(parent_aclp, child_aclp,
1203 mode, file_owner_id, is_directory);
1205 #endif /* _KERNEL */
1208 * Calculate trivial ACL in a manner compatible with PSARC/2010/029.
1209 * Note that this results in an ACL different from (but semantically
1210 * equal to) the "canonical six" trivial ACL computed using algorithm
1211 * described in draft-ietf-nfsv4-minorversion1-03.txt, 3.16.6.2.
1214 acl_nfs4_trivial_from_mode(struct acl *aclp, mode_t mode)
1218 acl_nfs4_compute_inherited_acl_psarc(NULL, aclp, mode, -1, -1);
1223 * This routine is used by libc to implement acl_strip_np(3)
1224 * and acl_is_trivial_np(3).
1227 acl_nfs4_trivial_from_mode_libc(struct acl *aclp, int mode, int canonical_six)
1232 acl_nfs4_sync_acl_from_mode_draft(aclp, mode, -1);
1234 acl_nfs4_trivial_from_mode(aclp, mode);
1236 #endif /* !_KERNEL */
1240 _acls_are_equal(const struct acl *a, const struct acl *b)
1243 const struct acl_entry *entrya, *entryb;
1245 if (a->acl_cnt != b->acl_cnt)
1248 for (i = 0; i < b->acl_cnt; i++) {
1249 entrya = &(a->acl_entry[i]);
1250 entryb = &(b->acl_entry[i]);
1252 if (entrya->ae_tag != entryb->ae_tag ||
1253 entrya->ae_id != entryb->ae_id ||
1254 entrya->ae_perm != entryb->ae_perm ||
1255 entrya->ae_entry_type != entryb->ae_entry_type ||
1256 entrya->ae_flags != entryb->ae_flags)
1264 * This routine is used to determine whether to remove extended attribute
1265 * that stores ACL contents.
1268 acl_nfs4_is_trivial(const struct acl *aclp, int file_owner_id)
1272 struct acl *tmpaclp;
1274 if (aclp->acl_cnt > 6)
1278 * Compute the mode from the ACL, then compute new ACL from that mode.
1279 * If the ACLs are identical, then the ACL is trivial.
1281 * XXX: I guess there is a faster way to do this. However, even
1282 * this slow implementation significantly speeds things up
1283 * for files that don't have non-trivial ACLs - it's critical
1284 * for performance to not use EA when they are not needed.
1286 * First try the PSARC/2010/029 semantics.
1288 tmpaclp = acl_alloc(M_WAITOK | M_ZERO);
1289 acl_nfs4_sync_mode_from_acl(&tmpmode, aclp);
1290 acl_nfs4_trivial_from_mode(tmpaclp, tmpmode);
1291 trivial = _acls_are_equal(aclp, tmpaclp);
1298 * Check if it's a draft-ietf-nfsv4-minorversion1-03.txt trivial ACL.
1300 tmpaclp->acl_cnt = 0;
1301 acl_nfs4_sync_acl_from_mode_draft(tmpaclp, tmpmode, file_owner_id);
1302 trivial = _acls_are_equal(aclp, tmpaclp);
1307 #endif /* _KERNEL */
1310 acl_nfs4_check(const struct acl *aclp, int is_directory)
1313 const struct acl_entry *entry;
1316 * The spec doesn't seem to say anything about ACL validity.
1317 * It seems there is not much to do here. There is even no need
1318 * to count "owner@" or "everyone@" (ACL_USER_OBJ and ACL_EVERYONE)
1319 * entries, as there can be several of them and that's perfectly
1320 * valid. There can be none of them too. Really.
1323 if (aclp->acl_cnt > ACL_MAX_ENTRIES || aclp->acl_cnt <= 0)
1326 for (i = 0; i < aclp->acl_cnt; i++) {
1327 entry = &(aclp->acl_entry[i]);
1329 switch (entry->ae_tag) {
1333 if (entry->ae_id != ACL_UNDEFINED_ID)
1339 if (entry->ae_id == ACL_UNDEFINED_ID)
1347 if ((entry->ae_perm | ACL_NFS4_PERM_BITS) != ACL_NFS4_PERM_BITS)
1351 * Disallow ACL_ENTRY_TYPE_AUDIT and ACL_ENTRY_TYPE_ALARM for now.
1353 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
1354 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
1357 if ((entry->ae_flags | ACL_FLAGS_BITS) != ACL_FLAGS_BITS)
1360 /* Disallow unimplemented flags. */
1361 if (entry->ae_flags & (ACL_ENTRY_SUCCESSFUL_ACCESS |
1362 ACL_ENTRY_FAILED_ACCESS))
1365 /* Disallow flags not allowed for ordinary files. */
1366 if (!is_directory) {
1367 if (entry->ae_flags & (ACL_ENTRY_FILE_INHERIT |
1368 ACL_ENTRY_DIRECTORY_INHERIT |
1369 ACL_ENTRY_NO_PROPAGATE_INHERIT | ACL_ENTRY_INHERIT_ONLY))
1379 acl_nfs4_modload(module_t module, int what, void *arg)
1407 static moduledata_t acl_nfs4_mod = {
1414 * XXX TODO: which subsystem, order?
1416 DECLARE_MODULE(acl_nfs4, acl_nfs4_mod, SI_SUB_VFS, SI_ORDER_FIRST);
1417 MODULE_VERSION(acl_nfs4, 1);
1418 #endif /* _KERNEL */