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(&(dir->d_inode->i_mutex), I_MUTEX_PARENT);
48 static void unlock_dir(struct dentry *dir)
50 mutex_unlock(&dir->d_inode->i_mutex);
54 static int ecryptfs_inode_test(struct inode *inode, void *lower_inode)
56 if (ecryptfs_inode_to_lower(inode) == (struct inode *)lower_inode)
61 static int ecryptfs_inode_set(struct inode *inode, void *opaque)
63 struct inode *lower_inode = opaque;
65 ecryptfs_set_inode_lower(inode, lower_inode);
66 fsstack_copy_attr_all(inode, lower_inode);
67 /* i_size will be overwritten for encrypted regular files */
68 fsstack_copy_inode_size(inode, lower_inode);
69 inode->i_ino = lower_inode->i_ino;
71 inode->i_mapping->a_ops = &ecryptfs_aops;
72 inode->i_mapping->backing_dev_info = inode->i_sb->s_bdi;
74 if (S_ISLNK(inode->i_mode))
75 inode->i_op = &ecryptfs_symlink_iops;
76 else if (S_ISDIR(inode->i_mode))
77 inode->i_op = &ecryptfs_dir_iops;
79 inode->i_op = &ecryptfs_main_iops;
81 if (S_ISDIR(inode->i_mode))
82 inode->i_fop = &ecryptfs_dir_fops;
83 else if (special_file(inode->i_mode))
84 init_special_inode(inode, inode->i_mode, inode->i_rdev);
86 inode->i_fop = &ecryptfs_main_fops;
91 static struct inode *__ecryptfs_get_inode(struct inode *lower_inode,
92 struct super_block *sb)
96 if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb))
97 return ERR_PTR(-EXDEV);
98 if (!igrab(lower_inode))
99 return ERR_PTR(-ESTALE);
100 inode = iget5_locked(sb, (unsigned long)lower_inode,
101 ecryptfs_inode_test, ecryptfs_inode_set,
105 return ERR_PTR(-EACCES);
107 if (!(inode->i_state & I_NEW))
113 struct inode *ecryptfs_get_inode(struct inode *lower_inode,
114 struct super_block *sb)
116 struct inode *inode = __ecryptfs_get_inode(lower_inode, sb);
118 if (!IS_ERR(inode) && (inode->i_state & I_NEW))
119 unlock_new_inode(inode);
126 * @lower_dentry: Existing dentry in the lower filesystem
127 * @dentry: ecryptfs' dentry
128 * @sb: ecryptfs's super_block
130 * Interposes upper and lower dentries.
132 * Returns zero on success; non-zero otherwise
134 static int ecryptfs_interpose(struct dentry *lower_dentry,
135 struct dentry *dentry, struct super_block *sb)
137 struct inode *inode = ecryptfs_get_inode(lower_dentry->d_inode, sb);
140 return PTR_ERR(inode);
141 d_instantiate(dentry, inode);
146 static int ecryptfs_do_unlink(struct inode *dir, struct dentry *dentry,
149 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
150 struct inode *lower_dir_inode = ecryptfs_inode_to_lower(dir);
151 struct dentry *lower_dir_dentry;
155 lower_dir_dentry = lock_parent(lower_dentry);
156 rc = vfs_unlink(lower_dir_inode, lower_dentry);
158 printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
161 fsstack_copy_attr_times(dir, lower_dir_inode);
162 set_nlink(inode, ecryptfs_inode_to_lower(inode)->i_nlink);
163 inode->i_ctime = dir->i_ctime;
166 unlock_dir(lower_dir_dentry);
173 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
174 * @ecryptfs_dentry: New file's dentry in ecryptfs
175 * @mode: The mode of the new file
176 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
178 * Creates the underlying file and the eCryptfs inode which will link to
179 * it. It will also update the eCryptfs directory inode to mimic the
180 * stat of the lower directory inode.
182 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
184 static struct inode *
185 ecryptfs_do_create(struct inode *directory_inode,
186 struct dentry *ecryptfs_dentry, umode_t mode)
189 struct dentry *lower_dentry;
190 struct dentry *lower_dir_dentry;
193 lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
194 lower_dir_dentry = lock_parent(lower_dentry);
195 if (IS_ERR(lower_dir_dentry)) {
196 ecryptfs_printk(KERN_ERR, "Error locking directory of "
198 inode = ERR_CAST(lower_dir_dentry);
201 rc = vfs_create(lower_dir_dentry->d_inode, lower_dentry, mode, NULL);
203 printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
204 "rc = [%d]\n", __func__, rc);
208 inode = __ecryptfs_get_inode(lower_dentry->d_inode,
209 directory_inode->i_sb);
211 vfs_unlink(lower_dir_dentry->d_inode, lower_dentry);
214 fsstack_copy_attr_times(directory_inode, lower_dir_dentry->d_inode);
215 fsstack_copy_inode_size(directory_inode, lower_dir_dentry->d_inode);
217 unlock_dir(lower_dir_dentry);
223 * ecryptfs_initialize_file
225 * Cause the file to be changed from a basic empty file to an ecryptfs
226 * file with a header and first data page.
228 * Returns zero on success
230 int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
231 struct inode *ecryptfs_inode)
233 struct ecryptfs_crypt_stat *crypt_stat =
234 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
237 if (S_ISDIR(ecryptfs_inode->i_mode)) {
238 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
239 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
242 ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
243 rc = ecryptfs_new_file_context(ecryptfs_inode);
245 ecryptfs_printk(KERN_ERR, "Error creating new file "
246 "context; rc = [%d]\n", rc);
249 rc = ecryptfs_get_lower_file(ecryptfs_dentry, ecryptfs_inode);
251 printk(KERN_ERR "%s: Error attempting to initialize "
252 "the lower file for the dentry with name "
253 "[%s]; rc = [%d]\n", __func__,
254 ecryptfs_dentry->d_name.name, rc);
257 rc = ecryptfs_write_metadata(ecryptfs_dentry, ecryptfs_inode);
259 printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
260 ecryptfs_put_lower_file(ecryptfs_inode);
267 * @dir: The inode of the directory in which to create the file.
268 * @dentry: The eCryptfs dentry
269 * @mode: The mode of the new file.
272 * Creates a new file.
274 * Returns zero on success; non-zero on error condition
277 ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
278 umode_t mode, struct nameidata *nd)
280 struct inode *ecryptfs_inode;
283 ecryptfs_inode = ecryptfs_do_create(directory_inode, ecryptfs_dentry,
285 if (unlikely(IS_ERR(ecryptfs_inode))) {
286 ecryptfs_printk(KERN_WARNING, "Failed to create file in"
287 "lower filesystem\n");
288 rc = PTR_ERR(ecryptfs_inode);
291 /* At this point, a file exists on "disk"; we need to make sure
292 * that this on disk file is prepared to be an ecryptfs file */
293 rc = ecryptfs_initialize_file(ecryptfs_dentry, ecryptfs_inode);
295 ecryptfs_do_unlink(directory_inode, ecryptfs_dentry,
297 make_bad_inode(ecryptfs_inode);
298 unlock_new_inode(ecryptfs_inode);
299 iput(ecryptfs_inode);
302 d_instantiate(ecryptfs_dentry, ecryptfs_inode);
303 unlock_new_inode(ecryptfs_inode);
308 static int ecryptfs_i_size_read(struct dentry *dentry, struct inode *inode)
310 struct ecryptfs_crypt_stat *crypt_stat;
313 rc = ecryptfs_get_lower_file(dentry, inode);
315 printk(KERN_ERR "%s: Error attempting to initialize "
316 "the lower file for the dentry with name "
317 "[%s]; rc = [%d]\n", __func__,
318 dentry->d_name.name, rc);
322 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
323 /* TODO: lock for crypt_stat comparison */
324 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
325 ecryptfs_set_default_sizes(crypt_stat);
327 rc = ecryptfs_read_and_validate_header_region(inode);
328 ecryptfs_put_lower_file(inode);
330 rc = ecryptfs_read_and_validate_xattr_region(dentry, inode);
332 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
335 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
340 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
342 static int ecryptfs_lookup_interpose(struct dentry *dentry,
343 struct dentry *lower_dentry,
344 struct inode *dir_inode)
346 struct inode *inode, *lower_inode = lower_dentry->d_inode;
347 struct ecryptfs_dentry_info *dentry_info;
348 struct vfsmount *lower_mnt;
351 lower_mnt = mntget(ecryptfs_dentry_to_lower_mnt(dentry->d_parent));
352 fsstack_copy_attr_atime(dir_inode, lower_dentry->d_parent->d_inode);
353 BUG_ON(!lower_dentry->d_count);
355 dentry_info = kmem_cache_alloc(ecryptfs_dentry_info_cache, GFP_KERNEL);
356 ecryptfs_set_dentry_private(dentry, dentry_info);
358 printk(KERN_ERR "%s: Out of memory whilst attempting "
359 "to allocate ecryptfs_dentry_info struct\n",
366 ecryptfs_set_dentry_lower(dentry, lower_dentry);
367 ecryptfs_set_dentry_lower_mnt(dentry, lower_mnt);
369 if (!lower_dentry->d_inode) {
370 /* We want to add because we couldn't find in lower */
374 inode = __ecryptfs_get_inode(lower_inode, dir_inode->i_sb);
376 printk(KERN_ERR "%s: Error interposing; rc = [%ld]\n",
377 __func__, PTR_ERR(inode));
378 return PTR_ERR(inode);
380 if (S_ISREG(inode->i_mode)) {
381 rc = ecryptfs_i_size_read(dentry, inode);
383 make_bad_inode(inode);
388 if (inode->i_state & I_NEW)
389 unlock_new_inode(inode);
390 d_add(dentry, inode);
397 * @ecryptfs_dir_inode: The eCryptfs directory inode
398 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
399 * @ecryptfs_nd: nameidata; may be NULL
401 * Find a file on disk. If the file does not exist, then we'll add it to the
402 * dentry cache and continue on to read it from the disk.
404 static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
405 struct dentry *ecryptfs_dentry,
406 struct nameidata *ecryptfs_nd)
408 char *encrypted_and_encoded_name = NULL;
409 size_t encrypted_and_encoded_name_size;
410 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
411 struct dentry *lower_dir_dentry, *lower_dentry;
414 if ((ecryptfs_dentry->d_name.len == 1
415 && !strcmp(ecryptfs_dentry->d_name.name, "."))
416 || (ecryptfs_dentry->d_name.len == 2
417 && !strcmp(ecryptfs_dentry->d_name.name, ".."))) {
420 lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
421 mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
422 lower_dentry = lookup_one_len(ecryptfs_dentry->d_name.name,
424 ecryptfs_dentry->d_name.len);
425 mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
426 if (IS_ERR(lower_dentry)) {
427 rc = PTR_ERR(lower_dentry);
428 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
429 "[%d] on lower_dentry = [%s]\n", __func__, rc,
430 encrypted_and_encoded_name);
433 if (lower_dentry->d_inode)
435 mount_crypt_stat = &ecryptfs_superblock_to_private(
436 ecryptfs_dentry->d_sb)->mount_crypt_stat;
437 if (!(mount_crypt_stat
438 && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)))
441 rc = ecryptfs_encrypt_and_encode_filename(
442 &encrypted_and_encoded_name, &encrypted_and_encoded_name_size,
443 NULL, mount_crypt_stat, ecryptfs_dentry->d_name.name,
444 ecryptfs_dentry->d_name.len);
446 printk(KERN_ERR "%s: Error attempting to encrypt and encode "
447 "filename; rc = [%d]\n", __func__, rc);
450 mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
451 lower_dentry = lookup_one_len(encrypted_and_encoded_name,
453 encrypted_and_encoded_name_size);
454 mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
455 if (IS_ERR(lower_dentry)) {
456 rc = PTR_ERR(lower_dentry);
457 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
458 "[%d] on lower_dentry = [%s]\n", __func__, rc,
459 encrypted_and_encoded_name);
463 rc = ecryptfs_lookup_interpose(ecryptfs_dentry, lower_dentry,
467 d_drop(ecryptfs_dentry);
469 kfree(encrypted_and_encoded_name);
473 static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
474 struct dentry *new_dentry)
476 struct dentry *lower_old_dentry;
477 struct dentry *lower_new_dentry;
478 struct dentry *lower_dir_dentry;
482 file_size_save = i_size_read(old_dentry->d_inode);
483 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
484 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
485 dget(lower_old_dentry);
486 dget(lower_new_dentry);
487 lower_dir_dentry = lock_parent(lower_new_dentry);
488 rc = vfs_link(lower_old_dentry, lower_dir_dentry->d_inode,
490 if (rc || !lower_new_dentry->d_inode)
492 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb);
495 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
496 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
497 set_nlink(old_dentry->d_inode,
498 ecryptfs_inode_to_lower(old_dentry->d_inode)->i_nlink);
499 i_size_write(new_dentry->d_inode, file_size_save);
501 unlock_dir(lower_dir_dentry);
502 dput(lower_new_dentry);
503 dput(lower_old_dentry);
507 static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
509 return ecryptfs_do_unlink(dir, dentry, dentry->d_inode);
512 static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
516 struct dentry *lower_dentry;
517 struct dentry *lower_dir_dentry;
518 char *encoded_symname;
519 size_t encoded_symlen;
520 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
522 lower_dentry = ecryptfs_dentry_to_lower(dentry);
524 lower_dir_dentry = lock_parent(lower_dentry);
525 mount_crypt_stat = &ecryptfs_superblock_to_private(
526 dir->i_sb)->mount_crypt_stat;
527 rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
530 mount_crypt_stat, symname,
534 rc = vfs_symlink(lower_dir_dentry->d_inode, lower_dentry,
536 kfree(encoded_symname);
537 if (rc || !lower_dentry->d_inode)
539 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
542 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
543 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
545 unlock_dir(lower_dir_dentry);
547 if (!dentry->d_inode)
552 static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
555 struct dentry *lower_dentry;
556 struct dentry *lower_dir_dentry;
558 lower_dentry = ecryptfs_dentry_to_lower(dentry);
559 lower_dir_dentry = lock_parent(lower_dentry);
560 rc = vfs_mkdir(lower_dir_dentry->d_inode, lower_dentry, mode);
561 if (rc || !lower_dentry->d_inode)
563 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
566 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
567 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
568 set_nlink(dir, lower_dir_dentry->d_inode->i_nlink);
570 unlock_dir(lower_dir_dentry);
571 if (!dentry->d_inode)
576 static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
578 struct dentry *lower_dentry;
579 struct dentry *lower_dir_dentry;
582 lower_dentry = ecryptfs_dentry_to_lower(dentry);
584 lower_dir_dentry = lock_parent(lower_dentry);
586 rc = vfs_rmdir(lower_dir_dentry->d_inode, lower_dentry);
588 if (!rc && dentry->d_inode)
589 clear_nlink(dentry->d_inode);
590 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
591 set_nlink(dir, lower_dir_dentry->d_inode->i_nlink);
592 unlock_dir(lower_dir_dentry);
600 ecryptfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t dev)
603 struct dentry *lower_dentry;
604 struct dentry *lower_dir_dentry;
606 lower_dentry = ecryptfs_dentry_to_lower(dentry);
607 lower_dir_dentry = lock_parent(lower_dentry);
608 rc = vfs_mknod(lower_dir_dentry->d_inode, lower_dentry, mode, dev);
609 if (rc || !lower_dentry->d_inode)
611 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
614 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
615 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
617 unlock_dir(lower_dir_dentry);
618 if (!dentry->d_inode)
624 ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
625 struct inode *new_dir, struct dentry *new_dentry)
628 struct dentry *lower_old_dentry;
629 struct dentry *lower_new_dentry;
630 struct dentry *lower_old_dir_dentry;
631 struct dentry *lower_new_dir_dentry;
632 struct dentry *trap = NULL;
634 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
635 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
636 dget(lower_old_dentry);
637 dget(lower_new_dentry);
638 lower_old_dir_dentry = dget_parent(lower_old_dentry);
639 lower_new_dir_dentry = dget_parent(lower_new_dentry);
640 trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
641 /* source should not be ancestor of target */
642 if (trap == lower_old_dentry) {
646 /* target should not be ancestor of source */
647 if (trap == lower_new_dentry) {
651 rc = vfs_rename(lower_old_dir_dentry->d_inode, lower_old_dentry,
652 lower_new_dir_dentry->d_inode, lower_new_dentry);
655 fsstack_copy_attr_all(new_dir, lower_new_dir_dentry->d_inode);
656 if (new_dir != old_dir)
657 fsstack_copy_attr_all(old_dir, lower_old_dir_dentry->d_inode);
659 unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
660 dput(lower_new_dir_dentry);
661 dput(lower_old_dir_dentry);
662 dput(lower_new_dentry);
663 dput(lower_old_dentry);
667 static int ecryptfs_readlink_lower(struct dentry *dentry, char **buf,
670 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
675 lower_buf = kmalloc(PATH_MAX, GFP_KERNEL);
682 rc = lower_dentry->d_inode->i_op->readlink(lower_dentry,
683 (char __user *)lower_buf,
688 rc = ecryptfs_decode_and_decrypt_filename(buf, bufsiz, dentry,
695 static void *ecryptfs_follow_link(struct dentry *dentry, struct nameidata *nd)
698 size_t len = PATH_MAX;
701 rc = ecryptfs_readlink_lower(dentry, &buf, &len);
704 fsstack_copy_attr_atime(dentry->d_inode,
705 ecryptfs_dentry_to_lower(dentry)->d_inode);
708 nd_set_link(nd, buf);
713 ecryptfs_put_link(struct dentry *dentry, struct nameidata *nd, void *ptr)
715 char *buf = nd_get_link(nd);
723 * upper_size_to_lower_size
724 * @crypt_stat: Crypt_stat associated with file
725 * @upper_size: Size of the upper file
727 * Calculate the required size of the lower file based on the
728 * specified size of the upper file. This calculation is based on the
729 * number of headers in the underlying file and the extent size.
731 * Returns Calculated size of the lower file.
734 upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
739 lower_size = ecryptfs_lower_header_size(crypt_stat);
740 if (upper_size != 0) {
743 num_extents = upper_size >> crypt_stat->extent_shift;
744 if (upper_size & ~crypt_stat->extent_mask)
746 lower_size += (num_extents * crypt_stat->extent_size);
753 * @dentry: The ecryptfs layer dentry
754 * @ia: Address of the ecryptfs inode's attributes
755 * @lower_ia: Address of the lower inode's attributes
757 * Function to handle truncations modifying the size of the file. Note
758 * that the file sizes are interpolated. When expanding, we are simply
759 * writing strings of 0's out. When truncating, we truncate the upper
760 * inode and update the lower_ia according to the page index
761 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
762 * the caller must use lower_ia in a call to notify_change() to perform
763 * the truncation of the lower inode.
765 * Returns zero on success; non-zero otherwise
767 static int truncate_upper(struct dentry *dentry, struct iattr *ia,
768 struct iattr *lower_ia)
771 struct inode *inode = dentry->d_inode;
772 struct ecryptfs_crypt_stat *crypt_stat;
773 loff_t i_size = i_size_read(inode);
774 loff_t lower_size_before_truncate;
775 loff_t lower_size_after_truncate;
777 if (unlikely((ia->ia_size == i_size))) {
778 lower_ia->ia_valid &= ~ATTR_SIZE;
781 rc = ecryptfs_get_lower_file(dentry, inode);
784 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
785 /* Switch on growing or shrinking file */
786 if (ia->ia_size > i_size) {
787 char zero[] = { 0x00 };
789 lower_ia->ia_valid &= ~ATTR_SIZE;
790 /* Write a single 0 at the last position of the file;
791 * this triggers code that will fill in 0's throughout
792 * the intermediate portion of the previous end of the
793 * file and the new and of the file */
794 rc = ecryptfs_write(inode, zero,
795 (ia->ia_size - 1), 1);
796 } else { /* ia->ia_size < i_size_read(inode) */
797 /* We're chopping off all the pages down to the page
798 * in which ia->ia_size is located. Fill in the end of
799 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
800 * PAGE_CACHE_SIZE with zeros. */
801 size_t num_zeros = (PAGE_CACHE_SIZE
802 - (ia->ia_size & ~PAGE_CACHE_MASK));
804 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
805 truncate_setsize(inode, ia->ia_size);
806 lower_ia->ia_size = ia->ia_size;
807 lower_ia->ia_valid |= ATTR_SIZE;
813 zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
818 rc = ecryptfs_write(inode, zeros_virt,
819 ia->ia_size, num_zeros);
822 printk(KERN_ERR "Error attempting to zero out "
823 "the remainder of the end page on "
824 "reducing truncate; rc = [%d]\n", rc);
828 truncate_setsize(inode, ia->ia_size);
829 rc = ecryptfs_write_inode_size_to_metadata(inode);
831 printk(KERN_ERR "Problem with "
832 "ecryptfs_write_inode_size_to_metadata; "
836 /* We are reducing the size of the ecryptfs file, and need to
837 * know if we need to reduce the size of the lower file. */
838 lower_size_before_truncate =
839 upper_size_to_lower_size(crypt_stat, i_size);
840 lower_size_after_truncate =
841 upper_size_to_lower_size(crypt_stat, ia->ia_size);
842 if (lower_size_after_truncate < lower_size_before_truncate) {
843 lower_ia->ia_size = lower_size_after_truncate;
844 lower_ia->ia_valid |= ATTR_SIZE;
846 lower_ia->ia_valid &= ~ATTR_SIZE;
849 ecryptfs_put_lower_file(inode);
853 static int ecryptfs_inode_newsize_ok(struct inode *inode, loff_t offset)
855 struct ecryptfs_crypt_stat *crypt_stat;
856 loff_t lower_oldsize, lower_newsize;
858 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
859 lower_oldsize = upper_size_to_lower_size(crypt_stat,
861 lower_newsize = upper_size_to_lower_size(crypt_stat, offset);
862 if (lower_newsize > lower_oldsize) {
864 * The eCryptfs inode and the new *lower* size are mixed here
865 * because we may not have the lower i_mutex held and/or it may
866 * not be appropriate to call inode_newsize_ok() with inodes
867 * from other filesystems.
869 return inode_newsize_ok(inode, lower_newsize);
877 * @dentry: The ecryptfs layer dentry
878 * @new_length: The length to expand the file to
880 * Simple function that handles the truncation of an eCryptfs inode and
881 * its corresponding lower inode.
883 * Returns zero on success; non-zero otherwise
885 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
887 struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
888 struct iattr lower_ia = { .ia_valid = 0 };
891 rc = ecryptfs_inode_newsize_ok(dentry->d_inode, new_length);
895 rc = truncate_upper(dentry, &ia, &lower_ia);
896 if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
897 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
899 mutex_lock(&lower_dentry->d_inode->i_mutex);
900 rc = notify_change(lower_dentry, &lower_ia);
901 mutex_unlock(&lower_dentry->d_inode->i_mutex);
907 ecryptfs_permission(struct inode *inode, int mask)
909 return inode_permission(ecryptfs_inode_to_lower(inode), mask);
914 * @dentry: dentry handle to the inode to modify
915 * @ia: Structure with flags of what to change and values
917 * Updates the metadata of an inode. If the update is to the size
918 * i.e. truncation, then ecryptfs_truncate will handle the size modification
919 * of both the ecryptfs inode and the lower inode.
921 * All other metadata changes will be passed right to the lower filesystem,
922 * and we will just update our inode to look like the lower.
924 static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
927 struct dentry *lower_dentry;
928 struct iattr lower_ia;
930 struct inode *lower_inode;
931 struct ecryptfs_crypt_stat *crypt_stat;
933 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
934 if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED))
935 ecryptfs_init_crypt_stat(crypt_stat);
936 inode = dentry->d_inode;
937 lower_inode = ecryptfs_inode_to_lower(inode);
938 lower_dentry = ecryptfs_dentry_to_lower(dentry);
939 mutex_lock(&crypt_stat->cs_mutex);
940 if (S_ISDIR(dentry->d_inode->i_mode))
941 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
942 else if (S_ISREG(dentry->d_inode->i_mode)
943 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
944 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
945 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
947 mount_crypt_stat = &ecryptfs_superblock_to_private(
948 dentry->d_sb)->mount_crypt_stat;
949 rc = ecryptfs_get_lower_file(dentry, inode);
951 mutex_unlock(&crypt_stat->cs_mutex);
954 rc = ecryptfs_read_metadata(dentry);
955 ecryptfs_put_lower_file(inode);
957 if (!(mount_crypt_stat->flags
958 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
960 printk(KERN_WARNING "Either the lower file "
961 "is not in a valid eCryptfs format, "
962 "or the key could not be retrieved. "
963 "Plaintext passthrough mode is not "
964 "enabled; returning -EIO\n");
965 mutex_unlock(&crypt_stat->cs_mutex);
969 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
970 | ECRYPTFS_ENCRYPTED);
973 mutex_unlock(&crypt_stat->cs_mutex);
975 rc = inode_change_ok(inode, ia);
978 if (ia->ia_valid & ATTR_SIZE) {
979 rc = ecryptfs_inode_newsize_ok(inode, ia->ia_size);
984 memcpy(&lower_ia, ia, sizeof(lower_ia));
985 if (ia->ia_valid & ATTR_FILE)
986 lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
987 if (ia->ia_valid & ATTR_SIZE) {
988 rc = truncate_upper(dentry, ia, &lower_ia);
994 * mode change is for clearing setuid/setgid bits. Allow lower fs
995 * to interpret this in its own way.
997 if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
998 lower_ia.ia_valid &= ~ATTR_MODE;
1000 mutex_lock(&lower_dentry->d_inode->i_mutex);
1001 rc = notify_change(lower_dentry, &lower_ia);
1002 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1004 fsstack_copy_attr_all(inode, lower_inode);
1008 int ecryptfs_getattr_link(struct vfsmount *mnt, struct dentry *dentry,
1011 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
1014 mount_crypt_stat = &ecryptfs_superblock_to_private(
1015 dentry->d_sb)->mount_crypt_stat;
1016 generic_fillattr(dentry->d_inode, stat);
1017 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
1021 rc = ecryptfs_readlink_lower(dentry, &target, &targetsiz);
1024 stat->size = targetsiz;
1030 int ecryptfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
1033 struct kstat lower_stat;
1036 rc = vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry),
1037 ecryptfs_dentry_to_lower(dentry), &lower_stat);
1039 fsstack_copy_attr_all(dentry->d_inode,
1040 ecryptfs_inode_to_lower(dentry->d_inode));
1041 generic_fillattr(dentry->d_inode, stat);
1042 stat->blocks = lower_stat.blocks;
1048 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
1049 size_t size, int flags)
1052 struct dentry *lower_dentry;
1054 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1055 if (!lower_dentry->d_inode->i_op->setxattr) {
1060 rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1062 fsstack_copy_attr_all(dentry->d_inode, lower_dentry->d_inode);
1068 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
1069 void *value, size_t size)
1073 if (!lower_dentry->d_inode->i_op->getxattr) {
1077 mutex_lock(&lower_dentry->d_inode->i_mutex);
1078 rc = lower_dentry->d_inode->i_op->getxattr(lower_dentry, name, value,
1080 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1086 ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
1089 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry), name,
1094 ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1097 struct dentry *lower_dentry;
1099 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1100 if (!lower_dentry->d_inode->i_op->listxattr) {
1104 mutex_lock(&lower_dentry->d_inode->i_mutex);
1105 rc = lower_dentry->d_inode->i_op->listxattr(lower_dentry, list, size);
1106 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1111 static int ecryptfs_removexattr(struct dentry *dentry, const char *name)
1114 struct dentry *lower_dentry;
1116 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1117 if (!lower_dentry->d_inode->i_op->removexattr) {
1121 mutex_lock(&lower_dentry->d_inode->i_mutex);
1122 rc = lower_dentry->d_inode->i_op->removexattr(lower_dentry, name);
1123 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1128 const struct inode_operations ecryptfs_symlink_iops = {
1129 .readlink = generic_readlink,
1130 .follow_link = ecryptfs_follow_link,
1131 .put_link = ecryptfs_put_link,
1132 .permission = ecryptfs_permission,
1133 .setattr = ecryptfs_setattr,
1134 .getattr = ecryptfs_getattr_link,
1135 .setxattr = ecryptfs_setxattr,
1136 .getxattr = ecryptfs_getxattr,
1137 .listxattr = ecryptfs_listxattr,
1138 .removexattr = ecryptfs_removexattr
1141 const struct inode_operations ecryptfs_dir_iops = {
1142 .create = ecryptfs_create,
1143 .lookup = ecryptfs_lookup,
1144 .link = ecryptfs_link,
1145 .unlink = ecryptfs_unlink,
1146 .symlink = ecryptfs_symlink,
1147 .mkdir = ecryptfs_mkdir,
1148 .rmdir = ecryptfs_rmdir,
1149 .mknod = ecryptfs_mknod,
1150 .rename = ecryptfs_rename,
1151 .permission = ecryptfs_permission,
1152 .setattr = ecryptfs_setattr,
1153 .setxattr = ecryptfs_setxattr,
1154 .getxattr = ecryptfs_getxattr,
1155 .listxattr = ecryptfs_listxattr,
1156 .removexattr = ecryptfs_removexattr
1159 const struct inode_operations ecryptfs_main_iops = {
1160 .permission = ecryptfs_permission,
1161 .setattr = ecryptfs_setattr,
1162 .getattr = ecryptfs_getattr,
1163 .setxattr = ecryptfs_setxattr,
1164 .getxattr = ecryptfs_getxattr,
1165 .listxattr = ecryptfs_listxattr,
1166 .removexattr = ecryptfs_removexattr