1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * eCryptfs: Linux filesystem encryption layer
5 * Copyright (C) 1997-2004 Erez Zadok
6 * Copyright (C) 2001-2004 Stony Brook University
7 * Copyright (C) 2004-2007 International Business Machines Corp.
12 #include <linux/file.h>
13 #include <linux/vmalloc.h>
14 #include <linux/pagemap.h>
15 #include <linux/dcache.h>
16 #include <linux/namei.h>
17 #include <linux/mount.h>
18 #include <linux/fs_stack.h>
19 #include <linux/slab.h>
20 #include <linux/xattr.h>
21 #include <asm/unaligned.h>
22 #include "ecryptfs_kernel.h"
24 static struct dentry *lock_parent(struct dentry *dentry)
28 dir = dget_parent(dentry);
29 inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
33 static void unlock_dir(struct dentry *dir)
35 inode_unlock(d_inode(dir));
39 static int ecryptfs_inode_test(struct inode *inode, void *lower_inode)
41 return ecryptfs_inode_to_lower(inode) == lower_inode;
44 static int ecryptfs_inode_set(struct inode *inode, void *opaque)
46 struct inode *lower_inode = opaque;
48 ecryptfs_set_inode_lower(inode, lower_inode);
49 fsstack_copy_attr_all(inode, lower_inode);
50 /* i_size will be overwritten for encrypted regular files */
51 fsstack_copy_inode_size(inode, lower_inode);
52 inode->i_ino = lower_inode->i_ino;
53 inode->i_mapping->a_ops = &ecryptfs_aops;
55 if (S_ISLNK(inode->i_mode))
56 inode->i_op = &ecryptfs_symlink_iops;
57 else if (S_ISDIR(inode->i_mode))
58 inode->i_op = &ecryptfs_dir_iops;
60 inode->i_op = &ecryptfs_main_iops;
62 if (S_ISDIR(inode->i_mode))
63 inode->i_fop = &ecryptfs_dir_fops;
64 else if (special_file(inode->i_mode))
65 init_special_inode(inode, inode->i_mode, inode->i_rdev);
67 inode->i_fop = &ecryptfs_main_fops;
72 static struct inode *__ecryptfs_get_inode(struct inode *lower_inode,
73 struct super_block *sb)
77 if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb))
78 return ERR_PTR(-EXDEV);
79 if (!igrab(lower_inode))
80 return ERR_PTR(-ESTALE);
81 inode = iget5_locked(sb, (unsigned long)lower_inode,
82 ecryptfs_inode_test, ecryptfs_inode_set,
86 return ERR_PTR(-EACCES);
88 if (!(inode->i_state & I_NEW))
94 struct inode *ecryptfs_get_inode(struct inode *lower_inode,
95 struct super_block *sb)
97 struct inode *inode = __ecryptfs_get_inode(lower_inode, sb);
99 if (!IS_ERR(inode) && (inode->i_state & I_NEW))
100 unlock_new_inode(inode);
107 * @lower_dentry: Existing dentry in the lower filesystem
108 * @dentry: ecryptfs' dentry
109 * @sb: ecryptfs's super_block
111 * Interposes upper and lower dentries.
113 * Returns zero on success; non-zero otherwise
115 static int ecryptfs_interpose(struct dentry *lower_dentry,
116 struct dentry *dentry, struct super_block *sb)
118 struct inode *inode = ecryptfs_get_inode(d_inode(lower_dentry), sb);
121 return PTR_ERR(inode);
122 d_instantiate(dentry, inode);
127 static int ecryptfs_do_unlink(struct inode *dir, struct dentry *dentry,
130 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
131 struct inode *lower_dir_inode = ecryptfs_inode_to_lower(dir);
132 struct dentry *lower_dir_dentry;
136 lower_dir_dentry = lock_parent(lower_dentry);
137 rc = vfs_unlink(lower_dir_inode, lower_dentry, NULL);
139 printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
142 fsstack_copy_attr_times(dir, lower_dir_inode);
143 set_nlink(inode, ecryptfs_inode_to_lower(inode)->i_nlink);
144 inode->i_ctime = dir->i_ctime;
147 unlock_dir(lower_dir_dentry);
154 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
155 * @ecryptfs_dentry: New file's dentry in ecryptfs
156 * @mode: The mode of the new file
158 * Creates the underlying file and the eCryptfs inode which will link to
159 * it. It will also update the eCryptfs directory inode to mimic the
160 * stat of the lower directory inode.
162 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
164 static struct inode *
165 ecryptfs_do_create(struct inode *directory_inode,
166 struct dentry *ecryptfs_dentry, umode_t mode)
169 struct dentry *lower_dentry;
170 struct dentry *lower_dir_dentry;
173 lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
174 lower_dir_dentry = lock_parent(lower_dentry);
175 rc = vfs_create(d_inode(lower_dir_dentry), lower_dentry, mode, true);
177 printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
178 "rc = [%d]\n", __func__, rc);
182 inode = __ecryptfs_get_inode(d_inode(lower_dentry),
183 directory_inode->i_sb);
185 vfs_unlink(d_inode(lower_dir_dentry), lower_dentry, NULL);
188 fsstack_copy_attr_times(directory_inode, d_inode(lower_dir_dentry));
189 fsstack_copy_inode_size(directory_inode, d_inode(lower_dir_dentry));
191 unlock_dir(lower_dir_dentry);
196 * ecryptfs_initialize_file
198 * Cause the file to be changed from a basic empty file to an ecryptfs
199 * file with a header and first data page.
201 * Returns zero on success
203 int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
204 struct inode *ecryptfs_inode)
206 struct ecryptfs_crypt_stat *crypt_stat =
207 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
210 if (S_ISDIR(ecryptfs_inode->i_mode)) {
211 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
212 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
215 ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
216 rc = ecryptfs_new_file_context(ecryptfs_inode);
218 ecryptfs_printk(KERN_ERR, "Error creating new file "
219 "context; rc = [%d]\n", rc);
222 rc = ecryptfs_get_lower_file(ecryptfs_dentry, ecryptfs_inode);
224 printk(KERN_ERR "%s: Error attempting to initialize "
225 "the lower file for the dentry with name "
226 "[%pd]; rc = [%d]\n", __func__,
227 ecryptfs_dentry, rc);
230 rc = ecryptfs_write_metadata(ecryptfs_dentry, ecryptfs_inode);
232 printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
233 ecryptfs_put_lower_file(ecryptfs_inode);
240 * @dir: The inode of the directory in which to create the file.
241 * @dentry: The eCryptfs dentry
242 * @mode: The mode of the new file.
244 * Creates a new file.
246 * Returns zero on success; non-zero on error condition
249 ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
250 umode_t mode, bool excl)
252 struct inode *ecryptfs_inode;
255 ecryptfs_inode = ecryptfs_do_create(directory_inode, ecryptfs_dentry,
257 if (IS_ERR(ecryptfs_inode)) {
258 ecryptfs_printk(KERN_WARNING, "Failed to create file in"
259 "lower filesystem\n");
260 rc = PTR_ERR(ecryptfs_inode);
263 /* At this point, a file exists on "disk"; we need to make sure
264 * that this on disk file is prepared to be an ecryptfs file */
265 rc = ecryptfs_initialize_file(ecryptfs_dentry, ecryptfs_inode);
267 ecryptfs_do_unlink(directory_inode, ecryptfs_dentry,
269 iget_failed(ecryptfs_inode);
272 d_instantiate_new(ecryptfs_dentry, ecryptfs_inode);
277 static int ecryptfs_i_size_read(struct dentry *dentry, struct inode *inode)
279 struct ecryptfs_crypt_stat *crypt_stat;
282 rc = ecryptfs_get_lower_file(dentry, inode);
284 printk(KERN_ERR "%s: Error attempting to initialize "
285 "the lower file for the dentry with name "
286 "[%pd]; rc = [%d]\n", __func__,
291 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
292 /* TODO: lock for crypt_stat comparison */
293 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
294 ecryptfs_set_default_sizes(crypt_stat);
296 rc = ecryptfs_read_and_validate_header_region(inode);
297 ecryptfs_put_lower_file(inode);
299 rc = ecryptfs_read_and_validate_xattr_region(dentry, inode);
301 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
304 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
309 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
311 static struct dentry *ecryptfs_lookup_interpose(struct dentry *dentry,
312 struct dentry *lower_dentry)
314 struct inode *inode, *lower_inode = d_inode(lower_dentry);
315 struct ecryptfs_dentry_info *dentry_info;
316 struct vfsmount *lower_mnt;
319 dentry_info = kmem_cache_alloc(ecryptfs_dentry_info_cache, GFP_KERNEL);
322 return ERR_PTR(-ENOMEM);
325 lower_mnt = mntget(ecryptfs_dentry_to_lower_mnt(dentry->d_parent));
326 fsstack_copy_attr_atime(d_inode(dentry->d_parent),
327 d_inode(lower_dentry->d_parent));
328 BUG_ON(!d_count(lower_dentry));
330 ecryptfs_set_dentry_private(dentry, dentry_info);
331 dentry_info->lower_path.mnt = lower_mnt;
332 dentry_info->lower_path.dentry = lower_dentry;
334 if (d_really_is_negative(lower_dentry)) {
335 /* We want to add because we couldn't find in lower */
339 inode = __ecryptfs_get_inode(lower_inode, dentry->d_sb);
341 printk(KERN_ERR "%s: Error interposing; rc = [%ld]\n",
342 __func__, PTR_ERR(inode));
343 return ERR_CAST(inode);
345 if (S_ISREG(inode->i_mode)) {
346 rc = ecryptfs_i_size_read(dentry, inode);
348 make_bad_inode(inode);
353 if (inode->i_state & I_NEW)
354 unlock_new_inode(inode);
355 return d_splice_alias(inode, dentry);
360 * @ecryptfs_dir_inode: The eCryptfs directory inode
361 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
362 * @flags: lookup flags
364 * Find a file on disk. If the file does not exist, then we'll add it to the
365 * dentry cache and continue on to read it from the disk.
367 static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
368 struct dentry *ecryptfs_dentry,
371 char *encrypted_and_encoded_name = NULL;
372 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
373 struct dentry *lower_dir_dentry, *lower_dentry;
374 const char *name = ecryptfs_dentry->d_name.name;
375 size_t len = ecryptfs_dentry->d_name.len;
379 lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
381 mount_crypt_stat = &ecryptfs_superblock_to_private(
382 ecryptfs_dentry->d_sb)->mount_crypt_stat;
383 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
384 rc = ecryptfs_encrypt_and_encode_filename(
385 &encrypted_and_encoded_name, &len,
386 mount_crypt_stat, name, len);
388 printk(KERN_ERR "%s: Error attempting to encrypt and encode "
389 "filename; rc = [%d]\n", __func__, rc);
392 name = encrypted_and_encoded_name;
395 lower_dentry = lookup_one_len_unlocked(name, lower_dir_dentry, len);
396 if (IS_ERR(lower_dentry)) {
397 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
398 "[%ld] on lower_dentry = [%s]\n", __func__,
399 PTR_ERR(lower_dentry),
401 res = ERR_CAST(lower_dentry);
403 res = ecryptfs_lookup_interpose(ecryptfs_dentry, lower_dentry);
405 kfree(encrypted_and_encoded_name);
409 static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
410 struct dentry *new_dentry)
412 struct dentry *lower_old_dentry;
413 struct dentry *lower_new_dentry;
414 struct dentry *lower_dir_dentry;
418 file_size_save = i_size_read(d_inode(old_dentry));
419 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
420 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
421 dget(lower_old_dentry);
422 dget(lower_new_dentry);
423 lower_dir_dentry = lock_parent(lower_new_dentry);
424 rc = vfs_link(lower_old_dentry, d_inode(lower_dir_dentry),
425 lower_new_dentry, NULL);
426 if (rc || d_really_is_negative(lower_new_dentry))
428 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb);
431 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
432 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
433 set_nlink(d_inode(old_dentry),
434 ecryptfs_inode_to_lower(d_inode(old_dentry))->i_nlink);
435 i_size_write(d_inode(new_dentry), file_size_save);
437 unlock_dir(lower_dir_dentry);
438 dput(lower_new_dentry);
439 dput(lower_old_dentry);
443 static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
445 return ecryptfs_do_unlink(dir, dentry, d_inode(dentry));
448 static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
452 struct dentry *lower_dentry;
453 struct dentry *lower_dir_dentry;
454 char *encoded_symname;
455 size_t encoded_symlen;
456 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
458 lower_dentry = ecryptfs_dentry_to_lower(dentry);
460 lower_dir_dentry = lock_parent(lower_dentry);
461 mount_crypt_stat = &ecryptfs_superblock_to_private(
462 dir->i_sb)->mount_crypt_stat;
463 rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
465 mount_crypt_stat, symname,
469 rc = vfs_symlink(d_inode(lower_dir_dentry), lower_dentry,
471 kfree(encoded_symname);
472 if (rc || d_really_is_negative(lower_dentry))
474 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
477 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
478 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
480 unlock_dir(lower_dir_dentry);
482 if (d_really_is_negative(dentry))
487 static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
490 struct dentry *lower_dentry;
491 struct dentry *lower_dir_dentry;
493 lower_dentry = ecryptfs_dentry_to_lower(dentry);
494 lower_dir_dentry = lock_parent(lower_dentry);
495 rc = vfs_mkdir(d_inode(lower_dir_dentry), lower_dentry, mode);
496 if (rc || d_really_is_negative(lower_dentry))
498 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
501 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
502 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
503 set_nlink(dir, d_inode(lower_dir_dentry)->i_nlink);
505 unlock_dir(lower_dir_dentry);
506 if (d_really_is_negative(dentry))
511 static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
513 struct dentry *lower_dentry;
514 struct dentry *lower_dir_dentry;
517 lower_dentry = ecryptfs_dentry_to_lower(dentry);
519 lower_dir_dentry = lock_parent(lower_dentry);
521 rc = vfs_rmdir(d_inode(lower_dir_dentry), lower_dentry);
523 if (!rc && d_really_is_positive(dentry))
524 clear_nlink(d_inode(dentry));
525 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
526 set_nlink(dir, d_inode(lower_dir_dentry)->i_nlink);
527 unlock_dir(lower_dir_dentry);
535 ecryptfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t dev)
538 struct dentry *lower_dentry;
539 struct dentry *lower_dir_dentry;
541 lower_dentry = ecryptfs_dentry_to_lower(dentry);
542 lower_dir_dentry = lock_parent(lower_dentry);
543 rc = vfs_mknod(d_inode(lower_dir_dentry), lower_dentry, mode, dev);
544 if (rc || d_really_is_negative(lower_dentry))
546 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
549 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
550 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
552 unlock_dir(lower_dir_dentry);
553 if (d_really_is_negative(dentry))
559 ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
560 struct inode *new_dir, struct dentry *new_dentry,
564 struct dentry *lower_old_dentry;
565 struct dentry *lower_new_dentry;
566 struct dentry *lower_old_dir_dentry;
567 struct dentry *lower_new_dir_dentry;
568 struct dentry *trap = NULL;
569 struct inode *target_inode;
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 target_inode = d_inode(new_dentry);
581 trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
583 if (lower_old_dentry->d_parent != lower_old_dir_dentry)
585 if (lower_new_dentry->d_parent != lower_new_dir_dentry)
587 if (d_unhashed(lower_old_dentry) || d_unhashed(lower_new_dentry))
589 /* source should not be ancestor of target */
590 if (trap == lower_old_dentry)
592 /* target should not be ancestor of source */
593 if (trap == lower_new_dentry) {
597 rc = vfs_rename(d_inode(lower_old_dir_dentry), lower_old_dentry,
598 d_inode(lower_new_dir_dentry), lower_new_dentry,
603 fsstack_copy_attr_all(target_inode,
604 ecryptfs_inode_to_lower(target_inode));
605 fsstack_copy_attr_all(new_dir, d_inode(lower_new_dir_dentry));
606 if (new_dir != old_dir)
607 fsstack_copy_attr_all(old_dir, d_inode(lower_old_dir_dentry));
609 unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
610 dput(lower_new_dir_dentry);
611 dput(lower_old_dir_dentry);
612 dput(lower_new_dentry);
613 dput(lower_old_dentry);
617 static char *ecryptfs_readlink_lower(struct dentry *dentry, size_t *bufsiz)
619 DEFINE_DELAYED_CALL(done);
620 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
625 link = vfs_get_link(lower_dentry, &done);
627 return ERR_CAST(link);
629 rc = ecryptfs_decode_and_decrypt_filename(&buf, bufsiz, dentry->d_sb,
631 do_delayed_call(&done);
638 static const char *ecryptfs_get_link(struct dentry *dentry,
640 struct delayed_call *done)
646 return ERR_PTR(-ECHILD);
648 buf = ecryptfs_readlink_lower(dentry, &len);
651 fsstack_copy_attr_atime(d_inode(dentry),
652 d_inode(ecryptfs_dentry_to_lower(dentry)));
654 set_delayed_call(done, kfree_link, buf);
659 * upper_size_to_lower_size
660 * @crypt_stat: Crypt_stat associated with file
661 * @upper_size: Size of the upper file
663 * Calculate the required size of the lower file based on the
664 * specified size of the upper file. This calculation is based on the
665 * number of headers in the underlying file and the extent size.
667 * Returns Calculated size of the lower file.
670 upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
675 lower_size = ecryptfs_lower_header_size(crypt_stat);
676 if (upper_size != 0) {
679 num_extents = upper_size >> crypt_stat->extent_shift;
680 if (upper_size & ~crypt_stat->extent_mask)
682 lower_size += (num_extents * crypt_stat->extent_size);
689 * @dentry: The ecryptfs layer dentry
690 * @ia: Address of the ecryptfs inode's attributes
691 * @lower_ia: Address of the lower inode's attributes
693 * Function to handle truncations modifying the size of the file. Note
694 * that the file sizes are interpolated. When expanding, we are simply
695 * writing strings of 0's out. When truncating, we truncate the upper
696 * inode and update the lower_ia according to the page index
697 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
698 * the caller must use lower_ia in a call to notify_change() to perform
699 * the truncation of the lower inode.
701 * Returns zero on success; non-zero otherwise
703 static int truncate_upper(struct dentry *dentry, struct iattr *ia,
704 struct iattr *lower_ia)
707 struct inode *inode = d_inode(dentry);
708 struct ecryptfs_crypt_stat *crypt_stat;
709 loff_t i_size = i_size_read(inode);
710 loff_t lower_size_before_truncate;
711 loff_t lower_size_after_truncate;
713 if (unlikely((ia->ia_size == i_size))) {
714 lower_ia->ia_valid &= ~ATTR_SIZE;
717 rc = ecryptfs_get_lower_file(dentry, inode);
720 crypt_stat = &ecryptfs_inode_to_private(d_inode(dentry))->crypt_stat;
721 /* Switch on growing or shrinking file */
722 if (ia->ia_size > i_size) {
723 char zero[] = { 0x00 };
725 lower_ia->ia_valid &= ~ATTR_SIZE;
726 /* Write a single 0 at the last position of the file;
727 * this triggers code that will fill in 0's throughout
728 * the intermediate portion of the previous end of the
729 * file and the new and of the file */
730 rc = ecryptfs_write(inode, zero,
731 (ia->ia_size - 1), 1);
732 } else { /* ia->ia_size < i_size_read(inode) */
733 /* We're chopping off all the pages down to the page
734 * in which ia->ia_size is located. Fill in the end of
735 * that page from (ia->ia_size & ~PAGE_MASK) to
736 * PAGE_SIZE with zeros. */
737 size_t num_zeros = (PAGE_SIZE
738 - (ia->ia_size & ~PAGE_MASK));
740 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
741 truncate_setsize(inode, ia->ia_size);
742 lower_ia->ia_size = ia->ia_size;
743 lower_ia->ia_valid |= ATTR_SIZE;
749 zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
754 rc = ecryptfs_write(inode, zeros_virt,
755 ia->ia_size, num_zeros);
758 printk(KERN_ERR "Error attempting to zero out "
759 "the remainder of the end page on "
760 "reducing truncate; rc = [%d]\n", rc);
764 truncate_setsize(inode, ia->ia_size);
765 rc = ecryptfs_write_inode_size_to_metadata(inode);
767 printk(KERN_ERR "Problem with "
768 "ecryptfs_write_inode_size_to_metadata; "
772 /* We are reducing the size of the ecryptfs file, and need to
773 * know if we need to reduce the size of the lower file. */
774 lower_size_before_truncate =
775 upper_size_to_lower_size(crypt_stat, i_size);
776 lower_size_after_truncate =
777 upper_size_to_lower_size(crypt_stat, ia->ia_size);
778 if (lower_size_after_truncate < lower_size_before_truncate) {
779 lower_ia->ia_size = lower_size_after_truncate;
780 lower_ia->ia_valid |= ATTR_SIZE;
782 lower_ia->ia_valid &= ~ATTR_SIZE;
785 ecryptfs_put_lower_file(inode);
789 static int ecryptfs_inode_newsize_ok(struct inode *inode, loff_t offset)
791 struct ecryptfs_crypt_stat *crypt_stat;
792 loff_t lower_oldsize, lower_newsize;
794 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
795 lower_oldsize = upper_size_to_lower_size(crypt_stat,
797 lower_newsize = upper_size_to_lower_size(crypt_stat, offset);
798 if (lower_newsize > lower_oldsize) {
800 * The eCryptfs inode and the new *lower* size are mixed here
801 * because we may not have the lower i_mutex held and/or it may
802 * not be appropriate to call inode_newsize_ok() with inodes
803 * from other filesystems.
805 return inode_newsize_ok(inode, lower_newsize);
813 * @dentry: The ecryptfs layer dentry
814 * @new_length: The length to expand the file to
816 * Simple function that handles the truncation of an eCryptfs inode and
817 * its corresponding lower inode.
819 * Returns zero on success; non-zero otherwise
821 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
823 struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
824 struct iattr lower_ia = { .ia_valid = 0 };
827 rc = ecryptfs_inode_newsize_ok(d_inode(dentry), new_length);
831 rc = truncate_upper(dentry, &ia, &lower_ia);
832 if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
833 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
835 inode_lock(d_inode(lower_dentry));
836 rc = notify_change(lower_dentry, &lower_ia, NULL);
837 inode_unlock(d_inode(lower_dentry));
843 ecryptfs_permission(struct inode *inode, int mask)
845 return inode_permission(ecryptfs_inode_to_lower(inode), mask);
850 * @dentry: dentry handle to the inode to modify
851 * @ia: Structure with flags of what to change and values
853 * Updates the metadata of an inode. If the update is to the size
854 * i.e. truncation, then ecryptfs_truncate will handle the size modification
855 * of both the ecryptfs inode and the lower inode.
857 * All other metadata changes will be passed right to the lower filesystem,
858 * and we will just update our inode to look like the lower.
860 static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
863 struct dentry *lower_dentry;
864 struct iattr lower_ia;
866 struct inode *lower_inode;
867 struct ecryptfs_crypt_stat *crypt_stat;
869 crypt_stat = &ecryptfs_inode_to_private(d_inode(dentry))->crypt_stat;
870 if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED)) {
871 rc = ecryptfs_init_crypt_stat(crypt_stat);
875 inode = d_inode(dentry);
876 lower_inode = ecryptfs_inode_to_lower(inode);
877 lower_dentry = ecryptfs_dentry_to_lower(dentry);
878 mutex_lock(&crypt_stat->cs_mutex);
879 if (d_is_dir(dentry))
880 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
881 else if (d_is_reg(dentry)
882 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
883 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
884 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
886 mount_crypt_stat = &ecryptfs_superblock_to_private(
887 dentry->d_sb)->mount_crypt_stat;
888 rc = ecryptfs_get_lower_file(dentry, inode);
890 mutex_unlock(&crypt_stat->cs_mutex);
893 rc = ecryptfs_read_metadata(dentry);
894 ecryptfs_put_lower_file(inode);
896 if (!(mount_crypt_stat->flags
897 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
899 printk(KERN_WARNING "Either the lower file "
900 "is not in a valid eCryptfs format, "
901 "or the key could not be retrieved. "
902 "Plaintext passthrough mode is not "
903 "enabled; returning -EIO\n");
904 mutex_unlock(&crypt_stat->cs_mutex);
908 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
909 | ECRYPTFS_ENCRYPTED);
912 mutex_unlock(&crypt_stat->cs_mutex);
914 rc = setattr_prepare(dentry, ia);
917 if (ia->ia_valid & ATTR_SIZE) {
918 rc = ecryptfs_inode_newsize_ok(inode, ia->ia_size);
923 memcpy(&lower_ia, ia, sizeof(lower_ia));
924 if (ia->ia_valid & ATTR_FILE)
925 lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
926 if (ia->ia_valid & ATTR_SIZE) {
927 rc = truncate_upper(dentry, ia, &lower_ia);
933 * mode change is for clearing setuid/setgid bits. Allow lower fs
934 * to interpret this in its own way.
936 if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
937 lower_ia.ia_valid &= ~ATTR_MODE;
939 inode_lock(d_inode(lower_dentry));
940 rc = notify_change(lower_dentry, &lower_ia, NULL);
941 inode_unlock(d_inode(lower_dentry));
943 fsstack_copy_attr_all(inode, lower_inode);
947 static int ecryptfs_getattr_link(const struct path *path, struct kstat *stat,
948 u32 request_mask, unsigned int flags)
950 struct dentry *dentry = path->dentry;
951 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
954 mount_crypt_stat = &ecryptfs_superblock_to_private(
955 dentry->d_sb)->mount_crypt_stat;
956 generic_fillattr(d_inode(dentry), stat);
957 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
961 target = ecryptfs_readlink_lower(dentry, &targetsiz);
962 if (!IS_ERR(target)) {
964 stat->size = targetsiz;
966 rc = PTR_ERR(target);
972 static int ecryptfs_getattr(const struct path *path, struct kstat *stat,
973 u32 request_mask, unsigned int flags)
975 struct dentry *dentry = path->dentry;
976 struct kstat lower_stat;
979 rc = vfs_getattr(ecryptfs_dentry_to_lower_path(dentry), &lower_stat,
980 request_mask, flags);
982 fsstack_copy_attr_all(d_inode(dentry),
983 ecryptfs_inode_to_lower(d_inode(dentry)));
984 generic_fillattr(d_inode(dentry), stat);
985 stat->blocks = lower_stat.blocks;
991 ecryptfs_setxattr(struct dentry *dentry, struct inode *inode,
992 const char *name, const void *value,
993 size_t size, int flags)
996 struct dentry *lower_dentry;
998 lower_dentry = ecryptfs_dentry_to_lower(dentry);
999 if (!(d_inode(lower_dentry)->i_opflags & IOP_XATTR)) {
1003 rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1005 fsstack_copy_attr_all(inode, d_inode(lower_dentry));
1011 ecryptfs_getxattr_lower(struct dentry *lower_dentry, struct inode *lower_inode,
1012 const char *name, void *value, size_t size)
1016 if (!(lower_inode->i_opflags & IOP_XATTR)) {
1020 inode_lock(lower_inode);
1021 rc = __vfs_getxattr(lower_dentry, lower_inode, name, value, size);
1022 inode_unlock(lower_inode);
1028 ecryptfs_getxattr(struct dentry *dentry, struct inode *inode,
1029 const char *name, void *value, size_t size)
1031 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry),
1032 ecryptfs_inode_to_lower(inode),
1037 ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1040 struct dentry *lower_dentry;
1042 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1043 if (!d_inode(lower_dentry)->i_op->listxattr) {
1047 inode_lock(d_inode(lower_dentry));
1048 rc = d_inode(lower_dentry)->i_op->listxattr(lower_dentry, list, size);
1049 inode_unlock(d_inode(lower_dentry));
1054 static int ecryptfs_removexattr(struct dentry *dentry, struct inode *inode,
1058 struct dentry *lower_dentry;
1059 struct inode *lower_inode;
1061 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1062 lower_inode = ecryptfs_inode_to_lower(inode);
1063 if (!(lower_inode->i_opflags & IOP_XATTR)) {
1067 inode_lock(lower_inode);
1068 rc = __vfs_removexattr(lower_dentry, name);
1069 inode_unlock(lower_inode);
1074 const struct inode_operations ecryptfs_symlink_iops = {
1075 .get_link = ecryptfs_get_link,
1076 .permission = ecryptfs_permission,
1077 .setattr = ecryptfs_setattr,
1078 .getattr = ecryptfs_getattr_link,
1079 .listxattr = ecryptfs_listxattr,
1082 const struct inode_operations ecryptfs_dir_iops = {
1083 .create = ecryptfs_create,
1084 .lookup = ecryptfs_lookup,
1085 .link = ecryptfs_link,
1086 .unlink = ecryptfs_unlink,
1087 .symlink = ecryptfs_symlink,
1088 .mkdir = ecryptfs_mkdir,
1089 .rmdir = ecryptfs_rmdir,
1090 .mknod = ecryptfs_mknod,
1091 .rename = ecryptfs_rename,
1092 .permission = ecryptfs_permission,
1093 .setattr = ecryptfs_setattr,
1094 .listxattr = ecryptfs_listxattr,
1097 const struct inode_operations ecryptfs_main_iops = {
1098 .permission = ecryptfs_permission,
1099 .setattr = ecryptfs_setattr,
1100 .getattr = ecryptfs_getattr,
1101 .listxattr = ecryptfs_listxattr,
1104 static int ecryptfs_xattr_get(const struct xattr_handler *handler,
1105 struct dentry *dentry, struct inode *inode,
1106 const char *name, void *buffer, size_t size)
1108 return ecryptfs_getxattr(dentry, inode, name, buffer, size);
1111 static int ecryptfs_xattr_set(const struct xattr_handler *handler,
1112 struct dentry *dentry, struct inode *inode,
1113 const char *name, const void *value, size_t size,
1117 return ecryptfs_setxattr(dentry, inode, name, value, size, flags);
1119 BUG_ON(flags != XATTR_REPLACE);
1120 return ecryptfs_removexattr(dentry, inode, name);
1124 static const struct xattr_handler ecryptfs_xattr_handler = {
1125 .prefix = "", /* match anything */
1126 .get = ecryptfs_xattr_get,
1127 .set = ecryptfs_xattr_set,
1130 const struct xattr_handler *ecryptfs_xattr_handlers[] = {
1131 &ecryptfs_xattr_handler,