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_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
;
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
);
302 mutex_unlock(&inode
->i_mutex
);
306 error
= inode
->i_op
->removexattr(dentry
, name
);
307 mutex_unlock(&inode
->i_mutex
);
310 fsnotify_xattr(dentry
);
311 evm_inode_post_removexattr(dentry
, name
);
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 SYSCALL_DEFINE5(setxattr
, const char __user
*, pathname
,
368 const char __user
*, name
, const void __user
*, value
,
369 size_t, size
, int, flags
)
373 unsigned int lookup_flags
= LOOKUP_FOLLOW
;
375 error
= user_path_at(AT_FDCWD
, pathname
, lookup_flags
, &path
);
378 error
= mnt_want_write(path
.mnt
);
380 error
= setxattr(path
.dentry
, name
, value
, size
, flags
);
381 mnt_drop_write(path
.mnt
);
384 if (retry_estale(error
, lookup_flags
)) {
385 lookup_flags
|= LOOKUP_REVAL
;
391 SYSCALL_DEFINE5(lsetxattr
, const char __user
*, pathname
,
392 const char __user
*, name
, const void __user
*, value
,
393 size_t, size
, int, flags
)
398 error
= user_lpath(pathname
, &path
);
401 error
= mnt_want_write(path
.mnt
);
403 error
= setxattr(path
.dentry
, name
, value
, size
, flags
);
404 mnt_drop_write(path
.mnt
);
410 SYSCALL_DEFINE5(fsetxattr
, int, fd
, const char __user
*, name
,
411 const void __user
*,value
, size_t, size
, int, flags
)
413 struct fd f
= fdget(fd
);
414 struct dentry
*dentry
;
419 dentry
= f
.file
->f_path
.dentry
;
420 audit_inode(NULL
, dentry
, 0);
421 error
= mnt_want_write_file(f
.file
);
423 error
= setxattr(dentry
, name
, value
, size
, flags
);
424 mnt_drop_write_file(f
.file
);
431 * Extended attribute GET operations
434 getxattr(struct dentry
*d
, const char __user
*name
, void __user
*value
,
440 char kname
[XATTR_NAME_MAX
+ 1];
442 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
443 if (error
== 0 || error
== sizeof(kname
))
449 if (size
> XATTR_SIZE_MAX
)
450 size
= XATTR_SIZE_MAX
;
451 kvalue
= kzalloc(size
, GFP_KERNEL
| __GFP_NOWARN
);
453 vvalue
= vmalloc(size
);
460 error
= vfs_getxattr(d
, kname
, kvalue
, size
);
462 if ((strcmp(kname
, XATTR_NAME_POSIX_ACL_ACCESS
) == 0) ||
463 (strcmp(kname
, XATTR_NAME_POSIX_ACL_DEFAULT
) == 0))
464 posix_acl_fix_xattr_to_user(kvalue
, size
);
465 if (size
&& copy_to_user(value
, kvalue
, error
))
467 } else if (error
== -ERANGE
&& size
>= XATTR_SIZE_MAX
) {
468 /* The file system tried to returned a value bigger
469 than XATTR_SIZE_MAX bytes. Not possible. */
479 SYSCALL_DEFINE4(getxattr
, const char __user
*, pathname
,
480 const char __user
*, name
, void __user
*, value
, size_t, size
)
485 error
= user_path(pathname
, &path
);
488 error
= getxattr(path
.dentry
, name
, value
, size
);
493 SYSCALL_DEFINE4(lgetxattr
, const char __user
*, pathname
,
494 const char __user
*, name
, void __user
*, value
, size_t, size
)
499 error
= user_lpath(pathname
, &path
);
502 error
= getxattr(path
.dentry
, name
, value
, size
);
507 SYSCALL_DEFINE4(fgetxattr
, int, fd
, const char __user
*, name
,
508 void __user
*, value
, size_t, size
)
510 struct fd f
= fdget(fd
);
511 ssize_t error
= -EBADF
;
515 audit_inode(NULL
, f
.file
->f_path
.dentry
, 0);
516 error
= getxattr(f
.file
->f_path
.dentry
, name
, value
, size
);
522 * Extended attribute LIST operations
525 listxattr(struct dentry
*d
, char __user
*list
, size_t size
)
529 char *vlist
= NULL
; /* If non-NULL, we used vmalloc() */
532 if (size
> XATTR_LIST_MAX
)
533 size
= XATTR_LIST_MAX
;
534 klist
= kmalloc(size
, __GFP_NOWARN
| GFP_KERNEL
);
536 vlist
= vmalloc(size
);
543 error
= vfs_listxattr(d
, klist
, size
);
545 if (size
&& copy_to_user(list
, klist
, error
))
547 } else if (error
== -ERANGE
&& size
>= XATTR_LIST_MAX
) {
548 /* The file system tried to returned a list bigger
549 than XATTR_LIST_MAX bytes. Not possible. */
559 SYSCALL_DEFINE3(listxattr
, const char __user
*, pathname
, char __user
*, list
,
565 error
= user_path(pathname
, &path
);
568 error
= listxattr(path
.dentry
, list
, size
);
573 SYSCALL_DEFINE3(llistxattr
, const char __user
*, pathname
, char __user
*, list
,
579 error
= user_lpath(pathname
, &path
);
582 error
= listxattr(path
.dentry
, list
, size
);
587 SYSCALL_DEFINE3(flistxattr
, int, fd
, char __user
*, list
, size_t, size
)
589 struct fd f
= fdget(fd
);
590 ssize_t error
= -EBADF
;
594 audit_inode(NULL
, f
.file
->f_path
.dentry
, 0);
595 error
= listxattr(f
.file
->f_path
.dentry
, list
, size
);
601 * Extended attribute REMOVE operations
604 removexattr(struct dentry
*d
, const char __user
*name
)
607 char kname
[XATTR_NAME_MAX
+ 1];
609 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
610 if (error
== 0 || error
== sizeof(kname
))
615 return vfs_removexattr(d
, kname
);
618 SYSCALL_DEFINE2(removexattr
, const char __user
*, pathname
,
619 const char __user
*, name
)
624 error
= user_path(pathname
, &path
);
627 error
= mnt_want_write(path
.mnt
);
629 error
= removexattr(path
.dentry
, name
);
630 mnt_drop_write(path
.mnt
);
636 SYSCALL_DEFINE2(lremovexattr
, const char __user
*, pathname
,
637 const char __user
*, name
)
642 error
= user_lpath(pathname
, &path
);
645 error
= mnt_want_write(path
.mnt
);
647 error
= removexattr(path
.dentry
, name
);
648 mnt_drop_write(path
.mnt
);
654 SYSCALL_DEFINE2(fremovexattr
, int, fd
, const char __user
*, name
)
656 struct fd f
= fdget(fd
);
657 struct dentry
*dentry
;
662 dentry
= f
.file
->f_path
.dentry
;
663 audit_inode(NULL
, dentry
, 0);
664 error
= mnt_want_write_file(f
.file
);
666 error
= removexattr(dentry
, name
);
667 mnt_drop_write_file(f
.file
);
675 strcmp_prefix(const char *a
, const char *a_prefix
)
677 while (*a_prefix
&& *a
== *a_prefix
) {
681 return *a_prefix
? NULL
: a
;
685 * In order to implement different sets of xattr operations for each xattr
686 * prefix with the generic xattr API, a filesystem should create a
687 * null-terminated array of struct xattr_handler (one for each prefix) and
688 * hang a pointer to it off of the s_xattr field of the superblock.
690 * The generic_fooxattr() functions will use this list to dispatch xattr
691 * operations to the correct xattr_handler.
693 #define for_each_xattr_handler(handlers, handler) \
694 for ((handler) = *(handlers)++; \
696 (handler) = *(handlers)++)
699 * Find the xattr_handler with the matching prefix.
701 static const struct xattr_handler
*
702 xattr_resolve_name(const struct xattr_handler
**handlers
, const char **name
)
704 const struct xattr_handler
*handler
;
709 for_each_xattr_handler(handlers
, handler
) {
710 const char *n
= strcmp_prefix(*name
, handler
->prefix
);
720 * Find the handler for the prefix and dispatch its get() operation.
723 generic_getxattr(struct dentry
*dentry
, const char *name
, void *buffer
, size_t size
)
725 const struct xattr_handler
*handler
;
727 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
730 return handler
->get(dentry
, name
, buffer
, size
, handler
->flags
);
734 * Combine the results of the list() operation from every xattr_handler in the
738 generic_listxattr(struct dentry
*dentry
, char *buffer
, size_t buffer_size
)
740 const struct xattr_handler
*handler
, **handlers
= dentry
->d_sb
->s_xattr
;
741 unsigned int size
= 0;
744 for_each_xattr_handler(handlers
, handler
) {
745 size
+= handler
->list(dentry
, NULL
, 0, NULL
, 0,
751 for_each_xattr_handler(handlers
, handler
) {
752 size
= handler
->list(dentry
, buf
, buffer_size
,
753 NULL
, 0, handler
->flags
);
754 if (size
> buffer_size
)
765 * Find the handler for the prefix and dispatch its set() operation.
768 generic_setxattr(struct dentry
*dentry
, const char *name
, const void *value
, size_t size
, int flags
)
770 const struct xattr_handler
*handler
;
773 value
= ""; /* empty EA, do not remove */
774 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
777 return handler
->set(dentry
, name
, value
, size
, flags
, handler
->flags
);
781 * Find the handler for the prefix and dispatch its set() operation to remove
782 * any associated extended attribute.
785 generic_removexattr(struct dentry
*dentry
, const char *name
)
787 const struct xattr_handler
*handler
;
789 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
792 return handler
->set(dentry
, name
, NULL
, 0,
793 XATTR_REPLACE
, handler
->flags
);
796 EXPORT_SYMBOL(generic_getxattr
);
797 EXPORT_SYMBOL(generic_listxattr
);
798 EXPORT_SYMBOL(generic_setxattr
);
799 EXPORT_SYMBOL(generic_removexattr
);
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
);
850 static int __simple_xattr_set(struct simple_xattrs
*xattrs
, const char *name
,
851 const void *value
, size_t size
, int flags
)
853 struct simple_xattr
*xattr
;
854 struct simple_xattr
*new_xattr
= NULL
;
857 /* value == NULL means remove */
859 new_xattr
= simple_xattr_alloc(value
, size
);
863 new_xattr
->name
= kstrdup(name
, GFP_KERNEL
);
864 if (!new_xattr
->name
) {
870 spin_lock(&xattrs
->lock
);
871 list_for_each_entry(xattr
, &xattrs
->head
, list
) {
872 if (!strcmp(name
, xattr
->name
)) {
873 if (flags
& XATTR_CREATE
) {
876 } else if (new_xattr
) {
877 list_replace(&xattr
->list
, &new_xattr
->list
);
879 list_del(&xattr
->list
);
884 if (flags
& XATTR_REPLACE
) {
888 list_add(&new_xattr
->list
, &xattrs
->head
);
892 spin_unlock(&xattrs
->lock
);
902 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
903 * @xattrs: target simple_xattr list
904 * @name: name of the new extended attribute
905 * @value: value of the new xattr. If %NULL, will remove the attribute
906 * @size: size of the new xattr
907 * @flags: %XATTR_{CREATE|REPLACE}
909 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
910 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
911 * otherwise, fails with -ENODATA.
913 * Returns 0 on success, -errno on failure.
915 int simple_xattr_set(struct simple_xattrs
*xattrs
, const char *name
,
916 const void *value
, size_t size
, int flags
)
919 value
= ""; /* empty EA, do not remove */
920 return __simple_xattr_set(xattrs
, name
, value
, size
, flags
);
924 * xattr REMOVE operation for in-memory/pseudo filesystems
926 int simple_xattr_remove(struct simple_xattrs
*xattrs
, const char *name
)
928 return __simple_xattr_set(xattrs
, name
, NULL
, 0, XATTR_REPLACE
);
931 static bool xattr_is_trusted(const char *name
)
933 return !strncmp(name
, XATTR_TRUSTED_PREFIX
, XATTR_TRUSTED_PREFIX_LEN
);
937 * xattr LIST operation for in-memory/pseudo filesystems
939 ssize_t
simple_xattr_list(struct simple_xattrs
*xattrs
, char *buffer
,
942 bool trusted
= capable(CAP_SYS_ADMIN
);
943 struct simple_xattr
*xattr
;
946 spin_lock(&xattrs
->lock
);
947 list_for_each_entry(xattr
, &xattrs
->head
, list
) {
950 /* skip "trusted." attributes for unprivileged callers */
951 if (!trusted
&& xattr_is_trusted(xattr
->name
))
954 len
= strlen(xattr
->name
) + 1;
961 memcpy(buffer
, xattr
->name
, len
);
965 spin_unlock(&xattrs
->lock
);
971 * Adds an extended attribute to the list
973 void simple_xattr_list_add(struct simple_xattrs
*xattrs
,
974 struct simple_xattr
*new_xattr
)
976 spin_lock(&xattrs
->lock
);
977 list_add(&new_xattr
->list
, &xattrs
->head
);
978 spin_unlock(&xattrs
->lock
);