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/systm.h>
39 #include <sys/mount.h>
41 #include <sys/vnode.h>
42 #include <sys/errno.h>
44 #include <sys/sysctl.h>
51 #define KASSERT(a, b) assert(a)
58 static void acl_nfs4_trivial_from_mode(struct acl *aclp, mode_t mode);
60 static int acl_nfs4_old_semantics = 0;
62 SYSCTL_INT(_vfs, OID_AUTO, acl_nfs4_old_semantics, CTLFLAG_RW,
63 &acl_nfs4_old_semantics, 0, "Use pre-PSARC/2010/029 NFSv4 ACL semantics");
68 } accmode2mask[] = {{VREAD, ACL_READ_DATA},
69 {VWRITE, ACL_WRITE_DATA},
70 {VAPPEND, ACL_APPEND_DATA},
72 {VREAD_NAMED_ATTRS, ACL_READ_NAMED_ATTRS},
73 {VWRITE_NAMED_ATTRS, ACL_WRITE_NAMED_ATTRS},
74 {VDELETE_CHILD, ACL_DELETE_CHILD},
75 {VREAD_ATTRIBUTES, ACL_READ_ATTRIBUTES},
76 {VWRITE_ATTRIBUTES, ACL_WRITE_ATTRIBUTES},
77 {VDELETE, ACL_DELETE},
78 {VREAD_ACL, ACL_READ_ACL},
79 {VWRITE_ACL, ACL_WRITE_ACL},
80 {VWRITE_OWNER, ACL_WRITE_OWNER},
81 {VSYNCHRONIZE, ACL_SYNCHRONIZE},
85 _access_mask_from_accmode(accmode_t accmode)
87 int access_mask = 0, i;
89 for (i = 0; accmode2mask[i].accmode != 0; i++) {
90 if (accmode & accmode2mask[i].accmode)
91 access_mask |= accmode2mask[i].mask;
95 * VAPPEND is just a modifier for VWRITE; if the caller asked
96 * for 'VAPPEND | VWRITE', we want to check for ACL_APPEND_DATA only.
98 if (access_mask & ACL_APPEND_DATA)
99 access_mask &= ~ACL_WRITE_DATA;
101 return (access_mask);
105 * Return 0, iff access is allowed, 1 otherwise.
108 _acl_denies(const struct acl *aclp, int access_mask, struct ucred *cred,
109 int file_uid, int file_gid, int *denied_explicitly)
112 const struct acl_entry *entry;
114 if (denied_explicitly != NULL)
115 *denied_explicitly = 0;
117 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
118 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
120 for (i = 0; i < aclp->acl_cnt; i++) {
121 entry = &(aclp->acl_entry[i]);
123 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
124 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
126 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
128 switch (entry->ae_tag) {
130 if (file_uid != cred->cr_uid)
134 if (entry->ae_id != cred->cr_uid)
138 if (!groupmember(file_gid, cred))
142 if (!groupmember(entry->ae_id, cred))
146 KASSERT(entry->ae_tag == ACL_EVERYONE,
147 ("entry->ae_tag == ACL_EVERYONE"));
150 if (entry->ae_entry_type == ACL_ENTRY_TYPE_DENY) {
151 if (entry->ae_perm & access_mask) {
152 if (denied_explicitly != NULL)
153 *denied_explicitly = 1;
158 access_mask &= ~(entry->ae_perm);
159 if (access_mask == 0)
163 if (access_mask == 0)
170 vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid,
171 struct acl *aclp, accmode_t accmode, struct ucred *cred, int *privused)
173 accmode_t priv_granted = 0;
174 int denied, explicitly_denied, access_mask, is_directory,
176 mode_t file_mode = 0;
178 KASSERT((accmode & ~(VEXEC | VWRITE | VREAD | VADMIN | VAPPEND |
179 VEXPLICIT_DENY | VREAD_NAMED_ATTRS | VWRITE_NAMED_ATTRS |
180 VDELETE_CHILD | VREAD_ATTRIBUTES | VWRITE_ATTRIBUTES | VDELETE |
181 VREAD_ACL | VWRITE_ACL | VWRITE_OWNER | VSYNCHRONIZE)) == 0,
182 ("invalid bit in accmode"));
183 KASSERT((accmode & VAPPEND) == 0 || (accmode & VWRITE),
184 ("VAPPEND without VWRITE"));
186 if (privused != NULL)
189 if (accmode & VADMIN)
193 * Ignore VSYNCHRONIZE permission.
195 accmode &= ~VSYNCHRONIZE;
197 access_mask = _access_mask_from_accmode(accmode);
205 * File owner is always allowed to read and write the ACL
206 * and basic attributes. This is to prevent a situation
207 * where user would change ACL in a way that prevents him
208 * from undoing the change.
210 if (file_uid == cred->cr_uid)
211 access_mask &= ~(ACL_READ_ACL | ACL_WRITE_ACL |
212 ACL_READ_ATTRIBUTES | ACL_WRITE_ATTRIBUTES);
215 * Ignore append permission for regular files; use write
216 * permission instead.
218 if (!is_directory && (access_mask & ACL_APPEND_DATA)) {
219 access_mask &= ~ACL_APPEND_DATA;
220 access_mask |= ACL_WRITE_DATA;
223 denied = _acl_denies(aclp, access_mask, cred, file_uid, file_gid,
227 if (file_uid != cred->cr_uid)
232 * For VEXEC, ensure that at least one execute bit is set for
233 * non-directories. We have to check the mode here to stay
234 * consistent with execve(2). See the test in
235 * exec_check_permissions().
237 acl_nfs4_sync_mode_from_acl(&file_mode, aclp);
238 if (!denied && !is_directory && (accmode & VEXEC) &&
239 (file_mode & (S_IXUSR | S_IXGRP | S_IXOTH)) == 0)
246 * Access failed. Iff it was not denied explicitly and
247 * VEXPLICIT_DENY flag was specified, allow access.
249 if ((accmode & VEXPLICIT_DENY) && explicitly_denied == 0)
252 accmode &= ~VEXPLICIT_DENY;
255 * No match. Try to use privileges, if there are any.
258 if ((accmode & VEXEC) && !priv_check_cred(cred,
260 priv_granted |= VEXEC;
263 * Ensure that at least one execute bit is on. Otherwise,
264 * a privileged user will always succeed, and we don't want
265 * this to happen unless the file really is executable.
267 if ((accmode & VEXEC) && (file_mode &
268 (S_IXUSR | S_IXGRP | S_IXOTH)) != 0 &&
269 !priv_check_cred(cred, PRIV_VFS_EXEC, 0))
270 priv_granted |= VEXEC;
273 if ((accmode & VREAD) && !priv_check_cred(cred, PRIV_VFS_READ, 0))
274 priv_granted |= VREAD;
276 if ((accmode & (VWRITE | VAPPEND | VDELETE_CHILD)) &&
277 !priv_check_cred(cred, PRIV_VFS_WRITE, 0))
278 priv_granted |= (VWRITE | VAPPEND | VDELETE_CHILD);
280 if ((accmode & VADMIN_PERMS) &&
281 !priv_check_cred(cred, PRIV_VFS_ADMIN, 0))
282 priv_granted |= VADMIN_PERMS;
284 if ((accmode & VSTAT_PERMS) &&
285 !priv_check_cred(cred, PRIV_VFS_STAT, 0))
286 priv_granted |= VSTAT_PERMS;
288 if ((accmode & priv_granted) == accmode) {
289 if (privused != NULL)
295 if (accmode & (VADMIN_PERMS | VDELETE_CHILD | VDELETE))
305 _acl_entry_matches(struct acl_entry *entry, acl_tag_t tag, acl_perm_t perm,
306 acl_entry_type_t entry_type)
308 if (entry->ae_tag != tag)
311 if (entry->ae_id != ACL_UNDEFINED_ID)
314 if (entry->ae_perm != perm)
317 if (entry->ae_entry_type != entry_type)
320 if (entry->ae_flags != 0)
326 static struct acl_entry *
327 _acl_append(struct acl *aclp, acl_tag_t tag, acl_perm_t perm,
328 acl_entry_type_t entry_type)
330 struct acl_entry *entry;
332 KASSERT(aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
333 ("aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
335 entry = &(aclp->acl_entry[aclp->acl_cnt]);
339 entry->ae_id = ACL_UNDEFINED_ID;
340 entry->ae_perm = perm;
341 entry->ae_entry_type = entry_type;
347 static struct acl_entry *
348 _acl_duplicate_entry(struct acl *aclp, int entry_index)
352 KASSERT(aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
353 ("aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
355 for (i = aclp->acl_cnt; i > entry_index; i--)
356 aclp->acl_entry[i] = aclp->acl_entry[i - 1];
360 return (&(aclp->acl_entry[entry_index + 1]));
364 acl_nfs4_sync_acl_from_mode_draft(struct acl *aclp, mode_t mode,
367 int i, meets, must_append;
368 struct acl_entry *entry, *copy, *previous,
369 *a1, *a2, *a3, *a4, *a5, *a6;
372 const int WRITE = 02;
375 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
376 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
379 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
381 * 3.16.6.3. Applying a Mode to an Existing ACL
387 for (i = 0; i < aclp->acl_cnt; i++) {
388 entry = &(aclp->acl_entry[i]);
391 * 1.1. If the type is neither ALLOW or DENY - skip.
393 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
394 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
398 * 1.2. If ACL_ENTRY_INHERIT_ONLY is set - skip.
400 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
404 * 1.3. If ACL_ENTRY_FILE_INHERIT or ACL_ENTRY_DIRECTORY_INHERIT
407 if (entry->ae_flags &
408 (ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT)) {
410 * 1.3.1. A copy of the current ACE is made, and placed
411 * in the ACL immediately following the current
414 copy = _acl_duplicate_entry(aclp, i);
417 * 1.3.2. In the first ACE, the flag
418 * ACL_ENTRY_INHERIT_ONLY is set.
420 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
423 * 1.3.3. In the second ACE, the following flags
425 * ACL_ENTRY_FILE_INHERIT,
426 * ACL_ENTRY_DIRECTORY_INHERIT,
427 * ACL_ENTRY_NO_PROPAGATE_INHERIT.
429 copy->ae_flags &= ~(ACL_ENTRY_FILE_INHERIT |
430 ACL_ENTRY_DIRECTORY_INHERIT |
431 ACL_ENTRY_NO_PROPAGATE_INHERIT);
434 * The algorithm continues on with the second ACE.
441 * 1.4. If it's owner@, group@ or everyone@ entry, clear
442 * ACL_READ_DATA, ACL_WRITE_DATA, ACL_APPEND_DATA
443 * and ACL_EXECUTE. Continue to the next entry.
445 if (entry->ae_tag == ACL_USER_OBJ ||
446 entry->ae_tag == ACL_GROUP_OBJ ||
447 entry->ae_tag == ACL_EVERYONE) {
448 entry->ae_perm &= ~(ACL_READ_DATA | ACL_WRITE_DATA |
449 ACL_APPEND_DATA | ACL_EXECUTE);
454 * 1.5. Otherwise, if the "who" field did not match one
455 * of OWNER@, GROUP@, EVERYONE@:
457 * 1.5.1. If the type is ALLOW, check the preceding ACE.
458 * If it does not meet all of the following criteria:
460 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW)
466 previous = &(aclp->acl_entry[i - 1]);
469 * 1.5.1.1. The type field is DENY,
471 if (previous->ae_entry_type != ACL_ENTRY_TYPE_DENY)
475 * 1.5.1.2. The "who" field is the same as the current
478 * 1.5.1.3. The flag bit ACE4_IDENTIFIER_GROUP
479 * is the same as it is in the current ACE,
480 * and no other flag bits are set,
482 if (previous->ae_id != entry->ae_id ||
483 previous->ae_tag != entry->ae_tag)
486 if (previous->ae_flags)
490 * 1.5.1.4. The mask bits are a subset of the mask bits
491 * of the current ACE, and are also subset of
492 * the following: ACL_READ_DATA,
493 * ACL_WRITE_DATA, ACL_APPEND_DATA, ACL_EXECUTE
495 if (previous->ae_perm & ~(entry->ae_perm))
498 if (previous->ae_perm & ~(ACL_READ_DATA |
499 ACL_WRITE_DATA | ACL_APPEND_DATA | ACL_EXECUTE))
505 * Then the ACE of type DENY, with a who equal
506 * to the current ACE, flag bits equal to
507 * (<current ACE flags> & <ACE_IDENTIFIER_GROUP>)
508 * and no mask bits, is prepended.
511 entry = _acl_duplicate_entry(aclp, i);
513 /* Adjust counter, as we've just added an entry. */
516 previous->ae_tag = entry->ae_tag;
517 previous->ae_id = entry->ae_id;
518 previous->ae_flags = entry->ae_flags;
519 previous->ae_perm = 0;
520 previous->ae_entry_type = ACL_ENTRY_TYPE_DENY;
524 * 1.5.2. The following modifications are made to the prepended
525 * ACE. The intent is to mask the following ACE
526 * to disallow ACL_READ_DATA, ACL_WRITE_DATA,
527 * ACL_APPEND_DATA, or ACL_EXECUTE, based upon the group
528 * permissions of the new mode. As a special case,
529 * if the ACE matches the current owner of the file,
530 * the owner bits are used, rather than the group bits.
531 * This is reflected in the algorithm below.
536 * If ACE4_IDENTIFIER_GROUP is not set, and the "who" field
537 * in ACE matches the owner of the file, we shift amode three
538 * more bits, in order to have the owner permission bits
539 * placed in the three low order bits of amode.
541 if (entry->ae_tag == ACL_USER && entry->ae_id == file_owner_id)
544 if (entry->ae_perm & ACL_READ_DATA) {
546 previous->ae_perm &= ~ACL_READ_DATA;
548 previous->ae_perm |= ACL_READ_DATA;
551 if (entry->ae_perm & ACL_WRITE_DATA) {
553 previous->ae_perm &= ~ACL_WRITE_DATA;
555 previous->ae_perm |= ACL_WRITE_DATA;
558 if (entry->ae_perm & ACL_APPEND_DATA) {
560 previous->ae_perm &= ~ACL_APPEND_DATA;
562 previous->ae_perm |= ACL_APPEND_DATA;
565 if (entry->ae_perm & ACL_EXECUTE) {
567 previous->ae_perm &= ~ACL_EXECUTE;
569 previous->ae_perm |= ACL_EXECUTE;
573 * 1.5.3. If ACE4_IDENTIFIER_GROUP is set in the flags
576 * XXX: This point is not there in the Falkner's draft.
578 if (entry->ae_tag == ACL_GROUP &&
579 entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW) {
580 mode_t extramode, ownermode;
581 extramode = (mode >> 3) & 07;
582 ownermode = mode >> 6;
583 extramode &= ~ownermode;
586 if (extramode & READ) {
587 entry->ae_perm &= ~ACL_READ_DATA;
588 previous->ae_perm &= ~ACL_READ_DATA;
591 if (extramode & WRITE) {
593 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
595 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
598 if (extramode & EXEC) {
599 entry->ae_perm &= ~ACL_EXECUTE;
600 previous->ae_perm &= ~ACL_EXECUTE;
607 * 2. If there at least six ACEs, the final six ACEs are examined.
608 * If they are not equal to what we want, append six ACEs.
611 if (aclp->acl_cnt < 6) {
614 a6 = &(aclp->acl_entry[aclp->acl_cnt - 1]);
615 a5 = &(aclp->acl_entry[aclp->acl_cnt - 2]);
616 a4 = &(aclp->acl_entry[aclp->acl_cnt - 3]);
617 a3 = &(aclp->acl_entry[aclp->acl_cnt - 4]);
618 a2 = &(aclp->acl_entry[aclp->acl_cnt - 5]);
619 a1 = &(aclp->acl_entry[aclp->acl_cnt - 6]);
621 if (!_acl_entry_matches(a1, ACL_USER_OBJ, 0,
622 ACL_ENTRY_TYPE_DENY))
624 if (!_acl_entry_matches(a2, ACL_USER_OBJ, ACL_WRITE_ACL |
625 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
626 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_ALLOW))
628 if (!_acl_entry_matches(a3, ACL_GROUP_OBJ, 0,
629 ACL_ENTRY_TYPE_DENY))
631 if (!_acl_entry_matches(a4, ACL_GROUP_OBJ, 0,
632 ACL_ENTRY_TYPE_ALLOW))
634 if (!_acl_entry_matches(a5, ACL_EVERYONE, ACL_WRITE_ACL |
635 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
636 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_DENY))
638 if (!_acl_entry_matches(a6, ACL_EVERYONE, ACL_READ_ACL |
639 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS |
640 ACL_SYNCHRONIZE, ACL_ENTRY_TYPE_ALLOW))
645 KASSERT(aclp->acl_cnt + 6 <= ACL_MAX_ENTRIES,
646 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
648 a1 = _acl_append(aclp, ACL_USER_OBJ, 0, ACL_ENTRY_TYPE_DENY);
649 a2 = _acl_append(aclp, ACL_USER_OBJ, ACL_WRITE_ACL |
650 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
651 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_ALLOW);
652 a3 = _acl_append(aclp, ACL_GROUP_OBJ, 0, ACL_ENTRY_TYPE_DENY);
653 a4 = _acl_append(aclp, ACL_GROUP_OBJ, 0, ACL_ENTRY_TYPE_ALLOW);
654 a5 = _acl_append(aclp, ACL_EVERYONE, ACL_WRITE_ACL |
655 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
656 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_DENY);
657 a6 = _acl_append(aclp, ACL_EVERYONE, ACL_READ_ACL |
658 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS |
659 ACL_SYNCHRONIZE, ACL_ENTRY_TYPE_ALLOW);
661 KASSERT(a1 != NULL && a2 != NULL && a3 != NULL && a4 != NULL &&
662 a5 != NULL && a6 != NULL, ("couldn't append to ACL."));
666 * 3. The final six ACEs are adjusted according to the incoming mode.
669 a2->ae_perm |= ACL_READ_DATA;
671 a1->ae_perm |= ACL_READ_DATA;
673 a2->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
675 a1->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
677 a2->ae_perm |= ACL_EXECUTE;
679 a1->ae_perm |= ACL_EXECUTE;
682 a4->ae_perm |= ACL_READ_DATA;
684 a3->ae_perm |= ACL_READ_DATA;
686 a4->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
688 a3->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
690 a4->ae_perm |= ACL_EXECUTE;
692 a3->ae_perm |= ACL_EXECUTE;
695 a6->ae_perm |= ACL_READ_DATA;
697 a5->ae_perm |= ACL_READ_DATA;
699 a6->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
701 a5->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
703 a6->ae_perm |= ACL_EXECUTE;
705 a5->ae_perm |= ACL_EXECUTE;
710 acl_nfs4_sync_acl_from_mode(struct acl *aclp, mode_t mode,
714 if (acl_nfs4_old_semantics)
715 acl_nfs4_sync_acl_from_mode_draft(aclp, mode, file_owner_id);
717 acl_nfs4_trivial_from_mode(aclp, mode);
722 acl_nfs4_sync_mode_from_acl(mode_t *_mode, const struct acl *aclp)
725 mode_t old_mode = *_mode, mode = 0, seen = 0;
726 const struct acl_entry *entry;
728 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
729 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
732 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
734 * 3.16.6.1. Recomputing mode upon SETATTR of ACL
737 for (i = 0; i < aclp->acl_cnt; i++) {
738 entry = &(aclp->acl_entry[i]);
740 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
741 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
744 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
747 if (entry->ae_tag == ACL_USER_OBJ) {
748 if ((entry->ae_perm & ACL_READ_DATA) &&
749 ((seen & S_IRUSR) == 0)) {
751 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
754 if ((entry->ae_perm & ACL_WRITE_DATA) &&
755 ((seen & S_IWUSR) == 0)) {
757 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
760 if ((entry->ae_perm & ACL_EXECUTE) &&
761 ((seen & S_IXUSR) == 0)) {
763 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
766 } else if (entry->ae_tag == ACL_GROUP_OBJ) {
767 if ((entry->ae_perm & ACL_READ_DATA) &&
768 ((seen & S_IRGRP) == 0)) {
770 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
773 if ((entry->ae_perm & ACL_WRITE_DATA) &&
774 ((seen & S_IWGRP) == 0)) {
776 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
779 if ((entry->ae_perm & ACL_EXECUTE) &&
780 ((seen & S_IXGRP) == 0)) {
782 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
785 } else if (entry->ae_tag == ACL_EVERYONE) {
786 if (entry->ae_perm & ACL_READ_DATA) {
787 if ((seen & S_IRUSR) == 0) {
789 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
792 if ((seen & S_IRGRP) == 0) {
794 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
797 if ((seen & S_IROTH) == 0) {
799 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
803 if (entry->ae_perm & ACL_WRITE_DATA) {
804 if ((seen & S_IWUSR) == 0) {
806 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
809 if ((seen & S_IWGRP) == 0) {
811 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
814 if ((seen & S_IWOTH) == 0) {
816 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
820 if (entry->ae_perm & ACL_EXECUTE) {
821 if ((seen & S_IXUSR) == 0) {
823 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
826 if ((seen & S_IXGRP) == 0) {
828 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
831 if ((seen & S_IXOTH) == 0) {
833 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
840 *_mode = mode | (old_mode & ACL_PRESERVE_MASK);
845 * Calculate inherited ACL in a manner compatible with NFSv4 Minor Version 1,
846 * draft-ietf-nfsv4-minorversion1-03.txt.
849 acl_nfs4_compute_inherited_acl_draft(const struct acl *parent_aclp,
850 struct acl *child_aclp, mode_t mode, int file_owner_id,
854 const struct acl_entry *parent_entry;
855 struct acl_entry *entry, *copy;
857 KASSERT(child_aclp->acl_cnt == 0, ("child_aclp->acl_cnt == 0"));
858 KASSERT(parent_aclp->acl_cnt <= ACL_MAX_ENTRIES,
859 ("parent_aclp->acl_cnt <= ACL_MAX_ENTRIES"));
862 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
864 * 3.16.6.2. Applying the mode given to CREATE or OPEN
865 * to an inherited ACL
869 * 1. Form an ACL that is the concatenation of all inheritable ACEs.
871 for (i = 0; i < parent_aclp->acl_cnt; i++) {
872 parent_entry = &(parent_aclp->acl_entry[i]);
873 flags = parent_entry->ae_flags;
876 * Entry is not inheritable at all.
878 if ((flags & (ACL_ENTRY_DIRECTORY_INHERIT |
879 ACL_ENTRY_FILE_INHERIT)) == 0)
883 * We're creating a file, but entry is not inheritable
886 if (!is_directory && (flags & ACL_ENTRY_FILE_INHERIT) == 0)
890 * Entry is inheritable only by files, but has NO_PROPAGATE
891 * flag set, and we're creating a directory, so it wouldn't
892 * propagate to any file in that directory anyway.
895 (flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0 &&
896 (flags & ACL_ENTRY_NO_PROPAGATE_INHERIT))
899 KASSERT(child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
900 ("child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
901 child_aclp->acl_entry[child_aclp->acl_cnt] = *parent_entry;
902 child_aclp->acl_cnt++;
906 * 2. For each entry in the new ACL, adjust its flags, possibly
907 * creating two entries in place of one.
909 for (i = 0; i < child_aclp->acl_cnt; i++) {
910 entry = &(child_aclp->acl_entry[i]);
913 * This is not in the specification, but SunOS
914 * apparently does that.
916 if (((entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT) ||
918 entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
919 entry->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER);
922 * 2.A. If the ACL_ENTRY_NO_PROPAGATE_INHERIT is set, or if the object
923 * being created is not a directory, then clear the
924 * following flags: ACL_ENTRY_NO_PROPAGATE_INHERIT,
925 * ACL_ENTRY_FILE_INHERIT, ACL_ENTRY_DIRECTORY_INHERIT,
926 * ACL_ENTRY_INHERIT_ONLY.
928 if (entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT ||
930 entry->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
931 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
932 ACL_ENTRY_INHERIT_ONLY);
935 * Continue on to the next ACE.
941 * 2.B. If the object is a directory and ACL_ENTRY_FILE_INHERIT
942 * is set, but ACL_ENTRY_NO_PROPAGATE_INHERIT is not set, ensure
943 * that ACL_ENTRY_INHERIT_ONLY is set. Continue to the
944 * next ACE. Otherwise...
947 * XXX: Read it again and make sure what does the "otherwise"
951 (entry->ae_flags & ACL_ENTRY_FILE_INHERIT) &&
952 ((entry->ae_flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0)) {
953 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
958 * 2.C. If the type of the ACE is neither ALLOW nor deny,
961 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
962 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
966 * 2.D. Copy the original ACE into a second, adjacent ACE.
968 copy = _acl_duplicate_entry(child_aclp, i);
971 * 2.E. On the first ACE, ensure that ACL_ENTRY_INHERIT_ONLY
974 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
977 * 2.F. On the second ACE, clear the following flags:
978 * ACL_ENTRY_NO_PROPAGATE_INHERIT, ACL_ENTRY_FILE_INHERIT,
979 * ACL_ENTRY_DIRECTORY_INHERIT, ACL_ENTRY_INHERIT_ONLY.
981 copy->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
982 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
983 ACL_ENTRY_INHERIT_ONLY);
986 * 2.G. On the second ACE, if the type is ALLOW,
987 * an implementation MAY clear the following
988 * mask bits: ACL_WRITE_ACL, ACL_WRITE_OWNER.
990 if (copy->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
991 copy->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER);
994 * Increment the counter to skip the copied entry.
1000 * 3. To ensure that the mode is honored, apply the algorithm describe
1001 * in Section 2.16.6.3, using the mode that is to be used for file
1004 acl_nfs4_sync_acl_from_mode(child_aclp, mode, file_owner_id);
1006 #endif /* _KERNEL */
1009 * Populate the ACL with entries inherited from parent_aclp.
1012 acl_nfs4_inherit_entries(const struct acl *parent_aclp,
1013 struct acl *child_aclp, mode_t mode, int file_owner_id,
1017 const struct acl_entry *parent_entry;
1018 struct acl_entry *entry;
1020 KASSERT(parent_aclp->acl_cnt <= ACL_MAX_ENTRIES,
1021 ("parent_aclp->acl_cnt <= ACL_MAX_ENTRIES"));
1023 for (i = 0; i < parent_aclp->acl_cnt; i++) {
1024 parent_entry = &(parent_aclp->acl_entry[i]);
1025 flags = parent_entry->ae_flags;
1026 tag = parent_entry->ae_tag;
1029 * Don't inherit owner@, group@, or everyone@ entries.
1031 if (tag == ACL_USER_OBJ || tag == ACL_GROUP_OBJ ||
1032 tag == ACL_EVERYONE)
1036 * Entry is not inheritable at all.
1038 if ((flags & (ACL_ENTRY_DIRECTORY_INHERIT |
1039 ACL_ENTRY_FILE_INHERIT)) == 0)
1043 * We're creating a file, but entry is not inheritable
1046 if (!is_directory && (flags & ACL_ENTRY_FILE_INHERIT) == 0)
1050 * Entry is inheritable only by files, but has NO_PROPAGATE
1051 * flag set, and we're creating a directory, so it wouldn't
1052 * propagate to any file in that directory anyway.
1055 (flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0 &&
1056 (flags & ACL_ENTRY_NO_PROPAGATE_INHERIT))
1060 * Entry qualifies for being inherited.
1062 KASSERT(child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
1063 ("child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
1064 entry = &(child_aclp->acl_entry[child_aclp->acl_cnt]);
1065 *entry = *parent_entry;
1066 child_aclp->acl_cnt++;
1068 entry->ae_flags &= ~ACL_ENTRY_INHERIT_ONLY;
1071 * If the type of the ACE is neither ALLOW nor DENY,
1072 * then leave it as it is and proceed to the next one.
1074 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
1075 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
1079 * If the ACL_ENTRY_NO_PROPAGATE_INHERIT is set, or if
1080 * the object being created is not a directory, then clear
1081 * the following flags: ACL_ENTRY_NO_PROPAGATE_INHERIT,
1082 * ACL_ENTRY_FILE_INHERIT, ACL_ENTRY_DIRECTORY_INHERIT,
1083 * ACL_ENTRY_INHERIT_ONLY.
1085 if (entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT ||
1087 entry->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
1088 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
1089 ACL_ENTRY_INHERIT_ONLY);
1093 * If the object is a directory and ACL_ENTRY_FILE_INHERIT
1094 * is set, but ACL_ENTRY_DIRECTORY_INHERIT is not set, ensure
1095 * that ACL_ENTRY_INHERIT_ONLY is set.
1098 (entry->ae_flags & ACL_ENTRY_FILE_INHERIT) &&
1099 ((entry->ae_flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0)) {
1100 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
1103 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW &&
1104 (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY) == 0) {
1106 * Some permissions must never be inherited.
1108 entry->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER |
1109 ACL_WRITE_NAMED_ATTRS | ACL_WRITE_ATTRIBUTES);
1112 * Others must be masked according to the file mode.
1114 if ((mode & S_IRGRP) == 0)
1115 entry->ae_perm &= ~ACL_READ_DATA;
1116 if ((mode & S_IWGRP) == 0)
1118 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
1119 if ((mode & S_IXGRP) == 0)
1120 entry->ae_perm &= ~ACL_EXECUTE;
1126 * Calculate inherited ACL in a manner compatible with PSARC/2010/029.
1127 * It's also being used to calculate a trivial ACL, by inheriting from
1131 acl_nfs4_compute_inherited_acl_psarc(const struct acl *parent_aclp,
1132 struct acl *aclp, mode_t mode, int file_owner_id, int is_directory)
1134 acl_perm_t user_allow_first = 0, user_deny = 0, group_deny = 0;
1135 acl_perm_t user_allow, group_allow, everyone_allow;
1137 KASSERT(aclp->acl_cnt == 0, ("aclp->acl_cnt == 0"));
1139 user_allow = group_allow = everyone_allow = ACL_READ_ACL |
1140 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS | ACL_SYNCHRONIZE;
1141 user_allow |= ACL_WRITE_ACL | ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
1142 ACL_WRITE_NAMED_ATTRS;
1145 user_allow |= ACL_READ_DATA;
1147 user_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1149 user_allow |= ACL_EXECUTE;
1152 group_allow |= ACL_READ_DATA;
1154 group_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1156 group_allow |= ACL_EXECUTE;
1159 everyone_allow |= ACL_READ_DATA;
1161 everyone_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1163 everyone_allow |= ACL_EXECUTE;
1165 user_deny = ((group_allow | everyone_allow) & ~user_allow);
1166 group_deny = everyone_allow & ~group_allow;
1167 user_allow_first = group_deny & ~user_deny;
1169 if (user_allow_first != 0)
1170 _acl_append(aclp, ACL_USER_OBJ, user_allow_first,
1171 ACL_ENTRY_TYPE_ALLOW);
1173 _acl_append(aclp, ACL_USER_OBJ, user_deny,
1174 ACL_ENTRY_TYPE_DENY);
1175 if (group_deny != 0)
1176 _acl_append(aclp, ACL_GROUP_OBJ, group_deny,
1177 ACL_ENTRY_TYPE_DENY);
1179 if (parent_aclp != NULL)
1180 acl_nfs4_inherit_entries(parent_aclp, aclp, mode,
1181 file_owner_id, is_directory);
1183 _acl_append(aclp, ACL_USER_OBJ, user_allow, ACL_ENTRY_TYPE_ALLOW);
1184 _acl_append(aclp, ACL_GROUP_OBJ, group_allow, ACL_ENTRY_TYPE_ALLOW);
1185 _acl_append(aclp, ACL_EVERYONE, everyone_allow, ACL_ENTRY_TYPE_ALLOW);
1190 acl_nfs4_compute_inherited_acl(const struct acl *parent_aclp,
1191 struct acl *child_aclp, mode_t mode, int file_owner_id,
1195 if (acl_nfs4_old_semantics)
1196 acl_nfs4_compute_inherited_acl_draft(parent_aclp, child_aclp,
1197 mode, file_owner_id, is_directory);
1199 acl_nfs4_compute_inherited_acl_psarc(parent_aclp, child_aclp,
1200 mode, file_owner_id, is_directory);
1202 #endif /* _KERNEL */
1205 * Calculate trivial ACL in a manner compatible with PSARC/2010/029.
1206 * Note that this results in an ACL different from (but semantically
1207 * equal to) the "canonical six" trivial ACL computed using algorithm
1208 * described in draft-ietf-nfsv4-minorversion1-03.txt, 3.16.6.2.
1211 acl_nfs4_trivial_from_mode(struct acl *aclp, mode_t mode)
1215 acl_nfs4_compute_inherited_acl_psarc(NULL, aclp, mode, -1, -1);
1220 * This routine is used by libc to implement acl_strip_np(3)
1221 * and acl_is_trivial_np(3).
1224 acl_nfs4_trivial_from_mode_libc(struct acl *aclp, int mode, int canonical_six)
1229 acl_nfs4_sync_acl_from_mode_draft(aclp, mode, -1);
1231 acl_nfs4_trivial_from_mode(aclp, mode);
1233 #endif /* !_KERNEL */
1237 _acls_are_equal(const struct acl *a, const struct acl *b)
1240 const struct acl_entry *entrya, *entryb;
1242 if (a->acl_cnt != b->acl_cnt)
1245 for (i = 0; i < b->acl_cnt; i++) {
1246 entrya = &(a->acl_entry[i]);
1247 entryb = &(b->acl_entry[i]);
1249 if (entrya->ae_tag != entryb->ae_tag ||
1250 entrya->ae_id != entryb->ae_id ||
1251 entrya->ae_perm != entryb->ae_perm ||
1252 entrya->ae_entry_type != entryb->ae_entry_type ||
1253 entrya->ae_flags != entryb->ae_flags)
1261 * This routine is used to determine whether to remove extended attribute
1262 * that stores ACL contents.
1265 acl_nfs4_is_trivial(const struct acl *aclp, int file_owner_id)
1269 struct acl *tmpaclp;
1271 if (aclp->acl_cnt > 6)
1275 * Compute the mode from the ACL, then compute new ACL from that mode.
1276 * If the ACLs are identical, then the ACL is trivial.
1278 * XXX: I guess there is a faster way to do this. However, even
1279 * this slow implementation significantly speeds things up
1280 * for files that don't have non-trivial ACLs - it's critical
1281 * for performance to not use EA when they are not needed.
1283 * First try the PSARC/2010/029 semantics.
1285 tmpaclp = acl_alloc(M_WAITOK | M_ZERO);
1286 acl_nfs4_sync_mode_from_acl(&tmpmode, aclp);
1287 acl_nfs4_trivial_from_mode(tmpaclp, tmpmode);
1288 trivial = _acls_are_equal(aclp, tmpaclp);
1295 * Check if it's a draft-ietf-nfsv4-minorversion1-03.txt trivial ACL.
1297 tmpaclp->acl_cnt = 0;
1298 acl_nfs4_sync_acl_from_mode_draft(tmpaclp, tmpmode, file_owner_id);
1299 trivial = _acls_are_equal(aclp, tmpaclp);
1304 #endif /* _KERNEL */
1307 acl_nfs4_check(const struct acl *aclp, int is_directory)
1310 const struct acl_entry *entry;
1313 * The spec doesn't seem to say anything about ACL validity.
1314 * It seems there is not much to do here. There is even no need
1315 * to count "owner@" or "everyone@" (ACL_USER_OBJ and ACL_EVERYONE)
1316 * entries, as there can be several of them and that's perfectly
1317 * valid. There can be none of them too. Really.
1320 if (aclp->acl_cnt > ACL_MAX_ENTRIES || aclp->acl_cnt <= 0)
1323 for (i = 0; i < aclp->acl_cnt; i++) {
1324 entry = &(aclp->acl_entry[i]);
1326 switch (entry->ae_tag) {
1330 if (entry->ae_id != ACL_UNDEFINED_ID)
1336 if (entry->ae_id == ACL_UNDEFINED_ID)
1344 if ((entry->ae_perm | ACL_NFS4_PERM_BITS) != ACL_NFS4_PERM_BITS)
1348 * Disallow ACL_ENTRY_TYPE_AUDIT and ACL_ENTRY_TYPE_ALARM for now.
1350 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
1351 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
1354 if ((entry->ae_flags | ACL_FLAGS_BITS) != ACL_FLAGS_BITS)
1357 /* Disallow unimplemented flags. */
1358 if (entry->ae_flags & (ACL_ENTRY_SUCCESSFUL_ACCESS |
1359 ACL_ENTRY_FAILED_ACCESS))
1362 /* Disallow flags not allowed for ordinary files. */
1363 if (!is_directory) {
1364 if (entry->ae_flags & (ACL_ENTRY_FILE_INHERIT |
1365 ACL_ENTRY_DIRECTORY_INHERIT |
1366 ACL_ENTRY_NO_PROPAGATE_INHERIT | ACL_ENTRY_INHERIT_ONLY))