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 error
= security_inode_removexattr(dentry
, name
);
303 mutex_lock(&inode
->i_mutex
);
304 error
= inode
->i_op
->removexattr(dentry
, name
);
305 mutex_unlock(&inode
->i_mutex
);
308 fsnotify_xattr(dentry
);
309 evm_inode_post_removexattr(dentry
, name
);
313 EXPORT_SYMBOL_GPL(vfs_removexattr
);
317 * Extended attribute SET operations
320 setxattr(struct dentry
*d
, const char __user
*name
, const void __user
*value
,
321 size_t size
, int flags
)
325 void *vvalue
= NULL
; /* If non-NULL, we used vmalloc() */
326 char kname
[XATTR_NAME_MAX
+ 1];
328 if (flags
& ~(XATTR_CREATE
|XATTR_REPLACE
))
331 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
332 if (error
== 0 || error
== sizeof(kname
))
338 if (size
> XATTR_SIZE_MAX
)
340 kvalue
= kmalloc(size
, GFP_KERNEL
| __GFP_NOWARN
);
342 vvalue
= vmalloc(size
);
347 if (copy_from_user(kvalue
, value
, size
)) {
351 if ((strcmp(kname
, XATTR_NAME_POSIX_ACL_ACCESS
) == 0) ||
352 (strcmp(kname
, XATTR_NAME_POSIX_ACL_DEFAULT
) == 0))
353 posix_acl_fix_xattr_from_user(kvalue
, size
);
356 error
= vfs_setxattr(d
, kname
, kvalue
, size
, flags
);
365 SYSCALL_DEFINE5(setxattr
, const char __user
*, pathname
,
366 const char __user
*, name
, const void __user
*, value
,
367 size_t, size
, int, flags
)
372 error
= user_path(pathname
, &path
);
375 error
= mnt_want_write(path
.mnt
);
377 error
= setxattr(path
.dentry
, name
, value
, size
, flags
);
378 mnt_drop_write(path
.mnt
);
384 SYSCALL_DEFINE5(lsetxattr
, const char __user
*, pathname
,
385 const char __user
*, name
, const void __user
*, value
,
386 size_t, size
, int, flags
)
391 error
= user_lpath(pathname
, &path
);
394 error
= mnt_want_write(path
.mnt
);
396 error
= setxattr(path
.dentry
, name
, value
, size
, flags
);
397 mnt_drop_write(path
.mnt
);
403 SYSCALL_DEFINE5(fsetxattr
, int, fd
, const char __user
*, name
,
404 const void __user
*,value
, size_t, size
, int, flags
)
408 struct dentry
*dentry
;
411 f
= fget_light(fd
, &fput_needed
);
414 dentry
= f
->f_path
.dentry
;
415 audit_inode(NULL
, dentry
);
416 error
= mnt_want_write_file(f
);
418 error
= setxattr(dentry
, name
, value
, size
, flags
);
419 mnt_drop_write_file(f
);
421 fput_light(f
, fput_needed
);
426 * Extended attribute GET operations
429 getxattr(struct dentry
*d
, const char __user
*name
, void __user
*value
,
435 char kname
[XATTR_NAME_MAX
+ 1];
437 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
438 if (error
== 0 || error
== sizeof(kname
))
444 if (size
> XATTR_SIZE_MAX
)
445 size
= XATTR_SIZE_MAX
;
446 kvalue
= kzalloc(size
, GFP_KERNEL
| __GFP_NOWARN
);
448 vvalue
= vmalloc(size
);
455 error
= vfs_getxattr(d
, kname
, kvalue
, size
);
457 if ((strcmp(kname
, XATTR_NAME_POSIX_ACL_ACCESS
) == 0) ||
458 (strcmp(kname
, XATTR_NAME_POSIX_ACL_DEFAULT
) == 0))
459 posix_acl_fix_xattr_to_user(kvalue
, size
);
460 if (size
&& copy_to_user(value
, kvalue
, error
))
462 } else if (error
== -ERANGE
&& size
>= XATTR_SIZE_MAX
) {
463 /* The file system tried to returned a value bigger
464 than XATTR_SIZE_MAX bytes. Not possible. */
474 SYSCALL_DEFINE4(getxattr
, const char __user
*, pathname
,
475 const char __user
*, name
, void __user
*, value
, size_t, size
)
480 error
= user_path(pathname
, &path
);
483 error
= getxattr(path
.dentry
, name
, value
, size
);
488 SYSCALL_DEFINE4(lgetxattr
, const char __user
*, pathname
,
489 const char __user
*, name
, void __user
*, value
, size_t, size
)
494 error
= user_lpath(pathname
, &path
);
497 error
= getxattr(path
.dentry
, name
, value
, size
);
502 SYSCALL_DEFINE4(fgetxattr
, int, fd
, const char __user
*, name
,
503 void __user
*, value
, size_t, size
)
507 ssize_t error
= -EBADF
;
509 f
= fget_light(fd
, &fput_needed
);
512 audit_inode(NULL
, f
->f_path
.dentry
);
513 error
= getxattr(f
->f_path
.dentry
, name
, value
, size
);
514 fput_light(f
, fput_needed
);
519 * Extended attribute LIST operations
522 listxattr(struct dentry
*d
, char __user
*list
, size_t size
)
526 char *vlist
= NULL
; /* If non-NULL, we used vmalloc() */
529 if (size
> XATTR_LIST_MAX
)
530 size
= XATTR_LIST_MAX
;
531 klist
= kmalloc(size
, __GFP_NOWARN
| GFP_KERNEL
);
533 vlist
= vmalloc(size
);
540 error
= vfs_listxattr(d
, klist
, size
);
542 if (size
&& copy_to_user(list
, klist
, error
))
544 } else if (error
== -ERANGE
&& size
>= XATTR_LIST_MAX
) {
545 /* The file system tried to returned a list bigger
546 than XATTR_LIST_MAX bytes. Not possible. */
556 SYSCALL_DEFINE3(listxattr
, const char __user
*, pathname
, char __user
*, list
,
562 error
= user_path(pathname
, &path
);
565 error
= listxattr(path
.dentry
, list
, size
);
570 SYSCALL_DEFINE3(llistxattr
, const char __user
*, pathname
, char __user
*, list
,
576 error
= user_lpath(pathname
, &path
);
579 error
= listxattr(path
.dentry
, list
, size
);
584 SYSCALL_DEFINE3(flistxattr
, int, fd
, char __user
*, list
, size_t, size
)
588 ssize_t error
= -EBADF
;
590 f
= fget_light(fd
, &fput_needed
);
593 audit_inode(NULL
, f
->f_path
.dentry
);
594 error
= listxattr(f
->f_path
.dentry
, list
, size
);
595 fput_light(f
, fput_needed
);
600 * Extended attribute REMOVE operations
603 removexattr(struct dentry
*d
, const char __user
*name
)
606 char kname
[XATTR_NAME_MAX
+ 1];
608 error
= strncpy_from_user(kname
, name
, sizeof(kname
));
609 if (error
== 0 || error
== sizeof(kname
))
614 return vfs_removexattr(d
, kname
);
617 SYSCALL_DEFINE2(removexattr
, const char __user
*, pathname
,
618 const char __user
*, name
)
623 error
= user_path(pathname
, &path
);
626 error
= mnt_want_write(path
.mnt
);
628 error
= removexattr(path
.dentry
, name
);
629 mnt_drop_write(path
.mnt
);
635 SYSCALL_DEFINE2(lremovexattr
, const char __user
*, pathname
,
636 const char __user
*, name
)
641 error
= user_lpath(pathname
, &path
);
644 error
= mnt_want_write(path
.mnt
);
646 error
= removexattr(path
.dentry
, name
);
647 mnt_drop_write(path
.mnt
);
653 SYSCALL_DEFINE2(fremovexattr
, int, fd
, const char __user
*, name
)
657 struct dentry
*dentry
;
660 f
= fget_light(fd
, &fput_needed
);
663 dentry
= f
->f_path
.dentry
;
664 audit_inode(NULL
, dentry
);
665 error
= mnt_want_write_file(f
);
667 error
= removexattr(dentry
, name
);
668 mnt_drop_write_file(f
);
670 fput_light(f
, fput_needed
);
676 strcmp_prefix(const char *a
, const char *a_prefix
)
678 while (*a_prefix
&& *a
== *a_prefix
) {
682 return *a_prefix
? NULL
: a
;
686 * In order to implement different sets of xattr operations for each xattr
687 * prefix with the generic xattr API, a filesystem should create a
688 * null-terminated array of struct xattr_handler (one for each prefix) and
689 * hang a pointer to it off of the s_xattr field of the superblock.
691 * The generic_fooxattr() functions will use this list to dispatch xattr
692 * operations to the correct xattr_handler.
694 #define for_each_xattr_handler(handlers, handler) \
695 for ((handler) = *(handlers)++; \
697 (handler) = *(handlers)++)
700 * Find the xattr_handler with the matching prefix.
702 static const struct xattr_handler
*
703 xattr_resolve_name(const struct xattr_handler
**handlers
, const char **name
)
705 const struct xattr_handler
*handler
;
710 for_each_xattr_handler(handlers
, handler
) {
711 const char *n
= strcmp_prefix(*name
, handler
->prefix
);
721 * Find the handler for the prefix and dispatch its get() operation.
724 generic_getxattr(struct dentry
*dentry
, const char *name
, void *buffer
, size_t size
)
726 const struct xattr_handler
*handler
;
728 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
731 return handler
->get(dentry
, name
, buffer
, size
, handler
->flags
);
735 * Combine the results of the list() operation from every xattr_handler in the
739 generic_listxattr(struct dentry
*dentry
, char *buffer
, size_t buffer_size
)
741 const struct xattr_handler
*handler
, **handlers
= dentry
->d_sb
->s_xattr
;
742 unsigned int size
= 0;
745 for_each_xattr_handler(handlers
, handler
) {
746 size
+= handler
->list(dentry
, NULL
, 0, NULL
, 0,
752 for_each_xattr_handler(handlers
, handler
) {
753 size
= handler
->list(dentry
, buf
, buffer_size
,
754 NULL
, 0, handler
->flags
);
755 if (size
> buffer_size
)
766 * Find the handler for the prefix and dispatch its set() operation.
769 generic_setxattr(struct dentry
*dentry
, const char *name
, const void *value
, size_t size
, int flags
)
771 const struct xattr_handler
*handler
;
774 value
= ""; /* empty EA, do not remove */
775 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
778 return handler
->set(dentry
, name
, value
, size
, flags
, handler
->flags
);
782 * Find the handler for the prefix and dispatch its set() operation to remove
783 * any associated extended attribute.
786 generic_removexattr(struct dentry
*dentry
, const char *name
)
788 const struct xattr_handler
*handler
;
790 handler
= xattr_resolve_name(dentry
->d_sb
->s_xattr
, &name
);
793 return handler
->set(dentry
, name
, NULL
, 0,
794 XATTR_REPLACE
, handler
->flags
);
797 EXPORT_SYMBOL(generic_getxattr
);
798 EXPORT_SYMBOL(generic_listxattr
);
799 EXPORT_SYMBOL(generic_setxattr
);
800 EXPORT_SYMBOL(generic_removexattr
);