fs/ecryptfs/mmap.c

   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
   9  * Copyright (C) 2004-2007 International Business Machines Corp.
  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 /**
  38  * ecryptfs_get_locked_page
  39  *
  40  * Get one page from cache or lower f/s, return error otherwise.
  41  *
  42  * Returns locked and up-to-date page (if ok), with increased
  43  * refcnt.
  44  */
  45 struct page *ecryptfs_get_locked_page(struct file *file, loff_t index)
  46 {
  47         struct dentry *dentry;
  48         struct inode *inode;
  49         struct address_space *mapping;
  50         struct page *page;
  51
  52         dentry = file->f_path.dentry;
  53         inode = dentry->d_inode;
  54         mapping = inode->i_mapping;
  55         page = read_mapping_page(mapping, index, (void *)file);
  56         if (!IS_ERR(page))
  57                 lock_page(page);
  58         return page;
  59 }
  60
  61 /**
  62  * ecryptfs_writepage
  63  * @page: Page that is locked before this call is made
  64  *
  65  * Returns zero on success; non-zero otherwise
  66  */
  67 static int ecryptfs_writepage(struct page *page, struct writeback_control *wbc)
  68 {
  69         int rc;
  70
  71         rc = ecryptfs_encrypt_page(page);
  72         if (rc) {
  73                 ecryptfs_printk(KERN_WARNING, "Error encrypting "
  74                                 "page (upper index [0x%.16x])\n", page->index);
  75                 ClearPageUptodate(page);
  76                 goto out;
  77         }
  78         SetPageUptodate(page);
  79         unlock_page(page);
  80 out:
  81         return rc;
  82 }
  83
  84 /**
  85  *   Header Extent:
  86  *     Octets 0-7:        Unencrypted file size (big-endian)
  87  *     Octets 8-15:       eCryptfs special marker
  88  *     Octets 16-19:      Flags
  89  *      Octet 16:         File format version number (between 0 and 255)
  90  *      Octets 17-18:     Reserved
  91  *      Octet 19:         Bit 1 (lsb): Reserved
  92  *                        Bit 2: Encrypted?
  93  *                        Bits 3-8: Reserved
  94  *     Octets 20-23:      Header extent size (big-endian)
  95  *     Octets 24-25:      Number of header extents at front of file
  96  *                        (big-endian)
  97  *     Octet  26:         Begin RFC 2440 authentication token packet set
  98  */
  99 static void set_header_info(char *page_virt,
 100                             struct ecryptfs_crypt_stat *crypt_stat)
 101 {
 102         size_t written;
 103         size_t save_num_header_bytes_at_front =
 104                 crypt_stat->num_header_bytes_at_front;
 105
 106         crypt_stat->num_header_bytes_at_front =
 107                 ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE;
 108         ecryptfs_write_header_metadata(page_virt + 20, crypt_stat, &written);
 109         crypt_stat->num_header_bytes_at_front =
 110                 save_num_header_bytes_at_front;
 111 }
 112
 113 /**
 114  * ecryptfs_copy_up_encrypted_with_header
 115  * @page: Sort of a ``virtual'' representation of the encrypted lower
 116  *        file. The actual lower file does not have the metadata in
 117  *        the header. This is locked.
 118  * @crypt_stat: The eCryptfs inode's cryptographic context
 119  *
 120  * The ``view'' is the version of the file that userspace winds up
 121  * seeing, with the header information inserted.
 122  */
 123 static int
 124 ecryptfs_copy_up_encrypted_with_header(struct page *page,
 125                                        struct ecryptfs_crypt_stat *crypt_stat)
 126 {
 127         loff_t extent_num_in_page = 0;
 128         loff_t num_extents_per_page = (PAGE_CACHE_SIZE
 129                                        / crypt_stat->extent_size);
 130         int rc = 0;
 131
 132         while (extent_num_in_page < num_extents_per_page) {
 133                 loff_t view_extent_num = ((((loff_t)page->index)
 134                                            * num_extents_per_page)
 135                                           + extent_num_in_page);
 136                 size_t num_header_extents_at_front =
 137                         (crypt_stat->num_header_bytes_at_front
 138                          / crypt_stat->extent_size);
 139
 140                 if (view_extent_num < num_header_extents_at_front) {
 141                         /* This is a header extent */
 142                         char *page_virt;
 143
 144                         page_virt = kmap_atomic(page, KM_USER0);
 145                         memset(page_virt, 0, PAGE_CACHE_SIZE);
 146                         /* TODO: Support more than one header extent */
 147                         if (view_extent_num == 0) {
 148                                 rc = ecryptfs_read_xattr_region(
 149                                         page_virt, page->mapping->host);
 150                                 set_header_info(page_virt, crypt_stat);
 151                         }
 152                         kunmap_atomic(page_virt, KM_USER0);
 153                         flush_dcache_page(page);
 154                         if (rc) {
 155                                 printk(KERN_ERR "%s: Error reading xattr "
 156                                        "region; rc = [%d]\n", __FUNCTION__, rc);
 157                                 goto out;
 158                         }
 159                 } else {
 160                         /* This is an encrypted data extent */
 161                         loff_t lower_offset =
 162                                 ((view_extent_num * crypt_stat->extent_size)
 163                                  - crypt_stat->num_header_bytes_at_front);
 164
 165                         rc = ecryptfs_read_lower_page_segment(
 166                                 page, (lower_offset >> PAGE_CACHE_SHIFT),
 167                                 (lower_offset & ~PAGE_CACHE_MASK),
 168                                 crypt_stat->extent_size, page->mapping->host);
 169                         if (rc) {
 170                                 printk(KERN_ERR "%s: Error attempting to read "
 171                                        "extent at offset [%lld] in the lower "
 172                                        "file; rc = [%d]\n", __FUNCTION__,
 173                                        lower_offset, rc);
 174                                 goto out;
 175                         }
 176                 }
 177                 extent_num_in_page++;
 178         }
 179 out:
 180         return rc;
 181 }
 182
 183 /**
 184  * ecryptfs_readpage
 185  * @file: An eCryptfs file
 186  * @page: Page from eCryptfs inode mapping into which to stick the read data
 187  *
 188  * Read in a page, decrypting if necessary.
 189  *
 190  * Returns zero on success; non-zero on error.
 191  */
 192 static int ecryptfs_readpage(struct file *file, struct page *page)
 193 {
 194         struct ecryptfs_crypt_stat *crypt_stat =
 195                 &ecryptfs_inode_to_private(file->f_path.dentry->d_inode)->crypt_stat;
 196         int rc = 0;
 197
 198         if (!crypt_stat
 199             || !(crypt_stat->flags & ECRYPTFS_ENCRYPTED)
 200             || (crypt_stat->flags & ECRYPTFS_NEW_FILE)) {
 201                 ecryptfs_printk(KERN_DEBUG,
 202                                 "Passing through unencrypted page\n");
 203                 rc = ecryptfs_read_lower_page_segment(page, page->index, 0,
 204                                                       PAGE_CACHE_SIZE,
 205                                                       page->mapping->host);
 206         } else if (crypt_stat->flags & ECRYPTFS_VIEW_AS_ENCRYPTED) {
 207                 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR) {
 208                         rc = ecryptfs_copy_up_encrypted_with_header(page,
 209                                                                     crypt_stat);
 210                         if (rc) {
 211                                 printk(KERN_ERR "%s: Error attempting to copy "
 212                                        "the encrypted content from the lower "
 213                                        "file whilst inserting the metadata "
 214                                        "from the xattr into the header; rc = "
 215                                        "[%d]\n", __FUNCTION__, rc);
 216                                 goto out;
 217                         }
 218
 219                 } else {
 220                         rc = ecryptfs_read_lower_page_segment(
 221                                 page, page->index, 0, PAGE_CACHE_SIZE,
 222                                 page->mapping->host);
 223                         if (rc) {
 224                                 printk(KERN_ERR "Error reading page; rc = "
 225                                        "[%d]\n", rc);
 226                                 goto out;
 227                         }
 228                 }
 229         } else {
 230                 rc = ecryptfs_decrypt_page(page);
 231                 if (rc) {
 232                         ecryptfs_printk(KERN_ERR, "Error decrypting page; "
 233                                         "rc = [%d]\n", rc);
 234                         goto out;
 235                 }
 236         }
 237 out:
 238         if (rc)
 239                 ClearPageUptodate(page);
 240         else
 241                 SetPageUptodate(page);
 242         ecryptfs_printk(KERN_DEBUG, "Unlocking page with index = [0x%.16x]\n",
 243                         page->index);
 244         unlock_page(page);
 245         return rc;
 246 }
 247
 248 /**
 249  * Called with lower inode mutex held.
 250  */
 251 static int fill_zeros_to_end_of_page(struct page *page, unsigned int to)
 252 {
 253         struct inode *inode = page->mapping->host;
 254         int end_byte_in_page;
 255
 256         if ((i_size_read(inode) / PAGE_CACHE_SIZE) != page->index)
 257                 goto out;
 258         end_byte_in_page = i_size_read(inode) % PAGE_CACHE_SIZE;
 259         if (to > end_byte_in_page)
 260                 end_byte_in_page = to;
 261         zero_user_segment(page, end_byte_in_page, PAGE_CACHE_SIZE);
 262 out:
 263         return 0;
 264 }
 265
 266 /**
 267  * ecryptfs_prepare_write
 268  * @file: The eCryptfs file
 269  * @page: The eCryptfs page
 270  * @from: The start byte from which we will write
 271  * @to: The end byte to which we will write
 272  *
 273  * This function must zero any hole we create
 274  *
 275  * Returns zero on success; non-zero otherwise
 276  */
 277 static int ecryptfs_prepare_write(struct file *file, struct page *page,
 278                                   unsigned from, unsigned to)
 279 {
 280         loff_t prev_page_end_size;
 281         int rc = 0;
 282
 283         if (!PageUptodate(page)) {
 284                 struct ecryptfs_crypt_stat *crypt_stat =
 285                         &ecryptfs_inode_to_private(
 286                                 file->f_path.dentry->d_inode)->crypt_stat;
 287
 288                 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)
 289                     || (crypt_stat->flags & ECRYPTFS_NEW_FILE)) {
 290                         rc = ecryptfs_read_lower_page_segment(
 291                                 page, page->index, 0, PAGE_CACHE_SIZE,
 292                                 page->mapping->host);
 293                         if (rc) {
 294                                 printk(KERN_ERR "%s: Error attemping to read "
 295                                        "lower page segment; rc = [%d]\n",
 296                                        __FUNCTION__, rc);
 297                                 ClearPageUptodate(page);
 298                                 goto out;
 299                         } else
 300                                 SetPageUptodate(page);
 301                 } else if (crypt_stat->flags & ECRYPTFS_VIEW_AS_ENCRYPTED) {
 302                         if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR) {
 303                                 rc = ecryptfs_copy_up_encrypted_with_header(
 304                                         page, crypt_stat);
 305                                 if (rc) {
 306                                         printk(KERN_ERR "%s: Error attempting "
 307                                                "to copy the encrypted content "
 308                                                "from the lower file whilst "
 309                                                "inserting the metadata from "
 310                                                "the xattr into the header; rc "
 311                                                "= [%d]\n", __FUNCTION__, rc);
 312                                         ClearPageUptodate(page);
 313                                         goto out;
 314                                 }
 315                                 SetPageUptodate(page);
 316                         } else {
 317                                 rc = ecryptfs_read_lower_page_segment(
 318                                         page, page->index, 0, PAGE_CACHE_SIZE,
 319                                         page->mapping->host);
 320                                 if (rc) {
 321                                         printk(KERN_ERR "%s: Error reading "
 322                                                "page; rc = [%d]\n",
 323                                                __FUNCTION__, rc);
 324                                         ClearPageUptodate(page);
 325                                         goto out;
 326                                 }
 327                                 SetPageUptodate(page);
 328                         }
 329                 } else {
 330                         rc = ecryptfs_decrypt_page(page);
 331                         if (rc) {
 332                                 printk(KERN_ERR "%s: Error decrypting page "
 333                                        "at index [%ld]; rc = [%d]\n",
 334                                        __FUNCTION__, page->index, rc);
 335                                 ClearPageUptodate(page);
 336                                 goto out;
 337                         }
 338                         SetPageUptodate(page);
 339                 }
 340         }
 341         prev_page_end_size = ((loff_t)page->index << PAGE_CACHE_SHIFT);
 342         /* If creating a page or more of holes, zero them out via truncate.
 343          * Note, this will increase i_size. */
 344         if (page->index != 0) {
 345                 if (prev_page_end_size > i_size_read(page->mapping->host)) {
 346                         rc = ecryptfs_truncate(file->f_path.dentry,
 347                                                prev_page_end_size);
 348                         if (rc) {
 349                                 printk(KERN_ERR "%s: Error on attempt to "
 350                                        "truncate to (higher) offset [%lld];"
 351                                        " rc = [%d]\n", __FUNCTION__,
 352                                        prev_page_end_size, rc);
 353                                 goto out;
 354                         }
 355                 }
 356         }
 357         /* Writing to a new page, and creating a small hole from start
 358          * of page?  Zero it out. */
 359         if ((i_size_read(page->mapping->host) == prev_page_end_size)
 360             && (from != 0))
 361                 zero_user(page, 0, PAGE_CACHE_SIZE);
 362 out:
 363         return rc;
 364 }
 365
 366 /**
 367  * ecryptfs_write_inode_size_to_header
 368  *
 369  * Writes the lower file size to the first 8 bytes of the header.
 370  *
 371  * Returns zero on success; non-zero on error.
 372  */
 373 static int ecryptfs_write_inode_size_to_header(struct inode *ecryptfs_inode)
 374 {
 375         u64 file_size;
 376         char *file_size_virt;
 377         int rc;
 378
 379         file_size_virt = kmalloc(sizeof(u64), GFP_KERNEL);
 380         if (!file_size_virt) {
 381                 rc = -ENOMEM;
 382                 goto out;
 383         }
 384         file_size = (u64)i_size_read(ecryptfs_inode);
 385         file_size = cpu_to_be64(file_size);
 386         memcpy(file_size_virt, &file_size, sizeof(u64));
 387         rc = ecryptfs_write_lower(ecryptfs_inode, file_size_virt, 0,
 388                                   sizeof(u64));
 389         kfree(file_size_virt);
 390         if (rc)
 391                 printk(KERN_ERR "%s: Error writing file size to header; "
 392                        "rc = [%d]\n", __FUNCTION__, rc);
 393 out:
 394         return rc;
 395 }
 396
 397 struct kmem_cache *ecryptfs_xattr_cache;
 398
 399 static int ecryptfs_write_inode_size_to_xattr(struct inode *ecryptfs_inode)
 400 {
 401         ssize_t size;
 402         void *xattr_virt;
 403         struct dentry *lower_dentry =
 404                 ecryptfs_inode_to_private(ecryptfs_inode)->lower_file->f_dentry;
 405         struct inode *lower_inode = lower_dentry->d_inode;
 406         u64 file_size;
 407         int rc;
 408
 409         if (!lower_inode->i_op->getxattr || !lower_inode->i_op->setxattr) {
 410                 printk(KERN_WARNING
 411                        "No support for setting xattr in lower filesystem\n");
 412                 rc = -ENOSYS;
 413                 goto out;
 414         }
 415         xattr_virt = kmem_cache_alloc(ecryptfs_xattr_cache, GFP_KERNEL);
 416         if (!xattr_virt) {
 417                 printk(KERN_ERR "Out of memory whilst attempting to write "
 418                        "inode size to xattr\n");
 419                 rc = -ENOMEM;
 420                 goto out;
 421         }
 422         mutex_lock(&lower_inode->i_mutex);
 423         size = lower_inode->i_op->getxattr(lower_dentry, ECRYPTFS_XATTR_NAME,
 424                                            xattr_virt, PAGE_CACHE_SIZE);
 425         if (size < 0)
 426                 size = 8;
 427         file_size = (u64)i_size_read(ecryptfs_inode);
 428         file_size = cpu_to_be64(file_size);
 429         memcpy(xattr_virt, &file_size, sizeof(u64));
 430         rc = lower_inode->i_op->setxattr(lower_dentry, ECRYPTFS_XATTR_NAME,
 431                                          xattr_virt, size, 0);
 432         mutex_unlock(&lower_inode->i_mutex);
 433         if (rc)
 434                 printk(KERN_ERR "Error whilst attempting to write inode size "
 435                        "to lower file xattr; rc = [%d]\n", rc);
 436         kmem_cache_free(ecryptfs_xattr_cache, xattr_virt);
 437 out:
 438         return rc;
 439 }
 440
 441 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode)
 442 {
 443         struct ecryptfs_crypt_stat *crypt_stat;
 444
 445         crypt_stat = &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
 446         if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
 447                 return ecryptfs_write_inode_size_to_xattr(ecryptfs_inode);
 448         else
 449                 return ecryptfs_write_inode_size_to_header(ecryptfs_inode);
 450 }
 451
 452 /**
 453  * ecryptfs_commit_write
 454  * @file: The eCryptfs file object
 455  * @page: The eCryptfs page
 456  * @from: Ignored (we rotate the page IV on each write)
 457  * @to: Ignored
 458  *
 459  * This is where we encrypt the data and pass the encrypted data to
 460  * the lower filesystem.  In OpenPGP-compatible mode, we operate on
 461  * entire underlying packets.
 462  */
 463 static int ecryptfs_commit_write(struct file *file, struct page *page,
 464                                  unsigned from, unsigned to)
 465 {
 466         loff_t pos;
 467         struct inode *ecryptfs_inode = page->mapping->host;
 468         struct ecryptfs_crypt_stat *crypt_stat =
 469                 &ecryptfs_inode_to_private(file->f_path.dentry->d_inode)->crypt_stat;
 470         int rc;
 471
 472         if (crypt_stat->flags & ECRYPTFS_NEW_FILE) {
 473                 ecryptfs_printk(KERN_DEBUG, "ECRYPTFS_NEW_FILE flag set in "
 474                         "crypt_stat at memory location [%p]\n", crypt_stat);
 475                 crypt_stat->flags &= ~(ECRYPTFS_NEW_FILE);
 476         } else
 477                 ecryptfs_printk(KERN_DEBUG, "Not a new file\n");
 478         ecryptfs_printk(KERN_DEBUG, "Calling fill_zeros_to_end_of_page"
 479                         "(page w/ index = [0x%.16x], to = [%d])\n", page->index,
 480                         to);
 481         /* Fills in zeros if 'to' goes beyond inode size */
 482         rc = fill_zeros_to_end_of_page(page, to);
 483         if (rc) {
 484                 ecryptfs_printk(KERN_WARNING, "Error attempting to fill "
 485                                 "zeros in page with index = [0x%.16x]\n",
 486                                 page->index);
 487                 goto out;
 488         }
 489         rc = ecryptfs_encrypt_page(page);
 490         if (rc) {
 491                 ecryptfs_printk(KERN_WARNING, "Error encrypting page (upper "
 492                                 "index [0x%.16x])\n", page->index);
 493                 goto out;
 494         }
 495         pos = (((loff_t)page->index) << PAGE_CACHE_SHIFT) + to;
 496         if (pos > i_size_read(ecryptfs_inode)) {
 497                 i_size_write(ecryptfs_inode, pos);
 498                 ecryptfs_printk(KERN_DEBUG, "Expanded file size to "
 499                                 "[0x%.16x]\n", i_size_read(ecryptfs_inode));
 500         }
 501         rc = ecryptfs_write_inode_size_to_metadata(ecryptfs_inode);
 502         if (rc)
 503                 printk(KERN_ERR "Error writing inode size to metadata; "
 504                        "rc = [%d]\n", rc);
 505 out:
 506         return rc;
 507 }
 508
 509 static sector_t ecryptfs_bmap(struct address_space *mapping, sector_t block)
 510 {
 511         int rc = 0;
 512         struct inode *inode;
 513         struct inode *lower_inode;
 514
 515         inode = (struct inode *)mapping->host;
 516         lower_inode = ecryptfs_inode_to_lower(inode);
 517         if (lower_inode->i_mapping->a_ops->bmap)
 518                 rc = lower_inode->i_mapping->a_ops->bmap(lower_inode->i_mapping,
 519                                                          block);
 520         return rc;
 521 }
 522
 523 struct address_space_operations ecryptfs_aops = {
 524         .writepage = ecryptfs_writepage,
 525         .readpage = ecryptfs_readpage,
 526         .prepare_write = ecryptfs_prepare_write,
 527         .commit_write = ecryptfs_commit_write,
 528         .bmap = ecryptfs_bmap,
 529 };