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/syscalls.h>
18 #include <linux/module.h>
19 #include <linux/fsnotify.h>
20 #include <linux/audit.h>
21 #include <asm/uaccess.h>
25 * Check permissions for extended attribute access. This is a bit complicated
26 * because different namespaces have very different rules.
29 xattr_permission(struct inode *inode, const char *name, int mask)
32 * We can never set or remove an extended attribute on a read-only
33 * filesystem or on an immutable / append-only inode.
35 if (mask & MAY_WRITE) {
36 if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
41 * No restriction for security.* and system.* from the VFS. Decision
42 * on these is left to the underlying filesystem / security module.
44 if (!strncmp(name, XATTR_SECURITY_PREFIX, XATTR_SECURITY_PREFIX_LEN) ||
45 !strncmp(name, XATTR_SYSTEM_PREFIX, XATTR_SYSTEM_PREFIX_LEN))
49 * The trusted.* namespace can only be accessed by a privileged user.
51 if (!strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN))
52 return (capable(CAP_SYS_ADMIN) ? 0 : -EPERM);
54 /* In user.* namespace, only regular files and directories can have
55 * extended attributes. For sticky directories, only the owner and
56 * privileged user can write attributes.
58 if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
59 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
61 if (S_ISDIR(inode->i_mode) && (inode->i_mode & S_ISVTX) &&
62 (mask & MAY_WRITE) && !is_owner_or_cap(inode))
66 return inode_permission(inode, mask);
70 vfs_setxattr(struct dentry *dentry, const char *name, const void *value,
71 size_t size, int flags)
73 struct inode *inode = dentry->d_inode;
76 error = xattr_permission(inode, name, MAY_WRITE);
80 mutex_lock(&inode->i_mutex);
81 error = security_inode_setxattr(dentry, name, value, size, flags);
85 if (inode->i_op->setxattr) {
86 error = inode->i_op->setxattr(dentry, name, value, size, flags);
88 fsnotify_xattr(dentry);
89 security_inode_post_setxattr(dentry, name, value,
92 } else if (!strncmp(name, XATTR_SECURITY_PREFIX,
93 XATTR_SECURITY_PREFIX_LEN)) {
94 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
95 error = security_inode_setsecurity(inode, suffix, value,
98 fsnotify_xattr(dentry);
101 mutex_unlock(&inode->i_mutex);
104 EXPORT_SYMBOL_GPL(vfs_setxattr);
107 xattr_getsecurity(struct inode *inode, const char *name, void *value,
113 if (!value || !size) {
114 len = security_inode_getsecurity(inode, name, &buffer, false);
118 len = security_inode_getsecurity(inode, name, &buffer, true);
125 memcpy(value, buffer, len);
127 security_release_secctx(buffer, len);
131 EXPORT_SYMBOL_GPL(xattr_getsecurity);
134 vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
136 struct inode *inode = dentry->d_inode;
139 error = xattr_permission(inode, name, MAY_READ);
143 error = security_inode_getxattr(dentry, name);
147 if (!strncmp(name, XATTR_SECURITY_PREFIX,
148 XATTR_SECURITY_PREFIX_LEN)) {
149 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
150 int ret = xattr_getsecurity(inode, suffix, value, size);
152 * Only overwrite the return value if a security module
153 * is actually active.
155 if (ret == -EOPNOTSUPP)
160 if (inode->i_op->getxattr)
161 error = inode->i_op->getxattr(dentry, name, value, size);
167 EXPORT_SYMBOL_GPL(vfs_getxattr);
170 vfs_listxattr(struct dentry *d, char *list, size_t size)
174 error = security_inode_listxattr(d);
178 if (d->d_inode->i_op && d->d_inode->i_op->listxattr) {
179 error = d->d_inode->i_op->listxattr(d, list, size);
181 error = security_inode_listsecurity(d->d_inode, list, size);
182 if (size && error > size)
187 EXPORT_SYMBOL_GPL(vfs_listxattr);
190 vfs_removexattr(struct dentry *dentry, const char *name)
192 struct inode *inode = dentry->d_inode;
195 if (!inode->i_op->removexattr)
198 error = xattr_permission(inode, name, MAY_WRITE);
202 error = security_inode_removexattr(dentry, name);
206 mutex_lock(&inode->i_mutex);
207 error = inode->i_op->removexattr(dentry, name);
208 mutex_unlock(&inode->i_mutex);
211 fsnotify_xattr(dentry);
214 EXPORT_SYMBOL_GPL(vfs_removexattr);
218 * Extended attribute SET operations
221 setxattr(struct dentry *d, const char __user *name, const void __user *value,
222 size_t size, int flags)
226 char kname[XATTR_NAME_MAX + 1];
228 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
231 error = strncpy_from_user(kname, name, sizeof(kname));
232 if (error == 0 || error == sizeof(kname))
238 if (size > XATTR_SIZE_MAX)
240 kvalue = kmalloc(size, GFP_KERNEL);
243 if (copy_from_user(kvalue, value, size)) {
249 error = vfs_setxattr(d, kname, kvalue, size, flags);
255 sys_setxattr(const char __user *pathname, const char __user *name,
256 const void __user *value, size_t size, int flags)
261 error = user_path(pathname, &path);
264 error = mnt_want_write(path.mnt);
266 error = setxattr(path.dentry, name, value, size, flags);
267 mnt_drop_write(path.mnt);
274 sys_lsetxattr(const char __user *pathname, const char __user *name,
275 const void __user *value, size_t size, int flags)
280 error = user_lpath(pathname, &path);
283 error = mnt_want_write(path.mnt);
285 error = setxattr(path.dentry, name, value, size, flags);
286 mnt_drop_write(path.mnt);
293 sys_fsetxattr(int fd, const char __user *name, const void __user *value,
294 size_t size, int flags)
297 struct dentry *dentry;
303 dentry = f->f_path.dentry;
304 audit_inode(NULL, dentry);
305 error = mnt_want_write(f->f_path.mnt);
307 error = setxattr(dentry, name, value, size, flags);
308 mnt_drop_write(f->f_path.mnt);
315 * Extended attribute GET operations
318 getxattr(struct dentry *d, const char __user *name, void __user *value,
323 char kname[XATTR_NAME_MAX + 1];
325 error = strncpy_from_user(kname, name, sizeof(kname));
326 if (error == 0 || error == sizeof(kname))
332 if (size > XATTR_SIZE_MAX)
333 size = XATTR_SIZE_MAX;
334 kvalue = kzalloc(size, GFP_KERNEL);
339 error = vfs_getxattr(d, kname, kvalue, size);
341 if (size && copy_to_user(value, kvalue, error))
343 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
344 /* The file system tried to returned a value bigger
345 than XATTR_SIZE_MAX bytes. Not possible. */
353 sys_getxattr(const char __user *pathname, const char __user *name,
354 void __user *value, size_t size)
359 error = user_path(pathname, &path);
362 error = getxattr(path.dentry, name, value, size);
368 sys_lgetxattr(const char __user *pathname, const char __user *name, void __user *value,
374 error = user_lpath(pathname, &path);
377 error = getxattr(path.dentry, name, value, size);
383 sys_fgetxattr(int fd, const char __user *name, void __user *value, size_t size)
386 ssize_t error = -EBADF;
391 audit_inode(NULL, f->f_path.dentry);
392 error = getxattr(f->f_path.dentry, name, value, size);
398 * Extended attribute LIST operations
401 listxattr(struct dentry *d, char __user *list, size_t size)
407 if (size > XATTR_LIST_MAX)
408 size = XATTR_LIST_MAX;
409 klist = kmalloc(size, GFP_KERNEL);
414 error = vfs_listxattr(d, klist, size);
416 if (size && copy_to_user(list, klist, error))
418 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
419 /* The file system tried to returned a list bigger
420 than XATTR_LIST_MAX bytes. Not possible. */
428 sys_listxattr(const char __user *pathname, char __user *list, size_t size)
433 error = user_path(pathname, &path);
436 error = listxattr(path.dentry, list, size);
442 sys_llistxattr(const char __user *pathname, char __user *list, size_t size)
447 error = user_lpath(pathname, &path);
450 error = listxattr(path.dentry, list, size);
456 sys_flistxattr(int fd, char __user *list, size_t size)
459 ssize_t error = -EBADF;
464 audit_inode(NULL, f->f_path.dentry);
465 error = listxattr(f->f_path.dentry, list, size);
471 * Extended attribute REMOVE operations
474 removexattr(struct dentry *d, const char __user *name)
477 char kname[XATTR_NAME_MAX + 1];
479 error = strncpy_from_user(kname, name, sizeof(kname));
480 if (error == 0 || error == sizeof(kname))
485 return vfs_removexattr(d, kname);
489 sys_removexattr(const char __user *pathname, const char __user *name)
494 error = user_path(pathname, &path);
497 error = mnt_want_write(path.mnt);
499 error = removexattr(path.dentry, name);
500 mnt_drop_write(path.mnt);
507 sys_lremovexattr(const char __user *pathname, const char __user *name)
512 error = user_lpath(pathname, &path);
515 error = mnt_want_write(path.mnt);
517 error = removexattr(path.dentry, name);
518 mnt_drop_write(path.mnt);
525 sys_fremovexattr(int fd, const char __user *name)
528 struct dentry *dentry;
534 dentry = f->f_path.dentry;
535 audit_inode(NULL, dentry);
536 error = mnt_want_write(f->f_path.mnt);
538 error = removexattr(dentry, name);
539 mnt_drop_write(f->f_path.mnt);
547 strcmp_prefix(const char *a, const char *a_prefix)
549 while (*a_prefix && *a == *a_prefix) {
553 return *a_prefix ? NULL : a;
557 * In order to implement different sets of xattr operations for each xattr
558 * prefix with the generic xattr API, a filesystem should create a
559 * null-terminated array of struct xattr_handler (one for each prefix) and
560 * hang a pointer to it off of the s_xattr field of the superblock.
562 * The generic_fooxattr() functions will use this list to dispatch xattr
563 * operations to the correct xattr_handler.
565 #define for_each_xattr_handler(handlers, handler) \
566 for ((handler) = *(handlers)++; \
568 (handler) = *(handlers)++)
571 * Find the xattr_handler with the matching prefix.
573 static struct xattr_handler *
574 xattr_resolve_name(struct xattr_handler **handlers, const char **name)
576 struct xattr_handler *handler;
581 for_each_xattr_handler(handlers, handler) {
582 const char *n = strcmp_prefix(*name, handler->prefix);
592 * Find the handler for the prefix and dispatch its get() operation.
595 generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
597 struct xattr_handler *handler;
598 struct inode *inode = dentry->d_inode;
600 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
603 return handler->get(inode, name, buffer, size);
607 * Combine the results of the list() operation from every xattr_handler in the
611 generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
613 struct inode *inode = dentry->d_inode;
614 struct xattr_handler *handler, **handlers = inode->i_sb->s_xattr;
615 unsigned int size = 0;
618 for_each_xattr_handler(handlers, handler)
619 size += handler->list(inode, NULL, 0, NULL, 0);
623 for_each_xattr_handler(handlers, handler) {
624 size = handler->list(inode, buf, buffer_size, NULL, 0);
625 if (size > buffer_size)
636 * Find the handler for the prefix and dispatch its set() operation.
639 generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
641 struct xattr_handler *handler;
642 struct inode *inode = dentry->d_inode;
645 value = ""; /* empty EA, do not remove */
646 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
649 return handler->set(inode, name, value, size, flags);
653 * Find the handler for the prefix and dispatch its set() operation to remove
654 * any associated extended attribute.
657 generic_removexattr(struct dentry *dentry, const char *name)
659 struct xattr_handler *handler;
660 struct inode *inode = dentry->d_inode;
662 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
665 return handler->set(inode, name, NULL, 0, XATTR_REPLACE);
668 EXPORT_SYMBOL(generic_getxattr);
669 EXPORT_SYMBOL(generic_listxattr);
670 EXPORT_SYMBOL(generic_setxattr);
671 EXPORT_SYMBOL(generic_removexattr);