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 permission(inode, mask, NULL);
70 vfs_setxattr(struct dentry *dentry, char *name, 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, 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, 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, char __user *name, 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(char __user *path, char __user *name, void __user *value,
256 size_t size, int flags)
261 error = user_path_walk(path, &nd);
264 error = mnt_want_write(nd.path.mnt);
266 error = setxattr(nd.path.dentry, name, value, size, flags);
267 mnt_drop_write(nd.path.mnt);
274 sys_lsetxattr(char __user *path, char __user *name, void __user *value,
275 size_t size, int flags)
280 error = user_path_walk_link(path, &nd);
283 error = mnt_want_write(nd.path.mnt);
285 error = setxattr(nd.path.dentry, name, value, size, flags);
286 mnt_drop_write(nd.path.mnt);
293 sys_fsetxattr(int fd, char __user *name, 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, char __user *name, void __user *value, size_t size)
322 char kname[XATTR_NAME_MAX + 1];
324 error = strncpy_from_user(kname, name, sizeof(kname));
325 if (error == 0 || error == sizeof(kname))
331 if (size > XATTR_SIZE_MAX)
332 size = XATTR_SIZE_MAX;
333 kvalue = kzalloc(size, GFP_KERNEL);
338 error = vfs_getxattr(d, kname, kvalue, size);
340 if (size && copy_to_user(value, kvalue, error))
342 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
343 /* The file system tried to returned a value bigger
344 than XATTR_SIZE_MAX bytes. Not possible. */
352 sys_getxattr(char __user *path, char __user *name, void __user *value,
358 error = user_path_walk(path, &nd);
361 error = getxattr(nd.path.dentry, name, value, size);
367 sys_lgetxattr(char __user *path, char __user *name, void __user *value,
373 error = user_path_walk_link(path, &nd);
376 error = getxattr(nd.path.dentry, name, value, size);
382 sys_fgetxattr(int fd, char __user *name, void __user *value, size_t size)
385 ssize_t error = -EBADF;
390 audit_inode(NULL, f->f_path.dentry);
391 error = getxattr(f->f_path.dentry, name, value, size);
397 * Extended attribute LIST operations
400 listxattr(struct dentry *d, char __user *list, size_t size)
406 if (size > XATTR_LIST_MAX)
407 size = XATTR_LIST_MAX;
408 klist = kmalloc(size, GFP_KERNEL);
413 error = vfs_listxattr(d, klist, size);
415 if (size && copy_to_user(list, klist, error))
417 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
418 /* The file system tried to returned a list bigger
419 than XATTR_LIST_MAX bytes. Not possible. */
427 sys_listxattr(char __user *path, char __user *list, size_t size)
432 error = user_path_walk(path, &nd);
435 error = listxattr(nd.path.dentry, list, size);
441 sys_llistxattr(char __user *path, char __user *list, size_t size)
446 error = user_path_walk_link(path, &nd);
449 error = listxattr(nd.path.dentry, list, size);
455 sys_flistxattr(int fd, char __user *list, size_t size)
458 ssize_t error = -EBADF;
463 audit_inode(NULL, f->f_path.dentry);
464 error = listxattr(f->f_path.dentry, list, size);
470 * Extended attribute REMOVE operations
473 removexattr(struct dentry *d, char __user *name)
476 char kname[XATTR_NAME_MAX + 1];
478 error = strncpy_from_user(kname, name, sizeof(kname));
479 if (error == 0 || error == sizeof(kname))
484 return vfs_removexattr(d, kname);
488 sys_removexattr(char __user *path, char __user *name)
493 error = user_path_walk(path, &nd);
496 error = mnt_want_write(nd.path.mnt);
498 error = removexattr(nd.path.dentry, name);
499 mnt_drop_write(nd.path.mnt);
506 sys_lremovexattr(char __user *path, char __user *name)
511 error = user_path_walk_link(path, &nd);
514 error = mnt_want_write(nd.path.mnt);
516 error = removexattr(nd.path.dentry, name);
517 mnt_drop_write(nd.path.mnt);
524 sys_fremovexattr(int fd, char __user *name)
527 struct dentry *dentry;
533 dentry = f->f_path.dentry;
534 audit_inode(NULL, dentry);
535 error = mnt_want_write(f->f_path.mnt);
537 error = removexattr(dentry, name);
538 mnt_drop_write(f->f_path.mnt);
546 strcmp_prefix(const char *a, const char *a_prefix)
548 while (*a_prefix && *a == *a_prefix) {
552 return *a_prefix ? NULL : a;
556 * In order to implement different sets of xattr operations for each xattr
557 * prefix with the generic xattr API, a filesystem should create a
558 * null-terminated array of struct xattr_handler (one for each prefix) and
559 * hang a pointer to it off of the s_xattr field of the superblock.
561 * The generic_fooxattr() functions will use this list to dispatch xattr
562 * operations to the correct xattr_handler.
564 #define for_each_xattr_handler(handlers, handler) \
565 for ((handler) = *(handlers)++; \
567 (handler) = *(handlers)++)
570 * Find the xattr_handler with the matching prefix.
572 static struct xattr_handler *
573 xattr_resolve_name(struct xattr_handler **handlers, const char **name)
575 struct xattr_handler *handler;
580 for_each_xattr_handler(handlers, handler) {
581 const char *n = strcmp_prefix(*name, handler->prefix);
591 * Find the handler for the prefix and dispatch its get() operation.
594 generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
596 struct xattr_handler *handler;
597 struct inode *inode = dentry->d_inode;
599 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
602 return handler->get(inode, name, buffer, size);
606 * Combine the results of the list() operation from every xattr_handler in the
610 generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
612 struct inode *inode = dentry->d_inode;
613 struct xattr_handler *handler, **handlers = inode->i_sb->s_xattr;
614 unsigned int size = 0;
617 for_each_xattr_handler(handlers, handler)
618 size += handler->list(inode, NULL, 0, NULL, 0);
622 for_each_xattr_handler(handlers, handler) {
623 size = handler->list(inode, buf, buffer_size, NULL, 0);
624 if (size > buffer_size)
635 * Find the handler for the prefix and dispatch its set() operation.
638 generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
640 struct xattr_handler *handler;
641 struct inode *inode = dentry->d_inode;
644 value = ""; /* empty EA, do not remove */
645 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
648 return handler->set(inode, name, value, size, flags);
652 * Find the handler for the prefix and dispatch its set() operation to remove
653 * any associated extended attribute.
656 generic_removexattr(struct dentry *dentry, const char *name)
658 struct xattr_handler *handler;
659 struct inode *inode = dentry->d_inode;
661 handler = xattr_resolve_name(inode->i_sb->s_xattr, &name);
664 return handler->set(inode, name, NULL, 0, XATTR_REPLACE);
667 EXPORT_SYMBOL(generic_getxattr);
668 EXPORT_SYMBOL(generic_listxattr);
669 EXPORT_SYMBOL(generic_setxattr);
670 EXPORT_SYMBOL(generic_removexattr);