4 * Fixes from William Schumacher incorporated on 15 March 2001.
9 * This file contains generic functions for manipulating
10 * POSIX 1003.1e draft standard 17 ACLs.
13 #include <linux/kernel.h>
14 #include <linux/slab.h>
15 #include <linux/atomic.h>
17 #include <linux/sched.h>
18 #include <linux/posix_acl.h>
19 #include <linux/posix_acl_xattr.h>
20 #include <linux/xattr.h>
21 #include <linux/export.h>
22 #include <linux/user_namespace.h>
24 EXPORT_SYMBOL(posix_acl_init);
25 EXPORT_SYMBOL(posix_acl_alloc);
26 EXPORT_SYMBOL(posix_acl_valid);
27 EXPORT_SYMBOL(posix_acl_equiv_mode);
28 EXPORT_SYMBOL(posix_acl_from_mode);
30 struct posix_acl *get_acl(struct inode *inode, int type)
32 struct posix_acl *acl;
34 acl = get_cached_acl(inode, type);
35 if (acl != ACL_NOT_CACHED)
38 if (!IS_POSIXACL(inode))
42 * A filesystem can force a ACL callback by just never filling the
43 * ACL cache. But normally you'd fill the cache either at inode
44 * instantiation time, or on the first ->get_acl call.
46 * If the filesystem doesn't have a get_acl() function at all, we'll
47 * just create the negative cache entry.
49 if (!inode->i_op->get_acl) {
50 set_cached_acl(inode, type, NULL);
53 return inode->i_op->get_acl(inode, type);
55 EXPORT_SYMBOL(get_acl);
58 * Init a fresh posix_acl
61 posix_acl_init(struct posix_acl *acl, int count)
63 atomic_set(&acl->a_refcount, 1);
68 * Allocate a new ACL with the specified number of entries.
71 posix_acl_alloc(int count, gfp_t flags)
73 const size_t size = sizeof(struct posix_acl) +
74 count * sizeof(struct posix_acl_entry);
75 struct posix_acl *acl = kmalloc(size, flags);
77 posix_acl_init(acl, count);
84 static struct posix_acl *
85 posix_acl_clone(const struct posix_acl *acl, gfp_t flags)
87 struct posix_acl *clone = NULL;
90 int size = sizeof(struct posix_acl) + acl->a_count *
91 sizeof(struct posix_acl_entry);
92 clone = kmemdup(acl, size, flags);
94 atomic_set(&clone->a_refcount, 1);
100 * Check if an acl is valid. Returns 0 if it is, or -E... otherwise.
103 posix_acl_valid(const struct posix_acl *acl)
105 const struct posix_acl_entry *pa, *pe;
106 int state = ACL_USER_OBJ;
107 kuid_t prev_uid = INVALID_UID;
108 kgid_t prev_gid = INVALID_GID;
111 FOREACH_ACL_ENTRY(pa, acl, pe) {
112 if (pa->e_perm & ~(ACL_READ|ACL_WRITE|ACL_EXECUTE))
116 if (state == ACL_USER_OBJ) {
123 if (state != ACL_USER)
125 if (!uid_valid(pa->e_uid))
127 if (uid_valid(prev_uid) &&
128 uid_lte(pa->e_uid, prev_uid))
130 prev_uid = pa->e_uid;
135 if (state == ACL_USER) {
142 if (state != ACL_GROUP)
144 if (!gid_valid(pa->e_gid))
146 if (gid_valid(prev_gid) &&
147 gid_lte(pa->e_gid, prev_gid))
149 prev_gid = pa->e_gid;
154 if (state != ACL_GROUP)
160 if (state == ACL_OTHER ||
161 (state == ACL_GROUP && !needs_mask)) {
177 * Returns 0 if the acl can be exactly represented in the traditional
178 * file mode permission bits, or else 1. Returns -E... on error.
181 posix_acl_equiv_mode(const struct posix_acl *acl, umode_t *mode_p)
183 const struct posix_acl_entry *pa, *pe;
187 FOREACH_ACL_ENTRY(pa, acl, pe) {
190 mode |= (pa->e_perm & S_IRWXO) << 6;
193 mode |= (pa->e_perm & S_IRWXO) << 3;
196 mode |= pa->e_perm & S_IRWXO;
199 mode = (mode & ~S_IRWXG) |
200 ((pa->e_perm & S_IRWXO) << 3);
212 *mode_p = (*mode_p & ~S_IRWXUGO) | mode;
217 * Create an ACL representing the file mode permission bits of an inode.
220 posix_acl_from_mode(umode_t mode, gfp_t flags)
222 struct posix_acl *acl = posix_acl_alloc(3, flags);
224 return ERR_PTR(-ENOMEM);
226 acl->a_entries[0].e_tag = ACL_USER_OBJ;
227 acl->a_entries[0].e_perm = (mode & S_IRWXU) >> 6;
229 acl->a_entries[1].e_tag = ACL_GROUP_OBJ;
230 acl->a_entries[1].e_perm = (mode & S_IRWXG) >> 3;
232 acl->a_entries[2].e_tag = ACL_OTHER;
233 acl->a_entries[2].e_perm = (mode & S_IRWXO);
238 * Return 0 if current is granted want access to the inode
239 * by the acl. Returns -E... otherwise.
242 posix_acl_permission(struct inode *inode, const struct posix_acl *acl, int want)
244 const struct posix_acl_entry *pa, *pe, *mask_obj;
247 want &= MAY_READ | MAY_WRITE | MAY_EXEC | MAY_NOT_BLOCK;
249 FOREACH_ACL_ENTRY(pa, acl, pe) {
252 /* (May have been checked already) */
253 if (uid_eq(inode->i_uid, current_fsuid()))
257 if (uid_eq(pa->e_uid, current_fsuid()))
261 if (in_group_p(inode->i_gid)) {
263 if ((pa->e_perm & want) == want)
268 if (in_group_p(pa->e_gid)) {
270 if ((pa->e_perm & want) == want)
288 for (mask_obj = pa+1; mask_obj != pe; mask_obj++) {
289 if (mask_obj->e_tag == ACL_MASK) {
290 if ((pa->e_perm & mask_obj->e_perm & want) == want)
297 if ((pa->e_perm & want) == want)
303 * Modify acl when creating a new inode. The caller must ensure the acl is
304 * only referenced once.
306 * mode_p initially must contain the mode parameter to the open() / creat()
307 * system calls. All permissions that are not granted by the acl are removed.
308 * The permissions in the acl are changed to reflect the mode_p parameter.
310 static int posix_acl_create_masq(struct posix_acl *acl, umode_t *mode_p)
312 struct posix_acl_entry *pa, *pe;
313 struct posix_acl_entry *group_obj = NULL, *mask_obj = NULL;
314 umode_t mode = *mode_p;
317 /* assert(atomic_read(acl->a_refcount) == 1); */
319 FOREACH_ACL_ENTRY(pa, acl, pe) {
322 pa->e_perm &= (mode >> 6) | ~S_IRWXO;
323 mode &= (pa->e_perm << 6) | ~S_IRWXU;
336 pa->e_perm &= mode | ~S_IRWXO;
337 mode &= pa->e_perm | ~S_IRWXO;
351 mask_obj->e_perm &= (mode >> 3) | ~S_IRWXO;
352 mode &= (mask_obj->e_perm << 3) | ~S_IRWXG;
356 group_obj->e_perm &= (mode >> 3) | ~S_IRWXO;
357 mode &= (group_obj->e_perm << 3) | ~S_IRWXG;
360 *mode_p = (*mode_p & ~S_IRWXUGO) | mode;
365 * Modify the ACL for the chmod syscall.
367 static int __posix_acl_chmod_masq(struct posix_acl *acl, umode_t mode)
369 struct posix_acl_entry *group_obj = NULL, *mask_obj = NULL;
370 struct posix_acl_entry *pa, *pe;
372 /* assert(atomic_read(acl->a_refcount) == 1); */
374 FOREACH_ACL_ENTRY(pa, acl, pe) {
377 pa->e_perm = (mode & S_IRWXU) >> 6;
393 pa->e_perm = (mode & S_IRWXO);
402 mask_obj->e_perm = (mode & S_IRWXG) >> 3;
406 group_obj->e_perm = (mode & S_IRWXG) >> 3;
413 __posix_acl_create(struct posix_acl **acl, gfp_t gfp, umode_t *mode_p)
415 struct posix_acl *clone = posix_acl_clone(*acl, gfp);
418 err = posix_acl_create_masq(clone, mode_p);
420 posix_acl_release(clone);
424 posix_acl_release(*acl);
428 EXPORT_SYMBOL(__posix_acl_create);
431 __posix_acl_chmod(struct posix_acl **acl, gfp_t gfp, umode_t mode)
433 struct posix_acl *clone = posix_acl_clone(*acl, gfp);
436 err = __posix_acl_chmod_masq(clone, mode);
438 posix_acl_release(clone);
442 posix_acl_release(*acl);
446 EXPORT_SYMBOL(__posix_acl_chmod);
449 posix_acl_chmod(struct inode *inode, umode_t mode)
451 struct posix_acl *acl;
454 if (!IS_POSIXACL(inode))
456 if (!inode->i_op->set_acl)
459 acl = get_acl(inode, ACL_TYPE_ACCESS);
460 if (IS_ERR_OR_NULL(acl))
463 ret = __posix_acl_chmod(&acl, GFP_KERNEL, mode);
466 ret = inode->i_op->set_acl(inode, acl, ACL_TYPE_ACCESS);
467 posix_acl_release(acl);
470 EXPORT_SYMBOL(posix_acl_chmod);
473 posix_acl_create(struct inode *dir, umode_t *mode,
474 struct posix_acl **default_acl, struct posix_acl **acl)
479 if (S_ISLNK(*mode) || !IS_POSIXACL(dir))
482 p = get_acl(dir, ACL_TYPE_DEFAULT);
487 *mode &= ~current_umask();
491 *acl = posix_acl_clone(p, GFP_NOFS);
495 ret = posix_acl_create_masq(*acl, mode);
497 posix_acl_release(*acl);
502 posix_acl_release(*acl);
506 if (!S_ISDIR(*mode)) {
507 posix_acl_release(p);
519 EXPORT_SYMBOL_GPL(posix_acl_create);
522 * Fix up the uids and gids in posix acl extended attributes in place.
524 static void posix_acl_fix_xattr_userns(
525 struct user_namespace *to, struct user_namespace *from,
526 void *value, size_t size)
528 posix_acl_xattr_header *header = (posix_acl_xattr_header *)value;
529 posix_acl_xattr_entry *entry = (posix_acl_xattr_entry *)(header+1), *end;
536 if (size < sizeof(posix_acl_xattr_header))
538 if (header->a_version != cpu_to_le32(POSIX_ACL_XATTR_VERSION))
541 count = posix_acl_xattr_count(size);
547 for (end = entry + count; entry != end; entry++) {
548 switch(le16_to_cpu(entry->e_tag)) {
550 uid = make_kuid(from, le32_to_cpu(entry->e_id));
551 entry->e_id = cpu_to_le32(from_kuid(to, uid));
554 gid = make_kgid(from, le32_to_cpu(entry->e_id));
555 entry->e_id = cpu_to_le32(from_kgid(to, gid));
563 void posix_acl_fix_xattr_from_user(void *value, size_t size)
565 struct user_namespace *user_ns = current_user_ns();
566 if (user_ns == &init_user_ns)
568 posix_acl_fix_xattr_userns(&init_user_ns, user_ns, value, size);
571 void posix_acl_fix_xattr_to_user(void *value, size_t size)
573 struct user_namespace *user_ns = current_user_ns();
574 if (user_ns == &init_user_ns)
576 posix_acl_fix_xattr_userns(user_ns, &init_user_ns, value, size);
580 * Convert from extended attribute to in-memory representation.
583 posix_acl_from_xattr(struct user_namespace *user_ns,
584 const void *value, size_t size)
586 posix_acl_xattr_header *header = (posix_acl_xattr_header *)value;
587 posix_acl_xattr_entry *entry = (posix_acl_xattr_entry *)(header+1), *end;
589 struct posix_acl *acl;
590 struct posix_acl_entry *acl_e;
594 if (size < sizeof(posix_acl_xattr_header))
595 return ERR_PTR(-EINVAL);
596 if (header->a_version != cpu_to_le32(POSIX_ACL_XATTR_VERSION))
597 return ERR_PTR(-EOPNOTSUPP);
599 count = posix_acl_xattr_count(size);
601 return ERR_PTR(-EINVAL);
605 acl = posix_acl_alloc(count, GFP_NOFS);
607 return ERR_PTR(-ENOMEM);
608 acl_e = acl->a_entries;
610 for (end = entry + count; entry != end; acl_e++, entry++) {
611 acl_e->e_tag = le16_to_cpu(entry->e_tag);
612 acl_e->e_perm = le16_to_cpu(entry->e_perm);
614 switch(acl_e->e_tag) {
624 le32_to_cpu(entry->e_id));
625 if (!uid_valid(acl_e->e_uid))
631 le32_to_cpu(entry->e_id));
632 if (!gid_valid(acl_e->e_gid))
643 posix_acl_release(acl);
644 return ERR_PTR(-EINVAL);
646 EXPORT_SYMBOL (posix_acl_from_xattr);
649 * Convert from in-memory to extended attribute representation.
652 posix_acl_to_xattr(struct user_namespace *user_ns, const struct posix_acl *acl,
653 void *buffer, size_t size)
655 posix_acl_xattr_header *ext_acl = (posix_acl_xattr_header *)buffer;
656 posix_acl_xattr_entry *ext_entry = ext_acl->a_entries;
659 real_size = posix_acl_xattr_size(acl->a_count);
662 if (real_size > size)
665 ext_acl->a_version = cpu_to_le32(POSIX_ACL_XATTR_VERSION);
667 for (n=0; n < acl->a_count; n++, ext_entry++) {
668 const struct posix_acl_entry *acl_e = &acl->a_entries[n];
669 ext_entry->e_tag = cpu_to_le16(acl_e->e_tag);
670 ext_entry->e_perm = cpu_to_le16(acl_e->e_perm);
671 switch(acl_e->e_tag) {
674 cpu_to_le32(from_kuid(user_ns, acl_e->e_uid));
678 cpu_to_le32(from_kgid(user_ns, acl_e->e_gid));
681 ext_entry->e_id = cpu_to_le32(ACL_UNDEFINED_ID);
687 EXPORT_SYMBOL (posix_acl_to_xattr);
690 posix_acl_xattr_get(struct dentry *dentry, const char *name,
691 void *value, size_t size, int type)
693 struct posix_acl *acl;
696 if (!IS_POSIXACL(dentry->d_inode))
698 if (S_ISLNK(dentry->d_inode->i_mode))
701 acl = get_acl(dentry->d_inode, type);
707 error = posix_acl_to_xattr(&init_user_ns, acl, value, size);
708 posix_acl_release(acl);
714 posix_acl_xattr_set(struct dentry *dentry, const char *name,
715 const void *value, size_t size, int flags, int type)
717 struct inode *inode = dentry->d_inode;
718 struct posix_acl *acl = NULL;
721 if (!IS_POSIXACL(inode))
723 if (!inode->i_op->set_acl)
726 if (type == ACL_TYPE_DEFAULT && !S_ISDIR(inode->i_mode))
727 return value ? -EACCES : 0;
728 if (!inode_owner_or_capable(inode))
732 acl = posix_acl_from_xattr(&init_user_ns, value, size);
737 ret = posix_acl_valid(acl);
743 ret = inode->i_op->set_acl(inode, acl, type);
745 posix_acl_release(acl);
750 posix_acl_xattr_list(struct dentry *dentry, char *list, size_t list_size,
751 const char *name, size_t name_len, int type)
756 if (!IS_POSIXACL(dentry->d_inode))
758 if (S_ISLNK(dentry->d_inode->i_mode))
761 if (type == ACL_TYPE_ACCESS)
762 xname = POSIX_ACL_XATTR_ACCESS;
764 xname = POSIX_ACL_XATTR_DEFAULT;
766 size = strlen(xname) + 1;
767 if (list && size <= list_size)
768 memcpy(list, xname, size);
772 const struct xattr_handler posix_acl_access_xattr_handler = {
773 .prefix = POSIX_ACL_XATTR_ACCESS,
774 .flags = ACL_TYPE_ACCESS,
775 .list = posix_acl_xattr_list,
776 .get = posix_acl_xattr_get,
777 .set = posix_acl_xattr_set,
779 EXPORT_SYMBOL_GPL(posix_acl_access_xattr_handler);
781 const struct xattr_handler posix_acl_default_xattr_handler = {
782 .prefix = POSIX_ACL_XATTR_DEFAULT,
783 .flags = ACL_TYPE_DEFAULT,
784 .list = posix_acl_xattr_list,
785 .get = posix_acl_xattr_get,
786 .set = posix_acl_xattr_set,
788 EXPORT_SYMBOL_GPL(posix_acl_default_xattr_handler);
790 int simple_set_acl(struct inode *inode, struct posix_acl *acl, int type)
794 if (type == ACL_TYPE_ACCESS) {
795 error = posix_acl_equiv_mode(acl, &inode->i_mode);
802 inode->i_ctime = CURRENT_TIME;
803 set_cached_acl(inode, type, acl);
807 int simple_acl_create(struct inode *dir, struct inode *inode)
809 struct posix_acl *default_acl, *acl;
812 error = posix_acl_create(dir, &inode->i_mode, &default_acl, &acl);
816 set_cached_acl(inode, ACL_TYPE_DEFAULT, default_acl);
817 set_cached_acl(inode, ACL_TYPE_ACCESS, acl);
820 posix_acl_release(default_acl);
822 posix_acl_release(acl);