2 * Copyright (c) 1999-2006 Robert N. M. Watson
5 * This software was developed by Robert Watson for the TrustedBSD Project.
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
29 * Developed by the TrustedBSD Project.
31 * ACL support routines specific to POSIX.1e access control lists. These are
32 * utility routines for code common across file systems implementing POSIX.1e
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/mount.h>
43 #include <sys/vnode.h>
44 #include <sys/errno.h>
49 * Implement a version of vaccess() that understands POSIX.1e ACL semantics;
50 * the access ACL has already been prepared for evaluation by the file system
51 * and is passed via 'uid', 'gid', and 'acl'. Return 0 on success, else an
55 vaccess_acl_posix1e(enum vtype type, uid_t file_uid, gid_t file_gid,
56 struct acl *acl, accmode_t accmode, struct ucred *cred, int *privused)
58 struct acl_entry *acl_other, *acl_mask;
59 accmode_t dac_granted;
60 accmode_t priv_granted;
61 accmode_t acl_mask_granted;
64 KASSERT((accmode & ~(VEXEC | VWRITE | VREAD | VADMIN | VAPPEND)) == 0,
65 ("invalid bit in accmode"));
66 KASSERT((accmode & VAPPEND) == 0 || (accmode & VWRITE),
67 ("VAPPEND without VWRITE"));
70 * Look for a normal, non-privileged way to access the file/directory
71 * as requested. If it exists, go with that. Otherwise, attempt to
72 * use privileges granted via priv_granted. In some cases, which
73 * privileges to use may be ambiguous due to "best match", in which
74 * case fall back on first match for the time being.
80 * Determine privileges now, but don't apply until we've found a DAC
81 * entry that matches but has failed to allow access.
83 * XXXRW: Ideally, we'd determine the privileges required before
89 if ((accmode & VEXEC) && !priv_check_cred(cred,
91 priv_granted |= VEXEC;
94 * Ensure that at least one execute bit is on. Otherwise,
95 * a privileged user will always succeed, and we don't want
96 * this to happen unless the file really is executable.
98 if ((accmode & VEXEC) && (acl_posix1e_acl_to_mode(acl) &
99 (S_IXUSR | S_IXGRP | S_IXOTH)) != 0 &&
100 !priv_check_cred(cred, PRIV_VFS_EXEC, 0))
101 priv_granted |= VEXEC;
104 if ((accmode & VREAD) && !priv_check_cred(cred, PRIV_VFS_READ, 0))
105 priv_granted |= VREAD;
107 if (((accmode & VWRITE) || (accmode & VAPPEND)) &&
108 !priv_check_cred(cred, PRIV_VFS_WRITE, 0))
109 priv_granted |= (VWRITE | VAPPEND);
111 if ((accmode & VADMIN) && !priv_check_cred(cred, PRIV_VFS_ADMIN, 0))
112 priv_granted |= VADMIN;
115 * The owner matches if the effective uid associated with the
116 * credential matches that of the ACL_USER_OBJ entry. While we're
117 * doing the first scan, also cache the location of the ACL_MASK and
118 * ACL_OTHER entries, preventing some future iterations.
120 acl_mask = acl_other = NULL;
121 for (i = 0; i < acl->acl_cnt; i++) {
122 switch (acl->acl_entry[i].ae_tag) {
124 if (file_uid != cred->cr_uid)
127 dac_granted |= VADMIN;
128 if (acl->acl_entry[i].ae_perm & ACL_EXECUTE)
129 dac_granted |= VEXEC;
130 if (acl->acl_entry[i].ae_perm & ACL_READ)
131 dac_granted |= VREAD;
132 if (acl->acl_entry[i].ae_perm & ACL_WRITE)
133 dac_granted |= (VWRITE | VAPPEND);
134 if ((accmode & dac_granted) == accmode)
138 * XXXRW: Do privilege lookup here.
140 if ((accmode & (dac_granted | priv_granted)) ==
142 if (privused != NULL)
149 acl_mask = &acl->acl_entry[i];
153 acl_other = &acl->acl_entry[i];
162 * An ACL_OTHER entry should always exist in a valid access ACL. If
163 * it doesn't, then generate a serious failure. For now, this means
164 * a debugging message and EPERM, but in the future should probably
167 if (acl_other == NULL) {
169 * XXX This should never happen
171 printf("vaccess_acl_posix1e: ACL_OTHER missing\n");
176 * Checks against ACL_USER, ACL_GROUP_OBJ, and ACL_GROUP fields are
177 * masked by an ACL_MASK entry, if any. As such, first identify the
178 * ACL_MASK field, then iterate through identifying potential user
179 * matches, then group matches. If there is no ACL_MASK, assume that
180 * the mask allows all requests to succeed.
182 if (acl_mask != NULL) {
183 acl_mask_granted = 0;
184 if (acl_mask->ae_perm & ACL_EXECUTE)
185 acl_mask_granted |= VEXEC;
186 if (acl_mask->ae_perm & ACL_READ)
187 acl_mask_granted |= VREAD;
188 if (acl_mask->ae_perm & ACL_WRITE)
189 acl_mask_granted |= (VWRITE | VAPPEND);
191 acl_mask_granted = VEXEC | VREAD | VWRITE | VAPPEND;
194 * Check ACL_USER ACL entries. There will either be one or no
195 * matches; if there is one, we accept or rejected based on the
196 * match; otherwise, we continue on to groups.
198 for (i = 0; i < acl->acl_cnt; i++) {
199 switch (acl->acl_entry[i].ae_tag) {
201 if (acl->acl_entry[i].ae_id != cred->cr_uid)
204 if (acl->acl_entry[i].ae_perm & ACL_EXECUTE)
205 dac_granted |= VEXEC;
206 if (acl->acl_entry[i].ae_perm & ACL_READ)
207 dac_granted |= VREAD;
208 if (acl->acl_entry[i].ae_perm & ACL_WRITE)
209 dac_granted |= (VWRITE | VAPPEND);
210 dac_granted &= acl_mask_granted;
211 if ((accmode & dac_granted) == accmode)
214 * XXXRW: Do privilege lookup here.
216 if ((accmode & (dac_granted | priv_granted)) !=
220 if (privused != NULL)
227 * Group match is best-match, not first-match, so find a "best"
228 * match. Iterate across, testing each potential group match. Make
229 * sure we keep track of whether we found a match or not, so that we
230 * know if we should try again with any available privilege, or if we
231 * should move on to ACL_OTHER.
234 for (i = 0; i < acl->acl_cnt; i++) {
235 switch (acl->acl_entry[i].ae_tag) {
237 if (!groupmember(file_gid, cred))
240 if (acl->acl_entry[i].ae_perm & ACL_EXECUTE)
241 dac_granted |= VEXEC;
242 if (acl->acl_entry[i].ae_perm & ACL_READ)
243 dac_granted |= VREAD;
244 if (acl->acl_entry[i].ae_perm & ACL_WRITE)
245 dac_granted |= (VWRITE | VAPPEND);
246 dac_granted &= acl_mask_granted;
248 if ((accmode & dac_granted) == accmode)
255 if (!groupmember(acl->acl_entry[i].ae_id, cred))
258 if (acl->acl_entry[i].ae_perm & ACL_EXECUTE)
259 dac_granted |= VEXEC;
260 if (acl->acl_entry[i].ae_perm & ACL_READ)
261 dac_granted |= VREAD;
262 if (acl->acl_entry[i].ae_perm & ACL_WRITE)
263 dac_granted |= (VWRITE | VAPPEND);
264 dac_granted &= acl_mask_granted;
266 if ((accmode & dac_granted) == accmode)
277 if (group_matched == 1) {
279 * There was a match, but it did not grant rights via pure
280 * DAC. Try again, this time with privilege.
282 for (i = 0; i < acl->acl_cnt; i++) {
283 switch (acl->acl_entry[i].ae_tag) {
285 if (!groupmember(file_gid, cred))
288 if (acl->acl_entry[i].ae_perm & ACL_EXECUTE)
289 dac_granted |= VEXEC;
290 if (acl->acl_entry[i].ae_perm & ACL_READ)
291 dac_granted |= VREAD;
292 if (acl->acl_entry[i].ae_perm & ACL_WRITE)
293 dac_granted |= (VWRITE | VAPPEND);
294 dac_granted &= acl_mask_granted;
297 * XXXRW: Do privilege lookup here.
299 if ((accmode & (dac_granted | priv_granted))
303 if (privused != NULL)
308 if (!groupmember(acl->acl_entry[i].ae_id,
312 if (acl->acl_entry[i].ae_perm & ACL_EXECUTE)
313 dac_granted |= VEXEC;
314 if (acl->acl_entry[i].ae_perm & ACL_READ)
315 dac_granted |= VREAD;
316 if (acl->acl_entry[i].ae_perm & ACL_WRITE)
317 dac_granted |= (VWRITE | VAPPEND);
318 dac_granted &= acl_mask_granted;
321 * XXXRW: Do privilege lookup here.
323 if ((accmode & (dac_granted | priv_granted))
327 if (privused != NULL)
336 * Even with privilege, group membership was not sufficient.
343 * Fall back on ACL_OTHER. ACL_MASK is not applied to ACL_OTHER.
346 if (acl_other->ae_perm & ACL_EXECUTE)
347 dac_granted |= VEXEC;
348 if (acl_other->ae_perm & ACL_READ)
349 dac_granted |= VREAD;
350 if (acl_other->ae_perm & ACL_WRITE)
351 dac_granted |= (VWRITE | VAPPEND);
353 if ((accmode & dac_granted) == accmode)
356 * XXXRW: Do privilege lookup here.
358 if ((accmode & (dac_granted | priv_granted)) == accmode) {
359 if (privused != NULL)
365 return ((accmode & VADMIN) ? EPERM : EACCES);
369 * For the purposes of filesystems maintaining the _OBJ entries in an inode
370 * with a mode_t field, this routine converts a mode_t entry to an
374 acl_posix1e_mode_to_perm(acl_tag_t tag, mode_t mode)
407 printf("acl_posix1e_mode_to_perm: invalid tag (%d)\n", tag);
413 * Given inode information (uid, gid, mode), return an acl entry of the
417 acl_posix1e_mode_to_entry(acl_tag_t tag, uid_t uid, gid_t gid, mode_t mode)
419 struct acl_entry acl_entry;
421 acl_entry.ae_tag = tag;
422 acl_entry.ae_perm = acl_posix1e_mode_to_perm(tag, mode);
423 acl_entry.ae_entry_type = 0;
424 acl_entry.ae_flags = 0;
427 acl_entry.ae_id = uid;
431 acl_entry.ae_id = gid;
435 acl_entry.ae_id = ACL_UNDEFINED_ID;
439 acl_entry.ae_id = ACL_UNDEFINED_ID;
440 printf("acl_posix1e_mode_to_entry: invalid tag (%d)\n", tag);
447 * Utility function to generate a file mode given appropriate ACL entries.
450 acl_posix1e_perms_to_mode(struct acl_entry *acl_user_obj_entry,
451 struct acl_entry *acl_group_obj_entry, struct acl_entry *acl_other_entry)
456 if (acl_user_obj_entry->ae_perm & ACL_EXECUTE)
458 if (acl_user_obj_entry->ae_perm & ACL_READ)
460 if (acl_user_obj_entry->ae_perm & ACL_WRITE)
462 if (acl_group_obj_entry->ae_perm & ACL_EXECUTE)
464 if (acl_group_obj_entry->ae_perm & ACL_READ)
466 if (acl_group_obj_entry->ae_perm & ACL_WRITE)
468 if (acl_other_entry->ae_perm & ACL_EXECUTE)
470 if (acl_other_entry->ae_perm & ACL_READ)
472 if (acl_other_entry->ae_perm & ACL_WRITE)
479 * Utility function to generate a file mode given a complete POSIX.1e access
480 * ACL. Note that if the ACL is improperly formed, this may result in a
484 acl_posix1e_acl_to_mode(struct acl *acl)
486 struct acl_entry *acl_mask, *acl_user_obj, *acl_group_obj, *acl_other;
490 * Find the ACL entries relevant to a POSIX permission mode.
492 acl_user_obj = acl_group_obj = acl_other = acl_mask = NULL;
493 for (i = 0; i < acl->acl_cnt; i++) {
494 switch (acl->acl_entry[i].ae_tag) {
496 acl_user_obj = &acl->acl_entry[i];
500 acl_group_obj = &acl->acl_entry[i];
504 acl_other = &acl->acl_entry[i];
508 acl_mask = &acl->acl_entry[i];
516 panic("acl_posix1e_acl_to_mode: bad ae_tag");
520 if (acl_user_obj == NULL || acl_group_obj == NULL || acl_other == NULL)
521 panic("acl_posix1e_acl_to_mode: missing base ae_tags");
524 * POSIX.1e specifies that if there is an ACL_MASK entry, we replace
525 * the mode "group" bits with its permissions. If there isn't, we
526 * use the ACL_GROUP_OBJ permissions.
528 if (acl_mask != NULL)
529 return (acl_posix1e_perms_to_mode(acl_user_obj, acl_mask,
532 return (acl_posix1e_perms_to_mode(acl_user_obj, acl_group_obj,
537 * Perform a syntactic check of the ACL, sufficient to allow an implementing
538 * filesystem to determine if it should accept this and rely on the POSIX.1e
542 acl_posix1e_check(struct acl *acl)
544 int num_acl_user_obj, num_acl_user, num_acl_group_obj, num_acl_group;
545 int num_acl_mask, num_acl_other, i;
548 * Verify that the number of entries does not exceed the maximum
551 * Verify that the correct number of various sorts of ae_tags are
553 * Exactly one ACL_USER_OBJ
554 * Exactly one ACL_GROUP_OBJ
555 * Exactly one ACL_OTHER
556 * If any ACL_USER or ACL_GROUP entries appear, then exactly one
557 * ACL_MASK entry must also appear.
559 * Verify that all ae_perm entries are in ACL_PERM_BITS.
561 * Verify all ae_tag entries are understood by this implementation.
563 * Note: Does not check for uniqueness of qualifier (ae_id) field.
565 num_acl_user_obj = num_acl_user = num_acl_group_obj = num_acl_group =
566 num_acl_mask = num_acl_other = 0;
567 if (acl->acl_cnt > ACL_MAX_ENTRIES)
569 for (i = 0; i < acl->acl_cnt; i++) {
571 * Check for a valid tag.
573 switch(acl->acl_entry[i].ae_tag) {
575 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID; /* XXX */
576 if (acl->acl_entry[i].ae_id != ACL_UNDEFINED_ID)
581 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID; /* XXX */
582 if (acl->acl_entry[i].ae_id != ACL_UNDEFINED_ID)
587 if (acl->acl_entry[i].ae_id == ACL_UNDEFINED_ID)
592 if (acl->acl_entry[i].ae_id == ACL_UNDEFINED_ID)
597 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID; /* XXX */
598 if (acl->acl_entry[i].ae_id != ACL_UNDEFINED_ID)
603 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID; /* XXX */
604 if (acl->acl_entry[i].ae_id != ACL_UNDEFINED_ID)
612 * Check for valid perm entries.
614 if ((acl->acl_entry[i].ae_perm | ACL_PERM_BITS) !=
618 if ((num_acl_user_obj != 1) || (num_acl_group_obj != 1) ||
619 (num_acl_other != 1) || (num_acl_mask != 0 && num_acl_mask != 1))
621 if (((num_acl_group != 0) || (num_acl_user != 0)) &&
628 * Given a requested mode for a new object, and a default ACL, combine the
629 * two to produce a new mode. Be careful not to clear any bits that aren't
630 * intended to be affected by the POSIX.1e ACL. Eventually, this might also
631 * take the cmask as an argument, if we push that down into
632 * per-filesystem-code.
635 acl_posix1e_newfilemode(mode_t cmode, struct acl *dacl)
641 * The current composition policy is that a permission bit must be
642 * set in *both* the ACL and the requested creation mode for it to
643 * appear in the resulting mode/ACL. First clear any possibly
644 * effected bits, then reconstruct.
646 mode &= ACL_PRESERVE_MASK;
647 mode |= (ACL_OVERRIDE_MASK & cmode & acl_posix1e_acl_to_mode(dacl));