xref: /openbmc/linux/fs/ecryptfs/inode.c (revision 3aeb86ea4cd15f728147a3bd5469a205ada8c767)
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 <mahalcro@us.ibm.com>
8  *              Michael C. Thompsion <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/vmalloc.h>
28 #include <linux/pagemap.h>
29 #include <linux/dcache.h>
30 #include <linux/namei.h>
31 #include <linux/mount.h>
32 #include <linux/crypto.h>
33 #include <linux/fs_stack.h>
34 #include <linux/slab.h>
35 #include <linux/xattr.h>
36 #include <asm/unaligned.h>
37 #include "ecryptfs_kernel.h"
38 
39 static struct dentry *lock_parent(struct dentry *dentry)
40 {
41 	struct dentry *dir;
42 
43 	dir = dget_parent(dentry);
44 	mutex_lock_nested(&(dir->d_inode->i_mutex), I_MUTEX_PARENT);
45 	return dir;
46 }
47 
48 static void unlock_dir(struct dentry *dir)
49 {
50 	mutex_unlock(&dir->d_inode->i_mutex);
51 	dput(dir);
52 }
53 
54 /**
55  * ecryptfs_create_underlying_file
56  * @lower_dir_inode: inode of the parent in the lower fs of the new file
57  * @dentry: New file's dentry
58  * @mode: The mode of the new file
59  * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
60  *
61  * Creates the file in the lower file system.
62  *
63  * Returns zero on success; non-zero on error condition
64  */
65 static int
66 ecryptfs_create_underlying_file(struct inode *lower_dir_inode,
67 				struct dentry *dentry, int mode,
68 				struct nameidata *nd)
69 {
70 	struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
71 	struct vfsmount *lower_mnt = ecryptfs_dentry_to_lower_mnt(dentry);
72 	struct dentry *dentry_save;
73 	struct vfsmount *vfsmount_save;
74 	unsigned int flags_save;
75 	int rc;
76 
77 	if (nd) {
78 		dentry_save = nd->path.dentry;
79 		vfsmount_save = nd->path.mnt;
80 		flags_save = nd->flags;
81 		nd->path.dentry = lower_dentry;
82 		nd->path.mnt = lower_mnt;
83 		nd->flags &= ~LOOKUP_OPEN;
84 	}
85 	rc = vfs_create(lower_dir_inode, lower_dentry, mode, nd);
86 	if (nd) {
87 		nd->path.dentry = dentry_save;
88 		nd->path.mnt = vfsmount_save;
89 		nd->flags = flags_save;
90 	}
91 	return rc;
92 }
93 
94 /**
95  * ecryptfs_do_create
96  * @directory_inode: inode of the new file's dentry's parent in ecryptfs
97  * @ecryptfs_dentry: New file's dentry in ecryptfs
98  * @mode: The mode of the new file
99  * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
100  *
101  * Creates the underlying file and the eCryptfs inode which will link to
102  * it. It will also update the eCryptfs directory inode to mimic the
103  * stat of the lower directory inode.
104  *
105  * Returns zero on success; non-zero on error condition
106  */
107 static int
108 ecryptfs_do_create(struct inode *directory_inode,
109 		   struct dentry *ecryptfs_dentry, int mode,
110 		   struct nameidata *nd)
111 {
112 	int rc;
113 	struct dentry *lower_dentry;
114 	struct dentry *lower_dir_dentry;
115 
116 	lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
117 	lower_dir_dentry = lock_parent(lower_dentry);
118 	if (IS_ERR(lower_dir_dentry)) {
119 		ecryptfs_printk(KERN_ERR, "Error locking directory of "
120 				"dentry\n");
121 		rc = PTR_ERR(lower_dir_dentry);
122 		goto out;
123 	}
124 	rc = ecryptfs_create_underlying_file(lower_dir_dentry->d_inode,
125 					     ecryptfs_dentry, mode, nd);
126 	if (rc) {
127 		printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
128 		       "rc = [%d]\n", __func__, rc);
129 		goto out_lock;
130 	}
131 	rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry,
132 				directory_inode->i_sb, 0);
133 	if (rc) {
134 		ecryptfs_printk(KERN_ERR, "Failure in ecryptfs_interpose\n");
135 		goto out_lock;
136 	}
137 	fsstack_copy_attr_times(directory_inode, lower_dir_dentry->d_inode);
138 	fsstack_copy_inode_size(directory_inode, lower_dir_dentry->d_inode);
139 out_lock:
140 	unlock_dir(lower_dir_dentry);
141 out:
142 	return rc;
143 }
144 
145 /**
146  * ecryptfs_initialize_file
147  *
148  * Cause the file to be changed from a basic empty file to an ecryptfs
149  * file with a header and first data page.
150  *
151  * Returns zero on success
152  */
153 static int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry)
154 {
155 	struct ecryptfs_crypt_stat *crypt_stat =
156 		&ecryptfs_inode_to_private(ecryptfs_dentry->d_inode)->crypt_stat;
157 	int rc = 0;
158 
159 	if (S_ISDIR(ecryptfs_dentry->d_inode->i_mode)) {
160 		ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
161 		crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
162 		goto out;
163 	}
164 	ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
165 	rc = ecryptfs_new_file_context(ecryptfs_dentry);
166 	if (rc) {
167 		ecryptfs_printk(KERN_ERR, "Error creating new file "
168 				"context; rc = [%d]\n", rc);
169 		goto out;
170 	}
171 	rc = ecryptfs_get_lower_file(ecryptfs_dentry);
172 	if (rc) {
173 		printk(KERN_ERR "%s: Error attempting to initialize "
174 			"the lower file for the dentry with name "
175 			"[%s]; rc = [%d]\n", __func__,
176 			ecryptfs_dentry->d_name.name, rc);
177 		goto out;
178 	}
179 	rc = ecryptfs_write_metadata(ecryptfs_dentry);
180 	if (rc)
181 		printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
182 	ecryptfs_put_lower_file(ecryptfs_dentry->d_inode);
183 out:
184 	return rc;
185 }
186 
187 /**
188  * ecryptfs_create
189  * @dir: The inode of the directory in which to create the file.
190  * @dentry: The eCryptfs dentry
191  * @mode: The mode of the new file.
192  * @nd: nameidata
193  *
194  * Creates a new file.
195  *
196  * Returns zero on success; non-zero on error condition
197  */
198 static int
199 ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
200 		int mode, struct nameidata *nd)
201 {
202 	int rc;
203 
204 	/* ecryptfs_do_create() calls ecryptfs_interpose() */
205 	rc = ecryptfs_do_create(directory_inode, ecryptfs_dentry, mode, nd);
206 	if (unlikely(rc)) {
207 		ecryptfs_printk(KERN_WARNING, "Failed to create file in"
208 				"lower filesystem\n");
209 		goto out;
210 	}
211 	/* At this point, a file exists on "disk"; we need to make sure
212 	 * that this on disk file is prepared to be an ecryptfs file */
213 	rc = ecryptfs_initialize_file(ecryptfs_dentry);
214 out:
215 	return rc;
216 }
217 
218 /**
219  * ecryptfs_lookup_and_interpose_lower - Perform a lookup
220  */
221 int ecryptfs_lookup_and_interpose_lower(struct dentry *ecryptfs_dentry,
222 					struct dentry *lower_dentry,
223 					struct inode *ecryptfs_dir_inode)
224 {
225 	struct dentry *lower_dir_dentry;
226 	struct vfsmount *lower_mnt;
227 	struct inode *lower_inode;
228 	struct ecryptfs_crypt_stat *crypt_stat;
229 	char *page_virt = NULL;
230 	int put_lower = 0, rc = 0;
231 
232 	lower_dir_dentry = lower_dentry->d_parent;
233 	lower_mnt = mntget(ecryptfs_dentry_to_lower_mnt(
234 				   ecryptfs_dentry->d_parent));
235 	lower_inode = lower_dentry->d_inode;
236 	fsstack_copy_attr_atime(ecryptfs_dir_inode, lower_dir_dentry->d_inode);
237 	BUG_ON(!lower_dentry->d_count);
238 	ecryptfs_set_dentry_private(ecryptfs_dentry,
239 				    kmem_cache_alloc(ecryptfs_dentry_info_cache,
240 						     GFP_KERNEL));
241 	if (!ecryptfs_dentry_to_private(ecryptfs_dentry)) {
242 		rc = -ENOMEM;
243 		printk(KERN_ERR "%s: Out of memory whilst attempting "
244 		       "to allocate ecryptfs_dentry_info struct\n",
245 			__func__);
246 		goto out_put;
247 	}
248 	ecryptfs_set_dentry_lower(ecryptfs_dentry, lower_dentry);
249 	ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry, lower_mnt);
250 	if (!lower_dentry->d_inode) {
251 		/* We want to add because we couldn't find in lower */
252 		d_add(ecryptfs_dentry, NULL);
253 		goto out;
254 	}
255 	rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry,
256 				ecryptfs_dir_inode->i_sb,
257 				ECRYPTFS_INTERPOSE_FLAG_D_ADD);
258 	if (rc) {
259 		printk(KERN_ERR "%s: Error interposing; rc = [%d]\n",
260 		       __func__, rc);
261 		goto out;
262 	}
263 	if (S_ISDIR(lower_inode->i_mode))
264 		goto out;
265 	if (S_ISLNK(lower_inode->i_mode))
266 		goto out;
267 	if (special_file(lower_inode->i_mode))
268 		goto out;
269 	/* Released in this function */
270 	page_virt = kmem_cache_zalloc(ecryptfs_header_cache_2, GFP_USER);
271 	if (!page_virt) {
272 		printk(KERN_ERR "%s: Cannot kmem_cache_zalloc() a page\n",
273 		       __func__);
274 		rc = -ENOMEM;
275 		goto out;
276 	}
277 	rc = ecryptfs_get_lower_file(ecryptfs_dentry);
278 	if (rc) {
279 		printk(KERN_ERR "%s: Error attempting to initialize "
280 			"the lower file for the dentry with name "
281 			"[%s]; rc = [%d]\n", __func__,
282 			ecryptfs_dentry->d_name.name, rc);
283 		goto out_free_kmem;
284 	}
285 	put_lower = 1;
286 	crypt_stat = &ecryptfs_inode_to_private(
287 					ecryptfs_dentry->d_inode)->crypt_stat;
288 	/* TODO: lock for crypt_stat comparison */
289 	if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
290 			ecryptfs_set_default_sizes(crypt_stat);
291 	rc = ecryptfs_read_and_validate_header_region(page_virt,
292 						      ecryptfs_dentry->d_inode);
293 	if (rc) {
294 		memset(page_virt, 0, PAGE_CACHE_SIZE);
295 		rc = ecryptfs_read_and_validate_xattr_region(page_virt,
296 							     ecryptfs_dentry);
297 		if (rc) {
298 			rc = 0;
299 			goto out_free_kmem;
300 		}
301 		crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
302 	}
303 	ecryptfs_i_size_init(page_virt, ecryptfs_dentry->d_inode);
304 out_free_kmem:
305 	kmem_cache_free(ecryptfs_header_cache_2, page_virt);
306 	goto out;
307 out_put:
308 	dput(lower_dentry);
309 	mntput(lower_mnt);
310 	d_drop(ecryptfs_dentry);
311 out:
312 	if (put_lower)
313 		ecryptfs_put_lower_file(ecryptfs_dentry->d_inode);
314 	return rc;
315 }
316 
317 /**
318  * ecryptfs_lookup
319  * @ecryptfs_dir_inode: The eCryptfs directory inode
320  * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
321  * @ecryptfs_nd: nameidata; may be NULL
322  *
323  * Find a file on disk. If the file does not exist, then we'll add it to the
324  * dentry cache and continue on to read it from the disk.
325  */
326 static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
327 				      struct dentry *ecryptfs_dentry,
328 				      struct nameidata *ecryptfs_nd)
329 {
330 	char *encrypted_and_encoded_name = NULL;
331 	size_t encrypted_and_encoded_name_size;
332 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
333 	struct dentry *lower_dir_dentry, *lower_dentry;
334 	int rc = 0;
335 
336 	if ((ecryptfs_dentry->d_name.len == 1
337 	     && !strcmp(ecryptfs_dentry->d_name.name, "."))
338 	    || (ecryptfs_dentry->d_name.len == 2
339 		&& !strcmp(ecryptfs_dentry->d_name.name, ".."))) {
340 		goto out_d_drop;
341 	}
342 	lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
343 	mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
344 	lower_dentry = lookup_one_len(ecryptfs_dentry->d_name.name,
345 				      lower_dir_dentry,
346 				      ecryptfs_dentry->d_name.len);
347 	mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
348 	if (IS_ERR(lower_dentry)) {
349 		rc = PTR_ERR(lower_dentry);
350 		ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
351 				"[%d] on lower_dentry = [%s]\n", __func__, rc,
352 				encrypted_and_encoded_name);
353 		goto out_d_drop;
354 	}
355 	if (lower_dentry->d_inode)
356 		goto lookup_and_interpose;
357 	mount_crypt_stat = &ecryptfs_superblock_to_private(
358 				ecryptfs_dentry->d_sb)->mount_crypt_stat;
359 	if (!(mount_crypt_stat
360 	    && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)))
361 		goto lookup_and_interpose;
362 	dput(lower_dentry);
363 	rc = ecryptfs_encrypt_and_encode_filename(
364 		&encrypted_and_encoded_name, &encrypted_and_encoded_name_size,
365 		NULL, mount_crypt_stat, ecryptfs_dentry->d_name.name,
366 		ecryptfs_dentry->d_name.len);
367 	if (rc) {
368 		printk(KERN_ERR "%s: Error attempting to encrypt and encode "
369 		       "filename; rc = [%d]\n", __func__, rc);
370 		goto out_d_drop;
371 	}
372 	mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
373 	lower_dentry = lookup_one_len(encrypted_and_encoded_name,
374 				      lower_dir_dentry,
375 				      encrypted_and_encoded_name_size);
376 	mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
377 	if (IS_ERR(lower_dentry)) {
378 		rc = PTR_ERR(lower_dentry);
379 		ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
380 				"[%d] on lower_dentry = [%s]\n", __func__, rc,
381 				encrypted_and_encoded_name);
382 		goto out_d_drop;
383 	}
384 lookup_and_interpose:
385 	rc = ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry, lower_dentry,
386 						 ecryptfs_dir_inode);
387 	goto out;
388 out_d_drop:
389 	d_drop(ecryptfs_dentry);
390 out:
391 	kfree(encrypted_and_encoded_name);
392 	return ERR_PTR(rc);
393 }
394 
395 static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
396 			 struct dentry *new_dentry)
397 {
398 	struct dentry *lower_old_dentry;
399 	struct dentry *lower_new_dentry;
400 	struct dentry *lower_dir_dentry;
401 	u64 file_size_save;
402 	int rc;
403 
404 	file_size_save = i_size_read(old_dentry->d_inode);
405 	lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
406 	lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
407 	dget(lower_old_dentry);
408 	dget(lower_new_dentry);
409 	lower_dir_dentry = lock_parent(lower_new_dentry);
410 	rc = vfs_link(lower_old_dentry, lower_dir_dentry->d_inode,
411 		      lower_new_dentry);
412 	if (rc || !lower_new_dentry->d_inode)
413 		goto out_lock;
414 	rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb, 0);
415 	if (rc)
416 		goto out_lock;
417 	fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
418 	fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
419 	old_dentry->d_inode->i_nlink =
420 		ecryptfs_inode_to_lower(old_dentry->d_inode)->i_nlink;
421 	i_size_write(new_dentry->d_inode, file_size_save);
422 out_lock:
423 	unlock_dir(lower_dir_dentry);
424 	dput(lower_new_dentry);
425 	dput(lower_old_dentry);
426 	return rc;
427 }
428 
429 static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
430 {
431 	int rc = 0;
432 	struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
433 	struct inode *lower_dir_inode = ecryptfs_inode_to_lower(dir);
434 	struct dentry *lower_dir_dentry;
435 
436 	dget(lower_dentry);
437 	lower_dir_dentry = lock_parent(lower_dentry);
438 	rc = vfs_unlink(lower_dir_inode, lower_dentry);
439 	if (rc) {
440 		printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
441 		goto out_unlock;
442 	}
443 	fsstack_copy_attr_times(dir, lower_dir_inode);
444 	dentry->d_inode->i_nlink =
445 		ecryptfs_inode_to_lower(dentry->d_inode)->i_nlink;
446 	dentry->d_inode->i_ctime = dir->i_ctime;
447 	d_drop(dentry);
448 out_unlock:
449 	unlock_dir(lower_dir_dentry);
450 	dput(lower_dentry);
451 	return rc;
452 }
453 
454 static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
455 			    const char *symname)
456 {
457 	int rc;
458 	struct dentry *lower_dentry;
459 	struct dentry *lower_dir_dentry;
460 	char *encoded_symname;
461 	size_t encoded_symlen;
462 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
463 
464 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
465 	dget(lower_dentry);
466 	lower_dir_dentry = lock_parent(lower_dentry);
467 	mount_crypt_stat = &ecryptfs_superblock_to_private(
468 		dir->i_sb)->mount_crypt_stat;
469 	rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
470 						  &encoded_symlen,
471 						  NULL,
472 						  mount_crypt_stat, symname,
473 						  strlen(symname));
474 	if (rc)
475 		goto out_lock;
476 	rc = vfs_symlink(lower_dir_dentry->d_inode, lower_dentry,
477 			 encoded_symname);
478 	kfree(encoded_symname);
479 	if (rc || !lower_dentry->d_inode)
480 		goto out_lock;
481 	rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
482 	if (rc)
483 		goto out_lock;
484 	fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
485 	fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
486 out_lock:
487 	unlock_dir(lower_dir_dentry);
488 	dput(lower_dentry);
489 	if (!dentry->d_inode)
490 		d_drop(dentry);
491 	return rc;
492 }
493 
494 static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
495 {
496 	int rc;
497 	struct dentry *lower_dentry;
498 	struct dentry *lower_dir_dentry;
499 
500 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
501 	lower_dir_dentry = lock_parent(lower_dentry);
502 	rc = vfs_mkdir(lower_dir_dentry->d_inode, lower_dentry, mode);
503 	if (rc || !lower_dentry->d_inode)
504 		goto out;
505 	rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
506 	if (rc)
507 		goto out;
508 	fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
509 	fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
510 	dir->i_nlink = lower_dir_dentry->d_inode->i_nlink;
511 out:
512 	unlock_dir(lower_dir_dentry);
513 	if (!dentry->d_inode)
514 		d_drop(dentry);
515 	return rc;
516 }
517 
518 static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
519 {
520 	struct dentry *lower_dentry;
521 	struct dentry *lower_dir_dentry;
522 	int rc;
523 
524 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
525 	dget(dentry);
526 	lower_dir_dentry = lock_parent(lower_dentry);
527 	dget(lower_dentry);
528 	rc = vfs_rmdir(lower_dir_dentry->d_inode, lower_dentry);
529 	dput(lower_dentry);
530 	fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
531 	dir->i_nlink = lower_dir_dentry->d_inode->i_nlink;
532 	unlock_dir(lower_dir_dentry);
533 	if (!rc)
534 		d_drop(dentry);
535 	dput(dentry);
536 	return rc;
537 }
538 
539 static int
540 ecryptfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t dev)
541 {
542 	int rc;
543 	struct dentry *lower_dentry;
544 	struct dentry *lower_dir_dentry;
545 
546 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
547 	lower_dir_dentry = lock_parent(lower_dentry);
548 	rc = vfs_mknod(lower_dir_dentry->d_inode, lower_dentry, mode, dev);
549 	if (rc || !lower_dentry->d_inode)
550 		goto out;
551 	rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
552 	if (rc)
553 		goto out;
554 	fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
555 	fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
556 out:
557 	unlock_dir(lower_dir_dentry);
558 	if (!dentry->d_inode)
559 		d_drop(dentry);
560 	return rc;
561 }
562 
563 static int
564 ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
565 		struct inode *new_dir, struct dentry *new_dentry)
566 {
567 	int rc;
568 	struct dentry *lower_old_dentry;
569 	struct dentry *lower_new_dentry;
570 	struct dentry *lower_old_dir_dentry;
571 	struct dentry *lower_new_dir_dentry;
572 	struct dentry *trap = NULL;
573 
574 	lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
575 	lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
576 	dget(lower_old_dentry);
577 	dget(lower_new_dentry);
578 	lower_old_dir_dentry = dget_parent(lower_old_dentry);
579 	lower_new_dir_dentry = dget_parent(lower_new_dentry);
580 	trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
581 	/* source should not be ancestor of target */
582 	if (trap == lower_old_dentry) {
583 		rc = -EINVAL;
584 		goto out_lock;
585 	}
586 	/* target should not be ancestor of source */
587 	if (trap == lower_new_dentry) {
588 		rc = -ENOTEMPTY;
589 		goto out_lock;
590 	}
591 	rc = vfs_rename(lower_old_dir_dentry->d_inode, lower_old_dentry,
592 			lower_new_dir_dentry->d_inode, lower_new_dentry);
593 	if (rc)
594 		goto out_lock;
595 	fsstack_copy_attr_all(new_dir, lower_new_dir_dentry->d_inode);
596 	if (new_dir != old_dir)
597 		fsstack_copy_attr_all(old_dir, lower_old_dir_dentry->d_inode);
598 out_lock:
599 	unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
600 	dput(lower_new_dir_dentry);
601 	dput(lower_old_dir_dentry);
602 	dput(lower_new_dentry);
603 	dput(lower_old_dentry);
604 	return rc;
605 }
606 
607 static int ecryptfs_readlink_lower(struct dentry *dentry, char **buf,
608 				   size_t *bufsiz)
609 {
610 	struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
611 	char *lower_buf;
612 	size_t lower_bufsiz = PATH_MAX;
613 	mm_segment_t old_fs;
614 	int rc;
615 
616 	lower_buf = kmalloc(lower_bufsiz, GFP_KERNEL);
617 	if (!lower_buf) {
618 		rc = -ENOMEM;
619 		goto out;
620 	}
621 	old_fs = get_fs();
622 	set_fs(get_ds());
623 	rc = lower_dentry->d_inode->i_op->readlink(lower_dentry,
624 						   (char __user *)lower_buf,
625 						   lower_bufsiz);
626 	set_fs(old_fs);
627 	if (rc < 0)
628 		goto out;
629 	lower_bufsiz = rc;
630 	rc = ecryptfs_decode_and_decrypt_filename(buf, bufsiz, dentry,
631 						  lower_buf, lower_bufsiz);
632 out:
633 	kfree(lower_buf);
634 	return rc;
635 }
636 
637 static int
638 ecryptfs_readlink(struct dentry *dentry, char __user *buf, int bufsiz)
639 {
640 	char *kbuf;
641 	size_t kbufsiz, copied;
642 	int rc;
643 
644 	rc = ecryptfs_readlink_lower(dentry, &kbuf, &kbufsiz);
645 	if (rc)
646 		goto out;
647 	copied = min_t(size_t, bufsiz, kbufsiz);
648 	rc = copy_to_user(buf, kbuf, copied) ? -EFAULT : copied;
649 	kfree(kbuf);
650 	fsstack_copy_attr_atime(dentry->d_inode,
651 				ecryptfs_dentry_to_lower(dentry)->d_inode);
652 out:
653 	return rc;
654 }
655 
656 static void *ecryptfs_follow_link(struct dentry *dentry, struct nameidata *nd)
657 {
658 	char *buf;
659 	int len = PAGE_SIZE, rc;
660 	mm_segment_t old_fs;
661 
662 	/* Released in ecryptfs_put_link(); only release here on error */
663 	buf = kmalloc(len, GFP_KERNEL);
664 	if (!buf) {
665 		buf = ERR_PTR(-ENOMEM);
666 		goto out;
667 	}
668 	old_fs = get_fs();
669 	set_fs(get_ds());
670 	rc = dentry->d_inode->i_op->readlink(dentry, (char __user *)buf, len);
671 	set_fs(old_fs);
672 	if (rc < 0) {
673 		kfree(buf);
674 		buf = ERR_PTR(rc);
675 	} else
676 		buf[rc] = '\0';
677 out:
678 	nd_set_link(nd, buf);
679 	return NULL;
680 }
681 
682 static void
683 ecryptfs_put_link(struct dentry *dentry, struct nameidata *nd, void *ptr)
684 {
685 	char *buf = nd_get_link(nd);
686 	if (!IS_ERR(buf)) {
687 		/* Free the char* */
688 		kfree(buf);
689 	}
690 }
691 
692 /**
693  * upper_size_to_lower_size
694  * @crypt_stat: Crypt_stat associated with file
695  * @upper_size: Size of the upper file
696  *
697  * Calculate the required size of the lower file based on the
698  * specified size of the upper file. This calculation is based on the
699  * number of headers in the underlying file and the extent size.
700  *
701  * Returns Calculated size of the lower file.
702  */
703 static loff_t
704 upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
705 			 loff_t upper_size)
706 {
707 	loff_t lower_size;
708 
709 	lower_size = ecryptfs_lower_header_size(crypt_stat);
710 	if (upper_size != 0) {
711 		loff_t num_extents;
712 
713 		num_extents = upper_size >> crypt_stat->extent_shift;
714 		if (upper_size & ~crypt_stat->extent_mask)
715 			num_extents++;
716 		lower_size += (num_extents * crypt_stat->extent_size);
717 	}
718 	return lower_size;
719 }
720 
721 /**
722  * truncate_upper
723  * @dentry: The ecryptfs layer dentry
724  * @ia: Address of the ecryptfs inode's attributes
725  * @lower_ia: Address of the lower inode's attributes
726  *
727  * Function to handle truncations modifying the size of the file. Note
728  * that the file sizes are interpolated. When expanding, we are simply
729  * writing strings of 0's out. When truncating, we truncate the upper
730  * inode and update the lower_ia according to the page index
731  * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
732  * the caller must use lower_ia in a call to notify_change() to perform
733  * the truncation of the lower inode.
734  *
735  * Returns zero on success; non-zero otherwise
736  */
737 static int truncate_upper(struct dentry *dentry, struct iattr *ia,
738 			  struct iattr *lower_ia)
739 {
740 	int rc = 0;
741 	struct inode *inode = dentry->d_inode;
742 	struct ecryptfs_crypt_stat *crypt_stat;
743 	loff_t i_size = i_size_read(inode);
744 	loff_t lower_size_before_truncate;
745 	loff_t lower_size_after_truncate;
746 
747 	if (unlikely((ia->ia_size == i_size))) {
748 		lower_ia->ia_valid &= ~ATTR_SIZE;
749 		return 0;
750 	}
751 	rc = ecryptfs_get_lower_file(dentry);
752 	if (rc)
753 		return rc;
754 	crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
755 	/* Switch on growing or shrinking file */
756 	if (ia->ia_size > i_size) {
757 		char zero[] = { 0x00 };
758 
759 		lower_ia->ia_valid &= ~ATTR_SIZE;
760 		/* Write a single 0 at the last position of the file;
761 		 * this triggers code that will fill in 0's throughout
762 		 * the intermediate portion of the previous end of the
763 		 * file and the new and of the file */
764 		rc = ecryptfs_write(inode, zero,
765 				    (ia->ia_size - 1), 1);
766 	} else { /* ia->ia_size < i_size_read(inode) */
767 		/* We're chopping off all the pages down to the page
768 		 * in which ia->ia_size is located. Fill in the end of
769 		 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
770 		 * PAGE_CACHE_SIZE with zeros. */
771 		size_t num_zeros = (PAGE_CACHE_SIZE
772 				    - (ia->ia_size & ~PAGE_CACHE_MASK));
773 
774 
775 		/*
776 		 * XXX(truncate) this should really happen at the begginning
777 		 * of ->setattr.  But the code is too messy to that as part
778 		 * of a larger patch.  ecryptfs is also totally missing out
779 		 * on the inode_change_ok check at the beginning of
780 		 * ->setattr while would include this.
781 		 */
782 		rc = inode_newsize_ok(inode, ia->ia_size);
783 		if (rc)
784 			goto out;
785 
786 		if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
787 			truncate_setsize(inode, ia->ia_size);
788 			lower_ia->ia_size = ia->ia_size;
789 			lower_ia->ia_valid |= ATTR_SIZE;
790 			goto out;
791 		}
792 		if (num_zeros) {
793 			char *zeros_virt;
794 
795 			zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
796 			if (!zeros_virt) {
797 				rc = -ENOMEM;
798 				goto out;
799 			}
800 			rc = ecryptfs_write(inode, zeros_virt,
801 					    ia->ia_size, num_zeros);
802 			kfree(zeros_virt);
803 			if (rc) {
804 				printk(KERN_ERR "Error attempting to zero out "
805 				       "the remainder of the end page on "
806 				       "reducing truncate; rc = [%d]\n", rc);
807 				goto out;
808 			}
809 		}
810 		truncate_setsize(inode, ia->ia_size);
811 		rc = ecryptfs_write_inode_size_to_metadata(inode);
812 		if (rc) {
813 			printk(KERN_ERR	"Problem with "
814 			       "ecryptfs_write_inode_size_to_metadata; "
815 			       "rc = [%d]\n", rc);
816 			goto out;
817 		}
818 		/* We are reducing the size of the ecryptfs file, and need to
819 		 * know if we need to reduce the size of the lower file. */
820 		lower_size_before_truncate =
821 		    upper_size_to_lower_size(crypt_stat, i_size);
822 		lower_size_after_truncate =
823 		    upper_size_to_lower_size(crypt_stat, ia->ia_size);
824 		if (lower_size_after_truncate < lower_size_before_truncate) {
825 			lower_ia->ia_size = lower_size_after_truncate;
826 			lower_ia->ia_valid |= ATTR_SIZE;
827 		} else
828 			lower_ia->ia_valid &= ~ATTR_SIZE;
829 	}
830 out:
831 	ecryptfs_put_lower_file(inode);
832 	return rc;
833 }
834 
835 /**
836  * ecryptfs_truncate
837  * @dentry: The ecryptfs layer dentry
838  * @new_length: The length to expand the file to
839  *
840  * Simple function that handles the truncation of an eCryptfs inode and
841  * its corresponding lower inode.
842  *
843  * Returns zero on success; non-zero otherwise
844  */
845 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
846 {
847 	struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
848 	struct iattr lower_ia = { .ia_valid = 0 };
849 	int rc;
850 
851 	rc = truncate_upper(dentry, &ia, &lower_ia);
852 	if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
853 		struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
854 
855 		mutex_lock(&lower_dentry->d_inode->i_mutex);
856 		rc = notify_change(lower_dentry, &lower_ia);
857 		mutex_unlock(&lower_dentry->d_inode->i_mutex);
858 	}
859 	return rc;
860 }
861 
862 static int
863 ecryptfs_permission(struct inode *inode, int mask, unsigned int flags)
864 {
865 	if (flags & IPERM_FLAG_RCU)
866 		return -ECHILD;
867 	return inode_permission(ecryptfs_inode_to_lower(inode), mask);
868 }
869 
870 /**
871  * ecryptfs_setattr
872  * @dentry: dentry handle to the inode to modify
873  * @ia: Structure with flags of what to change and values
874  *
875  * Updates the metadata of an inode. If the update is to the size
876  * i.e. truncation, then ecryptfs_truncate will handle the size modification
877  * of both the ecryptfs inode and the lower inode.
878  *
879  * All other metadata changes will be passed right to the lower filesystem,
880  * and we will just update our inode to look like the lower.
881  */
882 static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
883 {
884 	int rc = 0;
885 	struct dentry *lower_dentry;
886 	struct iattr lower_ia;
887 	struct inode *inode;
888 	struct inode *lower_inode;
889 	struct ecryptfs_crypt_stat *crypt_stat;
890 
891 	crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
892 	if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED))
893 		ecryptfs_init_crypt_stat(crypt_stat);
894 	inode = dentry->d_inode;
895 	lower_inode = ecryptfs_inode_to_lower(inode);
896 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
897 	mutex_lock(&crypt_stat->cs_mutex);
898 	if (S_ISDIR(dentry->d_inode->i_mode))
899 		crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
900 	else if (S_ISREG(dentry->d_inode->i_mode)
901 		 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
902 		     || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
903 		struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
904 
905 		mount_crypt_stat = &ecryptfs_superblock_to_private(
906 			dentry->d_sb)->mount_crypt_stat;
907 		rc = ecryptfs_get_lower_file(dentry);
908 		if (rc) {
909 			mutex_unlock(&crypt_stat->cs_mutex);
910 			goto out;
911 		}
912 		rc = ecryptfs_read_metadata(dentry);
913 		ecryptfs_put_lower_file(inode);
914 		if (rc) {
915 			if (!(mount_crypt_stat->flags
916 			      & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
917 				rc = -EIO;
918 				printk(KERN_WARNING "Either the lower file "
919 				       "is not in a valid eCryptfs format, "
920 				       "or the key could not be retrieved. "
921 				       "Plaintext passthrough mode is not "
922 				       "enabled; returning -EIO\n");
923 				mutex_unlock(&crypt_stat->cs_mutex);
924 				goto out;
925 			}
926 			rc = 0;
927 			crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
928 					       | ECRYPTFS_ENCRYPTED);
929 		}
930 	}
931 	mutex_unlock(&crypt_stat->cs_mutex);
932 	memcpy(&lower_ia, ia, sizeof(lower_ia));
933 	if (ia->ia_valid & ATTR_FILE)
934 		lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
935 	if (ia->ia_valid & ATTR_SIZE) {
936 		rc = truncate_upper(dentry, ia, &lower_ia);
937 		if (rc < 0)
938 			goto out;
939 	}
940 
941 	/*
942 	 * mode change is for clearing setuid/setgid bits. Allow lower fs
943 	 * to interpret this in its own way.
944 	 */
945 	if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
946 		lower_ia.ia_valid &= ~ATTR_MODE;
947 
948 	mutex_lock(&lower_dentry->d_inode->i_mutex);
949 	rc = notify_change(lower_dentry, &lower_ia);
950 	mutex_unlock(&lower_dentry->d_inode->i_mutex);
951 out:
952 	fsstack_copy_attr_all(inode, lower_inode);
953 	return rc;
954 }
955 
956 int ecryptfs_getattr_link(struct vfsmount *mnt, struct dentry *dentry,
957 			  struct kstat *stat)
958 {
959 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
960 	int rc = 0;
961 
962 	mount_crypt_stat = &ecryptfs_superblock_to_private(
963 						dentry->d_sb)->mount_crypt_stat;
964 	generic_fillattr(dentry->d_inode, stat);
965 	if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
966 		char *target;
967 		size_t targetsiz;
968 
969 		rc = ecryptfs_readlink_lower(dentry, &target, &targetsiz);
970 		if (!rc) {
971 			kfree(target);
972 			stat->size = targetsiz;
973 		}
974 	}
975 	return rc;
976 }
977 
978 int ecryptfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
979 		     struct kstat *stat)
980 {
981 	struct kstat lower_stat;
982 	int rc;
983 
984 	rc = vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry),
985 			 ecryptfs_dentry_to_lower(dentry), &lower_stat);
986 	if (!rc) {
987 		fsstack_copy_attr_all(dentry->d_inode,
988 				      ecryptfs_inode_to_lower(dentry->d_inode));
989 		generic_fillattr(dentry->d_inode, stat);
990 		stat->blocks = lower_stat.blocks;
991 	}
992 	return rc;
993 }
994 
995 int
996 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
997 		  size_t size, int flags)
998 {
999 	int rc = 0;
1000 	struct dentry *lower_dentry;
1001 
1002 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
1003 	if (!lower_dentry->d_inode->i_op->setxattr) {
1004 		rc = -EOPNOTSUPP;
1005 		goto out;
1006 	}
1007 
1008 	rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1009 out:
1010 	return rc;
1011 }
1012 
1013 ssize_t
1014 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
1015 			void *value, size_t size)
1016 {
1017 	int rc = 0;
1018 
1019 	if (!lower_dentry->d_inode->i_op->getxattr) {
1020 		rc = -EOPNOTSUPP;
1021 		goto out;
1022 	}
1023 	mutex_lock(&lower_dentry->d_inode->i_mutex);
1024 	rc = lower_dentry->d_inode->i_op->getxattr(lower_dentry, name, value,
1025 						   size);
1026 	mutex_unlock(&lower_dentry->d_inode->i_mutex);
1027 out:
1028 	return rc;
1029 }
1030 
1031 static ssize_t
1032 ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
1033 		  size_t size)
1034 {
1035 	return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry), name,
1036 				       value, size);
1037 }
1038 
1039 static ssize_t
1040 ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1041 {
1042 	int rc = 0;
1043 	struct dentry *lower_dentry;
1044 
1045 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
1046 	if (!lower_dentry->d_inode->i_op->listxattr) {
1047 		rc = -EOPNOTSUPP;
1048 		goto out;
1049 	}
1050 	mutex_lock(&lower_dentry->d_inode->i_mutex);
1051 	rc = lower_dentry->d_inode->i_op->listxattr(lower_dentry, list, size);
1052 	mutex_unlock(&lower_dentry->d_inode->i_mutex);
1053 out:
1054 	return rc;
1055 }
1056 
1057 static int ecryptfs_removexattr(struct dentry *dentry, const char *name)
1058 {
1059 	int rc = 0;
1060 	struct dentry *lower_dentry;
1061 
1062 	lower_dentry = ecryptfs_dentry_to_lower(dentry);
1063 	if (!lower_dentry->d_inode->i_op->removexattr) {
1064 		rc = -EOPNOTSUPP;
1065 		goto out;
1066 	}
1067 	mutex_lock(&lower_dentry->d_inode->i_mutex);
1068 	rc = lower_dentry->d_inode->i_op->removexattr(lower_dentry, name);
1069 	mutex_unlock(&lower_dentry->d_inode->i_mutex);
1070 out:
1071 	return rc;
1072 }
1073 
1074 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode)
1075 {
1076 	if ((ecryptfs_inode_to_lower(inode)
1077 	     == (struct inode *)candidate_lower_inode))
1078 		return 1;
1079 	else
1080 		return 0;
1081 }
1082 
1083 int ecryptfs_inode_set(struct inode *inode, void *lower_inode)
1084 {
1085 	ecryptfs_init_inode(inode, (struct inode *)lower_inode);
1086 	return 0;
1087 }
1088 
1089 const struct inode_operations ecryptfs_symlink_iops = {
1090 	.readlink = ecryptfs_readlink,
1091 	.follow_link = ecryptfs_follow_link,
1092 	.put_link = ecryptfs_put_link,
1093 	.permission = ecryptfs_permission,
1094 	.setattr = ecryptfs_setattr,
1095 	.getattr = ecryptfs_getattr_link,
1096 	.setxattr = ecryptfs_setxattr,
1097 	.getxattr = ecryptfs_getxattr,
1098 	.listxattr = ecryptfs_listxattr,
1099 	.removexattr = ecryptfs_removexattr
1100 };
1101 
1102 const struct inode_operations ecryptfs_dir_iops = {
1103 	.create = ecryptfs_create,
1104 	.lookup = ecryptfs_lookup,
1105 	.link = ecryptfs_link,
1106 	.unlink = ecryptfs_unlink,
1107 	.symlink = ecryptfs_symlink,
1108 	.mkdir = ecryptfs_mkdir,
1109 	.rmdir = ecryptfs_rmdir,
1110 	.mknod = ecryptfs_mknod,
1111 	.rename = ecryptfs_rename,
1112 	.permission = ecryptfs_permission,
1113 	.setattr = ecryptfs_setattr,
1114 	.setxattr = ecryptfs_setxattr,
1115 	.getxattr = ecryptfs_getxattr,
1116 	.listxattr = ecryptfs_listxattr,
1117 	.removexattr = ecryptfs_removexattr
1118 };
1119 
1120 const struct inode_operations ecryptfs_main_iops = {
1121 	.permission = ecryptfs_permission,
1122 	.setattr = ecryptfs_setattr,
1123 	.getattr = ecryptfs_getattr,
1124 	.setxattr = ecryptfs_setxattr,
1125 	.getxattr = ecryptfs_getxattr,
1126 	.listxattr = ecryptfs_listxattr,
1127 	.removexattr = ecryptfs_removexattr
1128 };
1129