4 Extended attribute handling.
6 Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org>
7 Copyright (C) 2001 SGI - Silicon Graphics, Inc <linux-xfs@oss.sgi.com>
8 Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com>
11 #include <linux/slab.h>
12 #include <linux/file.h>
13 #include <linux/xattr.h>
14 #include <linux/mount.h>
15 #include <linux/namei.h>
16 #include <linux/security.h>
17 #include <linux/evm.h>
18 #include <linux/syscalls.h>
19 #include <linux/export.h>
20 #include <linux/fsnotify.h>
21 #include <linux/audit.h>
22 #include <linux/vmalloc.h>
23 #include <linux/posix_acl_xattr.h>
25 #include <asm/uaccess.h>
28 * Check permissions for extended attribute access. This is a bit complicated
29 * because different namespaces have very different rules.
32 xattr_permission(struct inode *inode, const char *name, int mask)
35 * We can never set or remove an extended attribute on a read-only
36 * filesystem or on an immutable / append-only inode.
38 if (mask & MAY_WRITE) {
39 if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
44 * No restriction for security.* and system.* from the VFS. Decision
45 * on these is left to the underlying filesystem / security module.
47 if (!strncmp(name, XATTR_SECURITY_PREFIX, XATTR_SECURITY_PREFIX_LEN) ||
48 !strncmp(name, XATTR_SYSTEM_PREFIX, XATTR_SYSTEM_PREFIX_LEN))
52 * The trusted.* namespace can only be accessed by privileged users.
54 if (!strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN)) {
55 if (!capable(CAP_SYS_ADMIN))
56 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
61 * In the user.* namespace, only regular files and directories can have
62 * extended attributes. For sticky directories, only the owner and
63 * privileged users can write attributes.
65 if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
66 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
67 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
68 if (S_ISDIR(inode->i_mode) && (inode->i_mode & S_ISVTX) &&
69 (mask & MAY_WRITE) && !inode_owner_or_capable(inode))
73 return inode_permission2(ERR_PTR(-EOPNOTSUPP), inode, mask);
77 * __vfs_setxattr_noperm - perform setxattr operation without performing
80 * @dentry - object to perform setxattr on
81 * @name - xattr name to set
82 * @value - value to set @name to
83 * @size - size of @value
84 * @flags - flags to pass into filesystem operations
86 * returns the result of the internal setxattr or setsecurity operations.
88 * This function requires the caller to lock the inode's i_mutex before it
89 * is executed. It also assumes that the caller will make the appropriate
92 int __vfs_setxattr_noperm(struct dentry *dentry, const char *name,
93 const void *value, size_t size, int flags)
95 struct inode *inode = dentry->d_inode;
96 int error = -EOPNOTSUPP;
97 int issec = !strncmp(name, XATTR_SECURITY_PREFIX,
98 XATTR_SECURITY_PREFIX_LEN);
101 inode->i_flags &= ~S_NOSEC;
102 if (inode->i_op->setxattr) {
103 error = inode->i_op->setxattr(dentry, name, value, size, flags);
105 fsnotify_xattr(dentry);
106 security_inode_post_setxattr(dentry, name, value,
110 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
111 error = security_inode_setsecurity(inode, suffix, value,
114 fsnotify_xattr(dentry);
122 vfs_setxattr(struct dentry *dentry, const char *name, const void *value,
123 size_t size, int flags)
125 struct inode *inode = dentry->d_inode;
128 error = xattr_permission(inode, name, MAY_WRITE);
132 mutex_lock(&inode->i_mutex);
133 error = security_inode_setxattr(dentry, name, value, size, flags);
137 error = __vfs_setxattr_noperm(dentry, name, value, size, flags);
140 mutex_unlock(&inode->i_mutex);
143 EXPORT_SYMBOL_GPL(vfs_setxattr);
146 xattr_getsecurity(struct inode *inode, const char *name, void *value,
152 if (!value || !size) {
153 len = security_inode_getsecurity(inode, name, &buffer, false);
157 len = security_inode_getsecurity(inode, name, &buffer, true);
164 memcpy(value, buffer, len);
170 EXPORT_SYMBOL_GPL(xattr_getsecurity);
173 * vfs_getxattr_alloc - allocate memory, if necessary, before calling getxattr
175 * Allocate memory, if not already allocated, or re-allocate correct size,
176 * before retrieving the extended attribute.
178 * Returns the result of alloc, if failed, or the getxattr operation.
181 vfs_getxattr_alloc(struct dentry *dentry, const char *name, char **xattr_value,
182 size_t xattr_size, gfp_t flags)
184 struct inode *inode = dentry->d_inode;
185 char *value = *xattr_value;
188 error = xattr_permission(inode, name, MAY_READ);
192 if (!inode->i_op->getxattr)
195 error = inode->i_op->getxattr(dentry, name, NULL, 0);
199 if (!value || (error > xattr_size)) {
200 value = krealloc(*xattr_value, error + 1, flags);
203 memset(value, 0, error + 1);
206 error = inode->i_op->getxattr(dentry, name, value, error);
207 *xattr_value = value;
211 /* Compare an extended attribute value with the given value */
212 int vfs_xattr_cmp(struct dentry *dentry, const char *xattr_name,
213 const char *value, size_t size, gfp_t flags)
215 char *xattr_value = NULL;
218 rc = vfs_getxattr_alloc(dentry, xattr_name, &xattr_value, 0, flags);
222 if ((rc != size) || (memcmp(xattr_value, value, rc) != 0))
231 vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
233 struct inode *inode = dentry->d_inode;
236 error = xattr_permission(inode, name, MAY_READ);
240 error = security_inode_getxattr(dentry, name);
244 if (!strncmp(name, XATTR_SECURITY_PREFIX,
245 XATTR_SECURITY_PREFIX_LEN)) {
246 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
247 int ret = xattr_getsecurity(inode, suffix, value, size);
249 * Only overwrite the return value if a security module
250 * is actually active.
252 if (ret == -EOPNOTSUPP)
257 if (inode->i_op->getxattr)
258 error = inode->i_op->getxattr(dentry, name, value, size);
264 EXPORT_SYMBOL_GPL(vfs_getxattr);
267 vfs_listxattr(struct dentry *d, char *list, size_t size)
271 error = security_inode_listxattr(d);
275 if (d->d_inode->i_op->listxattr) {
276 error = d->d_inode->i_op->listxattr(d, list, size);
278 error = security_inode_listsecurity(d->d_inode, list, size);
279 if (size && error > size)
284 EXPORT_SYMBOL_GPL(vfs_listxattr);
287 vfs_removexattr(struct dentry *dentry, const char *name)
289 struct inode *inode = dentry->d_inode;
292 if (!inode->i_op->removexattr)
295 error = xattr_permission(inode, name, MAY_WRITE);
299 mutex_lock(&inode->i_mutex);
300 error = security_inode_removexattr(dentry, name);
304 error = inode->i_op->removexattr(dentry, name);
307 fsnotify_xattr(dentry);
308 evm_inode_post_removexattr(dentry, name);
312 mutex_unlock(&inode->i_mutex);
315 EXPORT_SYMBOL_GPL(vfs_removexattr);
319 * Extended attribute SET operations
322 setxattr(struct dentry *d, const char __user *name, const void __user *value,
323 size_t size, int flags)
327 void *vvalue = NULL; /* If non-NULL, we used vmalloc() */
328 char kname[XATTR_NAME_MAX + 1];
330 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
333 error = strncpy_from_user(kname, name, sizeof(kname));
334 if (error == 0 || error == sizeof(kname))
340 if (size > XATTR_SIZE_MAX)
342 kvalue = kmalloc(size, GFP_KERNEL | __GFP_NOWARN);
344 vvalue = vmalloc(size);
349 if (copy_from_user(kvalue, value, size)) {
353 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
354 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
355 posix_acl_fix_xattr_from_user(kvalue, size);
358 error = vfs_setxattr(d, kname, kvalue, size, flags);
367 static int path_setxattr(const char __user *pathname,
368 const char __user *name, const void __user *value,
369 size_t size, int flags, unsigned int lookup_flags)
374 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
377 error = mnt_want_write(path.mnt);
379 error = setxattr(path.dentry, name, value, size, flags);
380 mnt_drop_write(path.mnt);
383 if (retry_estale(error, lookup_flags)) {
384 lookup_flags |= LOOKUP_REVAL;
390 SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
391 const char __user *, name, const void __user *, value,
392 size_t, size, int, flags)
394 return path_setxattr(pathname, name, value, size, flags, LOOKUP_FOLLOW);
397 SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
398 const char __user *, name, const void __user *, value,
399 size_t, size, int, flags)
401 return path_setxattr(pathname, name, value, size, flags, 0);
404 SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
405 const void __user *,value, size_t, size, int, flags)
407 struct fd f = fdget(fd);
413 error = mnt_want_write_file(f.file);
415 error = setxattr(f.file->f_path.dentry, name, value, size, flags);
416 mnt_drop_write_file(f.file);
423 * Extended attribute GET operations
426 getxattr(struct dentry *d, const char __user *name, void __user *value,
432 char kname[XATTR_NAME_MAX + 1];
433 char kvalue_onstack[SZ_4K] __aligned(sizeof(long));
435 error = strncpy_from_user(kname, name, sizeof(kname));
436 if (error == 0 || error == sizeof(kname))
442 if (size <= ARRAY_SIZE(kvalue_onstack)) {
443 kvalue = kvalue_onstack;
444 memset(kvalue, 0, size);
446 if (size > XATTR_SIZE_MAX)
447 size = XATTR_SIZE_MAX;
448 kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
450 vvalue = vzalloc(size);
458 error = vfs_getxattr(d, kname, kvalue, size);
460 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
461 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
462 posix_acl_fix_xattr_to_user(kvalue, error);
463 if (size && copy_to_user(value, kvalue, error))
465 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
466 /* The file system tried to returned a value bigger
467 than XATTR_SIZE_MAX bytes. Not possible. */
472 else if (kvalue != kvalue_onstack)
477 static ssize_t path_getxattr(const char __user *pathname,
478 const char __user *name, void __user *value,
479 size_t size, unsigned int lookup_flags)
484 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
487 error = getxattr(path.dentry, name, value, size);
489 if (retry_estale(error, lookup_flags)) {
490 lookup_flags |= LOOKUP_REVAL;
496 SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
497 const char __user *, name, void __user *, value, size_t, size)
499 return path_getxattr(pathname, name, value, size, LOOKUP_FOLLOW);
502 SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
503 const char __user *, name, void __user *, value, size_t, size)
505 return path_getxattr(pathname, name, value, size, 0);
508 SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
509 void __user *, value, size_t, size)
511 struct fd f = fdget(fd);
512 ssize_t error = -EBADF;
517 error = getxattr(f.file->f_path.dentry, name, value, size);
523 * Extended attribute LIST operations
526 listxattr(struct dentry *d, char __user *list, size_t size)
530 char *vlist = NULL; /* If non-NULL, we used vmalloc() */
533 if (size > XATTR_LIST_MAX)
534 size = XATTR_LIST_MAX;
535 klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
537 vlist = vmalloc(size);
544 error = vfs_listxattr(d, klist, size);
546 if (size && copy_to_user(list, klist, error))
548 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
549 /* The file system tried to returned a list bigger
550 than XATTR_LIST_MAX bytes. Not possible. */
560 static ssize_t path_listxattr(const char __user *pathname, char __user *list,
561 size_t size, unsigned int lookup_flags)
566 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
569 error = listxattr(path.dentry, list, size);
571 if (retry_estale(error, lookup_flags)) {
572 lookup_flags |= LOOKUP_REVAL;
578 SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
581 return path_listxattr(pathname, list, size, LOOKUP_FOLLOW);
584 SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
587 return path_listxattr(pathname, list, size, 0);
590 SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
592 struct fd f = fdget(fd);
593 ssize_t error = -EBADF;
598 error = listxattr(f.file->f_path.dentry, list, size);
604 * Extended attribute REMOVE operations
607 removexattr(struct dentry *d, const char __user *name)
610 char kname[XATTR_NAME_MAX + 1];
612 error = strncpy_from_user(kname, name, sizeof(kname));
613 if (error == 0 || error == sizeof(kname))
618 return vfs_removexattr(d, kname);
621 static int path_removexattr(const char __user *pathname,
622 const char __user *name, unsigned int lookup_flags)
627 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
630 error = mnt_want_write(path.mnt);
632 error = removexattr(path.dentry, name);
633 mnt_drop_write(path.mnt);
636 if (retry_estale(error, lookup_flags)) {
637 lookup_flags |= LOOKUP_REVAL;
643 SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
644 const char __user *, name)
646 return path_removexattr(pathname, name, LOOKUP_FOLLOW);
649 SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
650 const char __user *, name)
652 return path_removexattr(pathname, name, 0);
655 SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
657 struct fd f = fdget(fd);
663 error = mnt_want_write_file(f.file);
665 error = removexattr(f.file->f_path.dentry, name);
666 mnt_drop_write_file(f.file);
674 strcmp_prefix(const char *a, const char *a_prefix)
676 while (*a_prefix && *a == *a_prefix) {
680 return *a_prefix ? NULL : a;
684 * In order to implement different sets of xattr operations for each xattr
685 * prefix with the generic xattr API, a filesystem should create a
686 * null-terminated array of struct xattr_handler (one for each prefix) and
687 * hang a pointer to it off of the s_xattr field of the superblock.
689 * The generic_fooxattr() functions will use this list to dispatch xattr
690 * operations to the correct xattr_handler.
692 #define for_each_xattr_handler(handlers, handler) \
693 for ((handler) = *(handlers)++; \
695 (handler) = *(handlers)++)
698 * Find the xattr_handler with the matching prefix.
700 static const struct xattr_handler *
701 xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
703 const struct xattr_handler *handler;
708 for_each_xattr_handler(handlers, handler) {
709 const char *n = strcmp_prefix(*name, handler->prefix);
719 * Find the handler for the prefix and dispatch its get() operation.
722 generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
724 const struct xattr_handler *handler;
726 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
729 return handler->get(handler, dentry, name, buffer, size);
733 * Combine the results of the list() operation from every xattr_handler in the
737 generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
739 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
740 unsigned int size = 0;
743 for_each_xattr_handler(handlers, handler) {
744 size += handler->list(handler, dentry, NULL, 0,
750 for_each_xattr_handler(handlers, handler) {
751 size = handler->list(handler, dentry, buf, buffer_size,
753 if (size > buffer_size)
764 * Find the handler for the prefix and dispatch its set() operation.
767 generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
769 const struct xattr_handler *handler;
772 value = ""; /* empty EA, do not remove */
773 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
776 return handler->set(handler, dentry, name, value, size, flags);
780 * Find the handler for the prefix and dispatch its set() operation to remove
781 * any associated extended attribute.
784 generic_removexattr(struct dentry *dentry, const char *name)
786 const struct xattr_handler *handler;
788 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
791 return handler->set(handler, dentry, name, NULL, 0, XATTR_REPLACE);
794 EXPORT_SYMBOL(generic_getxattr);
795 EXPORT_SYMBOL(generic_listxattr);
796 EXPORT_SYMBOL(generic_setxattr);
797 EXPORT_SYMBOL(generic_removexattr);
800 * xattr_full_name - Compute full attribute name from suffix
802 * @handler: handler of the xattr_handler operation
803 * @name: name passed to the xattr_handler operation
805 * The get and set xattr handler operations are called with the remainder of
806 * the attribute name after skipping the handler's prefix: for example, "foo"
807 * is passed to the get operation of a handler with prefix "user." to get
808 * attribute "user.foo". The full name is still "there" in the name though.
810 * Note: the list xattr handler operation when called from the vfs is passed a
811 * NULL name; some file systems use this operation internally, with varying
814 const char *xattr_full_name(const struct xattr_handler *handler,
817 size_t prefix_len = strlen(handler->prefix);
819 return name - prefix_len;
821 EXPORT_SYMBOL(xattr_full_name);
824 * Allocate new xattr and copy in the value; but leave the name to callers.
826 struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
828 struct simple_xattr *new_xattr;
832 len = sizeof(*new_xattr) + size;
833 if (len < sizeof(*new_xattr))
836 new_xattr = kmalloc(len, GFP_KERNEL);
840 new_xattr->size = size;
841 memcpy(new_xattr->value, value, size);
846 * xattr GET operation for in-memory/pseudo filesystems
848 int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
849 void *buffer, size_t size)
851 struct simple_xattr *xattr;
854 spin_lock(&xattrs->lock);
855 list_for_each_entry(xattr, &xattrs->head, list) {
856 if (strcmp(name, xattr->name))
861 if (size < xattr->size)
864 memcpy(buffer, xattr->value, xattr->size);
868 spin_unlock(&xattrs->lock);
872 static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
873 const void *value, size_t size, int flags)
875 struct simple_xattr *xattr;
876 struct simple_xattr *new_xattr = NULL;
879 /* value == NULL means remove */
881 new_xattr = simple_xattr_alloc(value, size);
885 new_xattr->name = kstrdup(name, GFP_KERNEL);
886 if (!new_xattr->name) {
892 spin_lock(&xattrs->lock);
893 list_for_each_entry(xattr, &xattrs->head, list) {
894 if (!strcmp(name, xattr->name)) {
895 if (flags & XATTR_CREATE) {
898 } else if (new_xattr) {
899 list_replace(&xattr->list, &new_xattr->list);
901 list_del(&xattr->list);
906 if (flags & XATTR_REPLACE) {
910 list_add(&new_xattr->list, &xattrs->head);
914 spin_unlock(&xattrs->lock);
924 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
925 * @xattrs: target simple_xattr list
926 * @name: name of the new extended attribute
927 * @value: value of the new xattr. If %NULL, will remove the attribute
928 * @size: size of the new xattr
929 * @flags: %XATTR_{CREATE|REPLACE}
931 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
932 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
933 * otherwise, fails with -ENODATA.
935 * Returns 0 on success, -errno on failure.
937 int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
938 const void *value, size_t size, int flags)
941 value = ""; /* empty EA, do not remove */
942 return __simple_xattr_set(xattrs, name, value, size, flags);
946 * xattr REMOVE operation for in-memory/pseudo filesystems
948 int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
950 return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
953 static bool xattr_is_trusted(const char *name)
955 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
959 * xattr LIST operation for in-memory/pseudo filesystems
961 ssize_t simple_xattr_list(struct simple_xattrs *xattrs, char *buffer,
964 bool trusted = capable(CAP_SYS_ADMIN);
965 struct simple_xattr *xattr;
968 spin_lock(&xattrs->lock);
969 list_for_each_entry(xattr, &xattrs->head, list) {
972 /* skip "trusted." attributes for unprivileged callers */
973 if (!trusted && xattr_is_trusted(xattr->name))
976 len = strlen(xattr->name) + 1;
983 memcpy(buffer, xattr->name, len);
987 spin_unlock(&xattrs->lock);
993 * Adds an extended attribute to the list
995 void simple_xattr_list_add(struct simple_xattrs *xattrs,
996 struct simple_xattr *new_xattr)
998 spin_lock(&xattrs->lock);
999 list_add(&new_xattr->list, &xattrs->head);
1000 spin_unlock(&xattrs->lock);