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                                 struct iov_iter *to)
  48 {
  49         ssize_t rc;
  50         struct path *path;
  51         struct file *file = iocb->ki_filp;
  52
  53         rc = generic_file_read_iter(iocb, to);
  54         if (rc >= 0) {
  55                 path = ecryptfs_dentry_to_lower_path(file->f_path.dentry);
  56                 touch_atime(path);
  57         }
  58         return rc;
  59 }
  60
  61 struct ecryptfs_getdents_callback {
  62         struct dir_context ctx;
  63         struct dir_context *caller;
  64         struct super_block *sb;
  65         int filldir_called;
  66         int entries_written;
  67 };
  68
  69 /* Inspired by generic filldir in fs/readdir.c */
  70 static int
  71 ecryptfs_filldir(struct dir_context *ctx, const char *lower_name,
  72                  int lower_namelen, loff_t offset, u64 ino, unsigned int d_type)
  73 {
  74         struct ecryptfs_getdents_callback *buf =
  75                 container_of(ctx, struct ecryptfs_getdents_callback, ctx);
  76         size_t name_size;
  77         char *name;
  78         int rc;
  79
  80         buf->filldir_called++;
  81         rc = ecryptfs_decode_and_decrypt_filename(&name, &name_size,
  82                                                   buf->sb, lower_name,
  83                                                   lower_namelen);
  84         if (rc) {
  85                 printk(KERN_ERR "%s: Error attempting to decode and decrypt "
  86                        "filename [%s]; rc = [%d]\n", __func__, lower_name,
  87                        rc);
  88                 goto out;
  89         }
  90         buf->caller->pos = buf->ctx.pos;
  91         rc = !dir_emit(buf->caller, name, name_size, ino, d_type);
  92         kfree(name);
  93         if (!rc)
  94                 buf->entries_written++;
  95 out:
  96         return rc;
  97 }
  98
  99 /**
 100  * ecryptfs_readdir
 101  * @file: The eCryptfs directory file
 102  * @ctx: The actor to feed the entries to
 103  */
 104 static int ecryptfs_readdir(struct file *file, struct dir_context *ctx)
 105 {
 106         int rc;
 107         struct file *lower_file;
 108         struct inode *inode = file_inode(file);
 109         struct ecryptfs_getdents_callback buf = {
 110                 .ctx.actor = ecryptfs_filldir,
 111                 .caller = ctx,
 112                 .sb = inode->i_sb,
 113         };
 114         lower_file = ecryptfs_file_to_lower(file);
 115         rc = iterate_dir(lower_file, &buf.ctx);
 116         ctx->pos = buf.ctx.pos;
 117         if (rc < 0)
 118                 goto out;
 119         if (buf.filldir_called && !buf.entries_written)
 120                 goto out;
 121         if (rc >= 0)
 122                 fsstack_copy_attr_atime(inode,
 123                                         file_inode(lower_file));
 124 out:
 125         return rc;
 126 }
 127
 128 struct kmem_cache *ecryptfs_file_info_cache;
 129
 130 static int read_or_initialize_metadata(struct dentry *dentry)
 131 {
 132         struct inode *inode = d_inode(dentry);
 133         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
 134         struct ecryptfs_crypt_stat *crypt_stat;
 135         int rc;
 136
 137         crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
 138         mount_crypt_stat = &ecryptfs_superblock_to_private(
 139                                                 inode->i_sb)->mount_crypt_stat;
 140         mutex_lock(&crypt_stat->cs_mutex);
 141
 142         if (crypt_stat->flags & ECRYPTFS_POLICY_APPLIED &&
 143             crypt_stat->flags & ECRYPTFS_KEY_VALID) {
 144                 rc = 0;
 145                 goto out;
 146         }
 147
 148         rc = ecryptfs_read_metadata(dentry);
 149         if (!rc)
 150                 goto out;
 151
 152         if (mount_crypt_stat->flags & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED) {
 153                 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
 154                                        | ECRYPTFS_ENCRYPTED);
 155                 rc = 0;
 156                 goto out;
 157         }
 158
 159         if (!(mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED) &&
 160             !i_size_read(ecryptfs_inode_to_lower(inode))) {
 161                 rc = ecryptfs_initialize_file(dentry, inode);
 162                 if (!rc)
 163                         goto out;
 164         }
 165
 166         rc = -EIO;
 167 out:
 168         mutex_unlock(&crypt_stat->cs_mutex);
 169         return rc;
 170 }
 171
 172 /**
 173  * ecryptfs_open
 174  * @inode: inode speciying file to open
 175  * @file: Structure to return filled in
 176  *
 177  * Opens the file specified by inode.
 178  *
 179  * Returns zero on success; non-zero otherwise
 180  */
 181 static int ecryptfs_open(struct inode *inode, struct file *file)
 182 {
 183         int rc = 0;
 184         struct ecryptfs_crypt_stat *crypt_stat = NULL;
 185         struct dentry *ecryptfs_dentry = file->f_path.dentry;
 186         /* Private value of ecryptfs_dentry allocated in
 187          * ecryptfs_lookup() */
 188         struct ecryptfs_file_info *file_info;
 189
 190         /* Released in ecryptfs_release or end of function if failure */
 191         file_info = kmem_cache_zalloc(ecryptfs_file_info_cache, GFP_KERNEL);
 192         ecryptfs_set_file_private(file, file_info);
 193         if (!file_info) {
 194                 ecryptfs_printk(KERN_ERR,
 195                                 "Error attempting to allocate memory\n");
 196                 rc = -ENOMEM;
 197                 goto out;
 198         }
 199         crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
 200         mutex_lock(&crypt_stat->cs_mutex);
 201         if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)) {
 202                 ecryptfs_printk(KERN_DEBUG, "Setting flags for stat...\n");
 203                 /* Policy code enabled in future release */
 204                 crypt_stat->flags |= (ECRYPTFS_POLICY_APPLIED
 205                                       | ECRYPTFS_ENCRYPTED);
 206         }
 207         mutex_unlock(&crypt_stat->cs_mutex);
 208         rc = ecryptfs_get_lower_file(ecryptfs_dentry, inode);
 209         if (rc) {
 210                 printk(KERN_ERR "%s: Error attempting to initialize "
 211                         "the lower file for the dentry with name "
 212                         "[%pd]; rc = [%d]\n", __func__,
 213                         ecryptfs_dentry, rc);
 214                 goto out_free;
 215         }
 216         if ((ecryptfs_inode_to_private(inode)->lower_file->f_flags & O_ACCMODE)
 217             == O_RDONLY && (file->f_flags & O_ACCMODE) != O_RDONLY) {
 218                 rc = -EPERM;
 219                 printk(KERN_WARNING "%s: Lower file is RO; eCryptfs "
 220                        "file must hence be opened RO\n", __func__);
 221                 goto out_put;
 222         }
 223         ecryptfs_set_file_lower(
 224                 file, ecryptfs_inode_to_private(inode)->lower_file);
 225         rc = read_or_initialize_metadata(ecryptfs_dentry);
 226         if (rc)
 227                 goto out_put;
 228         ecryptfs_printk(KERN_DEBUG, "inode w/ addr = [0x%p], i_ino = "
 229                         "[0x%.16lx] size: [0x%.16llx]\n", inode, inode->i_ino,
 230                         (unsigned long long)i_size_read(inode));
 231         goto out;
 232 out_put:
 233         ecryptfs_put_lower_file(inode);
 234 out_free:
 235         kmem_cache_free(ecryptfs_file_info_cache,
 236                         ecryptfs_file_to_private(file));
 237 out:
 238         return rc;
 239 }
 240
 241 /**
 242  * ecryptfs_dir_open
 243  * @inode: inode speciying file to open
 244  * @file: Structure to return filled in
 245  *
 246  * Opens the file specified by inode.
 247  *
 248  * Returns zero on success; non-zero otherwise
 249  */
 250 static int ecryptfs_dir_open(struct inode *inode, struct file *file)
 251 {
 252         struct dentry *ecryptfs_dentry = file->f_path.dentry;
 253         /* Private value of ecryptfs_dentry allocated in
 254          * ecryptfs_lookup() */
 255         struct ecryptfs_file_info *file_info;
 256         struct file *lower_file;
 257
 258         /* Released in ecryptfs_release or end of function if failure */
 259         file_info = kmem_cache_zalloc(ecryptfs_file_info_cache, GFP_KERNEL);
 260         ecryptfs_set_file_private(file, file_info);
 261         if (unlikely(!file_info)) {
 262                 ecryptfs_printk(KERN_ERR,
 263                                 "Error attempting to allocate memory\n");
 264                 return -ENOMEM;
 265         }
 266         lower_file = dentry_open(ecryptfs_dentry_to_lower_path(ecryptfs_dentry),
 267                                  file->f_flags, current_cred());
 268         if (IS_ERR(lower_file)) {
 269                 printk(KERN_ERR "%s: Error attempting to initialize "
 270                         "the lower file for the dentry with name "
 271                         "[%pd]; rc = [%ld]\n", __func__,
 272                         ecryptfs_dentry, PTR_ERR(lower_file));
 273                 kmem_cache_free(ecryptfs_file_info_cache, file_info);
 274                 return PTR_ERR(lower_file);
 275         }
 276         ecryptfs_set_file_lower(file, lower_file);
 277         return 0;
 278 }
 279
 280 static int ecryptfs_flush(struct file *file, fl_owner_t td)
 281 {
 282         struct file *lower_file = ecryptfs_file_to_lower(file);
 283
 284         if (lower_file->f_op->flush) {
 285                 filemap_write_and_wait(file->f_mapping);
 286                 return lower_file->f_op->flush(lower_file, td);
 287         }
 288
 289         return 0;
 290 }
 291
 292 static int ecryptfs_release(struct inode *inode, struct file *file)
 293 {
 294         ecryptfs_put_lower_file(inode);
 295         kmem_cache_free(ecryptfs_file_info_cache,
 296                         ecryptfs_file_to_private(file));
 297         return 0;
 298 }
 299
 300 static int ecryptfs_dir_release(struct inode *inode, struct file *file)
 301 {
 302         fput(ecryptfs_file_to_lower(file));
 303         kmem_cache_free(ecryptfs_file_info_cache,
 304                         ecryptfs_file_to_private(file));
 305         return 0;
 306 }
 307
 308 static loff_t ecryptfs_dir_llseek(struct file *file, loff_t offset, int whence)
 309 {
 310         return vfs_llseek(ecryptfs_file_to_lower(file), offset, whence);
 311 }
 312
 313 static int
 314 ecryptfs_fsync(struct file *file, loff_t start, loff_t end, int datasync)
 315 {
 316         int rc;
 317
 318         rc = filemap_write_and_wait(file->f_mapping);
 319         if (rc)
 320                 return rc;
 321
 322         return vfs_fsync(ecryptfs_file_to_lower(file), datasync);
 323 }
 324
 325 static int ecryptfs_fasync(int fd, struct file *file, int flag)
 326 {
 327         int rc = 0;
 328         struct file *lower_file = NULL;
 329
 330         lower_file = ecryptfs_file_to_lower(file);
 331         if (lower_file->f_op->fasync)
 332                 rc = lower_file->f_op->fasync(fd, lower_file, flag);
 333         return rc;
 334 }
 335
 336 static long
 337 ecryptfs_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 338 {
 339         struct file *lower_file = ecryptfs_file_to_lower(file);
 340         long rc = -ENOTTY;
 341
 342         if (!lower_file->f_op->unlocked_ioctl)
 343                 return rc;
 344
 345         switch (cmd) {
 346         case FITRIM:
 347         case FS_IOC_GETFLAGS:
 348         case FS_IOC_SETFLAGS:
 349         case FS_IOC_GETVERSION:
 350         case FS_IOC_SETVERSION:
 351                 rc = lower_file->f_op->unlocked_ioctl(lower_file, cmd, arg);
 352                 fsstack_copy_attr_all(file_inode(file), file_inode(lower_file));
 353
 354                 return rc;
 355         default:
 356                 return rc;
 357         }
 358 }
 359
 360 #ifdef CONFIG_COMPAT
 361 static long
 362 ecryptfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 363 {
 364         struct file *lower_file = ecryptfs_file_to_lower(file);
 365         long rc = -ENOIOCTLCMD;
 366
 367         if (!lower_file->f_op->compat_ioctl)
 368                 return rc;
 369
 370         switch (cmd) {
 371         case FS_IOC32_GETFLAGS:
 372         case FS_IOC32_SETFLAGS:
 373         case FS_IOC32_GETVERSION:
 374         case FS_IOC32_SETVERSION:
 375                 rc = lower_file->f_op->compat_ioctl(lower_file, cmd, arg);
 376                 fsstack_copy_attr_all(file_inode(file), file_inode(lower_file));
 377
 378                 return rc;
 379         default:
 380                 return rc;
 381         }
 382 }
 383 #endif
 384
 385 const struct file_operations ecryptfs_dir_fops = {
 386         .iterate = ecryptfs_readdir,
 387         .read = generic_read_dir,
 388         .unlocked_ioctl = ecryptfs_unlocked_ioctl,
 389 #ifdef CONFIG_COMPAT
 390         .compat_ioctl = ecryptfs_compat_ioctl,
 391 #endif
 392         .open = ecryptfs_dir_open,
 393         .release = ecryptfs_dir_release,
 394         .fsync = ecryptfs_fsync,
 395         .llseek = ecryptfs_dir_llseek,
 396 };
 397
 398 const struct file_operations ecryptfs_main_fops = {
 399         .llseek = generic_file_llseek,
 400         .read_iter = ecryptfs_read_update_atime,
 401         .write_iter = generic_file_write_iter,
 402         .unlocked_ioctl = ecryptfs_unlocked_ioctl,
 403 #ifdef CONFIG_COMPAT
 404         .compat_ioctl = ecryptfs_compat_ioctl,
 405 #endif
 406         .mmap = generic_file_mmap,
 407         .open = ecryptfs_open,
 408         .flush = ecryptfs_flush,
 409         .release = ecryptfs_release,
 410         .fsync = ecryptfs_fsync,
 411         .fasync = ecryptfs_fasync,
 412         .splice_read = generic_file_splice_read,
 413 };