Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 1 | /** |
| 2 | * eCryptfs: Linux filesystem encryption layer |
| 3 | * This is where eCryptfs coordinates the symmetric encryption and |
| 4 | * decryption of the file data as it passes between the lower |
| 5 | * encrypted file and the upper decrypted file. |
| 6 | * |
| 7 | * Copyright (C) 1997-2003 Erez Zadok |
| 8 | * Copyright (C) 2001-2003 Stony Brook University |
Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 9 | * Copyright (C) 2004-2007 International Business Machines Corp. |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 10 | * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com> |
| 11 | * |
| 12 | * This program is free software; you can redistribute it and/or |
| 13 | * modify it under the terms of the GNU General Public License as |
| 14 | * published by the Free Software Foundation; either version 2 of the |
| 15 | * License, or (at your option) any later version. |
| 16 | * |
| 17 | * This program is distributed in the hope that it will be useful, but |
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 20 | * General Public License for more details. |
| 21 | * |
| 22 | * You should have received a copy of the GNU General Public License |
| 23 | * along with this program; if not, write to the Free Software |
| 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA |
| 25 | * 02111-1307, USA. |
| 26 | */ |
| 27 | |
| 28 | #include <linux/pagemap.h> |
| 29 | #include <linux/writeback.h> |
| 30 | #include <linux/page-flags.h> |
| 31 | #include <linux/mount.h> |
| 32 | #include <linux/file.h> |
| 33 | #include <linux/crypto.h> |
| 34 | #include <linux/scatterlist.h> |
| 35 | #include "ecryptfs_kernel.h" |
| 36 | |
| 37 | struct kmem_cache *ecryptfs_lower_page_cache; |
| 38 | |
| 39 | /** |
| 40 | * ecryptfs_get1page |
| 41 | * |
| 42 | * Get one page from cache or lower f/s, return error otherwise. |
| 43 | * |
| 44 | * Returns unlocked and up-to-date page (if ok), with increased |
| 45 | * refcnt. |
| 46 | */ |
| 47 | static struct page *ecryptfs_get1page(struct file *file, int index) |
| 48 | { |
| 49 | struct page *page; |
| 50 | struct dentry *dentry; |
| 51 | struct inode *inode; |
| 52 | struct address_space *mapping; |
| 53 | |
Josef "Jeff" Sipek | bd243a4 | 2006-12-08 02:36:48 -0800 | [diff] [blame] | 54 | dentry = file->f_path.dentry; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 55 | inode = dentry->d_inode; |
| 56 | mapping = inode->i_mapping; |
| 57 | page = read_cache_page(mapping, index, |
| 58 | (filler_t *)mapping->a_ops->readpage, |
| 59 | (void *)file); |
| 60 | if (IS_ERR(page)) |
| 61 | goto out; |
| 62 | wait_on_page_locked(page); |
| 63 | out: |
| 64 | return page; |
| 65 | } |
| 66 | |
| 67 | static |
| 68 | int write_zeros(struct file *file, pgoff_t index, int start, int num_zeros); |
| 69 | |
| 70 | /** |
| 71 | * ecryptfs_fill_zeros |
| 72 | * @file: The ecryptfs file |
| 73 | * @new_length: The new length of the data in the underlying file; |
| 74 | * everything between the prior end of the file and the |
| 75 | * new end of the file will be filled with zero's. |
| 76 | * new_length must be greater than current length |
| 77 | * |
| 78 | * Function for handling lseek-ing past the end of the file. |
| 79 | * |
| 80 | * This function does not support shrinking, only growing a file. |
| 81 | * |
| 82 | * Returns zero on success; non-zero otherwise. |
| 83 | */ |
| 84 | int ecryptfs_fill_zeros(struct file *file, loff_t new_length) |
| 85 | { |
| 86 | int rc = 0; |
Josef "Jeff" Sipek | bd243a4 | 2006-12-08 02:36:48 -0800 | [diff] [blame] | 87 | struct dentry *dentry = file->f_path.dentry; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 88 | struct inode *inode = dentry->d_inode; |
| 89 | pgoff_t old_end_page_index = 0; |
| 90 | pgoff_t index = old_end_page_index; |
| 91 | int old_end_pos_in_page = -1; |
| 92 | pgoff_t new_end_page_index; |
| 93 | int new_end_pos_in_page; |
| 94 | loff_t cur_length = i_size_read(inode); |
| 95 | |
| 96 | if (cur_length != 0) { |
| 97 | index = old_end_page_index = |
| 98 | ((cur_length - 1) >> PAGE_CACHE_SHIFT); |
| 99 | old_end_pos_in_page = ((cur_length - 1) & ~PAGE_CACHE_MASK); |
| 100 | } |
| 101 | new_end_page_index = ((new_length - 1) >> PAGE_CACHE_SHIFT); |
| 102 | new_end_pos_in_page = ((new_length - 1) & ~PAGE_CACHE_MASK); |
| 103 | ecryptfs_printk(KERN_DEBUG, "old_end_page_index = [0x%.16x]; " |
| 104 | "old_end_pos_in_page = [%d]; " |
| 105 | "new_end_page_index = [0x%.16x]; " |
| 106 | "new_end_pos_in_page = [%d]\n", |
| 107 | old_end_page_index, old_end_pos_in_page, |
| 108 | new_end_page_index, new_end_pos_in_page); |
| 109 | if (old_end_page_index == new_end_page_index) { |
| 110 | /* Start and end are in the same page; we just need to |
| 111 | * set a portion of the existing page to zero's */ |
| 112 | rc = write_zeros(file, index, (old_end_pos_in_page + 1), |
| 113 | (new_end_pos_in_page - old_end_pos_in_page)); |
| 114 | if (rc) |
| 115 | ecryptfs_printk(KERN_ERR, "write_zeros(file=[%p], " |
| 116 | "index=[0x%.16x], " |
| 117 | "old_end_pos_in_page=[d], " |
| 118 | "(PAGE_CACHE_SIZE - new_end_pos_in_page" |
| 119 | "=[%d]" |
| 120 | ")=[d]) returned [%d]\n", file, index, |
| 121 | old_end_pos_in_page, |
| 122 | new_end_pos_in_page, |
| 123 | (PAGE_CACHE_SIZE - new_end_pos_in_page), |
| 124 | rc); |
| 125 | goto out; |
| 126 | } |
| 127 | /* Fill the remainder of the previous last page with zeros */ |
| 128 | rc = write_zeros(file, index, (old_end_pos_in_page + 1), |
| 129 | ((PAGE_CACHE_SIZE - 1) - old_end_pos_in_page)); |
| 130 | if (rc) { |
| 131 | ecryptfs_printk(KERN_ERR, "write_zeros(file=[%p], " |
| 132 | "index=[0x%.16x], old_end_pos_in_page=[d], " |
| 133 | "(PAGE_CACHE_SIZE - old_end_pos_in_page)=[d]) " |
| 134 | "returned [%d]\n", file, index, |
| 135 | old_end_pos_in_page, |
| 136 | (PAGE_CACHE_SIZE - old_end_pos_in_page), rc); |
| 137 | goto out; |
| 138 | } |
| 139 | index++; |
| 140 | while (index < new_end_page_index) { |
| 141 | /* Fill all intermediate pages with zeros */ |
| 142 | rc = write_zeros(file, index, 0, PAGE_CACHE_SIZE); |
| 143 | if (rc) { |
| 144 | ecryptfs_printk(KERN_ERR, "write_zeros(file=[%p], " |
| 145 | "index=[0x%.16x], " |
| 146 | "old_end_pos_in_page=[d], " |
| 147 | "(PAGE_CACHE_SIZE - new_end_pos_in_page" |
| 148 | "=[%d]" |
| 149 | ")=[d]) returned [%d]\n", file, index, |
| 150 | old_end_pos_in_page, |
| 151 | new_end_pos_in_page, |
| 152 | (PAGE_CACHE_SIZE - new_end_pos_in_page), |
| 153 | rc); |
| 154 | goto out; |
| 155 | } |
| 156 | index++; |
| 157 | } |
| 158 | /* Fill the portion at the beginning of the last new page with |
| 159 | * zero's */ |
| 160 | rc = write_zeros(file, index, 0, (new_end_pos_in_page + 1)); |
| 161 | if (rc) { |
| 162 | ecryptfs_printk(KERN_ERR, "write_zeros(file=" |
| 163 | "[%p], index=[0x%.16x], 0, " |
| 164 | "new_end_pos_in_page=[%d]" |
| 165 | "returned [%d]\n", file, index, |
| 166 | new_end_pos_in_page, rc); |
| 167 | goto out; |
| 168 | } |
| 169 | out: |
| 170 | return rc; |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * ecryptfs_writepage |
| 175 | * @page: Page that is locked before this call is made |
| 176 | * |
| 177 | * Returns zero on success; non-zero otherwise |
| 178 | */ |
| 179 | static int ecryptfs_writepage(struct page *page, struct writeback_control *wbc) |
| 180 | { |
| 181 | struct ecryptfs_page_crypt_context ctx; |
| 182 | int rc; |
| 183 | |
| 184 | ctx.page = page; |
| 185 | ctx.mode = ECRYPTFS_WRITEPAGE_MODE; |
| 186 | ctx.param.wbc = wbc; |
| 187 | rc = ecryptfs_encrypt_page(&ctx); |
| 188 | if (rc) { |
| 189 | ecryptfs_printk(KERN_WARNING, "Error encrypting " |
| 190 | "page (upper index [0x%.16x])\n", page->index); |
| 191 | ClearPageUptodate(page); |
| 192 | goto out; |
| 193 | } |
| 194 | SetPageUptodate(page); |
| 195 | unlock_page(page); |
| 196 | out: |
| 197 | return rc; |
| 198 | } |
| 199 | |
| 200 | /** |
| 201 | * Reads the data from the lower file file at index lower_page_index |
| 202 | * and copies that data into page. |
| 203 | * |
| 204 | * @param page Page to fill |
| 205 | * @param lower_page_index Index of the page in the lower file to get |
| 206 | */ |
| 207 | int ecryptfs_do_readpage(struct file *file, struct page *page, |
| 208 | pgoff_t lower_page_index) |
| 209 | { |
| 210 | int rc; |
| 211 | struct dentry *dentry; |
| 212 | struct file *lower_file; |
| 213 | struct dentry *lower_dentry; |
| 214 | struct inode *inode; |
| 215 | struct inode *lower_inode; |
| 216 | char *page_data; |
| 217 | struct page *lower_page = NULL; |
| 218 | char *lower_page_data; |
| 219 | const struct address_space_operations *lower_a_ops; |
| 220 | |
Josef "Jeff" Sipek | bd243a4 | 2006-12-08 02:36:48 -0800 | [diff] [blame] | 221 | dentry = file->f_path.dentry; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 222 | lower_file = ecryptfs_file_to_lower(file); |
| 223 | lower_dentry = ecryptfs_dentry_to_lower(dentry); |
| 224 | inode = dentry->d_inode; |
| 225 | lower_inode = ecryptfs_inode_to_lower(inode); |
| 226 | lower_a_ops = lower_inode->i_mapping->a_ops; |
| 227 | lower_page = read_cache_page(lower_inode->i_mapping, lower_page_index, |
| 228 | (filler_t *)lower_a_ops->readpage, |
| 229 | (void *)lower_file); |
| 230 | if (IS_ERR(lower_page)) { |
| 231 | rc = PTR_ERR(lower_page); |
| 232 | lower_page = NULL; |
| 233 | ecryptfs_printk(KERN_ERR, "Error reading from page cache\n"); |
| 234 | goto out; |
| 235 | } |
| 236 | wait_on_page_locked(lower_page); |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 237 | page_data = kmap_atomic(page, KM_USER0); |
| 238 | lower_page_data = kmap_atomic(lower_page, KM_USER1); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 239 | memcpy(page_data, lower_page_data, PAGE_CACHE_SIZE); |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 240 | kunmap_atomic(lower_page_data, KM_USER1); |
| 241 | kunmap_atomic(page_data, KM_USER0); |
Michael Halcrow | 0a9ac38 | 2007-02-12 00:53:50 -0800 | [diff] [blame] | 242 | flush_dcache_page(page); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 243 | rc = 0; |
| 244 | out: |
| 245 | if (likely(lower_page)) |
| 246 | page_cache_release(lower_page); |
| 247 | if (rc == 0) |
| 248 | SetPageUptodate(page); |
| 249 | else |
| 250 | ClearPageUptodate(page); |
| 251 | return rc; |
| 252 | } |
Michael Halcrow | e77a56d | 2007-02-12 00:53:47 -0800 | [diff] [blame] | 253 | /** |
| 254 | * Header Extent: |
| 255 | * Octets 0-7: Unencrypted file size (big-endian) |
| 256 | * Octets 8-15: eCryptfs special marker |
| 257 | * Octets 16-19: Flags |
| 258 | * Octet 16: File format version number (between 0 and 255) |
| 259 | * Octets 17-18: Reserved |
| 260 | * Octet 19: Bit 1 (lsb): Reserved |
| 261 | * Bit 2: Encrypted? |
| 262 | * Bits 3-8: Reserved |
| 263 | * Octets 20-23: Header extent size (big-endian) |
| 264 | * Octets 24-25: Number of header extents at front of file |
| 265 | * (big-endian) |
| 266 | * Octet 26: Begin RFC 2440 authentication token packet set |
| 267 | */ |
| 268 | static void set_header_info(char *page_virt, |
| 269 | struct ecryptfs_crypt_stat *crypt_stat) |
| 270 | { |
| 271 | size_t written; |
| 272 | int save_num_header_extents_at_front = |
| 273 | crypt_stat->num_header_extents_at_front; |
| 274 | |
| 275 | crypt_stat->num_header_extents_at_front = 1; |
| 276 | ecryptfs_write_header_metadata(page_virt + 20, crypt_stat, &written); |
| 277 | crypt_stat->num_header_extents_at_front = |
| 278 | save_num_header_extents_at_front; |
| 279 | } |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 280 | |
| 281 | /** |
| 282 | * ecryptfs_readpage |
| 283 | * @file: This is an ecryptfs file |
| 284 | * @page: ecryptfs associated page to stick the read data into |
| 285 | * |
| 286 | * Read in a page, decrypting if necessary. |
| 287 | * |
| 288 | * Returns zero on success; non-zero on error. |
| 289 | */ |
| 290 | static int ecryptfs_readpage(struct file *file, struct page *page) |
| 291 | { |
| 292 | int rc = 0; |
| 293 | struct ecryptfs_crypt_stat *crypt_stat; |
| 294 | |
Josef "Jeff" Sipek | bd243a4 | 2006-12-08 02:36:48 -0800 | [diff] [blame] | 295 | BUG_ON(!(file && file->f_path.dentry && file->f_path.dentry->d_inode)); |
| 296 | crypt_stat = &ecryptfs_inode_to_private(file->f_path.dentry->d_inode) |
| 297 | ->crypt_stat; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 298 | if (!crypt_stat |
Michael Halcrow | e2bd99e | 2007-02-12 00:53:49 -0800 | [diff] [blame] | 299 | || !(crypt_stat->flags & ECRYPTFS_ENCRYPTED) |
| 300 | || (crypt_stat->flags & ECRYPTFS_NEW_FILE)) { |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 301 | ecryptfs_printk(KERN_DEBUG, |
| 302 | "Passing through unencrypted page\n"); |
| 303 | rc = ecryptfs_do_readpage(file, page, page->index); |
| 304 | if (rc) { |
| 305 | ecryptfs_printk(KERN_ERR, "Error reading page; rc = " |
| 306 | "[%d]\n", rc); |
| 307 | goto out; |
| 308 | } |
Michael Halcrow | e77a56d | 2007-02-12 00:53:47 -0800 | [diff] [blame] | 309 | } else if (crypt_stat->flags & ECRYPTFS_VIEW_AS_ENCRYPTED) { |
| 310 | if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR) { |
| 311 | int num_pages_in_header_region = |
| 312 | (crypt_stat->header_extent_size |
| 313 | / PAGE_CACHE_SIZE); |
| 314 | |
| 315 | if (page->index < num_pages_in_header_region) { |
| 316 | char *page_virt; |
| 317 | |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 318 | page_virt = kmap_atomic(page, KM_USER0); |
Michael Halcrow | e77a56d | 2007-02-12 00:53:47 -0800 | [diff] [blame] | 319 | memset(page_virt, 0, PAGE_CACHE_SIZE); |
| 320 | if (page->index == 0) { |
| 321 | rc = ecryptfs_read_xattr_region( |
| 322 | page_virt, file->f_path.dentry); |
| 323 | set_header_info(page_virt, crypt_stat); |
| 324 | } |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 325 | kunmap_atomic(page_virt, KM_USER0); |
Michael Halcrow | 0a9ac38 | 2007-02-12 00:53:50 -0800 | [diff] [blame] | 326 | flush_dcache_page(page); |
Michael Halcrow | e77a56d | 2007-02-12 00:53:47 -0800 | [diff] [blame] | 327 | if (rc) { |
| 328 | printk(KERN_ERR "Error reading xattr " |
| 329 | "region\n"); |
| 330 | goto out; |
| 331 | } |
| 332 | } else { |
| 333 | rc = ecryptfs_do_readpage( |
| 334 | file, page, |
| 335 | (page->index |
| 336 | - num_pages_in_header_region)); |
| 337 | if (rc) { |
| 338 | printk(KERN_ERR "Error reading page; " |
| 339 | "rc = [%d]\n", rc); |
| 340 | goto out; |
| 341 | } |
| 342 | } |
| 343 | } else { |
| 344 | rc = ecryptfs_do_readpage(file, page, page->index); |
| 345 | if (rc) { |
| 346 | printk(KERN_ERR "Error reading page; rc = " |
| 347 | "[%d]\n", rc); |
| 348 | goto out; |
| 349 | } |
| 350 | } |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 351 | } else { |
| 352 | rc = ecryptfs_decrypt_page(file, page); |
| 353 | if (rc) { |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 354 | ecryptfs_printk(KERN_ERR, "Error decrypting page; " |
| 355 | "rc = [%d]\n", rc); |
| 356 | goto out; |
| 357 | } |
| 358 | } |
| 359 | SetPageUptodate(page); |
| 360 | out: |
| 361 | if (rc) |
| 362 | ClearPageUptodate(page); |
| 363 | ecryptfs_printk(KERN_DEBUG, "Unlocking page with index = [0x%.16x]\n", |
| 364 | page->index); |
| 365 | unlock_page(page); |
| 366 | return rc; |
| 367 | } |
| 368 | |
Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 369 | /** |
| 370 | * Called with lower inode mutex held. |
| 371 | */ |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 372 | static int fill_zeros_to_end_of_page(struct page *page, unsigned int to) |
| 373 | { |
| 374 | struct inode *inode = page->mapping->host; |
| 375 | int end_byte_in_page; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 376 | char *page_virt; |
| 377 | |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 378 | if ((i_size_read(inode) / PAGE_CACHE_SIZE) != page->index) |
| 379 | goto out; |
| 380 | end_byte_in_page = i_size_read(inode) % PAGE_CACHE_SIZE; |
| 381 | if (to > end_byte_in_page) |
| 382 | end_byte_in_page = to; |
| 383 | page_virt = kmap_atomic(page, KM_USER0); |
| 384 | memset((page_virt + end_byte_in_page), 0, |
| 385 | (PAGE_CACHE_SIZE - end_byte_in_page)); |
| 386 | kunmap_atomic(page_virt, KM_USER0); |
Michael Halcrow | 0a9ac38 | 2007-02-12 00:53:50 -0800 | [diff] [blame] | 387 | flush_dcache_page(page); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 388 | out: |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 389 | return 0; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 390 | } |
| 391 | |
| 392 | static int ecryptfs_prepare_write(struct file *file, struct page *page, |
| 393 | unsigned from, unsigned to) |
| 394 | { |
| 395 | int rc = 0; |
| 396 | |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 397 | if (from == 0 && to == PAGE_CACHE_SIZE) |
| 398 | goto out; /* If we are writing a full page, it will be |
| 399 | up to date. */ |
| 400 | if (!PageUptodate(page)) |
| 401 | rc = ecryptfs_do_readpage(file, page, page->index); |
| 402 | out: |
| 403 | return rc; |
| 404 | } |
| 405 | |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 406 | int ecryptfs_writepage_and_release_lower_page(struct page *lower_page, |
| 407 | struct inode *lower_inode, |
| 408 | struct writeback_control *wbc) |
| 409 | { |
| 410 | int rc = 0; |
| 411 | |
| 412 | rc = lower_inode->i_mapping->a_ops->writepage(lower_page, wbc); |
| 413 | if (rc) { |
| 414 | ecryptfs_printk(KERN_ERR, "Error calling lower writepage(); " |
| 415 | "rc = [%d]\n", rc); |
| 416 | goto out; |
| 417 | } |
| 418 | lower_inode->i_mtime = lower_inode->i_ctime = CURRENT_TIME; |
| 419 | page_cache_release(lower_page); |
| 420 | out: |
| 421 | return rc; |
| 422 | } |
| 423 | |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 424 | static |
| 425 | void ecryptfs_release_lower_page(struct page *lower_page, int page_locked) |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 426 | { |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 427 | if (page_locked) |
| 428 | unlock_page(lower_page); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 429 | page_cache_release(lower_page); |
| 430 | } |
| 431 | |
| 432 | /** |
| 433 | * ecryptfs_write_inode_size_to_header |
| 434 | * |
| 435 | * Writes the lower file size to the first 8 bytes of the header. |
| 436 | * |
| 437 | * Returns zero on success; non-zero on error. |
| 438 | */ |
Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 439 | static int ecryptfs_write_inode_size_to_header(struct file *lower_file, |
| 440 | struct inode *lower_inode, |
| 441 | struct inode *inode) |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 442 | { |
| 443 | int rc = 0; |
| 444 | struct page *header_page; |
| 445 | char *header_virt; |
| 446 | const struct address_space_operations *lower_a_ops; |
| 447 | u64 file_size; |
| 448 | |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 449 | header_page = grab_cache_page(lower_inode->i_mapping, 0); |
| 450 | if (!header_page) { |
| 451 | ecryptfs_printk(KERN_ERR, "grab_cache_page for " |
| 452 | "lower_page_index 0 failed\n"); |
| 453 | rc = -EINVAL; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 454 | goto out; |
| 455 | } |
| 456 | lower_a_ops = lower_inode->i_mapping->a_ops; |
| 457 | rc = lower_a_ops->prepare_write(lower_file, header_page, 0, 8); |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 458 | if (rc) { |
| 459 | if (rc == AOP_TRUNCATED_PAGE) |
| 460 | ecryptfs_release_lower_page(header_page, 0); |
| 461 | else |
| 462 | ecryptfs_release_lower_page(header_page, 1); |
| 463 | goto out; |
| 464 | } |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 465 | file_size = (u64)i_size_read(inode); |
| 466 | ecryptfs_printk(KERN_DEBUG, "Writing size: [0x%.16x]\n", file_size); |
| 467 | file_size = cpu_to_be64(file_size); |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 468 | header_virt = kmap_atomic(header_page, KM_USER0); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 469 | memcpy(header_virt, &file_size, sizeof(u64)); |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 470 | kunmap_atomic(header_virt, KM_USER0); |
Michael Halcrow | 0a9ac38 | 2007-02-12 00:53:50 -0800 | [diff] [blame] | 471 | flush_dcache_page(header_page); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 472 | rc = lower_a_ops->commit_write(lower_file, header_page, 0, 8); |
| 473 | if (rc < 0) |
| 474 | ecryptfs_printk(KERN_ERR, "Error commiting header page " |
| 475 | "write\n"); |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 476 | if (rc == AOP_TRUNCATED_PAGE) |
| 477 | ecryptfs_release_lower_page(header_page, 0); |
| 478 | else |
| 479 | ecryptfs_release_lower_page(header_page, 1); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 480 | lower_inode->i_mtime = lower_inode->i_ctime = CURRENT_TIME; |
| 481 | mark_inode_dirty_sync(inode); |
| 482 | out: |
| 483 | return rc; |
| 484 | } |
| 485 | |
Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 486 | static int ecryptfs_write_inode_size_to_xattr(struct inode *lower_inode, |
| 487 | struct inode *inode, |
| 488 | struct dentry *ecryptfs_dentry, |
| 489 | int lower_i_mutex_held) |
| 490 | { |
| 491 | ssize_t size; |
| 492 | void *xattr_virt; |
| 493 | struct dentry *lower_dentry; |
| 494 | u64 file_size; |
| 495 | int rc; |
| 496 | |
| 497 | xattr_virt = kmem_cache_alloc(ecryptfs_xattr_cache, GFP_KERNEL); |
| 498 | if (!xattr_virt) { |
| 499 | printk(KERN_ERR "Out of memory whilst attempting to write " |
| 500 | "inode size to xattr\n"); |
| 501 | rc = -ENOMEM; |
| 502 | goto out; |
| 503 | } |
| 504 | lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry); |
Dmitriy Monakhov | ad5f119 | 2007-03-05 00:30:12 -0800 | [diff] [blame^] | 505 | if (!lower_dentry->d_inode->i_op->getxattr || |
| 506 | !lower_dentry->d_inode->i_op->setxattr) { |
Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 507 | printk(KERN_WARNING |
| 508 | "No support for setting xattr in lower filesystem\n"); |
| 509 | rc = -ENOSYS; |
| 510 | kmem_cache_free(ecryptfs_xattr_cache, xattr_virt); |
| 511 | goto out; |
| 512 | } |
| 513 | if (!lower_i_mutex_held) |
| 514 | mutex_lock(&lower_dentry->d_inode->i_mutex); |
| 515 | size = lower_dentry->d_inode->i_op->getxattr(lower_dentry, |
| 516 | ECRYPTFS_XATTR_NAME, |
| 517 | xattr_virt, |
| 518 | PAGE_CACHE_SIZE); |
| 519 | if (!lower_i_mutex_held) |
| 520 | mutex_unlock(&lower_dentry->d_inode->i_mutex); |
| 521 | if (size < 0) |
| 522 | size = 8; |
| 523 | file_size = (u64)i_size_read(inode); |
| 524 | file_size = cpu_to_be64(file_size); |
| 525 | memcpy(xattr_virt, &file_size, sizeof(u64)); |
| 526 | if (!lower_i_mutex_held) |
| 527 | mutex_lock(&lower_dentry->d_inode->i_mutex); |
| 528 | rc = lower_dentry->d_inode->i_op->setxattr(lower_dentry, |
| 529 | ECRYPTFS_XATTR_NAME, |
| 530 | xattr_virt, size, 0); |
| 531 | if (!lower_i_mutex_held) |
| 532 | mutex_unlock(&lower_dentry->d_inode->i_mutex); |
| 533 | if (rc) |
| 534 | printk(KERN_ERR "Error whilst attempting to write inode size " |
| 535 | "to lower file xattr; rc = [%d]\n", rc); |
| 536 | kmem_cache_free(ecryptfs_xattr_cache, xattr_virt); |
| 537 | out: |
| 538 | return rc; |
| 539 | } |
| 540 | |
| 541 | int |
| 542 | ecryptfs_write_inode_size_to_metadata(struct file *lower_file, |
| 543 | struct inode *lower_inode, |
| 544 | struct inode *inode, |
| 545 | struct dentry *ecryptfs_dentry, |
| 546 | int lower_i_mutex_held) |
| 547 | { |
| 548 | struct ecryptfs_crypt_stat *crypt_stat; |
| 549 | |
| 550 | crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat; |
| 551 | if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR) |
| 552 | return ecryptfs_write_inode_size_to_xattr(lower_inode, inode, |
| 553 | ecryptfs_dentry, |
| 554 | lower_i_mutex_held); |
| 555 | else |
| 556 | return ecryptfs_write_inode_size_to_header(lower_file, |
| 557 | lower_inode, |
| 558 | inode); |
| 559 | } |
| 560 | |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 561 | int ecryptfs_get_lower_page(struct page **lower_page, struct inode *lower_inode, |
| 562 | struct file *lower_file, |
| 563 | unsigned long lower_page_index, int byte_offset, |
| 564 | int region_bytes) |
| 565 | { |
| 566 | int rc = 0; |
| 567 | |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 568 | *lower_page = grab_cache_page(lower_inode->i_mapping, lower_page_index); |
| 569 | if (!(*lower_page)) { |
| 570 | rc = -EINVAL; |
| 571 | ecryptfs_printk(KERN_ERR, "Error attempting to grab " |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 572 | "lower page with index [0x%.16x]\n", |
| 573 | lower_page_index); |
| 574 | goto out; |
| 575 | } |
| 576 | rc = lower_inode->i_mapping->a_ops->prepare_write(lower_file, |
| 577 | (*lower_page), |
| 578 | byte_offset, |
| 579 | region_bytes); |
| 580 | if (rc) { |
| 581 | ecryptfs_printk(KERN_ERR, "prepare_write for " |
| 582 | "lower_page_index = [0x%.16x] failed; rc = " |
| 583 | "[%d]\n", lower_page_index, rc); |
| 584 | } |
| 585 | out: |
| 586 | if (rc && (*lower_page)) { |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 587 | if (rc == AOP_TRUNCATED_PAGE) |
| 588 | ecryptfs_release_lower_page(*lower_page, 0); |
| 589 | else |
| 590 | ecryptfs_release_lower_page(*lower_page, 1); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 591 | (*lower_page) = NULL; |
| 592 | } |
| 593 | return rc; |
| 594 | } |
| 595 | |
| 596 | /** |
| 597 | * ecryptfs_commit_lower_page |
| 598 | * |
| 599 | * Returns zero on success; non-zero on error |
| 600 | */ |
| 601 | int |
| 602 | ecryptfs_commit_lower_page(struct page *lower_page, struct inode *lower_inode, |
| 603 | struct file *lower_file, int byte_offset, |
| 604 | int region_size) |
| 605 | { |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 606 | int page_locked = 1; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 607 | int rc = 0; |
| 608 | |
| 609 | rc = lower_inode->i_mapping->a_ops->commit_write( |
| 610 | lower_file, lower_page, byte_offset, region_size); |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 611 | if (rc == AOP_TRUNCATED_PAGE) |
| 612 | page_locked = 0; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 613 | if (rc < 0) { |
| 614 | ecryptfs_printk(KERN_ERR, |
| 615 | "Error committing write; rc = [%d]\n", rc); |
| 616 | } else |
| 617 | rc = 0; |
Michael Halcrow | ae73fc0 | 2007-02-28 20:12:16 -0800 | [diff] [blame] | 618 | ecryptfs_release_lower_page(lower_page, page_locked); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 619 | return rc; |
| 620 | } |
| 621 | |
| 622 | /** |
| 623 | * ecryptfs_copy_page_to_lower |
| 624 | * |
| 625 | * Used for plaintext pass-through; no page index interpolation |
| 626 | * required. |
| 627 | */ |
| 628 | int ecryptfs_copy_page_to_lower(struct page *page, struct inode *lower_inode, |
| 629 | struct file *lower_file) |
| 630 | { |
| 631 | int rc = 0; |
| 632 | struct page *lower_page; |
| 633 | |
| 634 | rc = ecryptfs_get_lower_page(&lower_page, lower_inode, lower_file, |
| 635 | page->index, 0, PAGE_CACHE_SIZE); |
| 636 | if (rc) { |
| 637 | ecryptfs_printk(KERN_ERR, "Error attempting to get page " |
| 638 | "at index [0x%.16x]\n", page->index); |
| 639 | goto out; |
| 640 | } |
| 641 | /* TODO: aops */ |
| 642 | memcpy((char *)page_address(lower_page), page_address(page), |
| 643 | PAGE_CACHE_SIZE); |
| 644 | rc = ecryptfs_commit_lower_page(lower_page, lower_inode, lower_file, |
| 645 | 0, PAGE_CACHE_SIZE); |
| 646 | if (rc) |
| 647 | ecryptfs_printk(KERN_ERR, "Error attempting to commit page " |
| 648 | "at index [0x%.16x]\n", page->index); |
| 649 | out: |
| 650 | return rc; |
| 651 | } |
| 652 | |
Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 653 | struct kmem_cache *ecryptfs_xattr_cache; |
| 654 | |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 655 | /** |
| 656 | * ecryptfs_commit_write |
| 657 | * @file: The eCryptfs file object |
| 658 | * @page: The eCryptfs page |
| 659 | * @from: Ignored (we rotate the page IV on each write) |
| 660 | * @to: Ignored |
| 661 | * |
| 662 | * This is where we encrypt the data and pass the encrypted data to |
| 663 | * the lower filesystem. In OpenPGP-compatible mode, we operate on |
| 664 | * entire underlying packets. |
| 665 | */ |
| 666 | static int ecryptfs_commit_write(struct file *file, struct page *page, |
| 667 | unsigned from, unsigned to) |
| 668 | { |
| 669 | struct ecryptfs_page_crypt_context ctx; |
| 670 | loff_t pos; |
| 671 | struct inode *inode; |
| 672 | struct inode *lower_inode; |
| 673 | struct file *lower_file; |
| 674 | struct ecryptfs_crypt_stat *crypt_stat; |
| 675 | int rc; |
| 676 | |
| 677 | inode = page->mapping->host; |
| 678 | lower_inode = ecryptfs_inode_to_lower(inode); |
| 679 | lower_file = ecryptfs_file_to_lower(file); |
| 680 | mutex_lock(&lower_inode->i_mutex); |
Josef "Jeff" Sipek | bd243a4 | 2006-12-08 02:36:48 -0800 | [diff] [blame] | 681 | crypt_stat = &ecryptfs_inode_to_private(file->f_path.dentry->d_inode) |
| 682 | ->crypt_stat; |
Michael Halcrow | e2bd99e | 2007-02-12 00:53:49 -0800 | [diff] [blame] | 683 | if (crypt_stat->flags & ECRYPTFS_NEW_FILE) { |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 684 | ecryptfs_printk(KERN_DEBUG, "ECRYPTFS_NEW_FILE flag set in " |
| 685 | "crypt_stat at memory location [%p]\n", crypt_stat); |
Michael Halcrow | e2bd99e | 2007-02-12 00:53:49 -0800 | [diff] [blame] | 686 | crypt_stat->flags &= ~(ECRYPTFS_NEW_FILE); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 687 | } else |
| 688 | ecryptfs_printk(KERN_DEBUG, "Not a new file\n"); |
| 689 | ecryptfs_printk(KERN_DEBUG, "Calling fill_zeros_to_end_of_page" |
| 690 | "(page w/ index = [0x%.16x], to = [%d])\n", page->index, |
| 691 | to); |
| 692 | rc = fill_zeros_to_end_of_page(page, to); |
| 693 | if (rc) { |
| 694 | ecryptfs_printk(KERN_WARNING, "Error attempting to fill " |
| 695 | "zeros in page with index = [0x%.16x]\n", |
| 696 | page->index); |
| 697 | goto out; |
| 698 | } |
| 699 | ctx.page = page; |
| 700 | ctx.mode = ECRYPTFS_PREPARE_COMMIT_MODE; |
| 701 | ctx.param.lower_file = lower_file; |
| 702 | rc = ecryptfs_encrypt_page(&ctx); |
| 703 | if (rc) { |
| 704 | ecryptfs_printk(KERN_WARNING, "Error encrypting page (upper " |
| 705 | "index [0x%.16x])\n", page->index); |
| 706 | goto out; |
| 707 | } |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 708 | inode->i_blocks = lower_inode->i_blocks; |
| 709 | pos = (page->index << PAGE_CACHE_SHIFT) + to; |
| 710 | if (pos > i_size_read(inode)) { |
| 711 | i_size_write(inode, pos); |
| 712 | ecryptfs_printk(KERN_DEBUG, "Expanded file size to " |
| 713 | "[0x%.16x]\n", i_size_read(inode)); |
| 714 | } |
Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 715 | rc = ecryptfs_write_inode_size_to_metadata(lower_file, lower_inode, |
| 716 | inode, file->f_dentry, |
| 717 | ECRYPTFS_LOWER_I_MUTEX_HELD); |
| 718 | if (rc) |
| 719 | printk(KERN_ERR "Error writing inode size to metadata; " |
| 720 | "rc = [%d]\n", rc); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 721 | lower_inode->i_mtime = lower_inode->i_ctime = CURRENT_TIME; |
| 722 | mark_inode_dirty_sync(inode); |
| 723 | out: |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 724 | if (rc < 0) |
| 725 | ClearPageUptodate(page); |
| 726 | else |
| 727 | SetPageUptodate(page); |
| 728 | mutex_unlock(&lower_inode->i_mutex); |
| 729 | return rc; |
| 730 | } |
| 731 | |
| 732 | /** |
| 733 | * write_zeros |
| 734 | * @file: The ecryptfs file |
| 735 | * @index: The index in which we are writing |
| 736 | * @start: The position after the last block of data |
| 737 | * @num_zeros: The number of zeros to write |
| 738 | * |
| 739 | * Write a specified number of zero's to a page. |
| 740 | * |
| 741 | * (start + num_zeros) must be less than or equal to PAGE_CACHE_SIZE |
| 742 | */ |
| 743 | static |
| 744 | int write_zeros(struct file *file, pgoff_t index, int start, int num_zeros) |
| 745 | { |
| 746 | int rc = 0; |
| 747 | struct page *tmp_page; |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 748 | char *tmp_page_virt; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 749 | |
| 750 | tmp_page = ecryptfs_get1page(file, index); |
| 751 | if (IS_ERR(tmp_page)) { |
| 752 | ecryptfs_printk(KERN_ERR, "Error getting page at index " |
| 753 | "[0x%.16x]\n", index); |
| 754 | rc = PTR_ERR(tmp_page); |
| 755 | goto out; |
| 756 | } |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 757 | rc = ecryptfs_prepare_write(file, tmp_page, start, start + num_zeros); |
| 758 | if (rc) { |
| 759 | ecryptfs_printk(KERN_ERR, "Error preparing to write zero's " |
| 760 | "to remainder of page at index [0x%.16x]\n", |
| 761 | index); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 762 | page_cache_release(tmp_page); |
| 763 | goto out; |
| 764 | } |
Michael Halcrow | 9d8b8ce | 2007-02-12 00:53:48 -0800 | [diff] [blame] | 765 | tmp_page_virt = kmap_atomic(tmp_page, KM_USER0); |
| 766 | memset(((char *)tmp_page_virt + start), 0, num_zeros); |
| 767 | kunmap_atomic(tmp_page_virt, KM_USER0); |
Michael Halcrow | 0a9ac38 | 2007-02-12 00:53:50 -0800 | [diff] [blame] | 768 | flush_dcache_page(tmp_page); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 769 | rc = ecryptfs_commit_write(file, tmp_page, start, start + num_zeros); |
| 770 | if (rc < 0) { |
| 771 | ecryptfs_printk(KERN_ERR, "Error attempting to write zero's " |
| 772 | "to remainder of page at index [0x%.16x]\n", |
| 773 | index); |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 774 | page_cache_release(tmp_page); |
| 775 | goto out; |
| 776 | } |
| 777 | rc = 0; |
Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 778 | page_cache_release(tmp_page); |
| 779 | out: |
| 780 | return rc; |
| 781 | } |
| 782 | |
| 783 | static sector_t ecryptfs_bmap(struct address_space *mapping, sector_t block) |
| 784 | { |
| 785 | int rc = 0; |
| 786 | struct inode *inode; |
| 787 | struct inode *lower_inode; |
| 788 | |
| 789 | inode = (struct inode *)mapping->host; |
| 790 | lower_inode = ecryptfs_inode_to_lower(inode); |
| 791 | if (lower_inode->i_mapping->a_ops->bmap) |
| 792 | rc = lower_inode->i_mapping->a_ops->bmap(lower_inode->i_mapping, |
| 793 | block); |
| 794 | return rc; |
| 795 | } |
| 796 | |
| 797 | static void ecryptfs_sync_page(struct page *page) |
| 798 | { |
| 799 | struct inode *inode; |
| 800 | struct inode *lower_inode; |
| 801 | struct page *lower_page; |
| 802 | |
| 803 | inode = page->mapping->host; |
| 804 | lower_inode = ecryptfs_inode_to_lower(inode); |
| 805 | /* NOTE: Recently swapped with grab_cache_page(), since |
| 806 | * sync_page() just makes sure that pending I/O gets done. */ |
| 807 | lower_page = find_lock_page(lower_inode->i_mapping, page->index); |
| 808 | if (!lower_page) { |
| 809 | ecryptfs_printk(KERN_DEBUG, "find_lock_page failed\n"); |
| 810 | return; |
| 811 | } |
| 812 | lower_page->mapping->a_ops->sync_page(lower_page); |
| 813 | ecryptfs_printk(KERN_DEBUG, "Unlocking page with index = [0x%.16x]\n", |
| 814 | lower_page->index); |
| 815 | unlock_page(lower_page); |
| 816 | page_cache_release(lower_page); |
| 817 | } |
| 818 | |
| 819 | struct address_space_operations ecryptfs_aops = { |
| 820 | .writepage = ecryptfs_writepage, |
| 821 | .readpage = ecryptfs_readpage, |
| 822 | .prepare_write = ecryptfs_prepare_write, |
| 823 | .commit_write = ecryptfs_commit_write, |
| 824 | .bmap = ecryptfs_bmap, |
| 825 | .sync_page = ecryptfs_sync_page, |
| 826 | }; |