1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2002,2003 by Andreas Gruenbacher <a.gruenbacher@computer.org>
5 * Fixes from William Schumacher incorporated on 15 March 2001.
6 * (Reported by Charles Bertsch, <CBertsch@microtest.com>).
10 * This file contains generic functions for manipulating
11 * POSIX 1003.1e draft standard 17 ACLs.
14 #include <linux/kernel.h>
15 #include <linux/slab.h>
16 #include <linux/atomic.h>
18 #include <linux/sched.h>
19 #include <linux/cred.h>
20 #include <linux/posix_acl.h>
21 #include <linux/posix_acl_xattr.h>
22 #include <linux/xattr.h>
23 #include <linux/export.h>
24 #include <linux/user_namespace.h>
26 static struct posix_acl **acl_by_type(struct inode *inode, int type)
31 case ACL_TYPE_DEFAULT:
32 return &inode->i_default_acl;
38 struct posix_acl *get_cached_acl(struct inode *inode, int type)
40 struct posix_acl **p = acl_by_type(inode, type);
41 struct posix_acl *acl;
45 acl = rcu_dereference(*p);
46 if (!acl || is_uncached_acl(acl) ||
47 refcount_inc_not_zero(&acl->a_refcount))
55 EXPORT_SYMBOL(get_cached_acl);
57 struct posix_acl *get_cached_acl_rcu(struct inode *inode, int type)
59 return rcu_dereference(*acl_by_type(inode, type));
61 EXPORT_SYMBOL(get_cached_acl_rcu);
63 void set_cached_acl(struct inode *inode, int type, struct posix_acl *acl)
65 struct posix_acl **p = acl_by_type(inode, type);
66 struct posix_acl *old;
68 old = xchg(p, posix_acl_dup(acl));
69 if (!is_uncached_acl(old))
70 posix_acl_release(old);
72 EXPORT_SYMBOL(set_cached_acl);
74 static void __forget_cached_acl(struct posix_acl **p)
76 struct posix_acl *old;
78 old = xchg(p, ACL_NOT_CACHED);
79 if (!is_uncached_acl(old))
80 posix_acl_release(old);
83 void forget_cached_acl(struct inode *inode, int type)
85 __forget_cached_acl(acl_by_type(inode, type));
87 EXPORT_SYMBOL(forget_cached_acl);
89 void forget_all_cached_acls(struct inode *inode)
91 __forget_cached_acl(&inode->i_acl);
92 __forget_cached_acl(&inode->i_default_acl);
94 EXPORT_SYMBOL(forget_all_cached_acls);
96 struct posix_acl *get_acl(struct inode *inode, int type)
100 struct posix_acl *acl;
103 * The sentinel is used to detect when another operation like
104 * set_cached_acl() or forget_cached_acl() races with get_acl().
105 * It is guaranteed that is_uncached_acl(sentinel) is true.
108 acl = get_cached_acl(inode, type);
109 if (!is_uncached_acl(acl))
112 if (!IS_POSIXACL(inode))
115 sentinel = uncached_acl_sentinel(current);
116 p = acl_by_type(inode, type);
119 * If the ACL isn't being read yet, set our sentinel. Otherwise, the
120 * current value of the ACL will not be ACL_NOT_CACHED and so our own
121 * sentinel will not be set; another task will update the cache. We
122 * could wait for that other task to complete its job, but it's easier
123 * to just call ->get_acl to fetch the ACL ourself. (This is going to
124 * be an unlikely race.)
126 if (cmpxchg(p, ACL_NOT_CACHED, sentinel) != ACL_NOT_CACHED)
130 * Normally, the ACL returned by ->get_acl will be cached.
131 * A filesystem can prevent that by calling
132 * forget_cached_acl(inode, type) in ->get_acl.
134 * If the filesystem doesn't have a get_acl() function at all, we'll
135 * just create the negative cache entry.
137 if (!inode->i_op->get_acl) {
138 set_cached_acl(inode, type, NULL);
141 acl = inode->i_op->get_acl(inode, type);
145 * Remove our sentinel so that we don't block future attempts
148 cmpxchg(p, sentinel, ACL_NOT_CACHED);
153 * Cache the result, but only if our sentinel is still in place.
156 if (unlikely(cmpxchg(p, sentinel, acl) != sentinel))
157 posix_acl_release(acl);
160 EXPORT_SYMBOL(get_acl);
163 * Init a fresh posix_acl
166 posix_acl_init(struct posix_acl *acl, int count)
168 refcount_set(&acl->a_refcount, 1);
169 acl->a_count = count;
171 EXPORT_SYMBOL(posix_acl_init);
174 * Allocate a new ACL with the specified number of entries.
177 posix_acl_alloc(int count, gfp_t flags)
179 const size_t size = sizeof(struct posix_acl) +
180 count * sizeof(struct posix_acl_entry);
181 struct posix_acl *acl = kmalloc(size, flags);
183 posix_acl_init(acl, count);
186 EXPORT_SYMBOL(posix_acl_alloc);
191 static struct posix_acl *
192 posix_acl_clone(const struct posix_acl *acl, gfp_t flags)
194 struct posix_acl *clone = NULL;
197 int size = sizeof(struct posix_acl) + acl->a_count *
198 sizeof(struct posix_acl_entry);
199 clone = kmemdup(acl, size, flags);
201 refcount_set(&clone->a_refcount, 1);
207 * Check if an acl is valid. Returns 0 if it is, or -E... otherwise.
210 posix_acl_valid(struct user_namespace *user_ns, const struct posix_acl *acl)
212 const struct posix_acl_entry *pa, *pe;
213 int state = ACL_USER_OBJ;
216 FOREACH_ACL_ENTRY(pa, acl, pe) {
217 if (pa->e_perm & ~(ACL_READ|ACL_WRITE|ACL_EXECUTE))
221 if (state == ACL_USER_OBJ) {
228 if (state != ACL_USER)
230 if (!kuid_has_mapping(user_ns, pa->e_uid))
236 if (state == ACL_USER) {
243 if (state != ACL_GROUP)
245 if (!kgid_has_mapping(user_ns, pa->e_gid))
251 if (state != ACL_GROUP)
257 if (state == ACL_OTHER ||
258 (state == ACL_GROUP && !needs_mask)) {
272 EXPORT_SYMBOL(posix_acl_valid);
275 * Returns 0 if the acl can be exactly represented in the traditional
276 * file mode permission bits, or else 1. Returns -E... on error.
279 posix_acl_equiv_mode(const struct posix_acl *acl, umode_t *mode_p)
281 const struct posix_acl_entry *pa, *pe;
286 * A null ACL can always be presented as mode bits.
291 FOREACH_ACL_ENTRY(pa, acl, pe) {
294 mode |= (pa->e_perm & S_IRWXO) << 6;
297 mode |= (pa->e_perm & S_IRWXO) << 3;
300 mode |= pa->e_perm & S_IRWXO;
303 mode = (mode & ~S_IRWXG) |
304 ((pa->e_perm & S_IRWXO) << 3);
316 *mode_p = (*mode_p & ~S_IRWXUGO) | mode;
319 EXPORT_SYMBOL(posix_acl_equiv_mode);
322 * Create an ACL representing the file mode permission bits of an inode.
325 posix_acl_from_mode(umode_t mode, gfp_t flags)
327 struct posix_acl *acl = posix_acl_alloc(3, flags);
329 return ERR_PTR(-ENOMEM);
331 acl->a_entries[0].e_tag = ACL_USER_OBJ;
332 acl->a_entries[0].e_perm = (mode & S_IRWXU) >> 6;
334 acl->a_entries[1].e_tag = ACL_GROUP_OBJ;
335 acl->a_entries[1].e_perm = (mode & S_IRWXG) >> 3;
337 acl->a_entries[2].e_tag = ACL_OTHER;
338 acl->a_entries[2].e_perm = (mode & S_IRWXO);
341 EXPORT_SYMBOL(posix_acl_from_mode);
344 * Return 0 if current is granted want access to the inode
345 * by the acl. Returns -E... otherwise.
348 posix_acl_permission(struct inode *inode, const struct posix_acl *acl, int want)
350 const struct posix_acl_entry *pa, *pe, *mask_obj;
353 want &= MAY_READ | MAY_WRITE | MAY_EXEC;
355 FOREACH_ACL_ENTRY(pa, acl, pe) {
358 /* (May have been checked already) */
359 if (uid_eq(inode->i_uid, current_fsuid()))
363 if (uid_eq(pa->e_uid, current_fsuid()))
367 if (in_group_p(inode->i_gid)) {
369 if ((pa->e_perm & want) == want)
374 if (in_group_p(pa->e_gid)) {
376 if ((pa->e_perm & want) == want)
394 for (mask_obj = pa+1; mask_obj != pe; mask_obj++) {
395 if (mask_obj->e_tag == ACL_MASK) {
396 if ((pa->e_perm & mask_obj->e_perm & want) == want)
403 if ((pa->e_perm & want) == want)
409 * Modify acl when creating a new inode. The caller must ensure the acl is
410 * only referenced once.
412 * mode_p initially must contain the mode parameter to the open() / creat()
413 * system calls. All permissions that are not granted by the acl are removed.
414 * The permissions in the acl are changed to reflect the mode_p parameter.
416 static int posix_acl_create_masq(struct posix_acl *acl, umode_t *mode_p)
418 struct posix_acl_entry *pa, *pe;
419 struct posix_acl_entry *group_obj = NULL, *mask_obj = NULL;
420 umode_t mode = *mode_p;
423 /* assert(atomic_read(acl->a_refcount) == 1); */
425 FOREACH_ACL_ENTRY(pa, acl, pe) {
428 pa->e_perm &= (mode >> 6) | ~S_IRWXO;
429 mode &= (pa->e_perm << 6) | ~S_IRWXU;
442 pa->e_perm &= mode | ~S_IRWXO;
443 mode &= pa->e_perm | ~S_IRWXO;
457 mask_obj->e_perm &= (mode >> 3) | ~S_IRWXO;
458 mode &= (mask_obj->e_perm << 3) | ~S_IRWXG;
462 group_obj->e_perm &= (mode >> 3) | ~S_IRWXO;
463 mode &= (group_obj->e_perm << 3) | ~S_IRWXG;
466 *mode_p = (*mode_p & ~S_IRWXUGO) | mode;
471 * Modify the ACL for the chmod syscall.
473 static int __posix_acl_chmod_masq(struct posix_acl *acl, umode_t mode)
475 struct posix_acl_entry *group_obj = NULL, *mask_obj = NULL;
476 struct posix_acl_entry *pa, *pe;
478 /* assert(atomic_read(acl->a_refcount) == 1); */
480 FOREACH_ACL_ENTRY(pa, acl, pe) {
483 pa->e_perm = (mode & S_IRWXU) >> 6;
499 pa->e_perm = (mode & S_IRWXO);
508 mask_obj->e_perm = (mode & S_IRWXG) >> 3;
512 group_obj->e_perm = (mode & S_IRWXG) >> 3;
519 __posix_acl_create(struct posix_acl **acl, gfp_t gfp, umode_t *mode_p)
521 struct posix_acl *clone = posix_acl_clone(*acl, gfp);
524 err = posix_acl_create_masq(clone, mode_p);
526 posix_acl_release(clone);
530 posix_acl_release(*acl);
534 EXPORT_SYMBOL(__posix_acl_create);
537 __posix_acl_chmod(struct posix_acl **acl, gfp_t gfp, umode_t mode)
539 struct posix_acl *clone = posix_acl_clone(*acl, gfp);
542 err = __posix_acl_chmod_masq(clone, mode);
544 posix_acl_release(clone);
548 posix_acl_release(*acl);
552 EXPORT_SYMBOL(__posix_acl_chmod);
555 posix_acl_chmod(struct inode *inode, umode_t mode)
557 struct posix_acl *acl;
560 if (!IS_POSIXACL(inode))
562 if (!inode->i_op->set_acl)
565 acl = get_acl(inode, ACL_TYPE_ACCESS);
566 if (IS_ERR_OR_NULL(acl)) {
567 if (acl == ERR_PTR(-EOPNOTSUPP))
572 ret = __posix_acl_chmod(&acl, GFP_KERNEL, mode);
575 ret = inode->i_op->set_acl(inode, acl, ACL_TYPE_ACCESS);
576 posix_acl_release(acl);
579 EXPORT_SYMBOL(posix_acl_chmod);
582 posix_acl_create(struct inode *dir, umode_t *mode,
583 struct posix_acl **default_acl, struct posix_acl **acl)
586 struct posix_acl *clone;
592 if (S_ISLNK(*mode) || !IS_POSIXACL(dir))
595 p = get_acl(dir, ACL_TYPE_DEFAULT);
596 if (!p || p == ERR_PTR(-EOPNOTSUPP)) {
597 *mode &= ~current_umask();
604 clone = posix_acl_clone(p, GFP_NOFS);
608 ret = posix_acl_create_masq(clone, mode);
610 goto err_release_clone;
613 posix_acl_release(clone);
618 posix_acl_release(p);
625 posix_acl_release(clone);
627 posix_acl_release(p);
630 EXPORT_SYMBOL_GPL(posix_acl_create);
633 * posix_acl_update_mode - update mode in set_acl
634 * @inode: target inode
635 * @mode_p: mode (pointer) for update
638 * Update the file mode when setting an ACL: compute the new file permission
639 * bits based on the ACL. In addition, if the ACL is equivalent to the new
640 * file mode, set *@acl to NULL to indicate that no ACL should be set.
642 * As with chmod, clear the setgid bit if the caller is not in the owning group
643 * or capable of CAP_FSETID (see inode_change_ok).
645 * Called from set_acl inode operations.
647 int posix_acl_update_mode(struct inode *inode, umode_t *mode_p,
648 struct posix_acl **acl)
650 umode_t mode = inode->i_mode;
653 error = posix_acl_equiv_mode(*acl, &mode);
658 if (!in_group_p(inode->i_gid) &&
659 !capable_wrt_inode_uidgid(inode, CAP_FSETID))
664 EXPORT_SYMBOL(posix_acl_update_mode);
667 * Fix up the uids and gids in posix acl extended attributes in place.
669 static void posix_acl_fix_xattr_userns(
670 struct user_namespace *to, struct user_namespace *from,
671 void *value, size_t size)
673 struct posix_acl_xattr_header *header = value;
674 struct posix_acl_xattr_entry *entry = (void *)(header + 1), *end;
681 if (size < sizeof(struct posix_acl_xattr_header))
683 if (header->a_version != cpu_to_le32(POSIX_ACL_XATTR_VERSION))
686 count = posix_acl_xattr_count(size);
692 for (end = entry + count; entry != end; entry++) {
693 switch(le16_to_cpu(entry->e_tag)) {
695 uid = make_kuid(from, le32_to_cpu(entry->e_id));
696 entry->e_id = cpu_to_le32(from_kuid(to, uid));
699 gid = make_kgid(from, le32_to_cpu(entry->e_id));
700 entry->e_id = cpu_to_le32(from_kgid(to, gid));
708 void posix_acl_fix_xattr_from_user(void *value, size_t size)
710 struct user_namespace *user_ns = current_user_ns();
711 if (user_ns == &init_user_ns)
713 posix_acl_fix_xattr_userns(&init_user_ns, user_ns, value, size);
716 void posix_acl_fix_xattr_to_user(void *value, size_t size)
718 struct user_namespace *user_ns = current_user_ns();
719 if (user_ns == &init_user_ns)
721 posix_acl_fix_xattr_userns(user_ns, &init_user_ns, value, size);
725 * Convert from extended attribute to in-memory representation.
728 posix_acl_from_xattr(struct user_namespace *user_ns,
729 const void *value, size_t size)
731 const struct posix_acl_xattr_header *header = value;
732 const struct posix_acl_xattr_entry *entry = (const void *)(header + 1), *end;
734 struct posix_acl *acl;
735 struct posix_acl_entry *acl_e;
739 if (size < sizeof(struct posix_acl_xattr_header))
740 return ERR_PTR(-EINVAL);
741 if (header->a_version != cpu_to_le32(POSIX_ACL_XATTR_VERSION))
742 return ERR_PTR(-EOPNOTSUPP);
744 count = posix_acl_xattr_count(size);
746 return ERR_PTR(-EINVAL);
750 acl = posix_acl_alloc(count, GFP_NOFS);
752 return ERR_PTR(-ENOMEM);
753 acl_e = acl->a_entries;
755 for (end = entry + count; entry != end; acl_e++, entry++) {
756 acl_e->e_tag = le16_to_cpu(entry->e_tag);
757 acl_e->e_perm = le16_to_cpu(entry->e_perm);
759 switch(acl_e->e_tag) {
769 le32_to_cpu(entry->e_id));
770 if (!uid_valid(acl_e->e_uid))
776 le32_to_cpu(entry->e_id));
777 if (!gid_valid(acl_e->e_gid))
788 posix_acl_release(acl);
789 return ERR_PTR(-EINVAL);
791 EXPORT_SYMBOL (posix_acl_from_xattr);
794 * Convert from in-memory to extended attribute representation.
797 posix_acl_to_xattr(struct user_namespace *user_ns, const struct posix_acl *acl,
798 void *buffer, size_t size)
800 struct posix_acl_xattr_header *ext_acl = buffer;
801 struct posix_acl_xattr_entry *ext_entry;
804 real_size = posix_acl_xattr_size(acl->a_count);
807 if (real_size > size)
810 ext_entry = (void *)(ext_acl + 1);
811 ext_acl->a_version = cpu_to_le32(POSIX_ACL_XATTR_VERSION);
813 for (n=0; n < acl->a_count; n++, ext_entry++) {
814 const struct posix_acl_entry *acl_e = &acl->a_entries[n];
815 ext_entry->e_tag = cpu_to_le16(acl_e->e_tag);
816 ext_entry->e_perm = cpu_to_le16(acl_e->e_perm);
817 switch(acl_e->e_tag) {
820 cpu_to_le32(from_kuid(user_ns, acl_e->e_uid));
824 cpu_to_le32(from_kgid(user_ns, acl_e->e_gid));
827 ext_entry->e_id = cpu_to_le32(ACL_UNDEFINED_ID);
833 EXPORT_SYMBOL (posix_acl_to_xattr);
836 posix_acl_xattr_get(const struct xattr_handler *handler,
837 struct dentry *unused, struct inode *inode,
838 const char *name, void *value, size_t size)
840 struct posix_acl *acl;
843 if (!IS_POSIXACL(inode))
845 if (S_ISLNK(inode->i_mode))
848 acl = get_acl(inode, handler->flags);
854 error = posix_acl_to_xattr(&init_user_ns, acl, value, size);
855 posix_acl_release(acl);
861 set_posix_acl(struct inode *inode, int type, struct posix_acl *acl)
863 if (!IS_POSIXACL(inode))
865 if (!inode->i_op->set_acl)
868 if (type == ACL_TYPE_DEFAULT && !S_ISDIR(inode->i_mode))
869 return acl ? -EACCES : 0;
870 if (!inode_owner_or_capable(inode))
874 int ret = posix_acl_valid(inode->i_sb->s_user_ns, acl);
878 return inode->i_op->set_acl(inode, acl, type);
880 EXPORT_SYMBOL(set_posix_acl);
883 posix_acl_xattr_set(const struct xattr_handler *handler,
884 struct dentry *unused, struct inode *inode,
885 const char *name, const void *value,
886 size_t size, int flags)
888 struct posix_acl *acl = NULL;
892 acl = posix_acl_from_xattr(&init_user_ns, value, size);
896 ret = set_posix_acl(inode, handler->flags, acl);
897 posix_acl_release(acl);
902 posix_acl_xattr_list(struct dentry *dentry)
904 return IS_POSIXACL(d_backing_inode(dentry));
907 const struct xattr_handler posix_acl_access_xattr_handler = {
908 .name = XATTR_NAME_POSIX_ACL_ACCESS,
909 .flags = ACL_TYPE_ACCESS,
910 .list = posix_acl_xattr_list,
911 .get = posix_acl_xattr_get,
912 .set = posix_acl_xattr_set,
914 EXPORT_SYMBOL_GPL(posix_acl_access_xattr_handler);
916 const struct xattr_handler posix_acl_default_xattr_handler = {
917 .name = XATTR_NAME_POSIX_ACL_DEFAULT,
918 .flags = ACL_TYPE_DEFAULT,
919 .list = posix_acl_xattr_list,
920 .get = posix_acl_xattr_get,
921 .set = posix_acl_xattr_set,
923 EXPORT_SYMBOL_GPL(posix_acl_default_xattr_handler);
925 int simple_set_acl(struct inode *inode, struct posix_acl *acl, int type)
929 if (type == ACL_TYPE_ACCESS) {
930 error = posix_acl_update_mode(inode,
931 &inode->i_mode, &acl);
936 inode->i_ctime = current_time(inode);
937 set_cached_acl(inode, type, acl);
941 int simple_acl_create(struct inode *dir, struct inode *inode)
943 struct posix_acl *default_acl, *acl;
946 error = posix_acl_create(dir, &inode->i_mode, &default_acl, &acl);
950 set_cached_acl(inode, ACL_TYPE_DEFAULT, default_acl);
951 set_cached_acl(inode, ACL_TYPE_ACCESS, acl);
954 posix_acl_release(default_acl);
956 posix_acl_release(acl);