mmap.c 15.7 KB
Newer Older
1 2 3 4 5 6 7 8
/**
 * eCryptfs: Linux filesystem encryption layer
 * This is where eCryptfs coordinates the symmetric encryption and
 * decryption of the file data as it passes between the lower
 * encrypted file and the upper decrypted file.
 *
 * Copyright (C) 1997-2003 Erez Zadok
 * Copyright (C) 2001-2003 Stony Brook University
9
 * Copyright (C) 2004-2007 International Business Machines Corp.
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
 *   Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#include <linux/pagemap.h>
#include <linux/writeback.h>
#include <linux/page-flags.h>
#include <linux/mount.h>
#include <linux/file.h>
#include <linux/scatterlist.h>
34
#include <linux/slab.h>
35
#include <linux/xattr.h>
36
#include <asm/unaligned.h>
37 38 39
#include "ecryptfs_kernel.h"

/**
40
 * ecryptfs_get_locked_page
41 42 43
 *
 * Get one page from cache or lower f/s, return error otherwise.
 *
44
 * Returns locked and up-to-date page (if ok), with increased
45 46
 * refcnt.
 */
47
struct page *ecryptfs_get_locked_page(struct inode *inode, loff_t index)
48
{
49
	struct page *page = read_mapping_page(inode->i_mapping, index, NULL);
50 51 52
	if (!IS_ERR(page))
		lock_page(page);
	return page;
53 54 55 56 57 58 59
}

/**
 * ecryptfs_writepage
 * @page: Page that is locked before this call is made
 *
 * Returns zero on success; non-zero otherwise
60 61 62 63
 *
 * This is where we encrypt the data and pass the encrypted data to
 * the lower filesystem.  In OpenPGP-compatible mode, we operate on
 * entire underlying packets.
64 65 66 67 68
 */
static int ecryptfs_writepage(struct page *page, struct writeback_control *wbc)
{
	int rc;

69
	rc = ecryptfs_encrypt_page(page);
70 71
	if (rc) {
		ecryptfs_printk(KERN_WARNING, "Error encrypting "
72
				"page (upper index [0x%.16lx])\n", page->index);
73 74 75 76 77
		ClearPageUptodate(page);
		goto out;
	}
	SetPageUptodate(page);
out:
78
	unlock_page(page);
79 80 81
	return rc;
}

82 83 84 85 86 87 88 89 90 91 92 93 94
static void strip_xattr_flag(char *page_virt,
			     struct ecryptfs_crypt_stat *crypt_stat)
{
	if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR) {
		size_t written;

		crypt_stat->flags &= ~ECRYPTFS_METADATA_IN_XATTR;
		ecryptfs_write_crypt_stat_flags(page_virt, crypt_stat,
						&written);
		crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
	}
}

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
/**
 *   Header Extent:
 *     Octets 0-7:        Unencrypted file size (big-endian)
 *     Octets 8-15:       eCryptfs special marker
 *     Octets 16-19:      Flags
 *      Octet 16:         File format version number (between 0 and 255)
 *      Octets 17-18:     Reserved
 *      Octet 19:         Bit 1 (lsb): Reserved
 *                        Bit 2: Encrypted?
 *                        Bits 3-8: Reserved
 *     Octets 20-23:      Header extent size (big-endian)
 *     Octets 24-25:      Number of header extents at front of file
 *                        (big-endian)
 *     Octet  26:         Begin RFC 2440 authentication token packet set
 */
110

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
/**
 * ecryptfs_copy_up_encrypted_with_header
 * @page: Sort of a ``virtual'' representation of the encrypted lower
 *        file. The actual lower file does not have the metadata in
 *        the header. This is locked.
 * @crypt_stat: The eCryptfs inode's cryptographic context
 *
 * The ``view'' is the version of the file that userspace winds up
 * seeing, with the header information inserted.
 */
static int
ecryptfs_copy_up_encrypted_with_header(struct page *page,
				       struct ecryptfs_crypt_stat *crypt_stat)
{
	loff_t extent_num_in_page = 0;
126
	loff_t num_extents_per_page = (PAGE_SIZE
127 128 129 130
				       / crypt_stat->extent_size);
	int rc = 0;

	while (extent_num_in_page < num_extents_per_page) {
Michael Halcrow's avatar
Michael Halcrow committed
131 132
		loff_t view_extent_num = ((((loff_t)page->index)
					   * num_extents_per_page)
133
					  + extent_num_in_page);
134
		size_t num_header_extents_at_front =
135
			(crypt_stat->metadata_size / crypt_stat->extent_size);
136

137
		if (view_extent_num < num_header_extents_at_front) {
138 139 140
			/* This is a header extent */
			char *page_virt;

141
			page_virt = kmap_atomic(page);
142
			memset(page_virt, 0, PAGE_SIZE);
143 144
			/* TODO: Support more than one header extent */
			if (view_extent_num == 0) {
145 146
				size_t written;

147 148
				rc = ecryptfs_read_xattr_region(
					page_virt, page->mapping->host);
149
				strip_xattr_flag(page_virt + 16, crypt_stat);
150 151 152
				ecryptfs_write_header_metadata(page_virt + 20,
							       crypt_stat,
							       &written);
153
			}
154
			kunmap_atomic(page_virt);
155 156 157
			flush_dcache_page(page);
			if (rc) {
				printk(KERN_ERR "%s: Error reading xattr "
158
				       "region; rc = [%d]\n", __func__, rc);
159 160 161 162 163
				goto out;
			}
		} else {
			/* This is an encrypted data extent */
			loff_t lower_offset =
164
				((view_extent_num * crypt_stat->extent_size)
165
				 - crypt_stat->metadata_size);
166 167

			rc = ecryptfs_read_lower_page_segment(
168 169
				page, (lower_offset >> PAGE_SHIFT),
				(lower_offset & ~PAGE_MASK),
170 171 172 173
				crypt_stat->extent_size, page->mapping->host);
			if (rc) {
				printk(KERN_ERR "%s: Error attempting to read "
				       "extent at offset [%lld] in the lower "
174
				       "file; rc = [%d]\n", __func__,
175 176 177 178 179 180 181 182 183 184
				       lower_offset, rc);
				goto out;
			}
		}
		extent_num_in_page++;
	}
out:
	return rc;
}

185 186
/**
 * ecryptfs_readpage
187 188
 * @file: An eCryptfs file
 * @page: Page from eCryptfs inode mapping into which to stick the read data
189 190 191 192 193 194 195
 *
 * Read in a page, decrypting if necessary.
 *
 * Returns zero on success; non-zero on error.
 */
static int ecryptfs_readpage(struct file *file, struct page *page)
{
196
	struct ecryptfs_crypt_stat *crypt_stat =
197
		&ecryptfs_inode_to_private(page->mapping->host)->crypt_stat;
198 199
	int rc = 0;

200
	if (!crypt_stat || !(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
201
		rc = ecryptfs_read_lower_page_segment(page, page->index, 0,
202
						      PAGE_SIZE,
203
						      page->mapping->host);
204 205
	} else if (crypt_stat->flags & ECRYPTFS_VIEW_AS_ENCRYPTED) {
		if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR) {
206 207 208 209 210 211 212
			rc = ecryptfs_copy_up_encrypted_with_header(page,
								    crypt_stat);
			if (rc) {
				printk(KERN_ERR "%s: Error attempting to copy "
				       "the encrypted content from the lower "
				       "file whilst inserting the metadata "
				       "from the xattr into the header; rc = "
213
				       "[%d]\n", __func__, rc);
214
				goto out;
215
			}
216

217
		} else {
218
			rc = ecryptfs_read_lower_page_segment(
219
				page, page->index, 0, PAGE_SIZE,
220
				page->mapping->host);
221 222 223 224 225 226
			if (rc) {
				printk(KERN_ERR "Error reading page; rc = "
				       "[%d]\n", rc);
				goto out;
			}
		}
227
	} else {
228
		rc = ecryptfs_decrypt_page(page);
229 230 231 232 233 234 235
		if (rc) {
			ecryptfs_printk(KERN_ERR, "Error decrypting page; "
					"rc = [%d]\n", rc);
			goto out;
		}
	}
out:
236 237 238 239
	if (rc)
		ClearPageUptodate(page);
	else
		SetPageUptodate(page);
240
	ecryptfs_printk(KERN_DEBUG, "Unlocking page with index = [0x%.16lx]\n",
241 242 243 244 245
			page->index);
	unlock_page(page);
	return rc;
}

246 247 248
/**
 * Called with lower inode mutex held.
 */
249 250 251 252 253
static int fill_zeros_to_end_of_page(struct page *page, unsigned int to)
{
	struct inode *inode = page->mapping->host;
	int end_byte_in_page;

254
	if ((i_size_read(inode) / PAGE_SIZE) != page->index)
255
		goto out;
256
	end_byte_in_page = i_size_read(inode) % PAGE_SIZE;
257 258
	if (to > end_byte_in_page)
		end_byte_in_page = to;
259
	zero_user_segment(page, end_byte_in_page, PAGE_SIZE);
260
out:
261
	return 0;
262 263
}

264
/**
265
 * ecryptfs_write_begin
266
 * @file: The eCryptfs file
267 268 269 270 271 272
 * @mapping: The eCryptfs object
 * @pos: The file offset at which to start writing
 * @len: Length of the write
 * @flags: Various flags
 * @pagep: Pointer to return the page
 * @fsdata: Pointer to return fs data (unused)
273 274 275 276 277
 *
 * This function must zero any hole we create
 *
 * Returns zero on success; non-zero otherwise
 */
278 279 280 281
static int ecryptfs_write_begin(struct file *file,
			struct address_space *mapping,
			loff_t pos, unsigned len, unsigned flags,
			struct page **pagep, void **fsdata)
282
{
283
	pgoff_t index = pos >> PAGE_SHIFT;
284
	struct page *page;
285
	loff_t prev_page_end_size;
286
	int rc = 0;
287

288
	page = grab_cache_page_write_begin(mapping, index, flags);
289 290 291 292
	if (!page)
		return -ENOMEM;
	*pagep = page;

293
	prev_page_end_size = ((loff_t)index << PAGE_SHIFT);
294
	if (!PageUptodate(page)) {
295
		struct ecryptfs_crypt_stat *crypt_stat =
296
			&ecryptfs_inode_to_private(mapping->host)->crypt_stat;
297

298
		if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
299
			rc = ecryptfs_read_lower_page_segment(
300
				page, index, 0, PAGE_SIZE, mapping->host);
301
			if (rc) {
Masanari Iida's avatar
Masanari Iida committed
302
				printk(KERN_ERR "%s: Error attempting to read "
303
				       "lower page segment; rc = [%d]\n",
304
				       __func__, rc);
305 306 307 308 309 310 311 312 313 314 315 316 317 318
				ClearPageUptodate(page);
				goto out;
			} else
				SetPageUptodate(page);
		} else if (crypt_stat->flags & ECRYPTFS_VIEW_AS_ENCRYPTED) {
			if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR) {
				rc = ecryptfs_copy_up_encrypted_with_header(
					page, crypt_stat);
				if (rc) {
					printk(KERN_ERR "%s: Error attempting "
					       "to copy the encrypted content "
					       "from the lower file whilst "
					       "inserting the metadata from "
					       "the xattr into the header; rc "
319
					       "= [%d]\n", __func__, rc);
320 321 322 323 324 325
					ClearPageUptodate(page);
					goto out;
				}
				SetPageUptodate(page);
			} else {
				rc = ecryptfs_read_lower_page_segment(
326
					page, index, 0, PAGE_SIZE,
327
					mapping->host);
328 329 330
				if (rc) {
					printk(KERN_ERR "%s: Error reading "
					       "page; rc = [%d]\n",
331
					       __func__, rc);
332 333 334 335 336 337
					ClearPageUptodate(page);
					goto out;
				}
				SetPageUptodate(page);
			}
		} else {
338 339
			if (prev_page_end_size
			    >= i_size_read(page->mapping->host)) {
340
				zero_user(page, 0, PAGE_SIZE);
341
				SetPageUptodate(page);
342
			} else if (len < PAGE_SIZE) {
343 344 345 346 347 348 349 350 351
				rc = ecryptfs_decrypt_page(page);
				if (rc) {
					printk(KERN_ERR "%s: Error decrypting "
					       "page at index [%ld]; "
					       "rc = [%d]\n",
					       __func__, page->index, rc);
					ClearPageUptodate(page);
					goto out;
				}
352
				SetPageUptodate(page);
353 354
			}
		}
355
	}
356 357
	/* If creating a page or more of holes, zero them out via truncate.
	 * Note, this will increase i_size. */
358
	if (index != 0) {
359
		if (prev_page_end_size > i_size_read(page->mapping->host)) {
360
			rc = ecryptfs_truncate(file->f_path.dentry,
361
					       prev_page_end_size);
362
			if (rc) {
363
				printk(KERN_ERR "%s: Error on attempt to "
364
				       "truncate to (higher) offset [%lld];"
365
				       " rc = [%d]\n", __func__,
366
				       prev_page_end_size, rc);
367 368
				goto out;
			}
369
		}
370
	}
371 372
	/* Writing to a new page, and creating a small hole from start
	 * of page?  Zero it out. */
373 374
	if ((i_size_read(mapping->host) == prev_page_end_size)
	    && (pos != 0))
375
		zero_user(page, 0, PAGE_SIZE);
376
out:
377 378
	if (unlikely(rc)) {
		unlock_page(page);
379
		put_page(page);
380 381
		*pagep = NULL;
	}
382 383 384 385 386 387 388 389 390 391
	return rc;
}

/**
 * ecryptfs_write_inode_size_to_header
 *
 * Writes the lower file size to the first 8 bytes of the header.
 *
 * Returns zero on success; non-zero on error.
 */
392
static int ecryptfs_write_inode_size_to_header(struct inode *ecryptfs_inode)
393
{
394 395
	char *file_size_virt;
	int rc;
396

397 398 399
	file_size_virt = kmalloc(sizeof(u64), GFP_KERNEL);
	if (!file_size_virt) {
		rc = -ENOMEM;
400 401
		goto out;
	}
402
	put_unaligned_be64(i_size_read(ecryptfs_inode), file_size_virt);
403 404 405
	rc = ecryptfs_write_lower(ecryptfs_inode, file_size_virt, 0,
				  sizeof(u64));
	kfree(file_size_virt);
406
	if (rc < 0)
407
		printk(KERN_ERR "%s: Error writing file size to header; "
408
		       "rc = [%d]\n", __func__, rc);
409 410
	else
		rc = 0;
411 412 413 414
out:
	return rc;
}

415 416 417
struct kmem_cache *ecryptfs_xattr_cache;

static int ecryptfs_write_inode_size_to_xattr(struct inode *ecryptfs_inode)
418 419 420
{
	ssize_t size;
	void *xattr_virt;
421
	struct dentry *lower_dentry =
Al Viro's avatar
Al Viro committed
422
		ecryptfs_inode_to_private(ecryptfs_inode)->lower_file->f_path.dentry;
423
	struct inode *lower_inode = d_inode(lower_dentry);
424 425
	int rc;

426
	if (!(lower_inode->i_opflags & IOP_XATTR)) {
427 428 429 430 431
		printk(KERN_WARNING
		       "No support for setting xattr in lower filesystem\n");
		rc = -ENOSYS;
		goto out;
	}
432 433 434 435 436
	xattr_virt = kmem_cache_alloc(ecryptfs_xattr_cache, GFP_KERNEL);
	if (!xattr_virt) {
		rc = -ENOMEM;
		goto out;
	}
Al Viro's avatar
Al Viro committed
437
	inode_lock(lower_inode);
438 439
	size = __vfs_getxattr(lower_dentry, lower_inode, ECRYPTFS_XATTR_NAME,
			      xattr_virt, PAGE_SIZE);
440 441
	if (size < 0)
		size = 8;
442
	put_unaligned_be64(i_size_read(ecryptfs_inode), xattr_virt);
443 444
	rc = __vfs_setxattr(lower_dentry, lower_inode, ECRYPTFS_XATTR_NAME,
			    xattr_virt, size, 0);
Al Viro's avatar
Al Viro committed
445
	inode_unlock(lower_inode);
446 447 448 449 450 451 452 453
	if (rc)
		printk(KERN_ERR "Error whilst attempting to write inode size "
		       "to lower file xattr; rc = [%d]\n", rc);
	kmem_cache_free(ecryptfs_xattr_cache, xattr_virt);
out:
	return rc;
}

454
int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode)
455 456 457
{
	struct ecryptfs_crypt_stat *crypt_stat;

458
	crypt_stat = &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
459
	BUG_ON(!(crypt_stat->flags & ECRYPTFS_ENCRYPTED));
460
	if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
461
		return ecryptfs_write_inode_size_to_xattr(ecryptfs_inode);
462
	else
463
		return ecryptfs_write_inode_size_to_header(ecryptfs_inode);
464 465
}

466
/**
467
 * ecryptfs_write_end
468
 * @file: The eCryptfs file object
469 470 471 472
 * @mapping: The eCryptfs object
 * @pos: The file position
 * @len: The length of the data (unused)
 * @copied: The amount of data copied
473
 * @page: The eCryptfs page
474
 * @fsdata: The fsdata (unused)
475
 */
476 477 478 479
static int ecryptfs_write_end(struct file *file,
			struct address_space *mapping,
			loff_t pos, unsigned len, unsigned copied,
			struct page *page, void *fsdata)
480
{
481 482
	pgoff_t index = pos >> PAGE_SHIFT;
	unsigned from = pos & (PAGE_SIZE - 1);
483 484
	unsigned to = from + copied;
	struct inode *ecryptfs_inode = mapping->host;
485
	struct ecryptfs_crypt_stat *crypt_stat =
486
		&ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
487 488 489
	int rc;

	ecryptfs_printk(KERN_DEBUG, "Calling fill_zeros_to_end_of_page"
490
			"(page w/ index = [0x%.16lx], to = [%d])\n", index, to);
491 492 493 494 495 496 497 498 499 500
	if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
		rc = ecryptfs_write_lower_page_segment(ecryptfs_inode, page, 0,
						       to);
		if (!rc) {
			rc = copied;
			fsstack_copy_inode_size(ecryptfs_inode,
				ecryptfs_inode_to_lower(ecryptfs_inode));
		}
		goto out;
	}
501
	if (!PageUptodate(page)) {
502
		if (copied < PAGE_SIZE) {
503 504 505 506 507
			rc = 0;
			goto out;
		}
		SetPageUptodate(page);
	}
508
	/* Fills in zeros if 'to' goes beyond inode size */
509 510 511
	rc = fill_zeros_to_end_of_page(page, to);
	if (rc) {
		ecryptfs_printk(KERN_WARNING, "Error attempting to fill "
512
			"zeros in page with index = [0x%.16lx]\n", index);
513 514
		goto out;
	}
515 516 517 518 519 520
	rc = ecryptfs_encrypt_page(page);
	if (rc) {
		ecryptfs_printk(KERN_WARNING, "Error encrypting page (upper "
				"index [0x%.16lx])\n", index);
		goto out;
	}
521 522
	if (pos + copied > i_size_read(ecryptfs_inode)) {
		i_size_write(ecryptfs_inode, pos + copied);
523
		ecryptfs_printk(KERN_DEBUG, "Expanded file size to "
524 525
			"[0x%.16llx]\n",
			(unsigned long long)i_size_read(ecryptfs_inode));
526
	}
527 528 529 530 531 532
	rc = ecryptfs_write_inode_size_to_metadata(ecryptfs_inode);
	if (rc)
		printk(KERN_ERR "Error writing inode size to metadata; "
		       "rc = [%d]\n", rc);
	else
		rc = copied;
533
out:
534
	unlock_page(page);
535
	put_page(page);
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
	return rc;
}

static sector_t ecryptfs_bmap(struct address_space *mapping, sector_t block)
{
	int rc = 0;
	struct inode *inode;
	struct inode *lower_inode;

	inode = (struct inode *)mapping->host;
	lower_inode = ecryptfs_inode_to_lower(inode);
	if (lower_inode->i_mapping->a_ops->bmap)
		rc = lower_inode->i_mapping->a_ops->bmap(lower_inode->i_mapping,
							 block);
	return rc;
}

553
const struct address_space_operations ecryptfs_aops = {
554 555
	.writepage = ecryptfs_writepage,
	.readpage = ecryptfs_readpage,
556 557
	.write_begin = ecryptfs_write_begin,
	.write_end = ecryptfs_write_end,
558 559
	.bmap = ecryptfs_bmap,
};