blob: 74d36e063c8d163b53b988be712e71f5e775805d [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;
Jeff Layton49e09e12012-12-11 12:10:15 -0500397 unsigned int lookup_flags = 0;
398retry:
399 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 if (error)
401 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400402 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800403 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400404 error = setxattr(path.dentry, name, value, size, flags);
405 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800406 }
Al Viro2d8f3032008-07-22 09:59:21 -0400407 path_put(&path);
Jeff Layton49e09e12012-12-11 12:10:15 -0500408 if (retry_estale(error, lookup_flags)) {
409 lookup_flags |= LOOKUP_REVAL;
410 goto retry;
411 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 return error;
413}
414
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100415SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
416 const void __user *,value, size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Al Viro2903ff02012-08-28 12:52:22 -0400418 struct fd f = fdget(fd);
Amy Griffis73241cc2005-11-03 16:00:25 +0000419 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 int error = -EBADF;
421
Al Viro2903ff02012-08-28 12:52:22 -0400422 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 return error;
Al Viro2903ff02012-08-28 12:52:22 -0400424 dentry = f.file->f_path.dentry;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400425 audit_inode(NULL, dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400426 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800427 if (!error) {
428 error = setxattr(dentry, name, value, size, flags);
Al Viro2903ff02012-08-28 12:52:22 -0400429 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800430 }
Al Viro2903ff02012-08-28 12:52:22 -0400431 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 return error;
433}
434
435/*
436 * Extended attribute GET operations
437 */
438static ssize_t
David Howells8f0cfa52008-04-29 00:59:41 -0700439getxattr(struct dentry *d, const char __user *name, void __user *value,
440 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 ssize_t error;
443 void *kvalue = NULL;
Sasha Levin779302e2012-07-30 14:39:13 -0700444 void *vvalue = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 char kname[XATTR_NAME_MAX + 1];
446
447 error = strncpy_from_user(kname, name, sizeof(kname));
448 if (error == 0 || error == sizeof(kname))
449 error = -ERANGE;
450 if (error < 0)
451 return error;
452
453 if (size) {
454 if (size > XATTR_SIZE_MAX)
455 size = XATTR_SIZE_MAX;
Sasha Levin779302e2012-07-30 14:39:13 -0700456 kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
457 if (!kvalue) {
458 vvalue = vmalloc(size);
459 if (!vvalue)
460 return -ENOMEM;
461 kvalue = vvalue;
462 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 }
464
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800465 error = vfs_getxattr(d, kname, kvalue, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700466 if (error > 0) {
Eric W. Biederman2f6f0652012-02-07 18:52:57 -0800467 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
468 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
469 posix_acl_fix_xattr_to_user(kvalue, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700470 if (size && copy_to_user(value, kvalue, error))
471 error = -EFAULT;
472 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
473 /* The file system tried to returned a value bigger
474 than XATTR_SIZE_MAX bytes. Not possible. */
475 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 }
Sasha Levin779302e2012-07-30 14:39:13 -0700477 if (vvalue)
478 vfree(vvalue);
479 else
480 kfree(kvalue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 return error;
482}
483
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100484SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
485 const char __user *, name, void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486{
Al Viro2d8f3032008-07-22 09:59:21 -0400487 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 ssize_t error;
489
Al Viro2d8f3032008-07-22 09:59:21 -0400490 error = user_path(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 if (error)
492 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400493 error = getxattr(path.dentry, name, value, size);
494 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 return error;
496}
497
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100498SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
499 const char __user *, name, void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500{
Al Viro2d8f3032008-07-22 09:59:21 -0400501 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 ssize_t error;
503
Al Viro2d8f3032008-07-22 09:59:21 -0400504 error = user_lpath(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 if (error)
506 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400507 error = getxattr(path.dentry, name, value, size);
508 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 return error;
510}
511
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100512SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
513 void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514{
Al Viro2903ff02012-08-28 12:52:22 -0400515 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 ssize_t error = -EBADF;
517
Al Viro2903ff02012-08-28 12:52:22 -0400518 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 return error;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400520 audit_inode(NULL, f.file->f_path.dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400521 error = getxattr(f.file->f_path.dentry, name, value, size);
522 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 return error;
524}
525
526/*
527 * Extended attribute LIST operations
528 */
529static ssize_t
530listxattr(struct dentry *d, char __user *list, size_t size)
531{
532 ssize_t error;
533 char *klist = NULL;
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700534 char *vlist = NULL; /* If non-NULL, we used vmalloc() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
536 if (size) {
537 if (size > XATTR_LIST_MAX)
538 size = XATTR_LIST_MAX;
Dave Jones703bf2d2012-04-05 14:25:06 -0700539 klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700540 if (!klist) {
541 vlist = vmalloc(size);
542 if (!vlist)
543 return -ENOMEM;
544 klist = vlist;
545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 }
547
Bill Nottingham659564c2006-10-09 16:10:48 -0400548 error = vfs_listxattr(d, klist, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700549 if (error > 0) {
550 if (size && copy_to_user(list, klist, error))
551 error = -EFAULT;
552 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
553 /* The file system tried to returned a list bigger
554 than XATTR_LIST_MAX bytes. Not possible. */
555 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 }
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700557 if (vlist)
558 vfree(vlist);
559 else
560 kfree(klist);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 return error;
562}
563
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100564SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
565 size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Al Viro2d8f3032008-07-22 09:59:21 -0400567 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 ssize_t error;
569
Al Viro2d8f3032008-07-22 09:59:21 -0400570 error = user_path(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 if (error)
572 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400573 error = listxattr(path.dentry, list, size);
574 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 return error;
576}
577
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100578SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
579 size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Al Viro2d8f3032008-07-22 09:59:21 -0400581 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 ssize_t error;
583
Al Viro2d8f3032008-07-22 09:59:21 -0400584 error = user_lpath(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 if (error)
586 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400587 error = listxattr(path.dentry, list, size);
588 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 return error;
590}
591
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100592SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593{
Al Viro2903ff02012-08-28 12:52:22 -0400594 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 ssize_t error = -EBADF;
596
Al Viro2903ff02012-08-28 12:52:22 -0400597 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 return error;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400599 audit_inode(NULL, f.file->f_path.dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400600 error = listxattr(f.file->f_path.dentry, list, size);
601 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 return error;
603}
604
605/*
606 * Extended attribute REMOVE operations
607 */
608static long
David Howells8f0cfa52008-04-29 00:59:41 -0700609removexattr(struct dentry *d, const char __user *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
611 int error;
612 char kname[XATTR_NAME_MAX + 1];
613
614 error = strncpy_from_user(kname, name, sizeof(kname));
615 if (error == 0 || error == sizeof(kname))
616 error = -ERANGE;
617 if (error < 0)
618 return error;
619
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800620 return vfs_removexattr(d, kname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621}
622
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100623SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
624 const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625{
Al Viro2d8f3032008-07-22 09:59:21 -0400626 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 int error;
628
Al Viro2d8f3032008-07-22 09:59:21 -0400629 error = user_path(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 if (error)
631 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400632 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800633 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400634 error = removexattr(path.dentry, name);
635 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800636 }
Al Viro2d8f3032008-07-22 09:59:21 -0400637 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 return error;
639}
640
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100641SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
642 const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
Al Viro2d8f3032008-07-22 09:59:21 -0400644 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 int error;
646
Al Viro2d8f3032008-07-22 09:59:21 -0400647 error = user_lpath(pathname, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 if (error)
649 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400650 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800651 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400652 error = removexattr(path.dentry, name);
653 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800654 }
Al Viro2d8f3032008-07-22 09:59:21 -0400655 path_put(&path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 return error;
657}
658
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100659SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
Al Viro2903ff02012-08-28 12:52:22 -0400661 struct fd f = fdget(fd);
Amy Griffis73241cc2005-11-03 16:00:25 +0000662 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 int error = -EBADF;
664
Al Viro2903ff02012-08-28 12:52:22 -0400665 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 return error;
Al Viro2903ff02012-08-28 12:52:22 -0400667 dentry = f.file->f_path.dentry;
Jeff Laytonbfcec702012-10-10 15:25:23 -0400668 audit_inode(NULL, dentry, 0);
Al Viro2903ff02012-08-28 12:52:22 -0400669 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800670 if (!error) {
671 error = removexattr(dentry, name);
Al Viro2903ff02012-08-28 12:52:22 -0400672 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800673 }
Al Viro2903ff02012-08-28 12:52:22 -0400674 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 return error;
676}
677
678
679static const char *
680strcmp_prefix(const char *a, const char *a_prefix)
681{
682 while (*a_prefix && *a == *a_prefix) {
683 a++;
684 a_prefix++;
685 }
686 return *a_prefix ? NULL : a;
687}
688
689/*
690 * In order to implement different sets of xattr operations for each xattr
691 * prefix with the generic xattr API, a filesystem should create a
692 * null-terminated array of struct xattr_handler (one for each prefix) and
693 * hang a pointer to it off of the s_xattr field of the superblock.
694 *
695 * The generic_fooxattr() functions will use this list to dispatch xattr
696 * operations to the correct xattr_handler.
697 */
698#define for_each_xattr_handler(handlers, handler) \
699 for ((handler) = *(handlers)++; \
700 (handler) != NULL; \
701 (handler) = *(handlers)++)
702
703/*
704 * Find the xattr_handler with the matching prefix.
705 */
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700706static const struct xattr_handler *
707xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700709 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
711 if (!*name)
712 return NULL;
713
714 for_each_xattr_handler(handlers, handler) {
715 const char *n = strcmp_prefix(*name, handler->prefix);
716 if (n) {
717 *name = n;
718 break;
719 }
720 }
721 return handler;
722}
723
724/*
725 * Find the handler for the prefix and dispatch its get() operation.
726 */
727ssize_t
728generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
729{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700730 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Christoph Hellwig431547b2009-11-13 09:52:56 +0000732 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 if (!handler)
734 return -EOPNOTSUPP;
Christoph Hellwig431547b2009-11-13 09:52:56 +0000735 return handler->get(dentry, name, buffer, size, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
737
738/*
739 * Combine the results of the list() operation from every xattr_handler in the
740 * list.
741 */
742ssize_t
743generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
744{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700745 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 unsigned int size = 0;
747
748 if (!buffer) {
Christoph Hellwig431547b2009-11-13 09:52:56 +0000749 for_each_xattr_handler(handlers, handler) {
750 size += handler->list(dentry, NULL, 0, NULL, 0,
751 handler->flags);
752 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 } else {
754 char *buf = buffer;
755
756 for_each_xattr_handler(handlers, handler) {
Christoph Hellwig431547b2009-11-13 09:52:56 +0000757 size = handler->list(dentry, buf, buffer_size,
758 NULL, 0, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 if (size > buffer_size)
760 return -ERANGE;
761 buf += size;
762 buffer_size -= size;
763 }
764 size = buf - buffer;
765 }
766 return size;
767}
768
769/*
770 * Find the handler for the prefix and dispatch its set() operation.
771 */
772int
773generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
774{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700775 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
777 if (size == 0)
778 value = ""; /* empty EA, do not remove */
Christoph Hellwig431547b2009-11-13 09:52:56 +0000779 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 if (!handler)
781 return -EOPNOTSUPP;
Jan Karadf7e1302011-04-20 20:30:40 +0200782 return handler->set(dentry, name, value, size, flags, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783}
784
785/*
786 * Find the handler for the prefix and dispatch its set() operation to remove
787 * any associated extended attribute.
788 */
789int
790generic_removexattr(struct dentry *dentry, const char *name)
791{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700792 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Christoph Hellwig431547b2009-11-13 09:52:56 +0000794 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 if (!handler)
796 return -EOPNOTSUPP;
Christoph Hellwig431547b2009-11-13 09:52:56 +0000797 return handler->set(dentry, name, NULL, 0,
798 XATTR_REPLACE, handler->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799}
800
801EXPORT_SYMBOL(generic_getxattr);
802EXPORT_SYMBOL(generic_listxattr);
803EXPORT_SYMBOL(generic_setxattr);
804EXPORT_SYMBOL(generic_removexattr);
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400805
806/*
807 * Allocate new xattr and copy in the value; but leave the name to callers.
808 */
809struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
810{
811 struct simple_xattr *new_xattr;
812 size_t len;
813
814 /* wrap around? */
815 len = sizeof(*new_xattr) + size;
816 if (len <= sizeof(*new_xattr))
817 return NULL;
818
819 new_xattr = kmalloc(len, GFP_KERNEL);
820 if (!new_xattr)
821 return NULL;
822
823 new_xattr->size = size;
824 memcpy(new_xattr->value, value, size);
825 return new_xattr;
826}
827
828/*
829 * xattr GET operation for in-memory/pseudo filesystems
830 */
831int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
832 void *buffer, size_t size)
833{
834 struct simple_xattr *xattr;
835 int ret = -ENODATA;
836
837 spin_lock(&xattrs->lock);
838 list_for_each_entry(xattr, &xattrs->head, list) {
839 if (strcmp(name, xattr->name))
840 continue;
841
842 ret = xattr->size;
843 if (buffer) {
844 if (size < xattr->size)
845 ret = -ERANGE;
846 else
847 memcpy(buffer, xattr->value, xattr->size);
848 }
849 break;
850 }
851 spin_unlock(&xattrs->lock);
852 return ret;
853}
854
855static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
856 const void *value, size_t size, int flags)
857{
858 struct simple_xattr *xattr;
David Rientjes43385842012-10-17 20:41:15 -0700859 struct simple_xattr *new_xattr = NULL;
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400860 int err = 0;
861
862 /* value == NULL means remove */
863 if (value) {
864 new_xattr = simple_xattr_alloc(value, size);
865 if (!new_xattr)
866 return -ENOMEM;
867
868 new_xattr->name = kstrdup(name, GFP_KERNEL);
869 if (!new_xattr->name) {
870 kfree(new_xattr);
871 return -ENOMEM;
872 }
873 }
874
875 spin_lock(&xattrs->lock);
876 list_for_each_entry(xattr, &xattrs->head, list) {
877 if (!strcmp(name, xattr->name)) {
878 if (flags & XATTR_CREATE) {
879 xattr = new_xattr;
880 err = -EEXIST;
881 } else if (new_xattr) {
882 list_replace(&xattr->list, &new_xattr->list);
883 } else {
884 list_del(&xattr->list);
885 }
886 goto out;
887 }
888 }
889 if (flags & XATTR_REPLACE) {
890 xattr = new_xattr;
891 err = -ENODATA;
892 } else {
893 list_add(&new_xattr->list, &xattrs->head);
894 xattr = NULL;
895 }
896out:
897 spin_unlock(&xattrs->lock);
898 if (xattr) {
899 kfree(xattr->name);
900 kfree(xattr);
901 }
902 return err;
903
904}
905
Aristeu Rozanski48957682012-09-11 16:28:11 -0400906/**
907 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
908 * @xattrs: target simple_xattr list
909 * @name: name of the new extended attribute
910 * @value: value of the new xattr. If %NULL, will remove the attribute
911 * @size: size of the new xattr
912 * @flags: %XATTR_{CREATE|REPLACE}
913 *
914 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
915 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
916 * otherwise, fails with -ENODATA.
917 *
918 * Returns 0 on success, -errno on failure.
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400919 */
920int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
921 const void *value, size_t size, int flags)
922{
923 if (size == 0)
924 value = ""; /* empty EA, do not remove */
925 return __simple_xattr_set(xattrs, name, value, size, flags);
926}
927
928/*
929 * xattr REMOVE operation for in-memory/pseudo filesystems
930 */
931int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
932{
933 return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
934}
935
936static bool xattr_is_trusted(const char *name)
937{
938 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
939}
940
941/*
942 * xattr LIST operation for in-memory/pseudo filesystems
943 */
944ssize_t simple_xattr_list(struct simple_xattrs *xattrs, char *buffer,
945 size_t size)
946{
947 bool trusted = capable(CAP_SYS_ADMIN);
948 struct simple_xattr *xattr;
949 size_t used = 0;
950
951 spin_lock(&xattrs->lock);
952 list_for_each_entry(xattr, &xattrs->head, list) {
953 size_t len;
954
955 /* skip "trusted." attributes for unprivileged callers */
956 if (!trusted && xattr_is_trusted(xattr->name))
957 continue;
958
959 len = strlen(xattr->name) + 1;
960 used += len;
961 if (buffer) {
962 if (size < used) {
963 used = -ERANGE;
964 break;
965 }
966 memcpy(buffer, xattr->name, len);
967 buffer += len;
968 }
969 }
970 spin_unlock(&xattrs->lock);
971
972 return used;
973}
974
Aristeu Rozanski48957682012-09-11 16:28:11 -0400975/*
976 * Adds an extended attribute to the list
977 */
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400978void simple_xattr_list_add(struct simple_xattrs *xattrs,
979 struct simple_xattr *new_xattr)
980{
981 spin_lock(&xattrs->lock);
982 list_add(&new_xattr->list, &xattrs->head);
983 spin_unlock(&xattrs->lock);
984}