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/smp_lock.h>
13 #include <linux/file.h>
14 #include <linux/xattr.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) {
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 accessed by a privilegued user.
53 if (!strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN))
54 return (capable(CAP_SYS_ADMIN) ? 0 : -EPERM);
56 if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
57 if (!S_ISREG(inode->i_mode) &&
58 (!S_ISDIR(inode->i_mode) || inode->i_mode & S_ISVTX))
62 return permission(inode, mask, NULL);
66 vfs_setxattr(struct dentry *dentry, char *name, void *value,
67 size_t size, int flags)
69 struct inode *inode = dentry->d_inode;
72 error = xattr_permission(inode, name, MAY_WRITE);
76 mutex_lock(&inode->i_mutex);
77 error = security_inode_setxattr(dentry, name, value, size, flags);
81 if (inode->i_op->setxattr) {
82 error = inode->i_op->setxattr(dentry, name, value, size, flags);
84 fsnotify_xattr(dentry);
85 security_inode_post_setxattr(dentry, name, value,
88 } else if (!strncmp(name, XATTR_SECURITY_PREFIX,
89 XATTR_SECURITY_PREFIX_LEN)) {
90 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
91 error = security_inode_setsecurity(inode, suffix, value,
94 fsnotify_xattr(dentry);
97 mutex_unlock(&inode->i_mutex);
100 EXPORT_SYMBOL_GPL(vfs_setxattr);
103 vfs_getxattr(struct dentry *dentry, char *name, void *value, size_t size)
105 struct inode *inode = dentry->d_inode;
108 error = xattr_permission(inode, name, MAY_READ);
112 error = security_inode_getxattr(dentry, name);
116 if (inode->i_op->getxattr)
117 error = inode->i_op->getxattr(dentry, name, value, size);
121 if (!strncmp(name, XATTR_SECURITY_PREFIX,
122 XATTR_SECURITY_PREFIX_LEN)) {
123 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
124 int ret = security_inode_getsecurity(inode, suffix, value,
127 * Only overwrite the return value if a security module
128 * is actually active.
130 if (ret != -EOPNOTSUPP)
136 EXPORT_SYMBOL_GPL(vfs_getxattr);
139 vfs_removexattr(struct dentry *dentry, char *name)
141 struct inode *inode = dentry->d_inode;
144 if (!inode->i_op->removexattr)
147 error = xattr_permission(inode, name, MAY_WRITE);
151 error = security_inode_removexattr(dentry, name);
155 mutex_lock(&inode->i_mutex);
156 error = inode->i_op->removexattr(dentry, name);
157 mutex_unlock(&inode->i_mutex);
160 fsnotify_xattr(dentry);
163 EXPORT_SYMBOL_GPL(vfs_removexattr);
167 * Extended attribute SET operations
170 setxattr(struct dentry *d, char __user *name, void __user *value,
171 size_t size, int flags)
175 char kname[XATTR_NAME_MAX + 1];
177 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
180 error = strncpy_from_user(kname, name, sizeof(kname));
181 if (error == 0 || error == sizeof(kname))
187 if (size > XATTR_SIZE_MAX)
189 kvalue = kmalloc(size, GFP_KERNEL);
192 if (copy_from_user(kvalue, value, size)) {
198 error = vfs_setxattr(d, kname, kvalue, size, flags);
204 sys_setxattr(char __user *path, char __user *name, void __user *value,
205 size_t size, int flags)
210 error = user_path_walk(path, &nd);
213 error = setxattr(nd.dentry, name, value, size, flags);
219 sys_lsetxattr(char __user *path, char __user *name, void __user *value,
220 size_t size, int flags)
225 error = user_path_walk_link(path, &nd);
228 error = setxattr(nd.dentry, name, value, size, flags);
234 sys_fsetxattr(int fd, char __user *name, void __user *value,
235 size_t size, int flags)
238 struct dentry *dentry;
244 dentry = f->f_dentry;
245 audit_inode(NULL, dentry->d_inode, 0);
246 error = setxattr(dentry, name, value, size, flags);
252 * Extended attribute GET operations
255 getxattr(struct dentry *d, char __user *name, void __user *value, size_t size)
259 char kname[XATTR_NAME_MAX + 1];
261 error = strncpy_from_user(kname, name, sizeof(kname));
262 if (error == 0 || error == sizeof(kname))
268 if (size > XATTR_SIZE_MAX)
269 size = XATTR_SIZE_MAX;
270 kvalue = kzalloc(size, GFP_KERNEL);
275 error = vfs_getxattr(d, kname, kvalue, size);
277 if (size && copy_to_user(value, kvalue, error))
279 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
280 /* The file system tried to returned a value bigger
281 than XATTR_SIZE_MAX bytes. Not possible. */
289 sys_getxattr(char __user *path, char __user *name, void __user *value,
295 error = user_path_walk(path, &nd);
298 error = getxattr(nd.dentry, name, value, size);
304 sys_lgetxattr(char __user *path, char __user *name, void __user *value,
310 error = user_path_walk_link(path, &nd);
313 error = getxattr(nd.dentry, name, value, size);
319 sys_fgetxattr(int fd, char __user *name, void __user *value, size_t size)
322 ssize_t error = -EBADF;
327 error = getxattr(f->f_dentry, name, value, size);
333 * Extended attribute LIST operations
336 listxattr(struct dentry *d, char __user *list, size_t size)
342 if (size > XATTR_LIST_MAX)
343 size = XATTR_LIST_MAX;
344 klist = kmalloc(size, GFP_KERNEL);
349 error = security_inode_listxattr(d);
353 if (d->d_inode->i_op && d->d_inode->i_op->listxattr) {
354 error = d->d_inode->i_op->listxattr(d, klist, size);
356 error = security_inode_listsecurity(d->d_inode, klist, size);
357 if (size && error > size)
361 if (size && copy_to_user(list, klist, error))
363 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
364 /* The file system tried to returned a list bigger
365 than XATTR_LIST_MAX bytes. Not possible. */
374 sys_listxattr(char __user *path, char __user *list, size_t size)
379 error = user_path_walk(path, &nd);
382 error = listxattr(nd.dentry, list, size);
388 sys_llistxattr(char __user *path, char __user *list, size_t size)
393 error = user_path_walk_link(path, &nd);
396 error = listxattr(nd.dentry, list, size);
402 sys_flistxattr(int fd, char __user *list, size_t size)
405 ssize_t error = -EBADF;
410 error = listxattr(f->f_dentry, list, size);
416 * Extended attribute REMOVE operations
419 removexattr(struct dentry *d, char __user *name)
422 char kname[XATTR_NAME_MAX + 1];
424 error = strncpy_from_user(kname, name, sizeof(kname));
425 if (error == 0 || error == sizeof(kname))
430 return vfs_removexattr(d, kname);
434 sys_removexattr(char __user *path, char __user *name)
439 error = user_path_walk(path, &nd);
442 error = removexattr(nd.dentry, name);
448 sys_lremovexattr(char __user *path, char __user *name)
453 error = user_path_walk_link(path, &nd);
456 error = removexattr(nd.dentry, name);
462 sys_fremovexattr(int fd, char __user *name)
465 struct dentry *dentry;
471 dentry = f->f_dentry;
472 audit_inode(NULL, dentry->d_inode, 0);
473 error = removexattr(dentry, name);
480 strcmp_prefix(const char *a, const char *a_prefix)
482 while (*a_prefix && *a == *a_prefix) {
486 return *a_prefix ? NULL : a;
490 * In order to implement different sets of xattr operations for each xattr
491 * prefix with the generic xattr API, a filesystem should create a
492 * null-terminated array of struct xattr_handler (one for each prefix) and
493 * hang a pointer to it off of the s_xattr field of the superblock.
495 * The generic_fooxattr() functions will use this list to dispatch xattr
496 * operations to the correct xattr_handler.
498 #define for_each_xattr_handler(handlers, handler) \
499 for ((handler) = *(handlers)++; \
501 (handler) = *(handlers)++)
504 * Find the xattr_handler with the matching prefix.
506 static struct xattr_handler *
507 xattr_resolve_name(struct xattr_handler **handlers, const char **name)
509 struct xattr_handler *handler;
514 for_each_xattr_handler(handlers, handler) {
515 const char *n = strcmp_prefix(*name, handler->prefix);
525 * Find the handler for the prefix and dispatch its get() operation.
528 generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
530 struct xattr_handler *handler;
531 struct inode *inode = dentry->d_inode;
533 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
536 return handler->get(inode, name, buffer, size);
540 * Combine the results of the list() operation from every xattr_handler in the
544 generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
546 struct inode *inode = dentry->d_inode;
547 struct xattr_handler *handler, **handlers = inode->i_sb->s_xattr;
548 unsigned int size = 0;
551 for_each_xattr_handler(handlers, handler)
552 size += handler->list(inode, NULL, 0, NULL, 0);
556 for_each_xattr_handler(handlers, handler) {
557 size = handler->list(inode, buf, buffer_size, NULL, 0);
558 if (size > buffer_size)
569 * Find the handler for the prefix and dispatch its set() operation.
572 generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
574 struct xattr_handler *handler;
575 struct inode *inode = dentry->d_inode;
578 value = ""; /* empty EA, do not remove */
579 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
582 return handler->set(inode, name, value, size, flags);
586 * Find the handler for the prefix and dispatch its set() operation to remove
587 * any associated extended attribute.
590 generic_removexattr(struct dentry *dentry, const char *name)
592 struct xattr_handler *handler;
593 struct inode *inode = dentry->d_inode;
595 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
598 return handler->set(inode, name, NULL, 0, XATTR_REPLACE);
601 EXPORT_SYMBOL(generic_getxattr);
602 EXPORT_SYMBOL(generic_listxattr);
603 EXPORT_SYMBOL(generic_setxattr);
604 EXPORT_SYMBOL(generic_removexattr);