fs/ecryptfs/super.c

   1 /**
   2  * eCryptfs: Linux filesystem encryption layer
   3  *
   4  * Copyright (C) 1997-2003 Erez Zadok
   5  * Copyright (C) 2001-2003 Stony Brook University
   6  * Copyright (C) 2004-2006 International Business Machines Corp.
   7  *   Author(s): Michael A. Halcrow <mahalcro@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/fs.h>
  27 #include <linux/mount.h>
  28 #include <linux/key.h>
  29 #include <linux/seq_file.h>
  30 #include <linux/smp_lock.h>
  31 #include <linux/file.h>
  32 #include <linux/crypto.h>
  33 #include "ecryptfs_kernel.h"
  34
  35 struct kmem_cache *ecryptfs_inode_info_cache;
  36
  37 /**
  38  * ecryptfs_alloc_inode - allocate an ecryptfs inode
  39  * @sb: Pointer to the ecryptfs super block
  40  *
  41  * Called to bring an inode into existence.
  42  *
  43  * Only handle allocation, setting up structures should be done in
  44  * ecryptfs_read_inode. This is because the kernel, between now and
  45  * then, will 0 out the private data pointer.
  46  *
  47  * Returns a pointer to a newly allocated inode, NULL otherwise
  48  */
  49 static struct inode *ecryptfs_alloc_inode(struct super_block *sb)
  50 {
  51         struct ecryptfs_inode_info *inode_info;
  52         struct inode *inode = NULL;
  53
  54         inode_info = kmem_cache_alloc(ecryptfs_inode_info_cache, GFP_KERNEL);
  55         if (unlikely(!inode_info))
  56                 goto out;
  57         ecryptfs_init_crypt_stat(&inode_info->crypt_stat);
  58         mutex_init(&inode_info->lower_file_mutex);
  59         inode_info->lower_file = NULL;
  60         inode = &inode_info->vfs_inode;
  61 out:
  62         return inode;
  63 }
  64
  65 /**
  66  * ecryptfs_destroy_inode
  67  * @inode: The ecryptfs inode
  68  *
  69  * This is used during the final destruction of the inode.  All
  70  * allocation of memory related to the inode, including allocated
  71  * memory in the crypt_stat struct, will be released here. This
  72  * function also fput()'s the persistent file for the lower inode.
  73  * There should be no chance that this deallocation will be missed.
  74  */
  75 static void ecryptfs_destroy_inode(struct inode *inode)
  76 {
  77         struct ecryptfs_inode_info *inode_info;
  78
  79         inode_info = ecryptfs_inode_to_private(inode);
  80         if (inode_info->lower_file) {
  81                 struct dentry *lower_dentry =
  82                         inode_info->lower_file->f_dentry;
  83
  84                 BUG_ON(!lower_dentry);
  85                 if (lower_dentry->d_inode) {
  86                         fput(inode_info->lower_file);
  87                         inode_info->lower_file = NULL;
  88                         d_drop(lower_dentry);
  89                 }
  90         }
  91         ecryptfs_destroy_crypt_stat(&inode_info->crypt_stat);
  92         kmem_cache_free(ecryptfs_inode_info_cache, inode_info);
  93 }
  94
  95 /**
  96  * ecryptfs_init_inode
  97  * @inode: The ecryptfs inode
  98  *
  99  * Set up the ecryptfs inode.
 100  */
 101 void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode)
 102 {
 103         ecryptfs_set_inode_lower(inode, lower_inode);
 104         inode->i_ino = lower_inode->i_ino;
 105         inode->i_version++;
 106         inode->i_op = &ecryptfs_main_iops;
 107         inode->i_fop = &ecryptfs_main_fops;
 108         inode->i_mapping->a_ops = &ecryptfs_aops;
 109 }
 110
 111 /**
 112  * ecryptfs_put_super
 113  * @sb: Pointer to the ecryptfs super block
 114  *
 115  * Final actions when unmounting a file system.
 116  * This will handle deallocation and release of our private data.
 117  */
 118 static void ecryptfs_put_super(struct super_block *sb)
 119 {
 120         struct ecryptfs_sb_info *sb_info = ecryptfs_superblock_to_private(sb);
 121
 122         lock_kernel();
 123
 124         ecryptfs_destroy_mount_crypt_stat(&sb_info->mount_crypt_stat);
 125         kmem_cache_free(ecryptfs_sb_info_cache, sb_info);
 126         ecryptfs_set_superblock_private(sb, NULL);
 127
 128         unlock_kernel();
 129 }
 130
 131 /**
 132  * ecryptfs_statfs
 133  * @sb: The ecryptfs super block
 134  * @buf: The struct kstatfs to fill in with stats
 135  *
 136  * Get the filesystem statistics. Currently, we let this pass right through
 137  * to the lower filesystem and take no action ourselves.
 138  */
 139 static int ecryptfs_statfs(struct dentry *dentry, struct kstatfs *buf)
 140 {
 141         return vfs_statfs(ecryptfs_dentry_to_lower(dentry), buf);
 142 }
 143
 144 /**
 145  * ecryptfs_clear_inode
 146  * @inode - The ecryptfs inode
 147  *
 148  * Called by iput() when the inode reference count reached zero
 149  * and the inode is not hashed anywhere.  Used to clear anything
 150  * that needs to be, before the inode is completely destroyed and put
 151  * on the inode free list. We use this to drop out reference to the
 152  * lower inode.
 153  */
 154 static void ecryptfs_clear_inode(struct inode *inode)
 155 {
 156         iput(ecryptfs_inode_to_lower(inode));
 157 }
 158
 159 /**
 160  * ecryptfs_show_options
 161  *
 162  * Prints the mount options for a given superblock.
 163  * Returns zero; does not fail.
 164  */
 165 static int ecryptfs_show_options(struct seq_file *m, struct vfsmount *mnt)
 166 {
 167         struct super_block *sb = mnt->mnt_sb;
 168         struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
 169                 &ecryptfs_superblock_to_private(sb)->mount_crypt_stat;
 170         struct ecryptfs_global_auth_tok *walker;
 171
 172         mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
 173         list_for_each_entry(walker,
 174                             &mount_crypt_stat->global_auth_tok_list,
 175                             mount_crypt_stat_list) {
 176                 if (walker->flags & ECRYPTFS_AUTH_TOK_FNEK)
 177                         seq_printf(m, ",ecryptfs_fnek_sig=%s", walker->sig);
 178                 else
 179                         seq_printf(m, ",ecryptfs_sig=%s", walker->sig);
 180         }
 181         mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);
 182
 183         seq_printf(m, ",ecryptfs_cipher=%s",
 184                 mount_crypt_stat->global_default_cipher_name);
 185
 186         if (mount_crypt_stat->global_default_cipher_key_size)
 187                 seq_printf(m, ",ecryptfs_key_bytes=%zd",
 188                            mount_crypt_stat->global_default_cipher_key_size);
 189         if (mount_crypt_stat->flags & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)
 190                 seq_printf(m, ",ecryptfs_passthrough");
 191         if (mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED)
 192                 seq_printf(m, ",ecryptfs_xattr_metadata");
 193         if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
 194                 seq_printf(m, ",ecryptfs_encrypted_view");
 195         if (mount_crypt_stat->flags & ECRYPTFS_UNLINK_SIGS)
 196                 seq_printf(m, ",ecryptfs_unlink_sigs");
 197
 198         return 0;
 199 }
 200
 201 const struct super_operations ecryptfs_sops = {
 202         .alloc_inode = ecryptfs_alloc_inode,
 203         .destroy_inode = ecryptfs_destroy_inode,
 204         .drop_inode = generic_delete_inode,
 205         .put_super = ecryptfs_put_super,
 206         .statfs = ecryptfs_statfs,
 207         .remount_fs = NULL,
 208         .clear_inode = ecryptfs_clear_inode,
 209         .show_options = ecryptfs_show_options
 210 };