^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * eCryptfs: Linux filesystem encryption layer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 1997-2003 Erez Zadok
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 2001-2003 Stony Brook University
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Copyright (C) 2004-2006 International Business Machines Corp.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * Michael C. Thompson <mcthomps@us.ibm.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/fs.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/mount.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/key.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/seq_file.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/file.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <linux/statfs.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <linux/magic.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #include "ecryptfs_kernel.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) struct kmem_cache *ecryptfs_inode_info_cache;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) * ecryptfs_alloc_inode - allocate an ecryptfs inode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * @sb: Pointer to the ecryptfs super block
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) * Called to bring an inode into existence.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * Only handle allocation, setting up structures should be done in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * ecryptfs_read_inode. This is because the kernel, between now and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * then, will 0 out the private data pointer.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * Returns a pointer to a newly allocated inode, NULL otherwise
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) static struct inode *ecryptfs_alloc_inode(struct super_block *sb)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) struct ecryptfs_inode_info *inode_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) struct inode *inode = NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) inode_info = kmem_cache_alloc(ecryptfs_inode_info_cache, GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) if (unlikely(!inode_info))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) goto out;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) if (ecryptfs_init_crypt_stat(&inode_info->crypt_stat)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) kmem_cache_free(ecryptfs_inode_info_cache, inode_info);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) goto out;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) mutex_init(&inode_info->lower_file_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) atomic_set(&inode_info->lower_file_count, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) inode_info->lower_file = NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) inode = &inode_info->vfs_inode;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) out:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) return inode;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) static void ecryptfs_free_inode(struct inode *inode)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) struct ecryptfs_inode_info *inode_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) inode_info = ecryptfs_inode_to_private(inode);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) kmem_cache_free(ecryptfs_inode_info_cache, inode_info);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) * ecryptfs_destroy_inode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) * @inode: The ecryptfs inode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) * This is used during the final destruction of the inode. All
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) * allocation of memory related to the inode, including allocated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) * memory in the crypt_stat struct, will be released here.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) * There should be no chance that this deallocation will be missed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) static void ecryptfs_destroy_inode(struct inode *inode)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) struct ecryptfs_inode_info *inode_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) inode_info = ecryptfs_inode_to_private(inode);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) BUG_ON(inode_info->lower_file);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) ecryptfs_destroy_crypt_stat(&inode_info->crypt_stat);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) * ecryptfs_statfs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) * @sb: The ecryptfs super block
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) * @buf: The struct kstatfs to fill in with stats
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) * Get the filesystem statistics. Currently, we let this pass right through
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) * to the lower filesystem and take no action ourselves.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) static int ecryptfs_statfs(struct dentry *dentry, struct kstatfs *buf)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) int rc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) if (!lower_dentry->d_sb->s_op->statfs)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) return -ENOSYS;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) rc = lower_dentry->d_sb->s_op->statfs(lower_dentry, buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) if (rc)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) return rc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) buf->f_type = ECRYPTFS_SUPER_MAGIC;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) rc = ecryptfs_set_f_namelen(&buf->f_namelen, buf->f_namelen,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) &ecryptfs_superblock_to_private(dentry->d_sb)->mount_crypt_stat);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) return rc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) * ecryptfs_evict_inode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) * @inode - The ecryptfs inode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) * Called by iput() when the inode reference count reached zero
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) * and the inode is not hashed anywhere. Used to clear anything
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) * that needs to be, before the inode is completely destroyed and put
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) * on the inode free list. We use this to drop out reference to the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) * lower inode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) static void ecryptfs_evict_inode(struct inode *inode)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) truncate_inode_pages_final(&inode->i_data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) clear_inode(inode);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) iput(ecryptfs_inode_to_lower(inode));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) * ecryptfs_show_options
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) * Prints the mount options for a given superblock.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) * Returns zero; does not fail.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) static int ecryptfs_show_options(struct seq_file *m, struct dentry *root)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) struct super_block *sb = root->d_sb;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) &ecryptfs_superblock_to_private(sb)->mount_crypt_stat;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) struct ecryptfs_global_auth_tok *walker;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) list_for_each_entry(walker,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) &mount_crypt_stat->global_auth_tok_list,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) mount_crypt_stat_list) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) if (walker->flags & ECRYPTFS_AUTH_TOK_FNEK)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) seq_printf(m, ",ecryptfs_fnek_sig=%s", walker->sig);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) seq_printf(m, ",ecryptfs_sig=%s", walker->sig);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) seq_printf(m, ",ecryptfs_cipher=%s",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) mount_crypt_stat->global_default_cipher_name);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) if (mount_crypt_stat->global_default_cipher_key_size)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) seq_printf(m, ",ecryptfs_key_bytes=%zd",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) mount_crypt_stat->global_default_cipher_key_size);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) if (mount_crypt_stat->flags & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) seq_printf(m, ",ecryptfs_passthrough");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) if (mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) seq_printf(m, ",ecryptfs_xattr_metadata");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) seq_printf(m, ",ecryptfs_encrypted_view");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) if (mount_crypt_stat->flags & ECRYPTFS_UNLINK_SIGS)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) seq_printf(m, ",ecryptfs_unlink_sigs");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) seq_printf(m, ",ecryptfs_mount_auth_tok_only");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) const struct super_operations ecryptfs_sops = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) .alloc_inode = ecryptfs_alloc_inode,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) .destroy_inode = ecryptfs_destroy_inode,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) .free_inode = ecryptfs_free_inode,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) .statfs = ecryptfs_statfs,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) .remount_fs = NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) .evict_inode = ecryptfs_evict_inode,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) .show_options = ecryptfs_show_options
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) };