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 struct kmem_cache *ecryptfs_file_info_cache;
 143
 144 static int read_or_initialize_metadata(struct dentry *dentry)
 145 {
 146         struct inode *inode = dentry->d_inode;
 147         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
 148         struct ecryptfs_crypt_stat *crypt_stat;
 149         int rc;
 150
 151         crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
 152         mount_crypt_stat = &ecryptfs_superblock_to_private(
 153                                                 inode->i_sb)->mount_crypt_stat;
 154         mutex_lock(&crypt_stat->cs_mutex);
 155
 156         if (crypt_stat->flags & ECRYPTFS_POLICY_APPLIED &&
 157             crypt_stat->flags & ECRYPTFS_KEY_VALID) {
 158                 rc = 0;
 159                 goto out;
 160         }
 161
 162         rc = ecryptfs_read_metadata(dentry);
 163         if (!rc)
 164                 goto out;
 165
 166         if (mount_crypt_stat->flags & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED) {
 167                 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
 168                                        | ECRYPTFS_ENCRYPTED);
 169                 rc = 0;
 170                 goto out;
 171         }
 172
 173         if (!(mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED) &&
 174             !i_size_read(ecryptfs_inode_to_lower(inode))) {
 175                 rc = ecryptfs_initialize_file(dentry, inode);
 176                 if (!rc)
 177                         goto out;
 178         }
 179
 180         rc = -EIO;
 181 out:
 182         mutex_unlock(&crypt_stat->cs_mutex);
 183         return rc;
 184 }
 185
 186 static int ecryptfs_mmap(struct file *file, struct vm_area_struct *vma)
 187 {
 188         struct file *lower_file = ecryptfs_file_to_lower(file);
 189         /*
 190          * Don't allow mmap on top of file systems that don't support it
 191          * natively.  If FILESYSTEM_MAX_STACK_DEPTH > 2 or ecryptfs
 192          * allows recursive mounting, this will need to be extended.
 193          */
 194         if (!lower_file->f_op->mmap)
 195                 return -ENODEV;
 196         return generic_file_mmap(file, vma);
 197 }
 198
 199 /**
 200  * ecryptfs_open
 201  * @inode: inode speciying file to open
 202  * @file: Structure to return filled in
 203  *
 204  * Opens the file specified by inode.
 205  *
 206  * Returns zero on success; non-zero otherwise
 207  */
 208 static int ecryptfs_open(struct inode *inode, struct file *file)
 209 {
 210         int rc = 0;
 211         struct ecryptfs_crypt_stat *crypt_stat = NULL;
 212         struct dentry *ecryptfs_dentry = file->f_path.dentry;
 213         /* Private value of ecryptfs_dentry allocated in
 214          * ecryptfs_lookup() */
 215         struct dentry *lower_dentry;
 216         struct ecryptfs_file_info *file_info;
 217
 218         /* Released in ecryptfs_release or end of function if failure */
 219         file_info = kmem_cache_zalloc(ecryptfs_file_info_cache, GFP_KERNEL);
 220         ecryptfs_set_file_private(file, file_info);
 221         if (!file_info) {
 222                 ecryptfs_printk(KERN_ERR,
 223                                 "Error attempting to allocate memory\n");
 224                 rc = -ENOMEM;
 225                 goto out;
 226         }
 227         lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
 228         crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
 229         mutex_lock(&crypt_stat->cs_mutex);
 230         if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)) {
 231                 ecryptfs_printk(KERN_DEBUG, "Setting flags for stat...\n");
 232                 /* Policy code enabled in future release */
 233                 crypt_stat->flags |= (ECRYPTFS_POLICY_APPLIED
 234                                       | ECRYPTFS_ENCRYPTED);
 235         }
 236         mutex_unlock(&crypt_stat->cs_mutex);
 237         rc = ecryptfs_get_lower_file(ecryptfs_dentry, inode);
 238         if (rc) {
 239                 printk(KERN_ERR "%s: Error attempting to initialize "
 240                         "the lower file for the dentry with name "
 241                         "[%s]; rc = [%d]\n", __func__,
 242                         ecryptfs_dentry->d_name.name, rc);
 243                 goto out_free;
 244         }
 245         if ((ecryptfs_inode_to_private(inode)->lower_file->f_flags & O_ACCMODE)
 246             == O_RDONLY && (file->f_flags & O_ACCMODE) != O_RDONLY) {
 247                 rc = -EPERM;
 248                 printk(KERN_WARNING "%s: Lower file is RO; eCryptfs "
 249                        "file must hence be opened RO\n", __func__);
 250                 goto out_put;
 251         }
 252         ecryptfs_set_file_lower(
 253                 file, ecryptfs_inode_to_private(inode)->lower_file);
 254         if (S_ISDIR(ecryptfs_dentry->d_inode->i_mode)) {
 255                 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
 256                 mutex_lock(&crypt_stat->cs_mutex);
 257                 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
 258                 mutex_unlock(&crypt_stat->cs_mutex);
 259                 rc = 0;
 260                 goto out;
 261         }
 262         rc = read_or_initialize_metadata(ecryptfs_dentry);
 263         if (rc)
 264                 goto out_put;
 265         ecryptfs_printk(KERN_DEBUG, "inode w/ addr = [0x%p], i_ino = "
 266                         "[0x%.16lx] size: [0x%.16llx]\n", inode, inode->i_ino,
 267                         (unsigned long long)i_size_read(inode));
 268         goto out;
 269 out_put:
 270         ecryptfs_put_lower_file(inode);
 271 out_free:
 272         kmem_cache_free(ecryptfs_file_info_cache,
 273                         ecryptfs_file_to_private(file));
 274 out:
 275         return rc;
 276 }
 277
 278 static int ecryptfs_flush(struct file *file, fl_owner_t td)
 279 {
 280         struct file *lower_file = ecryptfs_file_to_lower(file);
 281
 282         if (lower_file->f_op && lower_file->f_op->flush) {
 283                 filemap_write_and_wait(file->f_mapping);
 284                 return lower_file->f_op->flush(lower_file, td);
 285         }
 286
 287         return 0;
 288 }
 289
 290 static int ecryptfs_release(struct inode *inode, struct file *file)
 291 {
 292         ecryptfs_put_lower_file(inode);
 293         kmem_cache_free(ecryptfs_file_info_cache,
 294                         ecryptfs_file_to_private(file));
 295         return 0;
 296 }
 297
 298 static int
 299 ecryptfs_fsync(struct file *file, loff_t start, loff_t end, int datasync)
 300 {
 301         return vfs_fsync(ecryptfs_file_to_lower(file), datasync);
 302 }
 303
 304 static int ecryptfs_fasync(int fd, struct file *file, int flag)
 305 {
 306         int rc = 0;
 307         struct file *lower_file = NULL;
 308
 309         lower_file = ecryptfs_file_to_lower(file);
 310         if (lower_file->f_op && lower_file->f_op->fasync)
 311                 rc = lower_file->f_op->fasync(fd, lower_file, flag);
 312         return rc;
 313 }
 314
 315 static long
 316 ecryptfs_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 317 {
 318         struct file *lower_file = NULL;
 319         long rc = -ENOTTY;
 320
 321         if (ecryptfs_file_to_private(file))
 322                 lower_file = ecryptfs_file_to_lower(file);
 323         if (!(lower_file && lower_file->f_op && lower_file->f_op->unlocked_ioctl))
 324                 return rc;
 325
 326         switch (cmd) {
 327         case FITRIM:
 328         case FS_IOC_GETFLAGS:
 329         case FS_IOC_SETFLAGS:
 330         case FS_IOC_GETVERSION:
 331         case FS_IOC_SETVERSION:
 332                 rc = lower_file->f_op->unlocked_ioctl(lower_file, cmd, arg);
 333                 fsstack_copy_attr_all(file->f_path.dentry->d_inode,
 334                                       lower_file->f_path.dentry->d_inode);
 335
 336                 return rc;
 337         default:
 338                 return rc;
 339         }
 340 }
 341
 342 #ifdef CONFIG_COMPAT
 343 static long
 344 ecryptfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 345 {
 346         struct file *lower_file = NULL;
 347         long rc = -ENOIOCTLCMD;
 348
 349         if (ecryptfs_file_to_private(file))
 350                 lower_file = ecryptfs_file_to_lower(file);
 351         if (!(lower_file && lower_file->f_op && lower_file->f_op->compat_ioctl))
 352                 return rc;
 353
 354         switch (cmd) {
 355         case FITRIM:
 356         case FS_IOC32_GETFLAGS:
 357         case FS_IOC32_SETFLAGS:
 358         case FS_IOC32_GETVERSION:
 359         case FS_IOC32_SETVERSION:
 360                 rc = lower_file->f_op->compat_ioctl(lower_file, cmd, arg);
 361                 fsstack_copy_attr_all(file->f_path.dentry->d_inode,
 362                                       lower_file->f_path.dentry->d_inode);
 363
 364                 return rc;
 365         default:
 366                 return rc;
 367         }
 368 }
 369 #endif
 370
 371 const struct file_operations ecryptfs_dir_fops = {
 372         .readdir = ecryptfs_readdir,
 373         .read = generic_read_dir,
 374         .unlocked_ioctl = ecryptfs_unlocked_ioctl,
 375 #ifdef CONFIG_COMPAT
 376         .compat_ioctl = ecryptfs_compat_ioctl,
 377 #endif
 378         .open = ecryptfs_open,
 379         .flush = ecryptfs_flush,
 380         .release = ecryptfs_release,
 381         .fsync = ecryptfs_fsync,
 382         .fasync = ecryptfs_fasync,
 383         .splice_read = generic_file_splice_read,
 384         .llseek = default_llseek,
 385 };
 386
 387 const struct file_operations ecryptfs_main_fops = {
 388         .llseek = generic_file_llseek,
 389         .read = do_sync_read,
 390         .aio_read = ecryptfs_read_update_atime,
 391         .write = do_sync_write,
 392         .aio_write = generic_file_aio_write,
 393         .readdir = ecryptfs_readdir,
 394         .unlocked_ioctl = ecryptfs_unlocked_ioctl,
 395 #ifdef CONFIG_COMPAT
 396         .compat_ioctl = ecryptfs_compat_ioctl,
 397 #endif
 398         .mmap = ecryptfs_mmap,
 399         .open = ecryptfs_open,
 400         .flush = ecryptfs_flush,
 401         .release = ecryptfs_release,
 402         .fsync = ecryptfs_fsync,
 403         .fasync = ecryptfs_fasync,
 404         .splice_read = generic_file_splice_read,
 405 };