[mirror_ubuntu-bionic-kernel.git] / fs / ecryptfs / super.c

/**
 * eCryptfs: Linux filesystem encryption layer
 *
 * Copyright (C) 1997-2003 Erez Zadok
 * Copyright (C) 2001-2003 Stony Brook University
 * Copyright (C) 2004-2006 International Business Machines Corp.
 *   Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
 *              Michael C. Thompson <mcthomps@us.ibm.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#include <linux/fs.h>
#include <linux/mount.h>
#include <linux/key.h>
#include <linux/seq_file.h>
#include <linux/file.h>
#include <linux/crypto.h>
#include "ecryptfs_kernel.h"

struct kmem_cache *ecryptfs_inode_info_cache;

/**
 * ecryptfs_alloc_inode - allocate an ecryptfs inode
 * @sb: Pointer to the ecryptfs super block
 *
 * Called to bring an inode into existence.
 *
 * Only handle allocation, setting up structures should be done in
 * ecryptfs_read_inode. This is because the kernel, between now and
 * then, will 0 out the private data pointer.
 *
 * Returns a pointer to a newly allocated inode, NULL otherwise
 */
static struct inode *ecryptfs_alloc_inode(struct super_block *sb)
{
	struct ecryptfs_inode_info *inode_info;
	struct inode *inode = NULL;

	inode_info = kmem_cache_alloc(ecryptfs_inode_info_cache, GFP_KERNEL);
	if (unlikely(!inode_info))
		goto out;
	ecryptfs_init_crypt_stat(&inode_info->crypt_stat);
	mutex_init(&inode_info->lower_file_mutex);
	inode_info->lower_file = NULL;
	inode = &inode_info->vfs_inode;
out:
	return inode;
}

/**
 * ecryptfs_destroy_inode
 * @inode: The ecryptfs inode
 *
 * This is used during the final destruction of the inode.  All
 * allocation of memory related to the inode, including allocated
 * memory in the crypt_stat struct, will be released here. This
 * function also fput()'s the persistent file for the lower inode.
 * There should be no chance that this deallocation will be missed.
 */
static void ecryptfs_destroy_inode(struct inode *inode)
{
	struct ecryptfs_inode_info *inode_info;

	inode_info = ecryptfs_inode_to_private(inode);
	mutex_lock(&inode_info->lower_file_mutex);
	if (inode_info->lower_file) {
		struct dentry *lower_dentry =
			inode_info->lower_file->f_dentry;

		BUG_ON(!lower_dentry);
		if (lower_dentry->d_inode) {
			fput(inode_info->lower_file);
			inode_info->lower_file = NULL;
			d_drop(lower_dentry);
		}
	}
	mutex_unlock(&inode_info->lower_file_mutex);
	ecryptfs_destroy_crypt_stat(&inode_info->crypt_stat);
	kmem_cache_free(ecryptfs_inode_info_cache, inode_info);
}

/**
 * ecryptfs_init_inode
 * @inode: The ecryptfs inode
 *
 * Set up the ecryptfs inode.
 */
void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode)
{
	ecryptfs_set_inode_lower(inode, lower_inode);
	inode->i_ino = lower_inode->i_ino;
	inode->i_version++;
	inode->i_op = &ecryptfs_main_iops;
	inode->i_fop = &ecryptfs_main_fops;
	inode->i_mapping->a_ops = &ecryptfs_aops;
}

/**
 * ecryptfs_put_super
 * @sb: Pointer to the ecryptfs super block
 *
 * Final actions when unmounting a file system.
 * This will handle deallocation and release of our private data.
 */
static void ecryptfs_put_super(struct super_block *sb)
{
	struct ecryptfs_sb_info *sb_info = ecryptfs_superblock_to_private(sb);

	ecryptfs_destroy_mount_crypt_stat(&sb_info->mount_crypt_stat);
	kmem_cache_free(ecryptfs_sb_info_cache, sb_info);
	ecryptfs_set_superblock_private(sb, NULL);
}

/**
 * ecryptfs_statfs
 * @sb: The ecryptfs super block
 * @buf: The struct kstatfs to fill in with stats
 *
 * Get the filesystem statistics. Currently, we let this pass right through
 * to the lower filesystem and take no action ourselves.
 */
static int ecryptfs_statfs(struct dentry *dentry, struct kstatfs *buf)
{
	return vfs_statfs(ecryptfs_dentry_to_lower(dentry), buf);
}

/**
 * ecryptfs_clear_inode
 * @inode - The ecryptfs inode
 *
 * Called by iput() when the inode reference count reached zero
 * and the inode is not hashed anywhere.  Used to clear anything
 * that needs to be, before the inode is completely destroyed and put
 * on the inode free list. We use this to drop out reference to the
 * lower inode.
 */
static void ecryptfs_clear_inode(struct inode *inode)
{
	iput(ecryptfs_inode_to_lower(inode));
}

/**
 * ecryptfs_show_options
 *
 * Prints the mount options for a given superblock.
 * Returns zero; does not fail.
 */
static int ecryptfs_show_options(struct seq_file *m, struct vfsmount *mnt)
{
	struct super_block *sb = mnt->mnt_sb;
	struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
		&ecryptfs_superblock_to_private(sb)->mount_crypt_stat;
	struct ecryptfs_global_auth_tok *walker;

	mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
	list_for_each_entry(walker,
			    &mount_crypt_stat->global_auth_tok_list,
			    mount_crypt_stat_list) {
		if (walker->flags & ECRYPTFS_AUTH_TOK_FNEK)
			seq_printf(m, ",ecryptfs_fnek_sig=%s", walker->sig);
		else
			seq_printf(m, ",ecryptfs_sig=%s", walker->sig);
	}
	mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);

	seq_printf(m, ",ecryptfs_cipher=%s",
		mount_crypt_stat->global_default_cipher_name);

	if (mount_crypt_stat->global_default_cipher_key_size)
		seq_printf(m, ",ecryptfs_key_bytes=%zd",
			   mount_crypt_stat->global_default_cipher_key_size);
	if (mount_crypt_stat->flags & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)
		seq_printf(m, ",ecryptfs_passthrough");
	if (mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED)
		seq_printf(m, ",ecryptfs_xattr_metadata");
	if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
		seq_printf(m, ",ecryptfs_encrypted_view");
	if (mount_crypt_stat->flags & ECRYPTFS_UNLINK_SIGS)
		seq_printf(m, ",ecryptfs_unlink_sigs");

	return 0;
}

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