xattr.c 22.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>
L
Linus Torvalds 已提交
23

24
#include <asm/uaccess.h>
25

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
/*
 * 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;

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

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

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

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
/**
 *  __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)
93 94
{
	struct inode *inode = dentry->d_inode;
95
	int error = -EOPNOTSUPP;
96 97
	int issec = !strncmp(name, XATTR_SECURITY_PREFIX,
				   XATTR_SECURITY_PREFIX_LEN);
98

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

	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);

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

144 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
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);

171 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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
/*
 * 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;
}

/* Compare an extended attribute value with the given value */
int vfs_xattr_cmp(struct dentry *dentry, const char *xattr_name,
		  const char *value, size_t size, gfp_t flags)
{
	char *xattr_value = NULL;
	int rc;

	rc = vfs_getxattr_alloc(dentry, xattr_name, &xattr_value, 0, flags);
	if (rc < 0)
		return rc;

	if ((rc != size) || (memcmp(xattr_value, value, rc) != 0))
		rc = -EINVAL;
	else
		rc = 0;
	kfree(xattr_value);
	return rc;
}

229
ssize_t
230
vfs_getxattr(struct dentry *dentry, const char *name, void *value, size_t size)
231 232 233 234
{
	struct inode *inode = dentry->d_inode;
	int error;

235 236 237 238
	error = xattr_permission(inode, name, MAY_READ);
	if (error)
		return error;

239 240 241 242 243
	error = security_inode_getxattr(dentry, name);
	if (error)
		return error;

	if (!strncmp(name, XATTR_SECURITY_PREFIX,
244 245
				XATTR_SECURITY_PREFIX_LEN)) {
		const char *suffix = name + XATTR_SECURITY_PREFIX_LEN;
246
		int ret = xattr_getsecurity(inode, suffix, value, size);
247 248 249 250
		/*
		 * Only overwrite the return value if a security module
		 * is actually active.
		 */
251 252 253
		if (ret == -EOPNOTSUPP)
			goto nolsm;
		return ret;
254
	}
255 256 257 258 259
nolsm:
	if (inode->i_op->getxattr)
		error = inode->i_op->getxattr(dentry, name, value, size);
	else
		error = -EOPNOTSUPP;
260 261 262 263 264

	return error;
}
EXPORT_SYMBOL_GPL(vfs_getxattr);

B
Bill Nottingham 已提交
265 266 267 268 269 270 271 272 273
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 已提交
274
	if (d->d_inode->i_op->listxattr) {
B
Bill Nottingham 已提交
275 276 277 278 279 280 281 282 283 284
		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);

285
int
286
vfs_removexattr(struct dentry *dentry, const char *name)
287 288 289 290 291 292 293
{
	struct inode *inode = dentry->d_inode;
	int error;

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

294 295 296 297
	error = xattr_permission(inode, name, MAY_WRITE);
	if (error)
		return error;

298 299 300 301 302 303 304 305
	error = security_inode_removexattr(dentry, name);
	if (error)
		return error;

	mutex_lock(&inode->i_mutex);
	error = inode->i_op->removexattr(dentry, name);
	mutex_unlock(&inode->i_mutex);

M
Mimi Zohar 已提交
306
	if (!error) {
307
		fsnotify_xattr(dentry);
M
Mimi Zohar 已提交
308 309
		evm_inode_post_removexattr(dentry, name);
	}
310 311 312 313 314
	return error;
}
EXPORT_SYMBOL_GPL(vfs_removexattr);


L
Linus Torvalds 已提交
315 316 317 318
/*
 * Extended attribute SET operations
 */
static long
319
setxattr(struct dentry *d, const char __user *name, const void __user *value,
L
Linus Torvalds 已提交
320 321 322 323
	 size_t size, int flags)
{
	int error;
	void *kvalue = NULL;
324
	void *vvalue = NULL;	/* If non-NULL, we used vmalloc() */
L
Linus Torvalds 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337 338
	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;
339 340 341 342 343 344 345 346 347 348 349
		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;
		}
L
Linus Torvalds 已提交
350 351
	}

352
	error = vfs_setxattr(d, kname, kvalue, size, flags);
353 354 355 356 357
out:
	if (vvalue)
		vfree(vvalue);
	else
		kfree(kvalue);
L
Linus Torvalds 已提交
358 359 360
	return error;
}

361 362 363
SYSCALL_DEFINE5(setxattr, const char __user *, pathname,
		const char __user *, name, const void __user *, value,
		size_t, size, int, flags)
L
Linus Torvalds 已提交
364
{
365
	struct path path;
L
Linus Torvalds 已提交
366 367
	int error;

368
	error = user_path(pathname, &path);
L
Linus Torvalds 已提交
369 370
	if (error)
		return error;
371
	error = mnt_want_write(path.mnt);
372
	if (!error) {
373 374
		error = setxattr(path.dentry, name, value, size, flags);
		mnt_drop_write(path.mnt);
375
	}
376
	path_put(&path);
L
Linus Torvalds 已提交
377 378 379
	return error;
}

380 381 382
SYSCALL_DEFINE5(lsetxattr, const char __user *, pathname,
		const char __user *, name, const void __user *, value,
		size_t, size, int, flags)
L
Linus Torvalds 已提交
383
{
384
	struct path path;
L
Linus Torvalds 已提交
385 386
	int error;

387
	error = user_lpath(pathname, &path);
L
Linus Torvalds 已提交
388 389
	if (error)
		return error;
390
	error = mnt_want_write(path.mnt);
391
	if (!error) {
392 393
		error = setxattr(path.dentry, name, value, size, flags);
		mnt_drop_write(path.mnt);
394
	}
395
	path_put(&path);
L
Linus Torvalds 已提交
396 397 398
	return error;
}

399 400
SYSCALL_DEFINE5(fsetxattr, int, fd, const char __user *, name,
		const void __user *,value, size_t, size, int, flags)
L
Linus Torvalds 已提交
401
{
402
	int fput_needed;
L
Linus Torvalds 已提交
403
	struct file *f;
404
	struct dentry *dentry;
L
Linus Torvalds 已提交
405 406
	int error = -EBADF;

407
	f = fget_light(fd, &fput_needed);
L
Linus Torvalds 已提交
408 409
	if (!f)
		return error;
410
	dentry = f->f_path.dentry;
411
	audit_inode(NULL, dentry);
N
npiggin@suse.de 已提交
412
	error = mnt_want_write_file(f);
413 414
	if (!error) {
		error = setxattr(dentry, name, value, size, flags);
A
Al Viro 已提交
415
		mnt_drop_write_file(f);
416
	}
417
	fput_light(f, fput_needed);
L
Linus Torvalds 已提交
418 419 420 421 422 423 424
	return error;
}

/*
 * Extended attribute GET operations
 */
static ssize_t
425 426
getxattr(struct dentry *d, const char __user *name, void __user *value,
	 size_t size)
L
Linus Torvalds 已提交
427 428 429
{
	ssize_t error;
	void *kvalue = NULL;
430
	void *vvalue = NULL;
L
Linus Torvalds 已提交
431 432 433 434 435 436 437 438 439 440 441
	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;
442 443 444 445 446 447 448
		kvalue = kzalloc(size, GFP_KERNEL | __GFP_NOWARN);
		if (!kvalue) {
			vvalue = vmalloc(size);
			if (!vvalue)
				return -ENOMEM;
			kvalue = vvalue;
		}
L
Linus Torvalds 已提交
449 450
	}

451
	error = vfs_getxattr(d, kname, kvalue, size);
452 453 454 455 456 457 458
	if (error > 0) {
		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 已提交
459
	}
460 461 462 463
	if (vvalue)
		vfree(vvalue);
	else
		kfree(kvalue);
L
Linus Torvalds 已提交
464 465 466
	return error;
}

467 468
SYSCALL_DEFINE4(getxattr, const char __user *, pathname,
		const char __user *, name, void __user *, value, size_t, size)
L
Linus Torvalds 已提交
469
{
470
	struct path path;
L
Linus Torvalds 已提交
471 472
	ssize_t error;

473
	error = user_path(pathname, &path);
L
Linus Torvalds 已提交
474 475
	if (error)
		return error;
476 477
	error = getxattr(path.dentry, name, value, size);
	path_put(&path);
L
Linus Torvalds 已提交
478 479 480
	return error;
}

481 482
SYSCALL_DEFINE4(lgetxattr, const char __user *, pathname,
		const char __user *, name, void __user *, value, size_t, size)
L
Linus Torvalds 已提交
483
{
484
	struct path path;
L
Linus Torvalds 已提交
485 486
	ssize_t error;

487
	error = user_lpath(pathname, &path);
L
Linus Torvalds 已提交
488 489
	if (error)
		return error;
490 491
	error = getxattr(path.dentry, name, value, size);
	path_put(&path);
L
Linus Torvalds 已提交
492 493 494
	return error;
}

495 496
SYSCALL_DEFINE4(fgetxattr, int, fd, const char __user *, name,
		void __user *, value, size_t, size)
L
Linus Torvalds 已提交
497
{
498
	int fput_needed;
L
Linus Torvalds 已提交
499 500 501
	struct file *f;
	ssize_t error = -EBADF;

502
	f = fget_light(fd, &fput_needed);
L
Linus Torvalds 已提交
503 504
	if (!f)
		return error;
505
	audit_inode(NULL, f->f_path.dentry);
506
	error = getxattr(f->f_path.dentry, name, value, size);
507
	fput_light(f, fput_needed);
L
Linus Torvalds 已提交
508 509 510 511 512 513 514 515 516 517 518
	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;
519
	char *vlist = NULL;	/* If non-NULL, we used vmalloc() */
L
Linus Torvalds 已提交
520 521 522 523

	if (size) {
		if (size > XATTR_LIST_MAX)
			size = XATTR_LIST_MAX;
524
		klist = kmalloc(size, __GFP_NOWARN | GFP_KERNEL);
525 526 527 528 529 530
		if (!klist) {
			vlist = vmalloc(size);
			if (!vlist)
				return -ENOMEM;
			klist = vlist;
		}
L
Linus Torvalds 已提交
531 532
	}

B
Bill Nottingham 已提交
533
	error = vfs_listxattr(d, klist, size);
534 535 536 537 538 539 540
	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 已提交
541
	}
542 543 544 545
	if (vlist)
		vfree(vlist);
	else
		kfree(klist);
L
Linus Torvalds 已提交
546 547 548
	return error;
}

549 550
SYSCALL_DEFINE3(listxattr, const char __user *, pathname, char __user *, list,
		size_t, size)
L
Linus Torvalds 已提交
551
{
552
	struct path path;
L
Linus Torvalds 已提交
553 554
	ssize_t error;

555
	error = user_path(pathname, &path);
L
Linus Torvalds 已提交
556 557
	if (error)
		return error;
558 559
	error = listxattr(path.dentry, list, size);
	path_put(&path);
L
Linus Torvalds 已提交
560 561 562
	return error;
}

563 564
SYSCALL_DEFINE3(llistxattr, const char __user *, pathname, char __user *, list,
		size_t, size)
L
Linus Torvalds 已提交
565
{
566
	struct path path;
L
Linus Torvalds 已提交
567 568
	ssize_t error;

569
	error = user_lpath(pathname, &path);
L
Linus Torvalds 已提交
570 571
	if (error)
		return error;
572 573
	error = listxattr(path.dentry, list, size);
	path_put(&path);
L
Linus Torvalds 已提交
574 575 576
	return error;
}

577
SYSCALL_DEFINE3(flistxattr, int, fd, char __user *, list, size_t, size)
L
Linus Torvalds 已提交
578
{
579
	int fput_needed;
L
Linus Torvalds 已提交
580 581 582
	struct file *f;
	ssize_t error = -EBADF;

583
	f = fget_light(fd, &fput_needed);
L
Linus Torvalds 已提交
584 585
	if (!f)
		return error;
586
	audit_inode(NULL, f->f_path.dentry);
587
	error = listxattr(f->f_path.dentry, list, size);
588
	fput_light(f, fput_needed);
L
Linus Torvalds 已提交
589 590 591 592 593 594 595
	return error;
}

/*
 * Extended attribute REMOVE operations
 */
static long
596
removexattr(struct dentry *d, const char __user *name)
L
Linus Torvalds 已提交
597 598 599 600 601 602 603 604 605 606
{
	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;

607
	return vfs_removexattr(d, kname);
L
Linus Torvalds 已提交
608 609
}

610 611
SYSCALL_DEFINE2(removexattr, const char __user *, pathname,
		const char __user *, name)
L
Linus Torvalds 已提交
612
{
613
	struct path path;
L
Linus Torvalds 已提交
614 615
	int error;

616
	error = user_path(pathname, &path);
L
Linus Torvalds 已提交
617 618
	if (error)
		return error;
619
	error = mnt_want_write(path.mnt);
620
	if (!error) {
621 622
		error = removexattr(path.dentry, name);
		mnt_drop_write(path.mnt);
623
	}
624
	path_put(&path);
L
Linus Torvalds 已提交
625 626 627
	return error;
}

628 629
SYSCALL_DEFINE2(lremovexattr, const char __user *, pathname,
		const char __user *, name)
L
Linus Torvalds 已提交
630
{
631
	struct path path;
L
Linus Torvalds 已提交
632 633
	int error;

634
	error = user_lpath(pathname, &path);
L
Linus Torvalds 已提交
635 636
	if (error)
		return error;
637
	error = mnt_want_write(path.mnt);
638
	if (!error) {
639 640
		error = removexattr(path.dentry, name);
		mnt_drop_write(path.mnt);
641
	}
642
	path_put(&path);
L
Linus Torvalds 已提交
643 644 645
	return error;
}

646
SYSCALL_DEFINE2(fremovexattr, int, fd, const char __user *, name)
L
Linus Torvalds 已提交
647
{
648
	int fput_needed;
L
Linus Torvalds 已提交
649
	struct file *f;
650
	struct dentry *dentry;
L
Linus Torvalds 已提交
651 652
	int error = -EBADF;

653
	f = fget_light(fd, &fput_needed);
L
Linus Torvalds 已提交
654 655
	if (!f)
		return error;
656
	dentry = f->f_path.dentry;
657
	audit_inode(NULL, dentry);
N
npiggin@suse.de 已提交
658
	error = mnt_want_write_file(f);
659 660
	if (!error) {
		error = removexattr(dentry, name);
A
Al Viro 已提交
661
		mnt_drop_write_file(f);
662
	}
663
	fput_light(f, fput_needed);
L
Linus Torvalds 已提交
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
	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.
 */
695 696
static const struct xattr_handler *
xattr_resolve_name(const struct xattr_handler **handlers, const char **name)
L
Linus Torvalds 已提交
697
{
698
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718

	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)
{
719
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
720

721
	handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
L
Linus Torvalds 已提交
722 723
	if (!handler)
		return -EOPNOTSUPP;
724
	return handler->get(dentry, name, buffer, size, handler->flags);
L
Linus Torvalds 已提交
725 726 727 728 729 730 731 732 733
}

/*
 * 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)
{
734
	const struct xattr_handler *handler, **handlers = dentry->d_sb->s_xattr;
L
Linus Torvalds 已提交
735 736 737
	unsigned int size = 0;

	if (!buffer) {
738 739 740 741
		for_each_xattr_handler(handlers, handler) {
			size += handler->list(dentry, NULL, 0, NULL, 0,
					      handler->flags);
		}
L
Linus Torvalds 已提交
742 743 744 745
	} else {
		char *buf = buffer;

		for_each_xattr_handler(handlers, handler) {
746 747
			size = handler->list(dentry, buf, buffer_size,
					     NULL, 0, handler->flags);
L
Linus Torvalds 已提交
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
			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)
{
764
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
765 766 767

	if (size == 0)
		value = "";  /* empty EA, do not remove */
768
	handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
L
Linus Torvalds 已提交
769 770
	if (!handler)
		return -EOPNOTSUPP;
J
Jan Kara 已提交
771
	return handler->set(dentry, name, value, size, flags, handler->flags);
L
Linus Torvalds 已提交
772 773 774 775 776 777 778 779 780
}

/*
 * 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)
{
781
	const struct xattr_handler *handler;
L
Linus Torvalds 已提交
782

783
	handler = xattr_resolve_name(dentry->d_sb->s_xattr, &name);
L
Linus Torvalds 已提交
784 785
	if (!handler)
		return -EOPNOTSUPP;
786 787
	return handler->set(dentry, name, NULL, 0,
			    XATTR_REPLACE, handler->flags);
L
Linus Torvalds 已提交
788 789 790 791 792 793
}

EXPORT_SYMBOL(generic_getxattr);
EXPORT_SYMBOL(generic_listxattr);
EXPORT_SYMBOL(generic_setxattr);
EXPORT_SYMBOL(generic_removexattr);
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 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 851 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

/*
 * 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;
	if (len <= sizeof(*new_xattr))
		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;
	struct simple_xattr *new_xattr = NULL;
	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;

}

895 896 897 898 899 900 901 902 903 904 905 906 907
/**
 * 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.
908 909 910 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
 */
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;
}

964 965 966
/*
 * Adds an extended attribute to the list
 */
967 968 969 970 971 972 973
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);
}