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"
35 #include "xfs_vnodeops.h"
37 #include <linux/capability.h>
38 #include <linux/posix_acl_xattr.h>
40 STATIC
int xfs_acl_setmode(bhv_vnode_t
*, xfs_acl_t
*, int *);
41 STATIC
void xfs_acl_filter_mode(mode_t
, xfs_acl_t
*);
42 STATIC
void xfs_acl_get_endian(xfs_acl_t
*);
43 STATIC
int xfs_acl_access(uid_t
, gid_t
, xfs_acl_t
*, mode_t
, cred_t
*);
44 STATIC
int xfs_acl_invalid(xfs_acl_t
*);
45 STATIC
void xfs_acl_sync_mode(mode_t
, xfs_acl_t
*);
46 STATIC
void xfs_acl_get_attr(bhv_vnode_t
*, xfs_acl_t
*, int, int, int *);
47 STATIC
void xfs_acl_set_attr(bhv_vnode_t
*, xfs_acl_t
*, int, int *);
48 STATIC
int xfs_acl_allow_set(bhv_vnode_t
*, int);
50 kmem_zone_t
*xfs_acl_zone
;
54 * Test for existence of access ACL attribute as efficiently as possible.
57 xfs_acl_vhasacl_access(
62 xfs_acl_get_attr(vp
, NULL
, _ACL_TYPE_ACCESS
, ATTR_KERNOVAL
, &error
);
67 * Test for existence of default ACL attribute as efficiently as possible.
70 xfs_acl_vhasacl_default(
77 xfs_acl_get_attr(vp
, NULL
, _ACL_TYPE_DEFAULT
, ATTR_KERNOVAL
, &error
);
82 * Convert from extended attribute representation to in-memory for XFS.
85 posix_acl_xattr_to_xfs(
86 posix_acl_xattr_header
*src
,
90 posix_acl_xattr_entry
*src_entry
;
91 xfs_acl_entry_t
*dest_entry
;
97 if (size
< sizeof(posix_acl_xattr_header
))
100 if (src
->a_version
!= cpu_to_le32(POSIX_ACL_XATTR_VERSION
))
103 memset(dest
, 0, sizeof(xfs_acl_t
));
104 dest
->acl_cnt
= posix_acl_xattr_count(size
);
105 if (dest
->acl_cnt
< 0 || dest
->acl_cnt
> XFS_ACL_MAX_ENTRIES
)
109 * acl_set_file(3) may request that we set default ACLs with
110 * zero length -- defend (gracefully) against that here.
115 src_entry
= (posix_acl_xattr_entry
*)((char *)src
+ sizeof(*src
));
116 dest_entry
= &dest
->acl_entry
[0];
118 for (n
= 0; n
< dest
->acl_cnt
; n
++, src_entry
++, dest_entry
++) {
119 dest_entry
->ae_perm
= le16_to_cpu(src_entry
->e_perm
);
120 if (_ACL_PERM_INVALID(dest_entry
->ae_perm
))
122 dest_entry
->ae_tag
= le16_to_cpu(src_entry
->e_tag
);
123 switch(dest_entry
->ae_tag
) {
126 dest_entry
->ae_id
= le32_to_cpu(src_entry
->e_id
);
132 dest_entry
->ae_id
= ACL_UNDEFINED_ID
;
138 if (xfs_acl_invalid(dest
))
145 * Comparison function called from xfs_sort().
146 * Primary key is ae_tag, secondary key is ae_id.
149 xfs_acl_entry_compare(
153 xfs_acl_entry_t
*a
= (xfs_acl_entry_t
*)va
,
154 *b
= (xfs_acl_entry_t
*)vb
;
156 if (a
->ae_tag
== b
->ae_tag
)
157 return (a
->ae_id
- b
->ae_id
);
158 return (a
->ae_tag
- b
->ae_tag
);
162 * Convert from in-memory XFS to extended attribute representation.
165 posix_acl_xfs_to_xattr(
167 posix_acl_xattr_header
*dest
,
171 size_t new_size
= posix_acl_xattr_size(src
->acl_cnt
);
172 posix_acl_xattr_entry
*dest_entry
;
173 xfs_acl_entry_t
*src_entry
;
178 /* Need to sort src XFS ACL by <ae_tag,ae_id> */
179 xfs_sort(src
->acl_entry
, src
->acl_cnt
, sizeof(src
->acl_entry
[0]),
180 xfs_acl_entry_compare
);
182 dest
->a_version
= cpu_to_le32(POSIX_ACL_XATTR_VERSION
);
183 dest_entry
= &dest
->a_entries
[0];
184 src_entry
= &src
->acl_entry
[0];
185 for (n
= 0; n
< src
->acl_cnt
; n
++, dest_entry
++, src_entry
++) {
186 dest_entry
->e_perm
= cpu_to_le16(src_entry
->ae_perm
);
187 if (_ACL_PERM_INVALID(src_entry
->ae_perm
))
189 dest_entry
->e_tag
= cpu_to_le16(src_entry
->ae_tag
);
190 switch (src_entry
->ae_tag
) {
193 dest_entry
->e_id
= cpu_to_le32(src_entry
->ae_id
);
199 dest_entry
->e_id
= cpu_to_le32(ACL_UNDEFINED_ID
);
216 xfs_acl_t
*xfs_acl
= NULL
;
217 posix_acl_xattr_header
*ext_acl
= acl
;
222 if (!(_ACL_ALLOC(xfs_acl
))) {
226 memset(xfs_acl
, 0, sizeof(xfs_acl_t
));
228 flags
= ATTR_KERNOVAL
;
230 xfs_acl_get_attr(vp
, xfs_acl
, kind
, flags
, &error
);
235 error
= -posix_acl_xattr_size(XFS_ACL_MAX_ENTRIES
);
237 if (xfs_acl_invalid(xfs_acl
)) {
241 if (kind
== _ACL_TYPE_ACCESS
) {
244 va
.va_mask
= XFS_AT_MODE
;
245 error
= xfs_getattr(xfs_vtoi(vp
), &va
, 0);
248 xfs_acl_sync_mode(va
.va_mode
, xfs_acl
);
250 error
= -posix_acl_xfs_to_xattr(xfs_acl
, ext_acl
, size
);
267 error
= xfs_acl_allow_set(vp
, kind
);
269 error
= xfs_attr_remove(xfs_vtoi(vp
),
270 kind
== _ACL_TYPE_DEFAULT
?
271 SGI_ACL_DEFAULT
: SGI_ACL_FILE
,
273 if (error
== ENOATTR
)
274 error
= 0; /* 'scool */
287 posix_acl_xattr_header
*ext_acl
= acl
;
290 int basicperms
= 0; /* more than std unix perms? */
295 if (!(_ACL_ALLOC(xfs_acl
)))
298 error
= posix_acl_xattr_to_xfs(ext_acl
, size
, xfs_acl
);
303 if (!xfs_acl
->acl_cnt
) {
309 error
= xfs_acl_allow_set(vp
, kind
);
313 /* Incoming ACL exists, set file mode based on its value */
314 if (kind
== _ACL_TYPE_ACCESS
)
315 xfs_acl_setmode(vp
, xfs_acl
, &basicperms
);
318 * If we have more than std unix permissions, set up the actual attr.
319 * Otherwise, delete any existing attr. This prevents us from
320 * having actual attrs for permissions that can be stored in the
321 * standard permission bits.
324 xfs_acl_set_attr(vp
, xfs_acl
, kind
, &error
);
326 xfs_acl_vremove(vp
, _ACL_TYPE_ACCESS
);
344 if (!(_ACL_ALLOC(acl
)))
347 /* If the file has no ACL return -1. */
348 rval
= sizeof(xfs_acl_t
);
349 if (xfs_attr_fetch(ip
, SGI_ACL_FILE
, SGI_ACL_FILE_SIZE
,
350 (char *)acl
, &rval
, ATTR_ROOT
| ATTR_KERNACCESS
, cr
)) {
354 xfs_acl_get_endian(acl
);
356 /* If the file has an empty ACL return -1. */
357 if (acl
->acl_cnt
== XFS_ACL_NOT_PRESENT
) {
362 /* Synchronize ACL with mode bits */
363 xfs_acl_sync_mode(ip
->i_d
.di_mode
, acl
);
365 rval
= xfs_acl_access(ip
->i_d
.di_uid
, ip
->i_d
.di_gid
, acl
, mode
, cr
);
375 xfs_inode_t
*ip
= xfs_vtoi(vp
);
379 if (vp
->i_flags
& (S_IMMUTABLE
|S_APPEND
))
381 if (kind
== _ACL_TYPE_DEFAULT
&& !VN_ISDIR(vp
))
383 if (vp
->i_sb
->s_flags
& MS_RDONLY
)
385 va
.va_mask
= XFS_AT_UID
;
386 error
= xfs_getattr(ip
, &va
, 0);
389 if (va
.va_uid
!= current
->fsuid
&& !capable(CAP_FOWNER
))
395 * The access control process to determine the access permission:
396 * if uid == file owner id, use the file owner bits.
397 * if gid == file owner group id, use the file group bits.
398 * scan ACL for a matching user or group, and use matched entry
399 * permission. Use total permissions of all matching group entries,
400 * until all acl entries are exhausted. The final permission produced
401 * by matching acl entry or entries needs to be & with group permission.
402 * if not owner, owning group, or matching entry in ACL, use file
406 xfs_acl_capability_check(
410 if ((mode
& ACL_READ
) && !capable_cred(cr
, CAP_DAC_READ_SEARCH
))
412 if ((mode
& ACL_WRITE
) && !capable_cred(cr
, CAP_DAC_OVERRIDE
))
414 if ((mode
& ACL_EXECUTE
) && !capable_cred(cr
, CAP_DAC_OVERRIDE
))
421 * Note: cr is only used here for the capability check if the ACL test fails.
422 * It is not used to find out the credentials uid or groups etc, as was
423 * done in IRIX. It is assumed that the uid and groups for the current
424 * thread are taken from "current" instead of the cr parameter.
434 xfs_acl_entry_t matched
;
436 int maskallows
= -1; /* true, but not 1, either */
437 int seen_userobj
= 0;
439 matched
.ae_tag
= 0; /* Invalid type */
441 md
>>= 6; /* Normalize the bits for comparison */
443 for (i
= 0; i
< fap
->acl_cnt
; i
++) {
445 * Break out if we've got a user_obj entry or
446 * a user entry and the mask (and have processed USER_OBJ)
448 if (matched
.ae_tag
== ACL_USER_OBJ
)
450 if (matched
.ae_tag
== ACL_USER
) {
451 if (maskallows
!= -1 && seen_userobj
)
453 if (fap
->acl_entry
[i
].ae_tag
!= ACL_MASK
&&
454 fap
->acl_entry
[i
].ae_tag
!= ACL_USER_OBJ
)
457 /* True if this entry allows the requested access */
458 allows
= ((fap
->acl_entry
[i
].ae_perm
& md
) == md
);
460 switch (fap
->acl_entry
[i
].ae_tag
) {
463 if (fuid
!= current
->fsuid
)
465 matched
.ae_tag
= ACL_USER_OBJ
;
466 matched
.ae_perm
= allows
;
469 if (fap
->acl_entry
[i
].ae_id
!= current
->fsuid
)
471 matched
.ae_tag
= ACL_USER
;
472 matched
.ae_perm
= allows
;
475 if ((matched
.ae_tag
== ACL_GROUP_OBJ
||
476 matched
.ae_tag
== ACL_GROUP
) && !allows
)
478 if (!in_group_p(fgid
))
480 matched
.ae_tag
= ACL_GROUP_OBJ
;
481 matched
.ae_perm
= allows
;
484 if ((matched
.ae_tag
== ACL_GROUP_OBJ
||
485 matched
.ae_tag
== ACL_GROUP
) && !allows
)
487 if (!in_group_p(fap
->acl_entry
[i
].ae_id
))
489 matched
.ae_tag
= ACL_GROUP
;
490 matched
.ae_perm
= allows
;
496 if (matched
.ae_tag
!= 0)
498 matched
.ae_tag
= ACL_OTHER
;
499 matched
.ae_perm
= allows
;
504 * First possibility is that no matched entry allows access.
505 * The capability to override DAC may exist, so check for it.
507 switch (matched
.ae_tag
) {
516 if (maskallows
&& matched
.ae_perm
)
523 return xfs_acl_capability_check(md
, cr
);
527 * ACL validity checker.
528 * This acl validation routine checks each ACL entry read in makes sense.
534 xfs_acl_entry_t
*entry
, *e
;
535 int user
= 0, group
= 0, other
= 0, mask
= 0;
536 int mask_required
= 0;
542 if (aclp
->acl_cnt
> XFS_ACL_MAX_ENTRIES
)
545 for (i
= 0; i
< aclp
->acl_cnt
; i
++) {
546 entry
= &aclp
->acl_entry
[i
];
547 switch (entry
->ae_tag
) {
562 for (j
= i
+ 1; j
< aclp
->acl_cnt
; j
++) {
563 e
= &aclp
->acl_entry
[j
];
564 if (e
->ae_id
== entry
->ae_id
&&
565 e
->ae_tag
== entry
->ae_tag
)
578 if (!user
|| !group
|| !other
|| (mask_required
&& !mask
))
587 * Do ACL endian conversion.
593 xfs_acl_entry_t
*ace
, *end
;
595 INT_SET(aclp
->acl_cnt
, ARCH_CONVERT
, aclp
->acl_cnt
);
596 end
= &aclp
->acl_entry
[0]+aclp
->acl_cnt
;
597 for (ace
= &aclp
->acl_entry
[0]; ace
< end
; ace
++) {
598 INT_SET(ace
->ae_tag
, ARCH_CONVERT
, ace
->ae_tag
);
599 INT_SET(ace
->ae_id
, ARCH_CONVERT
, ace
->ae_id
);
600 INT_SET(ace
->ae_perm
, ARCH_CONVERT
, ace
->ae_perm
);
605 * Get the ACL from the EA and do endian conversion.
615 int len
= sizeof(xfs_acl_t
);
617 ASSERT((flags
& ATTR_KERNOVAL
) ? (aclp
== NULL
) : 1);
619 *error
= xfs_attr_get(xfs_vtoi(vp
),
620 kind
== _ACL_TYPE_ACCESS
?
621 SGI_ACL_FILE
: SGI_ACL_DEFAULT
,
622 (char *)aclp
, &len
, flags
, sys_cred
);
623 if (*error
|| (flags
& ATTR_KERNOVAL
))
625 xfs_acl_get_endian(aclp
);
629 * Set the EA with the ACL and do endian conversion.
638 xfs_acl_entry_t
*ace
, *newace
, *end
;
642 if (!(_ACL_ALLOC(newacl
))) {
647 len
= sizeof(xfs_acl_t
) -
648 (sizeof(xfs_acl_entry_t
) * (XFS_ACL_MAX_ENTRIES
- aclp
->acl_cnt
));
649 end
= &aclp
->acl_entry
[0]+aclp
->acl_cnt
;
650 for (ace
= &aclp
->acl_entry
[0], newace
= &newacl
->acl_entry
[0];
653 INT_SET(newace
->ae_tag
, ARCH_CONVERT
, ace
->ae_tag
);
654 INT_SET(newace
->ae_id
, ARCH_CONVERT
, ace
->ae_id
);
655 INT_SET(newace
->ae_perm
, ARCH_CONVERT
, ace
->ae_perm
);
657 INT_SET(newacl
->acl_cnt
, ARCH_CONVERT
, aclp
->acl_cnt
);
658 *error
= xfs_attr_set(xfs_vtoi(vp
),
659 kind
== _ACL_TYPE_ACCESS
?
660 SGI_ACL_FILE
: SGI_ACL_DEFAULT
,
661 (char *)newacl
, len
, ATTR_ROOT
);
668 xfs_acl_t
*access_acl
,
669 xfs_acl_t
*default_acl
)
676 * Get the Access ACL and the mode. If either cannot
677 * be obtained for some reason, invalidate the access ACL.
679 xfs_acl_get_attr(vp
, access_acl
, _ACL_TYPE_ACCESS
, 0, &error
);
681 /* Got the ACL, need the mode... */
682 va
.va_mask
= XFS_AT_MODE
;
683 error
= xfs_getattr(xfs_vtoi(vp
), &va
, 0);
687 access_acl
->acl_cnt
= XFS_ACL_NOT_PRESENT
;
688 else /* We have a good ACL and the file mode, synchronize. */
689 xfs_acl_sync_mode(va
.va_mode
, access_acl
);
693 xfs_acl_get_attr(vp
, default_acl
, _ACL_TYPE_DEFAULT
, 0, &error
);
695 default_acl
->acl_cnt
= XFS_ACL_NOT_PRESENT
;
701 * This function retrieves the parent directory's acl, processes it
702 * and lets the child inherit the acl(s) that it should.
715 * If the parent does not have a default ACL, or it's an
716 * invalid ACL, we're done.
720 if (!pdaclp
|| xfs_acl_invalid(pdaclp
))
724 * Copy the default ACL of the containing directory to
725 * the access ACL of the new file and use the mode that
726 * was passed in to set up the correct initial values for
727 * the u::,g::[m::], and o:: entries. This is what makes
728 * umask() "work" with ACL's.
731 if (!(_ACL_ALLOC(cacl
)))
734 memcpy(cacl
, pdaclp
, sizeof(xfs_acl_t
));
735 xfs_acl_filter_mode(mode
, cacl
);
736 xfs_acl_setmode(vp
, cacl
, &basicperms
);
739 * Set the Default and Access ACL on the file. The mode is already
740 * set on the file, so we don't need to worry about that.
742 * If the new file is a directory, its default ACL is a copy of
743 * the containing directory's default ACL.
746 xfs_acl_set_attr(vp
, pdaclp
, _ACL_TYPE_DEFAULT
, &error
);
747 if (!error
&& !basicperms
)
748 xfs_acl_set_attr(vp
, cacl
, _ACL_TYPE_ACCESS
, &error
);
754 * Set up the correct mode on the file based on the supplied ACL. This
755 * makes sure that the mode on the file reflects the state of the
756 * u::,g::[m::], and o:: entries in the ACL. Since the mode is where
757 * the ACL is going to get the permissions for these entries, we must
758 * synchronize the mode whenever we set the ACL on a file.
768 xfs_acl_entry_t
*gap
= NULL
;
769 int i
, error
, nomask
= 1;
773 if (acl
->acl_cnt
== XFS_ACL_NOT_PRESENT
)
777 * Copy the u::, g::, o::, and m:: bits from the ACL into the
778 * mode. The m:: bits take precedence over the g:: bits.
780 va
.va_mask
= XFS_AT_MODE
;
781 error
= xfs_getattr(xfs_vtoi(vp
), &va
, 0);
785 va
.va_mask
= XFS_AT_MODE
;
786 va
.va_mode
&= ~(S_IRWXU
|S_IRWXG
|S_IRWXO
);
788 for (i
= 0; i
< acl
->acl_cnt
; ++i
) {
789 switch (ap
->ae_tag
) {
791 va
.va_mode
|= ap
->ae_perm
<< 6;
796 case ACL_MASK
: /* more than just standard modes */
798 va
.va_mode
|= ap
->ae_perm
<< 3;
802 va
.va_mode
|= ap
->ae_perm
;
804 default: /* more than just standard modes */
811 /* Set the group bits from ACL_GROUP_OBJ if there's no ACL_MASK */
813 va
.va_mode
|= gap
->ae_perm
<< 3;
815 return xfs_setattr(xfs_vtoi(vp
), &va
, 0, sys_cred
);
819 * The permissions for the special ACL entries (u::, g::[m::], o::) are
820 * actually stored in the file mode (if there is both a group and a mask,
821 * the group is stored in the ACL entry and the mask is stored on the file).
822 * This allows the mode to remain automatically in sync with the ACL without
823 * the need for a call-back to the ACL system at every point where the mode
824 * could change. This function takes the permissions from the specified mode
825 * and places it in the supplied ACL.
827 * This implementation draws its validity from the fact that, when the ACL
828 * was assigned, the mode was copied from the ACL.
829 * If the mode did not change, therefore, the mode remains exactly what was
830 * taken from the special ACL entries at assignment.
831 * If a subsequent chmod() was done, the POSIX spec says that the change in
832 * mode must cause an update to the ACL seen at user level and used for
833 * access checks. Before and after a mode change, therefore, the file mode
834 * most accurately reflects what the special ACL entries should permit/deny.
836 * CAVEAT: If someone sets the SGI_ACL_FILE attribute directly,
837 * the existing mode bits will override whatever is in the
838 * ACL. Similarly, if there is a pre-existing ACL that was
839 * never in sync with its mode (owing to a bug in 6.5 and
840 * before), it will now magically (or mystically) be
841 * synchronized. This could cause slight astonishment, but
842 * it is better than inconsistent permissions.
844 * The supplied ACL is a template that may contain any combination
845 * of special entries. These are treated as place holders when we fill
846 * out the ACL. This routine does not add or remove special entries, it
847 * simply unites each special entry with its associated set of permissions.
856 xfs_acl_entry_t
*gap
= NULL
;
859 * Set ACL entries. POSIX1003.1eD16 requires that the MASK
860 * be set instead of the GROUP entry, if there is a MASK.
862 for (ap
= acl
->acl_entry
, i
= 0; i
< acl
->acl_cnt
; ap
++, i
++) {
863 switch (ap
->ae_tag
) {
865 ap
->ae_perm
= (mode
>> 6) & 0x7;
872 ap
->ae_perm
= (mode
>> 3) & 0x7;
875 ap
->ae_perm
= mode
& 0x7;
881 /* Set the ACL_GROUP_OBJ if there's no ACL_MASK */
883 gap
->ae_perm
= (mode
>> 3) & 0x7;
887 * When inheriting an Access ACL from a directory Default ACL,
888 * the ACL bits are set to the intersection of the ACL default
889 * permission bits and the file permission bits in mode. If there
890 * are no permission bits on the file then we must not give them
891 * the ACL. This is what what makes umask() work with ACLs.
900 xfs_acl_entry_t
*gap
= NULL
;
903 * Set ACL entries. POSIX1003.1eD16 requires that the MASK
904 * be merged with GROUP entry, if there is a MASK.
906 for (ap
= acl
->acl_entry
, i
= 0; i
< acl
->acl_cnt
; ap
++, i
++) {
907 switch (ap
->ae_tag
) {
909 ap
->ae_perm
&= (mode
>> 6) & 0x7;
916 ap
->ae_perm
&= (mode
>> 3) & 0x7;
919 ap
->ae_perm
&= mode
& 0x7;
925 /* Set the ACL_GROUP_OBJ if there's no ACL_MASK */
927 gap
->ae_perm
&= (mode
>> 3) & 0x7;