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)
403 struct dentry *dentry;
409 dentry = f->f_path.dentry;
410 audit_inode(NULL, dentry);
411 error = mnt_want_write_file(f);
413 error = setxattr(dentry, name, value, size, flags);
414 mnt_drop_write_file(f);
421 * Extended attribute GET operations
424 getxattr(struct dentry *d, const char __user *name, void __user *value,
429 char kname[XATTR_NAME_MAX + 1];
431 error = strncpy_from_user(kname, name, sizeof(kname));
432 if (error == 0 || error == sizeof(kname))
438 if (size > XATTR_SIZE_MAX)
439 size = XATTR_SIZE_MAX;
440 kvalue = kzalloc(size, GFP_KERNEL);
445 error = vfs_getxattr(d, kname, kvalue, size);
447 if (size && copy_to_user(value, kvalue, error))
449 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
450 /* The file system tried to returned a value bigger
451 than XATTR_SIZE_MAX bytes. Not possible. */
458 SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
459 const char __user *, name, void __user *, value, size_t, size)
464 error = user_path(pathname, &path);
467 error = getxattr(path.dentry, name, value, size);
472 SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
473 const char __user *, name, void __user *, value, size_t, size)
478 error = user_lpath(pathname, &path);
481 error = getxattr(path.dentry, name, value, size);
486 SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
487 void __user *, value, size_t, size)
490 ssize_t error = -EBADF;
495 audit_inode(NULL, f->f_path.dentry);
496 error = getxattr(f->f_path.dentry, name, value, size);
502 * Extended attribute LIST operations
505 listxattr(struct dentry *d, char __user *list, size_t size)
509 char *vlist = NULL; /* If non-NULL, we used vmalloc() */
512 if (size > XATTR_LIST_MAX)
513 size = XATTR_LIST_MAX;
514 klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
516 vlist = vmalloc(size);
523 error = vfs_listxattr(d, klist, size);
525 if (size && copy_to_user(list, klist, error))
527 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
528 /* The file system tried to returned a list bigger
529 than XATTR_LIST_MAX bytes. Not possible. */
539 SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
545 error = user_path(pathname, &path);
548 error = listxattr(path.dentry, list, size);
553 SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
559 error = user_lpath(pathname, &path);
562 error = listxattr(path.dentry, list, size);
567 SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
570 ssize_t error = -EBADF;
575 audit_inode(NULL, f->f_path.dentry);
576 error = listxattr(f->f_path.dentry, list, size);
582 * Extended attribute REMOVE operations
585 removexattr(struct dentry *d, const char __user *name)
588 char kname[XATTR_NAME_MAX + 1];
590 error = strncpy_from_user(kname, name, sizeof(kname));
591 if (error == 0 || error == sizeof(kname))
596 return vfs_removexattr(d, kname);
599 SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
600 const char __user *, name)
605 error = user_path(pathname, &path);
608 error = mnt_want_write(path.mnt);
610 error = removexattr(path.dentry, name);
611 mnt_drop_write(path.mnt);
617 SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
618 const char __user *, name)
623 error = user_lpath(pathname, &path);
626 error = mnt_want_write(path.mnt);
628 error = removexattr(path.dentry, name);
629 mnt_drop_write(path.mnt);
635 SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
638 struct dentry *dentry;
644 dentry = f->f_path.dentry;
645 audit_inode(NULL, dentry);
646 error = mnt_want_write_file(f);
648 error = removexattr(dentry, name);
649 mnt_drop_write_file(f);
657 strcmp_prefix(const char *a, const char *a_prefix)
659 while (*a_prefix && *a == *a_prefix) {
663 return *a_prefix ? NULL : a;
667 * In order to implement different sets of xattr operations for each xattr
668 * prefix with the generic xattr API, a filesystem should create a
669 * null-terminated array of struct xattr_handler (one for each prefix) and
670 * hang a pointer to it off of the s_xattr field of the superblock.
672 * The generic_fooxattr() functions will use this list to dispatch xattr
673 * operations to the correct xattr_handler.
675 #define for_each_xattr_handler(handlers, handler) \
676 for ((handler) = *(handlers)++; \
678 (handler) = *(handlers)++)
681 * Find the xattr_handler with the matching prefix.
683 static const struct xattr_handler *
684 xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
686 const struct xattr_handler *handler;
691 for_each_xattr_handler(handlers, handler) {
692 const char *n = strcmp_prefix(*name, handler->prefix);
702 * Find the handler for the prefix and dispatch its get() operation.
705 generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
707 const struct xattr_handler *handler;
709 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
712 return handler->get(dentry, name, buffer, size, handler->flags);
716 * Combine the results of the list() operation from every xattr_handler in the
720 generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
722 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
723 unsigned int size = 0;
726 for_each_xattr_handler(handlers, handler) {
727 size += handler->list(dentry, NULL, 0, NULL, 0,
733 for_each_xattr_handler(handlers, handler) {
734 size = handler->list(dentry, buf, buffer_size,
735 NULL, 0, handler->flags);
736 if (size > buffer_size)
747 * Find the handler for the prefix and dispatch its set() operation.
750 generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
752 const struct xattr_handler *handler;
755 value = ""; /* empty EA, do not remove */
756 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
759 return handler->set(dentry, name, value, size, flags, handler->flags);
763 * Find the handler for the prefix and dispatch its set() operation to remove
764 * any associated extended attribute.
767 generic_removexattr(struct dentry *dentry, const char *name)
769 const struct xattr_handler *handler;
771 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
774 return handler->set(dentry, name, NULL, 0,
775 XATTR_REPLACE, handler->flags);
778 EXPORT_SYMBOL(generic_getxattr);
779 EXPORT_SYMBOL(generic_listxattr);
780 EXPORT_SYMBOL(generic_setxattr);
781 EXPORT_SYMBOL(generic_removexattr);