blob: c5e90d2d751fb6fa50200bd98ac2fdbcb26df89e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 File: fs/xattr.c
3
4 Extended attribute handling.
5
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>
9 */
10#include <linux/fs.h>
11#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/file.h>
13#include <linux/xattr.h>
Dave Hansen18f335a2008-02-15 14:37:38 -080014#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/namei.h>
16#include <linux/security.h>
Mimi Zoharc7b87de2011-03-09 14:39:18 -050017#include <linux/evm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/syscalls.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050019#include <linux/export.h>
Robert Love0eeca282005-07-12 17:06:03 -040020#include <linux/fsnotify.h>
Amy Griffis73241cc2005-11-03 16:00:25 +000021#include <linux/audit.h>
Andrew Morton0d08d7b2012-04-05 14:25:07 -070022#include <linux/vmalloc.h>
Eric W. Biederman2f6f0652012-02-07 18:52:57 -080023#include <linux/posix_acl_xattr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Andrew Morton0d08d7b2012-04-05 14:25:07 -070025#include <asm/uaccess.h>
Christoph Hellwig5be196e2006-01-09 20:51:55 -080026
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080027/*
28 * Check permissions for extended attribute access. This is a bit complicated
29 * because different namespaces have very different rules.
30 */
31static int
32xattr_permission(struct inode *inode, const char *name, int mask)
33{
34 /*
35 * We can never set or remove an extended attribute on a read-only
36 * filesystem or on an immutable / append-only inode.
37 */
38 if (mask & MAY_WRITE) {
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080039 if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
40 return -EPERM;
41 }
42
43 /*
44 * No restriction for security.* and system.* from the VFS. Decision
45 * on these is left to the underlying filesystem / security module.
46 */
47 if (!strncmp(name, XATTR_SECURITY_PREFIX, XATTR_SECURITY_PREFIX_LEN) ||
48 !strncmp(name, XATTR_SYSTEM_PREFIX, XATTR_SYSTEM_PREFIX_LEN))
49 return 0;
50
51 /*
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +020052 * The trusted.* namespace can only be accessed by privileged users.
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080053 */
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +020054 if (!strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN)) {
55 if (!capable(CAP_SYS_ADMIN))
56 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
57 return 0;
58 }
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080059
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +020060 /*
61 * In the user.* namespace, only regular files and directories can have
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -080062 * extended attributes. For sticky directories, only the owner and
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +020063 * privileged users can write attributes.
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -080064 */
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080065 if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -080066 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +020067 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -080068 if (S_ISDIR(inode->i_mode) && (inode->i_mode & S_ISVTX) &&
Serge E. Hallyn2e149672011-03-23 16:43:26 -070069 (mask & MAY_WRITE) && !inode_owner_or_capable(inode))
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080070 return -EPERM;
71 }
72
Al Virof419a2e2008-07-22 00:07:17 -040073 return inode_permission(inode, mask);
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080074}
75
David P. Quigleyb1ab7e42009-09-03 14:25:56 -040076/**
77 * __vfs_setxattr_noperm - perform setxattr operation without performing
78 * permission checks.
79 *
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
85 *
86 * returns the result of the internal setxattr or setsecurity operations.
87 *
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
90 * permission checks.
91 */
92int __vfs_setxattr_noperm(struct dentry *dentry, const char *name,
93 const void *value, size_t size, int flags)
Christoph Hellwig5be196e2006-01-09 20:51:55 -080094{
95 struct inode *inode = dentry->d_inode;
David P. Quigleyb1ab7e42009-09-03 14:25:56 -040096 int error = -EOPNOTSUPP;
Andi Kleen69b45732011-05-28 08:25:51 -070097 int issec = !strncmp(name, XATTR_SECURITY_PREFIX,
98 XATTR_SECURITY_PREFIX_LEN);
Christoph Hellwig5be196e2006-01-09 20:51:55 -080099
Andi Kleen69b45732011-05-28 08:25:51 -0700100 if (issec)
101 inode->i_flags &= ~S_NOSEC;
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800102 if (inode->i_op->setxattr) {
103 error = inode->i_op->setxattr(dentry, name, value, size, flags);
104 if (!error) {
105 fsnotify_xattr(dentry);
106 security_inode_post_setxattr(dentry, name, value,
107 size, flags);
108 }
Andi Kleen69b45732011-05-28 08:25:51 -0700109 } else if (issec) {
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800110 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800111 error = security_inode_setsecurity(inode, suffix, value,
112 size, flags);
113 if (!error)
114 fsnotify_xattr(dentry);
115 }
David P. Quigleyb1ab7e42009-09-03 14:25:56 -0400116
117 return error;
118}
119
120
121int
122vfs_setxattr(struct dentry *dentry, const char *name, const void *value,
123 size_t size, int flags)
124{
125 struct inode *inode = dentry->d_inode;
126 int error;
127
128 error = xattr_permission(inode, name, MAY_WRITE);
129 if (error)
130 return error;
131
132 mutex_lock(&inode->i_mutex);
133 error = security_inode_setxattr(dentry, name, value, size, flags);
134 if (error)
135 goto out;
136
137 error = __vfs_setxattr_noperm(dentry, name, value, size, flags);
138
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800139out:
140 mutex_unlock(&inode->i_mutex);
141 return error;
142}
143EXPORT_SYMBOL_GPL(vfs_setxattr);
144
145ssize_t
David P. Quigley42492592008-02-04 22:29:39 -0800146xattr_getsecurity(struct inode *inode, const char *name, void *value,
147 size_t size)
148{
149 void *buffer = NULL;
150 ssize_t len;
151
152 if (!value || !size) {
153 len = security_inode_getsecurity(inode, name, &buffer, false);
154 goto out_noalloc;
155 }
156
157 len = security_inode_getsecurity(inode, name, &buffer, true);
158 if (len < 0)
159 return len;
160 if (size < len) {
161 len = -ERANGE;
162 goto out;
163 }
164 memcpy(value, buffer, len);
165out:
166 security_release_secctx(buffer, len);
167out_noalloc:
168 return len;
169}
170EXPORT_SYMBOL_GPL(xattr_getsecurity);
171
Mimi Zohar1601fba2011-03-09 14:23:34 -0500172/*
173 * vfs_getxattr_alloc - allocate memory, if necessary, before calling getxattr
174 *
175 * Allocate memory, if not already allocated, or re-allocate correct size,
176 * before retrieving the extended attribute.
177 *
178 * Returns the result of alloc, if failed, or the getxattr operation.
179 */
180ssize_t
181vfs_getxattr_alloc(struct dentry *dentry, const char *name, char **xattr_value,
182 size_t xattr_size, gfp_t flags)
183{
184 struct inode *inode = dentry->d_inode;
185 char *value = *xattr_value;
186 int error;
187
188 error = xattr_permission(inode, name, MAY_READ);
189 if (error)
190 return error;
191
192 if (!inode->i_op->getxattr)
193 return -EOPNOTSUPP;
194
195 error = inode->i_op->getxattr(dentry, name, NULL, 0);
196 if (error < 0)
197 return error;
198
199 if (!value || (error > xattr_size)) {
200 value = krealloc(*xattr_value, error + 1, flags);
201 if (!value)
202 return -ENOMEM;
203 memset(value, 0, error + 1);
204 }
205
206 error = inode->i_op->getxattr(dentry, name, value, error);
207 *xattr_value = value;
208 return error;
209}
210
211/* Compare an extended attribute value with the given value */
212int vfs_xattr_cmp(struct dentry *dentry, const char *xattr_name,
213 const char *value, size_t size, gfp_t flags)
214{
215 char *xattr_value = NULL;
216 int rc;
217
218 rc = vfs_getxattr_alloc(dentry, xattr_name, &xattr_value, 0, flags);
219 if (rc < 0)
220 return rc;
221
222 if ((rc != size) || (memcmp(xattr_value, value, rc) != 0))
223 rc = -EINVAL;
224 else
225 rc = 0;
226 kfree(xattr_value);
227 return rc;
228}
229
David P. Quigley42492592008-02-04 22:29:39 -0800230ssize_t
David Howells8f0cfa52008-04-29 00:59:41 -0700231vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800232{
233 struct inode *inode = dentry->d_inode;
234 int error;
235
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800236 error = xattr_permission(inode, name, MAY_READ);
237 if (error)
238 return error;
239
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800240 error = security_inode_getxattr(dentry, name);
241 if (error)
242 return error;
243
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800244 if (!strncmp(name, XATTR_SECURITY_PREFIX,
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800245 XATTR_SECURITY_PREFIX_LEN)) {
246 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
David P. Quigley42492592008-02-04 22:29:39 -0800247 int ret = xattr_getsecurity(inode, suffix, value, size);
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800248 /*
249 * Only overwrite the return value if a security module
250 * is actually active.
251 */
David P. Quigley4bea5802008-02-04 22:29:40 -0800252 if (ret == -EOPNOTSUPP)
253 goto nolsm;
254 return ret;
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800255 }
David P. Quigley4bea5802008-02-04 22:29:40 -0800256nolsm:
257 if (inode->i_op->getxattr)
258 error = inode->i_op->getxattr(dentry, name, value, size);
259 else
260 error = -EOPNOTSUPP;
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800261
262 return error;
263}
264EXPORT_SYMBOL_GPL(vfs_getxattr);
265
Bill Nottingham659564c2006-10-09 16:10:48 -0400266ssize_t
267vfs_listxattr(struct dentry *d, char *list, size_t size)
268{
269 ssize_t error;
270
271 error = security_inode_listxattr(d);
272 if (error)
273 return error;
274 error = -EOPNOTSUPP;
Al Viroacfa4382008-12-04 10:06:33 -0500275 if (d->d_inode->i_op->listxattr) {
Bill Nottingham659564c2006-10-09 16:10:48 -0400276 error = d->d_inode->i_op->listxattr(d, list, size);
277 } else {
278 error = security_inode_listsecurity(d->d_inode, list, size);
279 if (size && error > size)
280 error = -ERANGE;
281 }
282 return error;
283}
284EXPORT_SYMBOL_GPL(vfs_listxattr);
285
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800286int
David Howells8f0cfa52008-04-29 00:59:41 -0700287vfs_removexattr(struct dentry *dentry, const char *name)
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800288{
289 struct inode *inode = dentry->d_inode;
290 int error;
291
292 if (!inode->i_op->removexattr)
293 return -EOPNOTSUPP;
294
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800295 error = xattr_permission(inode, name, MAY_WRITE);
296 if (error)
297 return error;
298
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800299 mutex_lock(&inode->i_mutex);
Mimi Zohar2ab51f32011-03-23 17:23:06 -0400300 error = security_inode_removexattr(dentry, name);
301 if (error) {
302 mutex_unlock(&inode->i_mutex);
303 return error;
304 }
305
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800306 error = inode->i_op->removexattr(dentry, name);
307 mutex_unlock(&inode->i_mutex);
308
Mimi Zoharc7b87de2011-03-09 14:39:18 -0500309 if (!error) {
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800310 fsnotify_xattr(dentry);
Mimi Zoharc7b87de2011-03-09 14:39:18 -0500311 evm_inode_post_removexattr(dentry, name);
312 }
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800313 return error;
314}
315EXPORT_SYMBOL_GPL(vfs_removexattr);
316
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318/*
319 * Extended attribute SET operations
320 */
321static long
David Howells8f0cfa52008-04-29 00:59:41 -0700322setxattr(struct dentry *d, const char __user *name, const void __user *value,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 size_t size, int flags)
324{
325 int error;
326 void *kvalue = NULL;
Andrew Morton44c82492012-04-05 14:25:07 -0700327 void *vvalue = NULL; /* If non-NULL, we used vmalloc() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 char kname[XATTR_NAME_MAX + 1];
329
330 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
331 return -EINVAL;
332
333 error = strncpy_from_user(kname, name, sizeof(kname));
334 if (error == 0 || error == sizeof(kname))
335 error = -ERANGE;
336 if (error < 0)
337 return error;
338
339 if (size) {
340 if (size > XATTR_SIZE_MAX)
341 return -E2BIG;
Andrew Morton44c82492012-04-05 14:25:07 -0700342 kvalue = kmalloc(size, GFP_KERNEL | __GFP_NOWARN);
343 if (!kvalue) {
344 vvalue = vmalloc(size);
345 if (!vvalue)
346 return -ENOMEM;
347 kvalue = vvalue;
348 }
349 if (copy_from_user(kvalue, value, size)) {
350 error = -EFAULT;
351 goto out;
352 }
Eric W. Biederman2f6f0652012-02-07 18:52:57 -0800353 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
354 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
355 posix_acl_fix_xattr_from_user(kvalue, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
357
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800358 error = vfs_setxattr(d, kname, kvalue, size, flags);
Andrew Morton44c82492012-04-05 14:25:07 -0700359out:
360 if (vvalue)
361 vfree(vvalue);
362 else
363 kfree(kvalue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 return error;
365}
366
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100367SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
368 const char __user *, name, const void __user *, value,
369 size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370{
Al Viro2d8f3032008-07-22 09:59:21 -0400371 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 int error;
Jeff Layton68f1bb82012-12-11 12:10:15 -0500373 unsigned int lookup_flags = LOOKUP_FOLLOW;
374retry:
375 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 if (error)
377 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400378 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800379 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400380 error = setxattr(path.dentry, name, value, size, flags);
381 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800382 }
Al Viro2d8f3032008-07-22 09:59:21 -0400383 path_put(&path);
Jeff Layton68f1bb82012-12-11 12:10:15 -0500384 if (retry_estale(error, lookup_flags)) {
385 lookup_flags |= LOOKUP_REVAL;
386 goto retry;
387 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 return error;
389}
390
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100391SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
392 const char __user *, name, const void __user *, value,
393 size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394{
Al Viro2d8f3032008-07-22 09:59:21 -0400395 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 int error;
397
Al Viro2d8f3032008-07-22 09:59:21 -0400398 error = user_lpath(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 if (error)
400 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400401 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800402 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400403 error = setxattr(path.dentry, name, value, size, flags);
404 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800405 }
Al Viro2d8f3032008-07-22 09:59:21 -0400406 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 return error;
408}
409
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100410SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
411 const void __user *,value, size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
Al Viro2903ff02012-08-28 12:52:22 -0400413 struct fd f = fdget(fd);
Amy Griffis73241cc2005-11-03 16:00:25 +0000414 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 int error = -EBADF;
416
Al Viro2903ff02012-08-28 12:52:22 -0400417 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 return error;
Al Viro2903ff02012-08-28 12:52:22 -0400419 dentry = f.file->f_path.dentry;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400420 audit_inode(NULL, dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400421 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800422 if (!error) {
423 error = setxattr(dentry, name, value, size, flags);
Al Viro2903ff02012-08-28 12:52:22 -0400424 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800425 }
Al Viro2903ff02012-08-28 12:52:22 -0400426 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 return error;
428}
429
430/*
431 * Extended attribute GET operations
432 */
433static ssize_t
David Howells8f0cfa52008-04-29 00:59:41 -0700434getxattr(struct dentry *d, const char __user *name, void __user *value,
435 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436{
437 ssize_t error;
438 void *kvalue = NULL;
Sasha Levin779302e2012-07-30 14:39:13 -0700439 void *vvalue = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 char kname[XATTR_NAME_MAX + 1];
441
442 error = strncpy_from_user(kname, name, sizeof(kname));
443 if (error == 0 || error == sizeof(kname))
444 error = -ERANGE;
445 if (error < 0)
446 return error;
447
448 if (size) {
449 if (size > XATTR_SIZE_MAX)
450 size = XATTR_SIZE_MAX;
Sasha Levin779302e2012-07-30 14:39:13 -0700451 kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
452 if (!kvalue) {
453 vvalue = vmalloc(size);
454 if (!vvalue)
455 return -ENOMEM;
456 kvalue = vvalue;
457 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 }
459
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800460 error = vfs_getxattr(d, kname, kvalue, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700461 if (error > 0) {
Eric W. Biederman2f6f0652012-02-07 18:52:57 -0800462 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
463 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
464 posix_acl_fix_xattr_to_user(kvalue, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700465 if (size && copy_to_user(value, kvalue, error))
466 error = -EFAULT;
467 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
468 /* The file system tried to returned a value bigger
469 than XATTR_SIZE_MAX bytes. Not possible. */
470 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 }
Sasha Levin779302e2012-07-30 14:39:13 -0700472 if (vvalue)
473 vfree(vvalue);
474 else
475 kfree(kvalue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 return error;
477}
478
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100479SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
480 const char __user *, name, void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
Al Viro2d8f3032008-07-22 09:59:21 -0400482 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 ssize_t error;
484
Al Viro2d8f3032008-07-22 09:59:21 -0400485 error = user_path(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 if (error)
487 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400488 error = getxattr(path.dentry, name, value, size);
489 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 return error;
491}
492
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100493SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
494 const char __user *, name, void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Al Viro2d8f3032008-07-22 09:59:21 -0400496 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 ssize_t error;
498
Al Viro2d8f3032008-07-22 09:59:21 -0400499 error = user_lpath(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 if (error)
501 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400502 error = getxattr(path.dentry, name, value, size);
503 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 return error;
505}
506
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100507SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
508 void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Al Viro2903ff02012-08-28 12:52:22 -0400510 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 ssize_t error = -EBADF;
512
Al Viro2903ff02012-08-28 12:52:22 -0400513 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 return error;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400515 audit_inode(NULL, f.file->f_path.dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400516 error = getxattr(f.file->f_path.dentry, name, value, size);
517 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 return error;
519}
520
521/*
522 * Extended attribute LIST operations
523 */
524static ssize_t
525listxattr(struct dentry *d, char __user *list, size_t size)
526{
527 ssize_t error;
528 char *klist = NULL;
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700529 char *vlist = NULL; /* If non-NULL, we used vmalloc() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
531 if (size) {
532 if (size > XATTR_LIST_MAX)
533 size = XATTR_LIST_MAX;
Dave Jones703bf2d2012-04-05 14:25:06 -0700534 klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700535 if (!klist) {
536 vlist = vmalloc(size);
537 if (!vlist)
538 return -ENOMEM;
539 klist = vlist;
540 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 }
542
Bill Nottingham659564c2006-10-09 16:10:48 -0400543 error = vfs_listxattr(d, klist, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700544 if (error > 0) {
545 if (size && copy_to_user(list, klist, error))
546 error = -EFAULT;
547 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
548 /* The file system tried to returned a list bigger
549 than XATTR_LIST_MAX bytes. Not possible. */
550 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700552 if (vlist)
553 vfree(vlist);
554 else
555 kfree(klist);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return error;
557}
558
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100559SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
560 size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
Al Viro2d8f3032008-07-22 09:59:21 -0400562 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 ssize_t error;
564
Al Viro2d8f3032008-07-22 09:59:21 -0400565 error = user_path(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 if (error)
567 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400568 error = listxattr(path.dentry, list, size);
569 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 return error;
571}
572
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100573SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
574 size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
Al Viro2d8f3032008-07-22 09:59:21 -0400576 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 ssize_t error;
578
Al Viro2d8f3032008-07-22 09:59:21 -0400579 error = user_lpath(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 if (error)
581 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400582 error = listxattr(path.dentry, list, size);
583 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return error;
585}
586
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100587SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
Al Viro2903ff02012-08-28 12:52:22 -0400589 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 ssize_t error = -EBADF;
591
Al Viro2903ff02012-08-28 12:52:22 -0400592 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 return error;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400594 audit_inode(NULL, f.file->f_path.dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400595 error = listxattr(f.file->f_path.dentry, list, size);
596 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 return error;
598}
599
600/*
601 * Extended attribute REMOVE operations
602 */
603static long
David Howells8f0cfa52008-04-29 00:59:41 -0700604removexattr(struct dentry *d, const char __user *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
606 int error;
607 char kname[XATTR_NAME_MAX + 1];
608
609 error = strncpy_from_user(kname, name, sizeof(kname));
610 if (error == 0 || error == sizeof(kname))
611 error = -ERANGE;
612 if (error < 0)
613 return error;
614
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800615 return vfs_removexattr(d, kname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616}
617
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100618SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
619 const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Al Viro2d8f3032008-07-22 09:59:21 -0400621 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 int error;
623
Al Viro2d8f3032008-07-22 09:59:21 -0400624 error = user_path(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 if (error)
626 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400627 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800628 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400629 error = removexattr(path.dentry, name);
630 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800631 }
Al Viro2d8f3032008-07-22 09:59:21 -0400632 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 return error;
634}
635
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100636SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
637 const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
Al Viro2d8f3032008-07-22 09:59:21 -0400639 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 int error;
641
Al Viro2d8f3032008-07-22 09:59:21 -0400642 error = user_lpath(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 if (error)
644 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400645 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800646 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400647 error = removexattr(path.dentry, name);
648 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800649 }
Al Viro2d8f3032008-07-22 09:59:21 -0400650 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 return error;
652}
653
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100654SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
Al Viro2903ff02012-08-28 12:52:22 -0400656 struct fd f = fdget(fd);
Amy Griffis73241cc2005-11-03 16:00:25 +0000657 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 int error = -EBADF;
659
Al Viro2903ff02012-08-28 12:52:22 -0400660 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 return error;
Al Viro2903ff02012-08-28 12:52:22 -0400662 dentry = f.file->f_path.dentry;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400663 audit_inode(NULL, dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400664 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800665 if (!error) {
666 error = removexattr(dentry, name);
Al Viro2903ff02012-08-28 12:52:22 -0400667 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800668 }
Al Viro2903ff02012-08-28 12:52:22 -0400669 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 return error;
671}
672
673
674static const char *
675strcmp_prefix(const char *a, const char *a_prefix)
676{
677 while (*a_prefix && *a == *a_prefix) {
678 a++;
679 a_prefix++;
680 }
681 return *a_prefix ? NULL : a;
682}
683
684/*
685 * In order to implement different sets of xattr operations for each xattr
686 * prefix with the generic xattr API, a filesystem should create a
687 * null-terminated array of struct xattr_handler (one for each prefix) and
688 * hang a pointer to it off of the s_xattr field of the superblock.
689 *
690 * The generic_fooxattr() functions will use this list to dispatch xattr
691 * operations to the correct xattr_handler.
692 */
693#define for_each_xattr_handler(handlers, handler) \
694 for ((handler) = *(handlers)++; \
695 (handler) != NULL; \
696 (handler) = *(handlers)++)
697
698/*
699 * Find the xattr_handler with the matching prefix.
700 */
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700701static const struct xattr_handler *
702xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700704 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
706 if (!*name)
707 return NULL;
708
709 for_each_xattr_handler(handlers, handler) {
710 const char *n = strcmp_prefix(*name, handler->prefix);
711 if (n) {
712 *name = n;
713 break;
714 }
715 }
716 return handler;
717}
718
719/*
720 * Find the handler for the prefix and dispatch its get() operation.
721 */
722ssize_t
723generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
724{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700725 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Christoph Hellwig431547b2009-11-13 09:52:56 +0000727 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 if (!handler)
729 return -EOPNOTSUPP;
Christoph Hellwig431547b2009-11-13 09:52:56 +0000730 return handler->get(dentry, name, buffer, size, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731}
732
733/*
734 * Combine the results of the list() operation from every xattr_handler in the
735 * list.
736 */
737ssize_t
738generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
739{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700740 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 unsigned int size = 0;
742
743 if (!buffer) {
Christoph Hellwig431547b2009-11-13 09:52:56 +0000744 for_each_xattr_handler(handlers, handler) {
745 size += handler->list(dentry, NULL, 0, NULL, 0,
746 handler->flags);
747 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 } else {
749 char *buf = buffer;
750
751 for_each_xattr_handler(handlers, handler) {
Christoph Hellwig431547b2009-11-13 09:52:56 +0000752 size = handler->list(dentry, buf, buffer_size,
753 NULL, 0, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 if (size > buffer_size)
755 return -ERANGE;
756 buf += size;
757 buffer_size -= size;
758 }
759 size = buf - buffer;
760 }
761 return size;
762}
763
764/*
765 * Find the handler for the prefix and dispatch its set() operation.
766 */
767int
768generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
769{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700770 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
772 if (size == 0)
773 value = ""; /* empty EA, do not remove */
Christoph Hellwig431547b2009-11-13 09:52:56 +0000774 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 if (!handler)
776 return -EOPNOTSUPP;
Jan Karadf7e1302011-04-20 20:30:40 +0200777 return handler->set(dentry, name, value, size, flags, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778}
779
780/*
781 * Find the handler for the prefix and dispatch its set() operation to remove
782 * any associated extended attribute.
783 */
784int
785generic_removexattr(struct dentry *dentry, const char *name)
786{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700787 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788
Christoph Hellwig431547b2009-11-13 09:52:56 +0000789 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 if (!handler)
791 return -EOPNOTSUPP;
Christoph Hellwig431547b2009-11-13 09:52:56 +0000792 return handler->set(dentry, name, NULL, 0,
793 XATTR_REPLACE, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794}
795
796EXPORT_SYMBOL(generic_getxattr);
797EXPORT_SYMBOL(generic_listxattr);
798EXPORT_SYMBOL(generic_setxattr);
799EXPORT_SYMBOL(generic_removexattr);
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400800
801/*
802 * Allocate new xattr and copy in the value; but leave the name to callers.
803 */
804struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
805{
806 struct simple_xattr *new_xattr;
807 size_t len;
808
809 /* wrap around? */
810 len = sizeof(*new_xattr) + size;
811 if (len <= sizeof(*new_xattr))
812 return NULL;
813
814 new_xattr = kmalloc(len, GFP_KERNEL);
815 if (!new_xattr)
816 return NULL;
817
818 new_xattr->size = size;
819 memcpy(new_xattr->value, value, size);
820 return new_xattr;
821}
822
823/*
824 * xattr GET operation for in-memory/pseudo filesystems
825 */
826int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
827 void *buffer, size_t size)
828{
829 struct simple_xattr *xattr;
830 int ret = -ENODATA;
831
832 spin_lock(&xattrs->lock);
833 list_for_each_entry(xattr, &xattrs->head, list) {
834 if (strcmp(name, xattr->name))
835 continue;
836
837 ret = xattr->size;
838 if (buffer) {
839 if (size < xattr->size)
840 ret = -ERANGE;
841 else
842 memcpy(buffer, xattr->value, xattr->size);
843 }
844 break;
845 }
846 spin_unlock(&xattrs->lock);
847 return ret;
848}
849
850static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
851 const void *value, size_t size, int flags)
852{
853 struct simple_xattr *xattr;
David Rientjes43385842012-10-17 20:41:15 -0700854 struct simple_xattr *new_xattr = NULL;
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400855 int err = 0;
856
857 /* value == NULL means remove */
858 if (value) {
859 new_xattr = simple_xattr_alloc(value, size);
860 if (!new_xattr)
861 return -ENOMEM;
862
863 new_xattr->name = kstrdup(name, GFP_KERNEL);
864 if (!new_xattr->name) {
865 kfree(new_xattr);
866 return -ENOMEM;
867 }
868 }
869
870 spin_lock(&xattrs->lock);
871 list_for_each_entry(xattr, &xattrs->head, list) {
872 if (!strcmp(name, xattr->name)) {
873 if (flags & XATTR_CREATE) {
874 xattr = new_xattr;
875 err = -EEXIST;
876 } else if (new_xattr) {
877 list_replace(&xattr->list, &new_xattr->list);
878 } else {
879 list_del(&xattr->list);
880 }
881 goto out;
882 }
883 }
884 if (flags & XATTR_REPLACE) {
885 xattr = new_xattr;
886 err = -ENODATA;
887 } else {
888 list_add(&new_xattr->list, &xattrs->head);
889 xattr = NULL;
890 }
891out:
892 spin_unlock(&xattrs->lock);
893 if (xattr) {
894 kfree(xattr->name);
895 kfree(xattr);
896 }
897 return err;
898
899}
900
Aristeu Rozanski48957682012-09-11 16:28:11 -0400901/**
902 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
903 * @xattrs: target simple_xattr list
904 * @name: name of the new extended attribute
905 * @value: value of the new xattr. If %NULL, will remove the attribute
906 * @size: size of the new xattr
907 * @flags: %XATTR_{CREATE|REPLACE}
908 *
909 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
910 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
911 * otherwise, fails with -ENODATA.
912 *
913 * Returns 0 on success, -errno on failure.
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400914 */
915int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
916 const void *value, size_t size, int flags)
917{
918 if (size == 0)
919 value = ""; /* empty EA, do not remove */
920 return __simple_xattr_set(xattrs, name, value, size, flags);
921}
922
923/*
924 * xattr REMOVE operation for in-memory/pseudo filesystems
925 */
926int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
927{
928 return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
929}
930
931static bool xattr_is_trusted(const char *name)
932{
933 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
934}
935
936/*
937 * xattr LIST operation for in-memory/pseudo filesystems
938 */
939ssize_t simple_xattr_list(struct simple_xattrs *xattrs, char *buffer,
940 size_t size)
941{
942 bool trusted = capable(CAP_SYS_ADMIN);
943 struct simple_xattr *xattr;
944 size_t used = 0;
945
946 spin_lock(&xattrs->lock);
947 list_for_each_entry(xattr, &xattrs->head, list) {
948 size_t len;
949
950 /* skip "trusted." attributes for unprivileged callers */
951 if (!trusted && xattr_is_trusted(xattr->name))
952 continue;
953
954 len = strlen(xattr->name) + 1;
955 used += len;
956 if (buffer) {
957 if (size < used) {
958 used = -ERANGE;
959 break;
960 }
961 memcpy(buffer, xattr->name, len);
962 buffer += len;
963 }
964 }
965 spin_unlock(&xattrs->lock);
966
967 return used;
968}
969
Aristeu Rozanski48957682012-09-11 16:28:11 -0400970/*
971 * Adds an extended attribute to the list
972 */
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400973void simple_xattr_list_add(struct simple_xattrs *xattrs,
974 struct simple_xattr *new_xattr)
975{
976 spin_lock(&xattrs->lock);
977 list_add(&new_xattr->list, &xattrs->head);
978 spin_unlock(&xattrs->lock);
979}