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