blob: 9e8a6529dfc56b6983824f4fcf3dd3ac3e52bf29 [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);
Dmitry Kasatkin7c51bb02014-11-20 16:31:01 +0200301 if (error)
302 goto out;
Mimi Zohar2ab51f32011-03-23 17:23:06 -0400303
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800304 error = inode->i_op->removexattr(dentry, name);
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800305
Mimi Zoharc7b87de2011-03-09 14:39:18 -0500306 if (!error) {
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800307 fsnotify_xattr(dentry);
Mimi Zoharc7b87de2011-03-09 14:39:18 -0500308 evm_inode_post_removexattr(dentry, name);
309 }
Dmitry Kasatkin7c51bb02014-11-20 16:31:01 +0200310
311out:
312 mutex_unlock(&inode->i_mutex);
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;
327 char kname[XATTR_NAME_MAX + 1];
328
329 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
330 return -EINVAL;
331
332 error = strncpy_from_user(kname, name, sizeof(kname));
333 if (error == 0 || error == sizeof(kname))
334 error = -ERANGE;
335 if (error < 0)
336 return error;
337
338 if (size) {
339 if (size > XATTR_SIZE_MAX)
340 return -E2BIG;
Andrew Morton44c82492012-04-05 14:25:07 -0700341 kvalue = kmalloc(size, GFP_KERNEL | __GFP_NOWARN);
342 if (!kvalue) {
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100343 kvalue = vmalloc(size);
344 if (!kvalue)
Andrew Morton44c82492012-04-05 14:25:07 -0700345 return -ENOMEM;
Andrew Morton44c82492012-04-05 14:25:07 -0700346 }
347 if (copy_from_user(kvalue, value, size)) {
348 error = -EFAULT;
349 goto out;
350 }
Eric W. Biederman2f6f0652012-02-07 18:52:57 -0800351 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
352 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
353 posix_acl_fix_xattr_from_user(kvalue, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 }
355
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800356 error = vfs_setxattr(d, kname, kvalue, size, flags);
Andrew Morton44c82492012-04-05 14:25:07 -0700357out:
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100358 kvfree(kvalue);
359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 return error;
361}
362
Eric Biggers8cc43112014-10-12 11:59:58 -0500363static int path_setxattr(const char __user *pathname,
364 const char __user *name, const void __user *value,
365 size_t size, int flags, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366{
Al Viro2d8f3032008-07-22 09:59:21 -0400367 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 int error;
Jeff Layton68f1bb82012-12-11 12:10:15 -0500369retry:
370 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 if (error)
372 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400373 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800374 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400375 error = setxattr(path.dentry, name, value, size, flags);
376 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800377 }
Al Viro2d8f3032008-07-22 09:59:21 -0400378 path_put(&path);
Jeff Layton68f1bb82012-12-11 12:10:15 -0500379 if (retry_estale(error, lookup_flags)) {
380 lookup_flags |= LOOKUP_REVAL;
381 goto retry;
382 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 return error;
384}
385
Eric Biggers8cc43112014-10-12 11:59:58 -0500386SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
387 const char __user *, name, const void __user *, value,
388 size_t, size, int, flags)
389{
390 return path_setxattr(pathname, name, value, size, flags, LOOKUP_FOLLOW);
391}
392
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100393SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
394 const char __user *, name, const void __user *, value,
395 size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396{
Eric Biggers8cc43112014-10-12 11:59:58 -0500397 return path_setxattr(pathname, name, value, size, flags, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398}
399
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100400SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
401 const void __user *,value, size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402{
Al Viro2903ff02012-08-28 12:52:22 -0400403 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 int error = -EBADF;
405
Al Viro2903ff02012-08-28 12:52:22 -0400406 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400408 audit_file(f.file);
Al Viro2903ff02012-08-28 12:52:22 -0400409 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800410 if (!error) {
Al Viro9f45f5b2014-10-31 17:44:57 -0400411 error = setxattr(f.file->f_path.dentry, name, value, size, flags);
Al Viro2903ff02012-08-28 12:52:22 -0400412 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800413 }
Al Viro2903ff02012-08-28 12:52:22 -0400414 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 return error;
416}
417
418/*
419 * Extended attribute GET operations
420 */
421static ssize_t
David Howells8f0cfa52008-04-29 00:59:41 -0700422getxattr(struct dentry *d, const char __user *name, void __user *value,
423 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424{
425 ssize_t error;
426 void *kvalue = NULL;
427 char kname[XATTR_NAME_MAX + 1];
428
429 error = strncpy_from_user(kname, name, sizeof(kname));
430 if (error == 0 || error == sizeof(kname))
431 error = -ERANGE;
432 if (error < 0)
433 return error;
434
435 if (size) {
436 if (size > XATTR_SIZE_MAX)
437 size = XATTR_SIZE_MAX;
Sasha Levin779302e2012-07-30 14:39:13 -0700438 kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
439 if (!kvalue) {
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100440 kvalue = vmalloc(size);
441 if (!kvalue)
Sasha Levin779302e2012-07-30 14:39:13 -0700442 return -ENOMEM;
Sasha Levin779302e2012-07-30 14:39:13 -0700443 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 }
445
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800446 error = vfs_getxattr(d, kname, kvalue, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700447 if (error > 0) {
Eric W. Biederman2f6f0652012-02-07 18:52:57 -0800448 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
449 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
450 posix_acl_fix_xattr_to_user(kvalue, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700451 if (size && copy_to_user(value, kvalue, error))
452 error = -EFAULT;
453 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
454 /* The file system tried to returned a value bigger
455 than XATTR_SIZE_MAX bytes. Not possible. */
456 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 }
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100458
459 kvfree(kvalue);
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 return error;
462}
463
Eric Biggers8cc43112014-10-12 11:59:58 -0500464static ssize_t path_getxattr(const char __user *pathname,
465 const char __user *name, void __user *value,
466 size_t size, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467{
Al Viro2d8f3032008-07-22 09:59:21 -0400468 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 ssize_t error;
Jeff Layton60e66b42012-12-11 12:10:16 -0500470retry:
471 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 if (error)
473 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400474 error = getxattr(path.dentry, name, value, size);
475 path_put(&path);
Jeff Layton60e66b42012-12-11 12:10:16 -0500476 if (retry_estale(error, lookup_flags)) {
477 lookup_flags |= LOOKUP_REVAL;
478 goto retry;
479 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 return error;
481}
482
Eric Biggers8cc43112014-10-12 11:59:58 -0500483SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
484 const char __user *, name, void __user *, value, size_t, size)
485{
486 return path_getxattr(pathname, name, value, size, LOOKUP_FOLLOW);
487}
488
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100489SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
490 const char __user *, name, void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491{
Eric Biggers8cc43112014-10-12 11:59:58 -0500492 return path_getxattr(pathname, name, value, size, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493}
494
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100495SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
496 void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
Al Viro2903ff02012-08-28 12:52:22 -0400498 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 ssize_t error = -EBADF;
500
Al Viro2903ff02012-08-28 12:52:22 -0400501 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400503 audit_file(f.file);
Al Viro2903ff02012-08-28 12:52:22 -0400504 error = getxattr(f.file->f_path.dentry, name, value, size);
505 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 return error;
507}
508
509/*
510 * Extended attribute LIST operations
511 */
512static ssize_t
513listxattr(struct dentry *d, char __user *list, size_t size)
514{
515 ssize_t error;
516 char *klist = NULL;
517
518 if (size) {
519 if (size > XATTR_LIST_MAX)
520 size = XATTR_LIST_MAX;
Dave Jones703bf2d2012-04-05 14:25:06 -0700521 klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700522 if (!klist) {
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100523 klist = vmalloc(size);
524 if (!klist)
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700525 return -ENOMEM;
Andrew Morton0d08d7b2012-04-05 14:25:07 -0700526 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 }
528
Bill Nottingham659564c2006-10-09 16:10:48 -0400529 error = vfs_listxattr(d, klist, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700530 if (error > 0) {
531 if (size && copy_to_user(list, klist, error))
532 error = -EFAULT;
533 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
534 /* The file system tried to returned a list bigger
535 than XATTR_LIST_MAX bytes. Not possible. */
536 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 }
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100538
539 kvfree(klist);
540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 return error;
542}
543
Eric Biggers8cc43112014-10-12 11:59:58 -0500544static ssize_t path_listxattr(const char __user *pathname, char __user *list,
545 size_t size, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
Al Viro2d8f3032008-07-22 09:59:21 -0400547 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 ssize_t error;
Jeff Layton10a90cf2012-12-11 12:10:16 -0500549retry:
550 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 if (error)
552 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400553 error = listxattr(path.dentry, list, size);
554 path_put(&path);
Jeff Layton10a90cf2012-12-11 12:10:16 -0500555 if (retry_estale(error, lookup_flags)) {
556 lookup_flags |= LOOKUP_REVAL;
557 goto retry;
558 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 return error;
560}
561
Eric Biggers8cc43112014-10-12 11:59:58 -0500562SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
563 size_t, size)
564{
565 return path_listxattr(pathname, list, size, LOOKUP_FOLLOW);
566}
567
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100568SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
569 size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Eric Biggers8cc43112014-10-12 11:59:58 -0500571 return path_listxattr(pathname, list, size, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572}
573
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100574SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
Al Viro2903ff02012-08-28 12:52:22 -0400576 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 ssize_t error = -EBADF;
578
Al Viro2903ff02012-08-28 12:52:22 -0400579 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400581 audit_file(f.file);
Al Viro2903ff02012-08-28 12:52:22 -0400582 error = listxattr(f.file->f_path.dentry, list, size);
583 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return error;
585}
586
587/*
588 * Extended attribute REMOVE operations
589 */
590static long
David Howells8f0cfa52008-04-29 00:59:41 -0700591removexattr(struct dentry *d, const char __user *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592{
593 int error;
594 char kname[XATTR_NAME_MAX + 1];
595
596 error = strncpy_from_user(kname, name, sizeof(kname));
597 if (error == 0 || error == sizeof(kname))
598 error = -ERANGE;
599 if (error < 0)
600 return error;
601
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800602 return vfs_removexattr(d, kname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603}
604
Eric Biggers8cc43112014-10-12 11:59:58 -0500605static int path_removexattr(const char __user *pathname,
606 const char __user *name, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
Al Viro2d8f3032008-07-22 09:59:21 -0400608 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 int error;
Jeff Layton12f06212012-12-11 12:10:17 -0500610retry:
611 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 if (error)
613 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400614 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800615 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400616 error = removexattr(path.dentry, name);
617 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800618 }
Al Viro2d8f3032008-07-22 09:59:21 -0400619 path_put(&path);
Jeff Layton12f06212012-12-11 12:10:17 -0500620 if (retry_estale(error, lookup_flags)) {
621 lookup_flags |= LOOKUP_REVAL;
622 goto retry;
623 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 return error;
625}
626
Eric Biggers8cc43112014-10-12 11:59:58 -0500627SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
628 const char __user *, name)
629{
630 return path_removexattr(pathname, name, LOOKUP_FOLLOW);
631}
632
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100633SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
634 const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Eric Biggers8cc43112014-10-12 11:59:58 -0500636 return path_removexattr(pathname, name, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637}
638
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100639SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
Al Viro2903ff02012-08-28 12:52:22 -0400641 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 int error = -EBADF;
643
Al Viro2903ff02012-08-28 12:52:22 -0400644 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400646 audit_file(f.file);
Al Viro2903ff02012-08-28 12:52:22 -0400647 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800648 if (!error) {
Al Viro9f45f5b2014-10-31 17:44:57 -0400649 error = removexattr(f.file->f_path.dentry, name);
Al Viro2903ff02012-08-28 12:52:22 -0400650 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800651 }
Al Viro2903ff02012-08-28 12:52:22 -0400652 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 return error;
654}
655
656
657static const char *
658strcmp_prefix(const char *a, const char *a_prefix)
659{
660 while (*a_prefix && *a == *a_prefix) {
661 a++;
662 a_prefix++;
663 }
664 return *a_prefix ? NULL : a;
665}
666
667/*
668 * In order to implement different sets of xattr operations for each xattr
669 * prefix with the generic xattr API, a filesystem should create a
670 * null-terminated array of struct xattr_handler (one for each prefix) and
671 * hang a pointer to it off of the s_xattr field of the superblock.
672 *
673 * The generic_fooxattr() functions will use this list to dispatch xattr
674 * operations to the correct xattr_handler.
675 */
676#define for_each_xattr_handler(handlers, handler) \
677 for ((handler) = *(handlers)++; \
678 (handler) != NULL; \
679 (handler) = *(handlers)++)
680
681/*
682 * Find the xattr_handler with the matching prefix.
683 */
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700684static const struct xattr_handler *
685xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700687 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
689 if (!*name)
690 return NULL;
691
692 for_each_xattr_handler(handlers, handler) {
693 const char *n = strcmp_prefix(*name, handler->prefix);
694 if (n) {
695 *name = n;
696 break;
697 }
698 }
699 return handler;
700}
701
702/*
703 * Find the handler for the prefix and dispatch its get() operation.
704 */
705ssize_t
706generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
707{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700708 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Christoph Hellwig431547b2009-11-13 09:52:56 +0000710 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 if (!handler)
712 return -EOPNOTSUPP;
Andreas Gruenbacherd9a82a02015-10-04 19:18:51 +0200713 return handler->get(handler, dentry, name, buffer, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714}
715
716/*
717 * Combine the results of the list() operation from every xattr_handler in the
718 * list.
719 */
720ssize_t
721generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
722{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700723 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 unsigned int size = 0;
725
726 if (!buffer) {
Christoph Hellwig431547b2009-11-13 09:52:56 +0000727 for_each_xattr_handler(handlers, handler) {
Andreas Gruenbacherd9a82a02015-10-04 19:18:51 +0200728 size += handler->list(handler, dentry, NULL, 0,
729 NULL, 0);
Christoph Hellwig431547b2009-11-13 09:52:56 +0000730 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 } else {
732 char *buf = buffer;
733
734 for_each_xattr_handler(handlers, handler) {
Andreas Gruenbacherd9a82a02015-10-04 19:18:51 +0200735 size = handler->list(handler, dentry, buf, buffer_size,
736 NULL, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (size > buffer_size)
738 return -ERANGE;
739 buf += size;
740 buffer_size -= size;
741 }
742 size = buf - buffer;
743 }
744 return size;
745}
746
747/*
748 * Find the handler for the prefix and dispatch its set() operation.
749 */
750int
751generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
752{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700753 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
755 if (size == 0)
756 value = ""; /* empty EA, do not remove */
Christoph Hellwig431547b2009-11-13 09:52:56 +0000757 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 if (!handler)
759 return -EOPNOTSUPP;
Andreas Gruenbacherd9a82a02015-10-04 19:18:51 +0200760 return handler->set(handler, dentry, name, value, size, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761}
762
763/*
764 * Find the handler for the prefix and dispatch its set() operation to remove
765 * any associated extended attribute.
766 */
767int
768generic_removexattr(struct dentry *dentry, const char *name)
769{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700770 const struct xattr_handler *handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
Christoph Hellwig431547b2009-11-13 09:52:56 +0000772 handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 if (!handler)
774 return -EOPNOTSUPP;
Andreas Gruenbacherd9a82a02015-10-04 19:18:51 +0200775 return handler->set(handler, dentry, name, NULL, 0, XATTR_REPLACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776}
777
778EXPORT_SYMBOL(generic_getxattr);
779EXPORT_SYMBOL(generic_listxattr);
780EXPORT_SYMBOL(generic_setxattr);
781EXPORT_SYMBOL(generic_removexattr);
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400782
Andreas Gruenbachere409de92015-10-04 19:18:52 +0200783/**
784 * xattr_full_name - Compute full attribute name from suffix
785 *
786 * @handler: handler of the xattr_handler operation
787 * @name: name passed to the xattr_handler operation
788 *
789 * The get and set xattr handler operations are called with the remainder of
790 * the attribute name after skipping the handler's prefix: for example, "foo"
791 * is passed to the get operation of a handler with prefix "user." to get
792 * attribute "user.foo". The full name is still "there" in the name though.
793 *
794 * Note: the list xattr handler operation when called from the vfs is passed a
795 * NULL name; some file systems use this operation internally, with varying
796 * semantics.
797 */
798const char *xattr_full_name(const struct xattr_handler *handler,
799 const char *name)
800{
801 size_t prefix_len = strlen(handler->prefix);
802
803 return name - prefix_len;
804}
805EXPORT_SYMBOL(xattr_full_name);
806
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400807/*
808 * Allocate new xattr and copy in the value; but leave the name to callers.
809 */
810struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
811{
812 struct simple_xattr *new_xattr;
813 size_t len;
814
815 /* wrap around? */
816 len = sizeof(*new_xattr) + size;
Hugh Dickins4e66d442014-07-23 14:00:17 -0700817 if (len < sizeof(*new_xattr))
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400818 return NULL;
819
820 new_xattr = kmalloc(len, GFP_KERNEL);
821 if (!new_xattr)
822 return NULL;
823
824 new_xattr->size = size;
825 memcpy(new_xattr->value, value, size);
826 return new_xattr;
827}
828
829/*
830 * xattr GET operation for in-memory/pseudo filesystems
831 */
832int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
833 void *buffer, size_t size)
834{
835 struct simple_xattr *xattr;
836 int ret = -ENODATA;
837
838 spin_lock(&xattrs->lock);
839 list_for_each_entry(xattr, &xattrs->head, list) {
840 if (strcmp(name, xattr->name))
841 continue;
842
843 ret = xattr->size;
844 if (buffer) {
845 if (size < xattr->size)
846 ret = -ERANGE;
847 else
848 memcpy(buffer, xattr->value, xattr->size);
849 }
850 break;
851 }
852 spin_unlock(&xattrs->lock);
853 return ret;
854}
855
856static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
857 const void *value, size_t size, int flags)
858{
859 struct simple_xattr *xattr;
David Rientjes43385842012-10-17 20:41:15 -0700860 struct simple_xattr *new_xattr = NULL;
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400861 int err = 0;
862
863 /* value == NULL means remove */
864 if (value) {
865 new_xattr = simple_xattr_alloc(value, size);
866 if (!new_xattr)
867 return -ENOMEM;
868
869 new_xattr->name = kstrdup(name, GFP_KERNEL);
870 if (!new_xattr->name) {
871 kfree(new_xattr);
872 return -ENOMEM;
873 }
874 }
875
876 spin_lock(&xattrs->lock);
877 list_for_each_entry(xattr, &xattrs->head, list) {
878 if (!strcmp(name, xattr->name)) {
879 if (flags & XATTR_CREATE) {
880 xattr = new_xattr;
881 err = -EEXIST;
882 } else if (new_xattr) {
883 list_replace(&xattr->list, &new_xattr->list);
884 } else {
885 list_del(&xattr->list);
886 }
887 goto out;
888 }
889 }
890 if (flags & XATTR_REPLACE) {
891 xattr = new_xattr;
892 err = -ENODATA;
893 } else {
894 list_add(&new_xattr->list, &xattrs->head);
895 xattr = NULL;
896 }
897out:
898 spin_unlock(&xattrs->lock);
899 if (xattr) {
900 kfree(xattr->name);
901 kfree(xattr);
902 }
903 return err;
904
905}
906
Aristeu Rozanski48957682012-09-11 16:28:11 -0400907/**
908 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
909 * @xattrs: target simple_xattr list
910 * @name: name of the new extended attribute
911 * @value: value of the new xattr. If %NULL, will remove the attribute
912 * @size: size of the new xattr
913 * @flags: %XATTR_{CREATE|REPLACE}
914 *
915 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
916 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
917 * otherwise, fails with -ENODATA.
918 *
919 * Returns 0 on success, -errno on failure.
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400920 */
921int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
922 const void *value, size_t size, int flags)
923{
924 if (size == 0)
925 value = ""; /* empty EA, do not remove */
926 return __simple_xattr_set(xattrs, name, value, size, flags);
927}
928
929/*
930 * xattr REMOVE operation for in-memory/pseudo filesystems
931 */
932int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
933{
934 return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
935}
936
937static bool xattr_is_trusted(const char *name)
938{
939 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
940}
941
942/*
943 * xattr LIST operation for in-memory/pseudo filesystems
944 */
945ssize_t simple_xattr_list(struct simple_xattrs *xattrs, char *buffer,
946 size_t size)
947{
948 bool trusted = capable(CAP_SYS_ADMIN);
949 struct simple_xattr *xattr;
950 size_t used = 0;
951
952 spin_lock(&xattrs->lock);
953 list_for_each_entry(xattr, &xattrs->head, list) {
954 size_t len;
955
956 /* skip "trusted." attributes for unprivileged callers */
957 if (!trusted && xattr_is_trusted(xattr->name))
958 continue;
959
960 len = strlen(xattr->name) + 1;
961 used += len;
962 if (buffer) {
963 if (size < used) {
964 used = -ERANGE;
965 break;
966 }
967 memcpy(buffer, xattr->name, len);
968 buffer += len;
969 }
970 }
971 spin_unlock(&xattrs->lock);
972
973 return used;
974}
975
Aristeu Rozanski48957682012-09-11 16:28:11 -0400976/*
977 * Adds an extended attribute to the list
978 */
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400979void simple_xattr_list_add(struct simple_xattrs *xattrs,
980 struct simple_xattr *new_xattr)
981{
982 spin_lock(&xattrs->lock);
983 list_add(&new_xattr->list, &xattrs->head);
984 spin_unlock(&xattrs->lock);
985}