blob: 386b45676d7e65b2e9958fb602e01e0c41f3e157 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 File: fs/xattr.c
4
5 Extended attribute handling.
6
7 Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org>
8 Copyright (C) 2001 SGI - Silicon Graphics, Inc <linux-xfs@oss.sgi.com>
9 Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com>
10 */
11#include <linux/fs.h>
12#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/file.h>
14#include <linux/xattr.h>
Dave Hansen18f335a2008-02-15 14:37:38 -080015#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/namei.h>
17#include <linux/security.h>
Mimi Zoharc7b87de2011-03-09 14:39:18 -050018#include <linux/evm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/syscalls.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050020#include <linux/export.h>
Robert Love0eeca282005-07-12 17:06:03 -040021#include <linux/fsnotify.h>
Amy Griffis73241cc2005-11-03 16:00:25 +000022#include <linux/audit.h>
Andrew Morton0d08d7b2012-04-05 14:25:07 -070023#include <linux/vmalloc.h>
Eric W. Biederman2f6f0652012-02-07 18:52:57 -080024#include <linux/posix_acl_xattr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080026#include <linux/uaccess.h>
Christoph Hellwig5be196e2006-01-09 20:51:55 -080027
Andreas Gruenbacherb6ba1172016-09-29 17:48:38 +020028static 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
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +020040 * 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.
Andreas Gruenbacherb6ba1172016-09-29 17:48:38 +020043 */
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 *
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +020054xattr_resolve_name(struct inode *inode, const char **name)
Andreas Gruenbacherb6ba1172016-09-29 17:48:38 +020055{
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +020056 const struct xattr_handler **handlers = inode->i_sb->s_xattr;
Andreas Gruenbacherb6ba1172016-09-29 17:48:38 +020057 const struct xattr_handler *handler;
58
Andreas Gruenbacher5f6e59a2016-09-29 17:48:40 +020059 if (!(inode->i_opflags & IOP_XATTR)) {
60 if (unlikely(is_bad_inode(inode)))
61 return ERR_PTR(-EIO);
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +020062 return ERR_PTR(-EOPNOTSUPP);
Andreas Gruenbacher5f6e59a2016-09-29 17:48:40 +020063 }
Andreas Gruenbacherb6ba1172016-09-29 17:48:38 +020064 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
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080081/*
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) {
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -080093 if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
94 return -EPERM;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -050095 /*
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;
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800102 }
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 /*
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +0200113 * The trusted.* namespace can only be accessed by privileged users.
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800114 */
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +0200115 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 }
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800120
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +0200121 /*
122 * In the user.* namespace, only regular files and directories can have
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -0800123 * extended attributes. For sticky directories, only the owner and
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +0200124 * privileged users can write attributes.
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -0800125 */
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800126 if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -0800127 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
Andreas Gruenbacher55b23bd2011-05-27 14:50:36 +0200128 return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
Andreas Gruenbacherf1f2d872006-11-02 22:07:29 -0800129 if (S_ISDIR(inode->i_mode) && (inode->i_mode & S_ISVTX) &&
Serge E. Hallyn2e149672011-03-23 16:43:26 -0700130 (mask & MAY_WRITE) && !inode_owner_or_capable(inode))
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800131 return -EPERM;
132 }
133
Al Virof419a2e2008-07-22 00:07:17 -0400134 return inode_permission(inode, mask);
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800135}
136
Frank van der Lindencab8d282020-06-23 22:39:19 +0000137/*
138 * Look for any handler that deals with the specified namespace.
139 */
140int
141xattr_supported_namespace(struct inode *inode, const char *prefix)
142{
143 const struct xattr_handler **handlers = inode->i_sb->s_xattr;
144 const struct xattr_handler *handler;
145 size_t preflen;
146
147 if (!(inode->i_opflags & IOP_XATTR)) {
148 if (unlikely(is_bad_inode(inode)))
149 return -EIO;
150 return -EOPNOTSUPP;
151 }
152
153 preflen = strlen(prefix);
154
155 for_each_xattr_handler(handlers, handler) {
156 if (!strncmp(xattr_prefix(handler), prefix, preflen))
157 return 0;
158 }
159
160 return -EOPNOTSUPP;
161}
162EXPORT_SYMBOL(xattr_supported_namespace);
163
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200164int
165__vfs_setxattr(struct dentry *dentry, struct inode *inode, const char *name,
166 const void *value, size_t size, int flags)
167{
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200168 const struct xattr_handler *handler;
169
170 handler = xattr_resolve_name(inode, &name);
171 if (IS_ERR(handler))
172 return PTR_ERR(handler);
173 if (!handler->set)
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200174 return -EOPNOTSUPP;
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200175 if (size == 0)
176 value = ""; /* empty EA, do not remove */
177 return handler->set(handler, dentry, inode, name, value, size, flags);
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200178}
179EXPORT_SYMBOL(__vfs_setxattr);
180
David P. Quigleyb1ab7e42009-09-03 14:25:56 -0400181/**
182 * __vfs_setxattr_noperm - perform setxattr operation without performing
183 * permission checks.
184 *
185 * @dentry - object to perform setxattr on
186 * @name - xattr name to set
187 * @value - value to set @name to
188 * @size - size of @value
189 * @flags - flags to pass into filesystem operations
190 *
191 * returns the result of the internal setxattr or setsecurity operations.
192 *
193 * This function requires the caller to lock the inode's i_mutex before it
194 * is executed. It also assumes that the caller will make the appropriate
195 * permission checks.
196 */
197int __vfs_setxattr_noperm(struct dentry *dentry, const char *name,
198 const void *value, size_t size, int flags)
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800199{
200 struct inode *inode = dentry->d_inode;
Andreas Gruenbacher4a590152016-11-13 21:23:34 +0100201 int error = -EAGAIN;
Andi Kleen69b45732011-05-28 08:25:51 -0700202 int issec = !strncmp(name, XATTR_SECURITY_PREFIX,
203 XATTR_SECURITY_PREFIX_LEN);
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800204
Andi Kleen69b45732011-05-28 08:25:51 -0700205 if (issec)
206 inode->i_flags &= ~S_NOSEC;
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200207 if (inode->i_opflags & IOP_XATTR) {
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200208 error = __vfs_setxattr(dentry, inode, name, value, size, flags);
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800209 if (!error) {
210 fsnotify_xattr(dentry);
211 security_inode_post_setxattr(dentry, name, value,
212 size, flags);
213 }
Andreas Gruenbacher4a590152016-11-13 21:23:34 +0100214 } else {
Andreas Gruenbacher5f6e59a2016-09-29 17:48:40 +0200215 if (unlikely(is_bad_inode(inode)))
216 return -EIO;
Andreas Gruenbacher4a590152016-11-13 21:23:34 +0100217 }
218 if (error == -EAGAIN) {
219 error = -EOPNOTSUPP;
220
221 if (issec) {
222 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
223
224 error = security_inode_setsecurity(inode, suffix, value,
225 size, flags);
226 if (!error)
227 fsnotify_xattr(dentry);
228 }
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800229 }
David P. Quigleyb1ab7e42009-09-03 14:25:56 -0400230
231 return error;
232}
233
Frank van der Linden08b5d502020-06-23 22:39:18 +0000234/**
235 * __vfs_setxattr_locked: set an extended attribute while holding the inode
236 * lock
237 *
238 * @dentry - object to perform setxattr on
239 * @name - xattr name to set
240 * @value - value to set @name to
241 * @size - size of @value
242 * @flags - flags to pass into filesystem operations
243 * @delegated_inode - on return, will contain an inode pointer that
244 * a delegation was broken on, NULL if none.
245 */
David P. Quigleyb1ab7e42009-09-03 14:25:56 -0400246int
Frank van der Linden08b5d502020-06-23 22:39:18 +0000247__vfs_setxattr_locked(struct dentry *dentry, const char *name,
248 const void *value, size_t size, int flags,
249 struct inode **delegated_inode)
David P. Quigleyb1ab7e42009-09-03 14:25:56 -0400250{
251 struct inode *inode = dentry->d_inode;
252 int error;
253
254 error = xattr_permission(inode, name, MAY_WRITE);
255 if (error)
256 return error;
257
David P. Quigleyb1ab7e42009-09-03 14:25:56 -0400258 error = security_inode_setxattr(dentry, name, value, size, flags);
259 if (error)
260 goto out;
261
Frank van der Linden08b5d502020-06-23 22:39:18 +0000262 error = try_break_deleg(inode, delegated_inode);
263 if (error)
264 goto out;
265
David P. Quigleyb1ab7e42009-09-03 14:25:56 -0400266 error = __vfs_setxattr_noperm(dentry, name, value, size, flags);
267
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800268out:
Frank van der Linden08b5d502020-06-23 22:39:18 +0000269 return error;
270}
271EXPORT_SYMBOL_GPL(__vfs_setxattr_locked);
272
273int
274vfs_setxattr(struct dentry *dentry, const char *name, const void *value,
275 size_t size, int flags)
276{
277 struct inode *inode = dentry->d_inode;
278 struct inode *delegated_inode = NULL;
279 int error;
280
281retry_deleg:
282 inode_lock(inode);
283 error = __vfs_setxattr_locked(dentry, name, value, size, flags,
284 &delegated_inode);
Al Viro59551022016-01-22 15:40:57 -0500285 inode_unlock(inode);
Frank van der Linden08b5d502020-06-23 22:39:18 +0000286
287 if (delegated_inode) {
288 error = break_deleg_wait(&delegated_inode);
289 if (!error)
290 goto retry_deleg;
291 }
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800292 return error;
293}
294EXPORT_SYMBOL_GPL(vfs_setxattr);
295
Al Viro2220c5b2018-04-24 21:22:04 -0400296static ssize_t
David P. Quigley42492592008-02-04 22:29:39 -0800297xattr_getsecurity(struct inode *inode, const char *name, void *value,
298 size_t size)
299{
300 void *buffer = NULL;
301 ssize_t len;
302
303 if (!value || !size) {
304 len = security_inode_getsecurity(inode, name, &buffer, false);
305 goto out_noalloc;
306 }
307
308 len = security_inode_getsecurity(inode, name, &buffer, true);
309 if (len < 0)
310 return len;
311 if (size < len) {
312 len = -ERANGE;
313 goto out;
314 }
315 memcpy(value, buffer, len);
316out:
Casey Schaufler57e7ba02017-09-19 09:39:08 -0700317 kfree(buffer);
David P. Quigley42492592008-02-04 22:29:39 -0800318out_noalloc:
319 return len;
320}
David P. Quigley42492592008-02-04 22:29:39 -0800321
Mimi Zohar1601fba2011-03-09 14:23:34 -0500322/*
323 * vfs_getxattr_alloc - allocate memory, if necessary, before calling getxattr
324 *
325 * Allocate memory, if not already allocated, or re-allocate correct size,
326 * before retrieving the extended attribute.
327 *
328 * Returns the result of alloc, if failed, or the getxattr operation.
329 */
330ssize_t
331vfs_getxattr_alloc(struct dentry *dentry, const char *name, char **xattr_value,
332 size_t xattr_size, gfp_t flags)
333{
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200334 const struct xattr_handler *handler;
Mimi Zohar1601fba2011-03-09 14:23:34 -0500335 struct inode *inode = dentry->d_inode;
336 char *value = *xattr_value;
337 int error;
338
339 error = xattr_permission(inode, name, MAY_READ);
340 if (error)
341 return error;
342
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200343 handler = xattr_resolve_name(inode, &name);
344 if (IS_ERR(handler))
345 return PTR_ERR(handler);
346 if (!handler->get)
Mimi Zohar1601fba2011-03-09 14:23:34 -0500347 return -EOPNOTSUPP;
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200348 error = handler->get(handler, dentry, inode, name, NULL, 0);
Mimi Zohar1601fba2011-03-09 14:23:34 -0500349 if (error < 0)
350 return error;
351
352 if (!value || (error > xattr_size)) {
353 value = krealloc(*xattr_value, error + 1, flags);
354 if (!value)
355 return -ENOMEM;
356 memset(value, 0, error + 1);
357 }
358
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200359 error = handler->get(handler, dentry, inode, name, value, error);
Mimi Zohar1601fba2011-03-09 14:23:34 -0500360 *xattr_value = value;
361 return error;
362}
363
David P. Quigley42492592008-02-04 22:29:39 -0800364ssize_t
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200365__vfs_getxattr(struct dentry *dentry, struct inode *inode, const char *name,
366 void *value, size_t size)
367{
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200368 const struct xattr_handler *handler;
369
370 handler = xattr_resolve_name(inode, &name);
371 if (IS_ERR(handler))
372 return PTR_ERR(handler);
373 if (!handler->get)
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200374 return -EOPNOTSUPP;
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200375 return handler->get(handler, dentry, inode, name, value, size);
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200376}
377EXPORT_SYMBOL(__vfs_getxattr);
378
379ssize_t
David Howells8f0cfa52008-04-29 00:59:41 -0700380vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800381{
382 struct inode *inode = dentry->d_inode;
383 int error;
384
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800385 error = xattr_permission(inode, name, MAY_READ);
386 if (error)
387 return error;
388
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800389 error = security_inode_getxattr(dentry, name);
390 if (error)
391 return error;
392
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800393 if (!strncmp(name, XATTR_SECURITY_PREFIX,
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800394 XATTR_SECURITY_PREFIX_LEN)) {
395 const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
David P. Quigley42492592008-02-04 22:29:39 -0800396 int ret = xattr_getsecurity(inode, suffix, value, size);
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800397 /*
398 * Only overwrite the return value if a security module
399 * is actually active.
400 */
David P. Quigley4bea5802008-02-04 22:29:40 -0800401 if (ret == -EOPNOTSUPP)
402 goto nolsm;
403 return ret;
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800404 }
David P. Quigley4bea5802008-02-04 22:29:40 -0800405nolsm:
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200406 return __vfs_getxattr(dentry, inode, name, value, size);
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800407}
408EXPORT_SYMBOL_GPL(vfs_getxattr);
409
Bill Nottingham659564c2006-10-09 16:10:48 -0400410ssize_t
Andreas Gruenbacherbf3ee712016-09-29 17:48:43 +0200411vfs_listxattr(struct dentry *dentry, char *list, size_t size)
Bill Nottingham659564c2006-10-09 16:10:48 -0400412{
Andreas Gruenbacherbf3ee712016-09-29 17:48:43 +0200413 struct inode *inode = d_inode(dentry);
Bill Nottingham659564c2006-10-09 16:10:48 -0400414 ssize_t error;
415
Andreas Gruenbacherbf3ee712016-09-29 17:48:43 +0200416 error = security_inode_listxattr(dentry);
Bill Nottingham659564c2006-10-09 16:10:48 -0400417 if (error)
418 return error;
Andreas Gruenbacherbf3ee712016-09-29 17:48:43 +0200419 if (inode->i_op->listxattr && (inode->i_opflags & IOP_XATTR)) {
Andreas Gruenbacherbf3ee712016-09-29 17:48:43 +0200420 error = inode->i_op->listxattr(dentry, list, size);
Bill Nottingham659564c2006-10-09 16:10:48 -0400421 } else {
Andreas Gruenbacherbf3ee712016-09-29 17:48:43 +0200422 error = security_inode_listsecurity(inode, list, size);
Bill Nottingham659564c2006-10-09 16:10:48 -0400423 if (size && error > size)
424 error = -ERANGE;
425 }
426 return error;
427}
428EXPORT_SYMBOL_GPL(vfs_listxattr);
429
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800430int
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200431__vfs_removexattr(struct dentry *dentry, const char *name)
432{
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200433 struct inode *inode = d_inode(dentry);
434 const struct xattr_handler *handler;
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200435
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200436 handler = xattr_resolve_name(inode, &name);
437 if (IS_ERR(handler))
438 return PTR_ERR(handler);
439 if (!handler->set)
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200440 return -EOPNOTSUPP;
Andreas Gruenbacher6c6ef9f2016-09-29 17:48:44 +0200441 return handler->set(handler, dentry, inode, name, NULL, 0, XATTR_REPLACE);
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200442}
443EXPORT_SYMBOL(__vfs_removexattr);
444
Frank van der Linden08b5d502020-06-23 22:39:18 +0000445/**
446 * __vfs_removexattr_locked: set an extended attribute while holding the inode
447 * lock
448 *
449 * @dentry - object to perform setxattr on
450 * @name - name of xattr to remove
451 * @delegated_inode - on return, will contain an inode pointer that
452 * a delegation was broken on, NULL if none.
453 */
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200454int
Frank van der Linden08b5d502020-06-23 22:39:18 +0000455__vfs_removexattr_locked(struct dentry *dentry, const char *name,
456 struct inode **delegated_inode)
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800457{
458 struct inode *inode = dentry->d_inode;
459 int error;
460
akpm@osdl.orge0ad7b02006-01-09 20:51:56 -0800461 error = xattr_permission(inode, name, MAY_WRITE);
462 if (error)
463 return error;
464
Mimi Zohar2ab51f32011-03-23 17:23:06 -0400465 error = security_inode_removexattr(dentry, name);
Dmitry Kasatkin7c51bb002014-11-20 16:31:01 +0200466 if (error)
467 goto out;
Mimi Zohar2ab51f32011-03-23 17:23:06 -0400468
Frank van der Linden08b5d502020-06-23 22:39:18 +0000469 error = try_break_deleg(inode, delegated_inode);
470 if (error)
471 goto out;
472
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200473 error = __vfs_removexattr(dentry, name);
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800474
Mimi Zoharc7b87de2011-03-09 14:39:18 -0500475 if (!error) {
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800476 fsnotify_xattr(dentry);
Mimi Zoharc7b87de2011-03-09 14:39:18 -0500477 evm_inode_post_removexattr(dentry, name);
478 }
Dmitry Kasatkin7c51bb002014-11-20 16:31:01 +0200479
480out:
Frank van der Linden08b5d502020-06-23 22:39:18 +0000481 return error;
482}
483EXPORT_SYMBOL_GPL(__vfs_removexattr_locked);
484
485int
486vfs_removexattr(struct dentry *dentry, const char *name)
487{
488 struct inode *inode = dentry->d_inode;
489 struct inode *delegated_inode = NULL;
490 int error;
491
492retry_deleg:
493 inode_lock(inode);
494 error = __vfs_removexattr_locked(dentry, name, &delegated_inode);
Al Viro59551022016-01-22 15:40:57 -0500495 inode_unlock(inode);
Frank van der Linden08b5d502020-06-23 22:39:18 +0000496
497 if (delegated_inode) {
498 error = break_deleg_wait(&delegated_inode);
499 if (!error)
500 goto retry_deleg;
501 }
502
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800503 return error;
504}
505EXPORT_SYMBOL_GPL(vfs_removexattr);
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507/*
508 * Extended attribute SET operations
509 */
510static long
David Howells8f0cfa52008-04-29 00:59:41 -0700511setxattr(struct dentry *d, const char __user *name, const void __user *value,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 size_t size, int flags)
513{
514 int error;
515 void *kvalue = NULL;
516 char kname[XATTR_NAME_MAX + 1];
517
518 if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
519 return -EINVAL;
520
521 error = strncpy_from_user(kname, name, sizeof(kname));
522 if (error == 0 || error == sizeof(kname))
523 error = -ERANGE;
524 if (error < 0)
525 return error;
526
527 if (size) {
528 if (size > XATTR_SIZE_MAX)
529 return -E2BIG;
Michal Hocko752ade62017-05-08 15:57:27 -0700530 kvalue = kvmalloc(size, GFP_KERNEL);
531 if (!kvalue)
532 return -ENOMEM;
Andrew Morton44c82492012-04-05 14:25:07 -0700533 if (copy_from_user(kvalue, value, size)) {
534 error = -EFAULT;
535 goto out;
536 }
Eric W. Biederman2f6f0652012-02-07 18:52:57 -0800537 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
538 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
539 posix_acl_fix_xattr_from_user(kvalue, size);
Serge E. Hallyn8db6c342017-05-08 13:11:56 -0500540 else if (strcmp(kname, XATTR_NAME_CAPS) == 0) {
541 error = cap_convert_nscap(d, &kvalue, size);
542 if (error < 0)
543 goto out;
544 size = error;
545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 }
547
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800548 error = vfs_setxattr(d, kname, kvalue, size, flags);
Andrew Morton44c82492012-04-05 14:25:07 -0700549out:
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100550 kvfree(kvalue);
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 return error;
553}
554
Eric Biggers8cc43112014-10-12 11:59:58 -0500555static int path_setxattr(const char __user *pathname,
556 const char __user *name, const void __user *value,
557 size_t size, int flags, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Al Viro2d8f3032008-07-22 09:59:21 -0400559 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 int error;
Jeff Layton68f1bb82012-12-11 12:10:15 -0500561retry:
562 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 if (error)
564 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400565 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800566 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400567 error = setxattr(path.dentry, name, value, size, flags);
568 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800569 }
Al Viro2d8f3032008-07-22 09:59:21 -0400570 path_put(&path);
Jeff Layton68f1bb82012-12-11 12:10:15 -0500571 if (retry_estale(error, lookup_flags)) {
572 lookup_flags |= LOOKUP_REVAL;
573 goto retry;
574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 return error;
576}
577
Eric Biggers8cc43112014-10-12 11:59:58 -0500578SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
579 const char __user *, name, const void __user *, value,
580 size_t, size, int, flags)
581{
582 return path_setxattr(pathname, name, value, size, flags, LOOKUP_FOLLOW);
583}
584
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100585SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
586 const char __user *, name, const void __user *, value,
587 size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
Eric Biggers8cc43112014-10-12 11:59:58 -0500589 return path_setxattr(pathname, name, value, size, flags, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100592SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
593 const void __user *,value, size_t, size, int, flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
Al Viro2903ff02012-08-28 12:52:22 -0400595 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 int error = -EBADF;
597
Al Viro2903ff02012-08-28 12:52:22 -0400598 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400600 audit_file(f.file);
Miklos Szeredi6742cee2018-07-18 15:44:43 +0200601 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800602 if (!error) {
Al Viro9f45f5b2014-10-31 17:44:57 -0400603 error = setxattr(f.file->f_path.dentry, name, value, size, flags);
Miklos Szeredi6742cee2018-07-18 15:44:43 +0200604 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800605 }
Al Viro2903ff02012-08-28 12:52:22 -0400606 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 return error;
608}
609
610/*
611 * Extended attribute GET operations
612 */
613static ssize_t
David Howells8f0cfa52008-04-29 00:59:41 -0700614getxattr(struct dentry *d, const char __user *name, void __user *value,
615 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616{
617 ssize_t error;
618 void *kvalue = NULL;
619 char kname[XATTR_NAME_MAX + 1];
620
621 error = strncpy_from_user(kname, name, sizeof(kname));
622 if (error == 0 || error == sizeof(kname))
623 error = -ERANGE;
624 if (error < 0)
625 return error;
626
627 if (size) {
628 if (size > XATTR_SIZE_MAX)
629 size = XATTR_SIZE_MAX;
Michal Hocko752ade62017-05-08 15:57:27 -0700630 kvalue = kvzalloc(size, GFP_KERNEL);
631 if (!kvalue)
632 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 }
634
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800635 error = vfs_getxattr(d, kname, kvalue, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700636 if (error > 0) {
Eric W. Biederman2f6f0652012-02-07 18:52:57 -0800637 if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
638 (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
Christian Brauner82c9a922018-06-07 13:43:48 +0200639 posix_acl_fix_xattr_to_user(kvalue, error);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700640 if (size && copy_to_user(value, kvalue, error))
641 error = -EFAULT;
642 } else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
643 /* The file system tried to returned a value bigger
644 than XATTR_SIZE_MAX bytes. Not possible. */
645 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 }
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100647
648 kvfree(kvalue);
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 return error;
651}
652
Eric Biggers8cc43112014-10-12 11:59:58 -0500653static ssize_t path_getxattr(const char __user *pathname,
654 const char __user *name, void __user *value,
655 size_t size, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656{
Al Viro2d8f3032008-07-22 09:59:21 -0400657 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 ssize_t error;
Jeff Layton60e66b42012-12-11 12:10:16 -0500659retry:
660 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 if (error)
662 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400663 error = getxattr(path.dentry, name, value, size);
664 path_put(&path);
Jeff Layton60e66b42012-12-11 12:10:16 -0500665 if (retry_estale(error, lookup_flags)) {
666 lookup_flags |= LOOKUP_REVAL;
667 goto retry;
668 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 return error;
670}
671
Eric Biggers8cc43112014-10-12 11:59:58 -0500672SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
673 const char __user *, name, void __user *, value, size_t, size)
674{
675 return path_getxattr(pathname, name, value, size, LOOKUP_FOLLOW);
676}
677
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100678SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
679 const char __user *, name, void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680{
Eric Biggers8cc43112014-10-12 11:59:58 -0500681 return path_getxattr(pathname, name, value, size, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682}
683
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100684SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
685 void __user *, value, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686{
Al Viro2903ff02012-08-28 12:52:22 -0400687 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 ssize_t error = -EBADF;
689
Al Viro2903ff02012-08-28 12:52:22 -0400690 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400692 audit_file(f.file);
Al Viro2903ff02012-08-28 12:52:22 -0400693 error = getxattr(f.file->f_path.dentry, name, value, size);
694 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 return error;
696}
697
698/*
699 * Extended attribute LIST operations
700 */
701static ssize_t
702listxattr(struct dentry *d, char __user *list, size_t size)
703{
704 ssize_t error;
705 char *klist = NULL;
706
707 if (size) {
708 if (size > XATTR_LIST_MAX)
709 size = XATTR_LIST_MAX;
Michal Hocko752ade62017-05-08 15:57:27 -0700710 klist = kvmalloc(size, GFP_KERNEL);
711 if (!klist)
712 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 }
714
Bill Nottingham659564c2006-10-09 16:10:48 -0400715 error = vfs_listxattr(d, klist, size);
Stephen Smalleyf549d6c2005-09-03 15:55:18 -0700716 if (error > 0) {
717 if (size && copy_to_user(list, klist, error))
718 error = -EFAULT;
719 } else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
720 /* The file system tried to returned a list bigger
721 than XATTR_LIST_MAX bytes. Not possible. */
722 error = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
Richard Weinberger0b2a6f22016-01-02 23:09:47 +0100724
725 kvfree(klist);
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 return error;
728}
729
Eric Biggers8cc43112014-10-12 11:59:58 -0500730static ssize_t path_listxattr(const char __user *pathname, char __user *list,
731 size_t size, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732{
Al Viro2d8f3032008-07-22 09:59:21 -0400733 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 ssize_t error;
Jeff Layton10a90cf2012-12-11 12:10:16 -0500735retry:
736 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (error)
738 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400739 error = listxattr(path.dentry, list, size);
740 path_put(&path);
Jeff Layton10a90cf2012-12-11 12:10:16 -0500741 if (retry_estale(error, lookup_flags)) {
742 lookup_flags |= LOOKUP_REVAL;
743 goto retry;
744 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 return error;
746}
747
Eric Biggers8cc43112014-10-12 11:59:58 -0500748SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
749 size_t, size)
750{
751 return path_listxattr(pathname, list, size, LOOKUP_FOLLOW);
752}
753
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100754SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
755 size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
Eric Biggers8cc43112014-10-12 11:59:58 -0500757 return path_listxattr(pathname, list, size, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758}
759
Heiko Carstens64fd1de2009-01-14 14:14:14 +0100760SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
Al Viro2903ff02012-08-28 12:52:22 -0400762 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 ssize_t error = -EBADF;
764
Al Viro2903ff02012-08-28 12:52:22 -0400765 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400767 audit_file(f.file);
Al Viro2903ff02012-08-28 12:52:22 -0400768 error = listxattr(f.file->f_path.dentry, list, size);
769 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 return error;
771}
772
773/*
774 * Extended attribute REMOVE operations
775 */
776static long
David Howells8f0cfa52008-04-29 00:59:41 -0700777removexattr(struct dentry *d, const char __user *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778{
779 int error;
780 char kname[XATTR_NAME_MAX + 1];
781
782 error = strncpy_from_user(kname, name, sizeof(kname));
783 if (error == 0 || error == sizeof(kname))
784 error = -ERANGE;
785 if (error < 0)
786 return error;
787
Christoph Hellwig5be196e2006-01-09 20:51:55 -0800788 return vfs_removexattr(d, kname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789}
790
Eric Biggers8cc43112014-10-12 11:59:58 -0500791static int path_removexattr(const char __user *pathname,
792 const char __user *name, unsigned int lookup_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
Al Viro2d8f3032008-07-22 09:59:21 -0400794 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 int error;
Jeff Layton12f06212012-12-11 12:10:17 -0500796retry:
797 error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 if (error)
799 return error;
Al Viro2d8f3032008-07-22 09:59:21 -0400800 error = mnt_want_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800801 if (!error) {
Al Viro2d8f3032008-07-22 09:59:21 -0400802 error = removexattr(path.dentry, name);
803 mnt_drop_write(path.mnt);
Dave Hansen18f335a2008-02-15 14:37:38 -0800804 }
Al Viro2d8f3032008-07-22 09:59:21 -0400805 path_put(&path);
Jeff Layton12f06212012-12-11 12:10:17 -0500806 if (retry_estale(error, lookup_flags)) {
807 lookup_flags |= LOOKUP_REVAL;
808 goto retry;
809 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 return error;
811}
812
Eric Biggers8cc43112014-10-12 11:59:58 -0500813SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
814 const char __user *, name)
815{
816 return path_removexattr(pathname, name, LOOKUP_FOLLOW);
817}
818
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100819SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
820 const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821{
Eric Biggers8cc43112014-10-12 11:59:58 -0500822 return path_removexattr(pathname, name, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823}
824
Heiko Carstens6a6160a2009-01-14 14:14:15 +0100825SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Al Viro2903ff02012-08-28 12:52:22 -0400827 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 int error = -EBADF;
829
Al Viro2903ff02012-08-28 12:52:22 -0400830 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 return error;
Al Viro9f45f5b2014-10-31 17:44:57 -0400832 audit_file(f.file);
Miklos Szeredi6742cee2018-07-18 15:44:43 +0200833 error = mnt_want_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800834 if (!error) {
Al Viro9f45f5b2014-10-31 17:44:57 -0400835 error = removexattr(f.file->f_path.dentry, name);
Miklos Szeredi6742cee2018-07-18 15:44:43 +0200836 mnt_drop_write_file(f.file);
Dave Hansen18f335a2008-02-15 14:37:38 -0800837 }
Al Viro2903ff02012-08-28 12:52:22 -0400838 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 return error;
840}
841
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 * Combine the results of the list() operation from every xattr_handler in the
844 * list.
845 */
846ssize_t
847generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
848{
Stephen Hemmingerbb435452010-05-13 17:53:14 -0700849 const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 unsigned int size = 0;
851
852 if (!buffer) {
Christoph Hellwig431547b2009-11-13 09:52:56 +0000853 for_each_xattr_handler(handlers, handler) {
Andreas Gruenbacher764a5c62015-12-02 14:44:43 +0100854 if (!handler->name ||
855 (handler->list && !handler->list(dentry)))
Andreas Gruenbacherc4803c42015-12-02 14:44:41 +0100856 continue;
Andreas Gruenbacher764a5c62015-12-02 14:44:43 +0100857 size += strlen(handler->name) + 1;
Christoph Hellwig431547b2009-11-13 09:52:56 +0000858 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 } else {
860 char *buf = buffer;
Andreas Gruenbacher764a5c62015-12-02 14:44:43 +0100861 size_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
863 for_each_xattr_handler(handlers, handler) {
Andreas Gruenbacher764a5c62015-12-02 14:44:43 +0100864 if (!handler->name ||
865 (handler->list && !handler->list(dentry)))
Andreas Gruenbacherc4803c42015-12-02 14:44:41 +0100866 continue;
Andreas Gruenbacher764a5c62015-12-02 14:44:43 +0100867 len = strlen(handler->name);
868 if (len + 1 > buffer_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 return -ERANGE;
Andreas Gruenbacher764a5c62015-12-02 14:44:43 +0100870 memcpy(buf, handler->name, len + 1);
871 buf += len + 1;
872 buffer_size -= len + 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 }
874 size = buf - buffer;
875 }
876 return size;
877}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878EXPORT_SYMBOL(generic_listxattr);
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400879
Andreas Gruenbachere409de92015-10-04 19:18:52 +0200880/**
881 * xattr_full_name - Compute full attribute name from suffix
882 *
883 * @handler: handler of the xattr_handler operation
884 * @name: name passed to the xattr_handler operation
885 *
886 * The get and set xattr handler operations are called with the remainder of
887 * the attribute name after skipping the handler's prefix: for example, "foo"
888 * is passed to the get operation of a handler with prefix "user." to get
889 * attribute "user.foo". The full name is still "there" in the name though.
890 *
891 * Note: the list xattr handler operation when called from the vfs is passed a
892 * NULL name; some file systems use this operation internally, with varying
893 * semantics.
894 */
895const char *xattr_full_name(const struct xattr_handler *handler,
896 const char *name)
897{
Andreas Gruenbacher98e9cb52015-12-02 14:44:36 +0100898 size_t prefix_len = strlen(xattr_prefix(handler));
Andreas Gruenbachere409de92015-10-04 19:18:52 +0200899
900 return name - prefix_len;
901}
902EXPORT_SYMBOL(xattr_full_name);
903
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400904/*
905 * Allocate new xattr and copy in the value; but leave the name to callers.
906 */
907struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
908{
909 struct simple_xattr *new_xattr;
910 size_t len;
911
912 /* wrap around? */
913 len = sizeof(*new_xattr) + size;
Hugh Dickins4e66d442014-07-23 14:00:17 -0700914 if (len < sizeof(*new_xattr))
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400915 return NULL;
916
Daniel Xufdc85222020-03-12 13:03:14 -0700917 new_xattr = kvmalloc(len, GFP_KERNEL);
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400918 if (!new_xattr)
919 return NULL;
920
921 new_xattr->size = size;
922 memcpy(new_xattr->value, value, size);
923 return new_xattr;
924}
925
926/*
927 * xattr GET operation for in-memory/pseudo filesystems
928 */
929int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
930 void *buffer, size_t size)
931{
932 struct simple_xattr *xattr;
933 int ret = -ENODATA;
934
935 spin_lock(&xattrs->lock);
936 list_for_each_entry(xattr, &xattrs->head, list) {
937 if (strcmp(name, xattr->name))
938 continue;
939
940 ret = xattr->size;
941 if (buffer) {
942 if (size < xattr->size)
943 ret = -ERANGE;
944 else
945 memcpy(buffer, xattr->value, xattr->size);
946 }
947 break;
948 }
949 spin_unlock(&xattrs->lock);
950 return ret;
951}
952
Andreas Gruenbacheraa7c5242015-12-02 14:44:38 +0100953/**
954 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
955 * @xattrs: target simple_xattr list
956 * @name: name of the extended attribute
957 * @value: value of the xattr. If %NULL, will remove the attribute.
958 * @size: size of the new xattr
959 * @flags: %XATTR_{CREATE|REPLACE}
Daniel Xua46a2292020-03-12 13:03:15 -0700960 * @removed_size: returns size of the removed xattr, -1 if none removed
Andreas Gruenbacheraa7c5242015-12-02 14:44:38 +0100961 *
962 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
963 * with -EEXIST. If %XATTR_REPLACE is set, the xattr should exist;
964 * otherwise, fails with -ENODATA.
965 *
966 * Returns 0 on success, -errno on failure.
967 */
968int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
Daniel Xua46a2292020-03-12 13:03:15 -0700969 const void *value, size_t size, int flags,
970 ssize_t *removed_size)
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400971{
972 struct simple_xattr *xattr;
David Rientjes43385842012-10-17 20:41:15 -0700973 struct simple_xattr *new_xattr = NULL;
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400974 int err = 0;
975
Daniel Xu772b3142020-04-08 23:27:29 -0700976 if (removed_size)
977 *removed_size = -1;
978
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400979 /* value == NULL means remove */
980 if (value) {
981 new_xattr = simple_xattr_alloc(value, size);
982 if (!new_xattr)
983 return -ENOMEM;
984
985 new_xattr->name = kstrdup(name, GFP_KERNEL);
986 if (!new_xattr->name) {
Daniel Xufdc85222020-03-12 13:03:14 -0700987 kvfree(new_xattr);
Aristeu Rozanski38f38652012-08-23 16:53:28 -0400988 return -ENOMEM;
989 }
990 }
991
992 spin_lock(&xattrs->lock);
993 list_for_each_entry(xattr, &xattrs->head, list) {
994 if (!strcmp(name, xattr->name)) {
995 if (flags & XATTR_CREATE) {
996 xattr = new_xattr;
997 err = -EEXIST;
998 } else if (new_xattr) {
999 list_replace(&xattr->list, &new_xattr->list);
Daniel Xua46a2292020-03-12 13:03:15 -07001000 if (removed_size)
1001 *removed_size = xattr->size;
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001002 } else {
1003 list_del(&xattr->list);
Daniel Xua46a2292020-03-12 13:03:15 -07001004 if (removed_size)
1005 *removed_size = xattr->size;
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001006 }
1007 goto out;
1008 }
1009 }
1010 if (flags & XATTR_REPLACE) {
1011 xattr = new_xattr;
1012 err = -ENODATA;
1013 } else {
1014 list_add(&new_xattr->list, &xattrs->head);
1015 xattr = NULL;
1016 }
1017out:
1018 spin_unlock(&xattrs->lock);
1019 if (xattr) {
1020 kfree(xattr->name);
Daniel Xufdc85222020-03-12 13:03:14 -07001021 kvfree(xattr);
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001022 }
1023 return err;
1024
1025}
1026
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001027static bool xattr_is_trusted(const char *name)
1028{
1029 return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
1030}
1031
Andreas Gruenbacher786534b2015-12-02 14:44:39 +01001032static int xattr_list_one(char **buffer, ssize_t *remaining_size,
1033 const char *name)
1034{
1035 size_t len = strlen(name) + 1;
1036 if (*buffer) {
1037 if (*remaining_size < len)
1038 return -ERANGE;
1039 memcpy(*buffer, name, len);
1040 *buffer += len;
1041 }
1042 *remaining_size -= len;
1043 return 0;
1044}
1045
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001046/*
1047 * xattr LIST operation for in-memory/pseudo filesystems
1048 */
Andreas Gruenbacher786534b2015-12-02 14:44:39 +01001049ssize_t simple_xattr_list(struct inode *inode, struct simple_xattrs *xattrs,
1050 char *buffer, size_t size)
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001051{
1052 bool trusted = capable(CAP_SYS_ADMIN);
1053 struct simple_xattr *xattr;
Andreas Gruenbacher786534b2015-12-02 14:44:39 +01001054 ssize_t remaining_size = size;
Mateusz Guzik0e9a7da2016-02-04 02:56:30 +01001055 int err = 0;
Andreas Gruenbacher786534b2015-12-02 14:44:39 +01001056
1057#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherffc4c922018-09-18 00:36:36 -04001058 if (IS_POSIXACL(inode)) {
1059 if (inode->i_acl) {
1060 err = xattr_list_one(&buffer, &remaining_size,
1061 XATTR_NAME_POSIX_ACL_ACCESS);
1062 if (err)
1063 return err;
1064 }
1065 if (inode->i_default_acl) {
1066 err = xattr_list_one(&buffer, &remaining_size,
1067 XATTR_NAME_POSIX_ACL_DEFAULT);
1068 if (err)
1069 return err;
1070 }
Andreas Gruenbacher786534b2015-12-02 14:44:39 +01001071 }
1072#endif
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001073
1074 spin_lock(&xattrs->lock);
1075 list_for_each_entry(xattr, &xattrs->head, list) {
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001076 /* skip "trusted." attributes for unprivileged callers */
1077 if (!trusted && xattr_is_trusted(xattr->name))
1078 continue;
1079
Andreas Gruenbacher786534b2015-12-02 14:44:39 +01001080 err = xattr_list_one(&buffer, &remaining_size, xattr->name);
1081 if (err)
Mateusz Guzik0e9a7da2016-02-04 02:56:30 +01001082 break;
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001083 }
1084 spin_unlock(&xattrs->lock);
1085
Mateusz Guzik0e9a7da2016-02-04 02:56:30 +01001086 return err ? err : size - remaining_size;
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001087}
1088
Aristeu Rozanski48957682012-09-11 16:28:11 -04001089/*
1090 * Adds an extended attribute to the list
1091 */
Aristeu Rozanski38f38652012-08-23 16:53:28 -04001092void simple_xattr_list_add(struct simple_xattrs *xattrs,
1093 struct simple_xattr *new_xattr)
1094{
1095 spin_lock(&xattrs->lock);
1096 list_add(&new_xattr->list, &xattrs->head);
1097 spin_unlock(&xattrs->lock);
1098}