2 * Copyright (c) 2001-2002,2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 #include "xfs_types.h"
25 #include "xfs_bmap_btree.h"
26 #include "xfs_alloc_btree.h"
27 #include "xfs_ialloc_btree.h"
28 #include "xfs_dir2_sf.h"
29 #include "xfs_attr_sf.h"
30 #include "xfs_dinode.h"
31 #include "xfs_inode.h"
32 #include "xfs_btree.h"
36 #include <linux/capability.h>
37 #include <linux/posix_acl_xattr.h>
39 STATIC
int xfs_acl_setmode(bhv_vnode_t
*, xfs_acl_t
*, int *);
40 STATIC
void xfs_acl_filter_mode(mode_t
, xfs_acl_t
*);
41 STATIC
void xfs_acl_get_endian(xfs_acl_t
*);
42 STATIC
int xfs_acl_access(uid_t
, gid_t
, xfs_acl_t
*, mode_t
, cred_t
*);
43 STATIC
int xfs_acl_invalid(xfs_acl_t
*);
44 STATIC
void xfs_acl_sync_mode(mode_t
, xfs_acl_t
*);
45 STATIC
void xfs_acl_get_attr(bhv_vnode_t
*, xfs_acl_t
*, int, int, int *);
46 STATIC
void xfs_acl_set_attr(bhv_vnode_t
*, xfs_acl_t
*, int, int *);
47 STATIC
int xfs_acl_allow_set(bhv_vnode_t
*, int);
49 kmem_zone_t
*xfs_acl_zone
;
53 * Test for existence of access ACL attribute as efficiently as possible.
56 xfs_acl_vhasacl_access(
61 xfs_acl_get_attr(vp
, NULL
, _ACL_TYPE_ACCESS
, ATTR_KERNOVAL
, &error
);
66 * Test for existence of default ACL attribute as efficiently as possible.
69 xfs_acl_vhasacl_default(
76 xfs_acl_get_attr(vp
, NULL
, _ACL_TYPE_DEFAULT
, ATTR_KERNOVAL
, &error
);
81 * Convert from extended attribute representation to in-memory for XFS.
84 posix_acl_xattr_to_xfs(
85 posix_acl_xattr_header
*src
,
89 posix_acl_xattr_entry
*src_entry
;
90 xfs_acl_entry_t
*dest_entry
;
96 if (size
< sizeof(posix_acl_xattr_header
))
99 if (src
->a_version
!= cpu_to_le32(POSIX_ACL_XATTR_VERSION
))
102 memset(dest
, 0, sizeof(xfs_acl_t
));
103 dest
->acl_cnt
= posix_acl_xattr_count(size
);
104 if (dest
->acl_cnt
< 0 || dest
->acl_cnt
> XFS_ACL_MAX_ENTRIES
)
108 * acl_set_file(3) may request that we set default ACLs with
109 * zero length -- defend (gracefully) against that here.
114 src_entry
= (posix_acl_xattr_entry
*)((char *)src
+ sizeof(*src
));
115 dest_entry
= &dest
->acl_entry
[0];
117 for (n
= 0; n
< dest
->acl_cnt
; n
++, src_entry
++, dest_entry
++) {
118 dest_entry
->ae_perm
= le16_to_cpu(src_entry
->e_perm
);
119 if (_ACL_PERM_INVALID(dest_entry
->ae_perm
))
121 dest_entry
->ae_tag
= le16_to_cpu(src_entry
->e_tag
);
122 switch(dest_entry
->ae_tag
) {
125 dest_entry
->ae_id
= le32_to_cpu(src_entry
->e_id
);
131 dest_entry
->ae_id
= ACL_UNDEFINED_ID
;
137 if (xfs_acl_invalid(dest
))
144 * Comparison function called from xfs_sort().
145 * Primary key is ae_tag, secondary key is ae_id.
148 xfs_acl_entry_compare(
152 xfs_acl_entry_t
*a
= (xfs_acl_entry_t
*)va
,
153 *b
= (xfs_acl_entry_t
*)vb
;
155 if (a
->ae_tag
== b
->ae_tag
)
156 return (a
->ae_id
- b
->ae_id
);
157 return (a
->ae_tag
- b
->ae_tag
);
161 * Convert from in-memory XFS to extended attribute representation.
164 posix_acl_xfs_to_xattr(
166 posix_acl_xattr_header
*dest
,
170 size_t new_size
= posix_acl_xattr_size(src
->acl_cnt
);
171 posix_acl_xattr_entry
*dest_entry
;
172 xfs_acl_entry_t
*src_entry
;
177 /* Need to sort src XFS ACL by <ae_tag,ae_id> */
178 xfs_sort(src
->acl_entry
, src
->acl_cnt
, sizeof(src
->acl_entry
[0]),
179 xfs_acl_entry_compare
);
181 dest
->a_version
= cpu_to_le32(POSIX_ACL_XATTR_VERSION
);
182 dest_entry
= &dest
->a_entries
[0];
183 src_entry
= &src
->acl_entry
[0];
184 for (n
= 0; n
< src
->acl_cnt
; n
++, dest_entry
++, src_entry
++) {
185 dest_entry
->e_perm
= cpu_to_le16(src_entry
->ae_perm
);
186 if (_ACL_PERM_INVALID(src_entry
->ae_perm
))
188 dest_entry
->e_tag
= cpu_to_le16(src_entry
->ae_tag
);
189 switch (src_entry
->ae_tag
) {
192 dest_entry
->e_id
= cpu_to_le32(src_entry
->ae_id
);
198 dest_entry
->e_id
= cpu_to_le32(ACL_UNDEFINED_ID
);
215 xfs_acl_t
*xfs_acl
= NULL
;
216 posix_acl_xattr_header
*ext_acl
= acl
;
221 if (!(_ACL_ALLOC(xfs_acl
))) {
225 memset(xfs_acl
, 0, sizeof(xfs_acl_t
));
227 flags
= ATTR_KERNOVAL
;
229 xfs_acl_get_attr(vp
, xfs_acl
, kind
, flags
, &error
);
234 error
= -posix_acl_xattr_size(XFS_ACL_MAX_ENTRIES
);
236 if (xfs_acl_invalid(xfs_acl
)) {
240 if (kind
== _ACL_TYPE_ACCESS
) {
243 va
.va_mask
= XFS_AT_MODE
;
244 error
= bhv_vop_getattr(vp
, &va
, 0, sys_cred
);
247 xfs_acl_sync_mode(va
.va_mode
, xfs_acl
);
249 error
= -posix_acl_xfs_to_xattr(xfs_acl
, ext_acl
, size
);
266 error
= xfs_acl_allow_set(vp
, kind
);
268 error
= bhv_vop_attr_remove(vp
, kind
== _ACL_TYPE_DEFAULT
?
269 SGI_ACL_DEFAULT
: SGI_ACL_FILE
,
270 ATTR_ROOT
, sys_cred
);
271 if (error
== ENOATTR
)
272 error
= 0; /* 'scool */
285 posix_acl_xattr_header
*ext_acl
= acl
;
288 int basicperms
= 0; /* more than std unix perms? */
293 if (!(_ACL_ALLOC(xfs_acl
)))
296 error
= posix_acl_xattr_to_xfs(ext_acl
, size
, xfs_acl
);
301 if (!xfs_acl
->acl_cnt
) {
307 error
= xfs_acl_allow_set(vp
, kind
);
311 /* Incoming ACL exists, set file mode based on its value */
312 if (kind
== _ACL_TYPE_ACCESS
)
313 xfs_acl_setmode(vp
, xfs_acl
, &basicperms
);
316 * If we have more than std unix permissions, set up the actual attr.
317 * Otherwise, delete any existing attr. This prevents us from
318 * having actual attrs for permissions that can be stored in the
319 * standard permission bits.
322 xfs_acl_set_attr(vp
, xfs_acl
, kind
, &error
);
324 xfs_acl_vremove(vp
, _ACL_TYPE_ACCESS
);
342 if (!(_ACL_ALLOC(acl
)))
345 /* If the file has no ACL return -1. */
346 rval
= sizeof(xfs_acl_t
);
347 if (xfs_attr_fetch(ip
, SGI_ACL_FILE
, SGI_ACL_FILE_SIZE
,
348 (char *)acl
, &rval
, ATTR_ROOT
| ATTR_KERNACCESS
, cr
)) {
352 xfs_acl_get_endian(acl
);
354 /* If the file has an empty ACL return -1. */
355 if (acl
->acl_cnt
== XFS_ACL_NOT_PRESENT
) {
360 /* Synchronize ACL with mode bits */
361 xfs_acl_sync_mode(ip
->i_d
.di_mode
, acl
);
363 rval
= xfs_acl_access(ip
->i_d
.di_uid
, ip
->i_d
.di_gid
, acl
, mode
, cr
);
376 if (vp
->v_inode
.i_flags
& (S_IMMUTABLE
|S_APPEND
))
378 if (kind
== _ACL_TYPE_DEFAULT
&& !VN_ISDIR(vp
))
380 if (vp
->v_vfsp
->vfs_flag
& VFS_RDONLY
)
382 va
.va_mask
= XFS_AT_UID
;
383 error
= bhv_vop_getattr(vp
, &va
, 0, NULL
);
386 if (va
.va_uid
!= current
->fsuid
&& !capable(CAP_FOWNER
))
392 * The access control process to determine the access permission:
393 * if uid == file owner id, use the file owner bits.
394 * if gid == file owner group id, use the file group bits.
395 * scan ACL for a matching user or group, and use matched entry
396 * permission. Use total permissions of all matching group entries,
397 * until all acl entries are exhausted. The final permission produced
398 * by matching acl entry or entries needs to be & with group permission.
399 * if not owner, owning group, or matching entry in ACL, use file
403 xfs_acl_capability_check(
407 if ((mode
& ACL_READ
) && !capable_cred(cr
, CAP_DAC_READ_SEARCH
))
409 if ((mode
& ACL_WRITE
) && !capable_cred(cr
, CAP_DAC_OVERRIDE
))
411 if ((mode
& ACL_EXECUTE
) && !capable_cred(cr
, CAP_DAC_OVERRIDE
))
418 * Note: cr is only used here for the capability check if the ACL test fails.
419 * It is not used to find out the credentials uid or groups etc, as was
420 * done in IRIX. It is assumed that the uid and groups for the current
421 * thread are taken from "current" instead of the cr parameter.
431 xfs_acl_entry_t matched
;
433 int maskallows
= -1; /* true, but not 1, either */
434 int seen_userobj
= 0;
436 matched
.ae_tag
= 0; /* Invalid type */
438 md
>>= 6; /* Normalize the bits for comparison */
440 for (i
= 0; i
< fap
->acl_cnt
; i
++) {
442 * Break out if we've got a user_obj entry or
443 * a user entry and the mask (and have processed USER_OBJ)
445 if (matched
.ae_tag
== ACL_USER_OBJ
)
447 if (matched
.ae_tag
== ACL_USER
) {
448 if (maskallows
!= -1 && seen_userobj
)
450 if (fap
->acl_entry
[i
].ae_tag
!= ACL_MASK
&&
451 fap
->acl_entry
[i
].ae_tag
!= ACL_USER_OBJ
)
454 /* True if this entry allows the requested access */
455 allows
= ((fap
->acl_entry
[i
].ae_perm
& md
) == md
);
457 switch (fap
->acl_entry
[i
].ae_tag
) {
460 if (fuid
!= current
->fsuid
)
462 matched
.ae_tag
= ACL_USER_OBJ
;
463 matched
.ae_perm
= allows
;
466 if (fap
->acl_entry
[i
].ae_id
!= current
->fsuid
)
468 matched
.ae_tag
= ACL_USER
;
469 matched
.ae_perm
= allows
;
472 if ((matched
.ae_tag
== ACL_GROUP_OBJ
||
473 matched
.ae_tag
== ACL_GROUP
) && !allows
)
475 if (!in_group_p(fgid
))
477 matched
.ae_tag
= ACL_GROUP_OBJ
;
478 matched
.ae_perm
= allows
;
481 if ((matched
.ae_tag
== ACL_GROUP_OBJ
||
482 matched
.ae_tag
== ACL_GROUP
) && !allows
)
484 if (!in_group_p(fap
->acl_entry
[i
].ae_id
))
486 matched
.ae_tag
= ACL_GROUP
;
487 matched
.ae_perm
= allows
;
493 if (matched
.ae_tag
!= 0)
495 matched
.ae_tag
= ACL_OTHER
;
496 matched
.ae_perm
= allows
;
501 * First possibility is that no matched entry allows access.
502 * The capability to override DAC may exist, so check for it.
504 switch (matched
.ae_tag
) {
513 if (maskallows
&& matched
.ae_perm
)
520 return xfs_acl_capability_check(md
, cr
);
524 * ACL validity checker.
525 * This acl validation routine checks each ACL entry read in makes sense.
531 xfs_acl_entry_t
*entry
, *e
;
532 int user
= 0, group
= 0, other
= 0, mask
= 0;
533 int mask_required
= 0;
539 if (aclp
->acl_cnt
> XFS_ACL_MAX_ENTRIES
)
542 for (i
= 0; i
< aclp
->acl_cnt
; i
++) {
543 entry
= &aclp
->acl_entry
[i
];
544 switch (entry
->ae_tag
) {
559 for (j
= i
+ 1; j
< aclp
->acl_cnt
; j
++) {
560 e
= &aclp
->acl_entry
[j
];
561 if (e
->ae_id
== entry
->ae_id
&&
562 e
->ae_tag
== entry
->ae_tag
)
575 if (!user
|| !group
|| !other
|| (mask_required
&& !mask
))
584 * Do ACL endian conversion.
590 xfs_acl_entry_t
*ace
, *end
;
592 INT_SET(aclp
->acl_cnt
, ARCH_CONVERT
, aclp
->acl_cnt
);
593 end
= &aclp
->acl_entry
[0]+aclp
->acl_cnt
;
594 for (ace
= &aclp
->acl_entry
[0]; ace
< end
; ace
++) {
595 INT_SET(ace
->ae_tag
, ARCH_CONVERT
, ace
->ae_tag
);
596 INT_SET(ace
->ae_id
, ARCH_CONVERT
, ace
->ae_id
);
597 INT_SET(ace
->ae_perm
, ARCH_CONVERT
, ace
->ae_perm
);
602 * Get the ACL from the EA and do endian conversion.
612 int len
= sizeof(xfs_acl_t
);
614 ASSERT((flags
& ATTR_KERNOVAL
) ? (aclp
== NULL
) : 1);
616 *error
= bhv_vop_attr_get(vp
, kind
== _ACL_TYPE_ACCESS
?
617 SGI_ACL_FILE
: SGI_ACL_DEFAULT
,
618 (char *)aclp
, &len
, flags
, sys_cred
);
619 if (*error
|| (flags
& ATTR_KERNOVAL
))
621 xfs_acl_get_endian(aclp
);
625 * Set the EA with the ACL and do endian conversion.
634 xfs_acl_entry_t
*ace
, *newace
, *end
;
638 if (!(_ACL_ALLOC(newacl
))) {
643 len
= sizeof(xfs_acl_t
) -
644 (sizeof(xfs_acl_entry_t
) * (XFS_ACL_MAX_ENTRIES
- aclp
->acl_cnt
));
645 end
= &aclp
->acl_entry
[0]+aclp
->acl_cnt
;
646 for (ace
= &aclp
->acl_entry
[0], newace
= &newacl
->acl_entry
[0];
649 INT_SET(newace
->ae_tag
, ARCH_CONVERT
, ace
->ae_tag
);
650 INT_SET(newace
->ae_id
, ARCH_CONVERT
, ace
->ae_id
);
651 INT_SET(newace
->ae_perm
, ARCH_CONVERT
, ace
->ae_perm
);
653 INT_SET(newacl
->acl_cnt
, ARCH_CONVERT
, aclp
->acl_cnt
);
654 *error
= bhv_vop_attr_set(vp
, kind
== _ACL_TYPE_ACCESS
?
655 SGI_ACL_FILE
: SGI_ACL_DEFAULT
,
656 (char *)newacl
, len
, ATTR_ROOT
, sys_cred
);
663 xfs_acl_t
*access_acl
,
664 xfs_acl_t
*default_acl
)
671 * Get the Access ACL and the mode. If either cannot
672 * be obtained for some reason, invalidate the access ACL.
674 xfs_acl_get_attr(vp
, access_acl
, _ACL_TYPE_ACCESS
, 0, &error
);
676 /* Got the ACL, need the mode... */
677 va
.va_mask
= XFS_AT_MODE
;
678 error
= bhv_vop_getattr(vp
, &va
, 0, sys_cred
);
682 access_acl
->acl_cnt
= XFS_ACL_NOT_PRESENT
;
683 else /* We have a good ACL and the file mode, synchronize. */
684 xfs_acl_sync_mode(va
.va_mode
, access_acl
);
688 xfs_acl_get_attr(vp
, default_acl
, _ACL_TYPE_DEFAULT
, 0, &error
);
690 default_acl
->acl_cnt
= XFS_ACL_NOT_PRESENT
;
696 * This function retrieves the parent directory's acl, processes it
697 * and lets the child inherit the acl(s) that it should.
710 * If the parent does not have a default ACL, or it's an
711 * invalid ACL, we're done.
715 if (!pdaclp
|| xfs_acl_invalid(pdaclp
))
719 * Copy the default ACL of the containing directory to
720 * the access ACL of the new file and use the mode that
721 * was passed in to set up the correct initial values for
722 * the u::,g::[m::], and o:: entries. This is what makes
723 * umask() "work" with ACL's.
726 if (!(_ACL_ALLOC(cacl
)))
729 memcpy(cacl
, pdaclp
, sizeof(xfs_acl_t
));
730 xfs_acl_filter_mode(vap
->va_mode
, cacl
);
731 xfs_acl_setmode(vp
, cacl
, &basicperms
);
734 * Set the Default and Access ACL on the file. The mode is already
735 * set on the file, so we don't need to worry about that.
737 * If the new file is a directory, its default ACL is a copy of
738 * the containing directory's default ACL.
741 xfs_acl_set_attr(vp
, pdaclp
, _ACL_TYPE_DEFAULT
, &error
);
742 if (!error
&& !basicperms
)
743 xfs_acl_set_attr(vp
, cacl
, _ACL_TYPE_ACCESS
, &error
);
749 * Set up the correct mode on the file based on the supplied ACL. This
750 * makes sure that the mode on the file reflects the state of the
751 * u::,g::[m::], and o:: entries in the ACL. Since the mode is where
752 * the ACL is going to get the permissions for these entries, we must
753 * synchronize the mode whenever we set the ACL on a file.
763 xfs_acl_entry_t
*gap
= NULL
;
764 int i
, error
, nomask
= 1;
768 if (acl
->acl_cnt
== XFS_ACL_NOT_PRESENT
)
772 * Copy the u::, g::, o::, and m:: bits from the ACL into the
773 * mode. The m:: bits take precedence over the g:: bits.
775 va
.va_mask
= XFS_AT_MODE
;
776 error
= bhv_vop_getattr(vp
, &va
, 0, sys_cred
);
780 va
.va_mask
= XFS_AT_MODE
;
781 va
.va_mode
&= ~(S_IRWXU
|S_IRWXG
|S_IRWXO
);
783 for (i
= 0; i
< acl
->acl_cnt
; ++i
) {
784 switch (ap
->ae_tag
) {
786 va
.va_mode
|= ap
->ae_perm
<< 6;
791 case ACL_MASK
: /* more than just standard modes */
793 va
.va_mode
|= ap
->ae_perm
<< 3;
797 va
.va_mode
|= ap
->ae_perm
;
799 default: /* more than just standard modes */
806 /* Set the group bits from ACL_GROUP_OBJ if there's no ACL_MASK */
808 va
.va_mode
|= gap
->ae_perm
<< 3;
810 return bhv_vop_setattr(vp
, &va
, 0, sys_cred
);
814 * The permissions for the special ACL entries (u::, g::[m::], o::) are
815 * actually stored in the file mode (if there is both a group and a mask,
816 * the group is stored in the ACL entry and the mask is stored on the file).
817 * This allows the mode to remain automatically in sync with the ACL without
818 * the need for a call-back to the ACL system at every point where the mode
819 * could change. This function takes the permissions from the specified mode
820 * and places it in the supplied ACL.
822 * This implementation draws its validity from the fact that, when the ACL
823 * was assigned, the mode was copied from the ACL.
824 * If the mode did not change, therefore, the mode remains exactly what was
825 * taken from the special ACL entries at assignment.
826 * If a subsequent chmod() was done, the POSIX spec says that the change in
827 * mode must cause an update to the ACL seen at user level and used for
828 * access checks. Before and after a mode change, therefore, the file mode
829 * most accurately reflects what the special ACL entries should permit/deny.
831 * CAVEAT: If someone sets the SGI_ACL_FILE attribute directly,
832 * the existing mode bits will override whatever is in the
833 * ACL. Similarly, if there is a pre-existing ACL that was
834 * never in sync with its mode (owing to a bug in 6.5 and
835 * before), it will now magically (or mystically) be
836 * synchronized. This could cause slight astonishment, but
837 * it is better than inconsistent permissions.
839 * The supplied ACL is a template that may contain any combination
840 * of special entries. These are treated as place holders when we fill
841 * out the ACL. This routine does not add or remove special entries, it
842 * simply unites each special entry with its associated set of permissions.
851 xfs_acl_entry_t
*gap
= NULL
;
854 * Set ACL entries. POSIX1003.1eD16 requires that the MASK
855 * be set instead of the GROUP entry, if there is a MASK.
857 for (ap
= acl
->acl_entry
, i
= 0; i
< acl
->acl_cnt
; ap
++, i
++) {
858 switch (ap
->ae_tag
) {
860 ap
->ae_perm
= (mode
>> 6) & 0x7;
867 ap
->ae_perm
= (mode
>> 3) & 0x7;
870 ap
->ae_perm
= mode
& 0x7;
876 /* Set the ACL_GROUP_OBJ if there's no ACL_MASK */
878 gap
->ae_perm
= (mode
>> 3) & 0x7;
882 * When inheriting an Access ACL from a directory Default ACL,
883 * the ACL bits are set to the intersection of the ACL default
884 * permission bits and the file permission bits in mode. If there
885 * are no permission bits on the file then we must not give them
886 * the ACL. This is what what makes umask() work with ACLs.
895 xfs_acl_entry_t
*gap
= NULL
;
898 * Set ACL entries. POSIX1003.1eD16 requires that the MASK
899 * be merged with GROUP entry, if there is a MASK.
901 for (ap
= acl
->acl_entry
, i
= 0; i
< acl
->acl_cnt
; ap
++, i
++) {
902 switch (ap
->ae_tag
) {
904 ap
->ae_perm
&= (mode
>> 6) & 0x7;
911 ap
->ae_perm
&= (mode
>> 3) & 0x7;
914 ap
->ae_perm
&= mode
& 0x7;
920 /* Set the ACL_GROUP_OBJ if there's no ACL_MASK */
922 gap
->ae_perm
&= (mode
>> 3) & 0x7;