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;
76 dentry_save = nd->path.dentry;
77 vfsmount_save = nd->path.mnt;
78 nd->path.dentry = lower_dentry;
79 nd->path.mnt = lower_mnt;
80 rc = vfs_create(lower_dir_inode, lower_dentry, mode, nd);
81 nd->path.dentry = dentry_save;
82 nd->path.mnt = vfsmount_save;
88 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
89 * @ecryptfs_dentry: New file's dentry in ecryptfs
90 * @mode: The mode of the new file
91 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
93 * Creates the underlying file and the eCryptfs inode which will link to
94 * it. It will also update the eCryptfs directory inode to mimic the
95 * stat of the lower directory inode.
97 * Returns zero on success; non-zero on error condition
100 ecryptfs_do_create(struct inode *directory_inode,
101 struct dentry *ecryptfs_dentry, int mode,
102 struct nameidata *nd)
105 struct dentry *lower_dentry;
106 struct dentry *lower_dir_dentry;
108 lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
109 lower_dir_dentry = lock_parent(lower_dentry);
110 if (IS_ERR(lower_dir_dentry)) {
111 ecryptfs_printk(KERN_ERR, "Error locking directory of "
113 rc = PTR_ERR(lower_dir_dentry);
116 rc = ecryptfs_create_underlying_file(lower_dir_dentry->d_inode,
117 ecryptfs_dentry, mode, nd);
119 printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
120 "rc = [%d]\n", __func__, rc);
123 rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry,
124 directory_inode->i_sb, 0);
126 ecryptfs_printk(KERN_ERR, "Failure in ecryptfs_interpose\n");
129 fsstack_copy_attr_times(directory_inode, lower_dir_dentry->d_inode);
130 fsstack_copy_inode_size(directory_inode, lower_dir_dentry->d_inode);
132 unlock_dir(lower_dir_dentry);
139 * @ecryptfs_dentry: the eCryptfs dentry
141 * This is the code which will grow the file to its correct size.
143 static int grow_file(struct dentry *ecryptfs_dentry)
145 struct inode *ecryptfs_inode = ecryptfs_dentry->d_inode;
146 char zero_virt[] = { 0x00 };
149 rc = ecryptfs_write(ecryptfs_inode, zero_virt, 0, 1);
150 i_size_write(ecryptfs_inode, 0);
151 rc = ecryptfs_write_inode_size_to_metadata(ecryptfs_inode);
152 ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat.flags |=
158 * ecryptfs_initialize_file
160 * Cause the file to be changed from a basic empty file to an ecryptfs
161 * file with a header and first data page.
163 * Returns zero on success
165 static int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry)
167 struct ecryptfs_crypt_stat *crypt_stat =
168 &ecryptfs_inode_to_private(ecryptfs_dentry->d_inode)->crypt_stat;
171 if (S_ISDIR(ecryptfs_dentry->d_inode->i_mode)) {
172 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
173 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
176 crypt_stat->flags |= ECRYPTFS_NEW_FILE;
177 ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
178 rc = ecryptfs_new_file_context(ecryptfs_dentry);
180 ecryptfs_printk(KERN_ERR, "Error creating new file "
181 "context; rc = [%d]\n", rc);
184 if (!ecryptfs_inode_to_private(ecryptfs_dentry->d_inode)->lower_file) {
185 rc = ecryptfs_init_persistent_file(ecryptfs_dentry);
187 printk(KERN_ERR "%s: Error attempting to initialize "
188 "the persistent file for the dentry with name "
189 "[%s]; rc = [%d]\n", __func__,
190 ecryptfs_dentry->d_name.name, rc);
194 rc = ecryptfs_write_metadata(ecryptfs_dentry);
196 printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
199 rc = grow_file(ecryptfs_dentry);
201 printk(KERN_ERR "Error growing file; rc = [%d]\n", rc);
208 * @dir: The inode of the directory in which to create the file.
209 * @dentry: The eCryptfs dentry
210 * @mode: The mode of the new file.
213 * Creates a new file.
215 * Returns zero on success; non-zero on error condition
218 ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
219 int mode, struct nameidata *nd)
223 /* ecryptfs_do_create() calls ecryptfs_interpose() */
224 rc = ecryptfs_do_create(directory_inode, ecryptfs_dentry, mode, nd);
226 ecryptfs_printk(KERN_WARNING, "Failed to create file in"
227 "lower filesystem\n");
230 /* At this point, a file exists on "disk"; we need to make sure
231 * that this on disk file is prepared to be an ecryptfs file */
232 rc = ecryptfs_initialize_file(ecryptfs_dentry);
238 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
240 int ecryptfs_lookup_and_interpose_lower(struct dentry *ecryptfs_dentry,
241 struct dentry *lower_dentry,
242 struct inode *ecryptfs_dir_inode,
243 struct nameidata *ecryptfs_nd)
245 struct dentry *lower_dir_dentry;
246 struct vfsmount *lower_mnt;
247 struct inode *lower_inode;
248 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
249 struct ecryptfs_crypt_stat *crypt_stat;
250 char *page_virt = NULL;
254 lower_dir_dentry = lower_dentry->d_parent;
255 lower_mnt = mntget(ecryptfs_dentry_to_lower_mnt(
256 ecryptfs_dentry->d_parent));
257 lower_inode = lower_dentry->d_inode;
258 fsstack_copy_attr_atime(ecryptfs_dir_inode, lower_dir_dentry->d_inode);
259 BUG_ON(!atomic_read(&lower_dentry->d_count));
260 ecryptfs_set_dentry_private(ecryptfs_dentry,
261 kmem_cache_alloc(ecryptfs_dentry_info_cache,
263 if (!ecryptfs_dentry_to_private(ecryptfs_dentry)) {
265 printk(KERN_ERR "%s: Out of memory whilst attempting "
266 "to allocate ecryptfs_dentry_info struct\n",
270 ecryptfs_set_dentry_lower(ecryptfs_dentry, lower_dentry);
271 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry, lower_mnt);
272 if (!lower_dentry->d_inode) {
273 /* We want to add because we couldn't find in lower */
274 d_add(ecryptfs_dentry, NULL);
277 rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry,
278 ecryptfs_dir_inode->i_sb,
279 ECRYPTFS_INTERPOSE_FLAG_D_ADD);
281 printk(KERN_ERR "%s: Error interposing; rc = [%d]\n",
285 if (S_ISDIR(lower_inode->i_mode))
287 if (S_ISLNK(lower_inode->i_mode))
289 if (special_file(lower_inode->i_mode))
293 /* Released in this function */
294 page_virt = kmem_cache_zalloc(ecryptfs_header_cache_2, GFP_USER);
296 printk(KERN_ERR "%s: Cannot kmem_cache_zalloc() a page\n",
301 if (!ecryptfs_inode_to_private(ecryptfs_dentry->d_inode)->lower_file) {
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);
311 crypt_stat = &ecryptfs_inode_to_private(
312 ecryptfs_dentry->d_inode)->crypt_stat;
313 /* TODO: lock for crypt_stat comparison */
314 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
315 ecryptfs_set_default_sizes(crypt_stat);
316 rc = ecryptfs_read_and_validate_header_region(page_virt,
317 ecryptfs_dentry->d_inode);
319 memset(page_virt, 0, PAGE_CACHE_SIZE);
320 rc = ecryptfs_read_and_validate_xattr_region(page_virt,
326 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
328 mount_crypt_stat = &ecryptfs_superblock_to_private(
329 ecryptfs_dentry->d_sb)->mount_crypt_stat;
330 if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED) {
331 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
332 file_size = (crypt_stat->metadata_size
333 + i_size_read(lower_dentry->d_inode));
335 file_size = i_size_read(lower_dentry->d_inode);
337 file_size = get_unaligned_be64(page_virt);
339 i_size_write(ecryptfs_dentry->d_inode, (loff_t)file_size);
341 kmem_cache_free(ecryptfs_header_cache_2, page_virt);
346 d_drop(ecryptfs_dentry);
352 * ecryptfs_new_lower_dentry
353 * @name: The name of the new dentry.
354 * @lower_dir_dentry: Parent directory of the new dentry.
355 * @nd: nameidata from last lookup.
357 * Create a new dentry or get it from lower parent dir.
359 static struct dentry *
360 ecryptfs_new_lower_dentry(struct qstr *name, struct dentry *lower_dir_dentry,
361 struct nameidata *nd)
363 struct dentry *new_dentry;
365 struct inode *lower_dir_inode;
367 lower_dir_inode = lower_dir_dentry->d_inode;
369 tmp = d_alloc(lower_dir_dentry, name);
371 return ERR_PTR(-ENOMEM);
373 mutex_lock(&lower_dir_inode->i_mutex);
374 new_dentry = lower_dir_inode->i_op->lookup(lower_dir_inode, tmp, nd);
375 mutex_unlock(&lower_dir_inode->i_mutex);
387 * ecryptfs_lookup_one_lower
388 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
389 * @lower_dir_dentry: lower parent directory
390 * @name: lower file name
392 * Get the lower dentry from vfs. If lower dentry does not exist yet,
395 static struct dentry *
396 ecryptfs_lookup_one_lower(struct dentry *ecryptfs_dentry,
397 struct dentry *lower_dir_dentry, struct qstr *name)
400 struct vfsmount *lower_mnt;
403 lower_mnt = mntget(ecryptfs_dentry_to_lower_mnt(
404 ecryptfs_dentry->d_parent));
405 err = vfs_path_lookup(lower_dir_dentry, lower_mnt, name->name , 0, &nd);
409 /* we dont need the mount */
411 return nd.path.dentry;
416 /* create a new lower dentry */
417 return ecryptfs_new_lower_dentry(name, lower_dir_dentry, &nd);
422 * @ecryptfs_dir_inode: The eCryptfs directory inode
423 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
424 * @ecryptfs_nd: nameidata; may be NULL
426 * Find a file on disk. If the file does not exist, then we'll add it to the
427 * dentry cache and continue on to read it from the disk.
429 static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
430 struct dentry *ecryptfs_dentry,
431 struct nameidata *ecryptfs_nd)
433 char *encrypted_and_encoded_name = NULL;
434 size_t encrypted_and_encoded_name_size;
435 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
436 struct dentry *lower_dir_dentry, *lower_dentry;
437 struct qstr lower_name;
440 ecryptfs_dentry->d_op = &ecryptfs_dops;
441 if ((ecryptfs_dentry->d_name.len == 1
442 && !strcmp(ecryptfs_dentry->d_name.name, "."))
443 || (ecryptfs_dentry->d_name.len == 2
444 && !strcmp(ecryptfs_dentry->d_name.name, ".."))) {
447 lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
448 lower_name.name = ecryptfs_dentry->d_name.name;
449 lower_name.len = ecryptfs_dentry->d_name.len;
450 lower_name.hash = ecryptfs_dentry->d_name.hash;
451 if (lower_dir_dentry->d_op && lower_dir_dentry->d_op->d_hash) {
452 rc = lower_dir_dentry->d_op->d_hash(lower_dir_dentry,
457 lower_dentry = ecryptfs_lookup_one_lower(ecryptfs_dentry,
458 lower_dir_dentry, &lower_name);
459 if (IS_ERR(lower_dentry)) {
460 rc = PTR_ERR(lower_dentry);
461 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_lower() returned "
462 "[%d] on lower_dentry = [%s]\n", __func__, rc,
463 encrypted_and_encoded_name);
466 if (lower_dentry->d_inode)
467 goto lookup_and_interpose;
468 mount_crypt_stat = &ecryptfs_superblock_to_private(
469 ecryptfs_dentry->d_sb)->mount_crypt_stat;
470 if (!(mount_crypt_stat
471 && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)))
472 goto lookup_and_interpose;
474 rc = ecryptfs_encrypt_and_encode_filename(
475 &encrypted_and_encoded_name, &encrypted_and_encoded_name_size,
476 NULL, mount_crypt_stat, ecryptfs_dentry->d_name.name,
477 ecryptfs_dentry->d_name.len);
479 printk(KERN_ERR "%s: Error attempting to encrypt and encode "
480 "filename; rc = [%d]\n", __func__, rc);
483 lower_name.name = encrypted_and_encoded_name;
484 lower_name.len = encrypted_and_encoded_name_size;
485 lower_name.hash = full_name_hash(lower_name.name, lower_name.len);
486 if (lower_dir_dentry->d_op && lower_dir_dentry->d_op->d_hash) {
487 rc = lower_dir_dentry->d_op->d_hash(lower_dir_dentry,
492 lower_dentry = ecryptfs_lookup_one_lower(ecryptfs_dentry,
493 lower_dir_dentry, &lower_name);
494 if (IS_ERR(lower_dentry)) {
495 rc = PTR_ERR(lower_dentry);
496 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_lower() returned "
497 "[%d] on lower_dentry = [%s]\n", __func__, rc,
498 encrypted_and_encoded_name);
501 lookup_and_interpose:
502 rc = ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry, lower_dentry,
507 d_drop(ecryptfs_dentry);
509 kfree(encrypted_and_encoded_name);
513 static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
514 struct dentry *new_dentry)
516 struct dentry *lower_old_dentry;
517 struct dentry *lower_new_dentry;
518 struct dentry *lower_dir_dentry;
522 file_size_save = i_size_read(old_dentry->d_inode);
523 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
524 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
525 dget(lower_old_dentry);
526 dget(lower_new_dentry);
527 lower_dir_dentry = lock_parent(lower_new_dentry);
528 rc = vfs_link(lower_old_dentry, lower_dir_dentry->d_inode,
530 if (rc || !lower_new_dentry->d_inode)
532 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb, 0);
535 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
536 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
537 old_dentry->d_inode->i_nlink =
538 ecryptfs_inode_to_lower(old_dentry->d_inode)->i_nlink;
539 i_size_write(new_dentry->d_inode, file_size_save);
541 unlock_dir(lower_dir_dentry);
542 dput(lower_new_dentry);
543 dput(lower_old_dentry);
547 static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
550 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
551 struct inode *lower_dir_inode = ecryptfs_inode_to_lower(dir);
552 struct dentry *lower_dir_dentry;
555 lower_dir_dentry = lock_parent(lower_dentry);
556 rc = vfs_unlink(lower_dir_inode, lower_dentry);
558 printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
561 fsstack_copy_attr_times(dir, lower_dir_inode);
562 dentry->d_inode->i_nlink =
563 ecryptfs_inode_to_lower(dentry->d_inode)->i_nlink;
564 dentry->d_inode->i_ctime = dir->i_ctime;
567 unlock_dir(lower_dir_dentry);
572 static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
576 struct dentry *lower_dentry;
577 struct dentry *lower_dir_dentry;
578 char *encoded_symname;
579 size_t encoded_symlen;
580 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
582 lower_dentry = ecryptfs_dentry_to_lower(dentry);
584 lower_dir_dentry = lock_parent(lower_dentry);
585 mount_crypt_stat = &ecryptfs_superblock_to_private(
586 dir->i_sb)->mount_crypt_stat;
587 rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
590 mount_crypt_stat, symname,
594 rc = vfs_symlink(lower_dir_dentry->d_inode, lower_dentry,
596 kfree(encoded_symname);
597 if (rc || !lower_dentry->d_inode)
599 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
602 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
603 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
605 unlock_dir(lower_dir_dentry);
607 if (!dentry->d_inode)
612 static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
615 struct dentry *lower_dentry;
616 struct dentry *lower_dir_dentry;
618 lower_dentry = ecryptfs_dentry_to_lower(dentry);
619 lower_dir_dentry = lock_parent(lower_dentry);
620 rc = vfs_mkdir(lower_dir_dentry->d_inode, lower_dentry, mode);
621 if (rc || !lower_dentry->d_inode)
623 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
626 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
627 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
628 dir->i_nlink = lower_dir_dentry->d_inode->i_nlink;
630 unlock_dir(lower_dir_dentry);
631 if (!dentry->d_inode)
636 static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
638 struct dentry *lower_dentry;
639 struct dentry *lower_dir_dentry;
642 lower_dentry = ecryptfs_dentry_to_lower(dentry);
644 lower_dir_dentry = lock_parent(lower_dentry);
646 rc = vfs_rmdir(lower_dir_dentry->d_inode, lower_dentry);
649 d_delete(lower_dentry);
650 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
651 dir->i_nlink = lower_dir_dentry->d_inode->i_nlink;
652 unlock_dir(lower_dir_dentry);
660 ecryptfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t dev)
663 struct dentry *lower_dentry;
664 struct dentry *lower_dir_dentry;
666 lower_dentry = ecryptfs_dentry_to_lower(dentry);
667 lower_dir_dentry = lock_parent(lower_dentry);
668 rc = vfs_mknod(lower_dir_dentry->d_inode, lower_dentry, mode, dev);
669 if (rc || !lower_dentry->d_inode)
671 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0);
674 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
675 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
677 unlock_dir(lower_dir_dentry);
678 if (!dentry->d_inode)
684 ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
685 struct inode *new_dir, struct dentry *new_dentry)
688 struct dentry *lower_old_dentry;
689 struct dentry *lower_new_dentry;
690 struct dentry *lower_old_dir_dentry;
691 struct dentry *lower_new_dir_dentry;
692 struct dentry *trap = NULL;
694 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
695 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
696 dget(lower_old_dentry);
697 dget(lower_new_dentry);
698 lower_old_dir_dentry = dget_parent(lower_old_dentry);
699 lower_new_dir_dentry = dget_parent(lower_new_dentry);
700 trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
701 /* source should not be ancestor of target */
702 if (trap == lower_old_dentry) {
706 /* target should not be ancestor of source */
707 if (trap == lower_new_dentry) {
711 rc = vfs_rename(lower_old_dir_dentry->d_inode, lower_old_dentry,
712 lower_new_dir_dentry->d_inode, lower_new_dentry);
715 fsstack_copy_attr_all(new_dir, lower_new_dir_dentry->d_inode);
716 if (new_dir != old_dir)
717 fsstack_copy_attr_all(old_dir, lower_old_dir_dentry->d_inode);
719 unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
720 dput(lower_new_dentry->d_parent);
721 dput(lower_old_dentry->d_parent);
722 dput(lower_new_dentry);
723 dput(lower_old_dentry);
727 static int ecryptfs_readlink_lower(struct dentry *dentry, char **buf,
730 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
732 size_t lower_bufsiz = PATH_MAX;
736 lower_buf = kmalloc(lower_bufsiz, GFP_KERNEL);
743 rc = lower_dentry->d_inode->i_op->readlink(lower_dentry,
744 (char __user *)lower_buf,
750 rc = ecryptfs_decode_and_decrypt_filename(buf, bufsiz, dentry,
751 lower_buf, lower_bufsiz);
758 ecryptfs_readlink(struct dentry *dentry, char __user *buf, int bufsiz)
761 size_t kbufsiz, copied;
764 rc = ecryptfs_readlink_lower(dentry, &kbuf, &kbufsiz);
767 copied = min_t(size_t, bufsiz, kbufsiz);
768 rc = copy_to_user(buf, kbuf, copied) ? -EFAULT : copied;
770 fsstack_copy_attr_atime(dentry->d_inode,
771 ecryptfs_dentry_to_lower(dentry)->d_inode);
776 static void *ecryptfs_follow_link(struct dentry *dentry, struct nameidata *nd)
779 int len = PAGE_SIZE, rc;
782 /* Released in ecryptfs_put_link(); only release here on error */
783 buf = kmalloc(len, GFP_KERNEL);
785 buf = ERR_PTR(-ENOMEM);
790 rc = dentry->d_inode->i_op->readlink(dentry, (char __user *)buf, len);
798 nd_set_link(nd, buf);
803 ecryptfs_put_link(struct dentry *dentry, struct nameidata *nd, void *ptr)
805 char *buf = nd_get_link(nd);
813 * upper_size_to_lower_size
814 * @crypt_stat: Crypt_stat associated with file
815 * @upper_size: Size of the upper file
817 * Calculate the required size of the lower file based on the
818 * specified size of the upper file. This calculation is based on the
819 * number of headers in the underlying file and the extent size.
821 * Returns Calculated size of the lower file.
824 upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
829 lower_size = ecryptfs_lower_header_size(crypt_stat);
830 if (upper_size != 0) {
833 num_extents = upper_size >> crypt_stat->extent_shift;
834 if (upper_size & ~crypt_stat->extent_mask)
836 lower_size += (num_extents * crypt_stat->extent_size);
843 * @dentry: The ecryptfs layer dentry
844 * @ia: Address of the ecryptfs inode's attributes
845 * @lower_ia: Address of the lower inode's attributes
847 * Function to handle truncations modifying the size of the file. Note
848 * that the file sizes are interpolated. When expanding, we are simply
849 * writing strings of 0's out. When truncating, we truncate the upper
850 * inode and update the lower_ia according to the page index
851 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
852 * the caller must use lower_ia in a call to notify_change() to perform
853 * the truncation of the lower inode.
855 * Returns zero on success; non-zero otherwise
857 static int truncate_upper(struct dentry *dentry, struct iattr *ia,
858 struct iattr *lower_ia)
861 struct inode *inode = dentry->d_inode;
862 struct ecryptfs_crypt_stat *crypt_stat;
863 loff_t i_size = i_size_read(inode);
864 loff_t lower_size_before_truncate;
865 loff_t lower_size_after_truncate;
867 if (unlikely((ia->ia_size == i_size))) {
868 lower_ia->ia_valid &= ~ATTR_SIZE;
871 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
872 /* Switch on growing or shrinking file */
873 if (ia->ia_size > i_size) {
874 char zero[] = { 0x00 };
876 lower_ia->ia_valid &= ~ATTR_SIZE;
877 /* Write a single 0 at the last position of the file;
878 * this triggers code that will fill in 0's throughout
879 * the intermediate portion of the previous end of the
880 * file and the new and of the file */
881 rc = ecryptfs_write(inode, zero,
882 (ia->ia_size - 1), 1);
883 } else { /* ia->ia_size < i_size_read(inode) */
884 /* We're chopping off all the pages down to the page
885 * in which ia->ia_size is located. Fill in the end of
886 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
887 * PAGE_CACHE_SIZE with zeros. */
888 size_t num_zeros = (PAGE_CACHE_SIZE
889 - (ia->ia_size & ~PAGE_CACHE_MASK));
893 * XXX(truncate) this should really happen at the begginning
894 * of ->setattr. But the code is too messy to that as part
895 * of a larger patch. ecryptfs is also totally missing out
896 * on the inode_change_ok check at the beginning of
897 * ->setattr while would include this.
899 rc = inode_newsize_ok(inode, ia->ia_size);
903 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
904 truncate_setsize(inode, ia->ia_size);
905 lower_ia->ia_size = ia->ia_size;
906 lower_ia->ia_valid |= ATTR_SIZE;
912 zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
917 rc = ecryptfs_write(inode, zeros_virt,
918 ia->ia_size, num_zeros);
921 printk(KERN_ERR "Error attempting to zero out "
922 "the remainder of the end page on "
923 "reducing truncate; rc = [%d]\n", rc);
927 truncate_setsize(inode, ia->ia_size);
928 rc = ecryptfs_write_inode_size_to_metadata(inode);
930 printk(KERN_ERR "Problem with "
931 "ecryptfs_write_inode_size_to_metadata; "
935 /* We are reducing the size of the ecryptfs file, and need to
936 * know if we need to reduce the size of the lower file. */
937 lower_size_before_truncate =
938 upper_size_to_lower_size(crypt_stat, i_size);
939 lower_size_after_truncate =
940 upper_size_to_lower_size(crypt_stat, ia->ia_size);
941 if (lower_size_after_truncate < lower_size_before_truncate) {
942 lower_ia->ia_size = lower_size_after_truncate;
943 lower_ia->ia_valid |= ATTR_SIZE;
945 lower_ia->ia_valid &= ~ATTR_SIZE;
953 * @dentry: The ecryptfs layer dentry
954 * @new_length: The length to expand the file to
956 * Simple function that handles the truncation of an eCryptfs inode and
957 * its corresponding lower inode.
959 * Returns zero on success; non-zero otherwise
961 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
963 struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
964 struct iattr lower_ia = { .ia_valid = 0 };
967 rc = truncate_upper(dentry, &ia, &lower_ia);
968 if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
969 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
971 mutex_lock(&lower_dentry->d_inode->i_mutex);
972 rc = notify_change(lower_dentry, &lower_ia);
973 mutex_unlock(&lower_dentry->d_inode->i_mutex);
979 ecryptfs_permission(struct inode *inode, int mask)
981 return inode_permission(ecryptfs_inode_to_lower(inode), mask);
986 * @dentry: dentry handle to the inode to modify
987 * @ia: Structure with flags of what to change and values
989 * Updates the metadata of an inode. If the update is to the size
990 * i.e. truncation, then ecryptfs_truncate will handle the size modification
991 * of both the ecryptfs inode and the lower inode.
993 * All other metadata changes will be passed right to the lower filesystem,
994 * and we will just update our inode to look like the lower.
996 static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
999 struct dentry *lower_dentry;
1000 struct iattr lower_ia;
1001 struct inode *inode;
1002 struct inode *lower_inode;
1003 struct ecryptfs_crypt_stat *crypt_stat;
1005 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
1006 if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED))
1007 ecryptfs_init_crypt_stat(crypt_stat);
1008 inode = dentry->d_inode;
1009 lower_inode = ecryptfs_inode_to_lower(inode);
1010 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1011 mutex_lock(&crypt_stat->cs_mutex);
1012 if (S_ISDIR(dentry->d_inode->i_mode))
1013 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
1014 else if (S_ISREG(dentry->d_inode->i_mode)
1015 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
1016 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
1017 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
1019 mount_crypt_stat = &ecryptfs_superblock_to_private(
1020 dentry->d_sb)->mount_crypt_stat;
1021 rc = ecryptfs_read_metadata(dentry);
1023 if (!(mount_crypt_stat->flags
1024 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
1026 printk(KERN_WARNING "Either the lower file "
1027 "is not in a valid eCryptfs format, "
1028 "or the key could not be retrieved. "
1029 "Plaintext passthrough mode is not "
1030 "enabled; returning -EIO\n");
1031 mutex_unlock(&crypt_stat->cs_mutex);
1035 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
1038 mutex_unlock(&crypt_stat->cs_mutex);
1039 memcpy(&lower_ia, ia, sizeof(lower_ia));
1040 if (ia->ia_valid & ATTR_FILE)
1041 lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
1042 if (ia->ia_valid & ATTR_SIZE) {
1043 rc = truncate_upper(dentry, ia, &lower_ia);
1049 * mode change is for clearing setuid/setgid bits. Allow lower fs
1050 * to interpret this in its own way.
1052 if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
1053 lower_ia.ia_valid &= ~ATTR_MODE;
1055 mutex_lock(&lower_dentry->d_inode->i_mutex);
1056 rc = notify_change(lower_dentry, &lower_ia);
1057 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1059 fsstack_copy_attr_all(inode, lower_inode);
1063 int ecryptfs_getattr_link(struct vfsmount *mnt, struct dentry *dentry,
1066 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
1069 mount_crypt_stat = &ecryptfs_superblock_to_private(
1070 dentry->d_sb)->mount_crypt_stat;
1071 generic_fillattr(dentry->d_inode, stat);
1072 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
1076 rc = ecryptfs_readlink_lower(dentry, &target, &targetsiz);
1079 stat->size = targetsiz;
1085 int ecryptfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
1088 struct kstat lower_stat;
1091 rc = vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry),
1092 ecryptfs_dentry_to_lower(dentry), &lower_stat);
1094 generic_fillattr(dentry->d_inode, stat);
1095 stat->blocks = lower_stat.blocks;
1101 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
1102 size_t size, int flags)
1105 struct dentry *lower_dentry;
1107 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1108 if (!lower_dentry->d_inode->i_op->setxattr) {
1113 rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1119 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
1120 void *value, size_t size)
1124 if (!lower_dentry->d_inode->i_op->getxattr) {
1128 mutex_lock(&lower_dentry->d_inode->i_mutex);
1129 rc = lower_dentry->d_inode->i_op->getxattr(lower_dentry, name, value,
1131 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1137 ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
1140 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry), name,
1145 ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1148 struct dentry *lower_dentry;
1150 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1151 if (!lower_dentry->d_inode->i_op->listxattr) {
1155 mutex_lock(&lower_dentry->d_inode->i_mutex);
1156 rc = lower_dentry->d_inode->i_op->listxattr(lower_dentry, list, size);
1157 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1162 static int ecryptfs_removexattr(struct dentry *dentry, const char *name)
1165 struct dentry *lower_dentry;
1167 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1168 if (!lower_dentry->d_inode->i_op->removexattr) {
1172 mutex_lock(&lower_dentry->d_inode->i_mutex);
1173 rc = lower_dentry->d_inode->i_op->removexattr(lower_dentry, name);
1174 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1179 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode)
1181 if ((ecryptfs_inode_to_lower(inode)
1182 == (struct inode *)candidate_lower_inode))
1188 int ecryptfs_inode_set(struct inode *inode, void *lower_inode)
1190 ecryptfs_init_inode(inode, (struct inode *)lower_inode);
1194 const struct inode_operations ecryptfs_symlink_iops = {
1195 .readlink = ecryptfs_readlink,
1196 .follow_link = ecryptfs_follow_link,
1197 .put_link = ecryptfs_put_link,
1198 .permission = ecryptfs_permission,
1199 .setattr = ecryptfs_setattr,
1200 .getattr = ecryptfs_getattr_link,
1201 .setxattr = ecryptfs_setxattr,
1202 .getxattr = ecryptfs_getxattr,
1203 .listxattr = ecryptfs_listxattr,
1204 .removexattr = ecryptfs_removexattr
1207 const struct inode_operations ecryptfs_dir_iops = {
1208 .create = ecryptfs_create,
1209 .lookup = ecryptfs_lookup,
1210 .link = ecryptfs_link,
1211 .unlink = ecryptfs_unlink,
1212 .symlink = ecryptfs_symlink,
1213 .mkdir = ecryptfs_mkdir,
1214 .rmdir = ecryptfs_rmdir,
1215 .mknod = ecryptfs_mknod,
1216 .rename = ecryptfs_rename,
1217 .permission = ecryptfs_permission,
1218 .setattr = ecryptfs_setattr,
1219 .setxattr = ecryptfs_setxattr,
1220 .getxattr = ecryptfs_getxattr,
1221 .listxattr = ecryptfs_listxattr,
1222 .removexattr = ecryptfs_removexattr
1225 const struct inode_operations ecryptfs_main_iops = {
1226 .permission = ecryptfs_permission,
1227 .setattr = ecryptfs_setattr,
1228 .getattr = ecryptfs_getattr,
1229 .setxattr = ecryptfs_setxattr,
1230 .getxattr = ecryptfs_getxattr,
1231 .listxattr = ecryptfs_listxattr,
1232 .removexattr = ecryptfs_removexattr