Loading...
1/*
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>
12#include <linux/file.h>
13#include <linux/xattr.h>
14#include <linux/mount.h>
15#include <linux/namei.h>
16#include <linux/security.h>
17#include <linux/evm.h>
18#include <linux/syscalls.h>
19#include <linux/export.h>
20#include <linux/fsnotify.h>
21#include <linux/audit.h>
22#include <linux/vmalloc.h>
23#include <linux/posix_acl_xattr.h>
24
25#include <linux/uaccess.h>
26
27static const char *
28strcmp_prefix(const char *a, const char *a_prefix)
29{
30 while (*a_prefix && *a == *a_prefix) {
31 a++;
32 a_prefix++;
33 }
34 return *a_prefix ? NULL : a;
35}
36
37/*
38 * In order to implement different sets of xattr operations for each xattr
39 * prefix, a filesystem should create a null-terminated array of struct
40 * xattr_handler (one for each prefix) and hang a pointer to it off of the
41 * s_xattr field of the superblock.
42 */
43#define for_each_xattr_handler(handlers, handler) \
44 if (handlers) \
45 for ((handler) = *(handlers)++; \
46 (handler) != NULL; \
47 (handler) = *(handlers)++)
48
49/*
50 * Find the xattr_handler with the matching prefix.
51 */
52static const struct xattr_handler *
53xattr_resolve_name(struct inode *inode, const char **name)
54{
55 const struct xattr_handler **handlers = inode->i_sb->s_xattr;
56 const struct xattr_handler *handler;
57
58 if (!(inode->i_opflags & IOP_XATTR)) {
59 if (unlikely(is_bad_inode(inode)))
60 return ERR_PTR(-EIO);
61 return ERR_PTR(-EOPNOTSUPP);
62 }
63 for_each_xattr_handler(handlers, handler) {
64 const char *n;
65
66 n = strcmp_prefix(*name, xattr_prefix(handler));
67 if (n) {
68 if (!handler->prefix ^ !*n) {
69 if (*n)
70 continue;
71 return ERR_PTR(-EINVAL);
72 }
73 *name = n;
74 return handler;
75 }
76 }
77 return ERR_PTR(-EOPNOTSUPP);
78}
79
80/*
81 * Check permissions for extended attribute access. This is a bit complicated
82 * because different namespaces have very different rules.
83 */
84static int
85xattr_permission(struct inode *inode, const char *name, int mask)
86{
87 /*
88 * We can never set or remove an extended attribute on a read-only
89 * filesystem or on an immutable / append-only inode.
90 */
91 if (mask & MAY_WRITE) {
92 if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
93 return -EPERM;
94 /*
95 * Updating an xattr will likely cause i_uid and i_gid
96 * to be writen back improperly if their true value is
97 * unknown to the vfs.
98 */
99 if (HAS_UNMAPPED_ID(inode))
100 return -EPERM;
101 }
102
103 /*
104 * No restriction for security.* and system.* from the VFS. Decision
105 * on these is left to the underlying filesystem / security module.
106 */
107 if (!strncmp(name, XATTR_SECURITY_PREFIX, XATTR_SECURITY_PREFIX_LEN) ||
108 !strncmp(name, XATTR_SYSTEM_PREFIX, XATTR_SYSTEM_PREFIX_LEN))
109 return 0;
110
111 /*
112 * The trusted.* namespace can only be accessed by privileged users.
113 */
114 if (!strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN)) {
115 if (!capable(CAP_SYS_ADMIN))
116 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
117 return 0;
118 }
119
120 /*
121 * In the user.* namespace, only regular files and directories can have
122 * extended attributes. For sticky directories, only the owner and
123 * privileged users can write attributes.
124 */
125 if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
126 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
127 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
128 if (S_ISDIR(inode->i_mode) && (inode->i_mode & S_ISVTX) &&
129 (mask & MAY_WRITE) && !inode_owner_or_capable(inode))
130 return -EPERM;
131 }
132
133 return inode_permission(inode, mask);
134}
135
136int
137__vfs_setxattr(struct dentry *dentry, struct inode *inode, const char *name,
138 const void *value, size_t size, int flags)
139{
140 const struct xattr_handler *handler;
141
142 handler = xattr_resolve_name(inode, &name);
143 if (IS_ERR(handler))
144 return PTR_ERR(handler);
145 if (!handler->set)
146 return -EOPNOTSUPP;
147 if (size == 0)
148 value = ""; /* empty EA, do not remove */
149 return handler->set(handler, dentry, inode, name, value, size, flags);
150}
151EXPORT_SYMBOL(__vfs_setxattr);
152
153/**
154 * __vfs_setxattr_noperm - perform setxattr operation without performing
155 * permission checks.
156 *
157 * @dentry - object to perform setxattr on
158 * @name - xattr name to set
159 * @value - value to set @name to
160 * @size - size of @value
161 * @flags - flags to pass into filesystem operations
162 *
163 * returns the result of the internal setxattr or setsecurity operations.
164 *
165 * This function requires the caller to lock the inode's i_mutex before it
166 * is executed. It also assumes that the caller will make the appropriate
167 * permission checks.
168 */
169int __vfs_setxattr_noperm(struct dentry *dentry, const char *name,
170 const void *value, size_t size, int flags)
171{
172 struct inode *inode = dentry->d_inode;
173 int error = -EAGAIN;
174 int issec = !strncmp(name, XATTR_SECURITY_PREFIX,
175 XATTR_SECURITY_PREFIX_LEN);
176
177 if (issec)
178 inode->i_flags &= ~S_NOSEC;
179 if (inode->i_opflags & IOP_XATTR) {
180 error = __vfs_setxattr(dentry, inode, name, value, size, flags);
181 if (!error) {
182 fsnotify_xattr(dentry);
183 security_inode_post_setxattr(dentry, name, value,
184 size, flags);
185 }
186 } else {
187 if (unlikely(is_bad_inode(inode)))
188 return -EIO;
189 }
190 if (error == -EAGAIN) {
191 error = -EOPNOTSUPP;
192
193 if (issec) {
194 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
195
196 error = security_inode_setsecurity(inode, suffix, value,
197 size, flags);
198 if (!error)
199 fsnotify_xattr(dentry);
200 }
201 }
202
203 return error;
204}
205
206
207int
208vfs_setxattr(struct dentry *dentry, const char *name, const void *value,
209 size_t size, int flags)
210{
211 struct inode *inode = dentry->d_inode;
212 int error;
213
214 error = xattr_permission(inode, name, MAY_WRITE);
215 if (error)
216 return error;
217
218 inode_lock(inode);
219 error = security_inode_setxattr(dentry, name, value, size, flags);
220 if (error)
221 goto out;
222
223 error = __vfs_setxattr_noperm(dentry, name, value, size, flags);
224
225out:
226 inode_unlock(inode);
227 return error;
228}
229EXPORT_SYMBOL_GPL(vfs_setxattr);
230
231ssize_t
232xattr_getsecurity(struct inode *inode, const char *name, void *value,
233 size_t size)
234{
235 void *buffer = NULL;
236 ssize_t len;
237
238 if (!value || !size) {
239 len = security_inode_getsecurity(inode, name, &buffer, false);
240 goto out_noalloc;
241 }
242
243 len = security_inode_getsecurity(inode, name, &buffer, true);
244 if (len < 0)
245 return len;
246 if (size < len) {
247 len = -ERANGE;
248 goto out;
249 }
250 memcpy(value, buffer, len);
251out:
252 security_release_secctx(buffer, len);
253out_noalloc:
254 return len;
255}
256EXPORT_SYMBOL_GPL(xattr_getsecurity);
257
258/*
259 * vfs_getxattr_alloc - allocate memory, if necessary, before calling getxattr
260 *
261 * Allocate memory, if not already allocated, or re-allocate correct size,
262 * before retrieving the extended attribute.
263 *
264 * Returns the result of alloc, if failed, or the getxattr operation.
265 */
266ssize_t
267vfs_getxattr_alloc(struct dentry *dentry, const char *name, char **xattr_value,
268 size_t xattr_size, gfp_t flags)
269{
270 const struct xattr_handler *handler;
271 struct inode *inode = dentry->d_inode;
272 char *value = *xattr_value;
273 int error;
274
275 error = xattr_permission(inode, name, MAY_READ);
276 if (error)
277 return error;
278
279 handler = xattr_resolve_name(inode, &name);
280 if (IS_ERR(handler))
281 return PTR_ERR(handler);
282 if (!handler->get)
283 return -EOPNOTSUPP;
284 error = handler->get(handler, dentry, inode, name, NULL, 0);
285 if (error < 0)
286 return error;
287
288 if (!value || (error > xattr_size)) {
289 value = krealloc(*xattr_value, error + 1, flags);
290 if (!value)
291 return -ENOMEM;
292 memset(value, 0, error + 1);
293 }
294
295 error = handler->get(handler, dentry, inode, name, value, error);
296 *xattr_value = value;
297 return error;
298}
299
300ssize_t
301__vfs_getxattr(struct dentry *dentry, struct inode *inode, const char *name,
302 void *value, size_t size)
303{
304 const struct xattr_handler *handler;
305
306 handler = xattr_resolve_name(inode, &name);
307 if (IS_ERR(handler))
308 return PTR_ERR(handler);
309 if (!handler->get)
310 return -EOPNOTSUPP;
311 return handler->get(handler, dentry, inode, name, value, size);
312}
313EXPORT_SYMBOL(__vfs_getxattr);
314
315ssize_t
316vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
317{
318 struct inode *inode = dentry->d_inode;
319 int error;
320
321 error = xattr_permission(inode, name, MAY_READ);
322 if (error)
323 return error;
324
325 error = security_inode_getxattr(dentry, name);
326 if (error)
327 return error;
328
329 if (!strncmp(name, XATTR_SECURITY_PREFIX,
330 XATTR_SECURITY_PREFIX_LEN)) {
331 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
332 int ret = xattr_getsecurity(inode, suffix, value, size);
333 /*
334 * Only overwrite the return value if a security module
335 * is actually active.
336 */
337 if (ret == -EOPNOTSUPP)
338 goto nolsm;
339 return ret;
340 }
341nolsm:
342 return __vfs_getxattr(dentry, inode, name, value, size);
343}
344EXPORT_SYMBOL_GPL(vfs_getxattr);
345
346ssize_t
347vfs_listxattr(struct dentry *dentry, char *list, size_t size)
348{
349 struct inode *inode = d_inode(dentry);
350 ssize_t error;
351
352 error = security_inode_listxattr(dentry);
353 if (error)
354 return error;
355 if (inode->i_op->listxattr && (inode->i_opflags & IOP_XATTR)) {
356 error = -EOPNOTSUPP;
357 error = inode->i_op->listxattr(dentry, list, size);
358 } else {
359 error = security_inode_listsecurity(inode, list, size);
360 if (size && error > size)
361 error = -ERANGE;
362 }
363 return error;
364}
365EXPORT_SYMBOL_GPL(vfs_listxattr);
366
367int
368__vfs_removexattr(struct dentry *dentry, const char *name)
369{
370 struct inode *inode = d_inode(dentry);
371 const struct xattr_handler *handler;
372
373 handler = xattr_resolve_name(inode, &name);
374 if (IS_ERR(handler))
375 return PTR_ERR(handler);
376 if (!handler->set)
377 return -EOPNOTSUPP;
378 return handler->set(handler, dentry, inode, name, NULL, 0, XATTR_REPLACE);
379}
380EXPORT_SYMBOL(__vfs_removexattr);
381
382int
383vfs_removexattr(struct dentry *dentry, const char *name)
384{
385 struct inode *inode = dentry->d_inode;
386 int error;
387
388 error = xattr_permission(inode, name, MAY_WRITE);
389 if (error)
390 return error;
391
392 inode_lock(inode);
393 error = security_inode_removexattr(dentry, name);
394 if (error)
395 goto out;
396
397 error = __vfs_removexattr(dentry, name);
398
399 if (!error) {
400 fsnotify_xattr(dentry);
401 evm_inode_post_removexattr(dentry, name);
402 }
403
404out:
405 inode_unlock(inode);
406 return error;
407}
408EXPORT_SYMBOL_GPL(vfs_removexattr);
409
410
411/*
412 * Extended attribute SET operations
413 */
414static long
415setxattr(struct dentry *d, const char __user *name, const void __user *value,
416 size_t size, int flags)
417{
418 int error;
419 void *kvalue = NULL;
420 char kname[XATTR_NAME_MAX + 1];
421
422 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
423 return -EINVAL;
424
425 error = strncpy_from_user(kname, name, sizeof(kname));
426 if (error == 0 || error == sizeof(kname))
427 error = -ERANGE;
428 if (error < 0)
429 return error;
430
431 if (size) {
432 if (size > XATTR_SIZE_MAX)
433 return -E2BIG;
434 kvalue = kmalloc(size, GFP_KERNEL | __GFP_NOWARN);
435 if (!kvalue) {
436 kvalue = vmalloc(size);
437 if (!kvalue)
438 return -ENOMEM;
439 }
440 if (copy_from_user(kvalue, value, size)) {
441 error = -EFAULT;
442 goto out;
443 }
444 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
445 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
446 posix_acl_fix_xattr_from_user(kvalue, size);
447 }
448
449 error = vfs_setxattr(d, kname, kvalue, size, flags);
450out:
451 kvfree(kvalue);
452
453 return error;
454}
455
456static int path_setxattr(const char __user *pathname,
457 const char __user *name, const void __user *value,
458 size_t size, int flags, unsigned int lookup_flags)
459{
460 struct path path;
461 int error;
462retry:
463 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
464 if (error)
465 return error;
466 error = mnt_want_write(path.mnt);
467 if (!error) {
468 error = setxattr(path.dentry, name, value, size, flags);
469 mnt_drop_write(path.mnt);
470 }
471 path_put(&path);
472 if (retry_estale(error, lookup_flags)) {
473 lookup_flags |= LOOKUP_REVAL;
474 goto retry;
475 }
476 return error;
477}
478
479SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
480 const char __user *, name, const void __user *, value,
481 size_t, size, int, flags)
482{
483 return path_setxattr(pathname, name, value, size, flags, LOOKUP_FOLLOW);
484}
485
486SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
487 const char __user *, name, const void __user *, value,
488 size_t, size, int, flags)
489{
490 return path_setxattr(pathname, name, value, size, flags, 0);
491}
492
493SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
494 const void __user *,value, size_t, size, int, flags)
495{
496 struct fd f = fdget(fd);
497 int error = -EBADF;
498
499 if (!f.file)
500 return error;
501 audit_file(f.file);
502 error = mnt_want_write_file(f.file);
503 if (!error) {
504 error = setxattr(f.file->f_path.dentry, name, value, size, flags);
505 mnt_drop_write_file(f.file);
506 }
507 fdput(f);
508 return error;
509}
510
511/*
512 * Extended attribute GET operations
513 */
514static ssize_t
515getxattr(struct dentry *d, const char __user *name, void __user *value,
516 size_t size)
517{
518 ssize_t error;
519 void *kvalue = NULL;
520 char kname[XATTR_NAME_MAX + 1];
521
522 error = strncpy_from_user(kname, name, sizeof(kname));
523 if (error == 0 || error == sizeof(kname))
524 error = -ERANGE;
525 if (error < 0)
526 return error;
527
528 if (size) {
529 if (size > XATTR_SIZE_MAX)
530 size = XATTR_SIZE_MAX;
531 kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
532 if (!kvalue) {
533 kvalue = vmalloc(size);
534 if (!kvalue)
535 return -ENOMEM;
536 }
537 }
538
539 error = vfs_getxattr(d, kname, kvalue, size);
540 if (error > 0) {
541 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
542 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
543 posix_acl_fix_xattr_to_user(kvalue, size);
544 if (size && copy_to_user(value, kvalue, error))
545 error = -EFAULT;
546 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
547 /* The file system tried to returned a value bigger
548 than XATTR_SIZE_MAX bytes. Not possible. */
549 error = -E2BIG;
550 }
551
552 kvfree(kvalue);
553
554 return error;
555}
556
557static ssize_t path_getxattr(const char __user *pathname,
558 const char __user *name, void __user *value,
559 size_t size, unsigned int lookup_flags)
560{
561 struct path path;
562 ssize_t error;
563retry:
564 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
565 if (error)
566 return error;
567 error = getxattr(path.dentry, name, value, size);
568 path_put(&path);
569 if (retry_estale(error, lookup_flags)) {
570 lookup_flags |= LOOKUP_REVAL;
571 goto retry;
572 }
573 return error;
574}
575
576SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
577 const char __user *, name, void __user *, value, size_t, size)
578{
579 return path_getxattr(pathname, name, value, size, LOOKUP_FOLLOW);
580}
581
582SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
583 const char __user *, name, void __user *, value, size_t, size)
584{
585 return path_getxattr(pathname, name, value, size, 0);
586}
587
588SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
589 void __user *, value, size_t, size)
590{
591 struct fd f = fdget(fd);
592 ssize_t error = -EBADF;
593
594 if (!f.file)
595 return error;
596 audit_file(f.file);
597 error = getxattr(f.file->f_path.dentry, name, value, size);
598 fdput(f);
599 return error;
600}
601
602/*
603 * Extended attribute LIST operations
604 */
605static ssize_t
606listxattr(struct dentry *d, char __user *list, size_t size)
607{
608 ssize_t error;
609 char *klist = NULL;
610
611 if (size) {
612 if (size > XATTR_LIST_MAX)
613 size = XATTR_LIST_MAX;
614 klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
615 if (!klist) {
616 klist = vmalloc(size);
617 if (!klist)
618 return -ENOMEM;
619 }
620 }
621
622 error = vfs_listxattr(d, klist, size);
623 if (error > 0) {
624 if (size && copy_to_user(list, klist, error))
625 error = -EFAULT;
626 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
627 /* The file system tried to returned a list bigger
628 than XATTR_LIST_MAX bytes. Not possible. */
629 error = -E2BIG;
630 }
631
632 kvfree(klist);
633
634 return error;
635}
636
637static ssize_t path_listxattr(const char __user *pathname, char __user *list,
638 size_t size, unsigned int lookup_flags)
639{
640 struct path path;
641 ssize_t error;
642retry:
643 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
644 if (error)
645 return error;
646 error = listxattr(path.dentry, list, size);
647 path_put(&path);
648 if (retry_estale(error, lookup_flags)) {
649 lookup_flags |= LOOKUP_REVAL;
650 goto retry;
651 }
652 return error;
653}
654
655SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
656 size_t, size)
657{
658 return path_listxattr(pathname, list, size, LOOKUP_FOLLOW);
659}
660
661SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
662 size_t, size)
663{
664 return path_listxattr(pathname, list, size, 0);
665}
666
667SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
668{
669 struct fd f = fdget(fd);
670 ssize_t error = -EBADF;
671
672 if (!f.file)
673 return error;
674 audit_file(f.file);
675 error = listxattr(f.file->f_path.dentry, list, size);
676 fdput(f);
677 return error;
678}
679
680/*
681 * Extended attribute REMOVE operations
682 */
683static long
684removexattr(struct dentry *d, const char __user *name)
685{
686 int error;
687 char kname[XATTR_NAME_MAX + 1];
688
689 error = strncpy_from_user(kname, name, sizeof(kname));
690 if (error == 0 || error == sizeof(kname))
691 error = -ERANGE;
692 if (error < 0)
693 return error;
694
695 return vfs_removexattr(d, kname);
696}
697
698static int path_removexattr(const char __user *pathname,
699 const char __user *name, unsigned int lookup_flags)
700{
701 struct path path;
702 int error;
703retry:
704 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
705 if (error)
706 return error;
707 error = mnt_want_write(path.mnt);
708 if (!error) {
709 error = removexattr(path.dentry, name);
710 mnt_drop_write(path.mnt);
711 }
712 path_put(&path);
713 if (retry_estale(error, lookup_flags)) {
714 lookup_flags |= LOOKUP_REVAL;
715 goto retry;
716 }
717 return error;
718}
719
720SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
721 const char __user *, name)
722{
723 return path_removexattr(pathname, name, LOOKUP_FOLLOW);
724}
725
726SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
727 const char __user *, name)
728{
729 return path_removexattr(pathname, name, 0);
730}
731
732SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
733{
734 struct fd f = fdget(fd);
735 int error = -EBADF;
736
737 if (!f.file)
738 return error;
739 audit_file(f.file);
740 error = mnt_want_write_file(f.file);
741 if (!error) {
742 error = removexattr(f.file->f_path.dentry, name);
743 mnt_drop_write_file(f.file);
744 }
745 fdput(f);
746 return error;
747}
748
749/*
750 * Combine the results of the list() operation from every xattr_handler in the
751 * list.
752 */
753ssize_t
754generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
755{
756 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
757 unsigned int size = 0;
758
759 if (!buffer) {
760 for_each_xattr_handler(handlers, handler) {
761 if (!handler->name ||
762 (handler->list && !handler->list(dentry)))
763 continue;
764 size += strlen(handler->name) + 1;
765 }
766 } else {
767 char *buf = buffer;
768 size_t len;
769
770 for_each_xattr_handler(handlers, handler) {
771 if (!handler->name ||
772 (handler->list && !handler->list(dentry)))
773 continue;
774 len = strlen(handler->name);
775 if (len + 1 > buffer_size)
776 return -ERANGE;
777 memcpy(buf, handler->name, len + 1);
778 buf += len + 1;
779 buffer_size -= len + 1;
780 }
781 size = buf - buffer;
782 }
783 return size;
784}
785EXPORT_SYMBOL(generic_listxattr);
786
787/**
788 * xattr_full_name - Compute full attribute name from suffix
789 *
790 * @handler: handler of the xattr_handler operation
791 * @name: name passed to the xattr_handler operation
792 *
793 * The get and set xattr handler operations are called with the remainder of
794 * the attribute name after skipping the handler's prefix: for example, "foo"
795 * is passed to the get operation of a handler with prefix "user." to get
796 * attribute "user.foo". The full name is still "there" in the name though.
797 *
798 * Note: the list xattr handler operation when called from the vfs is passed a
799 * NULL name; some file systems use this operation internally, with varying
800 * semantics.
801 */
802const char *xattr_full_name(const struct xattr_handler *handler,
803 const char *name)
804{
805 size_t prefix_len = strlen(xattr_prefix(handler));
806
807 return name - prefix_len;
808}
809EXPORT_SYMBOL(xattr_full_name);
810
811/*
812 * Allocate new xattr and copy in the value; but leave the name to callers.
813 */
814struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
815{
816 struct simple_xattr *new_xattr;
817 size_t len;
818
819 /* wrap around? */
820 len = sizeof(*new_xattr) + size;
821 if (len < sizeof(*new_xattr))
822 return NULL;
823
824 new_xattr = kmalloc(len, GFP_KERNEL);
825 if (!new_xattr)
826 return NULL;
827
828 new_xattr->size = size;
829 memcpy(new_xattr->value, value, size);
830 return new_xattr;
831}
832
833/*
834 * xattr GET operation for in-memory/pseudo filesystems
835 */
836int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
837 void *buffer, size_t size)
838{
839 struct simple_xattr *xattr;
840 int ret = -ENODATA;
841
842 spin_lock(&xattrs->lock);
843 list_for_each_entry(xattr, &xattrs->head, list) {
844 if (strcmp(name, xattr->name))
845 continue;
846
847 ret = xattr->size;
848 if (buffer) {
849 if (size < xattr->size)
850 ret = -ERANGE;
851 else
852 memcpy(buffer, xattr->value, xattr->size);
853 }
854 break;
855 }
856 spin_unlock(&xattrs->lock);
857 return ret;
858}
859
860/**
861 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
862 * @xattrs: target simple_xattr list
863 * @name: name of the extended attribute
864 * @value: value of the xattr. If %NULL, will remove the attribute.
865 * @size: size of the new xattr
866 * @flags: %XATTR_{CREATE|REPLACE}
867 *
868 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
869 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
870 * otherwise, fails with -ENODATA.
871 *
872 * Returns 0 on success, -errno on failure.
873 */
874int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
875 const void *value, size_t size, int flags)
876{
877 struct simple_xattr *xattr;
878 struct simple_xattr *new_xattr = NULL;
879 int err = 0;
880
881 /* value == NULL means remove */
882 if (value) {
883 new_xattr = simple_xattr_alloc(value, size);
884 if (!new_xattr)
885 return -ENOMEM;
886
887 new_xattr->name = kstrdup(name, GFP_KERNEL);
888 if (!new_xattr->name) {
889 kfree(new_xattr);
890 return -ENOMEM;
891 }
892 }
893
894 spin_lock(&xattrs->lock);
895 list_for_each_entry(xattr, &xattrs->head, list) {
896 if (!strcmp(name, xattr->name)) {
897 if (flags & XATTR_CREATE) {
898 xattr = new_xattr;
899 err = -EEXIST;
900 } else if (new_xattr) {
901 list_replace(&xattr->list, &new_xattr->list);
902 } else {
903 list_del(&xattr->list);
904 }
905 goto out;
906 }
907 }
908 if (flags & XATTR_REPLACE) {
909 xattr = new_xattr;
910 err = -ENODATA;
911 } else {
912 list_add(&new_xattr->list, &xattrs->head);
913 xattr = NULL;
914 }
915out:
916 spin_unlock(&xattrs->lock);
917 if (xattr) {
918 kfree(xattr->name);
919 kfree(xattr);
920 }
921 return err;
922
923}
924
925static bool xattr_is_trusted(const char *name)
926{
927 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
928}
929
930static int xattr_list_one(char **buffer, ssize_t *remaining_size,
931 const char *name)
932{
933 size_t len = strlen(name) + 1;
934 if (*buffer) {
935 if (*remaining_size < len)
936 return -ERANGE;
937 memcpy(*buffer, name, len);
938 *buffer += len;
939 }
940 *remaining_size -= len;
941 return 0;
942}
943
944/*
945 * xattr LIST operation for in-memory/pseudo filesystems
946 */
947ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs,
948 char *buffer, size_t size)
949{
950 bool trusted = capable(CAP_SYS_ADMIN);
951 struct simple_xattr *xattr;
952 ssize_t remaining_size = size;
953 int err = 0;
954
955#ifdef CONFIG_FS_POSIX_ACL
956 if (inode->i_acl) {
957 err = xattr_list_one(&buffer, &remaining_size,
958 XATTR_NAME_POSIX_ACL_ACCESS);
959 if (err)
960 return err;
961 }
962 if (inode->i_default_acl) {
963 err = xattr_list_one(&buffer, &remaining_size,
964 XATTR_NAME_POSIX_ACL_DEFAULT);
965 if (err)
966 return err;
967 }
968#endif
969
970 spin_lock(&xattrs->lock);
971 list_for_each_entry(xattr, &xattrs->head, list) {
972 /* skip "trusted." attributes for unprivileged callers */
973 if (!trusted && xattr_is_trusted(xattr->name))
974 continue;
975
976 err = xattr_list_one(&buffer, &remaining_size, xattr->name);
977 if (err)
978 break;
979 }
980 spin_unlock(&xattrs->lock);
981
982 return err ? err : size - remaining_size;
983}
984
985/*
986 * Adds an extended attribute to the list
987 */
988void simple_xattr_list_add(struct simple_xattrs *xattrs,
989 struct simple_xattr *new_xattr)
990{
991 spin_lock(&xattrs->lock);
992 list_add(&new_xattr->list, &xattrs->head);
993 spin_unlock(&xattrs->lock);
994}
1/*
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>
12#include <linux/file.h>
13#include <linux/xattr.h>
14#include <linux/mount.h>
15#include <linux/namei.h>
16#include <linux/security.h>
17#include <linux/evm.h>
18#include <linux/syscalls.h>
19#include <linux/export.h>
20#include <linux/fsnotify.h>
21#include <linux/audit.h>
22#include <linux/vmalloc.h>
23#include <linux/posix_acl_xattr.h>
24
25#include <linux/uaccess.h>
26#include "internal.h"
27
28static const char *
29strcmp_prefix(const char *a, const char *a_prefix)
30{
31 while (*a_prefix && *a == *a_prefix) {
32 a++;
33 a_prefix++;
34 }
35 return *a_prefix ? NULL : a;
36}
37
38/*
39 * In order to implement different sets of xattr operations for each xattr
40 * prefix, a filesystem should create a null-terminated array of struct
41 * xattr_handler (one for each prefix) and hang a pointer to it off of the
42 * s_xattr field of the superblock.
43 */
44#define for_each_xattr_handler(handlers, handler) \
45 if (handlers) \
46 for ((handler) = *(handlers)++; \
47 (handler) != NULL; \
48 (handler) = *(handlers)++)
49
50/*
51 * Find the xattr_handler with the matching prefix.
52 */
53static const struct xattr_handler *
54xattr_resolve_name(struct inode *inode, const char **name)
55{
56 const struct xattr_handler **handlers = inode->i_sb->s_xattr;
57 const struct xattr_handler *handler;
58
59 if (!(inode->i_opflags & IOP_XATTR)) {
60 if (unlikely(is_bad_inode(inode)))
61 return ERR_PTR(-EIO);
62 return ERR_PTR(-EOPNOTSUPP);
63 }
64 for_each_xattr_handler(handlers, handler) {
65 const char *n;
66
67 n = strcmp_prefix(*name, xattr_prefix(handler));
68 if (n) {
69 if (!handler->prefix ^ !*n) {
70 if (*n)
71 continue;
72 return ERR_PTR(-EINVAL);
73 }
74 *name = n;
75 return handler;
76 }
77 }
78 return ERR_PTR(-EOPNOTSUPP);
79}
80
81/*
82 * Check permissions for extended attribute access. This is a bit complicated
83 * because different namespaces have very different rules.
84 */
85static int
86xattr_permission(struct inode *inode, const char *name, int mask)
87{
88 /*
89 * We can never set or remove an extended attribute on a read-only
90 * filesystem or on an immutable / append-only inode.
91 */
92 if (mask & MAY_WRITE) {
93 if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
94 return -EPERM;
95 /*
96 * Updating an xattr will likely cause i_uid and i_gid
97 * to be writen back improperly if their true value is
98 * unknown to the vfs.
99 */
100 if (HAS_UNMAPPED_ID(inode))
101 return -EPERM;
102 }
103
104 /*
105 * No restriction for security.* and system.* from the VFS. Decision
106 * on these is left to the underlying filesystem / security module.
107 */
108 if (!strncmp(name, XATTR_SECURITY_PREFIX, XATTR_SECURITY_PREFIX_LEN) ||
109 !strncmp(name, XATTR_SYSTEM_PREFIX, XATTR_SYSTEM_PREFIX_LEN))
110 return 0;
111
112 /*
113 * The trusted.* namespace can only be accessed by privileged users.
114 */
115 if (!strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN)) {
116 if (!capable(CAP_SYS_ADMIN))
117 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
118 return 0;
119 }
120
121 /*
122 * In the user.* namespace, only regular files and directories can have
123 * extended attributes. For sticky directories, only the owner and
124 * privileged users can write attributes.
125 */
126 if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
127 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
128 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
129 if (S_ISDIR(inode->i_mode) && (inode->i_mode & S_ISVTX) &&
130 (mask & MAY_WRITE) && !inode_owner_or_capable(inode))
131 return -EPERM;
132 }
133
134 return inode_permission(inode, mask);
135}
136
137int
138__vfs_setxattr(struct dentry *dentry, struct inode *inode, const char *name,
139 const void *value, size_t size, int flags)
140{
141 const struct xattr_handler *handler;
142
143 handler = xattr_resolve_name(inode, &name);
144 if (IS_ERR(handler))
145 return PTR_ERR(handler);
146 if (!handler->set)
147 return -EOPNOTSUPP;
148 if (size == 0)
149 value = ""; /* empty EA, do not remove */
150 return handler->set(handler, dentry, inode, name, value, size, flags);
151}
152EXPORT_SYMBOL(__vfs_setxattr);
153
154/**
155 * __vfs_setxattr_noperm - perform setxattr operation without performing
156 * permission checks.
157 *
158 * @dentry - object to perform setxattr on
159 * @name - xattr name to set
160 * @value - value to set @name to
161 * @size - size of @value
162 * @flags - flags to pass into filesystem operations
163 *
164 * returns the result of the internal setxattr or setsecurity operations.
165 *
166 * This function requires the caller to lock the inode's i_mutex before it
167 * is executed. It also assumes that the caller will make the appropriate
168 * permission checks.
169 */
170int __vfs_setxattr_noperm(struct dentry *dentry, const char *name,
171 const void *value, size_t size, int flags)
172{
173 struct inode *inode = dentry->d_inode;
174 int error = -EAGAIN;
175 int issec = !strncmp(name, XATTR_SECURITY_PREFIX,
176 XATTR_SECURITY_PREFIX_LEN);
177
178 if (issec)
179 inode->i_flags &= ~S_NOSEC;
180 if (inode->i_opflags & IOP_XATTR) {
181 error = __vfs_setxattr(dentry, inode, name, value, size, flags);
182 if (!error) {
183 fsnotify_xattr(dentry);
184 security_inode_post_setxattr(dentry, name, value,
185 size, flags);
186 }
187 } else {
188 if (unlikely(is_bad_inode(inode)))
189 return -EIO;
190 }
191 if (error == -EAGAIN) {
192 error = -EOPNOTSUPP;
193
194 if (issec) {
195 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
196
197 error = security_inode_setsecurity(inode, suffix, value,
198 size, flags);
199 if (!error)
200 fsnotify_xattr(dentry);
201 }
202 }
203
204 return error;
205}
206
207
208int
209vfs_setxattr(struct dentry *dentry, const char *name, const void *value,
210 size_t size, int flags)
211{
212 struct inode *inode = dentry->d_inode;
213 int error;
214
215 error = xattr_permission(inode, name, MAY_WRITE);
216 if (error)
217 return error;
218
219 inode_lock(inode);
220 error = security_inode_setxattr(dentry, name, value, size, flags);
221 if (error)
222 goto out;
223
224 error = __vfs_setxattr_noperm(dentry, name, value, size, flags);
225
226out:
227 inode_unlock(inode);
228 return error;
229}
230EXPORT_SYMBOL_GPL(vfs_setxattr);
231
232ssize_t
233xattr_getsecurity(struct inode *inode, const char *name, void *value,
234 size_t size)
235{
236 void *buffer = NULL;
237 ssize_t len;
238
239 if (!value || !size) {
240 len = security_inode_getsecurity(inode, name, &buffer, false);
241 goto out_noalloc;
242 }
243
244 len = security_inode_getsecurity(inode, name, &buffer, true);
245 if (len < 0)
246 return len;
247 if (size < len) {
248 len = -ERANGE;
249 goto out;
250 }
251 memcpy(value, buffer, len);
252out:
253 kfree(buffer);
254out_noalloc:
255 return len;
256}
257EXPORT_SYMBOL_GPL(xattr_getsecurity);
258
259/*
260 * vfs_getxattr_alloc - allocate memory, if necessary, before calling getxattr
261 *
262 * Allocate memory, if not already allocated, or re-allocate correct size,
263 * before retrieving the extended attribute.
264 *
265 * Returns the result of alloc, if failed, or the getxattr operation.
266 */
267ssize_t
268vfs_getxattr_alloc(struct dentry *dentry, const char *name, char **xattr_value,
269 size_t xattr_size, gfp_t flags)
270{
271 const struct xattr_handler *handler;
272 struct inode *inode = dentry->d_inode;
273 char *value = *xattr_value;
274 int error;
275
276 error = xattr_permission(inode, name, MAY_READ);
277 if (error)
278 return error;
279
280 handler = xattr_resolve_name(inode, &name);
281 if (IS_ERR(handler))
282 return PTR_ERR(handler);
283 if (!handler->get)
284 return -EOPNOTSUPP;
285 error = handler->get(handler, dentry, inode, name, NULL, 0);
286 if (error < 0)
287 return error;
288
289 if (!value || (error > xattr_size)) {
290 value = krealloc(*xattr_value, error + 1, flags);
291 if (!value)
292 return -ENOMEM;
293 memset(value, 0, error + 1);
294 }
295
296 error = handler->get(handler, dentry, inode, name, value, error);
297 *xattr_value = value;
298 return error;
299}
300
301ssize_t
302__vfs_getxattr(struct dentry *dentry, struct inode *inode, const char *name,
303 void *value, size_t size)
304{
305 const struct xattr_handler *handler;
306
307 handler = xattr_resolve_name(inode, &name);
308 if (IS_ERR(handler))
309 return PTR_ERR(handler);
310 if (!handler->get)
311 return -EOPNOTSUPP;
312 return handler->get(handler, dentry, inode, name, value, size);
313}
314EXPORT_SYMBOL(__vfs_getxattr);
315
316ssize_t
317vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
318{
319 struct inode *inode = dentry->d_inode;
320 int error;
321
322 error = xattr_permission(inode, name, MAY_READ);
323 if (error)
324 return error;
325
326 error = security_inode_getxattr(dentry, name);
327 if (error)
328 return error;
329
330 if (!strncmp(name, XATTR_SECURITY_PREFIX,
331 XATTR_SECURITY_PREFIX_LEN)) {
332 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
333 int ret = xattr_getsecurity(inode, suffix, value, size);
334 /*
335 * Only overwrite the return value if a security module
336 * is actually active.
337 */
338 if (ret == -EOPNOTSUPP)
339 goto nolsm;
340 return ret;
341 }
342nolsm:
343 return __vfs_getxattr(dentry, inode, name, value, size);
344}
345EXPORT_SYMBOL_GPL(vfs_getxattr);
346
347ssize_t
348vfs_listxattr(struct dentry *dentry, char *list, size_t size)
349{
350 struct inode *inode = d_inode(dentry);
351 ssize_t error;
352
353 error = security_inode_listxattr(dentry);
354 if (error)
355 return error;
356 if (inode->i_op->listxattr && (inode->i_opflags & IOP_XATTR)) {
357 error = -EOPNOTSUPP;
358 error = inode->i_op->listxattr(dentry, list, size);
359 } else {
360 error = security_inode_listsecurity(inode, list, size);
361 if (size && error > size)
362 error = -ERANGE;
363 }
364 return error;
365}
366EXPORT_SYMBOL_GPL(vfs_listxattr);
367
368int
369__vfs_removexattr(struct dentry *dentry, const char *name)
370{
371 struct inode *inode = d_inode(dentry);
372 const struct xattr_handler *handler;
373
374 handler = xattr_resolve_name(inode, &name);
375 if (IS_ERR(handler))
376 return PTR_ERR(handler);
377 if (!handler->set)
378 return -EOPNOTSUPP;
379 return handler->set(handler, dentry, inode, name, NULL, 0, XATTR_REPLACE);
380}
381EXPORT_SYMBOL(__vfs_removexattr);
382
383int
384vfs_removexattr(struct dentry *dentry, const char *name)
385{
386 struct inode *inode = dentry->d_inode;
387 int error;
388
389 error = xattr_permission(inode, name, MAY_WRITE);
390 if (error)
391 return error;
392
393 inode_lock(inode);
394 error = security_inode_removexattr(dentry, name);
395 if (error)
396 goto out;
397
398 error = __vfs_removexattr(dentry, name);
399
400 if (!error) {
401 fsnotify_xattr(dentry);
402 evm_inode_post_removexattr(dentry, name);
403 }
404
405out:
406 inode_unlock(inode);
407 return error;
408}
409EXPORT_SYMBOL_GPL(vfs_removexattr);
410
411
412/*
413 * Extended attribute SET operations
414 */
415static long
416setxattr(struct dentry *d, const char __user *name, const void __user *value,
417 size_t size, int flags)
418{
419 int error;
420 void *kvalue = NULL;
421 char kname[XATTR_NAME_MAX + 1];
422
423 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
424 return -EINVAL;
425
426 error = strncpy_from_user(kname, name, sizeof(kname));
427 if (error == 0 || error == sizeof(kname))
428 error = -ERANGE;
429 if (error < 0)
430 return error;
431
432 if (size) {
433 if (size > XATTR_SIZE_MAX)
434 return -E2BIG;
435 kvalue = kvmalloc(size, GFP_KERNEL);
436 if (!kvalue)
437 return -ENOMEM;
438 if (copy_from_user(kvalue, value, size)) {
439 error = -EFAULT;
440 goto out;
441 }
442 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
443 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
444 posix_acl_fix_xattr_from_user(kvalue, size);
445 else if (strcmp(kname, XATTR_NAME_CAPS) == 0) {
446 error = cap_convert_nscap(d, &kvalue, size);
447 if (error < 0)
448 goto out;
449 size = error;
450 }
451 }
452
453 error = vfs_setxattr(d, kname, kvalue, size, flags);
454out:
455 kvfree(kvalue);
456
457 return error;
458}
459
460static int path_setxattr(const char __user *pathname,
461 const char __user *name, const void __user *value,
462 size_t size, int flags, unsigned int lookup_flags)
463{
464 struct path path;
465 int error;
466retry:
467 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
468 if (error)
469 return error;
470 error = mnt_want_write(path.mnt);
471 if (!error) {
472 error = setxattr(path.dentry, name, value, size, flags);
473 mnt_drop_write(path.mnt);
474 }
475 path_put(&path);
476 if (retry_estale(error, lookup_flags)) {
477 lookup_flags |= LOOKUP_REVAL;
478 goto retry;
479 }
480 return error;
481}
482
483SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
484 const char __user *, name, const void __user *, value,
485 size_t, size, int, flags)
486{
487 return path_setxattr(pathname, name, value, size, flags, LOOKUP_FOLLOW);
488}
489
490SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
491 const char __user *, name, const void __user *, value,
492 size_t, size, int, flags)
493{
494 return path_setxattr(pathname, name, value, size, flags, 0);
495}
496
497SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
498 const void __user *,value, size_t, size, int, flags)
499{
500 struct fd f = fdget(fd);
501 int error = -EBADF;
502
503 if (!f.file)
504 return error;
505 audit_file(f.file);
506 error = mnt_want_write_file_path(f.file);
507 if (!error) {
508 error = setxattr(f.file->f_path.dentry, name, value, size, flags);
509 mnt_drop_write_file_path(f.file);
510 }
511 fdput(f);
512 return error;
513}
514
515/*
516 * Extended attribute GET operations
517 */
518static ssize_t
519getxattr(struct dentry *d, const char __user *name, void __user *value,
520 size_t size)
521{
522 ssize_t error;
523 void *kvalue = NULL;
524 char kname[XATTR_NAME_MAX + 1];
525
526 error = strncpy_from_user(kname, name, sizeof(kname));
527 if (error == 0 || error == sizeof(kname))
528 error = -ERANGE;
529 if (error < 0)
530 return error;
531
532 if (size) {
533 if (size > XATTR_SIZE_MAX)
534 size = XATTR_SIZE_MAX;
535 kvalue = kvzalloc(size, GFP_KERNEL);
536 if (!kvalue)
537 return -ENOMEM;
538 }
539
540 error = vfs_getxattr(d, kname, kvalue, size);
541 if (error > 0) {
542 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
543 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
544 posix_acl_fix_xattr_to_user(kvalue, size);
545 if (size && copy_to_user(value, kvalue, error))
546 error = -EFAULT;
547 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
548 /* The file system tried to returned a value bigger
549 than XATTR_SIZE_MAX bytes. Not possible. */
550 error = -E2BIG;
551 }
552
553 kvfree(kvalue);
554
555 return error;
556}
557
558static ssize_t path_getxattr(const char __user *pathname,
559 const char __user *name, void __user *value,
560 size_t size, unsigned int lookup_flags)
561{
562 struct path path;
563 ssize_t error;
564retry:
565 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
566 if (error)
567 return error;
568 error = getxattr(path.dentry, name, value, size);
569 path_put(&path);
570 if (retry_estale(error, lookup_flags)) {
571 lookup_flags |= LOOKUP_REVAL;
572 goto retry;
573 }
574 return error;
575}
576
577SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
578 const char __user *, name, void __user *, value, size_t, size)
579{
580 return path_getxattr(pathname, name, value, size, LOOKUP_FOLLOW);
581}
582
583SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
584 const char __user *, name, void __user *, value, size_t, size)
585{
586 return path_getxattr(pathname, name, value, size, 0);
587}
588
589SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
590 void __user *, value, size_t, size)
591{
592 struct fd f = fdget(fd);
593 ssize_t error = -EBADF;
594
595 if (!f.file)
596 return error;
597 audit_file(f.file);
598 error = getxattr(f.file->f_path.dentry, name, value, size);
599 fdput(f);
600 return error;
601}
602
603/*
604 * Extended attribute LIST operations
605 */
606static ssize_t
607listxattr(struct dentry *d, char __user *list, size_t size)
608{
609 ssize_t error;
610 char *klist = NULL;
611
612 if (size) {
613 if (size > XATTR_LIST_MAX)
614 size = XATTR_LIST_MAX;
615 klist = kvmalloc(size, GFP_KERNEL);
616 if (!klist)
617 return -ENOMEM;
618 }
619
620 error = vfs_listxattr(d, klist, size);
621 if (error > 0) {
622 if (size && copy_to_user(list, klist, error))
623 error = -EFAULT;
624 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
625 /* The file system tried to returned a list bigger
626 than XATTR_LIST_MAX bytes. Not possible. */
627 error = -E2BIG;
628 }
629
630 kvfree(klist);
631
632 return error;
633}
634
635static ssize_t path_listxattr(const char __user *pathname, char __user *list,
636 size_t size, unsigned int lookup_flags)
637{
638 struct path path;
639 ssize_t error;
640retry:
641 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
642 if (error)
643 return error;
644 error = listxattr(path.dentry, list, size);
645 path_put(&path);
646 if (retry_estale(error, lookup_flags)) {
647 lookup_flags |= LOOKUP_REVAL;
648 goto retry;
649 }
650 return error;
651}
652
653SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
654 size_t, size)
655{
656 return path_listxattr(pathname, list, size, LOOKUP_FOLLOW);
657}
658
659SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
660 size_t, size)
661{
662 return path_listxattr(pathname, list, size, 0);
663}
664
665SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
666{
667 struct fd f = fdget(fd);
668 ssize_t error = -EBADF;
669
670 if (!f.file)
671 return error;
672 audit_file(f.file);
673 error = listxattr(f.file->f_path.dentry, list, size);
674 fdput(f);
675 return error;
676}
677
678/*
679 * Extended attribute REMOVE operations
680 */
681static long
682removexattr(struct dentry *d, const char __user *name)
683{
684 int error;
685 char kname[XATTR_NAME_MAX + 1];
686
687 error = strncpy_from_user(kname, name, sizeof(kname));
688 if (error == 0 || error == sizeof(kname))
689 error = -ERANGE;
690 if (error < 0)
691 return error;
692
693 return vfs_removexattr(d, kname);
694}
695
696static int path_removexattr(const char __user *pathname,
697 const char __user *name, unsigned int lookup_flags)
698{
699 struct path path;
700 int error;
701retry:
702 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
703 if (error)
704 return error;
705 error = mnt_want_write(path.mnt);
706 if (!error) {
707 error = removexattr(path.dentry, name);
708 mnt_drop_write(path.mnt);
709 }
710 path_put(&path);
711 if (retry_estale(error, lookup_flags)) {
712 lookup_flags |= LOOKUP_REVAL;
713 goto retry;
714 }
715 return error;
716}
717
718SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
719 const char __user *, name)
720{
721 return path_removexattr(pathname, name, LOOKUP_FOLLOW);
722}
723
724SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
725 const char __user *, name)
726{
727 return path_removexattr(pathname, name, 0);
728}
729
730SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
731{
732 struct fd f = fdget(fd);
733 int error = -EBADF;
734
735 if (!f.file)
736 return error;
737 audit_file(f.file);
738 error = mnt_want_write_file_path(f.file);
739 if (!error) {
740 error = removexattr(f.file->f_path.dentry, name);
741 mnt_drop_write_file_path(f.file);
742 }
743 fdput(f);
744 return error;
745}
746
747/*
748 * Combine the results of the list() operation from every xattr_handler in the
749 * list.
750 */
751ssize_t
752generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
753{
754 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
755 unsigned int size = 0;
756
757 if (!buffer) {
758 for_each_xattr_handler(handlers, handler) {
759 if (!handler->name ||
760 (handler->list && !handler->list(dentry)))
761 continue;
762 size += strlen(handler->name) + 1;
763 }
764 } else {
765 char *buf = buffer;
766 size_t len;
767
768 for_each_xattr_handler(handlers, handler) {
769 if (!handler->name ||
770 (handler->list && !handler->list(dentry)))
771 continue;
772 len = strlen(handler->name);
773 if (len + 1 > buffer_size)
774 return -ERANGE;
775 memcpy(buf, handler->name, len + 1);
776 buf += len + 1;
777 buffer_size -= len + 1;
778 }
779 size = buf - buffer;
780 }
781 return size;
782}
783EXPORT_SYMBOL(generic_listxattr);
784
785/**
786 * xattr_full_name - Compute full attribute name from suffix
787 *
788 * @handler: handler of the xattr_handler operation
789 * @name: name passed to the xattr_handler operation
790 *
791 * The get and set xattr handler operations are called with the remainder of
792 * the attribute name after skipping the handler's prefix: for example, "foo"
793 * is passed to the get operation of a handler with prefix "user." to get
794 * attribute "user.foo". The full name is still "there" in the name though.
795 *
796 * Note: the list xattr handler operation when called from the vfs is passed a
797 * NULL name; some file systems use this operation internally, with varying
798 * semantics.
799 */
800const char *xattr_full_name(const struct xattr_handler *handler,
801 const char *name)
802{
803 size_t prefix_len = strlen(xattr_prefix(handler));
804
805 return name - prefix_len;
806}
807EXPORT_SYMBOL(xattr_full_name);
808
809/*
810 * Allocate new xattr and copy in the value; but leave the name to callers.
811 */
812struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
813{
814 struct simple_xattr *new_xattr;
815 size_t len;
816
817 /* wrap around? */
818 len = sizeof(*new_xattr) + size;
819 if (len < sizeof(*new_xattr))
820 return NULL;
821
822 new_xattr = kmalloc(len, GFP_KERNEL);
823 if (!new_xattr)
824 return NULL;
825
826 new_xattr->size = size;
827 memcpy(new_xattr->value, value, size);
828 return new_xattr;
829}
830
831/*
832 * xattr GET operation for in-memory/pseudo filesystems
833 */
834int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
835 void *buffer, size_t size)
836{
837 struct simple_xattr *xattr;
838 int ret = -ENODATA;
839
840 spin_lock(&xattrs->lock);
841 list_for_each_entry(xattr, &xattrs->head, list) {
842 if (strcmp(name, xattr->name))
843 continue;
844
845 ret = xattr->size;
846 if (buffer) {
847 if (size < xattr->size)
848 ret = -ERANGE;
849 else
850 memcpy(buffer, xattr->value, xattr->size);
851 }
852 break;
853 }
854 spin_unlock(&xattrs->lock);
855 return ret;
856}
857
858/**
859 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
860 * @xattrs: target simple_xattr list
861 * @name: name of the extended attribute
862 * @value: value of the xattr. If %NULL, will remove the attribute.
863 * @size: size of the new xattr
864 * @flags: %XATTR_{CREATE|REPLACE}
865 *
866 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
867 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
868 * otherwise, fails with -ENODATA.
869 *
870 * Returns 0 on success, -errno on failure.
871 */
872int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
873 const void *value, size_t size, int flags)
874{
875 struct simple_xattr *xattr;
876 struct simple_xattr *new_xattr = NULL;
877 int err = 0;
878
879 /* value == NULL means remove */
880 if (value) {
881 new_xattr = simple_xattr_alloc(value, size);
882 if (!new_xattr)
883 return -ENOMEM;
884
885 new_xattr->name = kstrdup(name, GFP_KERNEL);
886 if (!new_xattr->name) {
887 kfree(new_xattr);
888 return -ENOMEM;
889 }
890 }
891
892 spin_lock(&xattrs->lock);
893 list_for_each_entry(xattr, &xattrs->head, list) {
894 if (!strcmp(name, xattr->name)) {
895 if (flags & XATTR_CREATE) {
896 xattr = new_xattr;
897 err = -EEXIST;
898 } else if (new_xattr) {
899 list_replace(&xattr->list, &new_xattr->list);
900 } else {
901 list_del(&xattr->list);
902 }
903 goto out;
904 }
905 }
906 if (flags & XATTR_REPLACE) {
907 xattr = new_xattr;
908 err = -ENODATA;
909 } else {
910 list_add(&new_xattr->list, &xattrs->head);
911 xattr = NULL;
912 }
913out:
914 spin_unlock(&xattrs->lock);
915 if (xattr) {
916 kfree(xattr->name);
917 kfree(xattr);
918 }
919 return err;
920
921}
922
923static bool xattr_is_trusted(const char *name)
924{
925 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
926}
927
928static int xattr_list_one(char **buffer, ssize_t *remaining_size,
929 const char *name)
930{
931 size_t len = strlen(name) + 1;
932 if (*buffer) {
933 if (*remaining_size < len)
934 return -ERANGE;
935 memcpy(*buffer, name, len);
936 *buffer += len;
937 }
938 *remaining_size -= len;
939 return 0;
940}
941
942/*
943 * xattr LIST operation for in-memory/pseudo filesystems
944 */
945ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs,
946 char *buffer, size_t size)
947{
948 bool trusted = capable(CAP_SYS_ADMIN);
949 struct simple_xattr *xattr;
950 ssize_t remaining_size = size;
951 int err = 0;
952
953#ifdef CONFIG_FS_POSIX_ACL
954 if (inode->i_acl) {
955 err = xattr_list_one(&buffer, &remaining_size,
956 XATTR_NAME_POSIX_ACL_ACCESS);
957 if (err)
958 return err;
959 }
960 if (inode->i_default_acl) {
961 err = xattr_list_one(&buffer, &remaining_size,
962 XATTR_NAME_POSIX_ACL_DEFAULT);
963 if (err)
964 return err;
965 }
966#endif
967
968 spin_lock(&xattrs->lock);
969 list_for_each_entry(xattr, &xattrs->head, list) {
970 /* skip "trusted." attributes for unprivileged callers */
971 if (!trusted && xattr_is_trusted(xattr->name))
972 continue;
973
974 err = xattr_list_one(&buffer, &remaining_size, xattr->name);
975 if (err)
976 break;
977 }
978 spin_unlock(&xattrs->lock);
979
980 return err ? err : size - remaining_size;
981}
982
983/*
984 * Adds an extended attribute to the list
985 */
986void simple_xattr_list_add(struct simple_xattrs *xattrs,
987 struct simple_xattr *new_xattr)
988{
989 spin_lock(&xattrs->lock);
990 list_add(&new_xattr->list, &xattrs->head);
991 spin_unlock(&xattrs->lock);
992}