2 * Copyright (c) 1999-2003 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
30 * Support for POSIX.1e access control lists: UFS-specific support functions.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 #include "opt_quota.h"
39 #include <sys/param.h>
40 #include <sys/systm.h>
42 #include <sys/mount.h>
43 #include <sys/vnode.h>
44 #include <sys/types.h>
46 #include <sys/event.h>
47 #include <sys/extattr.h>
49 #include <ufs/ufs/quota.h>
50 #include <ufs/ufs/inode.h>
51 #include <ufs/ufs/acl.h>
52 #include <ufs/ufs/extattr.h>
53 #include <ufs/ufs/dir.h>
54 #include <ufs/ufs/ufsmount.h>
55 #include <ufs/ufs/ufs_extern.h>
56 #include <ufs/ffs/fs.h>
61 * Synchronize an ACL and an inode by copying over appropriate inode fields
62 * to the passed ACL. Assumes an ACL that would satisfy acl_posix1e_check(),
63 * and may panic if not.
66 ufs_sync_acl_from_inode(struct inode *ip, struct acl *acl)
68 struct acl_entry *acl_mask, *acl_group_obj;
72 * Update ACL_USER_OBJ, ACL_OTHER, but simply identify ACL_MASK
73 * and ACL_GROUP_OBJ for use after we know whether ACL_MASK is
78 for (i = 0; i < acl->acl_cnt; i++) {
79 switch (acl->acl_entry[i].ae_tag) {
81 acl->acl_entry[i].ae_perm = acl_posix1e_mode_to_perm(
82 ACL_USER_OBJ, ip->i_mode);
83 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID;
87 acl_group_obj = &acl->acl_entry[i];
88 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID;
92 acl->acl_entry[i].ae_perm = acl_posix1e_mode_to_perm(
93 ACL_OTHER, ip->i_mode);
94 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID;
98 acl_mask = &acl->acl_entry[i];
99 acl->acl_entry[i].ae_id = ACL_UNDEFINED_ID;
107 panic("ufs_sync_acl_from_inode(): bad ae_tag");
111 if (acl_group_obj == NULL)
112 panic("ufs_sync_acl_from_inode(): no ACL_GROUP_OBJ");
114 if (acl_mask == NULL) {
116 * There is no ACL_MASK, so update ACL_GROUP_OBJ.
118 acl_group_obj->ae_perm = acl_posix1e_mode_to_perm(
119 ACL_GROUP_OBJ, ip->i_mode);
122 * Update the ACL_MASK entry instead of ACL_GROUP_OBJ.
124 acl_mask->ae_perm = acl_posix1e_mode_to_perm(ACL_GROUP_OBJ,
130 * Calculate what the inode mode should look like based on an authoritative
131 * ACL for the inode. Replace only the fields in the inode that the ACL
135 ufs_sync_inode_from_acl(struct acl *acl, struct inode *ip)
138 ip->i_mode &= ACL_PRESERVE_MASK;
139 ip->i_mode |= acl_posix1e_acl_to_mode(acl);
140 DIP_SET(ip, i_mode, ip->i_mode);
144 * Retrieve NFSv4 ACL, skipping access checks. Must be used in UFS code
145 * instead of VOP_GETACL() when we don't want to be restricted by the user
146 * not having ACL_READ_ACL permission, e.g. when calculating inherited ACL
147 * or in ufs_vnops.c:ufs_accessx().
150 ufs_getacl_nfs4_internal(struct vnode *vp, struct acl *aclp, struct thread *td)
153 struct inode *ip = VTOI(vp);
158 error = vn_extattr_get(vp, IO_NODELOCKED,
159 NFS4_ACL_EXTATTR_NAMESPACE, NFS4_ACL_EXTATTR_NAME,
160 &len, (char *) aclp, td);
161 aclp->acl_maxcnt = ACL_MAX_ENTRIES;
162 if (error == ENOATTR) {
164 * Legitimately no ACL set on object, purely
165 * emulate it through the inode.
167 acl_nfs4_sync_acl_from_mode(aclp, ip->i_mode, ip->i_uid);
175 if (len != sizeof(*aclp)) {
177 * A short (or long) read, meaning that for
178 * some reason the ACL is corrupted. Return
179 * EPERM since the object DAC protections
182 printf("ufs_getacl_nfs4(): Loaded invalid ACL ("
183 "%d bytes), inumber %d on %s\n", len,
184 ip->i_number, ip->i_fs->fs_fsmnt);
189 error = acl_nfs4_check(aclp, vp->v_type == VDIR);
191 printf("ufs_getacl_nfs4(): Loaded invalid ACL "
192 "(failed acl_nfs4_check), inumber %d on %s\n",
193 ip->i_number, ip->i_fs->fs_fsmnt);
202 ufs_getacl_nfs4(struct vop_getacl_args *ap)
206 if ((ap->a_vp->v_mount->mnt_flag & MNT_NFS4ACLS) == 0)
209 error = VOP_ACCESSX(ap->a_vp, VREAD_ACL, ap->a_td->td_ucred, ap->a_td);
213 error = ufs_getacl_nfs4_internal(ap->a_vp, ap->a_aclp, ap->a_td);
219 * Read POSIX.1e ACL from an EA. Return error if its not found
220 * or if any other error has occured.
223 ufs_get_oldacl(acl_type_t type, struct oldacl *old, struct vnode *vp,
227 struct inode *ip = VTOI(vp);
232 case ACL_TYPE_ACCESS:
233 error = vn_extattr_get(vp, IO_NODELOCKED,
234 POSIX1E_ACL_ACCESS_EXTATTR_NAMESPACE,
235 POSIX1E_ACL_ACCESS_EXTATTR_NAME, &len, (char *) old,
238 case ACL_TYPE_DEFAULT:
239 if (vp->v_type != VDIR)
241 error = vn_extattr_get(vp, IO_NODELOCKED,
242 POSIX1E_ACL_DEFAULT_EXTATTR_NAMESPACE,
243 POSIX1E_ACL_DEFAULT_EXTATTR_NAME, &len, (char *) old,
253 if (len != sizeof(*old)) {
255 * A short (or long) read, meaning that for some reason
256 * the ACL is corrupted. Return EPERM since the object
257 * DAC protections are unsafe.
259 printf("ufs_get_oldacl(): Loaded invalid ACL "
260 "(len = %d), inumber %d on %s\n", len,
261 ip->i_number, ip->i_fs->fs_fsmnt);
269 * Retrieve the ACL on a file.
271 * As part of the ACL is stored in the inode, and the rest in an EA,
272 * assemble both into a final ACL product. Right now this is not done
276 ufs_getacl_posix1e(struct vop_getacl_args *ap)
278 struct inode *ip = VTOI(ap->a_vp);
283 * XXX: If ufs_getacl() should work on file systems not supporting
284 * ACLs, remove this check.
286 if ((ap->a_vp->v_mount->mnt_flag & MNT_ACLS) == 0)
289 old = malloc(sizeof(*old), M_ACL, M_WAITOK | M_ZERO);
292 * Attempt to retrieve the ACL from the extended attributes.
294 error = ufs_get_oldacl(ap->a_type, old, ap->a_vp, ap->a_td);
297 * XXX: If ufs_getacl() should work on filesystems
298 * without the EA configured, add case EOPNOTSUPP here.
301 switch (ap->a_type) {
302 case ACL_TYPE_ACCESS:
304 * Legitimately no ACL set on object, purely
305 * emulate it through the inode. These fields will
306 * be updated when the ACL is synchronized with
310 old->acl_entry[0].ae_tag = ACL_USER_OBJ;
311 old->acl_entry[0].ae_id = ACL_UNDEFINED_ID;
312 old->acl_entry[0].ae_perm = ACL_PERM_NONE;
313 old->acl_entry[1].ae_tag = ACL_GROUP_OBJ;
314 old->acl_entry[1].ae_id = ACL_UNDEFINED_ID;
315 old->acl_entry[1].ae_perm = ACL_PERM_NONE;
316 old->acl_entry[2].ae_tag = ACL_OTHER;
317 old->acl_entry[2].ae_id = ACL_UNDEFINED_ID;
318 old->acl_entry[2].ae_perm = ACL_PERM_NONE;
321 case ACL_TYPE_DEFAULT:
323 * Unlike ACL_TYPE_ACCESS, there is no relationship
324 * between the inode contents and the ACL, and it is
325 * therefore possible for the request for the ACL
326 * to fail since the ACL is undefined. In this
327 * situation, return success and an empty ACL,
328 * as required by POSIX.1e.
335 error = acl_copy_oldacl_into_acl(old, ap->a_aclp);
339 if (ap->a_type == ACL_TYPE_ACCESS)
340 ufs_sync_acl_from_inode(ip, ap->a_aclp);
351 struct vop_getacl_args /* {
360 if ((ap->a_vp->v_mount->mnt_flag & (MNT_ACLS | MNT_NFS4ACLS)) == 0)
363 if (ap->a_type == ACL_TYPE_NFS4)
364 return (ufs_getacl_nfs4(ap));
366 return (ufs_getacl_posix1e(ap));
370 * Set NFSv4 ACL without doing any access checking. This is required
371 * e.g. by the UFS code that implements ACL inheritance, or from
372 * ufs_vnops.c:ufs_chmod(), as some of the checks have to be skipped
373 * in that case, and others are redundant.
376 ufs_setacl_nfs4_internal(struct vnode *vp, struct acl *aclp, struct thread *td)
380 struct inode *ip = VTOI(vp);
382 KASSERT(acl_nfs4_check(aclp, vp->v_type == VDIR) == 0,
383 ("invalid ACL passed to ufs_setacl_nfs4_internal"));
385 if (acl_nfs4_is_trivial(aclp, ip->i_uid)) {
386 error = vn_extattr_rm(vp, IO_NODELOCKED,
387 NFS4_ACL_EXTATTR_NAMESPACE, NFS4_ACL_EXTATTR_NAME, td);
390 * An attempt to remove ACL from a file that didn't have
391 * any extended entries is not an error.
393 if (error == ENOATTR)
397 error = vn_extattr_set(vp, IO_NODELOCKED,
398 NFS4_ACL_EXTATTR_NAMESPACE, NFS4_ACL_EXTATTR_NAME,
399 sizeof(*aclp), (char *) aclp, td);
403 * Map lack of attribute definition in UFS_EXTATTR into lack of
404 * support for ACLs on the filesystem.
406 if (error == ENOATTR)
414 acl_nfs4_sync_mode_from_acl(&mode, aclp);
416 ip->i_mode &= ACL_PRESERVE_MASK;
418 DIP_SET(ip, i_mode, ip->i_mode);
419 ip->i_flag |= IN_CHANGE;
421 VN_KNOTE_UNLOCKED(vp, NOTE_ATTRIB);
427 ufs_setacl_nfs4(struct vop_setacl_args *ap)
430 struct inode *ip = VTOI(ap->a_vp);
432 if ((ap->a_vp->v_mount->mnt_flag & MNT_NFS4ACLS) == 0)
435 if (ap->a_vp->v_mount->mnt_flag & MNT_RDONLY)
438 if (ap->a_aclp == NULL)
441 error = VOP_ACLCHECK(ap->a_vp, ap->a_type, ap->a_aclp, ap->a_cred,
447 * Authorize the ACL operation.
449 if (ip->i_flags & (IMMUTABLE | APPEND))
453 * Must hold VWRITE_ACL or have appropriate privilege.
455 if ((error = VOP_ACCESSX(ap->a_vp, VWRITE_ACL, ap->a_cred, ap->a_td)))
459 * With NFSv4 ACLs, chmod(2) may need to add additional entries.
460 * Make sure it has enough room for that - splitting every entry
461 * into two and appending "canonical six" entries at the end.
463 if (ap->a_aclp->acl_cnt > (ACL_MAX_ENTRIES - 6) / 2)
466 error = ufs_setacl_nfs4_internal(ap->a_vp, ap->a_aclp, ap->a_td);
472 * Set the ACL on a file.
474 * As part of the ACL is stored in the inode, and the rest in an EA,
475 * this is necessarily non-atomic, and has complex authorization.
476 * As ufs_setacl() includes elements of ufs_chown() and ufs_chmod(),
477 * a fair number of different access checks may be required to go ahead
478 * with the operation at all.
481 ufs_setacl_posix1e(struct vop_setacl_args *ap)
483 struct inode *ip = VTOI(ap->a_vp);
487 if ((ap->a_vp->v_mount->mnt_flag & MNT_ACLS) == 0)
491 * If this is a set operation rather than a delete operation,
492 * invoke VOP_ACLCHECK() on the passed ACL to determine if it is
493 * valid for the target. This will include a check on ap->a_type.
495 if (ap->a_aclp != NULL) {
499 error = VOP_ACLCHECK(ap->a_vp, ap->a_type, ap->a_aclp,
500 ap->a_cred, ap->a_td);
506 * POSIX.1e allows only deletion of the default ACL on a
507 * directory (ACL_TYPE_DEFAULT).
509 if (ap->a_type != ACL_TYPE_DEFAULT)
511 if (ap->a_vp->v_type != VDIR)
515 if (ap->a_vp->v_mount->mnt_flag & MNT_RDONLY)
519 * Authorize the ACL operation.
521 if (ip->i_flags & (IMMUTABLE | APPEND))
525 * Must hold VADMIN (be file owner) or have appropriate privilege.
527 if ((error = VOP_ACCESS(ap->a_vp, VADMIN, ap->a_cred, ap->a_td)))
531 case ACL_TYPE_ACCESS:
532 old = malloc(sizeof(*old), M_ACL, M_WAITOK | M_ZERO);
533 error = acl_copy_acl_into_oldacl(ap->a_aclp, old);
535 error = vn_extattr_set(ap->a_vp, IO_NODELOCKED,
536 POSIX1E_ACL_ACCESS_EXTATTR_NAMESPACE,
537 POSIX1E_ACL_ACCESS_EXTATTR_NAME, sizeof(*old),
538 (char *) old, ap->a_td);
543 case ACL_TYPE_DEFAULT:
544 if (ap->a_aclp == NULL) {
545 error = vn_extattr_rm(ap->a_vp, IO_NODELOCKED,
546 POSIX1E_ACL_DEFAULT_EXTATTR_NAMESPACE,
547 POSIX1E_ACL_DEFAULT_EXTATTR_NAME, ap->a_td);
549 * Attempting to delete a non-present default ACL
550 * will return success for portability purposes.
553 * XXX: Note that since we can't distinguish
554 * "that EA is not supported" from "that EA is not
555 * defined", the success case here overlaps the
556 * the ENOATTR->EOPNOTSUPP case below.
558 if (error == ENOATTR)
561 old = malloc(sizeof(*old), M_ACL, M_WAITOK | M_ZERO);
562 error = acl_copy_acl_into_oldacl(ap->a_aclp, old);
564 error = vn_extattr_set(ap->a_vp, IO_NODELOCKED,
565 POSIX1E_ACL_DEFAULT_EXTATTR_NAMESPACE,
566 POSIX1E_ACL_DEFAULT_EXTATTR_NAME,
567 sizeof(*old), (char *) old, ap->a_td);
577 * Map lack of attribute definition in UFS_EXTATTR into lack of
578 * support for ACLs on the filesystem.
580 if (error == ENOATTR)
585 if (ap->a_type == ACL_TYPE_ACCESS) {
587 * Now that the EA is successfully updated, update the
588 * inode and mark it as changed.
590 ufs_sync_inode_from_acl(ap->a_aclp, ip);
591 ip->i_flag |= IN_CHANGE;
594 VN_KNOTE_UNLOCKED(ap->a_vp, NOTE_ATTRIB);
600 struct vop_setacl_args /* {
608 if ((ap->a_vp->v_mount->mnt_flag & (MNT_ACLS | MNT_NFS4ACLS)) == 0)
611 if (ap->a_type == ACL_TYPE_NFS4)
612 return (ufs_setacl_nfs4(ap));
614 return (ufs_setacl_posix1e(ap));
618 ufs_aclcheck_nfs4(struct vop_aclcheck_args *ap)
620 int is_directory = 0;
622 if ((ap->a_vp->v_mount->mnt_flag & MNT_NFS4ACLS) == 0)
626 * With NFSv4 ACLs, chmod(2) may need to add additional entries.
627 * Make sure it has enough room for that - splitting every entry
628 * into two and appending "canonical six" entries at the end.
630 if (ap->a_aclp->acl_cnt > (ACL_MAX_ENTRIES - 6) / 2)
633 if (ap->a_vp->v_type == VDIR)
636 return (acl_nfs4_check(ap->a_aclp, is_directory));
640 ufs_aclcheck_posix1e(struct vop_aclcheck_args *ap)
643 if ((ap->a_vp->v_mount->mnt_flag & MNT_ACLS) == 0)
647 * Verify we understand this type of ACL, and that it applies
648 * to this kind of object.
649 * Rely on the acl_posix1e_check() routine to verify the contents.
652 case ACL_TYPE_ACCESS:
655 case ACL_TYPE_DEFAULT:
656 if (ap->a_vp->v_type != VDIR)
664 if (ap->a_aclp->acl_cnt > OLDACL_MAX_ENTRIES)
667 return (acl_posix1e_check(ap->a_aclp));
671 * Check the validity of an ACL for a file.
675 struct vop_aclcheck_args /* {
684 if ((ap->a_vp->v_mount->mnt_flag & (MNT_ACLS | MNT_NFS4ACLS)) == 0)
687 if (ap->a_type == ACL_TYPE_NFS4)
688 return (ufs_aclcheck_nfs4(ap));
690 return (ufs_aclcheck_posix1e(ap));
693 #endif /* !UFS_ACL */