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>
24 #include <asm/uaccess.h>
27 * Check permissions for extended attribute access. This is a bit complicated
28 * because different namespaces have very different rules.
31 xattr_permission(struct inode
*inode
, const char *name
, int mask
)
34 * We can never set or remove an extended attribute on a read-only
35 * filesystem or on an immutable / append-only inode.
37 if (mask
& MAY_WRITE
) {
38 if (IS_IMMUTABLE(inode
) || IS_APPEND(inode
))
43 * No restriction for security.* and system.* from the VFS. Decision
44 * on these is left to the underlying filesystem / security module.
46 if (!strncmp(name
, XATTR_SECURITY_PREFIX
, XATTR_SECURITY_PREFIX_LEN
) ||
47 !strncmp(name
, XATTR_SYSTEM_PREFIX
, XATTR_SYSTEM_PREFIX_LEN
))
51 * The trusted.* namespace can only be accessed by privileged users.
53 if (!strncmp(name
, XATTR_TRUSTED_PREFIX
, XATTR_TRUSTED_PREFIX_LEN
)) {
54 if (!capable(CAP_SYS_ADMIN
))
55 return (mask
& MAY_WRITE
) ? -EPERM
: -ENODATA
;
60 * In the user.* namespace, only regular files and directories can have
61 * extended attributes. For sticky directories, only the owner and
62 * privileged users can write attributes.
64 if (!strncmp(name
, XATTR_USER_PREFIX
, XATTR_USER_PREFIX_LEN
)) {
65 if (!S_ISREG(inode
->i_mode
) && !S_ISDIR(inode
->i_mode
))
66 return (mask
& MAY_WRITE
) ? -EPERM
: -ENODATA
;
67 if (S_ISDIR(inode
->i_mode
) && (inode
->i_mode
& S_ISVTX
) &&
68 (mask
& MAY_WRITE
) && !inode_owner_or_capable(inode
))
72 return inode_permission(inode
, mask
);
76 * __vfs_setxattr_noperm - perform setxattr operation without performing
79 * @dentry - object to perform setxattr on
80 * @name - xattr name to set
81 * @value - value to set @name to
82 * @size - size of @value
83 * @flags - flags to pass into filesystem operations
85 * returns the result of the internal setxattr or setsecurity operations.
87 * This function requires the caller to lock the inode's i_mutex before it
88 * is executed. It also assumes that the caller will make the appropriate
91 int __vfs_setxattr_noperm(struct dentry
*dentry
, const char *name
,
92 const void *value
, size_t size
, int flags
)
94 struct inode
*inode
= dentry
->d_inode
;
95 int error
= -EOPNOTSUPP
;
96 int issec
= !strncmp(name
, XATTR_SECURITY_PREFIX
,
97 XATTR_SECURITY_PREFIX_LEN
);
100 inode
->i_flags
&= ~S_NOSEC
;
101 if (inode
->i_op
->setxattr
) {
102 error
= inode
->i_op
->setxattr(dentry
, name
, value
, size
, flags
);
104 fsnotify_xattr(dentry
);
105 security_inode_post_setxattr(dentry
, name
, value
,
109 const char *suffix
= name
+ XATTR_SECURITY_PREFIX_LEN
;
110 error
= security_inode_setsecurity(inode
, suffix
, value
,
113 fsnotify_xattr(dentry
);
121 vfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
122 size_t size
, int flags
)
124 struct inode
*inode
= dentry
->d_inode
;
127 error
= xattr_permission(inode
, name
, MAY_WRITE
);
131 mutex_lock(&inode
->i_mutex
);
132 error
= security_inode_setxattr(dentry
, name
, value
, size
, flags
);
136 error
= __vfs_setxattr_noperm(dentry
, name
, value
, size
, flags
);
139 mutex_unlock(&inode
->i_mutex
);
142 EXPORT_SYMBOL_GPL(vfs_setxattr
);
145 xattr_getsecurity(struct inode
*inode
, const char *name
, void *value
,
151 if (!value
|| !size
) {
152 len
= security_inode_getsecurity(inode
, name
, &buffer
, false);
156 len
= security_inode_getsecurity(inode
, name
, &buffer
, true);
163 memcpy(value
, buffer
, len
);
165 security_release_secctx(buffer
, len
);
169 EXPORT_SYMBOL_GPL(xattr_getsecurity
);
172 * vfs_getxattr_alloc - allocate memory, if necessary, before calling getxattr
174 * Allocate memory, if not already allocated, or re-allocate correct size,
175 * before retrieving the extended attribute.
177 * Returns the result of alloc, if failed, or the getxattr operation.
180 vfs_getxattr_alloc(struct dentry
*dentry
, const char *name
, char **xattr_value
,
181 size_t xattr_size
, gfp_t flags
)
183 struct inode
*inode
= dentry
->d_inode
;
184 char *value
= *xattr_value
;
187 error
= xattr_permission(inode
, name
, MAY_READ
);
191 if (!inode
->i_op
->getxattr
)
194 error
= inode
->i_op
->getxattr(dentry
, name
, NULL
, 0);
198 if (!value
|| (error
> xattr_size
)) {
199 value
= krealloc(*xattr_value
, error
+ 1, flags
);
202 memset(value
, 0, error
+ 1);
205 error
= inode
->i_op
->getxattr(dentry
, name
, value
, error
);
206 *xattr_value
= value
;
210 /* Compare an extended attribute value with the given value */
211 int vfs_xattr_cmp(struct dentry
*dentry
, const char *xattr_name
,
212 const char *value
, size_t size
, gfp_t flags
)
214 char *xattr_value
= NULL
;
217 rc
= vfs_getxattr_alloc(dentry
, xattr_name
, &xattr_value
, 0, flags
);
221 if ((rc
!= size
) || (memcmp(xattr_value
, value
, rc
) != 0))
230 vfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
, size_t size
)
232 struct inode
*inode
= dentry
->d_inode
;
235 error
= xattr_permission(inode
, name
, MAY_READ
);
239 error
= security_inode_getxattr(dentry
, name
);
243 if (!strncmp(name
, XATTR_SECURITY_PREFIX
,
244 XATTR_SECURITY_PREFIX_LEN
)) {
245 const char *suffix
= name
+ XATTR_SECURITY_PREFIX_LEN
;
246 int ret
= xattr_getsecurity(inode
, suffix
, value
, size
);
248 * Only overwrite the return value if a security module
249 * is actually active.
251 if (ret
== -EOPNOTSUPP
)
256 if (inode
->i_op
->getxattr
)
257 error
= inode
->i_op
->getxattr(dentry
, name
, value
, size
);
263 EXPORT_SYMBOL_GPL(vfs_getxattr
);
266 vfs_listxattr(struct dentry
*d
, char *list
, size_t size
)
270 error
= security_inode_listxattr(d
);
274 if (d
->d_inode
->i_op
->listxattr
) {
275 error
= d
->d_inode
->i_op
->listxattr(d
, list
, size
);
277 error
= security_inode_listsecurity(d
->d_inode
, list
, size
);
278 if (size
&& error
> size
)
283 EXPORT_SYMBOL_GPL(vfs_listxattr
);
286 vfs_removexattr(struct dentry
*dentry
, const char *name
)
288 struct inode
*inode
= dentry
->d_inode
;
291 if (!inode
->i_op
->removexattr
)
294 error
= xattr_permission(inode
, name
, MAY_WRITE
);
298 error
= security_inode_removexattr(dentry
, name
);
302 mutex_lock(&inode
->i_mutex
);
303 error
= inode
->i_op
->removexattr(dentry
, name
);
304 mutex_unlock(&inode
->i_mutex
);
307 fsnotify_xattr(dentry
);
308 evm_inode_post_removexattr(dentry
, name
);
312 EXPORT_SYMBOL_GPL(vfs_removexattr
);
316 * Extended attribute SET operations
319 setxattr(struct dentry
*d
, const char __user
*name
, const void __user
*value
,
320 size_t size
, int flags
)
324 void *vvalue
= NULL
; /* If non-NULL, we used vmalloc() */
325 char kname
[XATTR_NAME_MAX
+ 1];
327 if (flags
& ~(XATTR_CREATE
|XATTR_REPLACE
))
330 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
331 if (error
== 0 || error
== sizeof(kname
))
337 if (size
> XATTR_SIZE_MAX
)
339 kvalue
= kmalloc(size
, GFP_KERNEL
| __GFP_NOWARN
);
341 vvalue
= vmalloc(size
);
346 if (copy_from_user(kvalue
, value
, size
)) {
352 error
= vfs_setxattr(d
, kname
, kvalue
, size
, flags
);
361 SYSCALL_DEFINE5(setxattr
, const char __user
*, pathname
,
362 const char __user
*, name
, const void __user
*, value
,
363 size_t, size
, int, flags
)
368 error
= user_path(pathname
, &path
);
371 error
= mnt_want_write(path
.mnt
);
373 error
= setxattr(path
.dentry
, name
, value
, size
, flags
);
374 mnt_drop_write(path
.mnt
);
380 SYSCALL_DEFINE5(lsetxattr
, const char __user
*, pathname
,
381 const char __user
*, name
, const void __user
*, value
,
382 size_t, size
, int, flags
)
387 error
= user_lpath(pathname
, &path
);
390 error
= mnt_want_write(path
.mnt
);
392 error
= setxattr(path
.dentry
, name
, value
, size
, flags
);
393 mnt_drop_write(path
.mnt
);
399 SYSCALL_DEFINE5(fsetxattr
, int, fd
, const char __user
*, name
,
400 const void __user
*,value
, size_t, size
, int, flags
)
404 struct dentry
*dentry
;
407 f
= fget_light(fd
, &fput_needed
);
410 dentry
= f
->f_path
.dentry
;
411 audit_inode(NULL
, dentry
);
412 error
= mnt_want_write_file(f
);
414 error
= setxattr(dentry
, name
, value
, size
, flags
);
415 mnt_drop_write_file(f
);
417 fput_light(f
, fput_needed
);
422 * Extended attribute GET operations
425 getxattr(struct dentry
*d
, const char __user
*name
, void __user
*value
,
430 char kname
[XATTR_NAME_MAX
+ 1];
432 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
433 if (error
== 0 || error
== sizeof(kname
))
439 if (size
> XATTR_SIZE_MAX
)
440 size
= XATTR_SIZE_MAX
;
441 kvalue
= kzalloc(size
, GFP_KERNEL
);
446 error
= vfs_getxattr(d
, kname
, kvalue
, size
);
448 if (size
&& copy_to_user(value
, kvalue
, error
))
450 } else if (error
== -ERANGE
&& size
>= XATTR_SIZE_MAX
) {
451 /* The file system tried to returned a value bigger
452 than XATTR_SIZE_MAX bytes. Not possible. */
459 SYSCALL_DEFINE4(getxattr
, const char __user
*, pathname
,
460 const char __user
*, name
, void __user
*, value
, size_t, size
)
465 error
= user_path(pathname
, &path
);
468 error
= getxattr(path
.dentry
, name
, value
, size
);
473 SYSCALL_DEFINE4(lgetxattr
, const char __user
*, pathname
,
474 const char __user
*, name
, void __user
*, value
, size_t, size
)
479 error
= user_lpath(pathname
, &path
);
482 error
= getxattr(path
.dentry
, name
, value
, size
);
487 SYSCALL_DEFINE4(fgetxattr
, int, fd
, const char __user
*, name
,
488 void __user
*, value
, size_t, size
)
492 ssize_t error
= -EBADF
;
494 f
= fget_light(fd
, &fput_needed
);
497 audit_inode(NULL
, f
->f_path
.dentry
);
498 error
= getxattr(f
->f_path
.dentry
, name
, value
, size
);
499 fput_light(f
, fput_needed
);
504 * Extended attribute LIST operations
507 listxattr(struct dentry
*d
, char __user
*list
, size_t size
)
511 char *vlist
= NULL
; /* If non-NULL, we used vmalloc() */
514 if (size
> XATTR_LIST_MAX
)
515 size
= XATTR_LIST_MAX
;
516 klist
= kmalloc(size
, __GFP_NOWARN
| GFP_KERNEL
);
518 vlist
= vmalloc(size
);
525 error
= vfs_listxattr(d
, klist
, size
);
527 if (size
&& copy_to_user(list
, klist
, error
))
529 } else if (error
== -ERANGE
&& size
>= XATTR_LIST_MAX
) {
530 /* The file system tried to returned a list bigger
531 than XATTR_LIST_MAX bytes. Not possible. */
541 SYSCALL_DEFINE3(listxattr
, const char __user
*, pathname
, char __user
*, list
,
547 error
= user_path(pathname
, &path
);
550 error
= listxattr(path
.dentry
, list
, size
);
555 SYSCALL_DEFINE3(llistxattr
, const char __user
*, pathname
, char __user
*, list
,
561 error
= user_lpath(pathname
, &path
);
564 error
= listxattr(path
.dentry
, list
, size
);
569 SYSCALL_DEFINE3(flistxattr
, int, fd
, char __user
*, list
, size_t, size
)
573 ssize_t error
= -EBADF
;
575 f
= fget_light(fd
, &fput_needed
);
578 audit_inode(NULL
, f
->f_path
.dentry
);
579 error
= listxattr(f
->f_path
.dentry
, list
, size
);
580 fput_light(f
, fput_needed
);
585 * Extended attribute REMOVE operations
588 removexattr(struct dentry
*d
, const char __user
*name
)
591 char kname
[XATTR_NAME_MAX
+ 1];
593 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
594 if (error
== 0 || error
== sizeof(kname
))
599 return vfs_removexattr(d
, kname
);
602 SYSCALL_DEFINE2(removexattr
, const char __user
*, pathname
,
603 const char __user
*, name
)
608 error
= user_path(pathname
, &path
);
611 error
= mnt_want_write(path
.mnt
);
613 error
= removexattr(path
.dentry
, name
);
614 mnt_drop_write(path
.mnt
);
620 SYSCALL_DEFINE2(lremovexattr
, const char __user
*, pathname
,
621 const char __user
*, name
)
626 error
= user_lpath(pathname
, &path
);
629 error
= mnt_want_write(path
.mnt
);
631 error
= removexattr(path
.dentry
, name
);
632 mnt_drop_write(path
.mnt
);
638 SYSCALL_DEFINE2(fremovexattr
, int, fd
, const char __user
*, name
)
642 struct dentry
*dentry
;
645 f
= fget_light(fd
, &fput_needed
);
648 dentry
= f
->f_path
.dentry
;
649 audit_inode(NULL
, dentry
);
650 error
= mnt_want_write_file(f
);
652 error
= removexattr(dentry
, name
);
653 mnt_drop_write_file(f
);
655 fput_light(f
, fput_needed
);
661 strcmp_prefix(const char *a
, const char *a_prefix
)
663 while (*a_prefix
&& *a
== *a_prefix
) {
667 return *a_prefix
? NULL
: a
;
671 * In order to implement different sets of xattr operations for each xattr
672 * prefix with the generic xattr API, a filesystem should create a
673 * null-terminated array of struct xattr_handler (one for each prefix) and
674 * hang a pointer to it off of the s_xattr field of the superblock.
676 * The generic_fooxattr() functions will use this list to dispatch xattr
677 * operations to the correct xattr_handler.
679 #define for_each_xattr_handler(handlers, handler) \
680 for ((handler) = *(handlers)++; \
682 (handler) = *(handlers)++)
685 * Find the xattr_handler with the matching prefix.
687 static const struct xattr_handler
*
688 xattr_resolve_name(const struct xattr_handler
**handlers
, const char **name
)
690 const struct xattr_handler
*handler
;
695 for_each_xattr_handler(handlers
, handler
) {
696 const char *n
= strcmp_prefix(*name
, handler
->prefix
);
706 * Find the handler for the prefix and dispatch its get() operation.
709 generic_getxattr(struct dentry
*dentry
, const char *name
, void *buffer
, size_t size
)
711 const struct xattr_handler
*handler
;
713 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
716 return handler
->get(dentry
, name
, buffer
, size
, handler
->flags
);
720 * Combine the results of the list() operation from every xattr_handler in the
724 generic_listxattr(struct dentry
*dentry
, char *buffer
, size_t buffer_size
)
726 const struct xattr_handler
*handler
, **handlers
= dentry
->d_sb
->s_xattr
;
727 unsigned int size
= 0;
730 for_each_xattr_handler(handlers
, handler
) {
731 size
+= handler
->list(dentry
, NULL
, 0, NULL
, 0,
737 for_each_xattr_handler(handlers
, handler
) {
738 size
= handler
->list(dentry
, buf
, buffer_size
,
739 NULL
, 0, handler
->flags
);
740 if (size
> buffer_size
)
751 * Find the handler for the prefix and dispatch its set() operation.
754 generic_setxattr(struct dentry
*dentry
, const char *name
, const void *value
, size_t size
, int flags
)
756 const struct xattr_handler
*handler
;
759 value
= ""; /* empty EA, do not remove */
760 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
763 return handler
->set(dentry
, name
, value
, size
, flags
, handler
->flags
);
767 * Find the handler for the prefix and dispatch its set() operation to remove
768 * any associated extended attribute.
771 generic_removexattr(struct dentry
*dentry
, const char *name
)
773 const struct xattr_handler
*handler
;
775 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
778 return handler
->set(dentry
, name
, NULL
, 0,
779 XATTR_REPLACE
, handler
->flags
);
782 EXPORT_SYMBOL(generic_getxattr
);
783 EXPORT_SYMBOL(generic_listxattr
);
784 EXPORT_SYMBOL(generic_setxattr
);
785 EXPORT_SYMBOL(generic_removexattr
);