• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 <linux/aio.h>
35 #include "ecryptfs_kernel.h"
36 
37 /**
38  * ecryptfs_read_update_atime
39  *
40  * generic_file_read updates the atime of upper layer inode.  But, it
41  * doesn't give us a chance to update the atime of the lower layer
42  * inode.  This function is a wrapper to generic_file_read.  It
43  * updates the atime of the lower level inode if generic_file_read
44  * returns without any errors. This is to be used only for file reads.
45  * The function to be used for directory reads is ecryptfs_read.
46  */
ecryptfs_read_update_atime(struct kiocb * iocb,const struct iovec * iov,unsigned long nr_segs,loff_t pos)47 static ssize_t ecryptfs_read_update_atime(struct kiocb *iocb,
48 				const struct iovec *iov,
49 				unsigned long nr_segs, loff_t pos)
50 {
51 	ssize_t rc;
52 	struct path lower;
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.mnt = ecryptfs_dentry_to_lower_mnt(file->f_path.dentry);
65 		touch_atime(&lower);
66 	}
67 	return rc;
68 }
69 
70 struct ecryptfs_getdents_callback {
71 	struct dir_context ctx;
72 	void *dirent;
73 	struct dentry *dentry;
74 	filldir_t filldir;
75 	int filldir_called;
76 	int entries_written;
77 };
78 
79 /* Inspired by generic filldir in fs/readdir.c */
80 static int
ecryptfs_filldir(void * dirent,const char * lower_name,int lower_namelen,loff_t offset,u64 ino,unsigned int d_type)81 ecryptfs_filldir(void *dirent, const char *lower_name, int lower_namelen,
82 		 loff_t offset, u64 ino, unsigned int d_type)
83 {
84 	struct ecryptfs_getdents_callback *buf =
85 	    (struct ecryptfs_getdents_callback *)dirent;
86 	size_t name_size;
87 	char *name;
88 	int rc;
89 
90 	buf->filldir_called++;
91 	rc = ecryptfs_decode_and_decrypt_filename(&name, &name_size,
92 						  buf->dentry, lower_name,
93 						  lower_namelen);
94 	if (rc) {
95 		printk(KERN_ERR "%s: Error attempting to decode and decrypt "
96 		       "filename [%s]; rc = [%d]\n", __func__, lower_name,
97 		       rc);
98 		goto out;
99 	}
100 	rc = buf->filldir(buf->dirent, name, name_size, offset, ino, d_type);
101 	kfree(name);
102 	if (rc >= 0)
103 		buf->entries_written++;
104 out:
105 	return rc;
106 }
107 
108 /**
109  * ecryptfs_readdir
110  * @file: The eCryptfs directory file
111  * @dirent: Directory entry handle
112  * @filldir: The filldir callback function
113  */
ecryptfs_readdir(struct file * file,void * dirent,filldir_t filldir)114 static int ecryptfs_readdir(struct file *file, void *dirent, filldir_t filldir)
115 {
116 	int rc;
117 	struct file *lower_file;
118 	struct inode *inode;
119 	struct ecryptfs_getdents_callback buf = {
120 		.dirent = dirent,
121 		.dentry = file->f_path.dentry,
122 		.filldir = filldir,
123 		.filldir_called = 0,
124 		.entries_written = 0,
125 		.ctx.actor = ecryptfs_filldir
126 	};
127 
128 	lower_file = ecryptfs_file_to_lower(file);
129 	lower_file->f_pos = file->f_pos;
130 	inode = file_inode(file);
131 	rc = iterate_dir(lower_file, &buf.ctx);
132 	file->f_pos = lower_file->f_pos;
133 	if (rc < 0)
134 		goto out;
135 	if (buf.filldir_called && !buf.entries_written)
136 		goto out;
137 	if (rc >= 0)
138 		fsstack_copy_attr_atime(inode,
139 					file_inode(lower_file));
140 out:
141 	return rc;
142 }
143 
144 struct kmem_cache *ecryptfs_file_info_cache;
145 
read_or_initialize_metadata(struct dentry * dentry)146 static int read_or_initialize_metadata(struct dentry *dentry)
147 {
148 	struct inode *inode = dentry->d_inode;
149 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
150 	struct ecryptfs_crypt_stat *crypt_stat;
151 	int rc;
152 
153 	crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
154 	mount_crypt_stat = &ecryptfs_superblock_to_private(
155 						inode->i_sb)->mount_crypt_stat;
156 	mutex_lock(&crypt_stat->cs_mutex);
157 
158 	if (crypt_stat->flags & ECRYPTFS_POLICY_APPLIED &&
159 	    crypt_stat->flags & ECRYPTFS_KEY_VALID) {
160 		rc = 0;
161 		goto out;
162 	}
163 
164 	rc = ecryptfs_read_metadata(dentry);
165 	if (!rc)
166 		goto out;
167 
168 	if (mount_crypt_stat->flags & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED) {
169 		crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
170 				       | ECRYPTFS_ENCRYPTED);
171 		rc = 0;
172 		goto out;
173 	}
174 
175 	if (!(mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED) &&
176 	    !i_size_read(ecryptfs_inode_to_lower(inode))) {
177 		rc = ecryptfs_initialize_file(dentry, inode);
178 		if (!rc)
179 			goto out;
180 	}
181 
182 	rc = -EIO;
183 out:
184 	mutex_unlock(&crypt_stat->cs_mutex);
185 	return rc;
186 }
187 
ecryptfs_mmap(struct file * file,struct vm_area_struct * vma)188 static int ecryptfs_mmap(struct file *file, struct vm_area_struct *vma)
189 {
190 	struct file *lower_file = ecryptfs_file_to_lower(file);
191 	/*
192 	 * Don't allow mmap on top of file systems that don't support it
193 	 * natively.  If FILESYSTEM_MAX_STACK_DEPTH > 2 or ecryptfs
194 	 * allows recursive mounting, this will need to be extended.
195 	 */
196 	if (!lower_file->f_op->mmap)
197 		return -ENODEV;
198 	return generic_file_mmap(file, vma);
199 }
200 
201 /**
202  * ecryptfs_open
203  * @inode: inode speciying file to open
204  * @file: Structure to return filled in
205  *
206  * Opens the file specified by inode.
207  *
208  * Returns zero on success; non-zero otherwise
209  */
ecryptfs_open(struct inode * inode,struct file * file)210 static int ecryptfs_open(struct inode *inode, struct file *file)
211 {
212 	int rc = 0;
213 	struct ecryptfs_crypt_stat *crypt_stat = NULL;
214 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
215 	struct dentry *ecryptfs_dentry = file->f_path.dentry;
216 	/* Private value of ecryptfs_dentry allocated in
217 	 * ecryptfs_lookup() */
218 	struct ecryptfs_file_info *file_info;
219 
220 	mount_crypt_stat = &ecryptfs_superblock_to_private(
221 		ecryptfs_dentry->d_sb)->mount_crypt_stat;
222 	if ((mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
223 	    && ((file->f_flags & O_WRONLY) || (file->f_flags & O_RDWR)
224 		|| (file->f_flags & O_CREAT) || (file->f_flags & O_TRUNC)
225 		|| (file->f_flags & O_APPEND))) {
226 		printk(KERN_WARNING "Mount has encrypted view enabled; "
227 		       "files may only be read\n");
228 		rc = -EPERM;
229 		goto out;
230 	}
231 	/* Released in ecryptfs_release or end of function if failure */
232 	file_info = kmem_cache_zalloc(ecryptfs_file_info_cache, GFP_KERNEL);
233 	ecryptfs_set_file_private(file, file_info);
234 	if (!file_info) {
235 		ecryptfs_printk(KERN_ERR,
236 				"Error attempting to allocate memory\n");
237 		rc = -ENOMEM;
238 		goto out;
239 	}
240 	crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
241 	mutex_lock(&crypt_stat->cs_mutex);
242 	if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)) {
243 		ecryptfs_printk(KERN_DEBUG, "Setting flags for stat...\n");
244 		/* Policy code enabled in future release */
245 		crypt_stat->flags |= (ECRYPTFS_POLICY_APPLIED
246 				      | ECRYPTFS_ENCRYPTED);
247 	}
248 	mutex_unlock(&crypt_stat->cs_mutex);
249 	rc = ecryptfs_get_lower_file(ecryptfs_dentry, inode);
250 	if (rc) {
251 		printk(KERN_ERR "%s: Error attempting to initialize "
252 			"the lower file for the dentry with name "
253 			"[%s]; rc = [%d]\n", __func__,
254 			ecryptfs_dentry->d_name.name, rc);
255 		goto out_free;
256 	}
257 	if ((ecryptfs_inode_to_private(inode)->lower_file->f_flags & O_ACCMODE)
258 	    == O_RDONLY && (file->f_flags & O_ACCMODE) != O_RDONLY) {
259 		rc = -EPERM;
260 		printk(KERN_WARNING "%s: Lower file is RO; eCryptfs "
261 		       "file must hence be opened RO\n", __func__);
262 		goto out_put;
263 	}
264 	ecryptfs_set_file_lower(
265 		file, ecryptfs_inode_to_private(inode)->lower_file);
266 	if (S_ISDIR(ecryptfs_dentry->d_inode->i_mode)) {
267 		ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
268 		mutex_lock(&crypt_stat->cs_mutex);
269 		crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
270 		mutex_unlock(&crypt_stat->cs_mutex);
271 		rc = 0;
272 		goto out;
273 	}
274 	rc = read_or_initialize_metadata(ecryptfs_dentry);
275 	if (rc)
276 		goto out_put;
277 	ecryptfs_printk(KERN_DEBUG, "inode w/ addr = [0x%p], i_ino = "
278 			"[0x%.16lx] size: [0x%.16llx]\n", inode, inode->i_ino,
279 			(unsigned long long)i_size_read(inode));
280 	goto out;
281 out_put:
282 	ecryptfs_put_lower_file(inode);
283 out_free:
284 	kmem_cache_free(ecryptfs_file_info_cache,
285 			ecryptfs_file_to_private(file));
286 out:
287 	return rc;
288 }
289 
ecryptfs_flush(struct file * file,fl_owner_t td)290 static int ecryptfs_flush(struct file *file, fl_owner_t td)
291 {
292 	struct file *lower_file = ecryptfs_file_to_lower(file);
293 
294 	if (lower_file->f_op && lower_file->f_op->flush) {
295 		filemap_write_and_wait(file->f_mapping);
296 		return lower_file->f_op->flush(lower_file, td);
297 	}
298 
299 	return 0;
300 }
301 
ecryptfs_release(struct inode * inode,struct file * file)302 static int ecryptfs_release(struct inode *inode, struct file *file)
303 {
304 	ecryptfs_put_lower_file(inode);
305 	kmem_cache_free(ecryptfs_file_info_cache,
306 			ecryptfs_file_to_private(file));
307 	return 0;
308 }
309 
310 static int
ecryptfs_fsync(struct file * file,loff_t start,loff_t end,int datasync)311 ecryptfs_fsync(struct file *file, loff_t start, loff_t end, int datasync)
312 {
313 	int rc;
314 
315 	rc = filemap_write_and_wait(file->f_mapping);
316 	if (rc)
317 		return rc;
318 
319 	return vfs_fsync(ecryptfs_file_to_lower(file), datasync);
320 }
321 
ecryptfs_fasync(int fd,struct file * file,int flag)322 static int ecryptfs_fasync(int fd, struct file *file, int flag)
323 {
324 	int rc = 0;
325 	struct file *lower_file = NULL;
326 
327 	lower_file = ecryptfs_file_to_lower(file);
328 	if (lower_file->f_op && lower_file->f_op->fasync)
329 		rc = lower_file->f_op->fasync(fd, lower_file, flag);
330 	return rc;
331 }
332 
333 static long
ecryptfs_unlocked_ioctl(struct file * file,unsigned int cmd,unsigned long arg)334 ecryptfs_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
335 {
336 	struct file *lower_file = NULL;
337 	long rc = -ENOTTY;
338 
339 	if (ecryptfs_file_to_private(file))
340 		lower_file = ecryptfs_file_to_lower(file);
341 	if (lower_file && lower_file->f_op && lower_file->f_op->unlocked_ioctl)
342 		rc = lower_file->f_op->unlocked_ioctl(lower_file, cmd, arg);
343 	return rc;
344 }
345 
346 #ifdef CONFIG_COMPAT
347 static long
ecryptfs_compat_ioctl(struct file * file,unsigned int cmd,unsigned long arg)348 ecryptfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
349 {
350 	struct file *lower_file = NULL;
351 	long rc = -ENOIOCTLCMD;
352 
353 	if (ecryptfs_file_to_private(file))
354 		lower_file = ecryptfs_file_to_lower(file);
355 	if (lower_file && lower_file->f_op && lower_file->f_op->compat_ioctl)
356 		rc = lower_file->f_op->compat_ioctl(lower_file, cmd, arg);
357 	return rc;
358 }
359 #endif
360 
361 const struct file_operations ecryptfs_dir_fops = {
362 	.readdir = ecryptfs_readdir,
363 	.read = generic_read_dir,
364 	.unlocked_ioctl = ecryptfs_unlocked_ioctl,
365 #ifdef CONFIG_COMPAT
366 	.compat_ioctl = ecryptfs_compat_ioctl,
367 #endif
368 	.open = ecryptfs_open,
369 	.flush = ecryptfs_flush,
370 	.release = ecryptfs_release,
371 	.fsync = ecryptfs_fsync,
372 	.fasync = ecryptfs_fasync,
373 	.splice_read = generic_file_splice_read,
374 	.llseek = default_llseek,
375 };
376 
377 const struct file_operations ecryptfs_main_fops = {
378 	.llseek = generic_file_llseek,
379 	.read = do_sync_read,
380 	.aio_read = ecryptfs_read_update_atime,
381 	.write = do_sync_write,
382 	.aio_write = generic_file_aio_write,
383 	.readdir = ecryptfs_readdir,
384 	.unlocked_ioctl = ecryptfs_unlocked_ioctl,
385 #ifdef CONFIG_COMPAT
386 	.compat_ioctl = ecryptfs_compat_ioctl,
387 #endif
388 	.mmap = ecryptfs_mmap,
389 	.open = ecryptfs_open,
390 	.flush = ecryptfs_flush,
391 	.release = ecryptfs_release,
392 	.fsync = ecryptfs_fsync,
393 	.fasync = ecryptfs_fasync,
394 	.splice_read = generic_file_splice_read,
395 };
396