4 Extended attribute handling.
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_permission(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);
166 security_release_secctx(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;
212 vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
214 struct inode *inode = dentry->d_inode;
217 error = xattr_permission(inode, name, MAY_READ);
221 error = security_inode_getxattr(dentry, name);
225 if (!strncmp(name, XATTR_SECURITY_PREFIX,
226 XATTR_SECURITY_PREFIX_LEN)) {
227 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
228 int ret = xattr_getsecurity(inode, suffix, value, size);
230 * Only overwrite the return value if a security module
231 * is actually active.
233 if (ret == -EOPNOTSUPP)
238 if (inode->i_op->getxattr)
239 error = inode->i_op->getxattr(dentry, name, value, size);
245 EXPORT_SYMBOL_GPL(vfs_getxattr);
248 vfs_listxattr(struct dentry *d, char *list, size_t size)
252 error = security_inode_listxattr(d);
256 if (d->d_inode->i_op->listxattr) {
257 error = d->d_inode->i_op->listxattr(d, list, size);
259 error = security_inode_listsecurity(d->d_inode, list, size);
260 if (size && error > size)
265 EXPORT_SYMBOL_GPL(vfs_listxattr);
268 vfs_removexattr(struct dentry *dentry, const char *name)
270 struct inode *inode = dentry->d_inode;
273 if (!inode->i_op->removexattr)
276 error = xattr_permission(inode, name, MAY_WRITE);
280 mutex_lock(&inode->i_mutex);
281 error = security_inode_removexattr(dentry, name);
285 error = inode->i_op->removexattr(dentry, name);
288 fsnotify_xattr(dentry);
289 evm_inode_post_removexattr(dentry, name);
293 mutex_unlock(&inode->i_mutex);
296 EXPORT_SYMBOL_GPL(vfs_removexattr);
300 * Extended attribute SET operations
303 setxattr(struct dentry *d, const char __user *name, const void __user *value,
304 size_t size, int flags)
308 char kname[XATTR_NAME_MAX + 1];
310 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
313 error = strncpy_from_user(kname, name, sizeof(kname));
314 if (error == 0 || error == sizeof(kname))
320 if (size > XATTR_SIZE_MAX)
322 kvalue = kmalloc(size, GFP_KERNEL | __GFP_NOWARN);
324 kvalue = vmalloc(size);
328 if (copy_from_user(kvalue, value, size)) {
332 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
333 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
334 posix_acl_fix_xattr_from_user(kvalue, size);
337 error = vfs_setxattr(d, kname, kvalue, size, flags);
344 static int path_setxattr(const char __user *pathname,
345 const char __user *name, const void __user *value,
346 size_t size, int flags, unsigned int lookup_flags)
351 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
354 error = mnt_want_write(path.mnt);
356 error = setxattr(path.dentry, name, value, size, flags);
357 mnt_drop_write(path.mnt);
360 if (retry_estale(error, lookup_flags)) {
361 lookup_flags |= LOOKUP_REVAL;
367 SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
368 const char __user *, name, const void __user *, value,
369 size_t, size, int, flags)
371 return path_setxattr(pathname, name, value, size, flags, LOOKUP_FOLLOW);
374 SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
375 const char __user *, name, const void __user *, value,
376 size_t, size, int, flags)
378 return path_setxattr(pathname, name, value, size, flags, 0);
381 SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
382 const void __user *,value, size_t, size, int, flags)
384 struct fd f = fdget(fd);
390 error = mnt_want_write_file(f.file);
392 error = setxattr(f.file->f_path.dentry, name, value, size, flags);
393 mnt_drop_write_file(f.file);
400 * Extended attribute GET operations
403 getxattr(struct dentry *d, const char __user *name, void __user *value,
408 char kname[XATTR_NAME_MAX + 1];
410 error = strncpy_from_user(kname, name, sizeof(kname));
411 if (error == 0 || error == sizeof(kname))
417 if (size > XATTR_SIZE_MAX)
418 size = XATTR_SIZE_MAX;
419 kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
421 kvalue = vmalloc(size);
427 error = vfs_getxattr(d, kname, kvalue, size);
429 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
430 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
431 posix_acl_fix_xattr_to_user(kvalue, size);
432 if (size && copy_to_user(value, kvalue, error))
434 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
435 /* The file system tried to returned a value bigger
436 than XATTR_SIZE_MAX bytes. Not possible. */
445 static ssize_t path_getxattr(const char __user *pathname,
446 const char __user *name, void __user *value,
447 size_t size, unsigned int lookup_flags)
452 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
455 error = getxattr(path.dentry, name, value, size);
457 if (retry_estale(error, lookup_flags)) {
458 lookup_flags |= LOOKUP_REVAL;
464 SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
465 const char __user *, name, void __user *, value, size_t, size)
467 return path_getxattr(pathname, name, value, size, LOOKUP_FOLLOW);
470 SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
471 const char __user *, name, void __user *, value, size_t, size)
473 return path_getxattr(pathname, name, value, size, 0);
476 SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
477 void __user *, value, size_t, size)
479 struct fd f = fdget(fd);
480 ssize_t error = -EBADF;
485 error = getxattr(f.file->f_path.dentry, name, value, size);
491 * Extended attribute LIST operations
494 listxattr(struct dentry *d, char __user *list, size_t size)
500 if (size > XATTR_LIST_MAX)
501 size = XATTR_LIST_MAX;
502 klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
504 klist = vmalloc(size);
510 error = vfs_listxattr(d, klist, size);
512 if (size && copy_to_user(list, klist, error))
514 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
515 /* The file system tried to returned a list bigger
516 than XATTR_LIST_MAX bytes. Not possible. */
525 static ssize_t path_listxattr(const char __user *pathname, char __user *list,
526 size_t size, unsigned int lookup_flags)
531 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
534 error = listxattr(path.dentry, list, size);
536 if (retry_estale(error, lookup_flags)) {
537 lookup_flags |= LOOKUP_REVAL;
543 SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
546 return path_listxattr(pathname, list, size, LOOKUP_FOLLOW);
549 SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
552 return path_listxattr(pathname, list, size, 0);
555 SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
557 struct fd f = fdget(fd);
558 ssize_t error = -EBADF;
563 error = listxattr(f.file->f_path.dentry, list, size);
569 * Extended attribute REMOVE operations
572 removexattr(struct dentry *d, const char __user *name)
575 char kname[XATTR_NAME_MAX + 1];
577 error = strncpy_from_user(kname, name, sizeof(kname));
578 if (error == 0 || error == sizeof(kname))
583 return vfs_removexattr(d, kname);
586 static int path_removexattr(const char __user *pathname,
587 const char __user *name, unsigned int lookup_flags)
592 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
595 error = mnt_want_write(path.mnt);
597 error = removexattr(path.dentry, name);
598 mnt_drop_write(path.mnt);
601 if (retry_estale(error, lookup_flags)) {
602 lookup_flags |= LOOKUP_REVAL;
608 SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
609 const char __user *, name)
611 return path_removexattr(pathname, name, LOOKUP_FOLLOW);
614 SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
615 const char __user *, name)
617 return path_removexattr(pathname, name, 0);
620 SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
622 struct fd f = fdget(fd);
628 error = mnt_want_write_file(f.file);
630 error = removexattr(f.file->f_path.dentry, name);
631 mnt_drop_write_file(f.file);
639 strcmp_prefix(const char *a, const char *a_prefix)
641 while (*a_prefix && *a == *a_prefix) {
645 return *a_prefix ? NULL : a;
649 * In order to implement different sets of xattr operations for each xattr
650 * prefix with the generic xattr API, a filesystem should create a
651 * null-terminated array of struct xattr_handler (one for each prefix) and
652 * hang a pointer to it off of the s_xattr field of the superblock.
654 * The generic_fooxattr() functions will use this list to dispatch xattr
655 * operations to the correct xattr_handler.
657 #define for_each_xattr_handler(handlers, handler) \
658 for ((handler) = *(handlers)++; \
660 (handler) = *(handlers)++)
663 * Find the xattr_handler with the matching prefix.
665 static const struct xattr_handler *
666 xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
668 const struct xattr_handler *handler;
673 for_each_xattr_handler(handlers, handler) {
676 n = strcmp_prefix(*name, xattr_prefix(handler));
678 if (!handler->prefix ^ !*n) {
681 return ERR_PTR(-EINVAL);
687 return ERR_PTR(-EOPNOTSUPP);
691 * Find the handler for the prefix and dispatch its get() operation.
694 generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
696 const struct xattr_handler *handler;
698 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
700 return PTR_ERR(handler);
701 return handler->get(handler, dentry, name, buffer, size);
705 * Combine the results of the list() operation from every xattr_handler in the
709 generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
711 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
712 unsigned int size = 0;
715 for_each_xattr_handler(handlers, handler) {
716 if (!handler->name ||
717 (handler->list && !handler->list(dentry)))
719 size += strlen(handler->name) + 1;
725 for_each_xattr_handler(handlers, handler) {
726 if (!handler->name ||
727 (handler->list && !handler->list(dentry)))
729 len = strlen(handler->name);
730 if (len + 1 > buffer_size)
732 memcpy(buf, handler->name, len + 1);
734 buffer_size -= len + 1;
742 * Find the handler for the prefix and dispatch its set() operation.
745 generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
747 const struct xattr_handler *handler;
750 value = ""; /* empty EA, do not remove */
751 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
753 return PTR_ERR(handler);
754 return handler->set(handler, dentry, name, value, size, flags);
758 * Find the handler for the prefix and dispatch its set() operation to remove
759 * any associated extended attribute.
762 generic_removexattr(struct dentry *dentry, const char *name)
764 const struct xattr_handler *handler;
766 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
768 return PTR_ERR(handler);
769 return handler->set(handler, dentry, name, NULL, 0, XATTR_REPLACE);
772 EXPORT_SYMBOL(generic_getxattr);
773 EXPORT_SYMBOL(generic_listxattr);
774 EXPORT_SYMBOL(generic_setxattr);
775 EXPORT_SYMBOL(generic_removexattr);
778 * xattr_full_name - Compute full attribute name from suffix
780 * @handler: handler of the xattr_handler operation
781 * @name: name passed to the xattr_handler operation
783 * The get and set xattr handler operations are called with the remainder of
784 * the attribute name after skipping the handler's prefix: for example, "foo"
785 * is passed to the get operation of a handler with prefix "user." to get
786 * attribute "user.foo". The full name is still "there" in the name though.
788 * Note: the list xattr handler operation when called from the vfs is passed a
789 * NULL name; some file systems use this operation internally, with varying
792 const char *xattr_full_name(const struct xattr_handler *handler,
795 size_t prefix_len = strlen(xattr_prefix(handler));
797 return name - prefix_len;
799 EXPORT_SYMBOL(xattr_full_name);
802 * Allocate new xattr and copy in the value; but leave the name to callers.
804 struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
806 struct simple_xattr *new_xattr;
810 len = sizeof(*new_xattr) + size;
811 if (len < sizeof(*new_xattr))
814 new_xattr = kmalloc(len, GFP_KERNEL);
818 new_xattr->size = size;
819 memcpy(new_xattr->value, value, size);
824 * xattr GET operation for in-memory/pseudo filesystems
826 int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
827 void *buffer, size_t size)
829 struct simple_xattr *xattr;
832 spin_lock(&xattrs->lock);
833 list_for_each_entry(xattr, &xattrs->head, list) {
834 if (strcmp(name, xattr->name))
839 if (size < xattr->size)
842 memcpy(buffer, xattr->value, xattr->size);
846 spin_unlock(&xattrs->lock);
851 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
852 * @xattrs: target simple_xattr list
853 * @name: name of the extended attribute
854 * @value: value of the xattr. If %NULL, will remove the attribute.
855 * @size: size of the new xattr
856 * @flags: %XATTR_{CREATE|REPLACE}
858 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
859 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
860 * otherwise, fails with -ENODATA.
862 * Returns 0 on success, -errno on failure.
864 int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
865 const void *value, size_t size, int flags)
867 struct simple_xattr *xattr;
868 struct simple_xattr *new_xattr = NULL;
871 /* value == NULL means remove */
873 new_xattr = simple_xattr_alloc(value, size);
877 new_xattr->name = kstrdup(name, GFP_KERNEL);
878 if (!new_xattr->name) {
884 spin_lock(&xattrs->lock);
885 list_for_each_entry(xattr, &xattrs->head, list) {
886 if (!strcmp(name, xattr->name)) {
887 if (flags & XATTR_CREATE) {
890 } else if (new_xattr) {
891 list_replace(&xattr->list, &new_xattr->list);
893 list_del(&xattr->list);
898 if (flags & XATTR_REPLACE) {
902 list_add(&new_xattr->list, &xattrs->head);
906 spin_unlock(&xattrs->lock);
915 static bool xattr_is_trusted(const char *name)
917 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
920 static int xattr_list_one(char **buffer, ssize_t *remaining_size,
923 size_t len = strlen(name) + 1;
925 if (*remaining_size < len)
927 memcpy(*buffer, name, len);
930 *remaining_size -= len;
935 * xattr LIST operation for in-memory/pseudo filesystems
937 ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs,
938 char *buffer, size_t size)
940 bool trusted = capable(CAP_SYS_ADMIN);
941 struct simple_xattr *xattr;
942 ssize_t remaining_size = size;
945 #ifdef CONFIG_FS_POSIX_ACL
947 err = xattr_list_one(&buffer, &remaining_size,
948 XATTR_NAME_POSIX_ACL_ACCESS);
952 if (inode->i_default_acl) {
953 err = xattr_list_one(&buffer, &remaining_size,
954 XATTR_NAME_POSIX_ACL_DEFAULT);
960 spin_lock(&xattrs->lock);
961 list_for_each_entry(xattr, &xattrs->head, list) {
962 /* skip "trusted." attributes for unprivileged callers */
963 if (!trusted && xattr_is_trusted(xattr->name))
966 err = xattr_list_one(&buffer, &remaining_size, xattr->name);
970 spin_unlock(&xattrs->lock);
972 return size - remaining_size;
976 * Adds an extended attribute to the list
978 void simple_xattr_list_add(struct simple_xattrs *xattrs,
979 struct simple_xattr *new_xattr)
981 spin_lock(&xattrs->lock);
982 list_add(&new_xattr->list, &xattrs->head);
983 spin_unlock(&xattrs->lock);