xattr.c 23.1 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
  File: fs/xattr.c

  Extended attribute handling.

  Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org>
  Copyright (C) 2001 SGI - Silicon Graphics, Inc <linux-xfs@oss.sgi.com>
  Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com>
 */
#include <linux/fs.h>
#include <linux/slab.h>
#include <linux/file.h>
#include <linux/xattr.h>
14
#include <linux/mount.h>
L
Linus Torvalds 已提交
15 16
#include <linux/namei.h>
#include <linux/security.h>
M
Mimi Zohar 已提交
17
#include <linux/evm.h>
L
Linus Torvalds 已提交
18
#include <linux/syscalls.h>
19
#include <linux/export.h>
R
Robert Love 已提交
20
#include <linux/fsnotify.h>
21
#include <linux/audit.h>
22
#include <linux/vmalloc.h>
23
#include <linux/posix_acl_xattr.h>
L
Linus Torvalds 已提交
24

25
#include <asm/uaccess.h>
26

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
/*
 * Check permissions for extended attribute access.  This is a bit complicated
 * because different namespaces have very different rules.
 */
static int
xattr_permission(struct inode *inode, const char *name, int mask)
{
	/*
	 * We can never set or remove an extended attribute on a read-only
	 * filesystem  or on an immutable / append-only inode.
	 */
	if (mask & MAY_WRITE) {
		if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
			return -EPERM;
	}

	/*
	 * No restriction for security.* and system.* from the VFS.  Decision
	 * on these is left to the underlying filesystem / security module.
	 */
	if (!strncmp(name, XATTR_SECURITY_PREFIX, XATTR_SECURITY_PREFIX_LEN) ||
	    !strncmp(name, XATTR_SYSTEM_PREFIX, XATTR_SYSTEM_PREFIX_LEN))
		return 0;

	/*
52
	 * The trusted.* namespace can only be accessed by privileged users.
53
	 */
54 55 56 57 58
	if (!strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN)) {
		if (!capable(CAP_SYS_ADMIN))
			return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
		return 0;
	}
59

60 61
	/*
	 * In the user.* namespace, only regular files and directories can have
62
	 * extended attributes. For sticky directories, only the owner and
63
	 * privileged users can write attributes.
64
	 */
65
	if (!strncmp(name, XATTR_USER_PREFIX, XATTR_USER_PREFIX_LEN)) {
66
		if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
67
			return (mask & MAY_WRITE) ? -EPERM : -ENODATA;
68
		if (S_ISDIR(inode->i_mode) && (inode->i_mode & S_ISVTX) &&
69
		    (mask & MAY_WRITE) && !inode_owner_or_capable(inode))
70 71 72
			return -EPERM;
	}

73
	return inode_permission(inode, mask);
74 75
}

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
/**
 *  __vfs_setxattr_noperm - perform setxattr operation without performing
 *  permission checks.
 *
 *  @dentry - object to perform setxattr on
 *  @name - xattr name to set
 *  @value - value to set @name to
 *  @size - size of @value
 *  @flags - flags to pass into filesystem operations
 *
 *  returns the result of the internal setxattr or setsecurity operations.
 *
 *  This function requires the caller to lock the inode's i_mutex before it
 *  is executed. It also assumes that the caller will make the appropriate
 *  permission checks.
 */
int __vfs_setxattr_noperm(struct dentry *dentry, const char *name,
		const void *value, size_t size, int flags)
94 95
{
	struct inode *inode = dentry->d_inode;
96
	int error = -EOPNOTSUPP;
97 98
	int issec = !strncmp(name, XATTR_SECURITY_PREFIX,
				   XATTR_SECURITY_PREFIX_LEN);
99

100 101
	if (issec)
		inode->i_flags &= ~S_NOSEC;
102 103 104 105 106 107 108
	if (inode->i_op->setxattr) {
		error = inode->i_op->setxattr(dentry, name, value, size, flags);
		if (!error) {
			fsnotify_xattr(dentry);
			security_inode_post_setxattr(dentry, name, value,
						     size, flags);
		}
109
	} else if (issec) {
110
		const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
111 112 113 114 115
		error = security_inode_setsecurity(inode, suffix, value,
						   size, flags);
		if (!error)
			fsnotify_xattr(dentry);
	}
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138

	return error;
}


int
vfs_setxattr(struct dentry *dentry, const char *name, const void *value,
		size_t size, int flags)
{
	struct inode *inode = dentry->d_inode;
	int error;

	error = xattr_permission(inode, name, MAY_WRITE);
	if (error)
		return error;

	mutex_lock(&inode->i_mutex);
	error = security_inode_setxattr(dentry, name, value, size, flags);
	if (error)
		goto out;

	error = __vfs_setxattr_noperm(dentry, name, value, size, flags);

139 140 141 142 143 144
out:
	mutex_unlock(&inode->i_mutex);
	return error;
}
EXPORT_SYMBOL_GPL(vfs_setxattr);

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
ssize_t
xattr_getsecurity(struct inode *inode, const char *name, void *value,
			size_t size)
{
	void *buffer = NULL;
	ssize_t len;

	if (!value || !size) {
		len = security_inode_getsecurity(inode, name, &buffer, false);
		goto out_noalloc;
	}

	len = security_inode_getsecurity(inode, name, &buffer, true);
	if (len < 0)
		return len;
	if (size < len) {
		len = -ERANGE;
		goto out;
	}
	memcpy(value, buffer, len);
out:
	security_release_secctx(buffer, len);
out_noalloc:
	return len;
}
EXPORT_SYMBOL_GPL(xattr_getsecurity);

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
/*
 * vfs_getxattr_alloc - allocate memory, if necessary, before calling getxattr
 *
 * Allocate memory, if not already allocated, or re-allocate correct size,
 * before retrieving the extended attribute.
 *
 * Returns the result of alloc, if failed, or the getxattr operation.
 */
ssize_t
vfs_getxattr_alloc(struct dentry *dentry, const char *name, char **xattr_value,
		   size_t xattr_size, gfp_t flags)
{
	struct inode *inode = dentry->d_inode;
	char *value = *xattr_value;
	int error;

	error = xattr_permission(inode, name, MAY_READ);
	if (error)
		return error;

	if (!inode->i_op->getxattr)
		return -EOPNOTSUPP;

	error = inode->i_op->getxattr(dentry, name, NULL, 0);
	if (error < 0)
		return error;

	if (!value || (error > xattr_size)) {
		value = krealloc(*xattr_value, error + 1, flags);
		if (!value)
			return -ENOMEM;
		memset(value, 0, error + 1);
	}

	error = inode->i_op->getxattr(dentry, name, value, error);
	*xattr_value = value;
	return error;
}

211
ssize_t
212
vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
213 214 215 216
{
	struct inode *inode = dentry->d_inode;
	int error;

217 218 219 220
	error = xattr_permission(inode, name, MAY_READ);
	if (error)
		return error;

221 222 223 224 225
	error = security_inode_getxattr(dentry, name);
	if (error)
		return error;

	if (!strncmp(name, XATTR_SECURITY_PREFIX,
226 227
				XATTR_SECURITY_PREFIX_LEN)) {
		const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
228
		int ret = xattr_getsecurity(inode, suffix, value, size);
229 230 231 232
		/*
		 * Only overwrite the return value if a security module
		 * is actually active.
		 */
233 234 235
		if (ret == -EOPNOTSUPP)
			goto nolsm;
		return ret;
236
	}
237 238 239 240 241
nolsm:
	if (inode->i_op->getxattr)
		error = inode->i_op->getxattr(dentry, name, value, size);
	else
		error = -EOPNOTSUPP;
242 243 244 245 246

	return error;
}
EXPORT_SYMBOL_GPL(vfs_getxattr);

B
Bill Nottingham 已提交
247 248 249 250 251 252 253 254 255
ssize_t
vfs_listxattr(struct dentry *d, char *list, size_t size)
{
	ssize_t error;

	error = security_inode_listxattr(d);
	if (error)
		return error;
	error = -EOPNOTSUPP;
A
Al Viro 已提交
256
	if (d->d_inode->i_op->listxattr) {
B
Bill Nottingham 已提交
257 258 259 260 261 262 263 264 265 266
		error = d->d_inode->i_op->listxattr(d, list, size);
	} else {
		error = security_inode_listsecurity(d->d_inode, list, size);
		if (size && error > size)
			error = -ERANGE;
	}
	return error;
}
EXPORT_SYMBOL_GPL(vfs_listxattr);

267
int
268
vfs_removexattr(struct dentry *dentry, const char *name)
269 270 271 272 273 274 275
{
	struct inode *inode = dentry->d_inode;
	int error;

	if (!inode->i_op->removexattr)
		return -EOPNOTSUPP;

276 277 278 279
	error = xattr_permission(inode, name, MAY_WRITE);
	if (error)
		return error;

M
Mimi Zohar 已提交
280
	mutex_lock(&inode->i_mutex);
281
	error = security_inode_removexattr(dentry, name);
282 283
	if (error)
		goto out;
284 285 286

	error = inode->i_op->removexattr(dentry, name);

M
Mimi Zohar 已提交
287
	if (!error) {
288
		fsnotify_xattr(dentry);
M
Mimi Zohar 已提交
289 290
		evm_inode_post_removexattr(dentry, name);
	}
291 292 293

out:
	mutex_unlock(&inode->i_mutex);
294 295 296 297 298
	return error;
}
EXPORT_SYMBOL_GPL(vfs_removexattr);


L
Linus Torvalds 已提交
299 300 301 302
/*
 * Extended attribute SET operations
 */
static long
303
setxattr(struct dentry *d, const char __user *name, const void __user *value,
L
Linus Torvalds 已提交
304 305 306 307
	 size_t size, int flags)
{
	int error;
	void *kvalue = NULL;
308
	void *vvalue = NULL;	/* If non-NULL, we used vmalloc() */
L
Linus Torvalds 已提交
309 310 311 312 313 314 315 316 317 318 319 320 321 322
	char kname[XATTR_NAME_MAX + 1];

	if (flags & ~(XATTR_CREATE|XATTR_REPLACE))
		return -EINVAL;

	error = strncpy_from_user(kname, name, sizeof(kname));
	if (error == 0 || error == sizeof(kname))
		error = -ERANGE;
	if (error < 0)
		return error;

	if (size) {
		if (size > XATTR_SIZE_MAX)
			return -E2BIG;
323 324 325 326 327 328 329 330 331 332 333
		kvalue = kmalloc(size, GFP_KERNEL | __GFP_NOWARN);
		if (!kvalue) {
			vvalue = vmalloc(size);
			if (!vvalue)
				return -ENOMEM;
			kvalue = vvalue;
		}
		if (copy_from_user(kvalue, value, size)) {
			error = -EFAULT;
			goto out;
		}
334 335 336
		if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
		    (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
			posix_acl_fix_xattr_from_user(kvalue, size);
L
Linus Torvalds 已提交
337 338
	}

339
	error = vfs_setxattr(d, kname, kvalue, size, flags);
340 341 342 343 344
out:
	if (vvalue)
		vfree(vvalue);
	else
		kfree(kvalue);
L
Linus Torvalds 已提交
345 346 347
	return error;
}

348 349 350
static int path_setxattr(const char __user *pathname,
			 const char __user *name, const void __user *value,
			 size_t size, int flags, unsigned int lookup_flags)
L
Linus Torvalds 已提交
351
{
352
	struct path path;
L
Linus Torvalds 已提交
353
	int error;
354 355
retry:
	error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
L
Linus Torvalds 已提交
356 357
	if (error)
		return error;
358
	error = mnt_want_write(path.mnt);
359
	if (!error) {
360 361
		error = setxattr(path.dentry, name, value, size, flags);
		mnt_drop_write(path.mnt);
362
	}
363
	path_put(&path);
364 365 366 367
	if (retry_estale(error, lookup_flags)) {
		lookup_flags |= LOOKUP_REVAL;
		goto retry;
	}
L
Linus Torvalds 已提交
368 369 370
	return error;
}

371 372 373 374 375 376 377
SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
		const char __user *, name, const void __user *, value,
		size_t, size, int, flags)
{
	return path_setxattr(pathname, name, value, size, flags, LOOKUP_FOLLOW);
}

378 379 380
SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
		const char __user *, name, const void __user *, value,
		size_t, size, int, flags)
L
Linus Torvalds 已提交
381
{
382
	return path_setxattr(pathname, name, value, size, flags, 0);
L
Linus Torvalds 已提交
383 384
}

385 386
SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
		const void __user *,value, size_t, size, int, flags)
L
Linus Torvalds 已提交
387
{
388
	struct fd f = fdget(fd);
L
Linus Torvalds 已提交
389 390
	int error = -EBADF;

391
	if (!f.file)
L
Linus Torvalds 已提交
392
		return error;
A
Al Viro 已提交
393
	audit_file(f.file);
394
	error = mnt_want_write_file(f.file);
395
	if (!error) {
A
Al Viro 已提交
396
		error = setxattr(f.file->f_path.dentry, name, value, size, flags);
397
		mnt_drop_write_file(f.file);
398
	}
399
	fdput(f);
L
Linus Torvalds 已提交
400 401 402 403 404 405 406
	return error;
}

/*
 * Extended attribute GET operations
 */
static ssize_t
407 408
getxattr(struct dentry *d, const char __user *name, void __user *value,
	 size_t size)
L
Linus Torvalds 已提交
409 410 411
{
	ssize_t error;
	void *kvalue = NULL;
412
	void *vvalue = NULL;
L
Linus Torvalds 已提交
413 414 415 416 417 418 419 420 421 422 423
	char kname[XATTR_NAME_MAX + 1];

	error = strncpy_from_user(kname, name, sizeof(kname));
	if (error == 0 || error == sizeof(kname))
		error = -ERANGE;
	if (error < 0)
		return error;

	if (size) {
		if (size > XATTR_SIZE_MAX)
			size = XATTR_SIZE_MAX;
424 425 426 427 428 429 430
		kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
		if (!kvalue) {
			vvalue = vmalloc(size);
			if (!vvalue)
				return -ENOMEM;
			kvalue = vvalue;
		}
L
Linus Torvalds 已提交
431 432
	}

433
	error = vfs_getxattr(d, kname, kvalue, size);
434
	if (error > 0) {
435 436 437
		if ((strcmp(kname, XATTR_NAME_POSIX_ACL_ACCESS) == 0) ||
		    (strcmp(kname, XATTR_NAME_POSIX_ACL_DEFAULT) == 0))
			posix_acl_fix_xattr_to_user(kvalue, size);
438 439 440 441 442 443
		if (size && copy_to_user(value, kvalue, error))
			error = -EFAULT;
	} else if (error == -ERANGE && size >= XATTR_SIZE_MAX) {
		/* The file system tried to returned a value bigger
		   than XATTR_SIZE_MAX bytes. Not possible. */
		error = -E2BIG;
L
Linus Torvalds 已提交
444
	}
445 446 447 448
	if (vvalue)
		vfree(vvalue);
	else
		kfree(kvalue);
L
Linus Torvalds 已提交
449 450 451
	return error;
}

452 453 454
static ssize_t path_getxattr(const char __user *pathname,
			     const char __user *name, void __user *value,
			     size_t size, unsigned int lookup_flags)
L
Linus Torvalds 已提交
455
{
456
	struct path path;
L
Linus Torvalds 已提交
457
	ssize_t error;
458 459
retry:
	error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
L
Linus Torvalds 已提交
460 461
	if (error)
		return error;
462 463
	error = getxattr(path.dentry, name, value, size);
	path_put(&path);
464 465 466 467
	if (retry_estale(error, lookup_flags)) {
		lookup_flags |= LOOKUP_REVAL;
		goto retry;
	}
L
Linus Torvalds 已提交
468 469 470
	return error;
}

471 472 473 474 475 476
SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
		const char __user *, name, void __user *, value, size_t, size)
{
	return path_getxattr(pathname, name, value, size, LOOKUP_FOLLOW);
}

477 478
SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
		const char __user *, name, void __user *, value, size_t, size)
L
Linus Torvalds 已提交
479
{
480
	return path_getxattr(pathname, name, value, size, 0);
L
Linus Torvalds 已提交
481 482
}

483 484
SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
		void __user *, value, size_t, size)
L
Linus Torvalds 已提交
485
{
486
	struct fd f = fdget(fd);
L
Linus Torvalds 已提交
487 488
	ssize_t error = -EBADF;

489
	if (!f.file)
L
Linus Torvalds 已提交
490
		return error;
A
Al Viro 已提交
491
	audit_file(f.file);
492 493
	error = getxattr(f.file->f_path.dentry, name, value, size);
	fdput(f);
L
Linus Torvalds 已提交
494 495 496 497 498 499 500 501 502 503 504
	return error;
}

/*
 * Extended attribute LIST operations
 */
static ssize_t
listxattr(struct dentry *d, char __user *list, size_t size)
{
	ssize_t error;
	char *klist = NULL;
505
	char *vlist = NULL;	/* If non-NULL, we used vmalloc() */
L
Linus Torvalds 已提交
506 507 508 509

	if (size) {
		if (size > XATTR_LIST_MAX)
			size = XATTR_LIST_MAX;
510
		klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
511 512 513 514 515 516
		if (!klist) {
			vlist = vmalloc(size);
			if (!vlist)
				return -ENOMEM;
			klist = vlist;
		}
L
Linus Torvalds 已提交
517 518
	}

B
Bill Nottingham 已提交
519
	error = vfs_listxattr(d, klist, size);
520 521 522 523 524 525 526
	if (error > 0) {
		if (size && copy_to_user(list, klist, error))
			error = -EFAULT;
	} else if (error == -ERANGE && size >= XATTR_LIST_MAX) {
		/* The file system tried to returned a list bigger
		   than XATTR_LIST_MAX bytes. Not possible. */
		error = -E2BIG;
L
Linus Torvalds 已提交
527
	}
528 529 530 531
	if (vlist)
		vfree(vlist);
	else
		kfree(klist);
L
Linus Torvalds 已提交
532 533 534
	return error;
}

535 536
static ssize_t path_listxattr(const char __user *pathname, char __user *list,
			      size_t size, unsigned int lookup_flags)
L
Linus Torvalds 已提交
537
{
538
	struct path path;
L
Linus Torvalds 已提交
539
	ssize_t error;
540 541
retry:
	error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
L
Linus Torvalds 已提交
542 543
	if (error)
		return error;
544 545
	error = listxattr(path.dentry, list, size);
	path_put(&path);
546 547 548 549
	if (retry_estale(error, lookup_flags)) {
		lookup_flags |= LOOKUP_REVAL;
		goto retry;
	}
L
Linus Torvalds 已提交
550 551 552
	return error;
}

553 554 555 556 557 558
SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
		size_t, size)
{
	return path_listxattr(pathname, list, size, LOOKUP_FOLLOW);
}

559 560
SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
		size_t, size)
L
Linus Torvalds 已提交
561
{
562
	return path_listxattr(pathname, list, size, 0);
L
Linus Torvalds 已提交
563 564
}

565
SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
L
Linus Torvalds 已提交
566
{
567
	struct fd f = fdget(fd);
L
Linus Torvalds 已提交
568 569
	ssize_t error = -EBADF;

570
	if (!f.file)
L
Linus Torvalds 已提交
571
		return error;
A
Al Viro 已提交
572
	audit_file(f.file);
573 574
	error = listxattr(f.file->f_path.dentry, list, size);
	fdput(f);
L
Linus Torvalds 已提交
575 576 577 578 579 580 581
	return error;
}

/*
 * Extended attribute REMOVE operations
 */
static long
582
removexattr(struct dentry *d, const char __user *name)
L
Linus Torvalds 已提交
583 584 585 586 587 588 589 590 591 592
{
	int error;
	char kname[XATTR_NAME_MAX + 1];

	error = strncpy_from_user(kname, name, sizeof(kname));
	if (error == 0 || error == sizeof(kname))
		error = -ERANGE;
	if (error < 0)
		return error;

593
	return vfs_removexattr(d, kname);
L
Linus Torvalds 已提交
594 595
}

596 597
static int path_removexattr(const char __user *pathname,
			    const char __user *name, unsigned int lookup_flags)
L
Linus Torvalds 已提交
598
{
599
	struct path path;
L
Linus Torvalds 已提交
600
	int error;
601 602
retry:
	error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
L
Linus Torvalds 已提交
603 604
	if (error)
		return error;
605
	error = mnt_want_write(path.mnt);
606
	if (!error) {
607 608
		error = removexattr(path.dentry, name);
		mnt_drop_write(path.mnt);
609
	}
610
	path_put(&path);
611 612 613 614
	if (retry_estale(error, lookup_flags)) {
		lookup_flags |= LOOKUP_REVAL;
		goto retry;
	}
L
Linus Torvalds 已提交
615 616 617
	return error;
}

618 619 620 621 622 623
SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
		const char __user *, name)
{
	return path_removexattr(pathname, name, LOOKUP_FOLLOW);
}

624 625
SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
		const char __user *, name)
L
Linus Torvalds 已提交
626
{
627
	return path_removexattr(pathname, name, 0);
L
Linus Torvalds 已提交
628 629
}

630
SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
L
Linus Torvalds 已提交
631
{
632
	struct fd f = fdget(fd);
L
Linus Torvalds 已提交
633 634
	int error = -EBADF;

635
	if (!f.file)
L
Linus Torvalds 已提交
636
		return error;
A
Al Viro 已提交
637
	audit_file(f.file);
638
	error = mnt_want_write_file(f.file);
639
	if (!error) {
A
Al Viro 已提交
640
		error = removexattr(f.file->f_path.dentry, name);
641
		mnt_drop_write_file(f.file);
642
	}
643
	fdput(f);
L
Linus Torvalds 已提交
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
	return error;
}


static const char *
strcmp_prefix(const char *a, const char *a_prefix)
{
	while (*a_prefix && *a == *a_prefix) {
		a++;
		a_prefix++;
	}
	return *a_prefix ? NULL : a;
}

/*
 * In order to implement different sets of xattr operations for each xattr
 * prefix with the generic xattr API, a filesystem should create a
 * null-terminated array of struct xattr_handler (one for each prefix) and
 * hang a pointer to it off of the s_xattr field of the superblock.
 *
 * The generic_fooxattr() functions will use this list to dispatch xattr
 * operations to the correct xattr_handler.
 */
#define for_each_xattr_handler(handlers, handler)		\
		for ((handler) = *(handlers)++;			\
			(handler) != NULL;			\
			(handler) = *(handlers)++)

/*
 * Find the xattr_handler with the matching prefix.
 */
675 676
static const struct xattr_handler *
xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
L
Linus Torvalds 已提交
677
{
678
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698

	if (!*name)
		return NULL;

	for_each_xattr_handler(handlers, handler) {
		const char *n = strcmp_prefix(*name, handler->prefix);
		if (n) {
			*name = n;
			break;
		}
	}
	return handler;
}

/*
 * Find the handler for the prefix and dispatch its get() operation.
 */
ssize_t
generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size)
{
699
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
700

701
	handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
L
Linus Torvalds 已提交
702 703
	if (!handler)
		return -EOPNOTSUPP;
704
	return handler->get(handler, dentry, name, buffer, size);
L
Linus Torvalds 已提交
705 706 707 708 709 710 711 712 713
}

/*
 * Combine the results of the list() operation from every xattr_handler in the
 * list.
 */
ssize_t
generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
{
714
	const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
L
Linus Torvalds 已提交
715 716 717
	unsigned int size = 0;

	if (!buffer) {
718
		for_each_xattr_handler(handlers, handler) {
719 720
			size += handler->list(handler, dentry, NULL, 0,
					      NULL, 0);
721
		}
L
Linus Torvalds 已提交
722 723 724 725
	} else {
		char *buf = buffer;

		for_each_xattr_handler(handlers, handler) {
726 727
			size = handler->list(handler, dentry, buf, buffer_size,
					     NULL, 0);
L
Linus Torvalds 已提交
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
			if (size > buffer_size)
				return -ERANGE;
			buf += size;
			buffer_size -= size;
		}
		size = buf - buffer;
	}
	return size;
}

/*
 * Find the handler for the prefix and dispatch its set() operation.
 */
int
generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags)
{
744
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
745 746 747

	if (size == 0)
		value = "";  /* empty EA, do not remove */
748
	handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
L
Linus Torvalds 已提交
749 750
	if (!handler)
		return -EOPNOTSUPP;
751
	return handler->set(handler, dentry, name, value, size, flags);
L
Linus Torvalds 已提交
752 753 754 755 756 757 758 759 760
}

/*
 * Find the handler for the prefix and dispatch its set() operation to remove
 * any associated extended attribute.
 */
int
generic_removexattr(struct dentry *dentry, const char *name)
{
761
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
762

763
	handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
L
Linus Torvalds 已提交
764 765
	if (!handler)
		return -EOPNOTSUPP;
766
	return handler->set(handler, dentry, name, NULL, 0, XATTR_REPLACE);
L
Linus Torvalds 已提交
767 768 769 770 771 772
}

EXPORT_SYMBOL(generic_getxattr);
EXPORT_SYMBOL(generic_listxattr);
EXPORT_SYMBOL(generic_setxattr);
EXPORT_SYMBOL(generic_removexattr);
773

A
Andreas Gruenbacher 已提交
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
/**
 * xattr_full_name  -  Compute full attribute name from suffix
 *
 * @handler:	handler of the xattr_handler operation
 * @name:	name passed to the xattr_handler operation
 *
 * The get and set xattr handler operations are called with the remainder of
 * the attribute name after skipping the handler's prefix: for example, "foo"
 * is passed to the get operation of a handler with prefix "user." to get
 * attribute "user.foo".  The full name is still "there" in the name though.
 *
 * Note: the list xattr handler operation when called from the vfs is passed a
 * NULL name; some file systems use this operation internally, with varying
 * semantics.
 */
const char *xattr_full_name(const struct xattr_handler *handler,
			    const char *name)
{
	size_t prefix_len = strlen(handler->prefix);

	return name - prefix_len;
}
EXPORT_SYMBOL(xattr_full_name);

798 799 800 801 802 803 804 805 806 807
/*
 * Allocate new xattr and copy in the value; but leave the name to callers.
 */
struct simple_xattr *simple_xattr_alloc(const void *value, size_t size)
{
	struct simple_xattr *new_xattr;
	size_t len;

	/* wrap around? */
	len = sizeof(*new_xattr) + size;
808
	if (len < sizeof(*new_xattr))
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
		return NULL;

	new_xattr = kmalloc(len, GFP_KERNEL);
	if (!new_xattr)
		return NULL;

	new_xattr->size = size;
	memcpy(new_xattr->value, value, size);
	return new_xattr;
}

/*
 * xattr GET operation for in-memory/pseudo filesystems
 */
int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
		     void *buffer, size_t size)
{
	struct simple_xattr *xattr;
	int ret = -ENODATA;

	spin_lock(&xattrs->lock);
	list_for_each_entry(xattr, &xattrs->head, list) {
		if (strcmp(name, xattr->name))
			continue;

		ret = xattr->size;
		if (buffer) {
			if (size < xattr->size)
				ret = -ERANGE;
			else
				memcpy(buffer, xattr->value, xattr->size);
		}
		break;
	}
	spin_unlock(&xattrs->lock);
	return ret;
}

static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
			      const void *value, size_t size, int flags)
{
	struct simple_xattr *xattr;
851
	struct simple_xattr *new_xattr = NULL;
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
	int err = 0;

	/* value == NULL means remove */
	if (value) {
		new_xattr = simple_xattr_alloc(value, size);
		if (!new_xattr)
			return -ENOMEM;

		new_xattr->name = kstrdup(name, GFP_KERNEL);
		if (!new_xattr->name) {
			kfree(new_xattr);
			return -ENOMEM;
		}
	}

	spin_lock(&xattrs->lock);
	list_for_each_entry(xattr, &xattrs->head, list) {
		if (!strcmp(name, xattr->name)) {
			if (flags & XATTR_CREATE) {
				xattr = new_xattr;
				err = -EEXIST;
			} else if (new_xattr) {
				list_replace(&xattr->list, &new_xattr->list);
			} else {
				list_del(&xattr->list);
			}
			goto out;
		}
	}
	if (flags & XATTR_REPLACE) {
		xattr = new_xattr;
		err = -ENODATA;
	} else {
		list_add(&new_xattr->list, &xattrs->head);
		xattr = NULL;
	}
out:
	spin_unlock(&xattrs->lock);
	if (xattr) {
		kfree(xattr->name);
		kfree(xattr);
	}
	return err;

}

898 899 900 901 902 903 904 905 906 907 908 909 910
/**
 * simple_xattr_set - xattr SET operation for in-memory/pseudo filesystems
 * @xattrs: target simple_xattr list
 * @name: name of the new extended attribute
 * @value: value of the new xattr. If %NULL, will remove the attribute
 * @size: size of the new xattr
 * @flags: %XATTR_{CREATE|REPLACE}
 *
 * %XATTR_CREATE is set, the xattr shouldn't exist already; otherwise fails
 * with -EEXIST.  If %XATTR_REPLACE is set, the xattr should exist;
 * otherwise, fails with -ENODATA.
 *
 * Returns 0 on success, -errno on failure.
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
 */
int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
		     const void *value, size_t size, int flags)
{
	if (size == 0)
		value = ""; /* empty EA, do not remove */
	return __simple_xattr_set(xattrs, name, value, size, flags);
}

/*
 * xattr REMOVE operation for in-memory/pseudo filesystems
 */
int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
{
	return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
}

static bool xattr_is_trusted(const char *name)
{
	return !strncmp(name, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN);
}

/*
 * xattr LIST operation for in-memory/pseudo filesystems
 */
ssize_t simple_xattr_list(struct simple_xattrs *xattrs, char *buffer,
			  size_t size)
{
	bool trusted = capable(CAP_SYS_ADMIN);
	struct simple_xattr *xattr;
	size_t used = 0;

	spin_lock(&xattrs->lock);
	list_for_each_entry(xattr, &xattrs->head, list) {
		size_t len;

		/* skip "trusted." attributes for unprivileged callers */
		if (!trusted && xattr_is_trusted(xattr->name))
			continue;

		len = strlen(xattr->name) + 1;
		used += len;
		if (buffer) {
			if (size < used) {
				used = -ERANGE;
				break;
			}
			memcpy(buffer, xattr->name, len);
			buffer += len;
		}
	}
	spin_unlock(&xattrs->lock);

	return used;
}

967 968 969
/*
 * Adds an extended attribute to the list
 */
970 971 972 973 974 975 976
void simple_xattr_list_add(struct simple_xattrs *xattrs,
			   struct simple_xattr *new_xattr)
{
	spin_lock(&xattrs->lock);
	list_add(&new_xattr->list, &xattrs->head);
	spin_unlock(&xattrs->lock);
}