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);
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
61 * Creates the file in the lower file system.
63 * Returns zero on success; non-zero on error condition
66 ecryptfs_create_underlying_file(struct inode *lower_dir_inode,
67 struct dentry *dentry, int mode,
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;
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;
85 rc = vfs_create(lower_dir_inode, lower_dentry, mode, nd);
87 nd->path.dentry = dentry_save;
88 nd->path.mnt = vfsmount_save;
89 nd->flags = flags_save;
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
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.
105 * Returns zero on success; non-zero on error condition
108 ecryptfs_do_create(struct inode *directory_inode,
109 struct dentry *ecryptfs_dentry, int mode,
110 struct nameidata *nd)
113 struct dentry *lower_dentry;
114 struct dentry *lower_dir_dentry;
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 "
121 rc = PTR_ERR(lower_dir_dentry);
124 rc = ecryptfs_create_underlying_file(lower_dir_dentry->d_inode,
125 ecryptfs_dentry, mode, nd);
127 printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
128 "rc = [%d]\n", __func__, rc);
131 rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry,
132 directory_inode->i_sb, 0);
134 ecryptfs_printk(KERN_ERR, "Failure in ecryptfs_interpose\n");
137 fsstack_copy_attr_times(directory_inode, lower_dir_dentry->d_inode);
138 fsstack_copy_inode_size(directory_inode, lower_dir_dentry->d_inode);
140 unlock_dir(lower_dir_dentry);
147 * @ecryptfs_dentry: the eCryptfs dentry
149 * This is the code which will grow the file to its correct size.
151 static int grow_file(struct dentry *ecryptfs_dentry)
153 struct inode *ecryptfs_inode = ecryptfs_dentry->d_inode;
154 char zero_virt[] = { 0x00 };
157 rc = ecryptfs_write(ecryptfs_inode, zero_virt, 0, 1);
158 i_size_write(ecryptfs_inode, 0);
159 rc = ecryptfs_write_inode_size_to_metadata(ecryptfs_inode);
160 ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat.flags |=
166 * ecryptfs_initialize_file
168 * Cause the file to be changed from a basic empty file to an ecryptfs
169 * file with a header and first data page.
171 * Returns zero on success
173 static int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry)
175 struct ecryptfs_crypt_stat *crypt_stat =
176 &ecryptfs_inode_to_private(ecryptfs_dentry->d_inode)->crypt_stat;
179 if (S_ISDIR(ecryptfs_dentry->d_inode->i_mode)) {
180 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
181 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
184 crypt_stat->flags |= ECRYPTFS_NEW_FILE;
185 ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
186 rc = ecryptfs_new_file_context(ecryptfs_dentry);
188 ecryptfs_printk(KERN_ERR, "Error creating new file "
189 "context; rc = [%d]\n", rc);
192 rc = ecryptfs_init_persistent_file(ecryptfs_dentry);
194 printk(KERN_ERR "%s: Error attempting to initialize "
195 "the persistent file for the dentry with name "
196 "[%s]; rc = [%d]\n", __func__,
197 ecryptfs_dentry->d_name.name, rc);
200 rc = ecryptfs_write_metadata(ecryptfs_dentry);
202 printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
205 rc = grow_file(ecryptfs_dentry);
207 printk(KERN_ERR "Error growing file; rc = [%d]\n", rc);
214 * @dir: The inode of the directory in which to create the file.
215 * @dentry: The eCryptfs dentry
216 * @mode: The mode of the new file.
219 * Creates a new file.
221 * Returns zero on success; non-zero on error condition
224 ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
225 int mode, struct nameidata *nd)
229 /* ecryptfs_do_create() calls ecryptfs_interpose() */
230 rc = ecryptfs_do_create(directory_inode, ecryptfs_dentry, mode, nd);
232 ecryptfs_printk(KERN_WARNING, "Failed to create file in"
233 "lower filesystem\n");
236 /* At this point, a file exists on "disk"; we need to make sure
237 * that this on disk file is prepared to be an ecryptfs file */
238 rc = ecryptfs_initialize_file(ecryptfs_dentry);
244 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
246 int ecryptfs_lookup_and_interpose_lower(struct dentry *ecryptfs_dentry,
247 struct dentry *lower_dentry,
248 struct inode *ecryptfs_dir_inode)
250 struct dentry *lower_dir_dentry;
251 struct vfsmount *lower_mnt;
252 struct inode *lower_inode;
253 struct ecryptfs_crypt_stat *crypt_stat;
254 char *page_virt = NULL;
257 lower_dir_dentry = lower_dentry->d_parent;
258 lower_mnt = mntget(ecryptfs_dentry_to_lower_mnt(
259 ecryptfs_dentry->d_parent));
260 lower_inode = lower_dentry->d_inode;
261 fsstack_copy_attr_atime(ecryptfs_dir_inode, lower_dir_dentry->d_inode);
262 BUG_ON(!lower_dentry->d_count);
263 ecryptfs_set_dentry_private(ecryptfs_dentry,
264 kmem_cache_alloc(ecryptfs_dentry_info_cache,
266 if (!ecryptfs_dentry_to_private(ecryptfs_dentry)) {
268 printk(KERN_ERR "%s: Out of memory whilst attempting "
269 "to allocate ecryptfs_dentry_info struct\n",
273 ecryptfs_set_dentry_lower(ecryptfs_dentry, lower_dentry);
274 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry, lower_mnt);
275 if (!lower_dentry->d_inode) {
276 /* We want to add because we couldn't find in lower */
277 d_add(ecryptfs_dentry, NULL);
280 rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry,
281 ecryptfs_dir_inode->i_sb,
282 ECRYPTFS_INTERPOSE_FLAG_D_ADD);
284 printk(KERN_ERR "%s: Error interposing; rc = [%d]\n",
288 if (S_ISDIR(lower_inode->i_mode))
290 if (S_ISLNK(lower_inode->i_mode))
292 if (special_file(lower_inode->i_mode))
294 /* Released in this function */
295 page_virt = kmem_cache_zalloc(ecryptfs_header_cache_2, GFP_USER);
297 printk(KERN_ERR "%s: Cannot kmem_cache_zalloc() a page\n",
302 rc = ecryptfs_init_persistent_file(ecryptfs_dentry);
304 printk(KERN_ERR "%s: Error attempting to initialize "
305 "the persistent file for the dentry with name "
306 "[%s]; rc = [%d]\n", __func__,
307 ecryptfs_dentry->d_name.name, rc);
310 crypt_stat = &ecryptfs_inode_to_private(
311 ecryptfs_dentry->d_inode)->crypt_stat;
312 /* TODO: lock for crypt_stat comparison */
313 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
314 ecryptfs_set_default_sizes(crypt_stat);
315 rc = ecryptfs_read_and_validate_header_region(page_virt,
316 ecryptfs_dentry->d_inode);
318 memset(page_virt, 0, PAGE_CACHE_SIZE);
319 rc = ecryptfs_read_and_validate_xattr_region(page_virt,
325 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
327 ecryptfs_i_size_init(page_virt, ecryptfs_dentry->d_inode);
329 kmem_cache_free(ecryptfs_header_cache_2, page_virt);
334 d_drop(ecryptfs_dentry);
341 * @ecryptfs_dir_inode: The eCryptfs directory inode
342 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
343 * @ecryptfs_nd: nameidata; may be NULL
345 * Find a file on disk. If the file does not exist, then we'll add it to the
346 * dentry cache and continue on to read it from the disk.
348 static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
349 struct dentry *ecryptfs_dentry,
350 struct nameidata *ecryptfs_nd)
352 char *encrypted_and_encoded_name = NULL;
353 size_t encrypted_and_encoded_name_size;
354 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
355 struct dentry *lower_dir_dentry, *lower_dentry;
358 if ((ecryptfs_dentry->d_name.len == 1
359 && !strcmp(ecryptfs_dentry->d_name.name, "."))
360 || (ecryptfs_dentry->d_name.len == 2
361 && !strcmp(ecryptfs_dentry->d_name.name, ".."))) {
364 lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
365 mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
366 lower_dentry = lookup_one_len(ecryptfs_dentry->d_name.name,
368 ecryptfs_dentry->d_name.len);
369 mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
370 if (IS_ERR(lower_dentry)) {
371 rc = PTR_ERR(lower_dentry);
372 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
373 "[%d] on lower_dentry = [%s]\n", __func__, rc,
374 encrypted_and_encoded_name);
377 if (lower_dentry->d_inode)
378 goto lookup_and_interpose;
379 mount_crypt_stat = &ecryptfs_superblock_to_private(
380 ecryptfs_dentry->d_sb)->mount_crypt_stat;
381 if (!(mount_crypt_stat
382 && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)))
383 goto lookup_and_interpose;
385 rc = ecryptfs_encrypt_and_encode_filename(
386 &encrypted_and_encoded_name, &encrypted_and_encoded_name_size,
387 NULL, mount_crypt_stat, ecryptfs_dentry->d_name.name,
388 ecryptfs_dentry->d_name.len);
390 printk(KERN_ERR "%s: Error attempting to encrypt and encode "
391 "filename; rc = [%d]\n", __func__, rc);
394 mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
395 lower_dentry = lookup_one_len(encrypted_and_encoded_name,
397 encrypted_and_encoded_name_size);
398 mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
399 if (IS_ERR(lower_dentry)) {
400 rc = PTR_ERR(lower_dentry);
401 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
402 "[%d] on lower_dentry = [%s]\n", __func__, rc,
403 encrypted_and_encoded_name);
406 lookup_and_interpose:
407 rc = ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry, lower_dentry,
411 d_drop(ecryptfs_dentry);
413 kfree(encrypted_and_encoded_name);
417 static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
418 struct dentry *new_dentry)
420 struct dentry *lower_old_dentry;
421 struct dentry *lower_new_dentry;
422 struct dentry *lower_dir_dentry;
426 file_size_save = i_size_read(old_dentry->d_inode);
427 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
428 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
429 dget(lower_old_dentry);
430 dget(lower_new_dentry);
431 lower_dir_dentry = lock_parent(lower_new_dentry);
432 rc = vfs_link(lower_old_dentry, lower_dir_dentry->d_inode,
434 if (rc || !lower_new_dentry->d_inode)
436 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb, 0);
439 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
440 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
441 old_dentry->d_inode->i_nlink =
442 ecryptfs_inode_to_lower(old_dentry->d_inode)->i_nlink;
443 i_size_write(new_dentry->d_inode, file_size_save);
445 unlock_dir(lower_dir_dentry);
446 dput(lower_new_dentry);
447 dput(lower_old_dentry);
451 static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
454 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
455 struct inode *lower_dir_inode = ecryptfs_inode_to_lower(dir);
456 struct dentry *lower_dir_dentry;
459 lower_dir_dentry = lock_parent(lower_dentry);
460 rc = vfs_unlink(lower_dir_inode, lower_dentry);
462 printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
465 fsstack_copy_attr_times(dir, lower_dir_inode);
466 dentry->d_inode->i_nlink =
467 ecryptfs_inode_to_lower(dentry->d_inode)->i_nlink;
468 dentry->d_inode->i_ctime = dir->i_ctime;
471 unlock_dir(lower_dir_dentry);
476 static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
480 struct dentry *lower_dentry;
481 struct dentry *lower_dir_dentry;
482 char *encoded_symname;
483 size_t encoded_symlen;
484 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
486 lower_dentry = ecryptfs_dentry_to_lower(dentry);
488 lower_dir_dentry = lock_parent(lower_dentry);
489 mount_crypt_stat = &ecryptfs_superblock_to_private(
490 dir->i_sb)->mount_crypt_stat;
491 rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
494 mount_crypt_stat, symname,
498 rc = vfs_symlink(lower_dir_dentry->d_inode, lower_dentry,
500 kfree(encoded_symname);
501 if (rc || !lower_dentry->d_inode)
503 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
506 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
507 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
509 unlock_dir(lower_dir_dentry);
511 if (!dentry->d_inode)
516 static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
519 struct dentry *lower_dentry;
520 struct dentry *lower_dir_dentry;
522 lower_dentry = ecryptfs_dentry_to_lower(dentry);
523 lower_dir_dentry = lock_parent(lower_dentry);
524 rc = vfs_mkdir(lower_dir_dentry->d_inode, lower_dentry, mode);
525 if (rc || !lower_dentry->d_inode)
527 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
530 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
531 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
532 dir->i_nlink = lower_dir_dentry->d_inode->i_nlink;
534 unlock_dir(lower_dir_dentry);
535 if (!dentry->d_inode)
540 static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
542 struct dentry *lower_dentry;
543 struct dentry *lower_dir_dentry;
546 lower_dentry = ecryptfs_dentry_to_lower(dentry);
548 lower_dir_dentry = lock_parent(lower_dentry);
550 rc = vfs_rmdir(lower_dir_dentry->d_inode, lower_dentry);
553 d_delete(lower_dentry);
554 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
555 dir->i_nlink = lower_dir_dentry->d_inode->i_nlink;
556 unlock_dir(lower_dir_dentry);
564 ecryptfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t dev)
567 struct dentry *lower_dentry;
568 struct dentry *lower_dir_dentry;
570 lower_dentry = ecryptfs_dentry_to_lower(dentry);
571 lower_dir_dentry = lock_parent(lower_dentry);
572 rc = vfs_mknod(lower_dir_dentry->d_inode, lower_dentry, mode, dev);
573 if (rc || !lower_dentry->d_inode)
575 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
578 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
579 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
581 unlock_dir(lower_dir_dentry);
582 if (!dentry->d_inode)
588 ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
589 struct inode *new_dir, struct dentry *new_dentry)
592 struct dentry *lower_old_dentry;
593 struct dentry *lower_new_dentry;
594 struct dentry *lower_old_dir_dentry;
595 struct dentry *lower_new_dir_dentry;
596 struct dentry *trap = NULL;
598 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
599 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
600 dget(lower_old_dentry);
601 dget(lower_new_dentry);
602 lower_old_dir_dentry = dget_parent(lower_old_dentry);
603 lower_new_dir_dentry = dget_parent(lower_new_dentry);
604 trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
605 /* source should not be ancestor of target */
606 if (trap == lower_old_dentry) {
610 /* target should not be ancestor of source */
611 if (trap == lower_new_dentry) {
615 rc = vfs_rename(lower_old_dir_dentry->d_inode, lower_old_dentry,
616 lower_new_dir_dentry->d_inode, lower_new_dentry);
619 fsstack_copy_attr_all(new_dir, lower_new_dir_dentry->d_inode);
620 if (new_dir != old_dir)
621 fsstack_copy_attr_all(old_dir, lower_old_dir_dentry->d_inode);
623 unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
624 dput(lower_new_dentry->d_parent);
625 dput(lower_old_dentry->d_parent);
626 dput(lower_new_dentry);
627 dput(lower_old_dentry);
631 static int ecryptfs_readlink_lower(struct dentry *dentry, char **buf,
634 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
636 size_t lower_bufsiz = PATH_MAX;
640 lower_buf = kmalloc(lower_bufsiz, GFP_KERNEL);
647 rc = lower_dentry->d_inode->i_op->readlink(lower_dentry,
648 (char __user *)lower_buf,
654 rc = ecryptfs_decode_and_decrypt_filename(buf, bufsiz, dentry,
655 lower_buf, lower_bufsiz);
662 ecryptfs_readlink(struct dentry *dentry, char __user *buf, int bufsiz)
665 size_t kbufsiz, copied;
668 rc = ecryptfs_readlink_lower(dentry, &kbuf, &kbufsiz);
671 copied = min_t(size_t, bufsiz, kbufsiz);
672 rc = copy_to_user(buf, kbuf, copied) ? -EFAULT : copied;
674 fsstack_copy_attr_atime(dentry->d_inode,
675 ecryptfs_dentry_to_lower(dentry)->d_inode);
680 static void *ecryptfs_follow_link(struct dentry *dentry, struct nameidata *nd)
683 int len = PAGE_SIZE, rc;
686 /* Released in ecryptfs_put_link(); only release here on error */
687 buf = kmalloc(len, GFP_KERNEL);
689 buf = ERR_PTR(-ENOMEM);
694 rc = dentry->d_inode->i_op->readlink(dentry, (char __user *)buf, len);
702 nd_set_link(nd, buf);
707 ecryptfs_put_link(struct dentry *dentry, struct nameidata *nd, void *ptr)
709 char *buf = nd_get_link(nd);
717 * upper_size_to_lower_size
718 * @crypt_stat: Crypt_stat associated with file
719 * @upper_size: Size of the upper file
721 * Calculate the required size of the lower file based on the
722 * specified size of the upper file. This calculation is based on the
723 * number of headers in the underlying file and the extent size.
725 * Returns Calculated size of the lower file.
728 upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
733 lower_size = ecryptfs_lower_header_size(crypt_stat);
734 if (upper_size != 0) {
737 num_extents = upper_size >> crypt_stat->extent_shift;
738 if (upper_size & ~crypt_stat->extent_mask)
740 lower_size += (num_extents * crypt_stat->extent_size);
747 * @dentry: The ecryptfs layer dentry
748 * @ia: Address of the ecryptfs inode's attributes
749 * @lower_ia: Address of the lower inode's attributes
751 * Function to handle truncations modifying the size of the file. Note
752 * that the file sizes are interpolated. When expanding, we are simply
753 * writing strings of 0's out. When truncating, we truncate the upper
754 * inode and update the lower_ia according to the page index
755 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
756 * the caller must use lower_ia in a call to notify_change() to perform
757 * the truncation of the lower inode.
759 * Returns zero on success; non-zero otherwise
761 static int truncate_upper(struct dentry *dentry, struct iattr *ia,
762 struct iattr *lower_ia)
765 struct inode *inode = dentry->d_inode;
766 struct ecryptfs_crypt_stat *crypt_stat;
767 loff_t i_size = i_size_read(inode);
768 loff_t lower_size_before_truncate;
769 loff_t lower_size_after_truncate;
771 if (unlikely((ia->ia_size == i_size))) {
772 lower_ia->ia_valid &= ~ATTR_SIZE;
775 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
776 /* Switch on growing or shrinking file */
777 if (ia->ia_size > i_size) {
778 char zero[] = { 0x00 };
780 lower_ia->ia_valid &= ~ATTR_SIZE;
781 /* Write a single 0 at the last position of the file;
782 * this triggers code that will fill in 0's throughout
783 * the intermediate portion of the previous end of the
784 * file and the new and of the file */
785 rc = ecryptfs_write(inode, zero,
786 (ia->ia_size - 1), 1);
787 } else { /* ia->ia_size < i_size_read(inode) */
788 /* We're chopping off all the pages down to the page
789 * in which ia->ia_size is located. Fill in the end of
790 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
791 * PAGE_CACHE_SIZE with zeros. */
792 size_t num_zeros = (PAGE_CACHE_SIZE
793 - (ia->ia_size & ~PAGE_CACHE_MASK));
797 * XXX(truncate) this should really happen at the begginning
798 * of ->setattr. But the code is too messy to that as part
799 * of a larger patch. ecryptfs is also totally missing out
800 * on the inode_change_ok check at the beginning of
801 * ->setattr while would include this.
803 rc = inode_newsize_ok(inode, ia->ia_size);
807 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
808 truncate_setsize(inode, ia->ia_size);
809 lower_ia->ia_size = ia->ia_size;
810 lower_ia->ia_valid |= ATTR_SIZE;
816 zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
821 rc = ecryptfs_write(inode, zeros_virt,
822 ia->ia_size, num_zeros);
825 printk(KERN_ERR "Error attempting to zero out "
826 "the remainder of the end page on "
827 "reducing truncate; rc = [%d]\n", rc);
831 truncate_setsize(inode, ia->ia_size);
832 rc = ecryptfs_write_inode_size_to_metadata(inode);
834 printk(KERN_ERR "Problem with "
835 "ecryptfs_write_inode_size_to_metadata; "
839 /* We are reducing the size of the ecryptfs file, and need to
840 * know if we need to reduce the size of the lower file. */
841 lower_size_before_truncate =
842 upper_size_to_lower_size(crypt_stat, i_size);
843 lower_size_after_truncate =
844 upper_size_to_lower_size(crypt_stat, ia->ia_size);
845 if (lower_size_after_truncate < lower_size_before_truncate) {
846 lower_ia->ia_size = lower_size_after_truncate;
847 lower_ia->ia_valid |= ATTR_SIZE;
849 lower_ia->ia_valid &= ~ATTR_SIZE;
857 * @dentry: The ecryptfs layer dentry
858 * @new_length: The length to expand the file to
860 * Simple function that handles the truncation of an eCryptfs inode and
861 * its corresponding lower inode.
863 * Returns zero on success; non-zero otherwise
865 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
867 struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
868 struct iattr lower_ia = { .ia_valid = 0 };
871 rc = truncate_upper(dentry, &ia, &lower_ia);
872 if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
873 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
875 mutex_lock(&lower_dentry->d_inode->i_mutex);
876 rc = notify_change(lower_dentry, &lower_ia);
877 mutex_unlock(&lower_dentry->d_inode->i_mutex);
883 ecryptfs_permission(struct inode *inode, int mask, unsigned int flags)
885 if (flags & IPERM_FLAG_RCU)
887 return inode_permission(ecryptfs_inode_to_lower(inode), mask);
892 * @dentry: dentry handle to the inode to modify
893 * @ia: Structure with flags of what to change and values
895 * Updates the metadata of an inode. If the update is to the size
896 * i.e. truncation, then ecryptfs_truncate will handle the size modification
897 * of both the ecryptfs inode and the lower inode.
899 * All other metadata changes will be passed right to the lower filesystem,
900 * and we will just update our inode to look like the lower.
902 static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
905 struct dentry *lower_dentry;
906 struct iattr lower_ia;
908 struct inode *lower_inode;
909 struct ecryptfs_crypt_stat *crypt_stat;
911 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
912 if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED))
913 ecryptfs_init_crypt_stat(crypt_stat);
914 inode = dentry->d_inode;
915 lower_inode = ecryptfs_inode_to_lower(inode);
916 lower_dentry = ecryptfs_dentry_to_lower(dentry);
917 mutex_lock(&crypt_stat->cs_mutex);
918 if (S_ISDIR(dentry->d_inode->i_mode))
919 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
920 else if (S_ISREG(dentry->d_inode->i_mode)
921 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
922 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
923 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
925 mount_crypt_stat = &ecryptfs_superblock_to_private(
926 dentry->d_sb)->mount_crypt_stat;
927 rc = ecryptfs_read_metadata(dentry);
929 if (!(mount_crypt_stat->flags
930 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
932 printk(KERN_WARNING "Either the lower file "
933 "is not in a valid eCryptfs format, "
934 "or the key could not be retrieved. "
935 "Plaintext passthrough mode is not "
936 "enabled; returning -EIO\n");
937 mutex_unlock(&crypt_stat->cs_mutex);
941 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
942 | ECRYPTFS_ENCRYPTED);
945 mutex_unlock(&crypt_stat->cs_mutex);
946 memcpy(&lower_ia, ia, sizeof(lower_ia));
947 if (ia->ia_valid & ATTR_FILE)
948 lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
949 if (ia->ia_valid & ATTR_SIZE) {
950 rc = truncate_upper(dentry, ia, &lower_ia);
956 * mode change is for clearing setuid/setgid bits. Allow lower fs
957 * to interpret this in its own way.
959 if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
960 lower_ia.ia_valid &= ~ATTR_MODE;
962 mutex_lock(&lower_dentry->d_inode->i_mutex);
963 rc = notify_change(lower_dentry, &lower_ia);
964 mutex_unlock(&lower_dentry->d_inode->i_mutex);
966 fsstack_copy_attr_all(inode, lower_inode);
970 int ecryptfs_getattr_link(struct vfsmount *mnt, struct dentry *dentry,
973 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
976 mount_crypt_stat = &ecryptfs_superblock_to_private(
977 dentry->d_sb)->mount_crypt_stat;
978 generic_fillattr(dentry->d_inode, stat);
979 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
983 rc = ecryptfs_readlink_lower(dentry, &target, &targetsiz);
986 stat->size = targetsiz;
992 int ecryptfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
995 struct kstat lower_stat;
998 rc = vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry),
999 ecryptfs_dentry_to_lower(dentry), &lower_stat);
1001 fsstack_copy_attr_all(dentry->d_inode,
1002 ecryptfs_inode_to_lower(dentry->d_inode));
1003 generic_fillattr(dentry->d_inode, stat);
1004 stat->blocks = lower_stat.blocks;
1010 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
1011 size_t size, int flags)
1014 struct dentry *lower_dentry;
1016 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1017 if (!lower_dentry->d_inode->i_op->setxattr) {
1022 rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1028 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
1029 void *value, size_t size)
1033 if (!lower_dentry->d_inode->i_op->getxattr) {
1037 mutex_lock(&lower_dentry->d_inode->i_mutex);
1038 rc = lower_dentry->d_inode->i_op->getxattr(lower_dentry, name, value,
1040 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1046 ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
1049 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry), name,
1054 ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1057 struct dentry *lower_dentry;
1059 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1060 if (!lower_dentry->d_inode->i_op->listxattr) {
1064 mutex_lock(&lower_dentry->d_inode->i_mutex);
1065 rc = lower_dentry->d_inode->i_op->listxattr(lower_dentry, list, size);
1066 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1071 static int ecryptfs_removexattr(struct dentry *dentry, const char *name)
1074 struct dentry *lower_dentry;
1076 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1077 if (!lower_dentry->d_inode->i_op->removexattr) {
1081 mutex_lock(&lower_dentry->d_inode->i_mutex);
1082 rc = lower_dentry->d_inode->i_op->removexattr(lower_dentry, name);
1083 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1088 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode)
1090 if ((ecryptfs_inode_to_lower(inode)
1091 == (struct inode *)candidate_lower_inode))
1097 int ecryptfs_inode_set(struct inode *inode, void *lower_inode)
1099 ecryptfs_init_inode(inode, (struct inode *)lower_inode);
1103 const struct inode_operations ecryptfs_symlink_iops = {
1104 .readlink = ecryptfs_readlink,
1105 .follow_link = ecryptfs_follow_link,
1106 .put_link = ecryptfs_put_link,
1107 .permission = ecryptfs_permission,
1108 .setattr = ecryptfs_setattr,
1109 .getattr = ecryptfs_getattr_link,
1110 .setxattr = ecryptfs_setxattr,
1111 .getxattr = ecryptfs_getxattr,
1112 .listxattr = ecryptfs_listxattr,
1113 .removexattr = ecryptfs_removexattr
1116 const struct inode_operations ecryptfs_dir_iops = {
1117 .create = ecryptfs_create,
1118 .lookup = ecryptfs_lookup,
1119 .link = ecryptfs_link,
1120 .unlink = ecryptfs_unlink,
1121 .symlink = ecryptfs_symlink,
1122 .mkdir = ecryptfs_mkdir,
1123 .rmdir = ecryptfs_rmdir,
1124 .mknod = ecryptfs_mknod,
1125 .rename = ecryptfs_rename,
1126 .permission = ecryptfs_permission,
1127 .setattr = ecryptfs_setattr,
1128 .setxattr = ecryptfs_setxattr,
1129 .getxattr = ecryptfs_getxattr,
1130 .listxattr = ecryptfs_listxattr,
1131 .removexattr = ecryptfs_removexattr
1134 const struct inode_operations ecryptfs_main_iops = {
1135 .permission = ecryptfs_permission,
1136 .setattr = ecryptfs_setattr,
1137 .getattr = ecryptfs_getattr,
1138 .setxattr = ecryptfs_setxattr,
1139 .getxattr = ecryptfs_getxattr,
1140 .listxattr = ecryptfs_listxattr,
1141 .removexattr = ecryptfs_removexattr