2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008-2010 Edward Tomasz NapieraĆa <trasz@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * ACL support routines specific to NFSv4 access control lists. These are
31 * utility routines for code common across file systems implementing NFSv4
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include <sys/param.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
42 #include <sys/systm.h>
43 #include <sys/mount.h>
45 #include <sys/vnode.h>
46 #include <sys/errno.h>
48 #include <sys/sysctl.h>
55 #define KASSERT(a, b) assert(a)
62 static void acl_nfs4_trivial_from_mode(struct acl *aclp, mode_t mode);
64 static int acl_nfs4_old_semantics = 0;
66 SYSCTL_INT(_vfs, OID_AUTO, acl_nfs4_old_semantics, CTLFLAG_RW,
67 &acl_nfs4_old_semantics, 0, "Use pre-PSARC/2010/029 NFSv4 ACL semantics");
72 } accmode2mask[] = {{VREAD, ACL_READ_DATA},
73 {VWRITE, ACL_WRITE_DATA},
74 {VAPPEND, ACL_APPEND_DATA},
76 {VREAD_NAMED_ATTRS, ACL_READ_NAMED_ATTRS},
77 {VWRITE_NAMED_ATTRS, ACL_WRITE_NAMED_ATTRS},
78 {VDELETE_CHILD, ACL_DELETE_CHILD},
79 {VREAD_ATTRIBUTES, ACL_READ_ATTRIBUTES},
80 {VWRITE_ATTRIBUTES, ACL_WRITE_ATTRIBUTES},
81 {VDELETE, ACL_DELETE},
82 {VREAD_ACL, ACL_READ_ACL},
83 {VWRITE_ACL, ACL_WRITE_ACL},
84 {VWRITE_OWNER, ACL_WRITE_OWNER},
85 {VSYNCHRONIZE, ACL_SYNCHRONIZE},
89 _access_mask_from_accmode(accmode_t accmode)
91 int access_mask = 0, i;
93 for (i = 0; accmode2mask[i].accmode != 0; i++) {
94 if (accmode & accmode2mask[i].accmode)
95 access_mask |= accmode2mask[i].mask;
99 * VAPPEND is just a modifier for VWRITE; if the caller asked
100 * for 'VAPPEND | VWRITE', we want to check for ACL_APPEND_DATA only.
102 if (access_mask & ACL_APPEND_DATA)
103 access_mask &= ~ACL_WRITE_DATA;
105 return (access_mask);
109 * Return 0, iff access is allowed, 1 otherwise.
112 _acl_denies(const struct acl *aclp, int access_mask, struct ucred *cred,
113 int file_uid, int file_gid, int *denied_explicitly)
116 const struct acl_entry *entry;
118 if (denied_explicitly != NULL)
119 *denied_explicitly = 0;
121 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
122 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
124 for (i = 0; i < aclp->acl_cnt; i++) {
125 entry = &(aclp->acl_entry[i]);
127 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
128 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
130 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
132 switch (entry->ae_tag) {
134 if (file_uid != cred->cr_uid)
138 if (entry->ae_id != cred->cr_uid)
142 if (!groupmember(file_gid, cred))
146 if (!groupmember(entry->ae_id, cred))
150 KASSERT(entry->ae_tag == ACL_EVERYONE,
151 ("entry->ae_tag == ACL_EVERYONE"));
154 if (entry->ae_entry_type == ACL_ENTRY_TYPE_DENY) {
155 if (entry->ae_perm & access_mask) {
156 if (denied_explicitly != NULL)
157 *denied_explicitly = 1;
162 access_mask &= ~(entry->ae_perm);
163 if (access_mask == 0)
167 if (access_mask == 0)
174 vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid,
175 struct acl *aclp, accmode_t accmode, struct ucred *cred)
177 accmode_t priv_granted = 0;
178 int denied, explicitly_denied, access_mask, is_directory,
180 mode_t file_mode = 0;
182 KASSERT((accmode & ~(VEXEC | VWRITE | VREAD | VADMIN | VAPPEND |
183 VEXPLICIT_DENY | VREAD_NAMED_ATTRS | VWRITE_NAMED_ATTRS |
184 VDELETE_CHILD | VREAD_ATTRIBUTES | VWRITE_ATTRIBUTES | VDELETE |
185 VREAD_ACL | VWRITE_ACL | VWRITE_OWNER | VSYNCHRONIZE)) == 0,
186 ("invalid bit in accmode"));
187 KASSERT((accmode & VAPPEND) == 0 || (accmode & VWRITE),
188 ("VAPPEND without VWRITE"));
190 if (accmode & VADMIN)
194 * Ignore VSYNCHRONIZE permission.
196 accmode &= ~VSYNCHRONIZE;
198 access_mask = _access_mask_from_accmode(accmode);
206 * File owner is always allowed to read and write the ACL
207 * and basic attributes. This is to prevent a situation
208 * where user would change ACL in a way that prevents him
209 * from undoing the change.
211 if (file_uid == cred->cr_uid)
212 access_mask &= ~(ACL_READ_ACL | ACL_WRITE_ACL |
213 ACL_READ_ATTRIBUTES | ACL_WRITE_ATTRIBUTES);
216 * Ignore append permission for regular files; use write
217 * permission instead.
219 if (!is_directory && (access_mask & ACL_APPEND_DATA)) {
220 access_mask &= ~ACL_APPEND_DATA;
221 access_mask |= ACL_WRITE_DATA;
224 denied = _acl_denies(aclp, access_mask, cred, file_uid, file_gid,
228 if (file_uid != cred->cr_uid)
233 * For VEXEC, ensure that at least one execute bit is set for
234 * non-directories. We have to check the mode here to stay
235 * consistent with execve(2). See the test in
236 * exec_check_permissions().
238 acl_nfs4_sync_mode_from_acl(&file_mode, aclp);
239 if (!denied && !is_directory && (accmode & VEXEC) &&
240 (file_mode & (S_IXUSR | S_IXGRP | S_IXOTH)) == 0)
247 * Access failed. Iff it was not denied explicitly and
248 * VEXPLICIT_DENY flag was specified, allow access.
250 if ((accmode & VEXPLICIT_DENY) && explicitly_denied == 0)
253 accmode &= ~VEXPLICIT_DENY;
256 * No match. Try to use privileges, if there are any.
259 if ((accmode & VEXEC) && !priv_check_cred(cred, PRIV_VFS_LOOKUP))
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))
270 priv_granted |= VEXEC;
273 if ((accmode & VREAD) && !priv_check_cred(cred, PRIV_VFS_READ))
274 priv_granted |= VREAD;
276 if ((accmode & (VWRITE | VAPPEND | VDELETE_CHILD)) &&
277 !priv_check_cred(cred, PRIV_VFS_WRITE))
278 priv_granted |= (VWRITE | VAPPEND | VDELETE_CHILD);
280 if ((accmode & VADMIN_PERMS) &&
281 !priv_check_cred(cred, PRIV_VFS_ADMIN))
282 priv_granted |= VADMIN_PERMS;
284 if ((accmode & VSTAT_PERMS) &&
285 !priv_check_cred(cred, PRIV_VFS_STAT))
286 priv_granted |= VSTAT_PERMS;
288 if ((accmode & priv_granted) == accmode) {
292 if (accmode & (VADMIN_PERMS | VDELETE_CHILD | VDELETE))
302 _acl_entry_matches(struct acl_entry *entry, acl_tag_t tag, acl_perm_t perm,
303 acl_entry_type_t entry_type)
305 if (entry->ae_tag != tag)
308 if (entry->ae_id != ACL_UNDEFINED_ID)
311 if (entry->ae_perm != perm)
314 if (entry->ae_entry_type != entry_type)
317 if (entry->ae_flags != 0)
323 static struct acl_entry *
324 _acl_append(struct acl *aclp, acl_tag_t tag, acl_perm_t perm,
325 acl_entry_type_t entry_type)
327 struct acl_entry *entry;
329 KASSERT(aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
330 ("aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
332 entry = &(aclp->acl_entry[aclp->acl_cnt]);
336 entry->ae_id = ACL_UNDEFINED_ID;
337 entry->ae_perm = perm;
338 entry->ae_entry_type = entry_type;
344 static struct acl_entry *
345 _acl_duplicate_entry(struct acl *aclp, int entry_index)
349 KASSERT(aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
350 ("aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
352 for (i = aclp->acl_cnt; i > entry_index; i--)
353 aclp->acl_entry[i] = aclp->acl_entry[i - 1];
357 return (&(aclp->acl_entry[entry_index + 1]));
361 acl_nfs4_sync_acl_from_mode_draft(struct acl *aclp, mode_t mode,
364 int i, meets, must_append;
365 struct acl_entry *entry, *copy, *previous,
366 *a1, *a2, *a3, *a4, *a5, *a6;
369 const int WRITE = 02;
372 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
373 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
376 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
378 * 3.16.6.3. Applying a Mode to an Existing ACL
384 for (i = 0; i < aclp->acl_cnt; i++) {
385 entry = &(aclp->acl_entry[i]);
388 * 1.1. If the type is neither ALLOW or DENY - skip.
390 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
391 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
395 * 1.2. If ACL_ENTRY_INHERIT_ONLY is set - skip.
397 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
401 * 1.3. If ACL_ENTRY_FILE_INHERIT or ACL_ENTRY_DIRECTORY_INHERIT
404 if (entry->ae_flags &
405 (ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT)) {
407 * 1.3.1. A copy of the current ACE is made, and placed
408 * in the ACL immediately following the current
411 copy = _acl_duplicate_entry(aclp, i);
414 * 1.3.2. In the first ACE, the flag
415 * ACL_ENTRY_INHERIT_ONLY is set.
417 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
420 * 1.3.3. In the second ACE, the following flags
422 * ACL_ENTRY_FILE_INHERIT,
423 * ACL_ENTRY_DIRECTORY_INHERIT,
424 * ACL_ENTRY_NO_PROPAGATE_INHERIT.
426 copy->ae_flags &= ~(ACL_ENTRY_FILE_INHERIT |
427 ACL_ENTRY_DIRECTORY_INHERIT |
428 ACL_ENTRY_NO_PROPAGATE_INHERIT);
431 * The algorithm continues on with the second ACE.
438 * 1.4. If it's owner@, group@ or everyone@ entry, clear
439 * ACL_READ_DATA, ACL_WRITE_DATA, ACL_APPEND_DATA
440 * and ACL_EXECUTE. Continue to the next entry.
442 if (entry->ae_tag == ACL_USER_OBJ ||
443 entry->ae_tag == ACL_GROUP_OBJ ||
444 entry->ae_tag == ACL_EVERYONE) {
445 entry->ae_perm &= ~(ACL_READ_DATA | ACL_WRITE_DATA |
446 ACL_APPEND_DATA | ACL_EXECUTE);
451 * 1.5. Otherwise, if the "who" field did not match one
452 * of OWNER@, GROUP@, EVERYONE@:
454 * 1.5.1. If the type is ALLOW, check the preceding ACE.
455 * If it does not meet all of the following criteria:
457 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW)
463 previous = &(aclp->acl_entry[i - 1]);
466 * 1.5.1.1. The type field is DENY,
468 if (previous->ae_entry_type != ACL_ENTRY_TYPE_DENY)
472 * 1.5.1.2. The "who" field is the same as the current
475 * 1.5.1.3. The flag bit ACE4_IDENTIFIER_GROUP
476 * is the same as it is in the current ACE,
477 * and no other flag bits are set,
479 if (previous->ae_id != entry->ae_id ||
480 previous->ae_tag != entry->ae_tag)
483 if (previous->ae_flags)
487 * 1.5.1.4. The mask bits are a subset of the mask bits
488 * of the current ACE, and are also subset of
489 * the following: ACL_READ_DATA,
490 * ACL_WRITE_DATA, ACL_APPEND_DATA, ACL_EXECUTE
492 if (previous->ae_perm & ~(entry->ae_perm))
495 if (previous->ae_perm & ~(ACL_READ_DATA |
496 ACL_WRITE_DATA | ACL_APPEND_DATA | ACL_EXECUTE))
502 * Then the ACE of type DENY, with a who equal
503 * to the current ACE, flag bits equal to
504 * (<current ACE flags> & <ACE_IDENTIFIER_GROUP>)
505 * and no mask bits, is prepended.
508 entry = _acl_duplicate_entry(aclp, i);
510 /* Adjust counter, as we've just added an entry. */
513 previous->ae_tag = entry->ae_tag;
514 previous->ae_id = entry->ae_id;
515 previous->ae_flags = entry->ae_flags;
516 previous->ae_perm = 0;
517 previous->ae_entry_type = ACL_ENTRY_TYPE_DENY;
521 * 1.5.2. The following modifications are made to the prepended
522 * ACE. The intent is to mask the following ACE
523 * to disallow ACL_READ_DATA, ACL_WRITE_DATA,
524 * ACL_APPEND_DATA, or ACL_EXECUTE, based upon the group
525 * permissions of the new mode. As a special case,
526 * if the ACE matches the current owner of the file,
527 * the owner bits are used, rather than the group bits.
528 * This is reflected in the algorithm below.
533 * If ACE4_IDENTIFIER_GROUP is not set, and the "who" field
534 * in ACE matches the owner of the file, we shift amode three
535 * more bits, in order to have the owner permission bits
536 * placed in the three low order bits of amode.
538 if (entry->ae_tag == ACL_USER && entry->ae_id == file_owner_id)
541 if (entry->ae_perm & ACL_READ_DATA) {
543 previous->ae_perm &= ~ACL_READ_DATA;
545 previous->ae_perm |= ACL_READ_DATA;
548 if (entry->ae_perm & ACL_WRITE_DATA) {
550 previous->ae_perm &= ~ACL_WRITE_DATA;
552 previous->ae_perm |= ACL_WRITE_DATA;
555 if (entry->ae_perm & ACL_APPEND_DATA) {
557 previous->ae_perm &= ~ACL_APPEND_DATA;
559 previous->ae_perm |= ACL_APPEND_DATA;
562 if (entry->ae_perm & ACL_EXECUTE) {
564 previous->ae_perm &= ~ACL_EXECUTE;
566 previous->ae_perm |= ACL_EXECUTE;
570 * 1.5.3. If ACE4_IDENTIFIER_GROUP is set in the flags
573 * XXX: This point is not there in the Falkner's draft.
575 if (entry->ae_tag == ACL_GROUP &&
576 entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW) {
577 mode_t extramode, ownermode;
578 extramode = (mode >> 3) & 07;
579 ownermode = mode >> 6;
580 extramode &= ~ownermode;
583 if (extramode & READ) {
584 entry->ae_perm &= ~ACL_READ_DATA;
585 previous->ae_perm &= ~ACL_READ_DATA;
588 if (extramode & WRITE) {
590 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
592 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
595 if (extramode & EXEC) {
596 entry->ae_perm &= ~ACL_EXECUTE;
597 previous->ae_perm &= ~ACL_EXECUTE;
604 * 2. If there at least six ACEs, the final six ACEs are examined.
605 * If they are not equal to what we want, append six ACEs.
608 if (aclp->acl_cnt < 6) {
611 a6 = &(aclp->acl_entry[aclp->acl_cnt - 1]);
612 a5 = &(aclp->acl_entry[aclp->acl_cnt - 2]);
613 a4 = &(aclp->acl_entry[aclp->acl_cnt - 3]);
614 a3 = &(aclp->acl_entry[aclp->acl_cnt - 4]);
615 a2 = &(aclp->acl_entry[aclp->acl_cnt - 5]);
616 a1 = &(aclp->acl_entry[aclp->acl_cnt - 6]);
618 if (!_acl_entry_matches(a1, ACL_USER_OBJ, 0,
619 ACL_ENTRY_TYPE_DENY))
621 if (!_acl_entry_matches(a2, ACL_USER_OBJ, ACL_WRITE_ACL |
622 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
623 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_ALLOW))
625 if (!_acl_entry_matches(a3, ACL_GROUP_OBJ, 0,
626 ACL_ENTRY_TYPE_DENY))
628 if (!_acl_entry_matches(a4, ACL_GROUP_OBJ, 0,
629 ACL_ENTRY_TYPE_ALLOW))
631 if (!_acl_entry_matches(a5, ACL_EVERYONE, ACL_WRITE_ACL |
632 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
633 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_DENY))
635 if (!_acl_entry_matches(a6, ACL_EVERYONE, ACL_READ_ACL |
636 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS |
637 ACL_SYNCHRONIZE, ACL_ENTRY_TYPE_ALLOW))
642 KASSERT(aclp->acl_cnt + 6 <= ACL_MAX_ENTRIES,
643 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
645 a1 = _acl_append(aclp, ACL_USER_OBJ, 0, ACL_ENTRY_TYPE_DENY);
646 a2 = _acl_append(aclp, ACL_USER_OBJ, ACL_WRITE_ACL |
647 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
648 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_ALLOW);
649 a3 = _acl_append(aclp, ACL_GROUP_OBJ, 0, ACL_ENTRY_TYPE_DENY);
650 a4 = _acl_append(aclp, ACL_GROUP_OBJ, 0, ACL_ENTRY_TYPE_ALLOW);
651 a5 = _acl_append(aclp, ACL_EVERYONE, ACL_WRITE_ACL |
652 ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
653 ACL_WRITE_NAMED_ATTRS, ACL_ENTRY_TYPE_DENY);
654 a6 = _acl_append(aclp, ACL_EVERYONE, ACL_READ_ACL |
655 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS |
656 ACL_SYNCHRONIZE, ACL_ENTRY_TYPE_ALLOW);
658 KASSERT(a1 != NULL && a2 != NULL && a3 != NULL && a4 != NULL &&
659 a5 != NULL && a6 != NULL, ("couldn't append to ACL."));
663 * 3. The final six ACEs are adjusted according to the incoming mode.
666 a2->ae_perm |= ACL_READ_DATA;
668 a1->ae_perm |= ACL_READ_DATA;
670 a2->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
672 a1->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
674 a2->ae_perm |= ACL_EXECUTE;
676 a1->ae_perm |= ACL_EXECUTE;
679 a4->ae_perm |= ACL_READ_DATA;
681 a3->ae_perm |= ACL_READ_DATA;
683 a4->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
685 a3->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
687 a4->ae_perm |= ACL_EXECUTE;
689 a3->ae_perm |= ACL_EXECUTE;
692 a6->ae_perm |= ACL_READ_DATA;
694 a5->ae_perm |= ACL_READ_DATA;
696 a6->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
698 a5->ae_perm |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
700 a6->ae_perm |= ACL_EXECUTE;
702 a5->ae_perm |= ACL_EXECUTE;
707 acl_nfs4_sync_acl_from_mode(struct acl *aclp, mode_t mode,
711 if (acl_nfs4_old_semantics)
712 acl_nfs4_sync_acl_from_mode_draft(aclp, mode, file_owner_id);
714 acl_nfs4_trivial_from_mode(aclp, mode);
719 acl_nfs4_sync_mode_from_acl(mode_t *_mode, const struct acl *aclp)
722 mode_t old_mode = *_mode, mode = 0, seen = 0;
723 const struct acl_entry *entry;
725 KASSERT(aclp->acl_cnt <= ACL_MAX_ENTRIES,
726 ("aclp->acl_cnt <= ACL_MAX_ENTRIES"));
729 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
731 * 3.16.6.1. Recomputing mode upon SETATTR of ACL
734 for (i = 0; i < aclp->acl_cnt; i++) {
735 entry = &(aclp->acl_entry[i]);
737 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
738 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
741 if (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY)
744 if (entry->ae_tag == ACL_USER_OBJ) {
745 if ((entry->ae_perm & ACL_READ_DATA) &&
746 ((seen & S_IRUSR) == 0)) {
748 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
751 if ((entry->ae_perm & ACL_WRITE_DATA) &&
752 ((seen & S_IWUSR) == 0)) {
754 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
757 if ((entry->ae_perm & ACL_EXECUTE) &&
758 ((seen & S_IXUSR) == 0)) {
760 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
763 } else if (entry->ae_tag == ACL_GROUP_OBJ) {
764 if ((entry->ae_perm & ACL_READ_DATA) &&
765 ((seen & S_IRGRP) == 0)) {
767 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
770 if ((entry->ae_perm & ACL_WRITE_DATA) &&
771 ((seen & S_IWGRP) == 0)) {
773 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
776 if ((entry->ae_perm & ACL_EXECUTE) &&
777 ((seen & S_IXGRP) == 0)) {
779 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
782 } else if (entry->ae_tag == ACL_EVERYONE) {
783 if (entry->ae_perm & ACL_READ_DATA) {
784 if ((seen & S_IRUSR) == 0) {
786 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
789 if ((seen & S_IRGRP) == 0) {
791 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
794 if ((seen & S_IROTH) == 0) {
796 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
800 if (entry->ae_perm & ACL_WRITE_DATA) {
801 if ((seen & S_IWUSR) == 0) {
803 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
806 if ((seen & S_IWGRP) == 0) {
808 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
811 if ((seen & S_IWOTH) == 0) {
813 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
817 if (entry->ae_perm & ACL_EXECUTE) {
818 if ((seen & S_IXUSR) == 0) {
820 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
823 if ((seen & S_IXGRP) == 0) {
825 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
828 if ((seen & S_IXOTH) == 0) {
830 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
837 *_mode = mode | (old_mode & ACL_PRESERVE_MASK);
842 * Calculate inherited ACL in a manner compatible with NFSv4 Minor Version 1,
843 * draft-ietf-nfsv4-minorversion1-03.txt.
846 acl_nfs4_compute_inherited_acl_draft(const struct acl *parent_aclp,
847 struct acl *child_aclp, mode_t mode, int file_owner_id,
851 const struct acl_entry *parent_entry;
852 struct acl_entry *entry, *copy;
854 KASSERT(child_aclp->acl_cnt == 0, ("child_aclp->acl_cnt == 0"));
855 KASSERT(parent_aclp->acl_cnt <= ACL_MAX_ENTRIES,
856 ("parent_aclp->acl_cnt <= ACL_MAX_ENTRIES"));
859 * NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-03.txt
861 * 3.16.6.2. Applying the mode given to CREATE or OPEN
862 * to an inherited ACL
866 * 1. Form an ACL that is the concatenation of all inheritable ACEs.
868 for (i = 0; i < parent_aclp->acl_cnt; i++) {
869 parent_entry = &(parent_aclp->acl_entry[i]);
870 flags = parent_entry->ae_flags;
873 * Entry is not inheritable at all.
875 if ((flags & (ACL_ENTRY_DIRECTORY_INHERIT |
876 ACL_ENTRY_FILE_INHERIT)) == 0)
880 * We're creating a file, but entry is not inheritable
883 if (!is_directory && (flags & ACL_ENTRY_FILE_INHERIT) == 0)
887 * Entry is inheritable only by files, but has NO_PROPAGATE
888 * flag set, and we're creating a directory, so it wouldn't
889 * propagate to any file in that directory anyway.
892 (flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0 &&
893 (flags & ACL_ENTRY_NO_PROPAGATE_INHERIT))
896 KASSERT(child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
897 ("child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
898 child_aclp->acl_entry[child_aclp->acl_cnt] = *parent_entry;
899 child_aclp->acl_cnt++;
903 * 2. For each entry in the new ACL, adjust its flags, possibly
904 * creating two entries in place of one.
906 for (i = 0; i < child_aclp->acl_cnt; i++) {
907 entry = &(child_aclp->acl_entry[i]);
910 * This is not in the specification, but SunOS
911 * apparently does that.
913 if (((entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT) ||
915 entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
916 entry->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER);
919 * 2.A. If the ACL_ENTRY_NO_PROPAGATE_INHERIT is set, or if the object
920 * being created is not a directory, then clear the
921 * following flags: ACL_ENTRY_NO_PROPAGATE_INHERIT,
922 * ACL_ENTRY_FILE_INHERIT, ACL_ENTRY_DIRECTORY_INHERIT,
923 * ACL_ENTRY_INHERIT_ONLY.
925 if (entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT ||
927 entry->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
928 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
929 ACL_ENTRY_INHERIT_ONLY);
932 * Continue on to the next ACE.
938 * 2.B. If the object is a directory and ACL_ENTRY_FILE_INHERIT
939 * is set, but ACL_ENTRY_NO_PROPAGATE_INHERIT is not set, ensure
940 * that ACL_ENTRY_INHERIT_ONLY is set. Continue to the
941 * next ACE. Otherwise...
944 * XXX: Read it again and make sure what does the "otherwise"
948 (entry->ae_flags & ACL_ENTRY_FILE_INHERIT) &&
949 ((entry->ae_flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0)) {
950 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
955 * 2.C. If the type of the ACE is neither ALLOW nor deny,
958 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
959 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
963 * 2.D. Copy the original ACE into a second, adjacent ACE.
965 copy = _acl_duplicate_entry(child_aclp, i);
968 * 2.E. On the first ACE, ensure that ACL_ENTRY_INHERIT_ONLY
971 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
974 * 2.F. On the second ACE, clear the following flags:
975 * ACL_ENTRY_NO_PROPAGATE_INHERIT, ACL_ENTRY_FILE_INHERIT,
976 * ACL_ENTRY_DIRECTORY_INHERIT, ACL_ENTRY_INHERIT_ONLY.
978 copy->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
979 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
980 ACL_ENTRY_INHERIT_ONLY);
983 * 2.G. On the second ACE, if the type is ALLOW,
984 * an implementation MAY clear the following
985 * mask bits: ACL_WRITE_ACL, ACL_WRITE_OWNER.
987 if (copy->ae_entry_type == ACL_ENTRY_TYPE_ALLOW)
988 copy->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER);
991 * Increment the counter to skip the copied entry.
997 * 3. To ensure that the mode is honored, apply the algorithm describe
998 * in Section 2.16.6.3, using the mode that is to be used for file
1001 acl_nfs4_sync_acl_from_mode(child_aclp, mode, file_owner_id);
1003 #endif /* _KERNEL */
1006 * Populate the ACL with entries inherited from parent_aclp.
1009 acl_nfs4_inherit_entries(const struct acl *parent_aclp,
1010 struct acl *child_aclp, mode_t mode, int file_owner_id,
1014 const struct acl_entry *parent_entry;
1015 struct acl_entry *entry;
1017 KASSERT(parent_aclp->acl_cnt <= ACL_MAX_ENTRIES,
1018 ("parent_aclp->acl_cnt <= ACL_MAX_ENTRIES"));
1020 for (i = 0; i < parent_aclp->acl_cnt; i++) {
1021 parent_entry = &(parent_aclp->acl_entry[i]);
1022 flags = parent_entry->ae_flags;
1023 tag = parent_entry->ae_tag;
1026 * Don't inherit owner@, group@, or everyone@ entries.
1028 if (tag == ACL_USER_OBJ || tag == ACL_GROUP_OBJ ||
1029 tag == ACL_EVERYONE)
1033 * Entry is not inheritable at all.
1035 if ((flags & (ACL_ENTRY_DIRECTORY_INHERIT |
1036 ACL_ENTRY_FILE_INHERIT)) == 0)
1040 * We're creating a file, but entry is not inheritable
1043 if (!is_directory && (flags & ACL_ENTRY_FILE_INHERIT) == 0)
1047 * Entry is inheritable only by files, but has NO_PROPAGATE
1048 * flag set, and we're creating a directory, so it wouldn't
1049 * propagate to any file in that directory anyway.
1052 (flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0 &&
1053 (flags & ACL_ENTRY_NO_PROPAGATE_INHERIT))
1057 * Entry qualifies for being inherited.
1059 KASSERT(child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES,
1060 ("child_aclp->acl_cnt + 1 <= ACL_MAX_ENTRIES"));
1061 entry = &(child_aclp->acl_entry[child_aclp->acl_cnt]);
1062 *entry = *parent_entry;
1063 child_aclp->acl_cnt++;
1065 entry->ae_flags &= ~ACL_ENTRY_INHERIT_ONLY;
1066 entry->ae_flags |= ACL_ENTRY_INHERITED;
1069 * If the type of the ACE is neither ALLOW nor DENY,
1070 * then leave it as it is and proceed to the next one.
1072 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
1073 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
1077 * If the ACL_ENTRY_NO_PROPAGATE_INHERIT is set, or if
1078 * the object being created is not a directory, then clear
1079 * the following flags: ACL_ENTRY_NO_PROPAGATE_INHERIT,
1080 * ACL_ENTRY_FILE_INHERIT, ACL_ENTRY_DIRECTORY_INHERIT,
1081 * ACL_ENTRY_INHERIT_ONLY.
1083 if (entry->ae_flags & ACL_ENTRY_NO_PROPAGATE_INHERIT ||
1085 entry->ae_flags &= ~(ACL_ENTRY_NO_PROPAGATE_INHERIT |
1086 ACL_ENTRY_FILE_INHERIT | ACL_ENTRY_DIRECTORY_INHERIT |
1087 ACL_ENTRY_INHERIT_ONLY);
1091 * If the object is a directory and ACL_ENTRY_FILE_INHERIT
1092 * is set, but ACL_ENTRY_DIRECTORY_INHERIT is not set, ensure
1093 * that ACL_ENTRY_INHERIT_ONLY is set.
1096 (entry->ae_flags & ACL_ENTRY_FILE_INHERIT) &&
1097 ((entry->ae_flags & ACL_ENTRY_DIRECTORY_INHERIT) == 0)) {
1098 entry->ae_flags |= ACL_ENTRY_INHERIT_ONLY;
1101 if (entry->ae_entry_type == ACL_ENTRY_TYPE_ALLOW &&
1102 (entry->ae_flags & ACL_ENTRY_INHERIT_ONLY) == 0) {
1104 * Some permissions must never be inherited.
1106 entry->ae_perm &= ~(ACL_WRITE_ACL | ACL_WRITE_OWNER |
1107 ACL_WRITE_NAMED_ATTRS | ACL_WRITE_ATTRIBUTES);
1110 * Others must be masked according to the file mode.
1112 if ((mode & S_IRGRP) == 0)
1113 entry->ae_perm &= ~ACL_READ_DATA;
1114 if ((mode & S_IWGRP) == 0)
1116 ~(ACL_WRITE_DATA | ACL_APPEND_DATA);
1117 if ((mode & S_IXGRP) == 0)
1118 entry->ae_perm &= ~ACL_EXECUTE;
1124 * Calculate inherited ACL in a manner compatible with PSARC/2010/029.
1125 * It's also being used to calculate a trivial ACL, by inheriting from
1129 acl_nfs4_compute_inherited_acl_psarc(const struct acl *parent_aclp,
1130 struct acl *aclp, mode_t mode, int file_owner_id, int is_directory)
1132 acl_perm_t user_allow_first = 0, user_deny = 0, group_deny = 0;
1133 acl_perm_t user_allow, group_allow, everyone_allow;
1135 KASSERT(aclp->acl_cnt == 0, ("aclp->acl_cnt == 0"));
1137 user_allow = group_allow = everyone_allow = ACL_READ_ACL |
1138 ACL_READ_ATTRIBUTES | ACL_READ_NAMED_ATTRS | ACL_SYNCHRONIZE;
1139 user_allow |= ACL_WRITE_ACL | ACL_WRITE_OWNER | ACL_WRITE_ATTRIBUTES |
1140 ACL_WRITE_NAMED_ATTRS;
1143 user_allow |= ACL_READ_DATA;
1145 user_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1147 user_allow |= ACL_EXECUTE;
1150 group_allow |= ACL_READ_DATA;
1152 group_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1154 group_allow |= ACL_EXECUTE;
1157 everyone_allow |= ACL_READ_DATA;
1159 everyone_allow |= (ACL_WRITE_DATA | ACL_APPEND_DATA);
1161 everyone_allow |= ACL_EXECUTE;
1163 user_deny = ((group_allow | everyone_allow) & ~user_allow);
1164 group_deny = everyone_allow & ~group_allow;
1165 user_allow_first = group_deny & ~user_deny;
1167 if (user_allow_first != 0)
1168 _acl_append(aclp, ACL_USER_OBJ, user_allow_first,
1169 ACL_ENTRY_TYPE_ALLOW);
1171 _acl_append(aclp, ACL_USER_OBJ, user_deny,
1172 ACL_ENTRY_TYPE_DENY);
1173 if (group_deny != 0)
1174 _acl_append(aclp, ACL_GROUP_OBJ, group_deny,
1175 ACL_ENTRY_TYPE_DENY);
1177 if (parent_aclp != NULL)
1178 acl_nfs4_inherit_entries(parent_aclp, aclp, mode,
1179 file_owner_id, is_directory);
1181 _acl_append(aclp, ACL_USER_OBJ, user_allow, ACL_ENTRY_TYPE_ALLOW);
1182 _acl_append(aclp, ACL_GROUP_OBJ, group_allow, ACL_ENTRY_TYPE_ALLOW);
1183 _acl_append(aclp, ACL_EVERYONE, everyone_allow, ACL_ENTRY_TYPE_ALLOW);
1188 acl_nfs4_compute_inherited_acl(const struct acl *parent_aclp,
1189 struct acl *child_aclp, mode_t mode, int file_owner_id,
1193 if (acl_nfs4_old_semantics)
1194 acl_nfs4_compute_inherited_acl_draft(parent_aclp, child_aclp,
1195 mode, file_owner_id, is_directory);
1197 acl_nfs4_compute_inherited_acl_psarc(parent_aclp, child_aclp,
1198 mode, file_owner_id, is_directory);
1200 #endif /* _KERNEL */
1203 * Calculate trivial ACL in a manner compatible with PSARC/2010/029.
1204 * Note that this results in an ACL different from (but semantically
1205 * equal to) the "canonical six" trivial ACL computed using algorithm
1206 * described in draft-ietf-nfsv4-minorversion1-03.txt, 3.16.6.2.
1209 acl_nfs4_trivial_from_mode(struct acl *aclp, mode_t mode)
1213 acl_nfs4_compute_inherited_acl_psarc(NULL, aclp, mode, -1, -1);
1218 * This routine is used by libc to implement acl_strip_np(3)
1219 * and acl_is_trivial_np(3).
1222 acl_nfs4_trivial_from_mode_libc(struct acl *aclp, int mode, int canonical_six)
1227 acl_nfs4_sync_acl_from_mode_draft(aclp, mode, -1);
1229 acl_nfs4_trivial_from_mode(aclp, mode);
1231 #endif /* !_KERNEL */
1235 _acls_are_equal(const struct acl *a, const struct acl *b)
1238 const struct acl_entry *entrya, *entryb;
1240 if (a->acl_cnt != b->acl_cnt)
1243 for (i = 0; i < b->acl_cnt; i++) {
1244 entrya = &(a->acl_entry[i]);
1245 entryb = &(b->acl_entry[i]);
1247 if (entrya->ae_tag != entryb->ae_tag ||
1248 entrya->ae_id != entryb->ae_id ||
1249 entrya->ae_perm != entryb->ae_perm ||
1250 entrya->ae_entry_type != entryb->ae_entry_type ||
1251 entrya->ae_flags != entryb->ae_flags)
1259 * This routine is used to determine whether to remove extended attribute
1260 * that stores ACL contents.
1263 acl_nfs4_is_trivial(const struct acl *aclp, int file_owner_id)
1267 struct acl *tmpaclp;
1269 if (aclp->acl_cnt > 6)
1273 * Compute the mode from the ACL, then compute new ACL from that mode.
1274 * If the ACLs are identical, then the ACL is trivial.
1276 * XXX: I guess there is a faster way to do this. However, even
1277 * this slow implementation significantly speeds things up
1278 * for files that don't have non-trivial ACLs - it's critical
1279 * for performance to not use EA when they are not needed.
1281 * First try the PSARC/2010/029 semantics.
1283 tmpaclp = acl_alloc(M_WAITOK | M_ZERO);
1284 acl_nfs4_sync_mode_from_acl(&tmpmode, aclp);
1285 acl_nfs4_trivial_from_mode(tmpaclp, tmpmode);
1286 trivial = _acls_are_equal(aclp, tmpaclp);
1293 * Check if it's a draft-ietf-nfsv4-minorversion1-03.txt trivial ACL.
1295 tmpaclp->acl_cnt = 0;
1296 acl_nfs4_sync_acl_from_mode_draft(tmpaclp, tmpmode, file_owner_id);
1297 trivial = _acls_are_equal(aclp, tmpaclp);
1302 #endif /* _KERNEL */
1305 acl_nfs4_check(const struct acl *aclp, int is_directory)
1308 const struct acl_entry *entry;
1311 * The spec doesn't seem to say anything about ACL validity.
1312 * It seems there is not much to do here. There is even no need
1313 * to count "owner@" or "everyone@" (ACL_USER_OBJ and ACL_EVERYONE)
1314 * entries, as there can be several of them and that's perfectly
1315 * valid. There can be none of them too. Really.
1318 if (aclp->acl_cnt > ACL_MAX_ENTRIES || aclp->acl_cnt <= 0)
1321 for (i = 0; i < aclp->acl_cnt; i++) {
1322 entry = &(aclp->acl_entry[i]);
1324 switch (entry->ae_tag) {
1328 if (entry->ae_id != ACL_UNDEFINED_ID)
1334 if (entry->ae_id == ACL_UNDEFINED_ID)
1342 if ((entry->ae_perm | ACL_NFS4_PERM_BITS) != ACL_NFS4_PERM_BITS)
1346 * Disallow ACL_ENTRY_TYPE_AUDIT and ACL_ENTRY_TYPE_ALARM for now.
1348 if (entry->ae_entry_type != ACL_ENTRY_TYPE_ALLOW &&
1349 entry->ae_entry_type != ACL_ENTRY_TYPE_DENY)
1352 if ((entry->ae_flags | ACL_FLAGS_BITS) != ACL_FLAGS_BITS)
1355 /* Disallow unimplemented flags. */
1356 if (entry->ae_flags & (ACL_ENTRY_SUCCESSFUL_ACCESS |
1357 ACL_ENTRY_FAILED_ACCESS))
1360 /* Disallow flags not allowed for ordinary files. */
1361 if (!is_directory) {
1362 if (entry->ae_flags & (ACL_ENTRY_FILE_INHERIT |
1363 ACL_ENTRY_DIRECTORY_INHERIT |
1364 ACL_ENTRY_NO_PROPAGATE_INHERIT | ACL_ENTRY_INHERIT_ONLY))
1374 acl_nfs4_modload(module_t module, int what, void *arg)
1402 static moduledata_t acl_nfs4_mod = {
1409 * XXX TODO: which subsystem, order?
1411 DECLARE_MODULE(acl_nfs4, acl_nfs4_mod, SI_SUB_VFS, SI_ORDER_FIRST);
1412 MODULE_VERSION(acl_nfs4, 1);
1413 #endif /* _KERNEL */