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
;
73 if (S_ISLNK(inode
->i_mode
))
74 inode
->i_op
= &ecryptfs_symlink_iops
;
75 else if (S_ISDIR(inode
->i_mode
))
76 inode
->i_op
= &ecryptfs_dir_iops
;
78 inode
->i_op
= &ecryptfs_main_iops
;
80 if (S_ISDIR(inode
->i_mode
))
81 inode
->i_fop
= &ecryptfs_dir_fops
;
82 else if (special_file(inode
->i_mode
))
83 init_special_inode(inode
, inode
->i_mode
, inode
->i_rdev
);
85 inode
->i_fop
= &ecryptfs_main_fops
;
90 static struct inode
*__ecryptfs_get_inode(struct inode
*lower_inode
,
91 struct super_block
*sb
)
95 if (lower_inode
->i_sb
!= ecryptfs_superblock_to_lower(sb
))
96 return ERR_PTR(-EXDEV
);
97 if (!igrab(lower_inode
))
98 return ERR_PTR(-ESTALE
);
99 inode
= iget5_locked(sb
, (unsigned long)lower_inode
,
100 ecryptfs_inode_test
, ecryptfs_inode_set
,
104 return ERR_PTR(-EACCES
);
106 if (!(inode
->i_state
& I_NEW
))
112 struct inode
*ecryptfs_get_inode(struct inode
*lower_inode
,
113 struct super_block
*sb
)
115 struct inode
*inode
= __ecryptfs_get_inode(lower_inode
, sb
);
117 if (!IS_ERR(inode
) && (inode
->i_state
& I_NEW
))
118 unlock_new_inode(inode
);
125 * @lower_dentry: Existing dentry in the lower filesystem
126 * @dentry: ecryptfs' dentry
127 * @sb: ecryptfs's super_block
129 * Interposes upper and lower dentries.
131 * Returns zero on success; non-zero otherwise
133 static int ecryptfs_interpose(struct dentry
*lower_dentry
,
134 struct dentry
*dentry
, struct super_block
*sb
)
136 struct inode
*inode
= ecryptfs_get_inode(lower_dentry
->d_inode
, sb
);
139 return PTR_ERR(inode
);
140 d_instantiate(dentry
, inode
);
146 * ecryptfs_create_underlying_file
147 * @lower_dir_inode: inode of the parent in the lower fs of the new file
148 * @dentry: New file's dentry
149 * @mode: The mode of the new file
150 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
152 * Creates the file in the lower file system.
154 * Returns zero on success; non-zero on error condition
157 ecryptfs_create_underlying_file(struct inode
*lower_dir_inode
,
158 struct dentry
*dentry
, int mode
,
159 struct nameidata
*nd
)
161 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
162 struct vfsmount
*lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
163 struct dentry
*dentry_save
;
164 struct vfsmount
*vfsmount_save
;
165 unsigned int flags_save
;
169 dentry_save
= nd
->path
.dentry
;
170 vfsmount_save
= nd
->path
.mnt
;
171 flags_save
= nd
->flags
;
172 nd
->path
.dentry
= lower_dentry
;
173 nd
->path
.mnt
= lower_mnt
;
174 nd
->flags
&= ~LOOKUP_OPEN
;
176 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
178 nd
->path
.dentry
= dentry_save
;
179 nd
->path
.mnt
= vfsmount_save
;
180 nd
->flags
= flags_save
;
187 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
188 * @ecryptfs_dentry: New file's dentry in ecryptfs
189 * @mode: The mode of the new file
190 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
192 * Creates the underlying file and the eCryptfs inode which will link to
193 * it. It will also update the eCryptfs directory inode to mimic the
194 * stat of the lower directory inode.
196 * Returns zero on success; non-zero on error condition
199 ecryptfs_do_create(struct inode
*directory_inode
,
200 struct dentry
*ecryptfs_dentry
, int mode
,
201 struct nameidata
*nd
)
204 struct dentry
*lower_dentry
;
205 struct dentry
*lower_dir_dentry
;
207 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
208 lower_dir_dentry
= lock_parent(lower_dentry
);
209 if (IS_ERR(lower_dir_dentry
)) {
210 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
212 rc
= PTR_ERR(lower_dir_dentry
);
215 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
216 ecryptfs_dentry
, mode
, nd
);
218 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
219 "rc = [%d]\n", __func__
, rc
);
222 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
223 directory_inode
->i_sb
);
225 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
228 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
229 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
231 unlock_dir(lower_dir_dentry
);
237 * ecryptfs_initialize_file
239 * Cause the file to be changed from a basic empty file to an ecryptfs
240 * file with a header and first data page.
242 * Returns zero on success
244 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
246 struct ecryptfs_crypt_stat
*crypt_stat
=
247 &ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->crypt_stat
;
250 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
251 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
252 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
255 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
256 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
258 ecryptfs_printk(KERN_ERR
, "Error creating new file "
259 "context; rc = [%d]\n", rc
);
262 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
);
264 printk(KERN_ERR
"%s: Error attempting to initialize "
265 "the lower file for the dentry with name "
266 "[%s]; rc = [%d]\n", __func__
,
267 ecryptfs_dentry
->d_name
.name
, rc
);
270 rc
= ecryptfs_write_metadata(ecryptfs_dentry
);
272 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
273 ecryptfs_put_lower_file(ecryptfs_dentry
->d_inode
);
280 * @dir: The inode of the directory in which to create the file.
281 * @dentry: The eCryptfs dentry
282 * @mode: The mode of the new file.
285 * Creates a new file.
287 * Returns zero on success; non-zero on error condition
290 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
291 int mode
, struct nameidata
*nd
)
295 /* ecryptfs_do_create() calls ecryptfs_interpose() */
296 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
298 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
299 "lower filesystem\n");
302 /* At this point, a file exists on "disk"; we need to make sure
303 * that this on disk file is prepared to be an ecryptfs file */
304 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
310 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
312 static int ecryptfs_lookup_interpose(struct dentry
*ecryptfs_dentry
,
313 struct dentry
*lower_dentry
,
314 struct inode
*ecryptfs_dir_inode
)
316 struct dentry
*lower_dir_dentry
;
317 struct vfsmount
*lower_mnt
;
318 struct inode
*inode
, *lower_inode
;
319 struct ecryptfs_crypt_stat
*crypt_stat
;
320 char *page_virt
= NULL
;
321 int put_lower
= 0, rc
= 0;
323 lower_dir_dentry
= lower_dentry
->d_parent
;
324 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
325 ecryptfs_dentry
->d_parent
));
326 lower_inode
= lower_dentry
->d_inode
;
327 fsstack_copy_attr_atime(ecryptfs_dir_inode
, lower_dir_dentry
->d_inode
);
328 BUG_ON(!lower_dentry
->d_count
);
329 ecryptfs_set_dentry_private(ecryptfs_dentry
,
330 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
332 if (!ecryptfs_dentry_to_private(ecryptfs_dentry
)) {
334 printk(KERN_ERR
"%s: Out of memory whilst attempting "
335 "to allocate ecryptfs_dentry_info struct\n",
339 ecryptfs_set_dentry_lower(ecryptfs_dentry
, lower_dentry
);
340 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry
, lower_mnt
);
341 if (!lower_dentry
->d_inode
) {
342 /* We want to add because we couldn't find in lower */
343 d_add(ecryptfs_dentry
, NULL
);
346 inode
= __ecryptfs_get_inode(lower_inode
, ecryptfs_dir_inode
->i_sb
);
349 printk(KERN_ERR
"%s: Error interposing; rc = [%d]\n",
353 if (inode
->i_state
& I_NEW
)
354 unlock_new_inode(inode
);
355 d_add(ecryptfs_dentry
, inode
);
356 if (S_ISDIR(lower_inode
->i_mode
))
358 if (S_ISLNK(lower_inode
->i_mode
))
360 if (special_file(lower_inode
->i_mode
))
362 /* Released in this function */
363 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
, GFP_USER
);
365 printk(KERN_ERR
"%s: Cannot kmem_cache_zalloc() a page\n",
370 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
);
372 printk(KERN_ERR
"%s: Error attempting to initialize "
373 "the lower file for the dentry with name "
374 "[%s]; rc = [%d]\n", __func__
,
375 ecryptfs_dentry
->d_name
.name
, rc
);
379 crypt_stat
= &ecryptfs_inode_to_private(
380 ecryptfs_dentry
->d_inode
)->crypt_stat
;
381 /* TODO: lock for crypt_stat comparison */
382 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
383 ecryptfs_set_default_sizes(crypt_stat
);
384 rc
= ecryptfs_read_and_validate_header_region(page_virt
,
385 ecryptfs_dentry
->d_inode
);
387 memset(page_virt
, 0, PAGE_CACHE_SIZE
);
388 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
,
394 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
396 ecryptfs_i_size_init(page_virt
, ecryptfs_dentry
->d_inode
);
398 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
403 d_drop(ecryptfs_dentry
);
406 ecryptfs_put_lower_file(ecryptfs_dentry
->d_inode
);
412 * @ecryptfs_dir_inode: The eCryptfs directory inode
413 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
414 * @ecryptfs_nd: nameidata; may be NULL
416 * Find a file on disk. If the file does not exist, then we'll add it to the
417 * dentry cache and continue on to read it from the disk.
419 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
420 struct dentry
*ecryptfs_dentry
,
421 struct nameidata
*ecryptfs_nd
)
423 char *encrypted_and_encoded_name
= NULL
;
424 size_t encrypted_and_encoded_name_size
;
425 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
426 struct dentry
*lower_dir_dentry
, *lower_dentry
;
429 if ((ecryptfs_dentry
->d_name
.len
== 1
430 && !strcmp(ecryptfs_dentry
->d_name
.name
, "."))
431 || (ecryptfs_dentry
->d_name
.len
== 2
432 && !strcmp(ecryptfs_dentry
->d_name
.name
, ".."))) {
435 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
436 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
437 lower_dentry
= lookup_one_len(ecryptfs_dentry
->d_name
.name
,
439 ecryptfs_dentry
->d_name
.len
);
440 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
441 if (IS_ERR(lower_dentry
)) {
442 rc
= PTR_ERR(lower_dentry
);
443 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
444 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
445 encrypted_and_encoded_name
);
448 if (lower_dentry
->d_inode
)
450 mount_crypt_stat
= &ecryptfs_superblock_to_private(
451 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
452 if (!(mount_crypt_stat
453 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
456 rc
= ecryptfs_encrypt_and_encode_filename(
457 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
458 NULL
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
459 ecryptfs_dentry
->d_name
.len
);
461 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
462 "filename; rc = [%d]\n", __func__
, rc
);
465 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
466 lower_dentry
= lookup_one_len(encrypted_and_encoded_name
,
468 encrypted_and_encoded_name_size
);
469 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
470 if (IS_ERR(lower_dentry
)) {
471 rc
= PTR_ERR(lower_dentry
);
472 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
473 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
474 encrypted_and_encoded_name
);
478 rc
= ecryptfs_lookup_interpose(ecryptfs_dentry
, lower_dentry
,
482 d_drop(ecryptfs_dentry
);
484 kfree(encrypted_and_encoded_name
);
488 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
489 struct dentry
*new_dentry
)
491 struct dentry
*lower_old_dentry
;
492 struct dentry
*lower_new_dentry
;
493 struct dentry
*lower_dir_dentry
;
497 file_size_save
= i_size_read(old_dentry
->d_inode
);
498 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
499 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
500 dget(lower_old_dentry
);
501 dget(lower_new_dentry
);
502 lower_dir_dentry
= lock_parent(lower_new_dentry
);
503 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
505 if (rc
|| !lower_new_dentry
->d_inode
)
507 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
);
510 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
511 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
512 old_dentry
->d_inode
->i_nlink
=
513 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
514 i_size_write(new_dentry
->d_inode
, file_size_save
);
516 unlock_dir(lower_dir_dentry
);
517 dput(lower_new_dentry
);
518 dput(lower_old_dentry
);
522 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
525 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
526 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
527 struct dentry
*lower_dir_dentry
;
530 lower_dir_dentry
= lock_parent(lower_dentry
);
531 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
533 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
536 fsstack_copy_attr_times(dir
, lower_dir_inode
);
537 dentry
->d_inode
->i_nlink
=
538 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
539 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
542 unlock_dir(lower_dir_dentry
);
547 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
551 struct dentry
*lower_dentry
;
552 struct dentry
*lower_dir_dentry
;
553 char *encoded_symname
;
554 size_t encoded_symlen
;
555 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
557 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
559 lower_dir_dentry
= lock_parent(lower_dentry
);
560 mount_crypt_stat
= &ecryptfs_superblock_to_private(
561 dir
->i_sb
)->mount_crypt_stat
;
562 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
565 mount_crypt_stat
, symname
,
569 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
571 kfree(encoded_symname
);
572 if (rc
|| !lower_dentry
->d_inode
)
574 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
577 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
578 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
580 unlock_dir(lower_dir_dentry
);
582 if (!dentry
->d_inode
)
587 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
590 struct dentry
*lower_dentry
;
591 struct dentry
*lower_dir_dentry
;
593 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
594 lower_dir_dentry
= lock_parent(lower_dentry
);
595 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
596 if (rc
|| !lower_dentry
->d_inode
)
598 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
601 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
602 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
603 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
605 unlock_dir(lower_dir_dentry
);
606 if (!dentry
->d_inode
)
611 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
613 struct dentry
*lower_dentry
;
614 struct dentry
*lower_dir_dentry
;
617 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
619 lower_dir_dentry
= lock_parent(lower_dentry
);
621 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
623 if (!rc
&& dentry
->d_inode
)
624 clear_nlink(dentry
->d_inode
);
625 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
626 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
627 unlock_dir(lower_dir_dentry
);
635 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
638 struct dentry
*lower_dentry
;
639 struct dentry
*lower_dir_dentry
;
641 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
642 lower_dir_dentry
= lock_parent(lower_dentry
);
643 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
644 if (rc
|| !lower_dentry
->d_inode
)
646 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
649 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
650 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
652 unlock_dir(lower_dir_dentry
);
653 if (!dentry
->d_inode
)
659 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
660 struct inode
*new_dir
, struct dentry
*new_dentry
)
663 struct dentry
*lower_old_dentry
;
664 struct dentry
*lower_new_dentry
;
665 struct dentry
*lower_old_dir_dentry
;
666 struct dentry
*lower_new_dir_dentry
;
667 struct dentry
*trap
= NULL
;
669 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
670 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
671 dget(lower_old_dentry
);
672 dget(lower_new_dentry
);
673 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
674 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
675 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
676 /* source should not be ancestor of target */
677 if (trap
== lower_old_dentry
) {
681 /* target should not be ancestor of source */
682 if (trap
== lower_new_dentry
) {
686 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
687 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
690 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
);
691 if (new_dir
!= old_dir
)
692 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
);
694 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
695 dput(lower_new_dir_dentry
);
696 dput(lower_old_dir_dentry
);
697 dput(lower_new_dentry
);
698 dput(lower_old_dentry
);
702 static int ecryptfs_readlink_lower(struct dentry
*dentry
, char **buf
,
705 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
707 size_t lower_bufsiz
= PATH_MAX
;
711 lower_buf
= kmalloc(lower_bufsiz
, GFP_KERNEL
);
718 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
719 (char __user
*)lower_buf
,
725 rc
= ecryptfs_decode_and_decrypt_filename(buf
, bufsiz
, dentry
,
726 lower_buf
, lower_bufsiz
);
733 ecryptfs_readlink(struct dentry
*dentry
, char __user
*buf
, int bufsiz
)
736 size_t kbufsiz
, copied
;
739 rc
= ecryptfs_readlink_lower(dentry
, &kbuf
, &kbufsiz
);
742 copied
= min_t(size_t, bufsiz
, kbufsiz
);
743 rc
= copy_to_user(buf
, kbuf
, copied
) ? -EFAULT
: copied
;
745 fsstack_copy_attr_atime(dentry
->d_inode
,
746 ecryptfs_dentry_to_lower(dentry
)->d_inode
);
751 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
754 int len
= PAGE_SIZE
, rc
;
757 /* Released in ecryptfs_put_link(); only release here on error */
758 buf
= kmalloc(len
, GFP_KERNEL
);
760 buf
= ERR_PTR(-ENOMEM
);
765 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
773 nd_set_link(nd
, buf
);
778 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
780 char *buf
= nd_get_link(nd
);
788 * upper_size_to_lower_size
789 * @crypt_stat: Crypt_stat associated with file
790 * @upper_size: Size of the upper file
792 * Calculate the required size of the lower file based on the
793 * specified size of the upper file. This calculation is based on the
794 * number of headers in the underlying file and the extent size.
796 * Returns Calculated size of the lower file.
799 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
804 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
805 if (upper_size
!= 0) {
808 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
809 if (upper_size
& ~crypt_stat
->extent_mask
)
811 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
818 * @dentry: The ecryptfs layer dentry
819 * @ia: Address of the ecryptfs inode's attributes
820 * @lower_ia: Address of the lower inode's attributes
822 * Function to handle truncations modifying the size of the file. Note
823 * that the file sizes are interpolated. When expanding, we are simply
824 * writing strings of 0's out. When truncating, we truncate the upper
825 * inode and update the lower_ia according to the page index
826 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
827 * the caller must use lower_ia in a call to notify_change() to perform
828 * the truncation of the lower inode.
830 * Returns zero on success; non-zero otherwise
832 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
833 struct iattr
*lower_ia
)
836 struct inode
*inode
= dentry
->d_inode
;
837 struct ecryptfs_crypt_stat
*crypt_stat
;
838 loff_t i_size
= i_size_read(inode
);
839 loff_t lower_size_before_truncate
;
840 loff_t lower_size_after_truncate
;
842 if (unlikely((ia
->ia_size
== i_size
))) {
843 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
846 rc
= ecryptfs_get_lower_file(dentry
);
849 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
850 /* Switch on growing or shrinking file */
851 if (ia
->ia_size
> i_size
) {
852 char zero
[] = { 0x00 };
854 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
855 /* Write a single 0 at the last position of the file;
856 * this triggers code that will fill in 0's throughout
857 * the intermediate portion of the previous end of the
858 * file and the new and of the file */
859 rc
= ecryptfs_write(inode
, zero
,
860 (ia
->ia_size
- 1), 1);
861 } else { /* ia->ia_size < i_size_read(inode) */
862 /* We're chopping off all the pages down to the page
863 * in which ia->ia_size is located. Fill in the end of
864 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
865 * PAGE_CACHE_SIZE with zeros. */
866 size_t num_zeros
= (PAGE_CACHE_SIZE
867 - (ia
->ia_size
& ~PAGE_CACHE_MASK
));
871 * XXX(truncate) this should really happen at the begginning
872 * of ->setattr. But the code is too messy to that as part
873 * of a larger patch. ecryptfs is also totally missing out
874 * on the inode_change_ok check at the beginning of
875 * ->setattr while would include this.
877 rc
= inode_newsize_ok(inode
, ia
->ia_size
);
881 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
882 truncate_setsize(inode
, ia
->ia_size
);
883 lower_ia
->ia_size
= ia
->ia_size
;
884 lower_ia
->ia_valid
|= ATTR_SIZE
;
890 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
895 rc
= ecryptfs_write(inode
, zeros_virt
,
896 ia
->ia_size
, num_zeros
);
899 printk(KERN_ERR
"Error attempting to zero out "
900 "the remainder of the end page on "
901 "reducing truncate; rc = [%d]\n", rc
);
905 truncate_setsize(inode
, ia
->ia_size
);
906 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
908 printk(KERN_ERR
"Problem with "
909 "ecryptfs_write_inode_size_to_metadata; "
913 /* We are reducing the size of the ecryptfs file, and need to
914 * know if we need to reduce the size of the lower file. */
915 lower_size_before_truncate
=
916 upper_size_to_lower_size(crypt_stat
, i_size
);
917 lower_size_after_truncate
=
918 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
919 if (lower_size_after_truncate
< lower_size_before_truncate
) {
920 lower_ia
->ia_size
= lower_size_after_truncate
;
921 lower_ia
->ia_valid
|= ATTR_SIZE
;
923 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
926 ecryptfs_put_lower_file(inode
);
932 * @dentry: The ecryptfs layer dentry
933 * @new_length: The length to expand the file to
935 * Simple function that handles the truncation of an eCryptfs inode and
936 * its corresponding lower inode.
938 * Returns zero on success; non-zero otherwise
940 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
942 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
943 struct iattr lower_ia
= { .ia_valid
= 0 };
946 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
947 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
948 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
950 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
951 rc
= notify_change(lower_dentry
, &lower_ia
);
952 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
958 ecryptfs_permission(struct inode
*inode
, int mask
, unsigned int flags
)
960 if (flags
& IPERM_FLAG_RCU
)
962 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
967 * @dentry: dentry handle to the inode to modify
968 * @ia: Structure with flags of what to change and values
970 * Updates the metadata of an inode. If the update is to the size
971 * i.e. truncation, then ecryptfs_truncate will handle the size modification
972 * of both the ecryptfs inode and the lower inode.
974 * All other metadata changes will be passed right to the lower filesystem,
975 * and we will just update our inode to look like the lower.
977 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
980 struct dentry
*lower_dentry
;
981 struct iattr lower_ia
;
983 struct inode
*lower_inode
;
984 struct ecryptfs_crypt_stat
*crypt_stat
;
986 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
987 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
988 ecryptfs_init_crypt_stat(crypt_stat
);
989 inode
= dentry
->d_inode
;
990 lower_inode
= ecryptfs_inode_to_lower(inode
);
991 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
992 mutex_lock(&crypt_stat
->cs_mutex
);
993 if (S_ISDIR(dentry
->d_inode
->i_mode
))
994 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
995 else if (S_ISREG(dentry
->d_inode
->i_mode
)
996 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
997 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
998 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
1000 mount_crypt_stat
= &ecryptfs_superblock_to_private(
1001 dentry
->d_sb
)->mount_crypt_stat
;
1002 rc
= ecryptfs_get_lower_file(dentry
);
1004 mutex_unlock(&crypt_stat
->cs_mutex
);
1007 rc
= ecryptfs_read_metadata(dentry
);
1008 ecryptfs_put_lower_file(inode
);
1010 if (!(mount_crypt_stat
->flags
1011 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
1013 printk(KERN_WARNING
"Either the lower file "
1014 "is not in a valid eCryptfs format, "
1015 "or the key could not be retrieved. "
1016 "Plaintext passthrough mode is not "
1017 "enabled; returning -EIO\n");
1018 mutex_unlock(&crypt_stat
->cs_mutex
);
1022 crypt_stat
->flags
&= ~(ECRYPTFS_I_SIZE_INITIALIZED
1023 | ECRYPTFS_ENCRYPTED
);
1026 mutex_unlock(&crypt_stat
->cs_mutex
);
1027 if (S_ISREG(inode
->i_mode
)) {
1028 rc
= filemap_write_and_wait(inode
->i_mapping
);
1031 fsstack_copy_attr_all(inode
, lower_inode
);
1033 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
1034 if (ia
->ia_valid
& ATTR_FILE
)
1035 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
1036 if (ia
->ia_valid
& ATTR_SIZE
) {
1037 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
1043 * mode change is for clearing setuid/setgid bits. Allow lower fs
1044 * to interpret this in its own way.
1046 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
1047 lower_ia
.ia_valid
&= ~ATTR_MODE
;
1049 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1050 rc
= notify_change(lower_dentry
, &lower_ia
);
1051 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1053 fsstack_copy_attr_all(inode
, lower_inode
);
1057 int ecryptfs_getattr_link(struct vfsmount
*mnt
, struct dentry
*dentry
,
1060 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
1063 mount_crypt_stat
= &ecryptfs_superblock_to_private(
1064 dentry
->d_sb
)->mount_crypt_stat
;
1065 generic_fillattr(dentry
->d_inode
, stat
);
1066 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
1070 rc
= ecryptfs_readlink_lower(dentry
, &target
, &targetsiz
);
1073 stat
->size
= targetsiz
;
1079 int ecryptfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
1082 struct kstat lower_stat
;
1085 rc
= vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry
),
1086 ecryptfs_dentry_to_lower(dentry
), &lower_stat
);
1088 fsstack_copy_attr_all(dentry
->d_inode
,
1089 ecryptfs_inode_to_lower(dentry
->d_inode
));
1090 generic_fillattr(dentry
->d_inode
, stat
);
1091 stat
->blocks
= lower_stat
.blocks
;
1097 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
1098 size_t size
, int flags
)
1101 struct dentry
*lower_dentry
;
1103 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1104 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
1109 rc
= vfs_setxattr(lower_dentry
, name
, value
, size
, flags
);
1115 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
1116 void *value
, size_t size
)
1120 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
1124 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1125 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
1127 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1133 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1136 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1141 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1144 struct dentry
*lower_dentry
;
1146 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1147 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1151 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1152 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1153 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1158 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1161 struct dentry
*lower_dentry
;
1163 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1164 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1168 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1169 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1170 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1175 const struct inode_operations ecryptfs_symlink_iops
= {
1176 .readlink
= ecryptfs_readlink
,
1177 .follow_link
= ecryptfs_follow_link
,
1178 .put_link
= ecryptfs_put_link
,
1179 .permission
= ecryptfs_permission
,
1180 .setattr
= ecryptfs_setattr
,
1181 .getattr
= ecryptfs_getattr_link
,
1182 .setxattr
= ecryptfs_setxattr
,
1183 .getxattr
= ecryptfs_getxattr
,
1184 .listxattr
= ecryptfs_listxattr
,
1185 .removexattr
= ecryptfs_removexattr
1188 const struct inode_operations ecryptfs_dir_iops
= {
1189 .create
= ecryptfs_create
,
1190 .lookup
= ecryptfs_lookup
,
1191 .link
= ecryptfs_link
,
1192 .unlink
= ecryptfs_unlink
,
1193 .symlink
= ecryptfs_symlink
,
1194 .mkdir
= ecryptfs_mkdir
,
1195 .rmdir
= ecryptfs_rmdir
,
1196 .mknod
= ecryptfs_mknod
,
1197 .rename
= ecryptfs_rename
,
1198 .permission
= ecryptfs_permission
,
1199 .setattr
= ecryptfs_setattr
,
1200 .setxattr
= ecryptfs_setxattr
,
1201 .getxattr
= ecryptfs_getxattr
,
1202 .listxattr
= ecryptfs_listxattr
,
1203 .removexattr
= ecryptfs_removexattr
1206 const struct inode_operations ecryptfs_main_iops
= {
1207 .permission
= ecryptfs_permission
,
1208 .setattr
= ecryptfs_setattr
,
1209 .getattr
= ecryptfs_getattr
,
1210 .setxattr
= ecryptfs_setxattr
,
1211 .getxattr
= ecryptfs_getxattr
,
1212 .listxattr
= ecryptfs_listxattr
,
1213 .removexattr
= ecryptfs_removexattr