fs/ecryptfs/file.c

   1 /**
   2  * eCryptfs: Linux filesystem encryption layer
   3  *
   4  * Copyright (C) 1997-2004 Erez Zadok
   5  * Copyright (C) 2001-2004 Stony Brook University
   6  * Copyright (C) 2004-2007 International Business Machines Corp.
   7  *   Author(s): Michael A. Halcrow <mhalcrow@us.ibm.com>
   8  *              Michael C. Thompson <mcthomps@us.ibm.com>
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as
  12  * published by the Free Software Foundation; either version 2 of the
  13  * License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  23  * 02111-1307, USA.
  24  */
  25
  26 #include <linux/file.h>
  27 #include <linux/poll.h>
  28 #include <linux/slab.h>
  29 #include <linux/mount.h>
  30 #include <linux/pagemap.h>
  31 #include <linux/security.h>
  32 #include <linux/compat.h>
  33 #include <linux/fs_stack.h>
  34 #include "ecryptfs_kernel.h"
  35
  36 /**
  37  * ecryptfs_read_update_atime
  38  *
  39  * generic_file_read updates the atime of upper layer inode.  But, it
  40  * doesn't give us a chance to update the atime of the lower layer
  41  * inode.  This function is a wrapper to generic_file_read.  It
  42  * updates the atime of the lower level inode if generic_file_read
  43  * returns without any errors. This is to be used only for file reads.
  44  * The function to be used for directory reads is ecryptfs_read.
  45  */
  46 static ssize_t ecryptfs_read_update_atime(struct kiocb *iocb,
  47                                 const struct iovec *iov,
  48                                 unsigned long nr_segs, loff_t pos)
  49 {
  50         ssize_t rc;
  51         struct dentry *lower_dentry;
  52         struct vfsmount *lower_vfsmount;
  53         struct file *file = iocb->ki_filp;
  54
  55         rc = generic_file_aio_read(iocb, iov, nr_segs, pos);
  56         /*
  57          * Even though this is a async interface, we need to wait
  58          * for IO to finish to update atime
  59          */
  60         if (-EIOCBQUEUED == rc)
  61                 rc = wait_on_sync_kiocb(iocb);
  62         if (rc >= 0) {
  63                 lower_dentry = ecryptfs_dentry_to_lower(file->f_path.dentry);
  64                 lower_vfsmount = ecryptfs_dentry_to_lower_mnt(file->f_path.dentry);
  65                 touch_atime(lower_vfsmount, lower_dentry);
  66         }
  67         return rc;
  68 }
  69
  70 struct ecryptfs_getdents_callback {
  71         void *dirent;
  72         struct dentry *dentry;
  73         filldir_t filldir;
  74         int filldir_called;
  75         int entries_written;
  76 };
  77
  78 /* Inspired by generic filldir in fs/readdir.c */
  79 static int
  80 ecryptfs_filldir(void *dirent, const char *lower_name, int lower_namelen,
  81                  loff_t offset, u64 ino, unsigned int d_type)
  82 {
  83         struct ecryptfs_getdents_callback *buf =
  84             (struct ecryptfs_getdents_callback *)dirent;
  85         size_t name_size;
  86         char *name;
  87         int rc;
  88
  89         buf->filldir_called++;
  90         rc = ecryptfs_decode_and_decrypt_filename(&name, &name_size,
  91                                                   buf->dentry, lower_name,
  92                                                   lower_namelen);
  93         if (rc) {
  94                 printk(KERN_ERR "%s: Error attempting to decode and decrypt "
  95                        "filename [%s]; rc = [%d]\n", __func__, lower_name,
  96                        rc);
  97                 goto out;
  98         }
  99         rc = buf->filldir(buf->dirent, name, name_size, offset, ino, d_type);
 100         kfree(name);
 101         if (rc >= 0)
 102                 buf->entries_written++;
 103 out:
 104         return rc;
 105 }
 106
 107 /**
 108  * ecryptfs_readdir
 109  * @file: The eCryptfs directory file
 110  * @dirent: Directory entry handle
 111  * @filldir: The filldir callback function
 112  */
 113 static int ecryptfs_readdir(struct file *file, void *dirent, filldir_t filldir)
 114 {
 115         int rc;
 116         struct file *lower_file;
 117         struct inode *inode;
 118         struct ecryptfs_getdents_callback buf;
 119
 120         lower_file = ecryptfs_file_to_lower(file);
 121         lower_file->f_pos = file->f_pos;
 122         inode = file->f_path.dentry->d_inode;
 123         memset(&buf, 0, sizeof(buf));
 124         buf.dirent = dirent;
 125         buf.dentry = file->f_path.dentry;
 126         buf.filldir = filldir;
 127         buf.filldir_called = 0;
 128         buf.entries_written = 0;
 129         rc = vfs_readdir(lower_file, ecryptfs_filldir, (void *)&buf);
 130         file->f_pos = lower_file->f_pos;
 131         if (rc < 0)
 132                 goto out;
 133         if (buf.filldir_called && !buf.entries_written)
 134                 goto out;
 135         if (rc >= 0)
 136                 fsstack_copy_attr_atime(inode,
 137                                         lower_file->f_path.dentry->d_inode);
 138 out:
 139         return rc;
 140 }
 141
 142 static void ecryptfs_vma_close(struct vm_area_struct *vma)
 143 {
 144         filemap_write_and_wait(vma->vm_file->f_mapping);
 145 }
 146
 147 static const struct vm_operations_struct ecryptfs_file_vm_ops = {
 148         .close          = ecryptfs_vma_close,
 149         .fault          = filemap_fault,
 150 };
 151
 152 static int ecryptfs_file_mmap(struct file *file, struct vm_area_struct *vma)
 153 {
 154         int rc;
 155
 156         rc = generic_file_mmap(file, vma);
 157         if (!rc)
 158                 vma->vm_ops = &ecryptfs_file_vm_ops;
 159
 160         return rc;
 161 }
 162
 163 struct kmem_cache *ecryptfs_file_info_cache;
 164
 165 /**
 166  * ecryptfs_open
 167  * @inode: inode speciying file to open
 168  * @file: Structure to return filled in
 169  *
 170  * Opens the file specified by inode.
 171  *
 172  * Returns zero on success; non-zero otherwise
 173  */
 174 static int ecryptfs_open(struct inode *inode, struct file *file)
 175 {
 176         int rc = 0;
 177         struct ecryptfs_crypt_stat *crypt_stat = NULL;
 178         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
 179         struct dentry *ecryptfs_dentry = file->f_path.dentry;
 180         /* Private value of ecryptfs_dentry allocated in
 181          * ecryptfs_lookup() */
 182         struct dentry *lower_dentry;
 183         struct ecryptfs_file_info *file_info;
 184
 185         mount_crypt_stat = &ecryptfs_superblock_to_private(
 186                 ecryptfs_dentry->d_sb)->mount_crypt_stat;
 187         if ((mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
 188             && ((file->f_flags & O_WRONLY) || (file->f_flags & O_RDWR)
 189                 || (file->f_flags & O_CREAT) || (file->f_flags & O_TRUNC)
 190                 || (file->f_flags & O_APPEND))) {
 191                 printk(KERN_WARNING "Mount has encrypted view enabled; "
 192                        "files may only be read\n");
 193                 rc = -EPERM;
 194                 goto out;
 195         }
 196         /* Released in ecryptfs_release or end of function if failure */
 197         file_info = kmem_cache_zalloc(ecryptfs_file_info_cache, GFP_KERNEL);
 198         ecryptfs_set_file_private(file, file_info);
 199         if (!file_info) {
 200                 ecryptfs_printk(KERN_ERR,
 201                                 "Error attempting to allocate memory\n");
 202                 rc = -ENOMEM;
 203                 goto out;
 204         }
 205         lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
 206         crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
 207         mutex_lock(&crypt_stat->cs_mutex);
 208         if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)) {
 209                 ecryptfs_printk(KERN_DEBUG, "Setting flags for stat...\n");
 210                 /* Policy code enabled in future release */
 211                 crypt_stat->flags |= (ECRYPTFS_POLICY_APPLIED
 212                                       | ECRYPTFS_ENCRYPTED);
 213         }
 214         mutex_unlock(&crypt_stat->cs_mutex);
 215         rc = ecryptfs_get_lower_file(ecryptfs_dentry, inode);
 216         if (rc) {
 217                 printk(KERN_ERR "%s: Error attempting to initialize "
 218                         "the lower file for the dentry with name "
 219                         "[%s]; rc = [%d]\n", __func__,
 220                         ecryptfs_dentry->d_name.name, rc);
 221                 goto out_free;
 222         }
 223         if ((ecryptfs_inode_to_private(inode)->lower_file->f_flags & O_ACCMODE)
 224             == O_RDONLY && (file->f_flags & O_ACCMODE) != O_RDONLY) {
 225                 rc = -EPERM;
 226                 printk(KERN_WARNING "%s: Lower file is RO; eCryptfs "
 227                        "file must hence be opened RO\n", __func__);
 228                 goto out_put;
 229         }
 230         ecryptfs_set_file_lower(
 231                 file, ecryptfs_inode_to_private(inode)->lower_file);
 232         if (S_ISDIR(ecryptfs_dentry->d_inode->i_mode)) {
 233                 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
 234                 mutex_lock(&crypt_stat->cs_mutex);
 235                 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
 236                 mutex_unlock(&crypt_stat->cs_mutex);
 237                 rc = 0;
 238                 goto out;
 239         }
 240         mutex_lock(&crypt_stat->cs_mutex);
 241         if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
 242             || !(crypt_stat->flags & ECRYPTFS_KEY_VALID)) {
 243                 rc = ecryptfs_read_metadata(ecryptfs_dentry);
 244                 if (rc) {
 245                         ecryptfs_printk(KERN_DEBUG,
 246                                         "Valid headers not found\n");
 247                         if (!(mount_crypt_stat->flags
 248                               & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
 249                                 rc = -EIO;
 250                                 printk(KERN_WARNING "Either the lower file "
 251                                        "is not in a valid eCryptfs format, "
 252                                        "or the key could not be retrieved. "
 253                                        "Plaintext passthrough mode is not "
 254                                        "enabled; returning -EIO\n");
 255                                 mutex_unlock(&crypt_stat->cs_mutex);
 256                                 goto out_put;
 257                         }
 258                         rc = 0;
 259                         crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
 260                                                | ECRYPTFS_ENCRYPTED);
 261                         mutex_unlock(&crypt_stat->cs_mutex);
 262                         goto out;
 263                 }
 264         }
 265         mutex_unlock(&crypt_stat->cs_mutex);
 266         ecryptfs_printk(KERN_DEBUG, "inode w/ addr = [0x%p], i_ino = "
 267                         "[0x%.16lx] size: [0x%.16llx]\n", inode, inode->i_ino,
 268                         (unsigned long long)i_size_read(inode));
 269         goto out;
 270 out_put:
 271         ecryptfs_put_lower_file(inode);
 272 out_free:
 273         kmem_cache_free(ecryptfs_file_info_cache,
 274                         ecryptfs_file_to_private(file));
 275 out:
 276         return rc;
 277 }
 278
 279 static int ecryptfs_flush(struct file *file, fl_owner_t td)
 280 {
 281         return file->f_mode & FMODE_WRITE
 282                ? filemap_write_and_wait(file->f_mapping) : 0;
 283 }
 284
 285 static int ecryptfs_release(struct inode *inode, struct file *file)
 286 {
 287         ecryptfs_put_lower_file(inode);
 288         kmem_cache_free(ecryptfs_file_info_cache,
 289                         ecryptfs_file_to_private(file));
 290         return 0;
 291 }
 292
 293 static int
 294 ecryptfs_fsync(struct file *file, loff_t start, loff_t end, int datasync)
 295 {
 296         int rc = 0;
 297
 298         rc = generic_file_fsync(file, start, end, datasync);
 299         if (rc)
 300                 goto out;
 301         rc = vfs_fsync_range(ecryptfs_file_to_lower(file), start, end,
 302                              datasync);
 303 out:
 304         return rc;
 305 }
 306
 307 static int ecryptfs_fasync(int fd, struct file *file, int flag)
 308 {
 309         int rc = 0;
 310         struct file *lower_file = NULL;
 311
 312         lower_file = ecryptfs_file_to_lower(file);
 313         if (lower_file->f_op && lower_file->f_op->fasync)
 314                 rc = lower_file->f_op->fasync(fd, lower_file, flag);
 315         return rc;
 316 }
 317
 318 static long
 319 ecryptfs_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 320 {
 321         struct file *lower_file = NULL;
 322         long rc = -ENOTTY;
 323
 324         if (ecryptfs_file_to_private(file))
 325                 lower_file = ecryptfs_file_to_lower(file);
 326         if (lower_file && lower_file->f_op && lower_file->f_op->unlocked_ioctl)
 327                 rc = lower_file->f_op->unlocked_ioctl(lower_file, cmd, arg);
 328         return rc;
 329 }
 330
 331 #ifdef CONFIG_COMPAT
 332 static long
 333 ecryptfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 334 {
 335         struct file *lower_file = NULL;
 336         long rc = -ENOIOCTLCMD;
 337
 338         if (ecryptfs_file_to_private(file))
 339                 lower_file = ecryptfs_file_to_lower(file);
 340         if (lower_file && lower_file->f_op && lower_file->f_op->compat_ioctl)
 341                 rc = lower_file->f_op->compat_ioctl(lower_file, cmd, arg);
 342         return rc;
 343 }
 344 #endif
 345
 346 const struct file_operations ecryptfs_dir_fops = {
 347         .readdir = ecryptfs_readdir,
 348         .read = generic_read_dir,
 349         .unlocked_ioctl = ecryptfs_unlocked_ioctl,
 350 #ifdef CONFIG_COMPAT
 351         .compat_ioctl = ecryptfs_compat_ioctl,
 352 #endif
 353         .open = ecryptfs_open,
 354         .flush = ecryptfs_flush,
 355         .release = ecryptfs_release,
 356         .fsync = ecryptfs_fsync,
 357         .fasync = ecryptfs_fasync,
 358         .splice_read = generic_file_splice_read,
 359         .llseek = default_llseek,
 360 };
 361
 362 const struct file_operations ecryptfs_main_fops = {
 363         .llseek = generic_file_llseek,
 364         .read = do_sync_read,
 365         .aio_read = ecryptfs_read_update_atime,
 366         .write = do_sync_write,
 367         .aio_write = generic_file_aio_write,
 368         .readdir = ecryptfs_readdir,
 369         .unlocked_ioctl = ecryptfs_unlocked_ioctl,
 370 #ifdef CONFIG_COMPAT
 371         .compat_ioctl = ecryptfs_compat_ioctl,
 372 #endif
 373         .mmap = ecryptfs_file_mmap,
 374         .open = ecryptfs_open,
 375         .flush = ecryptfs_flush,
 376         .release = ecryptfs_release,
 377         .fsync = ecryptfs_fsync,
 378         .fasync = ecryptfs_fasync,
 379         .splice_read = generic_file_splice_read,
 380 };