namei.c 23.7 KB
Newer Older
M
Miklos Szeredi 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * Copyright (C) 2011 Novell Inc.
 * Copyright (C) 2016 Red Hat, Inc.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */

#include <linux/fs.h>
11
#include <linux/cred.h>
A
Amir Goldstein 已提交
12
#include <linux/ctype.h>
M
Miklos Szeredi 已提交
13 14
#include <linux/namei.h>
#include <linux/xattr.h>
M
Miklos Szeredi 已提交
15
#include <linux/ratelimit.h>
16 17
#include <linux/mount.h>
#include <linux/exportfs.h>
M
Miklos Szeredi 已提交
18 19
#include "overlayfs.h"

20 21 22 23 24 25
struct ovl_lookup_data {
	struct qstr name;
	bool is_dir;
	bool opaque;
	bool stop;
	bool last;
M
Miklos Szeredi 已提交
26
	char *redirect;
27
};
M
Miklos Szeredi 已提交
28

M
Miklos Szeredi 已提交
29 30 31 32 33 34 35 36 37 38 39 40
static int ovl_check_redirect(struct dentry *dentry, struct ovl_lookup_data *d,
			      size_t prelen, const char *post)
{
	int res;
	char *s, *next, *buf = NULL;

	res = vfs_getxattr(dentry, OVL_XATTR_REDIRECT, NULL, 0);
	if (res < 0) {
		if (res == -ENODATA || res == -EOPNOTSUPP)
			return 0;
		goto fail;
	}
41
	buf = kzalloc(prelen + res + strlen(post) + 1, GFP_KERNEL);
M
Miklos Szeredi 已提交
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
	if (!buf)
		return -ENOMEM;

	if (res == 0)
		goto invalid;

	res = vfs_getxattr(dentry, OVL_XATTR_REDIRECT, buf, res);
	if (res < 0)
		goto fail;
	if (res == 0)
		goto invalid;
	if (buf[0] == '/') {
		for (s = buf; *s++ == '/'; s = next) {
			next = strchrnul(s, '/');
			if (s == next)
				goto invalid;
		}
	} else {
		if (strchr(buf, '/') != NULL)
			goto invalid;

		memmove(buf + prelen, buf, res);
		memcpy(buf, d->name.name, prelen);
	}

	strcat(buf, post);
	kfree(d->redirect);
	d->redirect = buf;
	d->name.name = d->redirect;
	d->name.len = strlen(d->redirect);

	return 0;

err_free:
	kfree(buf);
	return 0;
fail:
	pr_warn_ratelimited("overlayfs: failed to get redirect (%i)\n", res);
	goto err_free;
invalid:
	pr_warn_ratelimited("overlayfs: invalid redirect (%s)\n", buf);
	goto err_free;
}

86 87
static int ovl_acceptable(void *ctx, struct dentry *dentry)
{
88 89 90 91 92 93 94 95 96 97 98 99 100
	/*
	 * A non-dir origin may be disconnected, which is fine, because
	 * we only need it for its unique inode number.
	 */
	if (!d_is_dir(dentry))
		return 1;

	/* Don't decode a deleted empty directory */
	if (d_unhashed(dentry))
		return 0;

	/* Check if directory belongs to the layer we are decoding from */
	return is_subdir(dentry, ((struct vfsmount *)ctx)->mnt_root);
101 102
}

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
/*
 * Check validity of an overlay file handle buffer.
 *
 * Return 0 for a valid file handle.
 * Return -ENODATA for "origin unknown".
 * Return <0 for an invalid file handle.
 */
static int ovl_check_fh_len(struct ovl_fh *fh, int fh_len)
{
	if (fh_len < sizeof(struct ovl_fh) || fh_len < fh->len)
		return -EINVAL;

	if (fh->magic != OVL_FH_MAGIC)
		return -EINVAL;

	/* Treat larger version and unknown flags as "origin unknown" */
	if (fh->version > OVL_FH_VERSION || fh->flags & ~OVL_FH_FLAG_ALL)
		return -ENODATA;

	/* Treat endianness mismatch as "origin unknown" */
	if (!(fh->flags & OVL_FH_FLAG_ANY_ENDIAN) &&
	    (fh->flags & OVL_FH_FLAG_BIG_ENDIAN) != OVL_FH_FLAG_CPU_ENDIAN)
		return -ENODATA;

	return 0;
}

130
static struct ovl_fh *ovl_get_fh(struct dentry *dentry, const char *name)
131
{
132
	int res, err;
133 134
	struct ovl_fh *fh = NULL;

135
	res = vfs_getxattr(dentry, name, NULL, 0);
136 137 138 139 140 141 142 143 144
	if (res < 0) {
		if (res == -ENODATA || res == -EOPNOTSUPP)
			return NULL;
		goto fail;
	}
	/* Zero size value means "copied up but origin unknown" */
	if (res == 0)
		return NULL;

145
	fh = kzalloc(res, GFP_KERNEL);
146 147 148
	if (!fh)
		return ERR_PTR(-ENOMEM);

149
	res = vfs_getxattr(dentry, name, fh, res);
150 151 152
	if (res < 0)
		goto fail;

153 154 155 156
	err = ovl_check_fh_len(fh, res);
	if (err < 0) {
		if (err == -ENODATA)
			goto out;
157
		goto invalid;
158
	}
159

160 161 162 163 164 165 166 167 168 169 170 171 172 173
	return fh;

out:
	kfree(fh);
	return NULL;

fail:
	pr_warn_ratelimited("overlayfs: failed to get origin (%i)\n", res);
	goto out;
invalid:
	pr_warn_ratelimited("overlayfs: invalid origin (%*phN)\n", res, fh);
	goto out;
}

174
static struct dentry *ovl_decode_fh(struct ovl_fh *fh, struct vfsmount *mnt)
175
{
176
	struct dentry *real;
177 178
	int bytes;

179 180 181 182
	/*
	 * Make sure that the stored uuid matches the uuid of the lower
	 * layer where file handle will be decoded.
	 */
183
	if (!uuid_equal(&fh->uuid, &mnt->mnt_sb->s_uuid))
184
		return NULL;
185

186
	bytes = (fh->len - offsetof(struct ovl_fh, fid));
187 188 189 190 191 192 193 194 195 196 197 198 199 200
	real = exportfs_decode_fh(mnt, (struct fid *)fh->fid,
				  bytes >> 2, (int)fh->type,
				  ovl_acceptable, mnt);
	if (IS_ERR(real)) {
		/*
		 * Treat stale file handle to lower file as "origin unknown".
		 * upper file handle could become stale when upper file is
		 * unlinked and this information is needed to handle stale
		 * index entries correctly.
		 */
		if (real == ERR_PTR(-ESTALE) &&
		    !(fh->flags & OVL_FH_FLAG_PATH_UPPER))
			real = NULL;
		return real;
201 202
	}

203 204
	if (ovl_dentry_weird(real)) {
		dput(real);
205 206
		return NULL;
	}
207

208
	return real;
209 210
}

211 212 213 214 215
static bool ovl_is_opaquedir(struct dentry *dentry)
{
	return ovl_check_dir_xattr(dentry, OVL_XATTR_OPAQUE);
}

216 217
static int ovl_lookup_single(struct dentry *base, struct ovl_lookup_data *d,
			     const char *name, unsigned int namelen,
M
Miklos Szeredi 已提交
218
			     size_t prelen, const char *post,
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
			     struct dentry **ret)
{
	struct dentry *this;
	int err;

	this = lookup_one_len_unlocked(name, base, namelen);
	if (IS_ERR(this)) {
		err = PTR_ERR(this);
		this = NULL;
		if (err == -ENOENT || err == -ENAMETOOLONG)
			goto out;
		goto out_err;
	}
	if (!this->d_inode)
		goto put_and_out;

	if (ovl_dentry_weird(this)) {
		/* Don't support traversing automounts and other weirdness */
		err = -EREMOTE;
		goto out_err;
	}
	if (ovl_is_whiteout(this)) {
		d->stop = d->opaque = true;
		goto put_and_out;
	}
	if (!d_can_lookup(this)) {
		d->stop = true;
		if (d->is_dir)
			goto put_and_out;
		goto out;
	}
	d->is_dir = true;
	if (!d->last && ovl_is_opaquedir(this)) {
		d->stop = d->opaque = true;
		goto out;
	}
M
Miklos Szeredi 已提交
255 256 257
	err = ovl_check_redirect(this, d, prelen, post);
	if (err)
		goto out_err;
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
out:
	*ret = this;
	return 0;

put_and_out:
	dput(this);
	this = NULL;
	goto out;

out_err:
	dput(this);
	return err;
}

static int ovl_lookup_layer(struct dentry *base, struct ovl_lookup_data *d,
			    struct dentry **ret)
{
275 276
	/* Counting down from the end, since the prefix can change */
	size_t rem = d->name.len - 1;
M
Miklos Szeredi 已提交
277 278 279
	struct dentry *dentry = NULL;
	int err;

280
	if (d->name.name[0] != '/')
M
Miklos Szeredi 已提交
281 282 283
		return ovl_lookup_single(base, d, d->name.name, d->name.len,
					 0, "", ret);

284 285
	while (!IS_ERR_OR_NULL(base) && d_can_lookup(base)) {
		const char *s = d->name.name + d->name.len - rem;
M
Miklos Szeredi 已提交
286
		const char *next = strchrnul(s, '/');
287 288
		size_t thislen = next - s;
		bool end = !next[0];
M
Miklos Szeredi 已提交
289

290 291
		/* Verify we did not go off the rails */
		if (WARN_ON(s[-1] != '/'))
M
Miklos Szeredi 已提交
292 293
			return -EIO;

294 295
		err = ovl_lookup_single(base, d, s, thislen,
					d->name.len - rem, next, &base);
M
Miklos Szeredi 已提交
296 297 298 299
		dput(dentry);
		if (err)
			return err;
		dentry = base;
300 301 302 303 304 305 306
		if (end)
			break;

		rem -= thislen + 1;

		if (WARN_ON(rem >= d->name.len))
			return -EIO;
M
Miklos Szeredi 已提交
307 308 309
	}
	*ret = dentry;
	return 0;
310 311
}

312

313 314
static int ovl_check_origin_fh(struct ovl_fs *ofs, struct ovl_fh *fh,
			       struct dentry *upperdentry,
315
			       struct ovl_path **stackp)
316
{
317 318
	struct dentry *origin = NULL;
	int i;
319

320 321
	for (i = 0; i < ofs->numlower; i++) {
		origin = ovl_decode_fh(fh, ofs->lower_layers[i].mnt);
322 323 324 325 326
		if (origin)
			break;
	}

	if (!origin)
327 328 329 330 331 332 333
		return -ESTALE;
	else if (IS_ERR(origin))
		return PTR_ERR(origin);

	if (!ovl_is_whiteout(upperdentry) &&
	    ((d_inode(origin)->i_mode ^ d_inode(upperdentry)->i_mode) & S_IFMT))
		goto invalid;
334

335
	if (!*stackp)
336
		*stackp = kmalloc(sizeof(struct ovl_path), GFP_KERNEL);
337 338 339 340
	if (!*stackp) {
		dput(origin);
		return -ENOMEM;
	}
341 342 343 344
	**stackp = (struct ovl_path){
		.dentry = origin,
		.layer = &ofs->lower_layers[i]
	};
345 346

	return 0;
347 348 349 350 351 352 353 354 355

invalid:
	pr_warn_ratelimited("overlayfs: invalid origin (%pd2, ftype=%x, origin ftype=%x).\n",
			    upperdentry, d_inode(upperdentry)->i_mode & S_IFMT,
			    d_inode(origin)->i_mode & S_IFMT);
	dput(origin);
	return -EIO;
}

356
static int ovl_check_origin(struct ovl_fs *ofs, struct dentry *upperdentry,
357 358
			    struct ovl_path **stackp, unsigned int *ctrp)
{
359
	struct ovl_fh *fh = ovl_get_fh(upperdentry, OVL_XATTR_ORIGIN);
360 361 362 363 364
	int err;

	if (IS_ERR_OR_NULL(fh))
		return PTR_ERR(fh);

365
	err = ovl_check_origin_fh(ofs, fh, upperdentry, stackp);
366 367 368 369 370 371 372 373 374 375 376 377 378
	kfree(fh);

	if (err) {
		if (err == -ESTALE)
			return 0;
		return err;
	}

	if (WARN_ON(*ctrp))
		return -EIO;

	*ctrp = 1;
	return 0;
379 380
}

381
/*
382
 * Verify that @fh matches the file handle stored in xattr @name.
383 384
 * Return 0 on match, -ESTALE on mismatch, < 0 on error.
 */
385 386
static int ovl_verify_fh(struct dentry *dentry, const char *name,
			 const struct ovl_fh *fh)
387
{
388
	struct ovl_fh *ofh = ovl_get_fh(dentry, name);
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
	int err = 0;

	if (!ofh)
		return -ENODATA;

	if (IS_ERR(ofh))
		return PTR_ERR(ofh);

	if (fh->len != ofh->len || memcmp(fh, ofh, fh->len))
		err = -ESTALE;

	kfree(ofh);
	return err;
}

/*
405
 * Verify that @real dentry matches the file handle stored in xattr @name.
406
 *
407 408
 * If @set is true and there is no stored file handle, encode @real and store
 * file handle in xattr @name.
409
 *
410
 * Return 0 on match, -ESTALE on mismatch, -ENODATA on no xattr, < 0 on error.
411
 */
412 413
int ovl_verify_set_fh(struct dentry *dentry, const char *name,
		      struct dentry *real, bool is_upper, bool set)
414 415 416 417 418
{
	struct inode *inode;
	struct ovl_fh *fh;
	int err;

419
	fh = ovl_encode_fh(real, is_upper);
420 421 422 423
	err = PTR_ERR(fh);
	if (IS_ERR(fh))
		goto fail;

424
	err = ovl_verify_fh(dentry, name, fh);
425
	if (set && err == -ENODATA)
426
		err = ovl_do_setxattr(dentry, name, fh, fh->len, 0);
427 428 429 430 431 432 433 434
	if (err)
		goto fail;

out:
	kfree(fh);
	return err;

fail:
435 436 437 438
	inode = d_inode(real);
	pr_warn_ratelimited("overlayfs: failed to verify %s (%pd2, ino=%lu, err=%i)\n",
			    is_upper ? "upper" : "origin", real,
			    inode ? inode->i_ino : 0, err);
439 440 441
	goto out;
}

442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
/* Get upper dentry from index */
static struct dentry *ovl_index_upper(struct ovl_fs *ofs, struct dentry *index)
{
	struct ovl_fh *fh;
	struct dentry *upper;

	if (!d_is_dir(index))
		return dget(index);

	fh = ovl_get_fh(index, OVL_XATTR_UPPER);
	if (IS_ERR_OR_NULL(fh))
		return ERR_CAST(fh);

	upper = ovl_decode_fh(fh, ofs->upper_mnt);
	kfree(fh);

	if (IS_ERR_OR_NULL(upper))
		return upper ?: ERR_PTR(-ESTALE);

	if (!d_is_dir(upper)) {
		pr_warn_ratelimited("overlayfs: invalid index upper (%pd2, upper=%pd2).\n",
				    index, upper);
		dput(upper);
		return ERR_PTR(-EIO);
	}

	return upper;
}

A
Amir Goldstein 已提交
471 472 473 474 475 476
/* Is this a leftover from create/whiteout of directory index entry? */
static bool ovl_is_temp_index(struct dentry *index)
{
	return index->d_name.name[0] == '#';
}

477 478 479 480 481
/*
 * Verify that an index entry name matches the origin file handle stored in
 * OVL_XATTR_ORIGIN and that origin file handle can be decoded to lower path.
 * Return 0 on match, -ESTALE on mismatch or stale origin, < 0 on error.
 */
482
int ovl_verify_index(struct ovl_fs *ofs, struct dentry *index)
483 484 485
{
	struct ovl_fh *fh = NULL;
	size_t len;
486 487
	struct ovl_path origin = { };
	struct ovl_path *stack = &origin;
488
	struct dentry *upper = NULL;
489 490 491 492 493
	int err;

	if (!d_inode(index))
		return 0;

A
Amir Goldstein 已提交
494 495 496 497 498
	/* Cleanup leftover from index create/cleanup attempt */
	err = -ESTALE;
	if (ovl_is_temp_index(index))
		goto fail;

499
	err = -EINVAL;
500 501 502 503 504
	if (index->d_name.len < sizeof(struct ovl_fh)*2)
		goto fail;

	err = -ENOMEM;
	len = index->d_name.len / 2;
505
	fh = kzalloc(len, GFP_KERNEL);
506 507 508 509
	if (!fh)
		goto fail;

	err = -EINVAL;
510 511 512 513 514
	if (hex2bin((u8 *)fh, index->d_name.name, len))
		goto fail;

	err = ovl_check_fh_len(fh, len);
	if (err)
515 516
		goto fail;

517 518 519 520 521 522 523 524
	/*
	 * Whiteout index entries are used as an indication that an exported
	 * overlay file handle should be treated as stale (i.e. after unlink
	 * of the overlay inode). These entries contain no origin xattr.
	 */
	if (ovl_is_whiteout(index))
		goto out;

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
	/*
	 * Verifying directory index entries are not stale is expensive, so
	 * only verify stale dir index if NFS export is enabled.
	 */
	if (d_is_dir(index) && !ofs->config.nfs_export)
		goto out;

	/*
	 * Directory index entries should have 'upper' xattr pointing to the
	 * real upper dir. Non-dir index entries are hardlinks to the upper
	 * real inode. For non-dir index, we can read the copy up origin xattr
	 * directly from the index dentry, but for dir index we first need to
	 * decode the upper directory.
	 */
	upper = ovl_index_upper(ofs, index);
	if (IS_ERR_OR_NULL(upper)) {
		err = PTR_ERR(upper);
542 543 544 545 546 547 548 549 550
		/*
		 * Directory index entries with no 'upper' xattr need to be
		 * removed. When dir index entry has a stale 'upper' xattr,
		 * we assume that upper dir was removed and we treat the dir
		 * index as orphan entry that needs to be whited out.
		 */
		if (err == -ESTALE)
			goto orphan;
		else if (!err)
551
			err = -ESTALE;
552
		goto fail;
553
	}
554

555 556
	err = ovl_verify_fh(upper, OVL_XATTR_ORIGIN, fh);
	dput(upper);
557 558 559
	if (err)
		goto fail;

560 561 562 563 564 565 566
	/* Check if non-dir index is orphan and don't warn before cleaning it */
	if (!d_is_dir(index) && d_inode(index)->i_nlink == 1) {
		err = ovl_check_origin_fh(ofs, fh, index, &stack);
		if (err)
			goto fail;

		if (ovl_get_nlink(origin.dentry, index, 0) == 0)
567
			goto orphan;
568
	}
569

570
out:
571
	dput(origin.dentry);
572 573 574 575
	kfree(fh);
	return err;

fail:
576 577
	pr_warn_ratelimited("overlayfs: failed to verify index (%pd2, ftype=%x, err=%i)\n",
			    index, d_inode(index)->i_mode & S_IFMT, err);
578
	goto out;
579 580 581 582 583 584 585

orphan:
	pr_warn_ratelimited("overlayfs: orphan index entry (%pd2, ftype=%x, nlink=%u)\n",
			    index, d_inode(index)->i_mode & S_IFMT,
			    d_inode(index)->i_nlink);
	err = -ENOENT;
	goto out;
586 587
}

588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
/*
 * Lookup in indexdir for the index entry of a lower real inode or a copy up
 * origin inode. The index entry name is the hex representation of the lower
 * inode file handle.
 *
 * If the index dentry in negative, then either no lower aliases have been
 * copied up yet, or aliases have been copied up in older kernels and are
 * not indexed.
 *
 * If the index dentry for a copy up origin inode is positive, but points
 * to an inode different than the upper inode, then either the upper inode
 * has been copied up and not indexed or it was indexed, but since then
 * index dir was cleared. Either way, that index cannot be used to indentify
 * the overlay inode.
 */
int ovl_get_index_name(struct dentry *origin, struct qstr *name)
{
	int err;
	struct ovl_fh *fh;
	char *n, *s;

	fh = ovl_encode_fh(origin, false);
	if (IS_ERR(fh))
		return PTR_ERR(fh);

	err = -ENOMEM;
614
	n = kzalloc(fh->len * 2, GFP_KERNEL);
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
	if (n) {
		s  = bin2hex(n, fh, fh->len);
		*name = (struct qstr) QSTR_INIT(n, s - n);
		err = 0;
	}
	kfree(fh);

	return err;

}

static struct dentry *ovl_lookup_index(struct dentry *dentry,
				       struct dentry *upper,
				       struct dentry *origin)
{
	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
	struct dentry *index;
	struct inode *inode;
	struct qstr name;
634
	bool is_dir = d_is_dir(origin);
635 636 637 638 639 640 641 642
	int err;

	err = ovl_get_index_name(origin, &name);
	if (err)
		return ERR_PTR(err);

	index = lookup_one_len_unlocked(name.name, ofs->indexdir, name.len);
	if (IS_ERR(index)) {
643
		err = PTR_ERR(index);
644 645 646 647
		if (err == -ENOENT) {
			index = NULL;
			goto out;
		}
648 649 650 651 652 653 654
		pr_warn_ratelimited("overlayfs: failed inode index lookup (ino=%lu, key=%*s, err=%i);\n"
				    "overlayfs: mount with '-o index=off' to disable inodes index.\n",
				    d_inode(origin)->i_ino, name.len, name.name,
				    err);
		goto out;
	}

655
	inode = d_inode(index);
656
	if (d_is_negative(index)) {
657
		goto out_dput;
658 659 660 661 662 663 664 665 666 667 668 669
	} else if (ovl_dentry_weird(index) || ovl_is_whiteout(index) ||
		   ((inode->i_mode ^ d_inode(origin)->i_mode) & S_IFMT)) {
		/*
		 * Index should always be of the same file type as origin
		 * except for the case of a whiteout index. A whiteout
		 * index should only exist if all lower aliases have been
		 * unlinked, which means that finding a lower origin on lookup
		 * whose index is a whiteout should be treated as an error.
		 */
		pr_warn_ratelimited("overlayfs: bad index found (index=%pd2, ftype=%x, origin ftype=%x).\n",
				    index, d_inode(index)->i_mode & S_IFMT,
				    d_inode(origin)->i_mode & S_IFMT);
670
		goto fail;
671 672 673 674 675 676
	} else if (is_dir) {
		if (!upper) {
			pr_warn_ratelimited("overlayfs: suspected uncovered redirected dir found (origin=%pd2, index=%pd2).\n",
					    origin, index);
			goto fail;
		}
677

678 679 680 681 682 683 684 685 686 687 688 689
		/* Verify that dir index 'upper' xattr points to upper dir */
		err = ovl_verify_upper(index, upper, false);
		if (err) {
			if (err == -ESTALE) {
				pr_warn_ratelimited("overlayfs: suspected multiply redirected dir found (upper=%pd2, origin=%pd2, index=%pd2).\n",
						    upper, origin, index);
			}
			goto fail;
		}
	} else if (upper && d_inode(upper) != inode) {
		goto out_dput;
	}
690 691 692 693
out:
	kfree(name.name);
	return index;

694 695 696 697 698
out_dput:
	dput(index);
	index = NULL;
	goto out;

699 700 701 702 703 704
fail:
	dput(index);
	index = ERR_PTR(-EIO);
	goto out;
}

M
Miklos Szeredi 已提交
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
/*
 * Returns next layer in stack starting from top.
 * Returns -1 if this is the last layer.
 */
int ovl_path_next(int idx, struct dentry *dentry, struct path *path)
{
	struct ovl_entry *oe = dentry->d_fsdata;

	BUG_ON(idx < 0);
	if (idx == 0) {
		ovl_path_upper(dentry, path);
		if (path->dentry)
			return oe->numlower ? 1 : -1;
		idx++;
	}
	BUG_ON(idx > oe->numlower);
721 722
	path->dentry = oe->lowerstack[idx - 1].dentry;
	path->mnt = oe->lowerstack[idx - 1].layer->mnt;
M
Miklos Szeredi 已提交
723 724 725 726

	return (idx < oe->numlower) ? idx + 1 : -1;
}

727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
/* Fix missing 'origin' xattr */
static int ovl_fix_origin(struct dentry *dentry, struct dentry *lower,
			  struct dentry *upper)
{
	int err;

	if (ovl_check_origin_xattr(upper))
		return 0;

	err = ovl_want_write(dentry);
	if (err)
		return err;

	err = ovl_set_origin(dentry, lower, upper);
	if (!err)
		err = ovl_set_impure(dentry->d_parent, upper->d_parent);

	ovl_drop_write(dentry);
	return err;
}

M
Miklos Szeredi 已提交
748 749 750 751 752
struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
			  unsigned int flags)
{
	struct ovl_entry *oe;
	const struct cred *old_cred;
M
Miklos Szeredi 已提交
753
	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
M
Miklos Szeredi 已提交
754
	struct ovl_entry *poe = dentry->d_parent->d_fsdata;
755
	struct ovl_entry *roe = dentry->d_sb->s_root->d_fsdata;
756
	struct ovl_path *stack = NULL;
M
Miklos Szeredi 已提交
757
	struct dentry *upperdir, *upperdentry = NULL;
758
	struct dentry *origin = NULL;
759
	struct dentry *index = NULL;
M
Miklos Szeredi 已提交
760 761 762
	unsigned int ctr = 0;
	struct inode *inode = NULL;
	bool upperopaque = false;
M
Miklos Szeredi 已提交
763
	char *upperredirect = NULL;
M
Miklos Szeredi 已提交
764 765 766
	struct dentry *this;
	unsigned int i;
	int err;
767 768 769 770 771 772
	struct ovl_lookup_data d = {
		.name = dentry->d_name,
		.is_dir = false,
		.opaque = false,
		.stop = false,
		.last = !poe->numlower,
M
Miklos Szeredi 已提交
773
		.redirect = NULL,
774
	};
M
Miklos Szeredi 已提交
775

M
Miklos Szeredi 已提交
776 777 778
	if (dentry->d_name.len > ofs->namelen)
		return ERR_PTR(-ENAMETOOLONG);

M
Miklos Szeredi 已提交
779
	old_cred = ovl_override_creds(dentry->d_sb);
780
	upperdir = ovl_dentry_upper(dentry->d_parent);
M
Miklos Szeredi 已提交
781
	if (upperdir) {
782 783
		err = ovl_lookup_layer(upperdir, &d, &upperdentry);
		if (err)
M
Miklos Szeredi 已提交
784 785
			goto out;

786 787 788 789
		if (upperdentry && unlikely(ovl_dentry_remote(upperdentry))) {
			dput(upperdentry);
			err = -EREMOTE;
			goto out;
M
Miklos Szeredi 已提交
790
		}
791 792
		if (upperdentry && !d.is_dir) {
			BUG_ON(!d.stop || d.redirect);
793 794 795 796 797 798 799 800 801 802
			/*
			 * Lookup copy up origin by decoding origin file handle.
			 * We may get a disconnected dentry, which is fine,
			 * because we only need to hold the origin inode in
			 * cache and use its inode number.  We may even get a
			 * connected dentry, that is not under any of the lower
			 * layers root.  That is also fine for using it's inode
			 * number - it's the same as if we held a reference
			 * to a dentry in lower layer that was moved under us.
			 */
803
			err = ovl_check_origin(ofs, upperdentry, &stack, &ctr);
804
			if (err)
805
				goto out_put_upper;
806
		}
M
Miklos Szeredi 已提交
807 808

		if (d.redirect) {
809
			err = -ENOMEM;
M
Miklos Szeredi 已提交
810 811 812 813
			upperredirect = kstrdup(d.redirect, GFP_KERNEL);
			if (!upperredirect)
				goto out_put_upper;
			if (d.redirect[0] == '/')
814
				poe = roe;
M
Miklos Szeredi 已提交
815
		}
816
		upperopaque = d.opaque;
M
Miklos Szeredi 已提交
817 818
	}

819
	if (!d.stop && poe->numlower) {
M
Miklos Szeredi 已提交
820
		err = -ENOMEM;
821
		stack = kcalloc(ofs->numlower, sizeof(struct ovl_path),
822
				GFP_KERNEL);
M
Miklos Szeredi 已提交
823 824 825 826
		if (!stack)
			goto out_put_upper;
	}

827
	for (i = 0; !d.stop && i < poe->numlower; i++) {
828
		struct ovl_path lower = poe->lowerstack[i];
M
Miklos Szeredi 已提交
829

830
		d.last = i == poe->numlower - 1;
831
		err = ovl_lookup_layer(lower.dentry, &d, &this);
832
		if (err)
M
Miklos Szeredi 已提交
833
			goto out_put;
M
Miklos Szeredi 已提交
834

M
Miklos Szeredi 已提交
835 836 837
		if (!this)
			continue;

838 839 840 841 842 843 844 845 846 847 848 849
		/*
		 * If no origin fh is stored in upper of a merge dir, store fh
		 * of lower dir and set upper parent "impure".
		 */
		if (upperdentry && !ctr && !ofs->noxattr) {
			err = ovl_fix_origin(dentry, this, upperdentry);
			if (err) {
				dput(this);
				goto out_put;
			}
		}

850 851
		/*
		 * When "verify_lower" feature is enabled, do not merge with a
852 853
		 * lower dir that does not match a stored origin xattr. In any
		 * case, only verified origin is used for index lookup.
854 855 856 857 858 859 860
		 */
		if (upperdentry && !ctr && ovl_verify_lower(dentry->d_sb)) {
			err = ovl_verify_origin(upperdentry, this, false);
			if (err) {
				dput(this);
				break;
			}
861 862 863

			/* Bless lower dir as verified origin */
			origin = this;
864 865
		}

M
Miklos Szeredi 已提交
866
		stack[ctr].dentry = this;
867
		stack[ctr].layer = lower.layer;
M
Miklos Szeredi 已提交
868
		ctr++;
M
Miklos Szeredi 已提交
869 870 871 872

		if (d.stop)
			break;

873 874 875 876 877 878 879 880 881 882 883 884
		/*
		 * Following redirects can have security consequences: it's like
		 * a symlink into the lower layer without the permission checks.
		 * This is only a problem if the upper layer is untrusted (e.g
		 * comes from an USB drive).  This can allow a non-readable file
		 * or directory to become readable.
		 *
		 * Only following redirects when redirects are enabled disables
		 * this attack vector when not necessary.
		 */
		err = -EPERM;
		if (d.redirect && !ofs->config.redirect_follow) {
885 886
			pr_warn_ratelimited("overlayfs: refusing to follow redirect for (%pd2)\n",
					    dentry);
887 888 889
			goto out_put;
		}

890 891
		if (d.redirect && d.redirect[0] == '/' && poe != roe) {
			poe = roe;
M
Miklos Szeredi 已提交
892
			/* Find the current layer on the root dentry */
893
			i = lower.layer->idx - 1;
M
Miklos Szeredi 已提交
894
		}
M
Miklos Szeredi 已提交
895 896
	}

897 898 899 900 901 902 903 904
	/*
	 * Lookup index by lower inode and verify it matches upper inode.
	 * We only trust dir index if we verified that lower dir matches
	 * origin, otherwise dir index entries may be inconsistent and we
	 * ignore them. Always lookup index of non-dir and non-upper.
	 */
	if (ctr && (!upperdentry || !d.is_dir))
		origin = stack[0].dentry;
905

906 907
	if (origin && ovl_indexdir(dentry->d_sb) &&
	    (!d.is_dir || ovl_index_all(dentry->d_sb))) {
908 909 910 911 912 913 914 915
		index = ovl_lookup_index(dentry, upperdentry, origin);
		if (IS_ERR(index)) {
			err = PTR_ERR(index);
			index = NULL;
			goto out_put;
		}
	}

M
Miklos Szeredi 已提交
916 917 918 919 920
	oe = ovl_alloc_entry(ctr);
	err = -ENOMEM;
	if (!oe)
		goto out_put;

M
Miklos Szeredi 已提交
921
	oe->opaque = upperopaque;
922
	memcpy(oe->lowerstack, stack, sizeof(struct ovl_path) * ctr);
M
Miklos Szeredi 已提交
923
	dentry->d_fsdata = oe;
M
Miklos Szeredi 已提交
924

925 926 927
	if (upperdentry)
		ovl_dentry_set_upper_alias(dentry);
	else if (index)
928 929
		upperdentry = dget(index);

M
Miklos Szeredi 已提交
930
	if (upperdentry || ctr) {
931
		inode = ovl_get_inode(dentry, upperdentry, index);
932 933
		err = PTR_ERR(inode);
		if (IS_ERR(inode))
M
Miklos Szeredi 已提交
934
			goto out_free_oe;
M
Miklos Szeredi 已提交
935 936

		OVL_I(inode)->redirect = upperredirect;
937 938
		if (index)
			ovl_set_flag(OVL_INDEX, inode);
M
Miklos Szeredi 已提交
939 940 941
	}

	revert_creds(old_cred);
942
	dput(index);
M
Miklos Szeredi 已提交
943
	kfree(stack);
M
Miklos Szeredi 已提交
944
	kfree(d.redirect);
M
Miklos Szeredi 已提交
945 946 947 948 949
	d_add(dentry, inode);

	return NULL;

out_free_oe:
M
Miklos Szeredi 已提交
950
	dentry->d_fsdata = NULL;
M
Miklos Szeredi 已提交
951 952
	kfree(oe);
out_put:
953
	dput(index);
M
Miklos Szeredi 已提交
954 955 956 957 958
	for (i = 0; i < ctr; i++)
		dput(stack[i].dentry);
	kfree(stack);
out_put_upper:
	dput(upperdentry);
M
Miklos Szeredi 已提交
959
	kfree(upperredirect);
M
Miklos Szeredi 已提交
960
out:
M
Miklos Szeredi 已提交
961
	kfree(d.redirect);
M
Miklos Szeredi 已提交
962 963 964 965 966 967 968 969 970
	revert_creds(old_cred);
	return ERR_PTR(err);
}

bool ovl_lower_positive(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;
	struct ovl_entry *poe = dentry->d_parent->d_fsdata;
	const struct qstr *name = &dentry->d_name;
971
	const struct cred *old_cred;
M
Miklos Szeredi 已提交
972 973 974 975 976 977 978 979 980 981 982 983
	unsigned int i;
	bool positive = false;
	bool done = false;

	/*
	 * If dentry is negative, then lower is positive iff this is a
	 * whiteout.
	 */
	if (!dentry->d_inode)
		return oe->opaque;

	/* Negative upper -> positive lower */
984
	if (!ovl_dentry_upper(dentry))
M
Miklos Szeredi 已提交
985 986
		return true;

987
	old_cred = ovl_override_creds(dentry->d_sb);
M
Miklos Szeredi 已提交
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
	/* Positive upper -> have to look up lower to see whether it exists */
	for (i = 0; !done && !positive && i < poe->numlower; i++) {
		struct dentry *this;
		struct dentry *lowerdir = poe->lowerstack[i].dentry;

		this = lookup_one_len_unlocked(name->name, lowerdir,
					       name->len);
		if (IS_ERR(this)) {
			switch (PTR_ERR(this)) {
			case -ENOENT:
			case -ENAMETOOLONG:
				break;

			default:
				/*
				 * Assume something is there, we just couldn't
				 * access it.
				 */
				positive = true;
				break;
			}
		} else {
			if (this->d_inode) {
				positive = !ovl_is_whiteout(this);
				done = true;
			}
			dput(this);
		}
	}
1017
	revert_creds(old_cred);
M
Miklos Szeredi 已提交
1018 1019 1020

	return positive;
}