2 * eCryptfs: Linux filesystem encryption layer
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>
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.
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.
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
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"
39 static struct dentry *lock_parent(struct dentry *dentry)
43 dir = dget_parent(dentry);
44 mutex_lock_nested(&(d_inode(dir)->i_mutex), I_MUTEX_PARENT);
48 static void unlock_dir(struct dentry *dir)
50 mutex_unlock(&d_inode(dir)->i_mutex);
54 static int ecryptfs_inode_test(struct inode *inode, void *lower_inode)
56 return ecryptfs_inode_to_lower(inode) == lower_inode;
59 static int ecryptfs_inode_set(struct inode *inode, void *opaque)
61 struct inode *lower_inode = opaque;
63 ecryptfs_set_inode_lower(inode, lower_inode);
64 fsstack_copy_attr_all(inode, lower_inode);
65 /* i_size will be overwritten for encrypted regular files */
66 fsstack_copy_inode_size(inode, lower_inode);
67 inode->i_ino = lower_inode->i_ino;
69 inode->i_mapping->a_ops = &ecryptfs_aops;
71 if (S_ISLNK(inode->i_mode))
72 inode->i_op = &ecryptfs_symlink_iops;
73 else if (S_ISDIR(inode->i_mode))
74 inode->i_op = &ecryptfs_dir_iops;
76 inode->i_op = &ecryptfs_main_iops;
78 if (S_ISDIR(inode->i_mode))
79 inode->i_fop = &ecryptfs_dir_fops;
80 else if (special_file(inode->i_mode))
81 init_special_inode(inode, inode->i_mode, inode->i_rdev);
83 inode->i_fop = &ecryptfs_main_fops;
88 static struct inode *__ecryptfs_get_inode(struct inode *lower_inode,
89 struct super_block *sb)
93 if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb))
94 return ERR_PTR(-EXDEV);
95 if (!igrab(lower_inode))
96 return ERR_PTR(-ESTALE);
97 inode = iget5_locked(sb, (unsigned long)lower_inode,
98 ecryptfs_inode_test, ecryptfs_inode_set,
102 return ERR_PTR(-EACCES);
104 if (!(inode->i_state & I_NEW))
110 struct inode *ecryptfs_get_inode(struct inode *lower_inode,
111 struct super_block *sb)
113 struct inode *inode = __ecryptfs_get_inode(lower_inode, sb);
115 if (!IS_ERR(inode) && (inode->i_state & I_NEW))
116 unlock_new_inode(inode);
123 * @lower_dentry: Existing dentry in the lower filesystem
124 * @dentry: ecryptfs' dentry
125 * @sb: ecryptfs's super_block
127 * Interposes upper and lower dentries.
129 * Returns zero on success; non-zero otherwise
131 static int ecryptfs_interpose(struct dentry *lower_dentry,
132 struct dentry *dentry, struct super_block *sb)
134 struct inode *inode = ecryptfs_get_inode(d_inode(lower_dentry), sb);
137 return PTR_ERR(inode);
138 d_instantiate(dentry, inode);
143 static int ecryptfs_do_unlink(struct inode *dir, struct dentry *dentry,
146 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
147 struct inode *lower_dir_inode = ecryptfs_inode_to_lower(dir);
148 struct dentry *lower_dir_dentry;
152 lower_dir_dentry = lock_parent(lower_dentry);
153 rc = vfs_unlink(lower_dir_inode, lower_dentry, NULL);
155 printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
158 fsstack_copy_attr_times(dir, lower_dir_inode);
159 set_nlink(inode, ecryptfs_inode_to_lower(inode)->i_nlink);
160 inode->i_ctime = dir->i_ctime;
163 unlock_dir(lower_dir_dentry);
170 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
171 * @ecryptfs_dentry: New file's dentry in ecryptfs
172 * @mode: The mode of the new file
174 * Creates the underlying file and the eCryptfs inode which will link to
175 * it. It will also update the eCryptfs directory inode to mimic the
176 * stat of the lower directory inode.
178 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
180 static struct inode *
181 ecryptfs_do_create(struct inode *directory_inode,
182 struct dentry *ecryptfs_dentry, umode_t mode)
185 struct dentry *lower_dentry;
186 struct dentry *lower_dir_dentry;
189 lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
190 lower_dir_dentry = lock_parent(lower_dentry);
191 rc = vfs_create(d_inode(lower_dir_dentry), lower_dentry, mode, true);
193 printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
194 "rc = [%d]\n", __func__, rc);
198 inode = __ecryptfs_get_inode(d_inode(lower_dentry),
199 directory_inode->i_sb);
201 vfs_unlink(d_inode(lower_dir_dentry), lower_dentry, NULL);
204 fsstack_copy_attr_times(directory_inode, d_inode(lower_dir_dentry));
205 fsstack_copy_inode_size(directory_inode, d_inode(lower_dir_dentry));
207 unlock_dir(lower_dir_dentry);
212 * ecryptfs_initialize_file
214 * Cause the file to be changed from a basic empty file to an ecryptfs
215 * file with a header and first data page.
217 * Returns zero on success
219 int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
220 struct inode *ecryptfs_inode)
222 struct ecryptfs_crypt_stat *crypt_stat =
223 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
226 if (S_ISDIR(ecryptfs_inode->i_mode)) {
227 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
228 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
231 ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
232 rc = ecryptfs_new_file_context(ecryptfs_inode);
234 ecryptfs_printk(KERN_ERR, "Error creating new file "
235 "context; rc = [%d]\n", rc);
238 rc = ecryptfs_get_lower_file(ecryptfs_dentry, ecryptfs_inode);
240 printk(KERN_ERR "%s: Error attempting to initialize "
241 "the lower file for the dentry with name "
242 "[%pd]; rc = [%d]\n", __func__,
243 ecryptfs_dentry, rc);
246 rc = ecryptfs_write_metadata(ecryptfs_dentry, ecryptfs_inode);
248 printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
249 ecryptfs_put_lower_file(ecryptfs_inode);
256 * @dir: The inode of the directory in which to create the file.
257 * @dentry: The eCryptfs dentry
258 * @mode: The mode of the new file.
260 * Creates a new file.
262 * Returns zero on success; non-zero on error condition
267 ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
268 umode_t mode, bool excl)
270 struct inode *ecryptfs_inode;
272 struct ecryptfs_crypt_stat *crypt_stat;
274 ecryptfs_inode = ecryptfs_do_create(directory_inode, ecryptfs_dentry,
276 if (IS_ERR(ecryptfs_inode)) {
277 ecryptfs_printk(KERN_WARNING, "Failed to create file in"
278 "lower filesystem\n");
279 rc = PTR_ERR(ecryptfs_inode);
283 /* At this point, a file exists on "disk"; we need to make sure
284 * that this on disk file is prepared to be an ecryptfs file */
285 rc = ecryptfs_initialize_file(ecryptfs_dentry, ecryptfs_inode);
287 ecryptfs_do_unlink(directory_inode, ecryptfs_dentry,
289 make_bad_inode(ecryptfs_inode);
290 unlock_new_inode(ecryptfs_inode);
291 iput(ecryptfs_inode);
295 crypt_stat = &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
296 if (get_events() && get_events()->open_cb)
297 get_events()->open_cb(
298 ecryptfs_inode_to_lower(ecryptfs_inode),
301 unlock_new_inode(ecryptfs_inode);
302 d_instantiate(ecryptfs_dentry, ecryptfs_inode);
307 static int ecryptfs_i_size_read(struct dentry *dentry, struct inode *inode)
309 struct ecryptfs_crypt_stat *crypt_stat;
312 rc = ecryptfs_get_lower_file(dentry, inode);
314 printk(KERN_ERR "%s: Error attempting to initialize "
315 "the lower file for the dentry with name "
316 "[%pd]; rc = [%d]\n", __func__,
321 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
322 /* TODO: lock for crypt_stat comparison */
323 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
324 ecryptfs_set_default_sizes(crypt_stat);
326 rc = ecryptfs_read_and_validate_header_region(inode);
327 ecryptfs_put_lower_file(inode);
329 rc = ecryptfs_read_and_validate_xattr_region(dentry, inode);
331 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
334 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
339 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
341 static int ecryptfs_lookup_interpose(struct dentry *dentry,
342 struct dentry *lower_dentry,
343 struct inode *dir_inode)
345 struct path *path = ecryptfs_dentry_to_lower_path(dentry->d_parent);
346 struct inode *inode, *lower_inode;
347 struct ecryptfs_dentry_info *dentry_info;
350 dentry_info = kmem_cache_alloc(ecryptfs_dentry_info_cache, GFP_KERNEL);
352 printk(KERN_ERR "%s: Out of memory whilst attempting "
353 "to allocate ecryptfs_dentry_info struct\n",
359 fsstack_copy_attr_atime(dir_inode, d_inode(path->dentry));
360 BUG_ON(!d_count(lower_dentry));
362 ecryptfs_set_dentry_private(dentry, dentry_info);
363 dentry_info->lower_path.mnt = mntget(path->mnt);
364 dentry_info->lower_path.dentry = lower_dentry;
367 * negative dentry can go positive under us here - its parent is not
368 * locked. That's OK and that could happen just as we return from
369 * ecryptfs_lookup() anyway. Just need to be careful and fetch
370 * ->d_inode only once - it's not stable here.
372 lower_inode = READ_ONCE(lower_dentry->d_inode);
375 /* We want to add because we couldn't find in lower */
379 inode = __ecryptfs_get_inode(lower_inode, dir_inode->i_sb);
381 printk(KERN_ERR "%s: Error interposing; rc = [%ld]\n",
382 __func__, PTR_ERR(inode));
383 return PTR_ERR(inode);
385 if (S_ISREG(inode->i_mode)) {
386 rc = ecryptfs_i_size_read(dentry, inode);
388 make_bad_inode(inode);
393 if (inode->i_state & I_NEW)
394 unlock_new_inode(inode);
395 d_add(dentry, inode);
402 * @ecryptfs_dir_inode: The eCryptfs directory inode
403 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
404 * @flags: lookup flags
406 * Find a file on disk. If the file does not exist, then we'll add it to the
407 * dentry cache and continue on to read it from the disk.
409 static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
410 struct dentry *ecryptfs_dentry,
413 char *encrypted_and_encoded_name = NULL;
414 size_t encrypted_and_encoded_name_size;
415 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
416 struct dentry *lower_dir_dentry, *lower_dentry;
419 lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
420 mutex_lock(&d_inode(lower_dir_dentry)->i_mutex);
421 lower_dentry = lookup_one_len(ecryptfs_dentry->d_name.name,
423 ecryptfs_dentry->d_name.len);
424 mutex_unlock(&d_inode(lower_dir_dentry)->i_mutex);
425 if (IS_ERR(lower_dentry)) {
426 rc = PTR_ERR(lower_dentry);
427 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
428 "[%d] on lower_dentry = [%pd]\n", __func__, rc,
432 if (d_really_is_positive(lower_dentry))
434 mount_crypt_stat = &ecryptfs_superblock_to_private(
435 ecryptfs_dentry->d_sb)->mount_crypt_stat;
436 if (!(mount_crypt_stat
437 && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)))
440 rc = ecryptfs_encrypt_and_encode_filename(
441 &encrypted_and_encoded_name, &encrypted_and_encoded_name_size,
442 NULL, mount_crypt_stat, ecryptfs_dentry->d_name.name,
443 ecryptfs_dentry->d_name.len);
445 printk(KERN_ERR "%s: Error attempting to encrypt and encode "
446 "filename; rc = [%d]\n", __func__, rc);
449 mutex_lock(&d_inode(lower_dir_dentry)->i_mutex);
450 lower_dentry = lookup_one_len(encrypted_and_encoded_name,
452 encrypted_and_encoded_name_size);
453 mutex_unlock(&d_inode(lower_dir_dentry)->i_mutex);
454 if (IS_ERR(lower_dentry)) {
455 rc = PTR_ERR(lower_dentry);
456 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
457 "[%d] on lower_dentry = [%s]\n", __func__, rc,
458 encrypted_and_encoded_name);
462 rc = ecryptfs_lookup_interpose(ecryptfs_dentry, lower_dentry,
465 kfree(encrypted_and_encoded_name);
469 static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
470 struct dentry *new_dentry)
472 struct dentry *lower_old_dentry;
473 struct dentry *lower_new_dentry;
474 struct dentry *lower_dir_dentry;
478 file_size_save = i_size_read(d_inode(old_dentry));
479 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
480 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
481 dget(lower_old_dentry);
482 dget(lower_new_dentry);
483 lower_dir_dentry = lock_parent(lower_new_dentry);
484 rc = vfs_link(lower_old_dentry, d_inode(lower_dir_dentry),
485 lower_new_dentry, NULL);
486 if (rc || d_really_is_negative(lower_new_dentry))
488 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb);
491 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
492 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
493 set_nlink(d_inode(old_dentry),
494 ecryptfs_inode_to_lower(d_inode(old_dentry))->i_nlink);
495 i_size_write(d_inode(new_dentry), file_size_save);
497 unlock_dir(lower_dir_dentry);
498 dput(lower_new_dentry);
499 dput(lower_old_dentry);
503 static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
505 return ecryptfs_do_unlink(dir, dentry, d_inode(dentry));
508 static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
512 struct dentry *lower_dentry;
513 struct dentry *lower_dir_dentry;
514 char *encoded_symname;
515 size_t encoded_symlen;
516 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
518 lower_dentry = ecryptfs_dentry_to_lower(dentry);
520 lower_dir_dentry = lock_parent(lower_dentry);
521 mount_crypt_stat = &ecryptfs_superblock_to_private(
522 dir->i_sb)->mount_crypt_stat;
523 rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
526 mount_crypt_stat, symname,
530 rc = vfs_symlink(d_inode(lower_dir_dentry), lower_dentry,
532 kfree(encoded_symname);
533 if (rc || d_really_is_negative(lower_dentry))
535 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
538 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
539 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
541 unlock_dir(lower_dir_dentry);
543 if (d_really_is_negative(dentry))
548 static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
551 struct dentry *lower_dentry;
552 struct dentry *lower_dir_dentry;
554 lower_dentry = ecryptfs_dentry_to_lower(dentry);
555 lower_dir_dentry = lock_parent(lower_dentry);
556 rc = vfs_mkdir(d_inode(lower_dir_dentry), lower_dentry, mode);
557 if (rc || d_really_is_negative(lower_dentry))
559 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
562 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
563 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
564 set_nlink(dir, d_inode(lower_dir_dentry)->i_nlink);
566 unlock_dir(lower_dir_dentry);
567 if (d_really_is_negative(dentry))
572 static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
574 struct dentry *lower_dentry;
575 struct dentry *lower_dir_dentry;
578 lower_dentry = ecryptfs_dentry_to_lower(dentry);
580 lower_dir_dentry = lock_parent(lower_dentry);
582 rc = vfs_rmdir(d_inode(lower_dir_dentry), lower_dentry);
584 if (!rc && d_really_is_positive(dentry))
585 clear_nlink(d_inode(dentry));
586 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
587 set_nlink(dir, d_inode(lower_dir_dentry)->i_nlink);
588 unlock_dir(lower_dir_dentry);
596 ecryptfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t dev)
599 struct dentry *lower_dentry;
600 struct dentry *lower_dir_dentry;
602 lower_dentry = ecryptfs_dentry_to_lower(dentry);
603 lower_dir_dentry = lock_parent(lower_dentry);
604 rc = vfs_mknod(d_inode(lower_dir_dentry), lower_dentry, mode, dev);
605 if (rc || d_really_is_negative(lower_dentry))
607 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
610 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
611 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
613 unlock_dir(lower_dir_dentry);
614 if (d_really_is_negative(dentry))
620 ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
621 struct inode *new_dir, struct dentry *new_dentry)
624 struct dentry *lower_old_dentry;
625 struct dentry *lower_new_dentry;
626 struct dentry *lower_old_dir_dentry;
627 struct dentry *lower_new_dir_dentry;
628 struct dentry *trap = NULL;
629 struct inode *target_inode;
631 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
632 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
633 dget(lower_old_dentry);
634 dget(lower_new_dentry);
635 lower_old_dir_dentry = dget_parent(lower_old_dentry);
636 lower_new_dir_dentry = dget_parent(lower_new_dentry);
637 target_inode = d_inode(new_dentry);
638 trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
639 /* source should not be ancestor of target */
640 if (trap == lower_old_dentry) {
644 /* target should not be ancestor of source */
645 if (trap == lower_new_dentry) {
649 rc = vfs_rename(d_inode(lower_old_dir_dentry), lower_old_dentry,
650 d_inode(lower_new_dir_dentry), lower_new_dentry,
655 fsstack_copy_attr_all(target_inode,
656 ecryptfs_inode_to_lower(target_inode));
657 fsstack_copy_attr_all(new_dir, d_inode(lower_new_dir_dentry));
658 if (new_dir != old_dir)
659 fsstack_copy_attr_all(old_dir, d_inode(lower_old_dir_dentry));
661 unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
662 dput(lower_new_dir_dentry);
663 dput(lower_old_dir_dentry);
664 dput(lower_new_dentry);
665 dput(lower_old_dentry);
669 static char *ecryptfs_readlink_lower(struct dentry *dentry, size_t *bufsiz)
671 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
677 lower_buf = kmalloc(PATH_MAX, GFP_KERNEL);
679 return ERR_PTR(-ENOMEM);
682 rc = d_inode(lower_dentry)->i_op->readlink(lower_dentry,
683 (char __user *)lower_buf,
688 rc = ecryptfs_decode_and_decrypt_filename(&buf, bufsiz, dentry->d_sb,
692 return rc ? ERR_PTR(rc) : buf;
695 static const char *ecryptfs_follow_link(struct dentry *dentry, void **cookie)
698 char *buf = ecryptfs_readlink_lower(dentry, &len);
701 fsstack_copy_attr_atime(d_inode(dentry),
702 d_inode(ecryptfs_dentry_to_lower(dentry)));
704 return *cookie = buf;
708 * upper_size_to_lower_size
709 * @crypt_stat: Crypt_stat associated with file
710 * @upper_size: Size of the upper file
712 * Calculate the required size of the lower file based on the
713 * specified size of the upper file. This calculation is based on the
714 * number of headers in the underlying file and the extent size.
716 * Returns Calculated size of the lower file.
719 upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
724 lower_size = ecryptfs_lower_header_size(crypt_stat);
725 if (upper_size != 0) {
728 num_extents = upper_size >> crypt_stat->extent_shift;
729 if (upper_size & ~crypt_stat->extent_mask)
731 lower_size += (num_extents * crypt_stat->extent_size);
738 * @dentry: The ecryptfs layer dentry
739 * @ia: Address of the ecryptfs inode's attributes
740 * @lower_ia: Address of the lower inode's attributes
742 * Function to handle truncations modifying the size of the file. Note
743 * that the file sizes are interpolated. When expanding, we are simply
744 * writing strings of 0's out. When truncating, we truncate the upper
745 * inode and update the lower_ia according to the page index
746 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
747 * the caller must use lower_ia in a call to notify_change() to perform
748 * the truncation of the lower inode.
750 * Returns zero on success; non-zero otherwise
752 static int truncate_upper(struct dentry *dentry, struct iattr *ia,
753 struct iattr *lower_ia)
756 struct inode *inode = d_inode(dentry);
757 struct ecryptfs_crypt_stat *crypt_stat;
758 loff_t i_size = i_size_read(inode);
759 loff_t lower_size_before_truncate;
760 loff_t lower_size_after_truncate;
762 if (unlikely((ia->ia_size == i_size))) {
763 lower_ia->ia_valid &= ~ATTR_SIZE;
766 rc = ecryptfs_get_lower_file(dentry, inode);
769 crypt_stat = &ecryptfs_inode_to_private(d_inode(dentry))->crypt_stat;
770 /* Switch on growing or shrinking file */
771 if (ia->ia_size > i_size) {
772 char zero[] = { 0x00 };
774 lower_ia->ia_valid &= ~ATTR_SIZE;
775 /* Write a single 0 at the last position of the file;
776 * this triggers code that will fill in 0's throughout
777 * the intermediate portion of the previous end of the
778 * file and the new and of the file */
779 rc = ecryptfs_write(inode, zero,
780 (ia->ia_size - 1), 1);
781 } else { /* ia->ia_size < i_size_read(inode) */
782 /* We're chopping off all the pages down to the page
783 * in which ia->ia_size is located. Fill in the end of
784 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
785 * PAGE_CACHE_SIZE with zeros. */
786 size_t num_zeros = (PAGE_CACHE_SIZE
787 - (ia->ia_size & ~PAGE_CACHE_MASK));
789 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
790 truncate_setsize(inode, ia->ia_size);
791 lower_ia->ia_size = ia->ia_size;
792 lower_ia->ia_valid |= ATTR_SIZE;
798 zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
803 rc = ecryptfs_write(inode, zeros_virt,
804 ia->ia_size, num_zeros);
807 printk(KERN_ERR "Error attempting to zero out "
808 "the remainder of the end page on "
809 "reducing truncate; rc = [%d]\n", rc);
813 truncate_setsize(inode, ia->ia_size);
814 rc = ecryptfs_write_inode_size_to_metadata(inode);
816 printk(KERN_ERR "Problem with "
817 "ecryptfs_write_inode_size_to_metadata; "
821 /* We are reducing the size of the ecryptfs file, and need to
822 * know if we need to reduce the size of the lower file. */
823 lower_size_before_truncate =
824 upper_size_to_lower_size(crypt_stat, i_size);
825 lower_size_after_truncate =
826 upper_size_to_lower_size(crypt_stat, ia->ia_size);
827 if (lower_size_after_truncate < lower_size_before_truncate) {
828 lower_ia->ia_size = lower_size_after_truncate;
829 lower_ia->ia_valid |= ATTR_SIZE;
831 lower_ia->ia_valid &= ~ATTR_SIZE;
834 ecryptfs_put_lower_file(inode);
838 static int ecryptfs_inode_newsize_ok(struct inode *inode, loff_t offset)
840 struct ecryptfs_crypt_stat *crypt_stat;
841 loff_t lower_oldsize, lower_newsize;
843 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
844 lower_oldsize = upper_size_to_lower_size(crypt_stat,
846 lower_newsize = upper_size_to_lower_size(crypt_stat, offset);
847 if (lower_newsize > lower_oldsize) {
849 * The eCryptfs inode and the new *lower* size are mixed here
850 * because we may not have the lower i_mutex held and/or it may
851 * not be appropriate to call inode_newsize_ok() with inodes
852 * from other filesystems.
854 return inode_newsize_ok(inode, lower_newsize);
862 * @dentry: The ecryptfs layer dentry
863 * @new_length: The length to expand the file to
865 * Simple function that handles the truncation of an eCryptfs inode and
866 * its corresponding lower inode.
868 * Returns zero on success; non-zero otherwise
870 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
872 struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
873 struct iattr lower_ia = { .ia_valid = 0 };
876 rc = ecryptfs_inode_newsize_ok(d_inode(dentry), new_length);
880 rc = truncate_upper(dentry, &ia, &lower_ia);
881 if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
882 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
884 mutex_lock(&d_inode(lower_dentry)->i_mutex);
885 rc = notify_change(lower_dentry, &lower_ia, NULL);
886 mutex_unlock(&d_inode(lower_dentry)->i_mutex);
892 ecryptfs_permission(struct inode *inode, int mask)
894 return inode_permission(ecryptfs_inode_to_lower(inode), mask);
899 * @dentry: dentry handle to the inode to modify
900 * @ia: Structure with flags of what to change and values
902 * Updates the metadata of an inode. If the update is to the size
903 * i.e. truncation, then ecryptfs_truncate will handle the size modification
904 * of both the ecryptfs inode and the lower inode.
906 * All other metadata changes will be passed right to the lower filesystem,
907 * and we will just update our inode to look like the lower.
909 static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
912 struct dentry *lower_dentry;
913 struct iattr lower_ia;
915 struct inode *lower_inode;
916 struct ecryptfs_crypt_stat *crypt_stat;
918 crypt_stat = &ecryptfs_inode_to_private(d_inode(dentry))->crypt_stat;
919 if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED))
920 ecryptfs_init_crypt_stat(crypt_stat);
921 inode = d_inode(dentry);
922 lower_inode = ecryptfs_inode_to_lower(inode);
923 lower_dentry = ecryptfs_dentry_to_lower(dentry);
924 mutex_lock(&crypt_stat->cs_mutex);
925 if (d_is_dir(dentry))
926 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
927 else if (d_is_reg(dentry)
928 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
929 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
930 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
932 mount_crypt_stat = &ecryptfs_superblock_to_private(
933 dentry->d_sb)->mount_crypt_stat;
934 rc = ecryptfs_get_lower_file(dentry, inode);
936 mutex_unlock(&crypt_stat->cs_mutex);
939 rc = ecryptfs_read_metadata(dentry);
940 ecryptfs_put_lower_file(inode);
942 if (!(mount_crypt_stat->flags
943 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
945 printk(KERN_WARNING "Either the lower file "
946 "is not in a valid eCryptfs format, "
947 "or the key could not be retrieved. "
948 "Plaintext passthrough mode is not "
949 "enabled; returning -EIO\n");
950 mutex_unlock(&crypt_stat->cs_mutex);
954 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
955 | ECRYPTFS_ENCRYPTED);
958 mutex_unlock(&crypt_stat->cs_mutex);
960 rc = inode_change_ok(inode, ia);
963 if (ia->ia_valid & ATTR_SIZE) {
964 rc = ecryptfs_inode_newsize_ok(inode, ia->ia_size);
969 memcpy(&lower_ia, ia, sizeof(lower_ia));
970 if (ia->ia_valid & ATTR_FILE)
971 lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
972 if (ia->ia_valid & ATTR_SIZE) {
973 rc = truncate_upper(dentry, ia, &lower_ia);
979 * mode change is for clearing setuid/setgid bits. Allow lower fs
980 * to interpret this in its own way.
982 if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
983 lower_ia.ia_valid &= ~ATTR_MODE;
985 mutex_lock(&d_inode(lower_dentry)->i_mutex);
986 rc = notify_change(lower_dentry, &lower_ia, NULL);
987 mutex_unlock(&d_inode(lower_dentry)->i_mutex);
989 fsstack_copy_attr_all(inode, lower_inode);
993 static int ecryptfs_getattr_link(struct vfsmount *mnt, struct dentry *dentry,
996 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
999 mount_crypt_stat = &ecryptfs_superblock_to_private(
1000 dentry->d_sb)->mount_crypt_stat;
1001 generic_fillattr(d_inode(dentry), stat);
1002 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
1006 target = ecryptfs_readlink_lower(dentry, &targetsiz);
1007 if (!IS_ERR(target)) {
1009 stat->size = targetsiz;
1011 rc = PTR_ERR(target);
1017 static int ecryptfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
1020 struct kstat lower_stat;
1023 rc = vfs_getattr(ecryptfs_dentry_to_lower_path(dentry), &lower_stat);
1025 fsstack_copy_attr_all(d_inode(dentry),
1026 ecryptfs_inode_to_lower(d_inode(dentry)));
1027 generic_fillattr(d_inode(dentry), stat);
1028 stat->blocks = lower_stat.blocks;
1034 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
1035 size_t size, int flags)
1038 struct dentry *lower_dentry;
1040 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1041 if (!d_inode(lower_dentry)->i_op->setxattr) {
1046 rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1047 if (!rc && d_really_is_positive(dentry))
1048 fsstack_copy_attr_all(d_inode(dentry), d_inode(lower_dentry));
1054 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
1055 void *value, size_t size)
1059 if (!d_inode(lower_dentry)->i_op->getxattr) {
1063 mutex_lock(&d_inode(lower_dentry)->i_mutex);
1064 rc = d_inode(lower_dentry)->i_op->getxattr(lower_dentry, name, value,
1066 mutex_unlock(&d_inode(lower_dentry)->i_mutex);
1072 ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
1075 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry), name,
1080 ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1083 struct dentry *lower_dentry;
1085 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1086 if (!d_inode(lower_dentry)->i_op->listxattr) {
1090 mutex_lock(&d_inode(lower_dentry)->i_mutex);
1091 rc = d_inode(lower_dentry)->i_op->listxattr(lower_dentry, list, size);
1092 mutex_unlock(&d_inode(lower_dentry)->i_mutex);
1097 static int ecryptfs_removexattr(struct dentry *dentry, const char *name)
1100 struct dentry *lower_dentry;
1102 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1103 if (!d_inode(lower_dentry)->i_op->removexattr) {
1107 mutex_lock(&d_inode(lower_dentry)->i_mutex);
1108 rc = d_inode(lower_dentry)->i_op->removexattr(lower_dentry, name);
1109 mutex_unlock(&d_inode(lower_dentry)->i_mutex);
1114 const struct inode_operations ecryptfs_symlink_iops = {
1115 .readlink = generic_readlink,
1116 .follow_link = ecryptfs_follow_link,
1117 .put_link = kfree_put_link,
1118 .permission = ecryptfs_permission,
1119 .setattr = ecryptfs_setattr,
1120 .getattr = ecryptfs_getattr_link,
1121 .setxattr = ecryptfs_setxattr,
1122 .getxattr = ecryptfs_getxattr,
1123 .listxattr = ecryptfs_listxattr,
1124 .removexattr = ecryptfs_removexattr
1127 const struct inode_operations ecryptfs_dir_iops = {
1128 .create = ecryptfs_create,
1129 .lookup = ecryptfs_lookup,
1130 .link = ecryptfs_link,
1131 .unlink = ecryptfs_unlink,
1132 .symlink = ecryptfs_symlink,
1133 .mkdir = ecryptfs_mkdir,
1134 .rmdir = ecryptfs_rmdir,
1135 .mknod = ecryptfs_mknod,
1136 .rename = ecryptfs_rename,
1137 .permission = ecryptfs_permission,
1138 .setattr = ecryptfs_setattr,
1139 .setxattr = ecryptfs_setxattr,
1140 .getxattr = ecryptfs_getxattr,
1141 .listxattr = ecryptfs_listxattr,
1142 .removexattr = ecryptfs_removexattr
1145 const struct inode_operations ecryptfs_main_iops = {
1146 .permission = ecryptfs_permission,
1147 .setattr = ecryptfs_setattr,
1148 .getattr = ecryptfs_getattr,
1149 .setxattr = ecryptfs_setxattr,
1150 .getxattr = ecryptfs_getxattr,
1151 .listxattr = ecryptfs_listxattr,
1152 .removexattr = ecryptfs_removexattr